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