Gan likun / mbed1-dev

001

targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_crc.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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