Merge branch 'docusaurus' of github.com:qmk/qmk_firmware into docusaurus

Co-authored-by: Pablo Martínez <58857054+elpekenin@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -7,6 +7,9 @@ body:
     attributes:
       value: |
         Provide a general summary of the changes you want in the title above.
+
+        Please refrain from asking maintainers to add support for specific keyboards -- it is unlikely they will have hardware available, and will not be able to help.
+        Your best bet is to take the initiative, add support, then submit a PR yourself.
   - type: checkboxes
     attributes:
       label: Feature Request Type
@@ -18,4 +21,4 @@ body:
   - type: textarea
     attributes:
       label: Description
-      description: A few sentences describing what it is that you'd like to see in QMK. Additional information (such as links to spec sheets, licensing info, other related issues or PRs, etc) would be helpful.
+      description: A few sentences describing what it is that you'd like to see in QMK. Additional information (such as links to spec sheets, licensing info, other related issues or PRs, etc) would be helpful.

.github/ISSUE_TEMPLATE/other_issues.yml

@@ -10,7 +10,10 @@ body:
     attributes:
       value: |
         Please check [https://docs.qmk.fm/#/support](https://docs.qmk.fm/#/support) for additional resources first. If that doesn't answer your question, choose the bug report template instead, as that may be more appropriate.
+
+        Please refrain from asking maintainers to add support for specific keyboards -- it is unlikely they will have hardware available, and will not be able to help.
+        Your best bet is to take the initiative, add support, then submit a PR yourself.
   - type: textarea
     attributes:
       label: Issue Description
-      description: Describe your issue in as much detail as possible.
+      description: Describe your issue in as much detail as possible.

.github/labeler.yml

@@ -5,6 +5,7 @@ core:
   - tests/**/*
   - util/**/*
   - platforms/**/*
+  - builddefs/**/*
   - Makefile
   - '*.mk'
 dependencies:

.github/workflows/auto_tag.yml

@@ -31,7 +31,7 @@ jobs:
         fetch-depth: 0
 
     - name: Bump version and push tag
-      uses: anothrNick/github-tag-action@1.56.0
+      uses: anothrNick/github-tag-action@1.62.0
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         DEFAULT_BUMP: 'patch'

.github/workflows/ci_builds.yml

@@ -0,0 +1,74 @@
+name: CI Builds
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [master, develop]
+  workflow_dispatch:
+    inputs:
+      branch:
+        type: choice
+        description: 'Branch to build'
+        options: [master, develop]
+
+concurrency: ci_build-${{ github.event.inputs.branch || github.ref_name }}
+
+jobs:
+  ci_builds:
+    if: github.repository == 'qmk/qmk_firmware'
+    name: "CI Build"
+    runs-on: self-hosted
+    timeout-minutes: 1380
+
+    strategy:
+      fail-fast: false
+      matrix:
+        keymap: [default, via]
+
+    container: qmkfm/qmk_cli
+
+    steps:
+    - name: Disable safe.directory check
+      run : git config --global --add safe.directory '*'
+
+    - uses: actions/checkout@v3
+      with:
+        submodules: recursive
+        ref: ${{ github.event.inputs.branch || github.ref }}
+
+    - name: Install dependencies
+      run: pip3 install -r requirements.txt
+
+    - name: Run `qmk mass-compile` (keymap ${{ matrix.keymap }})
+      run: |
+        export NCPUS=$(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || getconf _NPROCESSORS_ONLN 2>/dev/null)
+        qmk mass-compile -t -j $NCPUS -km ${{ matrix.keymap }} -e DUMP_CI_METADATA=yes || touch .failed
+        # Generate the step summary markdown
+        ./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
+        # Truncate to a maximum of 1MB to deal with GitHub workflow limit
+        truncate --size='<960K' $GITHUB_STEP_SUMMARY || true
+        # Exit with failure if the compilation stage failed
+        [ ! -f .failed ] || exit 1
+
+    - name: 'Upload artifacts'
+      uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: artifacts-${{ github.event.inputs.branch || github.ref_name }}-${{ matrix.keymap }}
+        if-no-files-found: ignore
+        path: |
+          *.bin
+          *.hex
+          *.uf2
+          .build/failed.*
+
+    - name: 'CI Discord Notification'
+      if: always()
+      working-directory: util/ci/
+      env:
+        DISCORD_WEBHOOK: ${{ secrets.CI_DISCORD_WEBHOOK }}
+      run: |
+        python3 -m pip install -r requirements.txt
+        python3 ./discord-results.py --branch ${{ github.event.inputs.branch || github.ref_name }} --keymap ${{ matrix.keymap }} --url ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

.github/workflows/cli.yml

@@ -21,9 +21,13 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
+    - name: Disable safe.directory check
+      run : git config --global --add safe.directory '*'
+
     - uses: actions/checkout@v3
       with:
         submodules: recursive
+
     - name: Install dependencies
       run: pip3 install -r requirements-dev.txt
     - name: Run tests

.github/workflows/docs.yml

@@ -27,12 +27,16 @@ jobs:
       with:
         fetch-depth: 1
 
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16
+        cache: npm
+
     - name: Install dependencies
       run: |
         apt-get update && apt-get install -y rsync nodejs npm doxygen
-        npm install -g moxygen
 
-    - name: Build docs
+    - name: Build doxygen docs
       run: |
         qmk --verbose generate-docs
 
@@ -42,5 +46,5 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         BASE_BRANCH: master
         BRANCH: gh-pages
-        FOLDER: .build/docs
+        FOLDER: .build/docs/build
         GIT_CONFIG_EMAIL: hello@qmk.fm

.github/workflows/format.yml

@@ -22,6 +22,9 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
+    - name: Disable safe.directory check
+      run : git config --global --add safe.directory '*'
+
     - uses: actions/checkout@v3
       with:
         fetch-depth: 0
@@ -30,16 +33,14 @@ jobs:
       run: |
         pip3 install -r requirements-dev.txt
 
-    - uses: trilom/file-changes-action@v1.2.4
+    - name: Get changed files
       id: file_changes
-      with:
-        output: ' '
-        fileOutput: ' '
+      uses: tj-actions/changed-files@v35
 
     - name: Run qmk formatters
       shell: 'bash {0}'
       run: |
-        cat ~/files_added.txt ~/files_modified.txt > ~/files_changed.txt
+        echo '${{ steps.file_changes.outputs.added_files}}' '${{ steps.file_changes.outputs.modified_files}}' > ~/files_changed.txt
         qmk format-c --core-only $(< ~/files_changed.txt) || true
         qmk format-python $(< ~/files_changed.txt) || true
         qmk format-text $(< ~/files_changed.txt) || true

.github/workflows/format_push.yml

@@ -16,6 +16,9 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
+    - name: Disable safe.directory check
+      run : git config --global --add safe.directory '*'
+
     - uses: actions/checkout@v3
       with:
         fetch-depth: 0
@@ -44,7 +47,7 @@ jobs:
         git config user.email 'hello@qmk.fm'
 
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v4
+      uses: peter-evans/create-pull-request@v5
       if: ${{ github.repository == 'qmk/qmk_firmware'}}
       with:
         token: ${{ secrets.QMK_BOT_TOKEN }}

.github/workflows/lint.yml

@@ -15,6 +15,9 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
+    - name: Disable safe.directory check
+      run : git config --global --add safe.directory '*'
+
     - uses: actions/checkout@v3
       with:
         fetch-depth: 0
@@ -22,24 +25,24 @@ jobs:
     - name: Install dependencies
       run: pip3 install -r requirements-dev.txt
 
-    - uses: trilom/file-changes-action@v1.2.4
+    - name: Get changed files
       id: file_changes
-      with:
-        output: '\n'
+      uses: tj-actions/changed-files@v35
 
     - name: Print info
       run: |
         git rev-parse --short HEAD
         echo ${{ github.event.pull_request.base.sha }}
-        echo '${{ steps.file_changes.outputs.files}}'
+        echo '${{ steps.file_changes.outputs.all_changed_files}}'
 
     - name: Run qmk lint
       shell: 'bash {0}'
       run: |
-        QMK_CHANGES=$(echo -e '${{ steps.file_changes.outputs.files}}')
+        QMK_CHANGES=$(echo -e '${{ steps.file_changes.outputs.all_changed_files}}' | sed 's/ /\n/g')
         QMK_KEYBOARDS=$(qmk list-keyboards)
 
         exit_code=0
+
         for KB in $QMK_KEYBOARDS; do
           KEYBOARD_CHANGES=$(echo "$QMK_CHANGES" | grep -E '^(keyboards/'${KB}'/)')
           if [[ -z "$KEYBOARD_CHANGES" ]]; then
@@ -55,6 +58,16 @@ jobs:
             exit_code=$(($exit_code + $?))
           fi
         done
+
+        qmk format-text ${{ steps.file_changes.outputs.all_changed_files}} || true
+        for file in ${{ steps.file_changes.outputs.all_changed_files}}; do
+          if ! git diff --quiet $file; then
+            echo "File '${file}' Requires Formatting"
+            echo "::error file=${file}::Requires Formatting"
+            exit_code=$(($exit_code + 1))
+          fi
+        done
+
         if [[ $exit_code -gt 255 ]]; then
             exit 255
         fi

.github/workflows/regen.yml

@@ -0,0 +1,36 @@
+name: PR Regenerate Files
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    paths:
+    - 'data/constants/**'
+    - 'lib/python/**'
+
+jobs:
+  regen:
+    runs-on: ubuntu-latest
+
+    container: qmkfm/qmk_cli
+
+    steps:
+    - name: Disable safe.directory check
+      run : git config --global --add safe.directory '*'
+
+    - uses: actions/checkout@v3
+
+    - name: Run qmk generators
+      run: |
+        util/regen.sh
+        git diff
+
+    - name: Fail when regeneration required
+      run: |
+        git diff
+        for file in $(git diff --name-only); do
+          echo "File '${file}' Requires Regeneration"
+          echo "::error file=${file}::Requires Regeneration"
+        done
+        test -z "$(git diff --name-only)"

.github/workflows/regen_push.yml

@@ -0,0 +1,46 @@
+name: Regenerate Files
+
+permissions:
+  contents: write
+
+on:
+  push:
+    branches:
+    - master
+    - develop
+
+jobs:
+  regen:
+    runs-on: ubuntu-latest
+
+    container: qmkfm/qmk_cli
+
+    steps:
+    - name: Disable safe.directory check
+      run : git config --global --add safe.directory '*'
+
+    - uses: actions/checkout@v3
+
+    - name: Run qmk generators
+      run: |
+        util/regen.sh
+        git diff
+
+    - uses: rlespinasse/github-slug-action@v3.x
+
+    - name: Become QMK Bot
+      run: |
+        git config user.name 'QMK Bot'
+        git config user.email 'hello@qmk.fm'
+
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v5
+      if: ${{ github.repository == 'qmk/qmk_firmware'}}
+      with:
+        token: ${{ secrets.QMK_BOT_TOKEN }}
+        delete-branch: true
+        branch: bugfix/regen_${{ env.GITHUB_REF_SLUG }}
+        author: QMK Bot <hello@qmk.fm>
+        committer: QMK Bot <hello@qmk.fm>
+        commit-message: Regenerate Files
+        title: '[CI] Regenerate Files'

.github/workflows/stale.yml

@@ -13,7 +13,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v7
+      - uses: actions/stale@v8
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 

.gitignore

@@ -30,6 +30,9 @@ quantum/version.h
 *.qmk
 *.uf2
 
+# DD config at wrong location
+/keyboards/**/keymaps/*/info.json
+
 # Old-style QMK Makefiles
 /keyboards/**/Makefile
 

.gitmodules

@@ -21,3 +21,7 @@
 [submodule "lib/pico-sdk"]
 	path = lib/pico-sdk
 	url = https://github.com/qmk/pico-sdk.git
+[submodule "lib/lvgl"]
+	path = lib/lvgl
+	url = https://github.com/qmk/lvgl.git
+	branch = release/v8.2

.vscode/extensions.json

@@ -1,10 +1,11 @@
 // Suggested extensions
 {
   "recommendations": [
-    "EditorConfig.EditorConfig",
+    "editorconfig.editorconfig",
     "xaver.clang-format",
     "ms-vscode.cpptools",
     "bierner.github-markdown-preview",
-    "donjayamanne.git-extension-pack"
+    "donjayamanne.git-extension-pack",
+    "kevgo.vscode-markdown-ide"
   ]
 }

Doxyfile

@@ -21,7 +21,7 @@ DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "QMK Firmware"
 PROJECT_NUMBER         = https://github.com/qmk/qmk_firmware
 PROJECT_BRIEF          = "Keyboard controller firmware for Atmel AVR and ARM USB families"
-OUTPUT_DIRECTORY       = .build/doxygen
+OUTPUT_DIRECTORY       = docs/static
 ALLOW_UNICODE_NAMES    = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
@@ -183,7 +183,7 @@ IGNORE_PREFIX          =
 # Configuration options related to disabled outputs
 #---------------------------------------------------------------------------
 
-GENERATE_HTML          = NO
+GENERATE_HTML          = YES
 GENERATE_LATEX         = NO
 GENERATE_RTF           = NO
 GENERATE_MAN           = NO
@@ -191,11 +191,18 @@ GENERATE_DOCBOOK       = NO
 GENERATE_AUTOGEN_DEF   = NO
 GENERATE_PERLMOD       = NO
 
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+HTML_OUTPUT            = doxygen
+# HTML_FILE_EXTENSION    = 
+
 #---------------------------------------------------------------------------
 # Configuration options related to the XML output
 #---------------------------------------------------------------------------
 
-GENERATE_XML           = YES
+GENERATE_XML           = NO
 XML_OUTPUT             = xml
 XML_PROGRAMLISTING     = YES
 

Makefile

@@ -19,8 +19,13 @@ endif
 # Otherwise the [OK], [ERROR] and [WARN] messages won't be displayed correctly
 override SILENT := false
 
+ifeq ($(shell git rev-parse --is-inside-work-tree 2>/dev/null),)
+    export SKIP_GIT := yes
+    export NOT_REPO := yes
+endif
+
 ifdef SKIP_VERSION
-    SKIP_GIT := yes
+    export SKIP_GIT := yes
 endif
 
 ifndef SUB_IS_SILENT
@@ -43,17 +48,10 @@ ON_ERROR := error_occurred=1
 
 BREAK_ON_ERRORS = no
 
-STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST))
-ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST))
-ROOT_DIR := $(dir $(ROOT_MAKEFILE))
+ROOT_DIR := $(dir $(lastword $(MAKEFILE_LIST)))
 ifeq ($(ROOT_DIR),)
     ROOT_DIR := .
 endif
