lib/main/STM32H7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_crc.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32h7xx_hal_crc.h
   4   * @author  MCD Application Team
   5   * @brief   Header file of CRC HAL module.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  10   * All rights reserved.</center></h2>
  11   *
  12   * This software component is licensed by ST under BSD 3-Clause license,
  13   * the "License"; You may not use this file except in compliance with the
  14   * License. You may obtain a copy of the License at:
  15   *                        opensource.org/licenses/BSD-3-Clause
  16   *
  17   ******************************************************************************
  18   */
  19
  20 /* Define to prevent recursive inclusion -------------------------------------*/
  21 #ifndef STM32H7xx_HAL_CRC_H
  22 #define STM32H7xx_HAL_CRC_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /* Includes ------------------------------------------------------------------*/
  29 #include "stm32h7xx_hal_def.h"
  30
  31 /** @addtogroup STM32H7xx_HAL_Driver
  32   * @{
  33   */
  34
  35 /** @addtogroup CRC
  36   * @{
  37   */
  38
  39 /* Exported types ------------------------------------------------------------*/
  40 /** @defgroup CRC_Exported_Types CRC Exported Types
  41   * @{
  42   */
  43
  44 /**
  45   * @brief  CRC HAL State Structure definition
  46   */
  47 typedef enum
  48 {
  49   HAL_CRC_STATE_RESET     = 0x00U,  /*!< CRC not yet initialized or disabled */
  50   HAL_CRC_STATE_READY     = 0x01U,  /*!< CRC initialized and ready for use   */
  51   HAL_CRC_STATE_BUSY      = 0x02U,  /*!< CRC internal process is ongoing     */
  52   HAL_CRC_STATE_TIMEOUT   = 0x03U,  /*!< CRC timeout state                   */
  53   HAL_CRC_STATE_ERROR     = 0x04U   /*!< CRC error state                     */
  54 } HAL_CRC_StateTypeDef;
  55
  56 /**
  57   * @brief CRC Init Structure definition
  58   */
  59 typedef struct
  60 {
  61   uint8_t DefaultPolynomialUse;       /*!< This parameter is a value of @ref CRC_Default_Polynomial and indicates if default polynomial is used.
  62                                             If set to DEFAULT_POLYNOMIAL_ENABLE, resort to default
  63                                             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.
  64                                             In that case, there is no need to set GeneratingPolynomial field.
  65                                             If otherwise set to DEFAULT_POLYNOMIAL_DISABLE, GeneratingPolynomial and CRCLength fields must be set. */
  66
  67   uint8_t DefaultInitValueUse;        /*!< This parameter is a value of @ref CRC_Default_InitValue_Use and indicates if default init value is used.
  68                                            If set to DEFAULT_INIT_VALUE_ENABLE, resort to default
  69                                            0xFFFFFFFF value. In that case, there is no need to set InitValue field.
  70                                            If otherwise set to DEFAULT_INIT_VALUE_DISABLE,  InitValue field must be set. */
  71
  72   uint32_t GeneratingPolynomial;      /*!< Set CRC generating polynomial as a 7, 8, 16 or 32-bit long value for a polynomial degree
  73                                            respectively equal to 7, 8, 16 or 32. This field is written in normal representation,
  74                                            e.g., for a polynomial of degree 7, X^7 + X^6 + X^5 + X^2 + 1 is written 0x65.
  75                                            No need to specify it if DefaultPolynomialUse is set to DEFAULT_POLYNOMIAL_ENABLE.   */
  76
  77   uint32_t CRCLength;                 /*!< This parameter is a value of @ref CRC_Polynomial_Sizes and indicates CRC length.
  78                                            Value can be either one of
  79                                            @arg @ref CRC_POLYLENGTH_32B                  (32-bit CRC),
  80                                            @arg @ref CRC_POLYLENGTH_16B                  (16-bit CRC),
  81                                            @arg @ref CRC_POLYLENGTH_8B                   (8-bit CRC),
  82                                            @arg @ref CRC_POLYLENGTH_7B                   (7-bit CRC). */
  83
  84   uint32_t InitValue;                 /*!< Init value to initiate CRC computation. No need to specify it if DefaultInitValueUse
  85                                            is set to DEFAULT_INIT_VALUE_ENABLE.   */
  86
  87   uint32_t InputDataInversionMode;    /*!< This parameter is a value of @ref CRCEx_Input_Data_Inversion and specifies input data inversion mode.
  88                                            Can be either one of the following values
  89                                            @arg @ref CRC_INPUTDATA_INVERSION_NONE       no input data inversion
  90                                            @arg @ref CRC_INPUTDATA_INVERSION_BYTE       byte-wise inversion, 0x1A2B3C4D becomes 0x58D43CB2
  91                                            @arg @ref CRC_INPUTDATA_INVERSION_HALFWORD   halfword-wise inversion, 0x1A2B3C4D becomes 0xD458B23C
  92                                            @arg @ref CRC_INPUTDATA_INVERSION_WORD       word-wise inversion, 0x1A2B3C4D becomes 0xB23CD458 */
  93
  94   uint32_t OutputDataInversionMode;   /*!< This parameter is a value of @ref CRCEx_Output_Data_Inversion and specifies output data (i.e. CRC) inversion mode.
  95                                             Can be either
  96                                             @arg @ref CRC_OUTPUTDATA_INVERSION_DISABLE   no CRC inversion,
  97                                             @arg @ref CRC_OUTPUTDATA_INVERSION_ENABLE    CRC 0x11223344 is converted into 0x22CC4488 */
  98 } CRC_InitTypeDef;
  99
 100 /**
 101   * @brief  CRC Handle Structure definition
 102   */
 103 typedef struct
 104 {
 105   CRC_TypeDef                 *Instance;   /*!< Register base address        */
 106
 107   CRC_InitTypeDef             Init;        /*!< CRC configuration parameters */
 108
 109   HAL_LockTypeDef             Lock;        /*!< CRC Locking object           */
 110
 111   __IO HAL_CRC_StateTypeDef   State;       /*!< CRC communication state      */
 112
 113   uint32_t InputDataFormat;                /*!< This parameter is a value of @ref CRC_Input_Buffer_Format and specifies input data format.
 114                                             Can be either
 115                                             @arg @ref CRC_INPUTDATA_FORMAT_BYTES       input data is a stream of bytes (8-bit data)
 116                                             @arg @ref CRC_INPUTDATA_FORMAT_HALFWORDS   input data is a stream of half-words (16-bit data)
 117                                             @arg @ref CRC_INPUTDATA_FORMAT_WORDS       input data is a stream of words (32-bit data)
 118
 119                                            Note that constant CRC_INPUT_FORMAT_UNDEFINED is defined but an initialization error
 120                                            must occur if InputBufferFormat is not one of the three values listed above  */
 121 } CRC_HandleTypeDef;
 122 /**
 123   * @}
 124   */
 125
 126 /* Exported constants --------------------------------------------------------*/
 127 /** @defgroup CRC_Exported_Constants CRC Exported Constants
 128   * @{
 129   */
 130
 131 /** @defgroup CRC_Default_Polynomial_Value    Default CRC generating polynomial
 132   * @{
 133   */
 134 #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 */
 135 /**
 136   * @}
 137   */
 138
 139 /** @defgroup CRC_Default_InitValue    Default CRC computation initialization value
 140   * @{
 141   */
 142 #define DEFAULT_CRC_INITVALUE   0xFFFFFFFFU  /*!< Initial CRC default value */
 143 /**
 144   * @}
 145   */
 146
 147 /** @defgroup CRC_Default_Polynomial    Indicates whether or not default polynomial is used
 148   * @{
 149   */
 150 #define DEFAULT_POLYNOMIAL_ENABLE       ((uint8_t)0x00U)  /*!< Enable default generating polynomial 0x04C11DB7  */
 151 #define DEFAULT_POLYNOMIAL_DISABLE      ((uint8_t)0x01U)  /*!< Disable default generating polynomial 0x04C11DB7 */
 152 /**
 153   * @}
 154   */
 155
 156 /** @defgroup CRC_Default_InitValue_Use    Indicates whether or not default init value is used
 157   * @{
 158   */
 159 #define DEFAULT_INIT_VALUE_ENABLE      ((uint8_t)0x00U) /*!< Enable initial CRC default value  */
 160 #define DEFAULT_INIT_VALUE_DISABLE     ((uint8_t)0x01U) /*!< Disable initial CRC default value */
 161 /**
 162   * @}
 163   */
 164
 165 /** @defgroup CRC_Polynomial_Sizes Polynomial sizes to configure the peripheral
 166   * @{
 167   */
 168 #define CRC_POLYLENGTH_32B                  0x00000000U        /*!< Resort to a 32-bit long generating polynomial */
 169 #define CRC_POLYLENGTH_16B                  CRC_CR_POLYSIZE_0  /*!< Resort to a 16-bit long generating polynomial */
 170 #define CRC_POLYLENGTH_8B                   CRC_CR_POLYSIZE_1  /*!< Resort to a 8-bit long generating polynomial  */
 171 #define CRC_POLYLENGTH_7B                   CRC_CR_POLYSIZE    /*!< Resort to a 7-bit long generating polynomial  */
 172 /**
 173   * @}
 174   */
 175
 176 /** @defgroup CRC_Polynomial_Size_Definitions CRC polynomial possible sizes actual definitions
 177   * @{
 178   */
 179 #define HAL_CRC_LENGTH_32B     32U          /*!< 32-bit long CRC */
 180 #define HAL_CRC_LENGTH_16B     16U          /*!< 16-bit long CRC */
 181 #define HAL_CRC_LENGTH_8B       8U          /*!< 8-bit long CRC  */
 182 #define HAL_CRC_LENGTH_7B       7U          /*!< 7-bit long CRC  */
 183 /**
 184   * @}
 185   */
 186
 187 /** @defgroup CRC_Input_Buffer_Format Input Buffer Format
 188   * @{
 189   */
 190 /* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but
 191  * an error is triggered in HAL_CRC_Init() if InputDataFormat field is set
 192  * to CRC_INPUT_FORMAT_UNDEFINED: the format MUST be defined by the user for
 193  * the CRC APIs to provide a correct result */
 194 #define CRC_INPUTDATA_FORMAT_UNDEFINED             0x00000000U  /*!< Undefined input data format    */
 195 #define CRC_INPUTDATA_FORMAT_BYTES                 0x00000001U  /*!< Input data in byte format      */
 196 #define CRC_INPUTDATA_FORMAT_HALFWORDS             0x00000002U  /*!< Input data in half-word format */
 197 #define CRC_INPUTDATA_FORMAT_WORDS                 0x00000003U  /*!< Input data in word format      */
 198 /**
 199   * @}
 200   */
 201
 202 /** @defgroup CRC_Aliases CRC API aliases
 203   * @{
 204   */
 205 #define HAL_CRC_Input_Data_Reverse   HAL_CRCEx_Input_Data_Reverse    /*!< Aliased to HAL_CRCEx_Input_Data_Reverse for inter STM32 series compatibility  */
 206 #define HAL_CRC_Output_Data_Reverse  HAL_CRCEx_Output_Data_Reverse   /*!< Aliased to HAL_CRCEx_Output_Data_Reverse for inter STM32 series compatibility */
 207 /**
 208   * @}
 209   */
 210
 211 /**
 212   * @}
 213   */
 214
 215 /* Exported macros -----------------------------------------------------------*/
 216 /** @defgroup CRC_Exported_Macros CRC Exported Macros
 217   * @{
 218   */
 219
 220 /** @brief Reset CRC handle state.
 221   * @param  __HANDLE__ CRC handle.
 222   * @retval None
 223   */
 224 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
 225
 226 /**
 227   * @brief  Reset CRC Data Register.
 228   * @param  __HANDLE__ CRC handle
 229   * @retval None
 230   */
 231 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
 232
 233 /**
 234   * @brief  Set CRC INIT non-default value
 235   * @param  __HANDLE__ CRC handle
 236   * @param  __INIT__ 32-bit initial value
 237   * @retval None
 238   */
 239 #define __HAL_CRC_INITIALCRCVALUE_CONFIG(__HANDLE__, __INIT__) ((__HANDLE__)->Instance->INIT = (__INIT__))
 240
 241 /**
 242   * @brief Store data in the Independent Data (ID) register.
 243   * @param __HANDLE__ CRC handle
 244   * @param __VALUE__  Value to be stored in the ID register
 245   * @note  Refer to the Reference Manual to get the authorized __VALUE__ length in bits
 246   * @retval None
 247   */
 248 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, (__VALUE__)))
 249
 250 /**
 251   * @brief Return the data stored in the Independent Data (ID) register.
 252   * @param __HANDLE__ CRC handle
 253   * @note  Refer to the Reference Manual to get the authorized __VALUE__ length in bits
 254   * @retval Value of the ID register
 255   */
 256 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
 257 /**
 258   * @}
 259   */
 260
 261
 262 /* Private macros --------------------------------------------------------*/
 263 /** @defgroup  CRC_Private_Macros CRC Private Macros
 264   * @{
 265   */
 266
 267 #define IS_DEFAULT_POLYNOMIAL(DEFAULT) (((DEFAULT) == DEFAULT_POLYNOMIAL_ENABLE) || \
 268                                         ((DEFAULT) == DEFAULT_POLYNOMIAL_DISABLE))
 269
 270 #define IS_DEFAULT_INIT_VALUE(VALUE)  (((VALUE) == DEFAULT_INIT_VALUE_ENABLE) || \
 271                                        ((VALUE) == DEFAULT_INIT_VALUE_DISABLE))
 272
 273 #define IS_CRC_POL_LENGTH(LENGTH)     (((LENGTH) == CRC_POLYLENGTH_32B) || \
 274                                        ((LENGTH) == CRC_POLYLENGTH_16B) || \
 275                                        ((LENGTH) == CRC_POLYLENGTH_8B)  || \
 276                                        ((LENGTH) == CRC_POLYLENGTH_7B))
 277
 278 #define IS_CRC_INPUTDATA_FORMAT(FORMAT)           (((FORMAT) == CRC_INPUTDATA_FORMAT_BYTES)     || \
 279                                                    ((FORMAT) == CRC_INPUTDATA_FORMAT_HALFWORDS) || \
 280                                                    ((FORMAT) == CRC_INPUTDATA_FORMAT_WORDS))
 281
 282 /**
 283   * @}
 284   */
 285
 286 /* Include CRC HAL Extended module */
 287 #include "stm32h7xx_hal_crc_ex.h"
 288
 289 /* Exported functions --------------------------------------------------------*/
 290 /** @defgroup CRC_Exported_Functions CRC Exported Functions
 291   * @{
 292   */
 293
 294 /* Initialization and de-initialization functions  ****************************/
 295 /** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
 296   * @{
 297   */
 298 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
 299 HAL_StatusTypeDef HAL_CRC_DeInit(CRC_HandleTypeDef *hcrc);
 300 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
 301 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
 302 /**
 303   * @}
 304   */
 305
 306 /* Peripheral Control functions ***********************************************/
 307 /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
 308   * @{
 309   */
 310 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
 311 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
 312 /**
 313   * @}
 314   */
 315
 316 /* Peripheral State and Error functions ***************************************/
 317 /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
 318   * @{
 319   */
 320 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
 321 /**
 322   * @}
 323   */
 324
 325 /**
 326   * @}
 327   */
 328
 329 /**
 330   * @}
 331   */
 332
 333 /**
 334   * @}
 335   */
 336
 337 #ifdef __cplusplus
 338 }
 339 #endif
 340
 341 #endif /* STM32H7xx_HAL_CRC_H */
 342
 343 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/