November 2023 - gerrit-log - lists.osmocom.org

[M] Change in libosmocore[master]: soft_uart: implement the transmitter

by laforge

laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35044?usp=email ) Change subject: soft_uart: implement the transmitter ...................................................................... soft_uart: implement the transmitter Change-Id: Ibcd9643227e5616efd8bbd7a1430feda6fcef45c Related: OS#4396 --- M include/osmocom/core/soft_uart.h M src/core/libosmocore.map M src/core/soft_uart.c 3 files changed, 96 insertions(+), 28 deletions(-) Approvals: laforge: Looks good to me, approved Jenkins Builder: Verified diff --git a/include/osmocom/core/soft_uart.h b/include/osmocom/core/soft_uart.h index 2b9d67f..df2faac 100644 --- a/include/osmocom/core/soft_uart.h +++ b/include/osmocom/core/soft_uart.h @@ -68,6 +68,11 @@ * 'flags' is a bit-mask of osmo_soft_uart_flags, */ void (*rx_cb)(void *priv, struct msgb *rx_data, unsigned int flags); + /*! transmit call-back. The implementation is expected to provide at most + * tx_data->data_len characters (the actual amount is detetmined by the + * number of requested bits and the effective UART configuration). */ + void (*tx_cb)(void *priv, struct msgb *tx_data); + /*! modem status line change call-back. gets bitmask of osmo_soft_uart_status */ void (*status_change_cb)(void *priv, unsigned int status); }; @@ -86,5 +91,4 @@ int osmo_soft_uart_rx_ubits(struct osmo_soft_uart *suart, const ubit_t *ubits, size_t n_ubits); int osmo_soft_uart_tx_ubits(struct osmo_soft_uart *suart, ubit_t *ubits, size_t n_ubits); -void osmo_soft_uart_tx(struct osmo_soft_uart *suart, struct msgb *tx_data); int osmo_soft_uart_set_status(struct osmo_soft_uart *suart, unsigned int status); diff --git a/src/core/libosmocore.map b/src/core/libosmocore.map index a9d25fb..e6a1866 100644 --- a/src/core/libosmocore.map +++ b/src/core/libosmocore.map @@ -447,7 +447,6 @@ osmo_soft_uart_set_tx; osmo_soft_uart_rx_ubits; osmo_soft_uart_tx_ubits; -osmo_soft_uart_tx; osmo_soft_uart_set_status; osmo_stat_item_dec; osmo_stat_item_flush; diff --git a/src/core/soft_uart.c b/src/core/soft_uart.c index d8ce9d9..238425a 100644 --- a/src/core/soft_uart.c +++ b/src/core/soft_uart.c @@ -2,6 +2,7 @@ * Software UART implementation. */ /* * (C) 2022 by Harald Welte <laforge(a)gnumonks.org> + * (C) 2023 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> * * All Rights Reserved * @@ -53,8 +54,8 @@ bool running; uint8_t bit_count; uint8_t shift_reg; - struct msgb *msg; - struct llist_head queue; + ubit_t parity_bit; /* 0 (even) / 1 (odd) */ + enum suart_flow_state flow_state; } tx; }; @@ -79,7 +80,7 @@ if (suart->cfg.rx_cb) { suart->cfg.rx_cb(suart->cfg.priv, suart->rx.msg, suart->rx.flags); /* call-back has taken ownership of msgb, no need to free() here */ - suart->rx.msg = msgb_alloc_c(suart, suart->cfg.rx_buf_size, "soft_uart rx"); + suart->rx.msg = msgb_alloc_c(suart, suart->cfg.rx_buf_size, "soft_uart_rx"); } else { msgb_reset(suart->rx.msg); } @@ -191,29 +192,64 @@ * Transmitter *************************************************************************/ -/*! Enqueue the given message buffer into the transmit queue of the soft-UART. - * \param[in] suart soft-UART instance for transmitting data. - * \param[in] tx_data message buffer containing to be transmitted data. */ -void osmo_soft_uart_tx(struct osmo_soft_uart *suart, struct msgb *tx_data) -{ - if (!suart->tx.msg) - suart->tx.msg = tx_data; - else - msgb_enqueue(&suart->tx.queue, tx_data); -} - /* pull a single bit out of the UART transmitter */ -static inline ubit_t osmo_uart_tx_bit(struct osmo_soft_uart *suart) +static inline ubit_t osmo_uart_tx_bit(struct osmo_soft_uart *suart, struct msgb *msg) { - if (!suart->tx.running) - return 1; + ubit_t tx_bit = 1; - if (suart->tx.bit_count == 0) { - /* do we have anything to transmit? */ - /* FIXME */ + if (!suart->tx.running) + return tx_bit; + + switch (suart->tx.flow_state) { + case SUART_FLOW_ST_IDLE: + if (msgb_length(msg) > 0) { /* if we have pending data */ + suart->tx.shift_reg = msgb_pull_u8(msg); + suart->tx.flow_state = SUART_FLOW_ST_DATA; + suart->tx.bit_count = 0; + suart->tx.parity_bit = 0; + tx_bit = 0; + } + break; + case SUART_FLOW_ST_DATA: + tx_bit = suart->tx.shift_reg & 1; + suart->tx.parity_bit ^= tx_bit; + suart->tx.shift_reg >>= 1; + suart->tx.bit_count++; + if (suart->tx.bit_count >= suart->cfg.num_data_bits) { + /* we have transmitted all data bits */ + if (suart->cfg.parity_mode != OSMO_SUART_PARITY_NONE) + suart->tx.flow_state = SUART_FLOW_ST_PARITY; + else + suart->tx.flow_state = SUART_FLOW_ST_STOP; + } + break; + case SUART_FLOW_ST_PARITY: + switch (suart->cfg.parity_mode) { + case OSMO_SUART_PARITY_EVEN: + /* number of 1-bits (in both data and parity) shall be even */ + tx_bit = suart->tx.parity_bit; + break; + case OSMO_SUART_PARITY_ODD: + /* number of 1-bits (in both data and parity) shall be odd */ + tx_bit = !suart->tx.parity_bit; + break; + case OSMO_SUART_PARITY_NONE: + default: /* shall not happen */ + OSMO_ASSERT(0); + } + + suart->tx.flow_state = SUART_FLOW_ST_STOP; + break; + case SUART_FLOW_ST_STOP: + suart->tx.bit_count++; + if (suart->tx.bit_count >= (suart->cfg.num_data_bits + suart->cfg.num_stop_bits)) { + /* we have transmitted all stop bits, we're done */ + suart->tx.flow_state = SUART_FLOW_ST_IDLE; + } + break; } - /* FIXME */ - return 1; + + return tx_bit; } /*! Pull a number of unpacked bits out of the soft-UART transmitter. @@ -223,9 +259,28 @@ * \returns number of unpacked bits pulled; negative on error. */ int osmo_soft_uart_tx_ubits(struct osmo_soft_uart *suart, ubit_t *ubits, size_t n_ubits) { + const struct osmo_soft_uart_cfg *cfg = &suart->cfg; + size_t n_frame_bits; + struct msgb *msg; + + /* calculate UART frame size for the effective config */ + n_frame_bits = 1 + cfg->num_data_bits + cfg->num_stop_bits; + if (cfg->parity_mode != OSMO_SUART_PARITY_NONE) + n_frame_bits += 1; + + /* allocate a Tx buffer msgb */ + msg = msgb_alloc_c(suart, n_ubits / n_frame_bits, "soft_uart_tx"); + OSMO_ASSERT(msg != NULL); + + /* call the .tx_cb() to populate the Tx buffer */ + OSMO_ASSERT(cfg->tx_cb != NULL); + suart->cfg.tx_cb(cfg->priv, msg); + for (size_t i = 0; i < n_ubits; i++) - ubits[i] = osmo_uart_tx_bit(suart); - return n_ubits; + ubits[i] = osmo_uart_tx_bit(suart, msg); + msgb_free(msg); + + return 0; } /*! Set the modem status lines of the given soft-UART. @@ -300,7 +355,6 @@ suart->cfg = *cfg; osmo_timer_setup(&suart->rx.timer, suart_rx_timer_cb, suart); - INIT_LLIST_HEAD(&suart->tx.queue); return 0; } @@ -332,10 +386,11 @@ int osmo_soft_uart_set_tx(struct osmo_soft_uart *suart, bool enable) { if (!enable && suart->tx.running) { - /* FIXME: Tx */ suart->tx.running = false; + suart->tx.flow_state = SUART_FLOW_ST_IDLE; } else if (enable && !suart->tx.running) { suart->tx.running = true; + suart->tx.flow_state = SUART_FLOW_ST_IDLE; } return 0; -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35044?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: Ibcd9643227e5616efd8bbd7a1430feda6fcef45c Gerrit-Change-Number: 35044 Gerrit-PatchSet: 5 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-MessageType: merged

