Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_crc.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

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