tx_queue.h

Go to the documentation of this file.

/*
 * ether2ser - Ethernet <-> synchronous V.24 (RS-232/V.28) bridge
 *
 * File:    src/drivers/tx_queue.h
 * Purpose: TX queue API for buffered HDLC frames.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright (c) 2026 Florian <f.leuze@outlook.de>
 */
 
#ifndef TX_QUEUE_H
#define TX_QUEUE_H
 
// Related headers
 
// Standard library headers
#include <stdbool.h>
#include <stdint.h>
 
// Project Headers
#include "drivers/w5500_driver.h"
#include "protocol/hdlc_common.h"
#include "system/error.h"
#include "system/ringbuffer.h"
 
// Generated headers
 
#define TX_FRAME_QUEUE_SIZE 64
 
#define TX_FRAME_MAX_SIZE_BYTE 2048
 
#define TX_QUEUE_DECLARE_AND_INIT(var_name)                                            \
    TX_QUEUE_T var_name;                                                               \
    uint8_t    var_name##_buffer_data[TX_FRAME_QUEUE_SIZE * sizeof(TX_QUEUE_ENTRY_T)]; \
    Ringbuffer var_name##_ringbuf;                                                     \
    RbInit(&var_name##_ringbuf, var_name##_buffer_data, TX_FRAME_QUEUE_SIZE,           \
           sizeof(TX_QUEUE_ENTRY_T));                                                  \
    tx_queue_init(&var_name, &var_name##_ringbuf)
 
typedef struct
{
    uint8_t payload[TX_FRAME_MAX_SIZE_BYTE]; // TODO: This has to be tested on the target
    HDLC_FRAME_T frame;
    size_t offset;
} TX_QUEUE_ENTRY_T;
 
typedef struct
{
    TX_QUEUE_ENTRY_T current_entry;
    Ringbuffer queue_buffer;
    bool queue_touched;
    uint64_t tx_wire_bytes;
    uint32_t current_frame_cts_seq_start;
    bool     current_frame_cts_seq_valid;
} TX_QUEUE_T;
 
e2s_error_t tx_queue_enqueue_udp_frame(TX_QUEUE_T* queue, const UDP_FRAME_T* frame);
 
bool tx_queue_is_empty(TX_QUEUE_T* queue);
 
e2s_error_t tx_queue_drain(TX_QUEUE_T* queue, size_t bytes_to_drain, size_t* bytes_drained);
 
e2s_error_t poll_queue_stats(TX_QUEUE_T* queue);
 
e2s_error_t tx_queue_init(TX_QUEUE_T* queue, uint8_t* buffer_data);
 
size_t tx_queue_get_count(const TX_QUEUE_T* queue);
 
#endif /* TX_QUEUE_H */