From 87e4550585c643e97e0003119b254251ac5ed1d4 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Tue, 20 Jun 2017 00:17:59 +0200 Subject: 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 --- src/application.c | 8 ++--- src/backtrace.c | 6 ++-- src/bitcomp.c | 6 ++-- src/bits.c | 26 +++++++------- src/bitvec.c | 60 +++++++++++++++---------------- src/codec/gsm610.c | 2 +- src/codec/gsm620.c | 2 +- src/codec/gsm690.c | 4 +-- src/coding/gsm0503_coding.c | 76 +++++++++++++++++++-------------------- src/coding/gsm0503_interleaving.c | 46 ++++++++++++------------ src/coding/gsm0503_mapping.c | 2 +- src/coding/gsm0503_parity.c | 20 +++++------ src/coding/gsm0503_tables.c | 2 +- src/conv.c | 8 ++--- src/crc16.c | 4 +-- src/crcXXgen.c.tpl | 8 ++--- src/ctrl/control_if.c | 12 +++---- src/ctrl/fsm_ctrl_commands.c | 2 +- src/fsm.c | 28 +++++++-------- src/gb/gprs_bssgp_bss.c | 28 +++++++-------- src/gb/gprs_ns.c | 38 ++++++++++---------- src/gsm/a5.c | 26 +++++++------- src/gsm/abis_nm.c | 64 ++++++++++++++++----------------- src/gsm/auth_core.c | 18 +++++----- src/gsm/comp128.c | 6 ++-- src/gsm/comp128v23.c | 6 ++-- src/gsm/gan.c | 2 +- src/gsm/gea.c | 4 +-- src/gsm/gprs_cipher_core.c | 2 +- src/gsm/gprs_rlc.c | 2 +- src/gsm/gsm0341.c | 2 +- src/gsm/gsm0411_smc.c | 2 +- src/gsm/gsm0411_utils.c | 20 +++++------ src/gsm/gsm0808.c | 46 ++++++++++++------------ src/gsm/gsm0808_utils.c | 28 +++++++-------- src/gsm/gsm48.c | 50 +++++++++++++------------- src/gsm/gsm48_ie.c | 70 ++++++++++++++++++------------------ src/gsm/gsm_04_08_gprs.c | 18 +++++----- src/gsm/gsm_utils.c | 46 ++++++++++++------------ src/gsm/gsup.c | 2 +- src/gsm/ipa.c | 6 ++-- src/gsm/lapd_core.c | 4 +-- src/gsm/lapdm.c | 32 ++++++++--------- src/gsm/oap.c | 6 ++-- src/gsm/rsl.c | 40 ++++++++++----------- src/gsm/sysinfo.c | 10 +++--- src/gsm/tlv_parser.c | 14 ++++---- src/gsmtap_util.c | 22 ++++++------ src/logging.c | 66 +++++++++++++++++----------------- src/logging_gsmtap.c | 4 +-- src/logging_syslog.c | 4 +-- src/loggingrb.c | 10 +++--- src/macaddr.c | 8 ++--- src/msgb.c | 26 +++++++------- src/panic.c | 6 ++-- src/plugin.c | 4 +-- src/prim.c | 4 +-- src/rate_ctr.c | 20 +++++------ src/select.c | 14 ++++---- src/sercomm.c | 22 ++++++------ src/serial.c | 10 +++--- src/signal.c | 8 ++--- src/sim/core.c | 2 +- src/socket.c | 22 ++++++------ src/stat_item.c | 14 ++++---- src/strrb.c | 12 +++---- src/timer.c | 22 ++++++------ src/timer_gettimeofday.c | 4 +-- src/utils.c | 32 ++++++++--------- src/vty/command.c | 26 +++++++------- src/vty/fsm_vty.c | 8 ++--- src/vty/logging_vty.c | 2 +- src/vty/stats_vty.c | 4 +-- src/vty/telnet_interface.c | 10 +++--- src/vty/utils.c | 6 ++-- src/vty/vector.c | 2 +- src/vty/vty.c | 28 +++++++-------- src/write_queue.c | 10 +++--- 78 files changed, 673 insertions(+), 673 deletions(-) (limited to 'src') diff --git a/src/application.c b/src/application.c index 8f37c938..e7c8e0f9 100644 --- a/src/application.c +++ b/src/application.c @@ -22,7 +22,7 @@ */ /*! \file application.c - * \brief Routines for helping with the osmocom application setup. + * Routines for helping with the osmocom application setup. */ /*! \mainpage libosmocore Documentation @@ -90,7 +90,7 @@ static void sighup_hdlr(int signal) log_targets_reopen(); } -/*! \brief Ignore \ref SIGPIPE, \ref SIGALRM, \ref SIGHUP and \ref SIGIO */ +/*! Ignore \ref SIGPIPE, \ref SIGALRM, \ref SIGHUP and \ref SIGIO */ void osmo_init_ignore_signals(void) { /* Signals that by default would terminate */ @@ -106,7 +106,7 @@ void osmo_init_ignore_signals(void) #endif } -/*! \brief Initialize the osmocom logging framework +/*! Initialize the osmocom logging framework * \param[in] log_info Array of available logging sub-systems * \returns 0 on success, -1 in case of error * @@ -125,7 +125,7 @@ int osmo_init_logging(const struct log_info *log_info) return 0; } -/*! \brief Turn the current process into a background daemon +/*! Turn the current process into a background daemon * * This function will fork the process, exit the parent and set umask, * create a new session, close stdin/stdout/stderr and chdir to /tmp diff --git a/src/backtrace.c b/src/backtrace.c index 6cd798c5..0240a758 100644 --- a/src/backtrace.c +++ b/src/backtrace.c @@ -21,7 +21,7 @@ */ /*! \file backtrace.c - * \brief Routines realted to generating call back traces + * Routines realted to generating call back traces */ #include @@ -60,7 +60,7 @@ static void _osmo_backtrace(int use_printf, int subsys, int level) free(strings); } -/*! \brief Generate and print a call back-trace +/*! Generate and print a call back-trace * * This function will generate a function call back-trace of the * current process and print it to stdout. */ @@ -69,7 +69,7 @@ void osmo_generate_backtrace(void) _osmo_backtrace(1, 0, 0); } -/*! \brief Generate and log a call back-trace +/*! Generate and log a call back-trace * \param[in] subsys Logging sub-system * \param[in] level Logging level * diff --git a/src/bitcomp.c b/src/bitcomp.c index 9c01246b..acf165e0 100644 --- a/src/bitcomp.c +++ b/src/bitcomp.c @@ -25,7 +25,7 @@ */ /*! \file bitcomp.c - * \brief Osmocom bit compression routines + * Osmocom bit compression routines */ #include @@ -222,7 +222,7 @@ static const unsigned t4_make_up[2][15] = { } }; -/*! \brief Make-up codes for a given length +/*! Make-up codes for a given length * * \return Return proper make-up code word for an uninterrupted * sequence of b bits of length len according to modified ITU-T T.4 @@ -307,7 +307,7 @@ static inline int t4_rle(struct bitvec *bv, unsigned len, bool b) return bitvec_set_uint(bv, t4_term[b][len], t4_term_length[b][len]); } -/*! \brief encode bit vector in-place using T4 encoding +/*! encode bit vector in-place using T4 encoding * Assumes MSB first encoding. * \param[in] bv bit vector to be encoded * \return color code (if the encoding started with 0 or 1) or -1 on diff --git a/src/bits.c b/src/bits.c index fe92f933..45ac8e24 100644 --- a/src/bits.c +++ b/src/bits.c @@ -26,13 +26,13 @@ /*! \addtogroup bits * @{ - * \brief Osmocom bit level support code + * Osmocom bit level support code */ /*! \file bits.c */ -/*! \brief convert unpacked bits to packed bits, return length in bytes +/*! convert unpacked bits to packed bits, return length in bytes * \param[out] out output buffer of packed bits * \param[in] in input buffer of unpacked bits * \param[in] num_bits number of bits @@ -60,7 +60,7 @@ int osmo_ubit2pbit(pbit_t *out, const ubit_t *in, unsigned int num_bits) return outptr - out; } -/*! \brief Shift unaligned input to octet-aligned output +/*! Shift unaligned input to octet-aligned output * \param[out] out output buffer, unaligned * \param[in] in input buffer, octet-aligned * \param[in] num_nibbles number of nibbles @@ -87,7 +87,7 @@ void osmo_nibble_shift_right(uint8_t *out, const uint8_t *in, out[i] = (in[i - 1] & 0xF) << 4; } -/*! \brief Shift unaligned input to octet-aligned output +/*! Shift unaligned input to octet-aligned output * \param[out] out output buffer, octet-aligned * \param[in] in input buffer, unaligned * \param[in] num_nibbles number of nibbles @@ -108,7 +108,7 @@ void osmo_nibble_shift_left_unal(uint8_t *out, const uint8_t *in, out[i] = (in[i] & 0xF) << 4; } -/*! \brief convert unpacked bits to soft bits +/*! convert unpacked bits to soft bits * \param[out] out output buffer of soft bits * \param[in] in input buffer of unpacked bits * \param[in] num_bits number of bits @@ -120,7 +120,7 @@ void osmo_ubit2sbit(sbit_t *out, const ubit_t *in, unsigned int num_bits) out[i] = in[i] ? -127 : 127; } -/*! \brief convert soft bits to unpacked bits +/*! convert soft bits to unpacked bits * \param[out] out output buffer of unpacked bits * \param[in] in input buffer of soft bits * \param[in] num_bits number of bits @@ -132,7 +132,7 @@ void osmo_sbit2ubit(ubit_t *out, const sbit_t *in, unsigned int num_bits) out[i] = in[i] < 0; } -/*! \brief convert packed bits to unpacked bits, return length in bytes +/*! convert packed bits to unpacked bits, return length in bytes * \param[out] out output buffer of unpacked bits * \param[in] in input buffer of packed bits * \param[in] num_bits number of bits @@ -174,7 +174,7 @@ int osmo_pbit2ubit(ubit_t *out, const pbit_t *in, unsigned int num_bits) return cur - out; } -/*! \brief convert unpacked bits to packed bits (extended options) +/*! convert unpacked bits to packed bits (extended options) * \param[out] out output buffer of packed bits * \param[in] out_ofs offset into output buffer * \param[in] in input buffer of unpacked bits @@ -199,7 +199,7 @@ int osmo_ubit2pbit_ext(pbit_t *out, unsigned int out_ofs, return ((out_ofs + num_bits - 1) >> 3) + 1; } -/*! \brief convert packed bits to unpacked bits (extended options) +/*! convert packed bits to unpacked bits (extended options) * \param[out] out output buffer of unpacked bits * \param[in] out_ofs offset into output buffer * \param[in] in input buffer of packed bits @@ -221,7 +221,7 @@ int osmo_pbit2ubit_ext(ubit_t *out, unsigned int out_ofs, return out_ofs + num_bits; } -/*! \brief generalized bit reversal function +/*! generalized bit reversal function * \param[in] x the 32bit value to be reversed * \param[in] k the type of reversal requested * \returns the reversed 32bit dword @@ -242,7 +242,7 @@ uint32_t osmo_bit_reversal(uint32_t x, enum osmo_br_mode k) return x; } -/*! \brief reverse the bit-order in each byte of a dword +/*! reverse the bit-order in each byte of a dword * \param[in] x 32bit input value * \returns 32bit value where bits of each byte have been reversed * @@ -257,7 +257,7 @@ uint32_t osmo_revbytebits_32(uint32_t x) return x; } -/*! \brief reverse the bit order in a byte +/*! reverse the bit order in a byte * \param[in] x 8bit input value * \returns 8bit value where bits order has been reversed * @@ -272,7 +272,7 @@ uint32_t osmo_revbytebits_8(uint8_t x) return x; } -/*! \brief reverse bit-order of each byte in a buffer +/*! reverse bit-order of each byte in a buffer * \param[in] buf buffer containing bytes to be bit-reversed * \param[in] len length of buffer in bytes * diff --git a/src/bitvec.c b/src/bitvec.c index 41e4f64c..8ed7296a 100644 --- a/src/bitvec.c +++ b/src/bitvec.c @@ -24,7 +24,7 @@ /*! \addtogroup bitvec * @{ - * \brief Osmocom bit vector abstraction + * Osmocom bit vector abstraction */ /*! \file bitvec.c */ @@ -71,7 +71,7 @@ static uint8_t bitval2mask(enum bit_value bit, uint8_t bitnum) return bitval; } -/*! \brief check if the bit is 0 or 1 for a given position inside a bitvec +/*! check if the bit is 0 or 1 for a given position inside a bitvec * \param[in] bv the bit vector on which to check * \param[in] bitnr the bit number inside the bit vector to check * \return value of the requested bit @@ -93,7 +93,7 @@ enum bit_value bitvec_get_bit_pos(const struct bitvec *bv, unsigned int bitnr) return ZERO; } -/*! \brief check if the bit is L or H for a given position inside a bitvec +/*! check if the bit is L or H for a given position inside a bitvec * \param[in] bv the bit vector on which to check * \param[in] bitnr the bit number inside the bit vector to check * \return value of the requested bit @@ -116,7 +116,7 @@ enum bit_value bitvec_get_bit_pos_high(const struct bitvec *bv, return L; } -/*! \brief get the Nth set bit inside the bit vector +/*! get the Nth set bit inside the bit vector * \param[in] bv the bit vector to use * \param[in] n the bit number to get * \returns the bit number (offset) of the Nth set bit in \a bv @@ -136,7 +136,7 @@ unsigned int bitvec_get_nth_set_bit(const struct bitvec *bv, unsigned int n) return 0; } -/*! \brief set a bit at given position in a bit vector +/*! set a bit at given position in a bit vector * \param[in] bv bit vector on which to operate * \param[in] bitnr number of bit to be set * \param[in] bit value to which the bit is to be set @@ -163,7 +163,7 @@ inline int bitvec_set_bit_pos(struct bitvec *bv, unsigned int bitnr, return 0; } -/*! \brief set the next bit inside a bitvec +/*! set the next bit inside a bitvec * \param[in] bv bit vector to be used * \param[in] bit value of the bit to be set * \returns 0 on success, negative value on error @@ -179,7 +179,7 @@ inline int bitvec_set_bit(struct bitvec *bv, enum bit_value bit) return rc; } -/*! \brief get the next bit (low/high) inside a bitvec +/*! get the next bit (low/high) inside a bitvec * \return value of th next bit in the vector */ int bitvec_get_bit_high(struct bitvec *bv) { @@ -192,7 +192,7 @@ int bitvec_get_bit_high(struct bitvec *bv) return rc; } -/*! \brief set multiple bits (based on array of bitvals) at current pos +/*! set multiple bits (based on array of bitvals) at current pos * \param[in] bv bit vector * \param[in] bits array of \ref bit_value * \param[in] count number of bits to set @@ -210,7 +210,7 @@ int bitvec_set_bits(struct bitvec *bv, const enum bit_value *bits, unsigned int return 0; } -/*! \brief set multiple bits (based on numeric value) at current pos +/*! set multiple bits (based on numeric value) at current pos * \return 0 in case of success; negative in case of error */ int bitvec_set_uint(struct bitvec *bv, unsigned int ui, unsigned int num_bits) { @@ -228,7 +228,7 @@ int bitvec_set_uint(struct bitvec *bv, unsigned int ui, unsigned int num_bits) return 0; } -/*! \brief get multiple bits (num_bits) from beginning of vector (MSB side) +/*! get multiple bits (num_bits) from beginning of vector (MSB side) * \return 16bit signed integer retrieved from bit vector */ int16_t bitvec_get_int16_msb(const struct bitvec *bv, unsigned int num_bits) { @@ -241,7 +241,7 @@ int16_t bitvec_get_int16_msb(const struct bitvec *bv, unsigned int num_bits) return osmo_load16be(bv->data) >> (16 - num_bits); } -/*! \brief get multiple bits (based on numeric value) from current pos +/*! get multiple bits (based on numeric value) from current pos * \return integer value retrieved from bit vector */ int bitvec_get_uint(struct bitvec *bv, unsigned int num_bits) { @@ -260,7 +260,7 @@ int bitvec_get_uint(struct bitvec *bv, unsigned int num_bits) return ui; } -/*! \brief fill num_bits with \fill starting from the current position +/*! fill num_bits with \fill starting from the current position * \return 0 on success; negative otherwise (out of vector boundary) */ int bitvec_fill(struct bitvec *bv, unsigned int num_bits, enum bit_value fill) @@ -273,7 +273,7 @@ int bitvec_fill(struct bitvec *bv, unsigned int num_bits, enum bit_value fill) return 0; } -/*! \brief pad all remaining bits up to num_bits +/*! pad all remaining bits up to num_bits * \return 0 on success; negative otherwise */ int bitvec_spare_padding(struct bitvec *bv, unsigned int up_to_bit) { @@ -284,7 +284,7 @@ int bitvec_spare_padding(struct bitvec *bv, unsigned int up_to_bit) return bitvec_fill(bv, n, L); } -/*! \brief find first bit set in bit vector +/*! find first bit set in bit vector * \return 0 on success; negative otherwise */ int bitvec_find_bit_pos(const struct bitvec *bv, unsigned int n, enum bit_value val) @@ -299,7 +299,7 @@ int bitvec_find_bit_pos(const struct bitvec *bv, unsigned int n, return -1; } -/*! \brief get multiple bytes from current pos +/*! get multiple bytes from current pos * Assumes MSB first encoding. * \param[in] bv bit vector * \param[in] bytes array @@ -335,7 +335,7 @@ int bitvec_get_bytes(struct bitvec *bv, uint8_t *bytes, unsigned int count) return 0; } -/*! \brief set multiple bytes at current pos +/*! set multiple bytes at current pos * Assumes MSB first encoding. * \param[in] bv bit vector * \param[in] bytes array @@ -375,7 +375,7 @@ int bitvec_set_bytes(struct bitvec *bv, const uint8_t *bytes, unsigned int count return 0; } -/*! \brief Allocate a bit vector +/*! Allocate a bit vector * \param[in] size Number of bits in the vector * \param[in] ctx Context from which to allocate * \return pointer to allocated vector; NULL in case of error */ @@ -396,7 +396,7 @@ struct bitvec *bitvec_alloc(unsigned int size, TALLOC_CTX *ctx) return bv; } -/*! \brief Free a bit vector (release its memory) +/*! Free a bit vector (release its memory) * \param[in] bit vector to free */ void bitvec_free(struct bitvec *bv) { @@ -404,7 +404,7 @@ void bitvec_free(struct bitvec *bv) talloc_free(bv); } -/*! \brief Export a bit vector to a buffer +/*! Export a bit vector to a buffer * \param[in] bitvec (unpacked bits) * \param[out] buffer for the unpacked bits * \return number of bytes (= bits) copied */ @@ -417,7 +417,7 @@ unsigned int bitvec_pack(const struct bitvec *bv, uint8_t *buffer) return i; } -/*! \brief Copy buffer of unpacked bits into bit vector +/*! Copy buffer of unpacked bits into bit vector * \param[in] buffer unpacked input bits * \param[out] bv unpacked bit vector * \return number of bytes (= bits) copied */ @@ -430,7 +430,7 @@ unsigned int bitvec_unpack(struct bitvec *bv, const uint8_t *buffer) return i; } -/*! \brief read hexadecimap string into a bit vector +/*! read hexadecimap string into a bit vector * \param[in] src string containing hex digits * \param[out] bv unpacked bit vector * \return 0 in case of success; 1 in case of error @@ -451,7 +451,7 @@ int bitvec_unhex(struct bitvec *bv, const char *src) return 0; } -/*! \brief read part of the vector +/*! read part of the vector * \param[in] bv The boolean vector to work on * \param[in,out] read_index Where reading supposed to start in the vector * \param[in] len How many bits to read from vector @@ -475,7 +475,7 @@ uint64_t bitvec_read_field(struct bitvec *bv, unsigned int *read_index, unsigned return ui; } -/*! \brief write into the vector +/*! write into the vector * \param[in] bv The boolean vector to work on * \param[in,out] write_index Where writing supposed to start in the vector * \param[in] len How many bits to write @@ -498,7 +498,7 @@ int bitvec_write_field(struct bitvec *bv, unsigned int *write_index, uint64_t va return 0; } -/*! \brief convert enum to corresponding character +/*! convert enum to corresponding character * \param v input value (bit) * \return single character, either 0, 1, L or H */ char bit_value_to_char(enum bit_value v) @@ -512,7 +512,7 @@ char bit_value_to_char(enum bit_value v) } } -/*! \brief prints bit vector to provided string +/*! prints bit vector to provided string * It's caller's responsibility to ensure that we won't shoot him in the foot: * the provided buffer should be at lest cur_bit + 1 bytes long */ @@ -551,14 +551,14 @@ static inline unsigned leading_bits(uint8_t x, bool b) } return 7; } -/*! \brief force bit vector to all 0 and current bit to the beginnig of the vector */ +/*! force bit vector to all 0 and current bit to the beginnig of the vector */ void bitvec_zero(struct bitvec *bv) { bv->cur_bit = 0; memset(bv->data, 0, bv->data_len); } -/*! \brief Return number (bits) of uninterrupted bit run in vector starting from the MSB +/*! Return number (bits) of uninterrupted bit run in vector starting from the MSB * \param[in] bv The boolean vector to work on * \param[in] b The boolean, sequence of which is looked at from the vector start * \returns Number of consecutive bits of \p b in \p bv @@ -574,7 +574,7 @@ unsigned bitvec_rl(const struct bitvec *bv, bool b) return bv->cur_bit; } -/*! \brief Return number (bits) of uninterrupted bit run in vector +/*! Return number (bits) of uninterrupted bit run in vector * starting from the current bit * \param[in] bv The boolean vector to work on * \param[in] b The boolean, sequence of 1's or 0's to be checked @@ -619,7 +619,7 @@ unsigned bitvec_rl_curbit(struct bitvec *bv, bool b, int max_bits) return (bv->cur_bit - readIndex + temp_res); } -/*! \brief Shifts bitvec to the left, n MSB bits lost */ +/*! Shifts bitvec to the left, n MSB bits lost */ void bitvec_shiftl(struct bitvec *bv, unsigned n) { if (0 == n) @@ -643,7 +643,7 @@ void bitvec_shiftl(struct bitvec *bv, unsigned n) bv->cur_bit -= n; } -/*! \brief Add given array to bitvec +/*! Add given array to bitvec * \param[in,out] bv bit vector to work with * \param[in] array elements to be added * \param[in] array_len length of array diff --git a/src/codec/gsm610.c b/src/codec/gsm610.c index c1eca0c3..df56583a 100644 --- a/src/codec/gsm610.c +++ b/src/codec/gsm610.c @@ -298,7 +298,7 @@ const uint16_t gsm610_bitorder[260] = { 29, /* LARc5:0 */ }; -/*! \brief Check whether RTP frame contains FR SID code word according to +/*! Check whether RTP frame contains FR SID code word according to * TS 101 318 §5.1.2 * \param[in] rtp_payload Buffer with RTP payload * \param[in] payload_len Length of payload diff --git a/src/codec/gsm620.c b/src/codec/gsm620.c index 7067239c..30647480 100644 --- a/src/codec/gsm620.c +++ b/src/codec/gsm620.c @@ -272,7 +272,7 @@ static inline uint16_t mask(const uint8_t msb) return (m - 1) ^ m; } -/*! \brief Check whether RTP frame contains HR SID code word according to +/*! Check whether RTP frame contains HR SID code word according to * TS 101 318 §5.2.2 * \param[in] rtp_payload Buffer with RTP payload * \param[in] payload_len Length of payload diff --git a/src/codec/gsm690.c b/src/codec/gsm690.c index b273f0fe..74655bf4 100644 --- a/src/codec/gsm690.c +++ b/src/codec/gsm690.c @@ -235,7 +235,7 @@ const struct value_string osmo_amr_type_names[] = { { 0, NULL }, }; -/*! \brief Decode various AMR parameters from RTP payload (RFC 4867) acording to +/*! Decode various AMR parameters from RTP payload (RFC 4867) acording to * 3GPP TS 26.101 * \param[in] rtppayload Payload from RTP packet * \param[in] payload_len length of rtppayload @@ -284,7 +284,7 @@ int osmo_amr_rtp_dec(const uint8_t *rtppayload, int payload_len, uint8_t *cmr, return 2 + amr_len_by_ft[type]; } -/*! \brief Encode various AMR parameters from RTP payload (RFC 4867) +/*! Encode various AMR parameters from RTP payload (RFC 4867) * \param[out] payload Payload for RTP packet, contains speech data (if any) * except for have 2 first bytes where header will be built * \param[in] cmr AMR codec Mode Request diff --git a/src/coding/gsm0503_coding.c b/src/coding/gsm0503_coding.c index 1e70d2eb..bb86b2c7 100644 --- a/src/coding/gsm0503_coding.c +++ b/src/coding/gsm0503_coding.c @@ -94,7 +94,7 @@ /*! \addtogroup coding * @{ * - * \brief GSM TS 05.03 coding + * GSM TS 05.03 coding * * This module is the "master module" of libosmocoding. It uses the * various other modules (mapping, parity, interleaving) in order to @@ -137,49 +137,49 @@ /* TS 101318 Chapter 5.3: 244 bits + 4bit sig */ #define GSM_EFR_BYTES 31 -/*! \brief union across the three different EGPRS Uplink header types */ +/*! union across the three different EGPRS Uplink header types */ union gprs_rlc_ul_hdr_egprs { struct gprs_rlc_ul_header_egprs_1 type1; struct gprs_rlc_ul_header_egprs_2 type2; struct gprs_rlc_ul_header_egprs_3 type3; }; -/*! \brief union across the three different EGPRS Downlink header types */ +/*! union across the three different EGPRS Downlink header types */ union gprs_rlc_dl_hdr_egprs { struct gprs_rlc_dl_header_egprs_1 type1; struct gprs_rlc_dl_header_egprs_2 type2; struct gprs_rlc_dl_header_egprs_3 type3; }; -/*! \brief Structure describing a Modulation and Coding Scheme */ +/*! Structure describing a Modulation and Coding Scheme */ struct gsm0503_mcs_code { - /*! \brief Modulation and Coding Scheme (MSC) number */ + /*! Modulation and Coding Scheme (MSC) number */ uint8_t mcs; - /*! \brief Length of Uplink Stealing Flag (USF) in bits */ + /*! Length of Uplink Stealing Flag (USF) in bits */ uint8_t usf_len; /* Header coding */ - /*! \brief Length of header (bits) */ + /*! Length of header (bits) */ uint8_t hdr_len; - /*! \brief Length of header convolutional code */ + /*! Length of header convolutional code */ uint8_t hdr_code_len; - /*! \brief Length of header code puncturing sequence */ + /*! Length of header code puncturing sequence */ uint8_t hdr_punc_len; - /*! \brief header convolutional code */ + /*! header convolutional code */ const struct osmo_conv_code *hdr_conv; - /*! \brief header puncturing sequence */ + /*! header puncturing sequence */ const uint8_t *hdr_punc; /* Data coding */ - /*! \brief length of data (bits) */ + /*! length of data (bits) */ uint16_t data_len; - /*! \brief length of data convolutional code */ + /*! length of data convolutional code */ uint16_t data_code_len; - /*! \brief length of data code puncturing sequence */ + /*! length of data code puncturing sequence */ uint16_t data_punc_len; - /*! \brief data convolutional code */ + /*! data convolutional code */ const struct osmo_conv_code *data_conv; - /*! \brief data puncturing sequences */ + /*! data puncturing sequences */ const uint8_t *data_punc[3]; }; @@ -534,7 +534,7 @@ const struct gsm0503_mcs_code gsm0503_mcs_dl_codes[EGPRS_NUM_MCS] = { }, }; -/*! \brief Convolutional Decode + compute BER +/*! Convolutional Decode + compute BER * \param[in] code Description of Convolutional Code * \param[in] input Input soft-bits (-127...127) * \param[out] output bits @@ -571,7 +571,7 @@ static int osmo_conv_decode_ber(const struct osmo_conv_code *code, return res; } -/*! \brief convenience wrapper for decoding coded bits +/*! convenience wrapper for decoding coded bits * \param[out] l2_data caller-allocated buffer for L2 Frame * \param[in] cB 456 coded (soft) bits as per TS 05.03 4.1.3 * \param[out] n_errors Number of detected errors @@ -596,7 +596,7 @@ static int _xcch_decode_cB(uint8_t *l2_data, const sbit_t *cB, return 0; } -/*! \brief convenience wrapper for encoding to coded bits +/*! convenience wrapper for encoding to coded bits * \param[out] cB caller-allocated buffer for 456 coded bits as per TS 05.03 4.1.3 * \param[out] l2_data to-be-encoded L2 Frame * \returns 0 */ @@ -617,7 +617,7 @@ static int _xcch_encode_cB(ubit_t *cB, const uint8_t *l2_data) * GSM xCCH block transcoding */ -/*! \brief Decoding of xCCH data from bursts to L2 frame +/*! Decoding of xCCH data from bursts to L2 frame * \param[out] l2_data caller-allocated output data buffer * \param[in] bursts four GSM bursts in soft-bits * \param[out] n_errors Number of detected errors @@ -637,7 +637,7 @@ int gsm0503_xcch_decode(uint8_t *l2_data, const sbit_t *bursts, return _xcch_decode_cB(l2_data, cB, n_errors, n_bits_total); } -/*! \brief Encoding of xCCH data from L2 frame to bursts +/*! Encoding of xCCH data from L2 frame to bursts * \param[out] bursts caller-allocated burst data (unpacked bits) * \param[in] l2_data L2 input data (MAC block) * \returns 0 @@ -904,7 +904,7 @@ static int egprs_decode_data(uint8_t *l2_data, const sbit_t *c, return OSMO_BYTES_FOR_BITS(code->hdr_len + code->data_len); } -/*! \brief Decode EGPRS UL message +/*! Decode EGPRS UL message * 1. Header section decoding * 2. Extract CPS settings * 3. Burst unmapping and deinterleaving @@ -986,7 +986,7 @@ int gsm0503_pdtch_egprs_decode(uint8_t *l2_data, const sbit_t *bursts, uint16_t * GSM PDTCH block transcoding */ -/*! \brief Decode GPRS PDTCH +/*! Decode GPRS PDTCH * \param[out] l2_data caller-allocated buffer for L2 Frame * \param[in] bursts burst input data as soft unpacked bits * \param[out] usf_p uplink stealing flag @@ -1303,7 +1303,7 @@ static int egprs_parse_dl_cps(struct egprs_cps *cps, return egprs_get_cps(cps, type, bits); } -/*! \brief EGPRS DL message encoding +/*! EGPRS DL message encoding * \param[out] bursts caller-allocated buffer for unpacked burst bits * \param[in] l2_data L2 (MAC) block to be encoded * \param[in] l2_len length of l2_data in bytes, used to determine MCS @@ -1398,7 +1398,7 @@ bad_header: return -1; } -/*! \brief GPRS DL message encoding +/*! GPRS DL message encoding * \param[out] bursts caller-allocated buffer for unpacked burst bits * \param[in] l2_data L2 (MAC) block to be encoded * \param[in] l2_len length of l2_data in bytes, used to determine CS @@ -1487,7 +1487,7 @@ int gsm0503_pdtch_encode(ubit_t *bursts, const uint8_t *l2_data, uint8_t l2_len) * GSM TCH/F FR/EFR transcoding */ -/*! \brief assemble a FR codec frame in format as used inside RTP +/*! assemble a FR codec frame in format as used inside RTP * \param[out] tch_data Codec frame in RTP format * \param[in] b_bits Codec frame in 'native' format * \param[in] net_order FIXME */ @@ -1772,7 +1772,7 @@ static void tch_amr_unmerge(ubit_t *d, ubit_t *p, const ubit_t *u, int len, int memcpy(d + prot, u + prot + 6, len - prot); } -/*! \brief Perform channel decoding of a FR/EFR channel according TS 05.03 +/*! Perform channel decoding of a FR/EFR channel according TS 05.03 * \param[out] tch_data Codec frame in RTP payload format * \param[in] bursts buffer containing the symbols of 8 bursts * \param[in] net_order FIXME @@ -1858,7 +1858,7 @@ int gsm0503_tch_fr_decode(uint8_t *tch_data, const sbit_t *bursts, return len; } -/*! \brief Perform channel encoding on a TCH/FS channel according to TS 05.03 +/*! Perform channel encoding on a TCH/FS channel according to TS 05.03 * \param[out] bursts caller-allocated output buffer for bursts bits * \param[in] tch_data Codec input data in RTP payload format * \param[in] len Length of \a tch_data in bytes @@ -1922,7 +1922,7 @@ coding_efr_fr: return 0; } -/*! \brief Perform channel decoding of a HR(v1) channel according TS 05.03 +/*! Perform channel decoding of a HR(v1) channel according TS 05.03 * \param[out] tch_data Codec frame in RTP payload format * \param[in] bursts buffer containing the symbols of 8 bursts * \param[in] odd Odd (1) or even (0) frame number @@ -1999,7 +1999,7 @@ int gsm0503_tch_hr_decode(uint8_t *tch_data, const sbit_t *bursts, int odd, return 15; } -/*! \brief Perform channel encoding on a TCH/HS channel according to TS 05.03 +/*! Perform channel encoding on a TCH/HS channel according to TS 05.03 * \param[out] bursts caller-allocated output buffer for bursts bits * \param[in] tch_data Codec input data in RTP payload format * \param[in] len Length of \a tch_data in bytes @@ -2059,7 +2059,7 @@ int gsm0503_tch_hr_encode(ubit_t *bursts, const uint8_t *tch_data, int len) return 0; } -/*! \brief Perform channel decoding of a TCH/AFS channel according TS 05.03 +/*! Perform channel decoding of a TCH/AFS channel according TS 05.03 * \param[out] tch_data Codec frame in RTP payload format * \param[in] bursts buffer containing the symbols of 8 bursts * \param[in] codec_mode_req is this CMR (1) or CMC (0) @@ -2265,7 +2265,7 @@ int gsm0503_tch_afs_decode(uint8_t *tch_data, const sbit_t *bursts, return len; } -/*! \brief Perform channel encoding on a TCH/AFS channel according to TS 05.03 +/*! Perform channel encoding on a TCH/AFS channel according to TS 05.03 * \param[out] bursts caller-allocated output buffer for bursts bits * \param[in] tch_data Codec input data in RTP payload format * \param[in] len Length of \a tch_data in bytes @@ -2435,7 +2435,7 @@ invalid_length: return -1; } -/*! \brief Perform channel decoding of a TCH/AFS channel according TS 05.03 +/*! Perform channel decoding of a TCH/AFS channel according TS 05.03 * \param[out] tch_data Codec frame in RTP payload format * \param[in] bursts buffer containing the symbols of 8 bursts * \param[in] odd Is this an odd (1) or even (0) frame number? @@ -2650,7 +2650,7 @@ int gsm0503_tch_ahs_decode(uint8_t *tch_data, const sbit_t *bursts, int odd, return len; } -/*! \brief Perform channel encoding on a TCH/AHS channel according to TS 05.03 +/*! Perform channel encoding on a TCH/AHS channel according to TS 05.03 * \param[out] bursts caller-allocated output buffer for bursts bits * \param[in] tch_data Codec input data in RTP payload format * \param[in] len Length of \a tch_data in bytes @@ -2834,7 +2834,7 @@ static int rach_apply_bsic(ubit_t *d, uint8_t bsic) return 0; } -/*! \brief Decode the (8-bit) RACH according to TS 05.03 +/*! Decode the (8-bit) RACH according to TS 05.03 * \param[out] ra output buffer for RACH data * \param[in] burst Input burst data * \param[in] bsic BSIC used in this cell @@ -2857,7 +2857,7 @@ int gsm0503_rach_decode(uint8_t *ra, const sbit_t *burst, uint8_t bsic) return 0; } -/*! \brief Encode the (8-bit) RACH according to TS 05.03 +/*! Encode the (8-bit) RACH according to TS 05.03 * \param[out] burst Caller-allocated output burst buffer * \param[in] ra Input RACH data * \param[in] bsic BSIC used in this cell @@ -2881,7 +2881,7 @@ int gsm0503_rach_encode(ubit_t *burst, const uint8_t *ra, uint8_t bsic) * GSM SCH transcoding */ -/*! \brief Decode the SCH according to TS 05.03 +/*! Decode the SCH according to TS 05.03 * \param[out] sb_info output buffer for SCH data * \param[in] burst Input burst data * \returns 0 on success; negative on error (e.g. CRC error) */ @@ -2901,7 +2901,7 @@ int gsm0503_sch_decode(uint8_t *sb_info, const sbit_t *burst) return 0; } -/*! \brief Encode the SCH according to TS 05.03 +/*! Encode the SCH according to TS 05.03 * \param[out] burst Caller-allocated output burst buffer * \param[in] sb_info Input SCH data * \returns 0 on success; negative on error */ diff --git a/src/coding/gsm0503_interleaving.c b/src/coding/gsm0503_interleaving.c index cd47cffc..19e68474 100644 --- a/src/coding/gsm0503_interleaving.c +++ b/src/coding/gsm0503_interleaving.c @@ -29,7 +29,7 @@ /*! \addtogroup interleaving * @{ - * \brief GSM TS 05.03 interleaving + * GSM TS 05.03 interleaving * * This module contains interleaving / de-interleaving routines for * various channel types, as defined in 3GPP TS 05.03 / 45.003 @@ -59,7 +59,7 @@ * Where hl(B) and hn(B) are bits in burst B indicating flags. */ -/*! \brief De-Interleave burst bits according to TS 05.03 4.1.4 +/*! De-Interleave burst bits according to TS 05.03 4.1.4 * \param[out] cB caller-allocated output buffer for 456 soft coded bits * \param[in] iB 456 soft input bits */ void gsm0503_xcch_deinterleave(sbit_t *cB, const sbit_t *iB) @@ -73,7 +73,7 @@ void gsm0503_xcch_deinterleave(sbit_t *cB, const sbit_t *iB) } } -/*! \brief Interleave burst bits according to TS 05.03 4.1.4 +/*! Interleave burst bits according to TS 05.03 4.1.4 * \param[out] iB caller-allocated output buffer for 456 soft interleaved bits * \param[in] cB 456 soft input coded bits */ void gsm0503_xcch_interleave(const ubit_t *cB, ubit_t *iB) @@ -87,7 +87,7 @@ void gsm0503_xcch_interleave(const ubit_t *cB, ubit_t *iB) } } -/*! \brief De-Interleave MCS1 DL burst bits according to TS 05.03 5.1.5.1.5 +/*! De-Interleave MCS1 DL burst bits according to TS 05.03 5.1.5.1.5 * \param[out] u caller-allocated output buffer for 12 soft coded bits * \param[out] hc caller-allocated output buffer for 68 soft coded bits * \param[out] dc caller-allocated output buffer for 372 soft coded bits @@ -128,7 +128,7 @@ void gsm0503_mcs1_dl_deinterleave(sbit_t *u, sbit_t *hc, } } -/*! \brief Interleave MCS1 DL burst bits according to TS 05.03 5.1.5.1.5 +/*! Interleave MCS1 DL burst bits according to TS 05.03 5.1.5.1.5 * \param[in] up 12 input soft coded bits (usf) * \param[in] hc 68 input soft coded bits (header) * \param[in] dc 372 input soft bits (data) @@ -166,7 +166,7 @@ void gsm0503_mcs1_dl_interleave(const ubit_t *up, const ubit_t *hc, gsm0503_xcch_interleave(cp, iB); } -/*! \brief Interleave MCS1 UL burst bits according to TS 05.03 5.1.5.2.4 +/*! Interleave MCS1 UL burst bits according to TS 05.03 5.1.5.2.4 * \param[out] hc caller-allocated output buffer for 80 soft coded header bits * \param[out] dc caller-allocated output buffer for 372 soft coded data bits * \param[in] iB 456 interleaved soft input bits */ @@ -200,7 +200,7 @@ void gsm0503_mcs1_ul_deinterleave(sbit_t *hc, sbit_t *dc, const sbit_t *iB) } } -/*! \brief Interleave MCS1 DL burst bits according to TS 05.03 5.1.5.2.4 +/*! Interleave MCS1 DL burst bits according to TS 05.03 5.1.5.2.4 * \param[in] hc 80 input coded bits (header) * \param[in] dc 372 input bits (data) * \param[out] iB 456 interleaved output bits */ @@ -234,7 +234,7 @@ void gsm0503_mcs1_ul_interleave(const ubit_t *hc, const ubit_t *dc, ubit_t *iB) gsm0503_xcch_interleave(cp, iB); } -/*! \brief Interleave MCS5 UL burst bits according to TS 05.03 5.1.9.2.4 +/*! Interleave MCS5 UL burst bits according to TS 05.03 5.1.9.2.4 * \param[in] hc 136 soft coded header input bits * \param[in] dc 1248 soft coded data input bits * \param[out] hi 136 interleaved header output bits @@ -257,7 +257,7 @@ void gsm0503_mcs5_ul_interleave(const ubit_t *hc, const ubit_t *dc, } } -/*! \brief De-Interleave MCS5 UL burst bits according to TS 05.03 5.1.9.2.4 +/*! De-Interleave MCS5 UL burst bits according to TS 05.03 5.1.9.2.4 * \param[out] hc caller-allocated output buffer for 136 soft coded header bits * \param[out] dc caller-allocated output buffer for 1248 soft coded data bits * \param[in] iB interleaved soft input bits */ @@ -283,7 +283,7 @@ void gsm0503_mcs5_ul_deinterleave(sbit_t *hc, sbit_t *dc, } } -/*! \brief Interleave MCS5 DL burst bits according to TS 05.03 5.1.9.1.5 +/*! Interleave MCS5 DL burst bits according to TS 05.03 5.1.9.1.5 * \param[in] hc 100 soft coded header input bits * \param[in] dc 1248 soft coded data input bits * \param[out] hi 100 interleaved header output bits @@ -306,7 +306,7 @@ void gsm0503_mcs5_dl_interleave(const ubit_t *hc, const ubit_t *dc, } } -/*! \brief De-Interleave MCS5 UL burst bits according to TS 05.03 5.1.9.1.5 +/*! De-Interleave MCS5 UL burst bits according to TS 05.03 5.1.9.1.5 * \param[out] hc caller-allocated output buffer for 100 soft coded header bits * \param[out] dc caller-allocated output buffer for 1248 soft coded data bits * \param[in] iB interleaved soft input bits */ @@ -332,7 +332,7 @@ void gsm0503_mcs5_dl_deinterleave(sbit_t *hc, sbit_t *dc, } } -/*! \brief Interleave MCS7 DL burst bits according to TS 05.03 5.1.11.1.5 +/*! Interleave MCS7 DL burst bits according to TS 05.03 5.1.11.1.5 * \param[in] hc 124 soft coded header input bits * \param[in] c1 612 soft coded data input bits * \param[in] c2 612 soft coded data input bits @@ -361,7 +361,7 @@ void gsm0503_mcs7_dl_interleave(const ubit_t *hc, const ubit_t *c1, } } -/*! \brief De-Interleave MCS7 DL burst bits according to TS 05.03 5.1.11.1.5 +/*! De-Interleave MCS7 DL burst bits according to TS 05.03 5.1.11.1.5 * \param[out] hc caller-allocated output buffer for 124 soft coded header bits * \param[out] c1 caller-allocated output buffer for 612 soft coded data bits * \param[out] c2 caller-allocated output buffer for 612 soft coded data bits @@ -394,7 +394,7 @@ void gsm0503_mcs7_dl_deinterleave(sbit_t *hc, sbit_t *c1, sbit_t *c2, } } -/*! \brief Interleave MCS7 UL burst bits according to TS 05.03 5.1.11.2.4 +/*! Interleave MCS7 UL burst bits according to TS 05.03 5.1.11.2.4 * \param[in] hc 124 soft coded header input bits * \param[in] c1 612 soft coded data input bits * \param[in] c2 612 soft coded data input bits @@ -423,7 +423,7 @@ void gsm0503_mcs7_ul_interleave(const ubit_t *hc, const ubit_t *c1, } } -/*! \brief De-Interleave MCS7 UL burst bits according to TS 05.03 5.1.11.2.4 +/*! De-Interleave MCS7 UL burst bits according to TS 05.03 5.1.11.2.4 * \param[out] hc caller-allocated output buffer for 160 soft coded header bits * \param[out] c1 caller-allocated output buffer for 612 soft coded data bits * \param[out] c2 caller-allocated output buffer for 612 soft coded data bits @@ -456,7 +456,7 @@ void gsm0503_mcs7_ul_deinterleave(sbit_t *hc, sbit_t *c1, sbit_t *c2, } } -/*! \brief Interleave MCS8 UL burst bits according to TS 05.03 5.1.12.2.4 +/*! Interleave MCS8 UL burst bits according to TS 05.03 5.1.12.2.4 * \param[in] hc 160 soft coded header input bits * \param[in] c1 612 soft coded data input bits * \param[in] c2 612 soft coded data input bits @@ -486,7 +486,7 @@ void gsm0503_mcs8_ul_interleave(const ubit_t *hc, const ubit_t *c1, } -/*! \brief De-Interleave MCS8 UL burst bits according to TS 05.03 5.1.12.2.4 +/*! De-Interleave MCS8 UL burst bits according to TS 05.03 5.1.12.2.4 * \param[out] hc caller-allocated output buffer for 160 soft coded header bits * \param[out] c1 caller-allocated output buffer for 612 soft coded data bits * \param[out] c2 caller-allocated output buffer for 612 soft coded data bits @@ -519,7 +519,7 @@ void gsm0503_mcs8_ul_deinterleave(sbit_t *hc, sbit_t *c1, sbit_t *c2, } } -/*! \brief Interleave MCS8 DL burst bits according to TS 05.03 5.1.12.1.5 +/*! Interleave MCS8 DL burst bits according to TS 05.03 5.1.12.1.5 * \param[in] hc 124 soft coded header input bits * \param[in] c1 612 soft coded data input bits * \param[in] c2 612 soft coded data input bits @@ -548,7 +548,7 @@ void gsm0503_mcs8_dl_interleave(const ubit_t *hc, const ubit_t *c1, } } -/*! \brief De-Interleave MCS8 DL burst bits according to TS 05.03 5.1.12.1.5 +/*! De-Interleave MCS8 DL burst bits according to TS 05.03 5.1.12.1.5 * \param[out] hc caller-allocated output buffer for 124 soft coded header bits * \param[out] c1 caller-allocated output buffer for 612 soft coded data bits * \param[out] c2 caller-allocated output buffer for 612 soft coded data bits @@ -605,7 +605,7 @@ void gsm0503_mcs8_dl_deinterleave(sbit_t *hc, sbit_t *c1, sbit_t *c2, * Where hl(B) and hn(B) are bits in burst B indicating flags. */ -/*! \brief GSM TCH FR/EFR/AFS De-Interleaving and burst mapping +/*! GSM TCH FR/EFR/AFS De-Interleaving and burst mapping * \param[out] cB caller-allocated buffer for 456 unpacked output bits * \param[in] iB 456 unpacked interleaved input bits */ void gsm0503_tch_fr_deinterleave(sbit_t *cB, const sbit_t *iB) @@ -619,7 +619,7 @@ void gsm0503_tch_fr_deinterleave(sbit_t *cB, const sbit_t *iB) } } -/*! \brief GSM TCH FR/EFR/AFS Interleaving and burst mapping +/*! GSM TCH FR/EFR/AFS Interleaving and burst mapping * \param[in] cB caller-allocated buffer for 456 unpacked input bits * \param[out] iB 456 unpacked interleaved output bits */ void gsm0503_tch_fr_interleave(const ubit_t *cB, ubit_t *iB) @@ -657,7 +657,7 @@ void gsm0503_tch_fr_interleave(const ubit_t *cB, ubit_t *iB) * Where hl(B) and hn(B) are bits in burst B indicating flags. */ -/*! \brief GSM TCH HR/AHS De-Interleaving and burst mapping +/*! GSM TCH HR/AHS De-Interleaving and burst mapping * \param[out] cB caller-allocated buffer for 228 unpacked output bits * \param[in] iB 228 unpacked interleaved input bits */ void gsm0503_tch_hr_deinterleave(sbit_t *cB, const sbit_t *iB) @@ -671,7 +671,7 @@ void gsm0503_tch_hr_deinterleave(sbit_t *cB, const sbit_t *iB) } } -/*! \brief GSM TCH HR/AHS Interleaving and burst mapping +/*! GSM TCH HR/AHS Interleaving and burst mapping * \param[in] cB caller-allocated buffer for 228 unpacked input bits * \param[out] iB 228 unpacked interleaved output bits */ void gsm0503_tch_hr_interleave(const ubit_t *cB, ubit_t *iB) diff --git a/src/coding/gsm0503_mapping.c b/src/coding/gsm0503_mapping.c index 82c049ce..15fd1b6e 100644 --- a/src/coding/gsm0503_mapping.c +++ b/src/coding/gsm0503_mapping.c @@ -28,7 +28,7 @@ /*! \addtogroup mapping * @{ * - * \brief GSM TS 05.03 burst mapping + * GSM TS 05.03 burst mapping * * This module contains burst mapping routines as specified in 3GPP TS * 05.03 / 45.003. diff --git a/src/coding/gsm0503_parity.c b/src/coding/gsm0503_parity.c index 171feb46..cc817024 100644 --- a/src/coding/gsm0503_parity.c +++ b/src/coding/gsm0503_parity.c @@ -27,7 +27,7 @@ /*! \addtogroup parity * @{ * - * \brief GSM TS 05.03 parity + * GSM TS 05.03 parity * * This module contains parity/crc code definitions for the various * parity/crc schemes as defined in 3GPP TS 05.03 / 45.003 @@ -35,7 +35,7 @@ /*! \file gsm0503_parity.c */ -/*! \brief GSM (SACCH) parity (FIRE code) +/*! GSM (SACCH) parity (FIRE code) * * g(x) = (x^23 + 1)(x^17 + x^3 + 1) * = x^40 + x^26 + x^23 + x^17 + x^3 + a1 @@ -47,7 +47,7 @@ const struct osmo_crc64gen_code gsm0503_fire_crc40 = { .remainder = 0xffffffffffULL, }; -/*! \brief GSM PDTCH CS-2, CS-3, CS-4 parity +/*! GSM PDTCH CS-2, CS-3, CS-4 parity * * g(x) = x^16 + x^12 + x^5 + 1 */ @@ -58,7 +58,7 @@ const struct osmo_crc16gen_code gsm0503_cs234_crc16 = { .remainder = 0xffff, }; -/*! \brief EDGE MCS header parity +/*! EDGE MCS header parity * */ const struct osmo_crc8gen_code gsm0503_mcs_crc8_hdr = { @@ -68,7 +68,7 @@ const struct osmo_crc8gen_code gsm0503_mcs_crc8_hdr = { .remainder = 0xff, }; -/*! \brief EDGE MCS data parity +/*! EDGE MCS data parity * */ const struct osmo_crc16gen_code gsm0503_mcs_crc12 = { @@ -78,7 +78,7 @@ const struct osmo_crc16gen_code gsm0503_mcs_crc12 = { .remainder = 0x0fff, }; -/*! \brief GSM RACH parity +/*! GSM RACH parity * * g(x) = x^6 + x^5 + x^3 + x^2 + x^1 + 1 */ @@ -89,7 +89,7 @@ const struct osmo_crc8gen_code gsm0503_rach_crc6 = { .remainder = 0x3f, }; -/*! \brief GSM SCH parity +/*! GSM SCH parity * * g(x) = x^10 + x^8 + x^6 + x^5 + x^4 + x^2 + 1 */ @@ -100,7 +100,7 @@ const struct osmo_crc16gen_code gsm0503_sch_crc10 = { .remainder = 0x3ff, }; -/*! \brief GSM TCH FR/HR/EFR parity +/*! GSM TCH FR/HR/EFR parity * * g(x) = x^3 + x + 1 */ @@ -111,7 +111,7 @@ const struct osmo_crc8gen_code gsm0503_tch_fr_crc3 = { .remainder = 0x7, }; -/*! \brief GSM TCH EFR parity +/*! GSM TCH EFR parity * * g(x) = x^8 + x^4 + x^3 + x^2 + 1 */ @@ -122,7 +122,7 @@ const struct osmo_crc8gen_code gsm0503_tch_efr_crc8 = { .remainder = 0x00, }; -/*! \brief GSM AMR parity +/*! GSM AMR parity * * g(x) = x^6 + x^5 + x^3 + x^2 + x^1 + 1 */ diff --git a/src/coding/gsm0503_tables.c b/src/coding/gsm0503_tables.c index 1c85765d..32d12eae 100644 --- a/src/coding/gsm0503_tables.c +++ b/src/coding/gsm0503_tables.c @@ -27,7 +27,7 @@ /*! \addtogroup tables * @{ * - * \brief GSM TS 05.03 tables + * GSM TS 05.03 tables * * This module contains various tables defining parts of 3GPP TS 05.03 * / 45.003, primarily for the purpose of (de)puncturing, interleaving, diff --git a/src/conv.c b/src/conv.c index b81e37ef..38ce173a 100644 --- a/src/conv.c +++ b/src/conv.c @@ -24,7 +24,7 @@ /*! \addtogroup conv * @{ - * \brief Osmocom convolutional encoder and decoder + * Osmocom convolutional encoder and decoder */ /*! \file conv.c */ @@ -78,7 +78,7 @@ osmo_conv_get_output_length(const struct osmo_conv_code *code, int len) /* Encoding */ /* ------------------------------------------------------------------------ */ -/*! \brief Initialize a convolutional encoder +/*! Initialize a convolutional encoder * \param[in,out] encoder Encoder state to initialize * \param[in] code Description of convolutional code */ @@ -198,7 +198,7 @@ osmo_conv_encode_flush(struct osmo_conv_encoder *encoder, return o_idx; } -/*! \brief All-in-one convolutional encoding function +/*! All-in-one convolutional encoding function * \param[in] code description of convolutional code to be used * \param[in] input array of unpacked bits (uncoded) * \param[out] output array of unpacked bits (encoded) @@ -593,7 +593,7 @@ osmo_conv_decode_get_output(struct osmo_conv_decoder *decoder, return min_ae; } -/*! \brief All-in-one convolutional decoding function +/*! All-in-one convolutional decoding function * \param[in] code description of convolutional code to be used * \param[in] input array of soft bits (coded) * \param[out] output array of unpacked bits (decoded) diff --git a/src/crc16.c b/src/crc16.c index accb0b45..7d523b65 100644 --- a/src/crc16.c +++ b/src/crc16.c @@ -10,7 +10,7 @@ #include -/*! \brief CRC table for the CRC-16. The poly is 0x8005 (x^16 + x^15 + x^2 + 1) */ +/*! CRC table for the CRC-16. The poly is 0x8005 (x^16 + x^15 + x^2 + 1) */ uint16_t const osmo_crc16_table[256] = { 0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241, 0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440, @@ -46,7 +46,7 @@ uint16_t const osmo_crc16_table[256] = { 0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040 }; -/*! \brief compute the CRC-16 for the data buffer +/*! compute the CRC-16 for the data buffer * \param crc[in] previous CRC value * \param buffer[in] data pointer * \param len[in] number of bytes in input \ref buffer diff --git a/src/crcXXgen.c.tpl b/src/crcXXgen.c.tpl index 1a69e852..9c63052d 100644 --- a/src/crcXXgen.c.tpl +++ b/src/crcXXgen.c.tpl @@ -24,7 +24,7 @@ /*! \addtogroup crcgen * @{ - * \brief Osmocom generic CRC routines + * Osmocom generic CRC routines */ /*! \file crcXXgen.c @@ -37,7 +37,7 @@ #include -/*! \brief Compute the CRC value of a given array of hard-bits +/*! Compute the CRC value of a given array of hard-bits * \param[in] code The CRC code description to apply * \param[in] in Array of hard bits * \param[in] len Length of the array of hard bits @@ -69,7 +69,7 @@ osmo_crcXXgen_compute_bits(const struct osmo_crcXXgen_code *code, } -/*! \brief Checks the CRC value of a given array of hard-bits +/*! Checks the CRC value of a given array of hard-bits * \param[in] code The CRC code description to apply * \param[in] in Array of hard bits * \param[in] len Length of the array of hard bits @@ -95,7 +95,7 @@ osmo_crcXXgen_check_bits(const struct osmo_crcXXgen_code *code, } -/*! \brief Computes and writes the CRC value of a given array of bits +/*! Computes and writes the CRC value of a given array of bits * \param[in] code The CRC code description to apply * \param[in] in Array of hard bits * \param[in] len Length of the array of hard bits diff --git a/src/ctrl/control_if.c b/src/ctrl/control_if.c index 5a84f7c0..5d04cdfd 100644 --- a/src/ctrl/control_if.c +++ b/src/ctrl/control_if.c @@ -126,7 +126,7 @@ int ctrl_cmd_send(struct osmo_wqueue *queue, struct ctrl_cmd *cmd) return ret; } -/*! \brief Send TRAP over given Control Interface +/*! Send TRAP over given Control Interface * \param[in] ctrl Control Interface over which TRAP will be sent * \param[in] name Name of the TRAP variable * \param[in] value Value of the TRAP variable @@ -401,7 +401,7 @@ static int control_write_cb(struct osmo_fd *bfd, struct msgb *msg) return rc; } -/*! \brief Allocate CTRL connection +/*! Allocate CTRL connection * \param[in] ctx Context from which talloc should allocate it * \param[in] data caller's private data parameter which should assigned to write queue's file descriptor data parameter. @@ -729,7 +729,7 @@ err: return -1; } -/*! \brief Allocate a CTRL interface handle +/*! Allocate a CTRL interface handle * \param[in] ctx Tallo callocation context to be used * \param[in] data Pointer which will be made available to each set_..() get_..() verify_..() control command function @@ -754,7 +754,7 @@ struct ctrl_handle *ctrl_handle_alloc(void *ctx, void *data, ctrl_cmd_lookup loo return ctrl; } -/*! \brief Setup CTRL interface on a given address +/*! Setup CTRL interface on a given address * \param[in] data Pointer which will be made available to each set_..() get_..() verify_..() control command function * \param[in] bind_addr Address on which CTRL socket shall listen @@ -788,7 +788,7 @@ struct ctrl_handle *ctrl_interface_setup_dynip(void *data, return ctrl; } -/*! \brief Install a lookup helper function for control nodes +/*! Install a lookup helper function for control nodes * This function is used by e.g. library code to install lookup helpers * for additional nodes in the control interface. * \param[in] lookup The lookup helper function @@ -813,7 +813,7 @@ int ctrl_lookup_register(ctrl_cmd_lookup lookup) return 0; } -/*! \brief Helper for "local execution" of a CTRL command from a string +/*! Helper for "local execution" of a CTRL command from a string * The function will parse + execute the given control command string * and return a corresponding ctrl_cmd. Caller is responsible to * talloc_free() the return value. diff --git a/src/ctrl/fsm_ctrl_commands.c b/src/ctrl/fsm_ctrl_commands.c index 95d5fca6..6c3ecde1 100644 --- a/src/ctrl/fsm_ctrl_commands.c +++ b/src/ctrl/fsm_ctrl_commands.c @@ -6,7 +6,7 @@ #include #include -/*! \brief control interface lookup function for FSM's +/*! control interface lookup function for FSM's * \param[in] data Private data passed to controlif_setup() * \param[in] vline Vector of the line holding the command string * \param[out] node_type type (CTRL_NODE_) that was determined diff --git a/src/fsm.c b/src/fsm.c index 16f5d654..27389a7d 100644 --- a/src/fsm.c +++ b/src/fsm.c @@ -30,7 +30,7 @@ /*! \addtogroup fsm * @{ - * \brief Finite State Machine abstraction + * Finite State Machine abstraction * * This is a generic C-language abstraction for implementing finite * state machines within the Osmocom framework. It is intended to @@ -89,7 +89,7 @@ LLIST_HEAD(osmo_g_fsms); static bool fsm_log_addr = true; -/*! \brief specify if FSM instance addresses should be logged or not +/*! specify if FSM instance addresses should be logged or not * * By default, the FSM name includes the pointer address of the \ref * osmo_fsm_inst. This behavior can be disabled (and re-enabled) @@ -136,7 +136,7 @@ struct osmo_fsm_inst *osmo_fsm_inst_find_by_id(const struct osmo_fsm *fsm, return NULL; } -/*! \brief register a FSM with the core +/*! register a FSM with the core * * A FSM descriptor needs to be registered with the core before any * instances can be created for it. @@ -154,7 +154,7 @@ int osmo_fsm_register(struct osmo_fsm *fsm) return 0; } -/*! \brief unregister a FSM from the core +/*! unregister a FSM from the core * * Once the FSM descriptor is unregistered, active instances can still * use it, but no new instances may be created for it. @@ -190,7 +190,7 @@ static void fsm_tmr_cb(void *data) osmo_fsm_inst_term(fi, OSMO_FSM_TERM_TIMEOUT, &T); } -/*! \brief allocate a new instance of a specified FSM +/*! allocate a new instance of a specified FSM * \param[in] fsm Descriptor of the FSM * \param[in] ctx talloc context from which to allocate memory * \param[in] priv private data reference store in fsm instance @@ -231,7 +231,7 @@ struct osmo_fsm_inst *osmo_fsm_inst_alloc(struct osmo_fsm *fsm, void *ctx, void return fi; } -/*! \brief allocate a new instance of a specified FSM as child of +/*! allocate a new instance of a specified FSM as child of * other FSM instance * * This is like \ref osmo_fsm_inst_alloc but using the parent FSM as @@ -265,7 +265,7 @@ struct osmo_fsm_inst *osmo_fsm_inst_alloc_child(struct osmo_fsm *fsm, return fi; } -/*! \brief delete a given instance of a FSM +/*! delete a given instance of a FSM * \param[in] fsm The FSM to be un-registered and deleted */ void osmo_fsm_inst_free(struct osmo_fsm_inst *fi) @@ -276,7 +276,7 @@ void osmo_fsm_inst_free(struct osmo_fsm_inst *fi) talloc_free(fi); } -/*! \brief get human-readable name of FSM event +/*! get human-readable name of FSM event * \param[in] fsm FSM descriptor of event * \param[in] event Event integer value * \returns string rendering of the event @@ -291,7 +291,7 @@ const char *osmo_fsm_event_name(struct osmo_fsm *fsm, uint32_t event) return get_value_string(fsm->event_names, event); } -/*! \brief get human-readable name of FSM instance +/*! get human-readable name of FSM instance * \param[in] fi FSM instance * \returns string rendering of the FSM identity */ @@ -306,7 +306,7 @@ const char *osmo_fsm_inst_name(struct osmo_fsm_inst *fi) return fi->fsm->name; } -/*! \brief get human-readable name of FSM instance +/*! get human-readable name of FSM instance * \param[in] fsm FSM descriptor * \param[in] state FSM state number * \returns string rendering of the FSM state @@ -321,7 +321,7 @@ const char *osmo_fsm_state_name(struct osmo_fsm *fsm, uint32_t state) return fsm->states[state].name; } -/*! \brief perform a state change of the given FSM instance +/*! perform a state change of the given FSM instance * * Best invoke via the osmo_fsm_inst_state_chg() macro which logs the source * file where the state change was effected. Alternatively, you may pass \a @@ -384,7 +384,7 @@ int _osmo_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t new_state, return 0; } -/*! \brief dispatch an event to an osmocom finite state machine instance +/*! dispatch an event to an osmocom finite state machine instance * * Best invoke via the osmo_fsm_inst_dispatch() macro which logs the source * file where the event was effected. Alternatively, you may pass \a file as @@ -438,7 +438,7 @@ int _osmo_fsm_inst_dispatch(struct osmo_fsm_inst *fi, uint32_t event, void *data return 0; } -/*! \brief Terminate FSM instance with given cause +/*! Terminate FSM instance with given cause * * This safely terminates the given FSM instance by first iterating * over all children and sending them a termination event. Next, it @@ -489,7 +489,7 @@ void _osmo_fsm_inst_term(struct osmo_fsm_inst *fi, file, line); } -/*! \brief Terminate all child FSM instances of an FSM instance. +/*! Terminate all child FSM instances of an FSM instance. * * Iterate over all children and send them a termination event, with the given * cause. Pass OSMO_FSM_TERM_PARENT to avoid dispatching events from the diff --git a/src/gb/gprs_bssgp_bss.c b/src/gb/gprs_bssgp_bss.c index 93af98f3..f41c4a4f 100644 --- a/src/gb/gprs_bssgp_bss.c +++ b/src/gb/gprs_bssgp_bss.c @@ -41,7 +41,7 @@ uint8_t *bssgp_msgb_tlli_put(struct msgb *msg, uint32_t tlli) return msgb_tvlv_put(msg, BSSGP_IE_TLLI, 4, (uint8_t *) &_tlli); } -/*! \brief GMM-SUSPEND.req (Chapter 10.3.6) */ +/*! GMM-SUSPEND.req (Chapter 10.3.6) */ int bssgp_tx_suspend(uint16_t nsei, uint32_t tlli, const struct gprs_ra_id *ra_id) { @@ -64,7 +64,7 @@ int bssgp_tx_suspend(uint16_t nsei, uint32_t tlli, return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief GMM-RESUME.req (Chapter 10.3.9) */ +/*! GMM-RESUME.req (Chapter 10.3.9) */ int bssgp_tx_resume(uint16_t nsei, uint32_t tlli, const struct gprs_ra_id *ra_id, uint8_t suspend_ref) { @@ -89,7 +89,7 @@ int bssgp_tx_resume(uint16_t nsei, uint32_t tlli, return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief Transmit RA-CAPABILITY-UPDATE (10.3.3) */ +/*! Transmit RA-CAPABILITY-UPDATE (10.3.3) */ int bssgp_tx_ra_capa_upd(struct bssgp_bvc_ctx *bctx, uint32_t tlli, uint8_t tag) { struct msgb *msg = bssgp_msgb_alloc(); @@ -139,7 +139,7 @@ static int common_tx_radio_status2(struct msgb *msg, uint8_t cause) return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief Transmit RADIO-STATUS for TLLI (10.3.5) */ +/*! Transmit RADIO-STATUS for TLLI (10.3.5) */ int bssgp_tx_radio_status_tlli(struct bssgp_bvc_ctx *bctx, uint8_t cause, uint32_t tlli) { @@ -153,7 +153,7 @@ int bssgp_tx_radio_status_tlli(struct bssgp_bvc_ctx *bctx, uint8_t cause, return common_tx_radio_status2(msg, cause); } -/*! \brief Transmit RADIO-STATUS for TMSI (10.3.5) */ +/*! Transmit RADIO-STATUS for TMSI (10.3.5) */ int bssgp_tx_radio_status_tmsi(struct bssgp_bvc_ctx *bctx, uint8_t cause, uint32_t tmsi) { @@ -168,7 +168,7 @@ int bssgp_tx_radio_status_tmsi(struct bssgp_bvc_ctx *bctx, uint8_t cause, return common_tx_radio_status2(msg, cause); } -/*! \brief Transmit RADIO-STATUS for IMSI (10.3.5) */ +/*! Transmit RADIO-STATUS for IMSI (10.3.5) */ int bssgp_tx_radio_status_imsi(struct bssgp_bvc_ctx *bctx, uint8_t cause, const char *imsi) { @@ -187,7 +187,7 @@ int bssgp_tx_radio_status_imsi(struct bssgp_bvc_ctx *bctx, uint8_t cause, return common_tx_radio_status2(msg, cause); } -/*! \brief Transmit FLUSH-LL-ACK (Chapter 10.4.2) */ +/*! Transmit FLUSH-LL-ACK (Chapter 10.4.2) */ int bssgp_tx_flush_ll_ack(struct bssgp_bvc_ctx *bctx, uint32_t tlli, uint8_t action, uint16_t bvci_new, uint32_t num_octets) @@ -211,7 +211,7 @@ int bssgp_tx_flush_ll_ack(struct bssgp_bvc_ctx *bctx, uint32_t tlli, return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief Transmit LLC-DISCARDED (Chapter 10.4.3) */ +/*! Transmit LLC-DISCARDED (Chapter 10.4.3) */ int bssgp_tx_llc_discarded(struct bssgp_bvc_ctx *bctx, uint32_t tlli, uint8_t num_frames, uint32_t num_octets) { @@ -237,7 +237,7 @@ int bssgp_tx_llc_discarded(struct bssgp_bvc_ctx *bctx, uint32_t tlli, return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief Transmit a BVC-BLOCK message (Chapter 10.4.8) */ +/*! Transmit a BVC-BLOCK message (Chapter 10.4.8) */ int bssgp_tx_bvc_block(struct bssgp_bvc_ctx *bctx, uint8_t cause) { struct msgb *msg = bssgp_msgb_alloc(); @@ -258,7 +258,7 @@ int bssgp_tx_bvc_block(struct bssgp_bvc_ctx *bctx, uint8_t cause) return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief Transmit a BVC-UNBLOCK message (Chapter 10.4.10) */ +/*! Transmit a BVC-UNBLOCK message (Chapter 10.4.10) */ int bssgp_tx_bvc_unblock(struct bssgp_bvc_ctx *bctx) { struct msgb *msg = bssgp_msgb_alloc(); @@ -277,7 +277,7 @@ int bssgp_tx_bvc_unblock(struct bssgp_bvc_ctx *bctx) return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief Transmit a BVC-RESET message (Chapter 10.4.12) */ +/*! Transmit a BVC-RESET message (Chapter 10.4.12) */ int bssgp_tx_bvc_reset(struct bssgp_bvc_ctx *bctx, uint16_t bvci, uint8_t cause) { struct msgb *msg = bssgp_msgb_alloc(); @@ -304,7 +304,7 @@ int bssgp_tx_bvc_reset(struct bssgp_bvc_ctx *bctx, uint16_t bvci, uint8_t cause) return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief Transmit a FLOW_CONTROL-BVC (Chapter 10.4.4) +/*! Transmit a FLOW_CONTROL-BVC (Chapter 10.4.4) * \param[in] bctx BVC Context * \param[in] tag Additional tag to identify acknowledge * \param[in] bucket_size Maximum bucket size in octets @@ -376,7 +376,7 @@ int bssgp_tx_fc_bvc(struct bssgp_bvc_ctx *bctx, uint8_t tag, return gprs_ns_sendmsg(bssgp_nsi, msg); } -/*! \brief Transmit a FLOW_CONTROL-MS (Chapter 10.4.6) +/*! Transmit a FLOW_CONTROL-MS (Chapter 10.4.6) * \param[in] bctx BVC Context * \param[in] tlli TLLI to identify MS * \param[in] tag Additional tag to identify acknowledge @@ -421,7 +421,7 @@ int bssgp_tx_fc_ms(struct bssgp_bvc_ctx *bctx, uint32_t tlli, ui