path: root/include/osmocom/core/bits.h
AgeCommit message (Collapse)AuthorFilesLines
2017-10-16[doc] bits.c: Better / more Doxygen documentationHarald Welte1-10/+12
Change-Id: If824a5c8d8ee6e3dc96a3fddeb105786c0c027c1
2017-09-18Expand bit pretty-printerMax1-9/+11
Add OSMO_BIT_PRINT_EX() which is like OSMO_BIT_PRINT() but allows to specify character to be printed for set bits. It's useful to print bytes used as mask where set bit has particular semantics - for example TS mask in OsmoPCU. Change-Id: I72528bc1e376134c5a7b6e7a50c48e38c3f48b0a Related: OS#2282
2017-06-23doxygen: unify use of \file across the boardNeels Hofmeyr1-9/+9
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
2017-06-23doxygen: enable AUTOBRIEF, drop \briefNeels Hofmeyr1-15/+15
Especially for short descriptions, it is annoying to have to type \brief for every single API doc. Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes the first sentence of an API doc as the brief description. Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
2016-06-20Add octet-aligned/unaligned shift functionsMax1-0/+5
The actual code is from OsmoBTS' tch.c by Harald Welte. Add unit tests, doxygen annotation and extra memory safety check. Those functions are used in several BTS implementations but seems generic enough to be generally useful. Change-Id: I2b1901c4161e8035f059585901dca593b661556d
2016-05-05Update doxygen annotations in libosmocoreHarald Welte1-6/+5
This adds and improves doxygen API descriptions all over libosmocore, reducing the 'white spots' that don't have any documentation.
2016-04-12Add ubit <-> sbit convertorsMax1-0/+3
Move functions for conversion between soft and unpacked bits to main library as they are generally useful.
2016-02-25Add byte printing macrosMax1-0/+21
It's sometimes handy for debugging to be able to immediately see which bits are set in a given byte. Generalize macro used for that in bitvec tests and make it available for the rest of the library.
2014-06-16bits: Add left circular shift functionMax1-0/+10
Submitted-by: Max <max.suraev@fairwaves.co> Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
2014-06-16core: Add generic LE/BE load/store uint type convertors and use them in msgbMax1-0/+5
Submitted-by: Max <max.suraev@fairwaves.co> Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
2014-06-16include: Switch to #pragma once patternSylvain Munaut1-4/+1
Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
2012-04-18doc: Fix the Doxygen section endingsSylvain Munaut1-1/+1
Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
2011-09-01add functions for bit-reversalHarald Welte1-0/+27
Sometimes we need stuff like reversing every bit in each byte (but not the byte-order).
2011-08-17some more doxygen work (include the notion of modules)Harald Welte1-29/+7
2011-08-16start to add doxygen documentation to libosmocore headersHarald Welte1-10/+38
2011-03-27core/bits: Make sbit_t a signed type (so that the math works)Sylvain Munaut1-1/+1
Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
2011-03-23include: reorganize headers file to include/osmocom/[gsm|core]0.2.0Pablo Neira Ayuso1-0/+45
This patch moves all GSM-specific definitions to include/osmocom/gsm. Moreover, the headers in include/osmocore/ have been moved to include/osmocom/core. This has been proposed by Harald Welte and Sylvain Munaunt. Tested with `make distcheck'. Signed-off-by: Pablo Neira Ayuso <pablo@gnumonks.org>