eth.h File Reference

#include "hal/vsf_hal_cfg.h"
#include "hal/driver/common/template/vsf_template_hal_driver.h"
#include "../../__device.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	vsf_$
struct	vsf_eth_isr_t
	ETH interrupt configuration structure. More...
struct	vsf_eth_cfg_t
	ETH configuration structure. More...
struct	vsf_eth_status_t
	ETH status information structure Contains the current status of ETH operations and FIFO thresholds. More...
struct	vsf_eth_capability_t
	Predefined VSF ETH capability that can be reimplemented in specific hal drivers. The vsf_eth_capability_t structure defines the features supported by the ETH hardware. When reimplementing this structure, all existing members must be preserved. More...
struct	vsf_eth_buf_desc_t

Macros
#define	__HAL_DRIVER_   ${SERIES/ETH_IP}_ETH_H__
#define	VSF_   ${ETH_IP}_ETH_CFG_MULTI_CLASS VSF_ETH_CFG_MULTI_CLASS
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC   ENABLED
#define	VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_BUF_DESC   ENABLED

Typedefs
typedef enum vsf_eth_phy_mode_t	vsf_eth_phy_mode_t
typedef enum vsf_eth_mode_t	vsf_eth_mode_t
typedef enum vsf_eth_irq_mask_t	vsf_eth_irq_mask_t
typedef enum vsf_eth_ctrl_t	vsf_eth_ctrl_t
typedef struct vsf_eth_t	vsf_eth_t
typedef void	vsf_eth_isr_handler_t(void *target_ptr, vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t irq_mask)
typedef struct vsf_eth_isr_t	vsf_eth_isr_t
typedef struct vsf_eth_cfg_t	vsf_eth_cfg_t
typedef struct vsf_eth_status_t	vsf_eth_status_t
typedef struct vsf_eth_capability_t	vsf_eth_capability_t
typedef enum vsf_eth_buf_mode_t	vsf_eth_buf_mode_t
typedef struct vsf_eth_buf_desc_t	vsf_eth_buf_desc_t
typedef vsf_eth_buf_desc_t	vsf_eth_send_buf_desc_t
typedef vsf_eth_buf_desc_t	vsf_eth_recv_buf_desc_t
typedef vsf_eth_buf_desc_t	vsf_eth_send_sg_buf_desc_t
typedef vsf_eth_buf_desc_t	vsf_eth_recv_sg_buf_desc_t

Enumerations
enum	vsf_eth_phy_mode_t {   VSF_ETH_PHY_MODE_SPEED_10M = 1 << 0 ,   VSF_ETH_PHY_MODE_SPEED_100M = 1 << 1 ,   VSF_ETH_PHY_MODE_SPEED_1000M = 1 << 2 ,   VSF_ETH_PHY_MODE_DUPLEX_HALF = 1 << 3 ,   VSF_ETH_PHY_MODE_DUPLEX_FULL = 1 << 4 }
enum	vsf_eth_mode_t {   VSF_ETH_MODE_TX_CHECKSUM_OFFLOAD = 1 << 5 ,   VSF_ETH_MODE_RX_CHECKSUM_OFFLOAD = 1 << 6 }
enum	vsf_eth_irq_mask_t {   VSF_ETH_IRQ_MASK_RX_AVAILABLE = (1 << 0) ,   VSF_ETH_IRQ_MASK_TX_COMPLETE = (1 << 1) ,   VSF_ETH_IRQ_MASK_SG_RX_AVAILABLE = (1 << 2) ,   VSF_ETH_IRQ_MASK_SG_TX_COMPLETE = (1 << 3) ,   VSF_ETH_IRQ_MASK_PHY_LINK_CHANGE = (1 << 4) ,   VSF_ETH_IRQ_MASK_ERROR = (1 << 5) ,   VSF_ETH_IRQ_MASK_OVERFLOW = (1 << 6) }
enum	vsf_eth_ctrl_t { VSF_ETH_CTRL_GET_MAC_ADDRESS }
enum	vsf_eth_buf_mode_t {   VSF_ETH_BUF_MODE_TX_CHECKSUM_OFFLOAD = 1 << 0 ,   VSF_ETH_BUF_MODE_RX_CHECKSUM_OFFLOAD = 1 << 1 }

