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
This commit is contained in:
Neels Hofmeyr 2017-06-20 04:35:06 +02:00
parent 33370cb18d
commit 17518fe393
251 changed files with 874 additions and 867 deletions

View File

@ -1,3 +1,5 @@
/*! \file codec.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,3 +1,7 @@
/*! \file gsm0503_coding.h
* GSM TS 05.03 coding
*/
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
@ -5,11 +9,7 @@
/*! \addtogroup coding /*! \addtogroup coding
* @{ * @{
*/ * \file gsm0503_coding.h */
/*! \file gsm0503_coding.h
* GSM TS 05.03 coding
*/
#define GSM0503_GPRS_BURSTS_NBITS (116 * 4) #define GSM0503_GPRS_BURSTS_NBITS (116 * 4)
#define GSM0503_EGPRS_BURSTS_NBITS (348 * 4) #define GSM0503_EGPRS_BURSTS_NBITS (348 * 4)

View File

@ -1,14 +1,14 @@
/*! \file gsm0503_interleaving.h
* GSM TS 05.03 interleaving.
*/
#pragma once #pragma once
#include <osmocom/core/bits.h> #include <osmocom/core/bits.h>
/*! \addtogroup interleaving /*! \addtogroup interleaving
* @{ * @{
*/ * \file gsm0503_interleaving.h */
/*! \file gsm0503_interleaving.h
* GSM TS 05.03 interleaving
*/
void gsm0503_xcch_deinterleave(sbit_t *cB, const sbit_t *iB); void gsm0503_xcch_deinterleave(sbit_t *cB, const sbit_t *iB);
void gsm0503_xcch_interleave(const ubit_t *cB, ubit_t *iB); void gsm0503_xcch_interleave(const ubit_t *cB, ubit_t *iB);

View File

@ -1,14 +1,14 @@
/*! \file gsm0503_mapping.c
* GSM TS 05.03 burst mapping.
*/
#pragma once #pragma once
#include <osmocom/core/bits.h> #include <osmocom/core/bits.h>
/*! \addtogroup mapping /*! \addtogroup mapping
* @{ * @{
*/ * \file gsm0503_mapping.h */
/*! \file gsm0503_mapping.c
* GSM TS 05.03 burst mapping
*/
void gsm0503_xcch_burst_unmap(sbit_t *iB, const sbit_t *eB, void gsm0503_xcch_burst_unmap(sbit_t *iB, const sbit_t *eB,
sbit_t *hl, sbit_t *hn); sbit_t *hl, sbit_t *hn);

View File

@ -1,14 +1,14 @@
/*! \file gsm0503_parity.h
* GSM TS 05.03 parity.
*/
#pragma once #pragma once
#include <osmocom/core/crcgen.h> #include <osmocom/core/crcgen.h>
/*! \addtogroup parity /*! \addtogroup parity
* @{ * @{
*/ * \file gsm0503_parity.h */
/*! \file gsm0503_parity.h
* GSM TS 05.03 parity
*/
const struct osmo_crc64gen_code gsm0503_fire_crc40; const struct osmo_crc64gen_code gsm0503_fire_crc40;
const struct osmo_crc16gen_code gsm0503_cs234_crc16; const struct osmo_crc16gen_code gsm0503_cs234_crc16;

View File

@ -1,3 +1,7 @@
/*! \file gsm0503_tables.h
* GSM TS 05.03 tables.
*/
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
@ -5,11 +9,7 @@
/*! \addtogroup tables /*! \addtogroup tables
* @{ * @{
*/ * \file gsm0503_tables.h */
/*! \file gsm0503_tables.h
* GSM TS 05.03 tables
*/
extern const ubit_t gsm0503_pdtch_hl_hn_ubit[4][8]; extern const ubit_t gsm0503_pdtch_hl_hn_ubit[4][8];
extern const ubit_t gsm0503_pdtch_edge_hl_hn_ubit[3][8]; extern const ubit_t gsm0503_pdtch_edge_hl_hn_ubit[3][8];

View File

@ -1,3 +1,5 @@
/*! \file backtrace.h */
#pragma once #pragma once
void osmo_generate_backtrace(void); void osmo_generate_backtrace(void);

View File

@ -1,8 +1,7 @@
#pragma once /*! \file bitcomp.h
* Osmocom bit compression routines. */
/* bit compression routines */ /*
* (C) 2016 sysmocom s.f.m.c. GmbH by Max Suraev <msuraev@sysmocom.de>
/* (C) 2016 sysmocom s.f.m.c. GmbH by Max Suraev <msuraev@sysmocom.de>
* *
* All Rights Reserved * All Rights Reserved
* *
@ -22,13 +21,11 @@
* *
*/ */
#pragma once
/*! \defgroup bitcomp Bit compression /*! \defgroup bitcomp Bit compression
* @{ * @{
*/ * \file bitcomp.h */
/*! \file bitcomp.h
* Osmocom bit compression routines
*/
#include <stdint.h> #include <stdint.h>
#include <stdbool.h> #include <stdbool.h>

View File

