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_MTS_MDOT_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:
93:e188a91d3eaa 
12

Who changed what in which revision?

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