mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_ELMO_F411RE/TOOLCHAIN_GCC_ARM/stm32f4xx_hal_crc.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 163:e59c8e839560 1 /**
AnnaBridge 163:e59c8e839560 2 ******************************************************************************
AnnaBridge 163:e59c8e839560 3 * @file stm32f4xx_hal_crc.h
AnnaBridge 163:e59c8e839560 4 * @author MCD Application Team
AnnaBridge 163:e59c8e839560 5 * @brief Header file of CRC HAL module.
AnnaBridge 163:e59c8e839560 6 ******************************************************************************
AnnaBridge 163:e59c8e839560 7 * @attention
AnnaBridge 163:e59c8e839560 8 *
AnnaBridge 163:e59c8e839560 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 163:e59c8e839560 10 *
AnnaBridge 163:e59c8e839560 11 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 163:e59c8e839560 12 * are permitted provided that the following conditions are met:
AnnaBridge 163:e59c8e839560 13 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 163:e59c8e839560 14 * this list of conditions and the following disclaimer.
AnnaBridge 163:e59c8e839560 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 163:e59c8e839560 16 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 163:e59c8e839560 17 * and/or other materials provided with the distribution.
AnnaBridge 163:e59c8e839560 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 163:e59c8e839560 19 * may be used to endorse or promote products derived from this software
AnnaBridge 163:e59c8e839560 20 * without specific prior written permission.
AnnaBridge 163:e59c8e839560 21 *
AnnaBridge 163:e59c8e839560 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 163:e59c8e839560 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 163:e59c8e839560 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 163:e59c8e839560 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 163:e59c8e839560 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 163:e59c8e839560 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 163:e59c8e839560 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 163:e59c8e839560 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 163:e59c8e839560 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 163:e59c8e839560 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 163:e59c8e839560 32 *
AnnaBridge 163:e59c8e839560 33 ******************************************************************************
AnnaBridge 163:e59c8e839560 34 */
AnnaBridge 163:e59c8e839560 35
AnnaBridge 163:e59c8e839560 36 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 163:e59c8e839560 37 #ifndef __STM32F4xx_HAL_CRC_H
AnnaBridge 163:e59c8e839560 38 #define __STM32F4xx_HAL_CRC_H
AnnaBridge 163:e59c8e839560 39
AnnaBridge 163:e59c8e839560 40 #ifdef __cplusplus
AnnaBridge 163:e59c8e839560 41 extern "C" {
AnnaBridge 163:e59c8e839560 42 #endif
AnnaBridge 163:e59c8e839560 43
AnnaBridge 163:e59c8e839560 44 /* Includes ------------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 45 #include "stm32f4xx_hal_def.h"
AnnaBridge 163:e59c8e839560 46
AnnaBridge 163:e59c8e839560 47 /** @addtogroup STM32F4xx_HAL_Driver
AnnaBridge 163:e59c8e839560 48 * @{
AnnaBridge 163:e59c8e839560 49 */
AnnaBridge 163:e59c8e839560 50
AnnaBridge 163:e59c8e839560 51 /** @defgroup CRC CRC
AnnaBridge 163:e59c8e839560 52 * @brief CRC HAL module driver
AnnaBridge 163:e59c8e839560 53 * @{
AnnaBridge 163:e59c8e839560 54 */
AnnaBridge 163:e59c8e839560 55
AnnaBridge 163:e59c8e839560 56 /* Exported types ------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 57 /** @defgroup CRC_Exported_Types CRC Exported Types
AnnaBridge 163:e59c8e839560 58 * @{
AnnaBridge 163:e59c8e839560 59 */
AnnaBridge 163:e59c8e839560 60
AnnaBridge 163:e59c8e839560 61 /** @defgroup CRC_Exported_Types_Group1 CRC State Structure definition
AnnaBridge 163:e59c8e839560 62 * @{
AnnaBridge 163:e59c8e839560 63 */
AnnaBridge 163:e59c8e839560 64 typedef enum
AnnaBridge 163:e59c8e839560 65 {
AnnaBridge 163:e59c8e839560 66 HAL_CRC_STATE_RESET = 0x00U, /*!< CRC not yet initialized or disabled */
AnnaBridge 163:e59c8e839560 67 HAL_CRC_STATE_READY = 0x01U, /*!< CRC initialized and ready for use */
AnnaBridge 163:e59c8e839560 68 HAL_CRC_STATE_BUSY = 0x02U, /*!< CRC internal process is ongoing */
AnnaBridge 163:e59c8e839560 69 HAL_CRC_STATE_TIMEOUT = 0x03U, /*!< CRC timeout state */
AnnaBridge 163:e59c8e839560 70 HAL_CRC_STATE_ERROR = 0x04U /*!< CRC error state */
AnnaBridge 163:e59c8e839560 71
AnnaBridge 163:e59c8e839560 72 }HAL_CRC_StateTypeDef;
AnnaBridge 163:e59c8e839560 73 /**
AnnaBridge 163:e59c8e839560 74 * @}
AnnaBridge 163:e59c8e839560 75 */
AnnaBridge 163:e59c8e839560 76
AnnaBridge 163:e59c8e839560 77 /** @defgroup CRC_Exported_Types_Group2 CRC Handle Structure definition
AnnaBridge 163:e59c8e839560 78 * @{
AnnaBridge 163:e59c8e839560 79 */
AnnaBridge 163:e59c8e839560 80 typedef struct
AnnaBridge 163:e59c8e839560 81 {
AnnaBridge 163:e59c8e839560 82 CRC_TypeDef *Instance; /*!< Register base address */
AnnaBridge 163:e59c8e839560 83
AnnaBridge 163:e59c8e839560 84 HAL_LockTypeDef Lock; /*!< CRC locking object */
AnnaBridge 163:e59c8e839560 85
AnnaBridge 163:e59c8e839560 86 __IO HAL_CRC_StateTypeDef State; /*!< CRC communication state */
AnnaBridge 163:e59c8e839560 87
AnnaBridge 163:e59c8e839560 88 }CRC_HandleTypeDef;
AnnaBridge 163:e59c8e839560 89 /**
AnnaBridge 163:e59c8e839560 90 * @}
AnnaBridge 163:e59c8e839560 91 */
AnnaBridge 163:e59c8e839560 92
AnnaBridge 163:e59c8e839560 93 /**
AnnaBridge 163:e59c8e839560 94 * @}
AnnaBridge 163:e59c8e839560 95 */
AnnaBridge 163:e59c8e839560 96
AnnaBridge 163:e59c8e839560 97 /* Exported constants --------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 98 /* Exported macro ------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 99 /** @defgroup CRC_Exported_Macros CRC Exported Macros
AnnaBridge 163:e59c8e839560 100 * @{
AnnaBridge 163:e59c8e839560 101 */
AnnaBridge 163:e59c8e839560 102
AnnaBridge 163:e59c8e839560 103 /** @brief Resets CRC handle state
AnnaBridge 163:e59c8e839560 104 * @param __HANDLE__ CRC handle
AnnaBridge 163:e59c8e839560 105 * @retval None
AnnaBridge 163:e59c8e839560 106 */
AnnaBridge 163:e59c8e839560 107 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
AnnaBridge 163:e59c8e839560 108
AnnaBridge 163:e59c8e839560 109 /**
AnnaBridge 163:e59c8e839560 110 * @brief Resets CRC Data Register.
AnnaBridge 163:e59c8e839560 111 * @param __HANDLE__ CRC handle
AnnaBridge 163:e59c8e839560 112 * @retval None
AnnaBridge 163:e59c8e839560 113 */
AnnaBridge 163:e59c8e839560 114 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
AnnaBridge 163:e59c8e839560 115
AnnaBridge 163:e59c8e839560 116 /**
AnnaBridge 163:e59c8e839560 117 * @brief Stores a 8-bit data in the Independent Data(ID) register.
AnnaBridge 163:e59c8e839560 118 * @param __HANDLE__ CRC handle
AnnaBridge 163:e59c8e839560 119 * @param __VALUE__ 8-bit value to be stored in the ID register
AnnaBridge 163:e59c8e839560 120 * @retval None
AnnaBridge 163:e59c8e839560 121 */
AnnaBridge 163:e59c8e839560 122 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, (__VALUE__)))
AnnaBridge 163:e59c8e839560 123
AnnaBridge 163:e59c8e839560 124 /**
AnnaBridge 163:e59c8e839560 125 * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
AnnaBridge 163:e59c8e839560 126 * @param __HANDLE__ CRC handle
AnnaBridge 163:e59c8e839560 127 * @retval 8-bit value of the ID register
AnnaBridge 163:e59c8e839560 128 */
AnnaBridge 163:e59c8e839560 129 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
AnnaBridge 163:e59c8e839560 130 /**
AnnaBridge 163:e59c8e839560 131 * @}
AnnaBridge 163:e59c8e839560 132 */
AnnaBridge 163:e59c8e839560 133
AnnaBridge 163:e59c8e839560 134 /* Exported functions --------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 135 /** @defgroup CRC_Exported_Functions CRC Exported Functions
AnnaBridge 163:e59c8e839560 136 * @{
AnnaBridge 163:e59c8e839560 137 */
AnnaBridge 163:e59c8e839560 138
AnnaBridge 163:e59c8e839560 139 /** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
AnnaBridge 163:e59c8e839560 140 * @{
AnnaBridge 163:e59c8e839560 141 */
AnnaBridge 163:e59c8e839560 142 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
AnnaBridge 163:e59c8e839560 143 HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
AnnaBridge 163:e59c8e839560 144 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
AnnaBridge 163:e59c8e839560 145 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
AnnaBridge 163:e59c8e839560 146 /**
AnnaBridge 163:e59c8e839560 147 * @}
AnnaBridge 163:e59c8e839560 148 */
AnnaBridge 163:e59c8e839560 149
AnnaBridge 163:e59c8e839560 150 /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
AnnaBridge 163:e59c8e839560 151 * @{
AnnaBridge 163:e59c8e839560 152 */
AnnaBridge 163:e59c8e839560 153 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
AnnaBridge 163:e59c8e839560 154 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
AnnaBridge 163:e59c8e839560 155 /**
AnnaBridge 163:e59c8e839560 156 * @}
AnnaBridge 163:e59c8e839560 157 */
AnnaBridge 163:e59c8e839560 158
AnnaBridge 163:e59c8e839560 159 /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
AnnaBridge 163:e59c8e839560 160 * @{
AnnaBridge 163:e59c8e839560 161 */
AnnaBridge 163:e59c8e839560 162 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
AnnaBridge 163:e59c8e839560 163 /**
AnnaBridge 163:e59c8e839560 164 * @}
AnnaBridge 163:e59c8e839560 165 */
AnnaBridge 163:e59c8e839560 166
AnnaBridge 163:e59c8e839560 167 /**
AnnaBridge 163:e59c8e839560 168 * @}
AnnaBridge 163:e59c8e839560 169 */
AnnaBridge 163:e59c8e839560 170 /* Private types -------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 171 /** @defgroup CRC_Private_Types CRC Private Types
AnnaBridge 163:e59c8e839560 172 * @{
AnnaBridge 163:e59c8e839560 173 */
AnnaBridge 163:e59c8e839560 174
AnnaBridge 163:e59c8e839560 175 /**
AnnaBridge 163:e59c8e839560 176 * @}
AnnaBridge 163:e59c8e839560 177 */
AnnaBridge 163:e59c8e839560 178
AnnaBridge 163:e59c8e839560 179 /* Private defines -----------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 180 /** @defgroup CRC_Private_Defines CRC Private Defines
AnnaBridge 163:e59c8e839560 181 * @{
AnnaBridge 163:e59c8e839560 182 */
AnnaBridge 163:e59c8e839560 183
AnnaBridge 163:e59c8e839560 184 /**
AnnaBridge 163:e59c8e839560 185 * @}
AnnaBridge 163:e59c8e839560 186 */
AnnaBridge 163:e59c8e839560 187
AnnaBridge 163:e59c8e839560 188 /* Private variables ---------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 189 /** @defgroup CRC_Private_Variables CRC Private Variables
AnnaBridge 163:e59c8e839560 190 * @{
AnnaBridge 163:e59c8e839560 191 */
AnnaBridge 163:e59c8e839560 192
AnnaBridge 163:e59c8e839560 193 /**
AnnaBridge 163:e59c8e839560 194 * @}
AnnaBridge 163:e59c8e839560 195 */
AnnaBridge 163:e59c8e839560 196
AnnaBridge 163:e59c8e839560 197 /* Private constants ---------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 198 /** @defgroup CRC_Private_Constants CRC Private Constants
AnnaBridge 163:e59c8e839560 199 * @{
AnnaBridge 163:e59c8e839560 200 */
AnnaBridge 163:e59c8e839560 201
AnnaBridge 163:e59c8e839560 202 /**
AnnaBridge 163:e59c8e839560 203 * @}
AnnaBridge 163:e59c8e839560 204 */
AnnaBridge 163:e59c8e839560 205
AnnaBridge 163:e59c8e839560 206 /* Private macros ------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 207 /** @defgroup CRC_Private_Macros CRC Private Macros
AnnaBridge 163:e59c8e839560 208 * @{
AnnaBridge 163:e59c8e839560 209 */
AnnaBridge 163:e59c8e839560 210
AnnaBridge 163:e59c8e839560 211 /**
AnnaBridge 163:e59c8e839560 212 * @}
AnnaBridge 163:e59c8e839560 213 */
AnnaBridge 163:e59c8e839560 214
AnnaBridge 163:e59c8e839560 215 /* Private functions prototypes ----------------------------------------------*/
AnnaBridge 163:e59c8e839560 216 /** @defgroup CRC_Private_Functions_Prototypes CRC Private Functions Prototypes
AnnaBridge 163:e59c8e839560 217 * @{
AnnaBridge 163:e59c8e839560 218 */
AnnaBridge 163:e59c8e839560 219
AnnaBridge 163:e59c8e839560 220 /**
AnnaBridge 163:e59c8e839560 221 * @}
AnnaBridge 163:e59c8e839560 222 */
AnnaBridge 163:e59c8e839560 223
AnnaBridge 163:e59c8e839560 224 /* Private functions ---------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 225 /** @defgroup CRC_Private_Functions CRC Private Functions
AnnaBridge 163:e59c8e839560 226 * @{
AnnaBridge 163:e59c8e839560 227 */
AnnaBridge 163:e59c8e839560 228
AnnaBridge 163:e59c8e839560 229 /**
AnnaBridge 163:e59c8e839560 230 * @}
AnnaBridge 163:e59c8e839560 231 */
AnnaBridge 163:e59c8e839560 232
AnnaBridge 163:e59c8e839560 233 /**
AnnaBridge 163:e59c8e839560 234 * @}
AnnaBridge 163:e59c8e839560 235 */
AnnaBridge 163:e59c8e839560 236
AnnaBridge 163:e59c8e839560 237 /**
AnnaBridge 163:e59c8e839560 238 * @}
AnnaBridge 163:e59c8e839560 239 */
AnnaBridge 163:e59c8e839560 240
AnnaBridge 163:e59c8e839560 241 #ifdef __cplusplus
AnnaBridge 163:e59c8e839560 242 }
AnnaBridge 163:e59c8e839560 243 #endif
AnnaBridge 163:e59c8e839560 244
AnnaBridge 163:e59c8e839560 245 #endif /* __STM32F4xx_HAL_CRC_H */
AnnaBridge 163:e59c8e839560 246
AnnaBridge 163:e59c8e839560 247 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/