From 094f7c8a84603a6b2535c6fd7fefaf25a90d1c57 Mon Sep 17 00:00:00 2001 From: Fabian Felix Selbach Date: Tue, 20 Feb 2024 19:21:11 +0100 Subject: [PATCH] Add Readme --- Readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..6a7ea92 --- /dev/null +++ b/Readme.md @@ -0,0 +1,17 @@ +# FC-KB diy keyboard software for milk-v duo + +## General project structure +### kbdrv-main.c +This file contains all the program code required to scan the keyboard matrix as well as assemble and send the hid reports. + +### keyboard\_mapping.h +This file contains all the configuration and mapping of the device you are working with. This includes the GPIO pin mapping to rows/columns, matrix to binding +identifier and binding identifier to hid-modifiers/hid-usage codes. Currently there is no support for binding multiple actions to one key. + +## Important notes + +While this project is designed to be used with the Milk-V duo range of devices it does **not** work out of the box because it assumes that a USB HID gadget is +configured in the UDC. To achieve this you need to modify the /etc/usb-run.sh script to be able to probe usb-hid *and* recompile the kernel to enable the +USB HID gadget support and configuration of this feature through configfs. + +The project should also be easily portable to any linux device with a configured USB HID gadget and GPIO support through wiringX.