RP2040 emulator for the testing and debugging of PIO programs
Project description
Emulator for the PIO Blocks within the RP2040 Microcontroller (Python Edition)
Introduction
An emulator for the Programmable Input/Output (PIO) blocks that are present within the Raspberry Pi Foundation's RP2040 Microcontroller. It is designed to assist in the analysis of PIO programs and to help you by:
- Enabling unit tests to be written.
- Answering questions such as: How many clock cycles are being consumed?
- Supporting the visualization of GPIO outputs over time.
- Providing alternatives to debugging on real hardware, which can be time consuming.
Quick Start
Below is a slight variation of the example used within the Quick Start Guide.
from pioemu import emulate
program = [0xE029, 0x0041, 0x2080] # Count down from 9 using X register
generator = emulate(program, stop_when=lambda _, state: state.x_register < 0)
for before, after in generator:
print(f"X register: {before.x_register} -> {after.x_register}")
Additional Examples
Some additional examples include:
-
Visualisation of square wave program using Jupyter Notebooks within the
examples/
directory. -
TDD example for the Pimoroni Blinkt! within the
examples/
directory.
Supported Instructions
Instruction | Supported | Notes |
---|---|---|
JMP | :heavy_check_mark: | |
WAIT | :heavy_check_mark: :warning: | IRQ variant is not supported |
IN | :heavy_multiplication_x: | |
OUT | :heavy_check_mark: :construction: | PC, ISR and EXEC destinations not implemented |
PUSH | :heavy_check_mark: :construction: | IfEmpty variant not implemented |
PULL | :heavy_check_mark: :construction: | IfEmpty variant not implemented |
MOV | :heavy_check_mark: :construction: | Some variants and operations not implemented |
IRQ | :heavy_multiplication_x: | |
SET | :heavy_check_mark: |
Known Limitations
This software is under development and currently has limitations - the notable ones are:
-
Not all of the available instructions are supported - please refer to the table above.
-
No support for pin-sets associated with OUT, SET or IN; all pin numbers are with respect to GPIO 0.
-
Pin-sets do not wrap after GPIO 31.
-
No direct support for the concurrent running of multiple PIO programs; a single State Machine is emulated and not an entire PIO block.
Thanks To
- aaronjamt for contributing features and fixes.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for rp2040_pio_emulator-0.76.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc79d2949e5e5cc8bd0979841144dc1aeda08cec8779f360662762495b457a1e |
|
MD5 | 3c413c7c85337a92b100b206b9a58f73 |
|
BLAKE2b-256 | 58e24910647adcb1bf8a3aba8136b3292dc28af0febeeebaa1cd64f2201d588e |
Hashes for rp2040_pio_emulator-0.76.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10c5406304d78457c9a01fb18ba29cc2012d91736fd282830466a0ce148192e9 |
|
MD5 | 63c199751df1de8dcdf7ba0e7d7e659e |
|
BLAKE2b-256 | 21c7b3409e36566f38abd47cda854a72391e5221fe8e78ce62cc0c3f5e529c8d |