1 year, 7 months

1
0
0 0

[S] Change in libosmocore[master]: soft_uart: add osmo_soft_uart_free()

by laforge

laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35018?usp=email ) Change subject: soft_uart: add osmo_soft_uart_free() ...................................................................... soft_uart: add osmo_soft_uart_free() Change-Id: I2fdcf6116144d8f16cf4167c37cfa7215d16337f Related: OS#4396 --- M include/osmocom/core/soft_uart.h M src/core/libosmocore.map M src/core/soft_uart.c 3 files changed, 26 insertions(+), 0 deletions(-) Approvals: laforge: Looks good to me, approved jolly: Looks good to me, but someone else must approve Jenkins Builder: Verified diff --git a/include/osmocom/core/soft_uart.h b/include/osmocom/core/soft_uart.h index 36a43fe..4f9c1fc 100644 --- a/include/osmocom/core/soft_uart.h +++ b/include/osmocom/core/soft_uart.h @@ -75,6 +75,7 @@ struct osmo_soft_uart; struct osmo_soft_uart *osmo_soft_uart_alloc(void *ctx, const char *name); +void osmo_soft_uart_free(struct osmo_soft_uart *suart); int osmo_soft_uart_configure(struct osmo_soft_uart *suart, const struct osmo_soft_uart_cfg *cfg); int osmo_soft_uart_enable(struct osmo_soft_uart *suart, bool rx, bool tx); diff --git a/src/core/libosmocore.map b/src/core/libosmocore.map index c08d3ff..142e4c4 100644 --- a/src/core/libosmocore.map +++ b/src/core/libosmocore.map @@ -440,6 +440,7 @@ osmo_sock_unix_init; osmo_sock_unix_init_ofd; osmo_soft_uart_alloc; +osmo_soft_uart_free; osmo_soft_uart_configure; osmo_soft_uart_enable; osmo_soft_uart_rx_ubits; diff --git a/src/core/soft_uart.c b/src/core/soft_uart.c index 22292af..7860453 100644 --- a/src/core/soft_uart.c +++ b/src/core/soft_uart.c @@ -220,6 +220,20 @@ return suart; } +/*! Release memory taken by the given soft-UART. + * \param[in] suart soft-UART instance to be free()d. */ +void osmo_soft_uart_free(struct osmo_soft_uart *suart) +{ + if (suart == NULL) + return; + + osmo_timer_del(&suart->rx.timer); + msgb_free(suart->rx.msg); + + talloc_free((void *)suart->name); + talloc_free(suart); +} + /*! change soft-UART configuration to user-provided config */ int osmo_soft_uart_configure(struct osmo_soft_uart *suart, const struct osmo_soft_uart_cfg *cfg) { -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35018?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: I2fdcf6116144d8f16cf4167c37cfa7215d16337f Gerrit-Change-Number: 35018 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-MessageType: merged