-ABS_STARTING_MAKEFILE := $(abspath $(STARTING_MAKEFILE))
-ABS_ROOT_MAKEFILE := $(abspath $(ROOT_MAKEFILE))
-ABS_STARTING_DIR := $(dir $(ABS_STARTING_MAKEFILE))
-ABS_ROOT_DIR := $(dir $(ABS_ROOT_MAKEFILE))
-STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR))
 
 include paths.mk
 
@@ -126,29 +124,16 @@ endef
 define PARSE_RULE
     RULE := $1
     COMMANDS :=
-    REQUIRE_PLATFORM_KEY :=
     # If the rule starts with all, then continue the parsing from
     # PARSE_ALL_KEYBOARDS
     ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
         KEYBOARD_RULE=all
         $$(eval $$(call PARSE_ALL_KEYBOARDS))
-    else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-avr),true)
-        KEYBOARD_RULE=all
-        REQUIRE_PLATFORM_KEY := avr
-        $$(eval $$(call PARSE_ALL_KEYBOARDS))
-    else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-chibios),true)
-        KEYBOARD_RULE=all
-        REQUIRE_PLATFORM_KEY := chibios
-        $$(eval $$(call PARSE_ALL_KEYBOARDS))
-    else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-arm_atsam),true)
-        KEYBOARD_RULE=all
-        REQUIRE_PLATFORM_KEY := arm_atsam
-        $$(eval $$(call PARSE_ALL_KEYBOARDS))
     else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,test),true)
         $$(eval $$(call PARSE_TEST))
     # If the rule starts with the name of a known keyboard, then continue
     # the parsing from PARSE_KEYBOARD
