/* * Copyright (c) 2015 - 2016, Freescale Semiconductor, Inc. * Copyright 2016-2021 NXP * All rights reserved. * * SPDX-License-Identifier: BSD-3-Clause */ #ifndef _FSL_ENET_H_ #define _FSL_ENET_H_ #include "fsl_common.h" #if defined(FSL_FEATURE_MEMORY_HAS_ADDRESS_OFFSET) && FSL_FEATURE_MEMORY_HAS_ADDRESS_OFFSET #include "fsl_memory.h" #endif /*! * @addtogroup enet * @{ */ /******************************************************************************* * Definitions ******************************************************************************/ /*! @name Driver version */ /*@{*/ /*! @brief Defines the driver version. */ #define FSL_ENET_DRIVER_VERSION (MAKE_VERSION(2, 5, 3)) /*@}*/ /*! @name ENET DESCRIPTOR QUEUE */ /*@{*/ /*! @brief Defines the queue number. */ #ifndef FSL_FEATURE_ENET_QUEUE #define FSL_FEATURE_ENET_QUEUE 1 /* Singal queue for previous IP. */ #endif /*@}*/ /*! @name Control and status region bit masks of the receive buffer descriptor. */ /*@{*/ #define ENET_BUFFDESCRIPTOR_RX_EMPTY_MASK 0x8000U /*!< Empty bit mask. */ #define ENET_BUFFDESCRIPTOR_RX_SOFTOWNER1_MASK 0x4000U /*!< Software owner one mask. */ #define ENET_BUFFDESCRIPTOR_RX_WRAP_MASK 0x2000U /*!< Next buffer descriptor is the start address. */ #define ENET_BUFFDESCRIPTOR_RX_SOFTOWNER2_Mask 0x1000U /*!< Software owner two mask. */ #define ENET_BUFFDESCRIPTOR_RX_LAST_MASK 0x0800U /*!< Last BD of the frame mask. */ #define ENET_BUFFDESCRIPTOR_RX_MISS_MASK 0x0100U /*!< Received because of the promiscuous mode. */ #define ENET_BUFFDESCRIPTOR_RX_BROADCAST_MASK 0x0080U /*!< Broadcast packet mask. */ #define ENET_BUFFDESCRIPTOR_RX_MULTICAST_MASK 0x0040U /*!< Multicast packet mask. */ #define ENET_BUFFDESCRIPTOR_RX_LENVLIOLATE_MASK 0x0020U /*!< Length violation mask. */ #define ENET_BUFFDESCRIPTOR_RX_NOOCTET_MASK 0x0010U /*!< Non-octet aligned frame mask. */ #define ENET_BUFFDESCRIPTOR_RX_CRC_MASK 0x0004U /*!< CRC error mask. */ #define ENET_BUFFDESCRIPTOR_RX_OVERRUN_MASK 0x0002U /*!< FIFO overrun mask. */ #define ENET_BUFFDESCRIPTOR_RX_TRUNC_MASK 0x0001U /*!< Frame is truncated mask. */ /*@}*/ /*! @name Control and status bit masks of the transmit buffer descriptor. */ /*@{*/ #define ENET_BUFFDESCRIPTOR_TX_READY_MASK 0x8000U /*!< Ready bit mask. */ #define ENET_BUFFDESCRIPTOR_TX_SOFTOWENER1_MASK 0x4000U /*!< Software owner one mask. */ #define ENET_BUFFDESCRIPTOR_TX_WRAP_MASK 0x2000U /*!< Wrap buffer descriptor mask. */ #define ENET_BUFFDESCRIPTOR_TX_SOFTOWENER2_MASK 0x1000U /*!< Software owner two mask. */ #define ENET_BUFFDESCRIPTOR_TX_LAST_MASK 0x0800U /*!< Last BD of the frame mask. */ #define ENET_BUFFDESCRIPTOR_TX_TRANMITCRC_MASK 0x0400U /*!< Transmit CRC mask. */ /*@}*/ /* Extended control regions for enhanced buffer descriptors. */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE /*! @name First extended control region bit masks of the receive buffer descriptor. */ /*@{*/ #define ENET_BUFFDESCRIPTOR_RX_IPV4_MASK 0x0001U /*!< Ipv4 frame mask. */ #define ENET_BUFFDESCRIPTOR_RX_IPV6_MASK 0x0002U /*!< Ipv6 frame mask. */ #define ENET_BUFFDESCRIPTOR_RX_VLAN_MASK 0x0004U /*!< VLAN frame mask. */ #define ENET_BUFFDESCRIPTOR_RX_PROTOCOLCHECKSUM_MASK 0x0010U /*!< Protocol checksum error mask. */ #define ENET_BUFFDESCRIPTOR_RX_IPHEADCHECKSUM_MASK 0x0020U /*!< IP header checksum error mask. */ /*@}*/ /*! @name Second extended control region bit masks of the receive buffer descriptor. */ /*@{*/ #define ENET_BUFFDESCRIPTOR_RX_INTERRUPT_MASK 0x0080U /*!< BD interrupt mask. */ #define ENET_BUFFDESCRIPTOR_RX_UNICAST_MASK 0x0100U /*!< Unicast frame mask. */ #define ENET_BUFFDESCRIPTOR_RX_COLLISION_MASK 0x0200U /*!< BD collision mask. */ #define ENET_BUFFDESCRIPTOR_RX_PHYERR_MASK 0x0400U /*!< PHY error mask. */ #define ENET_BUFFDESCRIPTOR_RX_MACERR_MASK 0x8000U /*!< Mac error mask. */ /*@}*/ /*! @name First extended control region bit masks of the transmit buffer descriptor. */ /*@{*/ #define ENET_BUFFDESCRIPTOR_TX_ERR_MASK 0x8000U /*!< Transmit error mask. */ #define ENET_BUFFDESCRIPTOR_TX_UNDERFLOWERR_MASK 0x2000U /*!< Underflow error mask. */ #define ENET_BUFFDESCRIPTOR_TX_EXCCOLLISIONERR_MASK 0x1000U /*!< Excess collision error mask. */ #define ENET_BUFFDESCRIPTOR_TX_FRAMEERR_MASK 0x0800U /*!< Frame error mask. */ #define ENET_BUFFDESCRIPTOR_TX_LATECOLLISIONERR_MASK 0x0400U /*!< Late collision error mask. */ #define ENET_BUFFDESCRIPTOR_TX_OVERFLOWERR_MASK 0x0200U /*!< Overflow error mask. */ #define ENET_BUFFDESCRIPTOR_TX_TIMESTAMPERR_MASK 0x0100U /*!< Timestamp error mask. */ /*@}*/ /*! @name Second extended control region bit masks of the transmit buffer descriptor. */ /*@{*/ #define ENET_BUFFDESCRIPTOR_TX_INTERRUPT_MASK 0x4000U /*!< Interrupt mask. */ #define ENET_BUFFDESCRIPTOR_TX_TIMESTAMP_MASK 0x2000U /*!< Timestamp flag mask. */ #define ENET_BUFFDESCRIPTOR_TX_PROTOCHECKSUM_MASK 0x1000U /*!< Protocal checksum mask. */ #define ENET_BUFFDESCRIPTOR_TX_IPCHECKSUM_MASK 0x0800U /*!< IP header checksum flag mask. */ #if defined(FSL_FEATURE_ENET_HAS_AVB) && FSL_FEATURE_ENET_HAS_AVB #define ENET_BUFFDESCRIPTOR_TX_USETXLAUNCHTIME_MASK 0x0100U /*!< Use the transmit launch time. */ #define ENET_BUFFDESCRIPTOR_TX_FRAMETYPE_MASK 0x00F0U /*!< Frame type mask. */ #define ENET_BUFFDESCRIPTOR_TX_FRAMETYPE_SHIFT 4U /*!< Frame type shift. */ #define ENET_BD_FTYPE(n) \ (((uint32_t)(n) << ENET_BUFFDESCRIPTOR_TX_FRAMETYPE_SHIFT) & ENET_BUFFDESCRIPTOR_TX_FRAMETYPE_MASK) #endif /* FSL_FEATURE_ENET_HAS_AVB */ /*@}*/ #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ /*! @brief Defines the receive error status flag mask. */ #define ENET_BUFFDESCRIPTOR_RX_ERR_MASK \ (ENET_BUFFDESCRIPTOR_RX_TRUNC_MASK | ENET_BUFFDESCRIPTOR_RX_OVERRUN_MASK | \ ENET_BUFFDESCRIPTOR_RX_LENVLIOLATE_MASK | ENET_BUFFDESCRIPTOR_RX_NOOCTET_MASK | ENET_BUFFDESCRIPTOR_RX_CRC_MASK) #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE #define ENET_BUFFDESCRIPTOR_RX_EXT_ERR_MASK \ (ENET_BUFFDESCRIPTOR_RX_MACERR_MASK | ENET_BUFFDESCRIPTOR_RX_PHYERR_MASK | ENET_BUFFDESCRIPTOR_RX_COLLISION_MASK) #endif /*! @name Defines some Ethernet parameters. */ /*@{*/ #define ENET_FRAME_MAX_FRAMELEN 1518U /*!< Default maximum Ethernet frame size without VLAN tag. */ #define ENET_FRAME_VLAN_TAGLEN 4U /*!< Ethernet single VLAN tag size. */ #define ENET_FRAME_CRC_LEN 4U /*!< CRC size in a frame. */ #define ENET_FRAME_TX_LEN_LIMITATION(x) \ ((((x)->RCR & ENET_RCR_MAX_FL_MASK) >> ENET_RCR_MAX_FL_SHIFT) - ENET_FRAME_CRC_LEN) #define ENET_FIFO_MIN_RX_FULL 5U /*!< ENET minimum receive FIFO full. */ #define ENET_RX_MIN_BUFFERSIZE 256U /*!< ENET minimum buffer size. */ #define ENET_PHY_MAXADDRESS (ENET_MMFR_PA_MASK >> ENET_MMFR_PA_SHIFT) /*!< Maximum PHY address. */ #if FSL_FEATURE_ENET_QUEUE > 1 #define ENET_TX_INTERRUPT \ ((uint32_t)kENET_TxFrameInterrupt | (uint32_t)kENET_TxBufferInterrupt | (uint32_t)kENET_TxFrame1Interrupt | \ (uint32_t)kENET_TxBuffer1Interrupt | (uint32_t)kENET_TxFrame2Interrupt | \ (uint32_t)kENET_TxBuffer2Interrupt) /*!< Enet Tx interrupt flag. */ #define ENET_RX_INTERRUPT \ ((uint32_t)kENET_RxFrameInterrupt | (uint32_t)kENET_RxBufferInterrupt | (uint32_t)kENET_RxFrame1Interrupt | \ (uint32_t)kENET_RxBuffer1Interrupt | (uint32_t)kENET_RxFrame2Interrupt | \ (uint32_t)kENET_RxBuffer2Interrupt) /*!< Enet Rx interrupt flag. */ #else #define ENET_TX_INTERRUPT \ ((uint32_t)kENET_TxFrameInterrupt | (uint32_t)kENET_TxBufferInterrupt) /*!< Enet Tx interrupt flag. */ #define ENET_RX_INTERRUPT \ ((uint32_t)kENET_RxFrameInterrupt | (uint32_t)kENET_RxBufferInterrupt) /*!< Enet Rx interrupt flag. */ #endif /* FSL_FEATURE_ENET_QUEUE > 1 */ #define ENET_TS_INTERRUPT \ ((uint32_t)kENET_TsTimerInterrupt | (uint32_t)kENET_TsAvailInterrupt) /*!< Enet timestamp interrupt flag. */ #define ENET_ERR_INTERRUPT \ ((uint32_t)kENET_BabrInterrupt | (uint32_t)kENET_BabtInterrupt | (uint32_t)kENET_EBusERInterrupt | \ (uint32_t)kENET_LateCollisionInterrupt | (uint32_t)kENET_RetryLimitInterrupt | \ (uint32_t)kENET_UnderrunInterrupt | (uint32_t)kENET_PayloadRxInterrupt) /*!< Enet error interrupt flag. */ /*@}*/ /*! @brief Defines the status return codes for transaction. */ enum { kStatus_ENET_InitMemoryFail = MAKE_STATUS(kStatusGroup_ENET, 0U), /*!< Init fails since buffer memory is not enough. */ kStatus_ENET_RxFrameError = MAKE_STATUS(kStatusGroup_ENET, 1U), /*!< A frame received but data error happen. */ kStatus_ENET_RxFrameFail = MAKE_STATUS(kStatusGroup_ENET, 2U), /*!< Failed to receive a frame. */ kStatus_ENET_RxFrameEmpty = MAKE_STATUS(kStatusGroup_ENET, 3U), /*!< No frame arrive. */ kStatus_ENET_RxFrameDrop = MAKE_STATUS(kStatusGroup_ENET, 4U), /*!< Rx frame is dropped since no buffer memory. */ kStatus_ENET_TxFrameOverLen = MAKE_STATUS(kStatusGroup_ENET, 5U), /*!< Tx frame over length. */ kStatus_ENET_TxFrameBusy = MAKE_STATUS(kStatusGroup_ENET, 6U), /*!< Tx buffer descriptors are under process. */ kStatus_ENET_TxFrameFail = MAKE_STATUS(kStatusGroup_ENET, 7U), /*!< Transmit frame fail. */ }; /*! @brief Defines the MII/RMII/RGMII mode for data interface between the MAC and the PHY. */ typedef enum _enet_mii_mode { kENET_MiiMode = 0U, /*!< MII mode for data interface. */ kENET_RmiiMode = 1U, /*!< RMII mode for data interface. */ #if defined(FSL_FEATURE_ENET_HAS_AVB) && FSL_FEATURE_ENET_HAS_AVB kENET_RgmiiMode = 2U /*!< RGMII mode for data interface. */ #endif /* FSL_FEATURE_ENET_HAS_AVB */ } enet_mii_mode_t; /*! @brief Defines the 10/100/1000 Mbps speed for the MII data interface. * * Notice: "kENET_MiiSpeed1000M" only supported when mii mode is "kENET_RgmiiMode". */ typedef enum _enet_mii_speed { kENET_MiiSpeed10M = 0U, /*!< Speed 10 Mbps. */ kENET_MiiSpeed100M = 1U, /*!< Speed 100 Mbps. */ #if defined(FSL_FEATURE_ENET_HAS_AVB) && FSL_FEATURE_ENET_HAS_AVB kENET_MiiSpeed1000M = 2U /*!< Speed 1000M bps. */ #endif /* FSL_FEATURE_ENET_HAS_AVB */ } enet_mii_speed_t; /*! @brief Defines the half or full duplex for the MII data interface. */ typedef enum _enet_mii_duplex { kENET_MiiHalfDuplex = 0U, /*!< Half duplex mode. */ kENET_MiiFullDuplex /*!< Full duplex mode. */ } enet_mii_duplex_t; /*! @brief Define the MII opcode for normal MDIO_CLAUSES_22 Frame. */ typedef enum _enet_mii_write { kENET_MiiWriteNoCompliant = 0U, /*!< Write frame operation, but not MII-compliant. */ kENET_MiiWriteValidFrame /*!< Write frame operation for a valid MII management frame. */ } enet_mii_write_t; /*! @brief Defines the read operation for the MII management frame. */ typedef enum _enet_mii_read { kENET_MiiReadValidFrame = 2U, /*!< Read frame operation for a valid MII management frame. */ kENET_MiiReadNoCompliant = 3U /*!< Read frame operation, but not MII-compliant. */ } enet_mii_read_t; #if defined(FSL_FEATURE_ENET_HAS_EXTEND_MDIO) && FSL_FEATURE_ENET_HAS_EXTEND_MDIO /*! @brief Define the MII opcode for extended MDIO_CLAUSES_45 Frame. */ typedef enum _enet_mii_extend_opcode { kENET_MiiAddrWrite_C45 = 0U, /*!< Address Write operation. */ kENET_MiiWriteFrame_C45 = 1U, /*!< Write frame operation for a valid MII management frame. */ kENET_MiiReadFrame_C45 = 3U /*!< Read frame operation for a valid MII management frame. */ } enet_mii_extend_opcode; #endif /* FSL_FEATURE_ENET_HAS_EXTEND_MDIO */ /*! @brief Defines a special configuration for ENET MAC controller. * * These control flags are provided for special user requirements. * Normally, these control flags are unused for ENET initialization. * For special requirements, set the flags to * macSpecialConfig in the enet_config_t. * The kENET_ControlStoreAndFwdDisable is used to disable the FIFO store * and forward. FIFO store and forward means that the FIFO read/send is started * when a complete frame is stored in TX/RX FIFO. If this flag is set, * configure rxFifoFullThreshold and txFifoWatermark * in the enet_config_t. */ typedef enum _enet_special_control_flag { kENET_ControlFlowControlEnable = 0x0001U, /*!< Enable ENET flow control: pause frame. */ kENET_ControlRxPayloadCheckEnable = 0x0002U, /*!< Enable ENET receive payload length check. */ kENET_ControlRxPadRemoveEnable = 0x0004U, /*!< Padding is removed from received frames. */ kENET_ControlRxBroadCastRejectEnable = 0x0008U, /*!< Enable broadcast frame reject. */ kENET_ControlMacAddrInsert = 0x0010U, /*!< Enable MAC address insert. */ kENET_ControlStoreAndFwdDisable = 0x0020U, /*!< Enable FIFO store and forward. */ kENET_ControlSMIPreambleDisable = 0x0040U, /*!< Enable SMI preamble. */ kENET_ControlPromiscuousEnable = 0x0080U, /*!< Enable promiscuous mode. */ kENET_ControlMIILoopEnable = 0x0100U, /*!< Enable ENET MII loop back. */ kENET_ControlVLANTagEnable = 0x0200U, /*!< Enable normal VLAN (single vlan tag). */ #if defined(FSL_FEATURE_ENET_HAS_AVB) && FSL_FEATURE_ENET_HAS_AVB kENET_ControlSVLANEnable = 0x0400U, /*!< Enable S-VLAN. */ kENET_ControlVLANUseSecondTag = 0x0800U /*!< Enable extracting the second vlan tag for further processing. */ #endif /* FSL_FEATURE_ENET_HAS_AVB */ } enet_special_control_flag_t; /*! @brief List of interrupts supported by the peripheral. This * enumeration uses one-bit encoding to allow a logical OR of multiple * members. Members usually map to interrupt enable bits in one or more * peripheral registers. */ typedef enum _enet_interrupt_enable { kENET_BabrInterrupt = ENET_EIR_BABR_MASK, /*!< Babbling receive error interrupt source */ kENET_BabtInterrupt = ENET_EIR_BABT_MASK, /*!< Babbling transmit error interrupt source */ kENET_GraceStopInterrupt = ENET_EIR_GRA_MASK, /*!< Graceful stop complete interrupt source */ kENET_TxFrameInterrupt = ENET_EIR_TXF_MASK, /*!< TX FRAME interrupt source */ kENET_TxBufferInterrupt = ENET_EIR_TXB_MASK, /*!< TX BUFFER interrupt source */ kENET_RxFrameInterrupt = ENET_EIR_RXF_MASK, /*!< RX FRAME interrupt source */ kENET_RxBufferInterrupt = ENET_EIR_RXB_MASK, /*!< RX BUFFER interrupt source */ kENET_MiiInterrupt = ENET_EIR_MII_MASK, /*!< MII interrupt source */ kENET_EBusERInterrupt = ENET_EIR_EBERR_MASK, /*!< Ethernet bus error interrupt source */ kENET_LateCollisionInterrupt = ENET_EIR_LC_MASK, /*!< Late collision interrupt source */ kENET_RetryLimitInterrupt = ENET_EIR_RL_MASK, /*!< Collision Retry Limit interrupt source */ kENET_UnderrunInterrupt = ENET_EIR_UN_MASK, /*!< Transmit FIFO underrun interrupt source */ kENET_PayloadRxInterrupt = ENET_EIR_PLR_MASK, /*!< Payload Receive error interrupt source */ kENET_WakeupInterrupt = ENET_EIR_WAKEUP_MASK, /*!< WAKEUP interrupt source */ #if FSL_FEATURE_ENET_QUEUE > 1 kENET_RxFlush2Interrupt = ENET_EIR_RXFLUSH_2_MASK, /*!< Rx DMA ring2 flush indication. */ kENET_RxFlush1Interrupt = ENET_EIR_RXFLUSH_1_MASK, /*!< Rx DMA ring1 flush indication. */ kENET_RxFlush0Interrupt = ENET_EIR_RXFLUSH_0_MASK, /*!< RX DMA ring0 flush indication. */ kENET_TxFrame2Interrupt = ENET_EIR_TXF2_MASK, /*!< Tx frame interrupt for Tx ring/class 2. */ kENET_TxBuffer2Interrupt = ENET_EIR_TXB2_MASK, /*!< Tx buffer interrupt for Tx ring/class 2. */ kENET_RxFrame2Interrupt = ENET_EIR_RXF2_MASK, /*!< Rx frame interrupt for Rx ring/class 2. */ kENET_RxBuffer2Interrupt = ENET_EIR_RXB2_MASK, /*!< Rx buffer interrupt for Rx ring/class 2. */ kENET_TxFrame1Interrupt = ENET_EIR_TXF1_MASK, /*!< Tx frame interrupt for Tx ring/class 1. */ kENET_TxBuffer1Interrupt = ENET_EIR_TXB1_MASK, /*!< Tx buffer interrupt for Tx ring/class 1. */ kENET_RxFrame1Interrupt = ENET_EIR_RXF1_MASK, /*!< Rx frame interrupt for Rx ring/class 1. */ kENET_RxBuffer1Interrupt = ENET_EIR_RXB1_MASK, /*!< Rx buffer interrupt for Rx ring/class 1. */ #endif /* FSL_FEATURE_ENET_QUEUE > 1 */ kENET_TsAvailInterrupt = ENET_EIR_TS_AVAIL_MASK, /*!< TS AVAIL interrupt source for PTP */ kENET_TsTimerInterrupt = ENET_EIR_TS_TIMER_MASK /*!< TS WRAP interrupt source for PTP */ } enet_interrupt_enable_t; /*! @brief Defines the common interrupt event for callback use. */ typedef enum _enet_event { kENET_RxEvent, /*!< Receive event. */ kENET_TxEvent, /*!< Transmit event. */ kENET_ErrEvent, /*!< Error event: BABR/BABT/EBERR/LC/RL/UN/PLR . */ kENET_WakeUpEvent, /*!< Wake up from sleep mode event. */ kENET_TimeStampEvent, /*!< Time stamp event. */ kENET_TimeStampAvailEvent /*!< Time stamp available event.*/ } enet_event_t; #if defined(FSL_FEATURE_ENET_HAS_AVB) && FSL_FEATURE_ENET_HAS_AVB /*! @brief Defines certain idle slope for bandwidth fraction. */ typedef enum _enet_idle_slope { kENET_IdleSlope1 = 1U, /*!< The bandwidth fraction is about 0.002. */ kENET_IdleSlope2 = 2U, /*!< The bandwidth fraction is about 0.003. */ kENET_IdleSlope4 = 4U, /*!< The bandwidth fraction is about 0.008. */ kENET_IdleSlope8 = 8U, /*!< The bandwidth fraction is about 0.02. */ kENET_IdleSlope16 = 16U, /*!< The bandwidth fraction is about 0.03. */ kENET_IdleSlope32 = 32U, /*!< The bandwidth fraction is about 0.06. */ kENET_IdleSlope64 = 64U, /*!< The bandwidth fraction is about 0.11. */ kENET_IdleSlope128 = 128U, /*!< The bandwidth fraction is about 0.20. */ kENET_IdleSlope256 = 256U, /*!< The bandwidth fraction is about 0.33. */ kENET_IdleSlope384 = 384U, /*!< The bandwidth fraction is about 0.43. */ kENET_IdleSlope512 = 512U, /*!< The bandwidth fraction is about 0.50. */ kENET_IdleSlope640 = 640U, /*!< The bandwidth fraction is about 0.56. */ kENET_IdleSlope768 = 768U, /*!< The bandwidth fraction is about 0.60. */ kENET_IdleSlope896 = 896U, /*!< The bandwidth fraction is about 0.64. */ kENET_IdleSlope1024 = 1024U, /*!< The bandwidth fraction is about 0.67. */ kENET_IdleSlope1152 = 1152U, /*!< The bandwidth fraction is about 0.69. */ kENET_IdleSlope1280 = 1280U, /*!< The bandwidth fraction is about 0.71. */ kENET_IdleSlope1408 = 1408U, /*!< The bandwidth fraction is about 0.73. */ kENET_IdleSlope1536 = 1536U /*!< The bandwidth fraction is about 0.75. */ } enet_idle_slope_t; #endif /* FSL_FEATURE_ENET_HAS_AVB */ /*! @brief Defines the transmit accelerator configuration. */ typedef enum _enet_tx_accelerator { kENET_TxAccelIsShift16Enabled = ENET_TACC_SHIFT16_MASK, /*!< Transmit FIFO shift-16. */ kENET_TxAccelIpCheckEnabled = ENET_TACC_IPCHK_MASK, /*!< Insert IP header checksum. */ kENET_TxAccelProtoCheckEnabled = ENET_TACC_PROCHK_MASK /*!< Insert protocol checksum. */ } enet_tx_accelerator_t; /*! @brief Defines the receive accelerator configuration. */ typedef enum _enet_rx_accelerator { kENET_RxAccelPadRemoveEnabled = ENET_RACC_PADREM_MASK, /*!< Padding removal for short IP frames. */ kENET_RxAccelIpCheckEnabled = ENET_RACC_IPDIS_MASK, /*!< Discard with wrong IP header checksum. */ kENET_RxAccelProtoCheckEnabled = ENET_RACC_PRODIS_MASK, /*!< Discard with wrong protocol checksum. */ kENET_RxAccelMacCheckEnabled = ENET_RACC_LINEDIS_MASK, /*!< Discard with Mac layer errors. */ kENET_RxAccelisShift16Enabled = ENET_RACC_SHIFT16_MASK /*!< Receive FIFO shift-16. */ } enet_rx_accelerator_t; #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE /*! @brief Defines the ENET PTP message related constant. */ typedef enum _enet_ptp_event_type { kENET_PtpEventMsgType = 3U, /*!< PTP event message type. */ kENET_PtpSrcPortIdLen = 10U, /*!< PTP message sequence id length. */ kENET_PtpEventPort = 319U, /*!< PTP event port number. */ kENET_PtpGnrlPort = 320U /*!< PTP general port number. */ } enet_ptp_event_type_t; /*! @brief Defines the IEEE 1588 PTP timer channel numbers. */ typedef enum _enet_ptp_timer_channel { kENET_PtpTimerChannel1 = 0U, /*!< IEEE 1588 PTP timer Channel 1. */ kENET_PtpTimerChannel2, /*!< IEEE 1588 PTP timer Channel 2. */ kENET_PtpTimerChannel3, /*!< IEEE 1588 PTP timer Channel 3. */ kENET_PtpTimerChannel4 /*!< IEEE 1588 PTP timer Channel 4. */ } enet_ptp_timer_channel_t; /*! @brief Defines the capture or compare mode for IEEE 1588 PTP timer channels. */ typedef enum _enet_ptp_timer_channel_mode { kENET_PtpChannelDisable = 0U, /*!< Disable timer channel. */ kENET_PtpChannelRisingCapture = 1U, /*!< Input capture on rising edge. */ kENET_PtpChannelFallingCapture = 2U, /*!< Input capture on falling edge. */ kENET_PtpChannelBothCapture = 3U, /*!< Input capture on both edges. */ kENET_PtpChannelSoftCompare = 4U, /*!< Output compare software only. */ kENET_PtpChannelToggleCompare = 5U, /*!< Toggle output on compare. */ kENET_PtpChannelClearCompare = 6U, /*!< Clear output on compare. */ kENET_PtpChannelSetCompare = 7U, /*!< Set output on compare. */ kENET_PtpChannelClearCompareSetOverflow = 10U, /*!< Clear output on compare, set output on overflow. */ kENET_PtpChannelSetCompareClearOverflow = 11U, /*!< Set output on compare, clear output on overflow. */ kENET_PtpChannelPulseLowonCompare = 14U, /*!< Pulse output low on compare for one IEEE 1588 clock cycle. */ kENET_PtpChannelPulseHighonCompare = 15U /*!< Pulse output high on compare for one IEEE 1588 clock cycle. */ } enet_ptp_timer_channel_mode_t; #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ /*! @brief Defines the receive buffer descriptor structure for the little endian system.*/ typedef struct _enet_rx_bd_struct { uint16_t length; /*!< Buffer descriptor data length. */ uint16_t control; /*!< Buffer descriptor control and status. */ uint8_t *buffer; /*!< Data buffer pointer. */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE uint16_t controlExtend0; /*!< Extend buffer descriptor control0. */ uint16_t controlExtend1; /*!< Extend buffer descriptor control1. */ uint16_t payloadCheckSum; /*!< Internal payload checksum. */ uint8_t headerLength; /*!< Header length. */ uint8_t protocolTyte; /*!< Protocol type. */ uint16_t reserved0; uint16_t controlExtend2; /*!< Extend buffer descriptor control2. */ uint32_t timestamp; /*!< Timestamp. */ uint16_t reserved1; uint16_t reserved2; uint16_t reserved3; uint16_t reserved4; #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ } enet_rx_bd_struct_t; /*! @brief Defines the enhanced transmit buffer descriptor structure for the little endian system. */ typedef struct _enet_tx_bd_struct { uint16_t length; /*!< Buffer descriptor data length. */ uint16_t control; /*!< Buffer descriptor control and status. */ uint8_t *buffer; /*!< Data buffer pointer. */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE uint16_t controlExtend0; /*!< Extend buffer descriptor control0. */ uint16_t controlExtend1; /*!< Extend buffer descriptor control1. */ #if defined(FSL_FEATURE_ENET_HAS_AVB) && FSL_FEATURE_ENET_HAS_AVB uint16_t txLaunchTimeLow; /*!< Low 16-bits of transmit launch time. */ uint16_t txLaunchTimeHigh; /*!< High 16-bits of transmit launch time. */ #else uint16_t reserved0; uint16_t reserved1; #endif /* FSL_FEATURE_ENET_HAS_AVB */ uint16_t reserved2; uint16_t controlExtend2; /*!< Extend buffer descriptor control2. */ uint32_t timestamp; /*!< Timestamp. */ uint16_t reserved3; uint16_t reserved4; uint16_t reserved5; uint16_t reserved6; #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ } enet_tx_bd_struct_t; /*! @brief Defines the ENET data error statistics structure. */ typedef struct _enet_data_error_stats { uint32_t statsRxLenGreaterErr; /*!< Receive length greater than RCR[MAX_FL]. */ uint32_t statsRxAlignErr; /*!< Receive non-octet alignment/ */ uint32_t statsRxFcsErr; /*!< Receive CRC error. */ uint32_t statsRxOverRunErr; /*!< Receive over run. */ uint32_t statsRxTruncateErr; /*!< Receive truncate. */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE uint32_t statsRxProtocolChecksumErr; /*!< Receive protocol checksum error. */ uint32_t statsRxIpHeadChecksumErr; /*!< Receive IP header checksum error. */ uint32_t statsRxMacErr; /*!< Receive Mac error. */ uint32_t statsRxPhyErr; /*!< Receive PHY error. */ uint32_t statsRxCollisionErr; /*!< Receive collision. */ uint32_t statsTxErr; /*!< The error happen when transmit the frame. */ uint32_t statsTxFrameErr; /*!< The transmit frame is error. */ uint32_t statsTxOverFlowErr; /*!< Transmit overflow. */ uint32_t statsTxLateCollisionErr; /*!< Transmit late collision. */ uint32_t statsTxExcessCollisionErr; /*!< Transmit excess collision.*/ uint32_t statsTxUnderFlowErr; /*!< Transmit under flow error. */ uint32_t statsTxTsErr; /*!< Transmit time stamp error. */ #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ } enet_data_error_stats_t; /*! @brief Defines the Rx frame error structure. */ typedef struct _enet_rx_frame_error { bool statsRxTruncateErr : 1; /*!< Receive truncate. */ bool statsRxOverRunErr : 1; /*!< Receive over run. */ bool statsRxFcsErr : 1; /*!< Receive CRC error. */ bool : 1; bool statsRxAlignErr : 1; /*!< Receive non-octet alignment. */ bool statsRxLenGreaterErr : 1; /*!< Receive length greater than RCR[MAX_FL]. */ uint32_t : 19; #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE bool statsRxCollisionErr : 1; /*!< Receive collision. */ bool statsRxPhyErr : 1; /*!< Receive PHY error. */ uint8_t : 4; bool statsRxMacErr : 1; /*!< Receive Mac error. */ #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ } enet_rx_frame_error_t; /*! @brief Defines the ENET transfer statistics structure. */ typedef struct _enet_transfer_stats { uint32_t statsRxFrameCount; /*!< Rx frame number. */ uint32_t statsRxFrameOk; /*!< Good Rx frame number. */ uint32_t statsRxCrcErr; /*!< Rx frame number with CRC error. */ uint32_t statsRxAlignErr; /*!< Rx frame number with alignment error. */ uint32_t statsRxDropInvalidSFD; /*!< Dropped frame number due to invalid SFD. */ uint32_t statsRxFifoOverflowErr; /*!< Rx FIFO overflow count. */ uint32_t statsTxFrameCount; /*!< Tx frame number. */ uint32_t statsTxFrameOk; /*!< Good Tx frame number. */ uint32_t statsTxCrcAlignErr; /*!< The transmit frame is error. */ uint32_t statsTxFifoUnderRunErr; /*!< Tx FIFO underrun count. */ } enet_transfer_stats_t; #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE /*! @brief Defines the ENET PTP time stamp structure. */ typedef struct _enet_ptp_time { uint64_t second; /*!< Second. */ uint32_t nanosecond; /*!< Nanosecond. */ } enet_ptp_time_t; /*! @brief Defines the structure for the ENET PTP message data and timestamp data.*/ typedef struct _enet_ptp_time_data { uint8_t version; /*!< PTP version. */ uint8_t sourcePortId[kENET_PtpSrcPortIdLen]; /*!< PTP source port ID. */ uint16_t sequenceId; /*!< PTP sequence ID. */ uint8_t messageType; /*!< PTP message type. */ enet_ptp_time_t timeStamp; /*!< PTP timestamp. */ } enet_ptp_time_data_t; /*! @brief Defines the ENET PTP configuration structure. */ typedef struct _enet_ptp_config { enet_ptp_timer_channel_t channel; /*!< Used for ERRATA_2579: the PTP 1588 timer channel for time interrupt. */ uint32_t ptp1588ClockSrc_Hz; /*!< The clock source of the PTP 1588 timer. */ } enet_ptp_config_t; #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ /*! @brief Defines the frame info structure. */ typedef struct enet_frame_info { void *context; /*!< User specified data */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE bool isTsAvail; /*!< Flag indicates timestamp available status */ enet_ptp_time_t timeStamp; /*!< Timestamp of frame */ #endif } enet_frame_info_t; /*! @brief Defines the ENET transmit dirty addresses ring/queue structure. */ typedef struct _enet_tx_dirty_ring { enet_frame_info_t *txDirtyBase; /*!< Dirty buffer descriptor base address pointer. */ uint16_t txGenIdx; /*!< tx generate index. */ uint16_t txConsumIdx; /*!< tx consume index. */ uint16_t txRingLen; /*!< tx ring length. */ bool isFull; /*!< tx ring is full flag. */ } enet_tx_dirty_ring_t; /*! @brief Defines the ENET Rx memory buffer alloc function pointer. */ typedef void *(*enet_rx_alloc_callback_t)(ENET_Type *base, void *userData, uint8_t ringId); /*! @brief Defines the ENET Rx memory buffer free function pointer. */ typedef void (*enet_rx_free_callback_t)(ENET_Type *base, void *buffer, void *userData, uint8_t ringId); /*! @brief Defines the receive buffer descriptor configuration structure. * * Note that for the internal DMA requirements, the buffers have a corresponding alignment requirements. * 1. The aligned receive and transmit buffer size must be evenly divisible by ENET_BUFF_ALIGNMENT. * when the data buffers are in cacheable region when cache is enabled, all those size should be * aligned to the maximum value of "ENET_BUFF_ALIGNMENT" and the cache line size. * 2. The aligned transmit and receive buffer descriptor start address must be at * least 64 bit aligned. However, it's recommended to be evenly divisible by ENET_BUFF_ALIGNMENT. * buffer descriptors should be put in non-cacheable region when cache is enabled. * 3. The aligned transmit and receive data buffer start address must be evenly divisible by ENET_BUFF_ALIGNMENT. * Receive buffers should be continuous with the total size equal to "rxBdNumber * rxBuffSizeAlign". * Transmit buffers should be continuous with the total size equal to "txBdNumber * txBuffSizeAlign". * when the data buffers are in cacheable region when cache is enabled, all those size should be * aligned to the maximum value of "ENET_BUFF_ALIGNMENT" and the cache line size. */ typedef struct _enet_buffer_config { uint16_t rxBdNumber; /*!< Receive buffer descriptor number. */ uint16_t txBdNumber; /*!< Transmit buffer descriptor number. */ uint16_t rxBuffSizeAlign; /*!< Aligned receive data buffer size. */ uint16_t txBuffSizeAlign; /*!< Aligned transmit data buffer size. */ volatile enet_rx_bd_struct_t *rxBdStartAddrAlign; /*!< Aligned receive buffer descriptor start address: should be non-cacheable. */ volatile enet_tx_bd_struct_t *txBdStartAddrAlign; /*!< Aligned transmit buffer descriptor start address: should be non-cacheable. */ uint8_t *rxBufferAlign; /*!< Receive data buffer start address. */ uint8_t *txBufferAlign; /*!< Transmit data buffer start address. */ bool rxMaintainEnable; /*!< Receive buffer cache maintain. */ bool txMaintainEnable; /*!< Transmit buffer cache maintain. */ enet_frame_info_t *txFrameInfo; /*!< Transmit frame information start address. */ } enet_buffer_config_t; #if defined(FSL_FEATURE_ENET_HAS_INTERRUPT_COALESCE) && FSL_FEATURE_ENET_HAS_INTERRUPT_COALESCE /*! @brief Defines the interrupt coalescing configure structure. */ typedef struct _enet_intcoalesce_config { uint8_t txCoalesceFrameCount[FSL_FEATURE_ENET_QUEUE]; /*!< Transmit interrupt coalescing frame count threshold. */ uint16_t txCoalesceTimeCount[FSL_FEATURE_ENET_QUEUE]; /*!< Transmit interrupt coalescing timer count threshold. */ uint8_t rxCoalesceFrameCount[FSL_FEATURE_ENET_QUEUE]; /*!< Receive interrupt coalescing frame count threshold. */ uint16_t rxCoalesceTimeCount[FSL_FEATURE_ENET_QUEUE]; /*!< Receive interrupt coalescing timer count threshold. */ } enet_intcoalesce_config_t; #endif /* FSL_FEATURE_ENET_HAS_INTERRUPT_COALESCE */ #if defined(FSL_FEATURE_ENET_HAS_AVB) && FSL_FEATURE_ENET_HAS_AVB /*! @brief Defines the ENET AVB Configure structure. * * This is used for to configure the extended ring 1 and ring 2. * 1. The classification match format is (CMP3 << 12) | (CMP2 << 8) | (CMP1 << 4) | CMP0. * composed of four 3-bit compared VLAN priority field cmp0~cmp3, cm0 ~ cmp3 are used in parallel. * * If CMP1,2,3 are not unused, please set them to the same value as CMP0. * 2. The idleSlope is used to calculate the Band Width fraction, BW fraction = 1 / (1 + 512/idleSlope). * For avb configuration, the BW fraction of Class 1 and Class 2 combined must not exceed 0.75. */ typedef struct _enet_avb_config { uint16_t rxClassifyMatch[FSL_FEATURE_ENET_QUEUE - 1]; /*!< The classification match value for the ring. */ enet_idle_slope_t idleSlope[FSL_FEATURE_ENET_QUEUE - 1]; /*!< The idle slope for certian bandwidth fraction. */ } enet_avb_config_t; #endif /* FSL_FEATURE_ENET_HAS_AVB */ /* Forward declaration of the handle typedef. */ typedef struct _enet_handle enet_handle_t; /*! @brief ENET callback function. */ typedef void (*enet_callback_t)(ENET_Type *base, enet_handle_t *handle, #if FSL_FEATURE_ENET_QUEUE > 1 uint32_t ringId, #endif /* FSL_FEATURE_ENET_QUEUE > 1 */ enet_event_t event, enet_frame_info_t *frameInfo, void *userData); /*! @brief Defines the basic configuration structure for the ENET device. * * Note: * 1. macSpecialConfig is used for a special control configuration, A logical OR of * "enet_special_control_flag_t". For a special configuration for MAC, * set this parameter to 0. * 2. txWatermark is used for a cut-through operation. It is in steps of 64 bytes: * 0/1 - 64 bytes written to TX FIFO before transmission of a frame begins. * 2 - 128 bytes written to TX FIFO .... * 3 - 192 bytes written to TX FIFO .... * The maximum of txWatermark is 0x2F - 4032 bytes written to TX FIFO .... * txWatermark allows minimizing the transmit latency to set the txWatermark to 0 or 1 * or for larger bus access latency 3 or larger due to contention for the system bus. * 3. rxFifoFullThreshold is similar to the txWatermark for cut-through operation in RX. * It is in 64-bit words. The minimum is ENET_FIFO_MIN_RX_FULL and the maximum is 0xFF. * If the end of the frame is stored in FIFO and the frame size if smaller than the * txWatermark, the frame is still transmitted. The rule is the * same for rxFifoFullThreshold in the receive direction. * 4. When "kENET_ControlFlowControlEnable" is set in the macSpecialConfig, ensure * that the pauseDuration, rxFifoEmptyThreshold, and rxFifoStatEmptyThreshold * are set for flow control enabled case. * 5. When "kENET_ControlStoreAndFwdDisabled" is set in the macSpecialConfig, ensure * that the rxFifoFullThreshold and txFifoWatermark are set for store and forward disable. * 6. The rxAccelerConfig and txAccelerConfig default setting with 0 - accelerator * are disabled. The "enet_tx_accelerator_t" and "enet_rx_accelerator_t" are * recommended to be used to enable the transmit and receive accelerator. * After the accelerators are enabled, the store and forward feature should be enabled. * As a result, kENET_ControlStoreAndFwdDisabled should not be set. * 7. The intCoalesceCfg can be used in the rx or tx enabled cases to decrese the CPU loading. */ typedef struct _enet_config { uint32_t macSpecialConfig; /*!< Mac special configuration. A logical OR of "enet_special_control_flag_t". */ uint32_t interrupt; /*!< Mac interrupt source. A logical OR of "enet_interrupt_enable_t". */ uint16_t rxMaxFrameLen; /*!< Receive maximum frame length. */ enet_mii_mode_t miiMode; /*!< MII mode. */ enet_mii_speed_t miiSpeed; /*!< MII Speed. */ enet_mii_duplex_t miiDuplex; /*!< MII duplex. */ uint8_t rxAccelerConfig; /*!< Receive accelerator, A logical OR of "enet_rx_accelerator_t". */ uint8_t txAccelerConfig; /*!< Transmit accelerator, A logical OR of "enet_rx_accelerator_t". */ uint16_t pauseDuration; /*!< For flow control enabled case: Pause duration. */ uint8_t rxFifoEmptyThreshold; /*!< For flow control enabled case: when RX FIFO level reaches this value, it makes MAC generate XOFF pause frame. */ #if defined(FSL_FEATURE_ENET_HAS_RECEIVE_STATUS_THRESHOLD) && FSL_FEATURE_ENET_HAS_RECEIVE_STATUS_THRESHOLD uint8_t rxFifoStatEmptyThreshold; /*!< For flow control enabled case: number of frames in the receive FIFO, independent of size, that can be accept. If the limit is reached, reception continues and a pause frame is triggered. */ #endif /* FSL_FEATURE_ENET_HAS_RECEIVE_STATUS_THRESHOLD */ uint8_t rxFifoFullThreshold; /*!< For store and forward disable case, the data required in RX FIFO to notify the MAC receive ready status. */ uint8_t txFifoWatermark; /*!< For store and forward disable case, the data required in TX FIFO before a frame transmit start. */ #if defined(FSL_FEATURE_ENET_HAS_INTERRUPT_COALESCE) && FSL_FEATURE_ENET_HAS_INTERRUPT_COALESCE enet_intcoalesce_config_t *intCoalesceCfg; /*!< If the interrupt coalsecence is not required in the ring n(0,1,2), please set to NULL. */ #endif /* FSL_FEATURE_ENET_HAS_INTERRUPT_COALESCE */ uint8_t ringNum; /*!< Number of used rings. default with 1 -- single ring. */ enet_rx_alloc_callback_t rxBuffAlloc; /*!< Callback function to alloc memory, must be provided for zero-copy Rx. */ enet_rx_free_callback_t rxBuffFree; /*!< Callback function to free memory, must be provided for zero-copy Rx. */ enet_callback_t callback; /*!< General callback function. */ void *userData; /*!< Callback function parameter.*/ } enet_config_t; /*! @brief Defines the ENET transmit buffer descriptor ring/queue structure. */ typedef struct _enet_tx_bd_ring { volatile enet_tx_bd_struct_t *txBdBase; /*!< Buffer descriptor base address pointer. */ uint16_t txGenIdx; /*!< The current available transmit buffer descriptor pointer. */ uint16_t txConsumIdx; /*!< Transmit consume index. */ volatile uint16_t txDescUsed; /*!< Transmit descriptor used number. */ uint16_t txRingLen; /*!< Transmit ring length. */ } enet_tx_bd_ring_t; /*! @brief Defines the ENET receive buffer descriptor ring/queue structure. */ typedef struct _enet_rx_bd_ring { volatile enet_rx_bd_struct_t *rxBdBase; /*!< Buffer descriptor base address pointer. */ uint16_t rxGenIdx; /*!< The current available receive buffer descriptor pointer. */ uint16_t rxRingLen; /*!< Receive ring length. */ } enet_rx_bd_ring_t; /*! @brief Defines the ENET handler structure. */ struct _enet_handle { enet_rx_bd_ring_t rxBdRing[FSL_FEATURE_ENET_QUEUE]; /*!< Receive buffer descriptor. */ enet_tx_bd_ring_t txBdRing[FSL_FEATURE_ENET_QUEUE]; /*!< Transmit buffer descriptor. */ uint16_t rxBuffSizeAlign[FSL_FEATURE_ENET_QUEUE]; /*!< Receive buffer size alignment. */ uint16_t txBuffSizeAlign[FSL_FEATURE_ENET_QUEUE]; /*!< Transmit buffer size alignment. */ bool rxMaintainEnable[FSL_FEATURE_ENET_QUEUE]; /*!< Receive buffer cache maintain. */ bool txMaintainEnable[FSL_FEATURE_ENET_QUEUE]; /*!< Transmit buffer cache maintain. */ uint8_t ringNum; /*!< Number of used rings. */ enet_callback_t callback; /*!< Callback function. */ void *userData; /*!< Callback function parameter.*/ enet_tx_dirty_ring_t txDirtyRing[FSL_FEATURE_ENET_QUEUE]; /*!< Ring to store tx frame information.*/ bool txReclaimEnable[FSL_FEATURE_ENET_QUEUE]; /*!< Tx reclaim enable flag.*/ enet_rx_alloc_callback_t rxBuffAlloc; /*!< Callback function to alloc memory for zero copy Rx. */ enet_rx_free_callback_t rxBuffFree; /*!< Callback function to free memory for zero copy Rx. */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE volatile enet_tx_bd_struct_t *txBdDirtyStatic[FSL_FEATURE_ENET_QUEUE]; /*!< The dirty transmit buffer descriptor for error static update. */ uint64_t msTimerSecond; /*!< The second for Master PTP timer. */ #endif uint8_t multicastCount[64]; /*!< Multicast collisions counter */ #if defined(FSL_FEATURE_ENET_TIMESTAMP_CAPTURE_BIT_INVALID) && FSL_FEATURE_ENET_TIMESTAMP_CAPTURE_BIT_INVALID uint32_t enetClock; /*!< The clock of enet peripheral, to caculate core cycles for PTP timestamp.*/ uint32_t tsDelayCount; /*!< The count of core cycles for PTP timestamp capture delay.*/ #endif }; typedef struct _enet_buffer_struct { void *buffer; /*!< The buffer store the whole or partial frame. */ uint16_t length; /*!< The byte length of this buffer. */ } enet_buffer_struct_t; typedef struct _enet_rx_frame_attribute_struct { bool promiscuous; /*!< This frame is received because of promiscuous mode. */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE uint32_t timestamp; /*!< The nanosecond part timestamp of this Rx frame. */ #endif } enet_rx_frame_attribute_t; typedef struct _enet_rx_frame_struct { enet_buffer_struct_t *rxBuffArray; /*!< Rx frame buffer structure. */ uint16_t totLen; /*!< Rx frame total length. */ enet_rx_frame_attribute_t rxAttribute; /*!< Rx frame attribute structure. */ enet_rx_frame_error_t rxFrameError; /*!< Rx frame error. */ } enet_rx_frame_struct_t; #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE typedef struct _enet_tx_config_struct { bool intEnable : 1; bool tsEnable : 1; bool autoProtocolChecksum : 1; bool autoIPChecksum : 1; uint8_t AVBFrameType : 4; /*!< AVB class type. */ bool tltEnable : 1; /*!< Transmit launch time enable. */ uint16_t tltLow; /*!< Specifies when frame can be transmitted. */ uint16_t tltHigh; /*!< Specifies when frame can be transmitted. */ } enet_tx_config_struct_t; #endif typedef struct _enet_tx_frame_struct { enet_buffer_struct_t *txBuffArray; /*!< Tx frame buffer structure. */ uint32_t txBuffNum; /*!< Buffer number of this Tx frame. */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE enet_tx_config_struct_t txConfig; /*!< Tx extra configuation. */ #endif void *context; /*!< Driver reclaims and gives it in Tx over callback, usually store network packet header. */ } enet_tx_frame_struct_t; /*! @brief Define interrupt IRQ handler. */ #if FSL_FEATURE_ENET_QUEUE > 1 typedef void (*enet_isr_ring_t)(ENET_Type *base, enet_handle_t *handle, uint32_t ringId); #endif /* FSL_FEATURE_ENET_QUEUE > 1 */ typedef void (*enet_isr_t)(ENET_Type *base, enet_handle_t *handle); /*! @brief Pointers to enet clocks for each instance. */ #if !(defined(FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL) && FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL) extern const clock_ip_name_t s_enetClock[]; #if defined(FSL_FEATURE_ENET_HAS_EXTRA_CLOCK_GATE) && FSL_FEATURE_ENET_HAS_EXTRA_CLOCK_GATE extern const clock_ip_name_t s_enetExtraClock[]; #endif #endif /* FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL */ /******************************************************************************* * API ******************************************************************************/ #if defined(__cplusplus) extern "C" { #endif /*! * @brief Get the ENET instance from peripheral base address. * * @param base ENET peripheral base address. * @return ENET instance. */ uint32_t ENET_GetInstance(ENET_Type *base); /*! * @name Initialization and De-initialization * @{ */ /*! * @brief Gets the ENET default configuration structure. * * The purpose of this API is to get the default ENET MAC controller * configure structure for ENET_Init(). User may use the initialized * structure unchanged in ENET_Init(), or modify some fields of the * structure before calling ENET_Init(). * Example: @code enet_config_t config; ENET_GetDefaultConfig(&config); @endcode * @param config The ENET mac controller configuration structure pointer. */ void ENET_GetDefaultConfig(enet_config_t *config); /*! * @brief Initializes the ENET module. * * This function initializes the module with the ENET configuration. * @note ENET has two buffer descriptors legacy buffer descriptors and * enhanced IEEE 1588 buffer descriptors. The legacy descriptor is used by default. To * use the IEEE 1588 feature, use the enhanced IEEE 1588 buffer descriptor * by defining "ENET_ENHANCEDBUFFERDESCRIPTOR_MODE" and calling ENET_Ptp1588Configure() * to configure the 1588 feature and related buffers after calling ENET_Up(). * * @param base ENET peripheral base address. * @param handle ENET handler pointer. * @param config ENET mac configuration structure pointer. * The "enet_config_t" type mac configuration return from ENET_GetDefaultConfig * can be used directly. It is also possible to verify the Mac configuration using other methods. * @param bufferConfig ENET buffer configuration structure pointer. * The buffer configuration should be prepared for ENET Initialization. * It is the start address of "ringNum" enet_buffer_config structures. * To support added multi-ring features in some soc and compatible with the previous * enet driver version. For single ring supported, this bufferConfig is a buffer * configure structure pointer, for multi-ring supported and used case, this bufferConfig * pointer should be a buffer configure structure array pointer. * @param macAddr ENET mac address of Ethernet device. This MAC address should be * provided. * @param srcClock_Hz The internal module clock source for MII clock. * @retval kStatus_Success Succeed to initialize the ethernet driver. * @retval kStatus_ENET_InitMemoryFail Init fails since buffer memory is not enough. * */ status_t ENET_Up(ENET_Type *base, enet_handle_t *handle, const enet_config_t *config, const enet_buffer_config_t *bufferConfig, uint8_t *macAddr, uint32_t srcClock_Hz); /*! * @brief Initializes the ENET module. * * This function ungates the module clock and initializes it with the ENET configuration. * @note ENET has two buffer descriptors legacy buffer descriptors and * enhanced IEEE 1588 buffer descriptors. The legacy descriptor is used by default. To * use the IEEE 1588 feature, use the enhanced IEEE 1588 buffer descriptor * by defining "ENET_ENHANCEDBUFFERDESCRIPTOR_MODE" and calling ENET_Ptp1588Configure() * to configure the 1588 feature and related buffers after calling ENET_Init(). * * @param base ENET peripheral base address. * @param handle ENET handler pointer. * @param config ENET mac configuration structure pointer. * The "enet_config_t" type mac configuration return from ENET_GetDefaultConfig * can be used directly. It is also possible to verify the Mac configuration using other methods. * @param bufferConfig ENET buffer configuration structure pointer. * The buffer configuration should be prepared for ENET Initialization. * It is the start address of "ringNum" enet_buffer_config structures. * To support added multi-ring features in some soc and compatible with the previous * enet driver version. For single ring supported, this bufferConfig is a buffer * configure structure pointer, for multi-ring supported and used case, this bufferConfig * pointer should be a buffer configure structure array pointer. * @param macAddr ENET mac address of Ethernet device. This MAC address should be * provided. * @param srcClock_Hz The internal module clock source for MII clock. * @retval kStatus_Success Succeed to initialize the ethernet driver. * @retval kStatus_ENET_InitMemoryFail Init fails since buffer memory is not enough. */ status_t ENET_Init(ENET_Type *base, enet_handle_t *handle, const enet_config_t *config, const enet_buffer_config_t *bufferConfig, uint8_t *macAddr, uint32_t srcClock_Hz); /*! * @brief Stops the ENET module. * This function disables the ENET module. * * @param base ENET peripheral base address. */ void ENET_Down(ENET_Type *base); /*! * @brief Deinitializes the ENET module. * This function gates the module clock, clears ENET interrupts, and disables the ENET module. * * @param base ENET peripheral base address. */ void ENET_Deinit(ENET_Type *base); /*! * @brief Resets the ENET module. * * This function restores the ENET module to reset state. * Note that this function sets all registers to * reset state. As a result, the ENET module can't work after calling this function. * * @param base ENET peripheral base address. */ static inline void ENET_Reset(ENET_Type *base) { base->ECR |= ENET_ECR_RESET_MASK; } /* @} */ /*! * @name MII interface operation * @{ */ /*! * @brief Sets the ENET MII speed and duplex. * * This API is provided to dynamically change the speed and dulpex for MAC. * * @param base ENET peripheral base address. * @param speed The speed of the RMII mode. * @param duplex The duplex of the RMII mode. */ void ENET_SetMII(ENET_Type *base, enet_mii_speed_t speed, enet_mii_duplex_t duplex); /*! * @brief Sets the ENET SMI(serial management interface)- MII management interface. * * @param base ENET peripheral base address. * @param srcClock_Hz This is the ENET module clock frequency. See clock distribution. * @param isPreambleDisabled The preamble disable flag. * - true Enables the preamble. * - false Disables the preamble. */ void ENET_SetSMI(ENET_Type *base, uint32_t srcClock_Hz, bool isPreambleDisabled); /*! * @brief Gets the ENET SMI- MII management interface configuration. * * This API is used to get the SMI configuration to check whether the MII management * interface has been set. * * @param base ENET peripheral base address. * @return The SMI setup status true or false. */ static inline bool ENET_GetSMI(ENET_Type *base) { return (0U != (base->MSCR & 0x7EU)); } /*! * @brief Reads data from the PHY register through an SMI interface. * * @param base ENET peripheral base address. * @return The data read from PHY */ static inline uint32_t ENET_ReadSMIData(ENET_Type *base) { return (uint32_t)((base->MMFR & ENET_MMFR_DATA_MASK) >> ENET_MMFR_DATA_SHIFT); } /*! * @brief Starts an SMI (Serial Management Interface) read command. * * Used for standard IEEE802.3 MDIO Clause 22 format. * * @param base ENET peripheral base address. * @param phyAddr The PHY address. * @param phyReg The PHY register. Range from 0 ~ 31. * @param operation The read operation. */ void ENET_StartSMIRead(ENET_Type *base, uint32_t phyAddr, uint32_t phyReg, enet_mii_read_t operation); /*! * @brief Starts an SMI write command. * * Used for standard IEEE802.3 MDIO Clause 22 format. * * @param base ENET peripheral base address. * @param phyAddr The PHY address. * @param phyReg The PHY register. Range from 0 ~ 31. * @param operation The write operation. * @param data The data written to PHY. */ void ENET_StartSMIWrite(ENET_Type *base, uint32_t phyAddr, uint32_t phyReg, enet_mii_write_t operation, uint32_t data); #if defined(FSL_FEATURE_ENET_HAS_EXTEND_MDIO) && FSL_FEATURE_ENET_HAS_EXTEND_MDIO /*! * @brief Starts the extended IEEE802.3 Clause 45 MDIO format SMI write register command. * * @param base ENET peripheral base address. * @param phyAddr The PHY address. * @param phyReg The PHY register. For MDIO IEEE802.3 Clause 45, * the phyReg is a 21-bits combination of the devaddr (5 bits device address) * and the regAddr (16 bits phy register): phyReg = (devaddr << 16) | regAddr. */ void ENET_StartExtC45SMIWriteReg(ENET_Type *base, uint32_t phyAddr, uint32_t phyReg); /*! * @brief Starts the extended IEEE802.3 Clause 45 MDIO format SMI write data command. * * After writing MMFR register, we need to check whether the transmission is over. * This is an example for whole precedure of clause 45 MDIO write. * @code * ENET_ClearInterruptStatus(base, ENET_EIR_MII_MASK); * ENET_StartExtC45SMIWriteReg(base, phyAddr, phyReg); * while ((ENET_GetInterruptStatus(base) & ENET_EIR_MII_MASK) == 0U) * { * } * ENET_ClearInterruptStatus(base, ENET_EIR_MII_MASK); * ENET_StartExtC45SMIWriteData(base, phyAddr, phyReg, data); * while ((ENET_GetInterruptStatus(base) & ENET_EIR_MII_MASK) == 0U) * { * } * ENET_ClearInterruptStatus(base, ENET_EIR_MII_MASK); * @endcode * @param base ENET peripheral base address. * @param phyAddr The PHY address. * @param phyReg The PHY register. For MDIO IEEE802.3 Clause 45, * the phyReg is a 21-bits combination of the devaddr (5 bits device address) * and the regAddr (16 bits phy register): phyReg = (devaddr << 16) | regAddr. * @param data The data written to PHY. */ void ENET_StartExtC45SMIWriteData(ENET_Type *base, uint32_t phyAddr, uint32_t phyReg, uint32_t data); /*! * @brief Starts the extended IEEE802.3 Clause 45 MDIO format SMI read data command. * * After writing MMFR register, we need to check whether the transmission is over. * This is an example for whole precedure of clause 45 MDIO read. * @code * uint32_t data; * ENET_ClearInterruptStatus(base, ENET_EIR_MII_MASK); * ENET_StartExtC45SMIWriteReg(base, phyAddr, phyReg); * while ((ENET_GetInterruptStatus(base) & ENET_EIR_MII_MASK) == 0U) * { * } * ENET_ClearInterruptStatus(base, ENET_EIR_MII_MASK); * ENET_StartExtC45SMIReadData(base, phyAddr, phyReg); * while ((ENET_GetInterruptStatus(base) & ENET_EIR_MII_MASK) == 0U) * { * } * ENET_ClearInterruptStatus(base, ENET_EIR_MII_MASK); * data = ENET_ReadSMIData(base); * @endcode * @param base ENET peripheral base address. * @param phyAddr The PHY address. * @param phyReg The PHY register. For MDIO IEEE802.3 Clause 45, * the phyReg is a 21-bits combination of the devaddr (5 bits device address) * and the regAddr (16 bits phy register): phyReg = (devaddr << 16) | regAddr. */ void ENET_StartExtC45SMIReadData(ENET_Type *base, uint32_t phyAddr, uint32_t phyReg); #endif /* FSL_FEATURE_ENET_HAS_EXTEND_MDIO */ #if ((defined(FSL_FEATURE_ENET_HAS_RGMII_TXC_DELAY) && FSL_FEATURE_ENET_HAS_RGMII_TXC_DELAY) || \ (defined(FSL_FEATURE_ENET_HAS_RGMII_RXC_DELAY) && FSL_FEATURE_ENET_HAS_RGMII_RXC_DELAY)) /*! * @brief Control the usage of the delayed tx/rx RGMII clock. * * @param base ENET peripheral base address. * @param txEnabled Enable or disable to generate the delayed version of RGMII_TXC. * @param rxEnabled Enable or disable to use the delayed version of RGMII_RXC. */ static inline void ENET_SetRGMIIClockDelay(ENET_Type *base, bool txEnabled, bool rxEnabled) { uint32_t ecrReg = base->ECR; #if defined(FSL_FEATURE_ENET_HAS_RGMII_TXC_DELAY) && FSL_FEATURE_ENET_HAS_RGMII_TXC_DELAY /* Set for transmit clock delay. */ if (txEnabled) { ecrReg |= ENET_ECR_TXC_DLY_MASK; } else { ecrReg &= ~ENET_ECR_TXC_DLY_MASK; } #endif /* FSL_FEATURE_ENET_HAS_RGMII_TXC_DELAY */ #if defined(FSL_FEATURE_ENET_HAS_RGMII_RXC_DELAY) && FSL_FEATURE_ENET_HAS_RGMII_RXC_DELAY /* Set for receive clock delay. */ if (rxEnabled) { ecrReg |= ENET_ECR_RXC_DLY_MASK; } else { ecrReg &= ~ENET_ECR_RXC_DLY_MASK; } #endif /* FSL_FEATURE_ENET_HAS_RGMII_RXC_DELAY */ base->ECR = ecrReg; } #endif /* @} */ /*! * @name MAC Address Filter * @{ */ /*! * @brief Sets the ENET module Mac address. * * @param base ENET peripheral base address. * @param macAddr The six-byte Mac address pointer. * The pointer is allocated by application and input into the API. */ void ENET_SetMacAddr(ENET_Type *base, uint8_t *macAddr); /*! * @brief Gets the ENET module Mac address. * * @param base ENET peripheral base address. * @param macAddr The six-byte Mac address pointer. * The pointer is allocated by application and input into the API. */ void ENET_GetMacAddr(ENET_Type *base, uint8_t *macAddr); /*! * @brief Adds the ENET device to a multicast group. * * @param base ENET peripheral base address. * @param address The six-byte multicast group address which is provided by application. */ void ENET_AddMulticastGroup(ENET_Type *base, uint8_t *address); /*! * @brief Moves the ENET device from a multicast group. * * @param base ENET peripheral base address. * @param address The six-byte multicast group address which is provided by application. */ void ENET_LeaveMulticastGroup(ENET_Type *base, uint8_t *address); /* @} */ /*! * @name Other basic operation * @{ */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE #if defined(FSL_FEATURE_ENET_HAS_AVB) && FSL_FEATURE_ENET_HAS_AVB /*! * @brief Sets the ENET AVB feature. * * ENET AVB feature configuration, set the Receive classification match and transmit * bandwidth. This API is called when the AVB feature is required. * * Note: The AVB frames transmission scheme is credit-based tx scheme and it's only supported * with the Enhanced buffer descriptors. so the AVB configuration should only done with * Enhanced buffer descriptor. so when the AVB feature is required, please make sure the * the "ENET_ENHANCEDBUFFERDESCRIPTOR_MODE" is defined. * * @param base ENET peripheral base address. * @param handle ENET handler pointer. * @param config The ENET AVB feature configuration structure. */ void ENET_AVBConfigure(ENET_Type *base, enet_handle_t *handle, const enet_avb_config_t *config); #endif /* FSL_FEATURE_ENET_HAS_AVB */ #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ /*! * @brief Activates frame reception for multiple rings. * * This function is to active the enet read process. * @note This must be called after the MAC configuration and * state are ready. It must be called after the ENET_Init(). * This should be called when the frame reception is required. * * @param base ENET peripheral base address. */ static inline void ENET_ActiveRead(ENET_Type *base) { base->RDAR = ENET_RDAR_RDAR_MASK; #if FSL_FEATURE_ENET_QUEUE > 1 if (FSL_FEATURE_ENET_INSTANCE_QUEUEn(base) > 1) { base->RDAR1 = ENET_RDAR1_RDAR_MASK; base->RDAR2 = ENET_RDAR2_RDAR_MASK; } #endif /* FSL_FEATURE_ENET_QUEUE > 1 */ } /*! * @brief Enables/disables the MAC to enter sleep mode. * This function is used to set the MAC enter sleep mode. * When entering sleep mode, the magic frame wakeup interrupt should be enabled * to wake up MAC from the sleep mode and reset it to normal mode. * * @param base ENET peripheral base address. * @param enable True enable sleep mode, false disable sleep mode. */ static inline void ENET_EnableSleepMode(ENET_Type *base, bool enable) { if (enable) { /* When this field is set, MAC enters sleep mode. */ base->ECR |= ENET_ECR_SLEEP_MASK | ENET_ECR_MAGICEN_MASK; } else { /* MAC exits sleep mode. */ base->ECR &= ~(ENET_ECR_SLEEP_MASK | ENET_ECR_MAGICEN_MASK); } } /*! * @brief Gets ENET transmit and receive accelerator functions from MAC controller. * * @param base ENET peripheral base address. * @param txAccelOption The transmit accelerator option. The "enet_tx_accelerator_t" is * recommended to be used to as the mask to get the exact the accelerator option. * @param rxAccelOption The receive accelerator option. The "enet_rx_accelerator_t" is * recommended to be used to as the mask to get the exact the accelerator option. */ static inline void ENET_GetAccelFunction(ENET_Type *base, uint32_t *txAccelOption, uint32_t *rxAccelOption) { assert(txAccelOption != NULL); assert(txAccelOption != NULL); *txAccelOption = base->TACC; *rxAccelOption = base->RACC; } /* @} */ /*! * @name Interrupts. * @{ */ /*! * @brief Enables the ENET interrupt. * * This function enables the ENET interrupt according to the provided mask. The mask * is a logical OR of enumeration members. See ::enet_interrupt_enable_t. * For example, to enable the TX frame interrupt and RX frame interrupt, do the following. * @code * ENET_EnableInterrupts(ENET, kENET_TxFrameInterrupt | kENET_RxFrameInterrupt); * @endcode * * @param base ENET peripheral base address. * @param mask ENET interrupts to enable. This is a logical OR of the * enumeration ::enet_interrupt_enable_t. */ static inline void ENET_EnableInterrupts(ENET_Type *base, uint32_t mask) { base->EIMR |= mask; } /*! * @brief Disables the ENET interrupt. * * This function disables the ENET interrupts according to the provided mask. The mask * is a logical OR of enumeration members. See ::enet_interrupt_enable_t. * For example, to disable the TX frame interrupt and RX frame interrupt, do the following. * @code * ENET_DisableInterrupts(ENET, kENET_TxFrameInterrupt | kENET_RxFrameInterrupt); * @endcode * * @param base ENET peripheral base address. * @param mask ENET interrupts to disable. This is a logical OR of the * enumeration ::enet_interrupt_enable_t. */ static inline void ENET_DisableInterrupts(ENET_Type *base, uint32_t mask) { base->EIMR &= ~mask; } /*! * @brief Gets the ENET interrupt status flag. * * @param base ENET peripheral base address. * @return The event status of the interrupt source. This is the logical OR of members * of the enumeration ::enet_interrupt_enable_t. */ static inline uint32_t ENET_GetInterruptStatus(ENET_Type *base) { return base->EIR; } /*! * @brief Clears the ENET interrupt events status flag. * * This function clears enabled ENET interrupts according to the provided mask. The mask * is a logical OR of enumeration members. See the ::enet_interrupt_enable_t. * For example, to clear the TX frame interrupt and RX frame interrupt, do the following. * @code * ENET_ClearInterruptStatus(ENET, kENET_TxFrameInterrupt | kENET_RxFrameInterrupt); * @endcode * * @param base ENET peripheral base address. * @param mask ENET interrupt source to be cleared. * This is the logical OR of members of the enumeration ::enet_interrupt_enable_t. */ static inline void ENET_ClearInterruptStatus(ENET_Type *base, uint32_t mask) { base->EIR = mask; } #if FSL_FEATURE_ENET_QUEUE > 1 /*! * @brief Set the second level Rx IRQ handler * * @param base ENET peripheral base address. * @param ISRHandler The handler to install. */ void ENET_SetRxISRHandler(ENET_Type *base, enet_isr_ring_t ISRHandler); /*! * @brief Set the second level Tx IRQ handler * * @param base ENET peripheral base address. * @param ISRHandler The handler to install. */ void ENET_SetTxISRHandler(ENET_Type *base, enet_isr_ring_t ISRHandler); #else /*! * @brief Set the second level Rx IRQ handler * * @param base ENET peripheral base address. * @param ISRHandler The handler to install. */ void ENET_SetRxISRHandler(ENET_Type *base, enet_isr_t ISRHandler); /*! * @brief Set the second level Tx IRQ handler * * @param base ENET peripheral base address. * @param ISRHandler The handler to install. */ void ENET_SetTxISRHandler(ENET_Type *base, enet_isr_t ISRHandler); #endif /* FSL_FEATURE_ENET_QUEUE > 1 */ /*! * @brief Set the second level Err IRQ handler * * @param base ENET peripheral base address. * @param ISRHandler The handler to install. */ void ENET_SetErrISRHandler(ENET_Type *base, enet_isr_t ISRHandler); #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE /*! * @brief Set the second level Ts IRQ handler * * @param ISRHandler The handler to install. */ void ENET_SetTsISRHandler(ENET_Type *base, enet_isr_t ISRHandler); /*! * @brief Set the second level 1588 Timer IRQ handler * * @param ISRHandler The handler to install. */ void ENET_Set1588TimerISRHandler(ENET_Type *base, enet_isr_t ISRHandler); #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ /* @} */ /*! * @name Transactional operation * @{ */ /*! * @brief Sets the callback function. * @deprecated Do not use this function. It has been superceded by the config param in @ref ENET_Init. * This API is provided for the application callback required case when ENET * interrupt is enabled. This API should be called after calling ENET_Init. * * @param handle ENET handler pointer. Should be provided by application. * @param callback The ENET callback function. * @param userData The callback function parameter. */ void ENET_SetCallback(enet_handle_t *handle, enet_callback_t callback, void *userData); /*! * @brief Gets the error statistics of a received frame for ENET specified ring. * * This API must be called after the ENET_GetRxFrameSize and before the ENET_ReadFrame(). * If the ENET_GetRxFrameSize returns kStatus_ENET_RxFrameError, * the ENET_GetRxErrBeforeReadFrame can be used to get the exact error statistics. * This is an example. * @code * status = ENET_GetRxFrameSize(&g_handle, &length, 0); * if (status == kStatus_ENET_RxFrameError) * { * Comments: Get the error information of the received frame. * ENET_GetRxErrBeforeReadFrame(&g_handle, &eErrStatic, 0); * Comments: update the receive buffer. * ENET_ReadFrame(EXAMPLE_ENET, &g_handle, NULL, 0); * } * @endcode * @param handle The ENET handler structure pointer. This is the same handler pointer used in the ENET_Init. * @param eErrorStatic The error statistics structure pointer. * @param ringId The ring index, range from 0 ~ (FSL_FEATURE_ENET_INSTANCE_QUEUEn(x) - 1). */ void ENET_GetRxErrBeforeReadFrame(enet_handle_t *handle, enet_data_error_stats_t *eErrorStatic, uint8_t ringId); #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE /*! * @brief Gets the ENET transmit frame statistics after the data send for specified ring. * * This interface gets the error statistics of the transmit frame. * Because the error information is reported by the uDMA after the data delivery, this interface * should be called after the data transmit API. It is recommended to call this function on * transmit interrupt handler. After calling the ENET_SendFrame, the * transmit interrupt notifies the transmit completion. * * @param handle The PTP handler pointer. This is the same handler pointer used in the ENET_Init. * @param eErrorStatic The error statistics structure pointer. * @param ringId The ring index, range from 0 ~ (FSL_FEATURE_ENET_INSTANCE_QUEUEn(x) - 1). * @return The execute status. */ status_t ENET_GetTxErrAfterSendFrame(enet_handle_t *handle, enet_data_error_stats_t *eErrorStatic, uint8_t ringId); #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ /*! * @brief Gets statistical data in transfer. * * @param base ENET peripheral base address. * @param statistics The statistics structure pointer. */ void ENET_GetStatistics(ENET_Type *base, enet_transfer_stats_t *statistics); /*! * @brief Gets the size of the read frame for specified ring. * * This function gets a received frame size from the ENET buffer descriptors. * @note The FCS of the frame is automatically removed by MAC and the size is the length without the FCS. * After calling ENET_GetRxFrameSize, ENET_ReadFrame() should be called to receive frame and update the BD * if the result is not "kStatus_ENET_RxFrameEmpty". * * @param handle The ENET handler structure. This is the same handler pointer used in the ENET_Init. * @param length The length of the valid frame received. * @param ringId The ring index or ring number. * @retval kStatus_ENET_RxFrameEmpty No frame received. Should not call ENET_ReadFrame to read frame. * @retval kStatus_ENET_RxFrameError Data error happens. ENET_ReadFrame should be called with NULL data * and NULL length to update the receive buffers. * @retval kStatus_Success Receive a frame Successfully then the ENET_ReadFrame * should be called with the right data buffer and the captured data length input. */ status_t ENET_GetRxFrameSize(enet_handle_t *handle, uint32_t *length, uint8_t ringId); /*! * @brief Reads a frame from the ENET device. * This function reads a frame (both the data and the length) from the ENET buffer descriptors. * User can get timestamp through ts pointer if the ts is not NULL. * @note It doesn't store the timestamp in the receive timestamp queue. * The ENET_GetRxFrameSize should be used to get the size of the prepared data buffer. * This API uses memcpy to copy data from DMA buffer to application buffer, 4 bytes aligned data buffer * in 32 bits platforms provided by user may let compiler use optimization instruction to reduce time * consumption. * This is an example: * @code * uint32_t length; * enet_handle_t g_handle; * Comments: Get the received frame size firstly. * status = ENET_GetRxFrameSize(&g_handle, &length, 0); * if (length != 0) * { * Comments: Allocate memory here with the size of "length" * uint8_t *data = memory allocate interface; * if (!data) * { * ENET_ReadFrame(ENET, &g_handle, NULL, 0, 0, NULL); * Comments: Add the console warning log. * } * else * { * status = ENET_ReadFrame(ENET, &g_handle, data, length, 0, NULL); * Comments: Call stack input API to deliver the data to stack * } * } * else if (status == kStatus_ENET_RxFrameError) * { * Comments: Update the received buffer when a error frame is received. * ENET_ReadFrame(ENET, &g_handle, NULL, 0, 0, NULL); * } * @endcode * @param base ENET peripheral base address. * @param handle The ENET handler structure. This is the same handler pointer used in the ENET_Init. * @param data The data buffer provided by user to store the frame which memory size should be at least "length". * @param length The size of the data buffer which is still the length of the received frame. * @param ringId The ring index or ring number. * @param ts The timestamp address to store received timestamp. * @return The execute status, successful or failure. */ status_t ENET_ReadFrame( ENET_Type *base, enet_handle_t *handle, uint8_t *data, uint32_t length, uint8_t ringId, uint32_t *ts); /*! * @brief Transmits an ENET frame for specified ring. * @note The CRC is automatically appended to the data. Input the data to send without the CRC. * This API uses memcpy to copy data from DMA buffer to application buffer, 4 bytes aligned data buffer * in 32 bits platforms provided by user may let compiler use optimization instruction to reduce time * consumption. * * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. This is the same handler pointer used in the ENET_Init. * @param data The data buffer provided by user to send. * @param length The length of the data to send. * @param ringId The ring index or ring number. * @param tsFlag Timestamp enable flag. * @param context Used by user to handle some events after transmit over. * @retval kStatus_Success Send frame succeed. * @retval kStatus_ENET_TxFrameBusy Transmit buffer descriptor is busy under transmission. * The transmit busy happens when the data send rate is over the MAC capacity. * The waiting mechanism is recommended to be added after each call return with * kStatus_ENET_TxFrameBusy. */ status_t ENET_SendFrame(ENET_Type *base, enet_handle_t *handle, const uint8_t *data, uint32_t length, uint8_t ringId, bool tsFlag, void *context); /*! * @brief Enable or disable tx descriptors reclaim mechanism. * @note This function must be called when no pending send frame action. * Set enable if you want to reclaim context or timestamp in interrupt. * * @param handle The ENET handler pointer. This is the same handler pointer used in the ENET_Init. * @param isEnable Enable or disable flag. * @param ringId The ring index or ring number. * @retval kStatus_Success Succeed to enable/disable Tx reclaim. * @retval kStatus_Fail Fail to enable/disable Tx reclaim. */ status_t ENET_SetTxReclaim(enet_handle_t *handle, bool isEnable, uint8_t ringId); /*! * @brief Reclaim tx descriptors. * This function is used to update the tx descriptor status and * store the tx timestamp when the 1588 feature is enabled. * This is called by the transmit interupt IRQ handler after the * complete of a frame transmission. * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. This is the same handler pointer used in the ENET_Init. * @param ringId The ring index or ring number. */ void ENET_ReclaimTxDescriptor(ENET_Type *base, enet_handle_t *handle, uint8_t ringId); /*! * @brief Get a receive buffer pointer of the ENET device for specified ring. * @deprecated Do not use this function. It has been superseded by @ref ENET_GetRxFrame. * * This function can get the data address which stores frame. Then can analyze these data directly without doing any * memory copy. When the frame locates in multiple BD buffer, need to repeat calling this function until isLastBuff=true * (need to store the temp buf pointer everytime call this function). After finishing the analysis of this frame, * call ENET_ReleaseRxBuffer to release rxbuff memory to DMA. * This is an example: * @code * uint32_t length; * uint8_t *buf = NULL; * uint32_t data_len = 0; * bool isLastBuff = false; * enet_handle_t g_handle; * status_t status; * status = ENET_GetRxFrameSize(&g_handle, &length, 0); * if (length != 0) * { * ENET_GetRxBuffer(EXAMPLE_ENET, &g_handle, &buf, &data_len, 0, &isLastBuff, NULL); * ENET_ReleaseRxBuffer(EXAMPLE_ENET, &g_handle, buf, 0); * } * @endcode * @param base ENET peripheral base address. * @param handle The ENET handler structure. This is the same handler pointer used in the ENET_Init. * @param buffer The data buffer pointer to store the frame. * @param length The size of the data buffer. If isLastBuff=false, it represents data length of this buffer. If * isLastBuff=true, it represents data length of total frame. * @param ringId The ring index, range from 0 ~ (FSL_FEATURE_ENET_INSTANCE_QUEUEn(x) - 1). * @param isLastBuff The flag represents whether this buffer is the last buffer to store frame. * @param ts The 1588 timestamp value, vaild in last buffer. * @retval kStatus_Success Get receive buffer succeed. * @retval kStatus_ENET_RxFrameFail Get receive buffer fails, it's owned by application, should wait app to release this * buffer. */ status_t ENET_GetRxBuffer(ENET_Type *base, enet_handle_t *handle, void **buffer, uint32_t *length, uint8_t ringId, bool *isLastBuff, uint32_t *ts); /*! * @brief Release receive buffer descriptor to DMA. * @deprecated Do not use this function. It has been superseded by @ref ENET_GetRxFrame. * * This function can release specified BD owned by application, meanwhile it may rearrange the BD to let the no-owned * BDs always in back of the index of DMA transfer. So for the situation that releasing order is not same as the getting * order, the rearrangement makes all ready BDs can be used by DMA. * @note This function can't be interrupted by ENET_GetRxBuffer, so in application must make sure ENET_GetRxBuffer is * called before or after this function. And this function itself isn't thread safe due to BD content exchanging. * * @param base ENET peripheral base address. * @param handle The ENET handler structure. This is the same handler pointer used in the ENET_Init. * @param buffer The buffer address to store frame, using it to find the correspond BD and release it. * @param ringId The ring index, range from 0 ~ (FSL_FEATURE_ENET_INSTANCE_QUEUEn(x) - 1). */ void ENET_ReleaseRxBuffer(ENET_Type *base, enet_handle_t *handle, void *buffer, uint8_t ringId); /*! * @brief Receives one frame in specified BD ring with zero copy. * * This function will use the user-defined allocate and free callback. Every time application gets one frame through * this function, driver will allocate new buffers for the BDs whose buffers have been taken by application. * @note This function will drop current frame and update related BDs as available for DMA if new buffers allocating * fails. Application must provide a memory pool including at least BD number + 1 buffers to make this function work * normally. If user calls this function in Rx interrupt handler, be careful that this function makes Rx BD ready with * allocating new buffer(normal) or updating current BD(out of memory). If there's always new Rx frame input, Rx * interrupt will be triggered forever. Application need to disable Rx interrupt according to specific design in this * case. * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. This is the same handler pointer used in the ENET_Init. * @param rxFrame The received frame information structure provided by user. * @param ringId The ring index or ring number. * @retval kStatus_Success Succeed to get one frame and allocate new memory for Rx buffer. * @retval kStatus_ENET_RxFrameEmpty There's no Rx frame in the BD. * @retval kStatus_ENET_RxFrameError There's issue in this receiving. * @retval kStatus_ENET_RxFrameDrop There's no new buffer memory for BD, drop this frame. */ status_t ENET_GetRxFrame(ENET_Type *base, enet_handle_t *handle, enet_rx_frame_struct_t *rxFrame, uint8_t ringId); /*! * @brief Sends one frame in specified BD ring with zero copy. * * This function supports scattered buffer transmit, user needs to provide the buffer array. * @note Tx reclaim should be enabled to ensure the Tx buffer ownership can be given back to * application after Tx is over. * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. This is the same handler pointer used in the ENET_Init. * @param txFrame The Tx frame structure. * @param ringId The ring index or ring number. * @retval kStatus_Success Succeed to send one frame. * @retval kStatus_ENET_TxFrameBusy The BD is not ready for Tx or the reclaim operation still not finishs. * @retval kStatus_ENET_TxFrameOverLen The Tx frame length is over max ethernet frame length. */ status_t ENET_StartTxFrame(ENET_Type *base, enet_handle_t *handle, enet_tx_frame_struct_t *txFrame, uint8_t ringId); /*! * @brief Transmits an ENET frame for specified ring with zero-copy. * @deprecated Do not use this function. It has been superseded by @ref ENET_StartTxFrame. * @note The CRC is automatically appended to the data. Input the data * to send without the CRC. The frame must store in continuous memory * and need to check the buffer start address alignment based on your * device, otherwise it has issue or can't get highest DMA transmit speed. * * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. This is the same handler pointer used in the ENET_Init. * @param data The data buffer provided by user to send. * @param length The length of the data to send. * @param ringId The ring index or ring number. * @param tsFlag Timestamp enable flag. * @param context Used by user to handle some events after transmit over. * @retval kStatus_Success Send frame succeed. * @retval kStatus_ENET_TxFrameBusy Transmit buffer descriptor is busy under transmission. * The transmit busy happens when the data send rate is over the MAC capacity. * The waiting mechanism is recommended to be added after each call return with * kStatus_ENET_TxFrameBusy. */ status_t ENET_SendFrameZeroCopy(ENET_Type *base, enet_handle_t *handle, const uint8_t *data, uint32_t length, uint8_t ringId, bool tsFlag, void *context); #if FSL_FEATURE_ENET_QUEUE > 1 /*! * @brief The transmit IRQ handler. * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. * @param ringId The ring id or ring number. */ void ENET_TransmitIRQHandler(ENET_Type *base, enet_handle_t *handle, uint32_t ringId); /*! * @brief The receive IRQ handler. * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. * @param ringId The ring id or ring number. */ void ENET_ReceiveIRQHandler(ENET_Type *base, enet_handle_t *handle, uint32_t ringId); /*! * @brief the common IRQ handler for the tx/rx irq handler. * * This is used for the combined tx/rx interrupt for multi-ring (frame 1). * * @param base ENET peripheral base address. */ void ENET_CommonFrame1IRQHandler(ENET_Type *base); /*! * @brief the common IRQ handler for the tx/rx irq handler. * * This is used for the combined tx/rx interrupt for multi-ring (frame 2). * * @param base ENET peripheral base address. */ void ENET_CommonFrame2IRQHandler(ENET_Type *base); #else /*! * @brief The transmit IRQ handler. * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. */ void ENET_TransmitIRQHandler(ENET_Type *base, enet_handle_t *handle); /*! * @brief The receive IRQ handler. * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. */ void ENET_ReceiveIRQHandler(ENET_Type *base, enet_handle_t *handle); #endif /* FSL_FEATURE_ENET_QUEUE > 1 */ /*! * @brief Some special IRQ handler including the error, mii, wakeup irq handler. * * @param base ENET peripheral base address. * @param handle The ENET handler pointer. */ void ENET_ErrorIRQHandler(ENET_Type *base, enet_handle_t *handle); /*! * @brief the common IRQ handler for the 1588 irq handler. * * This is used for the 1588 timer interrupt. * * @param base ENET peripheral base address. */ void ENET_Ptp1588IRQHandler(ENET_Type *base); /*! * @brief the common IRQ handler for the tx/rx/error etc irq handler. * * This is used for the combined tx/rx/error interrupt for single/mutli-ring (frame 0). * * @param base ENET peripheral base address. */ void ENET_CommonFrame0IRQHandler(ENET_Type *base); /* @} */ #ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE /*! * @name ENET PTP 1588 function operation * @{ */ void ENET_Ptp1588ConfigureHandler(ENET_Type *base, enet_handle_t *handle, enet_ptp_config_t *ptpConfig); /*! * @brief Configures the ENET PTP IEEE 1588 feature with the basic configuration. * The function sets the clock for PTP 1588 timer and enables * time stamp interrupts and transmit interrupts for PTP 1588 features. * This API should be called when the 1588 feature is enabled * or the ENET_ENHANCEDBUFFERDESCRIPTOR_MODE is defined. * ENET_Init should be called before calling this API. * * @note The PTP 1588 time-stamp second increase though time-stamp interrupt handler * and the transmit time-stamp store is done through transmit interrupt handler. * As a result, the TS interrupt and TX interrupt are enabled when you call this API. * * @param base ENET peripheral base address. * @param handle ENET handler pointer. * @param ptpConfig The ENET PTP1588 configuration. */ void ENET_Ptp1588Configure(ENET_Type *base, enet_handle_t *handle, enet_ptp_config_t *ptpConfig); /*! * @brief Starts the ENET PTP 1588 Timer. * This function is used to initialize the PTP timer. After the PTP starts, * the PTP timer starts running. * * @param base ENET peripheral base address. * @param ptpClkSrc The clock source of the PTP timer. */ void ENET_Ptp1588StartTimer(ENET_Type *base, uint32_t ptpClkSrc); /*! * @brief Stops the ENET PTP 1588 Timer. * This function is used to stops the ENET PTP timer. * * @param base ENET peripheral base address. */ static inline void ENET_Ptp1588StopTimer(ENET_Type *base) { /* Disable PTP timer and reset the timer. */ base->ATCR &= ~ENET_ATCR_EN_MASK; base->ATCR |= ENET_ATCR_RESTART_MASK; } /*! * @brief Adjusts the ENET PTP 1588 timer. * * @param base ENET peripheral base address. * @param corrIncrease The correction increment value. This value is added every time the correction * timer expires. A value less than the PTP timer frequency(1/ptpClkSrc) slows down the timer, * a value greater than the 1/ptpClkSrc speeds up the timer. * @param corrPeriod The PTP timer correction counter wrap-around value. This defines after how * many timer clock the correction counter should be reset and trigger a correction * increment on the timer. A value of 0 disables the correction counter and no correction occurs. */ void ENET_Ptp1588AdjustTimer(ENET_Type *base, uint32_t corrIncrease, uint32_t corrPeriod); /*! * @brief Sets the ENET PTP 1588 timer channel mode. * * @param base ENET peripheral base address. * @param channel The ENET PTP timer channel number. * @param mode The PTP timer channel mode, see "enet_ptp_timer_channel_mode_t". * @param intEnable Enables or disables the interrupt. */ static inline void ENET_Ptp1588SetChannelMode(ENET_Type *base, enet_ptp_timer_channel_t channel, enet_ptp_timer_channel_mode_t mode, bool intEnable) { uint32_t tcrReg = 0; tcrReg = ENET_TCSR_TMODE(mode) | (intEnable ? ENET_TCSR_TIE_MASK : 0U); /* Disable channel mode first. */ base->CHANNEL[channel].TCSR = 0; base->CHANNEL[channel].TCSR = tcrReg; } #if defined(FSL_FEATURE_ENET_HAS_TIMER_PWCONTROL) && FSL_FEATURE_ENET_HAS_TIMER_PWCONTROL /*! * @brief Sets ENET PTP 1588 timer channel mode pulse width. * * For the input "mode" in ENET_Ptp1588SetChannelMode, the kENET_PtpChannelPulseLowonCompare * kENET_PtpChannelPulseHighonCompare only support the pulse width for one 1588 clock. * this function is extended for control the pulse width from 1 to 32 1588 clock cycles. * so call this function if you need to set the timer channel mode for * kENET_PtpChannelPulseLowonCompare or kENET_PtpChannelPulseHighonCompare * with pulse width more than one 1588 clock, * * @param base ENET peripheral base address. * @param channel The ENET PTP timer channel number. * @param isOutputLow True --- timer channel is configured for output compare * pulse output low. * false --- timer channel is configured for output compare * pulse output high. * @param pulseWidth The pulse width control value, range from 0 ~ 31. * 0 --- pulse width is one 1588 clock cycle. * 31 --- pulse width is thirty two 1588 clock cycles. * @param intEnable Enables or disables the interrupt. */ static inline void ENET_Ptp1588SetChannelOutputPulseWidth( ENET_Type *base, enet_ptp_timer_channel_t channel, bool isOutputLow, uint8_t pulseWidth, bool intEnable) { uint32_t tcrReg; tcrReg = ENET_TCSR_TIE(intEnable) | ENET_TCSR_TPWC(pulseWidth); if (isOutputLow) { tcrReg |= ENET_TCSR_TMODE(kENET_PtpChannelPulseLowonCompare); } else { tcrReg |= ENET_TCSR_TMODE(kENET_PtpChannelPulseHighonCompare); } /* Disable channel mode first. */ base->CHANNEL[channel].TCSR = 0; base->CHANNEL[channel].TCSR = tcrReg; } #endif /* FSL_FEATURE_ENET_HAS_TIMER_PWCONTROL */ /*! * @brief Sets the ENET PTP 1588 timer channel comparison value. * * @param base ENET peripheral base address. * @param channel The PTP timer channel, see "enet_ptp_timer_channel_t". * @param cmpValue The compare value for the compare setting. */ static inline void ENET_Ptp1588SetChannelCmpValue(ENET_Type *base, enet_ptp_timer_channel_t channel, uint32_t cmpValue) { base->CHANNEL[channel].TCCR = cmpValue; } /*! * @brief Gets the ENET PTP 1588 timer channel status. * * @param base ENET peripheral base address. * @param channel The IEEE 1588 timer channel number. * @return True or false, Compare or capture operation status */ static inline bool ENET_Ptp1588GetChannelStatus(ENET_Type *base, enet_ptp_timer_channel_t channel) { return (0U != (base->CHANNEL[channel].TCSR & ENET_TCSR_TF_MASK)); } /*! * @brief Clears the ENET PTP 1588 timer channel status. * * @param base ENET peripheral base address. * @param channel The IEEE 1588 timer channel number. */ static inline void ENET_Ptp1588ClearChannelStatus(ENET_Type *base, enet_ptp_timer_channel_t channel) { base->CHANNEL[channel].TCSR |= ENET_TCSR_TF_MASK; base->TGSR = (1UL << (uint32_t)channel); } /*! * @brief Get the ENET PTP 1588 timer global status. * * @param base ENET peripheral base address. */ static inline uint32_t ENET_Ptp1588GetGlobalStatus(ENET_Type *base) { return base->TGSR; } /*! * @brief Gets the current ENET time from the PTP 1588 timer. * A variant of ENET_Ptp1588GetTimer() which does not disable interrupts. * * @param base ENET peripheral base address. * @param handle The ENET state pointer. This is the same state pointer used in the ENET_Init. * @param ptpTime The PTP timer structure. */ void ENET_Ptp1588GetTimerNoIrqDisable(ENET_Type *base, enet_handle_t *handle, enet_ptp_time_t *ptpTime); /*! * @brief Gets the current ENET time from the PTP 1588 timer. * * @param base ENET peripheral base address. * @param handle The ENET state pointer. This is the same state pointer used in the ENET_Init. * @param ptpTime The PTP timer structure. */ void ENET_Ptp1588GetTimer(ENET_Type *base, enet_handle_t *handle, enet_ptp_time_t *ptpTime); /*! * @brief Sets the ENET PTP 1588 timer to the assigned time. * * @param base ENET peripheral base address. * @param handle The ENET state pointer. This is the same state pointer used in the ENET_Init. * @param ptpTime The timer to be set to the PTP timer. */ void ENET_Ptp1588SetTimer(ENET_Type *base, enet_handle_t *handle, enet_ptp_time_t *ptpTime); /*! * @brief The IEEE 1588 PTP time stamp interrupt handler. * * @param base ENET peripheral base address. * @param handle The ENET state pointer. This is the same state pointer used in the ENET_Init. */ void ENET_TimeStampIRQHandler(ENET_Type *base, enet_handle_t *handle); /* @} */ #endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */ #if defined(__cplusplus) } #endif /*! @}*/ #endif /* _FSL_ENET_H_ */