1 year, 7 months

1
0
0 0

[S] Change in libosmocore[master]: soft_uart: add doxygen documentation

by laforge

laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35019?usp=email ) Change subject: soft_uart: add doxygen documentation ...................................................................... soft_uart: add doxygen documentation Change-Id: Ib0dcea0c35619bda5626cf75044000951b26485b Related: OS#4396 --- M src/core/soft_uart.c 1 file changed, 42 insertions(+), 6 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved jolly: Looks good to me, but someone else must approve diff --git a/src/core/soft_uart.c b/src/core/soft_uart.c index 7860453..e6dfe3d 100644 --- a/src/core/soft_uart.c +++ b/src/core/soft_uart.c @@ -26,7 +26,7 @@ #include <osmocom/core/timer.h> #include <osmocom/core/soft_uart.h> -/*! one instance of a soft-uart */ +/*! Internal state of a soft-UART */ struct osmo_soft_uart { struct osmo_soft_uart_cfg cfg; const char *name; @@ -49,6 +49,7 @@ } tx; }; +/*! Default soft-UART configuration (8-N-1) */ static struct osmo_soft_uart_cfg suart_default_cfg = { .num_data_bits = 8, .num_stop_bits = 1, @@ -154,7 +155,11 @@ suart_flush_rx(suart); } -/*! feed a number of unpacked bits into the soft-uart receiver */ +/*! Feed a number of unpacked bits into the soft-UART receiver. + * \param[in] suart soft-UART instance to feed bits into. + * \param[in] ubits pointer to the unpacked bits. + * \param[in] n_ubits number of unpacked bits to be fed. + * \returns 0 on success; negative on error. */ int osmo_soft_uart_rx_ubits(struct osmo_soft_uart *suart, const ubit_t *ubits, size_t n_ubits) { for (size_t i = 0; i < n_ubits; i++) @@ -166,7 +171,9 @@ * Transmitter *************************************************************************/ -/*! enqueue the given message buffer into the transmit queue of the UART. */ +/*! Enqueue the given message buffer into the transmit queue of the soft-UART. + * \param[in] suart soft-UART instance for transmitting data. + * \param[in] tx_data message buffer containing to be transmitted data. */ void osmo_soft_uart_tx(struct osmo_soft_uart *suart, struct msgb *tx_data) { if (!suart->tx.msg) @@ -189,7 +196,11 @@ return 1; } -/*! pull then number of specified unpacked bits out of the UART Transmitter */ +/*! Pull a number of unpacked bits out of the soft-UART transmitter. + * \param[in] suart soft-UART instance to pull the bits from. + * \param[out] ubits pointer to a buffer where to store pulled bits. + * \param[in] n_ubits number of unpacked bits to be pulled. + * \returns number of unpacked bits pulled; negative on error. */ int osmo_soft_uart_tx_ubits(struct osmo_soft_uart *suart, ubit_t *ubits, size_t n_ubits) { for (size_t i = 0; i < n_ubits; i++) @@ -197,7 +208,10 @@ return n_ubits; } -/*! Set the modem status lines of the UART */ +/*! Set the modem status lines of the given soft-UART. + * \param[in] suart soft-UART instance to update the modem status. + * \param[in] status mask of osmo_soft_uart_status. + * \returns 0 on success; negative on error. */ int osmo_soft_uart_set_status(struct osmo_soft_uart *suart, unsigned int status) { /* FIXME: Tx */ @@ -209,6 +223,10 @@ * Management / Initialization *************************************************************************/ +/*! Allocate a soft-UART instance. + * \param[in] ctx parent talloc context. + * \param[in] name name of the soft-UART instance. + * \returns pointer to allocated soft-UART instance; NULL on error. */ struct osmo_soft_uart *osmo_soft_uart_alloc(void *ctx, const char *name) { struct osmo_soft_uart *suart = talloc_zero(ctx, struct osmo_soft_uart); @@ -234,7 +252,10 @@ talloc_free(suart); } -/*! change soft-UART configuration to user-provided config */ +/*! Change soft-UART configuration to the user-provided config. + * \param[in] suart soft-UART instance to be re-configured. + * \param[in] cfg the user-provided config to be applied. + * \returns 0 on success; negative on error. */ int osmo_soft_uart_configure(struct osmo_soft_uart *suart, const struct osmo_soft_uart_cfg *cfg) { /* consistency checks on the configuration */ @@ -260,6 +281,11 @@ return 0; } +/*! Enable/disable receiver and/or transmitter of the given soft-UART. + * \param[in] suart soft-UART instance to be re-configured. + * \param[in] rx enable/disable state of the receiver. + * \param[in] tx enable/disable state of the transmitter. + * \returns 0 on success; negative on error. */ int osmo_soft_uart_enable(struct osmo_soft_uart *suart, bool rx, bool tx) { if (!rx && suart->rx.running) { -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35019?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: Ib0dcea0c35619bda5626cf75044000951b26485b Gerrit-Change-Number: 35019 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-MessageType: merged