-    else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(shell util/list_keyboards.sh | sort -u)),true)
+    else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(shell $(QMK_BIN) list-keyboards --no-resolve-defaults)),true)
         KEYBOARD_RULE=$$(MATCHED_ITEM)
         $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
     else
@@ -241,7 +226,7 @@ endef
 # if we are going to compile all keyboards, match the rest of the rule
 # for each of them
 define PARSE_ALL_KEYBOARDS
-    $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell util/list_keyboards.sh | sort -u)))
+    $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell $(QMK_BIN) list-keyboards --no-resolve-defaults)))
 endef
 
 # Prints a list of all known keymaps for the given keyboard
@@ -273,7 +258,7 @@ define PARSE_KEYMAP
     # Format it in bold
     KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
     # Specify the variables that we are passing forward to submake
-    MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM) REQUIRE_PLATFORM_KEY=$$(REQUIRE_PLATFORM_KEY) QMK_BIN=$$(QMK_BIN)
+    MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM) QMK_BIN=$$(QMK_BIN)
     # And the first part of the make command
     MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f $(BUILDDEFS_PATH)/build_keyboard.mk $$(MAKE_TARGET)
     # The message to display
@@ -390,25 +375,15 @@ endef
 # Catch everything and parse the command line ourselves.
 .PHONY: %
 %:
