diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h index c6fced0281..c06b6c929a 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h @@ -37,6 +37,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/ /** @defgroup UART_Exported_Types UART Exported Types + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -329,10 +330,12 @@ typedef void (*pUART_RxEventCallbackTypeDef) /* Exported constants --------------------------------------------------------*/ /** @defgroup UART_Exported_Constants UART Exported Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup UART_State_Definition UART State Code Definition + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_UART_STATE_RESET 0x00000000U /*!< Peripheral is not initialized @@ -357,6 +360,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Error_Definition UART Error Definition + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_UART_ERROR_NONE (0x00000000U) /*!< No error */ @@ -375,6 +379,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Stop_Bits UART Number of Stop Bits + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< UART frame with 0.5 stop bit */ @@ -386,6 +391,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Parity UART Parity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_PARITY_NONE 0x00000000U /*!< No parity */ @@ -396,6 +402,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_HWCONTROL_NONE 0x00000000U /*!< No hardware control */ @@ -407,6 +414,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Mode UART Transfer Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_MODE_RX USART_CR1_RE /*!< RX mode */ @@ -417,6 +425,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_State UART State + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_STATE_DISABLE 0x00000000U /*!< UART disabled */ @@ -426,6 +435,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Over_Sampling UART Over Sampling + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */ @@ -435,6 +445,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_OneBit_Sampling UART One Bit Sampling Method + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disable */ @@ -444,6 +455,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_ClockPrescaler UART Clock Prescaler + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */ @@ -463,6 +475,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_AutoBaud_Rate_Mode UART Advanced Feature AutoBaud Rate Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT 0x00000000U /*!< Auto Baud rate detection @@ -478,6 +491,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Receiver_Timeout UART Receiver Timeout + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_RECEIVER_TIMEOUT_DISABLE 0x00000000U /*!< UART Receiver Timeout disable */ @@ -487,6 +501,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_LIN UART Local Interconnection Network mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_LIN_DISABLE 0x00000000U /*!< Local Interconnect Network disable */ @@ -496,6 +511,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_LIN_Break_Detection UART LIN Break Detection + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_LINBREAKDETECTLENGTH_10B 0x00000000U /*!< LIN 10-bit break detection length */ @@ -505,6 +521,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_DMA_Tx UART DMA Tx + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_DMA_TX_DISABLE 0x00000000U /*!< UART DMA TX disabled */ @@ -514,6 +531,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_DMA_Rx UART DMA Rx + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_DMA_RX_DISABLE 0x00000000U /*!< UART DMA RX disabled */ @@ -523,6 +541,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Half_Duplex_Selection UART Half Duplex Selection + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_HALF_DUPLEX_DISABLE 0x00000000U /*!< UART half-duplex disabled */ @@ -532,6 +551,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_WakeUp_Methods UART WakeUp Methods + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_WAKEUPMETHOD_IDLELINE 0x00000000U /*!< UART wake-up on idle line */ @@ -541,6 +561,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Request_Parameters UART Request Parameters + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */ @@ -553,6 +574,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Advanced_Features_Initialization_Type UART Advanced Feature Initialization Type + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */ @@ -569,6 +591,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Tx_Inv UART Advanced Feature TX Pin Active Level Inversion + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */ @@ -578,6 +601,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Rx_Inv UART Advanced Feature RX Pin Active Level Inversion + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */ @@ -587,6 +611,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Data_Inv UART Advanced Feature Binary Data Inversion + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */ @@ -596,6 +621,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Rx_Tx_Swap UART Advanced Feature RX TX Pins Swap + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */ @@ -605,6 +631,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Overrun_Disable UART Advanced Feature Overrun Disable + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */ @@ -614,6 +641,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_AutoBaudRate_Enable UART Advanced Feature Auto BaudRate Enable + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE 0x00000000U /*!< RX Auto Baud rate detection enable */ @@ -623,6 +651,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_DMA_Disable_on_Rx_Error UART Advanced Feature DMA Disable On Rx Error + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */ @@ -632,6 +661,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_MSB_First UART Advanced Feature MSB First + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received @@ -643,6 +673,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Stop_Mode_Enable UART Advanced Feature Stop Mode Enable + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_STOPMODE_DISABLE 0x00000000U /*!< UART stop mode disable */ @@ -652,6 +683,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Mute_Mode UART Advanced Feature Mute Mode Enable + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_ADVFEATURE_MUTEMODE_DISABLE 0x00000000U /*!< UART mute mode disable */ @@ -661,6 +693,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_CR2_ADDRESS_LSB_POS UART Address-matching LSB Position In CR2 Register + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_CR2_ADDRESS_LSB_POS 24U /*!< UART address-matching LSB position in CR2 register */ @@ -669,6 +702,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_WakeUp_from_Stop_Selection UART WakeUp From Stop Selection + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_WAKEUP_ON_ADDRESS 0x00000000U /*!< UART wake-up on address */ @@ -680,6 +714,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_DriverEnable_Polarity UART DriverEnable Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_DE_POLARITY_HIGH 0x00000000U /*!< Driver enable signal is active high */ @@ -689,6 +724,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_CR1_DEAT_ADDRESS_LSB_POS UART Driver Enable Assertion Time LSB Position In CR1 Register + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_CR1_DEAT_ADDRESS_LSB_POS 21U /*!< UART Driver Enable assertion time LSB @@ -698,6 +734,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_CR1_DEDT_ADDRESS_LSB_POS UART Driver Enable DeAssertion Time LSB Position In CR1 Register + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_CR1_DEDT_ADDRESS_LSB_POS 16U /*!< UART Driver Enable de-assertion time LSB @@ -707,6 +744,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Interruption_Mask UART Interruptions Flag Mask + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_IT_MASK 0x001FU /*!< UART interruptions flags mask */ @@ -715,6 +753,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_TimeOut_Value UART polling-based communications time-out value + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_UART_TIMEOUT_VALUE 0x1FFFFFFU /*!< UART polling-based communications time-out value */ @@ -723,6 +762,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Flags UART Status Flags + * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0xXXXX * - 0xXXXX : Flag mask in the ISR register * @{ @@ -759,6 +799,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Interrupt_definition UART Interrupts Definition + * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 000ZZZZZ0XXYYYYYb * - YYYYY : Interrupt source position in the XX register (5bits) * - XX : Interrupt source register (2bits) @@ -803,6 +844,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_IT_CLEAR_Flags UART Interruption Clear Flags + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define UART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */ @@ -822,6 +864,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_Reception_Type_Values UART Reception type values + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_UART_RECEPTION_STANDARD (0x00000000U) /*!< Standard reception */ @@ -833,6 +876,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) */ /** @defgroup UART_RxEvent_Type_Values UART RxEvent type values + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_UART_RXEVENT_TC (0x00000000U) /*!< RxEvent linked to Transfer Complete event */ @@ -848,6 +892,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) /* Exported macros -----------------------------------------------------------*/ /** @defgroup UART_Exported_Macros UART Exported Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -1231,6 +1276,7 @@ typedef void (*pUART_RxEventCallbackTypeDef) /* Private macros --------------------------------------------------------*/ /** @defgroup UART_Private_Macros UART Private Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @brief Get UART clok division factor from clock prescaler value. @@ -1724,6 +1770,7 @@ HAL_StatusTypeDef UART_Start_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pDa /* Private variables -----------------------------------------------------------*/ /** @defgroup UART_Private_variables UART Private variables + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /* Prescaler Table used in BRR computation macros. |