1 year, 7 months

1
0
0 0

[L] Change in libosmocore[master]: core: Add software UART implementation

by laforge

laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/30763?usp=email ) Change subject: core: Add software UART implementation ...................................................................... core: Add software UART implementation This patch brings a Work-in-Progress implementation of the software UART (Universal Asynchronous Receiver/Transmitter) to libosmocore. Not only it will be useful in the context of retro-networking, but also it's needed for the MS-side CSD implementation (see OS#4396). It should be noted that the definition of struct osmo_soft_uart is intentionally kept private, since the API is not stable yet. Currently, the following limitations apply: * Only the receiver part is implemented, the transmitter is TBD. * Parity checking is not implemented in the receiver part. * Software flow control is not implemented. These missing components will be addressed in subsequent patches. Change-Id: I2ca95963fd5852ddb89bdd35b86b31489127fe84 --- M include/osmocom/core/Makefile.am A include/osmocom/core/soft_uart.h M src/core/Makefile.am M src/core/libosmocore.map A src/core/soft_uart.c 5 files changed, 388 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved diff --git a/include/osmocom/core/Makefile.am b/include/osmocom/core/Makefile.am index e1b52d5..7c29ca1 100644 --- a/include/osmocom/core/Makefile.am +++ b/include/osmocom/core/Makefile.am @@ -60,6 +60,7 @@ utils.h \ write_queue.h \ sockaddr_str.h \ + soft_uart.h \ time_cc.h \ use_count.h \ socket_compat.h \ diff --git a/include/osmocom/core/soft_uart.h b/include/osmocom/core/soft_uart.h new file mode 100644 index 0000000..36a43fe --- /dev/null +++ b/include/osmocom/core/soft_uart.h @@ -0,0 +1,85 @@ +#pragma once + +/*! \file soft_uart.h + * Software UART implementation. */ +/* + * (C) 2022 by Harald Welte <laforge(a)gnumonks.org> + * + * All Rights Reserved + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + */ + +#include <stdint.h> +#include <osmocom/core/bits.h> +#include <osmocom/core/msgb.h> + +enum osmo_soft_uart_parity_mode { + OSMO_SUART_PARITY_NONE, + OSMO_SUART_PARITY_EVEN, + OSMO_SUART_PARITY_ODD, + _OSMO_SUART_PARITY_NUM +}; + +enum osmo_soft_uart_flags { + OSMO_SUART_F_FRAMING_ERROR = (1 << 0), + OSMO_SUART_F_PARITY_ERROR = (1 << 1), + OSMO_SUART_F_BREAK = (1 << 2), +}; + +#if 0 +enum osmo_soft_uart_status { + /* RTS, CTS, ... */ + _fixme, +}; +#endif + +/* configuration for a soft-uart */ +struct osmo_soft_uart_cfg { + /*! number of data bits (typically 5, 6, 7 or 8) */ + uint8_t num_data_bits; + /*! number of stop bots (typically 1 or 2) */ + uint8_t num_stop_bits; + /*! parity mode (none, even, odd) */ + enum osmo_soft_uart_parity_mode parity_mode; + /*! size of receive buffer; UART will buffer up to that number of characters + * before calling the receive call-back */ + unsigned int rx_buf_size; + /*! receive timeout; UART will flush receive buffer via the receive call-back + * after indicated number of milli-seconds even if it is not full yet */ + unsigned int rx_timeout_ms; + + /*! opaque application-private data; passed to call-backs */ + void *priv; + + /*! receive call-back. Either rx_buf_size characters were received or rx_timeout_ms + * expired, or an error flag was detected (related to last byte received). + * 'flags' is a bit-mask of osmo_soft_uart_flags, */ + void (*rx_cb)(void *priv, struct msgb *rx_data, unsigned int flags); + + /*! modem status line change call-back. gets bitmask of osmo_soft_uart_status */ + void (*status_change_cb)(void *priv, unsigned int status); +}; + +struct osmo_soft_uart; + +struct osmo_soft_uart *osmo_soft_uart_alloc(void *ctx, const char *name); +int osmo_soft_uart_configure(struct osmo_soft_uart *suart, const struct osmo_soft_uart_cfg *cfg); +int osmo_soft_uart_enable(struct osmo_soft_uart *suart, bool rx, bool tx); + +int osmo_soft_uart_rx_ubits(struct osmo_soft_uart *suart, const ubit_t *ubits, size_t n_ubits); +int osmo_soft_uart_tx_ubits(struct osmo_soft_uart *suart, ubit_t *ubits, size_t n_ubits); + +void osmo_soft_uart_tx(struct osmo_soft_uart *suart, struct msgb *tx_data); +int osmo_soft_uart_set_status(struct osmo_soft_uart *suart, unsigned int status); diff --git a/src/core/Makefile.am b/src/core/Makefile.am index 326c68d..2efebd8 100644 --- a/src/core/Makefile.am +++ b/src/core/Makefile.am @@ -63,6 +63,7 @@ signal.c \ sockaddr_str.c \ socket.c \ + soft_uart.c \ stat_item.c \ stats.c \ stats_statsd.c \ diff --git a/src/core/libosmocore.map b/src/core/libosmocore.map index e5f8bd8..c08d3ff 100644 --- a/src/core/libosmocore.map +++ b/src/core/libosmocore.map @@ -439,6 +439,13 @@ osmo_sock_set_priority; osmo_sock_unix_init; osmo_sock_unix_init_ofd; +osmo_soft_uart_alloc; +osmo_soft_uart_configure; +osmo_soft_uart_enable; +osmo_soft_uart_rx_ubits; +osmo_soft_uart_tx_ubits; +osmo_soft_uart_tx; +osmo_soft_uart_set_status; osmo_stat_item_dec; osmo_stat_item_flush; osmo_stat_item_for_each_group; diff --git a/src/core/soft_uart.c b/src/core/soft_uart.c new file mode 100644 index 0000000..22292af --- /dev/null +++ b/src/core/soft_uart.c @@ -0,0 +1,268 @@ +/*! \file soft_uart.c + * Software UART implementation. */ +/* + * (C) 2022 by Harald Welte <laforge(a)gnumonks.org> + * + * All Rights Reserved + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + */ + +#include <stdbool.h> +#include <stdint.h> +#include <errno.h> + +#include <osmocom/core/timer.h> +#include <osmocom/core/soft_uart.h> + +/*! one instance of a soft-uart */ +struct osmo_soft_uart { + struct osmo_soft_uart_cfg cfg; + const char *name; + struct { + bool running; + uint8_t bit_count; + uint8_t shift_reg; + struct msgb *msg; + ubit_t parity_bit; + unsigned int flags; + unsigned int status; + struct osmo_timer_list timer; + } rx; + struct { + bool running; + uint8_t bit_count; + uint8_t shift_reg; + struct msgb *msg; + struct llist_head queue; + } tx; +}; + +static struct osmo_soft_uart_cfg suart_default_cfg = { + .num_data_bits = 8, + .num_stop_bits = 1, + .parity_mode = OSMO_SUART_PARITY_NONE, + .rx_buf_size = 1024, + .rx_timeout_ms = 100, + .priv = NULL, + .rx_cb = NULL, + .status_change_cb = NULL, +}; + +/************************************************************************* + * Receiver + *************************************************************************/ + +/* flush the receive buffer + allocate new one, as needed */ +static void suart_flush_rx(struct osmo_soft_uart *suart) +{ + if ((suart->rx.msg && msgb_length(suart->rx.msg)) || suart->rx.flags) { + osmo_timer_del(&suart->rx.timer); + if (suart->cfg.rx_cb) { + suart->cfg.rx_cb(suart->cfg.priv, suart->rx.msg, suart->rx.flags); + /* call-back has taken ownership of msgb, no need to free() here */ + suart->rx.msg = msgb_alloc_c(suart, suart->cfg.rx_buf_size, "soft_uart rx"); + } else { + msgb_reset(suart->rx.msg); + } + } +} + +/* one character was received; add to receive buffer and notify user, if needed */ +static void suart_rx_ch(struct osmo_soft_uart *suart, uint8_t ch) +{ + unsigned int msg_len; + + OSMO_ASSERT(suart->rx.msg); + msgb_put_u8(suart->rx.msg, ch); + msg_len = msgb_length(suart->rx.msg); + + /* first character in new message: start timer */ + if (msg_len == 1) { + osmo_timer_schedule(&suart->rx.timer, suart->cfg.rx_timeout_ms / 1000, + (suart->cfg.rx_timeout_ms % 1000) * 1000); + } else if (msg_len >= suart->cfg.rx_buf_size || suart->rx.flags) { + suart_flush_rx(suart); + } +} + +/* receive a single bit */ +static inline void osmo_uart_rx_bit(struct osmo_soft_uart *suart, const ubit_t bit) +{ + unsigned int num_parity_bits = 0; + + if (!suart->rx.running) + return; + + if (suart->rx.bit_count == 0) { + /* start bit is 0. Wait if there is none */ + if (bit == 0) { + /* START bit */ + suart->rx.flags = 0; + suart->rx.shift_reg = 0; + suart->rx.bit_count++; + } + return; + } + + if (suart->cfg.parity_mode != OSMO_SUART_PARITY_NONE) + num_parity_bits = 1; + + suart->rx.bit_count++; + if (suart->rx.bit_count <= 1 + suart->cfg.num_data_bits) { + /* DATA bit */ + suart->rx.shift_reg = suart->rx.shift_reg >> 1; + if (bit) + suart->rx.shift_reg |= 0x80; + } else if (suart->cfg.parity_mode != OSMO_SUART_PARITY_NONE && + suart->rx.bit_count == 1 + suart->cfg.num_data_bits + 1) { + /* PARITY bit */ + suart->rx.parity_bit = bit; + /* TODO: verify parity */ + //suart->rx.flags |= OSMO_SUART_F_PARITY_ERROR; + } else if (suart->rx.bit_count <= + 1 + suart->cfg.num_data_bits + num_parity_bits + suart->cfg.num_stop_bits) { + /* STOP bit */ + if (bit != 1) { + fprintf(stderr, "framing error: stop bit %u != 1\n", suart->rx.bit_count); + suart->rx.flags |= OSMO_SUART_F_FRAMING_ERROR; + } + + if (suart->rx.bit_count == 1 + suart->cfg.num_data_bits + num_parity_bits + suart->cfg.num_stop_bits) { + //printf("Rx: 0x%02x %c\n", suart->rx.shift_reg, suart->rx.shift_reg); + suart_rx_ch(suart, suart->rx.shift_reg); + suart->rx.bit_count = 0; + } + } +} + +/* receive timer expiration: flush rx-buffer to user call-back */ +static void suart_rx_timer_cb(void *data) +{ + struct osmo_soft_uart *suart = data; + suart_flush_rx(suart); +} + +/*! feed a number of unpacked bits into the soft-uart receiver */ +int osmo_soft_uart_rx_ubits(struct osmo_soft_uart *suart, const ubit_t *ubits, size_t n_ubits) +{ + for (size_t i = 0; i < n_ubits; i++) + osmo_uart_rx_bit(suart, ubits[i]); + return 0; +} + +/************************************************************************* + * Transmitter + *************************************************************************/ + +/*! enqueue the given message buffer into the transmit queue of the UART. */ +void osmo_soft_uart_tx(struct osmo_soft_uart *suart, struct msgb *tx_data) +{ + if (!suart->tx.msg) + suart->tx.msg = tx_data; + else + msgb_enqueue(&suart->tx.queue, tx_data); +} + +/* pull a single bit out of the UART transmitter */ +static inline ubit_t osmo_uart_tx_bit(struct osmo_soft_uart *suart) +{ + if (!suart->tx.running) + return 1; + + if (suart->tx.bit_count == 0) { + /* do we have anything to transmit? */ + /* FIXME */ + } + /* FIXME */ + return 1; +} + +/*! pull then number of specified unpacked bits out of the UART Transmitter */ +int osmo_soft_uart_tx_ubits(struct osmo_soft_uart *suart, ubit_t *ubits, size_t n_ubits) +{ + for (size_t i = 0; i < n_ubits; i++) + ubits[i] = osmo_uart_tx_bit(suart); + return n_ubits; +} + +/*! Set the modem status lines of the UART */ +int osmo_soft_uart_set_status(struct osmo_soft_uart *suart, unsigned int status) +{ + /* FIXME: Tx */ + return 0; +} + + +/************************************************************************* + * Management / Initialization + *************************************************************************/ + +struct osmo_soft_uart *osmo_soft_uart_alloc(void *ctx, const char *name) +{ + struct osmo_soft_uart *suart = talloc_zero(ctx, struct osmo_soft_uart); + if (!suart) + return NULL; + suart->name = talloc_strdup(suart, name); + suart->cfg = suart_default_cfg; + + return suart; +} + +/*! change soft-UART configuration to user-provided config */ +int osmo_soft_uart_configure(struct osmo_soft_uart *suart, const struct osmo_soft_uart_cfg *cfg) +{ + /* consistency checks on the configuration */ + if (cfg->num_data_bits > 8 || cfg->num_data_bits == 0) + return -EINVAL; + if (cfg->num_stop_bits == 0) + return -EINVAL; + if (cfg->parity_mode < 0 || cfg->parity_mode >= _OSMO_SUART_PARITY_NUM) + return -EINVAL; + if (cfg->rx_buf_size == 0) + return -EINVAL; + + if (suart->cfg.rx_buf_size > cfg->rx_buf_size || + suart->cfg.rx_timeout_ms > cfg->rx_timeout_ms) { + suart_flush_rx(suart); + } + + suart->cfg = *cfg; + + osmo_timer_setup(&suart->rx.timer, suart_rx_timer_cb, suart); + INIT_LLIST_HEAD(&suart->tx.queue); + + return 0; +} + +int osmo_soft_uart_enable(struct osmo_soft_uart *suart, bool rx, bool tx) +{ + if (!rx && suart->rx.running) { + suart_flush_rx(suart); + suart->rx.running = false; + } else if (rx && !suart->rx.running) { + if (!suart->rx.msg) + suart->rx.msg = msgb_alloc_c(suart, suart->cfg.rx_buf_size, "soft_uart rx"); + suart->rx.running = true; + } + + if (!tx && suart->tx.running) { + /* FIXME: Tx */ + suart->tx.running = false; + } else if (tx && !suart->tx.running) { + suart->tx.running = true; + } + + return 0; +} -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/30763?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: I2ca95963fd5852ddb89bdd35b86b31489127fe84 Gerrit-Change-Number: 30763 Gerrit-PatchSet: 4 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-CC: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-MessageType: merged

