Implement basic keyboard firmware

Lights up capslock LED and when in USB suspend blinks it every 500ms.

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Author: JohnAZoidberg

.github/workflows/firmware.yml

@@ -34,18 +34,21 @@ jobs:
       - run: cargo install flip-link
       - run: cargo make --cwd b1display
       - run: cargo make --cwd c1minimal
+      - run: cargo make --cwd keyboard
       - run: cargo make --cwd ledmatrix build-release
       - run: cargo make --cwd ledmatrix build-release-10k
       - run: cargo make --cwd ledmatrix build-release-evt
       - run: cargo make --cwd b1display build-release
       - run: cargo make --cwd c1minimal build-release
+      - run: cargo make --cwd keyboard build-release
 
       - name: Convert to UF2 format
         run: |
             sudo apt-get update
             sudo apt-get install -y libudev-dev
             cargo make --cwd b1display uf2
             cargo make --cwd c1minimal uf2
+            cargo make --cwd keyboard uf2
             cargo make --cwd ledmatrix build-release-10k-uf2
             cargo make --cwd ledmatrix build-release-evt-uf2
             cargo make --cwd ledmatrix uf2
@@ -56,6 +59,7 @@ jobs:
             sudo apt-get install -y llvm
             cargo make --cwd b1display bin
             cargo make --cwd c1minimal bin
+            cargo make --cwd keyboard bin
             cargo make --cwd ledmatrix bin
 
       - name: Upload ledmatrix files
@@ -87,6 +91,14 @@ jobs:
             target/thumbv6m-none-eabi/release/c1minimal.bin
             target/thumbv6m-none-eabi/release/c1minimal.uf2
 
+      - name: Upload keyboard files
+        uses: actions/upload-artifact@v3
+        with:
+          name: c1minimal_fw_${{github.sha}}
+          path: |
+            target/thumbv6m-none-eabi/release/keyboard.bin
+            target/thumbv6m-none-eabi/release/keyboard.uf2
+
   linting:
     name: Linting
     runs-on: ubuntu-latest
@@ -103,6 +115,7 @@ jobs:
           sudo apt-get install -y libudev-dev
           cargo make clippy --cwd b1display
           cargo make clippy --cwd c1minimal
+          cargo make clippy --cwd keyboard
           cargo make clippy --cwd ledmatrix
 
       # fl16-inputmodules/src/serialnum.rs
@@ -114,6 +127,7 @@ jobs:
           cargo pkgid -p fl16-inputmodules | cut -d "#" -f2 >> versions.tmp
           cargo pkgid -p b1display | cut -d "#" -f2 >> versions.tmp
           cargo pkgid -p c1minimal | cut -d "#" -f2 >> versions.tmp
+          cargo pkgid -p keyboard | cut -d "#" -f2 >> versions.tmp
           cargo pkgid -p ledmatrix | cut -d "#" -f2 >> versions.tmp
           uniq -c versions.tmp | [ $(wc -l) -eq 1 ]
 
@@ -129,5 +143,6 @@ jobs:
       - run: |
           cargo fmt -p b1display -- --check
           cargo fmt -p c1minimal -- --check
+          cargo fmt -p keyboard -- --check
           cargo fmt -p ledmatrix -- --check
           cargo fmt -p fl16-inputmodules -- --check

.github/workflows/software.yml

@@ -8,6 +8,7 @@ on:
     paths-ignore:
       - 'b1display/**'
       - 'c1minimal/**'
+      - 'keyboard/**'
       - 'fl16-inputmodules/**'
       - 'ledmatrix/**'
   pull_request:
@@ -16,6 +17,7 @@ on:
     paths-ignore:
       - 'b1display/**'
       - 'c1minimal/**'
+      - 'keyboard/**'
       - 'fl16-inputmodules/**'
       - 'ledmatrix/**'
 

.github/workflows/traditional-cargo.yml

@@ -36,6 +36,7 @@ jobs:
       - run: cargo build -p ledmatrix --features evt
       - run: cargo build -p b1display
       - run: cargo build -p c1minimal
