aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNathan Ringo <nathan@remexre.com>2024-10-05 10:11:25 -0500
committerNathan Ringo <nathan@remexre.com>2024-10-05 10:11:25 -0500
commit90661e174826684debe2532a260dcefb3b871067 (patch)
tree4bf0075bb784a4951221c3462445bc6573275ac1 /README.md
parent4b291d1804ef5fc9bc6cb02c58af383066975d15 (diff)
Add mention of the usbkbd/ dir in the README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9bb3c4d..82fec48 100644
--- a/README.md
+++ b/README.md
@@ -9,11 +9,14 @@ The [original Inkplate 6 case]'s top is used (since the Inkplate came glued to i
The Inkplate provides power via a lithium battery, and access to its display, its microSD card, and its Wi-Fi and Bluetooth connectivity.
The iCEBreaker is connected to the Inkplate over both I²C and UART.
The iCEBreaker is augmented with a [quad HyperRAM PMOD] module, which it uses for main memory.
+A [CH559] is used to provide support for USB keyboards.
+It connects to the iCEBreaker over UART, essentially acting as a PS/2 keyboard would.
[iCEBreaker]: https://docs.icebreaker-fpga.org/
[Inkplate 6]: https://soldered.com/product/soldered-inkplate-6-6-e-paper-board/
[original Inkplate 6 case]: https://github.com/SolderedElectronics/Inkplate-6-hardware/blob/master/3D%20printable%20case/Original%20case
[quad HyperRAM PMOD]: https://1bitsquared.com/products/pmod-hyperram
+[CH559]: https://www.wch-ic.com/products/CH559.html
The different components are in the following subdirectories:
@@ -21,6 +24,7 @@ The different components are in the following subdirectories:
- `fpga/` contains the [Bluespec] code that runs on the iCEBreaker.
- `inkplate/` contains the code that runs on the Inkplate.
- `simhost/` contains Rust code that implements simulated peripherals for bluesim.
+- `usbkbd/` contains the C code that runs on the CH559.
[Bluespec]: https://github.com/B-Lang-org/bsc
[OpenSCAD]: https://openscad.org/