2 ******************************************************************************
3 * @file stm32f1xx_hal_crc.c
4 * @author MCD Application Team
6 * @date 15-December-2014
7 * @brief CRC HAL module driver.
8 * This file provides firmware functions to manage the following
9 * functionalities of the Cyclic Redundancy Check (CRC) peripheral:
10 * + Initialization and de-initialization functions
11 * + Peripheral Control functions
12 * + Peripheral State functions
15 ==============================================================================
16 ##### How to use this driver #####
17 ==============================================================================
19 The CRC HAL driver can be used as follows:
21 (#) Enable CRC AHB clock using __HAL_RCC_CRC_CLK_ENABLE();
23 (#) Use HAL_CRC_Accumulate() function to compute the CRC value of
24 a 32-bit data buffer using combination of the previous CRC value
27 (#) Use HAL_CRC_Calculate() function to compute the CRC Value of
28 a new 32-bit data buffer. This function resets the CRC computation
29 unit before starting the computation to avoid getting wrong CRC values.
32 ******************************************************************************
35 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
37 * Redistribution and use in source and binary forms, with or without modification,
38 * are permitted provided that the following conditions are met:
39 * 1. Redistributions of source code must retain the above copyright notice,
40 * this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright notice,
42 * this list of conditions and the following disclaimer in the documentation
43 * and/or other materials provided with the distribution.
44 * 3. Neither the name of STMicroelectronics nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
48 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
49 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
51 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
54 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
55 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
56 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
57 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
59 ******************************************************************************
62 /* Includes ------------------------------------------------------------------*/
63 #include "stm32f1xx_hal.h"
65 /** @addtogroup STM32F1xx_HAL_Driver
70 * @brief CRC HAL module driver.
74 #ifdef HAL_CRC_MODULE_ENABLED
76 /* Private typedef -----------------------------------------------------------*/
77 /* Private define ------------------------------------------------------------*/
78 /* Private macro -------------------------------------------------------------*/
79 /* Private variables ---------------------------------------------------------*/
80 /* Private function prototypes -----------------------------------------------*/
81 /* Private functions ---------------------------------------------------------*/
83 /** @defgroup CRC_Exported_Functions CRC Exported Functions
87 /** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
88 * @brief Initialization and Configuration functions.
91 ==============================================================================
92 ##### Initialization and de-initialization functions #####
93 ==============================================================================
94 [..] This section provides functions allowing to:
95 (+) Initialize the CRC according to the specified parameters
96 in the CRC_InitTypeDef and create the associated handle
97 (+) DeInitialize the CRC peripheral
98 (+) Initialize the CRC MSP
99 (+) DeInitialize CRC MSP
106 * @brief Initializes the CRC according to the specified
107 * parameters in the CRC_InitTypeDef and creates the associated handle.
108 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
109 * the configuration information for CRC
112 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc)
114 /* Check the CRC handle allocation */
120 /* Check the parameters */
121 assert_param(IS_CRC_ALL_INSTANCE(hcrc->Instance));
123 if(hcrc->State == HAL_CRC_STATE_RESET)
125 /* Allocate lock resource and initialize it */
126 hcrc-> Lock = HAL_UNLOCKED;
128 /* Init the low level hardware */
129 HAL_CRC_MspInit(hcrc);
132 /* Change CRC peripheral state */
133 hcrc->State = HAL_CRC_STATE_READY;
135 /* Return function status */
140 * @brief DeInitializes the CRC peripheral.
141 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
142 * the configuration information for CRC
145 HAL_StatusTypeDef HAL_CRC_DeInit(CRC_HandleTypeDef *hcrc)
147 /* Check the CRC handle allocation */
153 /* Check the parameters */
154 assert_param(IS_CRC_ALL_INSTANCE(hcrc->Instance));
156 /* Change CRC peripheral state */
157 hcrc->State = HAL_CRC_STATE_BUSY;
159 /* DeInit the low level hardware */
160 HAL_CRC_MspDeInit(hcrc);
162 /* Resets the CRC calculation unit and sets the data register to 0xFFFF FFFF */
163 __HAL_CRC_DR_RESET(hcrc);
165 /* Change CRC peripheral state */
166 hcrc->State = HAL_CRC_STATE_RESET;
171 /* Return function status */
176 * @brief Initializes the CRC MSP.
177 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
178 * the configuration information for CRC
181 __weak void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc)
183 /* NOTE : This function Should not be modified, when the callback is needed,
184 the HAL_CRC_MspInit could be implemented in the user file
189 * @brief DeInitializes the CRC MSP.
190 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
191 * the configuration information for CRC
194 __weak void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc)
196 /* NOTE : This function Should not be modified, when the callback is needed,
197 the HAL_CRC_MspDeInit could be implemented in the user file
205 /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
206 * @brief management functions.
209 ==============================================================================
210 ##### Peripheral Control functions #####
211 ==============================================================================
212 [..] This section provides functions allowing to:
213 (+) Compute the 32-bit CRC value of 32-bit data buffer,
214 using combination of the previous CRC value and the new one.
215 (+) Compute the 32-bit CRC value of 32-bit data buffer,
216 independently of the previous CRC value.
223 * @brief Computes the 32-bit CRC of 32-bit data buffer using combination
224 * of the previous CRC value and the new one.
225 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
226 * the configuration information for CRC
227 * @param pBuffer: pointer to the buffer containing the data to be computed
228 * @param BufferLength: length of the buffer to be computed (defined in word, 4 bytes)
231 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength)
238 /* Change CRC peripheral state */
239 hcrc->State = HAL_CRC_STATE_BUSY;
241 /* Enter Data to the CRC calculator */
242 for(index = 0; index < BufferLength; index++)
244 hcrc->Instance->DR = pBuffer[index];
247 /* Change CRC peripheral state */
248 hcrc->State = HAL_CRC_STATE_READY;
250 /* Process Unlocked */
253 /* Return the CRC computed value */
254 return hcrc->Instance->DR;
258 * @brief Computes the 32-bit CRC of 32-bit data buffer independently
259 * of the previous CRC value.
260 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
261 * the configuration information for CRC
262 * @param pBuffer: Pointer to the buffer containing the data to be computed
263 * @param BufferLength: Length of the buffer to be computed (defined in word, 4 bytes)
266 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength)
273 /* Change CRC peripheral state */
274 hcrc->State = HAL_CRC_STATE_BUSY;
276 /* Reset CRC Calculation Unit */
277 __HAL_CRC_DR_RESET(hcrc);
279 /* Enter Data to the CRC calculator */
280 for(index = 0; index < BufferLength; index++)
282 hcrc->Instance->DR = pBuffer[index];
285 /* Change CRC peripheral state */
286 hcrc->State = HAL_CRC_STATE_READY;
288 /* Process Unlocked */
291 /* Return the CRC computed value */
292 return hcrc->Instance->DR;
299 /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
300 * @brief Peripheral State functions.
303 ==============================================================================
304 ##### Peripheral State functions #####
305 ==============================================================================
307 This subsection permits to get in run-time the status of the peripheral.
314 * @brief Returns the CRC state.
315 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
316 * the configuration information for CRC
319 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc)
332 #endif /* HAL_CRC_MODULE_ENABLED */
341 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/