test / mbed-src

mbed library sources

Dependents:   bare

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_crc.c@106:ced8cbb51063, 2014-02-26 (annotated)

Committer:
mbed_official
Date:
Wed Feb 26 09:45:12 2014 +0000
Revision:
106:ced8cbb51063
Parent:
87:085cde657901 
Synchronized with git revision 4222735eff5868389433f0e9271976b39c8115cd



Full URL: https://github.com/mbedmicro/mbed/commit/4222735eff5868389433f0e9271976b39c8115cd/



[NUCLEO_xxx] Update STM32CubeF4 driver V1.0.0 + update license

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 106:ced8cbb51063 5 * @version V1.0.0
mbed_official 106:ced8cbb51063 6 * @date 18-February-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 87:085cde657901 108 * @param hcrc: CRC handle
mbed_official 87:085cde657901 109 * @retval HAL status
mbed_official 87:085cde657901 110 */
mbed_official 87:085cde657901 111 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 112 {
mbed_official 87:085cde657901 113 /* Check the CRC handle allocation */
mbed_official 87:085cde657901 114 if(hcrc == NULL)
mbed_official 87:085cde657901 115 {
mbed_official 87:085cde657901 116 return HAL_ERROR;
mbed_official 87:085cde657901 117 }
mbed_official 87:085cde657901 118
mbed_official 87:085cde657901 119 /* Check the parameters */
mbed_official 87:085cde657901 120 assert_param(IS_CRC_ALL_INSTANCE(hcrc->Instance));
mbed_official 87:085cde657901 121
mbed_official 87:085cde657901 122 if(hcrc->State == HAL_CRC_STATE_RESET)
mbed_official 87:085cde657901 123 {
mbed_official 87:085cde657901 124 /* Init the low level hardware */
mbed_official 87:085cde657901 125 HAL_CRC_MspInit(hcrc);
mbed_official 87:085cde657901 126 }
mbed_official 87:085cde657901 127
mbed_official 87:085cde657901 128 /* Change CRC peripheral state */
mbed_official 87:085cde657901 129 hcrc->State = HAL_CRC_STATE_BUSY;
mbed_official 87:085cde657901 130
mbed_official 87:085cde657901 131 /* Change CRC peripheral state */
mbed_official 87:085cde657901 132 hcrc->State = HAL_CRC_STATE_READY;
mbed_official 87:085cde657901 133
mbed_official 87:085cde657901 134 /* Return function status */
mbed_official 87:085cde657901 135 return HAL_OK;
mbed_official 87:085cde657901 136 }
mbed_official 87:085cde657901 137
mbed_official 87:085cde657901 138 /**
mbed_official 87:085cde657901 139 * @brief DeInitializes the CRC peripheral.
mbed_official 87:085cde657901 140 * @param hcrc: CRC handle
mbed_official 87:085cde657901 141 * @retval HAL status
mbed_official 87:085cde657901 142 */
mbed_official 87:085cde657901 143 HAL_StatusTypeDef HAL_CRC_DeInit(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 144 {
mbed_official 87:085cde657901 145 /* Check the CRC handle allocation */
mbed_official 87:085cde657901 146 if(hcrc == NULL)
mbed_official 87:085cde657901 147 {
mbed_official 87:085cde657901 148 return HAL_ERROR;
mbed_official 87:085cde657901 149 }
mbed_official 87:085cde657901 150
mbed_official 87:085cde657901 151 /* Check the parameters */
mbed_official 87:085cde657901 152 assert_param(IS_CRC_ALL_INSTANCE(hcrc->Instance));
mbed_official 87:085cde657901 153
mbed_official 87:085cde657901 154 /* Change CRC peripheral state */
mbed_official 87:085cde657901 155 hcrc->State = HAL_CRC_STATE_BUSY;
mbed_official 87:085cde657901 156
mbed_official 87:085cde657901 157 /* DeInit the low level hardware */
mbed_official 87:085cde657901 158 HAL_CRC_MspDeInit(hcrc);
mbed_official 87:085cde657901 159
mbed_official 87:085cde657901 160 /* Change CRC peripheral state */
mbed_official 87:085cde657901 161 hcrc->State = HAL_CRC_STATE_RESET;
mbed_official 87:085cde657901 162
mbed_official 106:ced8cbb51063 163 /* Release Lock */
mbed_official 106:ced8cbb51063 164 __HAL_UNLOCK(hcrc);
mbed_official 106:ced8cbb51063 165
mbed_official 87:085cde657901 166 /* Return function status */
mbed_official 87:085cde657901 167 return HAL_OK;
mbed_official 87:085cde657901 168 }
mbed_official 87:085cde657901 169
mbed_official 87:085cde657901 170 /**
mbed_official 87:085cde657901 171 * @brief Initializes the CRC MSP.
mbed_official 87:085cde657901 172 * @param hcrc: CRC handle
mbed_official 87:085cde657901 173 * @retval None
mbed_official 87:085cde657901 174 */
mbed_official 87:085cde657901 175 __weak void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 176 {
mbed_official 87:085cde657901 177 /* NOTE : This function Should not be modified, when the callback is needed,
mbed_official 87:085cde657901 178 the HAL_CRC_MspInit could be implemented in the user file
mbed_official 87:085cde657901 179 */
mbed_official 87:085cde657901 180 }
mbed_official 87:085cde657901 181
mbed_official 87:085cde657901 182 /**
mbed_official 87:085cde657901 183 * @brief DeInitializes the CRC MSP.
mbed_official 87:085cde657901 184 * @param hcrc: CRC handle
mbed_official 87:085cde657901 185 * @retval None
mbed_official 87:085cde657901 186 */
mbed_official 87:085cde657901 187 __weak void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 188 {
mbed_official 87:085cde657901 189 /* NOTE : This function Should not be modified, when the callback is needed,
mbed_official 87:085cde657901 190 the HAL_CRC_MspDeInit could be implemented in the user file
mbed_official 87:085cde657901 191 */
mbed_official 87:085cde657901 192 }
mbed_official 87:085cde657901 193
mbed_official 87:085cde657901 194 /**
mbed_official 87:085cde657901 195 * @}
mbed_official 87:085cde657901 196 */
mbed_official 87:085cde657901 197
mbed_official 87:085cde657901 198 /** @defgroup CRC_Group2 Peripheral Control functions
mbed_official 87:085cde657901 199 * @brief management functions.
mbed_official 87:085cde657901 200 *
mbed_official 87:085cde657901 201 @verbatim
mbed_official 87:085cde657901 202 ==============================================================================
mbed_official 87:085cde657901 203 ##### Peripheral Control functions #####
mbed_official 87:085cde657901 204 ==============================================================================
mbed_official 87:085cde657901 205 [..] This section provides functions allowing to:
mbed_official 87:085cde657901 206 (+) Compute the 32-bit CRC value of 32-bit data buffer,
mbed_official 87:085cde657901 207 using combination of the previous CRC value and the new one.
mbed_official 87:085cde657901 208 (+) Compute the 32-bit CRC value of 32-bit data buffer,
mbed_official 87:085cde657901 209 independently of the previous CRC value.
mbed_official 87:085cde657901 210
mbed_official 87:085cde657901 211 @endverbatim
mbed_official 87:085cde657901 212 * @{
mbed_official 87:085cde657901 213 */
mbed_official 87:085cde657901 214
mbed_official 87:085cde657901 215 /**
mbed_official 87:085cde657901 216 * @brief Computes the 32-bit CRC of 32-bit data buffer using combination
mbed_official 87:085cde657901 217 * of the previous CRC value and the new one.
mbed_official 87:085cde657901 218 * @param hcrc: CRC handle
mbed_official 87:085cde657901 219 * @param pBuffer: pointer to the buffer containing the data to be computed
mbed_official 87:085cde657901 220 * @param BufferLength: length of the buffer to be computed
mbed_official 87:085cde657901 221 * @retval 32-bit CRC
mbed_official 87:085cde657901 222 */
mbed_official 87:085cde657901 223 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength)
mbed_official 87:085cde657901 224 {
mbed_official 87:085cde657901 225 uint32_t index = 0;
mbed_official 87:085cde657901 226
mbed_official 87:085cde657901 227 /* Process Locked */
mbed_official 87:085cde657901 228 __HAL_LOCK(hcrc);
mbed_official 87:085cde657901 229
mbed_official 87:085cde657901 230 /* Change CRC peripheral state */
mbed_official 87:085cde657901 231 hcrc->State = HAL_CRC_STATE_BUSY;
mbed_official 87:085cde657901 232
mbed_official 87:085cde657901 233 /* Enter Data to the CRC calculator */
mbed_official 87:085cde657901 234 for(index = 0; index < BufferLength; index++)
mbed_official 87:085cde657901 235 {
mbed_official 87:085cde657901 236 hcrc->Instance->DR = pBuffer[index];
mbed_official 87:085cde657901 237 }
mbed_official 87:085cde657901 238
mbed_official 87:085cde657901 239 /* Change CRC peripheral state */
mbed_official 87:085cde657901 240 hcrc->State = HAL_CRC_STATE_READY;
mbed_official 87:085cde657901 241
mbed_official 87:085cde657901 242 /* Process Unlocked */
mbed_official 87:085cde657901 243 __HAL_UNLOCK(hcrc);
mbed_official 87:085cde657901 244
mbed_official 87:085cde657901 245 /* Return the CRC computed value */
mbed_official 87:085cde657901 246 return hcrc->Instance->DR;
mbed_official 87:085cde657901 247 }
mbed_official 87:085cde657901 248
mbed_official 87:085cde657901 249 /**
mbed_official 87:085cde657901 250 * @brief Computes the 32-bit CRC of 32-bit data buffer independently
mbed_official 87:085cde657901 251 * of the previous CRC value.
mbed_official 87:085cde657901 252 * @param hcrc: CRC handle
mbed_official 87:085cde657901 253 * @param pBuffer: Pointer to the buffer containing the data to be computed
mbed_official 87:085cde657901 254 * @param BufferLength: Length of the buffer to be computed
mbed_official 87:085cde657901 255 * @retval 32-bit CRC
mbed_official 87:085cde657901 256 */
mbed_official 87:085cde657901 257 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength)
mbed_official 87:085cde657901 258 {
mbed_official 87:085cde657901 259 uint32_t index = 0;
mbed_official 87:085cde657901 260
mbed_official 87:085cde657901 261 /* Process Locked */
mbed_official 87:085cde657901 262 __HAL_LOCK(hcrc);
mbed_official 87:085cde657901 263
mbed_official 87:085cde657901 264 /* Change CRC peripheral state */
mbed_official 87:085cde657901 265 hcrc->State = HAL_CRC_STATE_BUSY;
mbed_official 87:085cde657901 266
mbed_official 87:085cde657901 267 /* Reset CRC Calculation Unit */
mbed_official 87:085cde657901 268 __HAL_CRC_DR_RESET(hcrc);
mbed_official 87:085cde657901 269
mbed_official 87:085cde657901 270 /* Enter Data to the CRC calculator */
mbed_official 87:085cde657901 271 for(index = 0; index < BufferLength; index++)
mbed_official 87:085cde657901 272 {
mbed_official 87:085cde657901 273 hcrc->Instance->DR = pBuffer[index];
mbed_official 87:085cde657901 274 }
mbed_official 87:085cde657901 275
mbed_official 87:085cde657901 276 /* Change CRC peripheral state */
mbed_official 87:085cde657901 277 hcrc->State = HAL_CRC_STATE_READY;
mbed_official 87:085cde657901 278
mbed_official 87:085cde657901 279 /* Process Unlocked */
mbed_official 87:085cde657901 280 __HAL_UNLOCK(hcrc);
mbed_official 87:085cde657901 281
mbed_official 87:085cde657901 282 /* Return the CRC computed value */
mbed_official 87:085cde657901 283 return hcrc->Instance->DR;
mbed_official 87:085cde657901 284 }
mbed_official 87:085cde657901 285
mbed_official 87:085cde657901 286 /**
mbed_official 87:085cde657901 287 * @}
mbed_official 87:085cde657901 288 */
mbed_official 87:085cde657901 289
mbed_official 87:085cde657901 290 /** @defgroup CRC_Group3 Peripheral State functions
mbed_official 87:085cde657901 291 * @brief Peripheral State functions.
mbed_official 87:085cde657901 292 *
mbed_official 87:085cde657901 293 @verbatim
mbed_official 87:085cde657901 294 ==============================================================================
mbed_official 87:085cde657901 295 ##### Peripheral State functions #####
mbed_official 87:085cde657901 296 ==============================================================================
mbed_official 87:085cde657901 297 [..]
mbed_official 87:085cde657901 298 This subsection permits to get in run-time the status of the peripheral
mbed_official 87:085cde657901 299 and the data flow.
mbed_official 87:085cde657901 300
mbed_official 87:085cde657901 301 @endverbatim
mbed_official 87:085cde657901 302 * @{
mbed_official 87:085cde657901 303 */
mbed_official 87:085cde657901 304
mbed_official 87:085cde657901 305 /**
mbed_official 87:085cde657901 306 * @brief Returns the CRC state.
mbed_official 87:085cde657901 307 * @param hcrc: CRC handle
mbed_official 87:085cde657901 308 * @retval HAL state
mbed_official 87:085cde657901 309 */
mbed_official 87:085cde657901 310 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc)
mbed_official 87:085cde657901 311 {
mbed_official 87:085cde657901 312 return hcrc->State;
mbed_official 87:085cde657901 313 }
mbed_official 87:085cde657901 314
mbed_official 87:085cde657901 315 /**
mbed_official 87:085cde657901 316 * @}
mbed_official 87:085cde657901 317 */
mbed_official 87:085cde657901 318
mbed_official 87:085cde657901 319 /**
mbed_official 87:085cde657901 320 * @}
mbed_official 87:085cde657901 321 */
mbed_official 87:085cde657901 322
mbed_official 87:085cde657901 323 #endif /* HAL_CRC_MODULE_ENABLED */
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 */
mbed_official 87:085cde657901 331
mbed_official 87:085cde657901 332 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/