summaryrefslogtreecommitdiffstats
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h18
1 files changed, 18 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h
index ffb8f7b328..b97872cb2c 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h
@@ -37,6 +37,7 @@ extern "C" {
/* Exported types ------------------------------------------------------------*/
/** @defgroup USART_Exported_Types USART Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -215,10 +216,12 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
/* Exported constants --------------------------------------------------------*/
/** @defgroup USART_Exported_Constants USART Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup USART_Error_Definition USART Error Definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_USART_ERROR_NONE (0x00000000U) /*!< No error */
@@ -237,6 +240,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Stop_Bits USART Number of Stop Bits
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< USART frame with 0.5 stop bit */
@@ -248,6 +252,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Parity USART Parity
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_PARITY_NONE 0x00000000U /*!< No parity */
@@ -258,6 +263,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Mode USART Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_MODE_RX USART_CR1_RE /*!< RX mode */
@@ -268,6 +274,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Clock USART Clock
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_CLOCK_DISABLE 0x00000000U /*!< USART clock disable */
@@ -277,6 +284,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Clock_Polarity USART Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_POLARITY_LOW 0x00000000U /*!< Driver enable signal is active high */
@@ -286,6 +294,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Clock_Phase USART Clock Phase
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_PHASE_1EDGE 0x00000000U /*!< USART frame phase on first clock transition */
@@ -295,6 +304,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Last_Bit USART Last Bit
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_LASTBIT_DISABLE 0x00000000U /*!< USART frame last data bit clock pulse not output to SCLK pin */
@@ -304,6 +314,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_ClockPrescaler USART Clock Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
@@ -324,6 +335,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Request_Parameters USART Request Parameters
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
@@ -333,6 +345,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Flags USART Flags
+ * @ingroup RTEMSBSPsARMSTM32H7
* Elements values convention: 0xXXXX
* - 0xXXXX : Flag mask in the ISR register
* @{
@@ -361,6 +374,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Interrupt_definition USART Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* Elements values convention: 0000ZZZZ0XXYYYYYb
* - YYYYY : Interrupt source position in the XX register (5bits)
* - XX : Interrupt source register (2bits)
@@ -392,6 +406,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_IT_CLEAR_Flags USART Interruption Clear Flags
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
@@ -408,6 +423,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
*/
/** @defgroup USART_Interruption_Mask USART Interruption Flags Mask
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define USART_IT_MASK 0x001FU /*!< USART interruptions flags mask */
@@ -425,6 +441,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
/* Exported macros -----------------------------------------------------------*/
/** @defgroup USART_Exported_Macros USART Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -688,6 +705,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin
/* Private macros --------------------------------------------------------*/
/** @defgroup USART_Private_Macros USART Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/