NKRO (usb and rf) (#24)

* nkro support (untested)

* adjusted nkro report size, it now works

* nkro through rf

* nkro as a feature

* fix extra keys

* update readme

Author: carlossless

.github/workflows/build.yml

@@ -8,6 +8,9 @@ on:
 
 jobs:
   build:
+    strategy:
+      matrix:
+        nkro: [enabled, disabled]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -21,13 +24,13 @@ jobs:
         name: smk
         authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
     - name: Setup
-      run: nix develop --command meson setup build
+      run: nix develop --command meson setup build -Dnkro=${{ matrix.nkro }}
     - name: Build
       run: nix develop --command meson compile -C build
     - name: Archive code coverage results
       uses: actions/upload-artifact@v4
       with:
-        name: firmware
+        name: smk-${{ matrix.nkro == 'enabled' && 'nkro' || '6kro' }}
         path: build/*.hex
 
   lint:

docs/keyboards/nuphy-air60.md

@@ -9,7 +9,7 @@
     - [x] USB Keyboard
     - [x] Status LEDs
     - [x] Extra Keys (System / Consumer)
-    - [ ] NKRO
+    - [x] NKRO
 - [~] QMK Compatibility
     - [~] Layouts
 - [~] Wireless

docs/smk.md

@@ -2,7 +2,7 @@ project(
     'smk',
     'c',
     version: 'alpha',
-    meson_version: '>=0.53.0'
+    meson_version: '>=1.1.0'
 )
 
 fs = import('fs')
@@ -113,6 +113,10 @@ cc_base_args = [
     '-DSMK_VERSION=@0@'.format(meson.project_version()),
 ]
 
+if get_option('nkro').enabled()
+    cc_base_args += '-DNKRO_ENABLE=1'
+endif
+
 if get_option('buildtype') == 'debug'
     cc_base_args += '-DDEBUG=1'
 endif

meson.build

@@ -0,0 +1 @@
+option('nkro', type : 'feature', value : 'enabled', description: 'NKRO support')

meson.options

@@ -5,8 +5,9 @@
 #include <stdbool.h>
 
 void kb_init();
-void kb_send_report(report_keyboard_t *report);
-void kb_send_extra(report_extra_t *report);
+void kb_send_report(__xdata report_keyboard_t *report);
+void kb_send_nkro(__xdata report_nkro_t *report);
+void kb_send_extra(__xdata report_extra_t *report);
 
 bool kb_process_record(uint16_t keycode, bool key_pressed);
 void kb_update_switches();

src/kb/kb.h

@@ -1,12 +1,17 @@
 #include "report.h"
 #include "usb.h"
 
-void kb_send_report(report_keyboard_t *report)
+void kb_send_report(__xdata report_keyboard_t *report)
 {
     usb_send_report(report);
 }
 
-void kb_send_extra(report_extra_t *report)
+void kb_send_nkro(__xdata report_nkro_t *report)
+{
+    usb_send_nkro(report);
+}
+
+void kb_send_extra(__xdata report_extra_t *report)
 {
     usb_send_extra(report);
 }

src/keyboards/example/kb.c

@@ -1,12 +1,17 @@
 #include "report.h"
 #include "usb.h"
 
-void kb_send_report(report_keyboard_t *report)
+void kb_send_report(__xdata report_keyboard_t *report)
 {
     usb_send_report(report);
 }
 
-void kb_send_extra(report_extra_t *report)
+void kb_send_nkro(__xdata report_nkro_t *report)
+{
+    usb_send_nkro(report);
+}
+
+void kb_send_extra(__xdata report_extra_t *report)
 {
     usb_send_extra(report);
 }

src/keyboards/eyooso-z11/kb.c

@@ -76,7 +76,7 @@ bool kb_process_record(uint16_t keycode, bool key_pressed)
     }
 }
 
-void kb_send_report(report_keyboard_t *report)
+void kb_send_report(__xdata report_keyboard_t *report)
 {
     switch (user_keyboard_state.conn_mode) {
         case KEYBOARD_CONN_MODE_USB:
@@ -90,7 +90,21 @@ void kb_send_report(report_keyboard_t *report)
     }
 }
 
-void kb_send_extra(report_extra_t *report)
+void kb_send_nkro(__xdata report_nkro_t *report)
+{
+    switch (user_keyboard_state.conn_mode) {
+        case KEYBOARD_CONN_MODE_USB:
+            usb_send_nkro(report);
+            break;
+#ifdef RF_ENABLED
+        case KEYBOARD_CONN_MODE_RF:
+            rf_send_nkro(report);
+            break;
+#endif
+    }
+}
+
+void kb_send_extra(__xdata report_extra_t *report)
 {
     switch (user_keyboard_state.conn_mode) {
         case KEYBOARD_CONN_MODE_USB:

src/keyboards/nuphy-air60/kb.c

@@ -52,8 +52,6 @@ void main()
 {
     init();
 
-    delay_ms(1000); // perhaps clocks are unstable at this point? influences UART
-
     dprintf("SMK v" TOSTRING(SMK_VERSION) "\r\n");
     dprintf("DEVICE vId:" TOSTRING(USB_VID) " pId:" TOSTRING(USB_PID) "\n\r");