stm32h7xx_hal_eth.h 86 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849
  1. /**
  2. ******************************************************************************
  3. * @file stm32h7xx_hal_eth.h
  4. * @author MCD Application Team
  5. * @brief Header file of ETH HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2017 STMicroelectronics.
  10. * All rights reserved.
  11. *
  12. * This software is licensed under terms that can be found in the LICENSE file
  13. * in the root directory of this software component.
  14. * If no LICENSE file comes with this software, it is provided AS-IS.
  15. *
  16. ******************************************************************************
  17. */
  18. /* Define to prevent recursive inclusion -------------------------------------*/
  19. #ifndef STM32H7xx_HAL_ETH_H
  20. #define STM32H7xx_HAL_ETH_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32h7xx_hal_def.h"
  26. #if defined(ETH)
  27. /** @addtogroup STM32H7xx_HAL_Driver
  28. * @{
  29. */
  30. /** @addtogroup ETH
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. #ifndef ETH_TX_DESC_CNT
  35. #define ETH_TX_DESC_CNT 4U
  36. #endif /* ETH_TX_DESC_CNT */
  37. #ifndef ETH_RX_DESC_CNT
  38. #define ETH_RX_DESC_CNT 4U
  39. #endif /* ETH_RX_DESC_CNT */
  40. #ifndef ETH_SWRESET_TIMEOUT
  41. #define ETH_SWRESET_TIMEOUT ((uint32_t)500U)
  42. #endif /* ETH_SWRESET_TIMEOUT */
  43. #ifndef ETH_MDIO_BUS_TIMEOUT
  44. #define ETH_MDIO_BUS_TIMEOUT ((uint32_t)1000U)
  45. #endif /* ETH_MDIO_BUS_TIMEOUT */
  46. #ifndef ETH_MAC_US_TICK
  47. #define ETH_MAC_US_TICK ((uint32_t)1000000U)
  48. #endif /* ETH_MAC_US_TICK */
  49. /*********************** Descriptors struct def section ************************/
  50. /** @defgroup ETH_Exported_Types ETH Exported Types
  51. * @{
  52. */
  53. /**
  54. * @brief ETH DMA Descriptor structure definition
  55. */
  56. typedef struct
  57. {
  58. __IO uint32_t DESC0;
  59. __IO uint32_t DESC1;
  60. __IO uint32_t DESC2;
  61. __IO uint32_t DESC3;
  62. uint32_t BackupAddr0; /* used to store rx buffer 1 address */
  63. uint32_t BackupAddr1; /* used to store rx buffer 2 address */
  64. } ETH_DMADescTypeDef;
  65. /**
  66. *
  67. */
  68. /**
  69. * @brief ETH Buffers List structure definition
  70. */
  71. typedef struct __ETH_BufferTypeDef
  72. {
  73. uint8_t *buffer; /*<! buffer address */
  74. uint32_t len; /*<! buffer length */
  75. struct __ETH_BufferTypeDef *next; /*<! Pointer to the next buffer in the list */
  76. } ETH_BufferTypeDef;
  77. /**
  78. *
  79. */
  80. /**
  81. * @brief DMA Transmit Descriptors Wrapper structure definition
  82. */
  83. typedef struct
  84. {
  85. uint32_t TxDesc[ETH_TX_DESC_CNT]; /*<! Tx DMA descriptors addresses */
  86. uint32_t CurTxDesc; /*<! Current Tx descriptor index for packet transmission */
  87. uint32_t *PacketAddress[ETH_TX_DESC_CNT]; /*<! Ethernet packet addresses array */
  88. uint32_t *CurrentPacketAddress; /*<! Current transmit NX_PACKET addresses */
  89. uint32_t BuffersInUse; /*<! Buffers in Use */
  90. uint32_t releaseIndex; /*<! Release index */
  91. } ETH_TxDescListTypeDef;
  92. /**
  93. *
  94. */
  95. /**
  96. * @brief Transmit Packet Configuration structure definition
  97. */
  98. typedef struct
  99. {
  100. uint32_t Attributes; /*!< Tx packet HW features capabilities.
  101. This parameter can be a combination of @ref ETH_Tx_Packet_Attributes*/
  102. uint32_t Length; /*!< Total packet length */
  103. ETH_BufferTypeDef *TxBuffer; /*!< Tx buffers pointers */
  104. uint32_t SrcAddrCtrl; /*!< Specifies the source address insertion control.
  105. This parameter can be a value of @ref ETH_Tx_Packet_Source_Addr_Control */
  106. uint32_t CRCPadCtrl; /*!< Specifies the CRC and Pad insertion and replacement control.
  107. This parameter can be a value of @ref ETH_Tx_Packet_CRC_Pad_Control */
  108. uint32_t ChecksumCtrl; /*!< Specifies the checksum insertion control.
  109. This parameter can be a value of @ref ETH_Tx_Packet_Checksum_Control */
  110. uint32_t MaxSegmentSize; /*!< Sets TCP maximum segment size only when TCP segmentation is enabled.
  111. This parameter can be a value from 0x0 to 0x3FFF */
  112. uint32_t PayloadLen; /*!< Sets Total payload length only when TCP segmentation is enabled.
  113. This parameter can be a value from 0x0 to 0x3FFFF */
  114. uint32_t TCPHeaderLen; /*!< Sets TCP header length only when TCP segmentation is enabled.
  115. This parameter can be a value from 0x5 to 0xF */
  116. uint32_t VlanTag; /*!< Sets VLAN Tag only when VLAN is enabled.
  117. This parameter can be a value from 0x0 to 0xFFFF*/
  118. uint32_t VlanCtrl; /*!< Specifies VLAN Tag insertion control only when VLAN is enabled.
  119. This parameter can be a value of @ref ETH_Tx_Packet_VLAN_Control */
  120. uint32_t InnerVlanTag; /*!< Sets Inner VLAN Tag only when Inner VLAN is enabled.
  121. This parameter can be a value from 0x0 to 0x3FFFF */
  122. uint32_t InnerVlanCtrl; /*!< Specifies Inner VLAN Tag insertion control only when Inner VLAN is enabled.
  123. This parameter can be a value of @ref ETH_Tx_Packet_Inner_VLAN_Control */
  124. void *pData; /*!< Specifies Application packet pointer to save */
  125. } ETH_TxPacketConfig;
  126. /**
  127. *
  128. */
  129. /**
  130. * @brief ETH Timestamp structure definition
  131. */
  132. typedef struct
  133. {
  134. uint32_t TimeStampLow;
  135. uint32_t TimeStampHigh;
  136. } ETH_TimeStampTypeDef;
  137. /**
  138. *
  139. */
  140. /**
  141. * @brief ETH Timeupdate structure definition
  142. */
  143. typedef struct
  144. {
  145. uint32_t Seconds;
  146. uint32_t NanoSeconds;
  147. } ETH_TimeTypeDef;
  148. /**
  149. *
  150. */
  151. /**
  152. * @brief DMA Receive Descriptors Wrapper structure definition
  153. */
  154. typedef struct
  155. {
  156. uint32_t RxDesc[ETH_RX_DESC_CNT]; /*<! Rx DMA descriptors addresses. */
  157. uint32_t ItMode; /*<! If 1, DMA will generate the Rx complete interrupt.
  158. If 0, DMA will not generate the Rx complete interrupt. */
  159. uint32_t RxDescIdx; /*<! Current Rx descriptor. */
  160. uint32_t RxDescCnt; /*<! Number of descriptors . */
  161. uint32_t RxDataLength; /*<! Received Data Length. */
  162. uint32_t RxBuildDescIdx; /*<! Current Rx Descriptor for building descriptors. */
  163. uint32_t RxBuildDescCnt; /*<! Number of Rx Descriptors awaiting building. */
  164. uint32_t pRxLastRxDesc; /*<! Last received descriptor. */
  165. ETH_TimeStampTypeDef TimeStamp; /*<! Time Stamp Low value for receive. */
  166. void *pRxStart; /*<! Pointer to the first buff. */
  167. void *pRxEnd; /*<! Pointer to the last buff. */
  168. } ETH_RxDescListTypeDef;
  169. /**
  170. *
  171. */
  172. /**
  173. * @brief ETH MAC Configuration Structure definition
  174. */
  175. typedef struct
  176. {
  177. uint32_t
  178. SourceAddrControl; /*!< Selects the Source Address Insertion or Replacement Control.
  179. This parameter can be a value of @ref ETH_Source_Addr_Control */
  180. FunctionalState
  181. ChecksumOffload; /*!< Enables or Disable the checksum checking for received packet payloads TCP, UDP or ICMP headers */
  182. uint32_t InterPacketGapVal; /*!< Sets the minimum IPG between Packet during transmission.
  183. This parameter can be a value of @ref ETH_Inter_Packet_Gap */
  184. FunctionalState GiantPacketSizeLimitControl; /*!< Enables or disables the Giant Packet Size Limit Control. */
  185. FunctionalState Support2KPacket; /*!< Enables or disables the IEEE 802.3as Support for 2K length Packets */
  186. FunctionalState CRCStripTypePacket; /*!< Enables or disables the CRC stripping for Type packets.*/
  187. FunctionalState AutomaticPadCRCStrip; /*!< Enables or disables the Automatic MAC Pad/CRC Stripping.*/
  188. FunctionalState Watchdog; /*!< Enables or disables the Watchdog timer on Rx path.*/
  189. FunctionalState Jabber; /*!< Enables or disables Jabber timer on Tx path.*/
  190. FunctionalState JumboPacket; /*!< Enables or disables receiving Jumbo Packet
  191. When enabled, the MAC allows jumbo packets of 9,018 bytes
  192. without reporting a giant packet error */
  193. uint32_t Speed; /*!< Sets the Ethernet speed: 10/100 Mbps.
  194. This parameter can be a value of @ref ETH_Speed */
  195. uint32_t DuplexMode; /*!< Selects the MAC duplex mode: Half-Duplex or Full-Duplex mode
  196. This parameter can be a value of @ref ETH_Duplex_Mode */
  197. FunctionalState LoopbackMode; /*!< Enables or disables the loopback mode */
  198. FunctionalState
  199. CarrierSenseBeforeTransmit; /*!< Enables or disables the Carrier Sense Before Transmission in Full Duplex Mode. */
  200. FunctionalState ReceiveOwn; /*!< Enables or disables the Receive Own in Half Duplex mode. */
  201. FunctionalState
  202. CarrierSenseDuringTransmit; /*!< Enables or disables the Carrier Sense During Transmission in the Half Duplex mode */
  203. FunctionalState
  204. RetryTransmission; /*!< Enables or disables the MAC retry transmission, when a collision occurs in Half Duplex mode.*/
  205. uint32_t BackOffLimit; /*!< Selects the BackOff limit value.
  206. This parameter can be a value of @ref ETH_Back_Off_Limit */
  207. FunctionalState
  208. DeferralCheck; /*!< Enables or disables the deferral check function in Half Duplex mode. */
  209. uint32_t
  210. PreambleLength; /*!< Selects or not the Preamble Length for Transmit packets (Full Duplex mode).
  211. This parameter can be a value of @ref ETH_Preamble_Length */
  212. FunctionalState
  213. UnicastSlowProtocolPacketDetect; /*!< Enable or disables the Detection of Slow Protocol Packets with unicast address. */
  214. FunctionalState SlowProtocolDetect; /*!< Enable or disables the Slow Protocol Detection. */
  215. FunctionalState CRCCheckingRxPackets; /*!< Enable or disables the CRC Checking for Received Packets. */
  216. uint32_t
  217. GiantPacketSizeLimit; /*!< Specifies the packet size that the MAC will declare it as Giant, If it's size is
  218. greater than the value programmed in this field in units of bytes
  219. This parameter must be a number between
  220. Min_Data = 0x618 (1518 byte) and Max_Data = 0x3FFF (32 Kbyte). */
  221. FunctionalState ExtendedInterPacketGap; /*!< Enable or disables the extended inter packet gap. */
  222. uint32_t ExtendedInterPacketGapVal; /*!< Sets the Extended IPG between Packet during transmission.
  223. This parameter can be a value from 0x0 to 0xFF */
  224. FunctionalState ProgrammableWatchdog; /*!< Enable or disables the Programmable Watchdog.*/
  225. uint32_t WatchdogTimeout; /*!< This field is used as watchdog timeout for a received packet
  226. This parameter can be a value of @ref ETH_Watchdog_Timeout */
  227. uint32_t
  228. PauseTime; /*!< This field holds the value to be used in the Pause Time field in the transmit control packet.
  229. This parameter must be a number between
  230. Min_Data = 0x0 and Max_Data = 0xFFFF.*/
  231. FunctionalState
  232. ZeroQuantaPause; /*!< Enable or disables the automatic generation of Zero Quanta Pause Control packets.*/
  233. uint32_t
  234. PauseLowThreshold; /*!< This field configures the threshold of the PAUSE to be checked for automatic retransmission of PAUSE Packet.
  235. This parameter can be a value of @ref ETH_Pause_Low_Threshold */
  236. FunctionalState
  237. TransmitFlowControl; /*!< Enables or disables the MAC to transmit Pause packets in Full Duplex mode
  238. or the MAC back pressure operation in Half Duplex mode */
  239. FunctionalState
  240. UnicastPausePacketDetect; /*!< Enables or disables the MAC to detect Pause packets with unicast address of the station */
  241. FunctionalState ReceiveFlowControl; /*!< Enables or disables the MAC to decodes the received Pause packet
  242. and disables its transmitter for a specified (Pause) time */
  243. uint32_t TransmitQueueMode; /*!< Specifies the Transmit Queue operating mode.
  244. This parameter can be a value of @ref ETH_Transmit_Mode */
  245. uint32_t ReceiveQueueMode; /*!< Specifies the Receive Queue operating mode.
  246. This parameter can be a value of @ref ETH_Receive_Mode */
  247. FunctionalState DropTCPIPChecksumErrorPacket; /*!< Enables or disables Dropping of TCPIP Checksum Error Packets. */
  248. FunctionalState ForwardRxErrorPacket; /*!< Enables or disables forwarding Error Packets. */
  249. FunctionalState ForwardRxUndersizedGoodPacket; /*!< Enables or disables forwarding Undersized Good Packets.*/
  250. } ETH_MACConfigTypeDef;
  251. /**
  252. *
  253. */
  254. /**
  255. * @brief ETH DMA Configuration Structure definition
  256. */
  257. typedef struct
  258. {
  259. uint32_t DMAArbitration; /*!< Sets the arbitration scheme between DMA Tx and Rx
  260. This parameter can be a value of @ref ETH_DMA_Arbitration */
  261. FunctionalState AddressAlignedBeats; /*!< Enables or disables the AHB Master interface address aligned
  262. burst transfers on Read and Write channels */
  263. uint32_t BurstMode; /*!< Sets the AHB Master interface burst transfers.
  264. This parameter can be a value of @ref ETH_Burst_Mode */
  265. FunctionalState RebuildINCRxBurst; /*!< Enables or disables the AHB Master to rebuild the pending beats
  266. of any initiated burst transfer with INCRx and SINGLE transfers. */
  267. FunctionalState PBLx8Mode; /*!< Enables or disables the PBL multiplication by eight. */
  268. uint32_t
  269. TxDMABurstLength; /*!< Indicates the maximum number of beats to be transferred in one Tx DMA transaction.
  270. This parameter can be a value of @ref ETH_Tx_DMA_Burst_Length */
  271. FunctionalState
  272. SecondPacketOperate; /*!< Enables or disables the Operate on second Packet mode, which allows the DMA to process a second
  273. Packet of Transmit data even before
  274. obtaining the status for the first one. */
  275. uint32_t
  276. RxDMABurstLength; /*!< Indicates the maximum number of beats to be transferred in one Rx DMA transaction.
  277. This parameter can be a value of @ref ETH_Rx_DMA_Burst_Length */
  278. FunctionalState FlushRxPacket; /*!< Enables or disables the Rx Packet Flush */
  279. FunctionalState TCPSegmentation; /*!< Enables or disables the TCP Segmentation */
  280. uint32_t
  281. MaximumSegmentSize; /*!< Sets the maximum segment size that should be used while segmenting the packet
  282. This parameter can be a value from 0x40 to 0x3FFF */
  283. } ETH_DMAConfigTypeDef;
  284. /**
  285. *
  286. */
  287. /**
  288. * @brief HAL ETH Media Interfaces enum definition
  289. */
  290. typedef enum
  291. {
  292. HAL_ETH_MII_MODE = 0x00U, /*!< Media Independent Interface */
  293. HAL_ETH_RMII_MODE = 0x01U /*!< Reduced Media Independent Interface */
  294. } ETH_MediaInterfaceTypeDef;
  295. /**
  296. *
  297. */
  298. /**
  299. * @brief HAL ETH PTP Update type enum definition
  300. */
  301. typedef enum
  302. {
  303. HAL_ETH_PTP_POSITIVE_UPDATE = 0x00000000U, /*!< PTP positive time update */
  304. HAL_ETH_PTP_NEGATIVE_UPDATE = 0x00000001U /*!< PTP negative time update */
  305. } ETH_PtpUpdateTypeDef;
  306. /**
  307. *
  308. */
  309. /**
  310. * @brief ETH Init Structure definition
  311. */
  312. typedef struct
  313. {
  314. uint8_t
  315. *MACAddr; /*!< MAC Address of used Hardware: must be pointer on an array of 6 bytes */
  316. ETH_MediaInterfaceTypeDef MediaInterface; /*!< Selects the MII interface or the RMII interface. */
  317. ETH_DMADescTypeDef
  318. *TxDesc; /*!< Provides the address of the first DMA Tx descriptor in the list */
  319. ETH_DMADescTypeDef
  320. *RxDesc; /*!< Provides the address of the first DMA Rx descriptor in the list */
  321. uint32_t RxBuffLen; /*!< Provides the length of Rx buffers size */
  322. } ETH_InitTypeDef;
  323. /**
  324. *
  325. */
  326. /**
  327. * @brief ETH PTP Init Structure definition
  328. */
  329. typedef struct
  330. {
  331. uint32_t Timestamp; /*!< Enable Timestamp */
  332. uint32_t TimestampUpdateMode; /*!< Fine or Coarse Timestamp Update */
  333. uint32_t TimestampInitialize; /*!< Initialize Timestamp */
  334. uint32_t TimestampUpdate; /*!< Timestamp Update */
  335. uint32_t TimestampAddendUpdate; /*!< Timestamp Addend Update */
  336. uint32_t TimestampAll; /*!< Enable Timestamp for All Packets */
  337. uint32_t TimestampRolloverMode; /*!< Timestamp Digital or Binary Rollover Control */
  338. uint32_t TimestampV2; /*!< Enable PTP Packet Processing for Version 2 Format */
  339. uint32_t TimestampEthernet; /*!< Enable Processing of PTP over Ethernet Packets */
  340. uint32_t TimestampIPv6; /*!< Enable Processing of PTP Packets Sent over IPv6-UDP */
  341. uint32_t TimestampIPv4; /*!< Enable Processing of PTP Packets Sent over IPv4-UDP */
  342. uint32_t TimestampEvent; /*!< Enable Timestamp Snapshot for Event Messages */
  343. uint32_t TimestampMaster; /*!< Enable Timestamp Snapshot for Event Messages */
  344. uint32_t TimestampSnapshots; /*!< Select PTP packets for Taking Snapshots */
  345. uint32_t TimestampFilter; /*!< Enable MAC Address for PTP Packet Filtering */
  346. uint32_t
  347. TimestampChecksumCorrection; /*!< Enable checksum correction during OST for PTP over UDP/IPv4 packets */
  348. uint32_t TimestampStatusMode; /*!< Transmit Timestamp Status Mode */
  349. uint32_t TimestampAddend; /*!< Timestamp addend value */
  350. uint32_t TimestampSubsecondInc; /*!< Subsecond Increment */
  351. } ETH_PTP_ConfigTypeDef;
  352. /**
  353. *
  354. */
  355. /**
  356. * @brief HAL State structures definition
  357. */
  358. typedef uint32_t HAL_ETH_StateTypeDef;
  359. /**
  360. *
  361. */
  362. /**
  363. * @brief HAL ETH Rx Get Buffer Function definition
  364. */
  365. typedef void (*pETH_rxAllocateCallbackTypeDef)(uint8_t **buffer); /*!< pointer to an ETH Rx Get Buffer Function */
  366. /**
  367. *
  368. */
  369. /**
  370. * @brief HAL ETH Rx Set App Data Function definition
  371. */
  372. typedef void (*pETH_rxLinkCallbackTypeDef)(void **pStart, void **pEnd, uint8_t *buff,
  373. uint16_t Length); /*!< pointer to an ETH Rx Set App Data Function */
  374. /**
  375. *
  376. */
  377. /**
  378. * @brief HAL ETH Tx Free Function definition
  379. */
  380. typedef void (*pETH_txFreeCallbackTypeDef)(uint32_t *buffer); /*!< pointer to an ETH Tx Free function */
  381. /**
  382. *
  383. */
  384. /**
  385. * @brief HAL ETH Tx Free Function definition
  386. */
  387. typedef void (*pETH_txPtpCallbackTypeDef)(uint32_t *buffer,
  388. ETH_TimeStampTypeDef *timestamp); /*!< pointer to an ETH Tx Free function */
  389. /**
  390. *
  391. */
  392. /**
  393. * @brief ETH Handle Structure definition
  394. */
  395. #if (USE_HAL_ETH_REGISTER_CALLBACKS == 1)
  396. typedef struct __ETH_HandleTypeDef
  397. #else
  398. typedef struct
  399. #endif /* USE_HAL_ETH_REGISTER_CALLBACKS */
  400. {
  401. ETH_TypeDef *Instance; /*!< Register base address */
  402. ETH_InitTypeDef Init; /*!< Ethernet Init Configuration */
  403. ETH_TxDescListTypeDef TxDescList; /*!< Tx descriptor wrapper: holds all Tx descriptors list
  404. addresses and current descriptor index */
  405. ETH_RxDescListTypeDef RxDescList; /*!< Rx descriptor wrapper: holds all Rx descriptors list
  406. addresses and current descriptor index */
  407. #ifdef HAL_ETH_USE_PTP
  408. ETH_TimeStampTypeDef TxTimestamp; /*!< Tx Timestamp */
  409. #endif /* HAL_ETH_USE_PTP */
  410. __IO HAL_ETH_StateTypeDef gState; /*!< ETH state information related to global Handle management
  411. and also related to Tx operations. This parameter can
  412. be a value of @ref HAL_ETH_StateTypeDef */
  413. __IO uint32_t ErrorCode; /*!< Holds the global Error code of the ETH HAL status machine
  414. This parameter can be a value of @ref ETH_Error_Code.*/
  415. __IO uint32_t
  416. DMAErrorCode; /*!< Holds the DMA Rx Tx Error code when a DMA AIS interrupt occurs
  417. This parameter can be a combination of
  418. @ref ETH_DMA_Status_Flags */
  419. __IO uint32_t
  420. MACErrorCode; /*!< Holds the MAC Rx Tx Error code when a MAC Rx or Tx status interrupt occurs
  421. This parameter can be a combination of
  422. @ref ETH_MAC_Rx_Tx_Status */
  423. __IO uint32_t MACWakeUpEvent; /*!< Holds the Wake Up event when the MAC exit the power down mode
  424. This parameter can be a value of
  425. @ref ETH_MAC_Wake_Up_Event */
  426. __IO uint32_t MACLPIEvent; /*!< Holds the LPI event when the an LPI status interrupt occurs.
  427. This parameter can be a value of @ref ETHEx_LPI_Event */
  428. __IO uint32_t IsPtpConfigured; /*!< Holds the PTP configuration status.
  429. This parameter can be a value of
  430. @ref ETH_PTP_Config_Status */
  431. #if (USE_HAL_ETH_REGISTER_CALLBACKS == 1)
  432. void (* TxCpltCallback)(struct __ETH_HandleTypeDef *heth); /*!< ETH Tx Complete Callback */
  433. void (* RxCpltCallback)(struct __ETH_HandleTypeDef *heth); /*!< ETH Rx Complete Callback */
  434. void (* ErrorCallback)(struct __ETH_HandleTypeDef *heth); /*!< ETH Error Callback */
  435. void (* PMTCallback)(struct __ETH_HandleTypeDef *heth); /*!< ETH Power Management Callback */
  436. void (* EEECallback)(struct __ETH_HandleTypeDef *heth); /*!< ETH EEE Callback */
  437. void (* WakeUpCallback)(struct __ETH_HandleTypeDef *heth); /*!< ETH Wake UP Callback */
  438. void (* MspInitCallback)(struct __ETH_HandleTypeDef *heth); /*!< ETH Msp Init callback */
  439. void (* MspDeInitCallback)(struct __ETH_HandleTypeDef *heth); /*!< ETH Msp DeInit callback */
  440. #endif /* USE_HAL_ETH_REGISTER_CALLBACKS */
  441. pETH_rxAllocateCallbackTypeDef rxAllocateCallback; /*!< ETH Rx Get Buffer Function */
  442. pETH_rxLinkCallbackTypeDef rxLinkCallback; /*!< ETH Rx Set App Data Function */
  443. pETH_txFreeCallbackTypeDef txFreeCallback; /*!< ETH Tx Free Function */
  444. pETH_txPtpCallbackTypeDef txPtpCallback; /*!< ETH Tx Handle Ptp Function */
  445. } ETH_HandleTypeDef;
  446. /**
  447. *
  448. */
  449. #if (USE_HAL_ETH_REGISTER_CALLBACKS == 1)
  450. /**
  451. * @brief HAL ETH Callback ID enumeration definition
  452. */
  453. typedef enum
  454. {
  455. HAL_ETH_MSPINIT_CB_ID = 0x00U, /*!< ETH MspInit callback ID */
  456. HAL_ETH_MSPDEINIT_CB_ID = 0x01U, /*!< ETH MspDeInit callback ID */
  457. HAL_ETH_TX_COMPLETE_CB_ID = 0x02U, /*!< ETH Tx Complete Callback ID */
  458. HAL_ETH_RX_COMPLETE_CB_ID = 0x03U, /*!< ETH Rx Complete Callback ID */
  459. HAL_ETH_ERROR_CB_ID = 0x04U, /*!< ETH Error Callback ID */
  460. HAL_ETH_PMT_CB_ID = 0x06U, /*!< ETH Power Management Callback ID */
  461. HAL_ETH_EEE_CB_ID = 0x07U, /*!< ETH EEE Callback ID */
  462. HAL_ETH_WAKEUP_CB_ID = 0x08U /*!< ETH Wake UP Callback ID */
  463. } HAL_ETH_CallbackIDTypeDef;
  464. /**
  465. * @brief HAL ETH Callback pointer definition
  466. */
  467. typedef void (*pETH_CallbackTypeDef)(ETH_HandleTypeDef *heth); /*!< pointer to an ETH callback function */
  468. #endif /* USE_HAL_ETH_REGISTER_CALLBACKS */
  469. /**
  470. * @brief ETH MAC filter structure definition
  471. */
  472. typedef struct
  473. {
  474. FunctionalState PromiscuousMode; /*!< Enable or Disable Promiscuous Mode */
  475. FunctionalState ReceiveAllMode; /*!< Enable or Disable Receive All Mode */
  476. FunctionalState HachOrPerfectFilter; /*!< Enable or Disable Perfect filtering in addition to Hash filtering */
  477. FunctionalState HashUnicast; /*!< Enable or Disable Hash filtering on unicast packets */
  478. FunctionalState HashMulticast; /*!< Enable or Disable Hash filtering on multicast packets */
  479. FunctionalState PassAllMulticast; /*!< Enable or Disable passing all multicast packets */
  480. FunctionalState SrcAddrFiltering; /*!< Enable or Disable source address filtering module */
  481. FunctionalState SrcAddrInverseFiltering; /*!< Enable or Disable source address inverse filtering */
  482. FunctionalState DestAddrInverseFiltering; /*!< Enable or Disable destination address inverse filtering */
  483. FunctionalState BroadcastFilter; /*!< Enable or Disable broadcast filter */
  484. uint32_t ControlPacketsFilter; /*!< Set the control packets filter
  485. This parameter can be a value of @ref ETH_Control_Packets_Filter */
  486. } ETH_MACFilterConfigTypeDef;
  487. /**
  488. *
  489. */
  490. /**
  491. * @brief ETH Power Down structure definition
  492. */
  493. typedef struct
  494. {
  495. FunctionalState WakeUpPacket; /*!< Enable or Disable Wake up packet detection in power down mode */
  496. FunctionalState MagicPacket; /*!< Enable or Disable Magic packet detection in power down mode */
  497. FunctionalState GlobalUnicast; /*!< Enable or Disable Global unicast packet detection in power down mode */
  498. FunctionalState WakeUpForward; /*!< Enable or Disable Forwarding Wake up packets */
  499. } ETH_PowerDownConfigTypeDef;
  500. /**
  501. *
  502. */
  503. /**
  504. * @}
  505. */
  506. /* Exported constants --------------------------------------------------------*/
  507. /** @defgroup ETH_Exported_Constants ETH Exported Constants
  508. * @{
  509. */
  510. /** @defgroup ETH_DMA_Tx_Descriptor_Bit_Definition ETH DMA Tx Descriptor Bit Definition
  511. * @{
  512. */
  513. /*
  514. DMA Tx Normal Descriptor Read Format
  515. -----------------------------------------------------------------------------------------------
  516. TDES0 | Buffer1 or Header Address [31:0] |
  517. -----------------------------------------------------------------------------------------------
  518. TDES1 | Buffer2 Address [31:0] / Next Descriptor Address [31:0] |
  519. -----------------------------------------------------------------------------------------------
  520. TDES2 | IOC(31) | TTSE(30) | Buff2 Length[29:16] | VTIR[15:14] | Header or Buff1 Length[13:0] |
  521. -----------------------------------------------------------------------------------------------
  522. TDES3 | OWN(31) | CTRL[30:26] | Reserved[25:24] | CTRL[23:20] | Reserved[19:17] | Status[16:0] |
  523. -----------------------------------------------------------------------------------------------
  524. */
  525. /**
  526. * @brief Bit definition of TDES0 RF register
  527. */
  528. #define ETH_DMATXNDESCRF_B1AP ((uint32_t)0xFFFFFFFFU) /*!< Transmit Packet Timestamp Low */
  529. /**
  530. * @brief Bit definition of TDES1 RF register
  531. */
  532. #define ETH_DMATXNDESCRF_B2AP ((uint32_t)0xFFFFFFFFU) /*!< Transmit Packet Timestamp High */
  533. /**
  534. * @brief Bit definition of TDES2 RF register
  535. */
  536. #define ETH_DMATXNDESCRF_IOC ((uint32_t)0x80000000U) /*!< Interrupt on Completion */
  537. #define ETH_DMATXNDESCRF_TTSE ((uint32_t)0x40000000U) /*!< Transmit Timestamp Enable */
  538. #define ETH_DMATXNDESCRF_B2L ((uint32_t)0x3FFF0000U) /*!< Buffer 2 Length */
  539. #define ETH_DMATXNDESCRF_VTIR ((uint32_t)0x0000C000U) /*!< VLAN Tag Insertion or Replacement mask */
  540. #define ETH_DMATXNDESCRF_VTIR_DISABLE ((uint32_t)0x00000000U) /*!< Do not add a VLAN tag. */
  541. #define ETH_DMATXNDESCRF_VTIR_REMOVE ((uint32_t)0x00004000U) /*!< Remove the VLAN tag from the packets before transmission. */
  542. #define ETH_DMATXNDESCRF_VTIR_INSERT ((uint32_t)0x00008000U) /*!< Insert a VLAN tag. */
  543. #define ETH_DMATXNDESCRF_VTIR_REPLACE ((uint32_t)0x0000C000U) /*!< Replace the VLAN tag. */
  544. #define ETH_DMATXNDESCRF_B1L ((uint32_t)0x00003FFFU) /*!< Buffer 1 Length */
  545. #define ETH_DMATXNDESCRF_HL ((uint32_t)0x000003FFU) /*!< Header Length */
  546. /**
  547. * @brief Bit definition of TDES3 RF register
  548. */
  549. #define ETH_DMATXNDESCRF_OWN ((uint32_t)0x80000000U) /*!< OWN bit: descriptor is owned by DMA engine */
  550. #define ETH_DMATXNDESCRF_CTXT ((uint32_t)0x40000000U) /*!< Context Type */
  551. #define ETH_DMATXNDESCRF_FD ((uint32_t)0x20000000U) /*!< First Descriptor */
  552. #define ETH_DMATXNDESCRF_LD ((uint32_t)0x10000000U) /*!< Last Descriptor */
  553. #define ETH_DMATXNDESCRF_CPC ((uint32_t)0x0C000000U) /*!< CRC Pad Control mask */
  554. #define ETH_DMATXNDESCRF_CPC_CRCPAD_INSERT ((uint32_t)0x00000000U) /*!< CRC Pad Control: CRC and Pad Insertion */
  555. #define ETH_DMATXNDESCRF_CPC_CRC_INSERT ((uint32_t)0x04000000U) /*!< CRC Pad Control: CRC Insertion (Disable Pad Insertion) */
  556. #define ETH_DMATXNDESCRF_CPC_DISABLE ((uint32_t)0x08000000U) /*!< CRC Pad Control: Disable CRC Insertion */
  557. #define ETH_DMATXNDESCRF_CPC_CRC_REPLACE ((uint32_t)0x0C000000U) /*!< CRC Pad Control: CRC Replacement */
  558. #define ETH_DMATXNDESCRF_SAIC ((uint32_t)0x03800000U) /*!< SA Insertion Control mask*/
  559. #define ETH_DMATXNDESCRF_SAIC_DISABLE ((uint32_t)0x00000000U) /*!< SA Insertion Control: Do not include the source address */
  560. #define ETH_DMATXNDESCRF_SAIC_INSERT ((uint32_t)0x00800000U) /*!< SA Insertion Control: Include or insert the source address */
  561. #define ETH_DMATXNDESCRF_SAIC_REPLACE ((uint32_t)0x01000000U) /*!< SA Insertion Control: Replace the source address */
  562. #define ETH_DMATXNDESCRF_THL ((uint32_t)0x00780000U) /*!< TCP Header Length */
  563. #define ETH_DMATXNDESCRF_TSE ((uint32_t)0x00040000U) /*!< TCP segmentation enable */
  564. #define ETH_DMATXNDESCRF_CIC ((uint32_t)0x00030000U) /*!< Checksum Insertion Control: 4 cases */
  565. #define ETH_DMATXNDESCRF_CIC_DISABLE ((uint32_t)0x00000000U) /*!< Do Nothing: Checksum Engine is disabled */
  566. #define ETH_DMATXNDESCRF_CIC_IPHDR_INSERT ((uint32_t)0x00010000U) /*!< Only IP header checksum calculation and insertion are enabled. */
  567. #define ETH_DMATXNDESCRF_CIC_IPHDR_PAYLOAD_INSERT ((uint32_t)0x00020000U) /*!< IP header checksum and payload checksum calculation and insertion are
  568. enabled, but pseudo header
  569. checksum is not
  570. calculated in hardware */
  571. #define ETH_DMATXNDESCRF_CIC_IPHDR_PAYLOAD_INSERT_PHDR_CALC ((uint32_t)0x00030000U) /*!< IP Header checksum and payload checksum calculation and insertion are
  572. enabled, and pseudo header
  573. checksum is
  574. calculated in hardware. */
  575. #define ETH_DMATXNDESCRF_TPL ((uint32_t)0x0003FFFFU) /*!< TCP Payload Length */
  576. #define ETH_DMATXNDESCRF_FL ((uint32_t)0x00007FFFU) /*!< Transmit End of Ring */
  577. /*
  578. DMA Tx Normal Descriptor Write Back Format
  579. -----------------------------------------------------------------------------------------------
  580. TDES0 | Timestamp Low |
  581. -----------------------------------------------------------------------------------------------
  582. TDES1 | Timestamp High |
  583. -----------------------------------------------------------------------------------------------
  584. TDES2 | Reserved[31:0] |
  585. -----------------------------------------------------------------------------------------------
  586. TDES3 | OWN(31) | Status[30:0] |
  587. -----------------------------------------------------------------------------------------------
  588. */
  589. /**
  590. * @brief Bit definition of TDES0 WBF register
  591. */
  592. #define ETH_DMATXNDESCWBF_TTSL ((uint32_t)0xFFFFFFFFU) /*!< Buffer1 Address Pointer or TSO Header Address Pointer */
  593. /**
  594. * @brief Bit definition of TDES1 WBF register
  595. */
  596. #define ETH_DMATXNDESCWBF_TTSH ((uint32_t)0xFFFFFFFFU) /*!< Buffer2 Address Pointer */
  597. /**
  598. * @brief Bit definition of TDES3 WBF register
  599. */
  600. #define ETH_DMATXNDESCWBF_OWN ((uint32_t)0x80000000U) /*!< OWN bit: descriptor is owned by DMA engine */
  601. #define ETH_DMATXNDESCWBF_CTXT ((uint32_t)0x40000000U) /*!< Context Type */
  602. #define ETH_DMATXNDESCWBF_FD ((uint32_t)0x20000000U) /*!< First Descriptor */
  603. #define ETH_DMATXNDESCWBF_LD ((uint32_t)0x10000000U) /*!< Last Descriptor */
  604. #define ETH_DMATXNDESCWBF_TTSS ((uint32_t)0x00020000U) /*!< Tx Timestamp Status */
  605. #define ETH_DMATXNDESCWBF_DP ((uint32_t)0x04000000U) /*!< Disable Padding */
  606. #define ETH_DMATXNDESCWBF_TTSE ((uint32_t)0x02000000U) /*!< Transmit Timestamp Enable */
  607. #define ETH_DMATXNDESCWBF_ES ((uint32_t)0x00008000U) /*!< Error summary: OR of the following bits: IHE || UF || ED || EC || LCO || PCE || NC || LCA || FF || JT */
  608. #define ETH_DMATXNDESCWBF_JT ((uint32_t)0x00004000U) /*!< Jabber Timeout */
  609. #define ETH_DMATXNDESCWBF_FF ((uint32_t)0x00002000U) /*!< Packet Flushed: DMA/MTL flushed the packet due to SW flush */
  610. #define ETH_DMATXNDESCWBF_PCE ((uint32_t)0x00001000U) /*!< Payload Checksum Error */
  611. #define ETH_DMATXNDESCWBF_LCA ((uint32_t)0x00000800U) /*!< Loss of Carrier: carrier lost during transmission */
  612. #define ETH_DMATXNDESCWBF_NC ((uint32_t)0x00000400U) /*!< No Carrier: no carrier signal from the transceiver */
  613. #define ETH_DMATXNDESCWBF_LCO ((uint32_t)0x00000200U) /*!< Late Collision: transmission aborted due to collision */
  614. #define ETH_DMATXNDESCWBF_EC ((uint32_t)0x00000100U) /*!< Excessive Collision: transmission aborted after 16 collisions */
  615. #define ETH_DMATXNDESCWBF_CC ((uint32_t)0x000000F0U) /*!< Collision Count */
  616. #define ETH_DMATXNDESCWBF_ED ((uint32_t)0x00000008U) /*!< Excessive Deferral */
  617. #define ETH_DMATXNDESCWBF_UF ((uint32_t)0x00000004U) /*!< Underflow Error: late data arrival from the memory */
  618. #define ETH_DMATXNDESCWBF_DB ((uint32_t)0x00000002U) /*!< Deferred Bit */
  619. #define ETH_DMATXNDESCWBF_IHE ((uint32_t)0x00000004U) /*!< IP Header Error */
  620. /*
  621. DMA Tx Context Descriptor
  622. -----------------------------------------------------------------------------------------------
  623. TDES0 | Timestamp Low |
  624. -----------------------------------------------------------------------------------------------
  625. TDES1 | Timestamp High |
  626. -----------------------------------------------------------------------------------------------
  627. TDES2 | Inner VLAN Tag[31:16] | Reserved(15) | Maximum Segment Size [14:0] |
  628. -----------------------------------------------------------------------------------------------
  629. TDES3 | OWN(31) | Status[30:0] |
  630. -----------------------------------------------------------------------------------------------
  631. */
  632. /**
  633. * @brief Bit definition of Tx context descriptor register 0
  634. */
  635. #define ETH_DMATXCDESC_TTSL ((uint32_t)0xFFFFFFFFU) /*!< Transmit Packet Timestamp Low */
  636. /**
  637. * @brief Bit definition of Tx context descriptor register 1
  638. */
  639. #define ETH_DMATXCDESC_TTSH ((uint32_t)0xFFFFFFFFU) /*!< Transmit Packet Timestamp High */
  640. /**
  641. * @brief Bit definition of Tx context descriptor register 2
  642. */
  643. #define ETH_DMATXCDESC_IVT ((uint32_t)0xFFFF0000U) /*!< Inner VLAN Tag */
  644. #define ETH_DMATXCDESC_MSS ((uint32_t)0x00003FFFU) /*!< Maximum Segment Size */
  645. /**
  646. * @brief Bit definition of Tx context descriptor register 3
  647. */
  648. #define ETH_DMATXCDESC_OWN ((uint32_t)0x80000000U) /*!< OWN bit: descriptor is owned by DMA engine */
  649. #define ETH_DMATXCDESC_CTXT ((uint32_t)0x40000000U) /*!< Context Type */
  650. #define ETH_DMATXCDESC_OSTC ((uint32_t)0x08000000U) /*!< One-Step Timestamp Correction Enable */
  651. #define ETH_DMATXCDESC_TCMSSV ((uint32_t)0x04000000U) /*!< One-Step Timestamp Correction Input or MSS Valid */
  652. #define ETH_DMATXCDESC_CDE ((uint32_t)0x00800000U) /*!< Context Descriptor Error */
  653. #define ETH_DMATXCDESC_IVTIR ((uint32_t)0x000C0000U) /*!< Inner VLAN Tag Insert or Replace Mask */
  654. #define ETH_DMATXCDESC_IVTIR_DISABLE ((uint32_t)0x00000000U) /*!< Do not add the inner VLAN tag. */
  655. #define ETH_DMATXCDESC_IVTIR_REMOVE ((uint32_t)0x00040000U) /*!< Remove the inner VLAN tag from the packets before transmission. */
  656. #define ETH_DMATXCDESC_IVTIR_INSERT ((uint32_t)0x00080000U) /*!< Insert the inner VLAN tag. */
  657. #define ETH_DMATXCDESC_IVTIR_REPLACE ((uint32_t)0x000C0000U) /*!< Replace the inner VLAN tag. */
  658. #define ETH_DMATXCDESC_IVLTV ((uint32_t)0x00020000U) /*!< Inner VLAN Tag Valid */
  659. #define ETH_DMATXCDESC_VLTV ((uint32_t)0x00010000U) /*!< VLAN Tag Valid */
  660. #define ETH_DMATXCDESC_VT ((uint32_t)0x0000FFFFU) /*!< VLAN Tag */
  661. /**
  662. * @}
  663. */
  664. /** @defgroup ETH_DMA_Rx_Descriptor_Bit_Definition ETH DMA Rx Descriptor Bit Definition
  665. * @{
  666. */
  667. /*
  668. DMA Rx Normal Descriptor read format
  669. -----------------------------------------------------------------------------------------------------------
  670. RDES0 | Buffer1 or Header Address [31:0] |
  671. -----------------------------------------------------------------------------------------------------------
  672. RDES1 | Reserved |
  673. -----------------------------------------------------------------------------------------------------------
  674. RDES2 | Payload or Buffer2 Address[31:0] |
  675. -----------------------------------------------------------------------------------------------------------
  676. RDES3 | OWN(31) | IOC(30) | Reserved [29:26] | BUF2V(25) | BUF1V(24) | Reserved [23:0] |
  677. -----------------------------------------------------------------------------------------------------------
  678. */
  679. /**
  680. * @brief Bit definition of Rx normal descriptor register 0 read format
  681. */
  682. #define ETH_DMARXNDESCRF_BUF1AP ((uint32_t)0xFFFFFFFFU) /*!< Header or Buffer 1 Address Pointer */
  683. /**
  684. * @brief Bit definition of Rx normal descriptor register 2 read format
  685. */
  686. #define ETH_DMARXNDESCRF_BUF2AP ((uint32_t)0xFFFFFFFFU) /*!< Buffer 2 Address Pointer */
  687. /**
  688. * @brief Bit definition of Rx normal descriptor register 3 read format
  689. */
  690. #define ETH_DMARXNDESCRF_OWN ((uint32_t)0x80000000U) /*!< OWN bit: descriptor is owned by DMA engine */
  691. #define ETH_DMARXNDESCRF_IOC ((uint32_t)0x40000000U) /*!< Interrupt Enabled on Completion */
  692. #define ETH_DMARXNDESCRF_BUF2V ((uint32_t)0x02000000U) /*!< Buffer 2 Address Valid */
  693. #define ETH_DMARXNDESCRF_BUF1V ((uint32_t)0x01000000U) /*!< Buffer 1 Address Valid */
  694. /*
  695. DMA Rx Normal Descriptor write back format
  696. ---------------------------------------------------------------------------------------------------------------------
  697. RDES0 | Inner VLAN Tag[31:16] | Outer VLAN Tag[15:0] |
  698. ---------------------------------------------------------------------------------------------------------------------
  699. RDES1 | OAM code, or MAC Control Opcode [31:16] | Extended Status |
  700. ---------------------------------------------------------------------------------------------------------------------
  701. RDES2 | MAC Filter Status[31:16] | VF(15) | Reserved [14:12] | ARP Status [11:10] | Header Length [9:0] |
  702. ---------------------------------------------------------------------------------------------------------------------
  703. RDES3 | OWN(31) | CTXT(30) | FD(29) | LD(28) | Status[27:16] | ES(15) | Packet Length[14:0] |
  704. ---------------------------------------------------------------------------------------------------------------------
  705. */
  706. /**
  707. * @brief Bit definition of Rx normal descriptor register 0 write back format
  708. */
  709. #define ETH_DMARXNDESCWBF_IVT ((uint32_t)0xFFFF0000U) /*!< Inner VLAN Tag */
  710. #define ETH_DMARXNDESCWBF_OVT ((uint32_t)0x0000FFFFU) /*!< Outer VLAN Tag */
  711. /**
  712. * @brief Bit definition of Rx normal descriptor register 1 write back format
  713. */
  714. #define ETH_DMARXNDESCWBF_OPC ((uint32_t)0xFFFF0000U) /*!< OAM Sub-Type Code, or MAC Control Packet opcode */
  715. #define ETH_DMARXNDESCWBF_TD ((uint32_t)0x00008000U) /*!< Timestamp Dropped */
  716. #define ETH_DMARXNDESCWBF_TSA ((uint32_t)0x00004000U) /*!< Timestamp Available */
  717. #define ETH_DMARXNDESCWBF_PV ((uint32_t)0x00002000U) /*!< PTP Version */
  718. #define ETH_DMARXNDESCWBF_PFT ((uint32_t)0x00001000U) /*!< PTP Packet Type */
  719. #define ETH_DMARXNDESCWBF_PMT_NO ((uint32_t)0x00000000U) /*!< PTP Message Type: No PTP message received */
  720. #define ETH_DMARXNDESCWBF_PMT_SYNC ((uint32_t)0x00000100U) /*!< PTP Message Type: SYNC (all clock types) */
  721. #define ETH_DMARXNDESCWBF_PMT_FUP ((uint32_t)0x00000200U) /*!< PTP Message Type: Follow_Up (all clock types) */
  722. #define ETH_DMARXNDESCWBF_PMT_DREQ ((uint32_t)0x00000300U) /*!< PTP Message Type: Delay_Req (all clock types) */
  723. #define ETH_DMARXNDESCWBF_PMT_DRESP ((uint32_t)0x00000400U) /*!< PTP Message Type: Delay_Resp (all clock types) */
  724. #define ETH_DMARXNDESCWBF_PMT_PDREQ ((uint32_t)0x00000500U) /*!< PTP Message Type: Pdelay_Req (in peer-to-peer transparent clock) */
  725. #define ETH_DMARXNDESCWBF_PMT_PDRESP ((uint32_t)0x00000600U) /*!< PTP Message Type: Pdelay_Resp (in peer-to-peer transparent clock) */
  726. #define ETH_DMARXNDESCWBF_PMT_PDRESPFUP ((uint32_t)0x00000700U) /*!< PTP Message Type: Pdelay_Resp_Follow_Up (in peer-to-peer transparent clock) */
  727. #define ETH_DMARXNDESCWBF_PMT_ANNOUNCE ((uint32_t)0x00000800U) /*!< PTP Message Type: Announce */
  728. #define ETH_DMARXNDESCWBF_PMT_MANAG ((uint32_t)0x00000900U) /*!< PTP Message Type: Management */
  729. #define ETH_DMARXNDESCWBF_PMT_SIGN ((uint32_t)0x00000A00U) /*!< PTP Message Type: Signaling */
  730. #define ETH_DMARXNDESCWBF_PMT_RESERVED ((uint32_t)0x00000F00U) /*!< PTP Message Type: PTP packet with Reserved message type */
  731. #define ETH_DMARXNDESCWBF_IPCE ((uint32_t)0x00000080U) /*!< IP Payload Error */
  732. #define ETH_DMARXNDESCWBF_IPCB ((uint32_t)0x00000040U) /*!< IP Checksum Bypassed */
  733. #define ETH_DMARXNDESCWBF_IPV6 ((uint32_t)0x00000020U) /*!< IPv6 header Present */
  734. #define ETH_DMARXNDESCWBF_IPV4 ((uint32_t)0x00000010U) /*!< IPv4 header Present */
  735. #define ETH_DMARXNDESCWBF_IPHE ((uint32_t)0x00000008U) /*!< IP Header Error */
  736. #define ETH_DMARXNDESCWBF_PT ((uint32_t)0x00000003U) /*!< Payload Type mask */
  737. #define ETH_DMARXNDESCWBF_PT_UNKNOWN ((uint32_t)0x00000000U) /*!< Payload Type: Unknown type or IP/AV payload not processed */
  738. #define ETH_DMARXNDESCWBF_PT_UDP ((uint32_t)0x00000001U) /*!< Payload Type: UDP */
  739. #define ETH_DMARXNDESCWBF_PT_TCP ((uint32_t)0x00000002U) /*!< Payload Type: TCP */
  740. #define ETH_DMARXNDESCWBF_PT_ICMP ((uint32_t)0x00000003U) /*!< Payload Type: ICMP */
  741. /**
  742. * @brief Bit definition of Rx normal descriptor register 2 write back format
  743. */
  744. #define ETH_DMARXNDESCWBF_L3L4FM ((uint32_t)0x20000000U) /*!< L3 and L4 Filter Number Matched: if reset filter 0 is matched , if set filter 1 is matched */
  745. #define ETH_DMARXNDESCWBF_L4FM ((uint32_t)0x10000000U) /*!< Layer 4 Filter Match */
  746. #define ETH_DMARXNDESCWBF_L3FM ((uint32_t)0x08000000U) /*!< Layer 3 Filter Match */
  747. #define ETH_DMARXNDESCWBF_MADRM ((uint32_t)0x07F80000U) /*!< MAC Address Match or Hash Value */
  748. #define ETH_DMARXNDESCWBF_HF ((uint32_t)0x00040000U) /*!< Hash Filter Status */
  749. #define ETH_DMARXNDESCWBF_DAF ((uint32_t)0x00020000U) /*!< Destination Address Filter Fail */
  750. #define ETH_DMARXNDESCWBF_SAF ((uint32_t)0x00010000U) /*!< SA Address Filter Fail */
  751. #define ETH_DMARXNDESCWBF_VF ((uint32_t)0x00008000U) /*!< VLAN Filter Status */
  752. #define ETH_DMARXNDESCWBF_ARPNR ((uint32_t)0x00000400U) /*!< ARP Reply Not Generated */
  753. /**
  754. * @brief Bit definition of Rx normal descriptor register 3 write back format
  755. */
  756. #define ETH_DMARXNDESCWBF_OWN ((uint32_t)0x80000000U) /*!< Own Bit */
  757. #define ETH_DMARXNDESCWBF_CTXT ((uint32_t)0x40000000U) /*!< Receive Context Descriptor */
  758. #define ETH_DMARXNDESCWBF_FD ((uint32_t)0x20000000U) /*!< First Descriptor */
  759. #define ETH_DMARXNDESCWBF_LD ((uint32_t)0x10000000U) /*!< Last Descriptor */
  760. #define ETH_DMARXNDESCWBF_RS2V ((uint32_t)0x08000000U) /*!< Receive Status RDES2 Valid */
  761. #define ETH_DMARXNDESCWBF_RS1V ((uint32_t)0x04000000U) /*!< Receive Status RDES1 Valid */
  762. #define ETH_DMARXNDESCWBF_RS0V ((uint32_t)0x02000000U) /*!< Receive Status RDES0 Valid */
  763. #define ETH_DMARXNDESCWBF_CE ((uint32_t)0x01000000U) /*!< CRC Error */
  764. #define ETH_DMARXNDESCWBF_GP ((uint32_t)0x00800000U) /*!< Giant Packet */
  765. #define ETH_DMARXNDESCWBF_RWT ((uint32_t)0x00400000U) /*!< Receive Watchdog Timeout */
  766. #define ETH_DMARXNDESCWBF_OE ((uint32_t)0x00200000U) /*!< Overflow Error */
  767. #define ETH_DMARXNDESCWBF_RE ((uint32_t)0x00100000U) /*!< Receive Error */
  768. #define ETH_DMARXNDESCWBF_DE ((uint32_t)0x00080000U) /*!< Dribble Bit Error */
  769. #define ETH_DMARXNDESCWBF_LT ((uint32_t)0x00070000U) /*!< Length/Type Field */
  770. #define ETH_DMARXNDESCWBF_LT_LP ((uint32_t)0x00000000U) /*!< The packet is a length packet */
  771. #define ETH_DMARXNDESCWBF_LT_TP ((uint32_t)0x00010000U) /*!< The packet is a type packet */
  772. #define ETH_DMARXNDESCWBF_LT_ARP ((uint32_t)0x00030000U) /*!< The packet is a ARP Request packet type */
  773. #define ETH_DMARXNDESCWBF_LT_VLAN ((uint32_t)0x00040000U) /*!< The packet is a type packet with VLAN Tag */
  774. #define ETH_DMARXNDESCWBF_LT_DVLAN ((uint32_t)0x00050000U) /*!< The packet is a type packet with Double VLAN Tag */
  775. #define ETH_DMARXNDESCWBF_LT_MAC ((uint32_t)0x00060000U) /*!< The packet is a MAC Control packet type */
  776. #define ETH_DMARXNDESCWBF_LT_OAM ((uint32_t)0x00070000U) /*!< The packet is a OAM packet type */
  777. #define ETH_DMARXNDESCWBF_ES ((uint32_t)0x00008000U) /*!< Error Summary */
  778. #define ETH_DMARXNDESCWBF_PL ((uint32_t)0x00007FFFU) /*!< Packet Length */
  779. /*
  780. DMA Rx context Descriptor
  781. ---------------------------------------------------------------------------------------------------------------------
  782. RDES0 | Timestamp Low[31:0] |
  783. ---------------------------------------------------------------------------------------------------------------------
  784. RDES1 | Timestamp High[31:0] |
  785. ---------------------------------------------------------------------------------------------------------------------
  786. RDES2 | Reserved |
  787. ---------------------------------------------------------------------------------------------------------------------
  788. RDES3 | OWN(31) | CTXT(30) | Reserved[29:0] |
  789. ---------------------------------------------------------------------------------------------------------------------
  790. */
  791. /**
  792. * @brief Bit definition of Rx context descriptor register 0
  793. */
  794. #define ETH_DMARXCDESC_RTSL ((uint32_t)0xFFFFFFFFU) /*!< Receive Packet Timestamp Low */
  795. /**
  796. * @brief Bit definition of Rx context descriptor register 1
  797. */
  798. #define ETH_DMARXCDESC_RTSH ((uint32_t)0xFFFFFFFFU) /*!< Receive Packet Timestamp High */
  799. /**
  800. * @brief Bit definition of Rx context descriptor register 3
  801. */
  802. #define ETH_DMARXCDESC_OWN ((uint32_t)0x80000000U) /*!< Own Bit */
  803. #define ETH_DMARXCDESC_CTXT ((uint32_t)0x40000000U) /*!< Receive Context Descriptor */
  804. /**
  805. * @}
  806. */
  807. /** @defgroup ETH_Frame_settings ETH frame settings
  808. * @{
  809. */
  810. #define ETH_MAX_PACKET_SIZE ((uint32_t)1528U) /*!< ETH_HEADER + 2*VLAN_TAG + MAX_ETH_PAYLOAD + ETH_CRC */
  811. #define ETH_HEADER ((uint32_t)14U) /*!< 6 byte Dest addr, 6 byte Src addr, 2 byte length/type */
  812. #define ETH_CRC ((uint32_t)4U) /*!< Ethernet CRC */
  813. #define ETH_VLAN_TAG ((uint32_t)4U) /*!< optional 802.1q VLAN Tag */
  814. #define ETH_MIN_PAYLOAD ((uint32_t)46U) /*!< Minimum Ethernet payload size */
  815. #define ETH_MAX_PAYLOAD ((uint32_t)1500U) /*!< Maximum Ethernet payload size */
  816. #define ETH_JUMBO_FRAME_PAYLOAD ((uint32_t)9000U) /*!< Jumbo frame payload size */
  817. /**
  818. * @}
  819. */
  820. /** @defgroup ETH_Error_Code ETH Error Code
  821. * @{
  822. */
  823. #define HAL_ETH_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
  824. #define HAL_ETH_ERROR_PARAM ((uint32_t)0x00000001U) /*!< Busy error */
  825. #define HAL_ETH_ERROR_BUSY ((uint32_t)0x00000002U) /*!< Parameter error */
  826. #define HAL_ETH_ERROR_TIMEOUT ((uint32_t)0x00000004U) /*!< Timeout error */
  827. #define HAL_ETH_ERROR_DMA ((uint32_t)0x00000008U) /*!< DMA transfer error */
  828. #define HAL_ETH_ERROR_MAC ((uint32_t)0x00000010U) /*!< MAC transfer error */
  829. #if (USE_HAL_ETH_REGISTER_CALLBACKS == 1)
  830. #define HAL_ETH_ERROR_INVALID_CALLBACK ((uint32_t)0x00000020U) /*!< Invalid Callback error */
  831. #endif /* USE_HAL_ETH_REGISTER_CALLBACKS */
  832. /**
  833. * @}
  834. */
  835. /** @defgroup ETH_Tx_Packet_Attributes ETH Tx Packet Attributes
  836. * @{
  837. */
  838. #define ETH_TX_PACKETS_FEATURES_CSUM ((uint32_t)0x00000001U)
  839. #define ETH_TX_PACKETS_FEATURES_SAIC ((uint32_t)0x00000002U)
  840. #define ETH_TX_PACKETS_FEATURES_VLANTAG ((uint32_t)0x00000004U)
  841. #define ETH_TX_PACKETS_FEATURES_INNERVLANTAG ((uint32_t)0x00000008U)
  842. #define ETH_TX_PACKETS_FEATURES_TSO ((uint32_t)0x00000010U)
  843. #define ETH_TX_PACKETS_FEATURES_CRCPAD ((uint32_t)0x00000020U)
  844. /**
  845. * @}
  846. */
  847. /** @defgroup ETH_Tx_Packet_Source_Addr_Control ETH Tx Packet Source Addr Control
  848. * @{
  849. */
  850. #define ETH_SRC_ADDR_CONTROL_DISABLE ETH_DMATXNDESCRF_SAIC_DISABLE
  851. #define ETH_SRC_ADDR_INSERT ETH_DMATXNDESCRF_SAIC_INSERT
  852. #define ETH_SRC_ADDR_REPLACE ETH_DMATXNDESCRF_SAIC_REPLACE
  853. /**
  854. * @}
  855. */
  856. /** @defgroup ETH_Tx_Packet_CRC_Pad_Control ETH Tx Packet CRC Pad Control
  857. * @{
  858. */
  859. #define ETH_CRC_PAD_DISABLE ETH_DMATXNDESCRF_CPC_DISABLE
  860. #define ETH_CRC_PAD_INSERT ETH_DMATXNDESCRF_CPC_CRCPAD_INSERT
  861. #define ETH_CRC_INSERT ETH_DMATXNDESCRF_CPC_CRC_INSERT
  862. #define ETH_CRC_REPLACE ETH_DMATXNDESCRF_CPC_CRC_REPLACE
  863. /**
  864. * @}
  865. */
  866. /** @defgroup ETH_Tx_Packet_Checksum_Control ETH Tx Packet Checksum Control
  867. * @{
  868. */
  869. #define ETH_CHECKSUM_DISABLE ETH_DMATXNDESCRF_CIC_DISABLE
  870. #define ETH_CHECKSUM_IPHDR_INSERT ETH_DMATXNDESCRF_CIC_IPHDR_INSERT
  871. #define ETH_CHECKSUM_IPHDR_PAYLOAD_INSERT ETH_DMATXNDESCRF_CIC_IPHDR_PAYLOAD_INSERT
  872. #define ETH_CHECKSUM_IPHDR_PAYLOAD_INSERT_PHDR_CALC ETH_DMATXNDESCRF_CIC_IPHDR_PAYLOAD_INSERT_PHDR_CALC
  873. /**
  874. * @}
  875. */
  876. /** @defgroup ETH_Tx_Packet_VLAN_Control ETH Tx Packet VLAN Control
  877. * @{
  878. */
  879. #define ETH_VLAN_DISABLE ETH_DMATXNDESCRF_VTIR_DISABLE
  880. #define ETH_VLAN_REMOVE ETH_DMATXNDESCRF_VTIR_REMOVE
  881. #define ETH_VLAN_INSERT ETH_DMATXNDESCRF_VTIR_INSERT
  882. #define ETH_VLAN_REPLACE ETH_DMATXNDESCRF_VTIR_REPLACE
  883. /**
  884. * @}
  885. */
  886. /** @defgroup ETH_Tx_Packet_Inner_VLAN_Control ETH Tx Packet Inner VLAN Control
  887. * @{
  888. */
  889. #define ETH_INNER_VLAN_DISABLE ETH_DMATXCDESC_IVTIR_DISABLE
  890. #define ETH_INNER_VLAN_REMOVE ETH_DMATXCDESC_IVTIR_REMOVE
  891. #define ETH_INNER_VLAN_INSERT ETH_DMATXCDESC_IVTIR_INSERT
  892. #define ETH_INNER_VLAN_REPLACE ETH_DMATXCDESC_IVTIR_REPLACE
  893. /**
  894. * @}
  895. */
  896. /** @defgroup ETH_Rx_Checksum_Status ETH Rx Checksum Status
  897. * @{
  898. */
  899. #define ETH_CHECKSUM_BYPASSED ETH_DMARXNDESCWBF_IPCB
  900. #define ETH_CHECKSUM_IP_HEADER_ERROR ETH_DMARXNDESCWBF_IPHE
  901. #define ETH_CHECKSUM_IP_PAYLOAD_ERROR ETH_DMARXNDESCWBF_IPCE
  902. /**
  903. * @}
  904. */
  905. /** @defgroup ETH_Rx_IP_Header_Type ETH Rx IP Header Type
  906. * @{
  907. */
  908. #define ETH_IP_HEADER_IPV4 ETH_DMARXNDESCWBF_IPV4
  909. #define ETH_IP_HEADER_IPV6 ETH_DMARXNDESCWBF_IPV6
  910. /**
  911. * @}
  912. */
  913. /** @defgroup ETH_Rx_Payload_Type ETH Rx Payload Type
  914. * @{
  915. */
  916. #define ETH_IP_PAYLOAD_UNKNOWN ETH_DMARXNDESCWBF_PT_UNKNOWN
  917. #define ETH_IP_PAYLOAD_UDP ETH_DMARXNDESCWBF_PT_UDP
  918. #define ETH_IP_PAYLOAD_TCP ETH_DMARXNDESCWBF_PT_TCP
  919. #define ETH_IP_PAYLOAD_ICMPN ETH_DMARXNDESCWBF_PT_ICMP
  920. /**
  921. * @}
  922. */
  923. /** @defgroup ETH_Rx_MAC_Filter_Status ETH Rx MAC Filter Status
  924. * @{
  925. */
  926. #define ETH_HASH_FILTER_PASS ETH_DMARXNDESCWBF_HF
  927. #define ETH_VLAN_FILTER_PASS ETH_DMARXNDESCWBF_VF
  928. #define ETH_DEST_ADDRESS_FAIL ETH_DMARXNDESCWBF_DAF
  929. #define ETH_SOURCE_ADDRESS_FAIL ETH_DMARXNDESCWBF_SAF
  930. /**
  931. * @}
  932. */
  933. /** @defgroup ETH_Rx_L3_Filter_Status ETH Rx L3 Filter Status
  934. * @{
  935. */
  936. #define ETH_L3_FILTER0_MATCH ETH_DMARXNDESCWBF_L3FM
  937. #define ETH_L3_FILTER1_MATCH (ETH_DMARXNDESCWBF_L3FM | ETH_DMARXNDESCWBF_L3L4FM)
  938. /**
  939. * @}
  940. */
  941. /** @defgroup ETH_Rx_L4_Filter_Status ETH Rx L4 Filter Status
  942. * @{
  943. */
  944. #define ETH_L4_FILTER0_MATCH ETH_DMARXNDESCWBF_L4FM
  945. #define ETH_L4_FILTER1_MATCH (ETH_DMARXNDESCWBF_L4FM | ETH_DMARXNDESCWBF_L3L4FM)
  946. /**
  947. * @}
  948. */
  949. /** @defgroup ETH_Rx_Error_Code ETH Rx Error Code
  950. * @{
  951. */
  952. #define ETH_DRIBBLE_BIT_ERROR ETH_DMARXNDESCWBF_DE
  953. #define ETH_RECEIVE_ERROR ETH_DMARXNDESCWBF_RE
  954. #define ETH_RECEIVE_OVERFLOW ETH_DMARXNDESCWBF_OE
  955. #define ETH_WATCHDOG_TIMEOUT ETH_DMARXNDESCWBF_RWT
  956. #define ETH_GIANT_PACKET ETH_DMARXNDESCWBF_GP
  957. #define ETH_CRC_ERROR ETH_DMARXNDESCWBF_CE
  958. /**
  959. * @}
  960. */
  961. /** @defgroup ETH_DMA_Arbitration ETH DMA Arbitration
  962. * @{
  963. */
  964. #define ETH_DMAARBITRATION_RX ETH_DMAMR_DA
  965. #define ETH_DMAARBITRATION_RX1_TX1 ((uint32_t)0x00000000U)
  966. #define ETH_DMAARBITRATION_RX2_TX1 ETH_DMAMR_PR_2_1
  967. #define ETH_DMAARBITRATION_RX3_TX1 ETH_DMAMR_PR_3_1
  968. #define ETH_DMAARBITRATION_RX4_TX1 ETH_DMAMR_PR_4_1
  969. #define ETH_DMAARBITRATION_RX5_TX1 ETH_DMAMR_PR_5_1
  970. #define ETH_DMAARBITRATION_RX6_TX1 ETH_DMAMR_PR_6_1
  971. #define ETH_DMAARBITRATION_RX7_TX1 ETH_DMAMR_PR_7_1
  972. #define ETH_DMAARBITRATION_RX8_TX1 ETH_DMAMR_PR_8_1
  973. #define ETH_DMAARBITRATION_TX (ETH_DMAMR_TXPR | ETH_DMAMR_DA)
  974. #define ETH_DMAARBITRATION_TX1_RX1 ((uint32_t)0x00000000U)
  975. #define ETH_DMAARBITRATION_TX2_RX1 (ETH_DMAMR_TXPR | ETH_DMAMR_PR_2_1)
  976. #define ETH_DMAARBITRATION_TX3_RX1 (ETH_DMAMR_TXPR | ETH_DMAMR_PR_3_1)
  977. #define ETH_DMAARBITRATION_TX4_RX1 (ETH_DMAMR_TXPR | ETH_DMAMR_PR_4_1)
  978. #define ETH_DMAARBITRATION_TX5_RX1 (ETH_DMAMR_TXPR | ETH_DMAMR_PR_5_1)
  979. #define ETH_DMAARBITRATION_TX6_RX1 (ETH_DMAMR_TXPR | ETH_DMAMR_PR_6_1)
  980. #define ETH_DMAARBITRATION_TX7_RX1 (ETH_DMAMR_TXPR | ETH_DMAMR_PR_7_1)
  981. #define ETH_DMAARBITRATION_TX8_RX1 (ETH_DMAMR_TXPR | ETH_DMAMR_PR_8_1)
  982. /**
  983. * @}
  984. */
  985. /** @defgroup ETH_Burst_Mode ETH Burst Mode
  986. * @{
  987. */
  988. #define ETH_BURSTLENGTH_FIXED ETH_DMASBMR_FB
  989. #define ETH_BURSTLENGTH_MIXED ETH_DMASBMR_MB
  990. #define ETH_BURSTLENGTH_UNSPECIFIED ((uint32_t)0x00000000U)
  991. /**
  992. * @}
  993. */
  994. /** @defgroup ETH_Tx_DMA_Burst_Length ETH Tx DMA Burst Length
  995. * @{
  996. */
  997. #define ETH_TXDMABURSTLENGTH_1BEAT ETH_DMACTCR_TPBL_1PBL
  998. #define ETH_TXDMABURSTLENGTH_2BEAT ETH_DMACTCR_TPBL_2PBL
  999. #define ETH_TXDMABURSTLENGTH_4BEAT ETH_DMACTCR_TPBL_4PBL
  1000. #define ETH_TXDMABURSTLENGTH_8BEAT ETH_DMACTCR_TPBL_8PBL
  1001. #define ETH_TXDMABURSTLENGTH_16BEAT ETH_DMACTCR_TPBL_16PBL
  1002. #define ETH_TXDMABURSTLENGTH_32BEAT ETH_DMACTCR_TPBL_32PBL
  1003. /**
  1004. * @}
  1005. */
  1006. /** @defgroup ETH_Rx_DMA_Burst_Length ETH Rx DMA Burst Length
  1007. * @{
  1008. */
  1009. #define ETH_RXDMABURSTLENGTH_1BEAT ETH_DMACRCR_RPBL_1PBL
  1010. #define ETH_RXDMABURSTLENGTH_2BEAT ETH_DMACRCR_RPBL_2PBL
  1011. #define ETH_RXDMABURSTLENGTH_4BEAT ETH_DMACRCR_RPBL_4PBL
  1012. #define ETH_RXDMABURSTLENGTH_8BEAT ETH_DMACRCR_RPBL_8PBL
  1013. #define ETH_RXDMABURSTLENGTH_16BEAT ETH_DMACRCR_RPBL_16PBL
  1014. #define ETH_RXDMABURSTLENGTH_32BEAT ETH_DMACRCR_RPBL_32PBL
  1015. /**
  1016. * @}
  1017. */
  1018. /** @defgroup ETH_DMA_Interrupts ETH DMA Interrupts
  1019. * @{
  1020. */
  1021. #define ETH_DMA_NORMAL_IT ETH_DMACIER_NIE
  1022. #define ETH_DMA_ABNORMAL_IT ETH_DMACIER_AIE
  1023. #define ETH_DMA_CONTEXT_DESC_ERROR_IT ETH_DMACIER_CDEE
  1024. #define ETH_DMA_FATAL_BUS_ERROR_IT ETH_DMACIER_FBEE
  1025. #define ETH_DMA_EARLY_RX_IT ETH_DMACIER_ERIE
  1026. #define ETH_DMA_EARLY_TX_IT ETH_DMACIER_ETIE
  1027. #define ETH_DMA_RX_WATCHDOG_TIMEOUT_IT ETH_DMACIER_RWTE
  1028. #define ETH_DMA_RX_PROCESS_STOPPED_IT ETH_DMACIER_RSE
  1029. #define ETH_DMA_RX_BUFFER_UNAVAILABLE_IT ETH_DMACIER_RBUE
  1030. #define ETH_DMA_RX_IT ETH_DMACIER_RIE
  1031. #define ETH_DMA_TX_BUFFER_UNAVAILABLE_IT ETH_DMACIER_TBUE
  1032. #define ETH_DMA_TX_PROCESS_STOPPED_IT ETH_DMACIER_TXSE
  1033. #define ETH_DMA_TX_IT ETH_DMACIER_TIE
  1034. /**
  1035. * @}
  1036. */
  1037. /** @defgroup ETH_DMA_Status_Flags ETH DMA Status Flags
  1038. * @{
  1039. */
  1040. #define ETH_DMA_RX_NO_ERROR_FLAG ((uint32_t)0x00000000U)
  1041. #define ETH_DMA_RX_DESC_READ_ERROR_FLAG (ETH_DMACSR_REB_BIT_2 | ETH_DMACSR_REB_BIT_1 | ETH_DMACSR_REB_BIT_0)
  1042. #define ETH_DMA_RX_DESC_WRITE_ERROR_FLAG (ETH_DMACSR_REB_BIT_2 | ETH_DMACSR_REB_BIT_1)
  1043. #define ETH_DMA_RX_BUFFER_READ_ERROR_FLAG (ETH_DMACSR_REB_BIT_2 | ETH_DMACSR_REB_BIT_0)
  1044. #define ETH_DMA_RX_BUFFER_WRITE_ERROR_FLAG ETH_DMACSR_REB_BIT_2
  1045. #define ETH_DMA_TX_NO_ERROR_FLAG ((uint32_t)0x00000000U)
  1046. #define ETH_DMA_TX_DESC_READ_ERROR_FLAG (ETH_DMACSR_TEB_BIT_2 | ETH_DMACSR_TEB_BIT_1 | ETH_DMACSR_TEB_BIT_0)
  1047. #define ETH_DMA_TX_DESC_WRITE_ERROR_FLAG (ETH_DMACSR_TEB_BIT_2 | ETH_DMACSR_TEB_BIT_1)
  1048. #define ETH_DMA_TX_BUFFER_READ_ERROR_FLAG (ETH_DMACSR_TEB_BIT_2 | ETH_DMACSR_TEB_BIT_0)
  1049. #define ETH_DMA_TX_BUFFER_WRITE_ERROR_FLAG ETH_DMACSR_TEB_BIT_2
  1050. #define ETH_DMA_CONTEXT_DESC_ERROR_FLAG ETH_DMACSR_CDE
  1051. #define ETH_DMA_FATAL_BUS_ERROR_FLAG ETH_DMACSR_FBE
  1052. #define ETH_DMA_EARLY_TX_IT_FLAG ETH_DMACSR_ERI
  1053. #define ETH_DMA_RX_WATCHDOG_TIMEOUT_FLAG ETH_DMACSR_RWT
  1054. #define ETH_DMA_RX_PROCESS_STOPPED_FLAG ETH_DMACSR_RPS
  1055. #define ETH_DMA_RX_BUFFER_UNAVAILABLE_FLAG ETH_DMACSR_RBU
  1056. #define ETH_DMA_TX_PROCESS_STOPPED_FLAG ETH_DMACSR_TPS
  1057. /**
  1058. * @}
  1059. */
  1060. /** @defgroup ETH_Transmit_Mode ETH Transmit Mode
  1061. * @{
  1062. */
  1063. #define ETH_TRANSMITSTOREFORWARD ETH_MTLTQOMR_TSF
  1064. #define ETH_TRANSMITTHRESHOLD_32 ETH_MTLTQOMR_TTC_32BITS
  1065. #define ETH_TRANSMITTHRESHOLD_64 ETH_MTLTQOMR_TTC_64BITS
  1066. #define ETH_TRANSMITTHRESHOLD_96 ETH_MTLTQOMR_TTC_96BITS
  1067. #define ETH_TRANSMITTHRESHOLD_128 ETH_MTLTQOMR_TTC_128BITS
  1068. #define ETH_TRANSMITTHRESHOLD_192 ETH_MTLTQOMR_TTC_192BITS
  1069. #define ETH_TRANSMITTHRESHOLD_256 ETH_MTLTQOMR_TTC_256BITS
  1070. #define ETH_TRANSMITTHRESHOLD_384 ETH_MTLTQOMR_TTC_384BITS
  1071. #define ETH_TRANSMITTHRESHOLD_512 ETH_MTLTQOMR_TTC_512BITS
  1072. /**
  1073. * @}
  1074. */
  1075. /** @defgroup ETH_Receive_Mode ETH Receive Mode
  1076. * @{
  1077. */
  1078. #define ETH_RECEIVESTOREFORWARD ETH_MTLRQOMR_RSF
  1079. #define ETH_RECEIVETHRESHOLD8_64 ETH_MTLRQOMR_RTC_64BITS
  1080. #define ETH_RECEIVETHRESHOLD8_32 ETH_MTLRQOMR_RTC_32BITS
  1081. #define ETH_RECEIVETHRESHOLD8_96 ETH_MTLRQOMR_RTC_96BITS
  1082. #define ETH_RECEIVETHRESHOLD8_128 ETH_MTLRQOMR_RTC_128BITS
  1083. /**
  1084. * @}
  1085. */
  1086. /** @defgroup ETH_Pause_Low_Threshold ETH Pause Low Threshold
  1087. * @{
  1088. */
  1089. #define ETH_PAUSELOWTHRESHOLD_MINUS_4 ETH_MACTFCR_PLT_MINUS4
  1090. #define ETH_PAUSELOWTHRESHOLD_MINUS_28 ETH_MACTFCR_PLT_MINUS28
  1091. #define ETH_PAUSELOWTHRESHOLD_MINUS_36 ETH_MACTFCR_PLT_MINUS36
  1092. #define ETH_PAUSELOWTHRESHOLD_MINUS_144 ETH_MACTFCR_PLT_MINUS144
  1093. #define ETH_PAUSELOWTHRESHOLD_MINUS_256 ETH_MACTFCR_PLT_MINUS256
  1094. #define ETH_PAUSELOWTHRESHOLD_MINUS_512 ETH_MACTFCR_PLT_MINUS512
  1095. /**
  1096. * @}
  1097. */
  1098. /** @defgroup ETH_Watchdog_Timeout ETH Watchdog Timeout
  1099. * @{
  1100. */
  1101. #define ETH_WATCHDOGTIMEOUT_2KB ETH_MACWTR_WTO_2KB
  1102. #define ETH_WATCHDOGTIMEOUT_3KB ETH_MACWTR_WTO_3KB
  1103. #define ETH_WATCHDOGTIMEOUT_4KB ETH_MACWTR_WTO_4KB
  1104. #define ETH_WATCHDOGTIMEOUT_5KB ETH_MACWTR_WTO_5KB
  1105. #define ETH_WATCHDOGTIMEOUT_6KB ETH_MACWTR_WTO_6KB
  1106. #define ETH_WATCHDOGTIMEOUT_7KB ETH_MACWTR_WTO_7KB
  1107. #define ETH_WATCHDOGTIMEOUT_8KB ETH_MACWTR_WTO_8KB
  1108. #define ETH_WATCHDOGTIMEOUT_9KB ETH_MACWTR_WTO_9KB
  1109. #define ETH_WATCHDOGTIMEOUT_10KB ETH_MACWTR_WTO_10KB
  1110. #define ETH_WATCHDOGTIMEOUT_11KB ETH_MACWTR_WTO_12KB
  1111. #define ETH_WATCHDOGTIMEOUT_12KB ETH_MACWTR_WTO_12KB
  1112. #define ETH_WATCHDOGTIMEOUT_13KB ETH_MACWTR_WTO_13KB
  1113. #define ETH_WATCHDOGTIMEOUT_14KB ETH_MACWTR_WTO_14KB
  1114. #define ETH_WATCHDOGTIMEOUT_15KB ETH_MACWTR_WTO_15KB
  1115. #define ETH_WATCHDOGTIMEOUT_16KB ETH_MACWTR_WTO_16KB
  1116. /**
  1117. * @}
  1118. */
  1119. /** @defgroup ETH_Inter_Packet_Gap ETH Inter Packet Gap
  1120. * @{
  1121. */
  1122. #define ETH_INTERPACKETGAP_96BIT ETH_MACCR_IPG_96BIT
  1123. #define ETH_INTERPACKETGAP_88BIT ETH_MACCR_IPG_88BIT
  1124. #define ETH_INTERPACKETGAP_80BIT ETH_MACCR_IPG_80BIT
  1125. #define ETH_INTERPACKETGAP_72BIT ETH_MACCR_IPG_72BIT
  1126. #define ETH_INTERPACKETGAP_64BIT ETH_MACCR_IPG_64BIT
  1127. #define ETH_INTERPACKETGAP_56BIT ETH_MACCR_IPG_56BIT
  1128. #define ETH_INTERPACKETGAP_48BIT ETH_MACCR_IPG_48BIT
  1129. #define ETH_INTERPACKETGAP_40BIT ETH_MACCR_IPG_40BIT
  1130. /**
  1131. * @}
  1132. */
  1133. /** @defgroup ETH_Speed ETH Speed
  1134. * @{
  1135. */
  1136. #define ETH_SPEED_10M ((uint32_t)0x00000000U)
  1137. #define ETH_SPEED_100M ETH_MACCR_FES
  1138. /**
  1139. * @}
  1140. */
  1141. /** @defgroup ETH_Duplex_Mode ETH Duplex Mode
  1142. * @{
  1143. */
  1144. #define ETH_FULLDUPLEX_MODE ETH_MACCR_DM
  1145. #define ETH_HALFDUPLEX_MODE ((uint32_t)0x00000000U)
  1146. /**
  1147. * @}
  1148. */
  1149. /** @defgroup ETH_Back_Off_Limit ETH Back Off Limit
  1150. * @{
  1151. */
  1152. #define ETH_BACKOFFLIMIT_10 ETH_MACCR_BL_10
  1153. #define ETH_BACKOFFLIMIT_8 ETH_MACCR_BL_8
  1154. #define ETH_BACKOFFLIMIT_4 ETH_MACCR_BL_4
  1155. #define ETH_BACKOFFLIMIT_1 ETH_MACCR_BL_1
  1156. /**
  1157. * @}
  1158. */
  1159. /** @defgroup ETH_Preamble_Length ETH Preamble Length
  1160. * @{
  1161. */
  1162. #define ETH_PREAMBLELENGTH_7 ETH_MACCR_PRELEN_7
  1163. #define ETH_PREAMBLELENGTH_5 ETH_MACCR_PRELEN_5
  1164. #define ETH_PREAMBLELENGTH_3 ETH_MACCR_PRELEN_3
  1165. /**
  1166. * @}
  1167. */
  1168. /** @defgroup ETH_Source_Addr_Control ETH Source Addr Control
  1169. * @{
  1170. */
  1171. #define ETH_SOURCEADDRESS_DISABLE ((uint32_t)0x00000000U)
  1172. #define ETH_SOURCEADDRESS_INSERT_ADDR0 ETH_MACCR_SARC_INSADDR0
  1173. #define ETH_SOURCEADDRESS_INSERT_ADDR1 ETH_MACCR_SARC_INSADDR1
  1174. #define ETH_SOURCEADDRESS_REPLACE_ADDR0 ETH_MACCR_SARC_REPADDR0
  1175. #define ETH_SOURCEADDRESS_REPLACE_ADDR1 ETH_MACCR_SARC_REPADDR1
  1176. /**
  1177. * @}
  1178. */
  1179. /** @defgroup ETH_Control_Packets_Filter ETH Control Packets Filter
  1180. * @{
  1181. */
  1182. #define ETH_CTRLPACKETS_BLOCK_ALL ETH_MACPFR_PCF_BLOCKALL
  1183. #define ETH_CTRLPACKETS_FORWARD_ALL_EXCEPT_PA ETH_MACPFR_PCF_FORWARDALLEXCEPTPA
  1184. #define ETH_CTRLPACKETS_FORWARD_ALL ETH_MACPFR_PCF_FORWARDALL
  1185. #define ETH_CTRLPACKETS_FORWARD_PASSED_ADDR_FILTER ETH_MACPFR_PCF_FORWARDPASSEDADDRFILTER
  1186. /**
  1187. * @}
  1188. */
  1189. /** @defgroup ETH_VLAN_Tag_Comparison ETH VLAN Tag Comparison
  1190. * @{
  1191. */
  1192. #define ETH_VLANTAGCOMPARISON_16BIT ((uint32_t)0x00000000U)
  1193. #define ETH_VLANTAGCOMPARISON_12BIT ETH_MACVTR_ETV
  1194. /**
  1195. * @}
  1196. */
  1197. /** @defgroup ETH_MAC_addresses ETH MAC addresses
  1198. * @{
  1199. */
  1200. #define ETH_MAC_ADDRESS0 ((uint32_t)0x00000000U)
  1201. #define ETH_MAC_ADDRESS1 ((uint32_t)0x00000008U)
  1202. #define ETH_MAC_ADDRESS2 ((uint32_t)0x00000010U)
  1203. #define ETH_MAC_ADDRESS3 ((uint32_t)0x00000018U)
  1204. /**
  1205. * @}
  1206. */
  1207. /** @defgroup ETH_MAC_Interrupts ETH MAC Interrupts
  1208. * @{
  1209. */
  1210. #define ETH_MAC_RX_STATUS_IT ETH_MACIER_RXSTSIE
  1211. #define ETH_MAC_TX_STATUS_IT ETH_MACIER_TXSTSIE
  1212. #define ETH_MAC_TIMESTAMP_IT ETH_MACIER_TSIE
  1213. #define ETH_MAC_LPI_IT ETH_MACIER_LPIIE
  1214. #define ETH_MAC_PMT_IT ETH_MACIER_PMTIE
  1215. #define ETH_MAC_PHY_IT ETH_MACIER_PHYIE
  1216. /**
  1217. * @}
  1218. */
  1219. /** @defgroup ETH_MAC_Wake_Up_Event ETH MAC Wake Up Event
  1220. * @{
  1221. */
  1222. #define ETH_WAKEUP_PACKET_RECIEVED ETH_MACPCSR_RWKPRCVD
  1223. #define ETH_MAGIC_PACKET_RECIEVED ETH_MACPCSR_MGKPRCVD
  1224. /**
  1225. * @}
  1226. */
  1227. /** @defgroup ETH_MAC_Rx_Tx_Status ETH MAC Rx Tx Status
  1228. * @{
  1229. */
  1230. #define ETH_RECEIVE_WATCHDOG_TIMEOUT ETH_MACRXTXSR_RWT
  1231. #define ETH_EXECESSIVE_COLLISIONS ETH_MACRXTXSR_EXCOL
  1232. #define ETH_LATE_COLLISIONS ETH_MACRXTXSR_LCOL
  1233. #define ETH_EXECESSIVE_DEFERRAL ETH_MACRXTXSR_EXDEF
  1234. #define ETH_LOSS_OF_CARRIER ETH_MACRXTXSR_LCARR
  1235. #define ETH_NO_CARRIER ETH_MACRXTXSR_NCARR
  1236. #define ETH_TRANSMIT_JABBR_TIMEOUT ETH_MACRXTXSR_TJT
  1237. /**
  1238. * @}
  1239. */
  1240. /** @defgroup HAL_ETH_StateTypeDef ETH States
  1241. * @{
  1242. */
  1243. #define HAL_ETH_STATE_RESET ((uint32_t)0x00000000U) /*!< Peripheral not yet Initialized or disabled */
  1244. #define HAL_ETH_STATE_READY ((uint32_t)0x00000010U) /*!< Peripheral Communication started */
  1245. #define HAL_ETH_STATE_BUSY ((uint32_t)0x00000023U) /*!< an internal process is ongoing */
  1246. #define HAL_ETH_STATE_STARTED ((uint32_t)0x00000023U) /*!< an internal process is started */
  1247. #define HAL_ETH_STATE_ERROR ((uint32_t)0x000000E0U) /*!< Error State */
  1248. /**
  1249. * @}
  1250. */
  1251. /** @defgroup ETH_PTP_Config_Status ETH PTP Config Status
  1252. * @{
  1253. */
  1254. #define HAL_ETH_PTP_NOT_CONFIGURATED ((uint32_t)0x00000000U) /*!< ETH PTP Configuration not done */
  1255. #define HAL_ETH_PTP_CONFIGURATED ((uint32_t)0x00000001U) /*!< ETH PTP Configuration done */
  1256. /**
  1257. * @}
  1258. */
  1259. /**
  1260. * @}
  1261. */
  1262. /* Exported macro ------------------------------------------------------------*/
  1263. /** @defgroup ETH_Exported_Macros ETH Exported Macros
  1264. * @{
  1265. */
  1266. /** @brief Reset ETH handle state
  1267. * @param __HANDLE__: specifies the ETH handle.
  1268. * @retval None
  1269. */
  1270. #if (USE_HAL_ETH_REGISTER_CALLBACKS == 1)
  1271. #define __HAL_ETH_RESET_HANDLE_STATE(__HANDLE__) do{ \
  1272. (__HANDLE__)->gState = HAL_ETH_STATE_RESET; \
  1273. (__HANDLE__)->MspInitCallback = NULL; \
  1274. (__HANDLE__)->MspDeInitCallback = NULL; \
  1275. } while(0)
  1276. #else
  1277. #define __HAL_ETH_RESET_HANDLE_STATE(__HANDLE__) do{ \
  1278. (__HANDLE__)->gState = HAL_ETH_STATE_RESET; \
  1279. } while(0)
  1280. #endif /*USE_HAL_ETH_REGISTER_CALLBACKS */
  1281. /**
  1282. * @brief Enables the specified ETHERNET DMA interrupts.
  1283. * @param __HANDLE__ : ETH Handle
  1284. * @param __INTERRUPT__: specifies the ETHERNET DMA interrupt sources to be
  1285. * enabled @ref ETH_DMA_Interrupts
  1286. * @retval None
  1287. */
  1288. #define __HAL_ETH_DMA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->DMACIER |= (__INTERRUPT__))
  1289. /**
  1290. * @brief Disables the specified ETHERNET DMA interrupts.
  1291. * @param __HANDLE__ : ETH Handle
  1292. * @param __INTERRUPT__: specifies the ETHERNET DMA interrupt sources to be
  1293. * disabled. @ref ETH_DMA_Interrupts
  1294. * @retval None
  1295. */
  1296. #define __HAL_ETH_DMA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->DMACIER &= ~(__INTERRUPT__))
  1297. /**
  1298. * @brief Gets the ETHERNET DMA IT source enabled or disabled.
  1299. * @param __HANDLE__ : ETH Handle
  1300. * @param __INTERRUPT__: specifies the interrupt source to get . @ref ETH_DMA_Interrupts
  1301. * @retval The ETH DMA IT Source enabled or disabled
  1302. */
  1303. #define __HAL_ETH_DMA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) \
  1304. (((__HANDLE__)->Instance->DMACIER & (__INTERRUPT__)) == (__INTERRUPT__))
  1305. /**
  1306. * @brief Gets the ETHERNET DMA IT pending bit.
  1307. * @param __HANDLE__ : ETH Handle
  1308. * @param __INTERRUPT__: specifies the interrupt source to get . @ref ETH_DMA_Interrupts
  1309. * @retval The state of ETH DMA IT (SET or RESET)
  1310. */
  1311. #define __HAL_ETH_DMA_GET_IT(__HANDLE__, __INTERRUPT__) \
  1312. (((__HANDLE__)->Instance->DMACSR & (__INTERRUPT__)) == (__INTERRUPT__))
  1313. /**
  1314. * @brief Clears the ETHERNET DMA IT pending bit.
  1315. * @param __HANDLE__ : ETH Handle
  1316. * @param __INTERRUPT__: specifies the interrupt pending bit to clear. @ref ETH_DMA_Interrupts
  1317. * @retval None
  1318. */
  1319. #define __HAL_ETH_DMA_CLEAR_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->DMACSR = (__INTERRUPT__))
  1320. /**
  1321. * @brief Checks whether the specified ETHERNET DMA flag is set or not.
  1322. * @param __HANDLE__: ETH Handle
  1323. * @param __FLAG__: specifies the flag to check. @ref ETH_DMA_Status_Flags
  1324. * @retval The state of ETH DMA FLAG (SET or RESET).
  1325. */
  1326. #define __HAL_ETH_DMA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->DMACSR &( __FLAG__)) == ( __FLAG__))
  1327. /**
  1328. * @brief Clears the specified ETHERNET DMA flag.
  1329. * @param __HANDLE__: ETH Handle
  1330. * @param __FLAG__: specifies the flag to check. @ref ETH_DMA_Status_Flags
  1331. * @retval The state of ETH DMA FLAG (SET or RESET).
  1332. */
  1333. #define __HAL_ETH_DMA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->DMACSR = ( __FLAG__))
  1334. /**
  1335. * @brief Enables the specified ETHERNET MAC interrupts.
  1336. * @param __HANDLE__ : ETH Handle
  1337. * @param __INTERRUPT__: specifies the ETHERNET MAC interrupt sources to be
  1338. * enabled @ref ETH_MAC_Interrupts
  1339. * @retval None
  1340. */
  1341. #define __HAL_ETH_MAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MACIER |= (__INTERRUPT__))
  1342. /**
  1343. * @brief Disables the specified ETHERNET MAC interrupts.
  1344. * @param __HANDLE__ : ETH Handle
  1345. * @param __INTERRUPT__: specifies the ETHERNET MAC interrupt sources to be
  1346. * enabled @ref ETH_MAC_Interrupts
  1347. * @retval None
  1348. */
  1349. #define __HAL_ETH_MAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MACIER &= ~(__INTERRUPT__))
  1350. /**
  1351. * @brief Checks whether the specified ETHERNET MAC flag is set or not.
  1352. * @param __HANDLE__: ETH Handle
  1353. * @param __INTERRUPT__: specifies the flag to check. @ref ETH_MAC_Interrupts
  1354. * @retval The state of ETH MAC IT (SET or RESET).
  1355. */
  1356. #define __HAL_ETH_MAC_GET_IT(__HANDLE__, __INTERRUPT__) \
  1357. (((__HANDLE__)->Instance->MACISR &( __INTERRUPT__)) == ( __INTERRUPT__))
  1358. /*!< External interrupt line 86 Connected to the ETH wakeup EXTI Line */
  1359. #define ETH_WAKEUP_EXTI_LINE ((uint32_t)0x00400000U) /* !< 86 - 64 = 22 */
  1360. /**
  1361. * @brief Enable the ETH WAKEUP Exti Line.
  1362. * @param __EXTI_LINE__: specifies the ETH WAKEUP Exti sources to be enabled.
  1363. * @arg ETH_WAKEUP_EXTI_LINE
  1364. * @retval None.
  1365. */
  1366. #define __HAL_ETH_WAKEUP_EXTI_ENABLE_IT(__EXTI_LINE__) (EXTI_D1->IMR3 |= (__EXTI_LINE__))
  1367. /**
  1368. * @brief checks whether the specified ETH WAKEUP Exti interrupt flag is set or not.
  1369. * @param __EXTI_LINE__: specifies the ETH WAKEUP Exti sources to be cleared.
  1370. * @arg ETH_WAKEUP_EXTI_LINE
  1371. * @retval EXTI ETH WAKEUP Line Status.
  1372. */
  1373. #define __HAL_ETH_WAKEUP_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI_D1->PR3 & (__EXTI_LINE__))
  1374. /**
  1375. * @brief Clear the ETH WAKEUP Exti flag.
  1376. * @param __EXTI_LINE__: specifies the ETH WAKEUP Exti sources to be cleared.
  1377. * @arg ETH_WAKEUP_EXTI_LINE
  1378. * @retval None.
  1379. */
  1380. #define __HAL_ETH_WAKEUP_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI_D1->PR3 = (__EXTI_LINE__))
  1381. #if defined(DUAL_CORE)
  1382. /**
  1383. * @brief Enable the ETH WAKEUP Exti Line by Core2.
  1384. * @param __EXTI_LINE__: specifies the ETH WAKEUP Exti sources to be enabled.
  1385. * @arg ETH_WAKEUP_EXTI_LINE
  1386. * @retval None.
  1387. */
  1388. #define __HAL_ETH_WAKEUP_EXTID2_ENABLE_IT(__EXTI_LINE__) (EXTI_D2->IMR3 |= (__EXTI_LINE__))
  1389. /**
  1390. * @brief checks whether the specified ETH WAKEUP Exti interrupt flag is set or not.
  1391. * @param __EXTI_LINE__: specifies the ETH WAKEUP Exti sources to be cleared.
  1392. * @arg ETH_WAKEUP_EXTI_LINE
  1393. * @retval EXTI ETH WAKEUP Line Status.
  1394. */
  1395. #define __HAL_ETH_WAKEUP_EXTID2_GET_FLAG(__EXTI_LINE__) (EXTI_D2->PR3 & (__EXTI_LINE__))
  1396. /**
  1397. * @brief Clear the ETH WAKEUP Exti flag.
  1398. * @param __EXTI_LINE__: specifies the ETH WAKEUP Exti sources to be cleared.
  1399. * @arg ETH_WAKEUP_EXTI_LINE
  1400. * @retval None.
  1401. */
  1402. #define __HAL_ETH_WAKEUP_EXTID2_CLEAR_FLAG(__EXTI_LINE__) (EXTI_D2->PR3 = (__EXTI_LINE__))
  1403. #endif /* DUAL_CORE */
  1404. /**
  1405. * @brief enable rising edge interrupt on selected EXTI line.
  1406. * @param __EXTI_LINE__: specifies the ETH WAKEUP EXTI sources to be disabled.
  1407. * @arg ETH_WAKEUP_EXTI_LINE
  1408. * @retval None
  1409. */
  1410. #define __HAL_ETH_WAKEUP_EXTI_ENABLE_RISING_EDGE(__EXTI_LINE__) (EXTI->FTSR3 &= ~(__EXTI_LINE__)); \
  1411. (EXTI->RTSR3 |= (__EXTI_LINE__))
  1412. /**
  1413. * @brief enable falling edge interrupt on selected EXTI line.
  1414. * @param __EXTI_LINE__: specifies the ETH WAKEUP EXTI sources to be disabled.
  1415. * @arg ETH_WAKEUP_EXTI_LINE
  1416. * @retval None
  1417. */
  1418. #define __HAL_ETH_WAKEUP_EXTI_ENABLE_FALLING_EDGE(__EXTI_LINE__) (EXTI->RTSR3 &= ~(__EXTI_LINE__));\
  1419. (EXTI->FTSR3 |= (__EXTI_LINE__))
  1420. /**
  1421. * @brief enable falling edge interrupt on selected EXTI line.
  1422. * @param __EXTI_LINE__: specifies the ETH WAKEUP EXTI sources to be disabled.
  1423. * @arg ETH_WAKEUP_EXTI_LINE
  1424. * @retval None
  1425. */
  1426. #define __HAL_ETH_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE(__EXTI_LINE__) (EXTI->RTSR3 |= (__EXTI_LINE__));\
  1427. (EXTI->FTSR3 |= (__EXTI_LINE__))
  1428. /**
  1429. * @brief Generates a Software interrupt on selected EXTI line.
  1430. * @param __EXTI_LINE__: specifies the ETH WAKEUP EXTI sources to be disabled.
  1431. * @arg ETH_WAKEUP_EXTI_LINE
  1432. * @retval None
  1433. */
  1434. #define __HAL_ETH_WAKEUP_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER3 |= (__EXTI_LINE__))
  1435. #define __HAL_ETH_GET_PTP_CONTROL(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->MACTSCR) & \
  1436. (__FLAG__)) == (__FLAG__)) ? SET : RESET)
  1437. #define __HAL_ETH_SET_PTP_CONTROL(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->MACTSCR |= (__FLAG__))
  1438. /**
  1439. * @}
  1440. */
  1441. /* Include ETH HAL Extension module */
  1442. #include "stm32h7xx_hal_eth_ex.h"
  1443. /* Exported functions --------------------------------------------------------*/
  1444. /** @addtogroup ETH_Exported_Functions
  1445. * @{
  1446. */
  1447. /** @addtogroup ETH_Exported_Functions_Group1
  1448. * @{
  1449. */
  1450. /* Initialization and de initialization functions **********************************/
  1451. HAL_StatusTypeDef HAL_ETH_Init(ETH_HandleTypeDef *heth);
  1452. HAL_StatusTypeDef HAL_ETH_DeInit(ETH_HandleTypeDef *heth);
  1453. void HAL_ETH_MspInit(ETH_HandleTypeDef *heth);
  1454. void HAL_ETH_MspDeInit(ETH_HandleTypeDef *heth);
  1455. /* Callbacks Register/UnRegister functions ***********************************/
  1456. #if (USE_HAL_ETH_REGISTER_CALLBACKS == 1)
  1457. HAL_StatusTypeDef HAL_ETH_RegisterCallback(ETH_HandleTypeDef *heth, HAL_ETH_CallbackIDTypeDef CallbackID,
  1458. pETH_CallbackTypeDef pCallback);
  1459. HAL_StatusTypeDef HAL_ETH_UnRegisterCallback(ETH_HandleTypeDef *heth, HAL_ETH_CallbackIDTypeDef CallbackID);
  1460. #endif /* USE_HAL_ETH_REGISTER_CALLBACKS */
  1461. /**
  1462. * @}
  1463. */
  1464. /** @addtogroup ETH_Exported_Functions_Group2
  1465. * @{
  1466. */
  1467. /* IO operation functions *******************************************************/
  1468. HAL_StatusTypeDef HAL_ETH_Start(ETH_HandleTypeDef *heth);
  1469. HAL_StatusTypeDef HAL_ETH_Start_IT(ETH_HandleTypeDef *heth);
  1470. HAL_StatusTypeDef HAL_ETH_Stop(ETH_HandleTypeDef *heth);
  1471. HAL_StatusTypeDef HAL_ETH_Stop_IT(ETH_HandleTypeDef *heth);
  1472. HAL_StatusTypeDef HAL_ETH_ReadData(ETH_HandleTypeDef *heth, void **pAppBuff);
  1473. HAL_StatusTypeDef HAL_ETH_RegisterRxAllocateCallback(ETH_HandleTypeDef *heth,
  1474. pETH_rxAllocateCallbackTypeDef rxAllocateCallback);
  1475. HAL_StatusTypeDef HAL_ETH_UnRegisterRxAllocateCallback(ETH_HandleTypeDef *heth);
  1476. HAL_StatusTypeDef HAL_ETH_RegisterRxLinkCallback(ETH_HandleTypeDef *heth, pETH_rxLinkCallbackTypeDef rxLinkCallback);
  1477. HAL_StatusTypeDef HAL_ETH_UnRegisterRxLinkCallback(ETH_HandleTypeDef *heth);
  1478. HAL_StatusTypeDef HAL_ETH_GetRxDataErrorCode(ETH_HandleTypeDef *heth, uint32_t *pErrorCode);
  1479. HAL_StatusTypeDef HAL_ETH_RegisterTxFreeCallback(ETH_HandleTypeDef *heth, pETH_txFreeCallbackTypeDef txFreeCallback);
  1480. HAL_StatusTypeDef HAL_ETH_UnRegisterTxFreeCallback(ETH_HandleTypeDef *heth);
  1481. HAL_StatusTypeDef HAL_ETH_ReleaseTxPacket(ETH_HandleTypeDef *heth);
  1482. #ifdef HAL_ETH_USE_PTP
  1483. HAL_StatusTypeDef HAL_ETH_PTP_SetConfig(ETH_HandleTypeDef *heth, ETH_PTP_ConfigTypeDef *ptpconfig);
  1484. HAL_StatusTypeDef HAL_ETH_PTP_GetConfig(ETH_HandleTypeDef *heth, ETH_PTP_ConfigTypeDef *ptpconfig);
  1485. HAL_StatusTypeDef HAL_ETH_PTP_SetTime(ETH_HandleTypeDef *heth, ETH_TimeTypeDef *time);
  1486. HAL_StatusTypeDef HAL_ETH_PTP_GetTime(ETH_HandleTypeDef *heth, ETH_TimeTypeDef *time);
  1487. HAL_StatusTypeDef HAL_ETH_PTP_AddTimeOffset(ETH_HandleTypeDef *heth, ETH_PtpUpdateTypeDef ptpoffsettype,
  1488. ETH_TimeTypeDef *timeoffset);
  1489. HAL_StatusTypeDef HAL_ETH_PTP_InsertTxTimestamp(ETH_HandleTypeDef *heth);
  1490. HAL_StatusTypeDef HAL_ETH_PTP_GetTxTimestamp(ETH_HandleTypeDef *heth, ETH_TimeStampTypeDef *timestamp);
  1491. HAL_StatusTypeDef HAL_ETH_PTP_GetRxTimestamp(ETH_HandleTypeDef *heth, ETH_TimeStampTypeDef *timestamp);
  1492. HAL_StatusTypeDef HAL_ETH_RegisterTxPtpCallback(ETH_HandleTypeDef *heth, pETH_txPtpCallbackTypeDef txPtpCallback);
  1493. HAL_StatusTypeDef HAL_ETH_UnRegisterTxPtpCallback(ETH_HandleTypeDef *heth);
  1494. #endif /* HAL_ETH_USE_PTP */
  1495. HAL_StatusTypeDef HAL_ETH_Transmit(ETH_HandleTypeDef *heth, ETH_TxPacketConfig *pTxConfig, uint32_t Timeout);
  1496. HAL_StatusTypeDef HAL_ETH_Transmit_IT(ETH_HandleTypeDef *heth, ETH_TxPacketConfig *pTxConfig);
  1497. HAL_StatusTypeDef HAL_ETH_WritePHYRegister(ETH_HandleTypeDef *heth, uint32_t PHYAddr, uint32_t PHYReg,
  1498. uint32_t RegValue);
  1499. HAL_StatusTypeDef HAL_ETH_ReadPHYRegister(ETH_HandleTypeDef *heth, uint32_t PHYAddr, uint32_t PHYReg,
  1500. uint32_t *pRegValue);
  1501. void HAL_ETH_IRQHandler(ETH_HandleTypeDef *heth);
  1502. void HAL_ETH_TxCpltCallback(ETH_HandleTypeDef *heth);
  1503. void HAL_ETH_RxCpltCallback(ETH_HandleTypeDef *heth);
  1504. void HAL_ETH_ErrorCallback(ETH_HandleTypeDef *heth);
  1505. void HAL_ETH_PMTCallback(ETH_HandleTypeDef *heth);
  1506. void HAL_ETH_EEECallback(ETH_HandleTypeDef *heth);
  1507. void HAL_ETH_WakeUpCallback(ETH_HandleTypeDef *heth);
  1508. void HAL_ETH_RxAllocateCallback(uint8_t **buff);
  1509. void HAL_ETH_RxLinkCallback(void **pStart, void **pEnd, uint8_t *buff, uint16_t Length);
  1510. void HAL_ETH_TxFreeCallback(uint32_t *buff);
  1511. void HAL_ETH_TxPtpCallback(uint32_t *buff, ETH_TimeStampTypeDef *timestamp);
  1512. /**
  1513. * @}
  1514. */
  1515. /** @addtogroup ETH_Exported_Functions_Group3
  1516. * @{
  1517. */
  1518. /* Peripheral Control functions **********************************************/
  1519. /* MAC & DMA Configuration APIs **********************************************/
  1520. HAL_StatusTypeDef HAL_ETH_GetMACConfig(ETH_HandleTypeDef *heth, ETH_MACConfigTypeDef *macconf);
  1521. HAL_StatusTypeDef HAL_ETH_GetDMAConfig(ETH_HandleTypeDef *heth, ETH_DMAConfigTypeDef *dmaconf);
  1522. HAL_StatusTypeDef HAL_ETH_SetMACConfig(ETH_HandleTypeDef *heth, ETH_MACConfigTypeDef *macconf);
  1523. HAL_StatusTypeDef HAL_ETH_SetDMAConfig(ETH_HandleTypeDef *heth, ETH_DMAConfigTypeDef *dmaconf);
  1524. void HAL_ETH_SetMDIOClockRange(ETH_HandleTypeDef *heth);
  1525. /* MAC VLAN Processing APIs ************************************************/
  1526. void HAL_ETH_SetRxVLANIdentifier(ETH_HandleTypeDef *heth, uint32_t ComparisonBits,
  1527. uint32_t VLANIdentifier);
  1528. /* MAC L2 Packet Filtering APIs **********************************************/
  1529. HAL_StatusTypeDef HAL_ETH_GetMACFilterConfig(ETH_HandleTypeDef *heth, ETH_MACFilterConfigTypeDef *pFilterConfig);
  1530. HAL_StatusTypeDef HAL_ETH_SetMACFilterConfig(ETH_HandleTypeDef *heth, ETH_MACFilterConfigTypeDef *pFilterConfig);
  1531. HAL_StatusTypeDef HAL_ETH_SetHashTable(ETH_HandleTypeDef *heth, uint32_t *pHashTable);
  1532. HAL_StatusTypeDef HAL_ETH_SetSourceMACAddrMatch(ETH_HandleTypeDef *heth, uint32_t AddrNbr, uint8_t *pMACAddr);
  1533. /* MAC Power Down APIs *****************************************************/
  1534. void HAL_ETH_EnterPowerDownMode(ETH_HandleTypeDef *heth, ETH_PowerDownConfigTypeDef *pPowerDownConfig);
  1535. void HAL_ETH_ExitPowerDownMode(ETH_HandleTypeDef *heth);
  1536. HAL_StatusTypeDef HAL_ETH_SetWakeUpFilter(ETH_HandleTypeDef *heth, uint32_t *pFilter, uint32_t Count);
  1537. /**
  1538. * @}
  1539. */
  1540. /** @addtogroup ETH_Exported_Functions_Group4
  1541. * @{
  1542. */
  1543. /* Peripheral State functions **************************************************/
  1544. HAL_ETH_StateTypeDef HAL_ETH_GetState(ETH_HandleTypeDef *heth);
  1545. uint32_t HAL_ETH_GetError(ETH_HandleTypeDef *heth);
  1546. uint32_t HAL_ETH_GetDMAError(ETH_HandleTypeDef *heth);
  1547. uint32_t HAL_ETH_GetMACError(ETH_HandleTypeDef *heth);
  1548. uint32_t HAL_ETH_GetMACWakeUpSource(ETH_HandleTypeDef *heth);
  1549. /**
  1550. * @}
  1551. */
  1552. /**
  1553. * @}
  1554. */
  1555. /**
  1556. * @}
  1557. */
  1558. /**
  1559. * @}
  1560. */
  1561. #endif /* ETH */
  1562. #ifdef __cplusplus
  1563. }
  1564. #endif
  1565. #endif /* STM32H7xx_HAL_ETH_H */