diff options
| author | Sylvain Munaut <tnt@246tNt.com> | 2011-11-17 21:01:46 +0100 |
|---|---|---|
| committer | Sylvain Munaut <tnt@246tNt.com> | 2011-11-17 21:01:46 +0100 |
| commit | 2735ac484896d1dac3ffced31533d4273161e265 (patch) | |
| tree | 2debd91669511141d17de7316f695aaa1266d3ac /include/osmocom | |
| parent | 7f975d231bf8b7267a65057185cdbc83dfd40ab7 (diff) | |
gsm/a5: Add documentation
Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
Diffstat (limited to 'include/osmocom')
| -rw-r--r-- | include/osmocom/gsm/a5.h | 14 |
1 files changed, 14 insertions, 0 deletions
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 <osmocom/core/bits.h> +/*! \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__ */ |