STM32CubeF4/Projects/STM32469I_EVAL/Examples/RNG/RNG_MultiRNG/readme.txt

78 lines
3.2 KiB
Plaintext

/**
@page RNG_MultiRNG Multiple Random Numbers Generator example
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file RNG/RNG_MultiRNG/readme.txt
* @author MCD Application Team
* @brief Description of multiple random numbers generation example.
******************************************************************************
* @attention
*
* Copyright (c) 2017 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
@endverbatim
@par Example Description
Configuration of the RNG using the HAL API. This example uses the RNG to generate 32-bit long random numbers.
At the beginning of the main program the HAL_Init() function is called to reset
all the peripherals, initialize the Flash interface and the systick.
Then the SystemClock_Config() function is used to configure the system
clock (SYSCLK) to run at 180 MHz.
The RNG peripheral configuration is ensured by the HAL_RNG_Init() function.
The latter is calling the HAL_RNG_MspInit() function which implements
the configuration of the needed RNG resources according to the used hardware (CLOCK,
GPIO, DMA and NVIC). You may update this function to change RNG configuration.
After startup, user is asked to press Tamper push-button.
The 8-entry array aRandom32bit[] is filled up by 32-bit long random numbers
at each key press.
The Random numbers can be displayed on the debugger in aRandom32bit variable.
In case of error, LED3 is toggling at a frequency of 1Hz.
@note The connection of the LCD reset pin to a dedicated GPIO PK7 instead of the STM32F469 NRST pin may cause residual display on LCD with applications/examples that do not require display.
The LCD clear can be ensured by hardware through the boards power off/power on or by software calling the BSP_LCD_Reset() function.
@par Keywords
Analog, RNG, Random, FIPS PUB 140-2, Analog Random number generator, Entropy, Period
@par Directory contents
- RNG/RNG_MultiRNG/Inc/stm32f4xx_hal_conf.h HAL configuration file
- RNG/RNG_MultiRNG/Inc/stm32f4xx_it.h Interrupt handlers header file
- RNG/RNG_MultiRNG/Inc/main.h Header for main.c module
- RNG/RNG_MultiRNG/Src/stm32f4xx_it.c Interrupt handlers
- RNG/RNG_MultiRNG/Src/main.c Main program
- RNG/RNG_MultiRNG/Src/stm32f4xx_hal_msp.c HAL MSP module
- RNG/RNG_MultiRNG/Src/system_stm32f4xx.c STM32F4xx system source file
@par Hardware and Software environment
- This example runs on STM32F469xx/STM32F479xx devices.
- This example has been tested and validated with STMicroelectronics STM32469I-EVAL RevC board and can be
easily tailored to any other supported device and development board.
@par How to use it ?
In order to make the program work, you must do the following:
- Open your preferred toolchain
- Rebuild all files and load your image into target memory
- Run the example
*/