diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h index bb2bacd68e..092999ef67 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h @@ -48,6 +48,7 @@ /*********************** Descriptors struct def section ************************/
/** @defgroup ETH_Exported_Types ETH Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -536,10 +537,12 @@ typedef struct{ /* Exported constants --------------------------------------------------------*/
/** @defgroup ETH_Exported_Constants ETH Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ETH_DMA_Tx_Descriptor_Bit_Definition ETH DMA Tx Descriptor Bit Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -708,6 +711,7 @@ typedef struct{ /** @defgroup ETH_DMA_Rx_Descriptor_Bit_Definition ETH DMA Rx Descriptor Bit Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -867,6 +871,7 @@ typedef struct{ */
/** @defgroup ETH_Frame_settings ETH frame settings
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_MAX_PACKET_SIZE ((uint32_t)1528U) /*!< ETH_HEADER + 2*VLAN_TAG + MAX_ETH_PAYLOAD + ETH_CRC */
@@ -881,6 +886,7 @@ typedef struct{ */
/** @defgroup ETH_Error_Code ETH Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_ETH_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -897,6 +903,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_Attributes ETH Tx Packet Attributes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_TX_PACKETS_FEATURES_CSUM ((uint32_t)0x00000001U)
@@ -910,6 +917,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_Source_Addr_Control ETH Tx Packet Source Addr Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_SRC_ADDR_CONTROL_DISABLE ETH_DMATXNDESCRF_SAIC_DISABLE
@@ -920,6 +928,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_CRC_Pad_Control ETH Tx Packet CRC Pad Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_CRC_PAD_DISABLE ETH_DMATXNDESCRF_CPC_DISABLE
@@ -931,6 +940,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_Checksum_Control ETH Tx Packet Checksum Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_CHECKSUM_DISABLE ETH_DMATXNDESCRF_CIC_DISABLE
@@ -942,6 +952,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_VLAN_Control ETH Tx Packet VLAN Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_VLAN_DISABLE ETH_DMATXNDESCRF_VTIR_DISABLE
@@ -953,6 +964,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_Inner_VLAN_Control ETH Tx Packet Inner VLAN Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_INNER_VLAN_DISABLE ETH_DMATXCDESC_IVTIR_DISABLE
@@ -964,6 +976,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_Checksum_Status ETH Rx Checksum Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_CHECKSUM_BYPASSED ETH_DMARXNDESCWBF_IPCB
@@ -974,6 +987,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_IP_Header_Type ETH Rx IP Header Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_IP_HEADER_IPV4 ETH_DMARXNDESCWBF_IPV4
@@ -983,6 +997,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_Payload_Type ETH Rx Payload Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_IP_PAYLOAD_UNKNOWN ETH_DMARXNDESCWBF_PT_UNKNOWN
@@ -994,6 +1009,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_MAC_Filter_Status ETH Rx MAC Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_HASH_FILTER_PASS ETH_DMARXNDESCWBF_HF
@@ -1005,6 +1021,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_L3_Filter_Status ETH Rx L3 Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L3_FILTER0_MATCH ETH_DMARXNDESCWBF_L3FM
@@ -1014,6 +1031,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_L4_Filter_Status ETH Rx L4 Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L4_FILTER0_MATCH ETH_DMARXNDESCWBF_L4FM
@@ -1023,6 +1041,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_Error_Code ETH Rx Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_DRIBBLE_BIT_ERROR ETH_DMARXNDESCWBF_DE
@@ -1036,6 +1055,7 @@ typedef struct{ */
/** @defgroup ETH_DMA_Arbitration ETH DMA Arbitration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_DMAARBITRATION_RX ETH_DMAMR_DA
@@ -1061,6 +1081,7 @@ typedef struct{ */
/** @defgroup ETH_Burst_Mode ETH Burst Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_BURSTLENGTH_FIXED ETH_DMASBMR_FB
@@ -1071,6 +1092,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_DMA_Burst_Length ETH Tx DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_TXDMABURSTLENGTH_1BEAT ETH_DMACTCR_TPBL_1PBL
@@ -1084,6 +1106,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_DMA_Burst_Length ETH Rx DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_RXDMABURSTLENGTH_1BEAT ETH_DMACRCR_RPBL_1PBL
@@ -1097,6 +1120,7 @@ typedef struct{ */
/** @defgroup ETH_DMA_Interrupts ETH DMA Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_DMA_NORMAL_IT ETH_DMACIER_NIE
@@ -1117,6 +1141,7 @@ typedef struct{ */
/** @defgroup ETH_DMA_Status_Flags ETH DMA Status Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_DMA_RX_NO_ERROR_FLAG ((uint32_t)0x00000000U)
@@ -1141,6 +1166,7 @@ typedef struct{ */
/** @defgroup ETH_Transmit_Mode ETH Transmit Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_TRANSMITSTOREFORWARD ETH_MTLTQOMR_TSF
@@ -1157,6 +1183,7 @@ typedef struct{ */
/** @defgroup ETH_Receive_Mode ETH Receive Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_RECEIVESTOREFORWARD ETH_MTLRQOMR_RSF
@@ -1169,6 +1196,7 @@ typedef struct{ */
/** @defgroup ETH_Pause_Low_Threshold ETH Pause Low Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_PAUSELOWTHRESHOLD_MINUS_4 ETH_MACTFCR_PLT_MINUS4
@@ -1182,6 +1210,7 @@ typedef struct{ */
/** @defgroup ETH_Watchdog_Timeout ETH Watchdog Timeout
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_WATCHDOGTIMEOUT_2KB ETH_MACWTR_WTO_2KB
@@ -1204,6 +1233,7 @@ typedef struct{ */
/** @defgroup ETH_Inter_Packet_Gap ETH Inter Packet Gap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_INTERPACKETGAP_96BIT ETH_MACCR_IPG_96BIT
@@ -1219,6 +1249,7 @@ typedef struct{ */
/** @defgroup ETH_Speed ETH Speed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_SPEED_10M ((uint32_t)0x00000000U)
@@ -1228,6 +1259,7 @@ typedef struct{ */
/** @defgroup ETH_Duplex_Mode ETH Duplex Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_FULLDUPLEX_MODE ETH_MACCR_DM
@@ -1237,6 +1269,7 @@ typedef struct{ */
/** @defgroup ETH_Back_Off_Limit ETH Back Off Limit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_BACKOFFLIMIT_10 ETH_MACCR_BL_10
@@ -1248,6 +1281,7 @@ typedef struct{ */
/** @defgroup ETH_Preamble_Length ETH Preamble Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_PREAMBLELENGTH_7 ETH_MACCR_PRELEN_7
@@ -1258,6 +1292,7 @@ typedef struct{ */
/** @defgroup ETH_Source_Addr_Control ETH Source Addr Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_SOURCEADDRESS_DISABLE ((uint32_t)0x00000000U)
@@ -1270,6 +1305,7 @@ typedef struct{ */
/** @defgroup ETH_Control_Packets_Filter ETH Control Packets Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_CTRLPACKETS_BLOCK_ALL ETH_MACPFR_PCF_BLOCKALL
@@ -1281,6 +1317,7 @@ typedef struct{ */
/** @defgroup ETH_VLAN_Tag_Comparison ETH VLAN Tag Comparison
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_VLANTAGCOMPARISON_16BIT ((uint32_t)0x00000000U)
@@ -1290,6 +1327,7 @@ typedef struct{ */
/** @defgroup ETH_MAC_addresses ETH MAC addresses
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_MAC_ADDRESS0 ((uint32_t)0x00000000U)
@@ -1301,6 +1339,7 @@ typedef struct{ */
/** @defgroup ETH_MAC_Interrupts ETH MAC Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_MAC_RX_STATUS_IT ETH_MACIER_RXSTSIE
@@ -1314,6 +1353,7 @@ typedef struct{ */
/** @defgroup ETH_MAC_Wake_Up_Event ETH MAC Wake Up Event
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_WAKEUP_PACKET_RECIEVED ETH_MACPCSR_RWKPRCVD
@@ -1323,6 +1363,7 @@ typedef struct{ */
/** @defgroup ETH_MAC_Rx_Tx_Status ETH MAC Rx Tx Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_RECEIVE_WATCHDOG_TIMEOUT ETH_MACRXTXSR_RWT
@@ -1337,6 +1378,7 @@ typedef struct{ */
/** @defgroup HAL_ETH_StateTypeDef ETH States
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_ETH_STATE_RESET ((uint32_t)0x00000000U) /*!< Peripheral not yet Initialized or disabled */
@@ -1354,6 +1396,7 @@ typedef struct{ /* Exported macro ------------------------------------------------------------*/
/** @defgroup ETH_Exported_Macros ETH Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
|