18#ifndef __HAL_DRIVER_${SERIES/ETH_IP}_ETH_H__
19#define __HAL_DRIVER_${SERIES/ETH_IP}_ETH_H__
25#if VSF_HAL_USE_ETH == ENABLED
44#if defined(__VSF_HAL_${ETH_IP}_ETH_CLASS_IMPLEMENT)
45# define __VSF_CLASS_IMPLEMENT__
46#elif defined(__VSF_HAL_${ETH_IP}_ETH_CLASS_INHERIT__)
47# define __VSF_CLASS_INHERIT__
64#ifndef VSF_${ETH_IP}_ETH_CFG_MULTI_CLASS
65# define VSF_${ETH_IP}_ETH_CFG_MULTI_CLASS VSF_ETH_CFG_MULTI_CLASS
88#define VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE ENABLED
89#define VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE ENABLED
90#define VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
91#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
92#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG ENABLED
93#define VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS ENABLED
94#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY ENABLED
95#define VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE ENABLED
96#define VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC ENABLED
97#define VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC ENABLED
98#define VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC ENABLED
99#define VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_BUF_DESC ENABLED
107#if VSF_${ETH_IP}_CFG_MULTI_CLASS == ENABLED
126#if VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE == ENABLED
139#if VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
148#if VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
162#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL == ENABLED
170#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
187#if VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
200#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
202#if VSF_ETH_CFG_INHERIT_HAL_CAPABILITY == ENABLED
222#if VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE == ENABLED
231#if VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC == ENABLED
239#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC == ENABLED
243#if VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC == ENABLED
247#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_SEND_BUF == DISABLED
251#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_RECV_BUF == DISABLED
271#undef __VSF_HAL_${ETH_IP}_ETH_CLASS_IMPLEMENT
272#undef __VSF_HAL_${ETH_IP}_ETH_CLASS_INHERIT__
vsf_arch_prio_t
Definition cortex_a_generic.h:88
vsf_eth_buf_desc_t vsf_eth_recv_buf_desc_t
Definition eth.h:244
vsf_eth_irq_mask_t
Definition eth.h:149
@ VSF_ETH_IRQ_MASK_ERROR
Definition eth.h:155
@ VSF_ETH_IRQ_MASK_RX_AVAILABLE
Definition eth.h:150
@ VSF_ETH_IRQ_MASK_PHY_LINK_CHANGE
Definition eth.h:154
@ VSF_ETH_IRQ_MASK_SG_TX_COMPLETE
Definition eth.h:153
@ VSF_ETH_IRQ_MASK_SG_RX_AVAILABLE
Definition eth.h:152
@ VSF_ETH_IRQ_MASK_OVERFLOW
Definition eth.h:156
@ VSF_ETH_IRQ_MASK_TX_COMPLETE
Definition eth.h:151
vsf_eth_ctrl_t
Definition eth.h:163
@ VSF_ETH_CTRL_GET_MAC_ADDRESS
Definition eth.h:164
vsf_eth_buf_mode_t
Definition eth.h:223
@ VSF_ETH_BUF_MODE_TX_CHECKSUM_OFFLOAD
Definition eth.h:224
@ VSF_ETH_BUF_MODE_RX_CHECKSUM_OFFLOAD
Definition eth.h:225
vsf_eth_isr_t isr
Definition eth.h:121
vsf_eth_mode_t
Definition eth.h:140
@ VSF_ETH_MODE_TX_CHECKSUM_OFFLOAD
Definition eth.h:141
@ VSF_ETH_MODE_RX_CHECKSUM_OFFLOAD
Definition eth.h:142
vsf_eth_phy_mode_t
Definition eth.h:127
@ VSF_ETH_PHY_MODE_SPEED_1000M
Definition eth.h:130
@ VSF_ETH_PHY_MODE_SPEED_100M
Definition eth.h:129
@ VSF_ETH_PHY_MODE_SPEED_10M
Definition eth.h:128
@ VSF_ETH_PHY_MODE_DUPLEX_HALF
Definition eth.h:132
@ VSF_ETH_PHY_MODE_DUPLEX_FULL
Definition eth.h:133
vsf_eth_buf_desc_t vsf_eth_send_sg_buf_desc_t
Definition eth.h:248
vsf_eth_buf_desc_t vsf_eth_send_buf_desc_t
Definition eth.h:240
vsf_eth_buf_desc_t vsf_eth_recv_sg_buf_desc_t
Definition eth.h:252
void vsf_eth_isr_handler_t(void *target_ptr, vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t irq_mask)
Definition eth.h:172
#define vsf_class(__name)
Definition ooc_class.h:48
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
unsigned uint32_t
Definition stdint.h:9
unsigned char uint8_t
Definition stdint.h:5
Definition vsf_template_eth.h:637
void * payload
Definition vsf_template_eth.h:639
vsf_eth_buf_mode_t mode
Definition vsf_template_eth.h:638
uint32_t size
Definition eth.h:235
Predefined VSF ETH capability that can be reimplemented in specific hal drivers. The vsf_eth_capabili...
Definition vsf_template_eth.h:597
uint32_t is_send_buf_releasable_immediately
Definition vsf_template_eth.h:614
uint32_t is_sg_send_buf_releasable_immediately
Definition vsf_template_eth.h:621
inherit(vsf_peripheral_capability_t) vsf_eth_mode_t support_modes
vsf_eth_phy_mode_t support_phy_modes
Supported PHY modes, refer to vsf_eth_phy_mode_t.
Definition vsf_template_eth.h:603
uint32_t value
Definition vsf_template_eth.h:607
vsf_eth_irq_mask_t support_irq_mask
Supported IRQ masks, refer to vsf_eth_irq_mask_t.
Definition vsf_template_eth.h:604
ETH configuration structure.
Definition vsf_template_eth.h:557
uint8_t mac_address[6]
MAC address, 6 bytes.
Definition vsf_template_eth.h:560
vsf_eth_phy_mode_t phy_mode
PHY mode, refer to vsf_eth_phy_mode_t.
Definition vsf_template_eth.h:559
vsf_eth_isr_t isr
ETH interrupt configuration, refer to vsf_eth_isr_t.
Definition vsf_template_eth.h:561
vsf_eth_mode_t mode
ETH mode, refer to vsf_eth_mode_t.
Definition vsf_template_eth.h:558
ETH interrupt configuration structure.
Definition vsf_template_eth.h:544
vsf_eth_isr_handler_t * handler_fn
Interrupt handler function pointer.
Definition vsf_template_eth.h:545
void * target_ptr
User-defined target pointer.
Definition vsf_template_eth.h:546
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_eth.h:547
ETH status information structure Contains the current status of ETH operations and FIFO thresholds.
Definition vsf_template_eth.h:574
uint32_t is_tx_ready
TX is ready to accept data.
Definition vsf_template_eth.h:580
uint32_t is_rx_available
RX data is available.
Definition vsf_template_eth.h:579
ETH instance structure, used for ETH Multi Class support, not needed in non Multi Class mode.
Definition vsf_template_eth.h:712
Definition vsf_template_hal_driver.h:203
Definition vsf_template_hal_driver.h:196
vk_av_control_value_t value
Definition vsf_audio.h:171
vsf_eth_irq_mask_t
Definition vsf_template_eth.h:498
vsf_eth_ctrl_t
Definition vsf_template_eth.h:669
vsf_eth_buf_mode_t
Definition vsf_template_eth.h:628
vsf_eth_mode_t
Predefined VSF ETH modes that can be reimplemented in specific HAL drivers.The following modes must b...
Definition vsf_template_eth.h:379
vsf_eth_phy_mode_t
Predefined VSF ETH modes that can be reimplemented in specific HAL drivers.The following modes must b...
Definition vsf_template_eth.h:320