tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_crc.h

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