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_F411RE/stm32f4xx_hal_crc.h@323:9e901b0a5aa1, 2014-09-13 (annotated)

Committer:
shaoziyang
Date:
Sat Sep 13 14:25:46 2014 +0000
Revision:
323:9e901b0a5aa1
Parent:
235:685d5f11838f 
test with CLOCK_SETUP = 0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 235:685d5f11838f 1 /**
mbed_official 235:685d5f11838f 2 ******************************************************************************
mbed_official 235:685d5f11838f 3 * @file stm32f4xx_hal_crc.h
mbed_official 235:685d5f11838f 4 * @author MCD Application Team
mbed_official 235:685d5f11838f 5 * @version V1.1.0
mbed_official 235:685d5f11838f 6 * @date 19-June-2014
mbed_official 235:685d5f11838f 7 * @brief Header file of CRC HAL module.
mbed_official 235:685d5f11838f 8 ******************************************************************************
mbed_official 235:685d5f11838f 9 * @attention
mbed_official 235:685d5f11838f 10 *
mbed_official 235:685d5f11838f 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 235:685d5f11838f 12 *
mbed_official 235:685d5f11838f 13 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 235:685d5f11838f 14 * are permitted provided that the following conditions are met:
mbed_official 235:685d5f11838f 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 235:685d5f11838f 16 * this list of conditions and the following disclaimer.
mbed_official 235:685d5f11838f 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 235:685d5f11838f 18 * this list of conditions and the following disclaimer in the documentation
mbed_official 235:685d5f11838f 19 * and/or other materials provided with the distribution.
mbed_official 235:685d5f11838f 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 235:685d5f11838f 21 * may be used to endorse or promote products derived from this software
mbed_official 235:685d5f11838f 22 * without specific prior written permission.
mbed_official 235:685d5f11838f 23 *
mbed_official 235:685d5f11838f 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 235:685d5f11838f 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 235:685d5f11838f 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 235:685d5f11838f 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 235:685d5f11838f 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 235:685d5f11838f 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 235:685d5f11838f 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 235:685d5f11838f 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 235:685d5f11838f 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 235:685d5f11838f 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 235:685d5f11838f 34 *
mbed_official 235:685d5f11838f 35 ******************************************************************************
mbed_official 235:685d5f11838f 36 */
mbed_official 235:685d5f11838f 37
mbed_official 235:685d5f11838f 38 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 235:685d5f11838f 39 #ifndef __STM32F4xx_HAL_CRC_H
mbed_official 235:685d5f11838f 40 #define __STM32F4xx_HAL_CRC_H
mbed_official 235:685d5f11838f 41
mbed_official 235:685d5f11838f 42 #ifdef __cplusplus
mbed_official 235:685d5f11838f 43 extern "C" {
mbed_official 235:685d5f11838f 44 #endif
mbed_official 235:685d5f11838f 45
mbed_official 235:685d5f11838f 46 /* Includes ------------------------------------------------------------------*/
mbed_official 235:685d5f11838f 47 #include "stm32f4xx_hal_def.h"
mbed_official 235:685d5f11838f 48
mbed_official 235:685d5f11838f 49 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 235:685d5f11838f 50 * @{
mbed_official 235:685d5f11838f 51 */
mbed_official 235:685d5f11838f 52
mbed_official 235:685d5f11838f 53 /** @addtogroup CRC
mbed_official 235:685d5f11838f 54 * @{
mbed_official 235:685d5f11838f 55 */
mbed_official 235:685d5f11838f 56
mbed_official 235:685d5f11838f 57 /* Exported types ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 58
mbed_official 235:685d5f11838f 59 /**
mbed_official 235:685d5f11838f 60 * @brief CRC HAL State Structure definition
mbed_official 235:685d5f11838f 61 */
mbed_official 235:685d5f11838f 62 typedef enum
mbed_official 235:685d5f11838f 63 {
mbed_official 235:685d5f11838f 64 HAL_CRC_STATE_RESET = 0x00, /*!< CRC not yet initialized or disabled */
mbed_official 235:685d5f11838f 65 HAL_CRC_STATE_READY = 0x01, /*!< CRC initialized and ready for use */
mbed_official 235:685d5f11838f 66 HAL_CRC_STATE_BUSY = 0x02, /*!< CRC internal process is ongoing */
mbed_official 235:685d5f11838f 67 HAL_CRC_STATE_TIMEOUT = 0x03, /*!< CRC timeout state */
mbed_official 235:685d5f11838f 68 HAL_CRC_STATE_ERROR = 0x04 /*!< CRC error state */
mbed_official 235:685d5f11838f 69
mbed_official 235:685d5f11838f 70 }HAL_CRC_StateTypeDef;
mbed_official 235:685d5f11838f 71
mbed_official 235:685d5f11838f 72 /**
mbed_official 235:685d5f11838f 73 * @brief CRC handle Structure definition
mbed_official 235:685d5f11838f 74 */
mbed_official 235:685d5f11838f 75 typedef struct
mbed_official 235:685d5f11838f 76 {
mbed_official 235:685d5f11838f 77 CRC_TypeDef *Instance; /*!< Register base address */
mbed_official 235:685d5f11838f 78
mbed_official 235:685d5f11838f 79 HAL_LockTypeDef Lock; /*!< CRC locking object */
mbed_official 235:685d5f11838f 80
mbed_official 235:685d5f11838f 81 __IO HAL_CRC_StateTypeDef State; /*!< CRC communication state */
mbed_official 235:685d5f11838f 82
mbed_official 235:685d5f11838f 83 }CRC_HandleTypeDef;
mbed_official 235:685d5f11838f 84
mbed_official 235:685d5f11838f 85 /* Exported constants --------------------------------------------------------*/
mbed_official 235:685d5f11838f 86 /* Exported macro ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 87
mbed_official 235:685d5f11838f 88 /** @brief Reset CRC handle state
mbed_official 235:685d5f11838f 89 * @param __HANDLE__: CRC handle
mbed_official 235:685d5f11838f 90 * @retval None
mbed_official 235:685d5f11838f 91 */
mbed_official 235:685d5f11838f 92 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
mbed_official 235:685d5f11838f 93
mbed_official 235:685d5f11838f 94 /**
mbed_official 235:685d5f11838f 95 * @brief Resets CRC Data Register.
mbed_official 235:685d5f11838f 96 * @param __HANDLE__: CRC handle
mbed_official 235:685d5f11838f 97 * @retval None
mbed_official 235:685d5f11838f 98 */
mbed_official 235:685d5f11838f 99 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
mbed_official 235:685d5f11838f 100
mbed_official 235:685d5f11838f 101 /**
mbed_official 235:685d5f11838f 102 * @brief Stores a 8-bit data in the Independent Data(ID) register.
mbed_official 235:685d5f11838f 103 * @param __HANDLE__: CRC handle
mbed_official 235:685d5f11838f 104 * @param __VALUE: 8-bit value to be stored in the ID register
mbed_official 235:685d5f11838f 105 * @retval None
mbed_official 235:685d5f11838f 106 */
mbed_official 235:685d5f11838f 107 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (MODIFY_REG((__HANDLE__)->Instance->IDR, CRC_IDR_IDR, (__VALUE__))
mbed_official 235:685d5f11838f 108
mbed_official 235:685d5f11838f 109 /**
mbed_official 235:685d5f11838f 110 * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
mbed_official 235:685d5f11838f 111 * @param __HANDLE__: CRC handle
mbed_official 235:685d5f11838f 112 * @retval 8-bit value of the ID register
mbed_official 235:685d5f11838f 113 */
mbed_official 235:685d5f11838f 114 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
mbed_official 235:685d5f11838f 115
mbed_official 235:685d5f11838f 116 /* Exported functions --------------------------------------------------------*/
mbed_official 235:685d5f11838f 117
mbed_official 235:685d5f11838f 118 /* Initialization/de-initialization functions **********************************/
mbed_official 235:685d5f11838f 119 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
mbed_official 235:685d5f11838f 120 HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
mbed_official 235:685d5f11838f 121 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
mbed_official 235:685d5f11838f 122 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
mbed_official 235:685d5f11838f 123
mbed_official 235:685d5f11838f 124 /* Peripheral Control functions ************************************************/
mbed_official 235:685d5f11838f 125 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
mbed_official 235:685d5f11838f 126 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
mbed_official 235:685d5f11838f 127
mbed_official 235:685d5f11838f 128 /* Peripheral State functions **************************************************/
mbed_official 235:685d5f11838f 129 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
mbed_official 235:685d5f11838f 130
mbed_official 235:685d5f11838f 131 /**
mbed_official 235:685d5f11838f 132 * @}
mbed_official 235:685d5f11838f 133 */
mbed_official 235:685d5f11838f 134
mbed_official 235:685d5f11838f 135 /**
mbed_official 235:685d5f11838f 136 * @}
mbed_official 235:685d5f11838f 137 */
mbed_official 235:685d5f11838f 138
mbed_official 235:685d5f11838f 139 #ifdef __cplusplus
mbed_official 235:685d5f11838f 140 }
mbed_official 235:685d5f11838f 141 #endif
mbed_official 235:685d5f11838f 142
mbed_official 235:685d5f11838f 143 #endif /* __STM32F4xx_HAL_CRC_H */
mbed_official 235:685d5f11838f 144
mbed_official 235:685d5f11838f 145 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/