diff options
| author | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-20 00:17:59 +0200 |
|---|---|---|
| committer | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-23 00:18:22 +0000 |
| commit | 87e4550585c643e97e0003119b254251ac5ed1d4 (patch) | |
| tree | 9287f66aba70e9253f4d62926c54dddeb492895e /include | |
| parent | 249fb71a2e124acb191b7cd4d2c3af6a45da4a5e (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 'include')
59 files changed, 885 insertions, 885 deletions
diff --git a/include/osmocom/codec/codec.h b/include/osmocom/codec/codec.h index 05da911e..3e9b6881 100644 --- a/include/osmocom/codec/codec.h +++ b/include/osmocom/codec/codec.h @@ -42,7 +42,7 @@ enum osmo_amr_quality { AMR_GOOD = 1 }; -/*! \brief Check if given AMR Frame Type is a speech frame +/*! Check if given AMR Frame Type is a speech frame * \param[in] ft AMR Frame Type * \returns true if AMR with given Frame Type contains voice, false otherwise */ diff --git a/include/osmocom/coding/gsm0503_coding.h b/include/osmocom/coding/gsm0503_coding.h index 2f0e6315..a9c59e47 100644 --- a/include/osmocom/coding/gsm0503_coding.h +++ b/include/osmocom/coding/gsm0503_coding.h @@ -8,7 +8,7 @@ */ /*! \file gsm0503_coding.h - * \brief GSM TS 05.03 coding + * GSM TS 05.03 coding */ #define GSM0503_GPRS_BURSTS_NBITS (116 * 4) diff --git a/include/osmocom/coding/gsm0503_interleaving.h b/include/osmocom/coding/gsm0503_interleaving.h index a5d25ed5..1463fb38 100644 --- a/include/osmocom/coding/gsm0503_interleaving.h +++ b/include/osmocom/coding/gsm0503_interleaving.h @@ -7,7 +7,7 @@ */ /*! \file gsm0503_interleaving.h - * \brief GSM TS 05.03 interleaving + * GSM TS 05.03 interleaving */ void gsm0503_xcch_deinterleave(sbit_t *cB, const sbit_t *iB); diff --git a/include/osmocom/coding/gsm0503_mapping.h b/include/osmocom/coding/gsm0503_mapping.h index 6e139bf0..435c9131 100644 --- a/include/osmocom/coding/gsm0503_mapping.h +++ b/include/osmocom/coding/gsm0503_mapping.h @@ -7,7 +7,7 @@ */ /*! \file gsm0503_mapping.c - * \brief GSM TS 05.03 burst mapping + * GSM TS 05.03 burst mapping */ void gsm0503_xcch_burst_unmap(sbit_t *iB, const sbit_t *eB, diff --git a/include/osmocom/coding/gsm0503_parity.h b/include/osmocom/coding/gsm0503_parity.h index f844720b..2743bdb1 100644 --- a/include/osmocom/coding/gsm0503_parity.h +++ b/include/osmocom/coding/gsm0503_parity.h @@ -7,7 +7,7 @@ */ /*! \file gsm0503_parity.h - * \brief GSM TS 05.03 parity + * GSM TS 05.03 parity */ const struct osmo_crc64gen_code gsm0503_fire_crc40; diff --git a/include/osmocom/coding/gsm0503_tables.h b/include/osmocom/coding/gsm0503_tables.h index 4622cae7..f8c43c61 100644 --- a/include/osmocom/coding/gsm0503_tables.h +++ b/include/osmocom/coding/gsm0503_tables.h @@ -8,7 +8,7 @@ */ /*! \file gsm0503_tables.h - * \brief GSM TS 05.03 tables + * GSM TS 05.03 tables */ extern const ubit_t gsm0503_pdtch_hl_hn_ubit[4][8]; diff --git a/include/osmocom/core/application.h b/include/osmocom/core/application.h index ecaeaa8a..266fa9bb 100644 --- a/include/osmocom/core/application.h +++ b/include/osmocom/core/application.h @@ -2,16 +2,16 @@ /*! * \file application.h - * \brief Routines for helping with the osmocom application setup. + * Routines for helping with the osmocom application setup. */ -/*! \brief information containing the available logging subsystems */ +/*! information containing the available logging subsystems */ struct log_info; -/*! \brief one instance of a logging target (file, stderr, ...) */ +/*! one instance of a logging target (file, stderr, ...) */ struct log_target; -/*! \brief the default logging target, logging to stderr */ +/*! the default logging target, logging to stderr */ extern struct log_target *osmo_stderr_target; void osmo_init_ignore_signals(void); diff --git a/include/osmocom/core/bitXXgen.h.tpl b/include/osmocom/core/bitXXgen.h.tpl index 7480a8f4..6881d87d 100644 --- a/include/osmocom/core/bitXXgen.h.tpl +++ b/include/osmocom/core/bitXXgen.h.tpl @@ -22,7 +22,7 @@ #pragma once -/*! \brief load unaligned n-byte integer (little-endian encoding) into uintXX_t +/*! load unaligned n-byte integer (little-endian encoding) into uintXX_t * \param[in] p Buffer where integer is stored * \param[in] n Number of bytes stored in p * \returns XX bit unsigned integer @@ -36,7 +36,7 @@ static inline uintXX_t osmo_loadXXle_ext(const void *p, uint8_t n) return r; } -/*! \brief load unaligned n-byte integer (big-endian encoding) into uintXX_t +/*! load unaligned n-byte integer (big-endian encoding) into uintXX_t * \param[in] p Buffer where integer is stored * \param[in] n Number of bytes stored in p * \returns XX bit unsigned integer @@ -51,7 +51,7 @@ static inline uintXX_t osmo_loadXXbe_ext(const void *p, uint8_t n) } -/*! \brief store unaligned n-byte integer (little-endian encoding) from uintXX_t +/*! store unaligned n-byte integer (little-endian encoding) from uintXX_t * \param[in] x unsigned XX bit integer * \param[out] p Buffer to store integer * \param[in] n Number of bytes to store @@ -63,7 +63,7 @@ static inline void osmo_storeXXle_ext(uintXX_t x, void *p, uint8_t n) for(i = 0; i < n; q[i] = (x >> i * 8) & 0xFF, i++); } -/*! \brief store unaligned n-byte integer (big-endian encoding) from uintXX_t +/*! store unaligned n-byte integer (big-endian encoding) from uintXX_t * \param[in] x unsigned XX bit integer * \param[out] p Buffer to store integer * \param[in] n Number of bytes to store @@ -79,26 +79,26 @@ static inline void osmo_storeXXbe_ext(uintXX_t x, void *p, uint8_t n) /* Convenience function for most-used cases */ -/*! \brief load unaligned XX-bit integer (little-endian encoding) */ +/*! load unaligned XX-bit integer (little-endian encoding) */ static inline uintXX_t osmo_loadXXle(const void *p) { return osmo_loadXXle_ext(p, XX / 8); } -/*! \brief load unaligned XX-bit integer (big-endian encoding) */ +/*! load unaligned XX-bit integer (big-endian encoding) */ static inline uintXX_t osmo_loadXXbe(const void *p) { return osmo_loadXXbe_ext(p, XX / 8); } -/*! \brief store unaligned XX-bit integer (little-endian encoding) */ +/*! store unaligned XX-bit integer (little-endian encoding) */ static inline void osmo_storeXXle(uintXX_t x, void *p) { osmo_storeXXle_ext(x, p, XX / 8); } -/*! \brief store unaligned XX-bit integer (big-endian encoding) */ +/*! store unaligned XX-bit integer (big-endian encoding) */ static inline void osmo_storeXXbe(uintXX_t x, void *p) { osmo_storeXXbe_ext(x, p, XX / 8); diff --git a/include/osmocom/core/bitcomp.h b/include/osmocom/core/bitcomp.h index e87c0e10..a184a1cf 100644 --- a/include/osmocom/core/bitcomp.h +++ b/include/osmocom/core/bitcomp.h @@ -27,7 +27,7 @@ */ /*! \file bitcomp.h - * \brief Osmocom bit compression routines + * Osmocom bit compression routines */ #include <stdint.h> diff --git a/include/osmocom/core/bits.h b/include/osmocom/core/bits.h index 5535920e..61af716c 100644 --- a/include/osmocom/core/bits.h +++ b/include/osmocom/core/bits.h @@ -12,18 +12,18 @@ */ /*! \file bits.h - * \brief Osmocom bit level support code + * Osmocom bit level support code * * NOTE on the endianess of pbit_t: * Bits in a pbit_t are ordered MSB first, i.e. 0x80 is the first bit. * Bit i in a pbit_t array is array[i/8] & (1<<(7-i%8)) */ -typedef int8_t sbit_t; /*!< \brief soft bit (-127...127) */ -typedef uint8_t ubit_t; /*!< \brief unpacked bit (0 or 1) */ -typedef uint8_t pbit_t; /*!< \brief packed bis (8 bits in a byte) */ +typedef int8_t sbit_t; /*!< soft bit (-127...127) */ +typedef uint8_t ubit_t; /*!< unpacked bit (0 or 1) */ +typedef uint8_t pbit_t; /*!< packed bis (8 bits in a byte) */ -/*! \brief determine how many bytes we would need for \a num_bits packed bits +/*! determine how many bytes we would need for \a num_bits packed bits * \param[in] num_bits Number of packed bits * \returns number of bytes needed for \a num_bits packed bits */ @@ -81,31 +81,31 @@ int osmo_pbit2ubit_ext(ubit_t *out, unsigned int out_ofs, /* BIT REVERSAL */ -/*! \brief bit-reversal mode for osmo_bit_reversal() */ +/*! bit-reversal mode for osmo_bit_reversal() */ enum osmo_br_mode { - /*! \brief reverse all bits in a 32bit dword */ + /*! reverse all bits in a 32bit dword */ OSMO_BR_BITS_IN_DWORD = 31, - /*! \brief reverse byte order in a 32bit dword */ + /*! reverse byte order in a 32bit dword */ OSMO_BR_BYTES_IN_DWORD = 24, - /*! \brief reverse bits of each byte in a 32bit dword */ + /*! reverse bits of each byte in a 32bit dword */ OSMO_BR_BITS_IN_BYTE = 7, - /*! \brief swap the two 16bit words in a 32bit dword */ + /*! swap the two 16bit words in a 32bit dword */ OSMO_BR_WORD_SWAP = 16, }; -/*! \brief generic bit reversal function */ +/*! generic bit reversal function */ uint32_t osmo_bit_reversal(uint32_t x, enum osmo_br_mode k); -/* \brief reverse the bits within each byte of a 32bit word */ +/* reverse the bits within each byte of a 32bit word */ uint32_t osmo_revbytebits_32(uint32_t x); -/* \brief reverse the bits within a byte */ +/* reverse the bits within a byte */ uint32_t osmo_revbytebits_8(uint8_t x); -/* \brief reverse the bits of each byte in a given buffer */ +/* reverse the bits of each byte in a given buffer */ void osmo_revbytebits_buf(uint8_t *buf, int len); -/*! \brief left circular shift +/*! left circular shift * \param[in] in The 16 bit unsigned integer to be rotated * \param[in] shift Number of bits to shift \a in to, [0;16] bits * \returns shifted value diff --git a/include/osmocom/core/bitvec.h b/include/osmocom/core/bitvec.h index 6944770c..9187ce23 100644 --- a/include/osmocom/core/bitvec.h +++ b/include/osmocom/core/bitvec.h @@ -29,7 +29,7 @@ */ /*! \file bitvec.h - * \brief Osmocom bit vector abstraction + * Osmocom bit vector abstraction * * These functions assume a MSB (most significant bit) first layout of the * bits, so that for instance the 5 bit number abcde (a is MSB) can be @@ -44,22 +44,22 @@ #include <osmocom/core/talloc.h> #include <stdbool.h> -/*! \brief A single GSM bit +/*! A single GSM bit * * In GSM mac blocks, every bit can be 0 or 1, or L or H. L/H are * defined relative to the 0x2b padding pattern */ enum bit_value { - ZERO = 0, /*!< \brief A zero (0) bit */ - ONE = 1, /*!< \brief A one (1) bit */ - L = 2, /*!< \brief A CSN.1 "L" bit */ - H = 3, /*!< \brief A CSN.1 "H" bit */ + ZERO = 0, /*!< A zero (0) bit */ + ONE = 1, /*!< A one (1) bit */ + L = 2, /*!< A CSN.1 "L" bit */ + H = 3, /*!< A CSN.1 "H" bit */ }; -/*! \brief structure describing a bit vector */ +/*! structure describing a bit vector */ struct bitvec { - unsigned int cur_bit; /*!< \brief cursor to the next unused bit */ - unsigned int data_len; /*!< \brief length of data array in bytes */ - uint8_t *data; /*!< \brief pointer to data array */ + unsigned int cur_bit; /*!< cursor to the next unused bit */ + unsigned int data_len; /*!< length of data array in bytes */ + uint8_t *data; /*!< pointer to data array */ }; enum bit_value bitvec_get_bit_pos(const struct bitvec *bv, unsigned int bitnr); diff --git a/include/osmocom/core/byteswap.h b/include/osmocom/core/byteswap.h index 1f09c2b1..4274b8fb 100644 --- a/include/osmocom/core/byteswap.h +++ b/include/osmocom/core/byteswap.h @@ -2,7 +2,7 @@ #include <stdint.h> #include <osmocom/core/endian.h> -/*! \brief byte-swap a 32bit word +/*! byte-swap a 32bit word * \param[in] in to be swapped 32bit word * \returns byte-swapped 32bit word */ static inline uint32_t osmo_swab32(uint32_t in) @@ -17,7 +17,7 @@ static inline uint32_t osmo_swab32(uint32_t in) return out; } -/*! \brief byte-swap a 16bit word +/*! byte-swap a 16bit word * \param[in] in to be swapped 16bit word * \returns byte-swapped 16bit word */ static inline uint16_t osmo_swab16(uint16_t in) diff --git a/include/osmocom/core/conv.h b/include/osmocom/core/conv.h index e7f6bd6a..1888fe13 100644 --- a/include/osmocom/core/conv.h +++ b/include/osmocom/core/conv.h @@ -34,7 +34,7 @@ #include <osmocom/core/bits.h> -/*! \brief possibe termination types +/*! possibe termination types * * The termination type will determine which state the encoder/decoder * can start/end with. This is mostly taken care of in the high level API @@ -42,31 +42,31 @@ * proper calls yourself. */ enum osmo_conv_term { - CONV_TERM_FLUSH = 0, /*!< \brief Flush encoder state */ - CONV_TERM_TRUNCATION, /*!< \brief Direct truncation */ - CONV_TERM_TAIL_BITING, /*!< \brief Tail biting */ + CONV_TERM_FLUSH = 0, /*!< Flush encoder state */ + CONV_TERM_TRUNCATION, /*!< Direct truncation */ + CONV_TERM_TAIL_BITING, /*!< Tail biting */ }; -/*! \brief structure describing a given convolutional code +/*! structure describing a given convolutional code * * The only required fields are N,K and the next_output/next_state arrays. The * other can be left to default value of zero depending on what the code does. * If 'len' is left at 0 then only the low level API can be used. */ struct osmo_conv_code { - int N; /*!< \brief Inverse of code rate */ - int K; /*!< \brief Constraint length */ - int len; /*!< \brief # of data bits */ + int N; /*!< Inverse of code rate */ + int K; /*!< Constraint length */ + int len; /*!< # of data bits */ - enum osmo_conv_term term; /*!< \brief Termination type */ + enum osmo_conv_term term; /*!< Termination type */ - const uint8_t (*next_output)[2];/*!< \brief Next output array */ - const uint8_t (*next_state)[2]; /*!< \brief Next state array */ + const uint8_t (*next_output)[2];/*!< Next output array */ + const uint8_t (*next_state)[2]; /*!< Next state array */ - const uint8_t *next_term_output;/*!< \brief Flush termination output */ - const uint8_t *next_term_state; /*!< \brief Flush termination state */ + const uint8_t *next_term_output;/*!< Flush termination output */ + const uint8_t *next_term_state; /*!< Flush termination state */ - const int *puncture; /*!< \brief Punctured bits indexes */ + const int *puncture; /*!< Punctured bits indexes */ }; @@ -80,12 +80,12 @@ int osmo_conv_get_output_length(const struct osmo_conv_code *code, int len); /* Low level API */ -/*! \brief convolutional encoder state */ +/*! convolutional encoder state */ struct osmo_conv_encoder { - const struct osmo_conv_code *code; /*!< \brief for which code? */ - int i_idx; /*!< \brief Next input bit index */ - int p_idx; /*!< \brief Current puncture index */ - uint8_t state; /*!< \brief Current state */ + const struct osmo_conv_code *code; /*!< for which code? */ + int i_idx; /*!< Next input bit index */ + int p_idx; /*!< Current puncture index */ + uint8_t state; /*!< Current state */ }; void osmo_conv_encode_init(struct osmo_conv_encoder *encoder, @@ -105,20 +105,20 @@ int osmo_conv_encode(const struct osmo_conv_code *code, /* Low level API */ -/*! \brief convolutional decoder state */ +/*! convolutional decoder state */ struct osmo_conv_decoder { - const struct osmo_conv_code *code; /*!< \brief for which code? */ + const struct osmo_conv_code *code; /*!< for which code? */ - int n_states; /*!< \brief number of states */ + int n_states; /*!< number of states */ - int len; /*!< \brief Max o_idx (excl. termination) */ + int len; /*!< Max o_idx (excl. termination) */ - int o_idx; /*!< \brief output index */ - int p_idx; /*!< \brief puncture index */ + int o_idx; /*!< output index */ + int p_idx; /*!< puncture index */ - unsigned int *ae; /*!< \brief accumulated error */ - unsigned int *ae_next; /*!< \brief next accumulated error (tmp in scan) */ - uint8_t *state_history; /*!< \brief state history [len][n_states] */ + unsigned int *ae; /*!< accumulated error */ + unsigned int *ae_next; /*!< next accumulated error (tmp in scan) */ + uint8_t *state_history; /*!< state history [len][n_states] */ }; void osmo_conv_decode_init(struct osmo_conv_decoder *decoder, diff --git a/include/osmocom/core/crcXXgen.h.tpl b/include/osmocom/core/crcXXgen.h.tpl index 164f7201..47188090 100644 --- a/include/osmocom/core/crcXXgen.h.tpl +++ b/include/osmocom/core/crcXXgen.h.tpl @@ -35,12 +35,12 @@ #include <osmocom/core/bits.h> -/*! \brief structure describing a given CRC code of max XX bits */ +/*! structure describing a given CRC code of max XX bits */ struct osmo_crcXXgen_code { - int bits; /*!< \brief Actual number of bits of the CRC */ - uintXX_t poly; /*!< \brief Polynom (normal representation, MSB omitted */ - uintXX_t init; /*!< \brief Initialization value of the CRC state */ - uintXX_t remainder; /*!< \brief Remainder of the CRC (final XOR) */ + int bits; /*!< Actual number of bits of the CRC */ + uintXX_t poly; /*!< Polynom (normal representation, MSB omitted */ + uintXX_t init; /*!< Initialization value of the CRC state */ + uintXX_t remainder; /*!< Remainder of the CRC (final XOR) */ }; uintXX_t osmo_crcXXgen_compute_bits(const struct osmo_crcXXgen_code *code, diff --git a/include/osmocom/core/defs.h b/include/osmocom/core/defs.h index 51ac4e51..88c41b91 100644 --- a/include/osmocom/core/defs.h +++ b/include/osmocom/core/defs.h @@ -5,10 +5,10 @@ */ /*! \file defs.h - * \brief General definitions that are meant to be included from header files. + * General definitions that are meant to be included from header files. */ -/*! \brief Check for gcc and version. +/*! Check for gcc and version. * * \note Albeit glibc provides a features.h file that contains a similar * definition (__GNUC_PREREQ), this definition has been copied from there @@ -23,7 +23,7 @@ # define OSMO_GNUC_PREREQ(maj, min) 0 #endif -/*! \brief Set the deprecated attribute with a message. +/*! Set the deprecated attribute with a message. */ #if defined(__clang__) # define _OSMO_HAS_ATTRIBUTE_DEPRECATED __has_attribute(deprecated) diff --git a/include/osmocom/core/fsm.h b/include/osmocom/core/fsm.h index f42dd0c6..fb182f35 100644 --- a/include/osmocom/core/fsm.h +++ b/include/osmocom/core/fsm.h @@ -12,21 +12,21 @@ */ /*! \file fsm.h - * \brief Finite State Machine + * Finite State Machine */ struct osmo_fsm_inst; enum osmo_fsm_term_cause { - /*! \brief terminate because parent terminated */ + /*! terminate because parent terminated */ OSMO_FSM_TERM_PARENT, - /*! \brief terminate on explicit user request */ + /*! terminate on explicit user request */ OSMO_FSM_TERM_REQUEST, - /*! \brief regular termination of process */ + /*! regular termination of process */ OSMO_FSM_TERM_REGULAR, - /*! \brief erroneous termination of process */ + /*! erroneous termination of process */ OSMO_FSM_TERM_ERROR, - /*! \brief termination due to time-out */ + /*! termination due to time-out */ OSMO_FSM_TERM_TIMEOUT, }; @@ -37,80 +37,80 @@ static inline const char *osmo_fsm_term_cause_name(enum osmo_fsm_term_cause caus } -/*! \brief description of a rule in the FSM */ +/*! description of a rule in the FSM */ struct osmo_fsm_state { - /*! \brief bit-mask of permitted input events for this state */ + /*! bit-mask of permitted input events for this state */ uint32_t in_event_mask; - /*! \brief bit-mask to which other states this state may transiton */ + /*! bit-mask to which other states this state may transiton */ uint32_t out_state_mask; - /*! \brief human-readable name of this state */ + /*! human-readable name of this state */ const char *name; - /*! \brief function to be called for events arriving in this state */ + /*! function to be called for events arriving in this state */ void (*action)(struct osmo_fsm_inst *fi, uint32_t event, void *data); - /*! \brief function to be called just after entering the state */ + /*! function to be called just after entering the state */ void (*onenter)(struct osmo_fsm_inst *fi, uint32_t prev_state); - /*! \brief function to be called just before leaving the state */ + /*! function to be called just before leaving the state */ void (*onleave)(struct osmo_fsm_inst *fi, uint32_t next_state); }; -/*! \brief a description of an osmocom finite state machine */ +/*! a description of an osmocom finite state machine */ struct osmo_fsm { - /*! \brief global list */ + /*! global list */ struct llist_head list; - /*! \brief list of instances of this FSM */ + /*! list of instances of this FSM */ struct llist_head instances; - /*! \brief human readable name */ + /*! human readable name */ const char *name; - /*! \brief table of state transition rules */ + /*! table of state transition rules */ const struct osmo_fsm_state *states; - /*! \brief number of entries in \ref states */ + /*! number of entries in \ref states */ unsigned int num_states; - /*! \brief bit-mask of events permitted in all states */ + /*! bit-mask of events permitted in all states */ uint32_t allstate_event_mask; - /*! \brief function pointer to be called for allstate events */ + /*! function pointer to be called for allstate events */ void (*allstate_action)(struct osmo_fsm_inst *fi, uint32_t event, void *data); - /*! \brief clean-up function, called during termination */ + /*! clean-up function, called during termination */ void (*cleanup)(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause); - /*! \brief timer call-back for states with time-out. + /*! timer call-back for states with time-out. * \returns 1 to request termination, 0 to keep running. */ int (*timer_cb)(struct osmo_fsm_inst *fi); - /*! \brief logging sub-system for this FSM */ + /*! logging sub-system for this FSM */ int log_subsys; - /*! \brief human-readable names of events */ + /*! human-readable names of events */ const struct value_string *event_names; }; -/*! \brief a single instanceof an osmocom finite state machine */ +/*! a single instanceof an osmocom finite state machine */ struct osmo_fsm_inst { - /*! \brief member in the fsm->instances list */ + /*! member in the fsm->instances list */ struct llist_head list; - /*! \brief back-pointer to the FSM of which we are an instance */ + /*! back-pointer to the FSM of which we are an instance */ struct osmo_fsm *fsm; - /*! \brief human readable identifier */ + /*! human readable identifier */ const char *id; - /*! \brief human readable fully-qualified name */ + /*! human readable fully-qualified name */ const char *name; - /*! \brief some private data of this instance */ + /*! some private data of this instance */ void *priv; - /*! \brief logging level for this FSM */ + /*! logging level for this FSM */ int log_level; - /*! \brief current state of the FSM */ + /*! current state of the FSM */ uint32_t state; - /*! \brief timer number for states with time-out */ + /*! timer number for states with time-out */ int T; - /*! \brief timer back-end for states with time-out */ + /*! timer back-end for states with time-out */ struct osmo_timer_list timer; - /*! \brief support for fsm-based procedures */ + /*! support for fsm-based procedures */ struct { - /*! \brief the parent FSM that has created us */ + /*! the parent FSM that has created us */ struct osmo_fsm_inst *parent; - /*! \brief the event we should send upon termination */ + /*! the event we should send upon termination */ uint32_t parent_term_event; - /*! \brief a list of children processes */ + /*! a list of children processes */ struct llist_head children; - /*! \brief \ref llist_head linked to parent->proc.children */ + /*! \ref llist_head linked to parent->proc.children */ struct llist_head child; } proc; }; @@ -156,11 +156,11 @@ const char *osmo_fsm_event_name(struct osmo_fsm *fsm, uint32_t event); const char *osmo_fsm_inst_name(struct osmo_fsm_inst *fi); const char *osmo_fsm_state_name(struct osmo_fsm *fsm, uint32_t state); -/*! \brief return the name of the state the FSM instance is currently in. */ +/*! return the name of the state the FSM instance is currently in. */ static inline const char *osmo_fsm_inst_state_name(struct osmo_fsm_inst *fi) { return osmo_fsm_state_name(fi->fsm, fi->state); } -/*! \brief perform a state change of the given FSM instance +/*! perform a state change of the given FSM instance * * This is a macro that calls _osmo_fsm_inst_state_chg() with the given * parameters as well as the caller's source file and line number for logging @@ -173,7 +173,7 @@ int _osmo_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t new_state, unsigned long timeout_secs, int T, const char *file, int line); -/*! \brief dispatch an event to an osmocom finite state machine instance +/*! dispatch an event to an osmocom finite state machine instance * * This is a macro that calls _osmo_fsm_inst_dispatch() with the given * parameters as well as the caller's source file and line number for logging @@ -184,7 +184,7 @@ int _osmo_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t new_state, int _osmo_fsm_inst_dispatch(struct osmo_fsm_inst *fi, uint32_t event, void *data, const char *file, int line); -/*! \brief Terminate FSM instance with given cause +/*! Terminate FSM instance with given cause * * This is a macro that calls _osmo_fsm_inst_term() with the given parameters * as well as the caller's source file and line number for logging purposes. @@ -196,7 +196,7 @@ void _osmo_fsm_inst_term(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause, void *data, const char *file, int line); -/*! \brief Terminate all child FSM instances of an FSM instance. +/*! Terminate all child FSM instances of an FSM instance. * * This is a macro that calls _osmo_fsm_inst_term_children() with the given * parameters as well as the caller's source file and line number for logging diff --git a/include/osmocom/core/gsmtap.h b/include/osmocom/core/gsmtap.h index f9d6f0a4..0dc25bb3 100644 --- a/include/osmocom/core/gsmtap.h +++ b/include/osmocom/core/gsmtap.h @@ -238,7 +238,7 @@ enum { }; /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ -/*! \brief Structure of the GTMTAP pseudo-header */ +/*! Structure of the GTMTAP pseudo-header */ struct gsmtap_hdr { uint8_t version; /*!< version, set to 0x01 currently */ uint8_t hdr_len; /*!< length in number of 32bit words */ @@ -258,7 +258,7 @@ struct gsmtap_hdr { } __attribute__((packed)); -/*! \brief Structure of the GTMTAP libosmocore logging header */ +/*! Structure of the GTMTAP libosmocore logging header */ struct gsmtap_osmocore_log_hdr { struct { uint32_t sec; diff --git a/include/osmocom/core/gsmtap_util.h b/include/osmocom/core/gsmtap_util.h index 2e3d068d..b60257e2 100644 --- a/include/osmocom/core/gsmtap_util.h +++ b/include/osmocom/core/gsmtap_util.h @@ -19,14 +19,14 @@ struct msgb *gsmtap_makemsg(uint16_t arfcn, uint8_t ts, uint8_t chan_type, uint8_t ss, uint32_t fn, int8_t signal_dbm, uint8_t snr, const uint8_t *data, unsigned int len); -/*! \brief one gsmtap instance */ +/*! one gsmtap instance */ struct gsmtap_inst { - int ofd_wq_mode; /*!< \brief wait queue mode? */ - struct osmo_wqueue wq; /*!< \brief the wait queue */ - struct osmo_fd sink_ofd;/*!< \brief file descriptor */ + int ofd_wq_mode; /*!< wait queue mode? */ + struct osmo_wqueue wq; /*!< the wait queue */ + struct osmo_fd sink_ofd;/*!< file descriptor */ }; -/*! \brief obtain the file descriptor associated with a gsmtap instance +/*! obtain the file descriptor associated with a gsmtap instance * \param[in] gti GSMTAP instance * \returns file descriptor of GSMTAP instance */ static inline int gsmtap_inst_fd(struct gsmtap_inst *gti) diff --git a/include/osmocom/core/linuxlist.h b/include/osmocom/core/linuxlist.h index 7d850776..5098c5f5 100644 --- a/include/osmocom/core/linuxlist.h +++ b/include/osmocom/core/linuxlist.h @@ -7,7 +7,7 @@ /*! * \file linuxlist.h * - * \brief Simple doubly linked list implementation. + * Simple doubly linked list implementation. * * Some of the internal functions ("__xxx") are useful when * manipulating whole llists rather than single entries, as @@ -24,7 +24,7 @@ static inline void prefetch(const void *x) {;} -/*! \brief cast a member of a structure out to the containing structure +/*! cast a member of a structure out to the containing structure * * \param[in] ptr the pointer to the member. * \param[in] type the type of the container struct this is embedded in. @@ -43,15 +43,15 @@ static inline void prefetch(const void *x) {;} #define LLIST_POISON1 ((void *) 0x00100100) #define LLIST_POISON2 ((void *) 0x00200200) -/*! \brief (double) linked list header structure */ +/*! (double) linked list header structure */ struct llist_head { - /*! \brief Pointer to next and previous item */ + /*! Pointer to next and previous item */ struct llist_head *next, *prev; }; #define LLIST_HEAD_INIT(name) { &(name), &(name) } -/*! \brief define a statically-initialized \ref llist_head +/*! define a statically-initialized \ref llist_head * \param[in] name Variable name * * This is a helper macro that will define a named variable of type @@ -59,12 +59,12 @@ struct llist_head { #define LLIST_HEAD(name) \ struct llist_head name = LLIST_HEAD_INIT(name) -/*! \brief initialize a \ref llist_head to point back to self */ +/*! initialize a \ref llist_head to point back to self */ #define INIT_LLIST_HEAD(ptr) do { \ (ptr)->next = (ptr); (ptr)->prev = (ptr); \ } while (0) -/*! \brief Insert a new entry between two known consecutive entries. +/*! Insert a new entry between two known consecutive entries. * * This is only for internal llist manipulation where we know * the prev/next entries already! @@ -79,7 +79,7 @@ static inline void __llist_add(struct llist_head *_new, prev->next = _new; } -/*! \brief add a new entry into a linked list (at head) +/*! add a new entry into a linked list (at head) * \param _new New entry to be added * \param head \ref llist_head to add it after * @@ -91,7 +91,7 @@ static inline void llist_add(struct llist_head *_new, struct llist_head *head) __llist_add(_new, head, head->next); } -/*! \brief add a new entry into a linked list (at tail) +/*! add a new entry into a linked list (at tail) * \param _new New entry to be added * \param head Head of linked list to whose tail we shall add \a _new * @@ -116,7 +116,7 @@ static inline void __llist_del(struct llist_head * prev, struct llist_head * nex prev->next = next; } -/*! \brief Delete entry from linked list +/*! Delete entry from linked list * \param entry The element to delete from the llist * * Note: llist_empty on entry does not return true after this, the entry is @@ -129,7 +129,7 @@ static inline void llist_del(struct llist_head *entry) entry->prev = (struct llist_head *)LLIST_POISON2; } -/*! \brief Delete entry from linked list and reinitialize it +/*! Delete entry from linked list and reinitialize it * \param entry The element to delete from the list */ static inline void llist_del_init(struct llist_head *entry) @@ -138,7 +138,7 @@ static inline void llist_del_init(struct llist_head *entry) INIT_LLIST_HEAD(entry); } -/*! \brief Delete from one llist and add as another's head +/*! Delete from one llist and add as another's head * \param llist The entry to move * \param head The head that will precede our entry */ @@ -148,7 +148,7 @@ static inline void llist_move(struct llist_head *llist, struct llist_head *head) llist_add(llist, head); } -/*! \brief Delete from one llist and add as another's tail +/*! Delete from one llist and add as another's tail * \param llist The entry to move * \param head The head that will follow our entry */ @@ -159,7 +159,7 @@ static inline void llist_move_tail(struct llist_head *llist, llist_add_tail(llist, head); } -/*! \brief Test whether a linked list is empty +/*! Test whether a linked list is empty * \param[in] head The llist to test. * \returns 1 if the list is empty, 0 otherwise */ @@ -182,7 +182,7 @@ static inline void __llist_splice(struct llist_head *llist, at->prev = last; } -/*! \brief Join two llists +/*! Join two llists * \param llist The new linked list to add * \param head The place to add \a llist in the other list */ @@ -192,7 +192,7 @@ static inline void llist_splice(struct llist_head *llist, struct llist_head *hea __llist_splice(llist, head); } -/*! \brief join two llists and reinitialise the emptied llist. +/*! join two llists and reinitialise the emptied llist. * \param llist The new linked list to add. * \param head The place to add it in the first llist. * @@ -207,7 +207,7 @@ static inline void llist_splice_init(struct llist_head *llist, } } -/*! \brief Get the struct containing this list entry +/*! Get the struct containing this list entry * \param ptr The \ref llist_head pointer * \param type The type of the struct this is embedded in * \param @member The name of the \ref llist_head within the struct @@ -215,7 +215,7 @@ static inline void llist_splice_init(struct llist_head *llist, #define llist_entry(ptr, type, member) \ container_of(ptr, type, member) -/*! \brief Get the first element from a list +/*! Get the first element from a list * \param ptr the list head to take the element from. * \param type the type of the struct this is embedded in. * \param member the name of the list_head within the struct. @@ -225,7 +225,7 @@ static inline void llist_splice_init(struct llist_head *llist, #define llist_first_entry(ptr, type, member) \ llist_entry((ptr)->next, type, member) -/*! \brief Get the last element from a list +/*! Get the last element from a list * \param ptr the list head to take the element from. * \param type the type of the struct this is embedded in. * \param member the name of the llist_head within the struct. @@ -235,7 +235,7 @@ static inline void llist_splice_init(struct llist_head *llist, #define llist_last_entry(ptr, type, member) \ llist_entry((ptr)->prev, type, member) -/*! \brief Get the first element from a list, or NULL +/*! Get the first element from a list, or NULL * \param ptr the list head to take the element from. * \param type the type of the struct this is embedded in. * \param member the name of the list_head within the struct. @@ -245,7 +245,7 @@ static inline void llist_splice_init(struct llist_head *llist, #define llist_first_entry_or_null(ptr, type, member) \ (!llist_empty(ptr) ? llist_first_entry(ptr, type, member) : NULL) -/*! \brief Iterate over a linked list +/*! Iterate over a linked list * \param pos The \ref llist_head to use as a loop counter * \param head The head of the list over which to iterate */ @@ -253,7 +253,7 @@ static inline void llist_splice_init(struct llist_head *llist, for (pos = (head)->next, prefetch(pos->next); pos != (head); \ pos = pos->next, prefetch(pos->next)) -/*! \brief Iterate over a llist (no prefetch) +/*! Iterate over a llist (no prefetch) * \param pos The \ref llist_head to use as a loop counter * \param head The head of the list over which to iterate * @@ -265,7 +265,7 @@ static inline void llist_splice_init(struct llist_head *llist, #define __llist_for_each(pos, head) \ for (pos = (head)->next; pos != (head); pos = pos->next) -/*! \brief Iterate over a llist backwards +/*! Iterate over a llist backwards * \param pos The \ref llist_head to use as a loop counter * \param head The head of the list over which to iterate */ @@ -273,7 +273,7 @@ static inline void llist_splice_init(struct llist_head *llist, for (pos = (head)->prev, prefetch(pos->prev); pos != (head); \ pos = pos->prev, prefetch(pos->prev)) -/*! \brief Iterate over a list; safe against removal of llist entry +/*! Iterate over a list; safe against removal of llist entry * \param pos The \ref llist_head to use as a loop counter * \param n Another \ref llist_head to use as temporary storage * \param head The head of the list over which to iterate @@ -282,7 +282,7 @@ static inline void llist_splice_init(struct llist_head *llist, for (pos = (head)->next, n = pos->next; pos != (head); \ pos = n, n = pos->next) -/*! \brief Iterate over llist of given type +/*! Iterate over llist of given type * \param pos The 'type *' to use as a loop counter * \param head The head of the list over which to iterate * \param member The name of the \ref llist_head within struct \a pos @@ -294,7 +294,7 @@ static inline void llist_splice_init(struct llist_head *llist, pos = llist_entry(pos->member.next, typeof(*pos), member), \ prefetch(pos->member.next)) -/*! \brief Iterate backwards over llist of given type. +/*! Iterate backwards over llist of given type. * \param pos The 'type *' to use as a loop counter * \param head The head of the list over which to iterate * \param member The name of the \ref llist_head within struct \a pos @@ -306,7 +306,7 @@ static inline void llist_splice_init(struct llist_head *llist, pos = llist_entry(pos->member.prev, typeof(*pos), member), \ prefetch(pos->member.prev)) -/*! \brief iterate over llist of given type continuing after existing +/*! iterate over llist of given type continuing after existing * point * \param pos The 'type *' to use as a loop counter * \param head The head of the list over which to iterate @@ -319,7 +319,7 @@ static inline void llist_splice_init(struct llist_head *llist, pos = llist_entry(pos->member.next, typeof(*pos), member), \ prefetch(pos->member.next)) -/*! \brief iterate over llist of given type, safe against removal of +/*! iterate over llist of given type, safe against removal of * non-consecutive(!) llist entries * \param pos The 'type *' to use as a loop counter * \param n Another type * to use as temporary storage @@ -381,7 +381,7 @@ static inline void llist_splice_init(struct llist_head *llist, for ((pos) = (pos)->next, prefetch((pos)->next); (pos) != (head); \ (pos) = (pos)->next, ({ smp_read_barrier_depends(); 0;}), prefetch((pos)->next)) -/*! \brief count nr of llist items by iterating. +/*! count nr of llist items by iterating. * \param head The llist head to count items of. * \returns Number of items. * diff --git a/include/osmocom/core/logging.h b/include/osmocom/core/logging.h index 7af0ad20..4721713e 100644 --- a/include/osmocom/core/logging.h +++ b/include/osmocom/core/logging.h @@ -13,15 +13,15 @@ #include <osmocom/core/defs.h> #include <osmocom/core/linuxlist.h> -/*! \brief Maximum number of logging contexts */ +/*! Maximum number of logging contexts */ #define LOG_MAX_CTX 8 -/*! \brief Maximum number of logging filters */ +/*! Maximum number of logging filters */ #define LOG_MAX_FILTERS 8 #define DEBUG #ifdef DEBUG -/*! \brief Log a debug message through the Osmocom logging framework +/*! Log a debug message through the Osmocom logging framework * \param[in] ss logging subsystem (e.g. \ref DLGLOBAL) * \param[in] fmt format string * \param[in] args variable argument list @@ -39,7 +39,7 @@ void osmo_vlogp(int subsys, int level, const char *file, int line, void logp(int subsys, const char *file, int line, int cont, const char *format, ...) OSMO_DEPRECATED("Use DEBUGP* macros instead"); -/*! \brief Log a new message through the Osmocom logging framework +/*! Log a new message through the Osmocom logging framework * \param[in] ss logging subsystem (e.g. \ref DLGLOBAL) * \param[in] level logging level (e.g. \ref LOGL_NOTICE) * \param[in] fmt format string @@ -48,7 +48,7 @@ void logp(int subsys, const char *file, int line, int cont, const char *format, #define LOGP(ss, level, fmt, args...) \ LOGPSRC(ss, level, NULL, 0, fmt, ## args) -/*! \brief Continue a log message through the Osmocom logging framework +/*! Continue a log message through the Osmocom logging framework * \param[in] ss logging subsystem (e.g. \ref DLGLOBAL) * \param[in] level logging level (e.g. \ref LOGL_NOTICE) * \param[in] fmt format string @@ -60,7 +60,7 @@ void logp(int subsys, const char *file, int line, int cont, const char *format, logp2(ss, level, __BASE_FILE__, __LINE__, 1, fmt, ##args); \ } while(0) -/*! \brief Log through the Osmocom logging framework with explicit source. +/*! Log through the Osmocom logging framework with explicit source. * If caller_file is passed as NULL, __BASE_FILE__ and __LINE__ are used * instead of caller_file and caller_line (so that this macro here defines * both cases in the same place, and to catch cases where callers fail to pass @@ -82,12 +82,12 @@ void logp(int subsys, const char *file, int line, int cont, const char *format, }\ } while(0) -/*! \brief different log levels */ -#define LOGL_DEBUG 1 /*!< \brief debugging information */ -#define LOGL_INFO 3 /*!< \brief general information */ -#define LOGL_NOTICE 5 /*!< \brief abnormal/unexpected condition */ -#define LOGL_ERROR 7 /*!< \brief error condition, requires user action */ -#define LOGL_FATAL 8 /*!< \brief fatal, program aborted */ +/*! different log levels */ +#define LOGL_DEBUG 1 /*!< debugging information */ +#define LOGL_INFO 3 /*!< general information */ +#define LOGL_NOTICE 5 /*!< abnormal/unexpected condition */ +#define LOGL_ERROR 7 /*!< error condition, requires user action */ +#define LOGL_FATAL 8 /*!< fatal, program aborted */ /* logging levels defined by the library itself */ #define DLGLOBAL -1 /*!< global logging */ @@ -114,7 +114,7 @@ struct log_category { uint8_t enabled; /*!< is logging enabled? */ }; -/*! \brief Information regarding one logging category */ +/*! Information regarding one logging category */ struct log_info_cat { const char *name; /*!< name of category */ const char *color; /*!< color string for cateyory */ @@ -123,12 +123,12 @@ struct log_info_cat { uint8_t enabled; /*!< is this category enabled or not */ }; -/*! \brief Log context information, passed to filter */ +/*! Log context information, passed to filter */ struct log_context { void *ctx[LOG_MAX_CTX+1]; }; -/*! \brief Indexes to indicate the object currently acted upon. +/*! Indexes to indicate the object currently acted upon. * Array indexes for the global \a log_context array. */ enum log_ctx_index { LOG_CTX_GB_NSVC, @@ -138,7 +138,7 @@ enum log_ctx_index { _LOG_CTX_COUNT }; -/*! \brief Indexes to indicate objects that should be logged. +/*! Indexes to indicate objects that should be logged. * Array indexes to log_target->filter_data and bit indexes for * log_target->filter_map. */ enum log_filter_index { @@ -150,18 +150,18 @@ enum log_filter_index { _LOG_FLT_COUNT }; -/*! \brief Compatibility with older libosmocore versions */ +/*! Compatibility with older libosmocore versions */ #define LOG_FILTER_ALL (1<<LOG_FLT_ALL) -/*! \brief Compatibility with older libosmocore versions */ +/*! Compatibility with older libosmocore versions */ #define GPRS_CTX_NSVC LOG_CTX_GB_NSVC -/*! \brief Compatibility with older libosmocore versions */ +/*! Compatibility with older libosmocore versions */ #define GPRS_CTX_BVC LOG_CTX_GB_BVC -/*! \brief Indexes to indicate the object currently acted upon. +/*! Indexes to indicate the object currently acted upon. * Array indexes for the global \a log_context array. */ struct log_target; -/*! \brief Log filter function */ +/*! Log filter function */ typedef int log_filter(const struct log_context *ctx, struct log_target *target); @@ -177,60 +177,60 @@ typedef void log_save_filters(struct vty *vty, const struct log_info *info, const struct log_target *tgt); -/*! \brief Logging configuration, passed to \ref log_init */ +/*! Logging configuration, passed to \ref log_init */ struct log_info { - /* \brief filter callback function */ + /* filter callback function */ log_filter *filter_fn; - /*! \brief per-category information */ + /*! per-category information */ const struct log_info_cat *cat; - /*! \brief total number of categories */ + /*! total number of categories */ unsigned int num_cat; - /*! \brief total number of user categories (not library) */ + /*! total number of user categories (not library) */ unsigned int num_cat_user; - /*! \brief filter saving function */ + /*! filter saving function */ log_save_filters *save_fn; - /*! \brief filter saving function */ + /*! filter saving function */ log_print_filters *print_fn; }; -/*! \brief Type of logging target */ +/*! Type of logging target */ enum log_target_type { - LOG_TGT_TYPE_VTY, /*!< \brief VTY logging */ - LOG_TGT_TYPE_SYSLOG, /*!< \brief syslog based logging */ - LOG_TGT_TYPE_FILE, /*!< \brief text file logging */ - LOG_TGT_TYPE_STDERR, /*!< \brief stderr logging */ - LOG_TGT_TYPE_STRRB, /*!< \brief osmo_strrb-backed logging */ - LOG_TGT_TYPE_GSMTAP, /*!< \brief GSMTAP network logging */ + LOG_TGT_TYPE_VTY, /*!< VTY logging */ + LOG_TGT_TYPE_SYSLOG, /*!< syslog based logging */ + LOG_TGT_TYPE_FILE, /*!< text file logging */ + LOG_TGT_TYPE_STDERR, /*!< stderr logging */ + LOG_TGT_TYPE_STRRB, /*!< osmo_strrb-backed logging */ + LOG_TGT_TYPE_GSMTAP, /*!< GSMTAP network logging */ }; -/*! \brief structure representing a logging target */ +/*! structure representing a logging target */ struct log_target { - struct llist_head entry; /*!< \brief linked list */ + struct llist_head entry; /*!< linked list */ - /*! \brief Internal data for filtering */ + /*! Internal data for filtering */ int filter_map; - /*! \brief Internal data for filtering */ + /*! Internal data for filtering */ void *filter_data[LOG_MAX_FILTERS+1]; - /*! \brief logging categories */ + /*! logging categories */ struct log_category *categories; - /*! \brief global log level */ + /*! global log level */ uint8_t loglevel; - /*! \brief should color be used when printing log messages? */ + /*! should color be used when printing log messages? */ unsigned int use_color:1; - /*! \brief should log messages be prefixed with a timestamp? */ + /*! should log messages be prefixed with a timestamp? */ unsigned int print_timestamp:1; - /*! \brief should log messages be prefixed with a filename? */ + /*! should log messages be prefixed with a filename? */ unsigned int print_filename:1; - /*! \brief should log messages be prefixed with a category name? */ + /*! should log messages be prefixed with a category name? */ unsigned int print_category:1; - /*! \brief should log messages be prefixed with an extended timestamp? */ + /*! should log messages be prefixed with an extended timestamp? */ unsigned int print_ext_timestamp:1; - /*! \brief the type of this log taget */ + /*! the type of this log taget */ enum log_target_type type; union { @@ -259,7 +259,7 @@ struct log_target { } tgt_gsmtap; }; - /*! \brief call-back function to be called when the logging framework + /*! call-back function to be called when the logging framework * wants to log a fully formatted string * \param[in] target logging target * \param[in] level log level of currnet message @@ -268,7 +268,7 @@ struct log_target { void (*output) (struct log_target *target, unsigned int level, const char *string); - /*! \brief alternative call-back function to which the logging + /*! alternative call-back function to which the logging * framework passes the unfortmatted input arguments, * i.e. bypassing the internal string formatter * \param[in] target logging target diff --git a/include/osmocom/core/msgb.h b/include/osmocom/core/msgb.h index f5dd323b..7fad943c 100644 --- a/include/osmocom/core/msgb.h +++ b/include/osmocom/core/msgb.h @@ -33,33 +33,33 @@ #define MSGB_DEBUG -/*! \brief Osmocom message buffer */ +/*! Osmocom message buffer */ struct msgb { - struct llist_head list; /*!< \brief linked list header */ + struct llist_head list; /*!< linked list header */ /* Part of which TRX logical channel we were received / transmitted */ /* FIXME: move them into the control buffer */ union { - void *dst; /*!< \brief reference of origin/destination */ + void *dst; /*!< reference of origin/destination */ struct gsm_bts_trx *trx; }; - struct gsm_lchan *lchan; /*!< \brief logical channel */ + struct gsm_lchan *lchan; /*!< logical channel */ - unsigned char *l1h; /*!< \brief pointer to Layer1 header (if any) */ - unsigned char *l2h; /*!< \brief pointer to A-bis layer 2 header: OML, RSL(RLL), NS */ - unsigned char *l3h; /*!< \brief pointer to Layer 3 header. For OML: FOM; RSL: 04.08; GPRS: BSSGP */ - unsigned char *l4h; /*!< \brief pointer to layer 4 header */ + unsigned char *l1h; /*!< pointer to Layer1 header (if any) */ + unsigned char *l2h; /*!< pointer to A-bis layer 2 header: OML, RSL(RLL), NS */ + unsigned char *l3h; /*!< pointer to Layer 3 header. For OML: FOM; RSL: 04.08; GPRS: BSSGP */ + unsigned char *l4h; /*!< pointer to layer 4 header */ - unsigned long cb[5]; /*!< \brief control buffer */ + unsigned long cb[5]; /*!< control buffer */ - uint16_t data_len; /*!< \brief length of underlying data array */ - uint16_t len; /*!< \brief length of bytes used in msgb */ + uint16_t data_len; /*!< length of underlying data array */ + uint16_t len; /*!< length of bytes used in msgb */ - unsigned char *head; /*!< \brief start of underlying memory buffer */ - unsigned char *tail; /*!< \brief end of message in buffer */ - unsigned char *data; /*!< \brief start of message in buffer */ - unsigned char _data[0]; /*!< \brief optional immediate data array */ + unsigned char *head; /*!< start of underlying memory buffer */ + unsigned char *tail; /*!< end of message in buffer */ + unsigned char *data; /*!< start of message in buffer */ + unsigned char _data[0]; /*!< optional immediate data array */ }; extern struct msgb *msgb_alloc(uint16_t size, const char *name); @@ -83,16 +83,16 @@ static int msgb_test_invariant(const struct msgb *msg) __attribute__((pure)); #define MSGB_ABORT(msg, fmt, args ...) #endif -/*! \brief obtain L1 header of msgb */ +/*! obtain L1 header of msgb */ #define msgb_l1(m) ((void *)(m->l1h)) -/*! \brief obtain L2 header of msgb */ +/*! obtain L2 header of msgb */ #define msgb_l2(m) ((void *)(m->l2h)) -/*! \brief obtain L3 header of msgb */ +/*! obtain L3 header of msgb */ #define msgb_l3(m) ((void *)(m->l3h)) -/*! \brief obtain SMS header of msgb */ +/*! obtain SMS header of msgb */ #define msgb_sms(m) ((void *)(m->l4h)) -/*! \brief determine length of L1 message +/*! determine length of L1 message * \param[in] msgb message buffer * \returns size of L1 message in bytes * @@ -104,7 +104,7 @@ static inline unsigned int msgb_l1len(const struct msgb *msgb) return msgb->tail - (uint8_t *)msgb_l1(msgb); } -/*! \brief determine length of L2 message +/*! determine length of L2 message * \param[in] msgb message buffer * \returns size of L2 message in bytes * @@ -116,7 +116,7 @@ static inline unsigned int msgb_l2len(const struct msgb *msgb) return msgb->tail - (uint8_t *)msgb_l2(msgb); } -/*! \brief determine length of L3 message +/*! determine length of L3 message * \param[in] msgb message buffer * \returns size of L3 message in bytes * @@ -128,7 +128,7 @@ static inline unsigned int msgb_l3len(const struct msgb *msgb) return msgb->tail - (uint8_t *)msgb_l3(msgb); } -/*! \brief determine the length of the header +/*! determine the length of the header * \param[in] msgb message buffer * \returns number of bytes between start of buffer and start of msg * @@ -140,7 +140,7 @@ static inline unsigned int msgb_headlen(const struct msgb *msgb) return msgb->len - msgb->data_len; } -/*! \brief determine how much tail room is left in msgb +/*! determine how much tail room is left in msgb * \param[in] msgb message buffer * \returns number of bytes remaining at end of msgb * @@ -152,7 +152,7 @@ static inline int msgb_tailroom(const struct msgb *msgb) return (msgb->head + msgb->data_len) - msgb->tail; } -/*! \brief determine the amount of headroom in msgb +/*! determine the amount of headroom in msgb * \param[in] msgb message buffer * \returns number of bytes left ahead of message start in msgb * @@ -164,7 +164,7 @@ static inline int msgb_headroom(const struct msgb *msgb) return (msgb->data - msgb->head); } -/*! \brief append data to end of message buffer +/*! append data to end of message buffer * \param[in] msgb message buffer * \param[in] len number of bytes to append to message * \returns pointer to start of newly-appended data @@ -187,7 +187,7 @@ static inline unsigned char *msgb_put(struct msgb *msgb, unsigned int len) return tmp; } -/*! \brief append a uint8 value to the end of the message +/*! append a uint8 value to the end of the message * \param[in] msgb message buffer * \param[in] word unsigned 8bit byte to be appended */ @@ -197,7 +197,7 @@ static inline void msgb_put_u8(struct msgb *msgb, uint8_t word) space[0] = word & 0xFF; } -/*! \brief append a uint16 value to the end of the message +/*! append a uint16 value to the end of the message * \param[in] msgb message buffer * \param[in] word unsigned 16bit byte to be appended */ @@ -207,7 +207,7 @@ static inline void msgb_put_u16(struct msgb *msgb, uint16_t word) osmo_store16be(word, space); } -/*! \brief append a uint32 value to the end of the message +/*! append a uint32 value to the end of the message * \param[in] msgb message buffer * \param[in] word unsigned 32bit byte to be appended */ @@ -217,7 +217,7 @@ static inline void msgb_put_u32(struct msgb *msgb, uint32_t word) osmo_store32be(word, space); } -/*! \brief remove data from end of message +/*! remove data from end of message * \param[in] msgb message buffer * \param[in] len number of bytes to remove from end */ @@ -232,7 +232,7 @@ static inline unsigned char *msgb_get(struct msgb *msgb, unsigned int len) return tmp; } -/*! \brief remove uint8 from end of message +/*! remove uint8 from end of message * \param[in] msgb message buffer * \returns 8bit value taken from end of msgb */ @@ -242,7 +242,7 @@ static inline uint8_t msgb_get_u8(struct msgb *msgb) return space[0]; } -/*! \brief remove uint16 from end of message +/*! remove uint16 from end of message * \param[in] msgb message buffer * \returns 16bit value taken from end of msgb */ @@ -252,7 +252,7 @@ static inline uint16_t msgb_get_u16(struct msgb *msgb) return osmo_load16be(space); } -/*! \brief remove uint32 from end of message +/*! remove uint32 from end of message * \param[in] msgb message buffer * \returns 32bit value taken from end of msgb */ @@ -262,7 +262,7 @@ static inline uint32_t msgb_get_u32(struct msgb *msgb) return osmo_load32be(space); } -/*! \brief prepend (push) some data to start of message +/*! prepend (push) some data to start of message * \param[in] msgb message buffer * \param[in] len number of bytes to pre-pend * \returns pointer to newly added portion at start of \a msgb @@ -284,7 +284,7 @@ static inline unsigned char *msgb_push(struct msgb *msgb, unsigned int len) return msgb->data; } -/*! \brief prepend a uint8 value to the head of the message +/*! prepend a uint8 value to the head of the message * \param[in] msgb message buffer * \param[in] word unsigned 8bit byte to be prepended */ @@ -294,7 +294,7 @@ static inline void msgb_push_u8(struct msgb *msg, uint8_t word) space[0] = word; } -/*! \brief prepend a uint16 value to the head of the message +/*! prepend a uint16 value to the head of the message * \param[in] msgb message buffer * \param[in] word unsigned 16bit byte to be prepended */ @@ -304,7 +304,7 @@ static inline void msgb_push_u16(struct msgb *msg, uint16_t word) osmo_store16be(word, space); } -/*! \brief prepend a uint32 value to the head of the message +/*! prepend a uint32 value to the head of the message * \param[in] msgb message buffer * \param[in] word unsigned 32bit byte to be prepended */ @@ -314,7 +314,7 @@ static inline void msgb_push_u32(struct msgb *msg, uint32_t word) osmo_store32be(word, space); } -/*! \brief remove (pull) a header from the front of the message buffer +/*! remove (pull) a header from the front of the message buffer * \param[in] msgb message buffer * \param[in] len number of octets to be pulled * \returns pointer to new start of msgb @@ -329,7 +329,7 @@ static inline unsigned char *msgb_pull(struct msgb *msgb, unsigned int len) return msgb->data += len; } -/*! \brief remove (pull) all headers in front of l3h from the message buffer. +/*! remove (pull) all headers in front of l3h from the message buffer. * \param[in] msgb message buffer with a valid l3h * \returns pointer to new start of msgb (l3h) * @@ -344,7 +344,7 @@ static inline unsigned char *msgb_pull_to_l3(struct msgb *msg) return ret; } -/*! \brief remove (pull) all headers in front of l2h from the message buffer. +/*! remove (pull) all headers in front of l2h from the message buffer. * \param[in] msgb message buffer with a valid l2h * \returns pointer to new start of msgb (l2h) * @@ -359,7 +359,7 @@ static inline unsigned char *msgb_pull_to_l2(struct msgb *msg) return ret; } -/*! \brief remove uint8 from front of message +/*! remove uint8 from front of message * \param[in] msgb message buffer * \returns 8bit value taken from end of msgb */ @@ -369,7 +369,7 @@ static inline uint8_t msgb_pull_u8(struct msgb *msgb) return space[0]; } -/*! \brief remove uint16 from front of message +/*! remove uint16 from front of message * \param[in] msgb message buffer * \returns 16bit value taken from end of msgb */ @@ -379,7 +379,7 @@ static inline uint16_t msgb_pull_u16(struct msgb *msgb) return osmo_load16be(space); } -/*! \brief remove uint32 from front of message +/*! remove uint32 from front of message * \param[in] msgb message buffer * \returns 32bit value taken from end of msgb */ @@ -389,7 +389,7 @@ static inline uint32_t msgb_pull_u32(struct msgb *msgb) return osmo_load32be(space); } -/*! \brief Increase headroom of empty msgb, reducing the tailroom +/*! Increase headroom of empty msgb, reducing the tailroom * \param[in] msg message buffer * \param[in] len amount of extra octets to be reserved as headroom * @@ -406,7 +406,7 @@ static inline void msgb_reserve(struct msgb *msg, int len) msg->tail += len; } -/*! \brief Trim the msgb to a given absolute length +/*! Trim the msgb to a given absolute length * \param[in] msg message buffer * \param[in] len new total length of buffer * \returns 0 in case of success, negative in case of error @@ -424,7 +424,7 @@ static inline int msgb_trim(struct msgb *msg, int len) return 0; } -/*! \brief Trim the msgb to a given layer3 length +/*! Trim the msgb to a given layer3 length * \param[in] msg message buffer * \param[in] l3len new layer3 length * \returns 0 in case of success, negative in case of error @@ -434,7 +434,7 @@ static inline int msgb_l3trim(struct msgb *msg, int l3len) return msgb_trim(msg, (msg->l3h - msg->data) + l3len); } -/*! \brief Allocate message buffer with specified headroom +/*! Allocate message buffer with specified headroom * \param[in] size size in bytes, including headroom * \param[in] headroom headroom in bytes * \param[in] name human-readable name @@ -455,7 +455,7 @@ static inline struct msgb *msgb_alloc_headroom(int size, int headroom, return msg; } -/*! \brief Check a message buffer for consistency +/*! Check a message buffer for consistency * \param[in] msg message buffer * \returns 0 (false) if inconsistent, != 0 (true) otherwise */ diff --git a/include/osmocom/core/panic.h b/include/osmocom/core/panic.h index 5d575c4b..92c557fe 100644 --- a/include/osmocom/core/panic.h +++ b/include/osmocom/core/panic.h @@ -8,7 +8,7 @@ #include <stdarg.h> -/*! \brief panic handler callback function type */ +/*! panic handler callback function type */ typedef void (*osmo_panic_handler_t)(const char *fmt, va_list args); extern void osmo_panic(const char *fmt, ...); diff --git a/include/osmocom/core/prim.h b/include/osmocom/core/prim.h index f04e15e1..7288ba6a 100644 --- a/include/osmocom/core/prim.h +++ b/include/osmocom/core/prim.h @@ -12,12 +12,12 @@ #define OSMO_PRIM(prim, op) ((prim << 8) | (op & 0xFF)) #define OSMO_PRIM_HDR(oph) OSMO_PRIM((oph)->primitive, (oph)->operation) -/*! \brief primitive operation */ +/*! primitive operation */ enum osmo_prim_operation { - PRIM_OP_REQUEST, /*!< \brief request */ - PRIM_OP_RESPONSE, /*!< \brief response */ - PRIM_OP_INDICATION, /*!< \brief indication */ - PRIM_OP_CONFIRM, /*!< \brief confirm */ + PRIM_OP_REQUEST, /*!< request */ + PRIM_OP_RESPONSE, /*!< response */ + PRIM_OP_INDICATION, /*!< indication */ + PRIM_OP_CONFIRM, /*!< confirm */ }; extern const struct value_string osmo_prim_op_names[5]; @@ -28,15 +28,15 @@ extern const struct value_string osmo_prim_op_names[5]; #define _SAP_TETRA_BASE (0x02 << _SAP_GSM_SHIFT) #define _SAP_SS7_BASE (0x03 << _SAP_GSM_SHIFT) -/*! \brief primitive header */ +/*! primitive header */ struct osmo_prim_hdr { - unsigned int sap; /*!< \brief Service Access Point */ - unsigned int primitive; /*!< \brief Primitive number */ - enum osmo_prim_operation operation; /*! \brief Primitive Operation */ - struct msgb *msg; /*!< \brief \ref msgb containing associated data */ + unsigned int sap; /*!< Service Access Point */ + unsigned int primitive; /*!< Primitive number */ + enum osmo_prim_operation operation; /*! Primitive Operation */ + struct msgb *msg; /*!< \ref msgb containing associated data */ }; -/*! \brief initialize a primitive header +/*! initialize a primitive header * \param[in,out] oph primitive header * \param[in] sap Service Access Point * \param[in] primitive Primitive Number @@ -54,14 +54,14 @@ osmo_prim_init(struct osmo_prim_hdr *oph, unsigned int sap, oph->msg = msg; } -/*! \brief primitive handler callback type */ +/*! primitive handler callback type */ typedef int (*osmo_prim_cb)(struct osmo_prim_hdr *oph, void *ctx); -/*! \brief magic value to be used as final record of \ref +/*! magic value to be used as final record of \ref * osmo_prim_event_map */ #define OSMO_NO_EVENT 0xFFFFFFFF -/*! \brief single entry in a SAP/PRIM/OP -> EVENT map */ +/*! single entry in a SAP/PRIM/OP -> EVENT map */ struct osmo_prim_event_map { unsigned int sap; /*!< SAP to match */ unsigned int primitive; /*!< primtiive to match */ diff --git a/include/osmocom/core/rate_ctr.h b/include/osmocom/core/rate_ctr.h index ebaa7a71..b75967a0 100644 --- a/include/osmocom/core/rate_ctr.h +++ b/include/osmocom/core/rate_ctr.h @@ -10,60 +10,60 @@ #include <osmocom/core/linuxlist.h> -/*! \brief Number of rate counter intervals */ +/*! Number of rate counter intervals */ #define RATE_CTR_INTV_NUM 4 -/*! \brief Rate counter interval */ +/*! Rate counter interval */ enum rate_ctr_intv { - RATE_CTR_INTV_SEC, /*!< \brief last second */ - RATE_CTR_INTV_MIN, /*!< \brief last minute */ - RATE_CTR_INTV_HOUR, /*!< \brief last hour */ - RATE_CTR_INTV_DAY, /*!< \brief last day */ + RATE_CTR_INTV_SEC, /*!< last second */ + RATE_CTR_INTV_MIN, /*!< last minute */ + RATE_CTR_INTV_HOUR, /*!< last hour */ + RATE_CTR_INTV_DAY, /*!< last day */ }; -/*! \brief data we keep for each of the intervals */ +/*! data we keep for each of the intervals */ struct rate_ctr_per_intv { - uint64_t last; /*!< \brief counter value in last interval */ - uint64_t rate; /*!< \brief counter rate */ + uint64_t last; /*!< counter value in last interval */ + uint64_t rate; /*!< counter rate */ }; -/*! \brief data we keep for each actual value */ +/*! data we keep for each actual value */ struct rate_ctr { - uint64_t current; /*!< \brief current value */ - uint64_t previous; /*!< \brief previous value, used for delta */ - /*! \brief per-interval data */ + uint64_t current; /*!< current value */ + uint64_t previous; /*!< previous value, used for delta */ + /*! per-interval data */ struct rate_ctr_per_intv intv[RATE_CTR_INTV_NUM]; }; -/*! \brief rate counter description */ +/*! rate counter description */ struct rate_ctr_desc { - const char *name; /*!< \brief name of the counter */ - const char *description;/*!< \brief description of the counter */ + const char *name; /*!< name of the counter */ + const char *description;/*!< description of the counter */ }; -/*! \brief description of a rate counter group */ +/*! description of a rate counter group */ struct rate_ctr_group_desc { - /*! \brief The prefix to the name of all counters in this group */ + /*! The prefix to the name of all counters in this group */ const char *group_name_prefix; - /*! \brief The human-readable description of the group */ + /*! The human-readable description of the group */ const char *group_description; - /*! \brief The class to which this group belongs */ + /*! The class to which this group belongs */ int class_id; - /*! \brief The number of counters in this group */ + /*! The number of counters in this group */ const unsigned int num_ctr; - /*! \brief Pointer to array of counter names */ + /*! Pointer to array of counter names */ const struct rate_ctr_desc *ctr_desc; }; -/*! \brief One instance of a counter group class */ +/*! One instance of a counter group class */ struct rate_ctr_group { - /*! \brief Linked list of all counter groups in the system */ + /*! Linked list of all counter groups in the system */ struct llist_head list; - /*! \brief Pointer to the counter group class */ + /*! Pointer to the counter group class */ const struct rate_ctr_group_desc *desc; - /*! \brief The index of this ctr_group within its class */ + /*! The index of this ctr_group within its class */ unsigned int idx; - /*! \brief Actual counter structures below */ + /*! Actual counter structures below */ struct rate_ctr ctr[0]; }; @@ -78,19 +78,19 @@ static inline void rate_ctr_group_upd_idx(struct rate_ctr_group *grp, unsigned i void rate_ctr_group_free(struct rate_ctr_group *grp); -/*! \brief Increment the counter by \a inc +/*! Increment the counter by \a inc * \param ctr \ref rate_ctr to increment * \param inc quantity to increment \a ctr by */ void rate_ctr_add(struct rate_ctr *ctr, int inc); -/*! \brief Increment the counter by 1 +/*! Increment the counter by 1 * \param ctr \ref rate_ctr to increment */ static inline void rate_ctr_inc(struct rate_ctr *ctr) { rate_ctr_add(ctr, 1); } -/*! \brief Return the counter difference since the last call to this function */ +/*! Return the counter difference since the last call to this function */ int64_t rate_ctr_difference(struct rate_ctr *ctr); int rate_ctr_init(void *tall_ctx); @@ -104,7 +104,7 @@ typedef int (*rate_ctr_handler_t)( typedef int (*rate_ctr_group_handler_t)(struct rate_ctr_group *, void *); -/*! \brief Iterate over all counters +/*! Iterate over all counters * \param[in] handle_item Call-back function, aborts if rc < 0 * \param[in] data Private data handed through to \a handle_counter */ diff --git a/include/osmocom/core/select.h b/include/osmocom/core/select.h index c2b51a45..fe84c5b0 100644 --- a/include/osmocom/core/select.h +++ b/include/osmocom/core/select.h @@ -8,17 +8,17 @@ */ /*! \file select.h - * \brief select loop abstraction + * select loop abstraction */ -/*! \brief Indicate interest in reading from the file descriptor */ +/*! Indicate interest in reading from the file descriptor */ #define BSC_FD_READ 0x0001 -/*! \brief Indicate interest in writing to the file descriptor */ +/*! Indicate interest in writing to the file descriptor */ #define BSC_FD_WRITE 0x0002 -/*! \brief Indicate interest in exceptions from the file descriptor */ +/*! Indicate interest in exceptions from the file descriptor */ #define BSC_FD_EXCEPT 0x0004 -/*! \brief Structure representing a file dsecriptor */ +/*! Structure representing a file dsecriptor */ struct osmo_fd { /*! linked list for internal management */ struct llist_head list; diff --git a/include/osmocom/core/sercomm.h b/include/osmocom/core/sercomm.h index 5ad1d73c..cf15613a 100644 --- a/include/osmocom/core/sercomm.h +++ b/include/osmocom/core/sercomm.h @@ -8,10 +8,10 @@ */ /*! \file sercomm.h - * \brief Osmocom Sercomm HDLC (de)multiplex + * Osmocom Sercomm HDLC (de)multiplex */ -/*! \brief A low sercomm_dlci means high priority. A high DLCI means low priority */ +/*! A low sercomm_dlci means high priority. A high DLCI means low priority */ enum sercomm_dlci { SC_DLCI_HIGHEST = 0, SC_DLCI_DEBUG = 4, @@ -23,44 +23,44 @@ enum sercomm_dlci { }; struct osmo_sercomm_inst; -/*! \brief call-back function for per-DLC receive handler +/*! call-back function for per-DLC receive handler * \param[in] sercomm instance on which msg was received * \param[in] dlci DLC Identifier of received msg * \param[in] msg received message that needs to be processed */ typedef void (*dlci_cb_t)(struct osmo_sercomm_inst *sercomm, uint8_t dlci, struct msgb *msg); -/*! \brief one instance of a sercomm multiplex/demultiplex */ +/*! one instance of a sercomm multiplex/demultiplex */ struct osmo_sercomm_inst { - /*! \brief Has this instance been initialized? */ + /*! Has this instance been initialized? */ int initialized; - /*! \brief UART Identifier */ + /*! UART Identifier */ int uart_id; - /*! \brief transmit side */ + /*! transmit side */ struct { - /*! \brief per-DLC queue of pending transmit msgbs */ + /*! per-DLC queue of pending transmit msgbs */ struct llist_head dlci_queues[_SC_DLCI_MAX]; - /*! \brief msgb currently being transmitted */ + /*! msgb currently being transmitted */ struct msgb *msg; - /*! \brief transmit state */ + /*! transmit state */ int state; - /*! \brief next to-be-transmitted char in msg */ + /*! next to-be-transmitted char in msg */ uint8_t *next_char; } tx; - /*! \brief receive side */ + /*! receive side */ struct { - /*! \brief per-DLC handler call-back functions */ + /*! per-DLC handler call-back functions */ dlci_cb_t dlci_handler[_SC_DLCI_MAX]; - /*! \brief msgb allocation size for rx msgs */ + /*! msgb allocation size for rx msgs */ unsigned int msg_size; - /*! \brief currently received msgb */ + /*! currently received msgb */ struct msgb *msg; - /*! \brief receive state */ + /*! receive state */ int state; - /*! \brief DLCI of currently received msgb */ + /*! DLCI of currently received msgb */ uint8_t dlci; - /*! \brief CTRL of currently received msgb */ + /*! CTRL of currently received msgb */ uint8_t ctrl; } rx; }; @@ -86,7 +86,7 @@ int osmo_sercomm_drv_rx_char(struct osmo_sercomm_inst *sercomm, uint8_t ch); extern void sercomm_drv_lock(unsigned long *flags); extern void sercomm_drv_unlock(unsigned long *flags); -/*! \brief low-level driver routine to request start of transmission +/*! low-level driver routine to request start of transmission * The Sercomm code calls this function to inform the low-level driver * that some data is pending for transmission, and the low-level driver * should (if not active already) start enabling tx_empty interrupts @@ -96,14 +96,14 @@ extern void sercomm_drv_unlock(unsigned long *flags); */ extern void sercomm_drv_start_tx(struct osmo_sercomm_inst *sercomm); -/*! \brief low-level driver routine to execute baud-rate change +/*! low-level driver routine to execute baud-rate change * \param[in] sercomm Osmocom sercomm instance for which to change * \param[in] bdrt New Baud-Rate (integer) * \returns 0 on success; negative in case of error */ extern int sercomm_drv_baudrate_chg(struct osmo_sercomm_inst *sercomm, uint32_t bdrt); -/*! \brief Sercomm msgb allocator function */ +/*! Sercomm msgb allocator function */ static inline struct msgb *osmo_sercomm_alloc_msgb(unsigned int len) { return msgb_alloc_headroom(len+4, 4, "sercomm_tx"); diff --git a/include/osmocom/core/signal.h b/include/osmocom/core/signal.h index 5ed4e151..d7132f9d 100644 --- a/include/osmocom/core/signal.h +++ b/include/osmocom/core/signal.h @@ -13,7 +13,7 @@ #define OSMO_SIGNAL_SS_APPS 0 #define OSMO_SIGNAL_SS_RESERVED 2147483648u -/*! \brief signal subsystems */ +/*! signal subsystems */ enum { SS_L_GLOBAL = OSMO_SIGNAL_SS_RESERVED, SS_L_INPUT, @@ -25,7 +25,7 @@ enum { #define OSMO_SIGNAL_T_APPS 0 #define OSMO_SIGNAL_T_RESERVED 2147483648u -/*! \brief signal types. */ +/*! signal types. */ enum { S_L_GLOBAL_SHUTDOWN = OSMO_SIGNAL_T_RESERVED, }; diff --git a/include/osmocom/core/socket.h b/include/osmocom/core/socket.h index 09376c39..d6a5662b 100644 --- a/include/osmocom/core/socket.h +++ b/include/osmocom/core/socket.h @@ -5,7 +5,7 @@ */ /*! \file socket.h - * \brief Osmocom socket convenience functions + * Osmocom socket convenience functions */ #include <stdint.h> diff --git a/include/osmocom/core/stat_item.h b/include/osmocom/core/stat_item.h index 181b029f..957918ae 100644 --- a/include/osmocom/core/stat_item.h +++ b/include/osmocom/core/stat_item.h @@ -20,49 +20,49 @@ struct osmo_stat_item_value { int32_t value; }; -/*! \brief data we keep for each actual value */ +/*! data we keep for each actual value */ struct osmo_stat_item { const struct osmo_stat_item_desc *desc; - /*! \brief the index of the freshest value */ + /*! the index of the freshest value */ int32_t last_value_index; - /*! \brief offset to the freshest value in the value fifo */ + /*! offset to the freshest value in the value fifo */ int16_t last_offs; - /*! \brief value fifo */ + /*! value fifo */ struct osmo_stat_item_value values[0]; }; -/*! \brief statistics value description */ +/*! statistics value description */ struct osmo_stat_item_desc { - const char *name; /*!< \brief name of the item */ - const char *description;/*!< \brief description of the item */ - const char *unit; /*!< \brief unit of a value */ - unsigned int num_values;/*!< \brief number of values to store */ + const char *name; /*!< name of the item */ + const char *description;/*!< description of the item */ + const char *unit; /*!< unit of a value */ + unsigned int num_values;/*!< number of values to store */ int32_t default_value; }; -/*! \brief description of a statistics value group */ +/*! description of a statistics value group */ struct osmo_stat_item_group_desc { - /*! \brief The prefix to the name of all values in this group */ + /*! The prefix to the name of all values in this group */ const char *group_name_prefix; - /*! \brief The human-readable description of the group */ + /*! The human-readable description of the group */ const char *group_description; - /*! \brief The class to which this group belongs */ + /*! The class to which this group belongs */ int class_id; - /*! \brief The number of values in this group */ + /*! The number of values in this group */ const unsigned int num_items; - /*! \brief Pointer to array of value names */ + /*! Pointer to array of value names */ const struct osmo_stat_item_desc *item_desc; }; -/*! \brief One instance of a counter group class */ +/*! One instance of a counter group class */ struct osmo_stat_item_group { - /*! \brief Linked list of all value groups in the system */ + /*! Linked list of all value groups in the system */ struct llist_head list; - /*! \brief Pointer to the counter group class */ + /*! Pointer to the counter group class */ const struct osmo_stat_item_group_desc *desc; - /*! \brief The index of this value group within its class */ + /*! The index of this value group within its class */ unsigned int idx; - /*! \brief Actual counter structures below */ + /*! Actual counter structures below */ struct osmo_stat_item *items[0]; }; @@ -89,7 +89,7 @@ struct osmo_stat_item_group *osmo_stat_item_get_group_by_name_idx( const struct osmo_stat_item *osmo_stat_item_get_by_name( const struct osmo_stat_item_group *statg, const char *name); -/*! \brief Retrieve the next value from the osmo_stat_item object. +/*! Retrieve the next value from the osmo_stat_item object. * If a new value has been set, it is returned. The idx is used to decide * which value to return. * On success, *idx is updated to refer to the next unread value. If @@ -107,13 +107,13 @@ const struct osmo_stat_item *osmo_stat_item_get_by_name( */ int osmo_stat_item_get_next(const struct osmo_stat_item *item, int32_t *idx, int32_t *value); -/*! \brief Get the last (freshest) value */ +/*! Get the last (freshest) value */ static int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item); -/*! \brief Skip all values of the item and update idx accordingly */ +/*! Skip all values of the item and update idx accordingly */ int osmo_stat_item_discard(const struct osmo_stat_item *item, int32_t *idx); -/*! \brief Skip all values of all items and update idx accordingly */ +/*! Skip all values of all items and update idx accordingly */ int osmo_stat_item_discard_all(int32_t *idx); typedef int (*osmo_stat_item_handler_t)( @@ -121,7 +121,7 @@ typedef int (*osmo_stat_item_handler_t)( typedef int (*osmo_stat_item_group_handler_t)(struct osmo_stat_item_group *, void *); -/*! \brief Iteate over all items +/*! Iteate over all items * \param[in] handle_item Call-back function, aborts if rc < 0 * \param[in] data Private data handed through to \a handle_item */ diff --git a/include/osmocom/core/statistics.h b/include/osmocom/core/statistics.h index 41716ccf..5ebb5fc0 100644 --- a/include/osmocom/core/statistics.h +++ b/include/osmocom/core/statistics.h @@ -1,60 +1,60 @@ #pragma once /*! \file statistics.h - * \brief Common routines regarding statistics */ + * Common routines regarding statistics */ /*! structure representing a single counter */ struct osmo_counter { - struct llist_head list; /*!< \brief internal list head */ - const char *name; /*!< \brief human-readable name */ - const char *description; /*!< \brief humn-readable description */ - unsigned long value; /*!< \brief current value */ - unsigned long previous; /*!< \brief previous value */ + struct llist_head list; /*!< internal list head */ + const char *name; /*!< human-readable name */ + const char *description; /*!< humn-readable description */ + unsigned long value; /*!< current value */ + unsigned long previous; /*!< previous value */ }; -/*! \brief Decrement counter */ +/*! Decrement counter */ static inline void osmo_counter_dec(struct osmo_counter *ctr) { ctr->value--; } -/*! \brief Increment counter */ +/*! Increment counter */ static inline void osmo_counter_inc(struct osmo_counter *ctr) { ctr->value++; } -/*! \brief Get current value of counter */ +/*! Get current value of counter */ static inline unsigned long osmo_counter_get(struct osmo_counter *ctr) { return ctr->value; } -/*! \brief Reset current value of counter to 0 */ +/*! Reset current value of counter to 0 */ static inline void osmo_counter_reset(struct osmo_counter *ctr) { ctr->value = 0; } -/*! \brief Allocate a new counter */ +/*! Allocate a new counter */ struct osmo_counter *osmo_counter_alloc(const char *name); -/*! \brief Free the specified counter +/*! Free the specified counter * \param[in] ctr Counter */ void osmo_counter_free(struct osmo_counter *ctr); -/*! \brief Iterate over all counters +/*! Iterate over all counters * \param[in] handle_counter Call-back function, aborts if rc < 0 * \param[in] data Private dtata handed through to \a handle_counter */ int osmo_counters_for_each(int (*handle_counter)(struct osmo_counter *, void *), void *data); -/*! \brief Resolve counter by human-readable name +/*! Resolve counter by human-readable name * \param[in] name human-readable name of counter * \returns pointer to counter (\ref osmo_counter) or NULL otherwise */ struct osmo_counter *osmo_counter_get_by_name(const char *name); -/*! \brief Return the counter difference since the last call to this function */ +/*! Return the counter difference since the last call to this function */ int osmo_counter_difference(struct osmo_counter *ctr); diff --git a/include/osmocom/core/strrb.h b/include/osmocom/core/strrb.h index 7507cf41..2b4d89f0 100644 --- a/include/osmocom/core/strrb.h +++ b/include/osmocom/core/strrb.h @@ -24,7 +24,7 @@ */ /*! \file strrb.h - * \brief Osmocom string ringbuffer handling routines + * Osmocom string ringbuffer handling routines */ #include <unistd.h> @@ -33,14 +33,14 @@ #include <osmocom/core/talloc.h> -/*! \brief A structure representing an osmocom string ringbuffer */ +/*! A structure representing an osmocom string ringbuffer */ #define RB_MAX_MESSAGE_SIZE 240 struct osmo_strrb { - uint16_t start; /*!< \brief index of the first slot */ - uint16_t end; /*!< \brief index of the last slot */ - uint16_t size; /*!< \brief max number of messages to store */ - char **buffer; /*!< \brief storage for messages */ + uint16_t start; /*!< index of the first slot */ + uint16_t end; /*!< index of the last slot */ + uint16_t size; /*!< max number of messages to store */ + char **buffer; /*!< storage for messages */ }; struct osmo_strrb *osmo_strrb_create(TALLOC_CTX * ctx, size_t rb_size); diff --git a/include/osmocom/core/timer.h b/include/osmocom/core/timer.h index 48e7d8da..28785dbd 100644 --- a/include/osmocom/core/timer.h +++ b/include/osmocom/core/timer.h @@ -23,7 +23,7 @@ */ /*! \file timer.h - * \brief Osmocom timer handling routines + * Osmocom timer handling routines */ #pragma once @@ -50,15 +50,15 @@ * remove the timers. * */ -/*! \brief A structure representing a single instance of a timer */ +/*! A structure representing a single instance of a timer */ struct osmo_timer_list { - struct rb_node node; /*!< \brief rb-tree node header */ - struct llist_head list; /*!< \brief internal list header */ - struct timeval timeout; /*!< \brief expiration time */ - unsigned int active : 1; /*!< \brief is it active? */ + struct rb_node node; /*!< rb-tree node header */ + struct llist_head list; /*!< internal list header */ + struct timeval timeout; /*!< expiration time */ + unsigned int active : 1; /*!< is it active? */ - void (*cb)(void*); /*!< \brief call-back called at timeout */ - void *data; /*!< \brief user data for callback */ + void (*cb)(void*); /*!< call-back called at timeout */ + void *data; /*!< user data for callback */ }; /** diff --git a/include/osmocom/core/timer_compat.h b/include/osmocom/core/timer_compat.h index fb2967ba..44259afe 100644 --- a/include/osmocom/core/timer_compat.h +++ b/include/osmocom/core/timer_compat.h @@ -23,7 +23,7 @@ */ /*! \file timer_compat.h - * \brief Compatibility header with some helpers + * Compatibility header with some helpers */ #pragma once diff --git a/include/osmocom/core/utils.h b/include/osmocom/core/utils.h index 1d1ebd8a..ce49cbe7 100644 --- a/include/osmocom/core/utils.h +++ b/include/osmocom/core/utils.h @@ -9,26 +9,26 @@ /*! \file utils.h */ -/*! \brief Determine number of elements in an array of static size */ +/*! Determine number of elements in an array of static size */ #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) -/*! \brief Return the maximum of two specified values */ +/*! Return the maximum of two specified values */ #define OSMO_MAX(a, b) ((a) >= (b) ? (a) : (b)) -/*! \brief Return the minimum of two specified values */ +/*! Return the minimum of two specified values */ #define OSMO_MIN(a, b) ((a) >= (b) ? (b) : (a)) -/*! \brief Stringify the contents of a macro, e.g. a port number */ +/*! Stringify the contents of a macro, e.g. a port number */ #define OSMO_STRINGIFY(x) #x -/*! \brief Make a value_string entry from an enum value name */ +/*! Make a value_string entry from an enum value name */ #define OSMO_VALUE_STRING(x) { x, #x } -/*! \brief Number of bytes necessary to store given BITS */ +/*! Number of bytes necessary to store given BITS */ #define OSMO_BYTES_FOR_BITS(BITS) ((BITS + 8 - 1) / 8) #include <stdint.h> #include <stdio.h> -/*! \brief A mapping between human-readable string and numeric value */ +/*! A mapping between human-readable string and numeric value */ struct value_string { - unsigned int value; /*!< \brief numeric value */ - const char *str; /*!< \brief human-readable string */ + unsigned int value; /*!< numeric value */ + const char *str; /*!< human-readable string */ }; const char *get_value_string(const struct value_string *vs, uint32_t val); diff --git a/include/osmocom/core/write_queue.h b/include/osmocom/core/write_queue.h index 4e0fdf3d..27d090d0 100644 --- a/include/osmocom/core/write_queue.h +++ b/include/osmocom/core/write_queue.h @@ -34,21 +34,21 @@ /*! write queue instance */ struct osmo_wqueue { - /*! \brief osmocom file descriptor */ + /*! osmocom file descriptor */ struct osmo_fd bfd; - /*! \brief maximum length of write queue */ + /*! maximum length of write queue */ unsigned int max_length; - /*! \brief current length of write queue */ + /*! current length of write queue */ unsigned int current_length; - /*! \brief actual linked list implementing the queue */ + /*! actual linked list implementing the queue */ struct llist_head msg_queue; - /*! \brief call-back in case qeueue is readable */ + /*! call-back in case qeueue is readable */ int (*read_cb)(struct osmo_fd *fd); - /*! \brief call-back in case qeueue is writable */ + /*! call-back in case qeueue is writable */ int (*write_cb)(struct osmo_fd *fd, struct msgb *msg); - /*! \brief call-back in case qeueue has exceptions */ + /*! call-back in case qeueue has exceptions */ int (*except_cb)(struct osmo_fd *fd); }; diff --git a/include/osmocom/crypt/auth.h b/include/osmocom/crypt/auth.h index 7a27f3b3..af4ae153 100644 --- a/include/osmocom/crypt/auth.h +++ b/include/osmocom/crypt/auth.h @@ -10,14 +10,14 @@ #include <osmocom/core/linuxlist.h> -/*! \brief Authentication Type (GSM/UMTS) */ +/*! Authentication Type (GSM/UMTS) */ enum osmo_sub_auth_type { OSMO_AUTH_TYPE_NONE = 0x00, OSMO_AUTH_TYPE_GSM = 0x01, OSMO_AUTH_TYPE_UMTS = 0x02, }; -/*! \brief Authentication Algorithm */ +/*! Authentication Algorithm */ enum osmo_auth_algo { OSMO_AUTH_ALG_NONE, OSMO_AUTH_ALG_COMP128v1, @@ -28,7 +28,7 @@ enum osmo_auth_algo { _OSMO_AUTH_ALG_NUM, }; -/*! \brief permanent (secret) subscriber auth data */ +/*! permanent (secret) subscriber auth data */ struct osmo_sub_auth_data { enum osmo_sub_auth_type type; enum osmo_auth_algo algo; @@ -61,19 +61,19 @@ struct osmo_auth_vector { uint32_t auth_types; /*!< bitmask of OSMO_AUTH_TYPE_* */ }; -/* \brief An implementation of an authentication algorithm */ +/* An implementation of an authentication algorithm */ struct osmo_auth_impl { struct llist_head list; enum osmo_auth_algo algo; /*!< algorithm we implement */ const char *name; /*!< name of the implementation */ unsigned int priority; /*!< priority value (resp. othe implementations */ - /*! \brief callback for generate authentication vectors */ + /*! callback for generate authentication vectors */ int (*gen_vec)(struct osmo_auth_vector *vec, struct osmo_sub_auth_data *aud, const uint8_t *_rand); - /* \brief callback for generationg auth vectors + re-sync */ + /* callback for generationg auth vectors + re-sync */ int (*gen_vec_auts)(struct osmo_auth_vector *vec, struct osmo_sub_auth_data *aud, const uint8_t *auts, const uint8_t *rand_auts, diff --git a/include/osmocom/gprs/gprs_bssgp.h b/include/osmocom/gprs/gprs_bssgp.h index b70487ce..0e9f7d68 100644 --- a/include/osmocom/gprs/gprs_bssgp.h +++ b/include/osmocom/gprs/gprs_bssgp.h @@ -58,7 +58,7 @@ struct osmo_bssgp_prim { /* gprs_bssgp.c */ -/*! \brief BSSGP flow control (SGSN side) According to Section 8.2 */ +/*! BSSGP flow control (SGSN side) According to Section 8.2 */ struct bssgp_flow_control { uint32_t bucket_size_max; /*!< maximum size of the bucket (octets) */ uint32_t bucket_leak_rate; /*!< leak rate of the bucket (octets/sec) */ @@ -158,13 +158,13 @@ static inline int bssgp_tlv_parse(struct tlv_parsed *tp, uint8_t *buf, int len) return tlv_parse(tp, &tvlv_att_def, buf, len, 0, 0); } -/*! \brief BSSGP Paging mode */ +/*! BSSGP Paging mode */ enum bssgp_paging_mode { BSSGP_PAGING_PS, BSSGP_PAGING_CS, }; -/*! \brief BSSGP Paging scope */ +/*! BSSGP Paging scope */ enum bssgp_paging_scope { BSSGP_PAGING_BSS_AREA, /*!< all cells in BSS */ BSSGP_PAGING_LOCATION_AREA, /*!< all cells in LA */ @@ -172,7 +172,7 @@ enum bssgp_paging_scope { BSSGP_PAGING_BVCI, /*!< one cell */ }; -/*! \brief BSSGP paging information */ +/*! BSSGP paging information */ struct bssgp_paging_info { enum bssgp_paging_mode mode; /*!< CS or PS paging */ enum bssgp_paging_scope scope; /*!< bssgp_paging_scope */ diff --git a/include/osmocom/gprs/gprs_ns.h b/include/osmocom/gprs/gprs_ns.h index 9cebbd6a..5ecaed8c 100644 --- a/include/osmocom/gprs/gprs_ns.h +++ b/include/osmocom/gprs/gprs_ns.h @@ -41,19 +41,19 @@ enum ns_timeout { #define NSE_S_ALIVE 0x0002 #define NSE_S_RESET 0x0004 -/*! \brief Osmocom NS link layer types */ +/*! Osmocom NS link layer types */ enum gprs_ns_ll { GPRS_NS_LL_UDP, /*!< NS/UDP/IP */ GPRS_NS_LL_E1, /*!< NS/E1 */ GPRS_NS_LL_FR_GRE, /*!< NS/FR/GRE/IP */ }; -/*! \brief Osmoco NS events */ +/*! Osmoco NS events */ enum gprs_ns_evt { GPRS_NS_EVT_UNIT_DATA, }; -/*! \brief Osmocom NS VC create status */ +/*! Osmocom NS VC create status */ enum gprs_ns_cs { GPRS_NS_CS_CREATED, /*!< A NSVC object has been created */ GPRS_NS_CS_FOUND, /*!< A NSVC object has been found */ @@ -63,32 +63,32 @@ enum gprs_ns_cs { }; struct gprs_nsvc; -/*! \brief Osmocom GPRS callback function type */ +/*! Osmocom GPRS callback function type */ typedef int gprs_ns_cb_t(enum gprs_ns_evt event, struct gprs_nsvc *nsvc, struct msgb *msg, uint16_t bvci); -/*! \brief An instance of the NS protocol stack */ +/*! An instance of the NS protocol stack */ struct gprs_ns_inst { - /*! \brief callback to the user for incoming UNIT DATA IND */ + /*! callback to the user for incoming UNIT DATA IND */ gprs_ns_cb_t *cb; - /*! \brief linked lists of all NSVC in this instance */ + /*! linked lists of all NSVC in this instance */ struct llist_head gprs_nsvcs; - /*! \brief a NSVC object that's needed to deal with packets for + /*! a NSVC object that's needed to deal with packets for * unknown NSVC */ struct gprs_nsvc *unknown_nsvc; uint16_t timeout[NS_TIMERS_COUNT]; - /*! \brief NS-over-IP specific bits */ + /*! NS-over-IP specific bits */ struct { struct osmo_fd fd; uint32_t local_ip; uint16_t local_port; int dscp; } nsip; - /*! \brief NS-over-FR-over-GRE-over-IP specific bits */ + /*! NS-over-FR-over-GRE-over-IP specific bits */ struct { struct osmo_fd fd; uint32_t local_ip; @@ -104,15 +104,15 @@ enum nsvc_timer_mode { _NSVC_TIMER_NR, }; -/*! \brief Structure representing a single NS-VC */ +/*! Structure representing a single NS-VC */ struct gprs_nsvc { - /*! \brief list of NS-VCs within NS Instance */ + /*! list of NS-VCs within NS Instance */ struct llist_head list; - /*! \brief pointer to NS Instance */ + /*! pointer to NS Instance */ struct gprs_ns_inst *nsi; - uint16_t nsei; /*! \brief end-to-end significance */ - uint16_t nsvci; /*! \brief uniquely identifies NS-VC at SGSN */ + uint16_t nsei; /*! end-to-end significance */ + uint16_t nsvci; /*! uniquely identifies NS-VC at SGSN */ uint32_t state; uint32_t remote_state; @@ -129,7 +129,7 @@ struct gprs_nsvc { struct rate_ctr_group *ctrg; struct osmo_stat_item_group *statg; - /*! \brief which link-layer are we based on? */ + /*! which link-layer are we based on? */ enum gprs_ns_ll ll; union { diff --git a/include/osmocom/gprs/gprs_rlc.h b/include/osmocom/gprs/gprs_rlc.h index d34d49bf..5765281b 100644 --- a/include/osmocom/gprs/gprs_rlc.h +++ b/include/osmocom/gprs/gprs_rlc.h @@ -2,14 +2,14 @@ #include <stdint.h> -/*! \brief Structure for CPS coding and puncturing scheme (TS 04.60 10.4.8a) */ +/*! Structure for CPS coding and puncturing scheme (TS 04.60 10.4.8a) */ struct egprs_cps { uint8_t bits; uint8_t mcs; uint8_t p[2]; }; -/*! \brief CPS puncturing table selection (TS 04.60 10.4.8a) */ +/*! CPS puncturing table selection (TS 04.60 10.4.8a) */ enum egprs_cps_punc { EGPRS_CPS_P1, EGPRS_CPS_P2, @@ -17,7 +17,7 @@ enum egprs_cps_punc { EGPRS_CPS_NONE = -1, }; -/*! \brief EGPRS header types (TS 04.60 10.0a.2) */ +/*! EGPRS header types (TS 04.60 10.0a.2) */ enum egprs_hdr_type { EGPRS_HDR_TYPE1, EGPRS_HDR_TYPE2, diff --git a/include/osmocom/gprs/protocol/gsm_08_16.h b/include/osmocom/gprs/protocol/gsm_08_16.h index 56ed5947..c3dbe695 100644 --- a/include/osmocom/gprs/protocol/gsm_08_16.h +++ b/include/osmocom/gprs/protocol/gsm_08_16.h @@ -12,7 +12,7 @@ /*! \file gprs_ns.h */ -/*! \brief Common header of GPRS NS */ +/*! Common header of GPRS NS */ struct gprs_ns_hdr { uint8_t pdu_type; /*!< NS PDU type */ uint8_t data[0]; /*!< variable-length payload */ @@ -20,7 +20,7 @@ struct gprs_ns_hdr { extern const struct value_string gprs_ns_pdu_strings[]; -/*! \brief NS PDU Type (TS 08.16, Section 10.3.7, Table 14) */ +/*! NS PDU Type (TS 08.16, Section 10.3.7, Table 14) */ enum ns_pdu_type { NS_PDUT_UNITDATA = 0x00, NS_PDUT_RESET = 0x02, @@ -43,7 +43,7 @@ enum ns_pdu_type { SNS_PDUT_SIZE_ACK = 0x13, }; -/*! \brief NS Control IE (TS 08.16, Section 10.3, Table 12) */ +/*! NS Control IE (TS 08.16, Section 10.3, Table 12) */ enum ns_ctrl_ie { NS_IE_CAUSE = 0x00, NS_IE_VCI = 0x01, @@ -60,7 +60,7 @@ enum ns_ctrl_ie { NS_IE_IP_ADDR = 0x0b, }; -/*! \brief NS Cause (TS 08.16, Section 10.3.2, Table 13) */ +/*! NS Cause (TS 08.16, Section 10.3.2, Table 13) */ enum ns_cause { NS_CAUSE_TRANSIT_FAIL = 0x00, NS_CAUSE_OM_INTERVENTION = 0x01, diff --git a/include/osmocom/gprs/protocol/gsm_08_18.h b/include/osmocom/gprs/protocol/gsm_08_18.h index 529e9889..8bc9a8ea 100644 --- a/include/osmocom/gprs/protocol/gsm_08_18.h +++ b/include/osmocom/gprs/protocol/gsm_08_18.h @@ -2,11 +2,11 @@ #include <stdint.h> -/*! \brief Fixed BVCI definitions (Section 5.4.1) */ +/*! Fixed BVCI definitions (Section 5.4.1) */ #define BVCI_SIGNALLING 0x0000 #define BVCI_PTM 0x0001 -/*! \brief BSSGP PDU types (Section 11.3.26 / Table 11.27) */ +/*! BSSGP PDU types (Section 11.3.26 / Table 11.27) */ enum bssgp_pdu_type { /* PDUs between RL and BSSGP SAPs */ BSSGP_PDUT_DL_UNITDATA = 0x00, @@ -52,7 +52,7 @@ enum bssgp_pdu_type { BSSGP_PDUT_DELETE_BSS_PFC_ACK = 0x57, }; -/*! \brief BSSGP User-Data header (Section 10.2.1 and 10.2.2) */ +/*! BSSGP User-Data header (Section 10.2.1 and 10.2.2) */ struct bssgp_ud_hdr { uint8_t pdu_type; /*!< BSSGP PDU type */ uint32_t tlli; /*!< Temporary Link-Local Identifier */ @@ -60,13 +60,13 @@ struct bssgp_ud_hdr { uint8_t data[0]; /* optional/conditional IEs as TLVs */ } __attribute__((packed)); -/*! \brief BSSGP normal header */ +/*! BSSGP normal header */ struct bssgp_normal_hdr { uint8_t pdu_type; /*!< BSSGP PDU type */ uint8_t data[0]; /*!< optional/conditional IEs as TLVs */ }; -/*! \brief BSSGP Information Element Identifiers */ +/*! BSSGP Information Element Identifiers */ enum bssgp_iei_type { BSSGP_IE_ALIGNMENT = 0x00, BSSGP_IE_BMAX_DEFAULT_MS = 0x01, @@ -116,7 +116,7 @@ enum bssgp_iei_type { BSSGP_IE_SERVICE_UTRAN_CCO = 0x3d, }; -/*! \brief Cause coding (Section 11.3.8 / Table 11.10) */ +/*! Cause coding (Section 11.3.8 / Table 11.10) */ enum gprs_bssgp_cause { BSSGP_CAUSE_PROC_OVERLOAD = 0x00, BSSGP_CAUSE_EQUIP_FAIL = 0x01, diff --git a/include/osmocom/gsm/a5.h b/include/osmocom/gsm/a5.h index a2278f22..893fb026 100644 --- a/include/osmocom/gsm/a5.h +++ b/include/osmocom/gsm/a5.h @@ -32,10 +32,10 @@ */ /*! \file gsm/a5.h - * \brief Osmocom GSM A5 ciphering algorithm header + * Osmocom GSM A5 ciphering algorithm header */ -/*! \brief Converts a frame number into the 22 bit number used in A5/x +/*! Converts a frame number into the 22 bit number used in A5/x * \param[in] fn The true framenumber * \return 22 bit word */ diff --git a/include/osmocom/gsm/abis_nm.h b/include/osmocom/gsm/abis_nm.h index 14dbc08c..acddb7f4 100644 --- a/include/osmocom/gsm/abis_nm.h +++ b/include/osmocom/gsm/abis_nm.h @@ -36,7 +36,7 @@ const char *abis_nm_test_name(uint8_t test); extern const struct tlv_definition abis_nm_osmo_att_tlvdef; extern const struct tlv_definition abis_nm_att_tlvdef_ipa; -/*! \brief write a human-readable OML header to the debug log +/*! write a human-readable OML header to the debug log * \param[in] ss Logging sub-system * \param[in] foh A-bis OML FOM header */ diff --git a/include/osmocom/gsm/gsm_utils.h b/include/osmocom/gsm/gsm_utils.h index 1ffe5797..e76d9ee8 100644 --- a/include/osmocom/gsm/gsm_utils.h +++ b/include/osmocom/gsm/gsm_utils.h @@ -60,7 +60,7 @@ const char *gsm_band_name(enum gsm_band band); enum gsm_band gsm_band_parse(const char *mhz); /*! - * \brief Decode a sequence of GSM 03.38 encoded 7 bit characters. + * Decode a sequence of GSM 03.38 encoded 7 bit characters. * * \param decoded The destination buffer for the decoded characters. * \param n A maximum of n chars is written (incl. terminating \0). @@ -76,14 +76,14 @@ enum gsm_band gsm_band_parse(const char *mhz); int gsm_7bit_decode_n(char *decoded, size_t n, const uint8_t *user_data, uint8_t length); /*! - * \brief Decode a sequence of 7 bit characters (USSD encoding). + * Decode a sequence of 7 bit characters (USSD encoding). * * \see gsm_7bit_encode_n() */ int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, uint8_t length); /*! - * \brief Encode a text string into GSM 03.38 encoded 7 bit characters. + * Encode a text string into GSM 03.38 encoded 7 bit characters. * * \param result The destination buffer for the packed 7 bit sequence. * \param n A maximum of n octets is written. @@ -97,7 +97,7 @@ int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, ui int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets_written); /*! - * \brief Encode a text string into GSM 03.38 encoded 7 bit characters (USSD encoding). + * Encode a text string into GSM 03.38 encoded 7 bit characters (USSD encoding). * * \see gsm_7bit_decode_n() */ diff --git a/include/osmocom/gsm/kasumi.h b/include/osmocom/gsm/kasumi.h index 8ecf65f6..222aece8 100644 --- a/include/osmocom/gsm/kasumi.h +++ b/include/osmocom/gsm/kasumi.h @@ -9,7 +9,7 @@ #include <stdint.h> -/*! \brief Single iteration of KASUMI cipher +/*! Single iteration of KASUMI cipher * \param[in] P Block, 64 bits to be processed in this round * \param[in] KLi1 Expanded subkeys * \param[in] KLi2 Expanded subkeys @@ -23,7 +23,7 @@ */ uint64_t _kasumi(uint64_t P, const uint16_t *KLi1, const uint16_t *KLi2, const uint16_t *KOi1, const uint16_t *KOi2, const uint16_t *KOi3, const uint16_t *KIi1, const uint16_t *KIi2, const uint16_t *KIi3); -/*! \brief Implementation of the KGCORE algorithm (used by A5/3, A5/4, GEA3, GEA4 and ECSD) +/*! Implementation of the KGCORE algorithm (used by A5/3, A5/4, GEA3, GEA4 and ECSD) * \param[in] CA * \param[in] cb * \param[in] cc @@ -34,7 +34,7 @@ uint64_t _kasumi(uint64_t P, const uint16_t *KLi1, const uint16_t *KLi2, const u */ void _kasumi_kgcore(uint8_t CA, uint8_t cb, uint32_t cc, uint8_t cd, const uint8_t *ck, uint8_t *co, uint16_t cl); -/*! \brief Expand key into set of subkeys - see TS 135 202 for details +/*! Expand key into set of subkeys - see TS 135 202 for details * \param[in] key (128 bits) as array of bytes * \param[out] KLi1 Expanded subkeys * \param[out] KLi2 Expanded subkeys diff --git a/include/osmocom/gsm/l1sap.h b/include/osmocom/gsm/l1sap.h index 183edbcb..322c7ec1 100644 --- a/include/osmocom/gsm/l1sap.h +++ b/include/osmocom/gsm/l1sap.h @@ -2,51 +2,51 @@ #include <osmocom/core/prim.h> -/*! \brief PH-SAP related primitives (L1<->L2 SAP) */ +/*! PH-SAP related primitives (L1<->L2 SAP) */ enum osmo_ph_prim { - PRIM_PH_DATA, /*!< \brief PH-DATA */ - PRIM_PH_RACH, /*!< \brief PH-RANDOM_ACCESS */ - PRIM_PH_CONN, /*!< \brief PH-CONNECT */ - PRIM_PH_EMPTY_FRAME, /*!< \brief PH-EMPTY_FRAME */ - PRIM_PH_RTS, /*!< \brief PH-RTS */ - PRIM_MPH_INFO, /*!< \brief MPH-INFO */ - PRIM_TCH, /*!< \brief TCH */ - PRIM_TCH_RTS, /*!< \brief TCH */ + PRIM_PH_DATA, /*!< PH-DATA */ + PRIM_PH_RACH, /*!< PH-RANDOM_ACCESS */ + PRIM_PH_CONN, /*!< PH-CONNECT */ + PRIM_PH_EMPTY_FRAME, /*!< PH-EMPTY_FRAME */ + PRIM_PH_RTS, /*!< PH-RTS */ + PRIM_MPH_INFO, /*!< MPH-INFO */ + PRIM_TCH, /*!< TCH */ + PRIM_TCH_RTS, /*!< TCH */ }; extern const struct value_string osmo_ph_prim_names[]; -/*! \brief PH-SAP related primitives (L1<->L2 SAP) */ +/*! PH-SAP related primitives (L1<->L2 SAP) */ enum osmo_mph_info_type { - PRIM_INFO_TIME, /*!< \brief Current GSM time */ - PRIM_INFO_MEAS, /*!< \brief Measurement indication */ - PRIM_INFO_ACTIVATE, /*!< \brief Activation of channel */ - PRIM_INFO_DEACTIVATE, /*!< \brief Deactivation of channel */ - PRIM_INFO_MODIFY, /*!< \brief Mode Modify of channel */ - PRIM_INFO_ACT_CIPH, /*!< \brief Activation of ciphering */ - PRIM_INFO_DEACT_CIPH, /*!< \brief Deactivation of ciphering */ + PRIM_INFO_TIME, /*!< Current GSM time */ + PRIM_INFO_MEAS, /*!< Measurement indication */ + PRIM_INFO_ACTIVATE, /*!< Activation of channel */ + PRIM_INFO_DEACTIVATE, /*!< Deactivation of channel */ + PRIM_INFO_MODIFY, /*!< Mode Modify of channel */ + PRIM_INFO_ACT_CIPH, /*!< Activation of ciphering */ + PRIM_INFO_DEACT_CIPH, /*!< Deactivation of ciphering */ }; -/*! \brief PH-DATA presence information */ +/*! PH-DATA presence information */ enum osmo_ph_pres_info_type { - PRES_INFO_INVALID = 0, /*!< \brief Data is invalid */ - PRES_INFO_HEADER = 1, /*!< \brief Only header is present and valid */ - PRES_INFO_FIRST = 3, /*!< \brief First half of data + header are valid (2nd half may be present but invalid) */ - PRES_INFO_SECOND = 5, /*!< \brief Second half of data + header are valid (1st halfmay be present but invalid) */ - PRES_INFO_BOTH = 7, /*!< \brief Both parts + header are present and valid */ + PRES_INFO_INVALID = 0, /*!< Data is invalid */ + PRES_INFO_HEADER = 1, /*!< Only header is present and valid */ + PRES_INFO_FIRST = 3, /*!< First half of data + header are valid (2nd half may be present but invalid) */ + PRES_INFO_SECOND = 5, /*!< Second half of data + header are valid (1st halfmay be present but invalid) */ + PRES_INFO_BOTH = 7, /*!< Both parts + header are present and valid */ PRES_INFO_UNKNOWN }; -/*! \brief for PH-RANDOM_ACCESS.req */ +/*! for PH-RANDOM_ACCESS.req */ struct ph_rach_req_param { - uint8_t ra; /*!< \brief Random Access */ - uint8_t ta; /*!< \brief Timing Advance */ - uint8_t tx_power; /*!< \brief Transmit Power */ - uint8_t is_combined_ccch;/*!< \brief Are we using a combined CCCH? */ - uint16_t offset; /*!< \brief Timing Offset */ + uint8_t ra; /*!< Random Access */ + uint8_t ta; /*!< Timing Advance */ + uint8_t tx_power; /*!< Transmit Power */ + uint8_t is_combined_ccch;/*!< Are we using a combined CCCH? */ + uint16_t offset; /*!< Timing Offset */ }; -/*! \brief for PH_RA_IND burstType inforamtion */ +/*! for PH_RA_IND burstType inforamtion */ enum ph_burst_type { GSM_L1_BURST_TYPE_NONE = 0, GSM_L1_BURST_TYPE_ACCESS_0, @@ -54,79 +54,79 @@ enum ph_burst_type { GSM_L1_BURST_TYPE_ACCESS_2 }; -/*! \brief for PH-RANDOM_ACCESS.ind */ +/*! for PH-RANDOM_ACCESS.ind */ struct ph_rach_ind_param { - uint8_t chan_nr; /*!< \brief Channel Number (Like RSL) */ - uint16_t ra; /*!< \brief Random Access */ - uint8_t acc_delay; /*!< \brief Delay in bit periods */ - uint32_t fn; /*!< \brief GSM Frame Number at time of RA */ - uint8_t is_11bit; /*!< \brief no.of bits in RACH*/ - enum ph_burst_type burst_type; /*!< \brief type of burst*/ + uint8_t chan_nr; /*!< Channel Number (Like RSL) */ + uint16_t ra; /*!< Random Access */ + uint8_t acc_delay; /*!< Delay in bit periods */ + uint32_t fn; /*!< GSM Frame Number at time of RA */ + uint8_t is_11bit; /*!< no.of bits in RACH*/ + enum ph_burst_type burst_type; /*!< type of burst*/ }; -/*! \brief for PH-[UNIT]DATA.{req,ind} | PH-RTS.ind */ +/*! for PH-[UNIT]DATA.{req,ind} | PH-RTS.ind */ struct ph_data_param { - uint8_t link_id; /*!< \brief Link Identifier (Like RSL) */ - uint8_t chan_nr; /*!< \brief Channel Number (Like RSL) */ - uint32_t fn; /*!< \brief GSM Frame Number */ - int8_t rssi; /*!< \brief RSSI of receivedindication */ - uint16_t ber10k; /*!< \brief BER in units of 0.01% */ - int16_t ta_offs_qbits; /* !< \brief Burst TA Offset in quarter bits */ - int16_t lqual_cb; /* !< \brief Link quality in centiBel */ - enum osmo_ph_pres_info_type pdch_presence_info; /*!< \brief Info regarding presence/validity of header and data parts */ + uint8_t link_id; /*!< Link Identifier (Like RSL) */ + uint8_t chan_nr; /*!< Channel Number (Like RSL) */ + uint32_t fn; /*!< GSM Frame Number */ + int8_t rssi; /*!< RSSI of receivedindication */ + uint16_t ber10k; /*!< BER in units of 0.01% */ + int16_t ta_offs_qbits; /* !< Burst TA Offset in quarter bits */ + int16_t lqual_cb; /* !< Link quality in centiBel */ + enum osmo_ph_pres_info_type pdch_presence_info; /*!< Info regarding presence/validity of header and data parts */ }; -/*! \brief for TCH.{req,ind} | TCH-RTS.ind */ +/*! for TCH.{req,ind} | TCH-RTS.ind */ struct ph_tch_param { - uint8_t chan_nr; /*!< \brief Channel Number (Like RSL) */ - uint32_t fn; /*!< \brief GSM Frame Number */ - int8_t rssi; /*!< \brief RSSI of received indication */ - uint8_t marker; /*!< \brief RTP Marker bit (speech onset indicator) */ + uint8_t chan_nr; /*!< Channel Number (Like RSL) */ + uint32_t fn; /*!< GSM Frame Number */ + int8_t rssi; /*!< RSSI of received indication */ + uint8_t marker; /*!< RTP Marker bit (speech onset indicator) */ }; -/*! \brief for PH-CONN.ind */ +/*! for PH-CONN.ind */ struct ph_conn_ind_param { - uint32_t fn; /*!< \brief GSM Frame Number */ + uint32_t fn; /*!< GSM Frame Number */ }; -/*! \brief for TIME MPH-INFO.ind */ +/*! for TIME MPH-INFO.ind */ struct info_time_ind_param { - uint32_t fn; /*!< \brief GSM Frame Number */ + uint32_t fn; /*!< GSM Frame Number */ }; -/*! \brief for MEAS MPH-INFO.ind */ +/*! for MEAS MPH-INFO.ind */ struct info_meas_ind_param { - uint8_t chan_nr; /*!< \brief Channel Number (Like RSL) */ - uint32_t fn; /*!< \brief GSM Frame Number */ - uint16_t ber10k; /*!< \brief BER in units of 0.01% */ - int16_t ta_offs_qbits; /*!< \brief timing advance offset (in qbits) */ - int16_t c_i_cb; /*!< \brief C/I ratio in 0.1 dB */ - uint8_t is_sub:1; /*!< \brief flags */ - uint8_t inv_rssi; /*!< \brief RSSI in dBm * -1 */ + uint8_t chan_nr; /*!< Channel Number (Like RSL) */ + uint32_t fn; /*!< GSM Frame Number */ + uint16_t ber10k; /*!< BER in units of 0.01% */ + int16_t ta_offs_qbits; /*!< timing advance offset (in qbits) */ + int16_t c_i_cb; /*!< C/I ratio in 0.1 dB */ + uint8_t is_sub:1; /*!< flags */ + uint8_t inv_rssi; /*!< RSSI in dBm * -1 */ }; -/*! \brief for {ACTIVATE,DEACTIVATE,MODIFY} MPH-INFO.req */ +/*! for {ACTIVATE,DEACTIVATE,MODIFY} MPH-INFO.req */ struct info_act_req_param { - uint8_t chan_nr; /*!< \brief Channel Number (Like RSL) */ + uint8_t chan_nr; /*!< Channel Number (Like RSL) */ uint8_t sacch_only; /*!< \breif Only deactivate SACCH */ }; -/*! \brief for {ACTIVATE,DEACTIVATE} MPH-INFO.cnf */ +/*! for {ACTIVATE,DEACTIVATE} MPH-INFO.cnf */ struct info_act_cnf_param { - uint8_t chan_nr; /*!< \brief Channel Number (Like RSL) */ - uint8_t cause; /*!< \brief RSL cause in case of nack */ + uint8_t chan_nr; /*!< Channel Number (Like RSL) */ + uint8_t cause; /*!< RSL cause in case of nack */ }; -/*! \brief for {ACTIVATE,DEACTIVATE} MPH-INFO.{req,cnf} */ +/*! for {ACTIVATE,DEACTIVATE} MPH-INFO.{req,cnf} */ struct info_ciph_req_param { - uint8_t chan_nr; /*!< \brief Channel Number (Like RSL) */ - uint8_t downlink; /*!< \brief Apply to downlink */ - uint8_t uplink; /*!< \brief Apply to uplink */ + uint8_t chan_nr; /*!< Channel Number (Like RSL) */ + uint8_t downlink; /*!< Apply to downlink */ + uint8_t uplink; /*!< Apply to uplink */ }; -/*! \brief for MPH-INFO.ind */ +/*! for MPH-INFO.ind */ struct mph_info_param { - enum osmo_mph_info_type type; /*!< \brief Info message type */ + enum osmo_mph_info_type type; /*!< Info message type */ union { struct info_time_ind_param time_ind; struct info_meas_ind_param meas_ind; @@ -136,9 +136,9 @@ struct mph_info_param { } u; }; -/*! \brief primitive header for PH-SAP primitives */ +/*! primitive header for PH-SAP primitives */ struct osmo_phsap_prim { - struct osmo_prim_hdr oph; /*!< \brief generic primitive header */ + struct osmo_prim_hdr oph; /*!< generic primitive header */ union { struct ph_data_param data; struct ph_tch_param tch; @@ -146,5 +146,5 @@ struct osmo_phsap_prim { struct ph_rach_ind_param rach_ind; struct ph_conn_ind_param conn_ind; struct mph_info_param info; - } u; /*!< \brief request-specific data */ + } u; /*!< request-specific data */ }; diff --git a/include/osmocom/gsm/lapd_core.h b/include/osmocom/gsm/lapd_core.h index 42ef417e..8d3a0f81 100644 --- a/include/osmocom/gsm/lapd_core.h +++ b/include/osmocom/gsm/lapd_core.h @@ -14,16 +14,16 @@ * primitive related stuff */ -/*! \brief LAPD related primitives (L2<->L3 SAP)*/ +/*! LAPD related primitives (L2<->L3 SAP)*/ enum osmo_dl_prim { - PRIM_DL_UNIT_DATA, /*!< \brief DL-UNIT-DATA */ - PRIM_DL_DATA, /*!< \brief DL-DATA */ - PRIM_DL_EST, /*!< \brief DL-ESTABLISH */ - PRIM_DL_REL, /*!< \brief DL-RLEEASE */ - PRIM_DL_SUSP, /*!< \brief DL-SUSPEND */ - PRIM_DL_RES, /*!< \brief DL-RESUME */ - PRIM_DL_RECON, /*!< \brief DL-RECONNECT */ - PRIM_MDL_ERROR, /*!< \brief MDL-ERROR */ + PRIM_DL_UNIT_DATA, /*!< DL-UNIT-DATA */ + PRIM_DL_DATA, /*!< DL-DATA */ + PRIM_DL_EST, /*!< DL-ESTABLISH */ + PRIM_DL_REL, /*!< DL-RLEEASE */ + PRIM_DL_SUSP, /*!< DL-SUSPEND */ + PRIM_DL_RES, /*!< DL-RESUME */ + PRIM_DL_RECON, /*!< DL-RECONNECT */ + PRIM_MDL_ERROR, /*!< MDL-ERROR */ }; /* Uses the same values as RLL, so no conversion for GSM is required. */ @@ -43,32 +43,32 @@ enum osmo_dl_prim { #define MDL_CAUSE_SABM_INFO_NOTALL 0x0e #define MDL_CAUSE_FRMR 0x0f -/*! \brief for MDL-ERROR.ind */ +/*! for MDL-ERROR.ind */ struct mdl_error_ind_param { - uint8_t cause; /*!< \brief generic cause value */ + uint8_t cause; /*!< generic cause value */ }; -/*! \brief for DL-REL.req */ +/*! for DL-REL.req */ struct dl_rel_req_param { - uint8_t mode; /*!< \brief release mode */ + uint8_t mode; /*!< release mode */ }; -/*! \brief primitive header for LAPD DL-SAP primitives */ +/*! primitive header for LAPD DL-SAP primitives */ struct osmo_dlsap_prim { - struct osmo_prim_hdr oph; /*!< \brief generic primitive header */ + struct osmo_prim_hdr oph; /*!< generic primitive header */ union { struct mdl_error_ind_param error_ind; struct dl_rel_req_param rel_req; - } u; /*!< \brief request-specific data */ + } u; /*!< request-specific data */ }; -/*! \brief LAPD mode/role */ +/*! LAPD mode/role */ enum lapd_mode { - LAPD_MODE_USER, /*!< \brief behave like user */ - LAPD_MODE_NETWORK, /*!< \brief behave like network */ + LAPD_MODE_USER, /*!< behave like user */ + LAPD_MODE_NETWORK, /*!< behave like network */ }; -/*! \brief LAPD state (Figure B.2/Q.921)*/ +/*! LAPD state (Figure B.2/Q.921)*/ enum lapd_state { LAPD_STATE_NULL = 0, LAPD_STATE_TEI_UNASS, @@ -81,7 +81,7 @@ enum lapd_state { LAPD_STATE_TIMER_RECOV, }; -/*! \brief LAPD message format (I / S / U) */ +/*! LAPD message format (I / S / U) */ enum lapd_format { LAPD_FORM_UKN = 0, LAPD_FORM_I, @@ -89,7 +89,7 @@ enum lapd_format { LAPD_FORM_U, }; -/*! \brief LAPD message context */ +/*! LAPD message context */ struct lapd_msg_ctx { struct lapd_datalink *dl; int n201; @@ -119,45 +119,45 @@ struct lapd_history { int more; /* if message is fragmented */ }; -/*! \brief LAPD datalink */ +/*! LAPD datalink */ struct lapd_datalink { int (*send_dlsap)(struct osmo_dlsap_prim *dp, struct lapd_msg_ctx *lctx); int (*send_ph_data_req)(struct lapd_msg_ctx *lctx, struct msgb *msg); int (*update_pending_frames)(struct lapd_msg_ctx *lctx); struct { - /*! \brief filled-in once we set the lapd_mode above */ + /*! filled-in once we set the lapd_mode above */ struct lapd_cr_ent loc2rem; struct lapd_cr_ent rem2loc; } cr; - enum lapd_mode mode; /*!< \brief current mode of link */ - int use_sabme; /*!< \brief use SABME instead of SABM */ - int reestablish; /*!< \brief enable reestablish support */ - int n200, n200_est_rel; /*!< \brief number of retranmissions */ - struct lapd_msg_ctx lctx; /*!< \brief LAPD context */ - int maxf; /*!< \brief maximum frame size (after defragmentation) */ - uint8_t k; /*!< \brief maximum number of unacknowledged frames */ - uint8_t v_range; /*!< \brief range of sequence numbers */ - uint8_t v_send; /*!< \brief seq nr of next I frame to be transmitted */ - uint8_t v_ack; /*!< \brief last frame ACKed by peer */ - uint8_t v_recv; /*!< \brief seq nr of next I frame expected to be received */ - uint32_t state; /*!< \brief LAPD state (\ref lapd_state) */ - int seq_err_cond; /*!< \brief condition of sequence error */ - uint8_t own_busy; /*!< \brief receiver busy on our side */ - uint8_t peer_busy; /*!< \brief receiver busy on remote side */ - int t200_sec, t200_usec; /*!< \brief retry timer (default 1 sec) */ - int t203_sec, t203_usec; /*!< \brief retry timer (default 10 secs) */ - struct osmo_timer_list t200; /*!< \brief T200 timer */ - struct osmo_timer_list t203; /*!< \brief T203 timer */ - uint8_t retrans_ctr; /*!< \brief re-transmission counter */ - struct llist_head tx_queue; /*!< \brief frames to L1 */ - struct llist_head send_queue; /*!< \brief frames from L3 */ - struct msgb *send_buffer; /*!< \brief current frame transmitting */ - int send_out; /*!< \brief how much was sent from send_buffer */ - struct lapd_history *tx_hist; /*!< \brief tx history structure array */ - uint8_t range_hist; /*!< \brief range of history buffer 2..2^n */ - struct msgb *rcv_buffer; /*!< \brief buffer to assemble the received message */ - struct msgb *cont_res; /*!< \brief buffer to store content resolution data on network side, to detect multiple phones on same channel */ + enum lapd_mode mode; /*!< current mode of link */ + int use_sabme; /*!< use SABME instead of SABM */ + int reestablish; /*!< enable reestablish support */ + int n200, n200_est_rel; /*!< number of retranmissions */ + struct lapd_msg_ctx lctx; /*!< LAPD context */ + int maxf; /*!< maximum frame size (after defragmentation) */ + uint8_t k; /*!< maximum number of unacknowledged frames */ + uint8_t v_range; /*!< range of sequence numbers */ + uint8_t v_send; /*!< seq nr of next I frame to be transmitted */ + uint8_t v_ack; /*!< last frame ACKed by peer */ + uint8_t v_recv; /*!< seq nr of next I frame expected to be received */ + uint32_t state; /*!< LAPD state (\ref lapd_state) */ + int seq_err_cond; /*!< condition of sequence error */ + uint8_t own_busy; /*!< receiver busy on our side */ + uint8_t peer_busy; /*!< receiver busy on remote side */ + int t200_sec, t200_usec; /*!< retry timer (default 1 sec) */ + int t203_sec, t203_usec; /*!< retry timer (default 10 secs) */ + struct osmo_timer_list t200; /*!< T200 timer */ + struct osmo_timer_list t203; /*!< T203 timer */ + uint8_t retrans_ctr; /*!< re-transmission counter */ + struct llist_head tx_queue; /*!< frames to L1 */ + struct llist_head send_queue; /*!< frames from L3 */ + struct msgb *send_buffer; /*!< current frame transmitting */ + int send_out; /*!< how much was sent from send_buffer */ + struct lapd_history *tx_hist; /*!< tx history structure array */ + uint8_t range_hist; /*!< range of history buffer 2..2^n */ + struct msgb *rcv_buffer; /*!< buffer to assemble the received message */ + struct msgb *cont_res; /*!< buffer to store content resolution data on network side, to detect multiple phones on same channel */ }; void lapd_dl_init(struct lapd_datalink *dl, uint8_t k, uint8_t v_range, diff --git a/include/osmocom/gsm/lapdm.h b/include/osmocom/gsm/lapdm.h index 84d109d5..ec14cddc 100644 --- a/include/osmocom/gsm/lapdm.h +++ b/include/osmocom/gsm/lapdm.h @@ -9,15 +9,15 @@ /*! \file lapdm.h */ -/*! \brief LAPDm mode/role */ +/*! LAPDm mode/role */ enum lapdm_mode { - LAPDM_MODE_MS, /*!< \brief behave like a MS (mobile phone) */ - LAPDM_MODE_BTS, /*!< \brief behave like a BTS (network) */ + LAPDM_MODE_MS, /*!< behave like a MS (mobile phone) */ + LAPDM_MODE_BTS, /*!< behave like a BTS (network) */ }; struct lapdm_entity; -/*! \brief LAPDm message context */ +/*! LAPDm message context */ struct lapdm_msg_ctx { struct lapdm_datalink *dl; int lapdm_fmt; @@ -27,18 +27,18 @@ struct lapdm_msg_ctx { uint8_t tx_power_ind; /* MS power indicated by network */ }; -/*! \brief LAPDm datalink like TS 04.06 / Section 3.5.2 */ +/*! LAPDm datalink like TS 04.06 / Section 3.5.2 */ struct lapdm_datalink { - struct lapd_datalink dl; /* \brief common LAPD */ - struct lapdm_msg_ctx mctx; /*!< \brief context of established connection */ + struct lapd_datalink dl; /* common LAPD */ + struct lapdm_msg_ctx mctx; /*!< context of established connection */ - struct lapdm_entity *entity; /*!< \brief LAPDm entity we are part of */ + struct lapdm_entity *entity; /*!< LAPDm entity we are part of */ }; -/*! \brief LAPDm datalink SAPIs */ +/*! LAPDm datalink SAPIs */ enum lapdm_dl_sapi { - DL_SAPI0 = 0, /*!< \brief SAPI 0 */ - DL_SAPI3 = 1, /*!< \brief SAPI 1 */ + DL_SAPI0 = 0, /*!< SAPI 0 */ + DL_SAPI3 = 1, /*!< SAPI 1 */ _NR_DL_SAPI }; @@ -47,34 +47,34 @@ typedef int (*lapdm_cb_t)(struct msgb *msg, struct lapdm_entity *le, void *ctx); #define LAPDM_ENT_F_EMPTY_FRAME 0x0001 #define LAPDM_ENT_F_POLLING_ONLY 0x0002 -/*! \brief a LAPDm Entity */ +/*! a LAPDm Entity */ struct lapdm_entity { - /*! \brief the SAPIs of the LAPDm entity */ + /*! the SAPIs of the LAPDm entity */ struct lapdm_datalink datalink[_NR_DL_SAPI]; - int last_tx_dequeue; /*!< \brief last entity that was dequeued */ - int tx_pending; /*!< \brief currently a pending frame not confirmed by L1 */ - enum lapdm_mode mode; /*!< \brief are we in BTS mode or MS mode */ + int last_tx_dequeue; /*!< last entity that was dequeued */ + int tx_pending; /*!< currently a pending frame not confirmed by L1 */ + enum lapdm_mode mode; /*!< are we in BTS mode or MS mode */ unsigned int flags; - void *l1_ctx; /*!< \brief context for layer1 instance */ - void *l3_ctx; /*!< \brief context for layer3 instance */ + void *l1_ctx; /*!< context for layer1 instance */ + void *l3_ctx; /*!< context for layer3 instance */ - osmo_prim_cb l1_prim_cb;/*!< \brief callback for sending prims to L1 */ - lapdm_cb_t l3_cb; /*!< \brief callback for sending stuff to L3 */ + osmo_prim_cb l1_prim_cb;/*!< callback for sending prims to L1 */ + lapdm_cb_t l3_cb; /*!< callback for sending stuff to L3 */ - /*! \brief pointer to \ref lapdm_channel of which we're part */ + /*! pointer to \ref lapdm_channel of which we're part */ struct lapdm_channel *lapdm_ch; uint8_t ta; /* TA used and indicated to network */ uint8_t tx_power; /* MS power used and indicated to network */ }; -/*! \brief the two lapdm_entities that form a GSM logical channel (ACCH + DCCH) */ +/*! the two lapdm_entities that form a GSM logical channel (ACCH + DCCH) */ struct lapdm_channel { - struct llist_head list; /*!< \brief internal linked list */ - char *name; /*!< \brief human-readable name */ - struct lapdm_entity lapdm_acch; /*!< \brief Associated Control Channel */ - struct lapdm_entity lapdm_dcch; /*!< \brief Dedicated Control Channel */ + struct llist_head list; /*!< internal linked list */ + char *name; /*!< human-readable name */ + struct lapdm_entity lapdm_acch; /*!< Associated Control Channel */ + struct lapdm_entity lapdm_dcch; /*!< Dedicated Control Channel */ }; const char *get_rsl_name(int value); diff --git a/include/osmocom/gsm/oap.h b/include/osmocom/gsm/oap.h index ff561bf1..fba22c78 100644 --- a/include/osmocom/gsm/oap.h +++ b/include/osmocom/gsm/oap.h @@ -26,7 +26,7 @@ #include <osmocom/core/msgb.h> #include <osmocom/gsm/protocol/gsm_04_08_gprs.h> -/*! \brief Information Element Identifiers for OAP IEs. +/*! Information Element Identifiers for OAP IEs. * They match osmo_gsup_iei (so far). */ enum osmo_oap_iei { OAP_CAUSE_IE = 0x02, @@ -37,7 +37,7 @@ enum osmo_oap_iei { OAP_CLIENT_ID_IE = 0x30, }; -/*! \brief OAP message types */ +/*! OAP message types */ enum osmo_oap_message_type { OAP_MSGT_REGISTER_REQUEST = 0b00000100, OAP_MSGT_REGISTER_ERROR = 0b00000101, @@ -52,7 +52,7 @@ enum osmo_oap_message_type { OAP_MSGT_SYNC_RESULT = 0b00001110, }; -/*! \brief Parsed/decoded OAP protocol message */ +/*! Parsed/decoded OAP protocol message */ struct osmo_oap_message { enum osmo_oap_message_type message_type; enum gsm48_gmm_cause cause; diff --git a/include/osmocom/gsm/protocol/gsm_04_08.h b/include/osmocom/gsm/protocol/gsm_04_08.h index 604a5df4..90b6cf15 100644 --- a/include/osmocom/gsm/protocol/gsm_04_08.h +++ b/include/osmocom/gsm/protocol/gsm_04_08.h @@ -957,7 +957,7 @@ static inline uint8_t gsm48_hdr_trans_id(const struct gsm48_hdr *hdr) #define GSM48_TA_INVALID 220 -/*! \brief Check if TA is valid according to 3GPP TS 44.018 § 10.5.2.40 +/*! Check if TA is valid according to 3GPP TS 44.018 § 10.5.2.40 * \param[in] ta Timing Advance value * \returns true if ta is valid, false otherwise * Note: Rules for GSM400 band are ignored as it's not implemented in practice. @@ -1620,7 +1620,7 @@ enum gsm48_bcap_modem_type { GSM48_BCAP_MT_AUTO_1 = 8, }; -/*! \brief GSM 04.08 Bearer Capability: Speech Version Indication +/*! GSM 04.08 Bearer Capability: Speech Version Indication * (See also 3GPP TS 24.008, Table 10.5.103) */ enum gsm48_bcap_speech_ver { GSM48_BCAP_SV_FR = 0, /*!< GSM FR V1 (GSM FR) */ diff --git a/include/osmocom/gsm/protocol/gsm_08_08.h b/include/osmocom/gsm/protocol/gsm_08_08.h index d1653309..6ae6855c 100644 --- a/include/osmocom/gsm/protocol/gsm_08_08.h +++ b/include/osmocom/gsm/protocol/gsm_08_08.h @@ -391,7 +391,7 @@ enum gsm0808_chan_rate_type_speech { GSM0808_SPEECH_PERM_NO_CHANGE = 0x1f, }; -/*! \brief GSM 08.08 3.2.2.11 Channel Type +/*! GSM 08.08 3.2.2.11 Channel Type * (see also 3GPP TS 48.008, section 3.2.2.11) */ enum gsm0808_permitted_speech { GSM0808_PERM_FR1 = 0x01, /*!< GSM FR */ @@ -406,7 +406,7 @@ enum gsm0808_permitted_speech { GSM0808_PERM_HR6 = 0x45, /*!< OHR AMR */ }; -/*! \brief 3GPP TS 48.008, 3.2.2.103 Speech Codec Type */ +/*! 3GPP TS 48.008, 3.2.2.103 Speech Codec Type */ enum gsm0808_speech_codec_type { GSM0808_SCT_FR1 = 0x0, /*!< GSM FR */ GSM0808_SCT_FR2 = 0x2, /*!< GSM EFR */ @@ -449,7 +449,7 @@ struct gsm0808_speech_codec { uint16_t cfg; }; -/*! \brief Default speech codec configurations: Some codecs specified with +/*! Default speech codec configurations: Some codecs specified with * struct gsm0808_speech_codec, require a configuration (cfg). The following * default configuration will configure the codec (RTP) to match the * configuration that is used on the air interface (Um). diff --git a/include/osmocom/gsm/protocol/gsm_08_58.h b/include/osmocom/gsm/protocol/gsm_08_58.h index a7a2ccfd..c76cf3b1 100644 --- a/include/osmocom/gsm/protocol/gsm_08_58.h +++ b/include/osmocom/gsm/protocol/gsm_08_58.h @@ -30,59 +30,59 @@ /*! \file gsm_08_58.h */ -/*! \brief RSL common header */ +/*! RSL common header */ struct abis_rsl_common_hdr { - uint8_t msg_discr; /*!< \brief message discriminator (ABIS_RSL_MDISC_*) */ - uint8_t msg_type; /*!< \brief message type (\ref abis_rsl_msgtype) */ - uint8_t data[0]; /*!< \brief actual payload data */ + uint8_t msg_discr; /*!< message discriminator (ABIS_RSL_MDISC_*) */ + uint8_t msg_type; /*!< message type (\ref abis_rsl_msgtype) */ + uint8_t data[0]; /*!< actual payload data */ } __attribute__ ((packed)); -/* \brief RSL RLL header (Chapter 8.3) */ +/* RSL RLL header (Chapter 8.3) */ struct abis_rsl_rll_hdr { struct abis_rsl_common_hdr c; - uint8_t ie_chan; /*!< \brief \ref RSL_IE_CHAN_NR (tag) */ - uint8_t chan_nr; /*!< \brief RSL channel number (value) */ - uint8_t ie_link_id; /*!< \brief \ref RSL_IE_LINK_IDENT (tag) */ - uint8_t link_id; /*!< \brief RSL link identifier (value) */ - uint8_t data[0]; /*!< \brief message payload data */ + uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */ + uint8_t chan_nr; /*!< RSL channel number (value) */ + uint8_t ie_link_id; /*!< \ref RSL_IE_LINK_IDENT (tag) */ + uint8_t link_id; /*!< RSL link identifier (value) */ + uint8_t data[0]; /*!< message payload data */ } __attribute__ ((packed)); -/* \brief RSL Dedicated Channel header (Chapter 8.3 and 8.4) */ +/* RSL Dedicated Channel header (Chapter 8.3 and 8.4) */ struct abis_rsl_dchan_hdr { struct abis_rsl_common_hdr c; - uint8_t ie_chan; /*!< \brief \ref RSL_IE_CHAN_NR (tag) */ - uint8_t chan_nr; /*!< \brief RSL channel number (value) */ - uint8_t data[0]; /*!< \brief message payload data */ + uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */ + uint8_t chan_nr; /*!< RSL channel number (value) */ + uint8_t data[0]; /*!< message payload data */ } __attribute__ ((packed)); -/* \brief RSL Common Channel header (Chapter 8.5) */ +/* RSL Common Channel header (Chapter 8.5) */ struct abis_rsl_cchan_hdr { struct abis_rsl_common_hdr c; - uint8_t ie_chan; /*!< \brief \ref RSL_IE_CHAN_NR (tag) */ - uint8_t chan_nr; /*!< \brief RSL channel number (value) */ - uint8_t data[0]; /*!< \brief message payload data */ + uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */ + uint8_t chan_nr; /*!< RSL channel number (value) */ + uint8_t data[0]; /*!< message payload data */ } __attribute__ ((packed)); /* Chapter 9.1 */ -/* \brief RSL Message Discriminator: RLL */ +/* RSL Message Discriminator: RLL */ #define ABIS_RSL_MDISC_RLL 0x02 -/* \brief RSL Message Discriminator: Dedicated Channel */ +/* RSL Message Discriminator: Dedicated Channel */ #define ABIS_RSL_MDISC_DED_CHAN 0x08 -/* \brief RSL Message Discriminator: Common Channel */ +/* RSL Message Discriminator: Common Channel */ #define ABIS_RSL_MDISC_COM_CHAN 0x0c -/* \brief RSL Message Discriminator: TRX Management */ +/* RSL Message Discriminator: TRX Management */ #define ABIS_RSL_MDISC_TRX 0x10 -/* \brief RSL Message Discriminator: Location Service */ +/* RSL Message Discriminator: Location Service */ #define ABIS_RSL_MDISC_LOC 0x20 -/* \brief RSL Message Discriminator: ip.access */ +/* RSL Message Discriminator: ip.access */ #define ABIS_RSL_MDISC_IPACCESS 0x7e #define ABIS_RSL_MDISC_TRANSP 0x01 -/* \brief Check if given RSL message discriminator is transparent */ +/* Check if given RSL message discriminator is transparent */ #define ABIS_RSL_MDISC_IS_TRANSP(x) (x & 0x01) -/* \brief RSL Message Type (Chapter 9.1) */ +/* RSL Message Type (Chapter 9.1) */ enum abis_rsl_msgtype { /* Radio Link Layer Management */ RSL_MT_DATA_REQ = 0x01, @@ -182,7 +182,7 @@ enum abis_rsl_msgtype { RSL_MT_IPAC_DLCX_NACK, }; -/*! \brief Siemens vendor-specific RSL message types */ +/*! Siemens vendor-specific RSL message types */ enum abis_rsl_msgtype_siemens { RSL_MT_SIEMENS_MRPCI = 0x41, RSL_MT_SIEMENS_INTRAC_HO_COND_IND = 0x42, @@ -202,7 +202,7 @@ enum abis_rsl_msgtype_siemens { RSL_MT_SIEMENS_MODIF_COND_IND = 0x50, }; -/*! \brief RSL Information Element Identifiers (Chapter 9.3) */ +/*! RSL Information Element Identifiers (Chapter 9.3) */ enum abis_rsl_ie { RSL_IE_CHAN_NR = 0x01, RSL_IE_LINK_IDENT, @@ -340,7 +340,7 @@ enum abis_rsl_ie { #define RSL_ACT_SECOND_MULTI 0x05 #define RSL_ACT_OSMO_PDCH 0x0f /*< non-standard, for dyn TS */ -/*! \brief RSL Channel Mode IF (Chapter 9.3.6) */ +/*! RSL Channel Mode IF (Chapter 9.3.6) */ struct rsl_ie_chan_mode { uint8_t dtx_dtu; uint8_t spd_ind; @@ -383,7 +383,7 @@ enum rsl_cmod_spd { #define RSL_CMOD_CSD_T_600 0x14 #define RSL_CMOD_CSD_T_1200_75 0x15 -/*! \brief RSL Channel Identification IE (Chapter 9.3.5) */ +/*! RSL Channel Identification IE (Chapter 9.3.5) */ struct rsl_ie_chan_ident { /* GSM 04.08 10.5.2.5 */ struct { @@ -496,7 +496,7 @@ struct rsl_ie_chan_ident { #define RSL_CHANNEED_TCH_F 0x02 #define RSL_CHANNEED_TCH_ForH 0x03 -/*! \brief RSL Cell Broadcast Command (Chapter 9.3.45) */ +/*! RSL Cell Broadcast Command (Chapter 9.3.45) */ struct rsl_ie_cb_cmd_type { uint8_t last_block:2; uint8_t spare:1; @@ -603,7 +603,7 @@ enum rsl_rel_mode { RSL_REL_LOCAL_END = 1, }; -/*! \brief ip.access specific embedded information elements */ +/*! ip.access specific embedded information elements */ enum rsl_ipac_embedded_ie { RSL_IPAC_EIE_RXLEV = 0x00, RSL_IPAC_EIE_RXQUAL = 0x01, diff --git a/include/osmocom/gsm/protocol/gsm_12_21.h b/include/osmocom/gsm/protocol/gsm_12_21.h index b35da447..1bdee9cd 100644 --- a/include/osmocom/gsm/protocol/gsm_12_21.h +++ b/include/osmocom/gsm/protocol/gsm_12_21.h @@ -32,60 +32,60 @@ #include <stdbool.h> #include <osmocom/gsm/tlv.h> -/*! \brief generic header in front of every OML message according to TS 08.59 */ +/*! generic header in front of every OML message according to TS 08.59 */ struct abis_om_hdr { - /*! \brief Message Discriminator \ref abis_oml_mdisc */ + /*! Message Discriminator \ref abis_oml_mdisc */ uint8_t mdisc; - /*! \brief Placement (like \ref ABIS_OM_PLACEMENT_ONLY) */ + /*! Placement (like \ref ABIS_OM_PLACEMENT_ONLY) */ uint8_t placement; - /*! \brief Sequence Number (if \ref ABIS_OM_PLACEMENT_MIDDLE) */ + /*! Sequence Number (if \ref ABIS_OM_PLACEMENT_MIDDLE) */ uint8_t sequence; - /*! \brief Length in octets */ + /*! Length in octets */ uint8_t length; - /*! \brief actual payload data */ + /*! actual payload data */ uint8_t data[0]; } __attribute__ ((packed)); #define ABIS_NM_MSG_SIZE 1024 #define ABIS_NM_MSG_HEADROOM 128 -/*! \brief Message Discriminator for Formatted Object Messages */ +/*! Message Discriminator for Formatted Object Messages */ #define ABIS_OM_MDISC_FOM 0x80 -/*! \brief Message Discriminator for Man Machine Interface */ +/*! Message Discriminator for Man Machine Interface */ #define ABIS_OM_MDISC_MMI 0x40 -/*! \brief Message Discriminator for TRAU management */ +/*! Message Discriminator for TRAU management */ #define ABIS_OM_MDISC_TRAU 0x20 -/*! \brief Message Discriminator for Manufacturer Specific Messages */ +/*! Message Discriminator for Manufacturer Specific Messages */ #define ABIS_OM_MDISC_MANUF 0x10 -/*! \brief Entire OML message is in the L2 frame */ +/*! Entire OML message is in the L2 frame */ #define ABIS_OM_PLACEMENT_ONLY 0x80 -/*! \brief First fragment of OML message is in this L2 frame */ +/*! First fragment of OML message is in this L2 frame */ #define ABIS_OM_PLACEMENT_FIRST 0x40 -/*! \brief Middle fragment of OML message is in this L2 frame */ +/*! Middle fragment of OML message is in this L2 frame */ #define ABIS_OM_PLACEMENT_MIDDLE 0x20 -/*! \brief Last fragment of OML message is in this L2 frame */ +/*! Last fragment of OML message is in this L2 frame */ #define ABIS_OM_PLACEMENT_LAST 0x10 -/*! \brief OML Object Instance */ +/*! OML Object Instance */ struct abis_om_obj_inst { - uint8_t bts_nr; /*!< \brief BTS Number */ - uint8_t trx_nr; /*!< \brief TRX Number */ - uint8_t ts_nr; /*!< \brief Timeslot Number */ + uint8_t bts_nr; /*!< BTS Number */ + uint8_t trx_nr; /*!< TRX Number */ + uint8_t ts_nr; /*!< Timeslot Number */ } __attribute__ ((packed)); -/*! \brief OML Object Instance */ +/*! OML Object Instance */ struct abis_om_fom_hdr { - uint8_t msg_type; /*!< \brief Message Type (\ref abis_nm_msgtype) */ - uint8_t obj_class; /*!< \brief Object Class (\ref abis_nm_obj_class) */ - struct abis_om_obj_inst obj_inst; /*!< \brief Object Instance */ - uint8_t data[0]; /*!< \brief Data */ + uint8_t msg_type; /*!< Message Type (\ref abis_nm_msgtype) */ + uint8_t obj_class; /*!< Object Class (\ref abis_nm_obj_class) */ + struct abis_om_obj_inst obj_inst; /*!< Object Instance */ + uint8_t data[0]; /*!< Data */ } __attribute__ ((packed)); -/*! \brief Size of the OML FOM header in octets */ +/*! Size of the OML FOM header in octets */ #define ABIS_OM_FOM_HDR_SIZE (sizeof(struct abis_om_hdr) + sizeof(struct abis_om_fom_hdr)) -/*! \brief OML Message Type (Section 9.1) */ +/*! OML Message Type (Section 9.1) */ enum abis_nm_msgtype { /* SW Download Management Messages */ NM_MT_LOAD_INIT = 0x01, @@ -196,7 +196,7 @@ enum abis_nm_msgtype { NM_MT_SET_ALARM_THRES_NACK, }; -/*! \brief Siemens specific OML Message Types */ +/*! Siemens specific OML Message Types */ enum abis_nm_msgtype_bs11 { NM_MT_BS11_RESET_RESOURCE = 0x74, @@ -232,7 +232,7 @@ enum abis_nm_msgtype_bs11 { NM_MT_BS11_RECONNECT_ACK, }; -/*! \brief ip.access specific OML Message Types */ +/*! ip.access specific OML Message Types */ enum abis_nm_msgtype_ipacc { NM_MT_IPACC_RESTART = 0x87, NM_MT_IPACC_RESTART_ACK, @@ -260,7 +260,7 @@ enum abis_nm_msgtype_ipacc { NM_MT_IPACC_SET_ATTR_NACK, }; -/*! \brief OML Probable Cause (Section 9.4.43) Manufacturer specific values */ +/*! OML Probable Cause (Section 9.4.43) Manufacturer specific values */ enum abis_mm_event_causes { /* Critical causes */ OSMO_EVT_CRIT_SW_FATAL = 0x0000, @@ -288,7 +288,7 @@ enum abis_nm_bs11_cell_alloc { NM_BS11_CANR_DCS1800 = 0x01, }; -/*! \brief OML Object Class (Section 9.2) */ +/*! OML Object Class (Section 9.2) */ enum abis_nm_obj_class { NM_OC_SITE_MANAGER = 0x00, NM_OC_BTS, @@ -319,7 +319,7 @@ enum abis_nm_obj_class { NM_OC_NULL = 0xff, }; -/*! \brief OML Attributes / IEs (Section 9.4) */ +/*! OML Attributes / IEs (Section 9.4) */ enum abis_nm_attr { NM_ATT_ABIS_CHANNEL = 0x01, NM_ATT_ADD_INFO, @@ -519,7 +519,7 @@ enum abis_nm_attr { }; #define NM_ATT_BS11_FILE_DATA NM_ATT_EVENT_TYPE -/*! \brief OML Administrative State (Section 9.4.4) */ +/*! OML Administrative State (Section 9.4.4) */ enum abis_nm_adm_state { NM_STATE_LOCKED = 0x01, NM_STATE_UNLOCKED = 0x02, @@ -527,7 +527,7 @@ enum abis_nm_adm_state { NM_STATE_NULL = 0xff, }; -/*! \brief OML Availability State (Section 9.4.7) */ +/*! OML Availability State (Section 9.4.7) */ enum abis_nm_avail_state { NM_AVSTATE_IN_TEST = 1, NM_AVSTATE_POWER_OFF = 2, @@ -538,14 +538,14 @@ enum abis_nm_avail_state { NM_AVSTATE_OK = 0xff, }; -/*! \brief OML Operational State */ +/*! OML Operational State */ enum abis_nm_op_state { NM_OPSTATE_DISABLED = 1, NM_OPSTATE_ENABLED = 2, NM_OPSTATE_NULL = 0xff, }; -/* \brief Channel Combination (Section 9.4.13) */ +/* Channel Combination (Section 9.4.13) */ enum abis_nm_chan_comb { NM_CHANC_TCHFull = 0x00, /* TCH/F + TCH/H + SACCH/TF */ NM_CHANC_TCHHalf = 0x01, /* TCH/H(0,1) + FACCH/H(0,1) + @@ -570,7 +570,7 @@ enum abis_nm_chan_comb { NM_CHANC_OSMO_TCHFull_TCHHalf_PDCH = 0x90, }; -/*! \brief Event Type (Section 9.4.16) */ +/*! Event Type (Section 9.4.16) */ enum abis_nm_event_type { NM_EVT_COMM_FAIL = 0x00, NM_EVT_QOS_FAIL = 0x01, @@ -579,7 +579,7 @@ enum abis_nm_event_type { NM_EVT_ENV_FAIL = 0x04, }; -/*! \brief Perceived Severity (Section: 9.4.63) */ +/*! Perceived Severity (Section: 9.4.63) */ enum abis_nm_severity { NM_SEVER_CEASED = 0x00, NM_SEVER_CRITICAL = 0x01, @@ -589,7 +589,7 @@ enum abis_nm_severity { NM_SEVER_INDETERMINATE = 0x05, }; -/*! \brief Probable Cause Type (Section 9.4.43) */ +/*! Probable Cause Type (Section 9.4.43) */ enum abis_nm_pcause_type { NM_PCAUSE_T_X721 = 0x01, NM_PCAUSE_T_GSM = 0x02, @@ -600,7 +600,7 @@ extern const struct value_string abis_nm_pcause_type_names[]; extern const struct value_string abis_nm_msgtype_names[]; extern const struct value_string abis_nm_att_names[]; -/*! \brief NACK causes (Section 9.4.36) */ +/*! NACK causes (Section 9.4.36) */ enum abis_nm_nack_cause { /* General Nack Causes */ NM_NACK_INCORR_STRUCT = 0x01, @@ -638,15 +638,15 @@ enum abis_nm_nack_cause { NM_NACK_MEAS_NOTSTART = 0x2c, }; -/*! \brief Abis OML Channel (Section 9.4.1) */ +/*! Abis OML Channel (Section 9.4.1) */ struct abis_nm_channel { uint8_t attrib; - uint8_t bts_port; /*!< \brief BTS port number */ - uint8_t timeslot; /*!< \brief E1 timeslot */ - uint8_t subslot; /*!< \brief E1 sub-slot */ + uint8_t bts_port; /*!< BTS port number */ + uint8_t timeslot; /*!< E1 timeslot */ + uint8_t subslot; /*!< E1 sub-slot */ } __attribute__ ((packed)); -/*! \brief 3GPP TS 12.21 9.4.53 T200 index */ +/*! 3GPP TS 12.21 9.4.53 T200 index */ enum abis_nm_t200_idx { T200_SDCCH = 0, T200_FACCH_F = 1, @@ -659,7 +659,7 @@ enum abis_nm_t200_idx { extern const uint8_t abis_nm_t200_ms[]; -/*! \brief Siemens BS-11 specific objects in the SienemsHW (0xA5) object class */ +/*! Siemens BS-11 specific objects in the SienemsHW (0xA5) object class */ enum abis_bs11_objtype { BS11_OBJ_ALCO = 0x01, BS11_OBJ_BBSIG = 0x02, /* obj_class: 0,1 */ @@ -670,7 +670,7 @@ enum abis_bs11_objtype { BS11_OBJ_PA = 0x09, /* obj_class: 0, 1*/ }; -/*! \brief Siemens BS11 TRX power */ +/*! Siemens BS11 TRX power */ enum abis_bs11_trx_power { BS11_TRX_POWER_GSM_2W = 0x06, BS11_TRX_POWER_GSM_250mW= 0x07, @@ -682,20 +682,20 @@ enum abis_bs11_trx_power { BS11_TRX_POWER_DCS_160mW= 0x0d, }; -/*! \brief Siemens BS11 PLL mode */ +/*! Siemens BS11 PLL mode */ enum abis_bs11_li_pll_mode { BS11_LI_PLL_LOCKED = 2, BS11_LI_PLL_STANDALONE = 3, }; -/*! \brief Siemens BS11 E1 line configuration */ +/*! Siemens BS11 E1 line configuration */ enum abis_bs11_line_cfg { BS11_LINE_CFG_STAR = 0x00, BS11_LINE_CFG_MULTIDROP = 0x01, BS11_LINE_CFG_LOOP = 0x02, }; -/*! \brief Siemens BS11 boot phase */ +/*! Siemens BS11 boot phase */ enum abis_bs11_phase { BS11_STATE_SOFTWARE_RQD = 0x01, BS11_STATE_LOAD_SMU_INTENDED = 0x11, @@ -712,7 +712,7 @@ enum abis_bs11_phase { BS11_STATE_ABIS_LOAD = 0x13, }; -/*! \brief ip.access test number */ +/*! ip.access test number */ enum abis_nm_ipacc_test_no { NM_IPACC_TESTNO_RLOOP_ANT = 0x01, NM_IPACC_TESTNO_RLOOP_XCVR = 0x02, @@ -726,7 +726,7 @@ enum abis_nm_ipacc_test_no { NM_IPACC_TESTNO_BCCCH_MONITOR = 0x46, }; -/*! \brief first byte after length inside NM_ATT_TEST_REPORT */ +/*! first byte after length inside NM_ATT_TEST_REPORT */ enum abis_nm_ipacc_test_res { NM_IPACC_TESTRES_SUCCESS = 0, NM_IPACC_TESTRES_TIMEOUT = 1, @@ -735,7 +735,7 @@ enum abis_nm_ipacc_test_res { NM_IPACC_TESTRES_STOPPED = 4, }; -/*! \brief internal IE inside NM_ATT_TEST_REPORT */ +/*! internal IE inside NM_ATT_TEST_REPORT */ enum abis_nm_ipacc_testres_ie { NM_IPACC_TR_IE_FREQ_ERR_LIST = 3, NM_IPACC_TR_IE_CHAN_USAGE = 4, @@ -744,7 +744,7 @@ enum abis_nm_ipacc_testres_ie { NM_IPACC_TR_IE_FREQ_ERR = 18, }; -/*! \brief ip.access IEI */ +/*! ip.access IEI */ enum ipac_eie { NM_IPAC_EIE_ARFCN_WHITE = 0x01, NM_IPAC_EIE_ARFCH_BLACK = 0x02, @@ -777,7 +777,7 @@ enum ipac_eie { NM_IPAC_EIE_BTS_ID = 0x25, }; -/*! \brief ip.access NWL BCCH information type */ +/*! ip.access NWL BCCH information type */ enum ipac_bcch_info_type { IPAC_BINF_RXLEV = (1 << 8), IPAC_BINF_RXQUAL = (1 << 9), @@ -792,7 +792,7 @@ enum ipac_bcch_info_type { IPAC_BINF_CELL_ALLOC = (1 << 2), }; -/*! \brief 3GPP TS 52.021 §9.4.62 SW Description */ +/*! 3GPP TS 52.021 §9.4.62 SW Description */ struct abis_nm_sw_desc { uint8_t file_id[UINT8_MAX]; uint8_t file_id_len; diff --git a/include/osmocom/gsm/rsl.h b/include/osmocom/gsm/rsl.h index 5da61808..93e27a14 100644 --- a/include/osmocom/gsm/rsl.h +++ b/include/osmocom/gsm/rsl.h @@ -17,13 +17,13 @@ void rsl_init_cchan_hdr(struct abis_rsl_cchan_hdr *ch, uint8_t msg_type); extern const struct tlv_definition rsl_att_tlvdef; -/*! \brief Parse RSL TLV structure using \ref tlv_parse */ +/*! Parse RSL TLV structure using \ref tlv_parse */ #define rsl_tlv_parse(dec, buf, len) \ tlv_parse(dec, &rsl_att_tlvdef, buf, len, 0, 0) extern const struct tlv_definition rsl_ipac_eie_tlvdef; -/*! \brief Parse RSL IPAC EIE TLV structure using \ref tlv_parse */ +/*! Parse RSL IPAC EIE TLV structure using \ref tlv_parse */ #define rsl_ipac_eie_tlv_parse(dec, buf, len) \ tlv_parse(dec, &rsl_ipac_eie_tlvdef, buf, len, 0, 0) @@ -58,7 +58,7 @@ struct msgb *rsl_rll_simple(uint8_t msg_type, uint8_t chan_nr, extern const struct value_string rsl_act_type_names[]; -/*! \brief Return a human readable name for GSM 08.58 RSL_ACT_* constants. */ +/*! Return a human readable name for GSM 08.58 RSL_ACT_* constants. */ static inline const char *rsl_act_type_name(uint8_t act_type) { return get_value_string(rsl_act_type_names, act_type); diff --git a/include/osmocom/gsm/tlv.h b/include/osmocom/gsm/tlv.h index 4a9bd272..fa3b6564 100644 --- a/include/osmocom/gsm/tlv.h +++ b/include/osmocom/gsm/tlv.h @@ -25,21 +25,21 @@ */ -/*! \brief gross length of a LV type field */ +/*! gross length of a LV type field */ #define LV_GROSS_LEN(x) (x+1) -/*! \brief gross length of a TLV type field */ +/*! gross length of a TLV type field */ #define TLV_GROSS_LEN(x) (x+2) -/*! \brief gross length of a TLV16 type field */ +/*! gross length of a TLV16 type field */ #define TLV16_GROSS_LEN(x) ((2*x)+2) -/*! \brief gross length of a TL16V type field */ +/*! gross length of a TL16V type field */ #define TL16V_GROSS_LEN(x) (x+3) -/*! \brief gross length of a L16TV type field */ +/*! gross length of a L16TV type field */ #define L16TV_GROSS_LEN(x) (x+3) -/*! \brief maximum length of TLV of one byte length */ +/*! maximum length of TLV of one byte length */ #define TVLV_MAX_ONEBYTE 0x7f -/*! \brief gross length of a TVLV type field */ +/*! gross length of a TVLV type field */ static inline uint16_t TVLV_GROSS_LEN(uint16_t len) { if (len <= TVLV_MAX_ONEBYTE) @@ -48,7 +48,7 @@ static inline uint16_t TVLV_GROSS_LEN(uint16_t len) return TL16V_GROSS_LEN(len); } -/*! \brief gross length of vTvL header (tag+len) */ +/*! gross length of vTvL header (tag+len) */ static inline uint16_t VTVL_GAN_GROSS_LEN(uint16_t tag, uint16_t len) { uint16_t ret = 2; @@ -62,7 +62,7 @@ static inline uint16_t VTVL_GAN_GROSS_LEN(uint16_t tag, uint16_t len) return ret; } -/*! \brief gross length of vTvLV (tag+len+val) */ +/*! gross length of vTvLV (tag+len+val) */ static inline uint16_t VTVLV_GAN_GROSS_LEN(uint16_t tag, uint16_t len) { uint16_t ret; @@ -80,7 +80,7 @@ static inline uint16_t VTVLV_GAN_GROSS_LEN(uint16_t tag, uint16_t len) /* TLV generation */ -/*! \brief put (append) a LV field */ +/*! put (append) a LV field */ static inline uint8_t *lv_put(uint8_t *buf, uint8_t len, const uint8_t *val) { @@ -89,7 +89,7 @@ static inline uint8_t *lv_put(uint8_t *buf, uint8_t len, return buf + len; } -/*! \brief put (append) a TLV field */ +/*! put (append) a TLV field */ static inline uint8_t *tlv_put(uint8_t *buf, uint8_t tag, uint8_t len, const uint8_t *val) { @@ -99,7 +99,7 @@ static inline uint8_t *tlv_put(uint8_t *buf, uint8_t tag, uint8_t len, return buf + len; } -/*! \brief put (append) a TLV16 field */ +/*! put (append) a TLV16 field */ static inline uint8_t *tlv16_put(uint8_t *buf, uint8_t tag, uint8_t len, const uint16_t *val) { @@ -109,7 +109,7 @@ static inline uint8_t *tlv16_put(uint8_t *buf, uint8_t tag, uint8_t len, return buf + len*2; } -/*! \brief put (append) a TL16V field */ +/*! put (append) a TL16V field */ static inline uint8_t *tl16v_put(uint8_t *buf, uint8_t tag, uint16_t len, const uint8_t *val) { @@ -120,7 +120,7 @@ static inline uint8_t *tl16v_put(uint8_t *buf, uint8_t tag, uint16_t len, return buf + len*2; } -/*! \brief put (append) a TvLV field */ +/*! put (append) a TvLV field */ static inline uint8_t *tvlv_put(uint8_t *buf, uint8_t tag, uint16_t len, const uint8_t *val) { @@ -135,7 +135,7 @@ static inline uint8_t *tvlv_put(uint8_t *buf, uint8_t tag, uint16_t len, return ret; } -/*! \brief put (append) a variable-length tag or variable-length length * */ +/*! put (append) a variable-length tag or variable-length length * */ static inline uint8_t *vt_gan_put(uint8_t *buf, uint16_t tag) { if (tag > TVLV_MAX_ONEBYTE) { @@ -148,7 +148,7 @@ static inline uint8_t *vt_gan_put(uint8_t *buf, uint16_t tag) return buf; } -/* \brief put (append) vTvL (GAN) field (tag + length)*/ +/* put (append) vTvL (GAN) field (tag + length)*/ static inline uint8_t *vtvl_gan_put(uint8_t *buf, uint16_t tag, uint16_t len) { uint8_t *ret; @@ -157,7 +157,7 @@ static inline uint8_t *vtvl_gan_put(uint8_t *buf, uint16_t tag, uint16_t len) return vt_gan_put(ret, len); } -/* \brief put (append) vTvLV (GAN) field (tag + length + val) */ +/* put (append) vTvLV (GAN) field (tag + length + val) */ static inline uint8_t *vtvlv_gan_put(uint8_t *buf, uint16_t tag, uint16_t len, const uint8_t *val) { @@ -171,14 +171,14 @@ static inline uint8_t *vtvlv_gan_put(uint8_t *buf, uint16_t tag, uint16_t len, return ret; } -/*! \brief put (append) a TLV16 field to \ref msgb */ +/*! put (append) a TLV16 field to \ref msgb */ static inline uint8_t *msgb_tlv16_put(struct msgb *msg, uint8_t tag, uint8_t len, const uint16_t *val) { uint8_t *buf = msgb_put(msg, TLV16_GROSS_LEN(len)); return tlv16_put(buf, tag, len, val); } -/*! \brief put (append) a TL16V field to \ref msgb */ +/*! put (append) a TL16V field to \ref msgb */ static inline uint8_t *msgb_tl16v_put(struct msgb *msg, uint8_t tag, uint16_t len, const uint8_t *val) { @@ -186,7 +186,7 @@ static inline uint8_t *msgb_tl16v_put(struct msgb *msg, uint8_t tag, uint16_t le return tl16v_put(buf, tag, len, val); } -/*! \brief put (append) a TvLV field to \ref msgb */ +/*! put (append) a TvLV field to \ref msgb */ static inline uint8_t *msgb_tvlv_put(struct msgb *msg, uint8_t tag, uint16_t len, const uint8_t *val) { @@ -194,7 +194,7 @@ static inline uint8_t *msgb_tvlv_put(struct msgb *msg, uint8_t tag, uint16_t len return tvlv_put(buf, tag, len, val); } -/*! \brief put (append) a vTvLV field to \ref msgb */ +/*! put (append) a vTvLV field to \ref msgb */ static inline uint8_t *msgb_vtvlv_gan_put(struct msgb *msg, uint16_t tag, uint16_t len, const uint8_t *val) { @@ -202,7 +202,7 @@ static inline uint8_t *msgb_vtvlv_gan_put(struct msgb *msg, uint16_t tag, return vtvlv_gan_put(buf, tag, len, val); } -/*! \brief put (append) a L16TV field to \ref msgb */ +/*! put (append) a L16TV field to \ref msgb */ static inline uint8_t *msgb_l16tv_put(struct msgb *msg, uint16_t len, uint8_t tag, const uint8_t *val) { @@ -215,14 +215,14 @@ static inline uint8_t *msgb_l16tv_put(struct msgb *msg, uint16_t len, uint8_t ta return buf + len; } -/*! \brief put (append) a V field */ +/*! put (append) a V field */ static inline uint8_t *v_put(uint8_t *buf, uint8_t val) { *buf++ = val; return buf; } -/*! \brief put (append) a TV field */ +/*! put (append) a TV field */ static inline uint8_t *tv_put(uint8_t *buf, uint8_t tag, uint8_t val) { @@ -231,7 +231,7 @@ static inline uint8_t *tv_put(uint8_t *buf, uint8_t tag, return buf; } -/*! \brief put (append) a TVfixed field */ +/*! put (append) a TVfixed field */ static inline uint8_t *tv_fixed_put(uint8_t *buf, uint8_t tag, unsigned int len, const uint8_t *val) { @@ -240,7 +240,7 @@ static inline uint8_t *tv_fixed_put(uint8_t *buf, uint8_t tag, return buf + len; } -/*! \brief put (append) a TV16 field +/*! put (append) a TV16 field * \param[in,out] buf data buffer * \param[in] tag Tag value * \param[in] val Value (in host byte order!) @@ -254,7 +254,7 @@ static inline uint8_t *tv16_put(uint8_t *buf, uint8_t tag, return buf; } -/*! \brief put (append) a LV field to a \ref msgb +/*! put (append) a LV field to a \ref msgb * \returns pointer to first byte after newly-put information */ static inline uint8_t *msgb_lv_put(struct msgb *msg, uint8_t len, const uint8_t *val) { @@ -262,7 +262,7 @@ static inline uint8_t *msgb_lv_put(struct msgb *msg, uint8_t len, const uint8_t return lv_put(buf, len, val); } -/*! \brief put (append) a TLV field to a \ref msgb +/*! put (append) a TLV field to a \ref msgb * \returns pointer to first byte after newly-put information */ static inline uint8_t *msgb_tlv_put(struct msgb *msg, uint8_t tag, uint8_t len, const uint8_t *val) { @@ -270,7 +270,7 @@ static inline uint8_t *msgb_tlv_put(struct msgb *msg, uint8_t tag, uint8_t len, return tlv_put(buf, tag, len, val); } -/*! \brief put (append) a TV field to a \ref msgb +/*! put (append) a TV field to a \ref msgb * \returns pointer to first byte after newly-put information */ static inline uint8_t *msgb_tv_put(struct msgb *msg, uint8_t tag, uint8_t val) { @@ -278,7 +278,7 @@ static inline uint8_t *msgb_tv_put(struct msgb *msg, uint8_t tag, uint8_t val) return tv_put(buf, tag, val); } -/*! \brief put (append) a TVfixed field to a \ref msgb +/*! put (append) a TVfixed field to a \ref msgb * \returns pointer to first byte after newly-put information */ static inline uint8_t *msgb_tv_fixed_put(struct msgb *msg, uint8_t tag, unsigned int len, const uint8_t *val) @@ -287,7 +287,7 @@ static inline uint8_t *msgb_tv_fixed_put(struct msgb *msg, uint8_t tag, return tv_fixed_put(buf, tag, len, val); } -/*! \brief put (append) a V field to a \ref msgb +/*! put (append) a V field to a \ref msgb * \returns pointer to first byte after newly-put information */ static inline uint8_t *msgb_v_put(struct msgb *msg, uint8_t val) { @@ -295,7 +295,7 @@ static inline uint8_t *msgb_v_put(struct msgb *msg, uint8_t val) return v_put(buf, val); } -/*! \brief put (append) a TV16 field to a \ref msgb +/*! put (append) a TV16 field to a \ref msgb * \returns pointer to first byte after newly-put information */ static inline uint8_t *msgb_tv16_put(struct msgb *msg, uint8_t tag, uint16_t val) { @@ -303,7 +303,7 @@ static inline uint8_t *msgb_tv16_put(struct msgb *msg, uint8_t tag, uint16_t val return tv16_put(buf, tag, val); } -/*! \brief push (prepend) a TLV field to a \ref msgb +/*! push (prepend) a TLV field to a \ref msgb * \returns pointer to first byte of newly-pushed information */ static inline uint8_t *msgb_tlv_push(struct msgb *msg, uint8_t tag, uint8_t len, const uint8_t *val) { @@ -312,7 +312,7 @@ static inline uint8_t *msgb_tlv_push(struct msgb *msg, uint8_t tag, uint8_t len, return buf; } -/*! \brief push (prepend) a TV field to a \ref msgb +/*! push (prepend) a TV field to a \ref msgb * \returns pointer to first byte of newly-pushed information */ static inline uint8_t *msgb_tv_push(struct msgb *msg, uint8_t tag, uint8_t val) { @@ -321,7 +321,7 @@ static inline uint8_t *msgb_tv_push(struct msgb *msg, uint8_t tag, uint8_t val) return buf; } -/*! \brief push (prepend) a TV16 field to a \ref msgb +/*! push (prepend) a TV16 field to a \ref msgb * \returns pointer to first byte of newly-pushed information */ static inline uint8_t *msgb_tv16_push(struct msgb *msg, uint8_t tag, uint16_t val) { @@ -330,7 +330,7 @@ static inline uint8_t *msgb_tv16_push(struct msgb *msg, uint8_t tag, uint16_t va return buf; } -/*! \brief push (prepend) a TvLV field to a \ref msgb +/*! push (prepend) a TvLV field to a \ref msgb * \returns pointer to first byte of newly-pushed information */ static inline uint8_t *msgb_tvlv_push(struct msgb *msg, uint8_t tag, uint16_t len, const uint8_t *val) @@ -340,7 +340,7 @@ static inline uint8_t *msgb_tvlv_push(struct msgb *msg, uint8_t tag, uint16_t le return buf; } -/* \brief push (prepend) a vTvL header to a \ref msgb +/* push (prepend) a vTvL header to a \ref msgb */ static inline uint8_t *msgb_vtvl_gan_push(struct msgb *msg, uint16_t tag, uint16_t len) @@ -361,37 +361,37 @@ static inline uint8_t *msgb_vtvlv_gan_push(struct msgb *msg, uint16_t tag, /* TLV parsing */ -/*! \brief Entry in a TLV parser array */ +/*! Entry in a TLV parser array */ struct tlv_p_entry { - uint16_t len; /*!< \brief length */ - const uint8_t *val; /*!< \brief pointer to value */ + uint16_t len; /*!< length */ + const uint8_t *val; /*!< pointer to value */ }; -/*! \brief TLV type */ +/*! TLV type */ enum tlv_type { - TLV_TYPE_NONE, /*!< \brief no type */ - TLV_TYPE_FIXED, /*!< \brief fixed-length value-only */ - TLV_TYPE_T, /*!< \brief tag-only */ - TLV_TYPE_TV, /*!< \brief tag-value (8bit) */ - TLV_TYPE_TLV, /*!< \brief tag-length-value */ - TLV_TYPE_TL16V, /*!< \brief tag, 16 bit length, value */ - TLV_TYPE_TvLV, /*!< \brief tag, variable length, value */ - TLV_TYPE_SINGLE_TV, /*!< \brief tag and value (both 4 bit) in 1 byte */ - TLV_TYPE_vTvLV_GAN, /*!< \brief variable-length tag, variable-length length */ + TLV_TYPE_NONE, /*!< no type */ + TLV_TYPE_FIXED, /*!< fixed-length value-only */ + TLV_TYPE_T, /*!< tag-only */ + TLV_TYPE_TV, /*!< tag-value (8bit) */ + TLV_TYPE_TLV, /*!< tag-length-value */ + TLV_TYPE_TL16V, /*!< tag, 16 bit length, value */ + TLV_TYPE_TvLV, /*!< tag, variable length, value */ + TLV_TYPE_SINGLE_TV, /*!< tag and value (both 4 bit) in 1 byte */ + TLV_TYPE_vTvLV_GAN, /*!< variable-length tag, variable-length length */ }; -/*! \brief Definition of a single IE (Information Element) */ +/*! Definition of a single IE (Information Element) */ struct tlv_def { - enum tlv_type type; /*!< \brief TLV type */ - uint8_t fixed_len; /*!< \brief length in case of \ref TLV_TYPE_FIXED */ + enum tlv_type type; /*!< TLV type */ + uint8_t fixed_len; /*!< length in case of \ref TLV_TYPE_FIXED */ }; -/*! \brief Definition of All 256 IE / TLV */ +/*! Definition of All 256 IE / TLV */ struct tlv_definition { struct tlv_def def[256]; }; -/*! \brief result of the TLV parser */ +/*! result of the TLV parser */ struct tlv_parsed { struct tlv_p_entry lv[256]; }; @@ -414,7 +414,7 @@ void tlv_def_patch(struct tlv_definition *dst, const struct tlv_definition *src) #define TLVP_PRES_LEN(tp, tag, min_len) \ (TLVP_PRESENT(tp, tag) && TLVP_LEN(tp, tag) >= min_len) -/*! \brief Align given TLV element with 16 bit value to an even address +/*! Align given TLV element with 16 bit value to an even address * \param[in] tp pointer to \ref tlv_parsed * \param[in] pos element to return * \returns aligned 16 bit value @@ -426,7 +426,7 @@ static inline uint16_t tlvp_val16_unal(const struct tlv_parsed *tp, int pos) return res; } -/*! \brief Align given TLV element with 32 bit value to an address that is a multiple of 4 +/*! Align given TLV element with 32 bit value to an address that is a multiple of 4 * \param[in] tp pointer to \ref tlv_parsed * \param[in] pos element to return * \returns aligned 32 bit value @@ -438,7 +438,7 @@ static inline uint32_t tlvp_val32_unal(const struct tlv_parsed *tp, int pos) return res; } -/*! \brief Retrieve (possibly unaligned) TLV element and convert to host byte order +/*! Retrieve (possibly unaligned) TLV element and convert to host byte order * \param[in] tp pointer to \ref tlv_parsed * \param[in] pos element to return * \returns aligned 16 bit value in host byte order @@ -448,7 +448,7 @@ static inline uint16_t tlvp_val16be(const struct tlv_parsed *tp, int pos) return osmo_load16be(TLVP_VAL(tp, pos)); } -/*! \brief Retrieve (possibly unaligned) TLV element and convert to host byte order +/*! Retrieve (possibly unaligned) TLV element and convert to host byte order * \param[in] tp pointer to \ref tlv_parsed * \param[in] pos element to return * \returns aligned 32 bit value in host byte order diff --git a/include/osmocom/sim/sim.h b/include/osmocom/sim/sim.h index ba6fb707..eb954807 100644 --- a/include/osmocom/sim/sim.h +++ b/include/osmocom/sim/sim.h @@ -8,10 +8,10 @@ /*! * \file sim.h - * \brief Routines for helping with SIM (ISO/IEC 7816-4 more generally) communication. + * Routines for helping with SIM (ISO/IEC 7816-4 more generally) communication. */ -/*! \brief command-response pairs cases +/*! command-response pairs cases * * Enumeration used to identify the APDU structure based on command-response pair case , as specified in ISO/IEC 7816-3:2006(E) §12.1. */ @@ -25,7 +25,7 @@ enum osim_apdu_case { APDU_CASE_4E /*!< command header, command data field (extended), response data field (extended) */ }; -/*! \brief APDU/TPDU command header +/*! APDU/TPDU command header * * This structure encode an APDU/TPDU command header, as specified in ISO/IEC 7816-3:2006(E) §12.2 and §12.3. * The APDU (application layer) can be encoded as different TPDUs (transport layer), depending on the transport protocol used. @@ -44,7 +44,7 @@ struct osim_apdu_cmd_hdr { #define msgb_apdu_dr(__x) -/*! \brief APDU command body +/*! APDU command body * * This structure encode a command body, as specified in ISO/IEC 7816-3:2006(E) §12.1. * The data and response contents should be provided along with this structure. @@ -56,12 +56,12 @@ struct osim_msgb_cb { uint16_t sw; /*!< status word, composed of SW1 and SW2 bytes */ } __attribute__((__may_alias__)); #define OSIM_MSGB_CB(__msgb) ((struct osim_msgb_cb *)&((__msgb)->cb[0])) -/*! \brief status word from msgb->cb */ +/*! status word from msgb->cb */ #define msgb_apdu_case(__x) OSIM_MSGB_CB(__x)->apduc #define msgb_apdu_lc(__x) OSIM_MSGB_CB(__x)->lc #define msgb_apdu_le(__x) OSIM_MSGB_CB(__x)->le #define msgb_apdu_sw(__x) OSIM_MSGB_CB(__x)->sw -/*! \brief pointer to the command header of the APDU */ +/*! pointer to the command header of the APDU */ #define msgb_apdu_h(__x) ((struct osim_apdu_cmd_hdr *)(__x)->l2h) #define msgb_apdu_dc(__x) ((__x)->l2h + sizeof(struct osim_apdu_cmd_hdr)) @@ -73,7 +73,7 @@ struct osim_file; struct osim_file_desc; struct osim_decoded_data; -/*! \brief Operations for a given File */ +/*! Operations for a given File */ struct osim_file_ops { /*! Parse binary file data into osim_decoded_data */ int (*parse)(struct osim_decoded_data *dd, @@ -102,7 +102,7 @@ enum osim_element_repr { ELEM_REPR_HEX, }; -/*! \brief A single decoded element inside a file */ +/*! A single decoded element inside a file */ struct osim_decoded_element { struct llist_head list; @@ -176,7 +176,7 @@ struct osim_file_desc { } size; }; -/*! \brief A single instance of a file: Descriptor and contents */ +/*! A single instance of a file: Descriptor and contents */ struct osim_file { /*! Descriptor for the file */ const struct osim_file_desc *desc; @@ -282,7 +282,7 @@ struct osim_card_sw { .class = SW_CLS_NONE, .u.str = NULL \ } -/*! \brief A card profile (e.g. SIM card */ +/*! A card profile (e.g. SIM card */ struct osim_card_profile { const char *name; /*! Descriptor for the MF (root directory */ @@ -343,33 +343,33 @@ struct osim_reader_ops { }; struct osim_reader_hdl { - /*! \brief member in global list of readers */ + /*! member in global list of readers */ struct llist_head list; const struct osim_reader_ops *ops; uint32_t proto_supported; void *priv; - /*! \brief current card, if any */ + /*! current card, if any */ struct osim_card_hdl *card; }; struct osim_card_hdl { - /*! \brief member in global list of cards */ + /*! member in global list of cards */ struct llist_head list; - /*! \brief reader through which card is accessed */ + /*! reader through which card is accessed */ struct osim_reader_hdl *reader; - /*! \brief card profile */ + /*! card profile */ struct osim_card_profile *prof; - /*! \brief card protocol */ + /*! card protocol */ enum osim_proto proto; - /*! \brief list of channels for this card */ + /*! list of channels for this card */ struct llist_head channels; }; struct osim_chan_hdl { - /*! \brief linked to card->channels */ + /*! linked to card->channels */ struct llist_head list; - /*! \brief card to which this channel belongs */ + /*! card to which this channel belongs */ struct osim_card_hdl *card; const struct osim_file_desc *cwd; }; diff --git a/include/osmocom/vty/command.h b/include/osmocom/vty/command.h index 62989c1d..9a072d73 100644 --- a/include/osmocom/vty/command.h +++ b/include/osmocom/vty/command.h @@ -31,97 +31,97 @@ */ /*! \file command.h */ -/*! \brief Host configuration variable */ +/*! Host configuration variable */ struct host { - /*! \brief Host name of this router. */ + /*! Host name of this router. */ char *name; - /*! \brief Password for vty interface. */ + /*! Password for vty interface. */ char *password; char *password_encrypt; - /*! \brief Enable password */ + /*! Enable password */ char *enable; char *enable_encrypt; - /*! \brief System wide terminal lines. */ + /*! System wide terminal lines. */ int lines; - /*! \brief Log filename. */ + /*! Log filename. */ char *logfile; - /*! \brief config file name of this host */ + /*! config file name of this host */ char *config; - /*! \brief Flags for services */ + /*! Flags for services */ int advanced; int encrypt; - /*! \brief Banner configuration. */ + /*! Banner configuration. */ const char *motd; char *motdfile; - /*! \brief VTY application information */ + /*! VTY application information */ const struct vty_app_info *app_info; }; -/*! \brief There are some command levels which called from command node. */ +/*! There are some command levels which called from command node. */ enum node_type { - AUTH_NODE, /*!< \brief Authentication mode of vty interface. */ - VIEW_NODE, /*!< \brief View node. Default mode of vty interface. */ - AUTH_ENABLE_NODE, /*!< \brief Authentication mode for change enable. */ - ENABLE_NODE, /*!< \brief Enable node. */ - CONFIG_NODE, /*!< \brief Config node. Default mode of config file. */ - SERVICE_NODE, /*!< \brief Service node. */ - DEBUG_NODE, /*!< \brief Debug node. */ - CFG_LOG_NODE, /*!< \brief Configure the logging */ - CFG_STATS_NODE, /*!< \brief Configure the statistics */ - - VTY_NODE, /*!< \brief Vty node. */ - - L_E1INP_NODE, /*!< \brief E1 line in libosmo-abis. */ - L_IPA_NODE, /*!< \brief IPA proxying commands in libosmo-abis. */ - L_NS_NODE, /*!< \brief NS node in libosmo-gb. */ - L_BSSGP_NODE, /*!< \brief BSSGP node in libosmo-gb. */ - L_CTRL_NODE, /*!< \brief Control interface node. */ - - L_CS7_NODE, /*!< \brief SS7 root node */ - L_CS7_AS_NODE, /*!< \brief SS7 Application Server */ - L_CS7_ASP_NODE, /*!< \brief SS7 Application Server Process */ - L_CS7_XUA_NODE, /*!< \brief SS7 xUA Listener */ - L_CS7_RTABLE_NODE, /*!< \brief SS7 Routing Table */ - L_CS7_LINK_NODE, /*!< \brief SS7 Link */ - L_CS7_LINKSET_NODE, /*!< \brief SS7 Linkset */ - L_CS7_SCCPADDR_NODE, /*!< \brief SS7 SCCP Address */ - L_CS7_SCCPADDR_GT_NODE, /*!< \brief SS7 SCCP Global Title */ + AUTH_NODE, /*!< Authentication mode of vty interface. */ + VIEW_NODE, /*!< View node. Default mode of vty interface. */ + AUTH_ENABLE_NODE, /*!< Authentication mode for change enable. */ + ENABLE_NODE, /*!< Enable node. */ + CONFIG_NODE, /*!< Config node. Default mode of config file. */ + SERVICE_NODE, /*!< Service node. */ + DEBUG_NODE, /*!< Debug node. */ + CFG_LOG_NODE, /*!< Configure the logging */ + CFG_STATS_NODE, /*!< Configure the statistics */ + + VTY_NODE, /*!< Vty node. */ + + L_E1INP_NODE, /*!< E1 line in libosmo-abis. */ + L_IPA_NODE, /*!< IPA proxying commands in libosmo-abis. */ + L_NS_NODE, /*!< NS node in libosmo-gb. */ + L_BSSGP_NODE, /*!< BSSGP node in libosmo-gb. */ + L_CTRL_NODE, /*!< Control interface node. */ + + L_CS7_NODE, /*!< SS7 root node */ + L_CS7_AS_NODE, /*!< SS7 Application Server */ + L_CS7_ASP_NODE, /*!< SS7 Application Server Process */ + L_CS7_XUA_NODE, /*!< SS7 xUA Listener */ + L_CS7_RTABLE_NODE, /*!< SS7 Routing Table */ + L_CS7_LINK_NODE, /*!< SS7 Link */ + L_CS7_LINKSET_NODE, /*!< SS7 Linkset */ + L_CS7_SCCPADDR_NODE, /*!< SS7 SCCP Address */ + L_CS7_SCCPADDR_GT_NODE, /*!< SS7 SCCP Global Title */ /* * When adding new nodes to the libosmocore project, these nodes can be * used to avoid ABI changes for unrelated projects. */ - RESERVED3_NODE, /*!< \brief Reserved for later extensions */ + RESERVED3_NODE, /*!< Reserved for later extensions */ _LAST_OSMOVTY_NODE }; #include "vty.h" -/*! \brief Node which has some commands and prompt string and +/*! Node which has some commands and prompt string and * configuration function pointer . */ struct cmd_node { - /*! \brief Node index */ + /*! Node index */ int node; - /*! \brief Prompt character at vty interface. */ + /*! Prompt character at vty interface. */ const char *prompt; - /*! \brief Is this node's configuration goes to vtysh ? */ + /*! Is this node's configuration goes to vtysh ? */ int vtysh; - /*! \brief Node's configuration write function */ + /*! Node's configuration write function */ int (*func) (struct vty *); - /*! \brief Vector of this node's command list. */ + /*! Vector of this node's command list. */ vector cmd_vector; }; @@ -130,26 +130,26 @@ enum { CMD_ATTR_HIDDEN, }; -/*! \brief Structure of a command element */ +/*! Structure of a command element */ struct cmd_element { - const char *string; /*!< \brief Command specification by string. */ + const char *string; /*!< Command specification by string. */ int (*func) (struct cmd_element *, struct vty *, int, const char *[]); - const char *doc; /*!< \brief Documentation of this command. */ - int daemon; /*!< \brief Daemon to which this command belong. */ - vector strvec; /*!< \brief Pointing out each description vector. */ - unsigned int cmdsize; /*!< \brief Command index count. */ - char *config; /*!< \brief Configuration string */ - vector subconfig; /*!< \brief Sub configuration string */ - unsigned char attr; /*!< \brief Command attributes */ + const char *doc; /*!< Documentation of this command. */ + int daemon; /*!< Daemon to which this command belong. */ + vector strvec; /*!< Pointing out each description vector. */ + unsigned int cmdsize; /*!< Command index count. */ + char *config; /*!< Configuration string */ + vector subconfig; /*!< Sub configuration string */ + unsigned char attr; /*!< Command attributes */ }; -/*! \brief Command description structure. */ +/*! Command description structure. */ struct desc { - const char *cmd; /*!< \brief Command string. */ - const char *str; /*!< \brief Command's description. */ + const char *cmd; /*!< Command string. */ + const char *str; /*!< Command's description. */ }; -/*! \brief Return value of the commands. */ +/*! Return value of the commands. */ #define CMD_SUCCESS 0 #define CMD_WARNING 1 #define CMD_ERR_NO_MATCH 2 @@ -197,7 +197,7 @@ struct desc { static int funcname \ (struct cmd_element *self, struct vty *vty, int argc, const char *argv[]) -/*! \brief Macro for defining a VTY node and function +/*! Macro for defining a VTY node and function * \param[in] funcname Name of the function implementing the node * \param[in] cmdname Name of the command node * \param[in] cmdstr String with syntax of node @@ -208,7 +208,7 @@ struct desc { DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \ DEFUN_CMD_FUNC_TEXT(funcname) -/*! \brief Macro for defining a non-static (global) VTY node and function +/*! Macro for defining a non-static (global) VTY node and function * \param[in] funcname Name of the function implementing the node * \param[in] cmdname Name of the command node * \param[in] cmdstr String with syntax of node diff --git a/include/osmocom/vty/telnet_interface.h b/include/osmocom/vty/telnet_interface.h index e939ec71..bca91564 100644 --- a/include/osmocom/vty/telnet_interface.h +++ b/include/osmocom/vty/telnet_interface.h @@ -31,17 +31,17 @@ /*! \file telnet_interface.h */ -/*! \brief A telnet connection */ +/*! A telnet connection */ struct telnet_connection { - /*! \brief linked list header for internal management */ + /*! linked list header for internal management */ struct llist_head entry; - /*! \brief private data pointer passed through */ + /*! private data pointer passed through */ void *priv; - /*! \brief filedsecriptor (socket ) */ + /*! filedsecriptor (socket ) */ struct osmo_fd fd; - /*! \brief VTY instance associated with telnet connection */ + /*! VTY instance associated with telnet connection */ struct vty *vty; - /*! \brief logging target associated with this telnet connection */ + /*! logging target associated with this telnet connection */ struct log_target *dbg; }; diff --git a/include/osmocom/vty/vty.h b/include/osmocom/vty/vty.h index 43cb0cfe..d59f5d47 100644 --- a/include/osmocom/vty/vty.h +++ b/include/osmocom/vty/vty.h @@ -25,7 +25,7 @@ #define VTY_BUFSIZ 512 #define VTY_MAXHIST 20 -/*! \brief VTY events */ +/*! VTY events */ enum event { VTY_SERV, VTY_READ, @@ -48,92 +48,92 @@ enum vty_type { /*! Internal representation of a single VTY */ struct vty { - /*! \brief underlying file (if any) */ + /*! underlying file (if any) */ FILE *file; - /*! \brief private data, specified by creator */ + /*! private data, specified by creator */ void *priv; - /*! \brief File descripter of this vty. */ + /*! File descripter of this vty. */ int fd; - /*! \brief Is this vty connect to file or not */ + /*! Is this vty connect to file or not */ enum vty_type type; - /*! \brief Node status of this vty */ + /*! Node status of this vty */ int node; - /*! \brief Failure count */ + /*! Failure count */ int fail; - /*! \brief Output buffer. */ + /*! Output buffer. */ struct buffer *obuf; - /*! \brief Command input buffer */ + /*! Command input buffer */ char *buf; - /*! \brief Command cursor point */ + /*! Command cursor point */ int cp; - /*! \brief Command length */ + /*! Command length */ int length; - /*! \brief Command max length. */ + /*! Command max length. */ int max; - /*! \brief Histry of command */ + /*! Histry of command */ char *hist[VTY_MAXHIST]; - /*! \brief History lookup current point */ + /*! History lookup current point */ int hp; - /*! \brief History insert end point */ + /*! History insert end point */ int hindex; - /*! \brief For current referencing point of interface, route-map, + /*! For current referencing point of interface, route-map, access-list etc... */ void *index; - /*! \brief For multiple level index treatment such as key chain and key. */ + /*! For multiple level index treatment such as key chain and key. */ void *index_sub; - /*! \brief For escape character. */ + /*! For escape character. */ unsigned char escape; - /*! \brief Current vty status. */ + /*! Current vty status. */ enum { VTY_NORMAL, VTY_CLOSE, VTY_MORE, VTY_MORELINE } status; - /*! \brief IAC handling + /*! IAC handling * * IAC handling: was the last character received the IAC * (interpret-as-command) escape character (and therefore the next * character will be the command code)? Refer to Telnet RFC 854. */ unsigned char iac; - /*! \brief IAC SB (option subnegotiation) handling */ + /*! IAC SB (option subnegotiation) handling */ unsigned char iac_sb_in_progress; /* At the moment, we care only about the NAWS (window size) negotiation, * and that requires just a 5-character buffer (RFC 1073): * <NAWS char> <16-bit width> <16-bit height> */ #define TELNET_NAWS_SB_LEN 5 - /*! \brief sub-negotiation buffer */ + /*! sub-negotiation buffer */ unsigned char sb_buf[TELNET_NAWS_SB_LEN]; - /*! \brief How many subnegotiation characters have we received? + /*! How many subnegotiation characters have we received? * * We just drop those that do not fit in the buffer. */ size_t sb_len; - /*! \brief Window width */ + /*! Window width */ int width; - /*! \brief Widnow height */ + /*! Widnow height */ int height; - /*! \brief Configure lines. */ + /*! Configure lines. */ int lines; int monitor; - /*! \brief In configure mode. */ + /*! In configure mode. */ int config; }; @@ -147,19 +147,19 @@ static inline const char *vty_newline(struct vty *vty) /*! Information an application registers with the VTY */ struct vty_app_info { - /*! \brief name of the application */ + /*! name of the application */ const char *name; - /*! \brief version string of the application */ + /*! version string of the application */ const char *version; - /*! \brief copyright string of the application */ + /*! copyright string of the application */ const char *copyright; - /*! \brief \ref talloc context */ + /*! \ref talloc context */ void *tall_ctx; - /*! \brief call-back for returning to parent n ode */ + /*! call-back for returning to parent n ode */ int (*go_parent_cb)(struct vty *vty); - /*! \brief call-back to determine if node is config node */ + /*! call-back to determine if node is config node */ int (*is_config_node)(struct vty *vty, int node); - /*! \brief Check if the config is consistent before write */ + /*! Check if the config is consistent before write */ int (*config_is_consistent)(struct vty *vty); }; |