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