lib/main/STM32F4/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_rng.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_rng.h
   4   * @author  MCD Application Team
   5   * @version V1.7.1
   6   * @date    14-April-2017
   7   * @brief   Header file of RNG HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2017 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) || defined(STM32F412Zx) || defined(STM32F412Vx) || defined(STM32F412Rx) ||\
  50     defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
  51
  52 /* Includes ------------------------------------------------------------------*/
  53 #include "stm32f4xx_hal_def.h"
  54
  55 /** @addtogroup STM32F4xx_HAL_Driver
  56   * @{
  57   */
  58
  59 /** @defgroup RNG RNG
  60   * @brief RNG HAL module driver
  61   * @{
  62   */
  63
  64 /* Exported types ------------------------------------------------------------*/
  65
  66 /** @defgroup RNG_Exported_Types RNG Exported Types
  67   * @{
  68   */
  69
  70 /** @defgroup RNG_Exported_Types_Group1 RNG State Structure definition
  71   * @{
  72   */
  73 typedef enum
  74 {
  75   HAL_RNG_STATE_RESET     = 0x00U,  /*!< RNG not yet initialized or disabled */
  76   HAL_RNG_STATE_READY     = 0x01U,  /*!< RNG initialized and ready for use   */
  77   HAL_RNG_STATE_BUSY      = 0x02U,  /*!< RNG internal process is ongoing     */
  78   HAL_RNG_STATE_TIMEOUT   = 0x03U,  /*!< RNG timeout state                   */
  79   HAL_RNG_STATE_ERROR     = 0x04U   /*!< RNG error state                     */
  80
  81 }HAL_RNG_StateTypeDef;
  82
  83 /**
  84   * @}
  85   */
  86
  87 /** @defgroup RNG_Exported_Types_Group2 RNG Handle Structure definition
  88   * @{
  89   */
  90 typedef struct
  91 {
  92   RNG_TypeDef                 *Instance;    /*!< Register base address   */
  93
  94   HAL_LockTypeDef             Lock;         /*!< RNG locking object      */
  95
  96   __IO HAL_RNG_StateTypeDef   State;        /*!< RNG communication state */
  97
  98   uint32_t                    RandomNumber; /*!< Last Generated RNG Data */
  99
 100 }RNG_HandleTypeDef;
 101
 102 /**
 103   * @}
 104   */
 105
 106 /**
 107   * @}
 108   */
 109
 110 /* Exported constants --------------------------------------------------------*/
 111
 112 /** @defgroup RNG_Exported_Constants RNG Exported Constants
 113   * @{
 114   */
 115
 116 /** @defgroup RNG_Exported_Constants_Group1 RNG Interrupt definition
 117   * @{
 118   */
 119 #define RNG_IT_DRDY  RNG_SR_DRDY  /*!< Data Ready interrupt  */
 120 #define RNG_IT_CEI   RNG_SR_CEIS  /*!< Clock error interrupt */
 121 #define RNG_IT_SEI   RNG_SR_SEIS  /*!< Seed error interrupt  */
 122 /**
 123   * @}
 124   */
 125
 126 /** @defgroup RNG_Exported_Constants_Group2 RNG Flag definition
 127   * @{
 128   */
 129 #define RNG_FLAG_DRDY   RNG_SR_DRDY  /*!< Data ready                 */
 130 #define RNG_FLAG_CECS   RNG_SR_CECS  /*!< Clock error current status */
 131 #define RNG_FLAG_SECS   RNG_SR_SECS  /*!< Seed error current status  */
 132
 133 /**
 134   * @}
 135   */
 136
 137 /**
 138   * @}
 139   */
 140
 141 /* Exported macros -----------------------------------------------------------*/
 142
 143 /** @defgroup RNG_Exported_Macros RNG Exported Macros
 144   * @{
 145   */
 146
 147 /** @brief Reset RNG handle state
 148   * @param  __HANDLE__: RNG Handle
 149   * @retval None
 150   */
 151 #define __HAL_RNG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RNG_STATE_RESET)
 152
 153 /**
 154   * @brief  Enables the RNG peripheral.
 155   * @param  __HANDLE__: RNG Handle
 156   * @retval None
 157   */
 158 #define __HAL_RNG_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |=  RNG_CR_RNGEN)
 159
 160 /**
 161   * @brief  Disables the RNG peripheral.
 162   * @param  __HANDLE__: RNG Handle
 163   * @retval None
 164   */
 165 #define __HAL_RNG_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~RNG_CR_RNGEN)
 166
 167 /**
 168   * @brief  Check the selected RNG flag status.
 169   * @param  __HANDLE__: RNG Handle
 170   * @param  __FLAG__: RNG flag
 171   *          This parameter can be one of the following values:
 172   *            @arg RNG_FLAG_DRDY: Data ready
 173   *            @arg RNG_FLAG_CECS: Clock error current status
 174   *            @arg RNG_FLAG_SECS: Seed error current status
 175   * @retval The new state of __FLAG__ (SET or RESET).
 176   */
 177 #define __HAL_RNG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
 178
 179 /**
 180   * @brief  Clears the selected RNG flag status.
 181   * @param  __HANDLE__: RNG handle
 182   * @param  __FLAG__: RNG flag to clear
 183   * @note   WARNING: This is a dummy macro for HAL code alignment,
 184   *         flags RNG_FLAG_DRDY, RNG_FLAG_CECS and RNG_FLAG_SECS are read-only.
 185   * @retval None
 186   */
 187 #define __HAL_RNG_CLEAR_FLAG(__HANDLE__, __FLAG__)                      /* dummy  macro */
 188
 189
 190
 191 /**
 192   * @brief  Enables the RNG interrupts.
 193   * @param  __HANDLE__: RNG Handle
 194   * @retval None
 195   */
 196 #define __HAL_RNG_ENABLE_IT(__HANDLE__) ((__HANDLE__)->Instance->CR |=  RNG_CR_IE)
 197
 198 /**
 199   * @brief  Disables the RNG interrupts.
 200   * @param  __HANDLE__: RNG Handle
 201   * @retval None
 202   */
 203 #define __HAL_RNG_DISABLE_IT(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~RNG_CR_IE)
 204
 205 /**
 206   * @brief  Checks whether the specified RNG interrupt has occurred or not.
 207   * @param  __HANDLE__: RNG Handle
 208   * @param  __INTERRUPT__: specifies the RNG interrupt status flag to check.
 209   *         This parameter can be one of the following values:
 210   *            @arg RNG_IT_DRDY: Data ready interrupt
 211   *            @arg RNG_IT_CEI: Clock error interrupt
 212   *            @arg RNG_IT_SEI: Seed error interrupt
 213   * @retval The new state of __INTERRUPT__ (SET or RESET).
 214   */
 215 #define __HAL_RNG_GET_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__))
 216
 217 /**
 218   * @brief  Clear the RNG interrupt status flags.
 219   * @param  __HANDLE__: RNG Handle
 220   * @param  __INTERRUPT__: specifies the RNG interrupt status flag to clear.
 221   *          This parameter can be one of the following values:
 222   *            @arg RNG_IT_CEI: Clock error interrupt
 223   *            @arg RNG_IT_SEI: Seed error interrupt
 224   * @note   RNG_IT_DRDY flag is read-only, reading RNG_DR register automatically clears RNG_IT_DRDY.
 225   * @retval None
 226   */
 227 #define __HAL_RNG_CLEAR_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR) = ~(__INTERRUPT__))
 228
 229 /**
 230   * @}
 231   */
 232
 233 /* Exported functions --------------------------------------------------------*/
 234 /** @defgroup RNG_Exported_Functions RNG Exported Functions
 235   * @{
 236   */
 237
 238 /** @defgroup RNG_Exported_Functions_Group1 Initialization and de-initialization functions
 239   * @{
 240   */
 241 HAL_StatusTypeDef HAL_RNG_Init(RNG_HandleTypeDef *hrng);
 242 HAL_StatusTypeDef HAL_RNG_DeInit (RNG_HandleTypeDef *hrng);
 243 void HAL_RNG_MspInit(RNG_HandleTypeDef *hrng);
 244 void HAL_RNG_MspDeInit(RNG_HandleTypeDef *hrng);
 245
 246 /**
 247   * @}
 248   */
 249
 250 /** @defgroup RNG_Exported_Functions_Group2 Peripheral Control functions
 251   * @{
 252   */
 253 uint32_t HAL_RNG_GetRandomNumber(RNG_HandleTypeDef *hrng);    /* Obsolete, use HAL_RNG_GenerateRandomNumber() instead    */
 254 uint32_t HAL_RNG_GetRandomNumber_IT(RNG_HandleTypeDef *hrng); /* Obsolete, use HAL_RNG_GenerateRandomNumber_IT() instead */
 255
 256 HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber(RNG_HandleTypeDef *hrng, uint32_t *random32bit);
 257 HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber_IT(RNG_HandleTypeDef *hrng);
 258 uint32_t HAL_RNG_ReadLastRandomNumber(RNG_HandleTypeDef *hrng);
 259
 260 void HAL_RNG_IRQHandler(RNG_HandleTypeDef *hrng);
 261 void HAL_RNG_ErrorCallback(RNG_HandleTypeDef *hrng);
 262 void HAL_RNG_ReadyDataCallback(RNG_HandleTypeDef* hrng, uint32_t random32bit);
 263
 264 /**
 265   * @}
 266   */
 267
 268 /** @defgroup RNG_Exported_Functions_Group3 Peripheral State functions
 269   * @{
 270   */
 271 HAL_RNG_StateTypeDef HAL_RNG_GetState(RNG_HandleTypeDef *hrng);
 272
 273 /**
 274   * @}
 275   */
 276
 277 /**
 278   * @}
 279   */
 280
 281 /* Private types -------------------------------------------------------------*/
 282 /** @defgroup RNG_Private_Types RNG Private Types
 283   * @{
 284   */
 285
 286 /**
 287   * @}
 288   */
 289
 290 /* Private defines -----------------------------------------------------------*/
 291 /** @defgroup RNG_Private_Defines RNG Private Defines
 292   * @{
 293   */
 294
 295 /**
 296   * @}
 297   */
 298
 299 /* Private variables ---------------------------------------------------------*/
 300 /** @defgroup RNG_Private_Variables RNG Private Variables
 301   * @{
 302   */
 303
 304 /**
 305   * @}
 306   */
 307
 308 /* Private constants ---------------------------------------------------------*/
 309 /** @defgroup RNG_Private_Constants RNG Private Constants
 310   * @{
 311   */
 312
 313 /**
 314   * @}
 315   */
 316
 317 /* Private macros ------------------------------------------------------------*/
 318 /** @defgroup RNG_Private_Macros RNG Private Macros
 319   * @{
 320   */
 321 #define IS_RNG_IT(IT) (((IT) == RNG_IT_CEI) || \
 322                        ((IT) == RNG_IT_SEI))
 323
 324 #define IS_RNG_FLAG(FLAG) (((FLAG) == RNG_FLAG_DRDY) || \
 325                            ((FLAG) == RNG_FLAG_CECS) || \
 326                            ((FLAG) == RNG_FLAG_SECS))
 327
 328 /**
 329   * @}
 330   */
 331
 332 /* Private functions prototypes ----------------------------------------------*/
 333 /** @defgroup RNG_Private_Functions_Prototypes RNG Private Functions Prototypes
 334   * @{
 335   */
 336
 337 /**
 338   * @}
 339   */
 340
 341 /* Private functions ---------------------------------------------------------*/
 342 /** @defgroup RNG_Private_Functions RNG Private Functions
 343   * @{
 344   */
 345
 346 /**
 347   * @}
 348   */
 349
 350 /**
 351   * @}
 352   */
 353
 354 /**
 355   * @}
 356   */
 357
 358 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
 359           STM32F429xx || STM32F439xx || STM32F410xx || STM32F469xx || STM32F479xx || STM32F412Zx ||\
 360           STM32F412Vx || STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
 361
 362 #ifdef __cplusplus
 363 }
 364 #endif
 365
 366
 367 #endif /* __STM32F4xx_HAL_RNG_H */
 368
 369 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/