ra8_rmac.h

Go to the documentation of this file.

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

typedef enum : uint32_t {
  k_ra8_rmac_mdc_default_hz = 1000000UL, 
  k_ra8_rmac_mdc_min_hz     = 100000UL,  
  k_ra8_rmac_mdc_psmcs_max  = 127UL,     
} ra8_rmac_mdc_clk_t;

typedef struct {
  ra8_rmac_mrafc_t  rx_filter;       
  uint32_t          err_irq_enable;  
  uint32_t          mon0_irq_enable; 
  uint32_t          mon1_irq_enable; 
  uint32_t          mon2_irq_enable; 
  ra8_rmac_pis_t    phy_interface;   
  ra8_rmac_lsc_t    link_speed;      
  ra8_rmac_duplex_t duplex;          
  uint32_t eswclk_hz;
  uint32_t mdc_hz;
} ra8_rmac_config_t;

typedef enum : uint8_t {
  k_ra8_rmac_phy_speed_unknown = 0U, 
  k_ra8_rmac_phy_speed_10_hd   = 1U, 
  k_ra8_rmac_phy_speed_10_fd   = 2U, 
  k_ra8_rmac_phy_speed_100_hd  = 3U, 
  k_ra8_rmac_phy_speed_100_fd  = 4U, 
  k_ra8_rmac_phy_speed_count   = 5U, 
} ra8_rmac_phy_speed_t;

typedef struct {
  bool                 up;    
  ra8_rmac_phy_speed_t speed; 
} ra8_rmac_phy_link_t;

typedef enum : uint16_t {
  k_ra8_rmac_phy_advert_10_hd  = 0x0020U, 
  k_ra8_rmac_phy_advert_10_fd  = 0x0040U, 
  k_ra8_rmac_phy_advert_100_hd = 0x0080U, 
  k_ra8_rmac_phy_advert_100_fd = 0x0100U, 
  k_ra8_rmac_phy_advert_pause  = 0x0400U, 
} ra8_rmac_phy_advert_t;

typedef struct {
  uint32_t err_status;    
  uint32_t mon_status[3]; 
  uint32_t phy_monitor;   
  uint32_t mrmac0;        
  uint32_t mrmac1;        
} ra8_rmac_status_t;

typedef struct {
  uint32_t pause_tx_manual;                           
  uint32_t pause_tx_auto;                             
  uint32_t pause_rx;                                  
  uint32_t false_carrier;                             
  uint32_t eee_count;                                 
  uint32_t pfc_tx_manual[k_ra8_rmac_pfc_group_count]; 
  uint32_t pfc_tx_auto[k_ra8_rmac_pfc_group_count];   
  uint32_t pfc_rx[k_ra8_rmac_pfc_rx_count];           
  uint32_t rx_overflow;                               
  uint32_t rx_hdr_crc_err;                            
  uint32_t rx_good_e;                                 
  uint32_t rx_good_p;                                 
  uint32_t rx_broadcast;                              
  uint32_t rx_multicast;                              
  uint32_t rx_unicast;                                
  uint32_t rx_phy_err;                                
  uint32_t rx_nibble_err;                             
  uint32_t rx_fcs_err;                                
  uint32_t rx_final_frag_miss;                        
  uint32_t rx_c_frag_err;                             
  uint32_t rx_frag_count_err;                         
  uint32_t rx_filter_rejected;                        
  uint32_t rx_total;                                  
  uint32_t rx_good_undersize;                         
  uint32_t rx_bad_undersize;                          
  uint32_t rx_good_oversize;                          
  uint32_t rx_bad_oversize;                           
  uint32_t rx_bytes_e_upper;                          
  uint32_t rx_bytes_e_lower;                          
  uint32_t rx_bytes_p_upper;                          
  uint32_t rx_bytes_p_lower;                          
  uint32_t tx_good_e;                                 
  uint32_t tx_good_p;                                 
  uint32_t tx_broadcast;                              
  uint32_t tx_multicast;                              
  uint32_t tx_unicast;                                
  uint32_t tx_error;                                  
  uint32_t tx_bytes_e_upper;                          
  uint32_t tx_bytes_e_lower;                          
  uint32_t tx_bytes_p_upper;                          
  uint32_t tx_bytes_p_lower;                          
} ra8_rmac_stats_t;

typedef void (*ra8_rmac_event_fn_t)(void*           ctx,
                                    ra8_rmac_port_t port,
                                    uint32_t        err_msk,
                                    uint32_t        mon0_msk,
                                    uint32_t        mon1_msk,
                                    uint32_t        mon2_msk);

