| 提交 | 用户 | age | ||
| bfc108 | 1 | /** |
| Q | 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 | * <h2><center>© COPYRIGHT(c) 2016 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 __STM32F0xx_HAL_CRC_H | |
| 38 | #define __STM32F0xx_HAL_CRC_H | |
| 39 | ||
| 40 | #ifdef __cplusplus | |
| 41 | extern "C" { | |
| 42 | #endif | |
| 43 | ||
| 44 | /* Includes ------------------------------------------------------------------*/ | |
| 45 | #include "stm32f0xx_hal_def.h" | |
| 46 | ||
| 47 | /** @addtogroup STM32F0xx_HAL_Driver | |
| 48 | * @{ | |
| 49 | */ | |
| 50 | ||
| 51 | /** @addtogroup CRC CRC | |
| 52 | * @{ | |
| 53 | */ | |
| 54 | ||
| 55 | /* Exported types ------------------------------------------------------------*/ | |
| 56 | /** @defgroup CRC_Exported_Types CRC Exported Types | |
| 57 | * @{ | |
| 58 | */ | |
| 59 | /** | |
| 60 | * @brief CRC HAL State Structure definition | |
| 61 | */ | |
| 62 | typedef enum | |
| 63 | { | |
| 64 | HAL_CRC_STATE_RESET = 0x00U, /*!< CRC not yet initialized or disabled */ | |
| 65 | HAL_CRC_STATE_READY = 0x01U, /*!< CRC initialized and ready for use */ | |
| 66 | HAL_CRC_STATE_BUSY = 0x02U, /*!< CRC internal process is ongoing */ | |
| 67 | HAL_CRC_STATE_TIMEOUT = 0x03U, /*!< CRC timeout state */ | |
| 68 | HAL_CRC_STATE_ERROR = 0x04U /*!< CRC error state */ | |
| 69 | }HAL_CRC_StateTypeDef; | |
| 70 | ||
| 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. 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 CRCEx_Polynomial_Sizes and indicates CRC length. | |
| 94 | Value can be either one of | |
| 95 | CRC_POLYLENGTH_32B (32-bit CRC) | |
| 96 | CRC_POLYLENGTH_16B (16-bit CRC) | |
| 97 | CRC_POLYLENGTH_8B (8-bit CRC) | |
| 98 | 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 | CRC_INPUTDATA_INVERSION_NONE no input data inversion | |
| 106 | CRC_INPUTDATA_INVERSION_BYTE byte-wise inversion, 0x1A2B3C4D becomes 0x58D43CB2 | |
| 107 | CRC_INPUTDATA_INVERSION_HALFWORD halfword-wise inversion, 0x1A2B3C4D becomes 0xD458B23C | |
| 108 | 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 | CRC_OUTPUTDATA_INVERSION_DISABLE no CRC inversion, or | |
| 113 | CRC_OUTPUTDATA_INVERSION_ENABLE CRC 0x11223344 is converted into 0x22CC4488 */ | |
| 114 | }CRC_InitTypeDef; | |
| 115 | ||
| 116 | ||
| 117 | /** | |
| 118 | * @brief CRC Handle Structure definition | |
| 119 | */ | |
| 120 | typedef struct | |
| 121 | { | |
| 122 | CRC_TypeDef *Instance; /*!< Register base address */ | |
| 123 | ||
| 124 | CRC_InitTypeDef Init; /*!< CRC configuration parameters */ | |
| 125 | ||
| 126 | HAL_LockTypeDef Lock; /*!< CRC Locking object */ | |
| 127 | ||
| 128 | __IO HAL_CRC_StateTypeDef State; /*!< CRC communication state */ | |
| 129 | ||
| 130 | uint32_t InputDataFormat; /*!< This parameter is a value of @ref CRC_Input_Buffer_Format and specifies input data format. | |
| 131 | Can be either | |
| 132 | CRC_INPUTDATA_FORMAT_BYTES input data is a stream of bytes (8-bit data) | |
| 133 | CRC_INPUTDATA_FORMAT_HALFWORDS input data is a stream of half-words (16-bit data) | |
| 134 | CRC_INPUTDATA_FORMAT_WORDS input data is a stream of words (32-bits data) | |
| 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 | /** @defgroup CRC_Default_Polynomial_Value Default CRC generating polynomial | |
| 147 | * @{ | |
| 148 | */ | |
| 149 | #define DEFAULT_CRC32_POLY 0x04C11DB7 | |
| 150 | ||
| 151 | /** | |
| 152 | * @} | |
| 153 | */ | |
| 154 | ||
| 155 | /** @defgroup CRC_Default_InitValue Default CRC computation initialization value | |
| 156 | * @{ | |
| 157 | */ | |
| 158 | #define DEFAULT_CRC_INITVALUE 0xFFFFFFFFU | |
| 159 | ||
| 160 | /** | |
| 161 | * @} | |
| 162 | */ | |
| 163 | ||
| 164 | /** @defgroup CRC_Default_Polynomial Indicates whether or not default polynomial is used | |
| 165 | * @{ | |
| 166 | */ | |
| 167 | #if defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx) | |
| 168 | #define DEFAULT_POLYNOMIAL_ENABLE ((uint8_t)0x00U) | |
| 169 | #define DEFAULT_POLYNOMIAL_DISABLE ((uint8_t)0x01U) | |
| 170 | ||
| 171 | #define IS_DEFAULT_POLYNOMIAL(DEFAULT) (((DEFAULT) == DEFAULT_POLYNOMIAL_ENABLE) || \ | |
| 172 | ((DEFAULT) == DEFAULT_POLYNOMIAL_DISABLE)) | |
| 173 | #else | |
| 174 | #define DEFAULT_POLYNOMIAL_ENABLE ((uint8_t)0x00U) | |
| 175 | ||
| 176 | #define IS_DEFAULT_POLYNOMIAL(DEFAULT) ((DEFAULT) == DEFAULT_POLYNOMIAL_ENABLE) | |
| 177 | #endif /* defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx) */ | |
| 178 | ||
| 179 | /** | |
| 180 | * @} | |
| 181 | */ | |
| 182 | ||
| 183 | /** @defgroup CRC_Default_InitValue_Use Indicates whether or not default init value is used | |
| 184 | * @{ | |
| 185 | */ | |
| 186 | #define DEFAULT_INIT_VALUE_ENABLE ((uint8_t)0x00U) | |
| 187 | #define DEFAULT_INIT_VALUE_DISABLE ((uint8_t)0x01U) | |
| 188 | ||
| 189 | #define IS_DEFAULT_INIT_VALUE(VALUE) (((VALUE) == DEFAULT_INIT_VALUE_ENABLE) || \ | |
| 190 | ((VALUE) == DEFAULT_INIT_VALUE_DISABLE)) | |
| 191 | /** | |
| 192 | * @} | |
| 193 | */ | |
| 194 | ||
| 195 | /** @defgroup CRC_Input_Buffer_Format Input Buffer Format | |
| 196 | * @{ | |
| 197 | */ | |
| 198 | /* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but | |
| 199 | * an error is triggered in HAL_CRC_Init() if InputDataFormat field is set | |
| 200 | * to CRC_INPUT_FORMAT_UNDEFINED: the format MUST be defined by the user for | |
| 201 | * the CRC APIs to provide a correct result */ | |
| 202 | #define CRC_INPUTDATA_FORMAT_UNDEFINED (0x00000000U) | |
| 203 | #define CRC_INPUTDATA_FORMAT_BYTES (0x00000001U) | |
| 204 | #define CRC_INPUTDATA_FORMAT_HALFWORDS (0x00000002U) | |
| 205 | #define CRC_INPUTDATA_FORMAT_WORDS (0x00000003U) | |
| 206 | ||
| 207 | #define IS_CRC_INPUTDATA_FORMAT(FORMAT) (((FORMAT) == CRC_INPUTDATA_FORMAT_BYTES) || \ | |
| 208 | ((FORMAT) == CRC_INPUTDATA_FORMAT_HALFWORDS) || \ | |
| 209 | ((FORMAT) == CRC_INPUTDATA_FORMAT_WORDS)) | |
| 210 | /** | |
| 211 | * @} | |
| 212 | */ | |
| 213 | ||
| 214 | /** | |
| 215 | * @} | |
| 216 | */ | |
| 217 | ||
| 218 | /* Exported macros -----------------------------------------------------------*/ | |
| 219 | ||
| 220 | /** @defgroup CRC_Exported_Macros CRC Exported Macros | |
| 221 | * @{ | |
| 222 | */ | |
| 223 | ||
| 224 | /** @brief Reset CRC handle state | |
| 225 | * @param __HANDLE__ CRC handle. | |
| 226 | * @retval None | |
| 227 | */ | |
| 228 | #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET) | |
| 229 | ||
| 230 | /** | |
| 231 | * @brief Reset CRC Data Register. | |
| 232 | * @param __HANDLE__ CRC handle | |
| 233 | * @retval None. | |
| 234 | */ | |
| 235 | #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET) | |
| 236 | ||
| 237 | /** | |
| 238 | * @brief Set CRC INIT non-default value | |
| 239 | * @param __HANDLE__ CRC handle | |
| 240 | * @param __INIT__ 32-bit initial value | |
| 241 | * @retval None. | |
| 242 | */ | |
| 243 | #define __HAL_CRC_INITIALCRCVALUE_CONFIG(__HANDLE__, __INIT__) ((__HANDLE__)->Instance->INIT = (__INIT__)) | |
| 244 | ||
| 245 | /** | |
| 246 | * @brief Stores a 8-bit data in the Independent Data(ID) register. | |
| 247 | * @param __HANDLE__ CRC handle | |
| 248 | * @param __VALUE__ 8-bit value to be stored in the ID register | |
| 249 | * @retval None | |
| 250 | */ | |
| 251 | #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, (__VALUE__))) | |
| 252 | ||
| 253 | /** | |
| 254 | * @brief Returns the 8-bit data stored in the Independent Data(ID) register. | |
| 255 | * @param __HANDLE__ CRC handle | |
| 256 | * @retval 8-bit value of the ID register | |
| 257 | */ | |
| 258 | #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR) | |
| 259 | /** | |
| 260 | * @} | |
| 261 | */ | |
| 262 | ||
| 263 | ||
| 264 | /* Include CRC HAL Extension module */ | |
| 265 | #include "stm32f0xx_hal_crc_ex.h" | |
| 266 | ||
| 267 | /* Exported functions --------------------------------------------------------*/ | |
| 268 | /** @addtogroup CRC_Exported_Functions CRC Exported Functions | |
| 269 | * @{ | |
| 270 | */ | |
| 271 | ||
| 272 | /** @addtogroup CRC_Exported_Functions_Group1 Initialization/de-initialization functions | |
| 273 | * @brief Initialization and Configuration functions. | |
| 274 | * @{ | |
| 275 | */ | |
| 276 | ||
| 277 | /* Initialization and de-initialization functions ****************************/ | |
| 278 | HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc); | |
| 279 | HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc); | |
| 280 | void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc); | |
| 281 | void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc); | |
| 282 | /** | |
| 283 | * @} | |
| 284 | */ | |
| 285 | ||
| 286 | /** @addtogroup CRC_Exported_Functions_Group2 Peripheral Control functions | |
| 287 | * @brief management functions. | |
| 288 | * @{ | |
| 289 | */ | |
| 290 | ||
| 291 | /* Peripheral Control functions ***********************************************/ | |
| 292 | uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength); | |
| 293 | uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength); | |
| 294 | /** | |
| 295 | * @} | |
| 296 | */ | |
| 297 | ||
| 298 | /** @addtogroup CRC_Exported_Functions_Group3 Peripheral State functions | |
| 299 | * @brief Peripheral State functions. | |
| 300 | * @{ | |
| 301 | */ | |
| 302 | /* Peripheral State and Error functions ***************************************/ | |
| 303 | HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc); | |
| 304 | /** | |
| 305 | * @} | |
| 306 | */ | |
| 307 | ||
| 308 | /** | |
| 309 | * @} | |
| 310 | */ | |
| 311 | ||
| 312 | /** @addtogroup CRC_Exported_Constants CRC Exported Constants | |
| 313 | * @brief aliases for inter STM32 series compatibility | |
| 314 | * @{ | |
| 315 | */ | |
| 316 | /** @defgroup CRC_Aliases Aliases for inter STM32 series compatibility | |
| 317 | * @{ | |
| 318 | */ | |
| 319 | /* Aliases for inter STM32 series compatibility */ | |
| 320 | #define HAL_CRC_Input_Data_Reverse HAL_CRCEx_Input_Data_Reverse | |
| 321 | #define HAL_CRC_Output_Data_Reverse HAL_CRCEx_Output_Data_Reverse | |
| 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 /* __STM32F0xx_HAL_CRC_H */ | |
| 343 | ||
| 344 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ | |
| 345 | ||
