1 /** 2 ****************************************************************************** 3 * @file stm32l4xx_hal_crc.h 4 * @author MCD Application Team 5 * @brief Header file of CRC HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * <h2><center>© COPYRIGHT(c) 2017 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 __STM32L4xx_HAL_CRC_H 38 #define __STM32L4xx_HAL_CRC_H 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* Includes ------------------------------------------------------------------*/ 45 #include "stm32l4xx_hal_def.h" 46 47 /** @addtogroup STM32L4xx_HAL_Driver 48 * @{ 49 */ 50 51 /** @addtogroup CRC 52 * @{ 53 */ 54 55 /* Exported types ------------------------------------------------------------*/ 56 /** @defgroup CRC_Exported_Types CRC Exported Types 57 * @{ 58 */ 59 60 /** 61 * @brief CRC HAL State Structure definition 62 */ 63 typedef enum 64 { 65 HAL_CRC_STATE_RESET = 0x00U, /*!< CRC not yet initialized or disabled */ 66 HAL_CRC_STATE_READY = 0x01U, /*!< CRC initialized and ready for use */ 67 HAL_CRC_STATE_BUSY = 0x02U, /*!< CRC internal process is ongoing */ 68 HAL_CRC_STATE_TIMEOUT = 0x03U, /*!< CRC timeout state */ 69 HAL_CRC_STATE_ERROR = 0x04U /*!< CRC error state */ 70 } HAL_CRC_StateTypeDef; 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^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. 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 7, 8, 16 or 32-bit long value for a polynomial degree 89 respectively equal to 7, 8, 16 or 32. This field is written in normal representation, 90 e.g., for a polynomial of degree 7, X^7 + X^6 + X^5 + X^2 + 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 @ref CRC_POLYLENGTH_32B (32-bit CRC), 96 @arg @ref CRC_POLYLENGTH_16B (16-bit CRC), 97 @arg @ref CRC_POLYLENGTH_8B (8-bit CRC), 98 @arg @ref 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 @ref CRC_INPUTDATA_INVERSION_NONE no input data inversion 106 @arg @ref CRC_INPUTDATA_INVERSION_BYTE byte-wise inversion, 0x1A2B3C4D becomes 0x58D43CB2 107 @arg @ref CRC_INPUTDATA_INVERSION_HALFWORD halfword-wise inversion, 0x1A2B3C4D becomes 0xD458B23C 108 @arg @ref CRC_INPUTDATA_INVERSION_WORD word-wise inversion, 0x1A2B3C4D becomes 0xB23CD458 */ 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 @ref CRC_OUTPUTDATA_INVERSION_DISABLE no CRC inversion, 113 @arg @ref CRC_OUTPUTDATA_INVERSION_ENABLE CRC 0x11223344 is converted into 0x22CC4488 */ 114 } CRC_InitTypeDef; 115 116 /** 117 * @brief CRC Handle Structure definition 118 */ 119 typedef struct 120 { 121 CRC_TypeDef *Instance; /*!< Register base address */ 122 123 CRC_InitTypeDef Init; /*!< CRC configuration parameters */ 124 125 HAL_LockTypeDef Lock; /*!< CRC Locking object */ 126 127 __IO HAL_CRC_StateTypeDef State; /*!< CRC communication state */ 128 129 uint32_t InputDataFormat; /*!< This parameter is a value of @ref CRC_Input_Buffer_Format and specifies input data format. 130 Can be either 131 @arg @ref CRC_INPUTDATA_FORMAT_BYTES input data is a stream of bytes (8-bit data) 132 @arg @ref CRC_INPUTDATA_FORMAT_HALFWORDS input data is a stream of half-words (16-bit data) 133 @arg @ref CRC_INPUTDATA_FORMAT_WORDS input data is a stream of words (32-bit data) 134 135 Note that constant CRC_INPUT_FORMAT_UNDEFINED is defined but an initialization error 136 must occur if InputBufferFormat is not one of the three values listed above */ 137 } CRC_HandleTypeDef; 138 /** 139 * @} 140 */ 141 142 /* Exported constants --------------------------------------------------------*/ 143 /** @defgroup CRC_Exported_Constants CRC Exported Constants 144 * @{ 145 */ 146 147 /** @defgroup CRC_Default_Polynomial_Value Default CRC generating polynomial 148 * @{ 149 */ 150 #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 */ 151 /** 152 * @} 153 */ 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 /** @defgroup CRC_Default_Polynomial Indicates whether or not default polynomial is used 164 * @{ 165 */ 166 #define DEFAULT_POLYNOMIAL_ENABLE ((uint8_t)0x00U) /*!< Enable default generating polynomial 0x04C11DB7 */ 167 #define DEFAULT_POLYNOMIAL_DISABLE ((uint8_t)0x01U) /*!< Disable default generating polynomial 0x04C11DB7 */ 168 /** 169 * @} 170 */ 171 172 /** @defgroup CRC_Default_InitValue_Use Indicates whether or not default init value is used 173 * @{ 174 */ 175 #define DEFAULT_INIT_VALUE_ENABLE ((uint8_t)0x00U) /*!< Enable initial CRC default value */ 176 #define DEFAULT_INIT_VALUE_DISABLE ((uint8_t)0x01U) /*!< Disable initial CRC default value */ 177 /** 178 * @} 179 */ 180 181 /** @defgroup CRC_Polynomial_Sizes Polynomial sizes to configure the IP 182 * @{ 183 */ 184 #define CRC_POLYLENGTH_32B 0x00000000U /*!< Resort to a 32-bit long generating polynomial */ 185 #define CRC_POLYLENGTH_16B CRC_CR_POLYSIZE_0 /*!< Resort to a 16-bit long generating polynomial */ 186 #define CRC_POLYLENGTH_8B CRC_CR_POLYSIZE_1 /*!< Resort to a 8-bit long generating polynomial */ 187 #define CRC_POLYLENGTH_7B CRC_CR_POLYSIZE /*!< Resort to a 7-bit long generating polynomial */ 188 /** 189 * @} 190 */ 191 192 /** @defgroup CRC_Polynomial_Size_Definitions CRC polynomial possible sizes actual definitions 193 * @{ 194 */ 195 #define HAL_CRC_LENGTH_32B 32U /*!< 32-bit long CRC */ 196 #define HAL_CRC_LENGTH_16B 16U /*!< 16-bit long CRC */ 197 #define HAL_CRC_LENGTH_8B 8U /*!< 8-bit long CRC */ 198 #define HAL_CRC_LENGTH_7B 7U /*!< 7-bit long CRC */ 199 /** 200 * @} 201 */ 202 203 /** @defgroup CRC_Input_Buffer_Format Input Buffer Format 204 * @{ 205 */ 206 /* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but 207 * an error is triggered in HAL_CRC_Init() if InputDataFormat field is set 208 * to CRC_INPUT_FORMAT_UNDEFINED: the format MUST be defined by the user for 209 * the CRC APIs to provide a correct result */ 210 #define CRC_INPUTDATA_FORMAT_UNDEFINED 0x00000000U /*!< Undefined input data format */ 211 #define CRC_INPUTDATA_FORMAT_BYTES 0x00000001U /*!< Input data in byte format */ 212 #define CRC_INPUTDATA_FORMAT_HALFWORDS 0x00000002U /*!< Input data in half-word format */ 213 #define CRC_INPUTDATA_FORMAT_WORDS 0x00000003U /*!< Input data in word format */ 214 /** 215 * @} 216 */ 217 218 /** @defgroup CRC_Aliases CRC API aliases 219 * @{ 220 */ 221 #define HAL_CRC_Input_Data_Reverse HAL_CRCEx_Input_Data_Reverse /*!< Aliased to HAL_CRCEx_Input_Data_Reverse for inter STM32 series compatibility */ 222 #define HAL_CRC_Output_Data_Reverse HAL_CRCEx_Output_Data_Reverse /*!< Aliased to HAL_CRCEx_Output_Data_Reverse for inter STM32 series compatibility */ 223 /** 224 * @} 225 */ 226 227 /** 228 * @} 229 */ 230 231 /* Exported macros -----------------------------------------------------------*/ 232 /** @defgroup CRC_Exported_Macros CRC Exported Macros 233 * @{ 234 */ 235 236 /** @brief Reset CRC handle state. 237 * @param __HANDLE__ CRC handle. 238 * @retval None 239 */ 240 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET) 241 242 /** 243 * @brief Reset CRC Data Register. 244 * @param __HANDLE__ CRC handle 245 * @retval None 246 */ 247 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET) 248 249 /** 250 * @brief Set CRC INIT non-default value 251 * @param __HANDLE__ CRC handle 252 * @param __INIT__ 32-bit initial value 253 * @retval None 254 */ 255 #define __HAL_CRC_INITIALCRCVALUE_CONFIG(__HANDLE__, __INIT__) ((__HANDLE__)->Instance->INIT = (__INIT__)) 256 257 /** 258 * @brief Store data in the Independent Data (ID) register. 259 * @param __HANDLE__ CRC handle 260 * @param __VALUE__ Value to be stored in the ID register 261 * @note Refer to the Reference Manual to get the authorized __VALUE__ length in bits 262 * @retval None 263 */ 264 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, (__VALUE__))) 265 266 /** 267 * @brief Return the data stored in the Independent Data (ID) register. 268 * @param __HANDLE__ CRC handle 269 * @note Refer to the Reference Manual to get the authorized __VALUE__ length in bits 270 * @retval Value of the ID register 271 */ 272 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR) 273 /** 274 * @} 275 */ 276 277 278 /* Private macros --------------------------------------------------------*/ 279 /** @defgroup CRC_Private_Macros CRC Private Macros 280 * @{ 281 */ 282 283 #define IS_DEFAULT_POLYNOMIAL(DEFAULT) (((DEFAULT) == DEFAULT_POLYNOMIAL_ENABLE) || \ 284 ((DEFAULT) == DEFAULT_POLYNOMIAL_DISABLE)) 285 286 287 #define IS_DEFAULT_INIT_VALUE(VALUE) (((VALUE) == DEFAULT_INIT_VALUE_ENABLE) || \ 288 ((VALUE) == DEFAULT_INIT_VALUE_DISABLE)) 289 290 #define IS_CRC_POL_LENGTH(LENGTH) (((LENGTH) == CRC_POLYLENGTH_32B) || \ 291 ((LENGTH) == CRC_POLYLENGTH_16B) || \ 292 ((LENGTH) == CRC_POLYLENGTH_8B) || \ 293 ((LENGTH) == CRC_POLYLENGTH_7B)) 294 295 #define IS_CRC_INPUTDATA_FORMAT(FORMAT) (((FORMAT) == CRC_INPUTDATA_FORMAT_BYTES) || \ 296 ((FORMAT) == CRC_INPUTDATA_FORMAT_HALFWORDS) || \ 297 ((FORMAT) == CRC_INPUTDATA_FORMAT_WORDS)) 298 299 /** 300 * @} 301 */ 302 303 /* Include CRC HAL Extended module */ 304 #include "stm32l4xx_hal_crc_ex.h" 305 306 /* Exported functions --------------------------------------------------------*/ 307 /** @defgroup CRC_Exported_Functions CRC Exported Functions 308 * @{ 309 */ 310 311 /* Initialization and de-initialization functions ****************************/ 312 /** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions 313 * @{ 314 */ 315 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc); 316 HAL_StatusTypeDef HAL_CRC_DeInit(CRC_HandleTypeDef *hcrc); 317 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc); 318 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc); 319 /** 320 * @} 321 */ 322 323 /* Peripheral Control functions ***********************************************/ 324 /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions 325 * @{ 326 */ 327 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength); 328 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength); 329 /** 330 * @} 331 */ 332 333 /* Peripheral State and Error functions ***************************************/ 334 /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions 335 * @{ 336 */ 337 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc); 338 /** 339 * @} 340 */ 341 342 /** 343 * @} 344 */ 345 346 /** 347 * @} 348 */ 349 350 /** 351 * @} 352 */ 353 354 #ifdef __cplusplus 355 } 356 #endif 357 358 #endif /* __STM32L4xx_HAL_CRC_H */ 359 360 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 361
