shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F411RE/stm32f4xx_hal_rng.h@323:9e901b0a5aa1, 2014-09-13 (annotated)

Committer:
shaoziyang
Date:
Sat Sep 13 14:25:46 2014 +0000
Revision:
323:9e901b0a5aa1
Parent:
235:685d5f11838f 
test with CLOCK_SETUP = 0

Who changed what in which revision?

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