-	# Check if we have the CMP tool installed
-	cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
 	# Ensure that $(QMK_BIN) works.
 	if ! $(QMK_BIN) hello 1> /dev/null 2>&1; then printf "$(MSG_PYTHON_MISSING)"; exit 1; fi
-	# Check if the submodules are dirty, and display a warning if they are
+ifdef NOT_REPO
+	printf "$(MSG_NOT_REPO)"
+endif
 ifndef SKIP_GIT
-	if [ ! -e lib/chibios ]; then git submodule sync lib/chibios && git submodule update --depth 50 --init lib/chibios; fi
-	if [ ! -e lib/chibios-contrib ]; then git submodule sync lib/chibios-contrib && git submodule update --depth 50 --init lib/chibios-contrib; fi
-	if [ ! -e lib/lufa ]; then git submodule sync lib/lufa && git submodule update --depth 50 --init lib/lufa; fi
-	if [ ! -e lib/vusb ]; then git submodule sync lib/vusb && git submodule update --depth 50 --init lib/vusb; fi
-	if [ ! -e lib/printf ]; then git submodule sync lib/printf && git submodule update --depth 50 --init lib/printf; fi
-	if [ ! -e lib/pico-sdk ]; then git submodule sync lib/pico-sdk && git submodule update --depth 50 --init lib/pico-sdk; fi
-	git submodule status --recursive 2>/dev/null | \
-	while IFS= read -r x; do \
-		case "$$x" in \
-			\ *) ;; \
-			*) printf "$(MSG_SUBMODULE_DIRTY)";break;; \
-		esac \
-	done
+	$(QMK_BIN) git-submodule --sync
+	# Check if the submodules are dirty, and display a warning if they are
+	if ! $(QMK_BIN) git-submodule --check 1> /dev/null 2>&1; then printf "$(MSG_SUBMODULE_DIRTY)"; fi
 endif
 	rm -f $(ERROR_FILE) > /dev/null 2>&1
 	$(eval $(call PARSE_RULE,$@))
@@ -429,22 +404,18 @@ lib/%:
 
 .PHONY: git-submodule
 git-submodule:
