ethernet.h

Go to the documentation of this file.

#ifndef NEXUS_IO_ETHERNET_H
#define NEXUS_IO_ETHERNET_H
#include "nexus/core/request.h"
#include "nexus/io/wake.h"
#ifdef __cplusplus
extern "C" {
#endif
#define NX_ETH_FRAME_MIN       14U
#define NX_ETH_FRAME_MAX       1514U
#define NX_ETH_RX_STORAGE_MIN  1518U
#define NX_ETH_RX_CRC          1U
#define NX_ETH_RX_LENGTH       2U
#define NX_ETH_RX_FRAGMENT     4U
#define NX_ETH_RX_UNSUPPORTED  8U
#define NX_ETH_RX_DMA_ERROR    16U
#define NX_ETH_RX_BACKPRESSURE 32U
typedef struct {
    nx_request_t base;
    const uint8_t* data;
    size_t length;
} nx_eth_tx_request_t;

typedef struct {
    bool up;
    bool full_duplex;
    uint16_t speed_mbps;
} nx_eth_link_t;

typedef struct {
    const uint8_t* data;
    size_t length;
    size_t slot;
    const void* identity;
    uint64_t epoch;
    nx_time_us_t timestamp_us;
} nx_eth_rx_frame_t;

typedef struct {
    nx_eth_link_t link;
    uint64_t received;
    uint64_t discarded;
    uint64_t unavailable_events;
    uint32_t receive_flags;
    size_t pending_tx;
    size_t held_rx;
    bool started;
    bool closing;
    bool fatal_bus_error;
    bool transmit_underflow;
} nx_eth_state_t;
typedef struct {
    nx_result_t (*submit)(void*, nx_eth_tx_request_t*);
    nx_result_t (*cancel)(void*, nx_eth_tx_request_t*);
    nx_result_t (*service)(void*);
    nx_result_t (*acquire)(void*, nx_eth_rx_frame_t*);
    nx_result_t (*release)(void*, const nx_eth_rx_frame_t*);
    nx_result_t (*state)(void*, nx_eth_state_t*);
    nx_result_t (*apply_link)(void*, const nx_eth_link_t*);
    nx_result_t (*stop)(void*);
    nx_result_t (*attach_wake)(void*, const nx_irq_wake_t*, uint8_t);
} nx_eth_ops_t;
typedef struct {
    const nx_eth_ops_t* ops;
    void* context;
} nx_eth_port_t;

nx_result_t nx_eth_tx_prepare(nx_eth_tx_request_t* request, const void* data,
                              size_t length, nx_time_us_t deadline);
nx_result_t nx_eth_port_submit(const nx_eth_port_t* port,
                               nx_eth_tx_request_t* request);
nx_result_t nx_eth_port_cancel(const nx_eth_port_t* port,
                               nx_eth_tx_request_t* request);
nx_result_t nx_eth_port_service(const nx_eth_port_t* port);
nx_result_t nx_eth_port_acquire(const nx_eth_port_t* port,
                                nx_eth_rx_frame_t* frame);
nx_result_t nx_eth_port_release(const nx_eth_port_t* port,
                                const nx_eth_rx_frame_t* frame);
nx_result_t nx_eth_port_state(const nx_eth_port_t* port, nx_eth_state_t* state);
nx_result_t nx_eth_port_apply_link(const nx_eth_port_t* port,
                                   const nx_eth_link_t* link);
nx_result_t nx_eth_port_stop(const nx_eth_port_t* port);
nx_result_t nx_eth_port_attach_wake(const nx_eth_port_t* port,
                                    const nx_irq_wake_t* wake,
                                    uint8_t syscall_ceiling);
#ifdef __cplusplus
}
#endif
#endif