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_MTS_MDOT_F411RE/stm32f4xx_hal_crc.h@99:dbbf35b96557, 2015-05-13 (annotated)

Committer:
Kojto
Date:
Wed May 13 08:08:21 2015 +0200
Revision:
99:dbbf35b96557
Parent:
93:e188a91d3eaa
Child:
106:ba1f97679dad
Release 99 of the mbed library



Changes:

 - new targets - MAXWSNENV, DISCO_L053C8

 - STM32F4xx - ST Cube driver

 - KSDK mcu - SPI timing fix

 - Nordic - update to softdevice s130

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 93:e188a91d3eaa 1 /**
Kojto 93:e188a91d3eaa 2 ******************************************************************************
Kojto 93:e188a91d3eaa 3 * @file stm32f4xx_hal_crc.h
Kojto 93:e188a91d3eaa 4 * @author MCD Application Team
Kojto 99:dbbf35b96557 5 * @version V1.3.0
Kojto 99:dbbf35b96557 6 * @date 09-March-2015
Kojto 93:e188a91d3eaa 7 * @brief Header file of CRC HAL module.
Kojto 93:e188a91d3eaa 8 ******************************************************************************
Kojto 93:e188a91d3eaa 9 * @attention
Kojto 93:e188a91d3eaa 10 *
Kojto 99:dbbf35b96557 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 93:e188a91d3eaa 12 *
Kojto 93:e188a91d3eaa 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 93:e188a91d3eaa 14 * are permitted provided that the following conditions are met:
Kojto 93:e188a91d3eaa 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 93:e188a91d3eaa 16 * this list of conditions and the following disclaimer.
Kojto 93:e188a91d3eaa 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 93:e188a91d3eaa 18 * this list of conditions and the following disclaimer in the documentation
Kojto 93:e188a91d3eaa 19 * and/or other materials provided with the distribution.
Kojto 93:e188a91d3eaa 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 93:e188a91d3eaa 21 * may be used to endorse or promote products derived from this software
Kojto 93:e188a91d3eaa 22 * without specific prior written permission.
Kojto 93:e188a91d3eaa 23 *
Kojto 93:e188a91d3eaa 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 93:e188a91d3eaa 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 93:e188a91d3eaa 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 93:e188a91d3eaa 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 93:e188a91d3eaa 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 93:e188a91d3eaa 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 93:e188a91d3eaa 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 93:e188a91d3eaa 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 93:e188a91d3eaa 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 93:e188a91d3eaa 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 93:e188a91d3eaa 34 *
Kojto 93:e188a91d3eaa 35 ******************************************************************************
Kojto 93:e188a91d3eaa 36 */
Kojto 93:e188a91d3eaa 37
Kojto 93:e188a91d3eaa 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 93:e188a91d3eaa 39 #ifndef __STM32F4xx_HAL_CRC_H
Kojto 93:e188a91d3eaa 40 #define __STM32F4xx_HAL_CRC_H
Kojto 93:e188a91d3eaa 41
Kojto 93:e188a91d3eaa 42 #ifdef __cplusplus
Kojto 93:e188a91d3eaa 43 extern "C" {
Kojto 93:e188a91d3eaa 44 #endif
Kojto 93:e188a91d3eaa 45
Kojto 93:e188a91d3eaa 46 /* Includes ------------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 47 #include "stm32f4xx_hal_def.h"
Kojto 93:e188a91d3eaa 48
Kojto 93:e188a91d3eaa 49 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 93:e188a91d3eaa 50 * @{
Kojto 93:e188a91d3eaa 51 */
Kojto 93:e188a91d3eaa 52
Kojto 99:dbbf35b96557 53 /** @defgroup CRC CRC
Kojto 99:dbbf35b96557 54 * @brief CRC HAL module driver
Kojto 93:e188a91d3eaa 55 * @{
Kojto 99:dbbf35b96557 56 */
Kojto 93:e188a91d3eaa 57
Kojto 93:e188a91d3eaa 58 /* Exported types ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 59 /** @defgroup CRC_Exported_Types CRC Exported Types
Kojto 99:dbbf35b96557 60 * @{
Kojto 99:dbbf35b96557 61 */
Kojto 93:e188a91d3eaa 62
Kojto 99:dbbf35b96557 63 /** @defgroup CRC_Exported_Types_Group1 CRC State Structure definition
Kojto 99:dbbf35b96557 64 * @{
Kojto 99:dbbf35b96557 65 */
Kojto 93:e188a91d3eaa 66 typedef enum
Kojto 93:e188a91d3eaa 67 {
Kojto 93:e188a91d3eaa 68 HAL_CRC_STATE_RESET = 0x00, /*!< CRC not yet initialized or disabled */
Kojto 93:e188a91d3eaa 69 HAL_CRC_STATE_READY = 0x01, /*!< CRC initialized and ready for use */
Kojto 93:e188a91d3eaa 70 HAL_CRC_STATE_BUSY = 0x02, /*!< CRC internal process is ongoing */
Kojto 93:e188a91d3eaa 71 HAL_CRC_STATE_TIMEOUT = 0x03, /*!< CRC timeout state */
Kojto 93:e188a91d3eaa 72 HAL_CRC_STATE_ERROR = 0x04 /*!< CRC error state */
Kojto 93:e188a91d3eaa 73
Kojto 93:e188a91d3eaa 74 }HAL_CRC_StateTypeDef;
Kojto 99:dbbf35b96557 75 /**
Kojto 99:dbbf35b96557 76 * @}
Kojto 99:dbbf35b96557 77 */
Kojto 93:e188a91d3eaa 78
Kojto 99:dbbf35b96557 79 /** @defgroup CRC_Exported_Types_Group2 CRC Handle Structure definition
Kojto 99:dbbf35b96557 80 * @{
Kojto 93:e188a91d3eaa 81 */
Kojto 93:e188a91d3eaa 82 typedef struct
Kojto 93:e188a91d3eaa 83 {
Kojto 93:e188a91d3eaa 84 CRC_TypeDef *Instance; /*!< Register base address */
Kojto 93:e188a91d3eaa 85
Kojto 93:e188a91d3eaa 86 HAL_LockTypeDef Lock; /*!< CRC locking object */
Kojto 93:e188a91d3eaa 87
Kojto 93:e188a91d3eaa 88 __IO HAL_CRC_StateTypeDef State; /*!< CRC communication state */
Kojto 93:e188a91d3eaa 89
Kojto 93:e188a91d3eaa 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 */
Kojto 93:e188a91d3eaa 98
Kojto 93:e188a91d3eaa 99 /* Exported constants --------------------------------------------------------*/
Kojto 93:e188a91d3eaa 100 /* Exported macro ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 101 /** @defgroup CRC_Exported_Macros CRC Exported Macros
Kojto 99:dbbf35b96557 102 * @{
Kojto 99:dbbf35b96557 103 */
Kojto 93:e188a91d3eaa 104
Kojto 99:dbbf35b96557 105 /** @brief Resets CRC handle state
Kojto 93:e188a91d3eaa 106 * @param __HANDLE__: CRC handle
Kojto 93:e188a91d3eaa 107 * @retval None
Kojto 93:e188a91d3eaa 108 */
Kojto 93:e188a91d3eaa 109 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
Kojto 93:e188a91d3eaa 110
Kojto 93:e188a91d3eaa 111 /**
Kojto 93:e188a91d3eaa 112 * @brief Resets CRC Data Register.
Kojto 93:e188a91d3eaa 113 * @param __HANDLE__: CRC handle
Kojto 93:e188a91d3eaa 114 * @retval None
Kojto 93:e188a91d3eaa 115 */
Kojto 93:e188a91d3eaa 116 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
Kojto 93:e188a91d3eaa 117
Kojto 93:e188a91d3eaa 118 /**
Kojto 93:e188a91d3eaa 119 * @brief Stores a 8-bit data in the Independent Data(ID) register.
Kojto 93:e188a91d3eaa 120 * @param __HANDLE__: CRC handle
Kojto 99:dbbf35b96557 121 * @param __VALUE__: 8-bit value to be stored in the ID register
Kojto 93:e188a91d3eaa 122 * @retval None
Kojto 93:e188a91d3eaa 123 */
Kojto 93:e188a91d3eaa 124 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (MODIFY_REG((__HANDLE__)->Instance->IDR, CRC_IDR_IDR, (__VALUE__))
Kojto 93:e188a91d3eaa 125
Kojto 93:e188a91d3eaa 126 /**
Kojto 93:e188a91d3eaa 127 * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
Kojto 93:e188a91d3eaa 128 * @param __HANDLE__: CRC handle
Kojto 93:e188a91d3eaa 129 * @retval 8-bit value of the ID register
Kojto 93:e188a91d3eaa 130 */
Kojto 93:e188a91d3eaa 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 */
Kojto 93:e188a91d3eaa 135
Kojto 93:e188a91d3eaa 136 /* Exported functions --------------------------------------------------------*/
Kojto 99:dbbf35b96557 137 /** @defgroup CRC_Exported_Functions CRC Exported Functions
Kojto 99:dbbf35b96557 138 * @{
Kojto 99:dbbf35b96557 139 */
Kojto 93:e188a91d3eaa 140
Kojto 99:dbbf35b96557 141 /** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
Kojto 99:dbbf35b96557 142 * @{
Kojto 99:dbbf35b96557 143 */
Kojto 93:e188a91d3eaa 144 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
Kojto 93:e188a91d3eaa 145 HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
Kojto 93:e188a91d3eaa 146 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
Kojto 93:e188a91d3eaa 147 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
Kojto 99:dbbf35b96557 148 /**
Kojto 99:dbbf35b96557 149 * @}
Kojto 99:dbbf35b96557 150 */
Kojto 93:e188a91d3eaa 151
Kojto 99:dbbf35b96557 152 /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
Kojto 99:dbbf35b96557 153 * @{
Kojto 99:dbbf35b96557 154 */
Kojto 93:e188a91d3eaa 155 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
Kojto 93:e188a91d3eaa 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 */
Kojto 93:e188a91d3eaa 160
Kojto 99:dbbf35b96557 161 /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
Kojto 99:dbbf35b96557 162 * @{
Kojto 99:dbbf35b96557 163 */
Kojto 93:e188a91d3eaa 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 */
Kojto 93:e188a91d3eaa 234
Kojto 93:e188a91d3eaa 235 /**
Kojto 93:e188a91d3eaa 236 * @}
Kojto 93:e188a91d3eaa 237 */
Kojto 93:e188a91d3eaa 238
Kojto 93:e188a91d3eaa 239 /**
Kojto 93:e188a91d3eaa 240 * @}
Kojto 99:dbbf35b96557 241 */
Kojto 99:dbbf35b96557 242
Kojto 93:e188a91d3eaa 243 #ifdef __cplusplus
Kojto 93:e188a91d3eaa 244 }
Kojto 93:e188a91d3eaa 245 #endif
Kojto 93:e188a91d3eaa 246
Kojto 93:e188a91d3eaa 247 #endif /* __STM32F4xx_HAL_CRC_H */
Kojto 93:e188a91d3eaa 248
Kojto 93:e188a91d3eaa 249 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/