Enumerated Types

General Description

Enumerations
enum	cy_en_ethif_status_t {   CY_ETHIF_SUCCESS = 0U,   CY_ETHIF_BAD_PARAM,   CY_ETHIF_MEMORY_NOT_ENOUGH,   CY_ETHIF_LINK_DOWN,   CY_ETHIF_LINK_UP,   CY_ETHIF_BUFFER_NOT_AVAILABLE }
	Ethernet MAC driver error codes. More...
enum	cy_en_ethif_buffer_status_t {   CY_ETHIF_BUFFER_UNINIT = 0U,   CY_ETHIF_BUFFER_FREE,   CY_ETHIF_BUFFER_OCCUPIED,   CY_ETHIF_BUFFER_RELEASED }
	Ethernet MAC driver buffer status. More...
enum	cy_en_ethif_speed_sel_t {   CY_ETHIF_CTL_MII_10 = 0U,   CY_ETHIF_CTL_MII_100 = 1U,   CY_ETHIF_CTL_GMII_1000 = 2U,   CY_ETHIF_CTL_RGMII_10 = 3U,   CY_ETHIF_CTL_RGMII_100 = 4U,   CY_ETHIF_CTL_RGMII_1000 = 5U,   CY_ETHIF_CTL_RMII_10 = 6U,   CY_ETHIF_CTL_RMII_100 = 7U }
	Ethernet MAC Drive Modes. More...
enum	cy_en_ethif_clock_ref_t {   CY_ETHIF_EXTERNAL_HSIO = 0U,   CY_ETHIF_INTERNAL_PLL }
	Reference Clock for RMII/RGMII. More...
enum	cy_en_ethif_filter_type_t {   CY_ETHIF_FILTER_TYPE_DESTINATION = 0U,   CY_ETHIF_FILTER_TYPE_SOURCE = 1U }
	MAC filter types. More...
enum	cy_en_ethif_filter_num_t {   CY_ETHIF_FILTER_NUM_1 = 1U,   CY_ETHIF_FILTER_NUM_2 = 2U,   CY_ETHIF_FILTER_NUM_3 = 3U,   CY_ETHIF_FILTER_NUM_4 = 4U,   CY_ETHIF_FILTER_NUM_INV }
	Total number of filters supported. More...
enum	cy_en_ethif_TxTs_mode_t {   CY_ETHIF_TX_TS_DISABLED = 0U,   CY_ETHIF_TX_TS_PTP_EVENT_ONLY = 1U,   CY_ETHIF_TX_TS_PTP_ALL = 2U,   CY_ETHIF_TX_TS_ALL = 3U }
	Transmit Time stamp modes. More...
enum	cy_en_ethif_RxTs_mode_t {   CY_ETHIF_RX_TS_DISABLED = 0U,   CY_ETHIF_RX_TS_PTP_EVENT_ONLY = 1U,   CY_ETHIF_RX_TS_PTP_ALL = 2U,   CY_ETHIF_RX_TS_ALL = 3U }
	Receive Time stamp modes. More...
enum	cy_en_ethif_dma_data_buffer_len_t {   CY_ETHIF_DMA_DBUR_LEN_1 = 0U,   CY_ETHIF_DMA_DBUR_LEN_4 = 1U,   CY_ETHIF_DMA_DBUR_LEN_8 = 2U,   CY_ETHIF_DMA_DBUR_LEN_16 = 3U }
	DMA data buffer length. More...
enum	cy_en_ethif_dma_mdc_clk_div_t {   CY_ETHIF_MDC_DIV_BY_8 = 0U,   CY_ETHIF_MDC_DIV_BY_16 = 1U,   CY_ETHIF_MDC_DIV_BY_32 = 2U,   CY_ETHIF_MDC_DIV_BY_48 = 3U,   CY_ETHIF_MDC_DIV_BY_64 = 4U,   CY_ETHIF_MDC_DIV_BY_96 = 5U,   CY_ETHIF_MDC_DIV_BY_128 = 6U,   CY_ETHIF_MDC_DIV_BY_224 = 7U }
	MDC clock divider. More...

Enumeration Type Documentation

cy_en_ethif_status_t

enum cy_en_ethif_status_t

Ethernet MAC driver error codes.

