From 8f2c7e5b2b2c038d51653c68380837fd54b84db0 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Wed, 17 Aug 2011 18:52:03 +0200 Subject: RSL: add doxygen documentation --- include/osmocom/gsm/protocol/gsm_08_58.h | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) (limited to 'include/osmocom/gsm') diff --git a/include/osmocom/gsm/protocol/gsm_08_58.h b/include/osmocom/gsm/protocol/gsm_08_58.h index 9b641b34..a7b68a79 100644 --- a/include/osmocom/gsm/protocol/gsm_08_58.h +++ b/include/osmocom/gsm/protocol/gsm_08_58.h @@ -25,13 +25,20 @@ #include +/*! \addtogroup rsl + * @{ + */ + +/*! \file gsm_08_58.h */ + +/*! \brief RSL common header */ struct abis_rsl_common_hdr { uint8_t msg_discr; uint8_t msg_type; uint8_t data[0]; } __attribute__ ((packed)); -/* Chapter 8.3 */ +/* \brief RSL RLL header (Chapter 8.3) */ struct abis_rsl_rll_hdr { struct abis_rsl_common_hdr c; uint8_t ie_chan; @@ -41,7 +48,7 @@ struct abis_rsl_rll_hdr { uint8_t data[0]; } __attribute__ ((packed)); -/* Chapter 8.3 and 8.4 */ +/* \brief 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; @@ -49,7 +56,7 @@ struct abis_rsl_dchan_hdr { uint8_t data[0]; } __attribute__ ((packed)); -/* Chapter 8.5 */ +/* \brief RSL Common Channel header (Chapter 8.5) */ struct abis_rsl_cchan_hdr { struct abis_rsl_common_hdr c; uint8_t ie_chan; @@ -69,7 +76,7 @@ struct abis_rsl_cchan_hdr { #define ABIS_RSL_MDISC_IS_TRANSP(x) (x & 0x01) -/* Chapter 9.1 */ +/* \brief RSL Message Tyoe (Chapter 9.1) */ enum abis_rsl_msgtype { /* Radio Link Layer Management */ RSL_MT_DATA_REQ = 0x01, @@ -169,7 +176,7 @@ enum abis_rsl_msgtype { RSL_MT_IPAC_DLCX_NACK, }; -/* Siemens vendor-specific */ +/*! \brief Siemens vendor-specific RSL message types */ enum abis_rsl_msgtype_siemens { RSL_MT_SIEMENS_MRPCI = 0x41, RSL_MT_SIEMENS_INTRAC_HO_COND_IND = 0x42, @@ -189,7 +196,7 @@ enum abis_rsl_msgtype_siemens { RSL_MT_SIEMENS_MODIF_COND_IND = 0x50, }; -/* Chapter 9.3 */ +/*! \brief RSL Information Element Identifiers (Chapter 9.3) */ enum abis_rsl_ie { RSL_IE_CHAN_NR = 0x01, RSL_IE_LINK_IDENT, @@ -302,7 +309,7 @@ enum abis_rsl_ie { #define RSL_ACT_SECOND_ADD 0x04 #define RSL_ACT_SECOND_MULTI 0x05 -/* Chapter 9.3.6 */ +/*! \brief RSL Channel Mode IF (Chapter 9.3.6) */ struct rsl_ie_chan_mode { uint8_t dtx_dtu; uint8_t spd_ind; @@ -329,7 +336,7 @@ enum rsl_cmod_spd { #define RSL_CMOD_SP_NT_12k0 0x50 #define RSL_CMOD_SP_NT_6k0 0x51 -/* Chapter 9.3.5 */ +/*! \brief RSL Channel Identification IE (Chapter 9.3.5) */ struct rsl_ie_chan_ident { /* GSM 04.08 10.5.2.5 */ struct { @@ -441,7 +448,7 @@ struct rsl_ie_chan_ident { #define RSL_CHANNEED_TCH_F 0x02 #define RSL_CHANNEED_TCH_ForH 0x03 -/* Chapter 9.3.45 */ +/*! \brief RSL Cell Broadcast Command (Chapter 9.3.45) */ struct rsl_ie_cb_cmd_type { uint8_t last_block:2; uint8_t spare:1; @@ -542,5 +549,6 @@ enum rsl_mrpci_phase { RSL_MRPCI_PHASE_2PLUS = 3, }; +/*! }@ */ #endif /* PROTO_GSM_08_58_H */ -- cgit v1.2.3