shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_crc.c@226:b062af740e40, 2014-06-11 (annotated)

Committer:
mbed_official
Date:
Wed Jun 11 09:45:09 2014 +0100
Revision:
226:b062af740e40
Parent:
106:ced8cbb51063 
Synchronized with git revision 42deb9ac55f9bdf9835e9c41dc757117d344ffda



Full URL: https://github.com/mbedmicro/mbed/commit/42deb9ac55f9bdf9835e9c41dc757117d344ffda/



[NUCLEO_F401RE] Remove call to Systick + bug fixes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 87:085cde657901 1 /**
mbed_official 87:085cde657901 2 ******************************************************************************
mbed_official 87:085cde657901 3 * @file stm32f4xx_hal_crc.c
mbed_official 87:085cde657901 4 * @author MCD Application Team
mbed_official 226:b062af740e40 5 * @version V1.1.0RC2
mbed_official 226:b062af740e40 6 * @date 14-May-2014
mbed_official 87:085cde657901 7 * @brief CRC HAL module driver.
mbed_official 87:085cde657901 8 * This file provides firmware functions to manage the following
mbed_official 87:085cde657901 9 * functionalities of the Cyclic Redundancy Check (CRC) peripheral:
mbed_official 87:085cde657901 10 * + Initialization and de-initialization functions
mbed_official 87:085cde657901 11 * + Peripheral Control functions
mbed_official 87:085cde657901 12 * + Peripheral State functions
mbed_official 87:085cde657901 13 *
mbed_official 87:085cde657901 14 @verbatim
mbed_official 87:085cde657901 15 ==============================================================================
mbed_official 87:085cde657901 16 ##### How to use this driver #####
mbed_official 87:085cde657901 17 ==============================================================================
mbed_official 87:085cde657901 18 [..]
mbed_official 87:085cde657901 19 The CRC HAL driver can be used as follows:
mbed_official 87:085cde657901 20
mbed_official 87:085cde657901 21 (#) Enable CRC AHB clock using __CRC_CLK_ENABLE();
mbed_official 87:085cde657901 22
mbed_official 87:085cde657901 23 (#) Use HAL_CRC_Accumulate() function to compute the CRC value of
mbed_official 87:085cde657901 24 a 32-bit data buffer using combination of the previous CRC value
mbed_official 87:085cde657901 25 and the new one.
mbed_official 87:085cde657901 26
mbed_official 87:085cde657901 27 (#) Use HAL_CRC_Calculate() function to compute the CRC Value of
mbed_official 87:085cde657901 28 a new 32-bit data buffer. This function resets the CRC computation
mbed_official 87:085cde657901 29 unit before starting the computation to avoid getting wrong CRC values.
mbed_official 87:085cde657901 30
mbed_official 87:085cde657901 31 @endverbatim
mbed_official 87:085cde657901 32 ******************************************************************************
mbed_official 87:085cde657901 33 * @attention
mbed_official 87:085cde657901 34 *
mbed_official 87:085cde657901 35 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 87:085cde657901 36 *
mbed_official 87:085cde657901 37 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 87:085cde657901 38 * are permitted provided that the following conditions are met:
mbed_official 87:085cde657901 39 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 87:085cde657901 40 * this list of conditions and the following disclaimer.
mbed_official 87:085cde657901 41 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 87:085cde657901 42 * this list of conditions and the following disclaimer in the documentation
mbed_official 87:085cde657901 43 * and/or other materials provided with the distribution.
mbed_official 87:085cde657901 44 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 87:085cde657901 45 * may be used to endorse or promote products derived from this software
mbed_official 87:085cde657901 46 * without specific prior written permission.
mbed_official 87:085cde657901 47 *
mbed_official 87:085cde657901 48 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 87:085cde657901 49 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 87:085cde657901 50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 87:085cde657901 51 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 87:085cde657901 52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 87:085cde657901 53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 87:085cde657901 54 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 87:085cde657901 55 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 87:085cde657901 56 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 87:085cde657901 57 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 87:085cde657901 58 *
mbed_official 87:085cde657901 59 ******************************************************************************
mbed_official 87:085cde657901 60 */
mbed_official 87:085cde657901 61
mbed_official 87:085cde657901 62 /* Includes ------------------------------------------------------------------*/
mbed_official 87:085cde657901 63 #include "stm32f4xx_hal.h"
mbed_official 87:085cde657901 64
mbed_official 87:085cde657901 65 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 87:085cde657901 66 * @{
mbed_official 87:085cde657901 67 */
mbed_official 87:085cde657901 68
mbed_official 87:085cde657901 69 /** @defgroup CRC
mbed_official 87:085cde657901 70 * @brief CRC HAL module driver.
mbed_official 87:085cde657901 71 * @{
mbed_official 87:085cde657901 72 */
mbed_official 87:085cde657901 73
mbed_official 87:085cde657901 74 #ifdef HAL_CRC_MODULE_ENABLED
mbed_official 87:085cde657901 75
mbed_official 87:085cde657901 76 /* Private typedef -----------------------------------------------------------*/
mbed_official 87:085cde657901 77 /* Private define ------------------------------------------------------------*/
mbed_official 87:085cde657901 78 /* Private macro -------------------------------------------------------------*/
mbed_official 87:085cde657901 79 /* Private variables ---------------------------------------------------------*/
mbed_official 87:085cde657901 80 /* Private function prototypes -----------------------------------------------*/
mbed_official 87:085cde657901 81 /* Private functions ---------------------------------------------------------*/
mbed_official 87:085cde657901 82
mbed_official 87:085cde657901 83 /** @defgroup CRC_Private_Functions
mbed_official 87:085cde657901 84 * @{
mbed_official 87:085cde657901 85 */
mbed_official 87:085cde657901 86
mbed_official 87:085cde657901 87 /** @defgroup CRC_Group1 Initialization and de-initialization functions
mbed_official 87:085cde657901 88 * @brief Initialization and Configuration functions.
mbed_official 87:085cde657901 89 *
mbed_official 87:085cde657901 90 @verbatim
mbed_official 87:085cde657901 91 ==============================================================================
mbed_official 87:085cde657901 92 ##### Initialization and de-initialization functions #####
mbed_official 87:085cde657901 93 ==============================================================================
mbed_official 87:085cde657901 94 [..] This section provides functions allowing to:
mbed_official 87:085cde657901 95 (+) Initialize the CRC according to the specified parameters
mbed_official 87:085cde657901 96 in the CRC_InitTypeDef and create the associated handle
mbed_official 87:085cde657901 97 (+) DeInitialize the CRC peripheral
mbed_official 87:085cde657901 98 (+) Initialize the CRC MSP
mbed_official 87:085cde657901 99 (+) DeInitialize CRC MSP
mbed_official 87:085cde657901 100
mbed_official 87:085cde657901 101 @endverbatim
mbed_official 87:085cde657901 102 * @{
mbed_official 87:085cde657901 103 */
mbed_official 87:085cde657901 104
mbed_official 87:085cde657901 105 /**
mbed_official 87:085cde657901 106 * @brief Initializes the CRC according to the specified
mbed_official 87:085cde657901 107 * parameters in the CRC_InitTypeDef and creates the associated handle.
mbed_official 226:b062af740e40 108 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
mbed_official 226:b062af740e40 109 * the configuration information for CRC
mbed_official 87:085cde657901 110 * @retval HAL status
mbed_official 87:085cde657901 111 */
mbed_official 87:085cde657901 112 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 113 {
mbed_official 87:085cde657901 114 /* Check the CRC handle allocation */
mbed_official 87:085cde657901 115 if(hcrc == NULL)
mbed_official 87:085cde657901 116 {
mbed_official 87:085cde657901 117 return HAL_ERROR;
mbed_official 87:085cde657901 118 }
mbed_official 87:085cde657901 119
mbed_official 87:085cde657901 120 /* Check the parameters */
mbed_official 87:085cde657901 121 assert_param(IS_CRC_ALL_INSTANCE(hcrc->Instance));
mbed_official 87:085cde657901 122
mbed_official 87:085cde657901 123 if(hcrc->State == HAL_CRC_STATE_RESET)
mbed_official 87:085cde657901 124 {
mbed_official 87:085cde657901 125 /* Init the low level hardware */
mbed_official 87:085cde657901 126 HAL_CRC_MspInit(hcrc);
mbed_official 87:085cde657901 127 }
mbed_official 87:085cde657901 128
mbed_official 87:085cde657901 129 /* Change CRC peripheral state */
mbed_official 87:085cde657901 130 hcrc->State = HAL_CRC_STATE_BUSY;
mbed_official 87:085cde657901 131
mbed_official 87:085cde657901 132 /* Change CRC peripheral state */
mbed_official 87:085cde657901 133 hcrc->State = HAL_CRC_STATE_READY;
mbed_official 87:085cde657901 134
mbed_official 87:085cde657901 135 /* Return function status */
mbed_official 87:085cde657901 136 return HAL_OK;
mbed_official 87:085cde657901 137 }
mbed_official 87:085cde657901 138
mbed_official 87:085cde657901 139 /**
mbed_official 87:085cde657901 140 * @brief DeInitializes the CRC peripheral.
mbed_official 226:b062af740e40 141 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
mbed_official 226:b062af740e40 142 * the configuration information for CRC
mbed_official 87:085cde657901 143 * @retval HAL status
mbed_official 87:085cde657901 144 */
mbed_official 87:085cde657901 145 HAL_StatusTypeDef HAL_CRC_DeInit(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 146 {
mbed_official 87:085cde657901 147 /* Check the CRC handle allocation */
mbed_official 87:085cde657901 148 if(hcrc == NULL)
mbed_official 87:085cde657901 149 {
mbed_official 87:085cde657901 150 return HAL_ERROR;
mbed_official 87:085cde657901 151 }
mbed_official 87:085cde657901 152
mbed_official 87:085cde657901 153 /* Check the parameters */
mbed_official 87:085cde657901 154 assert_param(IS_CRC_ALL_INSTANCE(hcrc->Instance));
mbed_official 87:085cde657901 155
mbed_official 87:085cde657901 156 /* Change CRC peripheral state */
mbed_official 87:085cde657901 157 hcrc->State = HAL_CRC_STATE_BUSY;
mbed_official 87:085cde657901 158
mbed_official 87:085cde657901 159 /* DeInit the low level hardware */
mbed_official 87:085cde657901 160 HAL_CRC_MspDeInit(hcrc);
mbed_official 87:085cde657901 161
mbed_official 87:085cde657901 162 /* Change CRC peripheral state */
mbed_official 87:085cde657901 163 hcrc->State = HAL_CRC_STATE_RESET;
mbed_official 87:085cde657901 164
mbed_official 106:ced8cbb51063 165 /* Release Lock */
mbed_official 106:ced8cbb51063 166 __HAL_UNLOCK(hcrc);
mbed_official 106:ced8cbb51063 167
mbed_official 87:085cde657901 168 /* Return function status */
mbed_official 87:085cde657901 169 return HAL_OK;
mbed_official 87:085cde657901 170 }
mbed_official 87:085cde657901 171
mbed_official 87:085cde657901 172 /**
mbed_official 87:085cde657901 173 * @brief Initializes the CRC MSP.
mbed_official 226:b062af740e40 174 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
mbed_official 226:b062af740e40 175 * the configuration information for CRC
mbed_official 87:085cde657901 176 * @retval None
mbed_official 87:085cde657901 177 */
mbed_official 87:085cde657901 178 __weak void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 179 {
mbed_official 87:085cde657901 180 /* NOTE : This function Should not be modified, when the callback is needed,
mbed_official 87:085cde657901 181 the HAL_CRC_MspInit could be implemented in the user file
mbed_official 87:085cde657901 182 */
mbed_official 87:085cde657901 183 }
mbed_official 87:085cde657901 184
mbed_official 87:085cde657901 185 /**
mbed_official 87:085cde657901 186 * @brief DeInitializes the CRC MSP.
mbed_official 226:b062af740e40 187 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
mbed_official 226:b062af740e40 188 * the configuration information for CRC
mbed_official 87:085cde657901 189 * @retval None
mbed_official 87:085cde657901 190 */
mbed_official 87:085cde657901 191 __weak void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 192 {
mbed_official 87:085cde657901 193 /* NOTE : This function Should not be modified, when the callback is needed,
mbed_official 87:085cde657901 194 the HAL_CRC_MspDeInit could be implemented in the user file
mbed_official 87:085cde657901 195 */
mbed_official 87:085cde657901 196 }
mbed_official 87:085cde657901 197
mbed_official 87:085cde657901 198 /**
mbed_official 87:085cde657901 199 * @}
mbed_official 87:085cde657901 200 */
mbed_official 87:085cde657901 201
mbed_official 87:085cde657901 202 /** @defgroup CRC_Group2 Peripheral Control functions
mbed_official 87:085cde657901 203 * @brief management functions.
mbed_official 87:085cde657901 204 *
mbed_official 87:085cde657901 205 @verbatim
mbed_official 87:085cde657901 206 ==============================================================================
mbed_official 87:085cde657901 207 ##### Peripheral Control functions #####
mbed_official 87:085cde657901 208 ==============================================================================
mbed_official 87:085cde657901 209 [..] This section provides functions allowing to:
mbed_official 87:085cde657901 210 (+) Compute the 32-bit CRC value of 32-bit data buffer,
mbed_official 87:085cde657901 211 using combination of the previous CRC value and the new one.
mbed_official 87:085cde657901 212 (+) Compute the 32-bit CRC value of 32-bit data buffer,
mbed_official 87:085cde657901 213 independently of the previous CRC value.
mbed_official 87:085cde657901 214
mbed_official 87:085cde657901 215 @endverbatim
mbed_official 87:085cde657901 216 * @{
mbed_official 87:085cde657901 217 */
mbed_official 87:085cde657901 218
mbed_official 87:085cde657901 219 /**
mbed_official 87:085cde657901 220 * @brief Computes the 32-bit CRC of 32-bit data buffer using combination
mbed_official 87:085cde657901 221 * of the previous CRC value and the new one.
mbed_official 226:b062af740e40 222 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
mbed_official 226:b062af740e40 223 * the configuration information for CRC
mbed_official 87:085cde657901 224 * @param pBuffer: pointer to the buffer containing the data to be computed
mbed_official 87:085cde657901 225 * @param BufferLength: length of the buffer to be computed
mbed_official 87:085cde657901 226 * @retval 32-bit CRC
mbed_official 87:085cde657901 227 */
mbed_official 87:085cde657901 228 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength)
mbed_official 87:085cde657901 229 {
mbed_official 87:085cde657901 230 uint32_t index = 0;
mbed_official 87:085cde657901 231
mbed_official 87:085cde657901 232 /* Process Locked */
mbed_official 87:085cde657901 233 __HAL_LOCK(hcrc);
mbed_official 87:085cde657901 234
mbed_official 87:085cde657901 235 /* Change CRC peripheral state */
mbed_official 87:085cde657901 236 hcrc->State = HAL_CRC_STATE_BUSY;
mbed_official 87:085cde657901 237
mbed_official 87:085cde657901 238 /* Enter Data to the CRC calculator */
mbed_official 87:085cde657901 239 for(index = 0; index < BufferLength; index++)
mbed_official 87:085cde657901 240 {
mbed_official 87:085cde657901 241 hcrc->Instance->DR = pBuffer[index];
mbed_official 87:085cde657901 242 }
mbed_official 87:085cde657901 243
mbed_official 87:085cde657901 244 /* Change CRC peripheral state */
mbed_official 87:085cde657901 245 hcrc->State = HAL_CRC_STATE_READY;
mbed_official 87:085cde657901 246
mbed_official 87:085cde657901 247 /* Process Unlocked */
mbed_official 87:085cde657901 248 __HAL_UNLOCK(hcrc);
mbed_official 87:085cde657901 249
mbed_official 87:085cde657901 250 /* Return the CRC computed value */
mbed_official 87:085cde657901 251 return hcrc->Instance->DR;
mbed_official 87:085cde657901 252 }
mbed_official 87:085cde657901 253
mbed_official 87:085cde657901 254 /**
mbed_official 87:085cde657901 255 * @brief Computes the 32-bit CRC of 32-bit data buffer independently
mbed_official 87:085cde657901 256 * of the previous CRC value.
mbed_official 226:b062af740e40 257 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
mbed_official 226:b062af740e40 258 * the configuration information for CRC
mbed_official 87:085cde657901 259 * @param pBuffer: Pointer to the buffer containing the data to be computed
mbed_official 87:085cde657901 260 * @param BufferLength: Length of the buffer to be computed
mbed_official 87:085cde657901 261 * @retval 32-bit CRC
mbed_official 87:085cde657901 262 */
mbed_official 87:085cde657901 263 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength)
mbed_official 87:085cde657901 264 {
mbed_official 87:085cde657901 265 uint32_t index = 0;
mbed_official 87:085cde657901 266
mbed_official 87:085cde657901 267 /* Process Locked */
mbed_official 87:085cde657901 268 __HAL_LOCK(hcrc);
mbed_official 87:085cde657901 269
mbed_official 87:085cde657901 270 /* Change CRC peripheral state */
mbed_official 87:085cde657901 271 hcrc->State = HAL_CRC_STATE_BUSY;
mbed_official 87:085cde657901 272
mbed_official 87:085cde657901 273 /* Reset CRC Calculation Unit */
mbed_official 87:085cde657901 274 __HAL_CRC_DR_RESET(hcrc);
mbed_official 87:085cde657901 275
mbed_official 87:085cde657901 276 /* Enter Data to the CRC calculator */
mbed_official 87:085cde657901 277 for(index = 0; index < BufferLength; index++)
mbed_official 87:085cde657901 278 {
mbed_official 87:085cde657901 279 hcrc->Instance->DR = pBuffer[index];
mbed_official 87:085cde657901 280 }
mbed_official 87:085cde657901 281
mbed_official 87:085cde657901 282 /* Change CRC peripheral state */
mbed_official 87:085cde657901 283 hcrc->State = HAL_CRC_STATE_READY;
mbed_official 87:085cde657901 284
mbed_official 87:085cde657901 285 /* Process Unlocked */
mbed_official 87:085cde657901 286 __HAL_UNLOCK(hcrc);
mbed_official 87:085cde657901 287
mbed_official 87:085cde657901 288 /* Return the CRC computed value */
mbed_official 87:085cde657901 289 return hcrc->Instance->DR;
mbed_official 87:085cde657901 290 }
mbed_official 87:085cde657901 291
mbed_official 87:085cde657901 292 /**
mbed_official 87:085cde657901 293 * @}
mbed_official 87:085cde657901 294 */
mbed_official 87:085cde657901 295
mbed_official 87:085cde657901 296 /** @defgroup CRC_Group3 Peripheral State functions
mbed_official 87:085cde657901 297 * @brief Peripheral State functions.
mbed_official 87:085cde657901 298 *
mbed_official 87:085cde657901 299 @verbatim
mbed_official 87:085cde657901 300 ==============================================================================
mbed_official 87:085cde657901 301 ##### Peripheral State functions #####
mbed_official 87:085cde657901 302 ==============================================================================
mbed_official 87:085cde657901 303 [..]
mbed_official 87:085cde657901 304 This subsection permits to get in run-time the status of the peripheral
mbed_official 87:085cde657901 305 and the data flow.
mbed_official 87:085cde657901 306
mbed_official 87:085cde657901 307 @endverbatim
mbed_official 87:085cde657901 308 * @{
mbed_official 87:085cde657901 309 */
mbed_official 87:085cde657901 310
mbed_official 87:085cde657901 311 /**
mbed_official 87:085cde657901 312 * @brief Returns the CRC state.
mbed_official 226:b062af740e40 313 * @param hcrc: pointer to a CRC_HandleTypeDef structure that contains
mbed_official 226:b062af740e40 314 * the configuration information for CRC
mbed_official 87:085cde657901 315 * @retval HAL state
mbed_official 87:085cde657901 316 */
mbed_official 87:085cde657901 317 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 318 {
mbed_official 87:085cde657901 319 return hcrc->State;
mbed_official 87:085cde657901 320 }
mbed_official 87:085cde657901 321
mbed_official 87:085cde657901 322 /**
mbed_official 87:085cde657901 323 * @}
mbed_official 87:085cde657901 324 */
mbed_official 87:085cde657901 325
mbed_official 87:085cde657901 326 /**
mbed_official 87:085cde657901 327 * @}
mbed_official 87:085cde657901 328 */
mbed_official 87:085cde657901 329
mbed_official 87:085cde657901 330 #endif /* HAL_CRC_MODULE_ENABLED */
mbed_official 87:085cde657901 331 /**
mbed_official 87:085cde657901 332 * @}
mbed_official 87:085cde657901 333 */
mbed_official 87:085cde657901 334
mbed_official 87:085cde657901 335 /**
mbed_official 87:085cde657901 336 * @}
mbed_official 87:085cde657901 337 */
mbed_official 87:085cde657901 338
mbed_official 87:085cde657901 339 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/