diff options
| author | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-20 04:35:06 +0200 |
|---|---|---|
| committer | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-23 00:18:23 +0000 |
| commit | 17518fe393a37781c84d09836256bb1a6256032b (patch) | |
| tree | 6a39eb3b0b86fa7407ea04a00410aaa1b588d3d3 /src | |
| parent | 33370cb18d3dda2bccbf2648f40d9614693ed0ea (diff) | |
doxygen: unify use of \file across the board
Considering the various styles and implications found in the sources, edit
scores of files to follow the same API doc guidelines around the doxygen
grouping and the \file tag.
Many files now show a short description in the generated API doc that was so
far only available as C comment.
The guidelines and reasoning behind it is documented at
https://osmocom.org/projects/cellular-infrastructure/wiki/Guidelines_for_API_documentation
In some instances, remove file comments and add to the corresponding group
instead, to be shared among several files (e.g. bitvec).
Change-Id: Ifa70e77e90462b5eb2b0457c70fd25275910c72b
Diffstat (limited to 'src')
130 files changed, 532 insertions, 553 deletions
diff --git a/src/application.c b/src/application.c index e7c8e0f9..aec3fd7b 100644 --- a/src/application.c +++ b/src/application.c @@ -1,4 +1,5 @@ -/* Utility functions to setup applications */ +/*! \file application.c + * Routines for helping with the osmocom application setup. */ /* * (C) 2010 by Harald Welte <laforge@gnumonks.org> * (C) 2011 by Holger Hans Peter Freyther @@ -21,10 +22,6 @@ * */ -/*! \file application.c - * Routines for helping with the osmocom application setup. - */ - /*! \mainpage libosmocore Documentation * \section sec_intro Introduction * This library is a collection of common code used in various diff --git a/src/backtrace.c b/src/backtrace.c index 0240a758..5ce74825 100644 --- a/src/backtrace.c +++ b/src/backtrace.c @@ -1,3 +1,5 @@ +/*! \file backtrace.c + * Routines related to generating call back traces. */ /* * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> * (C) 2012 by Harald Welte <laforge@gnumonks.org> @@ -20,10 +22,6 @@ * */ -/*! \file backtrace.c - * Routines realted to generating call back traces - */ - #include <stdio.h> #include <stdlib.h> #include <osmocom/core/utils.h> diff --git a/src/bitcomp.c b/src/bitcomp.c index acf165e0..94f60eb3 100644 --- a/src/bitcomp.c +++ b/src/bitcomp.c @@ -1,6 +1,7 @@ -/* bit compression routines */ - -/* (C) 2016 sysmocom s.f.m.c. GmbH by Max Suraev <msuraev@sysmocom.de> +/*! \file bitcomp.c + * Osmocom bit compression routines */ +/* + * (C) 2016 sysmocom s.f.m.c. GmbH by Max Suraev <msuraev@sysmocom.de> * * All Rights Reserved * @@ -22,11 +23,7 @@ /*! \defgroup bitcomp Bit compression * @{ - */ - -/*! \file bitcomp.c - * Osmocom bit compression routines - */ + * \file bitcomp.c */ #include <stdint.h> #include <stdbool.h> @@ -26,11 +26,9 @@ /*! \addtogroup bits * @{ - * Osmocom bit level support code - */ - -/*! \file bits.c */ - + * Osmocom bit level support code. + * + * \file bits.c */ /*! convert unpacked bits to packed bits, return length in bytes * \param[out] out output buffer of packed bits diff --git a/src/bitvec.c b/src/bitvec.c index 8ed7296a..f07b42c3 100644 --- a/src/bitvec.c +++ b/src/bitvec.c @@ -1,5 +1,3 @@ -/* bit vector utility routines */ - /* (C) 2009 by Harald Welte <laforge@gnumonks.org> * (C) 2012 Ivan Klyuchnikov * (C) 2015 by Sysmocom s.f.m.c. GmbH @@ -24,10 +22,17 @@ /*! \addtogroup bitvec * @{ - * Osmocom bit vector abstraction - */ - -/*! \file bitvec.c */ + * Osmocom bit vector abstraction utility routines. + * + * 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 + * embedded into a byte sequence like in xxxxxxab cdexxxxx. The bit count + * starts with the MSB, so the bits in a byte are numbered (MSB) 01234567 (LSB). + * Note that there are other incompatible encodings, like it is used + * for the EGPRS RLC data block headers (there the bits are numbered from LSB + * to MSB). + * + * \file bitvec.c */ #include <errno.h> #include <stdint.h> diff --git a/src/codec/gsm610.c b/src/codec/gsm610.c index df56583a..d5a21108 100644 --- a/src/codec/gsm610.c +++ b/src/codec/gsm610.c @@ -1,5 +1,5 @@ -/* GSM 06.10 - GSM FR codec */ - +/*! \file gsm610.c + * GSM 06.10 - GSM FR codec. */ /* * (C) 2010 Sylvain Munaut <tnt@246tNt.com> * diff --git a/src/codec/gsm620.c b/src/codec/gsm620.c index 30647480..b1a0b319 100644 --- a/src/codec/gsm620.c +++ b/src/codec/gsm620.c @@ -1,5 +1,5 @@ -/* GSM 06.20 - GSM HR codec */ - +/*! \file gsm620.c + * GSM 06.20 - GSM HR codec. */ /* * (C) 2010 Sylvain Munaut <tnt@246tNt.com> * diff --git a/src/codec/gsm660.c b/src/codec/gsm660.c index 6c9215f4..2f5c6a25 100644 --- a/src/codec/gsm660.c +++ b/src/codec/gsm660.c @@ -1,5 +1,5 @@ -/* GSM 06.60 - GSM EFR Codec */ - +/*! \file gsm660.c + * GSM 06.60 - GSM EFR Codec. */ /* * (C) 2010 Sylvain Munaut <tnt@246tNt.com> * diff --git a/src/codec/gsm690.c b/src/codec/gsm690.c index 74655bf4..1ee74d0b 100644 --- a/src/codec/gsm690.c +++ b/src/codec/gsm690.c @@ -1,5 +1,5 @@ -/* GSM 06.90 - GSM AMR Codec */ - +/*! \file gsm690.c + * GSM 06.90 - GSM AMR Codec. */ /* * (C) 2010 Sylvain Munaut <tnt@246tNt.com> * diff --git a/src/coding/gsm0503_coding.c b/src/coding/gsm0503_coding.c index bb86b2c7..5213dc5f 100644 --- a/src/coding/gsm0503_coding.c +++ b/src/coding/gsm0503_coding.c @@ -100,9 +100,8 @@ * various other modules (mapping, parity, interleaving) in order to * implement the complete channel coding (and decoding) chain for the * various channel types as defined in TS 05.03 / 45.003. - */ - -/*! \file gsm0503_coding.c */ + * + * \file gsm0503_coding.c */ /* * EGPRS coding limits diff --git a/src/coding/gsm0503_interleaving.c b/src/coding/gsm0503_interleaving.c index 19e68474..b42f242d 100644 --- a/src/coding/gsm0503_interleaving.c +++ b/src/coding/gsm0503_interleaving.c @@ -29,16 +29,12 @@ /*! \addtogroup interleaving * @{ - * GSM TS 05.03 interleaving + * GSM TS 05.03 interleaving * - * This module contains interleaving / de-interleaving routines for - * various channel types, as defined in 3GPP TS 05.03 / 45.003 - */ - -/*! \file gsm0503_interleaving.c */ - -/* - * GSM xCCH interleaving and burst mapping + * This module contains interleaving / de-interleaving routines for + * various channel types, as defined in 3GPP TS 05.03 / 45.003. + * + * GSM xCCH interleaving and burst mapping: * * Interleaving: * @@ -57,7 +53,30 @@ * e(B, 58) = h_n(B) * * Where hl(B) and hn(B) are bits in burst B indicating flags. - */ + * + * GSM TCH HR/AHS interleaving and burst mapping: + * + * Interleaving: + * + * Given 288 coded input bits, form 4 blocks of 114 bits, + * where even bits of the first 2 blocks and odd bits of the last 2 blocks + * are used: + * + * i(B, j) = c(n, k) k = 0, ..., 227 + * n = 0, ..., N, N + 1, ... + * B = B_0 + 2n + b + * j, b = table[k]; + * + * Mapping on Burst: + * + * e(B, j) = i(B, j) + * e(B, 59 + j) = i(B, 57 + j) j = 0, ..., 56 + * e(B, 57) = h_l(B) + * e(B, 58) = h_n(B) + * + * Where hl(B) and hn(B) are bits in burst B indicating flags. + * + * \file gsm0503_interleaving.c */ /*! De-Interleave burst bits according to TS 05.03 4.1.4 * \param[out] cB caller-allocated output buffer for 456 soft coded bits @@ -633,30 +652,6 @@ void gsm0503_tch_fr_interleave(const ubit_t *cB, ubit_t *iB) } } -/* - * GSM TCH HR/AHS interleaving and burst mapping - * - * Interleaving: - * - * Given 288 coded input bits, form 4 blocks of 114 bits, - * where even bits of the first 2 blocks and odd bits of the last 2 blocks - * are used: - * - * i(B, j) = c(n, k) k = 0, ..., 227 - * n = 0, ..., N, N + 1, ... - * B = B_0 + 2n + b - * j, b = table[k]; - * - * Mapping on Burst: - * - * e(B, j) = i(B, j) - * e(B, 59 + j) = i(B, 57 + j) j = 0, ..., 56 - * e(B, 57) = h_l(B) - * e(B, 58) = h_n(B) - * - * Where hl(B) and hn(B) are bits in burst B indicating flags. - */ - /*! GSM TCH HR/AHS De-Interleaving and burst mapping * \param[out] cB caller-allocated buffer for 228 unpacked output bits * \param[in] iB 228 unpacked interleaved input bits */ diff --git a/src/coding/gsm0503_mapping.c b/src/coding/gsm0503_mapping.c index 15fd1b6e..d414769f 100644 --- a/src/coding/gsm0503_mapping.c +++ b/src/coding/gsm0503_mapping.c @@ -32,9 +32,8 @@ * * This module contains burst mapping routines as specified in 3GPP TS * 05.03 / 45.003. - */ - -/*! \file gsm0503_mapping.c */ + * + * \file gsm0503_mapping.c */ void gsm0503_xcch_burst_unmap(sbit_t *iB, const sbit_t *eB, sbit_t *hl, sbit_t *hn) diff --git a/src/coding/gsm0503_parity.c b/src/coding/gsm0503_parity.c index cc817024..b57caa30 100644 --- a/src/coding/gsm0503_parity.c +++ b/src/coding/gsm0503_parity.c @@ -31,9 +31,8 @@ * * This module contains parity/crc code definitions for the various * parity/crc schemes as defined in 3GPP TS 05.03 / 45.003 - */ - -/*! \file gsm0503_parity.c */ + * + * \file gsm0503_parity.c */ /*! GSM (SACCH) parity (FIRE code) * diff --git a/src/coding/gsm0503_tables.c b/src/coding/gsm0503_tables.c index 32d12eae..dda8cad1 100644 --- a/src/coding/gsm0503_tables.c +++ b/src/coding/gsm0503_tables.c @@ -27,14 +27,13 @@ /*! \addtogroup tables * @{ * - * GSM TS 05.03 tables + * GSM TS 05.03 tables. * * This module contains various tables defining parts of 3GPP TS 05.03 * / 45.003, primarily for the purpose of (de)puncturing, interleaving, * etc. - */ - -/*! \file gsm0503_tables.c */ + * + * \file gsm0503_tables.c */ const ubit_t gsm0503_pdtch_hl_hn_ubit[4][8] = { { 1,1, 1,1, 1,1, 1,1 }, @@ -1,8 +1,6 @@ +/*! \file conv.c + * Generic convolutional encoding / decoding. */ /* - * conv.c - * - * Generic convolutional encoding / decoding - * * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * * All Rights Reserved @@ -24,10 +22,10 @@ /*! \addtogroup conv * @{ - * Osmocom convolutional encoder and decoder - */ + * Osmocom convolutional encoder and decoder. + * + * \file conv.c */ -/*! \file conv.c */ #include "config.h" #ifdef HAVE_ALLOCA_H #include <alloca.h> diff --git a/src/conv_acc.c b/src/conv_acc.c index 13b220b0..048bbb1c 100644 --- a/src/conv_acc.c +++ b/src/conv_acc.c @@ -1,6 +1,6 @@ +/*! \file conv_acc.c + * Accelerated Viterbi decoder implementation. */ /* - * Accelerated Viterbi decoder implementation - * * Copyright (C) 2013, 2014 Thomas Tsou <tom@tsou.cc> * * All Rights Reserved diff --git a/src/conv_acc_generic.c b/src/conv_acc_generic.c index a4787e35..228f3e28 100644 --- a/src/conv_acc_generic.c +++ b/src/conv_acc_generic.c @@ -1,7 +1,7 @@ -/* +/*! \file conv_acc_generic.c * Accelerated Viterbi decoder implementation - * for generic architectures without SSE support - * + * for generic architectures without SSE support. */ +/* * Copyright (C) 2013, 2014 Thomas Tsou <tom@tsou.cc> * * All Rights Reserved diff --git a/src/conv_acc_sse.c b/src/conv_acc_sse.c index bcc9d48f..e9bbde1c 100644 --- a/src/conv_acc_sse.c +++ b/src/conv_acc_sse.c @@ -1,7 +1,7 @@ -/* +/*! \file conv_acc_sse.c * Accelerated Viterbi decoder implementation - * for architectures with only SSE3 available - * + * for architectures with only SSE3 available. */ +/* * Copyright (C) 2013, 2014 Thomas Tsou <tom@tsou.cc> * * All Rights Reserved diff --git a/src/conv_acc_sse_avx.c b/src/conv_acc_sse_avx.c index 2ad353a4..c399719b 100644 --- a/src/conv_acc_sse_avx.c +++ b/src/conv_acc_sse_avx.c @@ -1,7 +1,7 @@ -/* +/*! \file conv_acc_sse_avx.c * Accelerated Viterbi decoder implementation - * for architectures with both SSE3 and AVX2 support - * + * for architectures with both SSE3 and AVX2 support. */ +/* * Copyright (C) 2013, 2014 Thomas Tsou <tom@tsou.cc> * * All Rights Reserved diff --git a/src/conv_acc_sse_impl.h b/src/conv_acc_sse_impl.h index a62f9106..e6eaaa6d 100644 --- a/src/conv_acc_sse_impl.h +++ b/src/conv_acc_sse_impl.h @@ -1,8 +1,8 @@ -/* - * Accelerated Viterbi decoder implementation +/*! \file conv_acc_sse_impl.h + * Accelerated Viterbi decoder implementation: * Actual definitions which are being included - * from both conv_acc_sse.c and conv_acc_sse_avx.c - * + * from both conv_acc_sse.c and conv_acc_sse_avx.c. */ +/* * Copyright (C) 2013, 2014 Thomas Tsou <tom@tsou.cc> * * All Rights Reserved diff --git a/src/crc16.c b/src/crc16.c index 7d523b65..b5cb9566 100644 --- a/src/crc16.c +++ b/src/crc16.c @@ -1,4 +1,4 @@ -/* +/*! \file crc16.c * This was copied from the linux kernel and adjusted for our types. */ /* diff --git a/src/crcXXgen.c.tpl b/src/crcXXgen.c.tpl index 9c63052d..e92a5381 100644 --- a/src/crcXXgen.c.tpl +++ b/src/crcXXgen.c.tpl @@ -1,8 +1,6 @@ +/*! \file crcXXgen.c + * Osmocom generic CRC routines (for max XX bits poly). */ /* - * crcXXgen.c - * - * Generic CRC routines (for max XX bits poly) - * * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * * All Rights Reserved @@ -24,12 +22,9 @@ /*! \addtogroup crcgen * @{ - * Osmocom generic CRC routines - */ - -/*! \file crcXXgen.c - * Osmocom generic CRC routines (for max XX bits poly) - */ + * Osmocom generic CRC routines (for max XX bits poly). + * + * \file crcXXgen.c.tpl */ #include <stdint.h> diff --git a/src/ctrl/control_cmd.c b/src/ctrl/control_cmd.c index d706995f..836bb717 100644 --- a/src/ctrl/control_cmd.c +++ b/src/ctrl/control_cmd.c @@ -1,5 +1,6 @@ -/* SNMP-like status interface - * +/*! \file control_cmd.c + * SNMP-like status interface. */ +/* * (C) 2010-2011 by Daniel Willmann <daniel@totalueberwachung.de> * (C) 2010-2011 by On-Waves * diff --git a/src/ctrl/control_if.c b/src/ctrl/control_if.c index 5d04cdfd..47efb253 100644 --- a/src/ctrl/control_if.c +++ b/src/ctrl/control_if.c @@ -1,5 +1,6 @@ -/* SNMP-like status interface - * +/*! \file control_if.c + * SNMP-like status interface. */ +/* * (C) 2010-2011 by Daniel Willmann <daniel@totalueberwachung.de> * (C) 2010-2011 by On-Waves * diff --git a/src/ctrl/control_vty.c b/src/ctrl/control_vty.c index a67dbe28..a968bc01 100644 --- a/src/ctrl/control_vty.c +++ b/src/ctrl/control_vty.c @@ -1,5 +1,6 @@ -/* VTY configuration for Control interface - * +/*! \file control_vty.c + * VTY configuration for Control interface. */ +/* * (C) 2016 by sysmocom s.m.f.c. GmbH <info@sysmocom.de> * * All Rights Reserved diff --git a/src/ctrl/fsm_ctrl_commands.c b/src/ctrl/fsm_ctrl_commands.c index 6c3ecde1..38fbd1e1 100644 --- a/src/ctrl/fsm_ctrl_commands.c +++ b/src/ctrl/fsm_ctrl_commands.c @@ -1,3 +1,5 @@ +/*! \file fsm_ctrl_commands.c */ + #include <string.h> #include <errno.h> @@ -1,5 +1,6 @@ -/* Osmocom generic Finite State Machine implementation - * +/*! \file fsm.c + * Osmocom generic Finite State Machine implementation. */ +/* * (C) 2016 by Harald Welte <laforge@gnumonks.org> * * This program is free software; you can redistribute it and/or modify @@ -82,9 +83,8 @@ * * In order to attach private state to the \ref osmo_fsm_inst, it * offers an opaque priv pointer. - */ - -/*! \file fsm.c */ + * + * \file fsm.c */ LLIST_HEAD(osmo_g_fsms); static bool fsm_log_addr = true; diff --git a/src/gb/common_vty.c b/src/gb/common_vty.c index 5848a11c..5de51355 100644 --- a/src/gb/common_vty.c +++ b/src/gb/common_vty.c @@ -1,5 +1,7 @@ -/* OpenBSC VTY common helpers */ -/* (C) 2009-2012 by Harald Welte <laforge@gnumonks.org> +/*! \file common_vty.c + * OpenBSC VTY common helpers. */ +/* + * (C) 2009-2012 by Harald Welte <laforge@gnumonks.org> * (C) 2009-2010 by Holger Hans Peter Freyther * All Rights Reserved * diff --git a/src/gb/common_vty.h b/src/gb/common_vty.h index 8c6b9ab1..a0674a7f 100644 --- a/src/gb/common_vty.h +++ b/src/gb/common_vty.h @@ -1,3 +1,5 @@ +/*! \file common_vty.h */ + #include <osmocom/vty/command.h> #include <osmocom/core/logging.h> diff --git a/src/gb/gprs_bssgp.c b/src/gb/gprs_bssgp.c index 142f5898..518198fd 100644 --- a/src/gb/gprs_bssgp.c +++ b/src/gb/gprs_bssgp.c @@ -1,6 +1,7 @@ -/* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */ - -/* (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> +/*! \file gprs_bssgp.c + * GPRS BSSGP protocol implementation as per 3GPP TS 08.18. */ +/* + * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gb/gprs_bssgp_bss.c b/src/gb/gprs_bssgp_bss.c index f41c4a4f..d9f04c5f 100644 --- a/src/gb/gprs_bssgp_bss.c +++ b/src/gb/gprs_bssgp_bss.c @@ -1,6 +1,7 @@ -/* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */ - -/* (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> +/*! \file gprs_bssgp_bss.c + * GPRS BSSGP protocol implementation as per 3GPP TS 08.18. */ +/* + * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gb/gprs_bssgp_util.c b/src/gb/gprs_bssgp_util.c index 88916c17..78a11a36 100644 --- a/src/gb/gprs_bssgp_util.c +++ b/src/gb/gprs_bssgp_util.c @@ -1,6 +1,7 @@ -/* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */ - -/* (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> +/*! \file gprs_bssgp_util.c + * GPRS BSSGP protocol implementation as per 3GPP TS 08.18. */ +/* + * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gb/gprs_bssgp_vty.c b/src/gb/gprs_bssgp_vty.c index f3f354cc..703d130a 100644 --- a/src/gb/gprs_bssgp_vty.c +++ b/src/gb/gprs_bssgp_vty.c @@ -1,6 +1,7 @@ -/* VTY interface for our GPRS BSS Gateway Protocol (BSSGP) implementation */ - -/* (C) 2010 by Harald Welte <laforge@gnumonks.org> +/*! \file gprs_bssgp_vty.c + * VTY interface for our GPRS BSS Gateway Protocol (BSSGP) implementation. */ +/* + * (C) 2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gb/gprs_ns.c b/src/gb/gprs_ns.c index 51d1c3c0..d20ed232 100644 --- a/src/gb/gprs_ns.c +++ b/src/gb/gprs_ns.c @@ -1,7 +1,8 @@ -/* GPRS Networks Service (NS) messages on the Gb interface - * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05) */ - -/* (C) 2009-2012 by Harald Welte <laforge@gnumonks.org> +/*! \file gprs_ns.c + * GPRS Networks Service (NS) messages on the Gb interface. + * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05). */ +/* + * (C) 2009-2012 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * @@ -22,11 +23,7 @@ /*! \addtogroup libgb * @{ - */ - -/*! \file gprs_ns.c */ - -/*! + * * GPRS Networks Service (NS) messages on the Gb interface * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05) * @@ -36,30 +33,31 @@ * do much, apart from providing congestion notification and status indication. * * Terms: + * * NS Network Service - * NSVC NS Virtual Connection - * NSEI NS Entity Identifier - * NSVL NS Virtual Link - * NSVLI NS Virtual Link Identifier - * BVC BSSGP Virtual Connection - * BVCI BSSGP Virtual Connection Identifier - * NSVCG NS Virtual Connection Goup - * Blocked NS-VC cannot be used for user traffic - * Alive Ability of a NS-VC to provide communication + * NSVC NS Virtual Connection + * NSEI NS Entity Identifier + * NSVL NS Virtual Link + * NSVLI NS Virtual Link Identifier + * BVC BSSGP Virtual Connection + * BVCI BSSGP Virtual Connection Identifier + * NSVCG NS Virtual Connection Goup + * Blocked NS-VC cannot be used for user traffic + * Alive Ability of a NS-VC to provide communication * - * There can be multiple BSSGP virtual connections over one (group of) NSVC's. BSSGP will + * There can be multiple BSSGP virtual connections over one (group of) NSVC's. BSSGP will * therefore identify the BSSGP virtual connection by a BVCI passed down to NS. * NS then has to firgure out which NSVC's are responsible for this BVCI. * Those mappings are administratively configured. - */ - -/* This implementation has the following limitations: - * o Only one NS-VC for each NSE: No load-sharing function - * o NSVCI 65535 and 65534 are reserved for internal use - * o Only UDP is supported as of now, no frame relay support - * o The IP Sub-Network-Service (SNS) as specified in 48.016 is not implemented - * o There are no BLOCK and UNBLOCK timers (yet?) - */ + * + * This implementation has the following limitations: + * - Only one NS-VC for each NSE: No load-sharing function + * - NSVCI 65535 and 65534 are reserved for internal use + * - Only UDP is supported as of now, no frame relay support + * - The IP Sub-Network-Service (SNS) as specified in 48.016 is not implemented + * - There are no BLOCK and UNBLOCK timers (yet?) + * + * \file gprs_ns.c */ #include <stdlib.h> #include <unistd.h> diff --git a/src/gb/gprs_ns_frgre.c b/src/gb/gprs_ns_frgre.c index 285a9a07..52145ff6 100644 --- a/src/gb/gprs_ns_frgre.c +++ b/src/gb/gprs_ns_frgre.c @@ -1,9 +1,9 @@ -/* GPRS Networks Service (NS) messages on the Gb interface - * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05) */ - -/* NS-over-FR-over-GRE implementation */ - -/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> +/*! \file gprs_ns_frgre.c + * NS-over-FR-over-GRE implementation. + * GPRS Networks Service (NS) messages on the Gb interface, + * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05). */ +/* + * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gb/gprs_ns_vty.c b/src/gb/gprs_ns_vty.c index bdccb3ff..e320ba29 100644 --- a/src/gb/gprs_ns_vty.c +++ b/src/gb/gprs_ns_vty.c @@ -1,6 +1,7 @@ -/* VTY interface for our GPRS Networks Service (NS) implementation */ - -/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> +/*! \file gprs_ns_vty.c + * VTY interface for our GPRS Networks Service (NS) implementation. */ +/* + * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gsm/a5.c b/src/gsm/a5.c index f21554f0..e906b6d9 100644 --- a/src/gsm/a5.c +++ b/src/gsm/a5.c @@ -1,12 +1,11 @@ -/* - * a5.c - * - * Full reimplementation of A5/1,2 (split and threadsafe) +/*! \file a5.c + * Full reimplementation of A5/1,2 (split and threadsafe). * * The logic behind the algorithm is taken from "A pedagogical implementation * of the GSM A5/1 and A5/2 "voice privacy" encryption algorithms." by * Marc Briceno, Ian Goldberg, and David Wagner. - * + */ +/* * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * * All Rights Reserved @@ -29,9 +28,8 @@ /*! \addtogroup crypto * @{ * Osmocom GSM/GPRS ciphering algorithm implementation - */ - -/*! \file gsm/a5.c */ + * + * \file gsm/a5.c */ #include <errno.h> #include <string.h> diff --git a/src/gsm/abis_nm.c b/src/gsm/abis_nm.c index 287973b3..c59ebb7c 100644 --- a/src/gsm/abis_nm.c +++ b/src/gsm/abis_nm.c @@ -1,7 +1,5 @@ -/* GSM Network Management (OML) messages on the A-bis interface - * 3GPP TS 12.21 version 8.0.0 Release 1999 / ETSI TS 100 623 V8.0.0 */ - -/* (C) 2008-2011 by Harald Welte <laforge@gnumonks.org> +/* + * (C) 2008-2011 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * @@ -22,11 +20,10 @@ /*! \addtogroup oml * @{ - * GSM Network Management (OML) messages on the A-bis interface + * GSM Network Management (OML) messages on the A-bis interface. * 3GPP TS 12.21 version 8.0.0 Release 1999 / ETSI TS 100 623 V8.0.0 - */ - -/*! \file abis_nm.c */ + * + * \file abis_nm.c */ #include <stdint.h> #include <errno.h> diff --git a/src/gsm/apn.c b/src/gsm/apn.c index ccf36b99..8d4b2bfc 100644 --- a/src/gsm/apn.c +++ b/src/gsm/apn.c @@ -1,3 +1,5 @@ +/*! \file apn.c */ + #include <stdio.h> #include <stdint.h> #include <stdlib.h> diff --git a/src/gsm/auth_comp128v1.c b/src/gsm/auth_comp128v1.c index 3b645d2a..1dddef31 100644 --- a/src/gsm/auth_comp128v1.c +++ b/src/gsm/auth_comp128v1.c @@ -1,7 +1,7 @@ - -/* GSM/GPRS/3G authentication core infrastructure */ - -/* (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> +/*! \file auth_comp128v1.c + * GSM/GPRS/3G authentication core infrastructure */ +/* + * (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gsm/auth_comp128v23.c b/src/gsm/auth_comp128v23.c index b0900af2..4d23769c 100644 --- a/src/gsm/auth_comp128v23.c +++ b/src/gsm/auth_comp128v23.c @@ -1,9 +1,8 @@ -/* registers COMP128 version 2 and 3 A3/A8 algorithms for the - * GSM/GPRS/3G authentication core infrastructure - * - */ - -/* (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> +/*! \file auth_comp128v23.c + * registers COMP128 version 2 and 3 A3/A8 algorithms for the + * GSM/GPRS/3G authentication core infrastructure. */ +/* + * (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> * (C) 2013 by Kévin Redon <kevredon@mail.tsaitgaist.info> * * All Rights Reserved diff --git a/src/gsm/auth_core.c b/src/gsm/auth_core.c index 1bdd4a84..41566959 100644 --- a/src/gsm/auth_core.c +++ b/src/gsm/auth_core.c @@ -1,5 +1,3 @@ -/* GSM/GPRS/3G authentication core infrastructure */ - /* (C) 2010-2012 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved @@ -33,9 +31,8 @@ /*! \addtogroup auth * @{ * GSM/GPRS/3G authentication core infrastructure - */ - -/* \file auth_core.c */ + * + * \file auth_core.c */ static LLIST_HEAD(osmo_auths); diff --git a/src/gsm/auth_milenage.c b/src/gsm/auth_milenage.c index 41e538d2..8d50990b 100644 --- a/src/gsm/auth_milenage.c +++ b/src/gsm/auth_milenage.c @@ -1,6 +1,7 @@ -/* GSM/GPRS/3G authentication core infrastructure */ - -/* (C) 2011 by Harald Welte <laforge@gnumonks.org> +/*! \file auth_milenage.c + * GSM/GPRS/3G authentication core infrastructure */ +/* + * (C) 2011 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gsm/comp128.c b/src/gsm/comp128.c index 78f0e07c..0fcc67d5 100644 --- a/src/gsm/comp128.c +++ b/src/gsm/comp128.c @@ -1,6 +1,5 @@ -/* - * COMP128 implementation - * +/*! \file comp128.c + * COMP128 v1; common/old GSM Authentication Algorithm (A3/A8). * * This code is inspired by original code from : * Marc Briceno <marc@scard.org>, Ian Goldberg <iang@cs.berkeley.edu>, @@ -11,7 +10,38 @@ * A comment snippet from the original code is included below, it describes * where the doc came from and how the algorithm was reverse engineered. * + * This code derived from a leaked document from the GSM standards. + * Some missing pieces were filled in by reverse-engineering a working SIM. + * We have verified that this is the correct COMP128 algorithm. + * + * The first page of the document identifies it as + * + * _Technical Information: GSM System Security Study_. + * 10-1617-01, 10th June 1988. + * + * The bottom of the title page is marked + * + * Racal Research Ltd. + * Worton Drive, Worton Grange Industrial Estate, + * Reading, Berks. RG2 0SB, England. + * Telephone: Reading (0734) 868601 Telex: 847152 + * + * The relevant bits are in Part I, Section 20 (pages 66--67). Enjoy! * + * Note: There are three typos in the spec (discovered by + * reverse-engineering). + * - First, "z = (2 * x[n] + x[n]) mod 2^(9-j)" should clearly read + * "z = (2 * x[m] + x[n]) mod 2^(9-j)". + * - Second, the "k" loop in the "Form bits from bytes" section is severely + * botched: the k index should run only from 0 to 3, and clearly the range + * on "the (8-k)th bit of byte j" is also off (should be 0..7, not 1..8, + * to be consistent with the subsequent section). + * - Third, SRES is taken from the first 8 nibbles of x[], not the last 8 as + * claimed in the document. (And the document doesn't specify how Kc is + * derived, but that was also easily discovered with reverse engineering.) + * All of these typos have been corrected in the following code. + */ +/* * (C) 2009 by Sylvain Munaut <tnt@246tNt.com> * * All Rights Reserved @@ -32,49 +62,12 @@ * */ -/* - * --- SNIP --- - * - * This code derived from a leaked document from the GSM standards. - * Some missing pieces were filled in by reverse-engineering a working SIM. - * We have verified that this is the correct COMP128 algorithm. - * - * The first page of the document identifies it as - * _Technical Information: GSM System Security Study_. - * 10-1617-01, 10th June 1988. - * The bottom of the title page is marked - * Racal Research Ltd. - * Worton Drive, Worton Grange Industrial Estate, - * Reading, Berks. RG2 0SB, England. - * Telephone: Reading (0734) 868601 Telex: 847152 - * The relevant bits are in Part I, Section 20 (pages 66--67). Enjoy! - * - * Note: There are three typos in the spec (discovered by - * reverse-engineering). - * First, "z = (2 * x[n] + x[n]) mod 2^(9-j)" should clearly read - * "z = (2 * x[m] + x[n]) mod 2^(9-j)". - * Second, the "k" loop in the "Form bits from bytes" section is severely - * botched: the k index should run only from 0 to 3, and clearly the range - * on "the (8-k)th bit of byte j" is also off (should be 0..7, not 1..8, - * to be consistent with the subsequent section). - * Third, SRES is taken from the first 8 nibbles of x[], not the last 8 as - * claimed in the document. (And the document doesn't specify how Kc is - * derived, but that was also easily discovered with reverse engineering.) - * All of these typos have been corrected in the following code. - * - * --- /SNIP --- - */ - #include <string.h> #include <stdint.h> /*! \addtogroup auth * @{ - */ - -/*! \file comp128.c - * COMP128 v1; common/old GSM Authentication Algorithm (A3/A8) - */ + * \file comp128.c */ /* The compression tables (just copied ...) */ static const uint8_t table_0[512] = { diff --git a/src/gsm/comp128v23.c b/src/gsm/comp128v23.c index 1797ebc9..12f8a4c1 100644 --- a/src/gsm/comp128v23.c +++ b/src/gsm/comp128v23.c @@ -1,11 +1,11 @@ -/* COMP128 version 2 and 3 implementation +/*! \file comp128v23.c + * COMP128 version 2 and 3 implementation, common algorithm used for GSM Authentication (A3/A8). * * This code is a C conversion of the original code from * http://www.hackingprojects.net/ - * */ - -/* (C) 2013 by Kévin Redon <kevredon@mail.tsaitgaist.info> +/* + * (C) 2013 by Kévin Redon <kevredon@mail.tsaitgaist.info> * * All Rights Reserved * @@ -30,11 +30,7 @@ /*! \addtogroup auth * @{ - */ - -/*! \file comp128v23.c - * COMP128 v2 / v3; Common Algorithm used for GSM Authentication (A3/A8) - */ + * \file comp128v23.c */ static const uint8_t table0[256] = { 197, 235, 60, 151, 98, 96, 3, 100, 248, 118, 42, 117, 172, 211, 181, 203, 61, diff --git a/src/gsm/gan.c b/src/gsm/gan.c index d357b7e1..fae93f11 100644 --- a/src/gsm/gan.c +++ b/src/gsm/gan.c @@ -1,4 +1,7 @@ -/* (C) 2012 by Harald Welte <laforge@gnumonks.org> +/*! \file gan.c + * Generic Access Network (GAN) / UMA according to TS 44.318. */ +/* + * (C) 2012 by Harald Welte <laforge@gnumonks.org> * All Rights Reserved * * This program is free software; you can redistribute it and/or modify @@ -21,11 +24,6 @@ #include <osmocom/gsm/protocol/gsm_44_318.h> -/*! \file gan.c - * Generic Access Network (GAN) / UMA according to TS 44.318 - */ - - const struct value_string gan_msgt_vals[] = { { GA_MT_RC_DISCOVERY_REQUEST, "GA-RC DISCOVERY REQUEST" }, { GA_MT_RC_DISCOVERY_ACCEPT, "GA-RC DISCOVERY ACCEPT" }, diff --git a/src/gsm/gea.c b/src/gsm/gea.c index d4e599c8..d95c03e8 100644 --- a/src/gsm/gea.c +++ b/src/gsm/gea.c @@ -1,8 +1,6 @@ +/*! \file gea.c + * Implementation of GEA3 and GEA4. */ /* - * gea.c - * - * Implementation of GEA3 and GEA4 - * * Copyright (C) 2016 by Sysmocom s.f.m.c. GmbH * * All Rights Reserved @@ -32,10 +30,7 @@ /*! \addtogroup crypto * @{ - */ - -/*! \file gsm/gea.c */ - + * \file gsm/gea.c */ /*! Performs the GEA4 algorithm as in 3GPP TS 55.226 V9.0.0 * \param[in,out] out Buffer for gamma for encrypted/decrypted diff --git a/src/gsm/gprs_cipher_core.c b/src/gsm/gprs_cipher_core.c index b833048d..fc68c402 100644 --- a/src/gsm/gprs_cipher_core.c +++ b/src/gsm/gprs_cipher_core.c @@ -1,6 +1,7 @@ -/* GPRS LLC cipher core infrastructure */ - -/* (C) 2010 by Harald Welte <laforge@gnumonks.org> +/*! \file gprs_cipher_core.c + * GPRS LLC cipher core infrastructure */ +/* + * (C) 2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gsm/gprs_gea.c b/src/gsm/gprs_gea.c index 836ee68c..db3f2cc7 100644 --- a/src/gsm/gprs_gea.c +++ b/src/gsm/gprs_gea.c @@ -1,8 +1,6 @@ +/*! \file gprs_gea.c + * GEA 3 & 4 plugin */ /* - * gprs_gea.c - * - * GEA 3 & 4 plugin - * * Copyright (C) 2016 by Sysmocom s.f.m.c. GmbH * * All Rights Reserved diff --git a/src/gsm/gprs_rlc.c b/src/gsm/gprs_rlc.c index 4b329473..b213b269 100644 --- a/src/gsm/gprs_rlc.c +++ b/src/gsm/gprs_rlc.c @@ -1,3 +1,7 @@ +/*! \file gsm/gprs_rlc.c + * helper functions for (E)GPRS RLC according to 3GPP TS 44.060. + */ + #include <errno.h> #include <string.h> @@ -5,10 +9,6 @@ #include <osmocom/coding/gsm0503_coding.h> #include <osmocom/gprs/protocol/gsm_04_60.h> -/*! \file gsm/gprs_rlc.c - * helper functions for (E)GPRS RLC according to 3GPP TS 44.060 - */ - #define EGPRS_CPS_TYPE1_TBL_SZ 29 #define EGPRS_CPS_TYPE2_TBL_SZ 8 #define EGPRS_CPS_TYPE3_TBL_SZ 16 diff --git a/src/gsm/gsm0341.c b/src/gsm/gsm0341.c index 0e3e453d..05a0b4a8 100644 --- a/src/gsm/gsm0341.c +++ b/src/gsm/gsm0341.c @@ -1,3 +1,4 @@ +/*! \file gsm0341.c */ /* * (C) 2014 by Harald Welte <laforge@gnumonks.org> * All Rights Reserved diff --git a/src/gsm/gsm0411_smc.c b/src/gsm/gsm0411_smc.c index dab83ebd..7414e95a 100644 --- a/src/gsm/gsm0411_smc.c +++ b/src/gsm/gsm0411_smc.c @@ -1,8 +1,9 @@ -/* Point-to-Point (PP) Short Message Service (SMS) +/*! \file gsm0411_smc.c + * Point-to-Point (PP) Short Message Service (SMS). * Support on Mobile Radio Interface - * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0 */ - -/* (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> + * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0. */ +/* + * (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> * (C) 2009 by Harald Welte <laforge@gnumonks.org> * (C) 2010 by Holger Hans Peter Freyther <zecke@selfish.org> * (C) 2010 by On-Waves diff --git a/src/gsm/gsm0411_smr.c b/src/gsm/gsm0411_smr.c index d120f2df..67bb2494 100644 --- a/src/gsm/gsm0411_smr.c +++ b/src/gsm/gsm0411_smr.c @@ -1,8 +1,9 @@ -/* Point-to-Point (PP) Short Message Service (SMS) +/*! \file gsm0411_smr.c + * Point-to-Point (PP) Short Message Service (SMS). * Support on Mobile Radio Interface * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0 */ - -/* (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> +/* + * (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> * (C) 2009 by Harald Welte <laforge@gnumonks.org> * (C) 2010 by Holger Hans Peter Freyther <zecke@selfish.org> * (C) 2010 by On-Waves diff --git a/src/gsm/gsm0411_utils.c b/src/gsm/gsm0411_utils.c index ef679304..7c7164c9 100644 --- a/src/gsm/gsm0411_utils.c +++ b/src/gsm/gsm0411_utils.c @@ -1,8 +1,9 @@ -/* Point-to-Point (PP) Short Message Service (SMS) +/*! \file gsm0411_utils.c + * Point-to-Point (PP) Short Message Service (SMS). * Support on Mobile Radio Interface - * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0 */ - -/* (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> + * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0. */ +/* + * (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> * (C) 2009 by Harald Welte <laforge@gnumonks.org> * (C) 2010-2013 by Holger Hans Peter Freyther <zecke@selfish.org> * (C) 2010 by On-Waves diff --git a/src/gsm/gsm0414.c b/src/gsm/gsm0414.c index 84d393df..616d7d96 100644 --- a/src/gsm/gsm0414.c +++ b/src/gsm/gsm0414.c @@ -1,3 +1,5 @@ +/*! \file gsm0414.c */ + #include <osmocom/gsm/protocol/gsm_04_14.h> #include <osmocom/core/utils.h> diff --git a/src/gsm/gsm0480.c b/src/gsm/gsm0480.c index 3c23f6fc..557aa148 100644 --- a/src/gsm/gsm0480.c +++ b/src/gsm/gsm0480.c @@ -1,5 +1,5 @@ -/* Format functions for GSM 04.80 */ - +/*! \file gsm0480.c + * Format functions for GSM 04.80. */ /* * (C) 2010 by Holger Hans Peter Freyther <zecke@selfish.org> * (C) 2009 by Mike Haben <michael.haben@btinternet.com> diff --git a/src/gsm/gsm0502.c b/src/gsm/gsm0502.c index df1d8e9e..6b698938 100644 --- a/src/gsm/gsm0502.c +++ b/src/gsm/gsm0502.c @@ -1,6 +1,7 @@ -/* Paging helper code */ - -/* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> +/*! \file gsm0502.c + * Paging helper code */ +/* + * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> * All Rights Reserved * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/gsm0808.c b/src/gsm/gsm0808.c index f595dd65..a8a5e45a 100644 --- a/src/gsm/gsm0808.c +++ b/src/gsm/gsm0808.c @@ -1,4 +1,6 @@ -/* (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org> +/*! \file gsm0808.c */ +/* + * (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org> * (C) 2009,2010 by On-Waves * All Rights Reserved * diff --git a/src/gsm/gsm0808_utils.c b/src/gsm/gsm0808_utils.c index 34e10bbc..e2cd91b4 100644 --- a/src/gsm/gsm0808_utils.c +++ b/src/gsm/gsm0808_utils.c @@ -1,4 +1,6 @@ -/* (C) 2016 by Sysmocom s.f.m.c. GmbH +/*! \file gsm0808_utils.c */ +/* + * (C) 2016 by Sysmocom s.f.m.c. GmbH * All Rights Reserved * * Author: Philipp Maier diff --git a/src/gsm/gsm48.c b/src/gsm/gsm48.c index 227dbef8..f69eee20 100644 --- a/src/gsm/gsm48.c +++ b/src/gsm/gsm48.c @@ -1,7 +1,8 @@ -/* GSM Mobile Radio Interface Layer 3 messages +/*! \file gsm48.c + * GSM Mobile Radio Interface Layer 3 messages * 3GPP TS 04.08 version 7.21.0 Release 1998 / ETSI TS 100 940 V7.21.0 */ - -/* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> +/* + * (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> * (C) 2008, 2009 by Holger Hans Peter Freyther <zecke@selfish.org> * * All Rights Reserved diff --git a/src/gsm/gsm48_ie.c b/src/gsm/gsm48_ie.c index d3a868d1..105acbaf 100644 --- a/src/gsm/gsm48_ie.c +++ b/src/gsm/gsm48_ie.c @@ -1,7 +1,8 @@ -/* GSM Mobile Radio Interface Layer 3 messages - * 3GPP TS 04.08 version 7.21.0 Release 1998 / ETSI TS 100 940 V7.21.0 */ - -/* (C) 2008 by Harald Welte <laforge@gnumonks.org> +/*! \file gsm48_ie.c + * GSM Mobile Radio Interface Layer 3 messages. + * 3GPP TS 04.08 version 7.21.0 Release 1998 / ETSI TS 100 940 V7.21.0. */ +/* + * (C) 2008 by Harald Welte <laforge@gnumonks.org> * (C) 2009-2010 by Andreas Eversberg * * All Rights Reserved diff --git a/src/gsm/gsm_04_08_gprs.c b/src/gsm/gsm_04_08_gprs.c index 7bcef4ec..43da27ee 100644 --- a/src/gsm/gsm_04_08_gprs.c +++ b/src/gsm/gsm_04_08_gprs.c @@ -1,4 +1,6 @@ -/* (C) 2009-2016 by Harald Welte <laforge@gnumonks.org> +/*! \file gsm_04_08_gprs.c */ +/* + * (C) 2009-2016 by Harald Welte <laforge@gnumonks.org> * (C) 2010 by On-Waves * (C) 2014-2015 by Sysmocom s.f.m.c. GmbH * diff --git a/src/gsm/gsm_utils.c b/src/gsm/gsm_utils.c index fd16e980..5a4ceb36 100644 --- a/src/gsm/gsm_utils.c +++ b/src/gsm/gsm_utils.c @@ -1,3 +1,4 @@ +/*! \file gsm_utils.c */ /* * (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> * (C) 2009,2013 by Holger Hans Peter Freyther <zecke@selfish.org> diff --git a/src/gsm/gsup.c b/src/gsm/gsup.c index 780198c3..2629eb75 100644 --- a/src/gsm/gsup.c +++ b/src/gsm/gsup.c @@ -1,5 +1,5 @@ -/* Osmocom Generic Subscriber Update Protocol message encoder/decoder */ - +/*! \file gsup.c + * Osmocom Generic Subscriber Update Protocol message encoder/decoder. */ /* * (C) 2014 by sysmocom s.f.m.c. GmbH * (C) 2015 by Holger Hans Peter Freyther diff --git a/src/gsm/ipa.c b/src/gsm/ipa.c index 2c7cf582..bc848504 100644 --- a/src/gsm/ipa.c +++ b/src/gsm/ipa.c @@ -1,6 +1,7 @@ -/* OpenBSC Abis input driver for ip.access */ - -/* (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> +/*! \file ipa.c + * OpenBSC Abis input driver for ip.access */ +/* + * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> * (C) 2010 by Holger Hans Peter Freyther * (C) 2010 by On-Waves * diff --git a/src/gsm/kasumi.c b/src/gsm/kasumi.c index d5d78a74..c3a028b7 100644 --- a/src/gsm/kasumi.c +++ b/src/gsm/kasumi.c @@ -1,6 +1,7 @@ -/* Kasumi cipher and KGcore functions */ - -/* (C) 2013 by Max <Max.Suraev@fairwaves.ru> +/*! \file kasumi.c + * Kasumi cipher and KGcore functions. */ +/* + * (C) 2013 by Max <Max.Suraev@fairwaves.ru> * * All Rights Reserved * diff --git a/src/gsm/lapd_core.c b/src/gsm/lapd_core.c index 4ad75568..166bf9a7 100644 --- a/src/gsm/lapd_core.c +++ b/src/gsm/lapd_core.c @@ -1,6 +1,7 @@ -/* LAPD core implementation */ - -/* (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> +/*! \file lapd_core.c + * LAPD core implementation */ +/* + * (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> * (C) 2010-2011 by Andreas Eversberg <jolly@eversberg.eu> * * All Rights Reserved @@ -23,12 +24,9 @@ /*! \addtogroup lapd * @{ - * Osmocom LAPD core, used for Q.921, LAPDm and others - */ - -/*! \file lapd_core.c */ - -/*! + * + * Osmocom LAPD core, used for Q.921, LAPDm and others. + * * Notes on Buffering: rcv_buffer, tx_queue, tx_hist, send_buffer, send_queue * * RX data is stored in the rcv_buffer (pointer). If the message is complete, it @@ -62,6 +60,7 @@ * will not trigger T200. It will be stoped, when T200 is started in MF EST * state. It will also be stoped when leaving MF EST state. * + * \file lapd_core.c */ /* Enable this to test content resolution on network side: diff --git a/src/gsm/lapdm.c b/src/gsm/lapdm.c index 1152e0d4..db950a68 100644 --- a/src/gsm/lapdm.c +++ b/src/gsm/lapdm.c @@ -1,6 +1,7 @@ -/* GSM LAPDm (TS 04.06) implementation */ - -/* (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> +/*! \file lapdm.c + * GSM LAPDm (TS 04.06) implementation. */ +/* + * (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> * (C) 2010-2011 by Andreas Eversberg <jolly@eversberg.eu> * * All Rights Reserved @@ -23,10 +24,7 @@ /*! \addtogroup lapdm * @{ - * GSM LAPDm (TS 04.06) implementation - */ - -/*! \file lapdm.c */ + * \file lapdm.c */ #include <stdio.h> #include <stdint.h> diff --git a/src/gsm/milenage/aes-encblock.c b/src/gsm/milenage/aes-encblock.c index 8f35caa2..c4aa260d 100644 --- a/src/gsm/milenage/aes-encblock.c +++ b/src/gsm/milenage/aes-encblock.c @@ -1,6 +1,6 @@ +/*! \file aes-encblock.c + * AES encrypt_block. */ /* - * AES encrypt_block - * * Copyright (c) 2003-2007, Jouni Malinen <j@w1.fi> * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/milenage/aes-internal-enc.c b/src/gsm/milenage/aes-internal-enc.c index 8726aa72..4c00f963 100644 --- a/src/gsm/milenage/aes-internal-enc.c +++ b/src/gsm/milenage/aes-internal-enc.c @@ -1,5 +1,5 @@ -/* - * AES (Rijndael) cipher - encrypt +/*! \file aes-internal-enc.c + * AES (Rijndael) cipher - encrypt. * * Modifications to public domain implementation: * - support only 128-bit keys @@ -8,7 +8,8 @@ * - added option (AES_SMALL_TABLES) for reducing code size by about 8 kB at * cost of reduced throughput (quite small difference on Pentium 4, * 10-25% when using -O1 or -O2 optimization) - * + */ +/* * Copyright (c) 2003-2005, Jouni Malinen <j@w1.fi> * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/milenage/aes-internal.c b/src/gsm/milenage/aes-internal.c index 41612202..60c520c2 100644 --- a/src/gsm/milenage/aes-internal.c +++ b/src/gsm/milenage/aes-internal.c @@ -1,5 +1,5 @@ -/* - * AES (Rijndael) cipher +/*! \file aes-internal.c + * AES (Rijndael) cipher. * * Modifications to public domain implementation: * - support only 128-bit keys @@ -8,7 +8,8 @@ * - added option (AES_SMALL_TABLES) for reducing code size by about 8 kB at * cost of reduced throughput (quite small difference on Pentium 4, * 10-25% when using -O1 or -O2 optimization) - * + */ +/* * Copyright (c) 2003-2005, Jouni Malinen <j@w1.fi> * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/milenage/aes.h b/src/gsm/milenage/aes.h index 7e97f618..ce42b207 100644 --- a/src/gsm/milenage/aes.h +++ b/src/gsm/milenage/aes.h @@ -1,5 +1,6 @@ +/*! \file aes.h + * AES functions */ /* - * AES functions * Copyright (c) 2003-2006, Jouni Malinen <j@w1.fi> * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/milenage/aes_i.h b/src/gsm/milenage/aes_i.h index 5d89abce..6df019a1 100644 --- a/src/gsm/milenage/aes_i.h +++ b/src/gsm/milenage/aes_i.h @@ -1,5 +1,6 @@ +/*! \file aes_i.h + * AES (Rijndael) cipher. */ /* - * AES (Rijndael) cipher * Copyright (c) 2003-2005, Jouni Malinen <j@w1.fi> * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/milenage/aes_wrap.h b/src/gsm/milenage/aes_wrap.h index afa1451e..7d4d5d90 100644 --- a/src/gsm/milenage/aes_wrap.h +++ b/src/gsm/milenage/aes_wrap.h @@ -1,12 +1,13 @@ -/* - * AES-based functions +/*! \file aes_wrap.h + * AES-based functions. * * - AES Key Wrap Algorithm (128-bit KEK) (RFC3394) * - One-Key CBC MAC (OMAC1) hash with AES-128 * - AES-128 CTR mode encryption * - AES-128 EAX mode encryption/decryption * - AES-128 CBC - * + */ +/* * Copyright (c) 2003-2007, Jouni Malinen <j@w1.fi> * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/milenage/common.h b/src/gsm/milenage/common.h index aaf82b97..2aa50fb3 100644 --- a/src/gsm/milenage/common.h +++ b/src/gsm/milenage/common.h @@ -1,3 +1,4 @@ +/*! \file common.h */ #include <stdint.h> #include <stdlib.h> diff --git a/src/gsm/milenage/milenage.c b/src/gsm/milenage/milenage.c index b43f986a..012b3996 100644 --- a/src/gsm/milenage/milenage.c +++ b/src/gsm/milenage/milenage.c @@ -1,5 +1,6 @@ +/*! \file milenage.c + * 3GPP AKA - Milenage algorithm (3GPP TS 35.205, .206, .207, .208) */ /* - * 3GPP AKA - Milenage algorithm (3GPP TS 35.205, .206, .207, .208) * Copyright (c) 2006-2007 <j@w1.fi> * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/milenage/milenage.h b/src/gsm/milenage/milenage.h index 6fb779c6..1a4364db 100644 --- a/src/gsm/milenage/milenage.h +++ b/src/gsm/milenage/milenage.h @@ -1,5 +1,7 @@ +/*! \file milenage.h + * UMTS AKA - Milenage algorithm (3GPP TS 35.205, .206, .207, .208). + */ /* - * UMTS AKA - Milenage algorithm (3GPP TS 35.205, .206, .207, .208) * Copyright (c) 2006-2007 <j@w1.fi> * * This program is free software; you can redistribute it and/or modify diff --git a/src/gsm/oap.c b/src/gsm/oap.c index 88c98f75..b07eafcf 100644 --- a/src/gsm/oap.c +++ b/src/gsm/oap.c @@ -1,6 +1,7 @@ -/* Osmocom Authentication Protocol message encoder/decoder */ - -/* (C) 2015-2016 by sysmocom s.f.m.c. GmbH +/*! \file oap.c + * Osmocom Authentication Protocol message encoder/decoder */ +/* + * (C) 2015-2016 by sysmocom s.f.m.c. GmbH * All Rights Reserved * * Author: Neels Hofmeyr diff --git a/src/gsm/rsl.c b/src/gsm/rsl.c index 4a1f733c..e33ea102 100644 --- a/src/gsm/rsl.c +++ b/src/gsm/rsl.c @@ -1,7 +1,5 @@ -/* GSM Radio Signalling Link messages on the A-bis interface - * 3GPP TS 08.58 version 8.6.0 Release 1999 / ETSI TS 100 596 V8.6.0 */ - -/* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> +/* + * (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * @@ -30,10 +28,10 @@ /*! \addtogroup rsl * @{ - * GSM Radio Signalling Link (TS 08.58) - */ - -/*! \file rsl.c */ + * GSM Radio Signalling Link messages on the A-bis interface. + * 3GPP TS 08.58 version 8.6.0 Release 1999 / ETSI TS 100 596 V8.6.0. + * + * \file rsl.c */ /*! Size for RSL \ref msgb_alloc */ #define RSL_ALLOC_SIZE 200 diff --git a/src/gsm/rxlev_stat.c b/src/gsm/rxlev_stat.c index d226861e..2ff0ac84 100644 --- a/src/gsm/rxlev_stat.c +++ b/src/gsm/rxlev_stat.c @@ -1,6 +1,7 @@ -/* Rx Level statistics */ - -/* (C) 2010 by Harald Welte <laforge@gnumonks.org> +/*! \file rxlev_stat.c + * Rx Level statistics */ +/* + * (C) 2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gsm/sysinfo.c b/src/gsm/sysinfo.c index 201acfc8..b73bb0c8 100644 --- a/src/gsm/sysinfo.c +++ b/src/gsm/sysinfo.c @@ -1,7 +1,8 @@ -/* GSM 04.08 System Information (SI) encoding and decoding +/*! \file sysinfo.c + * GSM 04.08 System Information (SI) encoding and decoding. * 3GPP TS 04.08 version 7.21.0 Release 1998 / ETSI TS 100 940 V7.21.0 */ - -/* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> +/* + * (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/gsm/tlv_parser.c b/src/gsm/tlv_parser.c index d9072c9d..b1b10340 100644 --- a/src/gsm/tlv_parser.c +++ b/src/gsm/tlv_parser.c @@ -39,9 +39,8 @@ * particular type. Types are e.g. TV (Tag + single byte value), Tag + * fixed-length value, TLV with 8bit length, TLV with 16bit length, TLV * with variable-length length field, etc. - */ - -/*! \file tlv_parser.c */ + * + * \file tlv_parser.c */ struct tlv_definition tvlv_att_def; struct tlv_definition vtvlv_gan_att_def; diff --git a/src/gsmtap_util.c b/src/gsmtap_util.c index 62bbd575..561cdb30 100644 --- a/src/gsmtap_util.c +++ b/src/gsmtap_util.c @@ -1,4 +1,5 @@ -/* GSMTAP support code in libmsomcore */ +/*! \file gsmtap_util.c + * GSMTAP support code in libosmocore. */ /* * (C) 2010-2011 by Harald Welte <laforge@gnumonks.org> * @@ -43,9 +44,9 @@ /*! \addtogroup gsmtap * @{ - * GSMTAP utility routines. Encapsulates GSM messages over UDP - */ -/*! \file gsmtap_util.c */ + * GSMTAP utility routines. Encapsulates GSM messages over UDP. + * + * \file gsmtap_util.c */ /*! convert RSL channel number to GSMTAP channel type diff --git a/src/logging.c b/src/logging.c index 964128bd..c8b86b1c 100644 --- a/src/logging.c +++ b/src/logging.c @@ -1,6 +1,7 @@ -/* Debugging/Logging support code */ - -/* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> +/*! \file logging.c + * Debugging/Logging support code. */ +/* + * (C) 2008-2010 by Harald Welte <laforge@gnumonks.org> * (C) 2008 by Holger Hans Peter Freyther <zecke@selfish.org> * All Rights Reserved * @@ -23,9 +24,8 @@ /* \addtogroup logging * @{ * libosmocore Logging sub-system - */ - -/* \file logging.c */ + * + * \file logging.c */ #include "../config.h" diff --git a/src/logging_gsmtap.c b/src/logging_gsmtap.c index 9e5884b3..d0aa47b6 100644 --- a/src/logging_gsmtap.c +++ b/src/logging_gsmtap.c @@ -1,6 +1,12 @@ -/* GSMTAP network logging support code */ - -/* (C) 2016 by Harald Welte <laforge@gnumonks.org> +/*! \file logging_gsmtap.c + * libosmocore log output encapsulated in GSMTAP. + * + * Encapsulating the log output inside GSMTAP frames allows us to + * observer protocol traces (of Um, Abis, A or any other interface in + * the Osmocom world) with synchronous interspersed log messages. + */ +/* + * (C) 2016 by Harald Welte <laforge@gnumonks.org> * All Rights Reserved * * This program is free software; you can redistribute it and/or modify @@ -21,15 +27,7 @@ /*! \addtogroup logging * @{ - */ - -/*! \file logging_gsmtap.c - * libosmocore log output encapsulated in GSMTAP - * - * Encapsulating the log output inside GSMTAP frames allows us to - * observer protocol traces (of Um, Abis, A or any other interface in - * the Osmocom world) with synchronous interspersed log messages. - */ + * \file logging_gsmtap.c */ #include "../config.h" diff --git a/src/logging_syslog.c b/src/logging_syslog.c index a80a31e2..d0d6a969 100644 --- a/src/logging_syslog.c +++ b/src/logging_syslog.c @@ -1,6 +1,7 @@ -/* Syslog logging support code */ - -/* (C) 2011 by Harald Welte <laforge@gnumonks.org> +/*! \file logging_syslog.c + * Syslog logging support code. */ +/* + * (C) 2011 by Harald Welte <laforge@gnumonks.org> * All Rights Reserved * * This program is free software; you can redistribute it and/or modify @@ -21,11 +22,7 @@ /*! \addtogroup logging * @{ - */ - -/*! \file logging_syslog.c - * libosmocore logging output via syslog - */ + * \file logging_syslog.c */ #include "../config.h" diff --git a/src/loggingrb.c b/src/loggingrb.c index 64033fc3..5127a2f2 100644 --- a/src/loggingrb.c +++ b/src/loggingrb.c @@ -1,6 +1,7 @@ -/* Ringbuffer-backed logging support code */ - -/* (C) 2012-2013 by Katerina Barone-Adesi +/*! \file loggingrb.c + * Ringbuffer-backed logging support code. */ +/* + * (C) 2012-2013 by Katerina Barone-Adesi * All Rights Reserved * * This program is free software; you can redistribute it and/or modify @@ -21,11 +22,7 @@ /*! \addtogroup logging * @{ - */ - -/*! \file loggingrb.c - * libosmocore logging backend for a ring-buffer of last log messages - */ + * \file loggingrb.c */ #include <osmocom/core/strrb.h> #include <osmocom/core/logging.h> diff --git a/src/macaddr.c b/src/macaddr.c index 6a1588d3..5c68d055 100644 --- a/src/macaddr.c +++ b/src/macaddr.c @@ -1,3 +1,5 @@ +/*! \file macaddr.c + * MAC address utility routines. */ /* * (C) 2013-2014 by Harald Welte <laforge@gnumonks.org> * (C) 2014 by Holger Hans Peter Freyther @@ -22,11 +24,7 @@ /*! \addtogroup utils * @{ - */ - -/*! \file macaddr.c - * MAC address utility routines - */ + * \file macaddr.c */ #include "config.h" @@ -20,6 +20,7 @@ /*! \addtogroup msgb * @{ + * * libosmocore message buffers, inspired by Linux kernel skbuff * * Inspired by the 'struct skbuff' of the Linux kernel, we implement a @@ -46,10 +47,10 @@ * * prepending (pushing) and appending (putting) data * * copying / resizing * * hex-dumping to a string for debug purposes + * + * \file msgb.c */ -/*! \file msgb.c */ - #include <unistd.h> #include <string.h> #include <stdlib.h> diff --git a/src/msgfile.c b/src/msgfile.c index bf36bf36..85170994 100644 --- a/src/msgfile.c +++ b/src/msgfile.c @@ -1,6 +1,6 @@ +/*! \file msgfile.c + * Parse a simple file with messages, e.g used for USSD messages. */ /* - * Parse a simple file with messages, e.g used for USSD messages - * * (C) 2010 by Holger Hans Peter Freyther * (C) 2010 by On-Waves * All Rights Reserved diff --git a/src/panic.c b/src/panic.c index 251fdad8..2a8b1ae4 100644 --- a/src/panic.c +++ b/src/panic.c @@ -1,4 +1,5 @@ -/* Panic handling */ +/*! \file panic.c + * Routines for panic handling. */ /* * (C) 2010 by Sylvain Munaut <tnt@246tNt.com> * @@ -22,11 +23,7 @@ /*! \addtogroup utils * @{ - */ - -/*! \file panic.c - * Routines for panic handling - */ + * \file panic.c */ #include <osmocom/core/panic.h> #include <osmocom/core/backtrace.h> diff --git a/src/plugin.c b/src/plugin.c index b6a5a48b..264171c2 100644 --- a/src/plugin.c +++ b/src/plugin.c @@ -1,6 +1,7 @@ -/* plugin infrastructure */ - -/* (C) 2010 by Harald Welte <laforge@gnumonks.org> +/*! \file plugin.c + * Routines for loading and managing shared library plug-ins. */ +/* + * (C) 2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * @@ -22,12 +23,7 @@ /*! \addtogroup utils * @{ - */ - -/*! \file plugin.c - * Routines for loading and managing shared library plug-ins. - */ - + * \file plugin.c */ #include "../config.h" @@ -1,3 +1,5 @@ +/*! \file prim.c */ + #include <osmocom/core/utils.h> #include <osmocom/core/prim.h> diff --git a/src/pseudotalloc/pseudotalloc.c b/src/pseudotalloc/pseudotalloc.c index bc7a4910..b77ffe9e 100644 --- a/src/pseudotalloc/pseudotalloc.c +++ b/src/pseudotalloc/pseudotalloc.c @@ -1,7 +1,7 @@ -/* overly simplistic talloc replacement for deeply embedded +/*! \file pseudotalloc.c + * overly simplistic talloc replacement for deeply embedded * microcontrollers. Obviously this has none of the properties of real - * talloc, it is particualrly not hierarchical at all */ - + * talloc, it is particualrly not hierarchical at all. */ #include "talloc.h" #include <string.h> diff --git a/src/pseudotalloc/talloc.h b/src/pseudotalloc/talloc.h index f4c0a74f..3ce9f37a 100644 --- a/src/pseudotalloc/talloc.h +++ b/src/pseudotalloc/talloc.h @@ -1,8 +1,9 @@ -#pragma once - -/* overly simplistic talloc replacement for deeply embedded +/*! \file talloc.h + * overly simplistic talloc replacement for deeply embedded * microcontrollers. Obviously this has none of the properties of real - * talloc, it is particualrly not hierarchical at all */ + * talloc, it is particualrly not hierarchical at all. */ + +#pragma once #include <stdlib.h> #include <stdarg.h> diff --git a/src/rate_ctr.c b/src/rate_ctr.c index 068d491d..2985bbb0 100644 --- a/src/rate_ctr.c +++ b/src/rate_ctr.c @@ -1,5 +1,3 @@ -/* utility routines for keeping conters about events and the event rates */ - /* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved @@ -22,11 +20,9 @@ /*! \addtogroup rate_ctr * @{ - * conters about events and their event rates - */ - -/*! \file rate_ctr.c */ - + * Counters about events and their event rates. + * + * \file rate_ctr.c */ #include <stdint.h> #include <string.h> diff --git a/src/select.c b/src/select.c index 575fd777..f7ee424c 100644 --- a/src/select.c +++ b/src/select.c @@ -1,7 +1,9 @@ -/* select filedescriptor handling, taken from: +/*! \file select.c + * select filedescriptor handling. + * Taken from: * userspace logging daemon for the iptables ULOG target - * of the linux 2.4 netfilter subsystem. - * + * of the linux 2.4 netfilter subsystem. */ +/* * (C) 2000-2009 by Harald Welte <laforge@gnumonks.org> * * This program is free software; you can redistribute it and/or modify @@ -37,9 +39,8 @@ /*! \addtogroup select * @{ * select() loop abstraction - */ - -/*! \file select.c */ + * + * \file select.c */ static int maxfd = 0; static LLIST_HEAD(osmo_fds); diff --git a/src/sercomm.c b/src/sercomm.c index d02b39e5..07b1aa08 100644 --- a/src/sercomm.c +++ b/src/sercomm.c @@ -1,5 +1,3 @@ -/* Serial communications layer, based on HDLC */ - /* (C) 2010,2017 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved @@ -22,11 +20,9 @@ /*! \addtogroup sercomm * @{ - * Serial communications layer, based on HDLC - */ - -/*! \file sercomm.c - */ + * Serial communications layer, based on HDLC. + * + * \file sercomm.c */ #include "config.h" diff --git a/src/serial.c b/src/serial.c index b8c347bd..dddad886 100644 --- a/src/serial.c +++ b/src/serial.c @@ -1,8 +1,6 @@ +/*! \file serial.c + * Utility functions to deal with serial ports */ /* - * serial.c - * - * Utility functions to deal with serial ports - * * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * * All Rights Reserved @@ -25,9 +23,8 @@ /*! \addtogroup serial * @{ * Osmocom serial port helpers - */ - -/*! \file serial.c */ + * + * \file serial.c */ #include <errno.h> #include <fcntl.h> diff --git a/src/signal.c b/src/signal.c index 301b0214..0c564651 100644 --- a/src/signal.c +++ b/src/signal.c @@ -1,5 +1,7 @@ -/* Generic signalling/notification infrastructure */ -/* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> +/*! \file signal.c + * Generic signalling/notification infrastructure. */ +/* + * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> * All Rights Reserved * * This program is free software; you can redistribute it and/or modify @@ -27,10 +29,9 @@ /*! \addtogroup signal * @{ - * Generic signalling/notification infrastructure - */ - -/*! \file signal.c */ + * Generic signalling/notification infrastructure. + * + * \file signal.c */ void *tall_sigh_ctx; diff --git a/src/sim/card_fs_isim.c b/src/sim/card_fs_isim.c index 339e8627..1073429b 100644 --- a/src/sim/card_fs_isim.c +++ b/src/sim/card_fs_isim.c @@ -1,4 +1,5 @@ -/* 3GPP ISIM specific structures / routines */ +/*! \file card_fs_isim.c + * 3GPP ISIM specific structures / routines. */ /* * (C) 2014 by Harald Welte <laforge@gnumonks.org> * diff --git a/src/sim/card_fs_sim.c b/src/sim/card_fs_sim.c index 432c945b..1411129d 100644 --- a/src/sim/card_fs_sim.c +++ b/src/sim/card_fs_sim.c @@ -1,4 +1,5 @@ -/* classic SIM card specific structures/routines */ +/*! \file card_fs_sim.c + * classic SIM card specific structures/routines. */ /* * (C) 2012-2014 by Harald Welte <laforge@gnumonks.org> * diff --git a/src/sim/card_fs_tetra.c b/src/sim/card_fs_tetra.c index 657e55f7..80f3284e 100644 --- a/src/sim/card_fs_tetra.c +++ b/src/sim/card_fs_tetra.c @@ -1,4 +1,5 @@ -/* TETRA SIM card specific structures/routines */ +/*! \file card_fs_tetra.c + * TETRA SIM card specific structures/routines. */ /* * (C) 2014 by Harald Welte <laforge@gnumonks.org> * diff --git a/src/sim/card_fs_uicc.c b/src/sim/card_fs_uicc.c index 27afe34a..8ff89364 100644 --- a/src/sim/card_fs_uicc.c +++ b/src/sim/card_fs_uicc.c @@ -1,4 +1,5 @@ -/* ETSI UICC specific structures / routines */ +/*! \file card_fs_uicc.c + * ETSI UICC specific structures / routines. */ /* * (C) 2012 by Harald Welte <laforge@gnumonks.org> * diff --git a/src/sim/card_fs_usim.c b/src/sim/card_fs_usim.c index 22c193f8..9e9fc878 100644 --- a/src/sim/card_fs_usim.c +++ b/src/sim/card_fs_usim.c @@ -1,4 +1,5 @@ -/* 3GPP USIM specific structures / routines */ +/*! \file card_fs_usim.c + * 3GPP USIM specific structures / routines. */ /* * (C) 2012-2014 by Harald Welte <laforge@gnumonks.org> * diff --git a/src/sim/class_tables.c b/src/sim/class_tables.c index c3e18d82..fcf67f05 100644 --- a/src/sim/class_tables.c +++ b/src/sim/class_tables.c @@ -1,5 +1,6 @@ -/* simtrace - tables determining APDU case for card emulation - * +/*! \file class_tables.c + * simtrace - tables determining APDU case for card emulation. */ +/* * (C) 2016 by Harald Welte <laforge@gnumonks.org> * * This program is free software; you can redistribute it and/or modify diff --git a/src/sim/core.c b/src/sim/core.c index 15a15636..8da839c0 100644 --- a/src/sim/core.c +++ b/src/sim/core.c @@ -1,4 +1,5 @@ -/* Core routines for SIM/UICC/USIM access */ +/*! \file core.c + * Core routines for SIM/UICC/USIM access. */ /* * (C) 2012 by Harald Welte <laforge@gnumonks.org> * diff --git a/src/sim/gsm_int.h b/src/sim/gsm_int.h index 54a2fbf2..42ccca72 100644 --- a/src/sim/gsm_int.h +++ b/src/sim/gsm_int.h @@ -1,3 +1,5 @@ +/*! \file gsm_int.h */ + #include <sys/types.h> #include <osmocom/sim/sim.h> diff --git a/src/sim/reader.c b/src/sim/reader.c index e7169b5a..f39829b4 100644 --- a/src/sim/reader.c +++ b/src/sim/reader.c @@ -1,4 +1,5 @@ -/* Card reader abstraction for libosmosim */ +/*! \file reader.c + * Card reader abstraction for libosmosim. */ /* * (C) 2012 by Harald Welte <laforge@gnumonks.org> * diff --git a/src/sim/reader_pcsc.c b/src/sim/reader_pcsc.c index f020142e..5b296387 100644 --- a/src/sim/reader_pcsc.c +++ b/src/sim/reader_pcsc.c @@ -1,4 +1,5 @@ -/* PC/SC Card reader backend for libosmosim */ +/*! \file reader_pcsc.c + * PC/SC Card reader backend for libosmosim. */ /* * (C) 2012 by Harald Welte <laforge@gnumonks.org> * diff --git a/src/sim/sim_int.h b/src/sim/sim_int.h index 7b07b834..885011ed 100644 --- a/src/sim/sim_int.h +++ b/src/sim/sim_int.h @@ -1,3 +1,5 @@ +/*! \file sim_int.h */ + #ifndef _SIM_INT_H #include <osmocom/sim/sim.h> diff --git a/src/socket.c b/src/socket.c index f0339120..b74edd43 100644 --- a/src/socket.c +++ b/src/socket.c @@ -23,10 +23,9 @@ /*! \addtogroup socket * @{ - * Osmocom socket convenience functions - */ - -/*! \file socket.c */ + * Osmocom socket convenience functions. + * + * \file socket.c */ #ifdef HAVE_SYS_SOCKET_H diff --git a/src/stat_item.c b/src/stat_item.c index 3b67ba03..c073a3e2 100644 --- a/src/stat_item.c +++ b/src/stat_item.c @@ -1,6 +1,7 @@ -/* utility routines for keeping conters about events and the event rates */ - -/* (C) 2015 by Sysmocom s.f.m.c. GmbH +/*! \file stat_item.c + * utility routines for keeping conters about events and the event rates. */ +/* + * (C) 2015 by Sysmocom s.f.m.c. GmbH * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved @@ -23,10 +24,7 @@ /*! \addtogroup osmo_stat_item * @{ - */ - -/*! \file stat_item.c */ - + * \file stat_item.c */ #include <stdint.h> #include <string.h> diff --git a/src/statistics.c b/src/statistics.c index ad069cea..fc808f58 100644 --- a/src/statistics.c +++ b/src/statistics.c @@ -1,6 +1,7 @@ -/* utility routines for keeping some statistics */ - -/* (C) 2009 by Harald Welte <laforge@gnumonks.org> +/*! \file statistics.c + * utility routines for keeping some statistics. */ +/* + * (C) 2009 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * diff --git a/src/stats.c b/src/stats.c index a5232595..b39ec53c 100644 --- a/src/stats.c +++ b/src/stats.c @@ -1,3 +1,4 @@ +/*! \file stats.c */ /* * (C) 2015 by Sysmocom s.f.m.c. GmbH * diff --git a/src/stats_statsd.c b/src/stats_statsd.c index 342bb88e..6e7be735 100644 --- a/src/stats_statsd.c +++ b/src/stats_statsd.c @@ -1,3 +1,4 @@ +/*! \file stats_statsd.c */ /* * (C) 2015 by Sysmocom s.f.m.c. GmbH * diff --git a/src/strrb.c b/src/strrb.c index 0c56be24..6bfb179f 100644 --- a/src/strrb.c +++ b/src/strrb.c @@ -1,7 +1,21 @@ -/* Ringbuffer implementation, tailored for logging. +/*! \file strrb.c + * Ringbuffer implementation, tailored for logging. * This is a lossy ringbuffer. It keeps up to N of the newest messages, * overwriting the oldest as newer ones come in. * + * Ringbuffer assumptions, invarients, and notes: + * - start is the index of the first used index slot in the ring buffer. + * - end is the index of the next index slot in the ring buffer. + * - start == end => buffer is empty + * - Consequence: the buffer can hold at most size - 1 messages + * (if this were not the case, full and empty buffers would be indistinguishable + * given the conventions in this implementation). + * - Whenever the ringbuffer is full, start is advanced. The second oldest + * message becomes unreachable by valid indexes (end is not a valid index) + * and the oldest message is overwritten (if there was a message there, which + * is the case unless this is the first time the ringbuffer becomes full). + */ +/* * (C) 2012-2013, Katerina Barone-Adesi <kat.obsc@gmail.com> * All Rights Reserved * @@ -23,11 +37,7 @@ /*! \addtogroup utils * @{ - */ - -/*! \file strrb.c - * Lossy string ringbuffer for logging; keeps newest messages. - */ + * \file strrb.c */ #include <stdio.h> #include <string.h> @@ -36,19 +46,6 @@ #include <osmocom/core/strrb.h> #include <osmocom/core/talloc.h> -/* Ringbuffer assumptions, invarients, and notes: - * - start is the index of the first used index slot in the ring buffer. - * - end is the index of the next index slot in the ring buffer. - * - start == end => buffer is empty - * - Consequence: the buffer can hold at most size - 1 messages - * (if this were not the case, full and empty buffers would be indistinguishable - * given the conventions in this implementation). - * - Whenever the ringbuffer is full, start is advanced. The second oldest - * message becomes unreachable by valid indexes (end is not a valid index) - * and the oldest message is overwritten (if there was a message there, which - * is the case unless this is the first time the ringbuffer becomes full). -*/ - /*! Create an empty, initialized osmo_strrb. * \param[in] ctx The talloc memory context which should own this. * \param[in] rb_size The number of message slots the osmo_strrb can hold. @@ -57,7 +54,6 @@ * This function creates and initializes a ringbuffer. * Note that the ringbuffer stores at most rb_size - 1 messages. */ - struct osmo_strrb *osmo_strrb_create(TALLOC_CTX * ctx, size_t rb_size) { struct osmo_strrb *rb = NULL; diff --git a/src/timer.c b/src/timer.c index e18195a7..bf46c24a 100644 --- a/src/timer.c +++ b/src/timer.c @@ -27,9 +27,8 @@ /*! \addtogroup timer * @{ * Osmocom timer abstraction; modelled after linux kernel timers - */ - -/*! \file timer.c */ + * + * \file timer.c */ #include <assert.h> #include <string.h> diff --git a/src/timer_gettimeofday.c b/src/timer_gettimeofday.c index 3a2ae9a5..1bf714eb 100644 --- a/src/timer_gettimeofday.c +++ b/src/timer_gettimeofday.c @@ -22,10 +22,7 @@ /*! \addtogroup timer * @{ - */ - -/*! \file timer_gettimeofday.c - */ + * \file timer_gettimeofday.c */ #include <stdbool.h> #include <sys/time.h> diff --git a/src/utils.c b/src/utils.c index 2bd4c199..9e3414b2 100644 --- a/src/utils.c +++ b/src/utils.c @@ -34,9 +34,8 @@ /*! \addtogroup utils * @{ * various utility routines - */ - -/*! \file utils.c */ + * + * \file utils.c */ static char namebuf[255]; diff --git a/src/vty/buffer.c b/src/vty/buffer.c index 8862da92..1935aa11 100644 --- a/src/vty/buffer.c +++ b/src/vty/buffer.c @@ -1,5 +1,6 @@ +/*! \file buffer.c + * Buffering of output and input. */ /* - * Buffering of output and input. * Copyright (C) 1998 Kunihiro Ishiguro * * This file is part of GNU Zebra. diff --git a/src/vty/command.c b/src/vty/command.c index a0824d39..33862c0d 100644 --- a/src/vty/command.c +++ b/src/vty/command.c @@ -44,8 +44,8 @@ Boston, MA 02110-1301, USA. */ /*! \addtogroup command * @{ * VTY command handling - */ -/*! \file command.c */ + * + * \file command.c */ #define CONFIGFILE_MASK 022 diff --git a/src/vty/fsm_vty.c b/src/vty/fsm_vty.c index acc8ca60..345be667 100644 --- a/src/vty/fsm_vty.c +++ b/src/vty/fsm_vty.c @@ -1,5 +1,7 @@ -/* Osmocom FSM introspection via VTY */ -/* (C) 2016 by Harald Welte <laforge@gnumonks.org> +/*! \file fsm_vty.c + * Osmocom FSM introspection via VTY. */ +/* + * (C) 2016 by Harald Welte <laforge@gnumonks.org> * All Rights Reserved * * This program is free software; you can redistribute it and/or modify diff --git a/src/vty/logging_vty.c b/src/vty/logging_vty.c index 4cb13792..758f0b96 100644 --- a/src/vty/logging_vty.c +++ b/src/vty/logging_vty.c @@ -1,5 +1,7 @@ -/* OpenBSC logging helper for the VTY */ -/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> +/*! \file logging_vty.c + * OpenBSC logging helper for the VTY. */ +/* + * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * (C) 2009-2014 by Holger Hans Peter Freyther * All Rights Reserved * diff --git a/src/vty/stats_vty.c b/src/vty/stats_vty.c index 05578208..57cdd308 100644 --- a/src/vty/stats_vty.c +++ b/src/vty/stats_vty.c @@ -1,5 +1,7 @@ -/* OpenBSC stats helper for the VTY */ -/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> +/*! \file stats_vty.c + * OpenBSC stats helper for the VTY. */ +/* + * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * (C) 2009-2014 by Holger Hans Peter Freyther * (C) 2015 by Sysmocom s.f.m.c. GmbH * All Rights Reserved diff --git a/src/vty/telnet_interface.c b/src/vty/telnet_interface.c index d59516c1..f82a7ff1 100644 --- a/src/vty/telnet_interface.c +++ b/src/vty/telnet_interface.c @@ -1,4 +1,5 @@ -/* minimalistic telnet/network interface it might turn into a wire interface */ +/*! \file telnet_interface.c + * minimalistic telnet/network interface it might turn into a wire interface */ /* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> * All Rights Reserved * @@ -44,8 +45,8 @@ * access. This telnet server gets linked into each libosmovty-using * process in order to enable interactive command-line introspection, * interaction and configuration. - */ -/*! \file telnet_interface.c */ + * + * \file telnet_interface.c */ /* per connection data */ LLIST_HEAD(active_connections); diff --git a/src/vty/utils.c b/src/vty/utils.c index 267d76e8..9d1bdf9e 100644 --- a/src/vty/utils.c +++ b/src/vty/utils.c @@ -1,6 +1,7 @@ -/* utility routines for printing common objects in the Osmocom world */ - -/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> +/*! \file utils.c + * Utility routines for printing common objects in the Osmocom world. */ +/* + * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * * All Rights Reserved * @@ -36,8 +37,6 @@ #include <osmocom/vty/vty.h> -/* \file utils.c */ - /*! \addtogroup rate_ctr * @{ */ diff --git a/src/vty/vector.c b/src/vty/vector.c index c21bca70..ee07cbd2 100644 --- a/src/vty/vector.c +++ b/src/vty/vector.c @@ -1,4 +1,6 @@ -/* Generic vector interface routine +/*! \file vector.c + * Generic vector interface routine. */ +/* * Copyright (C) 1997 Kunihiro Ishiguro * * This file is part of GNU Zebra. diff --git a/src/vty/vty.c b/src/vty/vty.c index 6e60eb75..644d4ed6 100644 --- a/src/vty/vty.c +++ b/src/vty/vty.c @@ -68,8 +68,7 @@ /* \addtogroup vty * @{ - */ -/*! \file vty.c */ + * \file vty.c */ #define SYSCONFDIR "/usr/local/etc" diff --git a/src/write_queue.c b/src/write_queue.c index d9297744..203815bb 100644 --- a/src/write_queue.c +++ b/src/write_queue.c @@ -1,4 +1,3 @@ -/* Generic write queue implementation */ /* * (C) 2010-2016 by Holger Hans Peter Freyther * (C) 2010 by On-Waves @@ -27,10 +26,9 @@ /*! \addtogroup write_queue * @{ - * write queue for writing \ref msgb to sockets/fd's - */ - -/*! \file write_queue.c */ + * Write queue for writing \ref msgb to sockets/fds. + * + * \file write_queue.c */ /*! Select loop function for write queue handling * \param[in] fd osmocom file descriptor |