summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-05-15 17:33:02 +0200
committerHarald Welte <laforge@gnumonks.org>2017-05-17 15:15:09 +0100
commit7711713b7a30dab16bcba3920433f3fa58f89149 (patch)
tree35f79fc85cb891bb45ce66cf6c16b80506d84b3f /include
parent799bef5cf614c303df1f88c1a7c4cc46a02e8c34 (diff)
sercomm: More API documentation
Change-Id: I5d5002ceedd10e10d772693478f4f9cab6b1290a
Diffstat (limited to 'include')
-rw-r--r--include/osmocom/core/sercomm.h28
1 files changed, 27 insertions, 1 deletions
diff --git a/include/osmocom/core/sercomm.h b/include/osmocom/core/sercomm.h
index e2630806..5ad1d73c 100644
--- a/include/osmocom/core/sercomm.h
+++ b/include/osmocom/core/sercomm.h
@@ -3,7 +3,15 @@
#include <osmocom/core/msgb.h>
-/* a low sercomm_dlci means high priority. A high DLCI means low priority */
+/*! \defgroup sercomm Seriall Communications (HDLC)
+ * @{
+ */
+
+/*! \file sercomm.h
+ * \brief Osmocom Sercomm HDLC (de)multiplex
+ */
+
+/*! \brief A low sercomm_dlci means high priority. A high DLCI means low priority */
enum sercomm_dlci {
SC_DLCI_HIGHEST = 0,
SC_DLCI_DEBUG = 4,
@@ -77,12 +85,30 @@ int osmo_sercomm_drv_rx_char(struct osmo_sercomm_inst *sercomm, uint8_t ch);
extern void sercomm_drv_lock(unsigned long *flags);
extern void sercomm_drv_unlock(unsigned long *flags);
+
+/*! \brief low-level driver routine to request start of transmission
+ * The Sercomm code calls this function to inform the low-level driver
+ * that some data is pending for transmission, and the low-level driver
+ * should (if not active already) start enabling tx_empty interrupts
+ * and pull drivers out of sercomm using osmo_sercomm_drv_pull() until
+ * the latter returns 0.
+ * \param[in] sercomm Osmocom sercomm instance for which to change
+ */
extern void sercomm_drv_start_tx(struct osmo_sercomm_inst *sercomm);
+
+/*! \brief low-level driver routine to execute baud-rate change
+ * \param[in] sercomm Osmocom sercomm instance for which to change
+ * \param[in] bdrt New Baud-Rate (integer)
+ * \returns 0 on success; negative in case of error
+ */
extern int sercomm_drv_baudrate_chg(struct osmo_sercomm_inst *sercomm, uint32_t bdrt);
+/*! \brief Sercomm msgb allocator function */
static inline struct msgb *osmo_sercomm_alloc_msgb(unsigned int len)
{
return msgb_alloc_headroom(len+4, 4, "sercomm_tx");
}
+/*! @} */
+
#endif /* _SERCOMM_H */