[WIP] XAP -- eXtensible Application Protocol

.github/workflows/docs.yml

@@ -36,6 +36,7 @@ jobs:
 
     - name: Install dependencies
       run: |
+        pip3 install -r requirements-dev.txt
         apt-get update && apt-get install -y rsync doxygen
         # install nvm
         touch $HOME/.bashrc

.github/workflows/regen.yml

@@ -21,6 +21,10 @@ jobs:
 
     - uses: actions/checkout@v4
 
+    - name: Install python reqs
+      run: |
+        python3 -m pip install -r requirements.txt
+
     - name: Run qmk generators
       run: |
         util/regen.sh

.github/workflows/regen_push.yml

@@ -21,6 +21,10 @@ jobs:
 
     - uses: actions/checkout@v4
 
+    - name: Install dependencies
+      run: |
+        pip3 install -r requirements-dev.txt
+
     - name: Run qmk generators
       run: |
         util/regen.sh

.gitignore

@@ -103,6 +103,7 @@ secrets.tar
 # Python things
 __pycache__
 .python-version
+*.egg-info
 .venv
 
 # Prerequisites for updating ChibiOS

builddefs/common_features.mk

@@ -44,6 +44,10 @@ else ifeq ($(strip $(DEBUG_MATRIX_SCAN_RATE_ENABLE)), api)
     OPT_DEFS += -DDEBUG_MATRIX_SCAN_RATE
 endif
 
+ifeq ($(strip $(XAP_ENABLE)), yes)
+    include $(BUILDDEFS_PATH)/xap.mk
+endif
+
 AUDIO_ENABLE ?= no
 ifeq ($(strip $(AUDIO_ENABLE)), yes)
     ifeq ($(PLATFORM),CHIBIOS)
@@ -623,6 +627,22 @@ ifeq ($(strip $(VIA_ENABLE)), yes)
     TRI_LAYER_ENABLE := yes
 endif
 
+ifeq ($(strip $(XAP_ENABLE)), yes)
+    ifeq ($(strip $(VIA_ENABLE)), yes)
+        $(error 'XAP_ENABLE = $(XAP_ENABLE)' deprecates 'VIA_ENABLE = $(VIA_ENABLE)'. Please set 'VIA_ENABLE = no')
+    endif
+
+    DYNAMIC_KEYMAP_ENABLE := yes
+    FNV_ENABLE := yes
+    SECURE_ENABLE := yes
+    BOOTMAGIC_ENABLE := yes
+
+    OPT_DEFS += -DXAP_ENABLE
+    OPT_DEFS += -DBOOTLOADER_JUMP_SUPPORTED
+    VPATH += $(QUANTUM_DIR)/xap
+    SRC += $(QUANTUM_DIR)/xap/xap.c $(QUANTUM_DIR)/xap/xap_handlers.c
+endif
+
 VALID_CUSTOM_MATRIX_TYPES:= yes lite no
 
 CUSTOM_MATRIX ?= no

builddefs/xap.mk