+      - run: cargo build -p keyboard
 
   linux-software:
     name: Build Linux
@@ -92,6 +93,7 @@ jobs:
         run: |
           cargo clippy -p b1display -- --deny=warnings
           cargo clippy -p c1minimal -- --deny=warnings
+          cargo clippy -p keyboard -- --deny=warnings
           cargo clippy -p ledmatrix -- --deny=warnings
           cargo clippy -p fl16-inputmodules -- --deny=warnings
 

Cargo.lock

@@ -7,6 +7,7 @@ resolver = "2"
 members = [
     "b1display",
     "c1minimal",
+    "keyboard",
     "ledmatrix",
     "fl16-inputmodules",
     "inputmodule-control",
@@ -57,6 +58,12 @@ incremental = true
 # To allow single-stepping through code use 0. Will cause timing issues, though
 opt-level = 3
 
+[profile.dev.package.keyboard]
+codegen-units = 1
+incremental = true
+# To allow single-stepping through code use 0. Will cause timing issues, though
+opt-level = 3
+
 [profile.dev.package.b1display]
 codegen-units = 1
 incremental = true

Cargo.toml

@@ -47,3 +47,4 @@ default = []
 ledmatrix = ["is31fl3741"]
 b1display = ["st7306", "embedded-graphics", "tinybmp"]
 c1minimal = ["smart-leds", "ws2812-pio"]
+keyboard = []

fl16-inputmodules/Cargo.toml

@@ -0,0 +1,97 @@
+// Taken from rp_pico hal and adjusted
+
+pub extern crate rp2040_hal as hal;
+
+extern crate cortex_m_rt;
+pub use hal::entry;
+
+/// The linker will place this boot block at the start of our program image. We
+/// need this to help the ROM bootloader get our code up and running.
+#[link_section = ".boot2"]
+#[no_mangle]
+#[used]
+pub static BOOT2_FIRMWARE: [u8; 256] = rp2040_boot2::BOOT_LOADER_W25Q080;
+
+pub use hal::pac;
+
+hal::bsp_pins!(
+    /// GPIO 0 is connected to the SLEEP# pin of the EC
+    Gpio0 { name: sleep },
+    /// Mux selector A
+    Gpio1 { name: mux_a },
+    /// Mux selector B
+    Gpio2 { name: mux_b },
+    /// Mux selector C
+    Gpio3 { name: mux_c },
+    /// Mux enable
+    Gpio4 { name: mux_enable },
+    /// Pull low when firmware has started to turn off bootloader logic
+    Gpio5 { name: boot_done },
+    /// Connected to KSI5 but unused, should use high-Z
+    Gpio6 {
+        name: ksi5_reserved
+    },
+    /// Connected to KSI5 but unused, should use high-Z
+    Gpio7 {
+        name: ksi6_reserved
+    },
+    /// Keyboard column drive
+    Gpio8 { name: kso0 },
+    /// Keyboard column drive
+    Gpio9 { name: kso1 },
+    /// Keyboard column drive
+    Gpio10 { name: kso2 },
+    /// Keyboard column drive
+    Gpio11 { name: kso3 },
+    /// Keyboard column drive
+    Gpio12 { name: kso4 },
+    /// Keyboard column drive
+    Gpio13 { name: kso5 },
+    /// Keyboard column drive
+    Gpio14 { name: kso6 },
+    /// Keyboard column drive
+    Gpio15 { name: kso7 },
+    /// Keyboard column drive
+    Gpio16 { name: kso13 },
+    /// Keyboard column drive
+    Gpio17 { name: kso12 },
+    /// Keyboard column drive
+    Gpio18 { name: kso11 },
+    /// Keyboard column drive
+    Gpio19 { name: kso10 },
+    /// Keyboard column drive
+    Gpio20 { name: kso9 },
+    /// Keyboard column drive
+    Gpio21 { name: kso8 },
+    /// Keyboard column drive
+    Gpio22 { name: kso15 },
+    /// Keyboard column drive
+    Gpio23 { name: kso14 },
+    /// Capslock LED
+    Gpio24 { name: caps_led },
+    /// Single zone backlight (unused on RGB keyboard)
+    Gpio25 { name: backlight },
+    /// GPIO 26 is connected to I2C SDA of the LED controller
+    Gpio26 {
+        name: gpio26,
+        aliases: {
+            /// I2C Function alias for pin [crate::Pins::gpio26].
+            FunctionI2C: Gp26I2C1Sda
+        }
+    },
+    /// GPIO 27 is connected to I2C SCL of the LED controller
+    Gpio27 {
+        name: gpio27,
+        aliases: {
+            /// I2C Function alias for pin [crate::Pins::gpio27].
+            FunctionI2C: Gp27I2C1Scl
+        }
+    },
+    /// Analog IN from mux
+    Gpio28 { name: analog_in },
+    /// GPIO 29 is connected to the SDB pin of the LED controller
+    Gpio29 { name: sdb },
+);
+
+// External crystal frequency, same as Raspberry Pi Pico
+pub const XOSC_CRYSTAL_FREQ: u32 = 12_000_000;

fl16-inputmodules/src/keyboard_hal.rs

@@ -5,8 +5,13 @@
     all(feature = "ledmatrix", feature = "b1display"),
     all(feature = "ledmatrix", feature = "c1minimal"),
     all(feature = "b1display", feature = "c1minimal"),
+    all(feature = "ledmatrix", feature = "keyboard"),
+    all(feature = "b1display", feature = "keyboard"),
+    all(feature = "c1minimal", feature = "keyboard"),
 ))]
