chore: move zsa/oryx module to a git submodule

.gitmodules

@@ -25,3 +25,6 @@
 	path = lib/lvgl
 	url = https://github.com/qmk/lvgl.git
 	branch = release/v8.2
+[submodule "modules/zsa"]
+	path = modules/zsa
+	url = git@github.com:zsa/qmk_modules.git

modules/zsa/oryx/config.h

@@ -1,10 +0,0 @@
-// Copyright 2024 ZSA Technology Labs, Inc <@zsa>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-#pragma once
-
-#define RAW_USAGE_PAGE 0xFF60
-#define RAW_USAGE_ID   0x61
-
-#define ORYX_ENABLE
-#define ORYX_CONFIGURATOR

modules/zsa/oryx/introspection.h

@@ -1,6 +0,0 @@
-// Copyright 2024 ZSA Technology Labs, Inc <@zsa>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-#pragma once
-
-#include "oryx.h"

modules/zsa/oryx/keycode_aliases.h

@@ -1,7 +0,0 @@
-// Copyright 2024 ZSA Technology Labs, Inc <@zsa>
-// SPDX-License-Identifier: GPL-2.0-or-later
-//
-// As QMK evolves, some keycodes are renamed. This file provides a way to map old keycodes to new ones.
-
-// Changed from fw23 to fw24
-#define QK_MAGIC_TOGGLE_NKRO MAGIC_TOGGLE_NKRO

modules/zsa/oryx/oryx.c

