Skip to content
This repository was archived by the owner on Oct 19, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Native MicroPython display **interface** modules for PyDevices `displaydev` (`US
Portable code in `src/ports/common/`; SoC code under `src/ports/<mp-port>/`;
desktop SDL (`usdl2`) under `src/ports/desktop/usdl2/`. The `jpegio` JPEG
decoder moved to micropython-pydevices' `modules/jpegio` (2026-10-06). CircuitPython: MCU
interfaces stay on stock CP; only `usdl2` uses `./apply_cp_patches.sh` (unix).
interfaces stay on stock CP; only `usdl2` builds there, on unix, as a user C module
(root `micropython.mk`).

**Before editing lifecycle / soft-reset / a new board bring-up**, read:

Expand All @@ -21,14 +22,13 @@ attr / soft-reset patterns when changing siblings.
|------|----------|
| `src/include/` | Public headers (`displayif/` subdir) |
| `src/ports/` | Port C sources + per-port `micropython.mk` / `.cmake` (`common/`, `esp32/`, `desktop/usdl2/`, …) |
| `src/circuitpython_spike/` | CP unix spike for `usdl2` (copied by `apply_cp_patches.sh`) |
| `docs/` | Markdown docs (root keeps `README.md` and `AGENTS.md` only) |
| `docs/ports/` | Per-port notes moved from former `ports/*/README.md` |
| `tests/` | Unit tests only (e.g. `test_lifecycle_api.py`) |
| `tools/` | Developer / hardware smoke tests (`*_smoke.py`), `test_usdl2.py`, `sdl2_dev_env.sh` |

Root `micropython.mk` / `micropython.cmake` stay at the repo root for `USER_C_MODULES`.
Desktop also: root `circuitpython.mk` + `apply_cp_patches.sh` (unix `usdl2` only).
CircuitPython reads the same root `micropython.mk` (unix `usdl2` only).

## Hard rules

Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,7 @@ user C module, `make -C ports/unix USER_C_MODULES=/path/to/displayif` from a
CircuitPython 11 checkout, or micropython-pydevices'
`./build_mp.py --interpreter circuitpython --port unix --modules displayif`.
Only `usdl2` builds there; any other CircuitPython port refuses this module,
because boards there use CircuitPython's own `displayio`. (`./apply_cp_patches.sh`
still patches a CircuitPython tree the older way.)
because boards there use CircuitPython's own `displayio`.

### First run (unix `usdl2` smoke)

Expand Down
7 changes: 4 additions & 3 deletions UPSTREAM
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ Org-pinned upstream (the ref CI builds against): v1.29.0
https://github.com/micropython/micropython @ v1.29.0
Verify locally with: git -C <your micropython checkout> describe --tags # expect v1.29.0

## CircuitPython (usdl2 desktop path only, via apply_cp_patches.sh)
Org oracle (same pin as audiodsp/CIRCUITPYTHON_ORACLE): 10.2.1
https://github.com/adafruit/circuitpython @ bcfcb511352652d7cb62d3b415e4a624380f1830
## CircuitPython (usdl2 desktop path only, as a user C module)
Tested against: 11.0.0-alpha.1 (CircuitPython 11 is the first line whose
USER_C_MODULES block matches MicroPython 1.29's)
https://github.com/adafruit/circuitpython @ 520805e12

## SDL2 (desktop usdl2 backend)
Minimum: >= 2.0 (SDL_* API used by src/ports/desktop/usdl2/)
Expand Down
Loading
Loading