Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_MTS_MDOT_F405RG/stm32f4xx_hal_crc.h@110:165afa46840b, 2015-11-25 (annotated)

Committer:
Kojto
Date:
Wed Nov 25 13:21:40 2015 +0000
Revision:
110:165afa46840b
Parent:
106:ba1f97679dad 
Release 110  of the mbed library



Changes:

- new platforms - STM32F410R, DISCO_F429ZI, DISCO_F469NI

- Nucleo L476 - gcc and uvision template

- k22,k64f targets - ADC channels A addition

- EFM32 - bugfixes in sleep, serial and spi

- Delta DFCM NNN40 - pinnames update

Who changed what in which revision?

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