From 830b8dbb140b4898c0c24adc7223f82b23991804 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Thu, 14 May 2020 03:21:59 +0700 Subject: libosmogsm: add Doxygen docs for gsm0502_hop_seq_gen() This is basically I16d5190b3cdc997c5609b52d41203f10264b017c. Change-Id: Ife660f00d7a6d3b874ab2e59e34dca2109fa82d8 Related: OS#4546 --- src/gsm/gsm0502.c | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/gsm/gsm0502.c b/src/gsm/gsm0502.c index 7ab6343a..e34d3f57 100644 --- a/src/gsm/gsm0502.c +++ b/src/gsm/gsm0502.c @@ -220,7 +220,16 @@ static const uint8_t rn_table[114] = { 125, 99, 17, 123, }; -/*! Hopping sequence generation as per 3GPP TS 45.002, section 6.2.3. */ +/*! Hopping sequence generation as per 3GPP TS 45.002, section 6.2.3. + * \param[in] t GSM time (TDMA frame number, T1/T2/T3). + * \param[in] hsn Hopping Sequence Number. + * \param[in] maio Mobile Allocation Index Offset. + * \param[in] n number of entries in mobile allocation (arfcn table). + * \param[in] ma array of ARFCNs (sorted in ascending order) + * representing the Mobile Allocation. + * \returns ARFCN to use for given input parameters at time 't' + * or Mobile Allocation Index if ma == NULL. + */ uint16_t gsm0502_hop_seq_gen(const struct gsm_time *t, uint8_t hsn, uint8_t maio, size_t n, const uint16_t *ma) -- cgit v1.2.3