2 ******************************************************************************
3 * @file stm32l0xx_hal_crc.h
4 * @author MCD Application Team
6 * @date 06-February-2015
7 * @brief Header file of CRC HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
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.
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.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32L0xx_HAL_CRC_H
40 #define __STM32L0xx_HAL_CRC_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32l0xx_hal_def.h"
49 /** @addtogroup STM32L0xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
60 * @brief CRC HAL State Structure definition
64 HAL_CRC_STATE_RESET = 0x00, /*!< CRC not yet initialized or disabled */
65 HAL_CRC_STATE_READY = 0x01, /*!< CRC initialized and ready for use */
66 HAL_CRC_STATE_BUSY = 0x02, /*!< CRC internal process is ongoing */
67 HAL_CRC_STATE_TIMEOUT = 0x03, /*!< CRC timeout state */
68 HAL_CRC_STATE_ERROR = 0x04 /*!< CRC error state */
69 }HAL_CRC_StateTypeDef;
73 * @brief CRC Init Structure definition
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 */
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 */
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 */
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 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) */
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 */
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 */
110 uint32_t OutputDataInversionMode; /*!< This parameter is a value of @ref CRCEx_Output_Data_Inversion and specifies output data (i.e. CRC) inversion mode.
112 CRC_OUTPUTDATA_INVERSION_DISABLE no CRC inversion, or
113 CRC_OUTPUTDATA_INVERSION_ENABLE CRC 0x11223344 is converted into 0x22CC4488 */
118 * @brief CRC Handle Structure definition
122 CRC_TypeDef *Instance; /*!< Register base address */
124 CRC_InitTypeDef Init; /*!< CRC configuration parameters */
126 HAL_LockTypeDef Lock; /*!< CRC Locking object */
128 __IO HAL_CRC_StateTypeDef State; /*!< CRC communication state */
130 uint32_t InputDataFormat; /*!< This parameter is a value of @ref CRC_Input_Buffer_Format and specifies input data format.
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 */
139 /* Exported constants --------------------------------------------------------*/
140 /** @defgroup CRC_Exported_Constants CRC exported constants
144 /** @defgroup CRC_Default_Polynomial_Value Default CRC generating polynomial
147 #define DEFAULT_CRC32_POLY 0x04C11DB7
153 /** @defgroup CRC_Default_InitValue Default CRC computation initialization value
156 #define DEFAULT_CRC_INITVALUE 0xFFFFFFFF
162 /** @defgroup CRC_Default_Polynomial Indicates whether or not default polynomial is used
165 #define DEFAULT_POLYNOMIAL_ENABLE ((uint8_t)0x00)
166 #define DEFAULT_POLYNOMIAL_DISABLE ((uint8_t)0x01)
168 #define IS_DEFAULT_POLYNOMIAL(__DEFAULT__) (((__DEFAULT__) == DEFAULT_POLYNOMIAL_ENABLE) || \
169 ((__DEFAULT__) == DEFAULT_POLYNOMIAL_DISABLE))
175 /** @defgroup CRC_Default_InitValue_Use Indicates whether or not default init value is used
178 #define DEFAULT_INIT_VALUE_ENABLE ((uint8_t)0x00)
179 #define DEFAULT_INIT_VALUE_DISABLE ((uint8_t)0x01)
181 #define IS_DEFAULT_INIT_VALUE(__VALUE__) (((__VALUE__) == DEFAULT_INIT_VALUE_ENABLE) || \
182 ((__VALUE__) == DEFAULT_INIT_VALUE_DISABLE))
188 /** @defgroup CRC_Polynomial_Sizes Polynomial sizes to configure the IP
191 #define CRC_POLYLENGTH_32B ((uint32_t)0x00000000)
192 #define CRC_POLYLENGTH_16B ((uint32_t)CRC_CR_POLYSIZE_0)
193 #define CRC_POLYLENGTH_8B ((uint32_t)CRC_CR_POLYSIZE_1)
194 #define CRC_POLYLENGTH_7B ((uint32_t)CRC_CR_POLYSIZE)
195 #define IS_CRC_POL_LENGTH(__LENGTH__) (((__LENGTH__) == CRC_POLYLENGTH_32B) || \
196 ((__LENGTH__) == CRC_POLYLENGTH_16B) || \
197 ((__LENGTH__) == CRC_POLYLENGTH_8B) || \
198 ((__LENGTH__) == CRC_POLYLENGTH_7B))
203 /** @defgroup CRC_Polynomial_Size_Definitions CRC polynomial possible sizes actual definitions
206 #define HAL_CRC_LENGTH_32B 32
207 #define HAL_CRC_LENGTH_16B 16
208 #define HAL_CRC_LENGTH_8B 8
209 #define HAL_CRC_LENGTH_7B 7
215 /** @defgroup CRC_Input_Buffer_Format CRC input buffer format
218 /* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but
219 * an error is triggered in HAL_CRC_Init() if InputDataFormat field is set
220 * to CRC_INPUT_FORMAT_UNDEFINED: the format MUST be defined by the user for
221 * the CRC APIs to provide a correct result */
222 #define CRC_INPUTDATA_FORMAT_UNDEFINED ((uint32_t)0x00000000)
223 #define CRC_INPUTDATA_FORMAT_BYTES ((uint32_t)0x00000001)
224 #define CRC_INPUTDATA_FORMAT_HALFWORDS ((uint32_t)0x00000002)
225 #define CRC_INPUTDATA_FORMAT_WORDS ((uint32_t)0x00000003)
227 #define IS_CRC_INPUTDATA_FORMAT(__FORMAT__) (((__FORMAT__) == CRC_INPUTDATA_FORMAT_BYTES) || \
228 ((__FORMAT__) == CRC_INPUTDATA_FORMAT_HALFWORDS) || \
229 ((__FORMAT__) == CRC_INPUTDATA_FORMAT_WORDS))
237 /* Exported macros -----------------------------------------------------------*/
239 /** @defgroup CRC_Exported_Macros CRC exported macros
243 /** @brief Reset CRC handle state
244 * @param __HANDLE__: CRC handle.
247 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
250 * @brief Reset CRC Data Register.
251 * @param __HANDLE__: CRC handle
254 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
257 * @brief Set CRC INIT non-default value
258 * @param __HANDLE__ : CRC handle
259 * @param __INIT__ : 32-bit initial value
262 #define __HAL_CRC_INITIALCRCVALUE_CONFIG(__HANDLE__, __INIT__) ((__HANDLE__)->Instance->INIT = (__INIT__))
265 * @brief Stores a 8-bit data in the Independent Data(ID) register.
266 * @param __HANDLE__: CRC handle
267 * @param __VALUE__: 8-bit value to be stored in the ID register
270 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (MODIFY_REG((__HANDLE__)->Instance->IDR, CRC_IDR_IDR, (__VALUE__))
273 * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
274 * @param __HANDLE__: CRC handle
275 * @retval 8-bit value of the ID register
277 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
283 /* Include CRC HAL Extension module */
284 #include "stm32l0xx_hal_crc_ex.h"
286 /* Exported functions --------------------------------------------------------*/
287 /** @defgroup CRC_Exported_Functions CRC Exported Functions
291 /** @defgroup CRC_Exported_Functions_Group1 Initialization/de-initialization functions
294 /* Initialization and de-initialization functions ****************************/
295 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
296 HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
297 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
298 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
303 /* Aliases for inter STM32 series compatibility */
304 #define HAL_CRC_Input_Data_Reverse HAL_CRCEx_Input_Data_Reverse
305 #define HAL_CRC_Output_Data_Reverse HAL_CRCEx_Output_Data_Reverse
307 /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
310 /* Peripheral Control functions ***********************************************/
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);
317 /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
320 /* Peripheral State and Error functions ***************************************/
321 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
343 #endif /* __STM32L0xx_HAL_CRC_H */
345 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/