@@ -1,334 +0,0 @@
-// Copyright 2024 ZSA Technology Labs, Inc <@zsa>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-#include QMK_KEYBOARD_H
-#include <string.h>
-#include "oryx.h"
-#include "action_util.h"
-
-ASSERT_COMMUNITY_MODULES_MIN_API_VERSION(1, 1, 1);
-
-uint8_t current_layer = 0;
-
-rawhid_state_t rawhid_state = {
-    .paired             = false,
-    .rgb_control        = false,
-    .status_led_control = false,
-};
-
-#if defined(PROTOCOL_LUFA)
-bool send_report(uint8_t endpoint, void *report, size_t size);
-#    include "usb_descriptor.h"
-#    define RAW_EP_NAME RAW_IN_EPNUM
-#elif defined(PROTOCOL_CHIBIOS)
-#    include "usb_endpoints.h"
-#    define RAW_EP_NAME USB_ENDPOINT_IN_RAW
-bool send_report(usb_endpoint_in_lut_t endpoint, void *report, size_t size);
-#endif
-
-#ifdef RGB_MATRIX_ENABLE
-RGB webhid_leds[RGB_MATRIX_LED_COUNT];
-#endif
-
-void raw_hid_send_oryx(uint8_t *data, uint8_t length) {
-    if (length != RAW_EPSIZE) {
-        return;
-    }
-    if (!send_report(RAW_EP_NAME, data, length)) {
-#if !defined(PROTOCOL_LUFA)
-        rawhid_state.paired = false;
-#endif
-    }
-}
-
-void oryx_error(uint8_t code) {
-    uint8_t event[RAW_EPSIZE];
-    event[0] = ORYX_EVT_ERROR;
-    event[1] = code;
-    raw_hid_send_oryx(event, RAW_EPSIZE);
-}
-
-void oryx_layer_event(void) {
-    uint8_t layer;
-    uint8_t event[RAW_EPSIZE];
-    layer    = get_highest_layer(layer_state | default_layer_state);
-    event[0] = ORYX_EVT_LAYER;
-    event[1] = layer;
-    event[2] = ORYX_STOP_BIT;
-    raw_hid_send_oryx(event, sizeof(event));
-}
-
-void pairing_failed_event(void) {
-    rawhid_state.paired = false;
-    uint8_t event[RAW_EPSIZE];
-    event[0] = ORYX_EVT_PAIRING_FAILED;
-    event[1] = ORYX_STOP_BIT;
-    raw_hid_send_oryx(event, sizeof(event));
-}
-
-void pairing_success_event(void) {
-    rawhid_state.paired = true;
-    uint8_t event[RAW_EPSIZE];
-    event[0] = ORYX_EVT_PAIRING_SUCCESS;
-    event[1] = ORYX_STOP_BIT;
-    raw_hid_send_oryx(event, sizeof(event));
-    oryx_layer_event();
-}
-
-void toggle_smart_layer(void) {
-    uint8_t event[RAW_EPSIZE];
-    event[0] = ORYX_EVT_TOGGLE_SMART_LAYER;
-    event[1] = ORYX_STOP_BIT;
-    raw_hid_send_oryx(event, sizeof(event));
-}
-
-void trigger_smart_layer(void) {
-    uint8_t event[RAW_EPSIZE];
-    event[0] = ORYX_EVT_TRIGGER_SMART_LAYER;
-    event[1] = ORYX_STOP_BIT;
-    raw_hid_send_oryx(event, sizeof(event));
-}
-
-void set_webhid_effect(void) {
-#if defined(RGB_MATRIX_ENABLE) && !defined(PROTOCOL_LUFA) && defined(RGB_MATRIX_CUSTOM_KB)
-    rgb_matrix_mode_noeeprom(RGB_MATRIX_CUSTOM_oryx_webhid_effect);
-    rawhid_state.rgb_control = true;
-#endif
-}
-
-void clear_webhid_effect(void) {
-#if defined(RGB_MATRIX_ENABLE) && !defined(PROTOCOL_LUFA)
-    // Clear the pattern
-    for (uint8_t i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
-        webhid_leds[i] = (RGB){.r = 0, .g = 0, .b = 0};
-    }
-    rgb_matrix_reload_from_eeprom();
-    rawhid_state.rgb_control = false;
-#endif
-}
-
-void raw_hid_receive(uint8_t *data, uint8_t length) {
-    uint8_t  command = data[0];
-    uint8_t *param   = &data[1];
-
-    switch (command) {
-        case ORYX_CMD_GET_FW_VERSION: {
-            uint8_t event[RAW_EPSIZE];
-            uint8_t fw_version_size = sizeof(SERIAL_NUMBER);
-            uint8_t stop[1];
-
-            event[0] = ORYX_EVT_GET_FW_VERSION;
-            stop[0]  = ORYX_STOP_BIT;
-
-            memcpy(event + 1, SERIAL_NUMBER, fw_version_size);
-            memcpy(event + fw_version_size, stop, 1);
-
-            raw_hid_send_oryx(event, RAW_EPSIZE);
-            break;
-        }
-
-        case ORYX_GET_PROTOCOL_VERSION: {
-            uint8_t event[RAW_EPSIZE];
-            event[0] = ORYX_EVT_GET_PROTOCOL_VERSION;
-            event[1] = ORYX_PROTOCOL_VERSION;
-            event[2] = ORYX_STOP_BIT;
-
-            raw_hid_send_oryx(event, RAW_EPSIZE);
-            break;
-        }
-
-        case ORYX_CMD_PAIRING_INIT:
-            pairing_success_event();
-
-        case ORYX_CMD_PAIRING_VALIDATE:
-            break; // Keeping this for backwards compatibility with older versions of Wally / Keymapp
-
-        case ORYX_SET_LAYER:
-            // The first param's byte is on / off
-            // The second param's byte is the layer number
-            if (rawhid_state.paired == true) {
-                if (param[0] == 0) {
-                    layer_off(param[1]);
-                } else {
-                    layer_move(param[1]);
-                }
-            }
-            break;
-
-        case ORYX_RGB_CONTROL:
-#if defined(RGB_MATRIX_ENABLE) && !defined(PROTOCOL_LUFA)
-            if (param[0] == 0) {
-                clear_webhid_effect();
-            } else {
-                set_webhid_effect();
-            }
-            uint8_t event[RAW_EPSIZE];
-            event[0] = ORYX_EVT_RGB_CONTROL;
-            event[1] = rawhid_state.rgb_control;
-            raw_hid_send_oryx(event, RAW_EPSIZE);
-#else
-            oryx_error(ORYX_ERR_RGB_MATRIX_NOT_ENABLED);
-#endif
-            break;
-
-        case ORYX_SET_RGB_LED:
-#if defined(RGB_MATRIX_ENABLE) && !defined(PROTOCOL_LUFA)
-            webhid_leds[param[0]] = (RGB){.r = param[1], .g = param[2], .b = param[3]};
-            if (rawhid_state.rgb_control == false) {
-                set_webhid_effect();
-            }
-#else
-            oryx_error(ORYX_ERR_RGB_MATRIX_NOT_ENABLED);
-#endif
-            break;
-        case ORYX_SET_RGB_LED_ALL:
-#if defined(RGB_MATRIX_ENABLE) && !defined(PROTOCOL_LUFA)
-            for (uint8_t i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
-                webhid_leds[i] = (RGB){.r = param[0], .g = param[1], .b = param[2]};
-            }
-            if (rawhid_state.rgb_control == false) {
-                set_webhid_effect();
-            }
-#else
-            oryx_error(ORYX_ERR_RGB_MATRIX_NOT_ENABLED);
-#endif
-            break;
-        case ORYX_SET_STATUS_LED:
-            rawhid_state.status_led_control = true; // Eagerly take control of the status LEDs
-            switch (param[0]) {
-                case 0:
-#ifdef STATUS_LED_1
-                    STATUS_LED_1(param[1]);
-#else
-                    oryx_error(ORYX_ERR_STATUS_LED_OUT_OF_RANGE);
-#endif
-                    break;
-                case 1:
-#ifdef STATUS_LED_2
-                    STATUS_LED_2(param[1]);
-#else
-                    oryx_error(ORYX_ERR_STATUS_LED_OUT_OF_RANGE);
-#endif
-                    break;
-                case 2:
-#ifdef STATUS_LED_3
-                    STATUS_LED_3(param[1]);
-#else
-                    oryx_error(ORYX_ERR_STATUS_LED_OUT_OF_RANGE);
-#endif
-                    break;
-                case 3:
-#ifdef STATUS_LED_4
-                    STATUS_LED_4(param[1]);
-#else
-                    oryx_error(ORYX_ERR_STATUS_LED_OUT_OF_RANGE);
-#endif
-                    break;
-                case 4:
-#ifdef STATUS_LED_5
-                    STATUS_LED_5(param[1]);
-#else
-                    oryx_error(ORYX_ERR_STATUS_LED_OUT_OF_RANGE);
-#endif
-                    break;
-                case 5:
-#ifdef STATUS_LED_6
-                    STATUS_LED_6(param[1]);
-#else
-                    oryx_error(ORYX_ERR_STATUS_LED_OUT_OF_RANGE);
-#endif
-                    break;
-
-                default:
-                    oryx_error(ORYX_ERR_STATUS_LED_OUT_OF_RANGE);
-                    break;
-            }
-            break;
-        case ORYX_UPDATE_BRIGHTNESS: {
-#if defined(RGB_MATRIX_ENABLE) && !defined(PROTOCOL_LUFA)
-            if (param[0]) {
-                rgb_matrix_increase_val_noeeprom();
-            } else {
-                rgb_matrix_decrease_val_noeeprom();
-            }
-#else
-            oryx_error(ORYX_ERR_RGB_MATRIX_NOT_ENABLED);
-#endif
-            break;
-        }
-        case ORYX_STATUS_LED_CONTROL: {
-            rawhid_state.status_led_control = param[0];
-            if (!param[0]) {
-#ifdef STATUS_LED_1
-                STATUS_LED_1(0);
-#endif
-#ifdef STATUS_LED_2
-                STATUS_LED_2(0);
-#endif
-#ifdef STATUS_LED_3
-                STATUS_LED_3(0);
-#endif
-#ifdef STATUS_LED_4
-                STATUS_LED_4(0);
-#endif
-#ifdef STATUS_LED_5
-                STATUS_LED_5(0);
-#endif
-#ifdef STATUS_LED_6
-                STATUS_LED_6(0);
-#endif
-            }
-            uint8_t event[RAW_EPSIZE];
-            event[0] = ORYX_EVT_STATUS_LED_CONTROL;
-            event[1] = rawhid_state.status_led_control;
-            raw_hid_send_oryx(event, RAW_EPSIZE);
-            break;
-        }
-        default:
-            oryx_error(ORYX_ERR_UNKNOWN_COMMAND);
-    }
-}
-
-bool pre_process_record_oryx(uint16_t keycode, keyrecord_t *record) {
-    if (!pre_process_record_oryx_kb(keycode, record)) {
-        return true;
-    }
-    // While paired, the keyboard sends keystrokes positions to the host
-    if (rawhid_state.paired == true) {
-        uint8_t event[RAW_EPSIZE];
-        event[0] = record->event.pressed ? ORYX_EVT_KEYDOWN : ORYX_EVT_KEYUP;
-        event[1] = record->event.key.col;
-        event[2] = record->event.key.row;
-        event[3] = ORYX_STOP_BIT;
-        raw_hid_send_oryx(event, sizeof(event));
-    }
-    return true;
-}
-
-layer_state_t layer_state_set_oryx(layer_state_t state) {
-    state = layer_state_set_oryx_kb(state);
-    if (rawhid_state.paired) {
-        uint8_t layer = get_highest_layer(state | default_layer_state);
-        // Some layer actions (OSL) trigger the layer state change thrice,
-        // so we need to check if the layer has actually changed
-        if (current_layer == layer) {
-            return state;
-        }
-        current_layer = layer;
-#if defined(PROTOCOL_LUFA)
-        // Required for Atmel Boards
-        wait_ms(10);
-#endif
-        uint8_t event[RAW_EPSIZE];
-        event[0] = ORYX_EVT_LAYER;
-        event[1] = current_layer;
-        event[2] = ORYX_STOP_BIT;
-        raw_hid_send_oryx(event, sizeof(event));
-    }
-    return state;
-}
-
-layer_state_t default_layer_state_set_oryx(layer_state_t state) {
-    layer_state_set_oryx(state | layer_state);
-    return default_layer_state_set_oryx_kb(state);
-}

