From 2735ac484896d1dac3ffced31533d4273161e265 Mon Sep 17 00:00:00 2001 From: Sylvain Munaut Date: Thu, 17 Nov 2011 21:01:46 +0100 Subject: gsm/a5: Add documentation Signed-off-by: Sylvain Munaut --- include/osmocom/gsm/a5.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'include/osmocom/gsm/a5.h') diff --git a/include/osmocom/gsm/a5.h b/include/osmocom/gsm/a5.h index 55ce24dc..7e6a17c4 100644 --- a/include/osmocom/gsm/a5.h +++ b/include/osmocom/gsm/a5.h @@ -27,6 +27,18 @@ #include +/*! \defgroup a5 GSM A5 ciphering algorithm + * @{ + */ + +/*! \file gsm/a5.h + * \brief Osmocom GSM A5 ciphering algorithm header + */ + +/*! \brief Converts a frame number into the 22 bit number used in A5/x + * \param[in] fn The true framenumber + * \return 22 bit word + */ static inline uint32_t osmo_a5_fn_count(uint32_t fn) { @@ -46,4 +58,6 @@ void osmo_a5(int n, const uint8_t *key, uint32_t fn, ubit_t *dl, ubit_t *ul); void osmo_a5_1(const uint8_t *key, uint32_t fn, ubit_t *dl, ubit_t *ul); void osmo_a5_2(const uint8_t *key, uint32_t fn, ubit_t *dl, ubit_t *ul); +/*! }@ */ + #endif /* __OSMO_A5_H__ */ -- cgit v1.2.3