mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_F401RE/stm32f4xx_hal_rng.h@89:552587b429a1, 2014-09-12 (annotated)

Committer:
bogdanm
Date:
Fri Sep 12 16:41:52 2014 +0100
Revision:
89:552587b429a1
Parent:
85:024bf7f99721
Child:
90:cb3d968589d8
Release 89 of the mbed library



Main changes:



- low power optimizations for Nordic targets

- code structure changes for Freescale K64F targets

- bug fixes in various backends

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 77:869cf507173a 1 /**
emilmont 77:869cf507173a 2 ******************************************************************************
emilmont 77:869cf507173a 3 * @file stm32f4xx_hal_rng.h
emilmont 77:869cf507173a 4 * @author MCD Application Team
bogdanm 85:024bf7f99721 5 * @version V1.1.0RC2
bogdanm 85:024bf7f99721 6 * @date 14-May-2014
emilmont 77:869cf507173a 7 * @brief Header file of RNG HAL module.
emilmont 77:869cf507173a 8 ******************************************************************************
emilmont 77:869cf507173a 9 * @attention
emilmont 77:869cf507173a 10 *
emilmont 77:869cf507173a 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
emilmont 77:869cf507173a 12 *
emilmont 77:869cf507173a 13 * Redistribution and use in source and binary forms, with or without modification,
emilmont 77:869cf507173a 14 * are permitted provided that the following conditions are met:
emilmont 77:869cf507173a 15 * 1. Redistributions of source code must retain the above copyright notice,
emilmont 77:869cf507173a 16 * this list of conditions and the following disclaimer.
emilmont 77:869cf507173a 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
emilmont 77:869cf507173a 18 * this list of conditions and the following disclaimer in the documentation
emilmont 77:869cf507173a 19 * and/or other materials provided with the distribution.
emilmont 77:869cf507173a 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
emilmont 77:869cf507173a 21 * may be used to endorse or promote products derived from this software
emilmont 77:869cf507173a 22 * without specific prior written permission.
emilmont 77:869cf507173a 23 *
emilmont 77:869cf507173a 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
emilmont 77:869cf507173a 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
emilmont 77:869cf507173a 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
emilmont 77:869cf507173a 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
emilmont 77:869cf507173a 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
emilmont 77:869cf507173a 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
emilmont 77:869cf507173a 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
emilmont 77:869cf507173a 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
emilmont 77:869cf507173a 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
emilmont 77:869cf507173a 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
emilmont 77:869cf507173a 34 *
emilmont 77:869cf507173a 35 ******************************************************************************
emilmont 77:869cf507173a 36 */
emilmont 77:869cf507173a 37
emilmont 77:869cf507173a 38 /* Define to prevent recursive inclusion -------------------------------------*/
emilmont 77:869cf507173a 39 #ifndef __STM32F4xx_HAL_RNG_H
emilmont 77:869cf507173a 40 #define __STM32F4xx_HAL_RNG_H
emilmont 77:869cf507173a 41
emilmont 77:869cf507173a 42 #ifdef __cplusplus
emilmont 77:869cf507173a 43 extern "C" {
emilmont 77:869cf507173a 44 #endif
emilmont 77:869cf507173a 45
emilmont 77:869cf507173a 46 /* Includes ------------------------------------------------------------------*/
emilmont 77:869cf507173a 47 #include "stm32f4xx_hal_def.h"
emilmont 77:869cf507173a 48
emilmont 77:869cf507173a 49 /** @addtogroup STM32F4xx_HAL_Driver
emilmont 77:869cf507173a 50 * @{
emilmont 77:869cf507173a 51 */
emilmont 77:869cf507173a 52
emilmont 77:869cf507173a 53 /** @addtogroup RNG
emilmont 77:869cf507173a 54 * @{
emilmont 77:869cf507173a 55 */
emilmont 77:869cf507173a 56
emilmont 77:869cf507173a 57 /* Exported types ------------------------------------------------------------*/
emilmont 77:869cf507173a 58
emilmont 77:869cf507173a 59 /**
emilmont 77:869cf507173a 60 * @brief RNG HAL State Structure definition
emilmont 77:869cf507173a 61 */
emilmont 77:869cf507173a 62 typedef enum
emilmont 77:869cf507173a 63 {
emilmont 77:869cf507173a 64 HAL_RNG_STATE_RESET = 0x00, /*!< RNG not yet initialized or disabled */
emilmont 77:869cf507173a 65 HAL_RNG_STATE_READY = 0x01, /*!< RNG initialized and ready for use */
emilmont 77:869cf507173a 66 HAL_RNG_STATE_BUSY = 0x02, /*!< RNG internal process is ongoing */
emilmont 77:869cf507173a 67 HAL_RNG_STATE_TIMEOUT = 0x03, /*!< RNG timeout state */
emilmont 77:869cf507173a 68 HAL_RNG_STATE_ERROR = 0x04 /*!< RNG error state */
emilmont 77:869cf507173a 69
emilmont 77:869cf507173a 70 }HAL_RNG_StateTypeDef;
emilmont 77:869cf507173a 71
emilmont 77:869cf507173a 72 /**
emilmont 77:869cf507173a 73 * @brief RNG Handle Structure definition
emilmont 77:869cf507173a 74 */
emilmont 77:869cf507173a 75 typedef struct
emilmont 77:869cf507173a 76 {
emilmont 77:869cf507173a 77 RNG_TypeDef *Instance; /*!< Register base address */
emilmont 77:869cf507173a 78
emilmont 77:869cf507173a 79 HAL_LockTypeDef Lock; /*!< RNG locking object */
emilmont 77:869cf507173a 80
emilmont 77:869cf507173a 81 __IO HAL_RNG_StateTypeDef State; /*!< RNG communication state */
emilmont 77:869cf507173a 82
emilmont 77:869cf507173a 83 }RNG_HandleTypeDef;
emilmont 77:869cf507173a 84
emilmont 77:869cf507173a 85 /* Exported constants --------------------------------------------------------*/
emilmont 77:869cf507173a 86
emilmont 77:869cf507173a 87 /** @defgroup RNG_Exported_Constants
emilmont 77:869cf507173a 88 * @{
emilmont 77:869cf507173a 89 */
emilmont 77:869cf507173a 90
emilmont 77:869cf507173a 91 /** @defgroup RNG_Interrupt_definition
emilmont 77:869cf507173a 92 * @{
emilmont 77:869cf507173a 93 */
emilmont 77:869cf507173a 94 #define RNG_IT_CEI ((uint32_t)0x20) /*!< Clock error interrupt */
emilmont 77:869cf507173a 95 #define RNG_IT_SEI ((uint32_t)0x40) /*!< Seed error interrupt */
emilmont 77:869cf507173a 96
emilmont 77:869cf507173a 97 #define IS_RNG_IT(IT) (((IT) == RNG_IT_CEI) || \
emilmont 77:869cf507173a 98 ((IT) == RNG_IT_SEI))
emilmont 77:869cf507173a 99 /**
emilmont 77:869cf507173a 100 * @}
emilmont 77:869cf507173a 101 */
emilmont 77:869cf507173a 102
emilmont 77:869cf507173a 103
emilmont 77:869cf507173a 104 /** @defgroup RNG_Flag_definition
emilmont 77:869cf507173a 105 * @{
emilmont 77:869cf507173a 106 */
emilmont 77:869cf507173a 107 #define RNG_FLAG_DRDY ((uint32_t)0x0001) /*!< Data ready */
emilmont 77:869cf507173a 108 #define RNG_FLAG_CECS ((uint32_t)0x0002) /*!< Clock error current status */
emilmont 77:869cf507173a 109 #define RNG_FLAG_SECS ((uint32_t)0x0004) /*!< Seed error current status */
emilmont 77:869cf507173a 110
emilmont 77:869cf507173a 111 #define IS_RNG_FLAG(FLAG) (((FLAG) == RNG_FLAG_DRDY) || \
emilmont 77:869cf507173a 112 ((FLAG) == RNG_FLAG_CECS) || \
emilmont 77:869cf507173a 113 ((FLAG) == RNG_FLAG_SECS))
emilmont 77:869cf507173a 114 /**
emilmont 77:869cf507173a 115 * @}
emilmont 77:869cf507173a 116 */
emilmont 77:869cf507173a 117
emilmont 77:869cf507173a 118 /**
emilmont 77:869cf507173a 119 * @}
emilmont 77:869cf507173a 120 */
emilmont 77:869cf507173a 121
emilmont 77:869cf507173a 122 /* Exported macro ------------------------------------------------------------*/
emilmont 77:869cf507173a 123
bogdanm 85:024bf7f99721 124 /** @brief Reset RNG handle state
bogdanm 85:024bf7f99721 125 * @param __HANDLE__: RNG Handle
bogdanm 85:024bf7f99721 126 * @retval None
bogdanm 85:024bf7f99721 127 */
bogdanm 85:024bf7f99721 128 #define __HAL_RNG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RNG_STATE_RESET)
bogdanm 85:024bf7f99721 129
emilmont 77:869cf507173a 130 /**
emilmont 77:869cf507173a 131 * @brief Enables the RNG peripheral.
emilmont 77:869cf507173a 132 * @param __HANDLE__: RNG Handle
emilmont 77:869cf507173a 133 * @retval None
emilmont 77:869cf507173a 134 */
emilmont 77:869cf507173a 135 #define __HAL_RNG_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= RNG_CR_RNGEN)
emilmont 77:869cf507173a 136
emilmont 77:869cf507173a 137 /**
emilmont 77:869cf507173a 138 * @brief Disables the RNG peripheral.
emilmont 77:869cf507173a 139 * @param __HANDLE__: RNG Handle
emilmont 77:869cf507173a 140 * @retval None
emilmont 77:869cf507173a 141 */
emilmont 77:869cf507173a 142 #define __HAL_RNG_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~RNG_CR_RNGEN)
emilmont 77:869cf507173a 143
emilmont 77:869cf507173a 144 /**
emilmont 77:869cf507173a 145 * @brief Gets the selected RNG's flag status.
emilmont 77:869cf507173a 146 * @param __HANDLE__: RNG Handle
emilmont 77:869cf507173a 147 * @param __FLAG__: RNG flag
emilmont 77:869cf507173a 148 * @retval The new state of RNG_FLAG (SET or RESET).
emilmont 77:869cf507173a 149 */
emilmont 77:869cf507173a 150 #define __HAL_RNG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
emilmont 77:869cf507173a 151
emilmont 77:869cf507173a 152 /**
emilmont 77:869cf507173a 153 * @brief Clears the RNG's pending flags.
emilmont 77:869cf507173a 154 * @param __HANDLE__: RNG Handle
emilmont 77:869cf507173a 155 * @param __FLAG__: RNG flag
emilmont 77:869cf507173a 156 * @retval None
emilmont 77:869cf507173a 157 */
emilmont 77:869cf507173a 158 #define __HAL_RNG_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) &= ~(__FLAG__))
emilmont 77:869cf507173a 159
emilmont 77:869cf507173a 160 /**
emilmont 77:869cf507173a 161 * @brief Enables the RNG interrupts.
emilmont 77:869cf507173a 162 * @param __HANDLE__: RNG Handle
emilmont 77:869cf507173a 163 * @retval None
emilmont 77:869cf507173a 164 */
emilmont 77:869cf507173a 165 #define __HAL_RNG_ENABLE_IT(__HANDLE__) ((__HANDLE__)->Instance->CR |= RNG_CR_IE)
emilmont 77:869cf507173a 166
emilmont 77:869cf507173a 167 /**
emilmont 77:869cf507173a 168 * @brief Disables the RNG interrupts.
emilmont 77:869cf507173a 169 * @param __HANDLE__: RNG Handle
emilmont 77:869cf507173a 170 * @retval None
emilmont 77:869cf507173a 171 */
emilmont 77:869cf507173a 172 #define __HAL_RNG_DISABLE_IT(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~RNG_CR_IE)
emilmont 77:869cf507173a 173
emilmont 77:869cf507173a 174 /**
emilmont 77:869cf507173a 175 * @brief Checks whether the specified RNG interrupt has occurred or not.
emilmont 77:869cf507173a 176 * @param __HANDLE__: RNG Handle
emilmont 77:869cf507173a 177 * @param __INTERRUPT__: specifies the RNG interrupt source to check.
emilmont 77:869cf507173a 178 * This parameter can be one of the following values:
emilmont 77:869cf507173a 179 * @arg RNG_FLAG_DRDY: Data ready interrupt
emilmont 77:869cf507173a 180 * @arg RNG_FLAG_CECS: Clock error interrupt
emilmont 77:869cf507173a 181 * @arg RNG_FLAG_SECS: Seed error interrupt
emilmont 77:869cf507173a 182 * @retval The new state of RNG_FLAG (SET or RESET).
emilmont 77:869cf507173a 183 */
emilmont 77:869cf507173a 184 #define __HAL_RNG_GET_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__))
emilmont 77:869cf507173a 185
emilmont 77:869cf507173a 186 /* Exported functions --------------------------------------------------------*/
emilmont 77:869cf507173a 187
emilmont 77:869cf507173a 188 /* Initialization/de-initialization functions **********************************/
emilmont 77:869cf507173a 189 HAL_StatusTypeDef HAL_RNG_Init(RNG_HandleTypeDef *hrng);
emilmont 77:869cf507173a 190 HAL_StatusTypeDef HAL_RNG_DeInit (RNG_HandleTypeDef *hrng);
bogdanm 81:7d30d6019079 191 void HAL_RNG_MspInit(RNG_HandleTypeDef *hrng);
bogdanm 81:7d30d6019079 192 void HAL_RNG_MspDeInit(RNG_HandleTypeDef *hrng);
emilmont 77:869cf507173a 193
emilmont 77:869cf507173a 194 /* Peripheral Control functions ************************************************/
emilmont 77:869cf507173a 195 uint32_t HAL_RNG_GetRandomNumber(RNG_HandleTypeDef *hrng);
emilmont 77:869cf507173a 196 uint32_t HAL_RNG_GetRandomNumber_IT(RNG_HandleTypeDef *hrng);
emilmont 77:869cf507173a 197 void HAL_RNG_IRQHandler(RNG_HandleTypeDef *hrng);
bogdanm 81:7d30d6019079 198 void HAL_RNG_ReadyCallback(RNG_HandleTypeDef* hrng);
bogdanm 81:7d30d6019079 199 void HAL_RNG_ErrorCallback(RNG_HandleTypeDef *hrng);
emilmont 77:869cf507173a 200
emilmont 77:869cf507173a 201 /* Peripheral State functions **************************************************/
emilmont 77:869cf507173a 202 HAL_RNG_StateTypeDef HAL_RNG_GetState(RNG_HandleTypeDef *hrng);
emilmont 77:869cf507173a 203
emilmont 77:869cf507173a 204 /**
emilmont 77:869cf507173a 205 * @}
emilmont 77:869cf507173a 206 */
emilmont 77:869cf507173a 207
emilmont 77:869cf507173a 208 /**
emilmont 77:869cf507173a 209 * @}
emilmont 77:869cf507173a 210 */
emilmont 77:869cf507173a 211
emilmont 77:869cf507173a 212 #ifdef __cplusplus
emilmont 77:869cf507173a 213 }
emilmont 77:869cf507173a 214 #endif
emilmont 77:869cf507173a 215
emilmont 77:869cf507173a 216 #endif /* __STM32F4xx_HAL_RNG_H */
emilmont 77:869cf507173a 217
emilmont 77:869cf507173a 218 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/