@@ -0,0 +1,44 @@
+# Copyright 2022 Nick Brassel (@tzarc)
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+XAP_FILES := $(shell ls -1 data/xap/* | sort | xargs echo)
+ifneq ("$(wildcard $(KEYBOARD_PATH_1)/xap.hjson)","")
+	XAP_FILES += $(KEYBOARD_PATH_1)/xap.hjson
+endif
+ifneq ("$(wildcard $(KEYBOARD_PATH_2)/xap.hjson)","")
+	XAP_FILES += $(KEYBOARD_PATH_2)/xap.hjson
+endif
+ifneq ("$(wildcard $(KEYBOARD_PATH_3)/xap.hjson)","")
+	XAP_FILES += $(KEYBOARD_PATH_3)/xap.hjson
+endif
+ifneq ("$(wildcard $(KEYBOARD_PATH_4)/xap.hjson)","")
+	XAP_FILES += $(KEYBOARD_PATH_4)/xap.hjson
+endif
+ifneq ("$(wildcard $(KEYBOARD_PATH_5)/xap.hjson)","")
+	XAP_FILES += $(KEYBOARD_PATH_5)/xap.hjson
+endif
+ifneq ("$(wildcard $(KEYMAP_PATH)/xap.hjson)","")
+	XAP_FILES += $(KEYMAP_PATH)/xap.hjson
+endif
+ifneq ("$(wildcard $(USER_NAME)/xap.hjson)","")
+	XAP_FILES += $(USER_NAME)/xap.hjson
+endif
+
+$(INTERMEDIATE_OUTPUT)/src/config_blob_gz.h: $(INFO_JSON_FILES)
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) xap-generate-qmk-blob-h -o "$(INTERMEDIATE_OUTPUT)/src/config_blob_gz.h" -kb $(KEYBOARD) -km $(KEYMAP))
+	@$(BUILD_CMD)
+
+$(INTERMEDIATE_OUTPUT)/src/xap_generated.inl: $(XAP_FILES)
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) xap-generate-qmk-inc -o "$(INTERMEDIATE_OUTPUT)/src/xap_generated.inl" -kb $(KEYBOARD) -km $(KEYMAP))
+	@$(BUILD_CMD)
+
+$(INTERMEDIATE_OUTPUT)/src/xap_generated.h: $(XAP_FILES)
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) xap-generate-qmk-h -o "$(INTERMEDIATE_OUTPUT)/src/xap_generated.h" -kb $(KEYBOARD) -km $(KEYMAP))
+	@$(BUILD_CMD)
+
+generated-files: $(INTERMEDIATE_OUTPUT)/src/config_blob_gz.h $(INTERMEDIATE_OUTPUT)/src/xap_generated.inl $(INTERMEDIATE_OUTPUT)/src/xap_generated.h
+
+VPATH += $(INTERMEDIATE_OUTPUT)/src

data/constants/lighting/led_matrix_0.0.1.hjson

@@ -0,0 +1,82 @@
+{
+    "groups": {
+        "reactive": {
+            "define": "LED_MATRIX_KEYREACTIVE_ENABLED"
+        }
+    },
+    "effects": {
+        "0x00": {
+            "key": "SOLID"
+        },
+        "0x01": {
+            "key": "ALPHAS_MODS"
+        },
+        "0x02": {
+            "key": "BREATHING"
+        },
+        "0x03": {
+            "key": "BAND"
+        },
+        "0x04": {
+            "key": "BAND_PINWHEEL"
+        },
+        "0x05": {
+            "key": "BAND_SPIRAL"
+        },
+        "0x06": {
+            "key": "CYCLE_LEFT_RIGHT"
+        },
+        "0x07": {
+            "key": "CYCLE_UP_DOWN"
+        },
+        "0x08": {
+            "key": "CYCLE_OUT_IN"
+        },
+        "0x09": {
+            "key": "DUAL_BEACON"
+        },
+        "0x0A": {
+            "key": "WAVE_LEFT_RIGHT"
+        },
+        "0x0B": {
+            "key": "WAVE_UP_DOWN"
+        },
+
+        "0x0C": {
+            "key": "SOLID_REACTIVE_SIMPLE",
+            "group": "reactive"
+        },
+        "0x0D": {
+            "key": "SOLID_REACTIVE_WIDE",
+            "group": "reactive"
+        },
+        "0x0E": {
+            "key": "SOLID_REACTIVE_MULTIWIDE",
+            "group": "reactive"
+        },
+        "0x0F": {
+            "key": "SOLID_REACTIVE_CROSS",
+            "group": "reactive"
+        },
+        "0x10": {
+            "key": "SOLID_REACTIVE_MULTICROSS",
+            "group": "reactive"
+        },
+        "0x11": {
+            "key": "SOLID_REACTIVE_NEXUS",
+            "group": "reactive"
+        },
+        "0x12": {
+            "key": "SOLID_REACTIVE_MULTINEXUS",
+            "group": "reactive"
+        },
+        "0x13": {
+            "key": "SOLID_SPLASH",
+            "group": "reactive"
+        },
+        "0x14": {
+            "key": "SOLID_MULTISPLASH",
+            "group": "reactive"
+        }
+    }
+}

data/constants/lighting/rgb_matrix_0.0.1.hjson

@@ -0,0 +1,175 @@
+{
+    "groups": {
+        "framebuffer": {
+            "define": "RGB_MATRIX_FRAMEBUFFER_EFFECTS"
+        },
+        "reactive": {
+            "define": "RGB_MATRIX_KEYREACTIVE_ENABLED"
+        }
+    },
+    "effects": {
+        "0x00": {
+            "key": "SOLID_COLOR"
+        },
+        "0x01": {
+            "key": "ALPHAS_MODS"
+        },
+        "0x02": {
+            "key": "GRADIENT_UP_DOWN"
+        },
+        "0x03": {
+            "key": "GRADIENT_LEFT_RIGHT"
+        },
+        "0x04": {
+            "key": "BREATHING"
+        },
+        "0x05": {
+            "key": "BAND_SAT"
+        },
+        "0x06": {
+            "key": "BAND_VAL"
+        },
+        "0x07": {
+            "key": "BAND_PINWHEEL_SAT"
+        },
+        "0x08": {
+            "key": "BAND_PINWHEEL_VAL"
+        },
+        "0x09": {
+            "key": "BAND_SPIRAL_SAT"
+        },
+        "0x0A": {
+            "key": "BAND_SPIRAL_VAL"
+        },
+        "0x0B": {
+            "key": "CYCLE_ALL"
+        },
+        "0x0C": {
+            "key": "CYCLE_LEFT_RIGHT"
+        },
+        "0x0D": {
+            "key": "CYCLE_UP_DOWN"
+        },
+        "0x0E": {
+            "key": "CYCLE_OUT_IN"
+        },
+        "0x0F": {
+            "key": "CYCLE_OUT_IN_DUAL"
+        },
+        "0x10": {
+            "key": "RAINBOW_MOVING_CHEVRON"
+        },
+        "0x11": {
+            "key": "CYCLE_PINWHEEL"
+        },
+        "0x12": {
+            "key": "CYCLE_SPIRAL"
+        },
+        "0x13": {
+            "key": "DUAL_BEACON"
+        },
+        "0x14": {
+            "key": "RAINBOW_BEACON"
+        },
+        "0x15": {
+            "key": "RAINBOW_PINWHEELS"
+        },
+        "0x16": {
+            "key": "RAINDROPS"
+        },
+        "0x17": {
+            "key": "JELLYBEAN_RAINDROPS"
+        },
+        "0x18": {
+            "key": "HUE_BREATHING"
+        },
+        "0x19": {
+            "key": "HUE_PENDULUM"
+        },
+        "0x1A": {
+            "key": "HUE_WAVE"
+        },
+        "0x1B": {
+            "key": "PIXEL_FRACTAL"
+        },
+        "0x1C": {
+            "key": "PIXEL_FLOW"
+        },
+        "0x1D": {
+            "key": "PIXEL_RAIN"
+        },
+
+        "0x1E": {
+            "key": "TYPING_HEATMAP",
+            "group": "framebuffer"
+        },
+        "0x1F": {
+            "key": "DIGITAL_RAIN",
+            "group": "framebuffer"
+        },
+
+        "0x20": {
+            "key": "SOLID_REACTIVE_SIMPLE",
+            "group": "reactive"
+        },
+        "0x21": {
+            "key": "SOLID_REACTIVE",
+            "group": "reactive"
+        },
+        "0x22": {
+            "key": "SOLID_REACTIVE_WIDE",
+            "group": "reactive"
+        },
+        "0x23": {
+            "key": "SOLID_REACTIVE_MULTIWIDE",
+            "group": "reactive"
+        },
+        "0x24": {
+            "key": "SOLID_REACTIVE_CROSS",
+            "group": "reactive"
+        },
+        "0x25": {
+            "key": "SOLID_REACTIVE_MULTICROSS",
+            "group": "reactive"
+        },
+        "0x26": {
+            "key": "SOLID_REACTIVE_NEXUS",
+            "group": "reactive"
+        },
+        "0x27": {
+            "key": "SOLID_REACTIVE_MULTINEXUS",
+            "group": "reactive"
+        },
+        "0x28": {
+            "key": "SPLASH",
+            "group": "reactive"
+        },
+        "0x29": {
+            "key": "MULTISPLASH",
+            "group": "reactive"
+        },
+        "0x2A": {
+            "key": "SOLID_SPLASH",
+            "group": "reactive"
+        },
+        "0x2B": {
+            "key": "SOLID_MULTISPLASH",
+            "group": "reactive"
+        },
+        "0x2C": {
+            "key": "FLOWER_BLOOMING"
+        },
+        "0x2D": {
+            "key": "STARLIGHT"
+        },
+        "0x2E": {
+            "key": "STARLIGHT_DUAL_SAT"
+        },
+        "0x2F": {
+            "key": "STARLIGHT_DUAL_HUE"
+        },
+        "0x30": {
+            "key": "RIVERFLOW"
+        }
+    }
+}