summaryrefslogtreecommitdiff
path: root/bsps/arm/stm32h7/include/Legacy/stm32h7xx_hal_eth_legacy.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/Legacy/stm32h7xx_hal_eth_legacy.h')
-rw-r--r--bsps/arm/stm32h7/include/Legacy/stm32h7xx_hal_eth_legacy.h43
1 files changed, 43 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/Legacy/stm32h7xx_hal_eth_legacy.h b/bsps/arm/stm32h7/include/Legacy/stm32h7xx_hal_eth_legacy.h
index 878036dd81..6e10c0e71b 100644
--- a/bsps/arm/stm32h7/include/Legacy/stm32h7xx_hal_eth_legacy.h
+++ b/bsps/arm/stm32h7/include/Legacy/stm32h7xx_hal_eth_legacy.h
@@ -49,6 +49,7 @@
/*********************** Descriptors struct def section ************************/
/** @defgroup ETH_Exported_Types ETH Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -542,10 +543,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
* @{
*/
@@ -714,6 +717,7 @@ typedef struct{
/** @defgroup ETH_DMA_Rx_Descriptor_Bit_Definition ETH DMA Rx Descriptor Bit Definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -873,6 +877,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 */
@@ -887,6 +892,7 @@ typedef struct{
*/
/** @defgroup ETH_Error_Code ETH Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_ETH_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -903,6 +909,7 @@ typedef struct{
*/
/** @defgroup ETH_Tx_Packet_Attributes ETH Tx Packet Attributes
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_TX_PACKETS_FEATURES_CSUM ((uint32_t)0x00000001U)
@@ -916,6 +923,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
@@ -926,6 +934,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
@@ -937,6 +946,7 @@ typedef struct{
*/
/** @defgroup ETH_Tx_Packet_Checksum_Control ETH Tx Packet Checksum Control
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_CHECKSUM_DISABLE ETH_DMATXNDESCRF_CIC_DISABLE
@@ -948,6 +958,7 @@ typedef struct{
*/
/** @defgroup ETH_Tx_Packet_VLAN_Control ETH Tx Packet VLAN Control
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_VLAN_DISABLE ETH_DMATXNDESCRF_VTIR_DISABLE
@@ -959,6 +970,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
@@ -970,6 +982,7 @@ typedef struct{
*/
/** @defgroup ETH_Rx_Checksum_Status ETH Rx Checksum Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_CHECKSUM_BYPASSED ETH_DMARXNDESCWBF_IPCB
@@ -980,6 +993,7 @@ typedef struct{
*/
/** @defgroup ETH_Rx_IP_Header_Type ETH Rx IP Header Type
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_IP_HEADER_IPV4 ETH_DMARXNDESCWBF_IPV4
@@ -989,6 +1003,7 @@ typedef struct{
*/
/** @defgroup ETH_Rx_Payload_Type ETH Rx Payload Type
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_IP_PAYLOAD_UNKNOWN ETH_DMARXNDESCWBF_PT_UNKNOWN
@@ -1000,6 +1015,7 @@ typedef struct{
*/
/** @defgroup ETH_Rx_MAC_Filter_Status ETH Rx MAC Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_HASH_FILTER_PASS ETH_DMARXNDESCWBF_HF
@@ -1011,6 +1027,7 @@ typedef struct{
*/
/** @defgroup ETH_Rx_L3_Filter_Status ETH Rx L3 Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_L3_FILTER0_MATCH ETH_DMARXNDESCWBF_L3FM
@@ -1020,6 +1037,7 @@ typedef struct{
*/
/** @defgroup ETH_Rx_L4_Filter_Status ETH Rx L4 Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_L4_FILTER0_MATCH ETH_DMARXNDESCWBF_L4FM
@@ -1029,6 +1047,7 @@ typedef struct{
*/
/** @defgroup ETH_Rx_Error_Code ETH Rx Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_DRIBBLE_BIT_ERROR ETH_DMARXNDESCWBF_DE
@@ -1042,6 +1061,7 @@ typedef struct{
*/
/** @defgroup ETH_DMA_Arbitration ETH DMA Arbitration
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_DMAARBITRATION_RX ETH_DMAMR_DA
@@ -1067,6 +1087,7 @@ typedef struct{
*/
/** @defgroup ETH_Burst_Mode ETH Burst Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_BURSTLENGTH_FIXED ETH_DMASBMR_FB
@@ -1077,6 +1098,7 @@ typedef struct{
*/
/** @defgroup ETH_Tx_DMA_Burst_Length ETH Tx DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_TXDMABURSTLENGTH_1BEAT ETH_DMACTCR_TPBL_1PBL
@@ -1090,6 +1112,7 @@ typedef struct{
*/
/** @defgroup ETH_Rx_DMA_Burst_Length ETH Rx DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_RXDMABURSTLENGTH_1BEAT ETH_DMACRCR_RPBL_1PBL
@@ -1103,6 +1126,7 @@ typedef struct{
*/
/** @defgroup ETH_DMA_Interrupts ETH DMA Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_DMA_NORMAL_IT ETH_DMACIER_NIE
@@ -1123,6 +1147,7 @@ typedef struct{
*/
/** @defgroup ETH_DMA_Status_Flags ETH DMA Status Flags
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_DMA_RX_NO_ERROR_FLAG ((uint32_t)0x00000000U)
@@ -1147,6 +1172,7 @@ typedef struct{
*/
/** @defgroup ETH_Transmit_Mode ETH Transmit Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_TRANSMITSTOREFORWARD ETH_MTLTQOMR_TSF
@@ -1163,6 +1189,7 @@ typedef struct{
*/
/** @defgroup ETH_Receive_Mode ETH Receive Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_RECEIVESTOREFORWARD ETH_MTLRQOMR_RSF
@@ -1175,6 +1202,7 @@ typedef struct{
*/
/** @defgroup ETH_Pause_Low_Threshold ETH Pause Low Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_PAUSELOWTHRESHOLD_MINUS_4 ETH_MACTFCR_PLT_MINUS4
@@ -1188,6 +1216,7 @@ typedef struct{
*/
/** @defgroup ETH_Watchdog_Timeout ETH Watchdog Timeout
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_WATCHDOGTIMEOUT_2KB ETH_MACWTR_WTO_2KB
@@ -1210,6 +1239,7 @@ typedef struct{
*/
/** @defgroup ETH_Inter_Packet_Gap ETH Inter Packet Gap
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_INTERPACKETGAP_96BIT ETH_MACCR_IPG_96BIT
@@ -1225,6 +1255,7 @@ typedef struct{
*/
/** @defgroup ETH_Speed ETH Speed
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_SPEED_10M ((uint32_t)0x00000000U)
@@ -1234,6 +1265,7 @@ typedef struct{
*/
/** @defgroup ETH_Duplex_Mode ETH Duplex Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_FULLDUPLEX_MODE ETH_MACCR_DM
@@ -1243,6 +1275,7 @@ typedef struct{
*/
/** @defgroup ETH_Back_Off_Limit ETH Back Off Limit
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_BACKOFFLIMIT_10 ETH_MACCR_BL_10
@@ -1254,6 +1287,7 @@ typedef struct{
*/
/** @defgroup ETH_Preamble_Length ETH Preamble Length
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_PREAMBLELENGTH_7 ETH_MACCR_PRELEN_7
@@ -1264,6 +1298,7 @@ typedef struct{
*/
/** @defgroup ETH_Source_Addr_Control ETH Source Addr Control
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_SOURCEADDRESS_DISABLE ((uint32_t)0x00000000U)
@@ -1276,6 +1311,7 @@ typedef struct{
*/
/** @defgroup ETH_Control_Packets_Filter ETH Control Packets Filter
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_CTRLPACKETS_BLOCK_ALL ETH_MACPFR_PCF_BLOCKALL
@@ -1287,6 +1323,7 @@ typedef struct{
*/
/** @defgroup ETH_VLAN_Tag_Comparison ETH VLAN Tag Comparison
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_VLANTAGCOMPARISON_16BIT ((uint32_t)0x00000000U)
@@ -1296,6 +1333,7 @@ typedef struct{
*/
/** @defgroup ETH_MAC_addresses ETH MAC addresses
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_MAC_ADDRESS0 ((uint32_t)0x00000000U)
@@ -1307,6 +1345,7 @@ typedef struct{
*/
/** @defgroup ETH_MAC_Interrupts ETH MAC Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_MAC_RX_STATUS_IT ETH_MACIER_RXSTSIE
@@ -1320,6 +1359,7 @@ typedef struct{
*/
/** @defgroup ETH_MAC_Wake_Up_Event ETH MAC Wake Up Event
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_WAKEUP_PACKET_RECIEVED ETH_MACPCSR_RWKPRCVD
@@ -1329,6 +1369,7 @@ typedef struct{
*/
/** @defgroup ETH_MAC_Rx_Tx_Status ETH MAC Rx Tx Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ETH_RECEIVE_WATCHDOG_TIMEOUT ETH_MACRXTXSR_RWT
@@ -1343,6 +1384,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 */
@@ -1360,6 +1402,7 @@ typedef struct{
/* Exported macro ------------------------------------------------------------*/
/** @defgroup ETH_Exported_Macros ETH Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/