-	[ -e lib/ugfx ] && rm -rf lib/ugfx || true
-	[ -e lib/pico-sdk ] && rm -rf lib/pico-sdk || true
-	[ -e lib/chibios-contrib/ext/mcux-sdk ] && rm -rf lib/chibios-contrib/ext/mcux-sdk || true
-	git submodule sync --recursive
-	git submodule update --init --recursive --progress
+	$(QMK_BIN) git-submodule
 
 .PHONY: git-submodules
 git-submodules: git-submodule
 
 .PHONY: list-keyboards
 list-keyboards:
-	util/list_keyboards.sh | sort -u | tr '\n' ' '
+	$(QMK_BIN) list-keyboards --no-resolve-defaults | tr '\n' ' '
 
 .PHONY: generate-keyboards-file
 generate-keyboards-file:
-	util/list_keyboards.sh | sort -u
+	$(QMK_BIN) list-keyboards --no-resolve-defaults
 
 .PHONY: clean
 clean:

builddefs/build_full_test.mk

@@ -24,6 +24,8 @@ $(TEST)_SRC := \
 	tests/test_common/matrix.c \
 	tests/test_common/test_driver.cpp \
 	tests/test_common/keyboard_report_util.cpp \
+	tests/test_common/keycode_util.cpp \
+	tests/test_common/keycode_table.cpp \
 	tests/test_common/test_fixture.cpp \
 	tests/test_common/test_keymap_key.cpp \
 	tests/test_common/test_logger.cpp \

builddefs/build_keyboard.mk

@@ -29,6 +29,11 @@ KEYBOARD_FILESAFE := $(subst /,_,$(KEYBOARD))
 TARGET ?= $(KEYBOARD_FILESAFE)_$(KEYMAP)
 KEYBOARD_OUTPUT := $(BUILD_DIR)/obj_$(KEYBOARD_FILESAFE)
 
+ifeq ($(strip $(DUMP_CI_METADATA)),yes)
+    $(info CI Metadata: KEYBOARD=$(KEYBOARD))
+    $(info CI Metadata: KEYMAP=$(KEYMAP))
+endif
+
 # Force expansion
 TARGET := $(TARGET)
 
@@ -46,11 +51,12 @@ ifdef SKIP_VERSION
 endif
 
 # Generate the version.h file
+VERSION_H_FLAGS :=
 ifdef SKIP_VERSION
-VERSION_H_FLAGS := --skip-all
+VERSION_H_FLAGS += --skip-all
 endif
 ifdef SKIP_GIT
-VERSION_H_FLAGS := --skip-git
+VERSION_H_FLAGS += --skip-git
 endif
 
 # Generate the board's version.h file.
@@ -182,7 +188,14 @@ endif
 
 include $(BUILDDEFS_PATH)/converters.mk
 
