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