Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F446RE/stm32f4xx_hal_crc.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b 
.

Who changed what in which revision?

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