-compile_error!("Features \"ledmatrix\", \"b1display\", and \"c1minimal\" are mutually exclusive");
+compile_error!(
+    "Features \"ledmatrix\", \"b1display\", \"c1minimal\", and \"keyboard\" are mutually exclusive"
+);
 
 #[cfg(feature = "ledmatrix")]
 pub mod fl16;
@@ -30,5 +35,8 @@ pub mod lcd_hal;
 #[cfg(feature = "c1minimal")]
 pub mod minimal_hal;
 
+#[cfg(feature = "keyboard")]
+pub mod keyboard_hal;
+
 pub mod control;
 pub mod serialnum;

fl16-inputmodules/src/lib.rs

@@ -0,0 +1,39 @@
+[package]
+edition = "2021"
+name = "keyboard"
+version = "0.1.7"
+
+[features]
+default = ["macropad"]
+cli = []
+ansi = []
+iso = []
+jis = []
+numpad = []
+macropad = []
+
+[dependencies]
+cortex-m.workspace = true
+cortex-m-rt.workspace = true
+embedded-hal.workspace = true
+
+defmt.workspace = true
+defmt-rtt.workspace = true
+
+#panic-probe.workspace = true
+rp2040-panic-usb-boot.workspace = true
+
+# Not using an external BSP, we've got the Framework Laptop 16 BSPs locally in this crate
+rp2040-hal.workspace = true
+rp2040-boot2.workspace = true
+
+# USB Serial
+usb-device.workspace = true
+heapless.workspace = true
+usbd-serial.workspace = true
+usbd-hid.workspace = true
+fugit.workspace = true
+
+[dependencies.fl16-inputmodules]
+path = "../fl16-inputmodules"
+features = ["keyboard"]

keyboard/Cargo.toml

@@ -0,0 +1,12 @@
+extend = "../Makefile.toml"
+
+[tasks.uf2]
+command = "elf2uf2-rs"
+args = ["../target/thumbv6m-none-eabi/release/b1display", "../target/thumbv6m-none-eabi/release/b1display.uf2"]
+dependencies = ["build-release"]
+install_crate = "elf2uf2-rs"
+
+[tasks.bin]
+command = "llvm-objcopy"
+args = ["-Obinary", "../target/thumbv6m-none-eabi/release/b1display", "../target/thumbv6m-none-eabi/release/b1display.bin"]
+dependencies = ["build-release"]

keyboard/Makefile.toml

@@ -0,0 +1,4 @@
+# Keyboard
+
+NOT THE OFFICIAL Keyboard firmware
+Just experimental reference code for building keyboard firmare in Rust