pio_tx_rx_driver.h

Go to the documentation of this file.

 
 
/*
 * ether2ser - Ethernet <-> synchronous V.24 (RS-232/V.28) bridge
 *
 * File:    src/drivers/pio_tx_rx_driver.h
 * Purpose: PIO TX clock driver API and baudrate definitions.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright (c) 2026 Florian <f.leuze@outlook.de>
 */
 
#ifndef PIO_TX_RX_DRIVER_H
#define PIO_TX_RX_DRIVER_H
// Related headers
 
// Standard library headers
#include <stdbool.h>
#include <stdint.h>
 
// Library Headers
#include "hardware/pio.h"
 
// Project Headers
#include "drivers/gpio_driver.h"
#include "drivers/v24_config.h"
 
// Generated headers
 
typedef struct
{
    uint32_t      tx_rts_holdoff_us;
    bool          rts_set;
    PIO           tx_pio;
    uint          tx_sm;
    PIO           rx_pio;
    uint          rx_sm;
    bool          tx_clock_forced_low;
    volatile uint32_t cts_toggle_seq;
} v24_runtime_t;
 
void tx_clock_init(PIO pio, uint pio_sm, V24_CONFIG_T* config);
 
bool tx_poll(void);
 
bool tx_put(uint8_t data);
 
void rx_clock_init(PIO pio, uint pio_sm, V24_RX_POLARITIES_T* polarities);
 
bool rx_get(uint8_t* data);
 
void init_v24_config(V24_CONFIG_T* config, V24_BAUDRATE_T baudrate);
 
void reinit_v24_config(V24_CONFIG_T* config, V24_BAUDRATE_T baudrate);
 
void led_mirror_init(void);
 
void tx_clock_update_settings(V24_CONFIG_T* config);
 
void rx_clock_update_settings(V24_RX_POLARITIES_T* polarities);
 
const v24_runtime_t* get_v24_runtime(void);
 
uint32_t tx_clock_get_cts_toggle_seq(void);
 
void tx_clock_hard_reset(void);
 
void rx_clock_hard_reset(void);
 
bool rx_clock_poll_stall(void);
 
#endif /* PIO_TX_RX_DRIVER_H */