event_queue.h

Go to the documentation of this file.

/*
 * ether2ser — Ethernet <-> synchronous V.24 (RS-232/V.28) bridge
 *
 * File:    src/system/event_queue.h
 * Purpose: Event queue API with opaque payload pointers.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright (c) 2026 Florian <f.leuze@outlook.de>
 */
 
#ifndef SYSTEM_EVENT_QUEUE_H
#define SYSTEM_EVENT_QUEUE_H
 
// Related headers
 
// Standard library headers
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
// Project Headers
#include "drivers/v24_config.h"
 
// Generated headers
#define EVENT_QUEUE_CAPACITY 16
 
typedef enum
{
    EV_NONE = 0,
    EV_CLI_LINE,
    EV_UDP_RX,
    EV_UDP_TX,
    EV_HDLC_DECODE,
    EV_SAVE_CONFIG,
    EV_STATUS,
    EV_MEM,
    EV_WIPE_CONFIG,
    EV_SET_NET_SETTINGS,
    EV_GET_NET_SETTINGS,
    EV_SET_V24_SETTINGS,
    EV_GET_V24_SETTINGS,
    EV_REBOOT
} event_type_t;
 
typedef enum
{
    NET_IP_REMOTE,
    NET_IP_GATEWAY,
    NET_IP_LOCAL,
    NET_IP_MASK,
    NET_PORT_LOCAL,
    NET_PORT_REMOTE,
    V24_BAUDRATE,
    V24_POLARITIES,
    V24_CLOCK_MODE,
    SYS_REBOOT
} event_queue_data_types_t;
 
typedef struct
{
    event_queue_data_types_t id;
    union
    {
        uint8_t          ip[4];
        uint16_t         port;
        V24_POLARITIES_T polarities;
        V24_BAUDRATE_T   baudrate;
        bool             v24_clock_mode;
    } value;
} event_queue_data_t;
 
typedef struct
{
    event_type_t type;
    size_t data_len;
    union
    {
        const void* ptr;       // for large/external data
        uint8_t     bytes[16]; // for small inline data
    } data;
    bool is_inline;
} event_t;
 
void event_queue_init(void);
 
bool event_queue_push(const event_t* event_entry);
 
bool event_queue_pop(event_t* event_out);
 
bool event_queue_is_empty(void);
 
bool event_queue_is_full(void);
 
size_t event_queue_get_count(void);
 
size_t event_queue_get_high_water_mark(void);
 
uint32_t event_queue_get_push_drop_count(void);
 
bool event_get_payload_ptr(const event_t* event, size_t required_size, const void** out);
 
#endif /* SYSTEM_EVENT_QUEUE_H */