diff options
author | Karel Gardas <karel@functional.vision> | 2023-07-21 14:24:09 +0200 |
---|---|---|
committer | Karel Gardas <karel@functional.vision> | 2023-07-31 15:15:10 +0200 |
commit | ba8ac65929f9e82892d44779a3c37d4cfea14ec7 (patch) | |
tree | 0606d24aa7ae7ec806837f2e67c70833ae0c58ee /bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h | |
parent | bsps/stm32h7: workaround compilation issue with libbsd (diff) | |
download | rtems-ba8ac65929f9e82892d44779a3c37d4cfea14ec7.tar.bz2 |
bsp/stm32h7: Add and use BSP Doxygen group
Inspired by:
commit fe58f6ce4bf1ff5e92d64b9fee0cb46b6ac06e64
Author: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Thu Nov 26 08:13:52 2020 +0100
bsp/stm32h7: Add and use BSP Doxygen group
Update #3910.
Diffstat (limited to '')
-rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h index ad9fc4aa22..44320efce1 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h @@ -34,6 +34,7 @@ extern "C" { #if defined (I2C1) || defined (I2C2) || defined (I2C3) || defined (I2C4) || defined (I2C5) /** @defgroup I2C_LL I2C + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -42,6 +43,7 @@ extern "C" { /* Private constants ---------------------------------------------------------*/ /** @defgroup I2C_LL_Private_Constants I2C Private Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @@ -51,6 +53,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/ #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__) /** @defgroup I2C_LL_Private_Macros I2C Private Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @@ -61,6 +64,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/ #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__) /** @defgroup I2C_LL_ES_INIT I2C Exported Init structure + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ typedef struct @@ -116,10 +120,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/ /** @defgroup I2C_LL_Exported_Constants I2C Exported Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup I2C_LL_EC_CLEAR_FLAG Clear Flags Defines + * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_I2C_WriteReg function * @{ */ @@ -137,6 +143,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_GET_FLAG Get Flags Defines + * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_I2C_ReadReg function * @{ */ @@ -160,6 +167,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_IT IT Defines + * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_I2C_ReadReg and LL_I2C_WriteReg functions * @{ */ @@ -175,6 +183,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_PERIPHERAL_MODE Peripheral Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_MODE_I2C 0x00000000U /*!< I2C Master or Slave mode */ @@ -187,6 +196,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_ANALOGFILTER_SELECTION Analog Filter Selection + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_ANALOGFILTER_ENABLE 0x00000000U /*!< Analog filter is enabled. */ @@ -196,6 +206,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_ADDRESSING_MODE Master Addressing Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_ADDRESSING_MODE_7BIT 0x00000000U /*!< Master operates in 7-bit addressing mode. */ @@ -205,6 +216,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_OWNADDRESS1 Own Address 1 Length + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_OWNADDRESS1_7BIT 0x00000000U /*!< Own address 1 is a 7-bit address. */ @@ -214,6 +226,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_OWNADDRESS2 Own Address 2 Masks + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_OWNADDRESS2_NOMASK I2C_OAR2_OA2NOMASK /*!< Own Address2 No mask. */ @@ -230,6 +243,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_I2C_ACKNOWLEDGE Acknowledge Generation + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_ACK 0x00000000U /*!< ACK is sent after current received byte. */ @@ -239,6 +253,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_ADDRSLAVE Slave Address Length + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_ADDRSLAVE_7BIT 0x00000000U /*!< Slave Address in 7-bit. */ @@ -248,6 +263,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_REQUEST Transfer Request Direction + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_REQUEST_WRITE 0x00000000U /*!< Master request a write transfer. */ @@ -257,6 +273,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_MODE Transfer End Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_MODE_RELOAD I2C_CR2_RELOAD /*!< Enable I2C Reload mode. */ @@ -279,6 +296,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_GENERATE Start And Stop Generation + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_GENERATE_NOSTARTSTOP 0x00000000U @@ -303,6 +321,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_DIRECTION Read Write Direction + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_DIRECTION_WRITE 0x00000000U /*!< Write transfer request by master, @@ -314,6 +333,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_DMA_REG_DATA DMA Register Data + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_DMA_REG_DATA_TRANSMIT 0x00000000U /*!< Get address of data register used for @@ -325,6 +345,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_SMBUS_TIMEOUTA_MODE SMBus TimeoutA Mode SCL SDA Timeout + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_SMBUS_TIMEOUTA_MODE_SCL_LOW 0x00000000U /*!< TimeoutA is used to detect @@ -336,6 +357,7 @@ typedef struct */ /** @defgroup I2C_LL_EC_SMBUS_TIMEOUT_SELECTION SMBus Timeout Selection + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define LL_I2C_SMBUS_TIMEOUTA I2C_TIMEOUTR_TIMOUTEN /*!< TimeoutA enable bit */ @@ -354,10 +376,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/ /** @defgroup I2C_LL_Exported_Macros I2C Exported Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup I2C_LL_EM_WRITE_READ Common Write and read registers Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -382,6 +406,7 @@ typedef struct */ /** @defgroup I2C_LL_EM_CONVERT_TIMINGS Convert SDA SCL timings + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @@ -413,10 +438,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/ /** @defgroup I2C_LL_Exported_Functions I2C Exported Functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup I2C_LL_EF_Configuration Configuration + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -1275,6 +1302,7 @@ __STATIC_INLINE uint32_t LL_I2C_IsEnabledSMBusTimeout(const I2C_TypeDef *I2Cx, u */ /** @defgroup I2C_LL_EF_IT_Management IT_Management + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -1538,6 +1566,7 @@ __STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_ERR(const I2C_TypeDef *I2Cx) */ /** @defgroup I2C_LL_EF_FLAG_management FLAG_management + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -1865,6 +1894,7 @@ __STATIC_INLINE void LL_I2C_ClearSMBusFlag_ALERT(I2C_TypeDef *I2Cx) */ /** @defgroup I2C_LL_EF_Data_Management Data_Management + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -2238,6 +2268,7 @@ __STATIC_INLINE void LL_I2C_TransmitData8(I2C_TypeDef *I2Cx, uint8_t Data) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__) /** @defgroup I2C_LL_EF_Init Initialization and de-initialization functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ |