MTB CAT1 Peripheral driver library
Data Structures

General Description

Data Structures

struct  ETH_Type
 The struct type definition for the hardware register set contained in the block.
The address of a variable of this type can be used as the base hardware address for register access. A device may support more than one instance of a peripheral block.
Refer to a device-specific header file, e.g. <PDL_DIR>/COMPONENT_<ARCH>/include/<device>.h for the list of block instances available on that device.
Refer to the device TRM for the block register descriptions. More...
 
struct  cy_stc_ethif_wrapper_config_t
 Wrapper Configuration. More...
 
struct  cy_stc_ethif_queue_disablestatus_t
 Tx/Rx Queue status. More...
 
struct  cy_stc_ethif_buff_addr_t
 Virtual and physical addresses of DMA-addressable data buffer. More...
 
struct  cy_stc_ethif_bufstatus_t
 Buffer status. More...
 
struct  cy_stc_ethif_1588_timer_val_t
 1588 Timer value More...
 
struct  cy_stc_ethif_timer_increment_t
 writing/reading the 1588 timer increment registers More...
 
struct  cy_stc_ethif_tsu_config_t
 struct for writing/reading 1588 timer More...
 
struct  cy_stc_ethif_cb_t
 Ethernet MAC call back handlers. More...
 
struct  cy_stc_ethif_mac_config_t
 Ethernet MAC detailed configurations. More...
 
struct  cy_stc_ethif_intr_config_t
 Interrupt configuration for Ethernet MAC. More...
 
struct  cy_stc_ethif_mac_address_t
 Ethernet MAC Address. More...
 
struct  cy_stc_ethif_filter_config_t
 filter configuration for Ethernet MAC More...
 

Typedefs

typedef void(* cy_ethif_tx_msg_cb_t) (ETH_Type *base, uint8_t u8QueueIndex)
 Frame transmission complete callback function. More...
 
typedef void(* cy_ethif_tx_error_cb_t) (ETH_Type *base, uint8_t u8QueueIndex)
 Frame transmission Error callback function. More...
 
typedef void(* cy_ethif_rx_frame_cb_t) (ETH_Type *base, uint8_t *u8RxBuffer, uint32_t u32Length)
 Frame received callback function. More...
 
typedef void(* cy_ethif_tsu_inc_cb_t) (ETH_Type *base)
 TSU Second counter increment callback function. More...
 
typedef void(* cy_ethif_rx_getbuffer_cb_t) (ETH_Type *base, uint8_t **u8RxBuffer, uint32_t *u32Length)
 Get Buffer callback function. More...
 
typedef uint8_t * cy_ethif_buffpool_t[CY_ETH_DEFINE_TOTAL_BD_PER_RXQUEUE]
 Pointer to a Buffer pool.
 

Typedef Documentation

◆ cy_ethif_tx_msg_cb_t

typedef void(* cy_ethif_tx_msg_cb_t) (ETH_Type *base, uint8_t u8QueueIndex)

Frame transmission complete callback function.

Signals a successful completed transmission.

Parameters
base[IN]Pointer to register area of Ethernet MAC
u8Queue[IN]Queue used for transmitting the frame

◆ cy_ethif_tx_error_cb_t

typedef void(* cy_ethif_tx_error_cb_t) (ETH_Type *base, uint8_t u8QueueIndex)

Frame transmission Error callback function.

Signals a transmission error.

Parameters
base[IN]Pointer to register area of Ethernet MAC
u8Queue[IN]Queue used for transmitting the frame

◆ cy_ethif_rx_frame_cb_t

typedef void(* cy_ethif_rx_frame_cb_t) (ETH_Type *base, uint8_t *u8RxBuffer, uint32_t u32Length)

Frame received callback function.

Signals a successful reception of frame.

Parameters
base[IN]Pointer to register area of Ethernet MAC
u8RxBuffer[IN]Receive frame buffer
u32Length[IN]Frame buffer length

◆ cy_ethif_tsu_inc_cb_t

typedef void(* cy_ethif_tsu_inc_cb_t) (ETH_Type *base)

TSU Second counter increment callback function.

Signals a One second increment in the TSU.

Parameters
base[IN]Pointer to register area of Ethernet MAC

◆ cy_ethif_rx_getbuffer_cb_t

typedef void(* cy_ethif_rx_getbuffer_cb_t) (ETH_Type *base, uint8_t **u8RxBuffer, uint32_t *u32Length)

Get Buffer callback function.

Driver call this for getting free buffer for filling subsequent receive frame.

Parameters
base[IN]Pointer to register area of Ethernet MAC
u8RxBuffer[OUT]32 bytes aligned Frame buffer
u32Length[OUT]Frame buffer length