@ -1,3 +1,11 @@
/*! \file bits.h
* 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))
*/
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
@ -9,15 +17,7 @@
/*! \defgroup bits soft, unpacked and packed bits /*! \defgroup bits soft, unpacked and packed bits
* @{ * @{
*/ * \file bits.h */
/*! \file bits.h
* 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; /*!< soft bit (-127...127) */ typedef int8_t sbit_t; /*!< soft bit (-127...127) */
typedef uint8_t ubit_t; /*!< unpacked bit (0 or 1) */ typedef uint8_t ubit_t; /*!< unpacked bit (0 or 1) */

View File

@ -1,7 +1,3 @@
#pragma once
/* bit vector utility routines */
/* (C) 2009 by Harald Welte <laforge@gnumonks.org> /* (C) 2009 by Harald Welte <laforge@gnumonks.org>
* (C) 2012 Ivan Klyuchnikov * (C) 2012 Ivan Klyuchnikov
* (C) 2015 Sysmocom s.f.m.c. GmbH * (C) 2015 Sysmocom s.f.m.c. GmbH
@ -24,21 +20,11 @@
* *
*/ */
#pragma once
/*! \defgroup bitvec Bit vectors /*! \defgroup bitvec Bit vectors
* @{ * @{
*/ * \file bitvec.h */
/*! \file bitvec.h
* 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
* 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).
*/
#include <stdint.h> #include <stdint.h>
#include <osmocom/core/talloc.h> #include <osmocom/core/talloc.h>

View File

@ -1,3 +1,5 @@
/*! \file byteswap.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
#include <osmocom/core/endian.h> #include <osmocom/core/endian.h>

View File

@ -1,6 +1,6 @@
/*! \file conv.h
* Osmocom convolutional encoder and decoder. */
/* /*
* conv.h
*
* Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com>
* *
* All Rights Reserved * All Rights Reserved
@ -22,11 +22,7 @@
/*! \defgroup conv Convolutional encoding and decoding routines /*! \defgroup conv Convolutional encoding and decoding routines
* @{ * @{
*/ * \file conv.h */
/*! \file conv.h
* Osmocom convolutional encoder and decoder
*/
#pragma once #pragma once

View File

@ -1,4 +1,4 @@
/* /*! \file crc16.h
* This was copied from the linux kernel and adjusted for our types. * This was copied from the linux kernel and adjusted for our types.
*/ */
/* /*

View File

@ -1,6 +1,6 @@
/*! \file crcXXgen.h
* Osmocom generic CRC routines (for max XX bits poly) header. */
/* /*
* crcXXgen.h
*
* Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com>
* *
* All Rights Reserved * All Rights Reserved
@ -24,12 +24,7 @@
/*! \addtogroup crcgen /*! \addtogroup crcgen
* @{ * @{
*/ * \file crcXXgen.h.tpl */
/*! \file crcXXgen.h
* Osmocom generic CRC routines (for max XX bits poly) header
*/
#include <stdint.h> #include <stdint.h>
#include <osmocom/core/bits.h> #include <osmocom/core/bits.h>

View File

@ -1,6 +1,6 @@
/*! \file crcgen.h
* Osmocom generic CRC routines global header. */
/* /*
* crcgen.h
*
* Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com>
* *
* All Rights Reserved * All Rights Reserved
@ -24,11 +24,7 @@
/*! \defgroup crcgen Osmocom generic CRC routines /*! \defgroup crcgen Osmocom generic CRC routines
* @{ * @{
*/ * \file crcgen.h */
/*! \file crcgen.h
* Osmocom generic CRC routines global header
*/
#include <osmocom/core/crc8gen.h> #include <osmocom/core/crc8gen.h>
#include <osmocom/core/crc16gen.h> #include <osmocom/core/crc16gen.h>

View File

@ -1,12 +1,12 @@
/*! \file defs.h
* General definitions that are meant to be included from header files.
*/
#pragma once #pragma once
/*! \defgroup utils General-purpose utility functions /*! \defgroup utils General-purpose utility functions
* @{ * @{
*/ * \file defs.h */
/*! \file defs.h
* General definitions that are meant to be included from header files.
*/
/*! Check for gcc and version. /*! Check for gcc and version.
* *

View File

@ -1,6 +1,5 @@
#pragma once /*! \file endian.h
*
/**
* GNU and FreeBSD have various ways to express the * GNU and FreeBSD have various ways to express the
* endianess but none of them is similiar enough. This * endianess but none of them is similiar enough. This
* will create two defines that allows to decide on the * will create two defines that allows to decide on the
@ -12,6 +11,8 @@
* *
*/ */
#pragma once
#if defined(__FreeBSD__) #if defined(__FreeBSD__)
#include <sys/endian.h> #include <sys/endian.h>
#if BYTE_ORDER == LITTLE_ENDIAN #if BYTE_ORDER == LITTLE_ENDIAN

View File