-include $(BUILDDEFS_PATH)/mcu_selection.mk
+MCU_ORIG := $(MCU)
+include $(wildcard $(PLATFORM_PATH)/*/mcu_selection.mk)
+
+# PLATFORM_KEY should be detected in info.json via key 'processor' (or rules.mk 'MCU')
+ifeq ($(PLATFORM_KEY),)
+    $(call CATASTROPHIC_ERROR,Platform not defined)
+endif
+PLATFORM=$(shell echo $(PLATFORM_KEY) | tr '[:lower:]' '[:upper:]')
 
 # Find all the C source files to be compiled in subfolders.
 KEYBOARD_SRC :=
@@ -257,24 +270,6 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).h)","")
     FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_5).h
 endif
 
-# Determine and set parameters based on the keyboard's processor family.
-# We can assume a ChibiOS target When MCU_FAMILY is defined since it's
-# not used for LUFA
-ifdef MCU_FAMILY
-    PLATFORM=CHIBIOS
-    PLATFORM_KEY=chibios
-    FIRMWARE_FORMAT?=bin
-    OPT_DEFS += -DMCU_$(MCU_FAMILY)
-else ifdef ARM_ATSAM
-    PLATFORM=ARM_ATSAM
-    PLATFORM_KEY=arm_atsam
-    FIRMWARE_FORMAT=bin
-else
-    PLATFORM=AVR
-    PLATFORM_KEY=avr
-    FIRMWARE_FORMAT?=hex
-endif
-
 # Find all of the config.h files and add them to our CONFIG_H define.
 CONFIG_H :=
 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
@@ -433,13 +428,6 @@ SRC += $(TMK_COMMON_SRC)
 OPT_DEFS += $(TMK_COMMON_DEFS)
 EXTRALDFLAGS += $(TMK_COMMON_LDFLAGS)
 
-SKIP_COMPILE := no
-ifneq ($(REQUIRE_PLATFORM_KEY),)
-    ifneq ($(REQUIRE_PLATFORM_KEY),$(PLATFORM_KEY))
-        SKIP_COMPILE := yes
-    endif
-endif
-
 -include $(PLATFORM_PATH)/$(PLATFORM_KEY)/bootloader.mk
 include $(PLATFORM_PATH)/$(PLATFORM_KEY)/platform.mk
 -include $(PLATFORM_PATH)/$(PLATFORM_KEY)/flash.mk
@@ -479,12 +467,7 @@ $(KEYBOARD_OUTPUT)_INC := $(PROJECT_INC)
 $(KEYBOARD_OUTPUT)_CONFIG := $(PROJECT_CONFIG)
 
 # Default target.
-ifeq ($(SKIP_COMPILE),no)
 all: build check-size
-else
-all:
-	echo "skipped" >&2
-endif
 
 build: elf cpfirmware
 check-size: build

builddefs/build_test.mk

@@ -62,6 +62,7 @@ include $(PLATFORM_PATH)/common.mk
 include $(TMK_PATH)/protocol.mk
 include $(QUANTUM_PATH)/debounce/tests/rules.mk
 include $(QUANTUM_PATH)/encoder/tests/rules.mk
+include $(QUANTUM_PATH)/os_detection/tests/rules.mk
 include $(QUANTUM_PATH)/sequencer/tests/rules.mk
 include $(QUANTUM_PATH)/wear_leveling/tests/rules.mk
 include $(QUANTUM_PATH)/logging/print.mk

builddefs/common_features.mk

@@ -84,6 +84,13 @@ endif
 ifeq ($(strip $(MIDI_ENABLE)), yes)
     OPT_DEFS += -DMIDI_ENABLE
     MUSIC_ENABLE = yes
+    COMMON_VPATH += $(QUANTUM_PATH)/midi
+    SRC += $(QUANTUM_DIR)/midi/midi.c
+    SRC += $(QUANTUM_DIR)/midi/midi_device.c
+    SRC += $(QUANTUM_DIR)/midi/qmk_midi.c
+    SRC += $(QUANTUM_DIR)/midi/sysex_tools.c
+    SRC += $(QUANTUM_DIR)/midi/bytequeue/bytequeue.c
+    SRC += $(QUANTUM_DIR)/midi/bytequeue/interrupt_setting.c
     SRC += $(QUANTUM_DIR)/process_keycode/process_midi.c
 endif
 
@@ -613,6 +620,7 @@ ifeq ($(strip $(VIA_ENABLE)), yes)
     DYNAMIC_KEYMAP_ENABLE := yes
     RAW_ENABLE := yes
     BOOTMAGIC_ENABLE := yes
+    TRI_LAYER_ENABLE := yes
     SRC += $(QUANTUM_DIR)/via.c
     OPT_DEFS += -DVIA_ENABLE
 endif
@@ -907,3 +915,11 @@ ifeq ($(strip $(ENCODER_ENABLE)), yes)
         OPT_DEFS += -DENCODER_MAP_ENABLE
     endif
 endif
+
+ifeq ($(strip $(OS_DETECTION_ENABLE)), yes)
+    SRC += $(QUANTUM_DIR)/os_detection.c
+    OPT_DEFS += -DOS_DETECTION_ENABLE
+    ifeq ($(strip $(OS_DETECTION_DEBUG_ENABLE)), yes)
+        OPT_DEFS += -DOS_DETECTION_DEBUG_ENABLE
+    endif
+endif

builddefs/common_rules.mk

@@ -218,8 +218,8 @@ gccversion :
 	@$(SILENT) || printf "$(MSG_FLASH) $@" | $(AWK_CMD)
 	@$(BUILD_CMD)
 
-%.uf2: %.hex
-	$(eval CMD=$(UF2CONV) $(BUILD_DIR)/$(TARGET).hex --output $(BUILD_DIR)/$(TARGET).uf2 --convert --family $(UF2_FAMILY) >/dev/null 2>&1)
+%.uf2: %.elf
+	$(eval CMD=$(HEX) $< $(BUILD_DIR)/$(TARGET).tmp && $(UF2CONV) $(BUILD_DIR)/$(TARGET).tmp --output $@ --convert --family $(UF2_FAMILY) >/dev/null 2>&1)
 	#@$(SILENT) || printf "$(MSG_EXECUTING) '$(CMD)':\n"
 	@$(SILENT) || printf "$(MSG_UF2) $@" | $(AWK_CMD)
 	@$(BUILD_CMD)

builddefs/converters.mk

@@ -1,30 +1,25 @@
 # Note for new boards -- CTPC and CONVERT_TO_PROTON_C are deprecated terms
 # and should not be replicated for new boards. These will be removed from
 # documentation as well as existing keymaps in due course.
-ifeq ($(strip $(CTPC)), yes)
-    CONVERT_TO_PROTON_C=yes
-endif
-ifeq ($(strip $(CONVERT_TO_PROTON_C)), yes)
-    CONVERT_TO=proton_c
-
-cpfirmware: ctpc_warning
-.INTERMEDIATE: ctpc_warning
-ctpc_warning: elf
-	$(info @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
-	$(info The `CONVERT_TO_PROTON_C` and `CTPC` options are soon to be deprecated.)
-	$(info Boards should be changed to use `CONVERT_TO=proton_c` instead.)
-	$(info @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
+ifneq ($(findstring yes, $(CTPC)$(CONVERT_TO_PROTON_C)),)
+$(call CATASTROPHIC_ERROR,The `CONVERT_TO_PROTON_C` and `CTPC` options are now deprecated. `CONVERT_TO=proton_c` should be used instead.)
 endif
 
 # TODO: opt in rather than assume everything uses a pro micro
 PIN_COMPATIBLE ?= promicro
 ifneq ($(CONVERT_TO),)
+    # stash so we can overwrite env provided vars if needed
+    ACTIVE_CONVERTER=$(CONVERT_TO)
+
     # glob to search each platfrorm and/or check for valid converter
     CONVERTER := $(wildcard $(PLATFORM_PATH)/*/converters/$(PIN_COMPATIBLE)_to_$(CONVERT_TO)/)
     ifeq ($(CONVERTER),)
         $(call CATASTROPHIC_ERROR,Converting from '$(PIN_COMPATIBLE)' to '$(CONVERT_TO)' not possible!)
     endif
 
