osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
10
0
Fork 0
Code Issues Releases Wiki Activity

doxygen: unify use of \file across the board

Browse Source 
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
changes/87/2987/4
Neels Hofmeyr 6 years ago
parent 33370cb18d
commit 17518fe393
251 changed files with 873 additions and 866 deletions
Show Stats Download Patch File Download Diff File

2
include/osmocom/codec/codec.h
Unescape View File

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

10
include/osmocom/coding/gsm0503_coding.h
Unescape View File

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

10
include/osmocom/coding/gsm0503_interleaving.h
Unescape View File

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

10
include/osmocom/coding/gsm0503_mapping.h
Unescape View File

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

10
include/osmocom/coding/gsm0503_parity.h
Unescape View File

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

10
include/osmocom/coding/gsm0503_tables.h
Unescape View File

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

2
include/osmocom/core/backtrace.h
Unescape View File

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

17
include/osmocom/core/bitcomp.h
Unescape View File

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

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

20
include/osmocom/core/bitvec.h
Unescape View File

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

2
include/osmocom/core/byteswap.h
Unescape View File

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

10
include/osmocom/core/conv.h
Unescape View File

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

2
include/osmocom/core/crc16.h
Unescape View File

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

11
include/osmocom/core/crcXXgen.h.tpl
Unescape 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>
*
* All Rights Reserved
@ -24,12 +24,7 @@
/*! \addtogroup crcgen
* @{
*/
/*! \file crcXXgen.h
* Osmocom generic CRC routines (for max XX bits poly) header
*/
* \file crcXXgen.h.tpl */
#include <stdint.h>
#include <osmocom/core/bits.h>

10
include/osmocom/core/crcgen.h
Unescape 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>
*
* All Rights Reserved
@ -24,11 +24,7 @@
/*! \defgroup crcgen Osmocom generic CRC routines
* @{
*/
/*! \file crcgen.h
* Osmocom generic CRC routines global header
*/
* \file crcgen.h */
#include <osmocom/core/crc8gen.h>
#include <osmocom/core/crc16gen.h>

10
include/osmocom/core/defs.h
Unescape View File

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

7
include/osmocom/core/endian.h
Unescape View File

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

10
include/osmocom/core/fsm.h
Unescape View File

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

10
include/osmocom/core/gsmtap.h
Unescape View File

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

3
include/osmocom/core/gsmtap_util.h
Unescape View File

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

15
include/osmocom/core/linuxlist.h
Unescape View File

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

4
include/osmocom/core/logging.h
Unescape View File

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

8
include/osmocom/core/loggingrb.h
Unescape View File

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

2
include/osmocom/core/macaddr.h
Unescape View File

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

4
include/osmocom/core/msgb.h
Unescape View File

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

1
include/osmocom/core/msgfile.h
Unescape View File

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

4
include/osmocom/core/panic.h
Unescape View File

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

2
include/osmocom/core/plugin.h
Unescape View File

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

4
include/osmocom/core/prim.h
Unescape View File

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

1
include/osmocom/core/process.h
Unescape View File

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

4
include/osmocom/core/rate_ctr.h
Unescape View File

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

10
include/osmocom/core/select.h
Unescape View File

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

10
include/osmocom/core/sercomm.h
Unescape View File

