soft_uart.h

Go to the documentation of this file.

#pragma once
 
/*
 * (C) 2022 by Harald Welte <laforge@gnumonks.org>
 * (C) 2023 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
 *
 * 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 <stdbool.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_MARK,         
        OSMO_SUART_PARITY_SPACE,        
        _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),     
};
 
enum osmo_soft_uart_status {
        OSMO_SUART_STATUS_F_DTR         = (1 << 0),     
        OSMO_SUART_STATUS_F_DCD         = (1 << 1),     
        OSMO_SUART_STATUS_F_DSR         = (1 << 2),     
        OSMO_SUART_STATUS_F_RI          = (1 << 3),     
        OSMO_SUART_STATUS_F_RTS_RTR     = (1 << 4),     
        OSMO_SUART_STATUS_F_CTS         = (1 << 5),     
};
 
enum osmo_soft_uart_flow_ctrl_mode {
        OSMO_SUART_FLOW_CTRL_NONE,
        OSMO_SUART_FLOW_CTRL_DTR_DSR,
        OSMO_SUART_FLOW_CTRL_RTS_CTS,
};
 
struct osmo_soft_uart_cfg {
        uint8_t num_data_bits;
        uint8_t num_stop_bits;
        enum osmo_soft_uart_parity_mode parity_mode;
        unsigned int rx_buf_size;
        unsigned int rx_timeout_ms;
 
        void *priv;
 
        void (*rx_cb)(void *priv, struct msgb *rx_data, unsigned int flags);
 
        void (*tx_cb)(void *priv, struct msgb *tx_data);
 
        void (*status_change_cb)(void *priv, unsigned int status);
 
        enum osmo_soft_uart_flow_ctrl_mode flow_ctrl_mode;
};
 
extern const struct osmo_soft_uart_cfg osmo_soft_uart_default_cfg;
 
struct osmo_soft_uart;
 
struct osmo_soft_uart *osmo_soft_uart_alloc(void *ctx, const char *name,
                                            const struct osmo_soft_uart_cfg *cfg);
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);
 
const char *osmo_soft_uart_get_name(const struct osmo_soft_uart *suart);
void osmo_soft_uart_set_name(struct osmo_soft_uart *suart, const char *name);
 
int osmo_soft_uart_set_rx(struct osmo_soft_uart *suart, bool enable);
int osmo_soft_uart_set_tx(struct osmo_soft_uart *suart, bool enable);
 
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);
 
unsigned int osmo_soft_uart_get_status(const struct osmo_soft_uart *suart);
int osmo_soft_uart_set_status(struct osmo_soft_uart *suart, unsigned int status);
void osmo_soft_uart_set_status_line(struct osmo_soft_uart *suart,
                                    enum osmo_soft_uart_status line,
                                    bool active);
 
void osmo_soft_uart_flush_rx(struct osmo_soft_uart *suart);