lib/main/STM32F3/Drivers/STM32F3xx_HAL_Driver/Inc/stm32f3xx_hal_crc.h

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