From 90661e174826684debe2532a260dcefb3b871067 Mon Sep 17 00:00:00 2001 From: Nathan Ringo Date: Sat, 5 Oct 2024 10:11:25 -0500 Subject: Add mention of the usbkbd/ dir in the README. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') 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/ -- cgit v1.2.3