Variables
class vsf_$ *	reg
vsf_eth_isr_t	isr

Macro Definition Documentation

__HAL_DRIVER_

#define __HAL_DRIVER_   ${SERIES/ETH_IP}_ETH_H__

VSF_

#define VSF_   ${ETH_IP}_ETH_CFG_MULTI_CLASS VSF_ETH_CFG_MULTI_CLASS

Note

When vsf_peripheral_status_t is inherited, vsf_template_hal_driver.h needs to be included

VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC   ENABLED

VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_BUF_DESC

#define VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_BUF_DESC   ENABLED

Typedef Documentation

vsf_eth_phy_mode_t

typedef enum vsf_eth_phy_mode_t vsf_eth_phy_mode_t

vsf_eth_mode_t

typedef enum vsf_eth_mode_t vsf_eth_mode_t

vsf_eth_irq_mask_t

typedef enum vsf_eth_irq_mask_t vsf_eth_irq_mask_t

vsf_eth_ctrl_t

typedef enum vsf_eth_ctrl_t vsf_eth_ctrl_t

vsf_eth_t

typedef struct vsf_eth_t vsf_eth_t

vsf_eth_isr_handler_t

typedef void vsf_eth_isr_handler_t(void *target_ptr, vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t irq_mask)

vsf_eth_isr_t

typedef struct vsf_eth_isr_t vsf_eth_isr_t

vsf_eth_cfg_t

typedef struct vsf_eth_cfg_t vsf_eth_cfg_t

vsf_eth_status_t

typedef struct vsf_eth_status_t vsf_eth_status_t

vsf_eth_capability_t

typedef struct vsf_eth_capability_t vsf_eth_capability_t

vsf_eth_buf_mode_t

typedef enum vsf_eth_buf_mode_t vsf_eth_buf_mode_t

vsf_eth_buf_desc_t

typedef struct vsf_eth_buf_desc_t vsf_eth_buf_desc_t

vsf_eth_send_buf_desc_t

typedef vsf_eth_buf_desc_t vsf_eth_send_buf_desc_t

vsf_eth_recv_buf_desc_t

typedef vsf_eth_buf_desc_t vsf_eth_recv_buf_desc_t

vsf_eth_send_sg_buf_desc_t

typedef vsf_eth_buf_desc_t vsf_eth_send_sg_buf_desc_t

vsf_eth_recv_sg_buf_desc_t

typedef vsf_eth_buf_desc_t vsf_eth_recv_sg_buf_desc_t

Enumeration Type Documentation

vsf_eth_phy_mode_t

enum vsf_eth_phy_mode_t

Enumerator
VSF_ETH_PHY_MODE_SPEED_10M
VSF_ETH_PHY_MODE_SPEED_100M
VSF_ETH_PHY_MODE_SPEED_1000M
VSF_ETH_PHY_MODE_DUPLEX_HALF
VSF_ETH_PHY_MODE_DUPLEX_FULL

vsf_eth_mode_t

enum vsf_eth_mode_t

Enumerator
VSF_ETH_MODE_TX_CHECKSUM_OFFLOAD
VSF_ETH_MODE_RX_CHECKSUM_OFFLOAD

vsf_eth_irq_mask_t

enum vsf_eth_irq_mask_t

Enumerator
VSF_ETH_IRQ_MASK_RX_AVAILABLE
VSF_ETH_IRQ_MASK_TX_COMPLETE
VSF_ETH_IRQ_MASK_SG_RX_AVAILABLE
VSF_ETH_IRQ_MASK_SG_TX_COMPLETE
VSF_ETH_IRQ_MASK_PHY_LINK_CHANGE
VSF_ETH_IRQ_MASK_ERROR
VSF_ETH_IRQ_MASK_OVERFLOW

vsf_eth_ctrl_t

enum vsf_eth_ctrl_t

Enumerator
VSF_ETH_CTRL_GET_MAC_ADDRESS

vsf_eth_buf_mode_t

enum vsf_eth_buf_mode_t

Enumerator
VSF_ETH_BUF_MODE_TX_CHECKSUM_OFFLOAD
VSF_ETH_BUF_MODE_RX_CHECKSUM_OFFLOAD

Variable Documentation

reg

class vsf_$* reg

isr

vsf_eth_isr_t isr