1 year, 7 months

1
0
0 0

[M] Change in libosmocore[master]: soft_uart: implement the transmitter

by laforge

Attention is currently required from: fixeria, jolly. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35044?usp=email ) Change subject: soft_uart: implement the transmitter ...................................................................... Patch Set 5: Code-Review+2 (1 comment) Patchset: PS5: no change from v4, which already had two +1 -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35044?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: Ibcd9643227e5616efd8bbd7a1430feda6fcef45c Gerrit-Change-Number: 35044 Gerrit-PatchSet: 5 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: jolly <andreas(a)eversberg.eu> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Tue, 21 Nov 2023 11:45:51 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 7 months

1
0
0 0

[S] Change in libosmocore[master]: soft_uart: implement parity checking for the receiver

by laforge

Attention is currently required from: fixeria. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35023?usp=email ) Change subject: soft_uart: implement parity checking for the receiver ...................................................................... Patch Set 4: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35023?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: I28be2ca19d423447a718fb518566d52ae1967ec7 Gerrit-Change-Number: 35023 Gerrit-PatchSet: 4 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Tue, 21 Nov 2023 11:45:17 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 7 months

1
0
0 0

[M] Change in libosmocore[master]: soft_uart: rework osmo_uart_rx_bit() to use flow state

by laforge

