| 1 | /**
|
|---|
| 2 | ******************************************************************************
|
|---|
| 3 | * @file stm32f4xx_hal_rng.h
|
|---|
| 4 | * @author MCD Application Team
|
|---|
| 5 | * @version V1.4.1
|
|---|
| 6 | * @date 09-October-2015
|
|---|
| 7 | * @brief Header file of RNG HAL module.
|
|---|
| 8 | ******************************************************************************
|
|---|
| 9 | * @attention
|
|---|
| 10 | *
|
|---|
| 11 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
|
|---|
| 12 | *
|
|---|
| 13 | * Redistribution and use in source and binary forms, with or without modification,
|
|---|
| 14 | * are permitted provided that the following conditions are met:
|
|---|
| 15 | * 1. Redistributions of source code must retain the above copyright notice,
|
|---|
| 16 | * this list of conditions and the following disclaimer.
|
|---|
| 17 | * 2. Redistributions in binary form must reproduce the above copyright notice,
|
|---|
| 18 | * this list of conditions and the following disclaimer in the documentation
|
|---|
| 19 | * and/or other materials provided with the distribution.
|
|---|
| 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors
|
|---|
| 21 | * may be used to endorse or promote products derived from this software
|
|---|
| 22 | * without specific prior written permission.
|
|---|
| 23 | *
|
|---|
| 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|---|
| 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|---|
| 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|---|
| 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|---|
| 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|---|
| 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|---|
| 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|---|
| 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|---|
| 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|---|
| 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 34 | *
|
|---|
| 35 | ******************************************************************************
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | /* Define to prevent recursive inclusion -------------------------------------*/
|
|---|
| 39 | #ifndef __STM32F4xx_HAL_RNG_H
|
|---|
| 40 | #define __STM32F4xx_HAL_RNG_H
|
|---|
| 41 |
|
|---|
| 42 | #ifdef __cplusplus
|
|---|
| 43 | extern "C" {
|
|---|
| 44 | #endif
|
|---|
| 45 |
|
|---|
| 46 | #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) ||\
|
|---|
| 47 | defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
|
|---|
| 48 | defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx) || defined(STM32F469xx) ||\
|
|---|
| 49 | defined(STM32F479xx)
|
|---|
| 50 |
|
|---|
| 51 | /* Includes ------------------------------------------------------------------*/
|
|---|
| 52 | #include "stm32f4xx_hal_def.h"
|
|---|
| 53 |
|
|---|
| 54 | /** @addtogroup STM32F4xx_HAL_Driver
|
|---|
| 55 | * @{
|
|---|
| 56 | */
|
|---|
| 57 |
|
|---|
| 58 | /** @defgroup RNG RNG
|
|---|
| 59 | * @brief RNG HAL module driver
|
|---|
| 60 | * @{
|
|---|
| 61 | */
|
|---|
| 62 |
|
|---|
| 63 | /* Exported types ------------------------------------------------------------*/
|
|---|
| 64 |
|
|---|
| 65 | /** @defgroup RNG_Exported_Types RNG Exported Types
|
|---|
| 66 | * @{
|
|---|
| 67 | */
|
|---|
| 68 |
|
|---|
| 69 | /** @defgroup RNG_Exported_Types_Group1 RNG State Structure definition
|
|---|
| 70 | * @{
|
|---|
| 71 | */
|
|---|
| 72 | typedef enum
|
|---|
| 73 | {
|
|---|
| 74 | HAL_RNG_STATE_RESET = 0x00, /*!< RNG not yet initialized or disabled */
|
|---|
| 75 | HAL_RNG_STATE_READY = 0x01, /*!< RNG initialized and ready for use */
|
|---|
| 76 | HAL_RNG_STATE_BUSY = 0x02, /*!< RNG internal process is ongoing */
|
|---|
| 77 | HAL_RNG_STATE_TIMEOUT = 0x03, /*!< RNG timeout state */
|
|---|
| 78 | HAL_RNG_STATE_ERROR = 0x04 /*!< RNG error state */
|
|---|
| 79 |
|
|---|
| 80 | }HAL_RNG_StateTypeDef;
|
|---|
| 81 |
|
|---|
| 82 | /**
|
|---|
| 83 | * @}
|
|---|
| 84 | */
|
|---|
| 85 |
|
|---|
| 86 | /** @defgroup RNG_Exported_Types_Group2 RNG Handle Structure definition
|
|---|
| 87 | * @{
|
|---|
| 88 | */
|
|---|
| 89 | typedef struct
|
|---|
| 90 | {
|
|---|
| 91 | RNG_TypeDef *Instance; /*!< Register base address */
|
|---|
| 92 |
|
|---|
| 93 | HAL_LockTypeDef Lock; /*!< RNG locking object */
|
|---|
| 94 |
|
|---|
| 95 | __IO HAL_RNG_StateTypeDef State; /*!< RNG communication state */
|
|---|
| 96 |
|
|---|
| 97 | uint32_t RandomNumber; /*!< Last Generated RNG Data */
|
|---|
| 98 |
|
|---|
| 99 | }RNG_HandleTypeDef;
|
|---|
| 100 |
|
|---|
| 101 | /**
|
|---|
| 102 | * @}
|
|---|
| 103 | */
|
|---|
| 104 |
|
|---|
| 105 | /**
|
|---|
| 106 | * @}
|
|---|
| 107 | */
|
|---|
| 108 |
|
|---|
| 109 | /* Exported constants --------------------------------------------------------*/
|
|---|
| 110 |
|
|---|
| 111 | /** @defgroup RNG_Exported_Constants RNG Exported Constants
|
|---|
| 112 | * @{
|
|---|
| 113 | */
|
|---|
| 114 |
|
|---|
| 115 | /** @defgroup RNG_Exported_Constants_Group1 RNG Interrupt definition
|
|---|
| 116 | * @{
|
|---|
| 117 | */
|
|---|
| 118 | #define RNG_IT_DRDY RNG_SR_DRDY /*!< Data Ready interrupt */
|
|---|
| 119 | #define RNG_IT_CEI RNG_SR_CEIS /*!< Clock error interrupt */
|
|---|
| 120 | #define RNG_IT_SEI RNG_SR_SEIS /*!< Seed error interrupt */
|
|---|
| 121 | /**
|
|---|
| 122 | * @}
|
|---|
| 123 | */
|
|---|
| 124 |
|
|---|
| 125 | /** @defgroup RNG_Exported_Constants_Group2 RNG Flag definition
|
|---|
| 126 | * @{
|
|---|
| 127 | */
|
|---|
| 128 | #define RNG_FLAG_DRDY RNG_SR_DRDY /*!< Data ready */
|
|---|
| 129 | #define RNG_FLAG_CECS RNG_SR_CECS /*!< Clock error current status */
|
|---|
| 130 | #define RNG_FLAG_SECS RNG_SR_SECS /*!< Seed error current status */
|
|---|
| 131 |
|
|---|
| 132 | /**
|
|---|
| 133 | * @}
|
|---|
| 134 | */
|
|---|
| 135 |
|
|---|
| 136 | /**
|
|---|
| 137 | * @}
|
|---|
| 138 | */
|
|---|
| 139 |
|
|---|
| 140 | /* Exported macros -----------------------------------------------------------*/
|
|---|
| 141 |
|
|---|
| 142 | /** @defgroup RNG_Exported_Macros RNG Exported Macros
|
|---|
| 143 | * @{
|
|---|
| 144 | */
|
|---|
| 145 |
|
|---|
| 146 | /** @brief Reset RNG handle state
|
|---|
| 147 | * @param __HANDLE__: RNG Handle
|
|---|
| 148 | * @retval None
|
|---|
| 149 | */
|
|---|
| 150 | #define __HAL_RNG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RNG_STATE_RESET)
|
|---|
| 151 |
|
|---|
| 152 | /**
|
|---|
| 153 | * @brief Enables the RNG peripheral.
|
|---|
| 154 | * @param __HANDLE__: RNG Handle
|
|---|
| 155 | * @retval None
|
|---|
| 156 | */
|
|---|
| 157 | #define __HAL_RNG_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= RNG_CR_RNGEN)
|
|---|
| 158 |
|
|---|
| 159 | /**
|
|---|
| 160 | * @brief Disables the RNG peripheral.
|
|---|
| 161 | * @param __HANDLE__: RNG Handle
|
|---|
| 162 | * @retval None
|
|---|
| 163 | */
|
|---|
| 164 | #define __HAL_RNG_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~RNG_CR_RNGEN)
|
|---|
| 165 |
|
|---|
| 166 | /**
|
|---|
| 167 | * @brief Check the selected RNG flag status.
|
|---|
| 168 | * @param __HANDLE__: RNG Handle
|
|---|
| 169 | * @param __FLAG__: RNG flag
|
|---|
| 170 | * This parameter can be one of the following values:
|
|---|
| 171 | * @arg RNG_FLAG_DRDY: Data ready
|
|---|
| 172 | * @arg RNG_FLAG_CECS: Clock error current status
|
|---|
| 173 | * @arg RNG_FLAG_SECS: Seed error current status
|
|---|
| 174 | * @retval The new state of __FLAG__ (SET or RESET).
|
|---|
| 175 | */
|
|---|
| 176 | #define __HAL_RNG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
|
|---|
| 177 |
|
|---|
| 178 | /**
|
|---|
| 179 | * @brief Clears the selected RNG flag status.
|
|---|
| 180 | * @param __HANDLE__: RNG handle
|
|---|
| 181 | * @param __FLAG__: RNG flag to clear
|
|---|
| 182 | * @note WARNING: This is a dummy macro for HAL code alignment,
|
|---|
| 183 | * flags RNG_FLAG_DRDY, RNG_FLAG_CECS and RNG_FLAG_SECS are read-only.
|
|---|
| 184 | * @retval None
|
|---|
| 185 | */
|
|---|
| 186 | #define __HAL_RNG_CLEAR_FLAG(__HANDLE__, __FLAG__) /* dummy macro */
|
|---|
| 187 |
|
|---|
| 188 |
|
|---|
| 189 |
|
|---|
| 190 | /**
|
|---|
| 191 | * @brief Enables the RNG interrupts.
|
|---|
| 192 | * @param __HANDLE__: RNG Handle
|
|---|
| 193 | * @retval None
|
|---|
| 194 | */
|
|---|
| 195 | #define __HAL_RNG_ENABLE_IT(__HANDLE__) ((__HANDLE__)->Instance->CR |= RNG_CR_IE)
|
|---|
| 196 |
|
|---|
| 197 | /**
|
|---|
| 198 | * @brief Disables the RNG interrupts.
|
|---|
| 199 | * @param __HANDLE__: RNG Handle
|
|---|
| 200 | * @retval None
|
|---|
| 201 | */
|
|---|
| 202 | #define __HAL_RNG_DISABLE_IT(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~RNG_CR_IE)
|
|---|
| 203 |
|
|---|
| 204 | /**
|
|---|
| 205 | * @brief Checks whether the specified RNG interrupt has occurred or not.
|
|---|
| 206 | * @param __HANDLE__: RNG Handle
|
|---|
| 207 | * @param __INTERRUPT__: specifies the RNG interrupt status flag to check.
|
|---|
| 208 | * This parameter can be one of the following values:
|
|---|
| 209 | * @arg RNG_IT_DRDY: Data ready interrupt
|
|---|
| 210 | * @arg RNG_IT_CEI: Clock error interrupt
|
|---|
| 211 | * @arg RNG_IT_SEI: Seed error interrupt
|
|---|
| 212 | * @retval The new state of __INTERRUPT__ (SET or RESET).
|
|---|
| 213 | */
|
|---|
| 214 | #define __HAL_RNG_GET_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__))
|
|---|
| 215 |
|
|---|
| 216 | /**
|
|---|
| 217 | * @brief Clear the RNG interrupt status flags.
|
|---|
| 218 | * @param __HANDLE__: RNG Handle
|
|---|
| 219 | * @param __INTERRUPT__: specifies the RNG interrupt status flag to clear.
|
|---|
| 220 | * This parameter can be one of the following values:
|
|---|
| 221 | * @arg RNG_IT_CEI: Clock error interrupt
|
|---|
| 222 | * @arg RNG_IT_SEI: Seed error interrupt
|
|---|
| 223 | * @note RNG_IT_DRDY flag is read-only, reading RNG_DR register automatically clears RNG_IT_DRDY.
|
|---|
| 224 | * @retval None
|
|---|
| 225 | */
|
|---|
| 226 | #define __HAL_RNG_CLEAR_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR) = ~(__INTERRUPT__))
|
|---|
| 227 |
|
|---|
| 228 | /**
|
|---|
| 229 | * @}
|
|---|
| 230 | */
|
|---|
| 231 |
|
|---|
| 232 | /* Exported functions --------------------------------------------------------*/
|
|---|
| 233 | /** @defgroup RNG_Exported_Functions RNG Exported Functions
|
|---|
| 234 | * @{
|
|---|
| 235 | */
|
|---|
| 236 |
|
|---|
| 237 | /** @defgroup RNG_Exported_Functions_Group1 Initialization and de-initialization functions
|
|---|
| 238 | * @{
|
|---|
| 239 | */
|
|---|
| 240 | HAL_StatusTypeDef HAL_RNG_Init(RNG_HandleTypeDef *hrng);
|
|---|
| 241 | HAL_StatusTypeDef HAL_RNG_DeInit (RNG_HandleTypeDef *hrng);
|
|---|
| 242 | void HAL_RNG_MspInit(RNG_HandleTypeDef *hrng);
|
|---|
| 243 | void HAL_RNG_MspDeInit(RNG_HandleTypeDef *hrng);
|
|---|
| 244 |
|
|---|
| 245 | /**
|
|---|
| 246 | * @}
|
|---|
| 247 | */
|
|---|
| 248 |
|
|---|
| 249 | /** @defgroup RNG_Exported_Functions_Group2 Peripheral Control functions
|
|---|
| 250 | * @{
|
|---|
| 251 | */
|
|---|
| 252 | uint32_t HAL_RNG_GetRandomNumber(RNG_HandleTypeDef *hrng); /* Obsolete, use HAL_RNG_GenerateRandomNumber() instead */
|
|---|
| 253 | uint32_t HAL_RNG_GetRandomNumber_IT(RNG_HandleTypeDef *hrng); /* Obsolete, use HAL_RNG_GenerateRandomNumber_IT() instead */
|
|---|
| 254 |
|
|---|
| 255 | HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber(RNG_HandleTypeDef *hrng, uint32_t *random32bit);
|
|---|
| 256 | HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber_IT(RNG_HandleTypeDef *hrng);
|
|---|
| 257 | uint32_t HAL_RNG_ReadLastRandomNumber(RNG_HandleTypeDef *hrng);
|
|---|
| 258 |
|
|---|
| 259 | void HAL_RNG_IRQHandler(RNG_HandleTypeDef *hrng);
|
|---|
| 260 | void HAL_RNG_ErrorCallback(RNG_HandleTypeDef *hrng);
|
|---|
| 261 | void HAL_RNG_ReadyDataCallback(RNG_HandleTypeDef* hrng, uint32_t random32bit);
|
|---|
| 262 |
|
|---|
| 263 | /**
|
|---|
| 264 | * @}
|
|---|
| 265 | */
|
|---|
| 266 |
|
|---|
| 267 | /** @defgroup RNG_Exported_Functions_Group3 Peripheral State functions
|
|---|
| 268 | * @{
|
|---|
| 269 | */
|
|---|
| 270 | HAL_RNG_StateTypeDef HAL_RNG_GetState(RNG_HandleTypeDef *hrng);
|
|---|
| 271 |
|
|---|
| 272 | /**
|
|---|
| 273 | * @}
|
|---|
| 274 | */
|
|---|
| 275 |
|
|---|
| 276 | /**
|
|---|
| 277 | * @}
|
|---|
| 278 | */
|
|---|
| 279 |
|
|---|
| 280 | /* Private types -------------------------------------------------------------*/
|
|---|
| 281 | /** @defgroup RNG_Private_Types RNG Private Types
|
|---|
| 282 | * @{
|
|---|
| 283 | */
|
|---|
| 284 |
|
|---|
| 285 | /**
|
|---|
| 286 | * @}
|
|---|
| 287 | */
|
|---|
| 288 |
|
|---|
| 289 | /* Private defines -----------------------------------------------------------*/
|
|---|
| 290 | /** @defgroup RNG_Private_Defines RNG Private Defines
|
|---|
| 291 | * @{
|
|---|
| 292 | */
|
|---|
| 293 |
|
|---|
| 294 | /**
|
|---|
| 295 | * @}
|
|---|
| 296 | */
|
|---|
| 297 |
|
|---|
| 298 | /* Private variables ---------------------------------------------------------*/
|
|---|
| 299 | /** @defgroup RNG_Private_Variables RNG Private Variables
|
|---|
| 300 | * @{
|
|---|
| 301 | */
|
|---|
| 302 |
|
|---|
| 303 | /**
|
|---|
| 304 | * @}
|
|---|
| 305 | */
|
|---|
| 306 |
|
|---|
| 307 | /* Private constants ---------------------------------------------------------*/
|
|---|
| 308 | /** @defgroup RNG_Private_Constants RNG Private Constants
|
|---|
| 309 | * @{
|
|---|
| 310 | */
|
|---|
| 311 |
|
|---|
| 312 | /**
|
|---|
| 313 | * @}
|
|---|
| 314 | */
|
|---|
| 315 |
|
|---|
| 316 | /* Private macros ------------------------------------------------------------*/
|
|---|
| 317 | /** @defgroup RNG_Private_Macros RNG Private Macros
|
|---|
| 318 | * @{
|
|---|
| 319 | */
|
|---|
| 320 | #define IS_RNG_IT(IT) (((IT) == RNG_IT_CEI) || \
|
|---|
| 321 | ((IT) == RNG_IT_SEI))
|
|---|
| 322 |
|
|---|
| 323 | #define IS_RNG_FLAG(FLAG) (((FLAG) == RNG_FLAG_DRDY) || \
|
|---|
| 324 | ((FLAG) == RNG_FLAG_CECS) || \
|
|---|
| 325 | ((FLAG) == RNG_FLAG_SECS))
|
|---|
| 326 |
|
|---|
| 327 | /**
|
|---|
| 328 | * @}
|
|---|
| 329 | */
|
|---|
| 330 |
|
|---|
| 331 | /* Private functions prototypes ----------------------------------------------*/
|
|---|
| 332 | /** @defgroup RNG_Private_Functions_Prototypes RNG Private Functions Prototypes
|
|---|
| 333 | * @{
|
|---|
| 334 | */
|
|---|
| 335 |
|
|---|
| 336 | /**
|
|---|
| 337 | * @}
|
|---|
| 338 | */
|
|---|
| 339 |
|
|---|
| 340 | /* Private functions ---------------------------------------------------------*/
|
|---|
| 341 | /** @defgroup RNG_Private_Functions RNG Private Functions
|
|---|
| 342 | * @{
|
|---|
| 343 | */
|
|---|
| 344 |
|
|---|
| 345 | /**
|
|---|
| 346 | * @}
|
|---|
| 347 | */
|
|---|
| 348 |
|
|---|
| 349 | /**
|
|---|
| 350 | * @}
|
|---|
| 351 | */
|
|---|
| 352 |
|
|---|
| 353 | /**
|
|---|
| 354 | * @}
|
|---|
| 355 | */
|
|---|
| 356 |
|
|---|
| 357 | #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
|
|---|
| 358 | STM32F429xx || STM32F439xx || STM32F410xx || STM32F469xx || STM32F479xx */
|
|---|
| 359 |
|
|---|
| 360 | #ifdef __cplusplus
|
|---|
| 361 | }
|
|---|
| 362 | #endif
|
|---|
| 363 |
|
|---|
| 364 |
|
|---|
| 365 | #endif /* __STM32F4xx_HAL_RNG_H */
|
|---|
| 366 |
|
|---|
| 367 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
|---|
![(please configure the [header_logo] section in trac.ini)](/trac_user/contrib/chrome/site/your_project_logo.png){kind=logo}