+    -include $(CONVERTER)/pre_converter.mk
+
+    PLATFORM_KEY = $(shell echo $(CONVERTER) | cut -d "/" -f2)
     TARGET := $(TARGET)_$(CONVERT_TO)
 
     # Configure any defaults
@@ -33,6 +28,9 @@ ifneq ($(CONVERT_TO),)
     OPT_DEFS += -DCONVERTER_ENABLED
     VPATH += $(CONVERTER)
 
+    # Configure for "alias" - worst case it produces an idential define
+    OPT_DEFS += -DCONVERT_TO_$(strip $(shell echo $(ACTIVE_CONVERTER) | tr '[:lower:]' '[:upper:]'))
+
     # Finally run any converter specific logic
     include $(CONVERTER)/converter.mk
 endif

builddefs/docs/.gitignore

@@ -0,0 +1,21 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+/static/doxygen
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

builddefs/docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

builddefs/docs/docusaurus.config.js

@@ -0,0 +1,285 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require("prism-react-renderer/themes/github");
+const darkCodeTheme = require("prism-react-renderer/themes/dracula");
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+    title: "QMK Firmware",
+    tagline: "The full documentation of the open-source firmware",
+    favicon: "img/favicon.ico",
+    url: "https://docs.qmk.fm",
+    baseUrl: "/",
+    organizationName: "qmk",
+    projectName: "qmk_firmware",
+    deploymentBranch: "gh-pages",
+    onBrokenLinks: "warn",
+    onBrokenMarkdownLinks: "warn",
+    i18n: {
+        defaultLocale: "en",
+        locales: ["en"], //, 'ja', 'zh-cn'],
+    },
+    themes: [
+        [
+            "classic",
+            {
+                customCss: require.resolve("./src/css/custom.css"),
+            }
+        ],
+        [
+            require.resolve("@easyops-cn/docusaurus-search-local"),
+            {
+                indexBlog: false,
+                docsRouteBasePath: '/',
+                searchResultLimits: 12,
+                searchBarShortcut: false,
+            },
+        ],
+    ],
+    plugins: [
+        [
+            "@docusaurus/plugin-content-docs",
+            {
+                sidebarPath: require.resolve("./sidebars.js"),
+                path: "../../docs",
+                routeBasePath: "/",
+                exclude: [
+                    "node_modules",
+                    "src",
+                    "static",
+                    "ja",
+                    "zh-cn",
+                    "gitbook",
+                    // "ChangeLog"
+                ],
+                editUrl:
+                    "https://github.com/qmk/qmk_firmware/edit/master/docs/",
+            },
+        ],
+        [
+            "@docusaurus/plugin-client-redirects",
+            {
+                // fromExtensions: ['md', 'html'],
+                redirects: [
+                    // from index.html
+                    {
+                        from: '/adding_a_keyboard_to_qmk',
+                        to: '/hardware_keyboard_guidelines',
+                    },
+                    {
+                        from: '/build_environment_setup',
+                        to: '/newbs_getting_started',
+                    },
+                    {
+                        from: '/cli_dev_configuration',
+                        to: '/cli_configuration',
+                    },
+                    {
+                        from: '/dynamic_macros',
+                        to: '/feature_dynamic_macros',
+                    },
+                    {
+                        from: '/feature_common_shortcuts',
+                        to: '/feature_advanced_keycodes',
+                    },
+                    {
+                        from: '/glossary',
+                        to: '/reference_glossary',
+                    },
+                    {
+                        from: '/key_lock',
+                        to: '/feature_key_lock',
+                    },
+                    {
+                        from: '/make_instructions',
+                        to: '/getting_started_make_guide',
+                    },
+                    {
+                        from: ['/space_cadet_shift', '/feature_space_cadet_shift'],
+                        to: '/feature_space_cadet',
+                    },
+                    {
+                        from: '/getting_started_getting_help',
+                        to: '/support',
+                    },
+                    {
+                        from: '/tap_dance',
+                        to: '/feature_tap_dance',
+                    },
+                    {
+                        from: '/unicode',
+                        to: '/feature_unicode',
+                    },
+                    {
+                        from: '/python_development',
+                        to: '/cli_development',
+                    },
+                    {
+                        from: '/getting_started_build_tools',
+                        to: '/newbs_getting_started',
+                    },
+                    {
+                        from: '/tutorial',
+                        to: '/newbs',
+                    },
+                    // from redirects.json
+                    // {
+                    //     from: "/adding_a_keyboard_to_qmk",
+                    //     to: "/hardware_keyboard_guidelines"
+                    // },
+                    // {
+                    //     from: "/build_environment_setup",
+                    //     to: "/getting_started_build_tools"
+                    // },
+                    // {
+                    //     from: "/dynamic_macros",
+                    //     to: "/feature_dynamic_macros"
+                    // },
+                    // {
+                    //     from: "/feature_common_shortcuts",
+                    //     to: "/feature_advanced_keycodes"
+                    // },
+                    // {
+                    //     from: "/glossary",
+                    //     to: "/reference_glossary"
+                    // },
+                    // {
+                    //     from: "/key_lock",
+                    //     to: "/feature_key_lock"
+                    // },
+                    // {
+                    //     from: "/make_instructions",
+                    //     to: "/getting_started_make_guide"
+                    // },
+                    // {
+                    //     from: "/porting_your_keyboard_to_qmk",
+                    //     to: "/hardware_avr"
+                    // },
+                    // {
+                    //     from: "/space_cadet_shift",
+                    //     to: "/feature_space_cadet_shift"
+                    // },
+                    // {
+                    //     from: "/tap_dance",
+                    //     to: "/feature_tap_dance"
+                    // },
+                    // {
+                    //     from: "/unicode",
+                    //     to: "/feature_unicode"
+                    // },
+                    // {
+                    //     from: "/python_development",
+                    //     to: "/cli_development"
+                    // }
+                  ],
+            },
+        ],
+    ],
+
+    themeConfig:
+        /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+        ({
+            image: "img/qmk-social-card.jpg",
+            navbar: {
+                title: "QMK Firmware Docs",
+                logo: {
+                    alt: "QMK Firmware",
+                    src: "img/qmk-new-light.svg",
+                    srcDark: "img/qmk-new-dark.svg",
+                    width: 32,
+                    height: 32,
+                },
+                items: [
+                    // {
+                    // type: 'localeDropdown',
+                    // position: 'right',
+                    // },
+                    {
+                        href: "https://github.com/qmk/qmk_firmware",
+                        label: "GitHub",
+                        position: "right",
+                    },
+                ],
+            },
+            docs: {
+                sidebar: {
+                    autoCollapseCategories: false,
+                },
+            },
+            footer: {
+                style: "dark",
+                links: [
+                    {
+                        title: "Docs",
+                        items: [
+                            {
+                                label: "Docs",
+                                to: "/",
+                            },
+                        ],
+                    },
+                    {
+                        title: "Community",
+                        items: [
+                            {
+                                label: "Discord",
+                                href: "https://discord.gg/Uq7gcHh",
+                            },
+                            {
+                                label: "Reddit",
+                                href: "https://reddit.com/r/olkb",
+                            },
+                        ],
+                    },
+                    {
+                        title: "More",
+                        items: [
+                            {
+                                label: "GitHub",
+                                href: "https://github.com/qmk/qmk_firmware",
+                            },
+                        ],
+                    },
+                ],
+                copyright: `Copyright © ${new Date().getFullYear()} QMK. Built with Docusaurus.`,
+            },
+            prism: {
+                theme: lightCodeTheme,
+                darkTheme: darkCodeTheme,
+            },
+            // applied for - will fill out once we hear back
+            //
+            // algolia: {
+            //   // The application ID provided by Algolia
+            //   appId: 'YOUR_APP_ID',
+
+            //   // Public API key: it is safe to commit it
+            //   apiKey: 'YOUR_SEARCH_API_KEY',
+
+            //   indexName: 'YOUR_INDEX_NAME',
+
+            //   // Optional: see doc section below
+            //   contextualSearch: true,
+
+            //   // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
+            //   externalUrlRegex: 'external\\.com|domain\\.com',
+
+            //   // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
+            //   replaceSearchResultPathname: {
+            //     from: '/docs/', // or as RegExp: /\/docs\//
+            //     to: '/',
+            //   },
+
+            //   // Optional: Algolia search parameters
+            //   searchParameters: {},
+
+            //   // Optional: path for search page that enabled by default (`false` to disable it)
+            //   searchPagePath: 'search',
+
+            //   //... other Algolia params
+            // },
+        }),
+};
+
+module.exports = config;

builddefs/docs/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "qmk_firmware_docs",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "docusaurus": "docusaurus",
+    "start": "docusaurus start --host 0.0.0.0 --port 8936",
+    "build": "docusaurus build",
+    "swizzle": "docusaurus swizzle",
+    "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve --host 0.0.0.0 --port 8936",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids"
+  },
+  "dependencies": {
+    "@docusaurus/core": "2.4.0",
+    "@docusaurus/plugin-client-redirects": "^2.4.0",
+    "@docusaurus/preset-classic": "2.4.0",
+    "@easyops-cn/docusaurus-search-local": "^0.35.0",
+    "@mdx-js/react": "^1.6.22",
+    "clsx": "^1.2.1",
+    "prism-react-renderer": "^1.3.5",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "2.4.0"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "engines": {
+    "node": ">=16.14"
+  }
+}