ra8_eth_gwca.h

Go to the documentation of this file.

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

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

[[nodiscard]] ra8_err_t ra8_eth_gwca_init(void);

[[nodiscard]] ra8_err_t ra8_eth_gwca_deinit(void);

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

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

[[nodiscard]] ra8_err_t ra8_eth_gwca_attach_handler(ra8_eth_gwca_event_fn_t fn, void* ctx);

void ra8_eth_gwca_dispatch(void);

[[nodiscard]] ra8_err_t ra8_eth_gwca_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_eth_gwca_exit_stop(void);

[[nodiscard]] ra8_err_t ra8_eth_gwca_set_operation_mode(ra8_gwmc_opc_t mode);

[[nodiscard]] ra8_err_t ra8_eth_gwca_axi_init(void);

[[nodiscard]] ra8_err_t ra8_eth_gwca_install_linkfix(ra8_gwca_basic_descriptor_t* linkfix_table,
                                                     uint32_t                     entry_count);

[[nodiscard]] ra8_err_t ra8_eth_gwca_bring_up(ra8_gwca_basic_descriptor_t* linkfix_table,
                                              uint32_t                     entry_count);

typedef struct {
  uint8_t priority;     
  bool    is_tx;        
  bool    stop_on_last; 
  bool    extended;     
  void*   chain_head;   
} ra8_eth_gwca_queue_cfg_t;

[[nodiscard]] ra8_err_t ra8_eth_gwca_configure_queue(ra8_gwca_basic_descriptor_t*    linkfix_table,
                                                     uint32_t                        queue_index,
                                                     const ra8_eth_gwca_queue_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_eth_gwca_reload_queue(uint32_t queue_index);

[[nodiscard]] ra8_err_t ra8_eth_gwca_init_ring(ra8_gwca_basic_descriptor_t* chain,
                                               uint32_t                     ring_depth,
                                               uint32_t                     slot_bytes);

[[nodiscard]] ra8_err_t ra8_eth_gwca_set_descriptor_buffer(ra8_gwca_basic_descriptor_t* desc,
                                                           void*                        buffer);

[[nodiscard]] ra8_err_t ra8_eth_gwca_attach_buffers(ra8_gwca_basic_descriptor_t* chain,
                                                    uint32_t                     ring_depth,
                                                    uint32_t                     slot_bytes,
                                                    uint8_t*                     pool);

[[nodiscard]] ra8_err_t ra8_eth_gwca_kick_tx(uint32_t queue_index);

[[nodiscard]] ra8_err_t ra8_eth_gwca_find_slot(const ra8_gwca_basic_descriptor_t* chain,
                                               uint32_t                           ring_depth,
                                               ra8_gwdcc_dt_t                     match_dt,
                                               uint32_t                           start_idx,
                                               uint32_t*                          out_index);

[[nodiscard]] ra8_err_t ra8_eth_gwca_tx_frame(ra8_gwca_basic_descriptor_t* chain,
                                              uint32_t                     ring_depth,
                                              uint32_t*                    tail_idx,
                                              const uint8_t*               frame,
                                              uint32_t                     frame_len,
                                              uint32_t                     slot_bytes);

[[nodiscard]] ra8_err_t ra8_eth_gwca_rx_frame(ra8_gwca_basic_descriptor_t* chain,
                                              uint32_t                     ring_depth,
                                              uint32_t*                    head_idx,
                                              uint8_t*                     out_frame,
                                              uint32_t                     out_capacity,
                                              uint32_t                     slot_bytes,
                                              uint32_t*                    out_len);

typedef struct {
  ra8_gwca_basic_descriptor_t* linkfix_table;
  uint32_t linkfix_count;
  ra8_gwca_basic_descriptor_t* rx_chain;
  uint32_t                     rx_depth;       
  uint8_t*                     rx_pool;        
  uint32_t                     rx_slot_bytes;  
  uint32_t                     rx_queue_index; 
  uint32_t                     rx_head;        
  ra8_gwca_ext_descriptor_t* tx_chain;
  uint32_t                   tx_depth;       
  uint8_t*                   tx_pool;        
  uint32_t                   tx_slot_bytes;  
  uint32_t                   tx_queue_index; 
  uint32_t                   tx_tail;        
  uint8_t mac_port;
} ra8_eth_gwca_default_state_t;

[[nodiscard]] ra8_err_t ra8_eth_gwca_default_open(ra8_eth_gwca_default_state_t* state);

[[nodiscard]] ra8_err_t
ra8_eth_gwca_default_send(ra8_eth_gwca_default_state_t* state, const uint8_t* frame, uint32_t len);

[[nodiscard]] ra8_err_t ra8_eth_gwca_default_recv(ra8_eth_gwca_default_state_t* state,
                                                  uint8_t*                      out_frame,
                                                  uint32_t                      out_capacity,
                                                  uint32_t*                     out_len);
 
#ifdef __cplusplus
}
#endif