Attention is currently required from: fixeria. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35022?usp=email ) Change subject: soft_uart: rework osmo_uart_rx_bit() to use flow state ...................................................................... Patch Set 4: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35022?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: I40ab5d12b6f7087daa51405468f5c4ea639561ea Gerrit-Change-Number: 35022 Gerrit-PatchSet: 4 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Tue, 21 Nov 2023 11:45:12 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 7 months

1
0
0 0

[S] Change in libosmocore[master]: soft_uart: make osmo_soft_uart_alloc() accept *cfg

by laforge

Attention is currently required from: fixeria. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35021?usp=email ) Change subject: soft_uart: make osmo_soft_uart_alloc() accept *cfg ...................................................................... Patch Set 4: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35021?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: I7e78d60c747a8805064d5e4bacfd47a30bc65cba Gerrit-Change-Number: 35021 Gerrit-PatchSet: 4 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Tue, 21 Nov 2023 11:45:04 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 7 months

1
0
0 0

[S] Change in libosmocore[master]: soft_uart: split osmo_soft_uart_enable()

by laforge

Attention is currently required from: fixeria. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35020?usp=email ) Change subject: soft_uart: split osmo_soft_uart_enable() ...................................................................... Patch Set 3: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35020?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: Ieacc7e639304eeb14fdb298c7e14d772c136ca6e Gerrit-Change-Number: 35020 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Tue, 21 Nov 2023 11:44:50 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 7 months

1
0
0 0

[S] Change in libosmocore[master]: soft_uart: add doxygen documentation

by laforge

Attention is currently required from: fixeria. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/libosmocore/+/35019?usp=email ) Change subject: soft_uart: add doxygen documentation ...................................................................... Patch Set 3: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/35019?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: Ib0dcea0c35619bda5626cf75044000951b26485b Gerrit-Change-Number: 35019 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Tue, 21 Nov 2023 11:44:47 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 7 months

1
0
0 0

2025

2024

2023

2022

gerrit-log November 2023