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_check_mark: | |
OUT | :heavy_check_mark: :construction: | EXEC destination not implemented |
PUSH | :heavy_check_mark: | |
PULL | :heavy_check_mark: | |
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.80.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7358ad86cb64d5bd9c99cbeafc02266c59b3ebe0db81b5697765e0cfa7532688 |
|
MD5 | 0227fc6aaf6cd13e3e58cb7c18e85f53 |
|
BLAKE2b-256 | c911f5ef22205bc148bf873362871015696dcc56c252ae916b28080bd3be2d15 |
Hashes for rp2040_pio_emulator-0.80.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b61ea26dea27f107d94ecc59e6ff347243f633c7996996e658afda6fc92cde38 |
|
MD5 | d73dd0d93b9af0e27b43632b424d67fa |
|
BLAKE2b-256 | 676618e8ae431edbf6bac487c281ba9df2814af1e5fac9259317f414aa688588 |