ra8_eth.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"

typedef void (*ra8_eth_event_fn_t)(void* ctx, uint32_t status_mask);

[[nodiscard]] ra8_err_t ra8_eth_init(void);

[[nodiscard]] ra8_err_t ra8_eth_deinit(void);

[[nodiscard]] ra8_err_t ra8_eth_get_status(uint32_t* out_mask);

[[nodiscard]] ra8_err_t ra8_eth_clear_status(uint32_t mask);

void ra8_eth_attach_handler(ra8_eth_event_fn_t fn, void* ctx);

void ra8_eth_dispatch(void);

[[nodiscard]] ra8_err_t ra8_eth_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_eth_exit_stop(void);

typedef enum : uint8_t {
  k_ra8_eth_mii_port_0     = 0U, 
  k_ra8_eth_mii_port_1     = 1U, 
  k_ra8_eth_mii_port_count = 2U, 
} ra8_eth_mii_port_t;

[[nodiscard]] ra8_err_t ra8_eth_rgmii_select(ra8_eth_mii_port_t port);
 
/* -----------------------------------------------------------------------
 * Frame-level NIC API (FSP r_ether shape).
 * -------------------------------------------------------------------- */

typedef enum : uint16_t {
  k_ra8_eth_num_tx_desc = 8U,    
  k_ra8_eth_num_rx_desc = 8U,    
  k_ra8_eth_buf_size    = 1536U, 
  k_ra8_eth_mac_len     = 6U,    
  k_ra8_eth_desc_align  = 16U,   
  k_ra8_eth_min_frame   = 60U,   
  k_ra8_eth_max_frame   = 1514U, 
} ra8_eth_limits_t;

typedef struct {
  uint8_t  mac_address[6];     
  uint8_t  channel;            
  uint16_t num_tx_descriptors; 
  uint16_t num_rx_descriptors; 
  uint16_t buffer_size;        
} ra8_eth_cfg_t;

typedef struct {
  uint8_t  link_up;     
  uint16_t speed_mbps;  
  uint8_t  full_duplex; 
  uint16_t bmsr;        
} ra8_eth_link_t;

typedef struct {
  uint32_t tx_ok;  
  uint32_t rx_ok;  
  uint32_t tx_err; 
  uint32_t rx_err; 
} ra8_eth_stats_t;

[[nodiscard]] ra8_err_t ra8_eth_open(const ra8_eth_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_eth_close(void);

[[nodiscard]] ra8_err_t ra8_eth_write(const uint8_t* buf, uint32_t len);

[[nodiscard]] ra8_err_t ra8_eth_read(uint8_t* buf, uint32_t max_len, uint32_t* got_len);

[[nodiscard]] ra8_err_t ra8_eth_link_status(ra8_eth_link_t* out_status);

[[nodiscard]] ra8_err_t ra8_eth_get_stats(ra8_eth_stats_t* out_stats);
 
#ifdef UNIT_TEST
[[nodiscard]] ra8_err_t ra8_eth_test_inject_rx(const uint8_t* payload, uint32_t len);
#endif /* UNIT_TEST */
 
#ifdef __cplusplus
}
#endif