Enumerator
CY_ETHIF_SUCCESS	Returned successful.
CY_ETHIF_BAD_PARAM	Bad parameter was passed.
CY_ETHIF_MEMORY_NOT_ENOUGH	Assigned memory for BDs not enough.
CY_ETHIF_LINK_DOWN	Link between nodes is not up.
CY_ETHIF_LINK_UP	Link between nodes is up.
CY_ETHIF_BUFFER_NOT_AVAILABLE	No local buffer available to send the frame.

cy_en_ethif_buffer_status_t

enum cy_en_ethif_buffer_status_t

Ethernet MAC driver buffer status.

Enumerator
CY_ETHIF_BUFFER_UNINIT	Buffer Uninitialized.
CY_ETHIF_BUFFER_FREE	Buffer free and cleared with CY_EHTIF_EMPTYVALUE.
CY_ETHIF_BUFFER_OCCUPIED	Buffer has been allocated to BD or in case of Tx loaded with the source data.
CY_ETHIF_BUFFER_RELEASED	Buffer has been used and can be written with CY_EHTIF_EMPTYVALUE.

cy_en_ethif_speed_sel_t

enum cy_en_ethif_speed_sel_t

Ethernet MAC Drive Modes.

Enumerator
CY_ETHIF_CTL_MII_10	PHY mode MII - 10Mbps.
CY_ETHIF_CTL_MII_100	PHY mode MII - 100Mbps.
CY_ETHIF_CTL_GMII_1000	PHY mode GMII - 1000Mbps.
CY_ETHIF_CTL_RGMII_10	PHY mode RGMII - 10Mbps (4bits/Cycle)
CY_ETHIF_CTL_RGMII_100	PHY mode RGMII - 100Mbps (4bits/Cycle)
CY_ETHIF_CTL_RGMII_1000	PHY mode RGMII - 1000Mbps (8bits/Cycle)
CY_ETHIF_CTL_RMII_10	PHY mode RMII - 10Mbps.
CY_ETHIF_CTL_RMII_100	PHY mode RMII - 100Mbps.

cy_en_ethif_clock_ref_t

enum cy_en_ethif_clock_ref_t

Reference Clock for RMII/RGMII.

Enumerator
CY_ETHIF_EXTERNAL_HSIO	Clock coming from HSIO.
CY_ETHIF_INTERNAL_PLL	Clock referenced from Internal PLL source.

cy_en_ethif_filter_type_t

enum cy_en_ethif_filter_type_t

MAC filter types.

Enumerator
CY_ETHIF_FILTER_TYPE_DESTINATION	filter on destination address
CY_ETHIF_FILTER_TYPE_SOURCE	filter on source address

cy_en_ethif_filter_num_t

enum cy_en_ethif_filter_num_t

Total number of filters supported.

Enumerator
CY_ETHIF_FILTER_NUM_1	filter 1
CY_ETHIF_FILTER_NUM_2	filter 2
CY_ETHIF_FILTER_NUM_3	filter 3
CY_ETHIF_FILTER_NUM_4	filter 4
CY_ETHIF_FILTER_NUM_INV	Invalid Filter.

cy_en_ethif_TxTs_mode_t

enum cy_en_ethif_TxTs_mode_t

Transmit Time stamp modes.

cy_en_ethif_RxTs_mode_t

enum cy_en_ethif_RxTs_mode_t

Receive Time stamp modes.

cy_en_ethif_dma_data_buffer_len_t

enum cy_en_ethif_dma_data_buffer_len_t

DMA data buffer length.

Enumerator
CY_ETHIF_DMA_DBUR_LEN_1	Single burst.
CY_ETHIF_DMA_DBUR_LEN_4	Burst upto 4.
CY_ETHIF_DMA_DBUR_LEN_8	Burst upto 8.
CY_ETHIF_DMA_DBUR_LEN_16	Burst upto 16.

cy_en_ethif_dma_mdc_clk_div_t

enum cy_en_ethif_dma_mdc_clk_div_t

MDC clock divider.

Enumerator
CY_ETHIF_MDC_DIV_BY_8	Divide by 8.
CY_ETHIF_MDC_DIV_BY_16	Divide by 16.
CY_ETHIF_MDC_DIV_BY_32	Divide by 32.
CY_ETHIF_MDC_DIV_BY_48	Divide by 48.
CY_ETHIF_MDC_DIV_BY_64	Divide by 64.
CY_ETHIF_MDC_DIV_BY_96	Divide by 96.
CY_ETHIF_MDC_DIV_BY_128	Divide by 128.
CY_ETHIF_MDC_DIV_BY_224	Divide by 224.