@ -1,3 +1,7 @@
/*! \file sercomm.h
* Osmocom Sercomm HDLC (de)multiplex.
*/
#ifndef _SERCOMM_H
#define _SERCOMM_H
@ -5,11 +9,7 @@
/*! \defgroup sercomm Seriall Communications (HDLC)
* @{
*/
/*! \file sercomm.h
* Osmocom Sercomm HDLC (de)multiplex
*/
* \file sercomm.h */
/*! A low sercomm_dlci means high priority. A high DLCI means low priority */
enum sercomm_dlci {

10
include/osmocom/core/serial.h
Unescape View File

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

3
include/osmocom/core/signal.h
Unescape View File

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

9
include/osmocom/core/socket.h
Unescape View File

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

4
include/osmocom/core/stat_item.h
Unescape View File

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

4
include/osmocom/core/stats.h
Unescape 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
*

15
include/osmocom/core/strrb.h
Unescape View File

@ -1,6 +1,7 @@
#pragma once
/* (C) 2012-2013 by Katerina Barone-Adesi <kat.obsc@gmail.com>
/*! \file strrb.h
* Osmocom string ringbuffer handling routines. */
/*
* (C) 2012-2013 by Katerina Barone-Adesi <kat.obsc@gmail.com>
* All Rights Reserved
*
* 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
* @{
*/
/*! \file strrb.h
* Osmocom string ringbuffer handling routines
*/
* \file strrb.h */
#include <unistd.h>
#include <stdbool.h>

3
include/osmocom/core/talloc.h
Unescape 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 */
#pragma once
#include <talloc.h>

8
include/osmocom/core/timer.h
Unescape View File

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

9
include/osmocom/core/timer_compat.h
Unescape View File

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

4
include/osmocom/core/utils.h
Unescape View File

@ -5,9 +5,7 @@
/*! \defgroup utils General-purpose utility functions
* @{
*/
/*! \file utils.h */
* \file utils.h */
/*! Determine number of elements in an array of static size */
#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))

8
include/osmocom/core/write_queue.h
Unescape 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 On-Waves
@ -24,10 +25,7 @@
/*! \defgroup write_queue Osmocom msgb write queues
* @{
*/
/*! \file write_queue.h
*/
* \file write_queue.h */
#include <osmocom/core/select.h>
#include <osmocom/core/msgb.h>

4
include/osmocom/crypt/auth.h
Unescape View File

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

2
include/osmocom/crypt/gprs_cipher.h
Unescape View File

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

2
include/osmocom/ctrl/control_cmd.h
Unescape View File

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

2
include/osmocom/ctrl/control_if.h
Unescape View File

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

2
include/osmocom/ctrl/control_vty.h
Unescape View File

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

6
include/osmocom/ctrl/ports.h
Unescape View File

@ -1,6 +1,4 @@
#pragma once
/*
/*! \file ports.h
* 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
* sync with this file:
@ -8,6 +6,8 @@
* 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_NITB_BSC 4249
#define OSMO_CTRL_PORT_BSC_NAT 4250

2
include/osmocom/gprs/gprs_bssgp.h
Unescape View File

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

16
include/osmocom/gprs/gprs_bssgp_bss.h
Unescape View File

@ -1,11 +1,7 @@
#pragma once
#include <osmocom/core/msgb.h>
#include <osmocom/gprs/gprs_bssgp.h>
/* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */
/* (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
/*! \file gprs_bssgp_bss.h
* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */
/*
* (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
*
* 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);

2
include/osmocom/gprs/gprs_msgb.h
Unescape View File

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

2
include/osmocom/gprs/gprs_ns.h
Unescape View File

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

2
include/osmocom/gprs/gprs_ns_frgre.h
Unescape View File

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

2
include/osmocom/gprs/gprs_rlc.h
Unescape View File

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

7
include/osmocom/gprs/protocol/gsm_04_60.h
Unescape View File

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

11
include/osmocom/gprs/protocol/gsm_08_16.h
Unescape View File

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

2
include/osmocom/gprs/protocol/gsm_08_18.h
Unescape View File

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

10
include/osmocom/gsm/a5.h
Unescape 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>
*
* All Rights Reserved
@ -29,11 +29,7 @@
/*! \defgroup a5 GSM A5 ciphering algorithm
* @{
*/
/*! \file gsm/a5.h
* Osmocom GSM A5 ciphering algorithm header
*/
* \file a5.h */
/*! Converts a frame number into the 22 bit number used in A5/x
* \param[in] fn The true framenumber

8
include/osmocom/gsm/abis_nm.h
Unescape View File

@ -1,14 +1,12 @@
#pragma once
/*! \defgroup oml A-bis OML
* @{
*/
#include <osmocom/gsm/tlv.h>
#include <osmocom/gsm/gsm_utils.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_osmo_magic[12];

2
include/osmocom/gsm/apn.h
Unescape View File

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

3
include/osmocom/gsm/bitvec_gsm.h
Unescape View File

@ -5,8 +5,7 @@
/*! \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);

4
include/osmocom/gsm/comp128.h
Unescape View File

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

4
include/osmocom/gsm/comp128v23.h
Unescape View File

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

2
include/osmocom/gsm/gan.h
Unescape View File

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

4
include/osmocom/gsm/gea.h
Unescape View File

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

2
include/osmocom/gsm/gsm0341.h
Unescape View File

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

2
include/osmocom/gsm/gsm0411_smc.h
Unescape View File

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

2
include/osmocom/gsm/gsm0411_smr.h
Unescape View File

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

2
include/osmocom/gsm/gsm0411_utils.h
Unescape View File

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

2
include/osmocom/gsm/gsm0480.h
Unescape View File

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

2
include/osmocom/gsm/gsm0502.h
Unescape View File

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

4
include/osmocom/gsm/gsm0808.h
Unescape 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
* All Rights Reserved
*

4
include/osmocom/gsm/gsm0808_utils.h
Unescape 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
*
* Author: Philipp Maier

3
include/osmocom/gsm/gsm23003.h
Unescape View File

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

2
include/osmocom/gsm/gsm48.h
Unescape View File

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

2
include/osmocom/gsm/gsm48_ie.h
Unescape View File

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

3
include/osmocom/gsm/gsm_utils.h
Unescape 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) 2009 by Holger Hans Peter Freyther <zecke@selfish.org>

7
include/osmocom/gsm/gsup.h
Unescape View File

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

2
include/osmocom/gsm/ipa.h
Unescape View File

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

4
include/osmocom/gsm/kasumi.h
Unescape View File

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

2
include/osmocom/gsm/l1sap.h
Unescape View File

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

8
include/osmocom/gsm/lapd_core.h
Unescape View File

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

4
include/osmocom/gsm/lapdm.h
Unescape View File

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

2
include/osmocom/gsm/meas_rep.h
Unescape View File

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

2
include/osmocom/gsm/mncc.h
Unescape View File

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

7
include/osmocom/gsm/oap.h
Unescape View File

@ -1,6 +1,7 @@
/* Osmocom Authentication Protocol message encoder/decoder */
/* (C) 2015-2016 by sysmocom s.f.m.c. GmbH