aboutsummaryrefslogtreecommitdiffstats
path: root/include/osmocom/core/sercomm.h
AgeCommit message (Collapse)AuthorFilesLines
2022-09-29include: use '#pragma once' everywhereVadim Yanitskiy1-4/+1
Change-Id: Iecc1754caae401aca28444d3e3d0cca04b398f26
2017-06-23doxygen: unify use of \file across the boardNeels Hofmeyr1-5/+5
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-21/+21
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
2017-05-17sercomm: More API documentationHarald Welte1-1/+27
Change-Id: I5d5002ceedd10e10d772693478f4f9cab6b1290a
2017-05-17sercomm: Better integration of driver interfaceHarald Welte1-6/+7
We cannot assume a certain UART API like uart_baudrate() which only exists in OsmocomBB. Rather, use generic function prototypes (sercomm_drv_*) which are to be provided by the application / environment to the sercomm core. Change-Id: I01ea3067baf1791000c1a7d537ccce496a1ab1ee
2017-05-17sercomm: Include in libosmocore MakefileHarald Welte1-1/+1
Change-Id: If9d50d634381f43b2c67b97fea36a462a66e4559
2017-05-17sercomm: remove unrequired helper functionsHarald Welte1-2/+0
osmo_sercomm_{bind,get}_uart() are not really needed anymore, as sercomm_inst is public and thus the user can access the uart_id member directly. Change-Id: I6d57709c3764036046202f16a26c9eb87426c8d1
2017-05-17sercomm: Move HDLC related defines into C fileHarald Welte1-7/+0
Those values are not relevant to the sercomm user, only to the implementation and thus can remain inside sercomm.c Change-Id: I5700a45985b7c119c6338932171aae62ee4e2d22
2017-05-17sercomm: Add doxygen-style documentation to public APIHarald Welte1-10/+19
Change-Id: I2d8b11905692920d328262836420f01305be489e
2017-05-17sercomm: make rx msg size configurable per instanceHarald Welte1-0/+1
Change-Id: I835506e26e83232e1e7290c0da04d389c8d7fb40
2017-05-17sercomm: introduce osmo_ naming prefix in struct and function namesHarald Welte1-14/+14
Change-Id: If4e22f182a47b72b1fe43146716a4fbccceb62e6
2017-05-17sercomm: Enable multiple instances of 'sercomm'Harald Welte1-11/+36
Rather than having one global instance, let's permit multiple instances of sercomm to co-exist, with all API functions extended by the instance as first argument. Change-Id: I0f3b53f464b119d65747bcb0be0af2d631e1cc05
2017-05-17Import sercomm.c from osmocom-bbHarald Welte1-0/+61
This imports the file src/target/firmware/comm/sercomm.c from osmocom-bb.git without introducing any modifications. It will not even be built yet, as Makefile integration is intentionally left until it has been adapted to work inside libosmocore. Change-Id: I9ee199381c7b5986a9540d124836cdddd0f66c86