@ -1,3 +1,7 @@
/*! \file fsm.h
* Finite State Machine
*/
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
@ -9,11 +13,7 @@
/*! \defgroup fsm Finite State Machine abstraction /*! \defgroup fsm Finite State Machine abstraction
* @{ * @{
*/ * \file fsm.h */
/*! \file fsm.h
* Finite State Machine
*/
struct osmo_fsm_inst; struct osmo_fsm_inst;

View File

@ -1,8 +1,6 @@
#pragma once /*! \file gsmtap.h
* gsmtap header, pseudo-header in front of the actua GSM payload.
/* gsmtap header, pseudo-header in front of the actua GSM payload */ * GSMTAP is a generic header format for GSM protocol captures,
/* GSMTAP is a generic header format for GSM protocol captures,
* it uses the IANA-assigned UDP port number 4729 and carries * it uses the IANA-assigned UDP port number 4729 and carries
* payload in various formats of GSM interfaces such as Um MAC * payload in various formats of GSM interfaces such as Um MAC
* blocks or Um bursts. * blocks or Um bursts.
@ -11,6 +9,8 @@
* (http://airprobe.org/) or OsmocomBB (http://bb.osmocom.org/) * (http://airprobe.org/) or OsmocomBB (http://bb.osmocom.org/)
*/ */
#pragma once
#include <stdint.h> #include <stdint.h>
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */

View File

@ -6,8 +6,7 @@
/*! \defgroup gsmtap GSMTAP /*! \defgroup gsmtap GSMTAP
* @{ * @{
*/ * \file gsmtap_util.h */
/*! \file gsmtap_util.h */
uint8_t chantype_rsl2gsmtap(uint8_t rsl_chantype, uint8_t rsl_link_id); uint8_t chantype_rsl2gsmtap(uint8_t rsl_chantype, uint8_t rsl_link_id);

View File

@ -1,11 +1,4 @@
#pragma once /*! \file linuxlist.h
/*! \defgroup linuxlist Simple doubly linked list implementation
* @{
*/
/*!
* \file linuxlist.h
* *
* Simple doubly linked list implementation. * Simple doubly linked list implementation.
* *
@ -16,6 +9,12 @@
* using the generic single-entry routines. * using the generic single-entry routines.
*/ */
#pragma once
/*! \defgroup linuxlist Simple doubly linked list implementation
* @{
* \file linuxlist.h */
#include <stddef.h> #include <stddef.h>
#ifndef inline #ifndef inline

View File

@ -2,9 +2,7 @@
/*! \defgroup logging Osmocom logging framework /*! \defgroup logging Osmocom logging framework
* @{ * @{
*/ * \file logging.h */
/*! \file logging.h */
#include <stdio.h> #include <stdio.h>
#include <stdint.h> #include <stdint.h>

View File

@ -1,5 +1,3 @@
#pragma once
/* (C) 2012-2013 by Katerina Barone-Adesi <kat.obsc@gmail.com> /* (C) 2012-2013 by Katerina Barone-Adesi <kat.obsc@gmail.com>
* All Rights Reserved * All Rights Reserved
* *
@ -19,13 +17,11 @@
* *
*/ */
#pragma once
/*! \defgroup loggingrb Osmocom ringbuffer-backed logging /*! \defgroup loggingrb Osmocom ringbuffer-backed logging
* @{ * @{
*/ * \file loggingrb.h */
/*! \file loggingrb.h
*/
struct log_info; struct log_info;

View File

@ -1,3 +1,5 @@
/*! \file macaddr.h */
#pragma once #pragma once
int osmo_macaddr_parse(uint8_t *out, const char *in); int osmo_macaddr_parse(uint8_t *out, const char *in);

View File

@ -27,9 +27,7 @@
/*! \defgroup msgb Message buffers /*! \defgroup msgb Message buffers
* @{ * @{
*/ * \file msgb.h */
/*! \file msgb.h */
#define MSGB_DEBUG #define MSGB_DEBUG

View File

@ -1,3 +1,4 @@
/*! \file msgfile.h */
/* /*
* (C) 2010 by Holger Hans Peter Freyther * (C) 2010 by Holger Hans Peter Freyther
* (C) 2010 by On-Waves * (C) 2010 by On-Waves

View File

@ -2,9 +2,7 @@
/*! \addtogroup utils /*! \addtogroup utils
* @{ * @{
*/ * \file panic.h */
/*! \file panic.h */
#include <stdarg.h> #include <stdarg.h>

View File

@ -1,3 +1,5 @@
/*! \file plugin.h */
#pragma once #pragma once
int osmo_plugin_load_all(const char *directory); int osmo_plugin_load_all(const char *directory);

View File

@ -2,9 +2,7 @@
/*! \defgroup prim Osmocom primitives /*! \defgroup prim Osmocom primitives
* @{ * @{
*/ * \file prim.h */
/*! \file prim.h */
#include <stdint.h> #include <stdint.h>
#include <osmocom/core/msgb.h> #include <osmocom/core/msgb.h>

View File

@ -1,2 +1,3 @@
/*! \file process.h */
#warning "Update from osmocom/core/process.h to osmocom/core/application.h" #warning "Update from osmocom/core/process.h to osmocom/core/application.h"
#include <osmocom/core/application.h> #include <osmocom/core/application.h>

