Senior Design: Sound Monitor / STM32L4xx_HAL_Driver

L4 HAL Drivers

Inc/stm32l4xx_hal_rng.h@0:80ee8f3b695e, 2015-11-02 (annotated)

Committer:
EricLew
Date:
Mon Nov 02 19:37:23 2015 +0000
Revision:
0:80ee8f3b695e
Errors are with definitions of LCD and QSPI functions. I believe all .h and .c files are  uploaded, but there may need to be certain functions called.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
EricLew 0:80ee8f3b695e 1 /**
EricLew 0:80ee8f3b695e 2 ******************************************************************************
EricLew 0:80ee8f3b695e 3 * @file stm32l4xx_hal_rng.h
EricLew 0:80ee8f3b695e 4 * @author MCD Application Team
EricLew 0:80ee8f3b695e 5 * @version V1.1.0
EricLew 0:80ee8f3b695e 6 * @date 16-September-2015
EricLew 0:80ee8f3b695e 7 * @brief Header file of RNG HAL module.
EricLew 0:80ee8f3b695e 8 ******************************************************************************
EricLew 0:80ee8f3b695e 9 * @attention
EricLew 0:80ee8f3b695e 10 *
EricLew 0:80ee8f3b695e 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
EricLew 0:80ee8f3b695e 12 *
EricLew 0:80ee8f3b695e 13 * Redistribution and use in source and binary forms, with or without modification,
EricLew 0:80ee8f3b695e 14 * are permitted provided that the following conditions are met:
EricLew 0:80ee8f3b695e 15 * 1. Redistributions of source code must retain the above copyright notice,
EricLew 0:80ee8f3b695e 16 * this list of conditions and the following disclaimer.
EricLew 0:80ee8f3b695e 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
EricLew 0:80ee8f3b695e 18 * this list of conditions and the following disclaimer in the documentation
EricLew 0:80ee8f3b695e 19 * and/or other materials provided with the distribution.
EricLew 0:80ee8f3b695e 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
EricLew 0:80ee8f3b695e 21 * may be used to endorse or promote products derived from this software
EricLew 0:80ee8f3b695e 22 * without specific prior written permission.
EricLew 0:80ee8f3b695e 23 *
EricLew 0:80ee8f3b695e 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
EricLew 0:80ee8f3b695e 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
EricLew 0:80ee8f3b695e 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
EricLew 0:80ee8f3b695e 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
EricLew 0:80ee8f3b695e 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
EricLew 0:80ee8f3b695e 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
EricLew 0:80ee8f3b695e 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
EricLew 0:80ee8f3b695e 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
EricLew 0:80ee8f3b695e 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
EricLew 0:80ee8f3b695e 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
EricLew 0:80ee8f3b695e 34 *
EricLew 0:80ee8f3b695e 35 ******************************************************************************
EricLew 0:80ee8f3b695e 36 */
EricLew 0:80ee8f3b695e 37
EricLew 0:80ee8f3b695e 38 /* Define to prevent recursive inclusion -------------------------------------*/
EricLew 0:80ee8f3b695e 39 #ifndef __STM32L4xx_HAL_RNG_H
EricLew 0:80ee8f3b695e 40 #define __STM32L4xx_HAL_RNG_H
EricLew 0:80ee8f3b695e 41
EricLew 0:80ee8f3b695e 42 #ifdef __cplusplus
EricLew 0:80ee8f3b695e 43 extern "C" {
EricLew 0:80ee8f3b695e 44 #endif
EricLew 0:80ee8f3b695e 45
EricLew 0:80ee8f3b695e 46 /* Includes ------------------------------------------------------------------*/
EricLew 0:80ee8f3b695e 47 #include "stm32l4xx_hal_def.h"
EricLew 0:80ee8f3b695e 48
EricLew 0:80ee8f3b695e 49 /** @addtogroup STM32L4xx_HAL_Driver
EricLew 0:80ee8f3b695e 50 * @{
EricLew 0:80ee8f3b695e 51 */
EricLew 0:80ee8f3b695e 52
EricLew 0:80ee8f3b695e 53 /** @addtogroup RNG
EricLew 0:80ee8f3b695e 54 * @{
EricLew 0:80ee8f3b695e 55 */
EricLew 0:80ee8f3b695e 56
EricLew 0:80ee8f3b695e 57 /* Exported types ------------------------------------------------------------*/
EricLew 0:80ee8f3b695e 58 /** @defgroup RNG_Exported_Types RNG Exported Types
EricLew 0:80ee8f3b695e 59 * @{
EricLew 0:80ee8f3b695e 60 */
EricLew 0:80ee8f3b695e 61
EricLew 0:80ee8f3b695e 62 /**
EricLew 0:80ee8f3b695e 63 * @brief RNG HAL State Structure definition
EricLew 0:80ee8f3b695e 64 */
EricLew 0:80ee8f3b695e 65 typedef enum
EricLew 0:80ee8f3b695e 66 {
EricLew 0:80ee8f3b695e 67 HAL_RNG_STATE_RESET = 0x00, /*!< RNG not yet initialized or disabled */
EricLew 0:80ee8f3b695e 68 HAL_RNG_STATE_READY = 0x01, /*!< RNG initialized and ready for use */
EricLew 0:80ee8f3b695e 69 HAL_RNG_STATE_BUSY = 0x02, /*!< RNG internal process is ongoing */
EricLew 0:80ee8f3b695e 70 HAL_RNG_STATE_TIMEOUT = 0x03, /*!< RNG timeout state */
EricLew 0:80ee8f3b695e 71 HAL_RNG_STATE_ERROR = 0x04 /*!< RNG error state */
EricLew 0:80ee8f3b695e 72
EricLew 0:80ee8f3b695e 73 }HAL_RNG_StateTypeDef;
EricLew 0:80ee8f3b695e 74
EricLew 0:80ee8f3b695e 75 /**
EricLew 0:80ee8f3b695e 76 * @brief RNG Handle Structure definition
EricLew 0:80ee8f3b695e 77 */
EricLew 0:80ee8f3b695e 78 typedef struct
EricLew 0:80ee8f3b695e 79 {
EricLew 0:80ee8f3b695e 80 RNG_TypeDef *Instance; /*!< Register base address */
EricLew 0:80ee8f3b695e 81
EricLew 0:80ee8f3b695e 82 HAL_LockTypeDef Lock; /*!< RNG locking object */
EricLew 0:80ee8f3b695e 83
EricLew 0:80ee8f3b695e 84 __IO HAL_RNG_StateTypeDef State; /*!< RNG communication state */
EricLew 0:80ee8f3b695e 85
EricLew 0:80ee8f3b695e 86 uint32_t RandomNumber; /*!< Last Generated RNG Data */
EricLew 0:80ee8f3b695e 87
EricLew 0:80ee8f3b695e 88 }RNG_HandleTypeDef;
EricLew 0:80ee8f3b695e 89
EricLew 0:80ee8f3b695e 90 /**
EricLew 0:80ee8f3b695e 91 * @}
EricLew 0:80ee8f3b695e 92 */
EricLew 0:80ee8f3b695e 93
EricLew 0:80ee8f3b695e 94 /* Exported constants --------------------------------------------------------*/
EricLew 0:80ee8f3b695e 95 /** @defgroup RNG_Exported_Constants RNG Exported Constants
EricLew 0:80ee8f3b695e 96 * @{
EricLew 0:80ee8f3b695e 97 */
EricLew 0:80ee8f3b695e 98
EricLew 0:80ee8f3b695e 99 /** @defgroup RNG_Interrupt_definition RNG Interrupts Definition
EricLew 0:80ee8f3b695e 100 * @{
EricLew 0:80ee8f3b695e 101 */
EricLew 0:80ee8f3b695e 102 #define RNG_IT_DRDY RNG_SR_DRDY /*!< Data Ready interrupt */
EricLew 0:80ee8f3b695e 103 #define RNG_IT_CEI RNG_SR_CEIS /*!< Clock error interrupt */
EricLew 0:80ee8f3b695e 104 #define RNG_IT_SEI RNG_SR_SEIS /*!< Seed error interrupt */
EricLew 0:80ee8f3b695e 105 /**
EricLew 0:80ee8f3b695e 106 * @}
EricLew 0:80ee8f3b695e 107 */
EricLew 0:80ee8f3b695e 108
EricLew 0:80ee8f3b695e 109 /** @defgroup RNG_Flag_definition RNG Flags Definition
EricLew 0:80ee8f3b695e 110 * @{
EricLew 0:80ee8f3b695e 111 */
EricLew 0:80ee8f3b695e 112 #define RNG_FLAG_DRDY RNG_SR_DRDY /*!< Data ready */
EricLew 0:80ee8f3b695e 113 #define RNG_FLAG_CECS RNG_SR_CECS /*!< Clock error current status */
EricLew 0:80ee8f3b695e 114 #define RNG_FLAG_SECS RNG_SR_SECS /*!< Seed error current status */
EricLew 0:80ee8f3b695e 115 /**
EricLew 0:80ee8f3b695e 116 * @}
EricLew 0:80ee8f3b695e 117 */
EricLew 0:80ee8f3b695e 118
EricLew 0:80ee8f3b695e 119 /**
EricLew 0:80ee8f3b695e 120 * @}
EricLew 0:80ee8f3b695e 121 */
EricLew 0:80ee8f3b695e 122
EricLew 0:80ee8f3b695e 123 /* Exported macros -----------------------------------------------------------*/
EricLew 0:80ee8f3b695e 124 /** @defgroup RNG_Exported_Macros RNG Exported Macros
EricLew 0:80ee8f3b695e 125 * @{
EricLew 0:80ee8f3b695e 126 */
EricLew 0:80ee8f3b695e 127
EricLew 0:80ee8f3b695e 128 /** @brief Reset RNG handle state.
EricLew 0:80ee8f3b695e 129 * @param __HANDLE__: RNG Handle
EricLew 0:80ee8f3b695e 130 * @retval None
EricLew 0:80ee8f3b695e 131 */
EricLew 0:80ee8f3b695e 132 #define __HAL_RNG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RNG_STATE_RESET)
EricLew 0:80ee8f3b695e 133
EricLew 0:80ee8f3b695e 134 /**
EricLew 0:80ee8f3b695e 135 * @brief Enable the RNG peripheral.
EricLew 0:80ee8f3b695e 136 * @param __HANDLE__: RNG Handle
EricLew 0:80ee8f3b695e 137 * @retval None
EricLew 0:80ee8f3b695e 138 */
EricLew 0:80ee8f3b695e 139 #define __HAL_RNG_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= RNG_CR_RNGEN)
EricLew 0:80ee8f3b695e 140
EricLew 0:80ee8f3b695e 141 /**
EricLew 0:80ee8f3b695e 142 * @brief Disable the RNG peripheral.
EricLew 0:80ee8f3b695e 143 * @param __HANDLE__: RNG Handle
EricLew 0:80ee8f3b695e 144 * @retval None
EricLew 0:80ee8f3b695e 145 */
EricLew 0:80ee8f3b695e 146 #define __HAL_RNG_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~RNG_CR_RNGEN)
EricLew 0:80ee8f3b695e 147
EricLew 0:80ee8f3b695e 148 /**
EricLew 0:80ee8f3b695e 149 * @brief Check whether the specified RNG flag is set or not.
EricLew 0:80ee8f3b695e 150 * @param __HANDLE__: RNG Handle
EricLew 0:80ee8f3b695e 151 * @param __FLAG__: RNG flag
EricLew 0:80ee8f3b695e 152 * This parameter can be one of the following values:
EricLew 0:80ee8f3b695e 153 * @arg RNG_FLAG_DRDY: Data ready
EricLew 0:80ee8f3b695e 154 * @arg RNG_FLAG_CECS: Clock error current status
EricLew 0:80ee8f3b695e 155 * @arg RNG_FLAG_SECS: Seed error current status
EricLew 0:80ee8f3b695e 156 * @retval The new state of __FLAG__ (SET or RESET).
EricLew 0:80ee8f3b695e 157 */
EricLew 0:80ee8f3b695e 158 #define __HAL_RNG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
EricLew 0:80ee8f3b695e 159
EricLew 0:80ee8f3b695e 160
EricLew 0:80ee8f3b695e 161 /**
EricLew 0:80ee8f3b695e 162 * @brief Clear the selected RNG flag status.
EricLew 0:80ee8f3b695e 163 * @param __HANDLE__: RNG handle
EricLew 0:80ee8f3b695e 164 * @param __FLAG__: RNG flag to clear
EricLew 0:80ee8f3b695e 165 * @note WARNING: This is a dummy macro for HAL code alignment,
EricLew 0:80ee8f3b695e 166 * flags RNG_FLAG_DRDY, RNG_FLAG_CECS and RNG_FLAG_SECS are read-only.
EricLew 0:80ee8f3b695e 167 * @retval None
EricLew 0:80ee8f3b695e 168 */
EricLew 0:80ee8f3b695e 169 #define __HAL_RNG_CLEAR_FLAG(__HANDLE__, __FLAG__) /* dummy macro */
EricLew 0:80ee8f3b695e 170
EricLew 0:80ee8f3b695e 171
EricLew 0:80ee8f3b695e 172
EricLew 0:80ee8f3b695e 173 /**
EricLew 0:80ee8f3b695e 174 * @brief Enable the RNG interrupt.
EricLew 0:80ee8f3b695e 175 * @param __HANDLE__: RNG Handle
EricLew 0:80ee8f3b695e 176 * @retval None
EricLew 0:80ee8f3b695e 177 */
EricLew 0:80ee8f3b695e 178 #define __HAL_RNG_ENABLE_IT(__HANDLE__) ((__HANDLE__)->Instance->CR |= RNG_CR_IE)
EricLew 0:80ee8f3b695e 179
EricLew 0:80ee8f3b695e 180 /**
EricLew 0:80ee8f3b695e 181 * @brief Disable the RNG interrupt.
EricLew 0:80ee8f3b695e 182 * @param __HANDLE__: RNG Handle
EricLew 0:80ee8f3b695e 183 * @retval None
EricLew 0:80ee8f3b695e 184 */
EricLew 0:80ee8f3b695e 185 #define __HAL_RNG_DISABLE_IT(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~RNG_CR_IE)
EricLew 0:80ee8f3b695e 186
EricLew 0:80ee8f3b695e 187 /**
EricLew 0:80ee8f3b695e 188 * @brief Check whether the specified RNG interrupt has occurred or not.
EricLew 0:80ee8f3b695e 189 * @param __HANDLE__: RNG Handle
EricLew 0:80ee8f3b695e 190 * @param __INTERRUPT__: specifies the RNG interrupt status flag to check.
EricLew 0:80ee8f3b695e 191 * This parameter can be one of the following values:
EricLew 0:80ee8f3b695e 192 * @arg RNG_IT_DRDY: Data ready interrupt
EricLew 0:80ee8f3b695e 193 * @arg RNG_IT_CEI: Clock error interrupt
EricLew 0:80ee8f3b695e 194 * @arg RNG_IT_SEI: Seed error interrupt
EricLew 0:80ee8f3b695e 195 * @retval The new state of __INTERRUPT__ (SET or RESET).
EricLew 0:80ee8f3b695e 196 */
EricLew 0:80ee8f3b695e 197 #define __HAL_RNG_GET_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__))
EricLew 0:80ee8f3b695e 198
EricLew 0:80ee8f3b695e 199 /**
EricLew 0:80ee8f3b695e 200 * @brief Clear the RNG interrupt status flags.
EricLew 0:80ee8f3b695e 201 * @param __HANDLE__: RNG Handle
EricLew 0:80ee8f3b695e 202 * @param __INTERRUPT__: specifies the RNG interrupt status flag to clear.
EricLew 0:80ee8f3b695e 203 * This parameter can be one of the following values:
EricLew 0:80ee8f3b695e 204 * @arg RNG_IT_CEI: Clock error interrupt
EricLew 0:80ee8f3b695e 205 * @arg RNG_IT_SEI: Seed error interrupt
EricLew 0:80ee8f3b695e 206 * @note RNG_IT_DRDY flag is read-only, reading RNG_DR register automatically clears RNG_IT_DRDY.
EricLew 0:80ee8f3b695e 207 * @retval None
EricLew 0:80ee8f3b695e 208 */
EricLew 0:80ee8f3b695e 209 #define __HAL_RNG_CLEAR_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR) = ~(__INTERRUPT__))
EricLew 0:80ee8f3b695e 210
EricLew 0:80ee8f3b695e 211 /**
EricLew 0:80ee8f3b695e 212 * @}
EricLew 0:80ee8f3b695e 213 */
EricLew 0:80ee8f3b695e 214
EricLew 0:80ee8f3b695e 215
EricLew 0:80ee8f3b695e 216 /* Exported functions --------------------------------------------------------*/
EricLew 0:80ee8f3b695e 217 /** @defgroup RNG_Exported_Functions RNG Exported Functions
EricLew 0:80ee8f3b695e 218 * @{
EricLew 0:80ee8f3b695e 219 */
EricLew 0:80ee8f3b695e 220
EricLew 0:80ee8f3b695e 221 /* Initialization and de-initialization functions ******************************/
EricLew 0:80ee8f3b695e 222 /** @defgroup RNG_Exported_Functions_Group1 Initialization and de-initialization functions
EricLew 0:80ee8f3b695e 223 * @{
EricLew 0:80ee8f3b695e 224 */
EricLew 0:80ee8f3b695e 225 HAL_StatusTypeDef HAL_RNG_Init(RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 226 HAL_StatusTypeDef HAL_RNG_DeInit (RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 227 void HAL_RNG_MspInit(RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 228 void HAL_RNG_MspDeInit(RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 229 /**
EricLew 0:80ee8f3b695e 230 * @}
EricLew 0:80ee8f3b695e 231 */
EricLew 0:80ee8f3b695e 232
EricLew 0:80ee8f3b695e 233 /* Peripheral Control functions ************************************************/
EricLew 0:80ee8f3b695e 234 /** @defgroup RNG_Exported_Functions_Group2 Peripheral Control functions
EricLew 0:80ee8f3b695e 235 * @{
EricLew 0:80ee8f3b695e 236 */
EricLew 0:80ee8f3b695e 237 uint32_t HAL_RNG_GetRandomNumber(RNG_HandleTypeDef *hrng); /* Obsolete, use HAL_RNG_GenerateRandomNumber() instead */
EricLew 0:80ee8f3b695e 238 uint32_t HAL_RNG_GetRandomNumber_IT(RNG_HandleTypeDef *hrng); /* Obsolete, use HAL_RNG_GenerateRandomNumber_IT() instead */
EricLew 0:80ee8f3b695e 239
EricLew 0:80ee8f3b695e 240 HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber(RNG_HandleTypeDef *hrng, uint32_t *random32bit);
EricLew 0:80ee8f3b695e 241 HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber_IT(RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 242 uint32_t HAL_RNG_ReadLastRandomNumber(RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 243
EricLew 0:80ee8f3b695e 244 void HAL_RNG_IRQHandler(RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 245 void HAL_RNG_ErrorCallback(RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 246 void HAL_RNG_ReadyDataCallback(RNG_HandleTypeDef* hrng, uint32_t random32bit);
EricLew 0:80ee8f3b695e 247 /**
EricLew 0:80ee8f3b695e 248 * @}
EricLew 0:80ee8f3b695e 249 */
EricLew 0:80ee8f3b695e 250
EricLew 0:80ee8f3b695e 251 /* Peripheral State functions **************************************************/
EricLew 0:80ee8f3b695e 252 /** @defgroup RNG_Exported_Functions_Group3 Peripheral State functions
EricLew 0:80ee8f3b695e 253 * @{
EricLew 0:80ee8f3b695e 254 */
EricLew 0:80ee8f3b695e 255 HAL_RNG_StateTypeDef HAL_RNG_GetState(RNG_HandleTypeDef *hrng);
EricLew 0:80ee8f3b695e 256 /**
EricLew 0:80ee8f3b695e 257 * @}
EricLew 0:80ee8f3b695e 258 */
EricLew 0:80ee8f3b695e 259
EricLew 0:80ee8f3b695e 260 /**
EricLew 0:80ee8f3b695e 261 * @}
EricLew 0:80ee8f3b695e 262 */
EricLew 0:80ee8f3b695e 263
EricLew 0:80ee8f3b695e 264 /* Private types -------------------------------------------------------------*/
EricLew 0:80ee8f3b695e 265 /* Private defines -----------------------------------------------------------*/
EricLew 0:80ee8f3b695e 266 /* Private variables ---------------------------------------------------------*/
EricLew 0:80ee8f3b695e 267 /* Private constants ---------------------------------------------------------*/
EricLew 0:80ee8f3b695e 268 /* Private macros ------------------------------------------------------------*/
EricLew 0:80ee8f3b695e 269 /* Private functions prototypes ----------------------------------------------*/
EricLew 0:80ee8f3b695e 270
EricLew 0:80ee8f3b695e 271 /**
EricLew 0:80ee8f3b695e 272 * @}
EricLew 0:80ee8f3b695e 273 */
EricLew 0:80ee8f3b695e 274
EricLew 0:80ee8f3b695e 275 /**
EricLew 0:80ee8f3b695e 276 * @}
EricLew 0:80ee8f3b695e 277 */
EricLew 0:80ee8f3b695e 278
EricLew 0:80ee8f3b695e 279 #ifdef __cplusplus
EricLew 0:80ee8f3b695e 280 }
EricLew 0:80ee8f3b695e 281 #endif
EricLew 0:80ee8f3b695e 282
EricLew 0:80ee8f3b695e 283 #endif /* __STM32L4xx_HAL_RNG_H */
EricLew 0:80ee8f3b695e 284
EricLew 0:80ee8f3b695e 285 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
EricLew 0:80ee8f3b695e 286