Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/microcontroleurmonde/rp2040_rosc_rng

A Micro-python library that provides an interface to generate a random number using the recommended method (ROSC reading) by Raspberry.
https://github.com/microcontroleurmonde/rp2040_rosc_rng

micropython rng rp2040

Last synced: 8 days ago
JSON representation

A Micro-python library that provides an interface to generate a random number using the recommended method (ROSC reading) by Raspberry.

Host: GitHub
URL: https://github.com/microcontroleurmonde/rp2040_rosc_rng
Owner: MicroControleurMonde
License: cc0-1.0
Created: 2024-12-18T14:48:10.000Z (9 days ago)
Default Branch: main
Last Pushed: 2024-12-18T15:21:47.000Z (9 days ago)
Last Synced: 2024-12-18T15:41:59.436Z (9 days ago)
Topics: micropython, rng, rp2040
Homepage:
Size: 0 Bytes
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# RP2040 ROSC RNG

![Image locale](https://github.com/MicroControleurMonde/RP2040-RNG/blob/main/Reports/RP2040-resizeimage3.png)

A Micro-python library that provides an interface to generate a random number using the recommended method (ROSC reading) by Raspberry.
- Library : **rosc_random_generator.py**
- Library test : **test_rosc_random_generator.py**

---

## Context:

Raspberry foundation recently updated their Pico Datasheet:
`Datasheet - Build-date: 2024-10-15 / Build-version: eec2b0c-clean` [Link](https://datasheets.raspberrypi.com/pico/pico-datasheet.pdf)

**Page 222. Chapter 2.17. Ring Oscillator (ROSC)**, here is what we can read:

2.17.5. Random Number Generator

If the system clocks are running from the XOSC and/or PLLs the ROSC can be used to generate
random numbers. Simply enable the ROSC and read the RANDOMBIT register to get a 1-bit
random number and read it n times to get an n-bit value. This does not meet the requirements
of randomness for security systems because it can be compromised, but it may be useful in
less critical applications. If the cores are running from the ROSC then the value will not be
random because the timing of the register read will be correlated to the phase of the ROSC.

The random number generator uses the ROSC (Resonance Oscillator) to produce random bits.

---
## Project Description

This project implements a True Random Number Generator (TRNG) using the RP2040 microcontroller. The generator collects Use the Resonance Oscillator as preconized in the Datasheet.

## Requirements

- RP2040-based microcontroller.
- MicroPython firmware installed on the board.
- **`machine`**, **`time`** (built-in with MicroPython).

## Usage

1. **rosc_random_generator.py – Library for generating random numbers**

This Python library provides a class `ROSCRandomGenerator` that generates random numbers based on the RP2040's RSOC.

2. **test_rosc_random_generator.py – Example script**

This script imports the `ROSCRandomGenerator` class from rosc_random_generator.py and generates random numbers

### Installation
- Save this code in a file named `rosc_random_generator.py` .
- To use this library in another project, just import it like any Python module.

### Output Example:

The RP2040 ROSC RNG generates random integer numbers as **32-bit values**.

ROSC is stable. Starting random number generation...

Random value # 1: 2880935910
Random value # 2: 3756622924
Random value # 3: 4041343900
Random value # 4: 41689329
Random value # 5: 1860732466
Random value # 6: 2376253135
Random value # 7: 2057898098
Random value # 8: 3392796777
Random value # 9: 1501861143
Random value # 10: 238555703
## How it Works

- 1 - The program declares the variables and constants required to interact with the ROSC.
- 2 - It checks the state of the ROSC to ensure that it is stable.
- 3 - If the ROSC is stable, it generates 32-bit random values, displaying each value and regularly checking the stability of the ROSC.
- 4 - If ROSC instability is detected, it resets the ROSC to restore stability.
- 5 - Once the values have been generated, it displays an end message.

This way, this process ensures that the ROSC is correctly initialised and stable before random values are generated, and manages the reset in the event of a stability problem during the process.

## Performance

**Caution**: no writing on flash !

- Estimated time to generate 1'000'000 values: **1400 seconds** (approx. 23 minutes)
- Average time per value: **0.0014 seconds**
- Estimated Throughput: **≈ 2857 Bytes/sec**
- Number of values generated per second: **≈ 714 values/sec**

- [Data sample](https://github.com/MicroControleurMonde/RP2040_ROSC_RNG/blob/main/Reports/rp2040_rosc_rng_1Mil.txt)

## Ent Test Report

([www.fourmilab.ch](https://www.fourmilab.ch/random/)) John Walker
- Sample size: **10,7 MB**
- Total generated: **1'000'000 values**
- Entropy = **3.450903** bits per byte

- [Ent Report - Raw](https://github.com/MicroControleurMonde/RP2040_ROSC_RNG/blob/main/Reports/Ent_rp2040_rosc_rng_1Mil.txt)
- [Ent Report Analyse](https://github.com/MicroControleurMonde/RP2040_ROSC_RNG/blob/main/Reports/Ent_1Mil_Report_Analyse.md)

## Dieharder Test Report
(https://webhome.phy.duke.edu/~rgb/General/dieharder.php) Robert G. Brown

- Sample size: **10,7 MB**
- Total generated: **1'000'000 values**

- [Dieharder Report - Raw](https://github.com/MicroControleurMonde/RP2040_ROSC_RNG/blob/main/Reports/Dieharder_rp2040_rosc_rng_1Mil.txt)
- [Dieharder Report Analyses](https://github.com/MicroControleurMonde/RP2040_ROSC_RNG/blob/main/Reports/Dieharder_1Mil_Report_Analyse.md)

## Acknowledgements

The project is based on the RP2040 microcontroller, and its MicroPython firmware.
- `Waveshare RP2040-Plus: MicroPython ef518cbf2-dirty on 2023-03-24;`
- `XIAO seed studio: MicroPython v1.22.1 on 2024-01-05;`

## Disclaimer

The code contained in this repository is provided “as is”, without any warranty of performance, accuracy or result. The author shall not be liable for any direct or indirect damages that may result from the use of this code, including, but not limited to, loss of data or interruption of service.

Use of this code is entirely at your own risk. Please ensure that you fully understand the code before using it in a production environment or integrating it into your projects.

## Special tribute:

### Passing of John Walker

We are deeply saddened to hear of the passing of John Walker, one of the founders of Autodesk. He died at home in Switzerland, on 2nd February 2024, aged 74.

[The announcement was shared here.](https://www.engineering.com/a-cad-legend-passes-autodesk-founder-john-walker-1949-to-2024/)