Egor Rumjantsev / mbed

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

Fork of mbed by mbed official

TARGET_NUCLEO_F411RE/stm32f4xx_hal_rng.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
86:04dd9b1680ae 
12

Who changed what in which revision?

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