STM32CubeF7/Projects/STM32F722ZE-Nucleo/Examples/RNG/RNG_MultiRNG/readme.txt

87 lines
3.8 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/**
@page RNG_MultiRNG Multiple Random Numbers Generator example
@verbatim
******************************************************************************
* @file RNG/RNG_MultiRNG/readme.txt
* @author MCD Application Team
* @brief Description of multiple random numbers generation example.
******************************************************************************
* @attention
*
* Copyright (c) 2016 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 216 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 User 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.
@par Keywords
Analog, RNG, Random, FIPS PUB 140-2, Analog Random number generator, Entropy, Period
@Note If the user code size exceeds the DTCM-RAM size or starts from internal cacheable memories (SRAM1 and SRAM2),that is shared between several processors,
     then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
      The address and the size of cacheable buffers (shared between CPU and other masters) must be properly updated to be aligned to cache line size (32 bytes).
@Note It is recommended to enable the cache and maintain its coherence, but depending on the use case
      It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
      In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
      Even though the user must manage the cache coherence for read accesses.
      Please refer to the AN4838 “Managing memory protection unit (MPU) in STM32 MCUs”
      Please refer to the AN4839 “Level 1 cache on STM32F7 Series”
@par Directory contents
- RNG/RNG_MultiRNG/Inc/stm32f7xx_hal_conf.h HAL configuration file
- RNG/RNG_MultiRNG/Inc/stm32f7xx_it.h Interrupt handlers header file
- RNG/RNG_MultiRNG/Inc/main.h Header for main.c module
- RNG/RNG_MultiRNG/Src/stm32f7xx_it.c Interrupt handlers
- RNG/RNG_MultiRNG/Src/main.c Main program
- RNG/RNG_MultiRNG/Src/stm32f7xx_hal_msp.c HAL MSP module
- RNG/RNG_MultiRNG/Src/system_stm32f7xx.c STM32F7xx system source file
@par Hardware and Software environment
- This example runs on STM32F722xx/STM32F723xx/STM32F732xx/STM32F733xx devices.
- This example has been tested with STM32F722ZE-Nucleo 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
*/