[[nodiscard]] ra8_err_t ra8_rmac_init(ra8_rmac_port_t port, const ra8_rmac_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_rmac_deinit(ra8_rmac_port_t port);

[[nodiscard]] ra8_err_t ra8_rmac_enter_stop(ra8_rmac_port_t port);

[[nodiscard]] ra8_err_t ra8_rmac_exit_stop(ra8_rmac_port_t port);

[[nodiscard]] ra8_err_t ra8_rmac_set_mac_address(ra8_rmac_port_t port,
                                                 const uint8_t   mac[k_ra8_rmac_mac_byte_count]);

[[nodiscard]] ra8_err_t ra8_rmac_set_rx_filter(ra8_rmac_port_t port, ra8_rmac_mrafc_t filter);

[[nodiscard]] ra8_err_t ra8_rmac_set_ptp_filter(ra8_rmac_port_t port,
                                                uint8_t         index,
                                                uint8_t         byte_offset,
                                                uint8_t         value,
                                                bool            tef0,
                                                bool            tef1);

[[nodiscard]] ra8_err_t
ra8_rmac_set_frame_size(ra8_rmac_port_t port, bool is_pframe, uint16_t min_size, uint16_t max_size);

[[nodiscard]] ra8_err_t
ra8_rmac_set_vlan_framing(ra8_rmac_port_t port, bool disable_pad, bool use_mcrc);

[[nodiscard]] ra8_err_t ra8_rmac_set_pause_frame(ra8_rmac_port_t       port,
                                                 ra8_rmac_pause_mode_t mode,
                                                 uint16_t              pause_time,
                                                 uint8_t               retry_time,
                                                 uint8_t               retry_level);

[[nodiscard]] ra8_err_t
ra8_rmac_set_pfc_group(ra8_rmac_port_t port, ra8_rmac_pfc_group_t group, uint8_t pcp_mask);

[[nodiscard]] ra8_err_t ra8_rmac_set_lpi(ra8_rmac_port_t port, bool enable);

[[nodiscard]] ra8_err_t ra8_rmac_set_magic_packet(ra8_rmac_port_t port, bool enable);

[[nodiscard]] ra8_err_t ra8_rmac_set_loopback(ra8_rmac_port_t port, bool enable);

[[nodiscard]] ra8_err_t ra8_rmac_set_link(ra8_rmac_port_t   port,
                                          ra8_rmac_pis_t    iface,
                                          ra8_rmac_lsc_t    speed,
                                          ra8_rmac_duplex_t duplex);

[[nodiscard]] ra8_err_t ra8_rmac_mdio_c22_read(ra8_rmac_port_t port,
                                               uint8_t         phy_addr,
                                               uint8_t         reg_addr,
                                               uint16_t*       out_value);

[[nodiscard]] ra8_err_t
ra8_rmac_mdio_c22_write(ra8_rmac_port_t port, uint8_t phy_addr, uint8_t reg_addr, uint16_t value);

[[nodiscard]] ra8_err_t ra8_rmac_mdio_c45_read(ra8_rmac_port_t port,
                                               uint8_t         phy_addr,
                                               uint8_t         dev_addr,
                                               uint16_t        reg_addr,
                                               uint16_t*       out_value);

[[nodiscard]] ra8_err_t ra8_rmac_mdio_c45_write(ra8_rmac_port_t port,
                                                uint8_t         phy_addr,
                                                uint8_t         dev_addr,
                                                uint16_t        reg_addr,
                                                uint16_t        value);

[[nodiscard]] ra8_err_t ra8_rmac_get_status(ra8_rmac_port_t port, ra8_rmac_status_t* out);

[[nodiscard]] ra8_err_t ra8_rmac_clear_status(ra8_rmac_port_t port,
                                              uint32_t        err_mask,
                                              uint32_t        mon0_mask,
                                              uint32_t        mon1_mask,
                                              uint32_t        mon2_mask);

[[nodiscard]] ra8_err_t ra8_rmac_read_stats(ra8_rmac_port_t port, ra8_rmac_stats_t* out);

[[nodiscard]] ra8_err_t
ra8_rmac_attach_handler(ra8_rmac_port_t port, ra8_rmac_event_fn_t cb, void* ctx);

void ra8_rmac_dispatch(ra8_rmac_port_t port);

[[nodiscard]] ra8_err_t ra8_rmac_phy_reset(ra8_rmac_port_t port, uint8_t phy_addr);

[[nodiscard]] ra8_err_t
ra8_rmac_phy_set_advertise(ra8_rmac_port_t port, uint8_t phy_addr, uint16_t capabilities);

[[nodiscard]] ra8_err_t ra8_rmac_phy_auto_neg_start(ra8_rmac_port_t port, uint8_t phy_addr);

[[nodiscard]] ra8_err_t ra8_rmac_phy_auto_neg_wait(ra8_rmac_port_t      port,
                                                   uint8_t              phy_addr,
                                                   uint32_t             timeout_ms,
                                                   ra8_rmac_phy_link_t* out_link);

[[nodiscard]] ra8_err_t
ra8_rmac_phy_link_status(ra8_rmac_port_t port, uint8_t phy_addr, ra8_rmac_phy_link_t* out_link);
 
#ifdef __cplusplus
}
#endif