marcus chiou / mbed-src

mbed library sources

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_rng.h@369:2e96f1b71984, 2014-10-27 (annotated)

Committer:
mbed_official
Date:
Mon Oct 27 09:45:07 2014 +0000
Revision:
369:2e96f1b71984
Parent:
226:b062af740e40 
Synchronized with git revision 2d1f64de28cfb25c0e602532e3ce5ad1d9accbed



Full URL: https://github.com/mbedmicro/mbed/commit/2d1f64de28cfb25c0e602532e3ce5ad1d9accbed/



CMSIS: NUCLEO_F401RE - Update STM32Cube driver

Who changed what in which revision?

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