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_DISCO_F407VG/stm32f4xx_hal_rng.h@133:d4dda5c437f0, 2014-03-24 (annotated)

Committer:
mbed_official
Date:
Mon Mar 24 17:45:07 2014 +0000
Revision:
133:d4dda5c437f0
Child:
242:7074e42da0b2
Synchronized with git revision 47b961246bed973fe4cb8932781ffc8025b78a61



Full URL: https://github.com/mbedmicro/mbed/commit/47b961246bed973fe4cb8932781ffc8025b78a61/



[STM32F4-Discovery (STM32F407VG)] initial port

Who changed what in which revision?

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