summaryrefslogtreecommitdiffstats
path: root/src/gsm
diff options
context:
space:
mode:
authorNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-20 00:17:59 +0200
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-23 00:18:22 +0000
commit87e4550585c643e97e0003119b254251ac5ed1d4 (patch)
tree9287f66aba70e9253f4d62926c54dddeb492895e /src/gsm
parent249fb71a2e124acb191b7cd4d2c3af6a45da4a5e (diff)
doxygen: enable AUTOBRIEF, drop \brief
Especially for short descriptions, it is annoying to have to type \brief for every single API doc. Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes the first sentence of an API doc as the brief description. Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
Diffstat (limited to 'src/gsm')
-rw-r--r--src/gsm/a5.c26
-rw-r--r--src/gsm/abis_nm.c64
-rw-r--r--src/gsm/auth_core.c18
-rw-r--r--src/gsm/comp128.c6
-rw-r--r--src/gsm/comp128v23.c6
-rw-r--r--src/gsm/gan.c2
-rw-r--r--src/gsm/gea.c4
-rw-r--r--src/gsm/gprs_cipher_core.c2
-rw-r--r--src/gsm/gprs_rlc.c2
-rw-r--r--src/gsm/gsm0341.c2
-rw-r--r--src/gsm/gsm0411_smc.c2
-rw-r--r--src/gsm/gsm0411_utils.c20
-rw-r--r--src/gsm/gsm0808.c46
-rw-r--r--src/gsm/gsm0808_utils.c28
-rw-r--r--src/gsm/gsm48.c50
-rw-r--r--src/gsm/gsm48_ie.c70
-rw-r--r--src/gsm/gsm_04_08_gprs.c18
-rw-r--r--src/gsm/gsm_utils.c46
-rw-r--r--src/gsm/gsup.c2
-rw-r--r--src/gsm/ipa.c6
-rw-r--r--src/gsm/lapd_core.c4
-rw-r--r--src/gsm/lapdm.c32
-rw-r--r--src/gsm/oap.c6
-rw-r--r--src/gsm/rsl.c40
-rw-r--r--src/gsm/sysinfo.c10
-rw-r--r--src/gsm/tlv_parser.c14
26 files changed, 263 insertions, 263 deletions
diff --git a/src/gsm/a5.c b/src/gsm/a5.c
index 23cbe0c9..f21554f0 100644
--- a/src/gsm/a5.c
+++ b/src/gsm/a5.c
@@ -28,7 +28,7 @@
/*! \addtogroup crypto
* @{
- * \brief Osmocom GSM/GPRS ciphering algorithm implementation
+ * Osmocom GSM/GPRS ciphering algorithm implementation
*/
/*! \file gsm/a5.c */
@@ -50,7 +50,7 @@
/* A5/3&4 */
/* ------------------------------------------------------------------------ */
-/*! \brief Generate a GSM A5/4 cipher stream
+/*! Generate a GSM A5/4 cipher stream
* \param[in] key 16 byte array for the key (as received from the SIM)
* \param[in] fn Frame number
* \param[out] dl Pointer to array of ubits to return Downlink cipher stream
@@ -79,7 +79,7 @@ _a5_4(const uint8_t *ck, uint32_t fn, ubit_t *dl, ubit_t *ul, bool fn_correct)
}
}
-/*! \brief Generate a GSM A5/3 cipher stream
+/*! Generate a GSM A5/3 cipher stream
* \param[in] key 8 byte array for the key (as received from the SIM)
* \param[in] fn Frame number
* \param[out] dl Pointer to array of ubits to return Downlink cipher stream
@@ -119,7 +119,7 @@ _a5_3(const uint8_t *key, uint32_t fn, ubit_t *dl, ubit_t *ul, bool fn_correct)
#define A5_R3_TAPS 0x700080 /* x^23 + x^22 + x^21 + x^8 + 1 */
#define A5_R4_TAPS 0x010800 /* x^17 + x^12 + 1 */
-/*! \brief Computes parity of a 32-bit word
+/*! Computes parity of a 32-bit word
* \param[in] x 32 bit word
* \return Parity bit (xor of all bits) as 0 or 1
*/
@@ -133,7 +133,7 @@ _a5_12_parity(uint32_t x)
return (0x6996 >> x) & 1;
}
-/*! \brief Compute majority bit from 3 taps
+/*! Compute majority bit from 3 taps
* \param[in] v1 LFSR state ANDed with tap-bit
* \param[in] v2 LFSR state ANDed with tap-bit
* \param[in] v3 LFSR state ANDed with tap-bit
@@ -145,7 +145,7 @@ _a5_12_majority(uint32_t v1, uint32_t v2, uint32_t v3)
return (!!v1 + !!v2 + !!v3) >= 2;
}
-/*! \brief Compute the next LFSR state
+/*! Compute the next LFSR state
* \param[in] r Current state
* \param[in] mask LFSR mask
* \param[in] taps LFSR taps
@@ -166,7 +166,7 @@ _a5_12_clock(uint32_t r, uint32_t mask, uint32_t taps)
#define A51_R2_CLKBIT 0x000400
#define A51_R3_CLKBIT 0x000400
-/*! \brief GSM A5/1 Clocking function
+/*! GSM A5/1 Clocking function
* \param[in] r Register state
* \param[in] force Non-zero value disable conditional clocking
*/
@@ -191,7 +191,7 @@ _a5_1_clock(uint32_t r[], int force)
r[2] = _a5_12_clock(r[2], A5_R3_MASK, A5_R3_TAPS);
}
-/*! \brief GSM A5/1 Output function
+/*! GSM A5/1 Output function
* \param[in] r Register state
* \return The A5/1 output function bit
*/
@@ -203,7 +203,7 @@ _a5_1_get_output(uint32_t r[])
(r[2] >> (A5_R3_LEN-1));
}
-/*! \brief Generate a GSM A5/1 cipher stream
+/*! Generate a GSM A5/1 cipher stream
* \param[in] key 8 byte array for the key (as received from the SIM)
* \param[in] fn Frame number
* \param[out] dl Pointer to array of ubits to return Downlink cipher stream
@@ -278,7 +278,7 @@ void osmo_a5_1(const uint8_t *key, uint32_t fn, ubit_t *dl, ubit_t *ul)
#define A52_R4_CLKBIT1 0x000008
#define A52_R4_CLKBIT2 0x000080
-/*! \brief GSM A5/2 Clocking function
+/*! GSM A5/2 Clocking function
* \param[in] r Register state
* \param[in] force Non-zero value disable conditional clocking
*/
@@ -305,7 +305,7 @@ _a5_2_clock(uint32_t r[], int force)
r[3] = _a5_12_clock(r[3], A5_R4_MASK, A5_R4_TAPS);
}
-/*! \brief GSM A5/2 Output function
+/*! GSM A5/2 Output function
* \param[in] r Register state
* \return The A5/2 output function bit
*/
@@ -324,7 +324,7 @@ _a5_2_get_output(uint32_t r[])
return b;
}
-/*! \brief Generate a GSM A5/1 cipher stream
+/*! Generate a GSM A5/1 cipher stream
* \param[in] key 8 byte array for the key (as received from the SIM)
* \param[in] fn Frame number
* \param[out] dl Pointer to array of ubits to return Downlink cipher stream
@@ -398,7 +398,7 @@ void osmo_a5_2(const uint8_t *key, uint32_t fn, ubit_t *dl, ubit_t *ul)
osmo_a5(2, key, fn, dl, ul);
}
-/*! \brief Main method to generate a A5/x cipher stream
+/*! Main method to generate a A5/x cipher stream
* \param[in] n Which A5/x method to use
* \param[in] key 8 or 16 (for a5/4) byte array for the key (as received from the SIM)
* \param[in] fn Frame number
diff --git a/src/gsm/abis_nm.c b/src/gsm/abis_nm.c
index c9549027..287973b3 100644
--- a/src/gsm/abis_nm.c
+++ b/src/gsm/abis_nm.c
@@ -22,7 +22,7 @@
/*! \addtogroup oml
* @{
- * \brief GSM Network Management (OML) messages on the A-bis interface
+ * GSM Network Management (OML) messages on the A-bis interface
* 3GPP TS 12.21 version 8.0.0 Release 1999 / ETSI TS 100 623 V8.0.0
*/
@@ -41,7 +41,7 @@
const char abis_nm_ipa_magic[13] = "com.ipaccess";
const char abis_nm_osmo_magic[12] = "org.osmocom";
-/*! \brief unidirectional messages from BTS to BSC */
+/*! unidirectional messages from BTS to BSC */
const enum abis_nm_msgtype abis_nm_reports[4] = {
NM_MT_SW_ACTIVATED_REP,
NM_MT_TEST_REP,
@@ -49,14 +49,14 @@ const enum abis_nm_msgtype abis_nm_reports[4] = {
NM_MT_FAILURE_EVENT_REP,
};
-/*! \brief messages without ACK/NACK */
+/*! messages without ACK/NACK */
const enum abis_nm_msgtype abis_nm_no_ack_nack[3] = {
NM_MT_MEAS_RES_REQ,
NM_MT_STOP_MEAS,
NM_MT_START_MEAS,
};
-/*! \brief messages related to software load */
+/*! messages related to software load */
const enum abis_nm_msgtype abis_nm_sw_load_msgs[9] = {
NM_MT_LOAD_INIT_ACK,
NM_MT_LOAD_INIT_NACK,
@@ -70,7 +70,7 @@ const enum abis_nm_msgtype abis_nm_sw_load_msgs[9] = {
NM_MT_SW_ACTIVATED_REP,
};
-/*! \brief All NACKs (negative acknowledgements */
+/*! All NACKs (negative acknowledgements */
const enum abis_nm_msgtype abis_nm_nacks[33] = {
NM_MT_LOAD_INIT_NACK,
NM_MT_LOAD_END_NACK,
@@ -145,7 +145,7 @@ static const struct value_string nack_names[] = {
{ 0, NULL }
};
-/*! \brief Get human-readable string for OML NACK message type */
+/*! Get human-readable string for OML NACK message type */
const char *abis_nm_nack_name(uint8_t nack)
{
return get_value_string(nack_names, nack);
@@ -214,7 +214,7 @@ static const struct value_string nack_cause_names[] = {
{ 0, NULL }
};
-/*! \brief Get human-readable string for NACK cause */
+/*! Get human-readable string for NACK cause */
const char *abis_nm_nack_cause_name(uint8_t cause)
{
return get_value_string(nack_cause_names, cause);
@@ -230,7 +230,7 @@ static const struct value_string event_type_names[] = {
{ 0, NULL }
};
-/*! \brief Get human-readable string for OML event type */
+/*! Get human-readable string for OML event type */
const char *abis_nm_event_type_name(uint8_t cause)
{
return get_value_string(event_type_names, cause);
@@ -247,13 +247,13 @@ static const struct value_string severity_names[] = {
{ 0, NULL }
};
-/*! \brief Get human-readable string for perceived OML severity */
+/*! Get human-readable string for perceived OML severity */
const char *abis_nm_severity_name(uint8_t cause)
{
return get_value_string(severity_names, cause);
}
-/*! \brief 3GPP TS 12.21 9.4.53 T200 values (in msec) */
+/*! 3GPP TS 12.21 9.4.53 T200 values (in msec) */
const uint8_t abis_nm_t200_ms[] = {
[T200_SDCCH] = 5,
[T200_FACCH_F] = 5,
@@ -264,7 +264,7 @@ const uint8_t abis_nm_t200_ms[] = {
[T200_SACCH_TCH_SAPI3] = 10
};
-/*! \brief 3GPP TS 52.021 §9.1 Message Types */
+/*! 3GPP TS 52.021 §9.1 Message Types */
const struct value_string abis_nm_msgtype_names[] = {
{ NM_MT_LOAD_INIT, "Load Data Initiate" }, /* §8.3.1 */
{ NM_MT_LOAD_INIT_ACK, "Load Data Initiate Ack" },
@@ -367,7 +367,7 @@ const struct value_string abis_nm_msgtype_names[] = {
{ 0, NULL }
};
-/*! \brief 3GPP TS 52.021 §9.4 Attributes and Parameters */
+/*! 3GPP TS 52.021 §9.4 Attributes and Parameters */
const struct value_string abis_nm_att_names[] = {
{ NM_ATT_ABIS_CHANNEL, "Abis Channel" }, /* §9.4.1 */
{ NM_ATT_ADD_INFO, "Additional Info" }, /* §9.4.2 */
@@ -438,7 +438,7 @@ const struct value_string abis_nm_att_names[] = {
{ 0, NULL }
};
-/*! \brief Attributes that the BSC can set, not only get, according to Section 9.4 */
+/*! Attributes that the BSC can set, not only get, according to Section 9.4 */
const enum abis_nm_attr abis_nm_att_settable[] = {
NM_ATT_ADD_INFO,
NM_ATT_ADD_TEXT,
@@ -467,7 +467,7 @@ const enum abis_nm_attr abis_nm_att_settable[] = {
NM_ATT_MEAS_TYPE,
};
-/*! \brief GSM A-bis OML IPA TLV parser definition */
+/*! GSM A-bis OML IPA TLV parser definition */
const struct tlv_definition abis_nm_att_tlvdef_ipa = {
.def = {
/* ip.access specifics */
@@ -516,7 +516,7 @@ const struct tlv_definition abis_nm_att_tlvdef_ipa = {
},
};
-/*! \brief GSM A-bis OML TLV parser definition */
+/*! GSM A-bis OML TLV parser definition */
const struct tlv_definition abis_nm_att_tlvdef = {
.def = {
[NM_ATT_ABIS_CHANNEL] = { TLV_TYPE_FIXED, 3 },
@@ -586,14 +586,14 @@ const struct tlv_definition abis_nm_att_tlvdef = {
},
};
-/*! \brief org.osmocom GSM A-bis OML TLV parser definition */
+/*! org.osmocom GSM A-bis OML TLV parser definition */
const struct tlv_definition abis_nm_osmo_att_tlvdef = {
.def = {
[NM_ATT_OSMO_REDUCEPOWER] = { TLV_TYPE_TV },
},
};
-/*! \brief Human-readable strings for A-bis OML Object Class */
+/*! Human-readable strings for A-bis OML Object Class */
const struct value_string abis_nm_msg_disc_names[] = {
{ ABIS_OM_MDISC_FOM, "FOM" },
{ ABIS_OM_MDISC_MMI, "MMI" },
@@ -602,7 +602,7 @@ const struct value_string abis_nm_msg_disc_names[] = {
{ 0, NULL }
};
-/*! \brief Human-readable strings for A-bis OML Object Class */
+/*! Human-readable strings for A-bis OML Object Class */
const struct value_string abis_nm_obj_class_names[] = {
{ NM_OC_SITE_MANAGER, "SITE-MANAGER" },
{ NM_OC_BTS, "BTS" },
@@ -624,7 +624,7 @@ const struct value_string abis_nm_obj_class_names[] = {
{ 0, NULL }
};
-/*! \brief Get human-readable string for OML Operational State */
+/*! Get human-readable string for OML Operational State */
const char *abis_nm_opstate_name(uint8_t os)
{
switch (os) {
@@ -653,7 +653,7 @@ static const struct value_string avail_names[] = {
{ 0, NULL }
};
-/*! \brief Get human-readable string for OML Availability State */
+/*! Get human-readable string for OML Availability State */
const char *abis_nm_avail_name(uint8_t avail)
{
return get_value_string(avail_names, avail);
@@ -671,13 +671,13 @@ static const struct value_string test_names[] = {
{ 0, NULL }
};
-/*! \brief Get human-readable string for OML test */
+/*! Get human-readable string for OML test */
const char *abis_nm_test_name(uint8_t test)
{
return get_value_string(test_names, test);
}
-/*! \brief Human-readable names for OML administrative state */
+/*! Human-readable names for OML administrative state */
const struct value_string abis_nm_adm_state_names[] = {
{ NM_STATE_LOCKED, "Locked" },
{ NM_STATE_UNLOCKED, "Unlocked" },
@@ -702,7 +702,7 @@ static const enum abis_nm_chan_comb chcomb4pchan[] = {
/* FIXME: bounds check */
};
-/*! \brief Pack 3GPP TS 12.21 § 8.8.2 Failure Event Report into msgb */
+/*! Pack 3GPP TS 12.21 § 8.8.2 Failure Event Report into msgb */
struct msgb *abis_nm_fail_evt_rep(enum abis_nm_event_type t,
enum abis_nm_severity s,
enum abis_nm_pcause_type ct,
@@ -718,7 +718,7 @@ struct msgb *abis_nm_fail_evt_rep(enum abis_nm_event_type t,
return nmsg;
}
-/*! \brief Pack 3GPP TS 12.21 § 8.8.2 Failure Event Report into msgb */
+/*! Pack 3GPP TS 12.21 § 8.8.2 Failure Event Report into msgb */
struct msgb *abis_nm_fail_evt_vrep(enum abis_nm_event_type t,
enum abis_nm_severity s,
enum abis_nm_pcause_type ct,
@@ -753,7 +753,7 @@ struct msgb *abis_nm_fail_evt_vrep(enum abis_nm_event_type t,
return nmsg;
}
-/*! \brief Compute length of given 3GPP TS 52.021 §9.4.62 SW Description.
+/*! Compute length of given 3GPP TS 52.021 §9.4.62 SW Description.
* \param[in] sw SW Description struct
* \param[in] put_sw_descr boolean, whether to put NM_ATT_SW_DESCR IE or not
* \returns length of buffer space necessary to store sw
@@ -764,7 +764,7 @@ uint16_t abis_nm_sw_desc_len(const struct abis_nm_sw_desc *sw, bool put_sw_desc)
return (put_sw_desc ? 1 : 0) + (sw->file_id_len + 3) + (sw->file_version_len + 3);
}
-/*! \brief Put given 3GPP TS 52.021 §9.4.62 SW Description into msgb.
+/*! Put given 3GPP TS 52.021 §9.4.62 SW Description into msgb.
* \param[out] msg message buffer
* \param[in] sw SW Description struct
* \param[in] put_sw_descr boolean, whether to put NM_ATT_SW_DESCR IE or not
@@ -781,7 +781,7 @@ uint16_t abis_nm_put_sw_desc(struct msgb *msg, const struct abis_nm_sw_desc *sw,
return abis_nm_sw_desc_len(sw, put_sw_desc);
}
-/*! \brief Put given file ID/Version pair as 3GPP TS 52.021 §9.4.62 SW Description into msgb.
+/*! Put given file ID/Version pair as 3GPP TS 52.021 §9.4.62 SW Description into msgb.
* \param[out] msg message buffer
* \param[in] id File ID part of SW Description
* \param[in] id File Version part of SW Description
@@ -801,7 +801,7 @@ uint16_t abis_nm_put_sw_file(struct msgb *msg, const char *id, const char *ver,
return abis_nm_put_sw_desc(msg, &sw, put_sw_desc);
}
-/*! \brief Get length of first 3GPP TS 52.021 §9.4.62 SW Description from buffer.
+/*! Get length of first 3GPP TS 52.021 §9.4.62 SW Description from buffer.
* \param[in] buf buffer, may contain several SW Descriptions
* \param[in] len buffer length
* \returns length if parsing succeeded, 0 otherwise
@@ -826,7 +826,7 @@ uint32_t abis_nm_get_sw_desc_len(const uint8_t *buf, size_t len)
return sw + 2; /* + 2-byte length field of 2nd FILE_* element */
}
-/*! \brief Parse single 3GPP TS 52.021 §9.4.62 SW Description from buffer.
+/*! Parse single 3GPP TS 52.021 §9.4.62 SW Description from buffer.
* \param[out] sw SW Description struct
* \param[in] buf buffer
* \param[in] len buffer length
@@ -882,7 +882,7 @@ static inline int abis_nm_get_sw_desc(struct abis_nm_sw_desc *sw, const uint8_t
return 0;
}
-/*! \brief Parse 3GPP TS 52.021 §9.4.61 SW Configuration from buffer.
+/*! Parse 3GPP TS 52.021 §9.4.61 SW Configuration from buffer.
* \param[in] buf buffer
* \param[in] buf_len buffer length
* \param[out] sw SW Description struct array
@@ -908,7 +908,7 @@ int abis_nm_get_sw_conf(const uint8_t * buf, size_t buf_len, struct abis_nm_sw_d
return i;
}
-/*! \brief Obtain OML Channel Combination for phnsical channel config */
+/*! Obtain OML Channel Combination for phnsical channel config */
int abis_nm_chcomb4pchan(enum gsm_phys_chan_config pchan)
{
if (pchan < ARRAY_SIZE(chcomb4pchan))
@@ -917,7 +917,7 @@ int abis_nm_chcomb4pchan(enum gsm_phys_chan_config pchan)
return -EINVAL;
}
-/*! \brief Obtain physical channel config for OML Channel Combination */
+/*! Obtain physical channel config for OML Channel Combination */
enum gsm_phys_chan_config abis_nm_pchan4chcomb(uint8_t chcomb)
{
int i;
diff --git a/src/gsm/auth_core.c b/src/gsm/auth_core.c
index c9e403c5..1bdd4a84 100644
--- a/src/gsm/auth_core.c
+++ b/src/gsm/auth_core.c
@@ -32,7 +32,7 @@
/*! \addtogroup auth
* @{
- * \brief GSM/GPRS/3G authentication core infrastructure
+ * GSM/GPRS/3G authentication core infrastructure
*/
/* \file auth_core.c */
@@ -41,7 +41,7 @@ static LLIST_HEAD(osmo_auths);
static struct osmo_auth_impl *selected_auths[_OSMO_AUTH_ALG_NUM];
-/*! \brief Register an authentication algorithm implementation with the core
+/*! Register an authentication algorithm implementation with the core
* \param[in] impl Structure describing implementation and it's callbacks
* \returns 0 on success, or a negative error code on failure
*
@@ -63,7 +63,7 @@ int osmo_auth_register(struct osmo_auth_impl *impl)
return 0;
}
-/*! \brief Load all available authentication plugins from the given path
+/*! Load all available authentication plugins from the given path
* \param[in] path Path name of the directory containing the plugins
* \returns number of plugins loaded in case of success, negative in case of error
*
@@ -75,7 +75,7 @@ int osmo_auth_load(const char *path)
return osmo_plugin_load_all(path);
}
-/*! \brief Determine if a given authentication algorithm is supported
+/*! Determine if a given authentication algorithm is supported
* \param[in] algo Algorithm which should be checked
* \returns 1 if algo is supported, 0 if not, negative error on failure
*
@@ -112,7 +112,7 @@ void osmo_c4(uint8_t *ck, const uint8_t *kc)
memcpy(ck+8, kc, 8);
}
-/*! \brief Generate 3G CK + IK from 2G authentication vector
+/*! Generate 3G CK + IK from 2G authentication vector
* \param vec Authentication Vector to be modified
* \returns 1 if the vector was changed, 0 otherwise
*
@@ -136,7 +136,7 @@ int osmo_auth_3g_from_2g(struct osmo_auth_vector *vec)
return 0;
}
-/*! \brief Generate authentication vector
+/*! Generate authentication vector
* \param[out] vec Generated authentication vector
* \param[in] aud Subscriber-specific key material
* \param[in] _rand Random challenge to be used
@@ -167,7 +167,7 @@ int osmo_auth_gen_vec(struct osmo_auth_vector *vec,
return 0;
}
-/*! \brief Generate authentication vector and re-sync sequence
+/*! Generate authentication vector and re-sync sequence
* \param[out] vec Generated authentication vector
* \param[in] aud Subscriber-specific key material
* \param[in] auts AUTS value sent by the SIM/MS
@@ -212,13 +212,13 @@ static const struct value_string auth_alg_vals[] = {
{ 0, NULL }
};
-/*! \brief Get human-readable name of authentication algorithm */
+/*! Get human-readable name of authentication algorithm */
const char *osmo_auth_alg_name(enum osmo_auth_algo alg)
{
return get_value_string(auth_alg_vals, alg);
}
-/*! \brief Parse human-readable name of authentication algorithm */
+/*! Parse human-readable name of authentication algorithm */
enum osmo_auth_algo osmo_auth_alg_parse(const char *name)
{
return get_string_value(auth_alg_vals, name);
diff --git a/src/gsm/comp128.c b/src/gsm/comp128.c
index cb3a3092..78f0e07c 100644
--- a/src/gsm/comp128.c
+++ b/src/gsm/comp128.c
@@ -73,7 +73,7 @@
*/
/*! \file comp128.c
- * \brief COMP128 v1; common/old GSM Authentication Algorithm (A3/A8)
+ * COMP128 v1; common/old GSM Authentication Algorithm (A3/A8)
*/
/* The compression tables (just copied ...) */
@@ -192,7 +192,7 @@ _comp128_permutation(uint8_t *x, uint8_t *bits)
x[(i>>3)+16] |= bits[(i*17) & 127] << (7-(i&7));
}
-/*! \brief Perform COMP128v1 algorithm
+/*! Perform COMP128v1 algorithm
* \param[in] ki Secret Key K(i) of subscriber
* \param[in] rand Random Challenge
* \param[out] sres user-supplied buffer for storing computed SRES value
@@ -242,7 +242,7 @@ comp128v1(const uint8_t *ki, const uint8_t *rand, uint8_t *sres, uint8_t *kc)
}
-/*! \brief Perform COMP128v1 algorithm
+/*! Perform COMP128v1 algorithm
* \param[in] ki Secret Key K(i) of subscriber
* \param[in] rand Random Challenge
* \param[out] sres user-supplied buffer for storing computed SRES value
diff --git a/src/gsm/comp128v23.c b/src/gsm/comp128v23.c
index bfb4a0ee..1797ebc9 100644
--- a/src/gsm/comp128v23.c
+++ b/src/gsm/comp128v23.c
@@ -33,7 +33,7 @@
*/
/*! \file comp128v23.c
- * \brief COMP128 v2 / v3; Common Algorithm used for GSM Authentication (A3/A8)
+ * COMP128 v2 / v3; Common Algorithm used for GSM Authentication (A3/A8)
*/
static const uint8_t table0[256] = {
@@ -109,7 +109,7 @@ _comp128v23_internal(uint8_t *output, const uint8_t *kxor, const uint8_t *rand)
}
}
-/*! \brief Perform COMP128v3 algorithm
+/*! Perform COMP128v3 algorithm
* \param[in] ki Secret Key K(i) of subscriber
* \param[in] rand Random Challenge
* \param[out] sres user-supplied buffer for storing computed SRES value
@@ -161,7 +161,7 @@ comp128v3(const uint8_t *ki, const uint8_t *rand, uint8_t *sres, uint8_t *kc)
return 0;
}
-/*! \brief Perform COMP128v2 algorithm
+/*! Perform COMP128v2 algorithm
* \param[in] ki Secret Key K(i) of subscriber
* \param[in] rand Random Challenge
* \param[out] sres user-supplied buffer for storing computed SRES value
diff --git a/src/gsm/gan.c b/src/gsm/gan.c
index 1d98b38b..d357b7e1 100644
--- a/src/gsm/gan.c
+++ b/src/gsm/gan.c
@@ -22,7 +22,7 @@
#include <osmocom/gsm/protocol/gsm_44_318.h>
/*! \file gan.c
- * \brief Generic Access Network (GAN) / UMA according to TS 44.318
+ * Generic Access Network (GAN) / UMA according to TS 44.318
*/
diff --git a/src/gsm/gea.c b/src/gsm/gea.c
index 8d026a29..d4e599c8 100644
--- a/src/gsm/gea.c
+++ b/src/gsm/gea.c
@@ -37,7 +37,7 @@
/*! \file gsm/gea.c */
-/*! \brief Performs the GEA4 algorithm as in 3GPP TS 55.226 V9.0.0
+/*! Performs the GEA4 algorithm as in 3GPP TS 55.226 V9.0.0
* \param[in,out] out Buffer for gamma for encrypted/decrypted
* \param[in] len Length of out, in bytes
* \param[in] kc Buffer with the ciphering key
@@ -51,7 +51,7 @@ int gea4(uint8_t *out, uint16_t len, uint8_t *kc, uint32_t iv,
return 0;
}
-/*! \brief Performs the GEA3 algorithm as in 3GPP TS 55.216 V6.2.0
+/*! Performs the GEA3 algorithm as in 3GPP TS 55.216 V6.2.0
* \param[in,out] out Buffer for gamma for encrypted/decrypted
* \param[in] len Length of out, in bytes
* \param[in] kc Buffer with the ciphering key
diff --git a/src/gsm/gprs_cipher_core.c b/src/gsm/gprs_cipher_core.c
index a0cf1851..b833048d 100644
--- a/src/gsm/gprs_cipher_core.c
+++ b/src/gsm/gprs_cipher_core.c
@@ -88,7 +88,7 @@ int gprs_cipher_run(uint8_t *out, uint16_t len, enum gprs_ciph_algo algo,
return selected_ciphers[algo]->run(out, len, kc, iv, dir);
}
-/*! \brief Obtain key lenght for given GPRS cipher
+/*! Obtain key lenght for given GPRS cipher
* \param[in] algo Enum representive GPRS cipher
* \returns unsigned integer key length for supported algorithms,
* for GEA0 and unknown ciphers will return 0
diff --git a/src/gsm/gprs_rlc.c b/src/gsm/gprs_rlc.c
index d1247be6..4b329473 100644
--- a/src/gsm/gprs_rlc.c
+++ b/src/gsm/gprs_rlc.c
@@ -6,7 +6,7 @@
#include <osmocom/gprs/protocol/gsm_04_60.h>
/*! \file gsm/gprs_rlc.c
- * \brief helper functions for (E)GPRS RLC according to 3GPP TS 44.060
+ * helper functions for (E)GPRS RLC according to 3GPP TS 44.060
*/
#define EGPRS_CPS_TYPE1_TBL_SZ 29
diff --git a/src/gsm/gsm0341.c b/src/gsm/gsm0341.c
index 2592b54e..0e3e453d 100644
--- a/src/gsm/gsm0341.c
+++ b/src/gsm/gsm0341.c
@@ -31,7 +31,7 @@
* @{
*/
-/*! \brief Encode a 3GPP TS 03.41 SMS-CB message
+/*! Encode a 3GPP TS 03.41 SMS-CB message
* \param[in] ctx talloc allocation context
* \param[in] geo_scope Geographic Scope
* \param[in] msg_code Message Code
diff --git a/src/gsm/gsm0411_smc.c b/src/gsm/gsm0411_smc.c
index 03016b92..dab83ebd 100644
--- a/src/gsm/gsm0411_smc.c
+++ b/src/gsm/gsm0411_smc.c
@@ -62,7 +62,7 @@
/*! \addtogroup sms
* @{
- * \brief Point-to-Point (PP) Short Message Service (SMS) as per TS 04.11
+ * Point-to-Point (PP) Short Message Service (SMS) as per TS 04.11
*/
static void cp_timer_expired(void *data);
diff --git a/src/gsm/gsm0411_utils.c b/src/gsm/gsm0411_utils.c
index 543775cc..ef679304 100644
--- a/src/gsm/gsm0411_utils.c
+++ b/src/gsm/gsm0411_utils.c
@@ -45,7 +45,7 @@
#define GSM411_ALLOC_SIZE 1024
#define GSM411_ALLOC_HEADROOM 128
-/*! \brief Allocate a message buffer for use as TS 04.11 message
+/*! Allocate a message buffer for use as TS 04.11 message
* \returns allocated message buffer */
struct msgb *gsm411_msgb_alloc(void)
{
@@ -53,7 +53,7 @@ struct msgb *gsm411_msgb_alloc(void)
"GSM 04.11");
}
-/*! \brief Turn int into semi-octet representation: 98 => 0x89
+/*! Turn int into semi-octet representation: 98 => 0x89
* \param[in] integer value representing decimal number 0..99
* \returns BSC encoded as nibbles, swapped */
uint8_t gsm411_bcdify(uint8_t value)
@@ -66,7 +66,7 @@ uint8_t gsm411_bcdify(uint8_t value)
return ret;
}
-/*! \brief Turn semi-octet representation into int: 0x89 => 98
+/*! Turn semi-octet representation into int: 0x89 => 98
* \param[in] value byte containing two BCD nibbles in revere order
* \returns integer representing decoded, re-ordered nibbles */
uint8_t gsm411_unbcdify(uint8_t value)
@@ -83,7 +83,7 @@ uint8_t gsm411_unbcdify(uint8_t value)
return ret;
}
-/*! \brief Generate 03.40 TP-SCTS
+/*! Generate 03.40 TP-SCTS
* \param[out] scts Caller-provided buffer to store SCTS (7 octets)
* \param[in] time to encode */
void gsm340_gen_scts(uint8_t *scts, time_t time)
@@ -104,7 +104,7 @@ void gsm340_gen_scts(uint8_t *scts, time_t time)
#endif
}
-/*! \brief Decode 03.40 TP-SCTS (into utc/gmt timestamp)
+/*! Decode 03.40 TP-SCTS (into utc/gmt timestamp)
* \param[in] scts SMS Center Time Stamp
* \return time in UTC time_t format */
time_t gsm340_scts(uint8_t *scts)
@@ -204,7 +204,7 @@ static unsigned long gsm340_vp_relative_semioctet(uint8_t *sms_vp)
return minutes;
}
-/*! \brief decode validity period. return minutes
+/*! decode validity period. return minutes
* \param[in] sms_vpf Validity Period Format in 03.40 encoding
* \param[in] sms_vp Validity Period Information Element
* \returns validity period in minutes */
@@ -245,7 +245,7 @@ unsigned long gsm340_validity_period(uint8_t sms_vpf, uint8_t *sms_vp)
}
}
-/*! \brief determine coding alphabet dependent on GSM 03.38 Section 4 DCS
+/*! determine coding alphabet dependent on GSM 03.38 Section 4 DCS
* \param[in] dcs Data Coding Scheme in 03.38 encoding
* \returns libosmogsm internal enum \ref sms_alphabet */
enum sms_alphabet gsm338_get_sms_alphabet(uint8_t dcs)
@@ -285,7 +285,7 @@ enum sms_alphabet gsm338_get_sms_alphabet(uint8_t dcs)
return alpha;
}
-/*! \brief generate a TPDU address field compliant with 03.40 sec. 9.1.2.5
+/*! generate a TPDU address field compliant with 03.40 sec. 9.1.2.5
* \param[out] oa caller-provided output buffer
* \param[in] oa_len caller-specified length of \a oa in bytes
* \param[in] type GSM340_TYPE_*
@@ -321,7 +321,7 @@ int gsm340_gen_oa(uint8_t *oa, unsigned int oa_len, uint8_t type,
return len_in_bytes;
}
-/*! \brief Prefix \ref msgb with a RP header
+/*! Prefix \ref msgb with a RP header
* \param msg Message Buffer containing message
* \param[in] rp_msg_type RP Message Type
* \param[in] rp_msg_ref RP Message Reference
@@ -341,7 +341,7 @@ int gsm411_push_rp_header(struct msgb *msg, uint8_t rp_msg_type,
return 0;
}
-/*! \brief Prefix \ref msgb with a 04.08/04.11 CP header
+/*! Prefix \ref msgb with a 04.08/04.11 CP header
* \param msg Message Buffer containing message
* \param[in] proto Protocol
* \param[in] trans Transaction
diff --git a/src/gsm/gsm0808.c b/src/gsm/gsm0808.c
index c96dc779..f595dd65 100644
--- a/src/gsm/gsm0808.c
+++ b/src/gsm/gsm0808.c
@@ -26,13 +26,13 @@
/*! \addtogroup gsm0808
* @{
- * \brief Helper functions regarding the TS 08.08 / 48.008 A interface
+ * Helper functions regarding the TS 08.08 / 48.008 A interface
*/
#define BSSMAP_MSG_SIZE 512
#define BSSMAP_MSG_HEADROOM 128
-/*! \brief Create "Complete L3 Info" for AoIP
+/*! Create "Complete L3 Info" for AoIP
* \param[in] msg_l3 msgb containing Layer 3 Message
* \param[in] nc Mobile Network Code
* \param[in] cc Mobile Country Code
@@ -81,7 +81,7 @@ struct msgb *gsm0808_create_layer3_aoip(const struct msgb *msg_l3, uint16_t nc,
return msg;
}
-/*! \brief Create "Complete L3 Info" for A
+/*! Create "Complete L3 Info" for A
* \param[in] msg_l3 msgb containing Layer 3 Message
* \param[in] nc Mobile Network Code
* \param[in] cc Mobile Country Code
@@ -94,7 +94,7 @@ struct msgb *gsm0808_create_layer3(struct msgb *msg_l3, uint16_t nc,
return gsm0808_create_layer3_aoip(msg_l3, nc, cc, lac, _ci, NULL);
}
-/*! \brief Create BSSMAP RESET message
+/*! Create BSSMAP RESET message
* \returns callee-allocated msgb with BSSMAP Reset message */
struct msgb *gsm0808_create_reset(void)
{
@@ -111,7 +111,7 @@ struct msgb *gsm0808_create_reset(void)
return msg;
}
-/*! \brief Create BSSMAP RESET ACK message
+/*! Create BSSMAP RESET ACK message
* \returns callee-allocated msgb with BSSMAP Reset ACK message */
struct msgb *gsm0808_create_reset_ack(void)
{
@@ -126,7 +126,7 @@ struct msgb *gsm0808_create_reset_ack(void)
return msg;
}
-/*! \brief Create BSSMAP Clear Complete message
+/*! Create BSSMAP Clear Complete message
* \returns callee-allocated msgb with BSSMAP Clear Complete message */
stru