modules/zsa/oryx/oryx.h

@@ -1,93 +0,0 @@
-// Copyright 2024 ZSA Technology Labs, Inc <@zsa>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-#pragma once
-/*
-The Oryx Webhid protocol
-
-Each HID packet is a series of bytes.  The first byte is the packet type is the command. The rest of the bytes are the
-params.
-
-Before sending a packet, the host needs to be paired or should request a pairing code.
-
-The pairing code is a sequence of key positions derived from Oryx's firmware version code stored in the FIRMWARE_VERSION
-define.
-
-Once the host has paired, it can freely use the commands define in the Oryx_Command_Code enum for which the board will
-always respond with a Oryx_Event_Code or a Oryx_Error_Code.
-*/
-
-#include "quantum.h"
-#include "raw_hid.h"
-
-#ifndef RAW_EPSIZE
-#    define RAW_EPSIZE 32
-#endif
-
-#define ORYX_PROTOCOL_VERSION 0x04
-#define ORYX_STOP_BIT -2
-
-enum Oryx_Command_Code {
-    ORYX_CMD_GET_FW_VERSION,
-    ORYX_CMD_PAIRING_INIT,
-    ORYX_CMD_PAIRING_VALIDATE,
-    ORYX_CMD_DISCONNECT,
-    ORYX_SET_LAYER,
-    ORYX_RGB_CONTROL,
-    ORYX_SET_RGB_LED,
-    ORYX_SET_STATUS_LED,
-    ORYX_UPDATE_BRIGHTNESS,
-    ORYX_SET_RGB_LED_ALL,
-    ORYX_STATUS_LED_CONTROL,
-    ORYX_GET_PROTOCOL_VERSION = 0xFE,
-};
-
-enum Oryx_Event_Code {
-    ORYX_EVT_GET_FW_VERSION,
-    ORYX_EVT_PAIRING_INPUT,
-    ORYX_EVT_PAIRING_KEY_INPUT,
-    ORYX_EVT_PAIRING_FAILED,
-    ORYX_EVT_PAIRING_SUCCESS,
-    ORYX_EVT_LAYER,
-    ORYX_EVT_KEYDOWN,
-    ORYX_EVT_KEYUP,
-    ORYX_EVT_RGB_CONTROL,
-    ORYX_EVT_TOGGLE_SMART_LAYER,
-    ORYX_EVT_TRIGGER_SMART_LAYER,
-    ORYX_EVT_STATUS_LED_CONTROL,
-    ORYX_EVT_GET_PROTOCOL_VERSION = 0XFE,
-    ORYX_EVT_ERROR                = 0xFF,
-};
-
-enum Oryx_Error_Code {
-    ORYX_ERR_PAIRING_INIT_FAILED,
-    ORYX_ERR_PAIRING_INPUT_FAILED,
-    ORYX_ERR_PAIRING_KEY_INPUT_FAILED,
-    ORYX_ERR_PAIRING_FAILED,
-    ORYX_ERR_RGB_MATRIX_NOT_ENABLED,
-    ORYX_ERR_STATUS_LED_OUT_OF_RANGE,
-    ORYX_ERR_UNKNOWN_COMMAND = 0xFF,
-};
-
-extern bool oryx_state_live_training_enabled;
-
-typedef struct {
-    bool paired;
-    bool rgb_control;
-    bool status_led_control;
-} rawhid_state_t;
-
-extern rawhid_state_t rawhid_state;
-
-void oryx_error(uint8_t code);
-void pairing_failed_event(void);
-void pairing_succesful_event(void);
-void toggle_smart_layer(void);
-void trigger_smart_layer(void);
-void set_webhid_effect(void);
-
-void oryx_layer_event(void);
-
-#if defined(RGB_MATRIX_ENABLE) && !defined(KEYBOARD_ergodox_ez_glow)
-extern RGB webhid_leds[RGB_MATRIX_LED_COUNT];
-#endif

