diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h index 224c8af85f..36c9144932 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup CRC_Exported_Types CRC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -125,10 +126,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup CRC_Exported_Constants CRC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRC_Default_Polynomial_Value Default CRC generating polynomial
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEFAULT_CRC32_POLY 0x04C11DB7U /*!< X^32 + X^26 + X^23 + X^22 + X^16 + X^12 + X^11 + X^10 +X^8 + X^7 + X^5 + X^4 + X^2+ X +1 */
@@ -137,6 +140,7 @@ typedef struct */
/** @defgroup CRC_Default_InitValue Default CRC computation initialization value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEFAULT_CRC_INITVALUE 0xFFFFFFFFU /*!< Initial CRC default value */
@@ -145,6 +149,7 @@ typedef struct */
/** @defgroup CRC_Default_Polynomial Indicates whether or not default polynomial is used
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEFAULT_POLYNOMIAL_ENABLE ((uint8_t)0x00U) /*!< Enable default generating polynomial 0x04C11DB7 */
@@ -154,6 +159,7 @@ typedef struct */
/** @defgroup CRC_Default_InitValue_Use Indicates whether or not default init value is used
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEFAULT_INIT_VALUE_ENABLE ((uint8_t)0x00U) /*!< Enable initial CRC default value */
@@ -163,6 +169,7 @@ typedef struct */
/** @defgroup CRC_Polynomial_Sizes Polynomial sizes to configure the peripheral
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CRC_POLYLENGTH_32B 0x00000000U /*!< Resort to a 32-bit long generating polynomial */
@@ -174,6 +181,7 @@ typedef struct */
/** @defgroup CRC_Polynomial_Size_Definitions CRC polynomial possible sizes actual definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_CRC_LENGTH_32B 32U /*!< 32-bit long CRC */
@@ -185,6 +193,7 @@ typedef struct */
/** @defgroup CRC_Input_Buffer_Format Input Buffer Format
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but
@@ -200,6 +209,7 @@ typedef struct */
/** @defgroup CRC_Aliases CRC API aliases
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_CRC_Input_Data_Reverse HAL_CRCEx_Input_Data_Reverse /*!< Aliased to HAL_CRCEx_Input_Data_Reverse for inter STM32 series compatibility */
@@ -214,6 +224,7 @@ typedef struct /* Exported macros -----------------------------------------------------------*/
/** @defgroup CRC_Exported_Macros CRC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -261,6 +272,7 @@ typedef struct /* Private macros --------------------------------------------------------*/
/** @defgroup CRC_Private_Macros CRC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -288,11 +300,13 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup CRC_Exported_Functions CRC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Initialization and de-initialization functions ****************************/
/** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
@@ -305,6 +319,7 @@ void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc); /* Peripheral Control functions ***********************************************/
/** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
@@ -315,6 +330,7 @@ uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t /* Peripheral State and Error functions ***************************************/
/** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
|