View File

@ -2,9 +2,7 @@
/*! \defgroup rate_ctr Rate counters /*! \defgroup rate_ctr Rate counters
* @{ * @{
*/ * \file rate_ctr.h */
/*! \file rate_ctr.h */
#include <stdint.h> #include <stdint.h>

View File

@ -1,3 +1,7 @@
/*! \file select.h
* select loop abstraction.
*/
#pragma once #pragma once
#include <osmocom/core/linuxlist.h> #include <osmocom/core/linuxlist.h>
@ -5,11 +9,7 @@
/*! \defgroup select Select loop abstraction /*! \defgroup select Select loop abstraction
* @{ * @{
*/ * \file select.h */
/*! \file select.h
* select loop abstraction
*/
/*! Indicate interest in reading from the file descriptor */ /*! Indicate interest in reading from the file descriptor */
#define BSC_FD_READ 0x0001 #define BSC_FD_READ 0x0001

View File

@ -1,3 +1,7 @@
/*! \file sercomm.h
* Osmocom Sercomm HDLC (de)multiplex.
*/
#ifndef _SERCOMM_H #ifndef _SERCOMM_H
#define _SERCOMM_H #define _SERCOMM_H
@ -5,11 +9,7 @@
/*! \defgroup sercomm Seriall Communications (HDLC) /*! \defgroup sercomm Seriall Communications (HDLC)
* @{ * @{
*/ * \file sercomm.h */
/*! \file sercomm.h
* Osmocom Sercomm HDLC (de)multiplex
*/
/*! 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 { enum sercomm_dlci {

View File

@ -1,6 +1,6 @@
/*! \file serial.h
* Osmocom serial port helpers. */
/* /*
* serial.h
*
* Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com>
* *
* All Rights Reserved * All Rights Reserved
@ -22,11 +22,7 @@
/*! \defgroup serial Utility functions to deal with serial ports /*! \defgroup serial Utility functions to deal with serial ports
* @{ * @{
*/ * \file serial.h */
/*! \file serial.h
* Osmocom serial port helpers
*/
#pragma once #pragma once

View File

@ -4,8 +4,7 @@
/*! \defgroup signal Intra-application signals /*! \defgroup signal Intra-application signals
* @{ * @{
*/ * \file signal.h */
/*! \file signal.h */
/*! subsystem signaling numbers: we split the numberspace for /*! subsystem signaling numbers: we split the numberspace for
* applications and libraries: from 0 to UINT_MAX/2 for applications, * applications and libraries: from 0 to UINT_MAX/2 for applications,

View File

@ -1,12 +1,11 @@
/*! \file socket.h
* Osmocom socket convenience functions. */
#pragma once #pragma once
/*! \defgroup socket Socket convenience functions /*! \defgroup socket Socket convenience functions
* @{ * @{
*/ * \file socket.h */
/*! \file socket.h
* Osmocom socket convenience functions
*/
#include <stdint.h> #include <stdint.h>

View File

@ -2,9 +2,7 @@
/*! \defgroup osmo_stat_item Statistics value item /*! \defgroup osmo_stat_item Statistics value item
* @{ * @{
*/ * \file stat_item.h */
/*! \file stat_item.h */
#include <stdint.h> #include <stdint.h>

View File

@ -1,4 +1,6 @@
/* (C) 2015 by Sysmocom s.f.m.c. GmbH /*! \file stats.h */
/*
* (C) 2015 by Sysmocom s.f.m.c. GmbH
* *
* All Rights Reserved * All Rights Reserved
* *

View File

@ -1,6 +1,7 @@
#pragma once /*! \file strrb.h
* Osmocom string ringbuffer handling routines. */
/* (C) 2012-2013 by Katerina Barone-Adesi <kat.obsc@gmail.com> /*
* (C) 2012-2013 by Katerina Barone-Adesi <kat.obsc@gmail.com>
* All Rights Reserved * All Rights Reserved
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -19,13 +20,11 @@
* *
*/ */
#pragma once
/*! \defgroup osmo_strrb Osmocom ringbuffers for log strings /*! \defgroup osmo_strrb Osmocom ringbuffers for log strings
* @{ * @{
*/ * \file strrb.h */
/*! \file strrb.h
* Osmocom string ringbuffer handling routines
*/
#include <unistd.h> #include <unistd.h>
#include <stdbool.h> #include <stdbool.h>

View File

@ -1,4 +1,5 @@
/* Convenience wrapper. libosmocore used to ship its own internal copy of /*! \file talloc.h
* Convenience wrapper. libosmocore used to ship its own internal copy of
* talloc, before libtalloc became a standard component on most systems */ * talloc, before libtalloc became a standard component on most systems */
#pragma once #pragma once
#include <talloc.h> #include <talloc.h>

View File

@ -1,3 +1,5 @@
/*! \file timer.h
* Osmocom timer handling routines. */
/* /*
* (C) 2008, 2009 by Holger Hans Peter Freyther <zecke@selfish.org> * (C) 2008, 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
* All Rights Reserved * All Rights Reserved
@ -33,11 +35,7 @@
* - osmo_timers_update() will call the callbacks and * - osmo_timers_update() will call the callbacks and
* remove the timers. * remove the timers.
* @{ * @{
*/ * \file timer.h */
/*! \file timer.h
* Osmocom timer handling routines.
*/
#pragma once #pragma once

View File

@ -1,3 +1,6 @@
/*! \file timer_compat.h
* Compatibility header with some helpers
*/
/* /*
* (C) 2011 Sylvain Munaut <tnt@246tNt.com> * (C) 2011 Sylvain Munaut <tnt@246tNt.com>
* All Rights Reserved * All Rights Reserved
@ -20,11 +23,7 @@
/*! \defgroup timer Osmocom timers /*! \defgroup timer Osmocom timers
* @{ * @{
*/ * \file timer_compat.h */
/*! \file timer_compat.h
* Compatibility header with some helpers
*/
#pragma once #pragma once

View File

@ -5,9 +5,7 @@
/*! \defgroup utils General-purpose utility functions /*! \defgroup utils General-purpose utility functions
* @{ * @{
*/ * \file utils.h */
/*! \file utils.h */
/*! 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])) #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))

View File

@ -1,4 +1,5 @@
/* Generic write queue implementation */ /*! \file write_queue.h
* Generic write queue implementation */
/* /*
* (C) 2010 by Holger Hans Peter Freyther * (C) 2010 by Holger Hans Peter Freyther
* (C) 2010 by On-Waves * (C) 2010 by On-Waves
@ -24,10 +25,7 @@
/*! \defgroup write_queue Osmocom msgb write queues /*! \defgroup write_queue Osmocom msgb write queues
* @{ * @{
*/ * \file write_queue.h */
/*! \file write_queue.h
*/
#include <osmocom/core/select.h> #include <osmocom/core/select.h>
#include <osmocom/core/msgb.h> #include <osmocom/core/msgb.h>

View File

@ -2,9 +2,7 @@
/*! \addtogroup auth /*! \addtogroup auth
* @{ * @{
*/ * \file auth.h */
/*! \file auth.h */
#include <stdint.h> #include <stdint.h>

View File

@ -1,3 +1,5 @@
/*! \file gprs_cipher.h */
#pragma once #pragma once
#include <osmocom/core/linuxlist.h> #include <osmocom/core/linuxlist.h>

View File

@ -1,3 +1,5 @@
/*! \file control_cmd.h */
#pragma once #pragma once
#include <osmocom/core/msgb.h> #include <osmocom/core/msgb.h>

View File

@ -1,3 +1,5 @@
/*! \file control_if.h */
#pragma once #pragma once
#include <osmocom/core/write_queue.h> #include <osmocom/core/write_queue.h>

View File

@ -1,3 +1,5 @@
/*! \file control_vty.h */
#pragma once #pragma once
/* Add the 'ctrl' section to VTY, containing the 'bind' command. */ /* Add the 'ctrl' section to VTY, containing the 'bind' command. */

View File

@ -1,6 +1,4 @@
#pragma once /*! \file ports.h
/*
* TCP port numbers used for CTRL interfaces in osmocom projects. See also the * TCP port numbers used for CTRL interfaces in osmocom projects. See also the
* osmocom wiki as well as the osmo-gsm-manuals, which should all be kept in * osmocom wiki as well as the osmo-gsm-manuals, which should all be kept in
* sync with this file: * sync with this file:
@ -8,6 +6,8 @@
* https://git.osmocom.org/osmo-gsm-manuals/tree/common/chapters/port_numbers.adoc * https://git.osmocom.org/osmo-gsm-manuals/tree/common/chapters/port_numbers.adoc
*/ */
#pragma once
#define OSMO_CTRL_PORT_BTS 4238 #define OSMO_CTRL_PORT_BTS 4238
#define OSMO_CTRL_PORT_NITB_BSC 4249 #define OSMO_CTRL_PORT_NITB_BSC 4249
#define OSMO_CTRL_PORT_BSC_NAT 4250 #define OSMO_CTRL_PORT_BSC_NAT 4250

View File

@ -1,3 +1,5 @@
/*! \file gprs_bssgp.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,11 +1,7 @@
#pragma once /*! \file gprs_bssgp_bss.h
* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */
#include <osmocom/core/msgb.h> /*
#include <osmocom/gprs/gprs_bssgp.h> * (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
/* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */
/* (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
* *
* All Rights Reserved * All Rights Reserved
* *
@ -24,6 +20,10 @@
* *
*/ */
#pragma once
#include <osmocom/core/msgb.h>
#include <osmocom/gprs/gprs_bssgp.h>
uint8_t *bssgp_msgb_tlli_put(struct msgb *msg, uint32_t tlli); uint8_t *bssgp_msgb_tlli_put(struct msgb *msg, uint32_t tlli);

View File

@ -1,3 +1,5 @@
/*! \file gprs_msgb.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,3 +1,5 @@
/*! \file gprs_ns.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,3 +1,5 @@
/*! \file gprs_ns_frgre.h */
#pragma once #pragma once
int gprs_ns_frgre_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg); int gprs_ns_frgre_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg);

