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_B96B_F446VE/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_crc.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
163:e59c8e839560 
mbed library. Release version 162

Who changed what in which revision?

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