uart.h

Go to the documentation of this file.

#ifndef NEXUS_UART_H
#define NEXUS_UART_H
 
#include "nexus/core/request.h"
#include "nexus/io/stream.h"
#include "nexus/io/wake.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct nx_uart_port nx_uart_port_t;
typedef enum {
    NX_UART_RX_BYTES,
    NX_UART_RX_EVENTS,
    NX_UART_RX_BLOCKS
} nx_uart_rx_profile_t;
#define NX_UART_EVENT_PARITY  1u
#define NX_UART_EVENT_FRAMING 2u
#define NX_UART_EVENT_OVERRUN 4u
#define NX_UART_EVENT_NOISE   8u
#define NX_UART_EVENT_LOSS    16u
#define NX_UART_EVENT_NO_BYTE 32u
typedef struct {
    nx_time_us_t timestamp_us;
    uint32_t flags;
    uint8_t byte;
} nx_uart_rx_event_t;

typedef struct {
    nx_request_t base;
    const uint8_t* data;
    size_t length;
} nx_uart_tx_request_t;

typedef struct {
    nx_result_t (*submit)(void* context, nx_uart_tx_request_t* request);
    nx_result_t (*start_admitted)(void* context, nx_uart_tx_request_t* request);
    nx_result_t (*cancel)(void* context, nx_uart_tx_request_t* request);
    void (*service)(void* context);
    nx_result_t (*read_events)(void* context, nx_uart_rx_event_t* events,
                               size_t capacity, size_t* count);
    nx_result_t (*read_bytes)(void* context, uint8_t* bytes, size_t capacity,
                              size_t* count);
    nx_result_t (*stop)(void* context);
    nx_result_t (*attach_wake)(void* context, const nx_irq_wake_t* wake,
                               uint8_t syscall_ceiling);
    nx_result_t (*rx_start)(void* context, nx_stream_t* stream);
    nx_result_t (*rx_stop)(void* context);
} nx_uart_ops_t;

struct nx_uart_port {
    const nx_uart_ops_t* ops;
    void* context;
};

nx_result_t nx_uart_tx_prepare(nx_uart_tx_request_t* request,
                               const uint8_t* data, size_t length,
                               nx_time_us_t deadline);
nx_result_t nx_uart_port_submit(const nx_uart_port_t* port,
                                nx_uart_tx_request_t* request);
nx_result_t nx_uart_port_start_admitted(const nx_uart_port_t* port,
                                        nx_uart_tx_request_t* request);
nx_result_t nx_uart_port_cancel(const nx_uart_port_t* port,
                                nx_uart_tx_request_t* request);
void nx_uart_port_service(const nx_uart_port_t* port);
nx_result_t nx_uart_port_read_events(const nx_uart_port_t* port,
                                     nx_uart_rx_event_t* events,
                                     size_t capacity, size_t* count);
nx_result_t nx_uart_port_read_bytes(const nx_uart_port_t* port, uint8_t* bytes,
                                    size_t capacity, size_t* count);
nx_result_t nx_uart_port_stop(const nx_uart_port_t* port);
nx_result_t nx_uart_port_attach_wake(const nx_uart_port_t* port,
                                     const nx_irq_wake_t* wake,
                                     uint8_t syscall_ceiling);
nx_result_t nx_uart_port_rx_start(const nx_uart_port_t* port,
                                  nx_stream_t* stream);
nx_result_t nx_uart_port_rx_stop(const nx_uart_port_t* port);
#ifdef __cplusplus
}
#endif
 
#endif