View File

@ -1,3 +1,5 @@
/*! \file gprs_rlc.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,10 +1,11 @@
#pragma once /*! \file gsm_04_60.h
* General Packet Radio Service (GPRS).
/* General Packet Radio Service (GPRS)
* Radio Link Control / Medium Access Control (RLC/MAC) protocol * Radio Link Control / Medium Access Control (RLC/MAC) protocol
* 3GPP TS 04.60 version 8.27.0 Release 1999 * 3GPP TS 04.60 version 8.27.0 Release 1999
*/ */
#pragma once
#include <stdint.h> #include <stdint.h>
#if OSMO_IS_LITTLE_ENDIAN == 1 #if OSMO_IS_LITTLE_ENDIAN == 1

View File

@ -1,16 +1,15 @@
#pragma once /*! \file gsm_08_16.h
* GPRS Networks Service (NS) messages on the Gb interface.
/* 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) * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05)
* 3GPP TS 48.016 version 6.5.0 Release 6 / ETSI TS 148 016 V6.5.0 (2005-11) */ * 3GPP TS 48.016 version 6.5.0 Release 6 / ETSI TS 148 016 V6.5.0 (2005-11) */
#pragma once
#include <stdint.h> #include <stdint.h>
/*! \addtogroup libgb /*! \addtogroup libgb
* @{ * @{
*/ * \file gprs_ns.h */
/*! \file gprs_ns.h */
/*! Common header of GPRS NS */ /*! Common header of GPRS NS */
struct gprs_ns_hdr { struct gprs_ns_hdr {

View File

@ -1,3 +1,5 @@
/*! \file gsm_08_18.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,6 +1,6 @@
/*! \file gsm/a5.h
* Osmocom GSM A5 ciphering algorithm header. */
/* /*
* a5.h
*
* Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com>
* *
* All Rights Reserved * All Rights Reserved
@ -29,11 +29,7 @@
/*! \defgroup a5 GSM A5 ciphering algorithm /*! \defgroup a5 GSM A5 ciphering algorithm
* @{ * @{
*/ * \file a5.h */
/*! \file gsm/a5.h
* Osmocom GSM A5 ciphering algorithm header
*/
/*! 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 * \param[in] fn The true framenumber

View File

@ -1,14 +1,12 @@
#pragma once #pragma once
/*! \defgroup oml A-bis OML
* @{
*/
#include <osmocom/gsm/tlv.h> #include <osmocom/gsm/tlv.h>
#include <osmocom/gsm/gsm_utils.h> #include <osmocom/gsm/gsm_utils.h>
#include <osmocom/gsm/protocol/gsm_12_21.h> #include <osmocom/gsm/protocol/gsm_12_21.h>
/*! \file abis_nm.h */ /*! \defgroup oml A-bis OML
* @{
* \file abis_nm.h */
extern const char abis_nm_ipa_magic[13]; extern const char abis_nm_ipa_magic[13];
extern const char abis_nm_osmo_magic[12]; extern const char abis_nm_osmo_magic[12];

View File

@ -1,3 +1,5 @@
/*! \file apn.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -5,8 +5,7 @@
/*! \defgroup bitvec helpers for GSM /*! \defgroup bitvec helpers for GSM
* @{ * @{
*/ * \file bitvec_gsm.h */
/*! \file bitvec_gsm.h */
void bitvec_add_range1024(struct bitvec *bv, const struct gsm48_range_1024 *r); void bitvec_add_range1024(struct bitvec *bv, const struct gsm48_range_1024 *r);

View File

@ -1,5 +1,5 @@
/* /*! \file comp128.h
* COMP128 header * COMP128 header.
* *
* See comp128.c for details * See comp128.c for details
*/ */

View File

@ -1,5 +1,5 @@
/* /*! \file comp128v23.h
* COMP128v23 header * COMP128v23 header.
* *
* See comp128v23.c for details * See comp128v23.c for details
*/ */

View File

@ -1,3 +1,5 @@
/*! \file gan.h */
#pragma once #pragma once
#include <osmocom/core/utils.h> #include <osmocom/core/utils.h>

View File

@ -1,5 +1,5 @@
/* /*! \file gea.h
* GEA3 header * GEA3 header.
* *
* See gea.c for details * See gea.c for details
*/ */

View File

@ -1,3 +1,5 @@
/*! \file gsm0341.h */
#pragma once #pragma once
#include <osmocom/gsm/protocol/gsm_03_41.h> #include <osmocom/gsm/protocol/gsm_03_41.h>

View File

@ -1,3 +1,5 @@
/*! \file gsm0411_smc.h */
#pragma once #pragma once
#include <osmocom/core/timer.h> #include <osmocom/core/timer.h>

View File

@ -1,3 +1,5 @@
/*! \file gsm0411_smr.h */
#pragma once #pragma once
#include <osmocom/gsm/protocol/gsm_04_11.h> #include <osmocom/gsm/protocol/gsm_04_11.h>

View File

@ -1,3 +1,5 @@
/*! \file gsm0411_utils.h */
#pragma once #pragma once
#include <time.h> #include <time.h>

View File

@ -1,3 +1,5 @@
/*! \file gsm0480.h */
#pragma once #pragma once
#include <osmocom/core/defs.h> #include <osmocom/core/defs.h>

View File

@ -1,3 +1,5 @@
/*! \file gsm0502.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,4 +1,6 @@
/* (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org> /*! \file gsm0808.h */
/*
* (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org>
* (C) 2009,2010 by On-Waves * (C) 2009,2010 by On-Waves
* All Rights Reserved * All Rights Reserved
* *

View File

@ -1,4 +1,6 @@
/* (C) 2016 by Sysmocom s.f.m.c. GmbH /*! \file gsm0808_utils.h */
/*
* (C) 2016 by Sysmocom s.f.m.c. GmbH
* All Rights Reserved * All Rights Reserved
* *
* Author: Philipp Maier * Author: Philipp Maier

View File

@ -1,4 +1,7 @@
/*! \file gsm23003.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
/* 23.003 Chapter 12.1 */ /* 23.003 Chapter 12.1 */

View File

@ -1,3 +1,5 @@
/*! \file gsm48.h */
#pragma once #pragma once
#include <osmocom/gsm/tlv.h> #include <osmocom/gsm/tlv.h>

View File

@ -1,3 +1,5 @@
/*! \file gsm48_ie.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,4 +1,5 @@
/* GSM utility functions, e.g. coding and decoding */ /*! \file gsm_utils.h
* GSM utility functions, e.g. coding and decoding. */
/* /*
* (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> * (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de>
* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org>

View File

@ -1,6 +1,7 @@
/* Osmocom Generic Subscriber Update Protocol message encoder/decoder */ /*! \file gsup.h
* Osmocom Generic Subscriber Update Protocol message encoder/decoder. */
/* (C) 2014 by sysmocom s.f.m.c. GmbH, Author: Jacob Erlbeck /*
* (C) 2014 by sysmocom s.f.m.c. GmbH, Author: Jacob Erlbeck
* (C) 2016 by Harald Welte <laforge@gnumonks.org> * (C) 2016 by Harald Welte <laforge@gnumonks.org>
* All Rights Reserved * All Rights Reserved
* *

View File

@ -1,3 +1,5 @@
/*! \file ipa.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,5 +1,5 @@
/* /*! \file kasumi.h
* KASUMI header * KASUMI header.
* *
* See kasumi.c for details * See kasumi.c for details
* The parameters are described in TS 135 202. * The parameters are described in TS 135 202.

View File

@ -1,3 +1,5 @@
/*! \file l1sap.h */
#pragma once #pragma once
#include <osmocom/core/prim.h> #include <osmocom/core/prim.h>

View File

@ -1,3 +1,6 @@
/*! \file lapd_core.h
* primitive related stuff
*/
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
@ -8,10 +11,7 @@
/*! \defgroup lapd LAPD implementation common part /*! \defgroup lapd LAPD implementation common part
* @{ * @{
*/ * \file lapd_core.h
/*! \file lapd_core.h
* primitive related stuff
*/ */
/*! LAPD related primitives (L2<->L3 SAP)*/ /*! LAPD related primitives (L2<->L3 SAP)*/

View File

@ -5,9 +5,7 @@
/*! \defgroup lapdm LAPDm implementation according to GSM TS 04.06 /*! \defgroup lapdm LAPDm implementation according to GSM TS 04.06
* @{ * @{
*/ * \file lapdm.h */
/*! \file lapdm.h */
/*! LAPDm mode/role */ /*! LAPDm mode/role */
enum lapdm_mode { enum lapdm_mode {

View File

@ -1,3 +1,5 @@
/*! \file meas_rep.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,3 +1,5 @@
/*! \file mncc.h */
#pragma once #pragma once
#include <osmocom/gsm/protocol/gsm_04_08.h> #include <osmocom/gsm/protocol/gsm_04_08.h>

View File

@ -1,6 +1,7 @@
/* Osmocom Authentication Protocol message encoder/decoder */ /*! \file oap.h
* Osmocom Authentication Protocol message encoder/decoder. */
/* (C) 2015-2016 by sysmocom s.f.m.c. GmbH /*
* (C) 2015-2016 by sysmocom s.f.m.c. GmbH
* All Rights Reserved * All Rights Reserved
* *
* Author: Neels Hofmeyr * Author: Neels Hofmeyr

View File

@ -1,3 +1,5 @@
/*! \file prim.h */
#pragma once #pragma once
#include <osmocom/core/prim.h> #include <osmocom/core/prim.h>

View File

@ -1,6 +1,7 @@
#pragma once /*! \file gsm_03_40.h
* GSM TS 03.40. */
/* GSM TS 03.40 */ #pragma once
/** /**
* 9.1.2.5 Type Of Number * 9.1.2.5 Type Of Number

View File

@ -1,3 +1,6 @@
/*! \file gsm_03_41.h
* GSM TS 03.41 definitions also TS 23.041. */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
@ -9,8 +12,6 @@
#define OSMO_IS_LITTLE_ENDIAN 0 #define OSMO_IS_LITTLE_ENDIAN 0
#endif #endif
/* GSM TS 03.41 definitions also TS 23.041*/
#define GSM341_MAX_PAYLOAD (GSM412_MSG_LEN-sizeof(struct gsm341_ms_message)) #define GSM341_MAX_PAYLOAD (GSM412_MSG_LEN-sizeof(struct gsm341_ms_message))
#define GSM341_MAX_CHARS (GSM341_MAX_PAYLOAD*8/7) #define GSM341_MAX_CHARS (GSM341_MAX_PAYLOAD*8/7)
#define GSM341_7BIT_PADDING '\r' #define GSM341_7BIT_PADDING '\r'

View File

@ -1,3 +1,6 @@
/*! \file gsm_04_08.h
* GSM TS 04.08 definitions. */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
@ -6,7 +9,6 @@
#include <osmocom/core/utils.h> #include <osmocom/core/utils.h>
#include <osmocom/core/endian.h> #include <osmocom/core/endian.h>
/* GSM TS 04.08 definitions */
struct gsm_lchan; struct gsm_lchan;
/* Chapter 10.5.1.5 */ /* Chapter 10.5.1.5 */

View File

@ -1,3 +1,5 @@
/*! \file gsm_04_08_gprs.h */
#ifndef _GSM48_GPRS_H #ifndef _GSM48_GPRS_H
#define _GSM48_GPRS_H #define _GSM48_GPRS_H

View File

@ -1,3 +1,5 @@
/*! \file gsm_04_11.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,9 +1,10 @@
/*! \file gsm_04_12.h
* GSM TS 04.12 definitions for Short Message Service Cell Broadcast. */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
/* GSM TS 04.12 definitions for Short Message Service Cell Broadcast */
#define GSM412_MSG_LEN 88 /* TS 04.12 Section 3.1 */ #define GSM412_MSG_LEN 88 /* TS 04.12 Section 3.1 */
#define GSM412_BLOCK_LEN 22 /* TS 04.12 Section 3.1 */ #define GSM412_BLOCK_LEN 22 /* TS 04.12 Section 3.1 */

View File

@ -1,3 +1,5 @@
/*! \file gsm_04_14.h */
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,6 +1,7 @@
#pragma once /*! \file gsm_04_80.h
* GSM TS 04.80 definitions (Supplementary Services Specification, Formats and Coding). */
/* GSM TS 04.80 definitions (Supplementary Services Specification, Formats and Coding) */ #pragma once
/* Section 3.4 */ /* Section 3.4 */
#define GSM0480_MTYPE_RELEASE_COMPLETE 0x2A #define GSM0480_MTYPE_RELEASE_COMPLETE 0x2A

View File

@ -1,9 +1,8 @@
#pragma once /*! \file gsm_08_58.h
* GSM Radio Signalling Link messages on the A-bis interface.
/* 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 */ * 3GPP TS 08.58 version 8.6.0 Release 1999 / ETSI TS 100 596 V8.6.0 */
/*
/* (C) 2008 by Harald Welte <laforge@gnumonks.org> * (C) 2008 by Harald Welte <laforge@gnumonks.org>
* All Rights Reserved * All Rights Reserved
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -22,13 +21,13 @@
* *
*/ */
#pragma once
#include <stdint.h> #include <stdint.h>
/*! \addtogroup rsl /*! \addtogroup rsl
* @{ * @{
*/ * \file gsm_08_58.h */
/*! \file gsm_08_58.h */
/*! RSL common header */ /*! RSL common header */
struct abis_rsl_common_hdr { struct abis_rsl_common_hdr {

View File

@ -1,8 +1,9 @@
/*! \file gsm_09_02.h
* GSM TS 09.02 definitions (MAP). */
#ifndef PROTO_GSM_09_02_H #ifndef PROTO_GSM_09_02_H
#define PROTO_GSM_09_02_H #define PROTO_GSM_09_02_H
/* GSM TS 09.02 definitions (MAP) */
/* Section 17.7.4 */ /* Section 17.7.4 */
/* SS-Status */ /* SS-Status */
#define GSM0902_SS_STATUS_Q_BIT 0x08 #define GSM0902_SS_STATUS_Q_BIT 0x08

View File

@ -1,9 +1,5 @@
#pragma once /*
* (C) 2008-2009 by Harald Welte <laforge@gnumonks.org>
/* GSM Network Management 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-2009 by Harald Welte <laforge@gnumonks.org>
* All Rights Reserved * All Rights Reserved
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -22,11 +18,11 @@
* *
*/ */
#pragma once
/*! \addtogroup oml /*! \addtogroup oml
* @{ * @{
*/ * \file gsm_12_21.h */
/*! \file gsm_12_21.h */
#include <stdint.h> #include <stdint.h>
#include <stdbool.h> #include <stdbool.h>

Some files were not shown because too many files have changed in this diff Show More