Add OP36 Qube RMK upstream firmware

Author: kissetfall

.github/workflows/build.yml

@@ -165,6 +165,105 @@ jobs:
           path: keyboards/${{ matrix.keyboard }}/${{ matrix.output_name }}.uf2
           retention-days: 30
 
+  build-op36-qube:
+    name: Build OP36 Qube firmware
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install ARM toolchain
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -y --no-install-recommends gcc-arm-none-eabi binutils-arm-none-eabi libnewlib-arm-none-eabi clang libclang-dev
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: thumbv7em-none-eabihf
+
+      - name: Cache cargo registry
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+          key: ${{ runner.os }}-cargo-op36-qube-${{ hashFiles('keyboards/op36_qube/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-op36-qube-
+            ${{ runner.os }}-cargo-
+
+      - name: Install flip-link
+        run: cargo install flip-link --locked
+
+      - name: Download uf2conv script
+        run: |
+          for i in 1 2 3 4 5; do
+            curl -fL --retry 3 --retry-delay 5 \
+              https://raw.githubusercontent.com/microsoft/uf2/master/utils/uf2conv.py \
+              -o uf2conv.py && break || sleep 10
+          done
+          for i in 1 2 3; do
+            curl -fL --retry 3 --retry-delay 5 \
+              https://raw.githubusercontent.com/microsoft/uf2/master/utils/uf2families.json \
+              -o uf2families.json && break || sleep 10
+          done
+          python3 -c "import ast; ast.parse(open('uf2conv.py').read())" || { echo "uf2conv.py invalid"; exit 1; }
+          chmod +x uf2conv.py
+
+      - name: Build Qube dongle
+        working-directory: keyboards/op36_qube
+        env:
+          BINDGEN_EXTRA_CLANG_ARGS: "--sysroot=/usr/lib/arm-none-eabi --target=arm-none-eabi -I/usr/lib/arm-none-eabi/include -I/usr/lib/gcc/arm-none-eabi/13.2.1/include"
+          RUST_MIN_STACK: "16777216"
+        run: cargo build --release --bin qube --features qube
+
+      - name: Build left half
+        working-directory: keyboards/op36_qube
+        env:
+          BINDGEN_EXTRA_CLANG_ARGS: "--sysroot=/usr/lib/arm-none-eabi --target=arm-none-eabi -I/usr/lib/arm-none-eabi/include -I/usr/lib/gcc/arm-none-eabi/13.2.1/include"
+          RUST_MIN_STACK: "16777216"
+        run: cargo build --release --bin left
+
+      - name: Build right half
+        working-directory: keyboards/op36_qube
+        env:
+          BINDGEN_EXTRA_CLANG_ARGS: "--sysroot=/usr/lib/arm-none-eabi --target=arm-none-eabi -I/usr/lib/arm-none-eabi/include -I/usr/lib/gcc/arm-none-eabi/13.2.1/include"
+          RUST_MIN_STACK: "16777216"
+        run: cargo build --release --bin right
+
+      - name: Convert to UF2
+        working-directory: keyboards/op36_qube
+        run: |
+          arm-none-eabi-objcopy -O binary \
+            target/thumbv7em-none-eabihf/release/qube qube.bin
+          python3 ../../uf2conv.py qube.bin \
+            --base 0x26000 --family 0xADA52840 \
+            --output op36_qube_dongle.uf2
+
+          arm-none-eabi-objcopy -O binary \
+            target/thumbv7em-none-eabihf/release/left left.bin
+          python3 ../../uf2conv.py left.bin \
+            --base 0x26000 --family 0xADA52840 \
+            --output op36_qube_left.uf2
+
+          arm-none-eabi-objcopy -O binary \
+            target/thumbv7em-none-eabihf/release/right right.bin
+          python3 ../../uf2conv.py right.bin \
+            --base 0x26000 --family 0xADA52840 \
+            --output op36_qube_right.uf2
+
+      - name: Upload firmware
+        uses: actions/upload-artifact@v4
+        with:
+          name: op36_qube
+          path: |
+            keyboards/op36_qube/op36_qube_dongle.uf2
+            keyboards/op36_qube/op36_qube_left.uf2
+            keyboards/op36_qube/op36_qube_right.uf2
+          retention-days: 30
+
   build-settings-reset:
     name: Build settings_reset firmware
     runs-on: ubuntu-latest

README.md

@@ -13,6 +13,7 @@ RMK BLE split firmware for Ergohaven keyboards and trackballs (nRF52840).
 | K:04 Micro  | 3×5 + 3 thumb  | 1+1      | —         |
 | Imperial44  | 4×6 + 3 thumb  | 1+1      | —         |
 | OP36        | 3×5 + 3 thumb  | —        | —         |
+| OP36 Qube   | 3×5 + 3 thumb  | —        | Qube dongle + ST7789 |
 | Velvet      | 4×6 + 5 thumb  | —        | —         |
 | Velvet UI   | 4×6 + 5 thumb  | —        | PMW3610   |
 
@@ -55,3 +56,8 @@ Every push builds all devices in parallel via GitHub Actions. UF2 artifacts avai
 ## RMK Version
 
 Based on [RMK](https://github.com/HaoboGu/rmk) 0.8.2 with nRF52840 BLE support.
+
+`keyboards/op36_qube` is isolated on `common/rmk-main-upstream`, vendored from
+official RMK upstream `https://github.com/HaoboGu/rmk` main at commit
+`baaab8b7d839e8938e016892965891f1bde45efe`, so current 0.8.2 firmwares are
+not mixed with the Qube runtime.

common/rmk-main-upstream/README.md

@@ -0,0 +1,145 @@
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/haobogu/rmk">
+    <img src="https://github.com/HaoboGu/rmk/blob/dad1f922f471127f5449262c4cb4a922e351bf43/docs/images/rmk_logo.svg?raw=true" alt="Logo" width="150">
+  </a>
+
+  <p align="center">
+  A feature-rich keyboard firmware written in Rust.
+  <br />
+  <br />
+  <a href="https://crates.io/crates/rmk"><img src="https://img.shields.io/crates/v/rmk"></a>
+  <a href="https://docs.rs/rmk/latest/rmk/"><img src="https://img.shields.io/docsrs/rmk"></a>
+  <a href="https://github.com/HaoboGu/rmk/actions"><img src="https://github.com/haobogu/rmk/actions/workflows/build.yml/badge.svg"></a>
+  <a href="https://discord.gg/HHGA7pQxkG"><img src="https://img.shields.io/discord/1166665039793639424?label=discord"></a>
+  </p>
+</p>
+
+👉 Join our [Discord server](https://discord.gg/HHGA7pQxkG) for discussions, support, and community collaboration!
+
+-----
+[中文](https://github.com/HaoboGu/rmk/blob/main/README_zh.md)
+
+
+## Features
+
+- **Broad microcontroller compatibility**: Leveraging [embassy](https://github.com/embassy-rs/embassy), RMK supports a comprehensive range of microcontrollers, including stm32, nRF, rp2040(w), esp32, etc
+- **Dynamic keymap customization**: RMK offers native [Vial](https://get.vial.today) support, enabling real-time keymap modifications. You can even edit keymaps over BLE connections wirelessly
+- **Advanced keyboard functionality**: RMK comes with lots of advanced keyboard features by default, including layer switching, media controls, system commands, mouse control, and more
+- **Wireless connectivity**: BLE wireless support with automatic reconnection and multi-device capabilities for nRF52 and esp32 microcontrollers, tested on nRF52840, esp32c3, esp32s3, Pi Pico W
+- **Easy configuration**: RMK simplifies keyboard development through a single `keyboard.toml` configuration file. For Rust enthusiasts, the firmware remains highly customizable using Rust code
+- **Optimized performance**: RMK achieves approximately 2ms latency in wired mode and 10ms in wireless mode. With the `async_matrix` feature enabled, power consumption is significantly reduced—a 2000mAh battery can power your keyboard for several months
+
+## [User Documentation](https://rmk.rs/docs/user_guide/guide_overview) | [API Reference](https://docs.rs/rmk/latest/rmk/) | [FAQs](https://rmk.rs/docs/getting_started/faq) | [Changelog](https://github.com/HaoboGu/rmk/blob/main/rmk/CHANGELOG.md)
+
+## Real-World Implementations
+
+### [rmk-ble-keyboard](https://github.com/HaoboGu/rmk-ble-keyboard)
+
+<img src="https://raw.githubusercontent.com/HaoboGu/rmk/refs/heads/main/docs/docs/main/images/rmk_ble_keyboard.jpg" width="60%">
+
+### [dactyl-lynx-rmk](https://github.com/whitelynx/dactyl-lynx-rmk)
+
+<img src="https://raw.githubusercontent.com/whitelynx/dactyl-lynx-keyboard/refs/heads/main/resources/skeleton-prototype.jpg" width="60%">
+
+### [sessile](https://github.com/willpuckett/sessile)
+
+<img src="https://raw.githubusercontent.com/HaoboGu/rmk/refs/heads/main/docs/docs/main/images/sessile.png" width="60%">
+
+### [Urchin](https://github.com/TimoBbz/urchin-rmk-firmware)
+
+<img src="https://raw.githubusercontent.com/HaoboGu/rmk/refs/heads/main/docs/docs/main/images/urchin.png" width="60%">
+
+### [zx66](https://github.com/zongxin1993/zx66-keybord)
+
+<img src="https://raw.githubusercontent.com/zongxin1993/zx66-keybord/refs/heads/master/Images/zx66-keybord_03.jpg" width="60%">
+
+### [rmk-zsa-voyager](https://github.com/jpds/rmk-zsa-voyager)
+
+<img src="https://raw.githubusercontent.com/HaoboGu/rmk/refs/heads/main/docs/docs/main/images/zsa-voyager.webp" width="60%">
+
+## Getting Started
+
+### Option 1: Start with a Template
+
+Quickly bootstrap your project using [rmkit](https://github.com/HaoboGu/rmkit) and the official RMK [project template](https://github.com/HaoboGu/rmk-template).
+
+```shell
+cargo install rmkit flip-link
+# If you encounter installation issues on Windows, try this alternative command:
+# powershell -ExecutionPolicy ByPass -c "irm https://github.com/haobogu/rmkit/releases/download/v0.0.20/rmkit-installer.ps1 | iex"
+rmkit init
+```
+
+For comprehensive guidance, refer to the [User Guide](https://rmk.rs/docs/user_guide/guide_overview).
+
+### Option 2: Explore Built-in Examples
+
+Browse the examples in the [`examples`](https://github.com/HaoboGu/rmk/tree/main/examples) directory. Below are step-by-step instructions for rp2040 development. The process is similar for other microcontrollers when using a debug probe.
+
+#### rp2040 Setup
+
+1. Install [probe-rs](https://github.com/probe-rs/probe-rs)
+
+   ```shell
+   curl --proto '=https' --tlsv1.2 -LsSf https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-tools-installer.sh | sh
+   ```
+
+2. Build the firmware
+
+   ```shell
+   cd examples/use_rust/rp2040
+   cargo build --release
+   ```
+
+3. Flash using a debug probe
+
+   With a debug probe connected to your rp2040 board, simply run:
+
+   ```shell
+   cd examples/use_rust/rp2040
+   cargo run --release
+   ```
+
+4. (Optional) Flash via USB
+
+   Without a debug probe, you can use `elf2uf2-rs` to flash via USB:
+
+   1. Install the tool: `cargo install elf2uf2-rs`
+   2. Modify `examples/use_rust/rp2040/.cargo/config.toml` to use `elf2uf2`:
+      ```diff
+      - runner = "probe-rs run --chip RP2040"
+      + runner = "elf2uf2-rs -d"
+      ```
+   3. Connect your rp2040 board while holding the BOOTSEL button until the USB drive appears
+   4. Flash the firmware:
+      ```shell
+      cd examples/use_rust/rp2040
+      cargo run --release
+      ```
+      Upon successful completion, you'll see output similar to:
+      ```shell
+      Finished release [optimized + debuginfo] target(s) in 0.21s
+      Running `elf2uf2-rs -d 'target\thumbv6m-none-eabi\release\rmk-rp2040'`
+      Found pico uf2 disk G:\
+      Transfering program to pico
+      173.00 KB / 173.00 KB [=======================] 100.00 % 193.64 KB/s
+      ```
+
+## [Development Roadmap](https://rmk.rs/docs/development/roadmap)
+
+Current roadmap of RMK can be found [here](https://rmk.rs/docs/development/roadmap).
+
+## Minimum Supported Rust Version (MSRV)
+
+RMK is developed against the latest stable Rust release. While other versions may work, they are not fully tested.
+
+## License
+
+RMK is licensed under either of
+
+- Apache License, Version 2.0 (LICENSE-APACHE or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license (LICENSE-MIT or <http://opensource.org/licenses/MIT>)
+
+at your option.

common/rmk-main-upstream/UPSTREAM.md

@@ -0,0 +1,11 @@
+# RMK Main Upstream
+
+This vendor root is reserved for Qube-capable firmware targets that need RMK
+mainline display and split events.
+
+- Upstream: https://github.com/HaoboGu/rmk
+- Branch: main
+- Commit: baaab8b7d839e8938e016892965891f1bde45efe
+- Imported crates: `rmk`, `rmk-config`, `rmk-macro`, `rmk-types`
+
+The existing `common/rmk-0.8.2-*` trees are intentionally left untouched.

common/rmk-main-upstream/rmk-config/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "rmk-config"
+version = "0.6.1"
+edition = "2024"
+authors = ["Haobo Gu <haobogu@outlook.com>"]
+description = "Config crate of RMK"
+homepage = "https://github.com/haobogu/rmk"
+repository = "https://github.com/haobogu/rmk"
+license = "MIT OR Apache-2.0"
+resolver = "2"
+
+[dependencies]
+config = "0.15"
+toml = "1"
+serde = { version = "1", features = ["derive"] }
+serde-inline-default = "1"
+once_cell = "1.19"
+pest = "2.8"
+pest_derive = "2.8"
+paste = "1.0.15"