lib/main/STM32F7/Drivers/STM32F7xx_HAL_Driver/Inc/stm32f7xx_hal_crc.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f7xx_hal_crc.h
   4   * @author  MCD Application Team
   5   * @version V1.2.2
   6   * @date    14-April-2017
   7   * @brief   Header file of CRC HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F7xx_HAL_CRC_H
  40 #define __STM32F7xx_HAL_CRC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f7xx_hal_def.h"
  48
  49 /** @addtogroup STM32F7xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @defgroup CRC CRC
  54   * @brief CRC HAL module driver
  55   * @{
  56   */
  57
  58 /* Exported types ------------------------------------------------------------*/
  59 /** @defgroup CRC_Exported_Types CRC Exported Types
  60   * @{
  61   */
  62
  63 /** @defgroup CRC_Exported_Types_Group1 CRC State Structure definition
  64   * @{
  65   */
  66 typedef enum
  67 {
  68   HAL_CRC_STATE_RESET     = 0x00U,  /*!< CRC not yet initialized or disabled */
  69   HAL_CRC_STATE_READY     = 0x01U,  /*!< CRC initialized and ready for use   */
  70   HAL_CRC_STATE_BUSY      = 0x02U,  /*!< CRC internal process is ongoing     */
  71   HAL_CRC_STATE_TIMEOUT   = 0x03U,  /*!< CRC timeout state                   */
  72   HAL_CRC_STATE_ERROR     = 0x04U   /*!< CRC error state                     */
  73 }HAL_CRC_StateTypeDef;
  74 /**
  75   * @}
  76   */
  77
  78 /** @defgroup CRC_Exported_Types_Group2 CRC Init Structure definition
  79   * @{
  80   */
  81 typedef struct
  82 {
  83   uint8_t DefaultPolynomialUse;       /*!< This parameter is a value of @ref CRC_Default_Polynomial and indicates if default polynomial is used.
  84                                             If set to DEFAULT_POLYNOMIAL_ENABLE, resort to default
  85                                             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.
  86                                             In that case, there is no need to set GeneratingPolynomial field.
  87                                             If otherwise set to DEFAULT_POLYNOMIAL_DISABLE, GeneratingPolynomial and CRCLength fields must be set */
  88
  89   uint8_t DefaultInitValueUse;        /*!< This parameter is a value of @ref CRC_Default_InitValue_Use and indicates if default init value is used.
  90                                            If set to DEFAULT_INIT_VALUE_ENABLE, resort to default
  91                                            0xFFFFFFFF value. In that case, there is no need to set InitValue field.
  92                                            If otherwise set to DEFAULT_INIT_VALUE_DISABLE,  InitValue field must be set */
  93
  94   uint32_t GeneratingPolynomial;      /*!< Set CRC generating polynomial. 7, 8, 16 or 32-bit long value for a polynomial degree
  95                                            respectively equal to 7, 8, 16 or 32. This field is written in normal representation,
  96                                            e.g., for a polynomial of degree 7, X^7 + X^6 + X^5 + X^2 + 1 is written 0x65.
  97                                            No need to specify it if DefaultPolynomialUse is set to DEFAULT_POLYNOMIAL_ENABLE   */
  98
  99   uint32_t CRCLength;                 /*!< This parameter is a value of @ref CRC_Polynomial_Sizes and indicates CRC length.
 100                                            Value can be either one of
 101                                            CRC_POLYLENGTH_32B                  (32-bit CRC)
 102                                            CRC_POLYLENGTH_16B                  (16-bit CRC)
 103                                            CRC_POLYLENGTH_8B                   (8-bit CRC)
 104                                            CRC_POLYLENGTH_7B                   (7-bit CRC) */
 105
 106   uint32_t InitValue;                 /*!< Init value to initiate CRC computation. No need to specify it if DefaultInitValueUse
 107                                            is set to DEFAULT_INIT_VALUE_ENABLE   */
 108
 109   uint32_t InputDataInversionMode;    /*!< This parameter is a value of @ref CRCEx_Input_Data_Inversion and specifies input data inversion mode.
 110                                            Can be either one of the following values
 111                                            CRC_INPUTDATA_INVERSION_NONE      no input data inversion
 112                                            CRC_INPUTDATA_INVERSION_BYTE      byte-wise inversion, 0x1A2B3C4D becomes 0x58D43CB2
 113                                            CRC_INPUTDATA_INVERSION_HALFWORD  halfword-wise inversion, 0x1A2B3C4D becomes 0xD458B23C
 114                                            CRC_INPUTDATA_INVERSION_WORD      word-wise inversion, 0x1A2B3C4D becomes 0xB23CD458 */
 115
 116   uint32_t OutputDataInversionMode;   /*!< This parameter is a value of @ref CRCEx_Output_Data_Inversion and specifies output data (i.e. CRC) inversion mode.
 117                                             Can be either
 118                                             CRC_OUTPUTDATA_INVERSION_DISABLE   no CRC inversion, or
 119                                             CRC_OUTPUTDATA_INVERSION_ENABLE    CRC 0x11223344 is converted into 0x22CC4488 */
 120 }CRC_InitTypeDef;
 121 /**
 122   * @}
 123   */
 124
 125 /** @defgroup CRC_Exported_Types_Group3 CRC Handle Structure definition
 126   * @{
 127   */
 128 typedef struct
 129 {
 130   CRC_TypeDef                 *Instance;   /*!< Register base address        */
 131
 132   CRC_InitTypeDef             Init;        /*!< CRC configuration parameters */
 133
 134   HAL_LockTypeDef             Lock;        /*!< CRC Locking object           */
 135
 136   __IO HAL_CRC_StateTypeDef   State;       /*!< CRC communication state      */
 137
 138   uint32_t InputDataFormat;                /*!< This parameter is a value of @ref CRC_Input_Buffer_Format and specifies input data format.
 139                                             Can be either
 140                                             CRC_INPUTDATA_FORMAT_BYTES       input data is a stream of bytes (8-bit data)
 141                                             CRC_INPUTDATA_FORMAT_HALFWORDS   input data is a stream of half-words (16-bit data)
 142                                             CRC_INPUTDATA_FORMAT_WORDS       input data is a stream of words (32-bits data)
 143                                            Note that constant CRC_INPUT_FORMAT_UNDEFINED is defined but an initialization error
 144                                            must occur if InputBufferFormat is not one of the three values listed above  */
 145 }CRC_HandleTypeDef;
 146 /**
 147   * @}
 148   */
 149
 150 /**
 151   * @}
 152   */
 153
 154 /* Exported constants --------------------------------------------------------*/
 155 /** @defgroup CRC_Exported_Constants   CRC exported constants
 156   * @{
 157   */
 158
 159 /** @defgroup CRC_Default_Polynomial_Value    Default CRC generating polynomial
 160   * @{
 161   */
 162 #define DEFAULT_CRC32_POLY      0x04C11DB7U
 163
 164 /**
 165   * @}
 166   */
 167
 168 /** @defgroup CRC_Default_InitValue    Default CRC computation initialization value
 169   * @{
 170   */
 171 #define DEFAULT_CRC_INITVALUE   0xFFFFFFFFU
 172
 173 /**
 174   * @}
 175   */
 176
 177 /** @defgroup CRC_Default_Polynomial    Indicates whether or not default polynomial is used
 178   * @{
 179   */
 180 #define DEFAULT_POLYNOMIAL_ENABLE       ((uint8_t)0x00U)
 181 #define DEFAULT_POLYNOMIAL_DISABLE      ((uint8_t)0x01U)
 182
 183
 184 /**
 185   * @}
 186   */
 187
 188 /** @defgroup CRC_Default_InitValue_Use    Indicates whether or not default init value is used
 189   * @{
 190   */
 191 #define DEFAULT_INIT_VALUE_ENABLE      ((uint8_t)0x00U)
 192 #define DEFAULT_INIT_VALUE_DISABLE     ((uint8_t)0x01U)
 193
 194 /**
 195   * @}
 196   */
 197
 198 /** @defgroup CRC_Polynomial_Sizes Polynomial sizes to configure the IP
 199   * @{
 200   */
 201 #define CRC_POLYLENGTH_32B                  ((uint32_t)0x00000000U)
 202 #define CRC_POLYLENGTH_16B                  ((uint32_t)CRC_CR_POLYSIZE_0)
 203 #define CRC_POLYLENGTH_8B                   ((uint32_t)CRC_CR_POLYSIZE_1)
 204 #define CRC_POLYLENGTH_7B                   ((uint32_t)CRC_CR_POLYSIZE)
 205 /**
 206   * @}
 207   */
 208
 209 /** @defgroup CRC_Polynomial_Size_Definitions CRC polynomial possible sizes actual definitions
 210   * @{
 211   */
 212 #define HAL_CRC_LENGTH_32B     32U
 213 #define HAL_CRC_LENGTH_16B     16U
 214 #define HAL_CRC_LENGTH_8B       8U
 215 #define HAL_CRC_LENGTH_7B       7U
 216
 217 /**
 218   * @}
 219   */
 220
 221 /** @defgroup CRC_Input_Buffer_Format CRC input buffer format
 222   * @{
 223   */
 224 /* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but
 225  * an error is triggered in HAL_CRC_Init() if InputDataFormat field is set
 226  * to CRC_INPUT_FORMAT_UNDEFINED: the format MUST be defined by the user for
 227  * the CRC APIs to provide a correct result */
 228 #define CRC_INPUTDATA_FORMAT_UNDEFINED             ((uint32_t)0x00000000U)
 229 #define CRC_INPUTDATA_FORMAT_BYTES                 ((uint32_t)0x00000001U)
 230 #define CRC_INPUTDATA_FORMAT_HALFWORDS             ((uint32_t)0x00000002U)
 231 #define CRC_INPUTDATA_FORMAT_WORDS                 ((uint32_t)0x00000003U)
 232 /**
 233   * @}
 234   */
 235
 236 /**
 237   * @}
 238   */
 239 /* Exported macros -----------------------------------------------------------*/
 240
 241 /** @defgroup CRC_Exported_Macros CRC exported macros
 242   * @{
 243   */
 244
 245 /** @brief Reset CRC handle state
 246   * @param  __HANDLE__: CRC handle.
 247   * @retval None
 248   */
 249 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
 250
 251 /**
 252   * @brief  Reset CRC Data Register.
 253   * @param  __HANDLE__: CRC handle
 254   * @retval None.
 255   */
 256 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
 257
 258 /**
 259   * @brief  Set CRC INIT non-default value
 260   * @param  __HANDLE__    : CRC handle
 261   * @param  __INIT__      : 32-bit initial value
 262   * @retval None.
 263   */
 264 #define __HAL_CRC_INITIALCRCVALUE_CONFIG(__HANDLE__, __INIT__) ((__HANDLE__)->Instance->INIT = (__INIT__))
 265
 266 /**
 267   * @brief Stores a 8-bit data in the Independent Data(ID) register.
 268   * @param __HANDLE__: CRC handle
 269   * @param __VALUE__: 8-bit value to be stored in the ID register
 270   * @retval None
 271   */
 272 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, CRC_IDR_IDR, (__VALUE__)))
 273
 274 /**
 275   * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
 276   * @param __HANDLE__: CRC handle
 277   * @retval 8-bit value of the ID register
 278   */
 279 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
 280 /**
 281   * @}
 282   */
 283
 284 /* Include CRC HAL Extension module */
 285 #include "stm32f7xx_hal_crc_ex.h"
 286
 287 /* Exported functions --------------------------------------------------------*/
 288 /** @defgroup CRC_Exported_Functions CRC Exported Functions
 289   * @{
 290   */
 291
 292 /** @defgroup CRC_Exported_Functions_Group1 Initialization/de-initialization functions
 293   * @{
 294   */
 295 /* Initialization and de-initialization functions  ****************************/
 296 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
 297 HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
 298 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
 299 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
 300 /**
 301   * @}
 302   */
 303
 304 /* Aliases for inter STM32 series compatibility */
 305 #define HAL_CRC_Input_Data_Reverse   HAL_CRCEx_Input_Data_Reverse
 306 #define HAL_CRC_Output_Data_Reverse  HAL_CRCEx_Output_Data_Reverse
 307
 308 /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
 309   * @{
 310   */
 311 /* Peripheral Control functions ***********************************************/
 312 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
 313 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
 314 /**
 315   * @}
 316   */
 317
 318 /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
 319   * @{
 320   */
 321 /* Peripheral State and Error functions ***************************************/
 322 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
 323 /**
 324   * @}
 325   */
 326
 327 /**
 328   * @}
 329   */
 330
 331
 332 /* Private types -------------------------------------------------------------*/
 333 /** @defgroup CRC_Private_Types CRC Private Types
 334   * @{
 335   */
 336
 337 /**
 338   * @}
 339   */
 340
 341 /* Private defines -----------------------------------------------------------*/
 342 /** @defgroup CRC_Private_Defines CRC Private Defines
 343   * @{
 344   */
 345
 346 /**
 347   * @}
 348   */
 349
 350 /* Private variables ---------------------------------------------------------*/
 351 /** @defgroup CRC_Private_Variables CRC Private Variables
 352   * @{
 353   */
 354
 355 /**
 356   * @}
 357   */
 358
 359 /* Private constants ---------------------------------------------------------*/
 360 /** @defgroup CRC_Private_Constants CRC Private Constants
 361   * @{
 362   */
 363
 364 /**
 365   * @}
 366   */
 367
 368 /* Private macros ------------------------------------------------------------*/
 369 /** @defgroup CRC_Private_Macros CRC Private Macros
 370   * @{
 371   */
 372 #define IS_DEFAULT_POLYNOMIAL(__DEFAULT__) (((__DEFAULT__) == DEFAULT_POLYNOMIAL_ENABLE) || \
 373                                             ((__DEFAULT__) == DEFAULT_POLYNOMIAL_DISABLE))
 374 #define IS_DEFAULT_INIT_VALUE(__VALUE__)  (((__VALUE__) == DEFAULT_INIT_VALUE_ENABLE) || \
 375                                            ((__VALUE__) == DEFAULT_INIT_VALUE_DISABLE))
 376 #define IS_CRC_POL_LENGTH(__LENGTH__)     (((__LENGTH__) == CRC_POLYLENGTH_32B) || \
 377                                            ((__LENGTH__) == CRC_POLYLENGTH_16B) || \
 378                                            ((__LENGTH__) == CRC_POLYLENGTH_8B)  || \
 379                                            ((__LENGTH__) == CRC_POLYLENGTH_7B))
 380 #define IS_CRC_INPUTDATA_FORMAT(__FORMAT__)       (((__FORMAT__) == CRC_INPUTDATA_FORMAT_BYTES) || \
 381                                                    ((__FORMAT__) == CRC_INPUTDATA_FORMAT_HALFWORDS) || \
 382                                                    ((__FORMAT__) == CRC_INPUTDATA_FORMAT_WORDS))
 383
 384
 385 /**
 386   * @}
 387   */
 388
 389 /* Private functions prototypes ----------------------------------------------*/
 390 /** @defgroup CRC_Private_Functions_Prototypes CRC Private Functions Prototypes
 391   * @{
 392   */
 393
 394 /**
 395   * @}
 396   */
 397
 398 /* Private functions ---------------------------------------------------------*/
 399 /** @defgroup CRC_Private_Functions CRC Private Functions
 400   * @{
 401   */
 402
 403 /**
 404   * @}
 405   */
 406
 407 /**
 408   * @}
 409   */
 410
 411 /**
 412   * @}
 413   */
 414
 415 #ifdef __cplusplus
 416 }
 417 #endif
 418
 419 #endif /* __STM32F7xx_HAL_CRC_H */
 420
 421 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
 422