tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F0/stm32f0xx_hal_crc.h

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