summaryrefslogtreecommitdiff
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h44
1 files changed, 44 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h
index 0a14686930..655066eeaa 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h
@@ -61,6 +61,7 @@ extern "C" {
/*********************** Descriptors struct def section ************************/
/** @defgroup ETH_Exported_Types ETH Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -672,10 +673,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
* @{
*/
@@ -848,6 +851,7 @@ typedef struct
/** @defgroup ETH_DMA_Rx_Descriptor_Bit_Definition ETH DMA Rx Descriptor Bit Definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -1007,6 +1011,7 @@ typedef struct
*/
/** @defgroup ETH_Frame_settings ETH frame settings
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_MAX_PACKET_SIZE 1528U /*!< ETH_HEADER + 2*VLAN_TAG + MAX_ETH_PAYLOAD + ETH_CRC */
@@ -1021,6 +1026,7 @@ typedef struct
*/
/** @defgroup ETH_Error_Code ETH Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_ETH_ERROR_NONE 0x00000000U /*!< No error */
@@ -1037,6 +1043,7 @@ typedef struct
*/
/** @defgroup ETH_Tx_Packet_Attributes ETH Tx Packet Attributes
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_TX_PACKETS_FEATURES_CSUM 0x00000001U
@@ -1050,6 +1057,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
@@ -1060,6 +1068,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
@@ -1071,6 +1080,7 @@ typedef struct
*/
/** @defgroup ETH_Tx_Packet_Checksum_Control ETH Tx Packet Checksum Control
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_CHECKSUM_DISABLE ETH_DMATXNDESCRF_CIC_DISABLE
@@ -1082,6 +1092,7 @@ typedef struct
*/
/** @defgroup ETH_Tx_Packet_VLAN_Control ETH Tx Packet VLAN Control
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_VLAN_DISABLE ETH_DMATXNDESCRF_VTIR_DISABLE
@@ -1093,6 +1104,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
@@ -1104,6 +1116,7 @@ typedef struct
*/
/** @defgroup ETH_Rx_Checksum_Status ETH Rx Checksum Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_CHECKSUM_BYPASSED ETH_DMARXNDESCWBF_IPCB
@@ -1114,6 +1127,7 @@ typedef struct
*/
/** @defgroup ETH_Rx_IP_Header_Type ETH Rx IP Header Type
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_IP_HEADER_IPV4 ETH_DMARXNDESCWBF_IPV4
@@ -1123,6 +1137,7 @@ typedef struct
*/
/** @defgroup ETH_Rx_Payload_Type ETH Rx Payload Type
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_IP_PAYLOAD_UNKNOWN ETH_DMARXNDESCWBF_PT_UNKNOWN
@@ -1134,6 +1149,7 @@ typedef struct
*/
/** @defgroup ETH_Rx_MAC_Filter_Status ETH Rx MAC Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_HASH_FILTER_PASS ETH_DMARXNDESCWBF_HF
@@ -1144,6 +1160,7 @@ typedef struct
* @}
*/
/** @defgroup ETH_Rx_L3_Filter_Status ETH Rx L3 Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_L3_FILTER0_MATCH ETH_DMARXNDESCWBF_L3FM
@@ -1153,6 +1170,7 @@ typedef struct
*/
/** @defgroup ETH_Rx_L4_Filter_Status ETH Rx L4 Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_L4_FILTER0_MATCH ETH_DMARXNDESCWBF_L4FM
@@ -1162,6 +1180,7 @@ typedef struct
*/
/** @defgroup ETH_Rx_Error_Code ETH Rx Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_DRIBBLE_BIT_ERROR ETH_DMARXNDESCWBF_DE
@@ -1175,6 +1194,7 @@ typedef struct
*/
/** @defgroup ETH_DMA_Arbitration ETH DMA Arbitration
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_DMAARBITRATION_RX ETH_DMAMR_DA
@@ -1200,6 +1220,7 @@ typedef struct
*/
/** @defgroup ETH_Burst_Mode ETH Burst Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_BURSTLENGTH_FIXED ETH_DMASBMR_FB
@@ -1210,6 +1231,7 @@ typedef struct
*/
/** @defgroup ETH_Tx_DMA_Burst_Length ETH Tx DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_TXDMABURSTLENGTH_1BEAT ETH_DMACTCR_TPBL_1PBL
@@ -1223,6 +1245,7 @@ typedef struct
*/
/** @defgroup ETH_Rx_DMA_Burst_Length ETH Rx DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_RXDMABURSTLENGTH_1BEAT ETH_DMACRCR_RPBL_1PBL
@@ -1236,6 +1259,7 @@ typedef struct
*/
/** @defgroup ETH_DMA_Interrupts ETH DMA Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_DMA_NORMAL_IT ETH_DMACIER_NIE
@@ -1256,6 +1280,7 @@ typedef struct
*/
/** @defgroup ETH_DMA_Status_Flags ETH DMA Status Flags
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_DMA_RX_NO_ERROR_FLAG 0x00000000U
@@ -1280,6 +1305,7 @@ typedef struct
*/
/** @defgroup ETH_Transmit_Mode ETH Transmit Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_TRANSMITSTOREFORWARD ETH_MTLTQOMR_TSF
@@ -1296,6 +1322,7 @@ typedef struct
*/
/** @defgroup ETH_Receive_Mode ETH Receive Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_RECEIVESTOREFORWARD ETH_MTLRQOMR_RSF
@@ -1308,6 +1335,7 @@ typedef struct
*/
/** @defgroup ETH_Pause_Low_Threshold ETH Pause Low Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_PAUSELOWTHRESHOLD_MINUS_4 ETH_MACTFCR_PLT_MINUS4
@@ -1321,6 +1349,7 @@ typedef struct
*/
/** @defgroup ETH_Watchdog_Timeout ETH Watchdog Timeout
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_WATCHDOGTIMEOUT_2KB ETH_MACWTR_WTO_2KB
@@ -1343,6 +1372,7 @@ typedef struct
*/
/** @defgroup ETH_Inter_Packet_Gap ETH Inter Packet Gap
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_INTERPACKETGAP_96BIT ETH_MACCR_IPG_96BIT
@@ -1358,6 +1388,7 @@ typedef struct
*/
/** @defgroup ETH_Speed ETH Speed
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_SPEED_10M 0x00000000U
@@ -1367,6 +1398,7 @@ typedef struct
*/
/** @defgroup ETH_Duplex_Mode ETH Duplex Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_FULLDUPLEX_MODE ETH_MACCR_DM
@@ -1376,6 +1408,7 @@ typedef struct
*/
/** @defgroup ETH_Back_Off_Limit ETH Back Off Limit
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_BACKOFFLIMIT_10 ETH_MACCR_BL_10
@@ -1387,6 +1420,7 @@ typedef struct
*/
/** @defgroup ETH_Preamble_Length ETH Preamble Length
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_PREAMBLELENGTH_7 ETH_MACCR_PRELEN_7
@@ -1397,6 +1431,7 @@ typedef struct
*/
/** @defgroup ETH_Source_Addr_Control ETH Source Addr Control
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_SOURCEADDRESS_DISABLE 0x00000000U
@@ -1409,6 +1444,7 @@ typedef struct
*/
/** @defgroup ETH_Control_Packets_Filter ETH Control Packets Filter
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_CTRLPACKETS_BLOCK_ALL ETH_MACPFR_PCF_BLOCKALL
@@ -1420,6 +1456,7 @@ typedef struct
*/
/** @defgroup ETH_VLAN_Tag_Comparison ETH VLAN Tag Comparison
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_VLANTAGCOMPARISON_16BIT 0x00000000U
@@ -1429,6 +1466,7 @@ typedef struct
*/
/** @defgroup ETH_MAC_addresses ETH MAC addresses
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_MAC_ADDRESS0 0x00000000U
@@ -1440,6 +1478,7 @@ typedef struct
*/
/** @defgroup ETH_MAC_Interrupts ETH MAC Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_MAC_RX_STATUS_IT ETH_MACIER_RXSTSIE
@@ -1453,6 +1492,7 @@ typedef struct
*/
/** @defgroup ETH_MAC_Wake_Up_Event ETH MAC Wake Up Event
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_WAKEUP_PACKET_RECIEVED ETH_MACPCSR_RWKPRCVD
@@ -1462,6 +1502,7 @@ typedef struct
*/
/** @defgroup ETH_MAC_Rx_Tx_Status ETH MAC Rx Tx Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_RECEIVE_WATCHDOG_TIMEOUT ETH_MACRXTXSR_RWT
@@ -1476,6 +1517,7 @@ typedef struct
*/
/** @defgroup HAL_ETH_StateTypeDef ETH States
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_ETH_STATE_RESET 0x00000000U /*!< Peripheral not yet Initialized or disabled */
@@ -1488,6 +1530,7 @@ typedef struct
*/
/** @defgroup ETH_PTP_Config_Status ETH PTP Config Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_ETH_PTP_NOT_CONFIGURATED 0x00000000U /*!< ETH PTP Configuration not done */
@@ -1501,6 +1544,7 @@ typedef struct
/* Exported macro ------------------------------------------------------------*/
/** @defgroup ETH_Exported_Macros ETH Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/