libosmocore  1.10.0.2-2e788.202408152026
Osmocom core library
soft_uart.h
Go to the documentation of this file.
1 #pragma once
2 
5 /*
6  * (C) 2022 by Harald Welte <laforge@gnumonks.org>
7  * (C) 2023 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
8  *
9  * All Rights Reserved
10  *
11  * SPDX-License-Identifier: GPL-2.0+
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  */
24 
25 #include <stdint.h>
26 #include <stdbool.h>
27 
28 #include <osmocom/core/bits.h>
29 #include <osmocom/core/msgb.h>
30 
40 };
41 
46  OSMO_SUART_F_BREAK = (1 << 2),
47 };
48 
58 };
59 
73 };
74 
78  uint8_t num_data_bits;
80  uint8_t num_stop_bits;
85  unsigned int rx_buf_size;
88  unsigned int rx_timeout_ms;
89 
91  void *priv;
92 
104  void (*rx_cb)(void *priv, struct msgb *rx_data, unsigned int flags);
105 
114  void (*tx_cb)(void *priv, struct msgb *tx_data);
115 
119  void (*status_change_cb)(void *priv, unsigned int status);
120 
123 };
124 
126 
127 struct osmo_soft_uart;
128 
129 struct osmo_soft_uart *osmo_soft_uart_alloc(void *ctx, const char *name,
130  const struct osmo_soft_uart_cfg *cfg);
131 void osmo_soft_uart_free(struct osmo_soft_uart *suart);
132 int osmo_soft_uart_configure(struct osmo_soft_uart *suart, const struct osmo_soft_uart_cfg *cfg);
133 
134 const char *osmo_soft_uart_get_name(const struct osmo_soft_uart *suart);
135 void osmo_soft_uart_set_name(struct osmo_soft_uart *suart, const char *name);
136 
137 int osmo_soft_uart_set_rx(struct osmo_soft_uart *suart, bool enable);
138 int osmo_soft_uart_set_tx(struct osmo_soft_uart *suart, bool enable);
139 
140 int osmo_soft_uart_rx_ubits(struct osmo_soft_uart *suart, const ubit_t *ubits, size_t n_ubits);
141 int osmo_soft_uart_tx_ubits(struct osmo_soft_uart *suart, ubit_t *ubits, size_t n_ubits);
142 
143 unsigned int osmo_soft_uart_get_status(const struct osmo_soft_uart *suart);
144 int osmo_soft_uart_set_status(struct osmo_soft_uart *suart, unsigned int status);
146  enum osmo_soft_uart_status line,
147  bool active);
148 
149 void osmo_soft_uart_flush_rx(struct osmo_soft_uart *suart);
Osmocom bit level support code.
uint16_t flags
const char * name
uint8_t ubit_t
unpacked bit (0 or 1): 1 bit per byte
Definition: bits.h:24
int osmo_soft_uart_set_tx(struct osmo_soft_uart *suart, bool enable)
Enable/disable transmitter of the given soft-UART.
Definition: soft_uart.c:507
void osmo_soft_uart_set_status_line(struct osmo_soft_uart *suart, enum osmo_soft_uart_status line, bool active)
Activate/deactivate a modem status line of the given soft-UART.
Definition: soft_uart.c:387
void osmo_soft_uart_set_name(struct osmo_soft_uart *suart, const char *name)
Set a new name for the given soft-UART instance.
Definition: soft_uart.c:478
int osmo_soft_uart_set_rx(struct osmo_soft_uart *suart, bool enable)
Enable/disable receiver of the given soft-UART.
Definition: soft_uart.c:487
void osmo_soft_uart_flush_rx(struct osmo_soft_uart *suart)
Flush the receive buffer, passing ownership of the msgb to the .rx_cb().
Definition: soft_uart.c:80
void osmo_soft_uart_free(struct osmo_soft_uart *suart)
Release memory taken by the given soft-UART.
Definition: soft_uart.c:427
int osmo_soft_uart_tx_ubits(struct osmo_soft_uart *suart, ubit_t *ubits, size_t n_ubits)
Pull a number of unpacked bits out of the soft-UART transmitter.
Definition: soft_uart.c:298
const struct osmo_soft_uart_cfg osmo_soft_uart_default_cfg
Default soft-UART configuration (8-N-1)
Definition: soft_uart.c:65
osmo_soft_uart_status
Modem status "line" flags.
Definition: soft_uart.h:51
@ OSMO_SUART_STATUS_F_DCD
Data Carrier Detect.
Definition: soft_uart.h:53
@ OSMO_SUART_STATUS_F_DTR
Data Terminal Ready.
Definition: soft_uart.h:52
@ OSMO_SUART_STATUS_F_RTS_RTR
Request To Send or Ready To Receive.
Definition: soft_uart.h:56
@ OSMO_SUART_STATUS_F_DSR
Data Set Ready.
Definition: soft_uart.h:54
@ OSMO_SUART_STATUS_F_RI
Ring Indicator.
Definition: soft_uart.h:55
@ OSMO_SUART_STATUS_F_CTS
Clear To Send.
Definition: soft_uart.h:57
const char * osmo_soft_uart_get_name(const struct osmo_soft_uart *suart)
Get a name for the given soft-UART instance.
Definition: soft_uart.c:470
osmo_soft_uart_flow_ctrl_mode
Flow control mode.
Definition: soft_uart.h:62
@ OSMO_SUART_FLOW_CTRL_RTS_CTS
RTS/CTS flow control: Tx if CTS is active and drop RTS if cannot Rx anymore.
Definition: soft_uart.h:72
@ OSMO_SUART_FLOW_CTRL_NONE
No flow control.
Definition: soft_uart.h:64
@ OSMO_SUART_FLOW_CTRL_DTR_DSR
DTR/DSR flow control: Tx if DSR is active and drop DTR if cannot Rx anymore.
Definition: soft_uart.h:66
unsigned int osmo_soft_uart_get_status(const struct osmo_soft_uart *suart)
Get the modem status bitmask of the given soft-UART.
Definition: soft_uart.c:361
osmo_soft_uart_parity_mode
Parity mode.
Definition: soft_uart.h:33
@ _OSMO_SUART_PARITY_NUM
Definition: soft_uart.h:39
@ OSMO_SUART_PARITY_SPACE
Always 0.
Definition: soft_uart.h:38
@ OSMO_SUART_PARITY_EVEN
Even parity.
Definition: soft_uart.h:35
@ OSMO_SUART_PARITY_ODD
Odd parity.
Definition: soft_uart.h:36
@ OSMO_SUART_PARITY_MARK
Always 1.
Definition: soft_uart.h:37
@ OSMO_SUART_PARITY_NONE
No parity bit.
Definition: soft_uart.h:34
osmo_soft_uart_flags
Flags passed to the application.
Definition: soft_uart.h:43
@ OSMO_SUART_F_BREAK
Break condition (not implemented)
Definition: soft_uart.h:46
@ OSMO_SUART_F_PARITY_ERROR
Parity error occurred.
Definition: soft_uart.h:45
@ OSMO_SUART_F_FRAMING_ERROR
Framing error occurred.
Definition: soft_uart.h:44
int osmo_soft_uart_rx_ubits(struct osmo_soft_uart *suart, const ubit_t *ubits, size_t n_ubits)
Feed a number of unpacked bits into the soft-UART receiver.
Definition: soft_uart.c:200
struct osmo_soft_uart * osmo_soft_uart_alloc(void *ctx, const char *name, const struct osmo_soft_uart_cfg *cfg)
Allocate a soft-UART instance.
Definition: soft_uart.c:411
int osmo_soft_uart_set_status(struct osmo_soft_uart *suart, unsigned int status)
Set the modem status bitmask of the given soft-UART.
Definition: soft_uart.c:370
int osmo_soft_uart_configure(struct osmo_soft_uart *suart, const struct osmo_soft_uart_cfg *cfg)
Change soft-UART configuration to the user-provided config.
Definition: soft_uart.c:443
Osmocom message buffer.
Definition: msgb.h:31
Configuration for a soft-UART.
Definition: soft_uart.h:76
uint8_t num_stop_bits
Number of stop bits (typically 1 or 2).
Definition: soft_uart.h:80
enum osmo_soft_uart_parity_mode parity_mode
Parity mode (none, even, odd, space, mark).
Definition: soft_uart.h:82
void(* tx_cb)(void *priv, struct msgb *tx_data)
Transmit call-back of the application.
Definition: soft_uart.h:114
uint8_t num_data_bits
Number of data bits (typically 5, 6, 7 or 8).
Definition: soft_uart.h:78
enum osmo_soft_uart_flow_ctrl_mode flow_ctrl_mode
"Hardware" flow control mode.
Definition: soft_uart.h:122
void(* rx_cb)(void *priv, struct msgb *rx_data, unsigned int flags)
Receive call-back of the application.
Definition: soft_uart.h:104
unsigned int rx_buf_size
Size of the receive buffer; UART will buffer up to that number of characters before calling the recei...
Definition: soft_uart.h:85
void * priv
Opaque application-private data; passed to call-backs.
Definition: soft_uart.h:91
unsigned int rx_timeout_ms
Receive timeout; UART will flush the receive buffer via the receive call-back after indicated number ...
Definition: soft_uart.h:88
void(* status_change_cb)(void *priv, unsigned int status)
Modem status line change call-back.
Definition: soft_uart.h:119
Internal state of a soft-UART.
Definition: soft_uart.c:40
struct osmo_soft_uart_cfg cfg
Definition: soft_uart.c:41
unsigned int status
Definition: soft_uart.c:44