modules/zsa/oryx/post_config.h

@@ -1,10 +0,0 @@
-// Copyright 2024 ZSA Technology Labs, Inc <@zsa>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-#pragma once
-
-#include "keycode_aliases.h"
-
-#ifndef SERIAL_NUMBER
-#    define SERIAL_NUMBER "default/latest"
-#endif // SERIAL_NUMBER

modules/zsa/oryx/qmk_module.json

@@ -1,8 +0,0 @@
-{
-    "maintainer": "ZSA",
-    "module_name": "oryx",
-    "features": {
-        "raw": true,
-        "via": false
-    }
-}

modules/zsa/oryx/rgb_matrix_module.inc

@@ -1,21 +0,0 @@
-#ifdef RGB_MATRIX_ENABLE
-RGB_MATRIX_EFFECT(oryx_webhid_effect)
-#    ifdef RGB_MATRIX_CUSTOM_EFFECT_IMPLS
-
-extern RGB webhid_leds[RGB_MATRIX_LED_COUNT];
-
-static bool oryx_webhid_effect_run(effect_params_t* params) {
-    RGB_MATRIX_USE_LIMITS(led_min, led_max);
-    float f = (float)rgb_matrix_config.hsv.v / UINT8_MAX;
-    for (uint8_t i = led_min; i < led_max; ++i) {
-        rgb_matrix_set_color(i, webhid_leds[i].r * f, webhid_leds[i].g * f, webhid_leds[i].b * f);
-    }
-    return rgb_matrix_check_finished_leds(led_max);
-}
-
-static bool oryx_webhid_effect(effect_params_t* params) {
-    return oryx_webhid_effect_run(params);
-}
-
-#    endif
-#endif

modules/zsa/oryx/rules.mk

@@ -1 +0,0 @@
-POST_CONFIG_H += keyboards/zsa/common/keycode_aliases.h