Steve Kim / mbed-src-test

mbed library sources

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_DISCO_L053C8/stm32l0xx_hal_rng.h@376:cb4d9db17537, 2014-10-31 (annotated)

Committer:
mbed_official
Date:
Fri Oct 31 11:00:10 2014 +0000
Revision:
376:cb4d9db17537
Synchronized with git revision 07b49da75eac883fc8916d3d6b6962664b8db29e



Full URL: https://github.com/mbedmicro/mbed/commit/07b49da75eac883fc8916d3d6b6962664b8db29e/



Targets: DISCO_L053C8 - new platform - STM32L0 Discovery board

Who changed what in which revision?

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