summaryrefslogtreecommitdiffstats
path: root/src/gsm/gsm_utils.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/gsm/gsm_utils.c')
-rw-r--r--src/gsm/gsm_utils.c46
1 files changed, 23 insertions, 23 deletions
diff --git a/src/gsm/gsm_utils.c b/src/gsm/gsm_utils.c
index 9cb5df62..fd16e980 100644
--- a/src/gsm/gsm_utils.c
+++ b/src/gsm/gsm_utils.c
@@ -146,7 +146,7 @@ uint8_t gsm_get_octet_len(const uint8_t sept_len){
return octet_len;
}
-/*! \brief TS 03.38 7-bit Character unpacking (6.2.1)
+/*! TS 03.38 7-bit Character unpacking (6.2.1)
* \param[out] text Caller-provided output text buffer
* \param[in] n Length of \a text
* \param[in] user_data Input Data (septets)
@@ -210,13 +210,13 @@ int gsm_7bit_decode_n_hdr(char *text, size_t n, const uint8_t *user_data, uint8_
return text - text_buf_begin;
}
-/*! \brief Decode 7bit GSM Alphabet */
+/*! Decode 7bit GSM Alphabet */
int gsm_7bit_decode_n(char *text, size_t n, const uint8_t *user_data, uint8_t septet_l)
{
return gsm_7bit_decode_n_hdr(text, n, user_data, septet_l, 0);
}
-/*! \brief Decode 7bit GSM Alphabet (USSD) */
+/*! Decode 7bit GSM Alphabet (USSD) */
int gsm_7bit_decode_n_ussd(char *text, size_t n, const uint8_t *user_data, uint8_t length)
{
int nchars;
@@ -229,7 +229,7 @@ int gsm_7bit_decode_n_ussd(char *text, size_t n, const uint8_t *user_data, uint8
return nchars;
}
-/*! \brief Encode a ASCII characterrs as 7-bit GSM alphabet (TS 03.38)
+/*! Encode a ASCII characterrs as 7-bit GSM alphabet (TS 03.38)
*
* This function converts a zero-terminated input string \a data from
* ASCII into octet-aligned 7-bit GSM characters. No packing is
@@ -266,7 +266,7 @@ int gsm_septet_encode(uint8_t *result, const char *data)
return y;
}
-/*! \brief GSM Default Alphabet 7bit to octet packing
+/*! GSM Default Alphabet 7bit to octet packing
* \param[out] result Caller-provided output buffer
* \param[in] rdata Input data septets
* \param[in] septet_len Length of \a rdata
@@ -317,7 +317,7 @@ int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len
return z;
}
-/*! \brief GSM 7-bit alphabet TS 03.38 6.2.1 Character packing
+/*! GSM 7-bit alphabet TS 03.38 6.2.1 Character packing
* \param[out] result Caller-provided output buffer
* \param[in] n Maximum length of \a result in bytes
* \param[in] data octet-aligned string
@@ -361,7 +361,7 @@ int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets)
return y;
}
-/*! \brief Encode according to GSM 7-bit alphabet (TS 03.38 6.2.1) for USSD
+/*! Encode according to GSM 7-bit alphabet (TS 03.38 6.2.1) for USSD
* \param[out] result Caller-provided output buffer
* \param[in] n Maximum length of \a result in bytes
* \param[in] data octet-aligned string
@@ -385,7 +385,7 @@ int gsm_7bit_encode_n_ussd(uint8_t *result, size_t n, const char *data, int *oct
return y;
}
-/*! \brief Build the RSL uplink measurement IE (3GPP TS 08.58 § 9.3.25)
+/*! Build the RSL uplink measurement IE (3GPP TS 08.58 § 9.3.25)
* \param[in] mru Unidirectional measurement report structure
* \param[in] dtxd_used Indicates if DTXd was used during measurement report
* period
@@ -403,7 +403,7 @@ size_t gsm0858_rsl_ul_meas_enc(struct gsm_meas_rep_unidir *mru, bool dtxd_used,
return 3;
}
-/*! \brief Convert power class to dBm according to GSM TS 05.05
+/*! Convert power class to dBm according to GSM TS 05.05
* \param[in] band GSM frequency band
* \param[in] class GSM power class
* \returns maximum transmit power of power class in dBm */
@@ -447,7 +447,7 @@ unsigned int ms_class_gmsk_dbm(enum gsm_band band, int class)
return -EINVAL;
}
-/*! \brief determine power control level for given dBm value, as indicated
+/*! determine power control level for given dBm value, as indicated
* by the tables in chapter 4.1.1 of GSM TS 05.05
* \param[in] GSM frequency band
* \param[in] dbm RF power value in dBm
@@ -500,7 +500,7 @@ int ms_pwr_ctl_lvl(enum gsm_band band, unsigned int dbm)
return -EINVAL;
}
-/*! \brief Convert TS 05.05 power level to absolute dBm value
+/*! Convert TS 05.05 power level to absolute dBm value
* \param[in] band GSM frequency band
* \param[in] lvl TS 05.05 power control level
* \returns RF power level in dBm */
@@ -542,7 +542,7 @@ int ms_pwr_dbm(enum gsm_band band, uint8_t lvl)
return -EINVAL;
}
-/*! \brief Convert TS 05.08 RxLev to dBm (TS 05.08 Chapter 8.1.4)
+/*! Convert TS 05.08 RxLev to dBm (TS 05.08 Chapter 8.1.4)
* \param[in] rxlev TS 05.08 RxLev value
* \returns Received RF power in dBm */
int rxlev2dbm(uint8_t rxlev)
@@ -553,7 +553,7 @@ int rxlev2dbm(uint8_t rxlev)
return -110 + rxlev;
}
-/*! \brief Convert RF signal level in dBm to TS 05.08 RxLev (TS 05.08 Chapter 8.1.4)
+/*! Convert RF signal level in dBm to TS 05.08 RxLev (TS 05.08 Chapter 8.1.4)
* \param[in] dbm RF signal level in dBm
* \returns TS 05.08 RxLev value */
uint8_t dbm2rxlev(int dbm)
@@ -568,7 +568,7 @@ uint8_t dbm2rxlev(int dbm)
return rxlev;
}
-/*! \brief Return string name of a given GSM Band */
+/*! Return string name of a given GSM Band */
const char *gsm_band_name(enum gsm_band band)
{
switch (band) {
@@ -592,7 +592,7 @@ const char *gsm_band_name(enum gsm_band band)
return "invalid";
}
-/*! \brief Parse string name of a GSM band */
+/*! Parse string name of a GSM band */
enum gsm_band gsm_band_parse(const char* mhz)
{
while (*mhz && !isdigit(*mhz))
@@ -623,7 +623,7 @@ enum gsm_band gsm_band_parse(const char* mhz)
}
}
-/*! \brief Resolve GSM band from ARFCN
+/*! Resolve GSM band from ARFCN
* In Osmocom, we use the highest bit of the \a arfcn to indicate PCS
* \param[in] arfcn Osmocom ARFCN, highest bit determines PCS mode
* \returns GSM Band */
@@ -676,7 +676,7 @@ static struct gsm_freq_range gsm_ranges[] = {
{ /* Guard */ }
};
-/*! \brief Convert an ARFCN to the frequency in MHz * 10
+/*! Convert an ARFCN to the frequency in MHz * 10
* \param[in] arfcn GSM ARFCN to convert
* \param[in] uplink Uplink (1) or Downlink (0) frequency
* \returns Frequency in units of 1/10ths of MHz (100kHz) */
@@ -703,7 +703,7 @@ uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink)
return uplink ? freq10_ul : freq10_dl;
}
-/*! \brief Convert a Frequency in MHz * 10 to ARFCN
+/*! Convert a Frequency in MHz * 10 to ARFCN
* \param[in] freq10 Frequency in units of 1/10ths of MHz (100kHz)
* \param[in] uplink Frequency is Uplink (1) or Downlink (0)
* \returns ARFCN in case of success; 0xffff on error */
@@ -736,7 +736,7 @@ uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink)
return arfcn;
}
-/*! \brief Parse GSM Frame Number into struct \ref gsm_time
+/*! Parse GSM Frame Number into struct \ref gsm_time
* \param[out] time Caller-provided memory for \ref gsm_time
* \param[in] fn GSM Frame Number */
void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn)
@@ -748,7 +748,7 @@ void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn)
time->tc = (time->fn / 51) % 8;
}
-/*! \brief Encode decoded \ref gsm_time to Frame Number
+/*! Encode decoded \ref gsm_time to Frame Number
* \param[in] time GSM Time in decoded structure
* \returns GSM Frame Number */
uint32_t gsm_gsmtime2fn(struct gsm_time *time)
@@ -757,7 +757,7 @@ uint32_t gsm_gsmtime2fn(struct gsm_time *time)
return (51 * ((time->t3 - time->t2 + 26) % 26) + time->t3 + (26 * 51 * time->t1));
}
-/*! \brief append range1024 encoded data to bit vector
+/*! append range1024 encoded data to bit vector
* \param[out] bv Caller-provided output bit-vector
* \param[in] r Input Range1024 sructure */
void bitvec_add_range1024(struct bitvec *bv, const struct gsm48_range_1024 *r)
@@ -793,7 +793,7 @@ void bitvec_add_range1024(struct bitvec *bv, const struct gsm48_range_1024 *r)
bitvec_set_uint(bv, r->w16, 6);
}
-/*! \brief Determine GPRS TLLI Type (TS 23.003 Chapter 2.6) */
+/*! Determine GPRS TLLI Type (TS 23.003 Chapter 2.6) */
int gprs_tlli_type(uint32_t tlli)
{
if ((tlli & 0xc0000000) == 0xc0000000)
@@ -812,7 +812,7 @@ int gprs_tlli_type(uint32_t tlli)
return TLLI_RESERVED;
}
-/*! \brief Determine TLLI from P-TMSI
+/*! Determine TLLI from P-TMSI
* \param[in] p_tmsi P-TMSI
* \param[in] type TLLI Type we want to derive from \a p_tmsi
* \returns TLLI of given type */