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