Fix non-functional RGBLIGHT_EFFECT_TWINKLE on ARM (#19335)

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,37 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve QMK Firmware.
-title: "[Bug] "
-labels: bug, help wanted
-assignees: ''
-
----
-
-<!-- Provide a general summary of the bug in the title above. -->
-
-<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
-<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
-
-## Describe the Bug
-
-<!-- A clear and concise description of what the bug is. -->
-
-## System Information
-
- - Keyboard:  
-   - Revision (if applicable):  
- - Operating system:
- - AVR GCC version: 
-<!-- Run `avr-gcc --version` to find this out. -->
- - ARM GCC version: 
-<!-- Run `arm-none-eabi-gcc --version` to find this out. -->
- - QMK Firmware version:
-<!-- Run `git describe --abbrev=0 --tags` to find this out. -->
- - Any keyboard related software installed? 
-   - [ ] AutoHotKey
-   - [ ] Karabiner
-   - [ ] Other:
-
-## Additional Context
-
-<!-- Add any other relevant information about the problem here. -->

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,41 @@
+name: Bug report
+description: Create a report to help us improve QMK Firmware.
+title: "[Bug] "
+labels: ["bug", "help wanted"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Provide a general summary of the bug in the title above.
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+  - type: input
+    attributes:
+      label: Keyboard Used
+      description: The name of the keyboard from the `make` or `qmk compile`/`qmk flash` commands, eg. `planck/rev6`.
+  - type: input
+    attributes:
+      label: Link to product page (if applicable)
+  - type: input
+    attributes:
+      label: Operating System
+  - type: textarea
+    attributes:
+      label: qmk doctor Output
+      description: Output from running the `qmk doctor` command.
+      render: text
+  - type: checkboxes
+    attributes:
+      label: Is AutoHotKey / Karabiner installed
+      options:
+        - label: AutoHotKey (Windows)
+        - label: Karabiner (macOS)
+  - type: input
+    attributes:
+      label: Other keyboard-related software installed
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: Add any other relevant information about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,24 +0,0 @@
----
-name: Feature request
-about: Suggest a new feature or changes to existing features.
-title: "[Feature Request] "
-labels: enhancement, help wanted
-assignees: ''
-
----
-
-<!--- Provide a general summary of the changes you want in the title above. -->
-
-<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
-<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
-
-## Feature Request Type
-
-- [ ] Core functionality
-- [ ] Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
-- [ ] Alteration (enhancement/optimization) of existing feature(s)
-- [ ] New behavior
-
-## 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/feature_request.yml

@@ -0,0 +1,21 @@
+name: Feature request
+description: Suggest a new feature or changes to existing features.
+title: "[Feature Request] "
+labels: ["enhancement", "help wanted"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Provide a general summary of the changes you want in the title above.
+  - type: checkboxes
+    attributes:
+      label: Feature Request Type
+      options:
+        - label: Core functionality
+        - label: Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
+        - label: Alteration (enhancement/optimization) of existing feature(s)
+        - label: New behavior
+  - 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.

.github/ISSUE_TEMPLATE/other_issues.md

@@ -1,14 +0,0 @@
----
-name: Other issues
-about: Anything else that doesn't fall into the above categories.
-title: ''
-labels: help wanted, question
-assignees: ''
-
----
-
-<!--- Provide a general summary of the changes you want in the title above. -->
-
-<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
-
-<!-- Please check 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. -->

.github/ISSUE_TEMPLATE/other_issues.yml

@@ -0,0 +1,16 @@
+name: Other issues
+description: Anything else that doesn't fall into the above categories.
+labels: ["help wanted", "question"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Provide a general summary of the changes you want in the title above.
+  - type: markdown
+    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.
+  - type: textarea
+    attributes:
+      label: Issue Description
+      description: Describe your issue in as much detail as possible.

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    labels: CI
+    reviewers:
+      - "qmk/collaborators"
+    schedule:
+      interval: "daily"

.github/stale.yml

@@ -1,58 +0,0 @@
-# Configuration for probot-stale - https://github.com/probot/stale
-
-# General configuration
-
-# Pull request specific configuration
-pulls:
-  staleLabel: awaiting changes
-  # Number of days of inactivity before an Issue or Pull Request becomes stale
-  daysUntilStale: 45
-  # Number of days of inactivity before a stale Issue or Pull Request is closed.
-  # Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
-  daysUntilClose: 30
-  # Comment to post when marking as stale. Set to `false` to disable
-  markComment: >
-    Thank you for your contribution!
-
-    This pull request has been automatically marked as stale because it has not had
-    activity in the last 45 days. It will be closed in 30 days if no further activity occurs.
-    Please feel free to give a status update now, or re-open when it's ready.
-    
-    For maintainers: Please label with `awaiting review`, `breaking_change`, `in progress`, or `on hold` to prevent 
-    the issue from being re-flagged.
-  # Comment to post when closing a stale Issue or Pull Request.
-  closeComment: >
-    Thank you for your contribution!
-
-    This pull request has been automatically closed because it has not had activity in the last 30 days.
-    Please feel free to give a status update now, ping for review, or re-open when it's ready.
-  # Limit the number of actions per hour, from 1-30. Default is 30
-  limitPerRun: 30
-  exemptLabels:
-    - awaiting review
-    - breaking_change
-    - in progress
-    - on hold
-
-# Issue specific configuration
-issues:
-  staleLabel: stale
-  limitPerRun: 10
-  daysUntilStale: 90
-  daysUntilClose: 30
-  markComment: >
-    This issue has been automatically marked as stale because it has not had activity in the
-    last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity
-    occurs.
-    
-    For maintainers: Please label with `bug`, `in progress`, `on hold`, `discussion` or `to do` to prevent 
-    the issue from being re-flagged.
-  closeComment: >
-    This issue has been automatically closed because it has not had activity in the last 30 days.
-    If this issue is still valid, re-open the issue and let us know.
-  exemptLabels:
-    - bug
-    - in progress
-    - on hold
-    - discussion
-    - to do

.github/workflows/api.yml

@@ -4,9 +4,13 @@ on:
   push:
     branches:
     - master
+    - develop
     paths:
     - 'keyboards/**'
     - 'layouts/community/**'
+    - 'lib/python/**'
+    - 'data/**'
+    - '.github/workflows/api.yml'
   workflow_dispatch:
 
 jobs:
@@ -14,25 +18,30 @@ jobs:
     runs-on: ubuntu-latest
     container: qmkfm/qmk_cli
 
-    # protect against those who develop with their fork on master
+    # protect against those who work in their fork on 'important' branches
     if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 1
         persist-credentials: false
 
+    - name: Install dependencies
+      run: |
+        pip3 install -r requirements-dev.txt
+
     - name: Generate API Data
-      run: qmk generate-api
+      run: |
+        qmk generate-api
 
     - name: Upload API Data
       uses: jakejarvis/s3-sync-action@master
       with:
         args: --acl public-read --follow-symlinks --delete
       env:
-        AWS_S3_BUCKET: ${{ secrets.API_SPACE_MASTER }}
+        AWS_S3_BUCKET: ${{ github.ref == 'refs/heads/develop' && secrets['API_SPACE_DEVELOP'] || secrets['API_SPACE_MASTER'] }}
         AWS_ACCESS_KEY_ID: ${{ secrets.SPACES_ACCESS_KEY }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.SPACES_SECRET_KEY }}
         AWS_S3_ENDPOINT: https://nyc3.digitaloceanspaces.com
-        SOURCE_DIR: 'api_data'
+        SOURCE_DIR: '.build/api_data'

.github/workflows/auto_approve.yml

@@ -0,0 +1,18 @@
+name: Automatic Approve
+
+on:
+  schedule:
+    - cron: "*/5 * * * *"
+
+jobs:
+  automatic_approve:
+    runs-on: ubuntu-latest
+
+    if: github.repository == 'qmk/qmk_firmware'
+
+    steps:
+    - uses: mheap/automatic-approve-action@v1
+      with:
+        token: ${{ secrets.QMK_BOT_TOKEN }}
+        workflows: "format.yml,lint.yml,unit_test.yml"
+        dangerous_files: "lib/python/,Makefile,paths.mk,builddefs/"

.github/workflows/auto_tag.yaml

@@ -1,33 +0,0 @@
-name: Essential files modified
-
-on:
-  push:
-    branches:
-    - master
-    paths:
-    - quantum/**/*
-    - tmk_core/**/*
-    - drivers/**/*
-    - tests/**/*
-    - util/**/*
-    - platforms/**/*
-    - Makefile
-    - '*.mk'
-
-jobs:
-  tag:
-    runs-on: ubuntu-latest
-
-    # protect against those who develop with their fork on master
-    if: github.repository == 'qmk/qmk_firmware'
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-
-    - name: Bump version and push tag
-      uses: anothrNick/github-tag-action@1.26.0
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        DEFAULT_BUMP: 'patch'

.github/workflows/auto_tag.yml

@@ -0,0 +1,34 @@
+name: Essential files modified
+
+on:
+  push:
+    branches:
+    - master
+    paths:
+    - builddefs/**/*
+    - drivers/**/*
+    - platforms/**/*
+    - quantum/**/*
+    - tests/**/*
+    - tmk_core/**/*
+    - util/**/*
+    - Makefile
+    - '*.mk'
+
+jobs:
+  tag:
+    runs-on: ubuntu-latest
+
+    # protect against those who develop with their fork on master
+    if: github.repository == 'qmk/qmk_firmware'
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Bump version and push tag
+      uses: anothrNick/github-tag-action@1.54.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        DEFAULT_BUMP: 'patch'

.github/workflows/cli.yml

@@ -18,7 +18,7 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         submodules: recursive
     - name: Install dependencies

.github/workflows/develop_api.yml

@@ -1,38 +0,0 @@
-name: Update Develop API Data
-
-on:
-  push:
-    branches:
-    - develop
-    paths:
-    - 'keyboards/**'
-    - 'layouts/community/**'
-  workflow_dispatch:
-
-jobs:
-  api_data:
-    runs-on: ubuntu-latest
-    container: qmkfm/qmk_cli
-
-    # protect against those who work in their fork on develop
-    if: github.repository == 'qmk/qmk_firmware'
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 1
-        persist-credentials: false
-
-    - name: Generate API Data
-      run: qmk generate-api
-
-    - name: Upload API Data
-      uses: jakejarvis/s3-sync-action@master
-      with:
-        args: --acl public-read --follow-symlinks --delete
-      env:
-        AWS_S3_BUCKET: ${{ secrets.API_SPACE_DEVELOP }}
-        AWS_ACCESS_KEY_ID: ${{ secrets.SPACES_ACCESS_KEY }}
-        AWS_SECRET_ACCESS_KEY: ${{ secrets.SPACES_SECRET_KEY }}
-        AWS_S3_ENDPOINT: https://nyc3.digitaloceanspaces.com
-        SOURCE_DIR: 'api_data'

.github/workflows/develop_update.yml

@@ -5,7 +5,6 @@ on:
     branches:
     - master
 
-
 jobs:
   develop_update:
     runs-on: ubuntu-latest
@@ -13,23 +12,21 @@ jobs:
     if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
+        token: ${{ secrets.QMK_BOT_TOKEN }}
         fetch-depth: 0
 
+    - name: Disable automatic eol conversion
+      run: |
+        echo "* -text" > .git/info/attributes
+
     - name: Checkout develop
       run: |
         git fetch origin master develop
         git checkout develop
 
-    - name: Check if branch locked
-      id: check_locked
-      uses: andstor/file-existence-action@v1
-      with:
-        files: ".locked"
-
     - name: Update develop from master
-      if: steps.check_locked.outputs.files_exists == 'false'
       run: |
         git config --global user.name "QMK Bot"
         git config --global user.email "hello@qmk.fm"

.github/workflows/docs.yml

@@ -20,7 +20,7 @@ jobs:
     if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 1
 
@@ -34,7 +34,7 @@ jobs:
         qmk --verbose generate-docs
 
     - name: Deploy
-      uses: JamesIves/github-pages-deploy-action@3.7.1
+      uses: JamesIves/github-pages-deploy-action@v4.4.1
       with:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         BASE_BRANCH: master

.github/workflows/feature_branch_update.yml

@@ -0,0 +1,39 @@
+name: Update feature branches after develop merge
+
+on:
+  push:
+    branches:
+    - develop
+
+jobs:
+  feature_branch_update:
+    runs-on: ubuntu-latest
+
+    if: github.repository == 'qmk/qmk_firmware'
+
+    strategy:
+      matrix:
+        branch:
+        - xap
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        token: ${{ secrets.QMK_BOT_TOKEN }}
+        fetch-depth: 0
+
+    - name: Disable automatic eol conversion
+      run: |
+        echo "* -text" > .git/info/attributes
+
+    - name: Checkout branch
+      run: |
+        git fetch origin develop ${{ matrix.branch }}
+        git checkout ${{ matrix.branch }}
+
+    - name: Update branch from develop
+      run: |
+        git config --global user.name "QMK Bot"
+        git config --global user.email "hello@qmk.fm"
+        git merge origin/develop
+        git push origin ${{ matrix.branch }}

.github/workflows/format.yaml

@@ -1,51 +0,0 @@
-name: PR Lint Format
-
-on:
-  pull_request:
-    paths:
-    - 'drivers/**'
-    - 'lib/arm_atsam/**'
-    - 'lib/lib8tion/**'
-    - 'lib/python/**'
-    - 'platforms/**'
-    - 'quantum/**'
-    - 'tests/**'
-    - 'tmk_core/**'
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-
-    container: qmkfm/qmk_cli
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-
-    - name: Install dependencies
-      run: |
-        pip3 install -r requirements-dev.txt
-
-    - uses: trilom/file-changes-action@v1.2.4
-      id: file_changes
-      with:
-        output: ' '
-        fileOutput: ' '
-
-    - name: Run qmk formatters
-      shell: 'bash {0}'
-      run: |
-        cat ~/files_added.txt ~/files_modified.txt > ~/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
-
-    - name: Fail when formatting required
-      run: |
-        git diff
-        for file in $(git diff --name-only); do
-          echo "File '${file}' Requires Formatting"
-          echo "::error file=${file}::Requires Formatting"
-        done
-        test -z "$(git diff --name-only)"

.github/workflows/format.yml

@@ -0,0 +1,51 @@
+name: PR Lint Format
+
+on:
+  pull_request:
+    paths:
+    - 'drivers/**'
+    - 'lib/arm_atsam/**'
+    - 'lib/lib8tion/**'
+    - 'lib/python/**'
+    - 'platforms/**'
+    - 'quantum/**'
+    - 'tests/**'
+    - 'tmk_core/**'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    container: qmkfm/qmk_cli
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Install dependencies
+      run: |
+        pip3 install -r requirements-dev.txt
+
+    - uses: trilom/file-changes-action@v1.2.4
+      id: file_changes
+      with:
+        output: ' '
+        fileOutput: ' '
+
+    - name: Run qmk formatters
+      shell: 'bash {0}'
+      run: |
+        cat ~/files_added.txt ~/files_modified.txt > ~/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
+
+    - name: Fail when formatting required
+      run: |
+        git diff
+        for file in $(git diff --name-only); do
+          echo "File '${file}' Requires Formatting"
+          echo "::error file=${file}::Requires Formatting"
+        done
+        test -z "$(git diff --name-only)"

.github/workflows/format_push.yaml

@@ -1,49 +0,0 @@
-name: Lint Format
-
-on:
-  push:
-    branches:
-    - master
-    - develop
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-
-    container: qmkfm/qmk_cli
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-
-    - name: Install dependencies
-      run: |
-        pip3 install -r requirements-dev.txt
-
-    - name: Run qmk formatters
-      shell: 'bash {0}'
-      run: |
-        qmk format-c -a
-        qmk format-python -a
-        qmk format-text -a
-        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@v3
-      if: ${{ github.repository == 'qmk/qmk_firmware'}}
-      with:
-        token: ${{ secrets.QMK_BOT_TOKEN }}
-        delete-branch: true
-        branch: bugfix/format_${{ env.GITHUB_REF_SLUG }}
-        author: QMK Bot <hello@qmk.fm>
-        committer: QMK Bot <hello@qmk.fm>
-        commit-message: Format code according to conventions
-        title: '[CI] Format code according to conventions'

.github/workflows/format_push.yml

@@ -0,0 +1,53 @@
+name: Lint Format
+
+on:
+  push:
+    branches:
+    - master
+    - develop
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    container: qmkfm/qmk_cli
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Disable automatic eol conversion
+      run: |
+        echo "* -text" > .git/info/attributes
+
+    - name: Install dependencies
+      run: |
+        pip3 install -r requirements-dev.txt
+
+    - name: Run qmk formatters
+      shell: 'bash {0}'
+      run: |
+        qmk format-c -a
+        qmk format-python -a
+        qmk format-text -a
+        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@v4
+      if: ${{ github.repository == 'qmk/qmk_firmware'}}
+      with:
+        token: ${{ secrets.QMK_BOT_TOKEN }}
+        delete-branch: true
+        branch: bugfix/format_${{ env.GITHUB_REF_SLUG }}
+        author: QMK Bot <hello@qmk.fm>
+        committer: QMK Bot <hello@qmk.fm>
+        commit-message: Format code according to conventions
+        title: '[CI] Format code according to conventions'

.github/workflows/lint.yml

@@ -12,10 +12,13 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
 
+    - name: Install dependencies
+      run: pip3 install -r requirements-dev.txt
+
     - uses: trilom/file-changes-action@v1.2.4
       id: file_changes
       with:

.github/workflows/stale.yml

@@ -0,0 +1,64 @@
+name: 'Close stale issues and PRs'
+on:
+  schedule:
+    - cron: '30 1 * * *'
+  workflow_dispatch:
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v6
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+          remove-stale-when-updated: true
+          exempt-draft-pr: true
+          ascending: true
+          operations-per-run: 150
+
+          stale-issue-label: stale
+          days-before-issue-stale: 90
+          days-before-issue-close: 30
+          exempt-issue-labels: bug,in progress,on hold,discussion,to do
+
+          stale-issue-message: >
+            This issue has been automatically marked as stale because it has not had activity in the
+            last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity
+            occurs.
+
+            For maintainers: Please label with `bug`, `in progress`, `on hold`, `discussion` or `to do` to prevent
+            the issue from being re-flagged.
+
+          close-issue-message: >
+            This issue has been automatically closed because it has not had activity in the last 30 days.
+            If this issue is still valid, re-open the issue and let us know.
+
+            // [stale-action-closed]
+
+          stale-pr-label: stale
+          days-before-pr-stale: 45
+          days-before-pr-close: 30
+          exempt-pr-labels: bug,awaiting review,breaking_change,in progress,on hold
+
+          stale-pr-message: >
+            Thank you for your contribution!
+
+            This pull request has been automatically marked as stale because it has not had
+            activity in the last 45 days. It will be closed in 30 days if no further activity occurs.
+            Please feel free to give a status update now, or re-open when it's ready.
+
+            For maintainers: Please label with `bug`, `awaiting review`, `breaking_change`, `in progress`, or `on hold`
+            to prevent the issue from being re-flagged.
+
+          close-pr-message: >
+            Thank you for your contribution!
+
+            This pull request has been automatically closed because it has not had activity in the last 30 days.
+            Please feel free to give a status update now, ping for review, or re-open when it's ready.
+
+            // [stale-action-closed]

.github/workflows/unit_test.yml

@@ -20,11 +20,13 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
-    container: qmkfm/base_container
+    container: qmkfm/qmk_cli
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         submodules: recursive
+    - name: Install dependencies
+      run: pip3 install -r requirements-dev.txt
     - name: Run tests
       run: make test:all

.gitignore

@@ -5,6 +5,10 @@
 .DS_Store
 ._*
 
+# Merge files
+*.orig
+*.rej
+
 # Build artifacts
 .clang_complete
 .build/
@@ -27,16 +31,11 @@ quantum/version.h
 *.uf2
 
 # Old-style QMK Makefiles
-/keyboards/*/Makefile
-/keyboards/*/*/Makefile
-/keyboards/*/*/*/Makefile
-/keyboards/*/*/*/*/Makefile
-/keyboards/*/*/*/*/*/Makefile
-/keyboards/*/keymaps/Makefile
-/keyboards/*/*/keymaps/Makefile
-/keyboards/*/*/*/keymaps/Makefile
-/keyboards/*/*/*/*/keymaps/Makefile
-/keyboards/*/*/*/*/*/keymaps/Makefile
+/keyboards/**/Makefile
+
+# kbfirmware....
+/keyboards/**/kb.h
+/keyboards/**/kb.c
 
 # Eclipse/PyCharm/Other IDE Settings
 *.iml
@@ -54,6 +53,7 @@ quantum/version.h
 build/
 cmake-build-debug
 CMakeLists.txt
+*.pdf
 
 # Let these ones be user specific, since we have so many different configurations
 *.code-workspace
@@ -67,10 +67,23 @@ CMakeLists.txt
 .vscode/temp.sql
 tags
 
-# Ignore image files
+# Ignore image/font files
+*.bmp
+*.wbmp
 *.gif
 *.jpg
+*.jpeg
 *.png
+*.apng
+*.mng
+*.svg
+*.webp
+*.webm
+*.avi
+*.mp4
+*.mpeg
+*.ttf
+*.otf
 
 # Things Travis sees
 /.vs
@@ -91,3 +104,6 @@ user_song_list.h
 compile_commands.json
 .clangd/
 .cache/
+
+# VIA(L) json files that don't belong in QMK repo
+via*.json

.gitmodules

@@ -18,3 +18,6 @@
 [submodule "lib/printf"]
 	path = lib/printf
 	url = https://github.com/qmk/printf
+[submodule "lib/pico-sdk"]
+	path = lib/pico-sdk
+	url = https://github.com/qmk/pico-sdk.git

.vscode/settings.json

@@ -6,7 +6,8 @@
     "files.exclude": {
         "**/.build": true,
         "**/*.hex": true,
-        "**/*.bin": true
+        "**/*.bin": true,
+        "**/*.uf2": true
     },
     "files.associations": {
         "*.h": "c",

Makefile

@@ -241,7 +241,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 noci | sort -u)))
+    $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell util/list_keyboards.sh | sort -u)))
 endef
 
 # Prints a list of all known keymaps for the given keyboard
@@ -264,7 +264,7 @@ define PARSE_KEYMAP
     # The rest of the rule is the target
     # Remove the leading ":" from the target, as it acts as a separator
     MAKE_TARGET := $$(patsubst :%,%,$$(RULE))
-    # We need to generate an unique indentifer to append to the COMMANDS list
+    # We need to generate an unique identifier to append to the COMMANDS list
     CURRENT_KB_UNDER := $$(subst /,_,$$(CURRENT_KB))
     COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB_UNDER)_KEYMAP_$$(CURRENT_KM)
     # If we are compiling a keyboard without a subproject, we want to display just the name
@@ -401,6 +401,7 @@ ifndef SKIP_GIT
 	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 \
@@ -428,9 +429,15 @@ 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
 
+.PHONY: git-submodules
+git-submodules: git-submodule
+
 .PHONY: list-keyboards
 list-keyboards:
 	util/list_keyboards.sh | sort -u | tr '\n' ' '

api_data/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-cayman

builddefs/bootloader.mk

@@ -1,208 +0,0 @@
-# Copyright 2017 Jack Humbert
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# If it's possible that multiple bootloaders can be used for one project,
-# you can leave this unset, and the correct size will be selected
-# automatically.
-#
-# Sets the bootloader defined in the keyboard's/keymap's rules.mk
-# Current options:
-#
-# AVR:
-#     halfkay      PJRC Teensy
-#     caterina     Pro Micro (Sparkfun/generic)
-#     atmel-dfu    Atmel factory DFU
-#     lufa-dfu     LUFA DFU
-#     qmk-dfu      QMK DFU (LUFA + blinkenlight)
-#     qmk-hid      QMK HID (LUFA + blinkenlight)
-#     bootloadhid  HIDBootFlash compatible (ATmega32A)
-#     usbasploader USBaspLoader (ATmega328P)
-# ARM:
-#     halfkay      PJRC Teensy
-#     kiibohd      Input:Club Kiibohd bootloader (only used on their boards)
-#     stm32duino   STM32Duino (STM32F103x8)
-#     stm32-dfu    STM32 USB DFU in ROM
-#     apm32-dfu    APM32 USB DFU in ROM
-# RISC-V:
-#     gd32v-dfu    GD32V USB DFU in ROM
-#
-# If you need to provide your own implementation, you can set inside `rules.mk`
-# `BOOTLOADER = custom` -- you'll need to provide your own implementations. See
-# the respective file under `platforms/<PLATFORM>/bootloaders/custom.c` to see
-# which functions may be overridden.
-#
-# BOOTLOADER_SIZE can still be defined manually, but it's recommended
-# you add any possible configuration to this list
-
-ifeq ($(strip $(BOOTLOADER)), custom)
-    OPT_DEFS += -DBOOTLOADER_CUSTOM
-    BOOTLOADER_TYPE = custom
-endif
-ifeq ($(strip $(BOOTLOADER)), atmel-dfu)
-    OPT_DEFS += -DBOOTLOADER_ATMEL_DFU
-    OPT_DEFS += -DBOOTLOADER_DFU
-    BOOTLOADER_TYPE = dfu
-
-    ifneq (,$(filter $(MCU), at90usb162 atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
-        BOOTLOADER_SIZE = 4096
-    endif
-    ifneq (,$(filter $(MCU), at90usb1286 at90usb1287))
-        BOOTLOADER_SIZE = 8192
-    endif
-endif
-ifeq ($(strip $(BOOTLOADER)), lufa-dfu)
-    OPT_DEFS += -DBOOTLOADER_LUFA_DFU
-    OPT_DEFS += -DBOOTLOADER_DFU
-    BOOTLOADER_TYPE = dfu
-
-    ifneq (,$(filter $(MCU), at90usb162 atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
-        BOOTLOADER_SIZE ?= 4096
-    endif
-    ifneq (,$(filter $(MCU), at90usb1286 at90usb1287))
-        BOOTLOADER_SIZE ?= 8192
-    endif
-endif
-ifeq ($(strip $(BOOTLOADER)), qmk-dfu)
-    OPT_DEFS += -DBOOTLOADER_QMK_DFU
-    OPT_DEFS += -DBOOTLOADER_DFU
-    BOOTLOADER_TYPE = dfu
-
-    ifneq (,$(filter $(MCU), at90usb162 atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
-        BOOTLOADER_SIZE ?= 4096
-    endif
-    ifneq (,$(filter $(MCU), at90usb1286 at90usb1287))
-        BOOTLOADER_SIZE ?= 8192
-    endif
-endif
-ifeq ($(strip $(BOOTLOADER)), qmk-hid)
-    OPT_DEFS += -DBOOTLOADER_QMK_HID
-    OPT_DEFS += -DBOOTLOADER_HID
-    BOOTLOADER_TYPE = dfu
-
-    BOOTLOADER_SIZE ?= 4096
-endif
-ifeq ($(strip $(BOOTLOADER)), halfkay)
-    OPT_DEFS += -DBOOTLOADER_HALFKAY
-    BOOTLOADER_TYPE = halfkay
-
-    ifeq ($(strip $(MCU)), atmega32u4)
-        BOOTLOADER_SIZE = 512
-    endif
-    ifeq ($(strip $(MCU)), at90usb1286)
-        BOOTLOADER_SIZE = 1024
-    endif
-endif
-ifeq ($(strip $(BOOTLOADER)), caterina)
-    OPT_DEFS += -DBOOTLOADER_CATERINA
-    BOOTLOADER_TYPE = caterina
-
-    BOOTLOADER_SIZE = 4096
-endif
-ifneq (,$(filter $(BOOTLOADER), bootloadhid bootloadHID))
-    OPT_DEFS += -DBOOTLOADER_BOOTLOADHID
-    BOOTLOADER_TYPE = bootloadhid
-
-    BOOTLOADER_SIZE = 4096
-endif
-ifneq (,$(filter $(BOOTLOADER), usbasploader USBasp))
-    OPT_DEFS += -DBOOTLOADER_USBASP
-    BOOTLOADER_TYPE = usbasploader
-
-    BOOTLOADER_SIZE = 4096
-endif
-ifeq ($(strip $(BOOTLOADER)), lufa-ms)
-    OPT_DEFS += -DBOOTLOADER_MS
-    BOOTLOADER_TYPE = dfu
-
-    BOOTLOADER_SIZE ?= 8192
-    FIRMWARE_FORMAT = bin
-cpfirmware: lufa_warning
-.INTERMEDIATE: lufa_warning
-lufa_warning: $(FIRMWARE_FORMAT)
-	$(info @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
-	$(info LUFA MASS STORAGE Bootloader selected)
-	$(info DO NOT USE THIS BOOTLOADER IN NEW PROJECTS!)
-	$(info It is extremely prone to bricking, and is only included to support existing boards.)
-	$(info @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
-endif
-ifdef BOOTLOADER_SIZE
-    OPT_DEFS += -DBOOTLOADER_SIZE=$(strip $(BOOTLOADER_SIZE))
-endif
-
-ifeq ($(strip $(BOOTLOADER)), stm32-dfu)
-    OPT_DEFS += -DBOOTLOADER_STM32_DFU
-    BOOTLOADER_TYPE = stm32_dfu
-
-    # Options to pass to dfu-util when flashing
-    DFU_ARGS ?= -d 0483:DF11 -a 0 -s 0x08000000:leave
-    DFU_SUFFIX_ARGS ?= -v 0483 -p DF11
-endif
-ifeq ($(strip $(BOOTLOADER)), apm32-dfu)
-    OPT_DEFS += -DBOOTLOADER_APM32_DFU
-    BOOTLOADER_TYPE = stm32_dfu
-
-    # Options to pass to dfu-util when flashing
-    DFU_ARGS ?= -d 314B:0106 -a 0 -s 0x08000000:leave
-    DFU_SUFFIX_ARGS ?= -v 314B -p 0106
-endif
-ifeq ($(strip $(BOOTLOADER)), gd32v-dfu)
-    OPT_DEFS += -DBOOTLOADER_GD32V_DFU
-    BOOTLOADER_TYPE = gd32v_dfu
-
-    # Options to pass to dfu-util when flashing
-    DFU_ARGS ?= -d 28E9:0189 -a 0 -s 0x08000000:leave
-    DFU_SUFFIX_ARGS ?= -v 28E9 -p 0189
-endif
-ifeq ($(strip $(BOOTLOADER)), kiibohd)
-    OPT_DEFS += -DBOOTLOADER_KIIBOHD
-    BOOTLOADER_TYPE = kiibohd
-
-    ifeq ($(strip $(MCU_ORIG)), MK20DX128)
-        MCU_LDSCRIPT = MK20DX128BLDR4
-    endif
-    ifeq ($(strip $(MCU_ORIG)), MK20DX256)
-        MCU_LDSCRIPT = MK20DX256BLDR8
-    endif
-
-    # Options to pass to dfu-util when flashing
-    DFU_ARGS = -d 1C11:B007
-    DFU_SUFFIX_ARGS = -v 1C11 -p B007
-endif
-ifeq ($(strip $(BOOTLOADER)), stm32duino)
-    OPT_DEFS += -DBOOTLOADER_STM32DUINO
-    MCU_LDSCRIPT = STM32F103x8_stm32duino_bootloader
-    BOARD = STM32_F103_STM32DUINO
-    BOOTLOADER_TYPE = stm32duino
-
-    # Options to pass to dfu-util when flashing
-    DFU_ARGS = -d 1EAF:0003 -a 2 -R
-    DFU_SUFFIX_ARGS = -v 1EAF -p 0003
-endif
-ifeq ($(strip $(BOOTLOADER)), tinyuf2)
-    OPT_DEFS += -DBOOTLOADER_TINYUF2
-    BOOTLOADER_TYPE = tinyuf2
-endif
-ifeq ($(strip $(BOOTLOADER)), halfkay)
-    OPT_DEFS += -DBOOTLOADER_HALFKAY
-    BOOTLOADER_TYPE = halfkay
-endif
-ifeq ($(strip $(BOOTLOADER)), md-boot)
-    OPT_DEFS += -DBOOTLOADER_MD_BOOT
-    BOOTLOADER_TYPE = md_boot
-endif
-
-ifeq ($(strip $(BOOTLOADER_TYPE)),)
-    $(call CATASTROPHIC_ERROR,Invalid BOOTLOADER,No bootloader specified. Please set an appropriate 'BOOTLOADER' in your keyboard's 'rules.mk' file.)
-endif

builddefs/build_full_test.mk

@@ -20,7 +20,7 @@ $(TEST)_SRC := \
 	$(TMK_COMMON_SRC) \
 	$(QUANTUM_SRC) \
 	$(SRC) \
-	tests/test_common/keymap.c \
+	$(QUANTUM_PATH)/keymap_introspection.c \
 	tests/test_common/matrix.c \
 	tests/test_common/test_driver.cpp \
 	tests/test_common/keyboard_report_util.cpp \
@@ -29,7 +29,7 @@ $(TEST)_SRC := \
 	tests/test_common/test_logger.cpp \
 	$(patsubst $(ROOTDIR)/%,%,$(wildcard $(TEST_PATH)/*.cpp))
 
-$(TEST)_DEFS := $(TMK_COMMON_DEFS) $(OPT_DEFS)
+$(TEST)_DEFS := $(TMK_COMMON_DEFS) $(OPT_DEFS) "-DKEYMAP_C=\"keymap.c\""
 
 $(TEST)_CONFIG := $(TEST_PATH)/config.h
 

builddefs/build_keyboard.mk

@@ -13,6 +13,14 @@ endif
 include paths.mk
 include $(BUILDDEFS_PATH)/message.mk
 
+# Helper to add defines with a 'QMK_' prefix
+define add_qmk_prefix_defs
+    ifdef $1
+        # Need to cater for 'STM32L4xx+'
+        OPT_DEFS += -DQMK_$(2)="$($1)" -DQMK_$(2)_$(shell echo $($1) | sed -e 's@+@Plus@g' -e 's@[^a-zA-Z0-9]@_@g' | tr '[:lower:]' '[:upper:]')
+    endif
+endef
+
 # Set the qmk cli to use
 QMK_BIN ?= qmk
 
@@ -116,26 +124,26 @@ include $(BUILDDEFS_PATH)/build_json.mk
 # Pull in keymap level rules.mk
 ifeq ("$(wildcard $(KEYMAP_PATH))", "")
     # Look through the possible keymap folders until we find a matching keymap.c
-    ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","")
-        -include $(MAIN_KEYMAP_PATH_5)/rules.mk
-        KEYMAP_C := $(MAIN_KEYMAP_PATH_5)/keymap.c
-        KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
-    else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.c)","")
-        -include $(MAIN_KEYMAP_PATH_4)/rules.mk
-        KEYMAP_C := $(MAIN_KEYMAP_PATH_4)/keymap.c
-        KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
-    else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.c)","")
-        -include $(MAIN_KEYMAP_PATH_3)/rules.mk
-        KEYMAP_C := $(MAIN_KEYMAP_PATH_3)/keymap.c
-        KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
+    ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.c)","")
+        -include $(MAIN_KEYMAP_PATH_1)/rules.mk
+        KEYMAP_C := $(MAIN_KEYMAP_PATH_1)/keymap.c
+        KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
     else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.c)","")
         -include $(MAIN_KEYMAP_PATH_2)/rules.mk
         KEYMAP_C := $(MAIN_KEYMAP_PATH_2)/keymap.c
         KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
-    else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.c)","")
-        -include $(MAIN_KEYMAP_PATH_1)/rules.mk
-        KEYMAP_C := $(MAIN_KEYMAP_PATH_1)/keymap.c
-        KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
+    else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.c)","")
+        -include $(MAIN_KEYMAP_PATH_3)/rules.mk
+        KEYMAP_C := $(MAIN_KEYMAP_PATH_3)/keymap.c
+        KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
+    else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.c)","")
+        -include $(MAIN_KEYMAP_PATH_4)/rules.mk
+        KEYMAP_C := $(MAIN_KEYMAP_PATH_4)/keymap.c
+        KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
+    else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","")
+        -include $(MAIN_KEYMAP_PATH_5)/rules.mk
+        KEYMAP_C := $(MAIN_KEYMAP_PATH_5)/keymap.c
+        KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
     else ifneq ($(LAYOUTS),)
         # If we haven't found a keymap yet fall back to community layouts
         include $(BUILDDEFS_PATH)/build_layout.mk
@@ -154,27 +162,25 @@ ifneq ("$(wildcard $(KEYMAP_JSON))", "")
     -include $(KEYMAP_PATH)/rules.mk
 
     # Load any rules.mk content from keymap.json
-    INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --keymap $(KEYMAP) --output $(KEYMAP_OUTPUT)/src/rules.mk)
+    INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --output $(KEYMAP_OUTPUT)/src/rules.mk $(KEYMAP_JSON))
     include $(INFO_RULES_MK)
 
 # Add rules to generate the keymap files - indentation here is important
 $(KEYMAP_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
-	$(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON)
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON))
+	@$(BUILD_CMD)
 
 $(KEYMAP_OUTPUT)/src/config.h: $(KEYMAP_JSON)
-	$(QMK_BIN) generate-config-h --quiet --keyboard $(KEYBOARD) --keymap $(KEYMAP) --output $(KEYMAP_H)
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) generate-config-h --quiet --output $(KEYMAP_H) $(KEYMAP_JSON))
+	@$(BUILD_CMD)
 
 generated-files: $(KEYMAP_OUTPUT)/src/config.h $(KEYMAP_OUTPUT)/src/keymap.c
 
 endif
 
-ifeq ($(strip $(CTPC)), yes)
-    CONVERT_TO_PROTON_C=yes
-endif
-
-ifeq ($(strip $(CONVERT_TO_PROTON_C)), yes)
-    include platforms/chibios/boards/QMK_PROTON_C/convert_to_proton_c.mk
-endif
+include $(BUILDDEFS_PATH)/converters.mk
 
 include $(BUILDDEFS_PATH)/mcu_selection.mk
 
@@ -230,26 +236,25 @@ endif
 # that the same keymap may be used on multiple keyboards.
 #
 # We grab the most top-level include file that we can. That file should
-# use #ifdef statements to include all the neccesary subfolder includes,
+# use #ifdef statements to include all the necessary subfolder includes,
 # as described here:
 #
 #    https://docs.qmk.fm/#/feature_layouts?id=tips-for-making-layouts-keyboard-agnostic
 #
-QMK_KEYBOARD_H = $(KEYBOARD_OUTPUT)/src/default_keyboard.h
 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).h)","")
-    QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_1).h
+    FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_1).h
 endif
 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).h)","")
-    QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_2).h
+    FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_2).h
 endif
 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).h)","")
-    QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_3).h
+    FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_3).h
 endif
 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).h)","")
-    QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_4).h
+    FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_4).h
 endif
 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).h)","")
-    QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_5).h
+    FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_5).h
 endif
 
 # Determine and set parameters based on the keyboard's processor family.
@@ -323,18 +328,25 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/info.json)","")
     INFO_JSON_FILES += $(KEYBOARD_PATH_5)/info.json
 endif
 
-CONFIG_H += $(KEYBOARD_OUTPUT)/src/info_config.h $(KEYBOARD_OUTPUT)/src/layouts.h
+CONFIG_H += $(KEYBOARD_OUTPUT)/src/info_config.h
+KEYBOARD_SRC += $(KEYBOARD_OUTPUT)/src/default_keyboard.c
 
 $(KEYBOARD_OUTPUT)/src/info_config.h: $(INFO_JSON_FILES)
-	$(QMK_BIN) generate-config-h --quiet --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/info_config.h
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) generate-config-h --quiet --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/info_config.h)
+	@$(BUILD_CMD)
+
+$(KEYBOARD_OUTPUT)/src/default_keyboard.c: $(INFO_JSON_FILES)
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) generate-keyboard-c --quiet --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/default_keyboard.c)
+	@$(BUILD_CMD)
 
 $(KEYBOARD_OUTPUT)/src/default_keyboard.h: $(INFO_JSON_FILES)
-	$(QMK_BIN) generate-keyboard-h --quiet --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/default_keyboard.h
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) generate-keyboard-h --quiet --keyboard $(KEYBOARD) --include $(FOUND_KEYBOARD_H) --output $(KEYBOARD_OUTPUT)/src/default_keyboard.h)
+	@$(BUILD_CMD)
 
-$(KEYBOARD_OUTPUT)/src/layouts.h: $(INFO_JSON_FILES)
-	$(QMK_BIN) generate-layouts --quiet --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/layouts.h
-
-generated-files: $(KEYBOARD_OUTPUT)/src/info_config.h $(KEYBOARD_OUTPUT)/src/default_keyboard.h $(KEYBOARD_OUTPUT)/src/layouts.h
+generated-files: $(KEYBOARD_OUTPUT)/src/info_config.h $(KEYBOARD_OUTPUT)/src/default_keyboard.c $(KEYBOARD_OUTPUT)/src/default_keyboard.h
 
 .INTERMEDIATE : generated-files
 
@@ -356,6 +368,10 @@ endif
 # Disable features that a keyboard doesn't support
 -include $(BUILDDEFS_PATH)/disable_features.mk
 
+ifneq ("$(CONVERTER)","")
+    -include $(CONVERTER)/post_converter.mk
+endif
+
 # Pull in post_rules.mk files from all our subfolders
 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_rules.mk)","")
     include $(KEYBOARD_PATH_1)/post_rules.mk
@@ -380,10 +396,18 @@ ifneq ("$(KEYMAP_H)","")
     CONFIG_H += $(KEYMAP_H)
 endif
 
+OPT_DEFS += -DKEYMAP_C=\"$(KEYMAP_C)\"
+
+# If a keymap or userspace places their keymap array in another file instead, allow for it to be included
+# !!NOTE!! -- For this to work, the source file cannot be part of $(SRC), so users should not add it via `SRC += <file>`
+ifneq ($(strip $(INTROSPECTION_KEYMAP_C)),)
+OPT_DEFS += -DINTROSPECTION_KEYMAP_C=\"$(strip $(INTROSPECTION_KEYMAP_C))\"
+endif
+
 # project specific files
 SRC += \
     $(KEYBOARD_SRC) \
-    $(KEYMAP_C) \
+    $(QUANTUM_DIR)/keymap_introspection.c \
     $(QUANTUM_SRC) \
     $(QUANTUM_DIR)/main.c \
 
@@ -402,7 +426,6 @@ include $(BUILDDEFS_PATH)/common_features.mk
 include $(BUILDDEFS_PATH)/generic_features.mk
 include $(TMK_PATH)/protocol.mk
 include $(PLATFORM_PATH)/common.mk
-include $(BUILDDEFS_PATH)/bootloader.mk
 
 SRC += $(patsubst %.c,%.clib,$(LIB_SRC))
 SRC += $(patsubst %.c,%.clib,$(QUANTUM_LIB_SRC))
@@ -417,6 +440,7 @@ ifneq ($(REQUIRE_PLATFORM_KEY),)
     endif
 endif
 
+-include $(PLATFORM_PATH)/$(PLATFORM_KEY)/bootloader.mk
 include $(PLATFORM_PATH)/$(PLATFORM_KEY)/platform.mk
 -include $(PLATFORM_PATH)/$(PLATFORM_KEY)/flash.mk
 
@@ -426,6 +450,14 @@ else
     include $(TMK_PATH)/protocol/$(PLATFORM_KEY).mk
 endif
 
+# Setup definitions based on the selected MCU
+$(eval $(call add_qmk_prefix_defs,MCU_ORIG,MCU))
+$(eval $(call add_qmk_prefix_defs,MCU_ARCH,MCU_ARCH))
+$(eval $(call add_qmk_prefix_defs,MCU_PORT_NAME,MCU_PORT_NAME))
+$(eval $(call add_qmk_prefix_defs,MCU_FAMILY,MCU_FAMILY))
+$(eval $(call add_qmk_prefix_defs,MCU_SERIES,MCU_SERIES))
+$(eval $(call add_qmk_prefix_defs,BOARD,BOARD))
+
 # TODO: remove this bodge?
 PROJECT_DEFS := $(OPT_DEFS)
 PROJECT_INC := $(VPATH) $(EXTRAINCDIRS) $(KEYBOARD_PATHS)
@@ -437,7 +469,7 @@ ALL_CONFIGS := $(PROJECT_CONFIG) $(CONFIG_H)
 OUTPUTS := $(KEYMAP_OUTPUT) $(KEYBOARD_OUTPUT)
 $(KEYMAP_OUTPUT)_SRC := $(SRC)
 $(KEYMAP_OUTPUT)_DEFS := $(OPT_DEFS) \
--DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(QMK_KEYBOARD_H)\" \
+-DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(KEYBOARD_OUTPUT)/src/default_keyboard.h\" \
 -DQMK_KEYMAP=\"$(KEYMAP)\" -DQMK_KEYMAP_H=\"$(KEYMAP).h\" -DQMK_KEYMAP_CONFIG_H=\"$(KEYMAP_PATH)/config.h\"
 $(KEYMAP_OUTPUT)_INC :=  $(VPATH) $(EXTRAINCDIRS)
 $(KEYMAP_OUTPUT)_CONFIG := $(CONFIG_H)
@@ -459,6 +491,19 @@ check-size: build
 check-md5: build
 objs-size: build
 
+ifeq ($(strip $(TOP_SYMBOLS)),yes)
+all: top-symbols
+check-size: top-symbols
+top-symbols: build
+	echo "###########################################"
+	echo "# Highest flash usage:"
+	$(NM) -Crtd --size-sort $(BUILD_DIR)/$(TARGET).elf | grep -i ' [t] ' | head -n10 | sed -e 's#^0000000#       #g' -e 's#^000000#      #g' -e 's#^00000#     #g' -e 's#^0000#    #g' -e 's#^000#   #g' -e 's#^00#  #g' -e 's#^0# #g'
+	echo "###########################################"
+	echo "# Highest RAM usage:"
+	$(NM) -Crtd --size-sort $(BUILD_DIR)/$(TARGET).elf | grep -i ' [dbv] ' | head -n10 | sed -e 's#^0000000#       #g' -e 's#^000000#      #g' -e 's#^00000#     #g' -e 's#^0000#    #g' -e 's#^000#   #g' -e 's#^00#  #g' -e 's#^0# #g'
+	echo "###########################################"
+endif
+
 include $(BUILDDEFS_PATH)/show_options.mk
 include $(BUILDDEFS_PATH)/common_rules.mk
 

builddefs/build_test.mk

@@ -4,6 +4,8 @@ endif
 
 .DEFAULT_GOAL := all
 
+OPT = g
+
 include paths.mk
 include $(BUILDDEFS_PATH)/message.mk
 
@@ -36,11 +38,11 @@ CREATE_MAP := no
 VPATH += \
 	$(LIB_PATH)/googletest \
 	$(LIB_PATH)/googlemock \
-	$(LIB_PATH)/printf
+	$(COMMON_VPATH) \
+	$(TEST_PATH)
 
 all: elf
 
-VPATH += $(COMMON_VPATH)
 PLATFORM:=TEST
 PLATFORM_KEY:=test
 BOOTLOADER_TYPE:=none
@@ -61,14 +63,15 @@ include $(TMK_PATH)/protocol.mk
 include $(QUANTUM_PATH)/debounce/tests/rules.mk
 include $(QUANTUM_PATH)/encoder/tests/rules.mk
 include $(QUANTUM_PATH)/sequencer/tests/rules.mk
+include $(QUANTUM_PATH)/wear_leveling/tests/rules.mk
+include $(QUANTUM_PATH)/logging/print.mk
 include $(PLATFORM_PATH)/test/rules.mk
 ifneq ($(filter $(FULL_TESTS),$(TEST)),)
 include $(BUILDDEFS_PATH)/build_full_test.mk
 endif
 
 $(TEST)_SRC += \
-	tests/test_common/main.c \
-	$(LIB_PATH)/printf/printf.c \
+	tests/test_common/main.cpp \
 	$(QUANTUM_PATH)/logging/print.c
 
 $(TEST_OBJ)/$(TEST)_SRC := $($(TEST)_SRC)

builddefs/common_features.mk

@@ -15,7 +15,6 @@
 
 QUANTUM_SRC += \
     $(QUANTUM_DIR)/quantum.c \
-    $(QUANTUM_DIR)/send_string.c \
     $(QUANTUM_DIR)/bitwise.c \
     $(QUANTUM_DIR)/led.c \
     $(QUANTUM_DIR)/action.c \
@@ -65,6 +64,7 @@ ifeq ($(strip $(AUDIO_ENABLE)), yes)
         OPT_DEFS += -DAUDIO_DRIVER_PWM
     endif
     OPT_DEFS += -DAUDIO_ENABLE
+    COMMON_VPATH += $(QUANTUM_PATH)/audio
     MUSIC_ENABLE = yes
     SRC += $(QUANTUM_DIR)/process_keycode/process_audio.c
     SRC += $(QUANTUM_DIR)/process_keycode/process_clicky.c
@@ -92,10 +92,29 @@ ifeq ($(MUSIC_ENABLE), yes)
     SRC += $(QUANTUM_DIR)/process_keycode/process_music.c
 endif
 
+VALID_STENO_PROTOCOL_TYPES := geminipr txbolt all
+STENO_PROTOCOL ?= all
 ifeq ($(strip $(STENO_ENABLE)), yes)
-    OPT_DEFS += -DSTENO_ENABLE
-    VIRTSER_ENABLE ?= yes
-    SRC += $(QUANTUM_DIR)/process_keycode/process_steno.c
+    ifeq ($(filter $(STENO_PROTOCOL),$(VALID_STENO_PROTOCOL_TYPES)),)
+        $(call CATASTROPHIC_ERROR,Invalid STENO_PROTOCOL,STENO_PROTOCOL="$(STENO_PROTOCOL)" is not a valid stenography protocol)
+    else
+        OPT_DEFS += -DSTENO_ENABLE
+        VIRTSER_ENABLE ?= yes
+
+        ifeq ($(strip $(STENO_PROTOCOL)), geminipr)
+            OPT_DEFS += -DSTENO_ENABLE_GEMINI
+        endif
+        ifeq ($(strip $(STENO_PROTOCOL)), txbolt)
+            OPT_DEFS += -DSTENO_ENABLE_BOLT
+        endif
+        ifeq ($(strip $(STENO_PROTOCOL)), all)
+            OPT_DEFS += -DSTENO_ENABLE_ALL
+            OPT_DEFS += -DSTENO_ENABLE_GEMINI
+            OPT_DEFS += -DSTENO_ENABLE_BOLT
+        endif
+
+        SRC += $(QUANTUM_DIR)/process_keycode/process_steno.c
+    endif
 endif
 
 ifeq ($(strip $(VIRTSER_ENABLE)), yes)
@@ -108,15 +127,17 @@ ifeq ($(strip $(MOUSEKEY_ENABLE)), yes)
     SRC += $(QUANTUM_DIR)/mousekey.c
 endif
 
-VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick cirque_pinnacle_i2c cirque_pinnacle_spi pmw3360 pmw3389 pimoroni_trackball custom
+VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick cirque_pinnacle_i2c cirque_pinnacle_spi paw3204 pmw3360 pmw3389 pimoroni_trackball custom
 ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
     ifeq ($(filter $(POINTING_DEVICE_DRIVER),$(VALID_POINTING_DEVICE_DRIVER_TYPES)),)
         $(call CATASTROPHIC_ERROR,Invalid POINTING_DEVICE_DRIVER,POINTING_DEVICE_DRIVER="$(POINTING_DEVICE_DRIVER)" is not a valid pointing device type)
     else
         OPT_DEFS += -DPOINTING_DEVICE_ENABLE
         MOUSE_ENABLE := yes
-        SRC += $(QUANTUM_DIR)/pointing_device.c
-        SRC += $(QUANTUM_DIR)/pointing_device_drivers.c
+        VPATH += $(QUANTUM_DIR)/pointing_device
+        SRC += $(QUANTUM_DIR)/pointing_device/pointing_device.c
+        SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_drivers.c
+        SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_auto_mouse.c
         ifneq ($(strip $(POINTING_DEVICE_DRIVER)), custom)
             SRC += drivers/sensors/$(strip $(POINTING_DEVICE_DRIVER)).c
             OPT_DEFS += -DPOINTING_DEVICE_DRIVER_$(strip $(shell echo $(POINTING_DEVICE_DRIVER) | tr '[:lower:]' '[:upper:]'))
@@ -131,51 +152,67 @@ ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
         else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), cirque_pinnacle_i2c)
             OPT_DEFS += -DSTM32_I2C -DHAL_USE_I2C=TRUE
             SRC += drivers/sensors/cirque_pinnacle.c
+            SRC += drivers/sensors/cirque_pinnacle_gestures.c
+            SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_gestures.c
             QUANTUM_LIB_SRC += i2c_master.c
         else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), cirque_pinnacle_spi)
             OPT_DEFS += -DSTM32_SPI -DHAL_USE_SPI=TRUE
             SRC += drivers/sensors/cirque_pinnacle.c
+            SRC += drivers/sensors/cirque_pinnacle_gestures.c
+            SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_gestures.c
             QUANTUM_LIB_SRC += spi_master.c
         else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), pimoroni_trackball)
             OPT_DEFS += -DSTM32_SPI -DHAL_USE_I2C=TRUE
             QUANTUM_LIB_SRC += i2c_master.c
-        else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), pmw3360)
-            OPT_DEFS += -DSTM32_SPI -DHAL_USE_SPI=TRUE
-            QUANTUM_LIB_SRC += spi_master.c
-        else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), pmw3389)
+        else ifneq ($(filter $(strip $(POINTING_DEVICE_DRIVER)),pmw3360 pmw3389),)
             OPT_DEFS += -DSTM32_SPI -DHAL_USE_SPI=TRUE
+            SRC += drivers/sensors/pmw33xx_common.c
             QUANTUM_LIB_SRC += spi_master.c
         endif
     endif
 endif
 
-VALID_EEPROM_DRIVER_TYPES := vendor custom transient i2c spi
+QUANTUM_PAINTER_ENABLE ?= no
+ifeq ($(strip $(QUANTUM_PAINTER_ENABLE)), yes)
+    include $(QUANTUM_DIR)/painter/rules.mk
+endif
+
+VALID_EEPROM_DRIVER_TYPES := vendor custom transient i2c spi wear_leveling legacy_stm32_flash
 EEPROM_DRIVER ?= vendor
 ifeq ($(filter $(EEPROM_DRIVER),$(VALID_EEPROM_DRIVER_TYPES)),)
   $(call CATASTROPHIC_ERROR,Invalid EEPROM_DRIVER,EEPROM_DRIVER="$(EEPROM_DRIVER)" is not a valid EEPROM driver)
 else
   OPT_DEFS += -DEEPROM_ENABLE
+  COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/eeprom
+  COMMON_VPATH += $(DRIVER_PATH)/eeprom
+  COMMON_VPATH += $(PLATFORM_COMMON_DIR)
   ifeq ($(strip $(EEPROM_DRIVER)), custom)
     # Custom EEPROM implementation -- only needs to implement init/erase/read_block/write_block
     OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_CUSTOM
-    COMMON_VPATH += $(DRIVER_PATH)/eeprom
     SRC += eeprom_driver.c
+  else ifeq ($(strip $(EEPROM_DRIVER)), wear_leveling)
+    # Wear-leveling EEPROM implementation
+    OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
+    SRC += eeprom_driver.c eeprom_wear_leveling.c
   else ifeq ($(strip $(EEPROM_DRIVER)), i2c)
     # External I2C EEPROM implementation
     OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_I2C
-    COMMON_VPATH += $(DRIVER_PATH)/eeprom
     QUANTUM_LIB_SRC += i2c_master.c
     SRC += eeprom_driver.c eeprom_i2c.c
   else ifeq ($(strip $(EEPROM_DRIVER)), spi)
     # External SPI EEPROM implementation
     OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_SPI
-    COMMON_VPATH += $(DRIVER_PATH)/eeprom
     QUANTUM_LIB_SRC += spi_master.c
     SRC += eeprom_driver.c eeprom_spi.c
+  else ifeq ($(strip $(EEPROM_DRIVER)), legacy_stm32_flash)
+    # STM32 Emulated EEPROM, backed by MCU flash (soon to be deprecated)
+    OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_STM32_FLASH_EMULATED
+    COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
+    COMMON_VPATH += $(DRIVER_PATH)/flash
+    SRC += eeprom_driver.c eeprom_stm32.c flash_stm32.c
   else ifeq ($(strip $(EEPROM_DRIVER)), transient)
     # Transient EEPROM implementation -- no data storage but provides runtime area for it
     OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_TRANSIENT
-    COMMON_VPATH += $(DRIVER_PATH)/eeprom
     SRC += eeprom_driver.c eeprom_transient.c
   else ifeq ($(strip $(EEPROM_DRIVER)), vendor)
     # Vendor-implemented EEPROM
@@ -183,53 +220,91 @@ else
     ifeq ($(PLATFORM),AVR)
       # Automatically provided by avr-libc, nothing required
     else ifeq ($(PLATFORM),CHIBIOS)
-      ifneq ($(filter STM32F3xx_% STM32F1xx_% %_STM32F401xC %_STM32F401xE %_STM32F405xG %_STM32F411xE %_STM32F072xB %_STM32F042x6 %_GD32VF103xB %_GD32VF103x8, $(MCU_SERIES)_$(MCU_LDSCRIPT)),)
-        # Emulated EEPROM
-        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_STM32_FLASH_EMULATED
-        COMMON_VPATH += $(DRIVER_PATH)/eeprom
-        SRC += eeprom_driver.c
-        SRC += $(PLATFORM_COMMON_DIR)/eeprom_stm32.c
-        SRC += $(PLATFORM_COMMON_DIR)/flash_stm32.c
+      ifneq ($(filter %_STM32F072xB %_STM32F042x6, $(MCU_SERIES)_$(MCU_LDSCRIPT)),)
+        # STM32 Emulated EEPROM, backed by MCU flash (soon to be deprecated)
+        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_LEGACY_EMULATED_FLASH
+        COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
+        COMMON_VPATH += $(DRIVER_PATH)/flash
+        SRC += eeprom_driver.c eeprom_legacy_emulated_flash.c legacy_flash_ops.c
+      else ifneq ($(filter $(MCU_SERIES),STM32F1xx STM32F3xx STM32F4xx STM32L4xx STM32G4xx WB32F3G71xx WB32FQ95xx GD32VF103),)
+        # Wear-leveling EEPROM implementation, backed by MCU flash
+        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
+        SRC += eeprom_driver.c eeprom_wear_leveling.c
+        WEAR_LEVELING_DRIVER ?= embedded_flash
       else ifneq ($(filter $(MCU_SERIES),STM32L0xx STM32L1xx),)
         # True EEPROM on STM32L0xx, L1xx
         OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_STM32_L0_L1
-        COMMON_VPATH += $(DRIVER_PATH)/eeprom
-        COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/eeprom
-        SRC += eeprom_driver.c
-        SRC += eeprom_stm32_L0_L1.c
+        SRC += eeprom_driver.c eeprom_stm32_L0_L1.c
+      else ifneq ($(filter $(MCU_SERIES),RP2040),)
+        # Wear-leveling EEPROM implementation, backed by RP2040 flash
+        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
+        SRC += eeprom_driver.c eeprom_wear_leveling.c
+        WEAR_LEVELING_DRIVER ?= rp2040_flash
       else ifneq ($(filter $(MCU_SERIES),KL2x K20x),)
         # Teensy EEPROM implementations
-        OPT_DEFS += -DEEPROM_TEENSY
-        SRC += eeprom_teensy.c
+        OPT_DEFS += -DEEPROM_KINETIS_FLEXRAM
+        SRC += eeprom_kinetis_flexram.c
       else
         # Fall back to transient, i.e. non-persistent
         OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_TRANSIENT
-        COMMON_VPATH += $(DRIVER_PATH)/eeprom
         SRC += eeprom_driver.c eeprom_transient.c
       endif
     else ifeq ($(PLATFORM),ARM_ATSAM)
       # arm_atsam EEPROM
       OPT_DEFS += -DEEPROM_SAMD
-      SRC += $(PLATFORM_COMMON_DIR)/eeprom_samd.c
+      SRC += eeprom_samd.c
     else ifeq ($(PLATFORM),TEST)
       # Test harness "EEPROM"
       OPT_DEFS += -DEEPROM_TEST_HARNESS
-      SRC += $(PLATFORM_COMMON_DIR)/eeprom.c
+      SRC += eeprom.c
+    endif
+  endif
+endif
+
+VALID_WEAR_LEVELING_DRIVER_TYPES := custom embedded_flash spi_flash rp2040_flash legacy
+WEAR_LEVELING_DRIVER ?= none
+ifneq ($(strip $(WEAR_LEVELING_DRIVER)),none)
+  ifeq ($(filter $(WEAR_LEVELING_DRIVER),$(VALID_WEAR_LEVELING_DRIVER_TYPES)),)
+    $(call CATASTROPHIC_ERROR,Invalid WEAR_LEVELING_DRIVER,WEAR_LEVELING_DRIVER="$(WEAR_LEVELING_DRIVER)" is not a valid wear leveling driver)
+  else
+    FNV_ENABLE := yes
+    OPT_DEFS += -DWEAR_LEVELING_ENABLE
+    OPT_DEFS += -DWEAR_LEVELING_$(strip $(shell echo $(WEAR_LEVELING_DRIVER) | tr '[:lower:]' '[:upper:]'))
+    COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling
+    COMMON_VPATH += $(DRIVER_PATH)/wear_leveling
+    COMMON_VPATH += $(QUANTUM_DIR)/wear_leveling
+    SRC += wear_leveling.c
+    ifeq ($(strip $(WEAR_LEVELING_DRIVER)), embedded_flash)
+      OPT_DEFS += -DHAL_USE_EFL
+      SRC += wear_leveling_efl.c
+      POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling/wear_leveling_efl_config.h
+    else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), spi_flash)
+      FLASH_DRIVER := spi
+      SRC += wear_leveling_flash_spi.c
+      POST_CONFIG_H += $(DRIVER_PATH)/wear_leveling/wear_leveling_flash_spi_config.h
+    else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), rp2040_flash)
+      SRC += wear_leveling_rp2040_flash.c
+      POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_PATH)/wear_leveling/wear_leveling_rp2040_flash_config.h
+    else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), legacy)
+      COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
+      SRC += legacy_flash_ops.c wear_leveling_legacy.c
+      POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling/wear_leveling_legacy_config.h
     endif
   endif
 endif
 
 VALID_FLASH_DRIVER_TYPES := spi
-FLASH_DRIVER ?= no
-ifneq ($(strip $(FLASH_DRIVER)), no)
+FLASH_DRIVER ?= none
+ifneq ($(strip $(FLASH_DRIVER)), none)
     ifeq ($(filter $(FLASH_DRIVER),$(VALID_FLASH_DRIVER_TYPES)),)
-        $(error FLASH_DRIVER="$(FLASH_DRIVER)" is not a valid FLASH driver)
+        $(call CATASTROPHIC_ERROR,Invalid FLASH_DRIVER,FLASH_DRIVER="$(FLASH_DRIVER)" is not a valid flash driver)
     else
         OPT_DEFS += -DFLASH_ENABLE
-        ifeq ($(strip $(FLASH_DRIVER)), spi)
+        ifeq ($(strip $(FLASH_DRIVER)),spi)
             OPT_DEFS += -DFLASH_DRIVER -DFLASH_SPI
             COMMON_VPATH += $(DRIVER_PATH)/flash
             SRC += flash_spi.c
+            QUANTUM_LIB_SRC += spi_master.c
         endif
     endif
 endif
@@ -270,7 +345,7 @@ ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
 endif
 
 LED_MATRIX_ENABLE ?= no
-VALID_LED_MATRIX_TYPES := IS31FL3731 IS31FL3742A IS31FL3743A IS31FL3745 IS31FL3746A custom
+VALID_LED_MATRIX_TYPES := IS31FL3731 IS31FL3742A IS31FL3743A IS31FL3745 IS31FL3746A CKLED2001 custom
 # TODO: IS31FL3733 IS31FL3737 IS31FL3741
 
 ifeq ($(strip $(LED_MATRIX_ENABLE)), yes)
@@ -326,6 +401,13 @@ endif
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 
+	ifeq ($(strip $(LED_MATRIX_DRIVER)), CKLED2001)
+        OPT_DEFS += -DCKLED2001 -DSTM32_I2C -DHAL_USE_I2C=TRUE
+        COMMON_VPATH += $(DRIVER_PATH)/led
+        SRC += ckled2001-simple.c
+        QUANTUM_LIB_SRC += i2c_master.c
+    endif
+
 endif
 
 RGB_MATRIX_ENABLE ?= no
@@ -443,12 +525,6 @@ ifeq ($(strip $(RGB_KEYCODES_ENABLE)), yes)
     SRC += $(QUANTUM_DIR)/process_keycode/process_rgb.c
 endif
 
-ifeq ($(strip $(PRINTING_ENABLE)), yes)
-    OPT_DEFS += -DPRINTING_ENABLE
-    SRC += $(QUANTUM_DIR)/process_keycode/process_printer.c
-    QUANTUM_LIB_SRC += uart.c
-endif
-
 VARIABLE_TRACE ?= no
 ifneq ($(strip $(VARIABLE_TRACE)),no)
     SRC += $(QUANTUM_DIR)/variable_trace.c
@@ -468,11 +544,7 @@ endif
 VALID_BACKLIGHT_TYPES := pwm timer software custom
 
 BACKLIGHT_ENABLE ?= no
-ifeq ($(strip $(CONVERT_TO_PROTON_C)), yes)
-    BACKLIGHT_DRIVER ?= software
-else
-    BACKLIGHT_DRIVER ?= pwm
-endif
+BACKLIGHT_DRIVER ?= pwm
 ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
     ifeq ($(filter $(BACKLIGHT_DRIVER),$(VALID_BACKLIGHT_TYPES)),)
         $(call CATASTROPHIC_ERROR,Invalid BACKLIGHT_DRIVER,BACKLIGHT_DRIVER="$(BACKLIGHT_DRIVER)" is not a valid backlight type)
@@ -495,7 +567,7 @@ ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
     endif
 endif
 
-VALID_WS2812_DRIVER_TYPES := bitbang pwm spi i2c
+VALID_WS2812_DRIVER_TYPES := bitbang pwm spi i2c vendor
 
 WS2812_DRIVER ?= bitbang
 ifeq ($(strip $(WS2812_DRIVER_REQUIRED)), yes)
@@ -537,12 +609,6 @@ ifeq ($(strip $(LED_TABLES)), yes)
     SRC += $(QUANTUM_DIR)/led_tables.c
 endif
 
-ifeq ($(strip $(TERMINAL_ENABLE)), yes)
-    SRC += $(QUANTUM_DIR)/process_keycode/process_terminal.c
-    OPT_DEFS += -DTERMINAL_ENABLE
-    OPT_DEFS += -DUSER_PRINT
-endif
-
 ifeq ($(strip $(VIA_ENABLE)), yes)
     DYNAMIC_KEYMAP_ENABLE := yes
     RAW_ENABLE := yes
@@ -590,6 +656,14 @@ ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
     QUANTUM_SRC += $(QUANTUM_DIR)/debounce/$(strip $(DEBOUNCE_TYPE)).c
 endif
 
+
+VALID_SERIAL_DRIVER_TYPES := bitbang usart vendor
+
+SERIAL_DRIVER ?= bitbang
+ifeq ($(filter $(SERIAL_DRIVER),$(VALID_SERIAL_DRIVER_TYPES)),)
+    $(call CATASTROPHIC_ERROR,Invalid SERIAL_DRIVER,SERIAL_DRIVER="$(SERIAL_DRIVER)" is not a valid SERIAL driver)
+endif
+
 ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
     POST_CONFIG_H += $(QUANTUM_DIR)/split_common/post_config.h
     OPT_DEFS += -DSPLIT_KEYBOARD
@@ -614,11 +688,11 @@ ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
             endif
         endif
 
-        SERIAL_DRIVER ?= bitbang
         OPT_DEFS += -DSERIAL_DRIVER_$(strip $(shell echo $(SERIAL_DRIVER) | tr '[:lower:]' '[:upper:]'))
         ifeq ($(strip $(SERIAL_DRIVER)), bitbang)
             QUANTUM_LIB_SRC += serial.c
         else
+            QUANTUM_LIB_SRC += serial_protocol.c
             QUANTUM_LIB_SRC += serial_$(strip $(SERIAL_DRIVER)).c
         endif
     endif
@@ -630,6 +704,12 @@ ifeq ($(strip $(CRC_ENABLE)), yes)
     SRC += crc.c
 endif
 
+ifeq ($(strip $(FNV_ENABLE)), yes)
+    OPT_DEFS += -DFNV_ENABLE
+    VPATH += $(LIB_PATH)/fnv
+    SRC += qmk_fnv_type_validation.c hash_32a.c hash_64a.c
+endif
+
 ifeq ($(strip $(HAPTIC_ENABLE)),yes)
     COMMON_VPATH += $(DRIVER_PATH)/haptic
 
@@ -646,8 +726,9 @@ ifeq ($(strip $(HAPTIC_ENABLE)),yes)
 endif
 
 ifeq ($(strip $(HD44780_ENABLE)), yes)
-    SRC += platforms/avr/drivers/hd44780.c
     OPT_DEFS += -DHD44780_ENABLE
+    COMMON_VPATH += $(DRIVER_PATH)/lcd
+    SRC += hd44780.c
 endif
 
 VALID_OLED_DRIVER_TYPES := SSD1306 custom
@@ -695,7 +776,10 @@ endif
 
 ifeq ($(strip $(UNICODE_COMMON)), yes)
     OPT_DEFS += -DUNICODE_COMMON_ENABLE
-    SRC += $(QUANTUM_DIR)/process_keycode/process_unicode_common.c
+    COMMON_VPATH += $(QUANTUM_DIR)/unicode
+    SRC += $(QUANTUM_DIR)/process_keycode/process_unicode_common.c \
+           $(QUANTUM_DIR)/unicode/unicode.c \
+           $(QUANTUM_DIR)/unicode/utf8.c
 endif
 
 MAGIC_ENABLE ?= yes
@@ -704,6 +788,13 @@ ifeq ($(strip $(MAGIC_ENABLE)), yes)
     OPT_DEFS += -DMAGIC_KEYCODE_ENABLE
 endif
 
+SEND_STRING_ENABLE ?= yes
+ifeq ($(strip $(SEND_STRING_ENABLE)), yes)
+    OPT_DEFS += -DSEND_STRING_ENABLE
+    COMMON_VPATH += $(QUANTUM_DIR)/send_string
+    SRC += $(QUANTUM_DIR)/send_string/send_string.c
+endif
+
 ifeq ($(strip $(AUTO_SHIFT_ENABLE)), yes)
     SRC += $(QUANTUM_DIR)/process_keycode/process_auto_shift.c
     OPT_DEFS += -DAUTO_SHIFT_ENABLE
@@ -719,31 +810,25 @@ ifeq ($(strip $(PS2_MOUSE_ENABLE)), yes)
     OPT_DEFS += -DMOUSE_ENABLE
 endif
 
-ifeq ($(strip $(PS2_USE_BUSYWAIT)), yes)
-    PS2_ENABLE := yes
-    SRC += ps2_busywait.c
-    SRC += ps2_io.c
-    OPT_DEFS += -DPS2_USE_BUSYWAIT
-endif
-
-ifeq ($(strip $(PS2_USE_INT)), yes)
-    PS2_ENABLE := yes
-    SRC += ps2_interrupt.c
-    SRC += ps2_io.c
-    OPT_DEFS += -DPS2_USE_INT
-endif
-
-ifeq ($(strip $(PS2_USE_USART)), yes)
-    PS2_ENABLE := yes
-    SRC += ps2_usart.c
-    SRC += ps2_io.c
-    OPT_DEFS += -DPS2_USE_USART
-endif
+VALID_PS2_DRIVER_TYPES := busywait interrupt usart vendor
 
+PS2_DRIVER ?= busywait
 ifeq ($(strip $(PS2_ENABLE)), yes)
+    ifeq ($(filter $(PS2_DRIVER),$(VALID_PS2_DRIVER_TYPES)),)
+        $(call CATASTROPHIC_ERROR,Invalid PS2_DRIVER,PS2_DRIVER="$(PS2_DRIVER)" is not a valid PS/2 driver)
+    endif
+
+    OPT_DEFS += -DPS2_DRIVER_$(strip $(shell echo $(PS2_DRIVER) | tr '[:lower:]' '[:upper:]'))
+
     COMMON_VPATH += $(DRIVER_PATH)/ps2
     COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/ps2
     OPT_DEFS += -DPS2_ENABLE
+
+    ifneq ($(strip $(PS2_DRIVER)), vendor)
+        SRC += ps2_io.c
+    endif
+
+    SRC += ps2_$(strip $(PS2_DRIVER)).c
 endif
 
 JOYSTICK_ENABLE ?= no
@@ -799,18 +884,26 @@ ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
     OPT_DEFS += -DBLUETOOTH_ENABLE
     NO_USB_STARTUP_CHECK := yes
     COMMON_VPATH += $(DRIVER_PATH)/bluetooth
-    SRC += outputselect.c
+    SRC += outputselect.c bluetooth.c
 
     ifeq ($(strip $(BLUETOOTH_DRIVER)), BluefruitLE)
-        OPT_DEFS += -DBLUETOOTH_BLUEFRUIT_LE
-        SRC += analog.c
+        OPT_DEFS += -DBLUETOOTH_BLUEFRUIT_LE -DHAL_USE_SPI=TRUE
         SRC += $(DRIVER_PATH)/bluetooth/bluefruit_le.cpp
+        QUANTUM_LIB_SRC += analog.c
         QUANTUM_LIB_SRC += spi_master.c
     endif
 
     ifeq ($(strip $(BLUETOOTH_DRIVER)), RN42)
-        OPT_DEFS += -DBLUETOOTH_RN42
+        OPT_DEFS += -DBLUETOOTH_RN42 -DHAL_USE_SERIAL=TRUE
         SRC += $(DRIVER_PATH)/bluetooth/rn42.c
         QUANTUM_LIB_SRC += uart.c
     endif
 endif
+
+ifeq ($(strip $(ENCODER_ENABLE)), yes)
+    SRC += $(QUANTUM_DIR)/encoder.c
+    OPT_DEFS += -DENCODER_ENABLE
+    ifeq ($(strip $(ENCODER_MAP_ENABLE)), yes)
+        OPT_DEFS += -DENCODER_MAP_ENABLE
+    endif
+endif

builddefs/common_rules.mk

@@ -1,21 +1,7 @@
 # Hey Emacs, this is a -*- makefile -*-
 #----------------------------------------------------------------------------
-# WinAVR Makefile Template written by Eric B. Weddington, Jg Wunsch, et al.
-#
-# Released to the Public Domain
-#
-# Additional material for this makefile was written by:
-# Peter Fleury
-# Tim Henigan
-# Colin O'Flynn
-# Reiner Patommel
-# Markus Pfaff
-# Sander Pool
-# Frederik Rouleau
-# Carlos Lamas
-#
 
-# Enable vpath seraching for source files only
+# Enable vpath searching for source files only
 # Without this, output files, could be read from the wrong .build directories
 VPATH_SRC := $(VPATH)
 vpath %.c $(VPATH_SRC)
@@ -38,36 +24,15 @@ NO_LTO_OBJ := $(filter %.a,$(OBJ))
 
 MASTER_OUTPUT := $(firstword $(OUTPUTS))
 
-
-
 # Output format. (can be srec, ihex, binary)
 FORMAT = ihex
 
 # Optimization level, can be [0, 1, 2, 3, s].
-#     0 = turn off optimization. s = optimize for size.
-#     (Note: 3 is not always the best optimization level. See avr-libc FAQ.)
 OPT ?= s
 
-# Compiler flag to set the C Standard level.
-#     c89   = "ANSI" C
-#     gnu89 = c89 plus GCC extensions
-#     c99   = ISO C99 standard (not yet fully implemented)
-#     gnu99 = c99 plus GCC extensions
-CSTANDARD = -std=gnu99
-
-
-# Place -D or -U options here for C sources
-#CDEFS +=
-
-
-# Place -D or -U options here for ASM sources
-#ADEFS +=
-
-
-# Place -D or -U options here for C++ sources
-#CXXDEFS += -D__STDC_LIMIT_MACROS
-#CXXDEFS += -D__STDC_CONSTANT_MACROS
-#CXXDEFS +=
+# Compiler flag to set the C and C++ language standard level
+CSTANDARD = -std=gnu11
+CXXSTANDARD = -std=gnu++14
 
 # Speed up recompilations by opt-in usage of ccache
 USE_CCACHE ?= no
@@ -75,15 +40,11 @@ ifneq ($(USE_CCACHE),no)
     CC_PREFIX ?= ccache
 endif
 
-#---------------- Compiler Options C ----------------
-#  -g*:          generate debugging information
-#  -O*:          optimization level
-#  -f...:        tuning, see GCC manual and avr-libc documentation
-#  -Wall...:     warning level
-#  -Wa,...:      tell GCC to pass this to the assembler.
+#---------------- C Compiler Options ----------------
+
 ifeq ($(strip $(LTO_ENABLE)), yes)
-    ifeq ($(PLATFORM),CHIBIOS)
-        $(info Enabling LTO on ChibiOS-targeting boards is known to have a high likelihood of failure.)
+    ifeq ($(PLATFORM),ARM_ATSAM)
+        $(info Enabling LTO on arm_atsam-targeting boards is known to have a high likelihood of failure.)
         $(info If unsure, set LTO_ENABLE = no.)
     endif
     CDEFS += -flto
@@ -111,29 +72,20 @@ CFLAGS += -Wstrict-prototypes
 ifneq ($(strip $(ALLOW_WARNINGS)), yes)
     CFLAGS += -Werror
 endif
-#CFLAGS += -mshort-calls
-#CFLAGS += -fno-unit-at-a-time
-#CFLAGS += -Wundef
-#CFLAGS += -Wunreachable-code
-#CFLAGS += -Wsign-compare
 CFLAGS += $(CSTANDARD)
 
 # This fixes lots of keyboards linking errors but SHOULDN'T BE A FINAL SOLUTION
 # Fixing of multiple variable definitions must be made.
 CFLAGS += -fcommon
 
-#---------------- Compiler Options C++ ----------------
-#  -g*:          generate debugging information
-#  -O*:          optimization level
-#  -f...:        tuning, see GCC manual and avr-libc documentation
-#  -Wall...:     warning level
-#  -Wa,...:      tell GCC to pass this to the assembler.
+#---------------- C++ Compiler Options ----------------
+
 ifeq ($(strip $(DEBUG_ENABLE)),yes)
   CXXFLAGS += -g$(DEBUG)
 endif
 CXXFLAGS += $(CXXDEFS)
 CXXFLAGS += -O$(OPT)
-# to supress "warning: only initialized variables can be placed into program memory area"
+# to suppress "warning: only initialized variables can be placed into program memory area"
 CXXFLAGS += -w
 CXXFLAGS += -Wall
 CXXFLAGS += -Wundef
@@ -141,57 +93,17 @@ CXXFLAGS += -Wundef
 ifneq ($(strip $(ALLOW_WARNINGS)), yes)
     CXXFLAGS += -Werror
 endif
-#CXXFLAGS += -mshort-calls
-#CXXFLAGS += -fno-unit-at-a-time
-#CXXFLAGS += -Wstrict-prototypes
-#CXXFLAGS += -Wunreachable-code
-#CXXFLAGS += -Wsign-compare
-#CXXFLAGS += $(CSTANDARD)
 
 #---------------- Assembler Options ----------------
+
 ASFLAGS += $(ADEFS)
 ifeq ($(VERBOSE_AS_CMD),yes)
 	ASFLAGS += -v
 endif
 
-#---------------- Library Options ----------------
-# Minimalistic printf version
-PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min
-
-# Floating point printf version (requires MATH_LIB = -lm below)
-PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt
-
-# If this is left blank, then it will use the Standard printf version.
-PRINTF_LIB =
-#PRINTF_LIB = $(PRINTF_LIB_MIN)
-#PRINTF_LIB = $(PRINTF_LIB_FLOAT)
-
-
-# Minimalistic scanf version
-SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min
-
-# Floating point + %[ scanf version (requires MATH_LIB = -lm below)
-SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt
-
-# If this is left blank, then it will use the Standard scanf version.
-SCANF_LIB =
-#SCANF_LIB = $(SCANF_LIB_MIN)
-#SCANF_LIB = $(SCANF_LIB_FLOAT)
-
-
-MATH_LIB = -lm
-CREATE_MAP ?= yes
-
-
 #---------------- Linker Options ----------------
-#  -Wl,...:     tell GCC to pass this to linker.
-#    -Map:      create map file
-#    --cref:    add cross reference to  map file
-#
-# Comennt out "--relax" option to avoid a error such:
-# 	(.vectors+0x30): relocation truncated to fit: R_AVR_13_PCREL against symbol `__vector_12'
-#
 
+CREATE_MAP ?= yes
 ifeq ($(CREATE_MAP),yes)
 	LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
 endif
@@ -201,20 +113,11 @@ endif
 #LDFLAGS += -Wl,--relax
 LDFLAGS += $(EXTMEMOPTS)
 LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))
-LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)
-#LDFLAGS += -T linker_script.x
+LDFLAGS += -lm
 # You can give EXTRALDFLAGS at 'make' command line.
 LDFLAGS += $(EXTRALDFLAGS)
 
 #---------------- Assembler Listings ----------------
-#  -Wa,...:   tell GCC to pass this to the assembler.
-#  -adhlns:   create listing
-#  -gstabs:   have the assembler create line number information; note that
-#             for use in COFF files, additional information about filenames
-#             and function names needs to be present in the assembler source
-#             files -- see avr-libc docs [FIXME: not yet described there]
-#  -listing-cont-lines: Sets the maximum number of continuation lines of hex
-#       dump that will be displayed for a given single line of source input.
 
 ADHLNS_ENABLE ?= no
 ifeq ($(ADHLNS_ENABLE),yes)
@@ -316,7 +219,7 @@ gccversion :
 	@$(BUILD_CMD)
 
 %.uf2: %.hex
-	$(eval CMD=$(UF2CONV) $(BUILD_DIR)/$(TARGET).hex -o $(BUILD_DIR)/$(TARGET).uf2 -c -f $(UF2_FAMILY) >/dev/null 2>&1)
+	$(eval CMD=$(UF2CONV) $(BUILD_DIR)/$(TARGET).hex --output $(BUILD_DIR)/$(TARGET).uf2 --convert --family $(UF2_FAMILY) >/dev/null 2>&1)
 	#@$(SILENT) || printf "$(MSG_EXECUTING) '$(CMD)':\n"
 	@$(SILENT) || printf "$(MSG_UF2) $@" | $(AWK_CMD)
 	@$(BUILD_CMD)
@@ -429,6 +332,7 @@ $1/asflags.txt: $1/force
 	echo '$$($1_ASFLAGS)' | cmp -s - $$@ || echo '$$($1_ASFLAGS)' > $$@
 
 $1/compiler.txt: $1/force
+	test -f $$@ || touch $$@
 	$$(CC) --version | cmp -s - $$@ || $$(CC) --version > $$@
 endef
 
@@ -468,6 +372,7 @@ show_path:
 dump_vars: ERROR_IF_EMPTY=""
 dump_vars: ERROR_IF_NONBOOL=""
 dump_vars: ERROR_IF_UNSET=""
+dump_vars: CATASTROPHIC_ERROR=""
 dump_vars:
 	@$(foreach V,$(sort $(.VARIABLES)),$(if $(filter-out environment% default automatic,$(origin $V)),$(info $V=$($V))))
 

builddefs/converters.mk

@@ -0,0 +1,38 @@
+# 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 @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
+endif
+
+# TODO: opt in rather than assume everything uses a pro micro
+PIN_COMPATIBLE ?= promicro
+ifneq ($(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
+
+    TARGET := $(TARGET)_$(CONVERT_TO)
+
+    # Configure any defaults
+    OPT_DEFS += -DCONVERT_TO_$(strip $(shell echo $(CONVERT_TO) | tr '[:lower:]' '[:upper:]'))
+    OPT_DEFS += -DCONVERTER_TARGET=\"$(strip $(CONVERT_TO))\"
+    OPT_DEFS += -DCONVERTER_ENABLED
+    VPATH += $(CONVERTER)
+
+    # Finally run any converter specific logic
+    include $(CONVERTER)/converter.mk
+endif

builddefs/disable_features.mk

@@ -14,7 +14,6 @@ FEATURE_NAMES += LCD_BACKLIGHT
 FEATURE_NAMES += LCD
 FEATURE_NAMES += OLED
 FEATURE_NAMES += POINTING_DEVICE
-FEATURE_NAMES += PRINTING
 FEATURE_NAMES += PS2_MOUSE
 FEATURE_NAMES += RGBLIGHT
 FEATURE_NAMES += RGB_MATRIX

builddefs/generic_features.mk

@@ -17,6 +17,8 @@ SPACE_CADET_ENABLE ?= yes
 GRAVE_ESC_ENABLE ?= yes
 
 GENERIC_FEATURES = \
+    AUTOCORRECT \
+    CAPS_WORD \
     COMBO \
     COMMAND \
     DEFERRED_EXEC \
@@ -24,13 +26,13 @@ GENERIC_FEATURES = \
     DIP_SWITCH \
     DYNAMIC_KEYMAP \
     DYNAMIC_MACRO \
-    ENCODER \
     GRAVE_ESC \
     HAPTIC \
     KEY_LOCK \
     KEY_OVERRIDE \
     LEADER \
     PROGRAMMABLE_BUTTON \
+    SECURE \
     SPACE_CADET \
     SWAP_HANDS \
     TAP_DANCE \

builddefs/mcu_selection.mk

@@ -9,7 +9,9 @@ ifneq ($(findstring MKL26Z64, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = KINETIS
   MCU_SERIES = KL2x
 
@@ -36,7 +38,9 @@ ifneq ($(findstring MK20DX128, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = KINETIS
   MCU_SERIES = K20x
 
@@ -63,7 +67,9 @@ ifneq ($(findstring MK20DX256, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = KINETIS
   MCU_SERIES = K20x
 
@@ -81,7 +87,7 @@ ifneq ($(findstring MK20DX256, $(MCU)),)
   BOARD ?= PJRC_TEENSY_3_1
 endif
 
-ifneq ($(findstring MK66FX1M0, $(MCU)),)
+ifneq ($(findstring MK64FX512, $(MCU)),)
   # Cortex version
   MCU = cortex-m4
 
@@ -92,6 +98,35 @@ ifneq ($(findstring MK66FX1M0, $(MCU)),)
   # - the next two should match the directories in
   #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = KINETIS
+  MCU_SERIES = K60x
+
+  # Linker script to use
+  # - it should exist either in <chibios>/os/common/ports/ARMCMx/compilers/GCC/ld/
+  #   or <keyboard_dir>/ld/
+  MCU_LDSCRIPT ?= MK64FX512
+
+  # Startup code to use
+  #  - it should exist in <chibios>/os/common/startup/ARMCMx/compilers/GCC/mk/
+  MCU_STARTUP ?= k60x
+
+  # Board: it should exist either in <chibios>/os/hal/boards/,
+  # <keyboard_dir>/boards/, or drivers/boards/
+  BOARD ?= PJRC_TEENSY_3_5
+endif
+
+ifneq ($(findstring MK66FX1M0, $(MCU)),)
+  # Cortex version
+  MCU = cortex-m4
+
+  # ARM version, CORTEX-M0/M1 are 6, CORTEX-M3/M4/M7 are 7
+  ARMV = 7
+
+  ## chip/board settings
+  # - the next two should match the directories in
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  MCU_FAMILY = KINETIS
   MCU_SERIES = MK66F18
 
   # Linker script to use
@@ -108,6 +143,41 @@ ifneq ($(findstring MK66FX1M0, $(MCU)),)
   BOARD ?= PJRC_TEENSY_3_6
 endif
 
+ifneq ($(findstring RP2040, $(MCU)),)
+  # Cortex version
+  MCU = cortex-m0plus
+
+  # ARM version, CORTEX-M0/M1 are 6, CORTEX-M3/M4/M7 are 7
+  CHIBIOS_PORT = ARMv6-M-RP2
+
+  ## chip/board settings
+  # - the next two should match the directories in
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  MCU_FAMILY = RP
+  MCU_SERIES = RP2040
+
+  # Linker script to use
+  # - it should exist either in <chibios>/os/common/ports/ARMCMx/compilers/GCC/ld/
+  #   or <keyboard_dir>/ld/
+  STARTUPLD_CONTRIB = $(CHIBIOS_CONTRIB)/os/common/startup/ARMCMx/compilers/GCC/ld
+  MCU_LDSCRIPT ?= RP2040_FLASH_TIMECRIT
+  LDFLAGS += -L $(STARTUPLD_CONTRIB)
+
+  # Startup code to use
+  #  - it should exist in <chibios>/os/common/startup/ARMCMx/compilers/GCC/mk/
+  MCU_STARTUP ?= rp2040
+
+  # Board: it should exist either in <chibios>/os/hal/boards/,
+  # <keyboard_dir>/boards/, or drivers/boards/
+  BOARD ?= GENERIC_PROMICRO_RP2040
+
+  # Default UF2 Bootloader settings
+  UF2_FAMILY ?= RP2040
+  FIRMWARE_FORMAT ?= uf2
+endif
+
 ifneq ($(findstring STM32F042, $(MCU)),)
   # Cortex version
   MCU = cortex-m0
@@ -117,7 +187,9 @@ ifneq ($(findstring STM32F042, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F0xx
 
@@ -157,7 +229,9 @@ ifneq ($(findstring STM32F072, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F0xx
 
@@ -192,7 +266,9 @@ ifneq ($(findstring STM32F103, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F1xx
 
@@ -224,7 +300,9 @@ ifneq ($(findstring STM32F303, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F3xx
 
@@ -259,7 +337,9 @@ ifneq ($(findstring STM32F401, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F4xx
 
@@ -268,7 +348,6 @@ ifneq ($(findstring STM32F401, $(MCU)),)
   #   or <keyboard_dir>/ld/
   ifeq ($(strip $(BOOTLOADER)), tinyuf2)
     MCU_LDSCRIPT ?= STM32F401xC_tinyuf2
-    FIRMWARE_FORMAT ?= uf2
   else
     MCU_LDSCRIPT ?= STM32F401xC
   endif
@@ -279,7 +358,7 @@ ifneq ($(findstring STM32F401, $(MCU)),)
 
   # Board: it should exist either in <chibios>/os/hal/boards/,
   # <keyboard_dir>/boards/, or drivers/boards/
-  BOARD ?= BLACKPILL_STM32_F401
+  BOARD ?= GENERIC_STM32_F401XC
 
   USE_FPU ?= yes
 
@@ -288,6 +367,10 @@ ifneq ($(findstring STM32F401, $(MCU)),)
 
   # Bootloader address for STM32 DFU
   STM32_BOOTLOADER_ADDRESS ?= 0x1FFF0000
+
+  # Revert to legacy wear-leveling driver until ChibiOS's EFL driver is fixed with 128kB and 384kB variants.
+  EEPROM_DRIVER ?= wear_leveling
+  WEAR_LEVELING_DRIVER ?= legacy
 endif
 
 ifneq ($(findstring STM32F405, $(MCU)),)
@@ -299,7 +382,9 @@ ifneq ($(findstring STM32F405, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F4xx
 
@@ -334,7 +419,9 @@ ifneq ($(findstring STM32F407, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F4xx
 
@@ -369,7 +456,9 @@ ifneq ($(findstring STM32F411, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F4xx
 
@@ -378,7 +467,6 @@ ifneq ($(findstring STM32F411, $(MCU)),)
   #   or <keyboard_dir>/ld/
   ifeq ($(strip $(BOOTLOADER)), tinyuf2)
     MCU_LDSCRIPT ?= STM32F411xE_tinyuf2
-    FIRMWARE_FORMAT ?= uf2
   else
     MCU_LDSCRIPT ?= STM32F411xE
   endif
@@ -389,7 +477,7 @@ ifneq ($(findstring STM32F411, $(MCU)),)
 
   # Board: it should exist either in <chibios>/os/hal/boards/,
   # <keyboard_dir>/boards/, or drivers/boards/
-  BOARD ?= BLACKPILL_STM32_F411
+  BOARD ?= GENERIC_STM32_F411XE
 
   USE_FPU ?= yes
 
@@ -409,7 +497,9 @@ ifneq ($(findstring STM32F446, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32F4xx
 
@@ -430,6 +520,9 @@ ifneq ($(findstring STM32F446, $(MCU)),)
 
   # Bootloader address for STM32 DFU
   STM32_BOOTLOADER_ADDRESS ?= 0x1FFF0000
+
+  # Default as no chibios efl config
+  EEPROM_DRIVER ?= transient
 endif
 
 ifneq ($(findstring STM32G431, $(MCU)),)
@@ -441,7 +534,9 @@ ifneq ($(findstring STM32G431, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32G4xx
 
@@ -476,7 +571,9 @@ ifneq ($(findstring STM32G474, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32G4xx
 
@@ -511,7 +608,9 @@ ifneq (,$(filter $(MCU),STM32L432 STM32L442))
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32L4xx
 
@@ -548,7 +647,9 @@ ifneq (,$(filter $(MCU),STM32L433 STM32L443))
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32L4xx
 
@@ -585,7 +686,9 @@ ifneq (,$(filter $(MCU),STM32L412 STM32L422))
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = STM32
   MCU_SERIES = STM32L4xx
 
@@ -602,7 +705,7 @@ ifneq (,$(filter $(MCU),STM32L412 STM32L422))
   # <keyboard_dir>/boards/, or drivers/boards/
   BOARD ?= GENERIC_STM32_L412XB
 
-  PLATFORM_NAME ?= platform_l432
+  PLATFORM_NAME ?= platform_l412_l422
 
   USE_FPU ?= yes
 
@@ -622,7 +725,9 @@ ifneq ($(findstring WB32F3G71, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
   MCU_FAMILY = WB32
   MCU_SERIES = WB32F3G71xx
 
@@ -642,7 +747,40 @@ ifneq ($(findstring WB32F3G71, $(MCU)),)
   USE_FPU ?= no
 
   # Bootloader address for WB32 DFU
-  STM32_BOOTLOADER_ADDRESS ?= 0x1FFFE000
+  WB32_BOOTLOADER_ADDRESS ?= 0x1FFFE000
+endif
+
+ifneq ($(findstring WB32FQ95, $(MCU)),)
+  # Cortex version
+  MCU = cortex-m3
+
+  # ARM version, CORTEX-M0/M1 are 6, CORTEX-M3/M4/M7 are 7
+  ARMV = 7
+
+  ## chip/board settings
+  # - the next two should match the directories in
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  MCU_FAMILY = WB32
+  MCU_SERIES = WB32FQ95xx
+
+  # Linker script to use
+  # - it should exist either in <chibios>/os/common/ports/ARMCMx/compilers/GCC/ld/
+  #   or <keyboard_dir>/ld/
+  MCU_LDSCRIPT ?= WB32FQ95xB
+
+  # Startup code to use
+  #  - it should exist in <chibios>/os/common/startup/ARMCMx/compilers/GCC/mk/
+  MCU_STARTUP ?= wb32fq95xx
+
+  # Board: it should exist either in <chibios>/os/hal/boards/,
+  # <keyboard_dir>/boards/, or drivers/boards/
+  BOARD ?= GENERIC_WB32_FQ95XX
+
+  USE_FPU ?= no
+
+  # Bootloader address for WB32 DFU
   WB32_BOOTLOADER_ADDRESS ?= 0x1FFFE000
 endif
 
@@ -657,7 +795,10 @@ ifneq ($(findstring GD32VF103, $(MCU)),)
 
   ## chip/board settings
   # - the next two should match the directories in
-  #   <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_PORT_NAME)/$(MCU_SERIES)
+  #   OR
+  #   <chibios[-contrib]>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
+  MCU_PORT_NAME = GD
   MCU_FAMILY = GD32V
   MCU_SERIES = GD32VF103
 

builddefs/message.mk

@@ -63,6 +63,7 @@ MSG_COMPILING_CXX = Compiling:
 MSG_ASSEMBLING = Assembling:
 MSG_CLEANING = Cleaning project:
 MSG_CREATING_LIBRARY = Creating library:
+MSG_GENERATING = Generating:
 MSG_SUBMODULE_DIRTY = $(WARN_COLOR)WARNING:$(NO_COLOR) Some git submodules are out of date or modified.\n\
 Please consider running $(BOLD)make git-submodule$(NO_COLOR).\n\n
 MSG_NO_CMP = $(ERROR_COLOR)Error:$(NO_COLOR)$(BOLD) cmp command not found, please install diffutils\n$(NO_COLOR)

builddefs/show_options.mk

@@ -5,7 +5,6 @@ BUILD_OPTION_NAMES = \
   CONSOLE_ENABLE \
   COMMAND_ENABLE \
   NKRO_ENABLE \
-  TERMINAL_ENABLE \
   CUSTOM_MATRIX \
   DEBOUNCE_TYPE \
   SPLIT_KEYBOARD \
@@ -44,8 +43,8 @@ OTHER_OPTION_NAMES = \
   KEY_LOCK_ENABLE \
   KEY_OVERRIDE_ENABLE \
   LEADER_ENABLE \
-  PRINTING_ENABLE \
   STENO_ENABLE \
+  STENO_PROTOCOL \
   TAP_DANCE_ENABLE \
   VIRTSER_ENABLE \
   OLED_ENABLE \
@@ -57,6 +56,7 @@ OTHER_OPTION_NAMES = \
   HELIX ZINC \
   AUTOLOG_ENABLE \
   DEBUG_ENABLE \
+  ENCODER_MAP_ENABLE \
   ENCODER_ENABLE_CUSTOM \
   GERMAN_ENABLE \
   HAPTIC_ENABLE \
@@ -65,7 +65,9 @@ OTHER_OPTION_NAMES = \
   KEYLOGGER_ENABLE \
   LCD_BACKLIGHT_ENABLE \
   MACROS_ENABLED \
+  PS2_ENABLE \
   PS2_MOUSE_ENABLE \
+  PS2_DRIVER \
   RAW_ENABLE \
   SWAP_HANDS_ENABLE \
   RING_BUFFERED_6KRO_REPORT_ENABLE \
@@ -79,7 +81,10 @@ OTHER_OPTION_NAMES = \
   LED_MIRRORED \
   RGBLIGHT_FULL_POWER \
   LTO_ENABLE \
-  PROGRAMMABLE_BUTTON_ENABLE
+  PROGRAMMABLE_BUTTON_ENABLE \
+  SECURE_ENABLE \
+  CAPS_WORD_ENABLE \
+  AUTOCORRECT_ENABLE
 
 define NAME_ECHO
        @printf "  %-30s = %-16s # %s\\n" "$1" "$($1)" "$(origin $1)"

builddefs/testlist.mk

@@ -2,7 +2,9 @@ TEST_LIST = $(sort $(patsubst %/test.mk,%, $(shell find $(ROOT_DIR)tests -type f
 FULL_TESTS := $(notdir $(TEST_LIST))
 
 include $(QUANTUM_PATH)/debounce/tests/testlist.mk
+include $(QUANTUM_PATH)/encoder/tests/testlist.mk
 include $(QUANTUM_PATH)/sequencer/tests/testlist.mk
+include $(QUANTUM_PATH)/wear_leveling/tests/testlist.mk
 include $(PLATFORM_PATH)/test/testlist.mk
 
 define VALIDATE_TEST_LIST

data/constants/keycodes/keycodes_0.0.1.hjson

@@ -0,0 +1,96 @@
+{
+    "ranges": {
+        "0x0000/0x00FF": {
+            "define": "QK_BASIC"
+        },
+        "0x0100/0x1EFF": {
+            "define": "QK_MODS"
+        },
+        "0x2000/0x1FFF": {
+            "define": "QK_MOD_TAP"
+        },
+        "0x4000/0x0FFF": {
+            "define": "QK_LAYER_TAP"
+        },
+        "0x5000/0x01FF": {
+            "define": "QK_LAYER_MOD"
+        },
+        "0x5200/0x001F": {
+            "define": "QK_TO"
+        },
+        "0x5220/0x001F": {
+            "define": "QK_MOMENTARY"
+        },
+        "0x5240/0x001F": {
+            "define": "QK_DEF_LAYER"
+        },
+        "0x5260/0x001F": {
+            "define": "QK_TOGGLE_LAYER"
+        },
+        "0x5280/0x001F": {
+            "define": "QK_ONE_SHOT_LAYER"
+        },
+        "0x52A0/0x001F": {
+            "define": "QK_ONE_SHOT_MOD"
+        },
+        "0x52C0/0x001F": {
+            "define": "QK_LAYER_TAP_TOGGLE"
+        },
+        // 0x52E0/0x001F - UNUSED
+        // 0x5300/0x02FF - UNUSED
+        "0x5600/0x00FF": {
+            "define": "QK_SWAP_HANDS"
+        },
+        "0x5700/0x00FF": {
+            "define": "QK_TAP_DANCE"
+        },
+        // 0x5800/0x17FF - UNUSED
+        "0x7000/0x00FF": {
+            "define": "QK_MAGIC"
+        },
+        "0x7100/0x00FF": {
+            "define": "QK_MIDI"
+        },
+        "0x7200/0x01FF": {
+            "define": "QK_SEQUENCER"
+        },
+        "0x7400/0x003F": {
+            "define": "QK_JOYSTICK"
+        },
+        "0x7440/0x003F": {
+            "define": "QK_PROGRAMMABLE_BUTTON"
+        },
+        "0x7480/0x003F": {
+            "define": "QK_AUDIO"
+        },
+        "0x74C0/0x003F": {
+            "define": "QK_STENO"
+        },
+        // 0x7500/0x01FF - UNUSED
+        "0x7700/0x007F": {
+            "define": "QK_MACRO"
+        },
+        // 0x7780/0x007F - UNUSED
+        "0x7800/0x00FF": {
+            "define": "QK_LIGHTING"
+        },
+        // 0x7900/0x02FF - UNUSED
+        "0x7C00/0x01FF": {
+            "define": "QK_QUANTUM"
+        },
+        "0x7E00/0x00FF": {
+            "define": "QK_KB"
+        },
+        "0x7F00/0x00FF": {
+            "define": "QK_USER"
+        },
+        "0x8000/0x7FFF": {
+            "define": "QK_UNICODE"
+        }
+    },
+    "keycodes": {
+        "0x7E00": {
+            "key": "SAFE_RANGE"
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_audio.hjson

@@ -0,0 +1,112 @@
+{
+    "keycodes": {
+        "0x7480": {
+            "group": "audio",
+            "key": "QK_AUDIO_ON",
+            "aliases": [
+                "AU_ON"
+            ]
+        },
+        "0x7481": {
+            "group": "audio",
+            "key": "QK_AUDIO_OFF",
+            "aliases": [
+                "AU_OFF"
+            ]
+        },
+        "0x7482": {
+            "group": "audio",
+            "key": "QK_AUDIO_TOGGLE",
+            "aliases": [
+                "AU_TOGG"
+            ]
+        },
+
+        "0x748A": {
+            "group": "audio",
+            "key": "QK_AUDIO_CLICKY_TOGGLE",
+            "aliases": [
+                "CK_TOGG"
+            ]
+        },
+        "0x748B": {
+            "group": "audio",
+            "key": "QK_AUDIO_CLICKY_ON",
+            "aliases": [
+                "CK_ON"
+            ]
+        },
+        "0x748C": {
+            "group": "audio",
+            "key": "QK_AUDIO_CLICKY_OFF",
+            "aliases": [
+                "CK_OFF"
+            ]
+        },
+        "0x748D": {
+            "group": "audio",
+            "key": "QK_AUDIO_CLICKY_UP",
+            "aliases": [
+                "CK_UP"
+            ]
+        },
+        "0x748E": {
+            "group": "audio",
+            "key": "QK_AUDIO_CLICKY_DOWN",
+            "aliases": [
+                "CK_DOWN"
+            ]
+        },
+        "0x748F": {
+            "group": "audio",
+            "key": "QK_AUDIO_CLICKY_RESET",
+            "aliases": [
+                "CK_RST"
+            ]
+        },
+
+        "0x7490": {
+            "group": "audio",
+            "key": "QK_MUSIC_ON",
+            "aliases": [
+                "MU_ON"
+            ]
+        },
+        "0x7491": {
+            "group": "audio",
+            "key": "QK_MUSIC_OFF",
+            "aliases": [
+                "MU_OFF"
+            ]
+        },
+        "0x7492": {
+            "group": "audio",
+            "key": "QK_MUSIC_TOGGLE",
+            "aliases": [
+                "MU_TOGG"
+            ]
+        },
+        "0x7493": {
+            "group": "audio",
+            "key": "QK_MUSIC_MODE_NEXT",
+            "aliases": [
+                "MU_NEXT"
+            ]
+        },
+
+        "0x7494": {
+            "group": "audio",
+            "key": "QK_AUDIO_VOICE_NEXT",
+            "aliases": [
+                "AU_NEXT"
+            ]
+        },
+        "0x7495": {
+            "group": "audio",
+            "key": "QK_AUDIO_VOICE_PREVIOUS",
+            "aliases": [
+                "AU_PREV"
+            ]
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_joystick.hjson

@@ -0,0 +1,228 @@
+{
+    "keycodes": {
+        "0x7400": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_0",
+            "aliases": [
+                "JS_0"
+            ]
+        },
+        "0x7401": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_1",
+            "aliases": [
+                "JS_1"
+            ]
+        },
+        "0x7402": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_2",
+            "aliases": [
+                "JS_2"
+            ]
+        },
+        "0x7403": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_3",
+            "aliases": [
+                "JS_3"
+            ]
+        },
+        "0x7404": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_4",
+            "aliases": [
+                "JS_4"
+            ]
+        },
+        "0x7405": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_5",
+            "aliases": [
+                "JS_5"
+            ]
+        },
+        "0x7406": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_6",
+            "aliases": [
+                "JS_6"
+            ]
+        },
+        "0x7407": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_7",
+            "aliases": [
+                "JS_7"
+            ]
+        },
+        "0x7408": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_8",
+            "aliases": [
+                "JS_8"
+            ]
+        },
+        "0x7409": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_9",
+            "aliases": [
+                "JS_9"
+            ]
+        },
+        "0x740A": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_10",
+            "aliases": [
+                "JS_10"
+            ]
+        },
+        "0x740B": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_11",
+            "aliases": [
+                "JS_11"
+            ]
+        },
+        "0x740C": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_12",
+            "aliases": [
+                "JS_12"
+            ]
+        },
+        "0x740D": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_13",
+            "aliases": [
+                "JS_13"
+            ]
+        },
+        "0x740E": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_14",
+            "aliases": [
+                "JS_14"
+            ]
+        },
+        "0x740F": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_15",
+            "aliases": [
+                "JS_15"
+            ]
+        },
+        "0x7410": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_16",
+            "aliases": [
+                "JS_16"
+            ]
+        },
+        "0x7411": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_17",
+            "aliases": [
+                "JS_17"
+            ]
+        },
+        "0x7412": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_18",
+            "aliases": [
+                "JS_18"
+            ]
+        },
+        "0x7413": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_19",
+            "aliases": [
+                "JS_19"
+            ]
+        },
+        "0x7414": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_20",
+            "aliases": [
+                "JS_20"
+            ]
+        },
+        "0x7415": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_21",
+            "aliases": [
+                "JS_21"
+            ]
+        },
+        "0x7416": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_22",
+            "aliases": [
+                "JS_22"
+            ]
+        },
+        "0x7417": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_23",
+            "aliases": [
+                "JS_23"
+            ]
+        },
+        "0x7418": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_24",
+            "aliases": [
+                "JS_24"
+            ]
+        },
+        "0x7419": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_25",
+            "aliases": [
+                "JS_25"
+            ]
+        },
+        "0x741A": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_26",
+            "aliases": [
+                "JS_26"
+            ]
+        },
+        "0x741B": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_27",
+            "aliases": [
+                "JS_27"
+            ]
+        },
+        "0x741C": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_28",
+            "aliases": [
+                "JS_28"
+            ]
+        },
+        "0x741D": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_29",
+            "aliases": [
+                "JS_29"
+            ]
+        },
+        "0x741E": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_30",
+            "aliases": [
+                "JS_30"
+            ]
+        },
+        "0x741F": {
+            "group": "joystick",
+            "key": "QK_JOYSTICK_BUTTON_31",
+            "aliases": [
+                "JS_31"
+            ]
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_lighting.hjson

@@ -0,0 +1,175 @@
+{
+    "keycodes": {
+        "0x7800": {
+            "group": "backlight",
+            "key": "QK_BACKLIGHT_ON",
+            "aliases": [
+                "BL_ON"
+            ]
+        },
+        "0x7801": {
+            "group": "backlight",
+            "key": "QK_BACKLIGHT_OFF",
+            "aliases": [
+                "BL_OFF"
+            ]
+        },
+        "0x7802": {
+            "group": "backlight",
+            "key": "QK_BACKLIGHT_TOGGLE",
+            "aliases": [
+                "BL_TOGG"
+            ]
+        },
+        "0x7803": {
+            "group": "backlight",
+            "key": "QK_BACKLIGHT_DOWN",
+            "aliases": [
+                "BL_DOWN"
+            ]
+        },
+        "0x7804": {
+            "group": "backlight",
+            "key": "QK_BACKLIGHT_UP",
+            "aliases": [
+                "BL_UP"
+            ]
+        },
+        "0x7805": {
+            "group": "backlight",
+            "key": "QK_BACKLIGHT_STEP",
+            "aliases": [
+                "BL_STEP"
+            ]
+        },
+        "0x7806": {
+            "group": "backlight",
+            "key": "QK_BACKLIGHT_TOGGLE_BREATHING",
+            "aliases": [
+                "BL_BRTG"
+            ]
+        },
+
+        "0x7820": {
+            "group": "rgb",
+            "key": "RGB_TOG"
+        },
+        "0x7821": {
+            "group": "rgb",
+            "key": "RGB_MODE_FORWARD",
+            "aliases": [
+                "RGB_MOD"
+            ]
+        },
+        "0x7822": {
+            "group": "rgb",
+            "key": "RGB_MODE_REVERSE",
+            "aliases": [
+                "RGB_RMOD"
+            ]
+        },
+        "0x7823": {
+            "group": "rgb",
+            "key": "RGB_HUI"
+        },
+        "0x7824": {
+            "group": "rgb",
+            "key": "RGB_HUD"
+        },
+        "0x7825": {
+            "group": "rgb",
+            "key": "RGB_SAI"
+        },
+        "0x7826": {
+            "group": "rgb",
+            "key": "RGB_SAD"
+        },
+        "0x7827": {
+            "group": "rgb",
+            "key": "RGB_VAI"
+        },
+        "0x7828": {
+            "group": "rgb",
+            "key": "RGB_VAD"
+        },
+        "0x7829": {
+            "group": "rgb",
+            "key": "RGB_SPI"
+        },
+        "0x782A": {
+            "group": "rgb",
+            "key": "RGB_SPD"
+        },
+
+        "0x782B": {
+            "group": "rgb",
+            "key": "RGB_MODE_PLAIN",
+            "aliases": [
+                "RGB_M_P"
+            ]
+        },
+        "0x782C": {
+            "group": "rgb",
+            "key": "RGB_MODE_BREATHE",
+            "aliases": [
+                "RGB_M_B"
+            ]
+        },
+        "0x782D": {
+            "group": "rgb",
+            "key": "RGB_MODE_RAINBOW",
+            "aliases": [
+                "RGB_M_R"
+            ]
+        },
+        "0x782E": {
+            "group": "rgb",
+            "key": "RGB_MODE_SWIRL",
+            "aliases": [
+                "RGB_M_SW"
+            ]
+        },
+        "0x782F": {
+            "group": "rgb",
+            "key": "RGB_MODE_SNAKE",
+            "aliases": [
+                "RGB_M_SN"
+            ]
+        },
+        "0x7830": {
+            "group": "rgb",
+            "key": "RGB_MODE_KNIGHT",
+            "aliases": [
+                "RGB_M_K"
+            ]
+        },
+        "0x7831": {
+            "group": "rgb",
+            "key": "RGB_MODE_XMAS",
+            "aliases": [
+                "RGB_M_X"
+            ]
+        },
+        "0x7832": {
+            "group": "rgb",
+            "key": "RGB_MODE_GRADIENT",
+            "aliases": [
+                "RGB_M_G"
+            ]
+        },
+        "0x7833": {
+            "group": "rgb",
+            "key": "RGB_MODE_RGBTEST",
+            "aliases": [
+                "RGB_M_T"
+            ]
+        },
+        "0x7834": {
+            "group": "rgb",
+            "key": "RGB_MODE_TWINKLE",
+            "aliases": [
+                "RGB_M_TW"
+            ]
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_macro.hjson

@@ -0,0 +1,229 @@
+{
+    "keycodes": {
+
+        "0x7700": {
+            "group": "macro",
+            "key": "QK_MACRO_0",
+            "aliases": [
+                "MC_0"
+            ]
+        },
+        "0x7701": {
+            "group": "macro",
+            "key": "QK_MACRO_1",
+            "aliases": [
+                "MC_1"
+            ]
+        },
+        "0x7702": {
+            "group": "macro",
+            "key": "QK_MACRO_2",
+            "aliases": [
+                "MC_2"
+            ]
+        },
+        "0x7703": {
+            "group": "macro",
+            "key": "QK_MACRO_3",
+            "aliases": [
+                "MC_3"
+            ]
+        },
+        "0x7704": {
+            "group": "macro",
+            "key": "QK_MACRO_4",
+            "aliases": [
+                "MC_4"
+            ]
+        },
+        "0x7705": {
+            "group": "macro",
+            "key": "QK_MACRO_5",
+            "aliases": [
+                "MC_5"
+            ]
+        },
+        "0x7706": {
+            "group": "macro",
+            "key": "QK_MACRO_6",
+            "aliases": [
+                "MC_6"
+            ]
+        },
+        "0x7707": {
+            "group": "macro",
+            "key": "QK_MACRO_7",
+            "aliases": [
+                "MC_7"
+            ]
+        },
+        "0x7708": {
+            "group": "macro",
+            "key": "QK_MACRO_8",
+            "aliases": [
+                "MC_8"
+            ]
+        },
+        "0x7709": {
+            "group": "macro",
+            "key": "QK_MACRO_9",
+            "aliases": [
+                "MC_9"
+            ]
+        },
+        "0x770A": {
+            "group": "macro",
+            "key": "QK_MACRO_10",
+            "aliases": [
+                "MC_10"
+            ]
+        },
+        "0x770B": {
+            "group": "macro",
+            "key": "QK_MACRO_11",
+            "aliases": [
+                "MC_11"
+            ]
+        },
+        "0x770C": {
+            "group": "macro",
+            "key": "QK_MACRO_12",
+            "aliases": [
+                "MC_12"
+            ]
+        },
+        "0x770D": {
+            "group": "macro",
+            "key": "QK_MACRO_13",
+            "aliases": [
+                "MC_13"
+            ]
+        },
+        "0x770E": {
+            "group": "macro",
+            "key": "QK_MACRO_14",
+            "aliases": [
+                "MC_14"
+            ]
+        },
+        "0x770F": {
+            "group": "macro",
+            "key": "QK_MACRO_15",
+            "aliases": [
+                "MC_15"
+            ]
+        },
+        "0x7710": {
+            "group": "macro",
+            "key": "QK_MACRO_16",
+            "aliases": [
+                "MC_16"
+            ]
+        },
+        "0x7711": {
+            "group": "macro",
+            "key": "QK_MACRO_17",
+            "aliases": [
+                "MC_17"
+            ]
+        },
+        "0x7712": {
+            "group": "macro",
+            "key": "QK_MACRO_18",
+            "aliases": [
+                "MC_18"
+            ]
+        },
+        "0x7713": {
+            "group": "macro",
+            "key": "QK_MACRO_19",
+            "aliases": [
+                "MC_19"
+            ]
+        },
+        "0x7714": {
+            "group": "macro",
+            "key": "QK_MACRO_20",
+            "aliases": [
+                "MC_20"
+            ]
+        },
+        "0x7715": {
+            "group": "macro",
+            "key": "QK_MACRO_21",
+            "aliases": [
+                "MC_21"
+            ]
+        },
+        "0x7716": {
+            "group": "macro",
+            "key": "QK_MACRO_22",
+            "aliases": [
+                "MC_22"
+            ]
+        },
+        "0x7717": {
+            "group": "macro",
+            "key": "QK_MACRO_23",
+            "aliases": [
+                "MC_23"
+            ]
+        },
+        "0x7718": {
+            "group": "macro",
+            "key": "QK_MACRO_24",
+            "aliases": [
+                "MC_24"
+            ]
+        },
+        "0x7719": {
+            "group": "macro",
+            "key": "QK_MACRO_25",
+            "aliases": [
+                "MC_25"
+            ]
+        },
+        "0x771A": {
+            "group": "macro",
+            "key": "QK_MACRO_26",
+            "aliases": [
+                "MC_26"
+            ]
+        },
+        "0x771B": {
+            "group": "macro",
+            "key": "QK_MACRO_27",
+            "aliases": [
+                "MC_27"
+            ]
+        },
+        "0x771C": {
+            "group": "macro",
+            "key": "QK_MACRO_28",
+            "aliases": [
+                "MC_28"
+            ]
+        },
+        "0x771D": {
+            "group": "macro",
+            "key": "QK_MACRO_29",
+            "aliases": [
+                "MC_29"
+            ]
+        },
+        "0x771E": {
+            "group": "macro",
+            "key": "QK_MACRO_30",
+            "aliases": [
+                "MC_30"
+            ]
+        },
+        "0x771F": {
+            "group": "macro",
+            "key": "QK_MACRO_31",
+            "aliases": [
+                "MC_31"
+            ]
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_magic.hjson

@@ -0,0 +1,249 @@
+{
+    "keycodes": {
+        "0x7000": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_CONTROL_CAPSLOCK",
+            "aliases": [
+                "CL_SWAP"
+            ]
+        },
+        "0x7001": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_CONTROL_CAPSLOCK",
+            "aliases": [
+                "CL_NORM"
+            ]
+        },
+        "0x7002": {
+            "group": "magic",
+            "key": "MAGIC_TOGGLE_CONTROL_CAPSLOCK",
+            "aliases": [
+                "CL_TOGG"
+            ]
+        },
+        "0x7003": {
+            "group": "magic",
+            "key": "MAGIC_UNCAPSLOCK_TO_CONTROL",
+            "aliases": [
+                "CL_CAPS"
+            ]
+        },
+        "0x7004": {
+            "group": "magic",
+            "key": "MAGIC_CAPSLOCK_TO_CONTROL",
+            "aliases": [
+                "CL_CTRL"
+            ]
+        },
+        "0x7005": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_LALT_LGUI",
+            "aliases": [
+                "LAG_SWP"
+            ]
+        },
+        "0x7006": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_LALT_LGUI",
+            "aliases": [
+                "LAG_NRM"
+            ]
+        },
+        "0x7007": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_RALT_RGUI",
+            "aliases": [
+                "RAG_SWP"
+            ]
+        },
+        "0x7008": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_RALT_RGUI",
+            "aliases": [
+                "RAG_NRM"
+            ]
+        },
+        "0x7009": {
+            "group": "magic",
+            "key": "MAGIC_UNNO_GUI",
+            "aliases": [
+                "GUI_ON"
+            ]
+        },
+        "0x700A": {
+            "group": "magic",
+            "key": "MAGIC_NO_GUI",
+            "aliases": [
+                "GUI_OFF"
+            ]
+        },
+        "0x700B": {
+            "group": "magic",
+            "key": "MAGIC_TOGGLE_GUI",
+            "aliases": [
+                "GUI_TOG"
+            ]
+        },
+        "0x700C": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_GRAVE_ESC",
+            "aliases": [
+                "GE_SWAP"
+            ]
+        },
+        "0x700D": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_GRAVE_ESC",
+            "aliases": [
+                "GE_NORM"
+            ]
+        },
+        "0x700E": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_BACKSLASH_BACKSPACE",
+            "aliases": [
+                "BS_SWAP"
+            ]
+        },
+        "0x700F": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_BACKSLASH_BACKSPACE",
+            "aliases": [
+                "BS_NORM"
+            ]
+        },
+        "0x7010": {
+            "group": "magic",
+            "key": "MAGIC_TOGGLE_BACKSLASH_BACKSPACE",
+            "aliases": [
+                "BS_TOGG"
+            ]
+        },
+        "0x7011": {
+            "group": "magic",
+            "key": "MAGIC_HOST_NKRO",
+            "aliases": [
+                "NK_ON"
+            ]
+        },
+        "0x7012": {
+            "group": "magic",
+            "key": "MAGIC_UNHOST_NKRO",
+            "aliases": [
+                "NK_OFF"
+            ]
+        },
+        "0x7013": {
+            "group": "magic",
+            "key": "MAGIC_TOGGLE_NKRO",
+            "aliases": [
+                "NK_TOGG"
+            ]
+        },
+        "0x7014": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_ALT_GUI",
+            "aliases": [
+                "AG_SWAP"
+            ]
+        },
+        "0x7015": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_ALT_GUI",
+            "aliases": [
+                "AG_NORM"
+            ]
+        },
+        "0x7016": {
+            "group": "magic",
+            "key": "MAGIC_TOGGLE_ALT_GUI",
+            "aliases": [
+                "AG_TOGG"
+            ]
+        },
+        "0x7017": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_LCTL_LGUI",
+            "aliases": [
+                "LCG_SWP"
+            ]
+        },
+        "0x7018": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_LCTL_LGUI",
+            "aliases": [
+                "LCG_NRM"
+            ]
+        },
+        "0x7019": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_RCTL_RGUI",
+            "aliases": [
+                "RCG_SWP"
+            ]
+        },
+        "0x701A": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_RCTL_RGUI",
+            "aliases": [
+                "RCG_NRM"
+            ]
+        },
+        "0x701B": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_CTL_GUI",
+            "aliases": [
+                "CG_SWAP"
+            ]
+        },
+        "0x701C": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_CTL_GUI",
+            "aliases": [
+                "CG_NORM"
+            ]
+        },
+        "0x701D": {
+            "group": "magic",
+            "key": "MAGIC_TOGGLE_CTL_GUI",
+            "aliases": [
+                "CG_TOGG"
+            ]
+        },
+        "0x701E": {
+            "group": "magic",
+            "key": "MAGIC_EE_HANDS_LEFT",
+            "aliases": [
+                "EH_LEFT"
+            ]
+        },
+        "0x701F": {
+            "group": "magic",
+            "key": "MAGIC_EE_HANDS_RIGHT",
+            "aliases": [
+                "EH_RGHT"
+            ]
+        },
+        "0x7020": {
+            "group": "magic",
+            "key": "MAGIC_SWAP_ESCAPE_CAPSLOCK",
+            "aliases": [
+                "EC_SWAP"
+            ]
+        },
+        "0x7021": {
+            "group": "magic",
+            "key": "MAGIC_UNSWAP_ESCAPE_CAPSLOCK",
+            "aliases": [
+                "EC_NORM"
+            ]
+        },
+        "0x7022": {
+            "group": "magic",
+            "key": "MAGIC_TOGGLE_ESCAPE_CAPSLOCK",
+            "aliases": [
+                "EC_TOGG"
+            ]
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_programmable_button.hjson

@@ -0,0 +1,228 @@
+{
+    "keycodes": {
+        "0x7440": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_1",
+            "aliases": [
+                "PB_1"
+            ]
+        },
+        "0x7441": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_2",
+            "aliases": [
+                "PB_2"
+            ]
+        },
+        "0x7442": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_3",
+            "aliases": [
+                "PB_3"
+            ]
+        },
+        "0x7443": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_4",
+            "aliases": [
+                "PB_4"
+            ]
+        },
+        "0x7444": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_5",
+            "aliases": [
+                "PB_5"
+            ]
+        },
+        "0x7445": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_6",
+            "aliases": [
+                "PB_6"
+            ]
+        },
+        "0x7446": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_7",
+            "aliases": [
+                "PB_7"
+            ]
+        },
+        "0x7447": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_8",
+            "aliases": [
+                "PB_8"
+            ]
+        },
+        "0x7448": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_9",
+            "aliases": [
+                "PB_9"
+            ]
+        },
+        "0x7449": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_10",
+            "aliases": [
+                "PB_10"
+            ]
+        },
+        "0x744A": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_11",
+            "aliases": [
+                "PB_11"
+            ]
+        },
+        "0x744B": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_12",
+            "aliases": [
+                "PB_12"
+            ]
+        },
+        "0x744C": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_13",
+            "aliases": [
+                "PB_13"
+            ]
+        },
+        "0x744D": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_14",
+            "aliases": [
+                "PB_14"
+            ]
+        },
+        "0x744E": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_15",
+            "aliases": [
+                "PB_15"
+            ]
+        },
+        "0x744F": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_16",
+            "aliases": [
+                "PB_16"
+            ]
+        },
+        "0x7450": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_17",
+            "aliases": [
+                "PB_17"
+            ]
+        },
+        "0x7451": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_18",
+            "aliases": [
+                "PB_18"
+            ]
+        },
+        "0x7452": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_19",
+            "aliases": [
+                "PB_19"
+            ]
+        },
+        "0x7453": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_20",
+            "aliases": [
+                "PB_20"
+            ]
+        },
+        "0x7454": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_21",
+            "aliases": [
+                "PB_21"
+            ]
+        },
+        "0x7455": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_22",
+            "aliases": [
+                "PB_22"
+            ]
+        },
+        "0x7456": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_23",
+            "aliases": [
+                "PB_23"
+            ]
+        },
+        "0x7457": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_24",
+            "aliases": [
+                "PB_24"
+            ]
+        },
+        "0x7458": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_25",
+            "aliases": [
+                "PB_25"
+            ]
+        },
+        "0x7459": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_26",
+            "aliases": [
+                "PB_26"
+            ]
+        },
+        "0x745A": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_27",
+            "aliases": [
+                "PB_27"
+            ]
+        },
+        "0x745B": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_28",
+            "aliases": [
+                "PB_28"
+            ]
+        },
+        "0x745C": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_29",
+            "aliases": [
+                "PB_29"
+            ]
+        },
+        "0x745D": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_30",
+            "aliases": [
+                "PB_30"
+            ]
+        },
+        "0x745E": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_31",
+            "aliases": [
+                "PB_31"
+            ]
+        },
+        "0x745F": {
+            "group": "programmable_button",
+            "key": "QK_PROGRAMMABLE_BUTTON_32",
+            "aliases": [
+                "PB_32"
+            ]
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_quantum.hjson

@@ -0,0 +1,512 @@
+{
+    "keycodes": {
+        "0x7C00": {
+            "group": "quantum",
+            "key": "QK_BOOTLOADER",
+            "aliases": [
+                "QK_BOOT"
+            ]
+        },
+        "0x7C01": {
+            "group": "quantum",
+            "key": "QK_REBOOT",
+            "aliases": [
+                "QK_RBT"
+            ]
+        },
+        "0x7C02": {
+            "group": "quantum",
+            "key": "QK_DEBUG_TOGGLE",
+            "aliases": [
+                "DB_TOGG"
+            ]
+        },
+        "0x7C03": {
+            "group": "quantum",
+            "key": "QK_CLEAR_EEPROM",
+            "aliases": [
+                "EE_CLR"
+            ]
+        },
+        "0x7C04": {
+            "group": "quantum",
+            "key": "QK_MAKE"
+        },
+
+        "0x7C10": {
+            "group": "quantum",
+            "key": "QK_AUTO_SHIFT_DOWN",
+            "aliases": [
+                "AS_DOWN"
+            ]
+        },
+        "0x7C11": {
+            "group": "quantum",
+            "key": "QK_AUTO_SHIFT_UP",
+            "aliases": [
+                "AS_UP"
+            ]
+        },
+        "0x7C12": {
+            "group": "quantum",
+            "key": "QK_AUTO_SHIFT_REPORT",
+            "aliases": [
+                "AS_RPT"
+            ]
+        },
+        "0x7C13": {
+            "group": "quantum",
+            "key": "QK_AUTO_SHIFT_ON",
+            "aliases": [
+                "AS_ON"
+            ]
+        },
+        "0x7C14": {
+            "group": "quantum",
+            "key": "QK_AUTO_SHIFT_OFF",
+            "aliases": [
+                "AS_OFF"
+            ]
+        },
+        "0x7C15": {
+            "group": "quantum",
+            "key": "QK_AUTO_SHIFT_TOGGLE",
+            "aliases": [
+                "AS_TOGG"
+            ]
+        },
+
+        "0x7C16": {
+            "group": "quantum",
+            "key": "QK_GRAVE_ESCAPE",
+            "aliases": [
+                "QK_GESC"
+            ]
+        },
+
+        "0x7C17": {
+            "group": "quantum",
+            "key": "QK_VELOCIKEY_TOGGLE",
+            "aliases": [
+                "VK_TOGG"
+            ]
+        },
+
+        "0x7C18": {
+            "group": "quantum",
+            "key": "QK_SPACE_CADET_LEFT_CTRL_PARENTHESIS_OPEN",
+            "aliases": [
+                "SC_LCPO"
+            ]
+        },
+        "0x7C19": {
+            "group": "quantum",
+            "key": "QK_SPACE_CADET_RIGHT_CTRL_PARENTHESIS_CLOSE",
+            "aliases": [
+                "SC_RCPC"
+            ]
+        },
+        "0x7C1A": {
+            "group": "quantum",
+            "key": "QK_SPACE_CADET_LEFT_SHIFT_PARENTHESIS_OPEN",
+            "aliases": [
+                "SC_LSPO"
+            ]
+        },
+        "0x7C1B": {
+            "group": "quantum",
+            "key": "QK_SPACE_CADET_RIGHT_SHIFT_PARENTHESIS_CLOSE",
+            "aliases": [
+                "SC_RSPC"
+            ]
+        },
+        "0x7C1C": {
+            "group": "quantum",
+            "key": "QK_SPACE_CADET_LEFT_ALT_PARENTHESIS_OPEN",
+            "aliases": [
+                "SC_LAPO"
+            ]
+        },
+        "0x7C1D": {
+            "group": "quantum",
+            "key": "QK_SPACE_CADET_RIGHT_ALT_PARENTHESIS_CLOSE",
+            "aliases": [
+                "SC_RAPC"
+            ]
+        },
+        "0x7C1E": {
+            "group": "quantum",
+            "key": "QK_SPACE_CADET_RIGHT_SHIFT_ENTER",
+            "aliases": [
+                "SC_SENT"
+            ]
+        },
+
+        "0x7C20": {
+            "group": "quantum",
+            "key": "QK_OUTPUT_AUTO",
+            "aliases": [
+                "OU_AUTO"
+            ]
+        },
+        "0x7C21": {
+            "group": "quantum",
+            "key": "QK_OUTPUT_USB",
+            "aliases": [
+                "OU_USB"
+            ]
+        },
+        "0x7C22": {
+            "group": "quantum",
+            "key": "QK_OUTPUT_BLUETOOTH",
+            "aliases": [
+                "OU_BT"
+            ]
+        },
+
+        "0x7C30": {
+            "group": "quantum",
+            "key": "QK_UNICODE_MODE_NEXT",
+            "aliases": [
+                "UC_NEXT"
+            ]
+        },
+        "0x7C31": {
+            "group": "quantum",
+            "key": "QK_UNICODE_MODE_PREVIOUS",
+            "aliases": [
+                "UC_PREV"
+            ]
+        },
+        "0x7C32": {
+            "group": "quantum",
+            "key": "QK_UNICODE_MODE_MACOS",
+            "aliases": [
+                "UC_MAC"
+            ]
+        },
+        "0x7C33": {
+            "group": "quantum",
+            "key": "QK_UNICODE_MODE_LINUX",
+            "aliases": [
+                "UC_LINX"
+            ]
+        },
+        "0x7C34": {
+            "group": "quantum",
+            "key": "QK_UNICODE_MODE_WINDOWS",
+            "aliases": [
+                "UC_WIN"
+            ]
+        },
+        "0x7C35": {
+            "group": "quantum",
+            "key": "QK_UNICODE_MODE_BSD",
+            "aliases": [
+                "UC_BSD"
+            ]
+        },
+        "0x7C36": {
+            "group": "quantum",
+            "key": "QK_UNICODE_MODE_WINCOMPOSE",
+            "aliases": [
+                "UC_WINC"
+            ]
+        },
+        "0x7C37": {
+            "group": "quantum",
+            "key": "QK_UNICODE_MODE_EMACS",
+            "aliases": [
+                "UC_EMAC"
+            ]
+        },
+
+        "0x7C40": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_ON",
+            "aliases": [
+                "HF_ON"
+            ]
+        },
+        "0x7C41": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_OFF",
+            "aliases": [
+                "HF_OFF"
+            ]
+        },
+        "0x7C42": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_TOGGLE",
+            "aliases": [
+                "HF_TOGG"
+            ]
+        },
+        "0x7C43": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_RESET",
+            "aliases": [
+                "HF_RST"
+            ]
+        },
+        "0x7C44": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_FEEDBACK_TOGGLE",
+            "aliases": [
+                "HF_FDBK"
+            ]
+        },
+        "0x7C45": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_BUZZ_TOGGLE",
+            "aliases": [
+                "HF_BUZZ"
+            ]
+        },
+        "0x7C46": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_MODE_NEXT",
+            "aliases": [
+                "HF_NEXT"
+            ]
+        },
+        "0x7C47": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_MODE_PREVIOUS",
+            "aliases": [
+                "HF_PREV"
+            ]
+        },
+        "0x7C48": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_CONTINUOUS_TOGGLE",
+            "aliases": [
+                "HF_CONT"
+            ]
+        },
+        "0x7C49": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_CONTINUOUS_UP",
+            "aliases": [
+                "HF_CONU"
+            ]
+        },
+        "0x7C4A": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_CONTINUOUS_DOWN",
+            "aliases": [
+                "HF_COND"
+            ]
+        },
+        "0x7C4B": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_DWELL_UP",
+            "aliases": [
+                "HF_DWLU"
+            ]
+        },
+        "0x7C4C": {
+            "group": "quantum",
+            "key": "QK_HAPTIC_DWELL_DOWN",
+            "aliases": [
+                "HF_DWLD"
+            ]
+        },
+
+        "0x7C50": {
+            "group": "quantum",
+            "key": "QK_COMBO_ON",
+            "aliases": [
+                "CM_ON"
+            ]
+        },
+        "0x7C51": {
+            "group": "quantum",
+            "key": "QK_COMBO_OFF",
+            "aliases": [
+                "CM_OFF"
+            ]
+        },
+        "0x7C52": {
+            "group": "quantum",
+            "key": "QK_COMBO_TOGGLE",
+            "aliases": [
+                "CM_TOGG"
+            ]
+        },
+
+        "0x7C53": {
+            "group": "quantum",
+            "key": "QK_DYNAMIC_MACRO_RECORD_START_1",
+            "aliases": [
+                "DM_REC1"
+            ]
+        },
+        "0x7C54": {
+            "group": "quantum",
+            "key": "QK_DYNAMIC_MACRO_RECORD_START_2",
+            "aliases": [
+                "DM_REC2"
+            ]
+        },
+        "0x7C55": {
+            "group": "quantum",
+            "key": "QK_DYNAMIC_MACRO_RECORD_STOP",
+            "aliases": [
+                "DM_RSTP"
+            ]
+        },
+        "0x7C56": {
+            "group": "quantum",
+            "key": "QK_DYNAMIC_MACRO_PLAY_1",
+            "aliases": [
+                "DM_PLY1"
+            ]
+        },
+        "0x7C57": {
+            "group": "quantum",
+            "key": "QK_DYNAMIC_MACRO_PLAY_2",
+            "aliases": [
+                "DM_PLY2"
+            ]
+        },
+
+        "0x7C58": {
+            "group": "quantum",
+            "key": "QK_LEADER",
+            "aliases": [
+                "QK_LEAD"
+            ]
+        },
+
+        "0x7C59": {
+            "group": "quantum",
+            "key": "QK_LOCK"
+        },
+
+        "0x7C5A": {
+            "group": "quantum",
+            "key": "QK_ONE_SHOT_ON",
+            "aliases": [
+                "OS_ON"
+            ]
+        },
+        "0x7C5B": {
+            "group": "quantum",
+            "key": "QK_ONE_SHOT_OFF",
+            "aliases": [
+                "OS_OFF"
+            ]
+        },
+        "0x7C5C": {
+            "group": "quantum",
+            "key": "QK_ONE_SHOT_TOGGLE",
+            "aliases": [
+                "OS_TOGG"
+            ]
+        },
+
+        "0x7C5D": {
+            "group": "quantum",
+            "key": "QK_KEY_OVERRIDE_TOGGLE",
+            "aliases": [
+                "KO_TOGG"
+            ]
+        },
+        "0x7C5E": {
+            "group": "quantum",
+            "key": "QK_KEY_OVERRIDE_ON",
+            "aliases": [
+                "KO_ON"
+            ]
+        },
+        "0x7C5F": {
+            "group": "quantum",
+            "key": "QK_KEY_OVERRIDE_OFF",
+            "aliases": [
+                "KO_OFF"
+            ]
+        },
+
+        "0x7C60": {
+            "group": "quantum",
+            "key": "QK_SECURE_LOCK",
+            "aliases": [
+                "SE_LOCK"
+            ]
+        },
+        "0x7C61": {
+            "group": "quantum",
+            "key": "QK_SECURE_UNLOCK",
+            "aliases": [
+                "SE_UNLK"
+            ]
+        },
+        "0x7C62": {
+            "group": "quantum",
+            "key": "QK_SECURE_TOGGLE",
+            "aliases": [
+                "SE_TOGG"
+            ]
+        },
+        "0x7C63": {
+            "group": "quantum",
+            "key": "QK_SECURE_REQUEST",
+            "aliases": [
+                "SE_REQ"
+            ]
+        },
+
+        "0x7C70": {
+            "group": "quantum",
+            "key": "QK_DYNAMIC_TAPPING_TERM_PRINT",
+            "aliases": [
+                "DT_PRNT"
+            ]
+        },
+        "0x7C71": {
+            "group": "quantum",
+            "key": "QK_DYNAMIC_TAPPING_TERM_UP",
+            "aliases": [
+                "DT_UP"
+            ]
+        },
+        "0x7C72": {
+            "group": "quantum",
+            "key": "QK_DYNAMIC_TAPPING_TERM_DOWN",
+            "aliases": [
+                "DT_DOWN"
+            ]
+        },
+
+        "0x7C73": {
+            "group": "quantum",
+            "key": "QK_CAPS_WORD_TOGGLE",
+            "aliases": [
+                "CW_TOGG"
+            ]
+        },
+
+        "0x7C74": {
+            "group": "quantum",
+            "key": "QK_AUTOCORRECT_ON",
+            "aliases": [
+                "AC_ON"
+            ]
+        },
+        "0x7C75": {
+            "group": "quantum",
+            "key": "QK_AUTOCORRECT_OFF",
+            "aliases": [
+                "AC_OFF"
+            ]
+        },
+        "0x7C76": {
+            "group": "quantum",
+            "key": "QK_AUTOCORRECT_TOGGLE",
+            "aliases": [
+                "AC_TOGG"
+            ]
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_sequencer.hjson

@@ -0,0 +1,40 @@
+{
+    "keycodes": {
+        "0x7200": {
+            "group": "sequencer",
+            "key": "SQ_ON"
+        },
+        "0x7201": {
+            "group": "sequencer",
+            "key": "SQ_OFF"
+        },
+        "0x7202": {
+            "group": "sequencer",
+            "key": "SQ_TOG"
+        },
+        "0x7203": {
+            "group": "sequencer",
+            "key": "SQ_TMPD"
+        },
+        "0x7204": {
+            "group": "sequencer",
+            "key": "SQ_TMPU"
+        },
+        "0x7205": {
+            "group": "sequencer",
+            "key": "SQ_RESD"
+        },
+        "0x7206": {
+            "group": "sequencer",
+            "key": "SQ_RESU"
+        },
+        "0x7207": {
+            "group": "sequencer",
+            "key": "SQ_SALL"
+        },
+        "0x7208": {
+            "group": "sequencer",
+            "key": "SQ_SCLR"
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_steno.hjson

@@ -0,0 +1,20 @@
+{
+    "keycodes": {
+        "0x74F0": {
+            "group": "steno",
+            "key": "QK_STENO_BOLT"
+        },
+        "0x74F1": {
+            "group": "steno",
+            "key": "QK_STENO_GEMINI"
+        },
+        "0x74F2": {
+            "group": "steno",
+            "key": "QK_STENO_COMB"
+        },
+        "0x74FC": {
+            "group": "steno",
+            "key": "QK_STENO_COMB_MAX"
+        }
+    }
+}

data/constants/keycodes/keycodes_0.0.1_swap_hands.hjson

@@ -0,0 +1,32 @@
+{
+    "keycodes": {
+        "0x56F0": {
+            "group": "swap_hands",
+            "key": "SH_TG"
+        },
+        "0x56F1": {
+            "group": "swap_hands",
+            "key": "SH_TT"
+        },
+        "0x56F2": {
+            "group": "swap_hands",
+            "key": "SH_MON"
+        },
+        "0x56F3": {
+            "group": "swap_hands",
+            "key": "SH_MOFF"
+        },
+        "0x56F4": {
+            "group": "swap_hands",
+            "key": "SH_OFF"
+        },
+        "0x56F5": {
+            "group": "swap_hands",
+            "key": "SH_ON"
+        },
+        "0x56F6": {
+            "group": "swap_hands",
+            "key": "SH_OS"
+        }
+    }
+}

data/mappings/defaults.hjson

@@ -0,0 +1,77 @@
+{
+    "development_board": {
+        "promicro": {
+            "processor": "atmega32u4",
+            "bootloader": "caterina",
+            "pin_compatible": "promicro"
+        },
+        "elite_c": {
+            "processor": "atmega32u4",
+            "bootloader": "atmel-dfu",
+            "pin_compatible": "promicro"
+        },
+        "elite_pi": {
+            "processor": "RP2040",
+            "bootloader": "rp2040",
+            "board": "QMK_PM2040",
+            "pin_compatible": "promicro"
+        },
+        "proton_c": {
+            "processor": "STM32F303",
+            "bootloader": "stm32-dfu",
+            "board": "QMK_PROTON_C",
+            "pin_compatible": "promicro"
+        },
+        "kb2040": {
+            "processor": "RP2040",
+            "bootloader": "rp2040",
+            "board": "QMK_PM2040",
+            "pin_compatible": "promicro"
+        },
+        "promicro_rp2040": {
+            "processor": "RP2040",
+            "bootloader": "rp2040",
+            "board": "QMK_PM2040",
+            "pin_compatible": "promicro"
+        },
+        "blok": {
+            "processor": "RP2040",
+            "bootloader": "rp2040",
+            "board": "QMK_PM2040",
+            "pin_compatible": "promicro"
+        },
+        "bit_c_pro": {
+            "processor": "RP2040",
+            "bootloader": "rp2040",
+            "board": "QMK_PM2040",
+            "pin_compatible": "promicro"
+        },
+        "bluepill": {
+            "processor": "STM32F103",
+            "bootloader": "stm32duino",
+            "board": "STM32_F103_STM32DUINO"
+        },
+        "blackpill_f401": {
+            "processor": "STM32F401",
+            "bootloader": "stm32-dfu",
+            "board": "BLACKPILL_STM32_F401"
+        },
+        "blackpill_f411": {
+            "processor": "STM32F411",
+            "bootloader": "stm32-dfu",
+            "board": "BLACKPILL_STM32_F411"
+        },
+        "stemcell": {
+            "processor": "STM32F411",
+            "bootloader": "tinyuf2",
+            "board": "STEMCELL",
+            "pin_compatible": "promicro"
+        },
+        "bonsai_c4": {
+            "processor": "STM32F411",
+            "bootloader": "stm32-dfu",
+            "board": "BONSAI_C4",
+            "pin_compatible": "promicro"
+        }
+    }
+}

data/mappings/info_config.hjson

@@ -0,0 +1,134 @@
+// This file maps keys between `config.h` and `info.json`. It is used by QMK
+// to correctly and consistently map back and forth between the two systems.
+{
+    // Format:
+    // <config.h key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
+    // value_type: one of "array", "array.int", "bool", "int", "hex", "list", "mapping", "str", "raw"
+    // to_json: Default `true`. Set to `false` to exclude this mapping from info.json
+    // to_c: Default `true`. Set to `false` to exclude this mapping from config.h
+    // warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
+    // deprecated: Default `false`. Set to `true` to turn on warning when a value exists
+    // invalid: Default `false`. Set to `true` to generate errors when a value exists
+    // replace_with: use with a key marked deprecated or invalid to designate a replacement
+    "AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "bool"},
+    "BACKLIGHT_BREATHING": {"info_key": "backlight.breathing", "value_type": "bool"},
+    "BREATHING_PERIOD": {"info_key": "backlight.breathing_period", "value_type": "int"},
+    "BACKLIGHT_LEVELS": {"info_key": "backlight.levels", "value_type": "int"},
+    "BACKLIGHT_LIMIT_VAL": {"info_key": "backlight.max_brightness", "value_type": "int"},
+    "BACKLIGHT_ON_STATE": {"info_key": "backlight.on_state", "value_type": "int"},
+    "BACKLIGHT_PIN": {"info_key": "backlight.pin"},
+    "BACKLIGHT_PINS": {"info_key": "backlight.pins", "value_type": "array"},
+    "BOTH_SHIFTS_TURNS_ON_CAPS_WORD": {"info_key": "caps_word.both_shifts_turns_on", "value_type": "bool"},
+    "CAPS_WORD_IDLE_TIMEOUT": {"info_key": "caps_word.idle_timeout", "value_type": "int"},
+    "COMBO_COUNT": {"info_key": "combo.count", "value_type": "int"},
+    "COMBO_TERM": {"info_key": "combo.term", "value_type": "int"},
+    "DEBOUNCE": {"info_key": "debounce", "value_type": "int"},
+    "DIODE_DIRECTION": {"info_key": "diode_direction"},
+    "DOUBLE_TAP_SHIFT_TURNS_ON_CAPS_WORD": {"info_key": "caps_word.double_tap_shift_turns_on", "value_type": "bool"},
+    "FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "bool"},
+    "DYNAMIC_KEYMAP_EEPROM_MAX_ADDR": {"info_key": "dynamic_keymap.eeprom_max_addr", "value_type": "int"},
+    "DYNAMIC_KEYMAP_LAYER_COUNT": {"info_key": "dynamic_keymap.layer_count", "value_type": "int"},
+    "IGNORE_MOD_TAP_INTERRUPT": {"info_key": "tapping.ignore_mod_tap_interrupt", "value_type": "bool"},
+    "IGNORE_MOD_TAP_INTERRUPT_PER_KEY": {"info_key": "tapping.ignore_mod_tap_interrupt_per_key", "value_type": "bool"},
+    "HOLD_ON_OTHER_KEY_PRESS": {"info_key": "tapping.hold_on_other_key_press", "value_type": "bool"},
+    "HOLD_ON_OTHER_KEY_PRESS_PER_KEY": {"info_key": "tapping.hold_on_other_key_press_per_key", "value_type": "bool"},
+    "LAYOUTS": {"info_key": "layout_aliases", "value_type": "mapping"},
+    "LEADER_PER_KEY_TIMING": {"info_key": "leader_key.timing", "value_type": "bool"},
+    "LEADER_KEY_STRICT_KEY_PROCESSING": {"info_key": "leader_key.strict_processing", "value_type": "bool"},
+    "LEADER_TIMEOUT": {"info_key": "leader_key.timeout", "value_type": "int"},
+    "LED_CAPS_LOCK_PIN": {"info_key": "indicators.caps_lock"},
+    "LED_NUM_LOCK_PIN": {"info_key": "indicators.num_lock"},
+    "LED_SCROLL_LOCK_PIN": {"info_key": "indicators.scroll_lock"},
+    "LED_COMPOSE_PIN": {"info_key": "indicators.compose"},
+    "LED_KANA_PIN": {"info_key": "indicators.kana"},
+    "LED_PIN_ON_STATE": {"info_key": "indicators.on_state", "value_type": "int"},
+    "LED_MATRIX_CENTER": {"info_key": "led_matrix.center_point", "value_type": "array.int"},
+    "LED_MATRIX_MAXIMUM_BRIGHTNESS": {"info_key": "led_matrix.max_brightness", "value_type": "int"},
+    "LED_MATRIX_SPLIT": {"info_key": "led_matrix.split_count", "value_type": "array.int"},
+    "LED_MATRIX_TIMEOUT": {"info_key": "led_matrix.timeout", "value_type": "int"},
+    "LED_MATRIX_HUE_STEP": {"info_key": "led_matrix.hue_steps", "value_type": "int"},
+    "LED_MATRIX_SAT_STEP": {"info_key": "led_matrix.sat_steps", "value_type": "int"},
+    "LED_MATRIX_VAL_STEP": {"info_key": "led_matrix.val_steps", "value_type": "int"},
+    "LED_MATRIX_SPD_STEP": {"info_key": "led_matrix.speed_steps", "value_type": "int"},
+    "MATRIX_HAS_GHOST": {"info_key": "matrix_pins.ghost", "value_type": "bool"},
+    "MATRIX_IO_DELAY": {"info_key": "matrix_pins.io_delay", "value_type": "int"},
+    "MOUSEKEY_DELAY": {"info_key": "mousekey.delay", "value_type": "int"},
+    "MOUSEKEY_INTERVAL": {"info_key": "mousekey.interval", "value_type": "int"},
+    "MOUSEKEY_MAX_SPEED": {"info_key": "mousekey.max_speed", "value_type": "int"},
+    "MOUSEKEY_TIME_TO_MAX": {"info_key": "mousekey.time_to_max", "value_type": "int"},
+    "MOUSEKEY_WHEEL_DELAY": {"info_key": "mousekey.wheel_delay", "value_type": "int"},
+    "ONESHOT_TIMEOUT": {"info_key": "oneshot.timeout", "value_type": "int"},
+    "ONESHOT_TAP_TOGGLE": {"info_key": "oneshot.tap_toggle", "value_type": "int"},
+    "PERMISSIVE_HOLD": {"info_key": "tapping.permissive_hold", "value_type": "bool"},
+    "PERMISSIVE_HOLD_PER_KEY": {"info_key": "tapping.permissive_hold_per_key", "value_type": "bool"},
+    "PS2_CLOCK_PIN": {"info_key": "ps2.clock_pin"},
+    "PS2_DATA_PIN": {"info_key": "ps2.data_pin"},
+    "RETRO_TAPPING": {"info_key": "tapping.retro", "value_type": "bool"},
+    "RETRO_TAPPING_PER_KEY": {"info_key": "tapping.retro_per_key", "value_type": "bool"},
+    "RGB_DI_PIN": {"info_key": "rgblight.pin"},
+    "RGBLED_NUM": {"info_key": "rgblight.led_count", "value_type": "int"},
+    "RGBLED_SPLIT": {"info_key": "rgblight.split_count", "value_type": "array.int"},
+    "RGBLIGHT_LAYER_BLINK": {"info_key": "rgblight.layers.blink", "value_type": "bool"},
+    "RGBLIGHT_LAYERS": {"info_key": "rgblight.layers.enabled", "value_type": "bool"},
+    "RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF": {"info_key": "rgblight.layers.override_rgb", "value_type": "bool"},
+    "RGBLIGHT_LIMIT_VAL": {"info_key": "rgblight.max_brightness", "value_type": "int"},
+    "RGBLIGHT_MAX_LAYERS": {"info_key": "rgblight.layers.max", "value_type": "int"},
+    "RGBLIGHT_HUE_STEP": {"info_key": "rgblight.hue_steps", "value_type": "int"},
+    "RGBLIGHT_SAT_STEP": {"info_key": "rgblight.saturation_steps", "value_type": "int"},
+    "RGBLIGHT_VAL_STEP": {"info_key": "rgblight.brightness_steps", "value_type": "int"},
+    "RGBLIGHT_SLEEP": {"info_key": "rgblight.sleep", "value_type": "bool"},
+    "RGBLIGHT_SPLIT": {"info_key": "rgblight.split", "value_type": "bool"},
+    "RGB_MATRIX_CENTER": {"info_key": "rgb_matrix.center_point", "value_type": "array.int"},
+    "RGB_MATRIX_MAXIMUM_BRIGHTNESS": {"info_key": "rgb_matrix.max_brightness", "value_type": "int"},
+    "RGB_MATRIX_SPLIT": {"info_key": "rgb_matrix.split_count", "value_type": "array.int"},
+    "RGB_MATRIX_TIMEOUT": {"info_key": "rgb_matrix.timeout", "value_type": "int"},
+    "RGB_MATRIX_HUE_STEP": {"info_key": "rgb_matrix.hue_steps", "value_type": "int"},
+    "RGB_MATRIX_SAT_STEP": {"info_key": "rgb_matrix.sat_steps", "value_type": "int"},
+    "RGB_MATRIX_VAL_STEP": {"info_key": "rgb_matrix.val_steps", "value_type": "int"},
+    "RGB_MATRIX_SPD_STEP": {"info_key": "rgb_matrix.speed_steps", "value_type": "int"},
+    "RGBW": {"info_key": "rgblight.rgbw", "value_type": "bool"},
+    "QMK_ESC_OUTPUT": {"info_key": "qmk_lufa_bootloader.esc_output"},
+    "QMK_ESC_INPUT": {"info_key": "qmk_lufa_bootloader.esc_input"},
+    "QMK_LED": {"info_key": "qmk_lufa_bootloader.led"},
+    "QMK_SPEAKER": {"info_key": "qmk_lufa_bootloader.speaker"},
+    "SECURE_UNLOCK_SEQUENCE": {"info_key": "secure.unlock_sequence", "value_type": "array.array.int", "to_json": false},
+    "SECURE_UNLOCK_TIMEOUT": {"info_key": "secure.unlock_timeout", "value_type": "int"},
+    "SECURE_IDLE_TIMEOUT": {"info_key": "secure.idle_timeout", "value_type": "int"},
+    "SENDSTRING_BELL": {"info_key": "audio.macro_beep", "value_type": "bool"},
+    "SPLIT_MODS_ENABLE": {"info_key": "split.transport.sync_modifiers", "value_type": "bool"},
+    "SPLIT_TRANSPORT_MIRROR": {"info_key": "split.transport.sync_matrix_state", "value_type": "bool"},
+    "SPLIT_USB_DETECT": {"info_key": "split.usb_detect.enabled", "value_type": "bool"},
+    "SPLIT_USB_TIMEOUT": {"info_key": "split.usb_detect.timeout", "value_type": "int"},
+    "SPLIT_USB_TIMEOUT_POLL": {"info_key": "split.usb_detect.polling_interval", "value_type": "int"},
+    "SPLIT_WATCHDOG_ENABLE": {"info_key": "split.transport.watchdog", "value_type": "bool"},
+    "SPLIT_WATCHDOG_TIMEOUT": {"info_key": "split.transport.watchdog_timeout", "value_type": "int"},
+    "SOFT_SERIAL_PIN": {"info_key": "split.soft_serial_pin"},
+    "SOFT_SERIAL_SPEED": {"info_key": "split.soft_serial_speed"},
+    "TAP_CODE_DELAY": {"info_key": "qmk.tap_keycode_delay", "value_type": "int"},
+    "TAP_HOLD_CAPS_DELAY": {"info_key": "qmk.tap_capslock_delay", "value_type": "int"},
+    "TAPPING_FORCE_HOLD": {"info_key": "tapping.force_hold", "value_type": "bool"},
+    "TAPPING_FORCE_HOLD_PER_KEY": {"info_key": "tapping.force_hold_per_key", "value_type": "bool"},
+    "TAPPING_TERM": {"info_key": "tapping.term", "value_type": "int"},
+    "TAPPING_TERM_PER_KEY": {"info_key": "tapping.term_per_key", "value_type": "bool"},
+    "TAPPING_TOGGLE": {"info_key": "tapping.toggle", "value_type": "int"},
+    "USB_MAX_POWER_CONSUMPTION": {"info_key": "usb.max_power", "value_type": "int"},
+    "USB_POLLING_INTERVAL_MS": {"info_key": "usb.polling_interval", "value_type": "int"},
+    "USB_SUSPEND_WAKEUP_DELAY": {"info_key": "usb.suspend_wakeup_delay", "value_type": "int"},
+
+    // Items we want flagged in lint
+    "NO_ACTION_MACRO": {"info_key": "_invalid.no_action_macro", "invalid": true},
+    "NO_ACTION_FUNCTION": {"info_key": "_invalid.no_action_function", "invalid": true},
+    "DESCRIPTION": {"info_key": "_invalid.usb_description", "invalid": true},
+    "DEBOUNCING_DELAY": {"info_key": "_invalid.debouncing_delay", "invalid": true, "replace_with": "DEBOUNCE"},
+    "PREVENT_STUCK_MODIFIERS": {"info_key": "_invalid.prevent_stuck_mods", "invalid": true},
+    "UNUSED_PINS": {"info_key": "_invalid.unused_pins", "deprecated": true},
+    "RGBLIGHT_ANIMATIONS": {"info_key": "rgblight.animations.all", "value_type": "bool", "deprecated": true},
+    "QMK_KEYS_PER_SCAN": {"info_key": "qmk.keys_per_scan", "value_type": "int", "deprecated": true},
+
+    // USB params, need to mark as failure when specified in config.h, rather than deprecated
+    "PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.pid` in info.json"},
+    "VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.vid` in info.json"},
+    "PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false, "value_type": "str", "deprecated": true, "replace_with": "`keyboard_name` in info.json"},
+    "MANUFACTURER": {"info_key": "manufacturer", "value_type": "str", "deprecated": true, "replace_with": "`manufacturer` in info.json"},
+    "DEVICE_VER": {"info_key": "usb.device_version", "value_type": "bcd_version", "deprecated": true, "replace_with": "`usb.device_version` in info.json"}
+}

data/mappings/info_config.json

@@ -1,99 +0,0 @@
-# This file maps keys between `config.h` and `info.json`. It is used by QMK
-# to correctly and consistently map back and forth between the two systems.
-{
-    # Format:
-    # <config.h key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
-    # value_type: one of "array", "array.int", "bool", "int", "hex", "list", "mapping"
-    # to_json: Default `true`. Set to `false` to exclude this mapping from info.json
-    # to_c: Default `true`. Set to `false` to exclude this mapping from config.h
-    # warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
-    "AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "bool"},
-    "BACKLIGHT_BREATHING": {"info_key": "backlight.breathing", "value_type": "bool"},
-    "BREATHING_PERIOD": {"info_key": "backlight.breathing_period", "value_type": "int"},
-    "BACKLIGHT_PIN": {"info_key": "backlight.pin"},
-    "COMBO_COUNT": {"info_key": "combo.count", "value_type": "int"},
-    "COMBO_TERM": {"info_key": "combo.term", "value_type": "int"},
-    "DEBOUNCE": {"info_key": "debounce", "value_type": "int"},
-    "DEVICE_VER": {"info_key": "usb.device_ver", "value_type": "hex"},
-    # TODO: Replace ^^^ with vvv
-    #"DEVICE_VER": {"info_key": "usb.device_version", "value_type": "bcd_version"},
-    "DESCRIPTION": {"info_key": "keyboard_folder", "to_json": false},
-    "DIODE_DIRECTION": {"info_key": "diode_direction"},
-    "FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "bool"},
-    "DYNAMIC_KEYMAP_EEPROM_MAX_ADDR": {"info_key": "dynamic_keymap.eeprom_max_addr", "value_type": "int"},
-    "DYNAMIC_KEYMAP_LAYER_COUNT": {"info_key": "dynamic_keymap.layer_count", "value_type": "int"},
-    "IGNORE_MOD_TAP_INTERRUPT": {"info_key": "tapping.ignore_mod_tap_interrupt", "value_type": "bool"},
-    "IGNORE_MOD_TAP_INTERRUPT_PER_KEY": {"info_key": "tapping.ignore_mod_tap_interrupt_per_key", "value_type": "bool"},
-    "LAYOUTS": {"info_key": "layout_aliases", "value_type": "mapping"},
-    "LEADER_PER_KEY_TIMING": {"info_key": "leader_key.timing", "value_type": "bool"},
-    "LEADER_KEY_STRICT_KEY_PROCESSING": {"info_key": "leader_key.strict_processing", "value_type": "bool"},
-    "LEADER_TIMEOUT": {"info_key": "leader_key.timeout", "value_type": "int"},
-    "LED_CAPS_LOCK_PIN": {"info_key": "indicators.caps_lock"},
-    "LED_NUM_LOCK_PIN": {"info_key": "indicators.num_lock"},
-    "LED_SCROLL_LOCK_PIN": {"info_key": "indicators.scroll_lock"},
-    "MANUFACTURER": {"info_key": "manufacturer"},
-    "MATRIX_HAS_GHOST": {"info_key": "matrix_pins.ghost", "value_type": "bool"},
-    "MATRIX_IO_DELAY": {"info_key": "matrix_pins.io_delay", "value_type": "int"},
-    "MOUSEKEY_DELAY": {"info_key": "mousekey.delay", "value_type": "int"},
-    "MOUSEKEY_INTERVAL": {"info_key": "mousekey.interval", "value_type": "int"},
-    "MOUSEKEY_MAX_SPEED": {"info_key": "mousekey.max_speed", "value_type": "int"},
-    "MOUSEKEY_TIME_TO_MAX": {"info_key": "mousekey.time_to_max", "value_type": "int"},
-    "MOUSEKEY_WHEEL_DELAY": {"info_key": "mousekey.wheel_delay", "value_type": "int"},
-    "ONESHOT_TIMEOUT": {"info_key": "oneshot.timeout", "value_type": "int"},
-    "ONESHOT_TAP_TOGGLE": {"info_key": "oneshot.tap_toggle", "value_type": "int"},
-    "PERMISSIVE_HOLD": {"info_key": "tapping.permissive_hold", "value_type": "bool"},
-    "PERMISSIVE_HOLD_PER_KEY": {"info_key": "tapping.permissive_hold_per_key", "value_type": "bool"},
-    "RETRO_TAPPING": {"info_key": "tapping.retro", "value_type": "bool"},
-    "RETRO_TAPPING_PER_KEY": {"info_key": "tapping.retro_per_key", "value_type": "bool"},
-    "RGB_DI_PIN": {"info_key": "rgblight.pin"},
-    "RGBLED_NUM": {"info_key": "rgblight.led_count", "value_type": "int"},
-    "RGBLED_SPLIT": {"info_key": "rgblight.split_count", "value_type": "array.int"},
-    "RGBLIGHT_ANIMATIONS": {"info_key": "rgblight.animations.all", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_ALTERNATING": {"info_key": "rgblight.animations.alternating", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_BREATHING": {"info_key": "rgblight.animations.breathing", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_CHRISTMAS": {"info_key": "rgblight.animations.christmas", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_KNIGHT": {"info_key": "rgblight.animations.knight", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_RAINBOW_MOOD": {"info_key": "rgblight.animations.rainbow_mood", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_RAINBOW_SWIRL": {"info_key": "rgblight.animations.rainbow_swirl", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_RGB_TEST": {"info_key": "rgblight.animations.rgb_test", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_SNAKE": {"info_key": "rgblight.animations.snake", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_STATIC_GRADIENT": {"info_key": "rgblight.animations.static_gradient", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_TWINKLE": {"info_key": "rgblight.animations.twinkle"},
-    "RGBLIGHT_LAYER_BLINK": {"info_key": "rgblight.layers.blink", "value_type": "bool"},
-    "RGBLIGHT_LAYERS": {"info_key": "rgblight.layers.enabled", "value_type": "bool"},
-    "RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF": {"info_key": "rgblight.layers.override_rgb", "value_type": "bool"},
-    "RGBLIGHT_LIMIT_VAL": {"info_key": "rgblight.max_brightness", "value_type": "int"},
-    "RGBLIGHT_MAX_LAYERS": {"info_key": "rgblight.layers.max", "value_type": "int"},
-    "RGBLIGHT_HUE_STEP": {"info_key": "rgblight.hue_steps", "value_type": "int"},
-    "RGBLIGHT_SAT_STEP": {"info_key": "rgblight.saturation_steps", "value_type": "int"},
-    "RGBLIGHT_VAL_STEP": {"info_key": "rgblight.brightness_steps", "value_type": "int"},
-    "RGBLIGHT_SLEEP": {"info_key": "rgblight.sleep", "value_type": "bool"},
-    "RGBLIGHT_SPLIT": {"info_key": "rgblight.split", "value_type": "bool"},
-    "RGBW": {"info_key": "rgblight.rgbw", "value_type": "bool"},
-    "PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false},
-    "PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex"},
-    "VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex"},
-    "QMK_ESC_OUTPUT": {"info_key": "qmk_lufa_bootloader.esc_output"},
-    "QMK_ESC_INPUT": {"info_key": "qmk_lufa_bootloader.esc_input"},
-    "QMK_KEYS_PER_SCAN": {"info_key": "qmk.keys_per_scan", "value_type": "int"},
-    "QMK_LED": {"info_key": "qmk_lufa_bootloader.led"},
-    "QMK_SPEAKER": {"info_key": "qmk_lufa_bootloader.speaker"},
-    "SENDSTRING_BELL": {"info_key": "audio.macro_beep", "value_type": "bool"},
-    "SPLIT_MODS_ENABLE": {"info_key": "split.transport.sync_modifiers", "value_type": "bool"},
-    "SPLIT_TRANSPORT_MIRROR": {"info_key": "split.transport.sync_matrix_state", "value_type": "bool"},
-    "SPLIT_USB_DETECT": {"info_key": "split.usb_detect.enabled", "value_type": "bool"},
-    "SPLIT_USB_TIMEOUT": {"info_key": "split.usb_detect.timeout", "value_type": "int"},
-    "SPLIT_USB_TIMEOUT_POLL": {"info_key": "split.usb_detect.polling_interval", "value_type": "int"},
-    "SOFT_SERIAL_PIN": {"info_key": "split.soft_serial_pin"},
-    "SOFT_SERIAL_SPEED": {"info_key": "split.soft_serial_speed"},
-    "TAP_CODE_DELAY": {"info_key": "qmk.tap_keycode_delay", "value_type": "int"},
-    "TAP_HOLD_CAPS_DELAY": {"info_key": "qmk.tap_capslock_delay", "value_type": "int"},
-    "TAPPING_FORCE_HOLD": {"info_key": "tapping.force_hold", "value_type": "bool"},
-    "TAPPING_FORCE_HOLD_PER_KEY": {"info_key": "tapping.force_hold_per_key", "value_type": "bool"},
-    "TAPPING_TERM": {"info_key": "tapping.term", "value_type": "int"},
-    "TAPPING_TERM_PER_KEY": {"info_key": "tapping.term_per_key", "value_type": "bool"},
-    "TAPPING_TOGGLE": {"info_key": "tapping.toggle", "value_type": "int"},
-    "USB_MAX_POWER_CONSUMPTION": {"info_key": "usb.max_power", "value_type": "int"},
-    "USB_POLLING_INTERVAL_MS": {"info_key": "usb.polling_interval", "value_type": "int"},
-    "USB_SUSPEND_WAKEUP_DELAY": {"info_key": "usb.suspend_wakeup_delay", "value_type": "int"},
-}

data/mappings/info_rules.hjson

@@ -0,0 +1,44 @@
+// This file maps keys between `rules.mk` and `info.json`. It is used by QMK
+// to correctly and consistently map back and forth between the two systems.
+{
+    // Format:
+    // <rules.mk key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
+    // value_type: one of "array", "array.int", "bool", "int", "list", "hex", "mapping", "str", "raw"
+    // to_json: Default `true`. Set to `false` to exclude this mapping from info.json
+    // to_c: Default `true`. Set to `false` to exclude this mapping from rules.mk
+    // warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
+    // deprecated: Default `false`. Set to `true` to turn on warning when a value exists
+    // invalid: Default `false`. Set to `true` to generate errors when a value exists
+    // replace_with: use with a key marked deprecated or invalid to designate a replacement
+    "BOARD": {"info_key": "board"},
+    "BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false},
+    "BLUETOOTH_DRIVER": {"info_key": "bluetooth.driver"},
+    "CAPS_WORD_ENABLE": {"info_key": "caps_word.enabled", "value_type": "bool"},
+    "DEBOUNCE_TYPE": {"info_key": "build.debounce_type"},
+    "ENCODER_ENABLE": {"info_key": "encoder.enabled", "value_type": "bool"},
+    "FIRMWARE_FORMAT": {"info_key": "build.firmware_format"},
+    "KEYBOARD_SHARED_EP": {"info_key": "usb.shared_endpoint.keyboard", "value_type": "bool"},
+    "MOUSE_SHARED_EP": {"info_key": "usb.shared_endpoint.mouse", "value_type": "bool"},
+    "LAYOUTS": {"info_key": "community_layouts", "value_type": "list"},
+    "LED_MATRIX_DRIVER": {"info_key": "led_matrix.driver"},
+    "RGB_MATRIX_DRIVER": {"info_key": "rgb_matrix.driver"},
+    "LTO_ENABLE": {"info_key": "build.lto", "value_type": "bool"},
+    "MCU": {"info_key": "processor", "warn_duplicate": false},
+    "MOUSEKEY_ENABLE": {"info_key": "mouse_key.enabled", "value_type": "bool"},
+    "NO_USB_STARTUP_CHECK": {"info_key": "usb.no_startup_check", "value_type": "bool"},
+    "PIN_COMPATIBLE": {"info_key": "pin_compatible"},
+    "SECURE_ENABLE": {"info_key": "secure.enabled", "value_type": "bool"},
+    "SPLIT_KEYBOARD": {"info_key": "split.enabled", "value_type": "bool"},
+    "SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "to_c": false},
+    "WAIT_FOR_USB": {"info_key": "usb.wait_for", "value_type": "bool"},
+    "STENO_ENABLE": {"info_key": "stenography.enabled", "value_type": "bool"},
+    "STENO_PROTOCOL": {"info_key": "stenography.protocol"},
+    "PS2_ENABLE": {"info_key": "ps2.enabled", "value_type": "bool"},
+    "PS2_MOUSE_ENABLE": {"info_key": "ps2.mouse_enabled", "value_type": "bool"},
+    "PS2_DRIVER": {"info_key": "ps2.driver"},
+
+    // Items we want flagged in lint
+    "CTPC": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
+    "CONVERT_TO_PROTON_C": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
+    "VIAL_ENABLE": {"info_key": "_invalid.vial", "invalid": true}
+}

data/mappings/info_rules.json

@@ -1,25 +0,0 @@
-# This file maps keys between `rules.mk` and `info.json`. It is used by QMK
-# to correctly and consistently map back and forth between the two systems.
-{
-    # Format:
-    # <rules.mk key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
-    # value_type: one of "array", "array.int", "bool", "int", "list", "hex", "mapping"
-    # to_json: Default `true`. Set to `false` to exclude this mapping from info.json
-    # to_c: Default `true`. Set to `false` to exclude this mapping from rules.mk
-    # warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
-    "BOARD": {"info_key": "board"},
-    "BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false},
-    "BLUETOOTH": {"info_key": "bluetooth.driver"},
-    "FIRMWARE_FORMAT": {"info_key": "build.firmware_format"},
-    "KEYBOARD_SHARED_EP": {"info_key": "usb.shared_endpoint.keyboard", "value_type": "bool"},
-    "MOUSE_SHARED_EP": {"info_key": "usb.shared_endpoint.mouse", "value_type": "bool"},
-    "LAYOUTS": {"info_key": "community_layouts", "value_type": "list"},
-    "LED_MATRIX_DRIVER": {"info_key": "led_matrix.driver"},
-    "LTO_ENABLE": {"info_key": "build.lto", "value_type": "bool"},
-    "MCU": {"info_key": "processor", "warn_duplicate": false},
-    "MOUSEKEY_ENABLE": {"info_key": "mouse_key.enabled", "value_type": "bool"},
-    "NO_USB_STARTUP_CHECK": {"info_key": "usb.no_startup_check", "value_type": "bool"},
-    "SPLIT_KEYBOARD": {"info_key": "split.enabled", "value_type": "bool"},
-    "SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "value_type": "str", "to_c": false},
-    "WAIT_FOR_USB": {"info_key": "usb.wait_for", "value_type": "bool"}
-}

data/schemas/api_keyboard.jsonschema

@@ -9,7 +9,6 @@
                     "properties": {
                         "url": {"type": "string"}
                     }
-
                 },
                 "parse_errors": {"$ref": "qmk.definitions.v1#/string_array"},
                 "parse_warnings": {"$ref": "qmk.definitions.v1#/string_array"},

data/schemas/definitions.jsonschema

@@ -1,5 +1,5 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$schema": "https://json-schema.org/draft/2020-12/schema#",
     "$id": "qmk.definitions.v1",
     "title": "Common definitions used across QMK's jsonschemas.",
     "type": "object",
@@ -33,7 +33,30 @@
         "oneOf": [
             {
                 "type": "string",
-                "enum": ["LAYOUT", "LAYOUT_planck_1x2uC"]
+                "enum": [
+                    "LAYOUT",
+                    "LAYOUT_1x2uC",
+                    "LAYOUT_1x2uL",
+                    "LAYOUT_1x2uR",
+                    "LAYOUT_2x2uC",
+                    "LAYOUT_2x3uC",
+                    "LAYOUT_625uC",
+                    "LAYOUT_ortho_3x12_1x2uC",
+                    "LAYOUT_ortho_4x12_1x2uC",
+                    "LAYOUT_ortho_4x12_1x2uL",
+                    "LAYOUT_ortho_4x12_1x2uR",
+                    "LAYOUT_ortho_5x12_1x2uC",
+                    "LAYOUT_ortho_5x12_2x2uC",
+                    "LAYOUT_ortho_5x14_1x2uC",
+                    "LAYOUT_ortho_5x14_1x2uL",
+                    "LAYOUT_ortho_5x14_1x2uR",
+                    "LAYOUT_planck_1x2uC",
+                    "LAYOUT_planck_1x2uL",
+                    "LAYOUT_planck_1x2uR",
+                    "LAYOUT_preonic_1x2uC",
+                    "LAYOUT_preonic_1x2uL",
+                    "LAYOUT_preonic_1x2uR"
+                ]
             },
             {
                 "type": "string",
@@ -42,8 +65,11 @@
         ]
     },
     "key_unit": {
-        "type": "number",
-        "min": 0.25
+        "type": "number"
+    },
+    "keyboard": {
+        "type": "string",
+        "pattern": "^[0-9a-z][0-9a-z_/]*$"
     },
     "mcu_pin_array": {
         "type": "array",
@@ -64,8 +90,11 @@
                 "pattern": "^LINE_PIN\\d{1,2}$"
             },
             {
-                "type": "number",
-                "multipleOf": 1
+                "type": "string",
+                "pattern": "^GP\\d{1,2}$"
+            },
+            {
+                "type": "integer"
             },
             {
                 "type": "null"
@@ -76,14 +105,12 @@
         "type": "number"
     },
     "signed_int": {
-        "type": "number",
-        "multipleOf": 1
+        "type": "integer"
     },
     "signed_int_8": {
-        "type": "number",
-        "min": -127,
-        "max": 127,
-        "multipleOf": 1
+        "type": "integer",
+        "minimum": -127,
+        "maximum": 127
     },
     "string_array": {
         "type": "array",
@@ -99,17 +126,20 @@
     },
     "unsigned_decimal": {
         "type": "number",
-        "min": 0
+        "minimum": 0
     },
     "unsigned_int": {
-        "type": "number",
-        "min": 0,
-        "multipleOf": 1
+        "type": "integer",
+        "minimum": 0
     },
     "unsigned_int_8": {
-        "type": "number",
-        "min": 0,
-        "max": 255,
-        "multipleOf": 1
+        "type": "integer",
+        "minimum": 0,
+        "maximum": 255
+    },
+    "bit": {
+        "type": "integer",
+        "minimum": 0,
+        "maximum": 1
     }
 }

data/schemas/keyboard.jsonschema

@@ -1,19 +1,99 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$schema": "https://json-schema.org/draft/2020-12/schema#",
     "$id": "qmk.keyboard.v1",
     "title": "Keyboard Information",
+    "definitions": {
+        "encoder_config": {
+            "type": "object",
+            "properties": {
+                "rotary": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "required": ["pin_a", "pin_b"],
+                        "properties": {
+                            "pin_a": {"$ref": "qmk.definitions.v1#/mcu_pin"},
+                            "pin_b": {"$ref": "qmk.definitions.v1#/mcu_pin"},
+                            "resolution": {"$ref": "qmk.definitions.v1#/unsigned_int"}
+                        }
+                    }
+                }
+            }
+        }
+    },
     "type": "object",
     "properties": {
         "keyboard_name": {"$ref": "qmk.definitions.v1#/text_identifier"},
+        "keyboard_folder": {"$ref": "qmk.definitions.v1#/keyboard"},
         "maintainer": {"$ref": "qmk.definitions.v1#/text_identifier"},
         "manufacturer": {"$ref": "qmk.definitions.v1#/text_identifier"},
         "url": {
             "type": "string",
             "format": "uri"
         },
+        "development_board": {
+            "type": "string",
+            "enum": ["promicro", "elite_c", "elite_pi", "proton_c", "kb2040", "promicro_rp2040", "blok", "bit_c_pro", "stemcell", "bluepill", "blackpill_f401", "blackpill_f411", "bonsai_c4"]
+        },
+        "pin_compatible": {
+            "type": "string",
+            "enum": ["promicro", "elite_c"]
+        },
         "processor": {
             "type": "string",
-            "enum": ["cortex-m0", "cortex-m0plus", "cortex-m3", "cortex-m4", "MKL26Z64", "MK20DX128", "MK20DX256", "MK66FX1M0", "STM32F042", "STM32F072", "STM32F103", "STM32F303", "STM32F401", "STM32F405", "STM32F407", "STM32F411", "STM32F446", "STM32G431", "STM32G474", "STM32L412", "STM32L422", "STM32L432", "STM32L433", "STM32L442", "STM32L443", "GD32VF103", "WB32F3G71", "atmega16u2", "atmega32u2", "atmega16u4", "atmega32u4", "at90usb162", "at90usb646", "at90usb647", "at90usb1286", "at90usb1287", "atmega32a", "atmega328p", "atmega328", "attiny85", "unknown"]
+            "enum": [
+                "cortex-m0",
+                "cortex-m0plus",
+                "cortex-m3",
+                "cortex-m4",
+                "cortex-m7",
+                "cortex-m23",
+                "cortex-m33",
+                "cortex-m35p",
+                "cortex-m55",
+                "cortex-m85",
+                "MKL26Z64",
+                "MK20DX128",
+                "MK20DX256",
+                "MK64FX512",
+                "MK66FX1M0",
+                "RP2040",
+                "STM32F042",
+                "STM32F072",
+                "STM32F103",
+                "STM32F303",
+                "STM32F401",
+                "STM32F405",
+                "STM32F407",
+                "STM32F411",
+                "STM32F446",
+                "STM32G431",
+                "STM32G474",
+                "STM32L412",
+                "STM32L422",
+                "STM32L432",
+                "STM32L433",
+                "STM32L442",
+                "STM32L443",
+                "GD32VF103",
+                "WB32F3G71",
+                "WB32FQ95",
+                "atmega16u2",
+                "atmega32u2",
+                "atmega16u4",
+                "atmega32u4",
+                "at90usb162",
+                "at90usb646",
+                "at90usb647",
+                "at90usb1286",
+                "at90usb1287",
+                "atmega32a",
+                "atmega328p",
+                "atmega328",
+                "attiny85",
+                "unknown"
+            ]
         },
         "audio": {
             "type": "object",
@@ -31,12 +111,14 @@
                 "breathing": {"type": "boolean"},
                 "breathing_period": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
                 "levels": {
-                    "type": "number",
-                    "min": 1,
-                    "max": 31,
-                    "multipleOf": 1
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 31
                 },
-                "pin": {"$ref": "qmk.definitions.v1#/mcu_pin"}
+                "max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
+                "pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
+                "pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
+                "on_state": {"$ref": "qmk.definitions.v1#/bit"}
             }
         },
         "bluetooth": {
@@ -46,8 +128,7 @@
                 "driver": {
                     "type": "string",
                     "enum": ["BluefruitLE", "RN42"]
-                },
-                "lto": {"type": "boolean"},
+                }
             }
         },
         "board": {
@@ -57,7 +138,27 @@
         },
         "bootloader": {
             "type": "string",
-            "enum": ["atmel-dfu", "bootloadhid", "bootloadHID", "custom", "caterina", "halfkay", "kiibohd", "lufa-dfu", "lufa-ms", "md-boot", "qmk-dfu", "qmk-hid", "stm32-dfu", "stm32duino", "gd32v-dfu", "wb32-dfu", "unknown", "usbasploader", "USBasp", "tinyuf2"],
+            "enum": [
+                "atmel-dfu",
+                "bootloadhid",
+                "caterina",
+                "custom",
+                "gd32v-dfu",
+                "halfkay",
+                "kiibohd",
+                "lufa-dfu",
+                "lufa-ms",
+                "md-boot",
+                "qmk-dfu",
+                "qmk-hid",
+                "rp2040",
+                "stm32-dfu",
+                "stm32duino",
+                "tinyuf2",
+                "unknown",
+                "usbasploader",
+                "wb32-dfu"
+            ]
         },
         "bootloader_instructions": {
             "type": "string",
@@ -69,13 +170,13 @@
             "properties": {
                 "debounce_type": {
                     "type": "string",
-                    "enum": ["custom", "eager_pk", "eager_pr", "sym_defer_pk", "sym_defer_pr", "sym_eager_pk"]
+                    "enum": ["asym_eager_defer_pk", "custom", "sym_defer_g", "sym_defer_pk", "sym_defer_pr", "sym_eager_pk", "sym_eager_pr"]
                 },
                 "firmware_format": {
                     "type": "string",
                     "enum": ["bin", "hex", "uf2"]
                 },
-                "lto": {"type": "boolean"},
+                "lto": {"type": "boolean"}
             }
         },
         "diode_direction": {
@@ -83,6 +184,16 @@
             "enum": ["COL2ROW", "ROW2COL"]
         },
         "debounce": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+        "caps_word": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "enabled": {"type": "boolean"},
+                "both_shifts_turns_on": {"type": "boolean"},
+                "double_tap_shift_turns_on": {"type": "boolean"},
+                "idle_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
+            }
+        },
         "combo": {
             "type": "object",
             "properties": {
@@ -94,13 +205,22 @@
             "type": "array",
             "items": {"$ref": "qmk.definitions.v1#/filename"}
         },
+        "encoder": {
+            "$ref": "#/definitions/encoder_config",
+            "properties": {
+                "enabled": {"type": "boolean"}
+            }
+        },
         "features": {"$ref": "qmk.definitions.v1#/boolean_array"},
         "indicators": {
             "type": "object",
             "properties": {
                 "caps_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
                 "num_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
-                "scroll_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"}
+                "scroll_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
+                "compose": {"$ref": "qmk.definitions.v1#/mcu_pin"},
+                "kana": {"$ref": "qmk.definitions.v1#/mcu_pin"},
+                "on_state": {"$ref": "qmk.definitions.v1#/bit"}
             }
         },
         "layout_aliases": {
@@ -109,6 +229,7 @@
         },
         "layouts": {
             "type": "object",
+            "propertyNames": {"$ref": "qmk.definitions.v1#/layout_macro"},
             "additionalProperties": {
                 "type": "object",
                 "additionalProperties": false,
@@ -124,19 +245,22 @@
                         "items": {
                             "type": "object",
                             "additionalProperties": false,
+                            "required": ["x", "y"],
                             "properties": {
-                                "label": {"type": "string"},
+                                "label": {
+                                    "type": "string",
+                                    "pattern": "^[^\\n]*$"
+                                },
                                 "matrix": {
                                     "type": "array",
                                     "minItems": 2,
                                     "maxItems": 2,
                                     "items": {
-                                        "type": "number",
-                                        "min": 0,
-                                        "multipleOf": 1
+                                        "type": "integer",
+                                        "minimum": 0
                                     }
                                 },
-                                "r": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
+                                "r": {"$ref": "qmk.definitions.v1#/signed_decimal"},
                                 "rx": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
                                 "ry": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
                                 "h": {"$ref": "qmk.definitions.v1#/key_unit"},
@@ -170,18 +294,17 @@
                     "items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
                 },
                 "cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
-                "rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
-                "unused": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
+                "rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
             }
         },
         "mouse_key": {
             "type": "object",
             "properties": {
                 "enabled": {"type": "boolean"},
-                "delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
-                "interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
-                "max_speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
-                "time_to_max": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
+                "delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
+                "interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
+                "max_speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
+                "time_to_max": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
                 "wheel_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
             }
         },
@@ -192,6 +315,108 @@
                 "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
             }
         },
+        "led_matrix": {
+            "type": "object",
+            "properties": {
+                "animations": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "boolean"
+                    }
+                },
+                "driver": {"type": "string"},
+                "center_point": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
+                },
+                "max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
+                "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "sat_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "val_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "speed_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "split_count": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
+                },
+                "layout": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "matrix": {
+                                "type": "array",
+                                "minItems": 2,
+                                "maxItems": 2,
+                                "items": {
+                                    "type": "integer",
+                                    "minimum": 0
+                                }
+                            },
+                            "x": {"$ref": "qmk.definitions.v1#/key_unit"},
+                            "y": {"$ref": "qmk.definitions.v1#/key_unit"},
+                            "flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
+                        }
+                    }
+                }
+            }
+        },
+        "rgb_matrix": {
+            "type": "object",
+            "properties": {
+                "animations": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "boolean"
+                    }
+                },
+                "driver": {"type": "string"},
+                "center_point": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
+                },
+                "max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
+                "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "sat_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "val_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "speed_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "split_count": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
+                },
+                "layout": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "matrix": {
+                                "type": "array",
+                                "minItems": 2,
+                                "maxItems": 2,
+                                "items": {
+                                    "type": "integer",
+                                    "minimum": 0
+                                }
+                            },
+                            "x": {"$ref": "qmk.definitions.v1#/key_unit"},
+                            "y": {"$ref": "qmk.definitions.v1#/key_unit"},
+                            "flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
+                        }
+                    }
+                }
+            }
+        },
         "rgblight": {
             "type": "object",
             "additionalProperties": false,
@@ -211,10 +436,9 @@
                         "blink": {"type": "boolean"},
                         "enabled": {"type": "boolean"},
                         "max": {
-                            "type": "number",
-                            "min": 1,
-                            "max": 32,
-                            "multipleOf": 1
+                            "type": "integer",
+                            "minimum": 1,
+                            "maximum": 32
                         },
                         "override_rgb": {"type": "boolean"}
                     }
@@ -228,12 +452,60 @@
                 "split": {"type": "boolean"},
                 "split_count": {
                     "type": "array",
-                    "minLength": 2,
-                    "maxLength": 2,
+                    "minItems": 2,
+                    "maxItems": 2,
                     "items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
                 }
             }
         },
+        "secure": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "enabled": {"type": "boolean"},
+                "unlock_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "idle_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "unlock_sequence": {
+                    "type": "array",
+                    "minItems": 1,
+                    "maxItems": 5,
+                    "items": {
+                        "type": "array",
+                        "minItems": 2,
+                        "maxItems": 2,
+                        "items": {
+                            "type": "integer",
+                            "minimum": 0
+                        }
+                    }
+                }
+            }
+        },
+        "stenography": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "enabled": {"type": "boolean"},
+                "protocol": {
+                    "type": "string",
+                    "enum": ["all", "geminipr", "txbolt"]
+                }
+            }
+        },
+        "ps2": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "enabled": {"type": "boolean"},
+                "mouse_enabled": {"type": "boolean"},
+                "clock_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
+                "data_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
+                "driver": {
+                    "type": "string",
+                    "enum": ["busywait", "interrupt", "usart", "vendor"]
+                }
+            }
+        },
         "split": {
             "type": "object",
             "additionalProperties": false,
@@ -262,16 +534,24 @@
                         }
                     }
                 },
+                "encoder": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "right": {
+                            "$ref": "#/definitions/encoder_config"
+                        }
+                    }
+                },
                 "main": {
                     "type": "string",
                     "enum": ["eeprom", "left", "matrix_grid", "pin", "right"]
                 },
                 "soft_serial_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
                 "soft_serial_speed": {
-                    "type": "number",
-                    "min": 0,
-                    "max": 5,
-                    "multipleOf": 1
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 5
                 },
                 "transport": {
                     "type": "object",
@@ -282,7 +562,9 @@
                             "enum": ["custom", "i2c", "serial", "serial_usart"]
                         },
                         "sync_matrix_state": {"type": "boolean"},
-                        "sync_modifiers": {"type": "boolean"}
+                        "sync_modifiers": {"type": "boolean"},
+                        "watchdog": {"type": "boolean"},
+                        "watchdog_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
                     }
                 },
                 "usb_detect": {
@@ -307,25 +589,30 @@
                 "force_hold_per_key": {"type": "boolean"},
                 "ignore_mod_tap_interrupt": {"type": "boolean"},
                 "ignore_mod_tap_interrupt_per_key": {"type": "boolean"},
+                "hold_on_other_key_press": {"type": "boolean"},
+                "hold_on_other_key_press_per_key": {"type": "boolean"},
                 "permissive_hold": {"type": "boolean"},
                 "permissive_hold_per_key": {"type": "boolean"},
                 "retro": {"type": "boolean"},
                 "retro_per_key": {"type": "boolean"},
                 "term": {"$ref": "qmk.definitions.v1#/unsigned_int"},
                 "term_per_key": {"type": "boolean"},
-                "toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"}
             }
         },
         "usb": {
             "type": "object",
             "additionalProperties": false,
             "properties": {
-                "device_ver": {"$ref": "qmk.definitions.v1#/hex_number_4d"}, # Deprecated
+                "device_ver": {
+                    "$ref": "qmk.definitions.v1#/hex_number_4d",
+                    "$comment": "Deprecated: use device_version instead"
+                },
                 "device_version": {"$ref": "qmk.definitions.v1#/bcd_version"},
                 "force_nkro": {"type": "boolean"},
                 "pid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
                 "vid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
-                "max_power": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
+                "max_power": {"$ref": "qmk.definitions.v1#/unsigned_int"},
                 "no_startup_check": {"type": "boolean"},
                 "polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
                 "shared_endpoint": {
@@ -336,8 +623,8 @@
                         "mouse": {"type": "boolean"}
                     }
                 },
-                "suspend_wakeup_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "wait_for": {"type": "boolean"},
+                "suspend_wakeup_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "wait_for": {"type": "boolean"}
             }
         },
         "qmk": {
@@ -345,8 +632,8 @@
             "additionalProperties": false,
             "properties": {
                 "keys_per_scan": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "tap_keycode_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "tap_capslock_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
+                "tap_keycode_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "tap_capslock_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"}
             }
         },
         "qmk_lufa_bootloader": {

data/schemas/keycodes.jsonschema

@@ -0,0 +1,57 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema#",
+    "$id": "qmk.keycodes.v1",
+    "title": "Keycode Information",
+    "type": "object",
+    "definitions": {
+        "define": {
+            "type": "string",
+            "minLength": 2,
+            "maxLength": 50,
+            "pattern": "^[A-Zs_0-9]*$"
+        },
+        "hex_number_4d": {
+            "type": "string",
+            "pattern": "^0x[0-9A-F]{4}$"
+        }
+    },
+    "properties": {
+        "ranges": {
+            "type": "object",
+            "propertyNames": {
+                "type": "string"
+            },
+            "additionalProperties": {
+                "type": "object",
+                "required": [
+                    "define"
+                ],
+                "properties": {
+                    "define": {"$ref": "#/definitions/define"}
+                }
+            }
+        },
+        "keycodes": {
+            "type": "object",
+            "propertyNames": {
+                "$ref": "#/definitions/hex_number_4d"
+            },
+            "additionalProperties": {
+                "type": "object",
+                "required": [
+                    "key"
+                ],
+                "properties": {
+                    "key": {"$ref": "#/definitions/define"},
+                    "aliases": {
+                        "type": "array",
+                        "minItems": 1,
+                        "items": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

data/schemas/keymap.jsonschema

@@ -1,10 +1,14 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$schema": "https://json-schema.org/draft/2020-12/schema#",
     "$id": "qmk.keymap.v1",
     "title": "Keymap Information",
     "type": "object",
     "properties": {
         "author": {"type": "string"},
+        "converter": {
+            "type": "string",
+            "enum": ["elite_pi", "proton_c", "kb2040", "promicro_rp2040", "blok", "bit_c_pro", "stemcell", "bonsai_c4"]
+        },
         "host_language": {"$ref": "qmk.definitions.v1#/text_identifier"},
         "keyboard": {"$ref": "qmk.definitions.v1#/text_identifier"},
         "keymap": {"$ref": "qmk.definitions.v1#/text_identifier"},
@@ -31,7 +35,7 @@
                             "properties": {
                                 "action": {
                                     "type": "string",
-                                    "enum": ['beep', 'delay', 'down', 'tap', 'up']
+                                    "enum": ["beep", "delay", "down", "tap", "up"]
                                 },
                                 "keycodes": {
                                     "type": "array",
@@ -50,8 +54,7 @@
         },
         "config": {"$ref": "qmk.keyboard.v1"},
         "notes": {
-            "type": "string",
-            "description": "asdf"
+            "type": "string"
         }
     },
     "required": [

data/templates/keyboard/info.json

@@ -15,11 +15,11 @@
         "device_version": "1.0.0"
     },
     "features": {
-        "bootmagic_lite": true,
+        "bootmagic": true,
         "command": false,
         "console": false,
         "extrakey": true,
         "mousekey": true,
         "nkro": true
     }
-}
+}

data/templates/keyboard/readme.md

@@ -24,4 +24,4 @@ Enter the bootloader in 3 ways:
 
 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
 * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
-* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available

docs/ChangeLog/20211127.md

@@ -56,19 +56,19 @@ You can now define up to 32 macros in your `keymap.json` file, as used by [QMK C
     "keyboard": "handwired/my_macropad",
     "keymap": "my_keymap",
     "macros": [
-        [ // first listed is MACRO_0...
+        [ // first listed is QK_MACRO_0...
             {"action":"down", "keycodes": ["LSFT"]},
             "hello world1",
             {"action": "up","keycodes": ["LSFT"]}
         ],
-        [ // ...then MACRO_1...
+        [ // ...then QK_MACRO_1...
             {"action":"tap", "keycodes": ["LCTL", "LALT", "DEL"]}
         ],
-        [ // ...then MACRO_2...
+        [ // ...then QK_MACRO_2...
             "ding!",
             {"action":"beep"}
         ],
-        [ // ...and MACRO_3.
+        [ // ...and QK_MACRO_3.
             {"action":"tap", "keycodes": ["F1"]},
             {"action":"delay", "duration": "1000"},
             {"action":"tap", "keycodes": ["PGDN"]}
@@ -76,7 +76,7 @@ You can now define up to 32 macros in your `keymap.json` file, as used by [QMK C
     ],
     "layout": "LAYOUT_all",
     "layers": [
-        ["MACRO_0", "MACRO_1", "MACRO_2", "MACRO_3"]
+        ["QK_MACRO_0", "QK_MACRO_1", "QK_MACRO_2", "QK_MACRO_3"]
     ]
 }
 ```

docs/ChangeLog/20220528.md

@@ -0,0 +1,216 @@
+# QMK Breaking Changes - 2022 May 28 Changelog
+
+## Notable Features :id=notable-features
+
+### Caps Word ([#16588](https://github.com/qmk/qmk_firmware/pull/16588)) :id=caps-word
+
+This is a new feature that allows for capslock-like functionality that turns itself off at the end of the word.
+
+For instance, if you wish to type "QMK" without holding shift the entire time, you can either tap both left and right shift, or double-tap shift, to turn on _Caps Word_ -- then type `qmk` (lowercase) without holding shift. Once you hit any key other than `a`--`z`, `0`--`9`, `-`, `_`, delete, or backspace, this will go back to normal typing!
+
+There are other activation mechanisms as well as configurable options like timeout and the like -- see the [Caps Word documentation](feature_caps_word.md) for more information.
+
+### Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174)) :id=quantum-painter
+
+QMK has had support for small OLED displays for some time now, but hasn't really gained too much ability to draw to panels other than the SSD1306 or SH1106 panels.
+
+Quantum Painter is a new drawing subsystem available to suitable ARM and RISC-V boards that is capable of drawing to large panel RGB LCDs and RGB OLEDs. It also allows for a lot more flexibility with a larger set of drawing APIs -- lines, rectangles, circles, ellipses, text, images, and even animations.
+
+The QMK CLI has new commands added to be able to generate images and fonts for Quantum Painter to digest -- it's even capable of converting animated gifs for display on screen.
+
+See the [Quantum Painter documentation](quantum_painter.md) for more information on how to set up the displays as well as how to convert images and fonts.
+
+!> Quantum Painter is not supported on AVR due to complexity and size constraints. Boards based on AVR such as ProMicro or Elite-C builds will not be able to leverage Quantum Painter.
+
+### Encoder Mapping ([#13286](https://github.com/qmk/qmk_firmware/pull/13286)) :id=encoder-mapping
+
+One of the long-standing complaints with Encoders is that there has been no easy way to configure them in user keymaps. [#13286](https://github.com/qmk/qmk_firmware/pull/13286) added support for [Encoder Mapping](feature_encoders.md#encoder-map), which allows users to define encoder functionality in a similar way to their normal keymap.
+
+!> This is not yet supported by QMK Configurator. It is also unlikely to ever be supported by VIA.
+
+## Changes Requiring User Action :id=changes-requiring-user-action
+
+### `RESET` => `QK_BOOT` ([#17037](https://github.com/qmk/qmk_firmware/pull/17037)) :id=reset-2-qk_boot
+
+QMK is always in the process of picking up support for new hardware platforms. One of the side-effects for future integrations has shown that QMK's usage of `RESET` as a keycode is causing naming collisions. As a result, [#17037](https://github.com/qmk/qmk_firmware/pull/17037) changed usages of `RESET` to the new keycode `QK_BOOT` in the majority of default-like keymaps. At this stage the old keycode is still usable but will likely be removed in the next breaking changes cycle. Users with keymaps containing `RESET` should also move to `QK_BOOT`.
+
+### Sendstring keycode overhaul ([#16941](https://github.com/qmk/qmk_firmware/pull/16941)) :id=sendstring-keycodes
+
+Some keycodes used with `SEND_STRING` and its relatives have been deprecated and may have their old keycode usages removed at a later date. The list of [deprecated keycodes](https://github.com/qmk/qmk_firmware/blob/ebd402788346aa6e88bde1486b2a835684d40d39/quantum/send_string_keycodes.h#L456-L505) should be consulted to determine if you're using one of the older names (the first identifier after `#define`) -- you should swap to the newer variant (the second identifier on the same line).
+
+### Pillow Installation ([#17133](https://github.com/qmk/qmk_firmware/pull/17133)) :id=pillow-install
+
+The merge of Quantum Painter added some new dependencies in the QMK CLI, most notably _Pillow_, which requires some installation in order for the CLI to function. If you've got an existing installation, you'll need to run some commands in order to get things working:
+
+On Windows, if using _QMK MSYS_ or _msys2_, you'll need to run the following command:
+
+```sh
+pacman --needed --noconfirm --disable-download-timeout -S mingw-w64-x86_64-python-pillow
+python3 -m pip install --upgrade qmk
+```
+
+On macOS:
+
+```sh
+brew update
+brew upgrade qmk/qmk/qmk
+```
+
+On Linux or WSL:
+
+```sh
+python3 -m pip install --user --upgrade qmk
+```
+
+### Updated Keyboard Codebases :id=updated-keyboard-codebases
+
+The following keyboards have had their source moved within QMK:
+
+| Old Keyboard Name    | New Keyboard Name  |
+|----------------------|--------------------|
+| absinthe             | keyhive/absinthe   |
+| amj40                | amjkeyboard/amj40  |
+| amj60                | amjkeyboard/amj60  |
+| amj96                | amjkeyboard/amj96  |
+| amjpad               | amjkeyboard/amjpad |
+| at101_bh             | viktus/at101_bh    |
+| ergosaurus           | keyhive/ergosaurus |
+| gmmk/pro/ansi        | gmmk/pro/rev1/ansi |
+| gmmk/pro/iso         | gmmk/pro/rev1/iso  |
+| honeycomb            | keyhive/honeycomb  |
+| lattice60            | keyhive/lattice60  |
+| melody96             | ymdk/melody96      |
+| mt40                 | mt/mt40            |
+| mt64rgb              | mt/mt64rgb         |
+| mt84                 | mt/mt84            |
+| mt980                | mt/mt980           |
+| navi10               | keyhive/navi10     |
+| omnikey_bh           | viktus/omnikey_bh  |
+| opus                 | keyhive/opus       |
+| smallice             | keyhive/smallice   |
+| southpole            | keyhive/southpole  |
+| uno                  | keyhive/uno        |
+| ut472                | keyhive/ut472      |
+| wheatfield/blocked65 | mt/blocked65       |
+| wheatfield/split75   | mt/split75         |
+| z150_bh              | viktus/z150_bh     |
+
+---
+
+## Full changelist :id=full-changelist
+
+Core:
+* Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174))
+* Add support for encoder mapping. ([#13286](https://github.com/qmk/qmk_firmware/pull/13286))
+* Add support for multiple switchs/solenoids to Haptic Feedback engine ([#15657](https://github.com/qmk/qmk_firmware/pull/15657))
+* Add compile/make macro to core ([#15959](https://github.com/qmk/qmk_firmware/pull/15959))
+* Add Reboot keycode to core ([#15990](https://github.com/qmk/qmk_firmware/pull/15990))
+* Add support for multiple sensors to pmw3360 ([#15996](https://github.com/qmk/qmk_firmware/pull/15996))
+* Asymmetric encoders, encoder tests. ([#16068](https://github.com/qmk/qmk_firmware/pull/16068))
+* Add hacky via support for RGB Matrix ([#16086](https://github.com/qmk/qmk_firmware/pull/16086))
+* Allow usage of AVRs minimal printf library ([#16266](https://github.com/qmk/qmk_firmware/pull/16266))
+* Squeeze AVR some more with `-mrelax` and `-mcall-prologues` ([#16269](https://github.com/qmk/qmk_firmware/pull/16269))
+* Heatmap incorrect matrix effect workaround ([#16315](https://github.com/qmk/qmk_firmware/pull/16315))
+* Add SN74x154 driver and convert AL1 custom matrix ([#16331](https://github.com/qmk/qmk_firmware/pull/16331))
+* Add customizable snake and knight animation increments ([#16337](https://github.com/qmk/qmk_firmware/pull/16337))
+* Chibios USB protocol: allow overriding RAW Capacity ([#16339](https://github.com/qmk/qmk_firmware/pull/16339))
+* HD44780 driver rework ([#16370](https://github.com/qmk/qmk_firmware/pull/16370))
+* Update wb32-dfu ([#16438](https://github.com/qmk/qmk_firmware/pull/16438))
+* Remove `send_unicode_hex_string()` ([#16518](https://github.com/qmk/qmk_firmware/pull/16518))
+* Add :flash target for UF2 bootloaders ([#16525](https://github.com/qmk/qmk_firmware/pull/16525))
+* Move `has_mouse_report_changed` function to `report.c` ([#16543](https://github.com/qmk/qmk_firmware/pull/16543))
+* Move Doxygen docs to subdirectory ([#16561](https://github.com/qmk/qmk_firmware/pull/16561))
+* Add Caps Word feature to core ([#16588](https://github.com/qmk/qmk_firmware/pull/16588))
+* Add non blackpill F4x1 config files ([#16600](https://github.com/qmk/qmk_firmware/pull/16600))
+* Force platform pin defs to be included ([#16611](https://github.com/qmk/qmk_firmware/pull/16611))
+* Refactor CTPC logic to allow future converters ([#16621](https://github.com/qmk/qmk_firmware/pull/16621))
+* Use a mutex guard for split shared memory ([#16647](https://github.com/qmk/qmk_firmware/pull/16647))
+* Rename TICK to TICK_EVENT ([#16649](https://github.com/qmk/qmk_firmware/pull/16649))
+* Add GET_TAPPING_TERM macro to reduce duplicate code ([#16681](https://github.com/qmk/qmk_firmware/pull/16681))
+* add the ability to change the pwm frequency for the IS31FL3737B ([#16718](https://github.com/qmk/qmk_firmware/pull/16718))
+* Joystick feature updates ([#16732](https://github.com/qmk/qmk_firmware/pull/16732))
+* Add emulated eeprom support for STM32F303xE ([#16737](https://github.com/qmk/qmk_firmware/pull/16737))
+* Refactor writePin to work with statements ([#16738](https://github.com/qmk/qmk_firmware/pull/16738))
+* Add mechanism to limit available converters ([#16783](https://github.com/qmk/qmk_firmware/pull/16783))
+* Implement XAP 'secure' core requirements ([#16843](https://github.com/qmk/qmk_firmware/pull/16843))
+* rgblight: Add functions to stop blinking one or all but one layer ([#16859](https://github.com/qmk/qmk_firmware/pull/16859))
+* Expose API for hardware unique ID ([#16869](https://github.com/qmk/qmk_firmware/pull/16869))
+* Added support for Wb32fq95 ([#16871](https://github.com/qmk/qmk_firmware/pull/16871))
+* Provide better config defaults for bluepill boards ([#16909](https://github.com/qmk/qmk_firmware/pull/16909))
+* Joystick: Simplify report descriptor and clean up error messages ([#16926](https://github.com/qmk/qmk_firmware/pull/16926))
+* Rename keymap_extras headers for consistency ([#16939](https://github.com/qmk/qmk_firmware/pull/16939))
+* Sendstring keycode overhaul ([#16941](https://github.com/qmk/qmk_firmware/pull/16941))
+* Move disable_jtag to platforms ([#16960](https://github.com/qmk/qmk_firmware/pull/16960))
+* Remove ARM pgm_read_word workaround in rgblight ([#16961](https://github.com/qmk/qmk_firmware/pull/16961))
+* Warn about LTO with arm_atsam, not ChibiOS. ([#17106](https://github.com/qmk/qmk_firmware/pull/17106))
+
+CLI:
+* Rework generate-api CLI command to use .build directory ([#16441](https://github.com/qmk/qmk_firmware/pull/16441))
+* Change data driven "str" type to represent a quoted string literal ([#16516](https://github.com/qmk/qmk_firmware/pull/16516))
+* Bump the 'jsonschema' version ([#16635](https://github.com/qmk/qmk_firmware/pull/16635))
+* Add frameworking for development board presets ([#16637](https://github.com/qmk/qmk_firmware/pull/16637))
+* Extend 'qmk info' to handle keymap level overrides ([#16702](https://github.com/qmk/qmk_firmware/pull/16702))
+* Data driven `g_led_config` ([#16728](https://github.com/qmk/qmk_firmware/pull/16728))
+* Allow new-keyboard to use development_board presets ([#16785](https://github.com/qmk/qmk_firmware/pull/16785))
+* Also format *.hpp files. ([#16997](https://github.com/qmk/qmk_firmware/pull/16997))
+
+Submodule updates:
+* ChibiOS 21.11.1 update. ([#16251](https://github.com/qmk/qmk_firmware/pull/16251))
+* Update ChibiOS-Contrib ([#16915](https://github.com/qmk/qmk_firmware/pull/16915))
+
+Keyboards:
+* chore: Add personal GMMK Pro keymap ([#15320](https://github.com/qmk/qmk_firmware/pull/15320))
+* move melody96 to ymdk vendor folder ([#15680](https://github.com/qmk/qmk_firmware/pull/15680))
+* move amj keyboards into amjkeyboard vendor folder ([#15733](https://github.com/qmk/qmk_firmware/pull/15733))
+* move z150_bh at101_bh omnikey_bh to viktus/ ([#16004](https://github.com/qmk/qmk_firmware/pull/16004))
+* MS Sculpt Mobile refactor ([#16038](https://github.com/qmk/qmk_firmware/pull/16038))
+* move keyhive exclusive boards into /keyhive ([#16084](https://github.com/qmk/qmk_firmware/pull/16084))
+* move 麦田 boards into /mt ([#16095](https://github.com/qmk/qmk_firmware/pull/16095))
+* Convert Wasdat Code custom matrix to SN74x138 driver ([#16257](https://github.com/qmk/qmk_firmware/pull/16257))
+* Move GMMK Pro to allow for multiple revisions ([#16423](https://github.com/qmk/qmk_firmware/pull/16423))
+* Updated pin mapping and readme. ([#16505](https://github.com/qmk/qmk_firmware/pull/16505))
+* Map data driven `DESCRIPTION` as string literal ([#16523](https://github.com/qmk/qmk_firmware/pull/16523))
+* remove unecessary layers ([#16559](https://github.com/qmk/qmk_firmware/pull/16559))
+* Helix/rev2 move to split common ([#16723](https://github.com/qmk/qmk_firmware/pull/16723))
+* Remove some layout exceptions ([#16957](https://github.com/qmk/qmk_firmware/pull/16957))
+* Refactor legacy quantum keycodes in default-ish keymaps ([#17037](https://github.com/qmk/qmk_firmware/pull/17037))
+* Refactor legacy quantum keycodes in default-ish keymaps ([#17150](https://github.com/qmk/qmk_firmware/pull/17150))
+
+Keyboard fixes:
+* gboards/gergoplex: move `COMBO_ENABLE` to keymap level ([#16667](https://github.com/qmk/qmk_firmware/pull/16667))
+* usb-usb converter: community layout support ([#16773](https://github.com/qmk/qmk_firmware/pull/16773))
+* Fix build of `keyhive/uno`. ([#16891](https://github.com/qmk/qmk_firmware/pull/16891))
+* Fix uno ([#16892](https://github.com/qmk/qmk_firmware/pull/16892))
+* converter/usb_usb: remove surplus commas ([#17024](https://github.com/qmk/qmk_firmware/pull/17024))
+* Various fixes for g_led_config lint warnings ([#17104](https://github.com/qmk/qmk_firmware/pull/17104))
+
+Others:
+* Add warning for CTPC/CONVERT_TO_PROTON_C. ([#16782](https://github.com/qmk/qmk_firmware/pull/16782))
+* Add bluepill/blackpill development board presets ([#16806](https://github.com/qmk/qmk_firmware/pull/16806))
+* Recommend pillow as part of manual MSYS install ([#17133](https://github.com/qmk/qmk_firmware/pull/17133))
+
+Bugs:
+* Fix one-shot locked modifiers ([#16114](https://github.com/qmk/qmk_firmware/pull/16114))
+* Fix missing definition for non-encoder case. ([#16593](https://github.com/qmk/qmk_firmware/pull/16593))
+* Fixup builds. ([#16596](https://github.com/qmk/qmk_firmware/pull/16596))
+* Missed some erroneous prints. ([#16597](https://github.com/qmk/qmk_firmware/pull/16597))
+* Workaround for pin_def errors on KINETIS based builds ([#16614](https://github.com/qmk/qmk_firmware/pull/16614))
+* Fix flipped logic bug with One Shot `OS_ON` / `OS_OFF` keys ([#16617](https://github.com/qmk/qmk_firmware/pull/16617))
+* Redo workaround for pin_def errors on KINETIS ([#16620](https://github.com/qmk/qmk_firmware/pull/16620))
+* Fix oneshot toggle logic ([#16630](https://github.com/qmk/qmk_firmware/pull/16630))
+* Mousekeys fix ([#16640](https://github.com/qmk/qmk_firmware/pull/16640))
+* Ignore transport defaults if SPLIT_KEYBOARD is unset ([#16706](https://github.com/qmk/qmk_firmware/pull/16706))
+* Fixes #16705 : digital rain follows val ([#16716](https://github.com/qmk/qmk_firmware/pull/16716))
+* Fix AVR backlight breathing: low brightness limit & exceeding breathing table max index ([#16770](https://github.com/qmk/qmk_firmware/pull/16770))
+* Fixed usb read loops not reading until timeout ([#16827](https://github.com/qmk/qmk_firmware/pull/16827))
+* [QP] Check BPP capabilities before loading the palette ([#16863](https://github.com/qmk/qmk_firmware/pull/16863))
+* Fix #16859. ([#16865](https://github.com/qmk/qmk_firmware/pull/16865))
+* Preinstall python dependencies before executing `qmk`. ([#16874](https://github.com/qmk/qmk_firmware/pull/16874))
+* Fixup AVR builds. ([#16875](https://github.com/qmk/qmk_firmware/pull/16875))
+* Fix kinetic mouse mode ([#16951](https://github.com/qmk/qmk_firmware/pull/16951))
+* Enhancement and fixes of "Secure" feature ([#16958](https://github.com/qmk/qmk_firmware/pull/16958))
+* Check for ongoing transfers on the OUT endpoint ([#16974](https://github.com/qmk/qmk_firmware/pull/16974))
+* MSYS2 install: add some Python dependencies through Pacman ([#17025](https://github.com/qmk/qmk_firmware/pull/17025))
+* Revert "Fix kinetic mouse mode (#16951)" ([#17095](https://github.com/qmk/qmk_firmware/pull/17095))
+* Workaround for recent -Werror=array-bounds AVR issues ([#17136](https://github.com/qmk/qmk_firmware/pull/17136))
+* Bug fix: Continue Caps Word when AltGr (right Alt) is held. ([#17156](https://github.com/qmk/qmk_firmware/pull/17156))

docs/ChangeLog/20220827.md

@@ -0,0 +1,343 @@
+# QMK Breaking Changes - 2022 August 27 Changelog
+
+## Notable Features :id=notable-features
+
+### Add Raspberry Pi RP2040 support ([#14877](https://github.com/qmk/qmk_firmware/pull/14877), [#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17516](https://github.com/qmk/qmk_firmware/pull/17516), [#17519](https://github.com/qmk/qmk_firmware/pull/17519), [#17612](https://github.com/qmk/qmk_firmware/pull/17612), [#17512](https://github.com/qmk/qmk_firmware/pull/17512), [#17557](https://github.com/qmk/qmk_firmware/pull/17557), [#17817](https://github.com/qmk/qmk_firmware/pull/17817), [#17839](https://github.com/qmk/qmk_firmware/pull/17839), [#18100](https://github.com/qmk/qmk_firmware/pull/18100)) :id=rp2040-support
+
+QMK _finally_ picked up support for RP2040-based boards, such as the Raspberry Pi Pico, the Sparkfun Pro Micro RP2040, and the Adafruit KB2040. One of QMK's newest collaborators, _@KarlK90_, effectively did `/micdrop` with RP2040, with a massive set of changes to both QMK and the repository QMK uses for the base platform support, ChibiOS[-Contrib]. There has been a flurry of development this breaking changes cycle related to RP2040 from a large number of contributors -- so much so that almost all standard QMK hardware subsystems are supported.
+
+Check the [RP2040 platform development page](platformdev_rp2040.md) for all supported peripherals and other hardware implementation details.
+
+### Allow `qmk flash` to use prebuilt firmware binaries ([#16584](https://github.com/qmk/qmk_firmware/pull/16584)) :id=cli-flash-binaries
+
+A long-requested capability of the QMK CLI has been the ability to flash binaries directly, without needing to build a firmware. QMK provides prebuilt `develop`-based default firmwares on our [CI page](https://qmk.tzarc.io/) -- normally people would need [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases/latest) to flash them. This new functionality written by _@Erovia_ allows `qmk flash` to be provided the prebuilt file instead, simplifying the workflow for people who haven't got Toolbox available.
+
+## Changes Requiring User Action :id=changes-requiring-user-action
+
+### Default layers dropped from 32 to 16 ([#15286](https://github.com/qmk/qmk_firmware/pull/15286))
+
+QMK allows for controlling the maximum number of layers it supports through `LAYER_STATE_(8|16|32)BIT`. Each definition allows for the same number of maximum layers -- `LAYER_STATE_8BIT` => 8 layers. There is also a corresponding firmware size decrease that goes along with smaller numbers -- given the vast majority of users don't use more than 16 layers the default has been swapped to 16. AVR users who were not previously specifying their max layer count may see some space freed up as a result.
+
+### `RESET` => `QK_BOOT` ([#17940](https://github.com/qmk/qmk_firmware/pull/17940)) :id=reset-2-qk_boot
+
+Following the last breaking changes cycle, QMK has been migrating usages of `RESET` to `QK_BOOT` due to naming collisions with our upstream board support packages. [#17940](https://github.com/qmk/qmk_firmware/pull/17940) converts user keymaps across to use the new keycode name. `RESET` should also move to `QK_BOOT`.
+
+### Updated Keyboard Codebases :id=updated-keyboard-codebases
+
+The following keyboards have had their source moved within QMK:
+
+| Old Keyboard Name      | New Keyboard Name        |
+|------------------------|--------------------------|
+| gentleman65            | jkeys_design/gentleman65 |
+| handwired/hillside/0_1 | handwired/hillside/48    |
+| idobao/id80/v1/ansi    | idobao/id80/v2/ansi      |
+| idobao/id80/v1/iso     | idobao/id80/v2/iso       |
+
+### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) :id=usb-ids-Refactoring
+
+QMK has decided to deprecate the specification of USB IDs inside `config.h` in favour of `info.json`, eventually leaving data-driven as the only method to specify USB information.
+
+A significant number of keyboards have already been changed on `master` in a like-for-like fashion, and [#18152](https://github.com/qmk/qmk_firmware/pull/18152) performs the same transformations for keyboards already on `develop`.
+
+Previously in `config.h`:
+```c
+#define VENDOR_ID    0x1234
+#define PRODUCT_ID   0x5678
+#define DEVICE_VER   0x0001
+#define MANUFACTURER Me
+#define PRODUCT      MyKeyboard
+```
+
+Replaced by `info.json`:
+```json
+{
+    "keyboard_name": "MyKeyboard",
+    "manufacturer": "Me",
+    "usb": {
+        "vid": "0x1234",
+        "pid": "0x5678",
+        "device_version": "0.0.1"
+    },
+    // ... layouts, etc. ...
+}
+```
+
+#### Deprecation Schedule
+
+- From 2022 Aug 27, specifying USB information in `config.h` will produce warnings during build but will still function as previously.
+- From 2022 Nov 26, specifying USB information in `config.h` will cause compilation to fail.
+
+## Notable core changes :id=notable-core
+
+### Board converters ([#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17603](https://github.com/qmk/qmk_firmware/pull/17603), [#17711](https://github.com/qmk/qmk_firmware/pull/17711), [#17827](https://github.com/qmk/qmk_firmware/pull/17827), [#17593](https://github.com/qmk/qmk_firmware/pull/17593), [#17652](https://github.com/qmk/qmk_firmware/pull/17652), [#17595](https://github.com/qmk/qmk_firmware/pull/17595)) :id=board-converters
+
+Historically QMK had a `CONVERT_TO_PROTON_C` directive for `rules.mk` to allow people to replace an AVR-based Pro Micro with a QMK Proton C. Global parts shortages have prompted people to create their own pin-compatible boards -- QMK has made this conversion generic and now allows for drop-in replacements for a lot more boards. see the [Converters Feature](feature_converters.md) documentation for the full list of supported replacement boards -- in this breaking changes cycle we've gone from 1 to 7.
+
+### Add cli command to import keyboard|keymap|kbfirmware ([#16668](https://github.com/qmk/qmk_firmware/pull/16668)) :id=cli-import
+
+To help with importing keyboards and keymaps from other sources, _@zvecr_ added [#16668](https://github.com/qmk/qmk_firmware/pull/16668) which adds a new set of commands to the CLI to automatically import keyboards (`qmk import-keyboard -h`), keymaps (`qmk import-keymap -h`), and kbfirmware definitions (`qmk import-kbfirmware -h`) into QMK.
+
+The now-EOL kbfirmware allowed people who aren't set up with QMK the ability to create keyboard firmwares without requiring a full installation of QMK. Unfortunately, it targets a 7-year-old version of QMK -- adding frustration for users who want the newest features, as well as for QMK maintainers who have to spend time explaining why QMK can't just accept a drive-by code drop from kbfirmware. With any luck, this new command helps both camps!
+
+### Generic wear-leveling for EEPROM emulation ([#16996](https://github.com/qmk/qmk_firmware/pull/16996), [#17376](https://github.com/qmk/qmk_firmware/pull/17376), [#18102](https://github.com/qmk/qmk_firmware/pull/18102)) :id=wear-leveling
+
+QMK has had the ability to write to internal MCU flash in order to emulate EEPROM for some time now, but it was only limited to a small number of MCUs. The base HAL used by QMK for a large number of ARM devices provides a "proper" embedded MCU flash driver, so _@tzarc_ decoupled the wear-leveling algorithm from the old flash writing code, improved it, wrote some tests, and enabled its use for a much larger number of other devices... including RP2040's XIP flash, and external SPI NOR Flash.
+
+See the [EEPROM Driver](eeprom_driver.md) documentation for more information.
+
+### Pointing Device Improvements ([#16371](https://github.com/qmk/qmk_firmware/pull/16371), [#17111](https://github.com/qmk/qmk_firmware/pull/17111), [#17176](https://github.com/qmk/qmk_firmware/pull/17176), [#17482](https://github.com/qmk/qmk_firmware/pull/17482), [#17776](https://github.com/qmk/qmk_firmware/pull/17776), [#17613](https://github.com/qmk/qmk_firmware/pull/17613)) :id=pointing-device-improvements
+
+Ever since Pointing Device Driver support and Split Pointing Device support were added by _@drashna_ and _@daskygit_, there has been increased interest in the development of the pointing device subsystem and its associated code.
+
+Both the PMW33xx and the Cirque Pinnacle implementations have seen a lot of improvement to their code, as has the mouse code in general. Features like circular/edge scrolling for the Cirque, and Kinetic movement for any sensor with "lift detection" ([#17482](https://github.com/qmk/qmk_firmware/pull/17482)). Additionally, for those that make fast motions with their pointing devices, support for much larger mouse movement reports has been added ([#16371](https://github.com/qmk/qmk_firmware/pull/16371)).
+
+Other related changes:
+
+* Add support for large Mouse Reports ([#16371](https://github.com/qmk/qmk_firmware/pull/16371))
+* Improve PS/2 mouse performance ([#17111](https://github.com/qmk/qmk_firmware/pull/17111))
+* Mouse key kinetic mode fix ([#17176](https://github.com/qmk/qmk_firmware/pull/17176))
+* Circular scroll, inertial cursor ([#17482](https://github.com/qmk/qmk_firmware/pull/17482))
+* Create generic Pointing Device Pin defines ([#17776](https://github.com/qmk/qmk_firmware/pull/17776))
+* PMW33XX drivers overhaul ([#17613](https://github.com/qmk/qmk_firmware/pull/17613))
+
+---
+
+## Full changelist :id=full-changelist
+
+Core:
+* Tentative Teensy 3.5 support ([#14420](https://github.com/qmk/qmk_firmware/pull/14420))
+* Make default layer size 16-bit ([#15286](https://github.com/qmk/qmk_firmware/pull/15286))
+* Process all changed keys in one scan loop, deprecate `QMK_KEYS_PER_SCAN` ([#15292](https://github.com/qmk/qmk_firmware/pull/15292))
+* Do not enable PERMISSIVE_HOLD when TAPPING_TERM exceeds 500ms ([#15674](https://github.com/qmk/qmk_firmware/pull/15674))
+* Allow usage of ChibiOS's SIO driver for split keyboards ([#15907](https://github.com/qmk/qmk_firmware/pull/15907))
+* [Controller] Added board config for custom controller STeMCell ([#16287](https://github.com/qmk/qmk_firmware/pull/16287))
+* PoC: Swap Escape and Caps ([#16336](https://github.com/qmk/qmk_firmware/pull/16336))
+* Add support for large Mouse Reports ([#16371](https://github.com/qmk/qmk_firmware/pull/16371))
+* tap-dance: Restructure code and document in more detail ([#16394](https://github.com/qmk/qmk_firmware/pull/16394))
+* Teaching the CLI to flash binaries ([#16584](https://github.com/qmk/qmk_firmware/pull/16584))
+* Split ChibiOS usart split driver in protocol and hardware driver part ([#16669](https://github.com/qmk/qmk_firmware/pull/16669))
+* Added Wait time to sending each Keys for Dynamic Macros function ([#16800](https://github.com/qmk/qmk_firmware/pull/16800))
+* Added Delay time to sending each Keys for VIA Macros function feature ([#16810](https://github.com/qmk/qmk_firmware/pull/16810))
+* Improve avr wait_us() ([#16879](https://github.com/qmk/qmk_firmware/pull/16879))
+* Improve ENCODER_DEFAULT_POS to recognize lost ticks ([#16932](https://github.com/qmk/qmk_firmware/pull/16932))
+* Added emacs as an "operating system" for input mode. ([#16949](https://github.com/qmk/qmk_firmware/pull/16949))
+* 24LC32A EEPROM addition ([#16990](https://github.com/qmk/qmk_firmware/pull/16990))
+* Refactor steno and add `STENO_PROTOCOL = [all|txbolt|geminipr]` ([#17065](https://github.com/qmk/qmk_firmware/pull/17065))
+* improvements for Cirque Pinnacle trackpads ([#17091](https://github.com/qmk/qmk_firmware/pull/17091))
+* Use TAP_HOLD_CAPS_DELAY for KC_LOCKING_CAPS_LOCK ([#17099](https://github.com/qmk/qmk_firmware/pull/17099))
+* Improve PS/2 mouse performance ([#17111](https://github.com/qmk/qmk_firmware/pull/17111))
+* Update C standard to GNU11, C++ to GNU++14 ([#17114](https://github.com/qmk/qmk_firmware/pull/17114))
+* Added ws2812_pwm support for WB32 MCU. ([#17142](https://github.com/qmk/qmk_firmware/pull/17142))
+* Added ws2812_spi support for WB32 MCU ([#17143](https://github.com/qmk/qmk_firmware/pull/17143))
+* Make bootloader_jump for dualbank STM32 respect STM32_BOOTLOADER_DUAL_BANK_DELAY ([#17178](https://github.com/qmk/qmk_firmware/pull/17178))
+* Expose the time of the last change to the LED state ([#17222](https://github.com/qmk/qmk_firmware/pull/17222))
+* [Code] Add solid reactive gradient mode ([#17228](https://github.com/qmk/qmk_firmware/pull/17228))
+* Add keymap wrappers for introspection into the keymap. ([#17229](https://github.com/qmk/qmk_firmware/pull/17229))
+* Ensure eeconfig initialised before reading EEPROM handedness. ([#17256](https://github.com/qmk/qmk_firmware/pull/17256))
+* Add uf2-split-* make targets. ([#17257](https://github.com/qmk/qmk_firmware/pull/17257))
+* Removes terminal from QMK. ([#17258](https://github.com/qmk/qmk_firmware/pull/17258))
+* Make SPI Mode configurable for AW20216 and change default mode to 3 ([#17263](https://github.com/qmk/qmk_firmware/pull/17263))
+* Move SPLIT_HAND_PIN setup to split_pre_init ([#17271](https://github.com/qmk/qmk_firmware/pull/17271))
+* Allow larger SPLIT_USB_TIMEOUT with default SPLIT_USB_TIMEOUT_POLL ([#17272](https://github.com/qmk/qmk_firmware/pull/17272))
+* Feature-ify Send String ([#17275](https://github.com/qmk/qmk_firmware/pull/17275))
+* Rework paths for eeprom locations. ([#17326](https://github.com/qmk/qmk_firmware/pull/17326))
+* Pca9505/6 driver ([#17333](https://github.com/qmk/qmk_firmware/pull/17333))
+* Cirque Attenuation Setting ([#17342](https://github.com/qmk/qmk_firmware/pull/17342))
+* Scale brigthness for VIA ([#17352](https://github.com/qmk/qmk_firmware/pull/17352))
+* Ensure that rgb+via compiles in all cases ([#17355](https://github.com/qmk/qmk_firmware/pull/17355))
+* Wear-leveling EEPROM drivers: `embedded_flash`, `spi_flash`, `legacy` ([#17376](https://github.com/qmk/qmk_firmware/pull/17376))
+* In honor of king terry ([#17387](https://github.com/qmk/qmk_firmware/pull/17387))
+* tap-dance: Rename tests so that tap_dance is used consistently ([#17396](https://github.com/qmk/qmk_firmware/pull/17396))
+* IS31FL3737 Global Current Setting ([#17420](https://github.com/qmk/qmk_firmware/pull/17420))
+* [QP] Add ILI9488 support. ([#17438](https://github.com/qmk/qmk_firmware/pull/17438))
+* Mark GD32VF103 as ChibiOS-Contrib ([#17444](https://github.com/qmk/qmk_firmware/pull/17444))
+* ISSI Drivers Global Current Option ([#17448](https://github.com/qmk/qmk_firmware/pull/17448))
+* [Split] pointing transport check ([#17481](https://github.com/qmk/qmk_firmware/pull/17481))
+* Cirque trackpad features: circular scroll, inertial cursor ([#17482](https://github.com/qmk/qmk_firmware/pull/17482))
+* RGB heatmap skip NO_LED ([#17488](https://github.com/qmk/qmk_firmware/pull/17488))
+* Add kb2040 and sparkfun rp2040 converters ([#17514](https://github.com/qmk/qmk_firmware/pull/17514))
+* [style] rp2040 stage2 formatting ([#17516](https://github.com/qmk/qmk_firmware/pull/17516))
+* Also check /run/media/ for uf2 drives ([#17517](https://github.com/qmk/qmk_firmware/pull/17517))
+* RP2040 emulated EEPROM. ([#17519](https://github.com/qmk/qmk_firmware/pull/17519))
+* Make debounce algorithms signal matrix changes ([#17554](https://github.com/qmk/qmk_firmware/pull/17554))
+* Update PM2040 I2C pins ([#17578](https://github.com/qmk/qmk_firmware/pull/17578))
+* Added implementation of WB32 MCU wear_leveling_efl. ([#17579](https://github.com/qmk/qmk_firmware/pull/17579))
+* Use Pro Micro SDA/SCL pinout for PM2040 ([#17595](https://github.com/qmk/qmk_firmware/pull/17595))
+* Refactor Pixel Fractal effect ([#17602](https://github.com/qmk/qmk_firmware/pull/17602))
+* Add Blok RP2040 converter ([#17603](https://github.com/qmk/qmk_firmware/pull/17603))
+* Use polled waiting on ChibiOS platforms that support it ([#17607](https://github.com/qmk/qmk_firmware/pull/17607))
+* Stabilize Half-duplex RP2040 PIO split comms ([#17612](https://github.com/qmk/qmk_firmware/pull/17612))
+* PMW33XX drivers overhaul ([#17613](https://github.com/qmk/qmk_firmware/pull/17613))
+* Include stdint.h in avr/i2c_master.h ([#17639](https://github.com/qmk/qmk_firmware/pull/17639))
+* Add led matrix support for CKLED2001 ([#17643](https://github.com/qmk/qmk_firmware/pull/17643))
+* `STM32_USB_USE_OTG1` => `USB_ENDPOINTS_ARE_REORDERABLE` ([#17647](https://github.com/qmk/qmk_firmware/pull/17647))
+* Allow MCU-specific overrides for SPI flags. ([#17650](https://github.com/qmk/qmk_firmware/pull/17650))
+* Update LED/RGB Matrix flag function behavior ([#17651](https://github.com/qmk/qmk_firmware/pull/17651))
+* Cirque circular scroll: Support POINTING_DEVICE_COMBINED ([#17654](https://github.com/qmk/qmk_firmware/pull/17654))
+* Add support for PAW3204 Optical Sensor ([#17669](https://github.com/qmk/qmk_firmware/pull/17669))
+* Add LED limits call ([#17679](https://github.com/qmk/qmk_firmware/pull/17679))
+* Move Pointing Device code to a subdirectory ([#17684](https://github.com/qmk/qmk_firmware/pull/17684))
+* Avoid OOB in dynamic_keymap_reset ([#17695](https://github.com/qmk/qmk_firmware/pull/17695))
+* Allow dynamic keymap to compile without `via.h` ([#17703](https://github.com/qmk/qmk_firmware/pull/17703))
+* Use correct angle tune range of +/-127 on PMW33XX ([#17708](https://github.com/qmk/qmk_firmware/pull/17708))
+* Add Bonsai C4 converter ([#17711](https://github.com/qmk/qmk_firmware/pull/17711))
+* VIA Encoder Map Support ([#17734](https://github.com/qmk/qmk_firmware/pull/17734))
+* Move Pointing Device Initialization to after Split Post Initialization ([#17740](https://github.com/qmk/qmk_firmware/pull/17740))
+* Add ability to enter bootloader mode from `QK_MAKE` ([#17745](https://github.com/qmk/qmk_firmware/pull/17745))
+* Add `tap_code16_delay` ([#17748](https://github.com/qmk/qmk_firmware/pull/17748))
+* Implement relative mode for Cirque trackpad ([#17760](https://github.com/qmk/qmk_firmware/pull/17760))
+* Create generic Pointing Device Pin defines ([#17776](https://github.com/qmk/qmk_firmware/pull/17776))
+* Constrain Cirque Pinnacle coordinates ([#17803](https://github.com/qmk/qmk_firmware/pull/17803))
+* Refactor/rename postprocess_steno_user → post_process_steno_user ([#17823](https://github.com/qmk/qmk_firmware/pull/17823))
+* Add Bit-C PRO converter ([#17827](https://github.com/qmk/qmk_firmware/pull/17827))
+* guard RPC invocation by checking RPC info against crc checksum ([#17840](https://github.com/qmk/qmk_firmware/pull/17840))
+* Add ST7735 driver to Quantum Painter ([#17848](https://github.com/qmk/qmk_firmware/pull/17848))
+* Add minimal STM32F103C6 support ([#17853](https://github.com/qmk/qmk_firmware/pull/17853))
+* Remove legacy AVR ssd1306 driver ([#17864](https://github.com/qmk/qmk_firmware/pull/17864))
+* Remove tmk_core 'serial' code ([#17866](https://github.com/qmk/qmk_firmware/pull/17866))
+* Use LT_ZCAR in place of LT_PLUS for modded kc definitions of keymap_lithuanian_qwerty.h ([#18000](https://github.com/qmk/qmk_firmware/pull/18000))
+* Remove invisible variation selector-15 from keymap_japanese.h ([#18007](https://github.com/qmk/qmk_firmware/pull/18007))
+* define CZ_PERC S(CZ_PLUS) → define CZ_PERC S(CZ_EQL) ([#18008](https://github.com/qmk/qmk_firmware/pull/18008))
+* KR_DQUO S(KR_COLN) → KR_DQUO S(KR_QUOT) in keymap_korean.h ([#18011](https://github.com/qmk/qmk_firmware/pull/18011))
+* Replace ; by : in the shifted symbols ASCII art of keymap_norman ([#18029](https://github.com/qmk/qmk_firmware/pull/18029))
+* Add eeprom defaults for tinyuf2 bootloader ([#18042](https://github.com/qmk/qmk_firmware/pull/18042))
+* Remove duplicate COMBINING HORN in keymap_us_extended.h ([#18045](https://github.com/qmk/qmk_firmware/pull/18045))
+* Nix shell updates for `develop` ([#18131](https://github.com/qmk/qmk_firmware/pull/18131))
+
+CLI:
+* Add cli command to import keyboard|keymap|kbfirmware ([#16668](https://github.com/qmk/qmk_firmware/pull/16668))
+* Publish data as part of API generation ([#17020](https://github.com/qmk/qmk_firmware/pull/17020))
+* Allow encoder config from info.json ([#17295](https://github.com/qmk/qmk_firmware/pull/17295))
+* `qmk doctor`: show arch for macOS ([#17356](https://github.com/qmk/qmk_firmware/pull/17356))
+* Use --exclude-from=.gitignore in place of --exclude-standard ([#17399](https://github.com/qmk/qmk_firmware/pull/17399))
+* Improve importer workflow ([#17707](https://github.com/qmk/qmk_firmware/pull/17707))
+* Remove legacy bootmagic cli parsing ([#18099](https://github.com/qmk/qmk_firmware/pull/18099))
+* Align CLI requirements ([#18117](https://github.com/qmk/qmk_firmware/pull/18117))
+
+Submodule updates:
+* Add Raspberry Pi RP2040 support ([#14877](https://github.com/qmk/qmk_firmware/pull/14877))
+* Update mpaland/printf to eyalroz/printf fork ([#16163](https://github.com/qmk/qmk_firmware/pull/16163))
+* Generic wear-leveling algorithm ([#16996](https://github.com/qmk/qmk_firmware/pull/16996))
+* Update LUFA submodule ([#17368](https://github.com/qmk/qmk_firmware/pull/17368))
+* Update V-USB submodule ([#17385](https://github.com/qmk/qmk_firmware/pull/17385))
+* Update ChibiOS-Contrib ([#17540](https://github.com/qmk/qmk_firmware/pull/17540))
+* Update to latest ChibiOS-Contrib. ([#18016](https://github.com/qmk/qmk_firmware/pull/18016))
+* Update LUFA submodule ([#18168](https://github.com/qmk/qmk_firmware/pull/18168))
+
+Keyboards:
+* GMMK 2 WBG7 MCU compatibility ([#16436](https://github.com/qmk/qmk_firmware/pull/16436))
+* bastardkb: restructure folder hierarchy ([#16778](https://github.com/qmk/qmk_firmware/pull/16778))
+* Add Gentleman 65 SE Solderd PCB support ([#16992](https://github.com/qmk/qmk_firmware/pull/16992))
+* Move/Rename to Hillside48, simplify default keymap ([#17210](https://github.com/qmk/qmk_firmware/pull/17210))
+* IDOBAO ID67 code touch-ups and include factory keymap ([#17231](https://github.com/qmk/qmk_firmware/pull/17231))
+* IDOBAO ID87v2 code rewrite and include factory keymap ([#17232](https://github.com/qmk/qmk_firmware/pull/17232))
+* IDOBAO ID80v3 code rewrite and include factory keymap ([#17234](https://github.com/qmk/qmk_firmware/pull/17234))
+* IDOBAO ID80v1 folder rename ([#17265](https://github.com/qmk/qmk_firmware/pull/17265))
+* Fine!40 PCB Support ([#17426](https://github.com/qmk/qmk_firmware/pull/17426))
+* Update Charybdis code for Extended Mouse reports ([#17435](https://github.com/qmk/qmk_firmware/pull/17435))
+* (develop)AP2: Enable support for WL EEPROM Driver ([#17506](https://github.com/qmk/qmk_firmware/pull/17506))
+* (develop)Keychron Q2: Enable support for WL EEPROM Driver ([#17507](https://github.com/qmk/qmk_firmware/pull/17507))
+* Add Adafruit Macropad RP2040 ([#17512](https://github.com/qmk/qmk_firmware/pull/17512))
+* Add RP2040 config defaults ([#17557](https://github.com/qmk/qmk_firmware/pull/17557))
+* Add support keyboard Feker IK75 ([#17611](https://github.com/qmk/qmk_firmware/pull/17611))
+* boardsource/holiday/spooky data driven ([#17632](https://github.com/qmk/qmk_firmware/pull/17632))
+* boardsource/lulu data driven ([#17638](https://github.com/qmk/qmk_firmware/pull/17638))
+* Added support for gmmk pro rev2 keyboard. ([#17655](https://github.com/qmk/qmk_firmware/pull/17655))
+* boardsource/microdox data driven ([#17675](https://github.com/qmk/qmk_firmware/pull/17675))
+* Remove full bootmagic config from user files ([#17702](https://github.com/qmk/qmk_firmware/pull/17702))
+* (develop) Update bootmagic for Adafruit Macropad ([#17755](https://github.com/qmk/qmk_firmware/pull/17755))
+* Add a kb2040 version of the onkey keyboard that works with the oled keymap ([#17786](https://github.com/qmk/qmk_firmware/pull/17786))
+* Enable mousekeys by default for RGBKB Sol3 ([#17842](https://github.com/qmk/qmk_firmware/pull/17842))
+* More glyph transformations for spidey3 userspace ([#17854](https://github.com/qmk/qmk_firmware/pull/17854))
+* Default rgblight ([#17855](https://github.com/qmk/qmk_firmware/pull/17855))
+* Refactor satt/comet46 to use core OLED driver ([#17856](https://github.com/qmk/qmk_firmware/pull/17856))
+* Convert yosino58 to use split common ([#17861](https://github.com/qmk/qmk_firmware/pull/17861))
+* Migrate crkbd keymaps to oled driver ([#17863](https://github.com/qmk/qmk_firmware/pull/17863))
+* Overhaul uzu42 ([#17868](https://github.com/qmk/qmk_firmware/pull/17868))
+* Update ginkgo65hot to allow use of community layouts ([#17911](https://github.com/qmk/qmk_firmware/pull/17911))
+* Remove `UNUSED_PINS` ([#17931](https://github.com/qmk/qmk_firmware/pull/17931))
+* RESET -> QK_BOOT user keymaps ([#17940](https://github.com/qmk/qmk_firmware/pull/17940))
+* Add cursor layer to DMQ Spin ([#17996](https://github.com/qmk/qmk_firmware/pull/17996))
+* add new keyboard 'soda/cherish' ([#18057](https://github.com/qmk/qmk_firmware/pull/18057))
+* Move keyboard USB IDs and strings to data driven: develop ([#18152](https://github.com/qmk/qmk_firmware/pull/18152))
+
+Keyboard fixes:
+* Fixup SPI mode 3 => 0 on tzarc/djinn, `develop`. ([#17440](https://github.com/qmk/qmk_firmware/pull/17440))
+* Fixup doio/kb16 ([#17545](https://github.com/qmk/qmk_firmware/pull/17545))
+* Adafruit Macropad: Add VIA keymap, fix default km ([#17735](https://github.com/qmk/qmk_firmware/pull/17735))
+* Fix compilation issues for Charybdis/Dilemma ([#17791](https://github.com/qmk/qmk_firmware/pull/17791))
+* bastardkb: fix info.json changes that got reverted during the last merge from `master` to `develop` ([#17800](https://github.com/qmk/qmk_firmware/pull/17800))
+* Fixup uzu42 ([#17867](https://github.com/qmk/qmk_firmware/pull/17867))
+* use correct function in Dilemma splinky ([#17923](https://github.com/qmk/qmk_firmware/pull/17923))
+* Fix compilation issues for Boardsource Microdox ([#18037](https://github.com/qmk/qmk_firmware/pull/18037))
+* Fixup gmmk/pro/rev2 USB Data ([#18056](https://github.com/qmk/qmk_firmware/pull/18056))
+
+Others:
+* backlight|led 'on state' for DD configuration ([#17383](https://github.com/qmk/qmk_firmware/pull/17383))
+* Dump out the largest symbols in flash and in RAM. ([#17397](https://github.com/qmk/qmk_firmware/pull/17397))
+* Re-order user space rules inclusion ([#17459](https://github.com/qmk/qmk_firmware/pull/17459))
+* Update feature_split_keyboard.md to add extra detail about left and right matrices. ([#17492](https://github.com/qmk/qmk_firmware/pull/17492))
+* Swap F4x1 default board files away from blackpill ([#17522](https://github.com/qmk/qmk_firmware/pull/17522))
+* Add converter docs ([#17593](https://github.com/qmk/qmk_firmware/pull/17593))
+* Updates to Pointing Device Docs ([#17777](https://github.com/qmk/qmk_firmware/pull/17777))
+* Add deprecated check for RGBLIGHT_ANIMATIONS ([#17832](https://github.com/qmk/qmk_firmware/pull/17832))
+* Remove OLED driver Split Common warning ([#17862](https://github.com/qmk/qmk_firmware/pull/17862))
+* Revert " Re-order user space rules inclusion (#17459)" ([#18032](https://github.com/qmk/qmk_firmware/pull/18032))
+
+Bugs:
+* Minor schema fixes ([#14200](https://github.com/qmk/qmk_firmware/pull/14200))
+* Fix buffer size for WS2812 PWM driver ([#17046](https://github.com/qmk/qmk_firmware/pull/17046))
+* Fix AVR I2C master 1ms timeout ([#17174](https://github.com/qmk/qmk_firmware/pull/17174))
+* Mouse key kinetic mode fix ([#17176](https://github.com/qmk/qmk_firmware/pull/17176))
+* Fix RGB heatmap to use XY positions and use correct led limits. ([#17184](https://github.com/qmk/qmk_firmware/pull/17184))
+* Fix keys being discarded after using the leader key ([#17287](https://github.com/qmk/qmk_firmware/pull/17287))
+* Fixup pimoroni trackball ([#17335](https://github.com/qmk/qmk_firmware/pull/17335))
+* Fix via builds broken by brightness scaling ([#17354](https://github.com/qmk/qmk_firmware/pull/17354))
+* SPI Bugfix for ChibiOS `21.11.1` => `21.11.2` ([#17371](https://github.com/qmk/qmk_firmware/pull/17371))
+* Additional schema fixes ([#17414](https://github.com/qmk/qmk_firmware/pull/17414))
+* Fix deadlocks on disconnected secondary half ([#17423](https://github.com/qmk/qmk_firmware/pull/17423))
+* [Fix] Fix compilation warning for non-split keebs after #17423 ([#17439](https://github.com/qmk/qmk_firmware/pull/17439))
+* Fix Caps Word to treat mod-taps more consistently. ([#17463](https://github.com/qmk/qmk_firmware/pull/17463))
+* Fix docs regarding `USB_SUSPEND_WAKEUP_DELAY` ([#17501](https://github.com/qmk/qmk_firmware/pull/17501))
+* Fixup SSD1351 build after #17438 ([#17533](https://github.com/qmk/qmk_firmware/pull/17533))
+* Fixup SPI init procedure, SPI EEPROM sequencing ([#17534](https://github.com/qmk/qmk_firmware/pull/17534))
+* Fix Caps Word capitalization when used with Combos + Auto Shift. ([#17549](https://github.com/qmk/qmk_firmware/pull/17549))
+* Allow for `keymaps` array to be implemented in a file other than `$(KEYMAP_C)` ([#17559](https://github.com/qmk/qmk_firmware/pull/17559))
+* [Fix] printf update aftermath ([#17584](https://github.com/qmk/qmk_firmware/pull/17584))
+* Fix rgbkb/sol/rev2 build issues ([#17601](https://github.com/qmk/qmk_firmware/pull/17601))
+* More DD encoder fixes ([#17615](https://github.com/qmk/qmk_firmware/pull/17615))
+* [Fix] Make ChibiOS `_wait.h` independent of `quantum.h` ([#17645](https://github.com/qmk/qmk_firmware/pull/17645))
+* Grammar fixes for docs/feature_converters.md ([#17652](https://github.com/qmk/qmk_firmware/pull/17652))
+* Fix compilation issue with Cirque Guestures file ([#17656](https://github.com/qmk/qmk_firmware/pull/17656))
+* Fix compile issue with LED Matrix ([#17658](https://github.com/qmk/qmk_firmware/pull/17658))
+* Post-bootloader EFL/SPI fixes. ([#17661](https://github.com/qmk/qmk_firmware/pull/17661))
+* Fix LED limit loop ([#17678](https://github.com/qmk/qmk_firmware/pull/17678))
+* [Fix] Use correct angle tune range of +/-30 on PMW33XX ([#17693](https://github.com/qmk/qmk_firmware/pull/17693))
+* Fix AVR compilation of FNV by using standard integer typenames. ([#17716](https://github.com/qmk/qmk_firmware/pull/17716))
+* fix syntax error in header file ([#17732](https://github.com/qmk/qmk_firmware/pull/17732))
+* Fix custom debug function and sample output ([#17790](https://github.com/qmk/qmk_firmware/pull/17790))
+* Fix QK_MAKE's reboot check ([#17795](https://github.com/qmk/qmk_firmware/pull/17795))
+* Chibios: Stop I2C peripheral on transaction error ([#17798](https://github.com/qmk/qmk_firmware/pull/17798))
+* Fix ChibiOS `i2c_master` error codes ([#17808](https://github.com/qmk/qmk_firmware/pull/17808))
+* Update ChibiOS Contrib for RP2040 fixes ([#17817](https://github.com/qmk/qmk_firmware/pull/17817))
+* RP2040 disable PIO IRQs on serial timeout ([#17839](https://github.com/qmk/qmk_firmware/pull/17839))
+* Fix POINTING_DEVICE_GESTURES_SCROLL_ENABLE typo ([#17850](https://github.com/qmk/qmk_firmware/pull/17850))
+* Fixup compilation of printf-like functions with uint32_t args. ([#17904](https://github.com/qmk/qmk_firmware/pull/17904))
+* Fix issue with #17904. ([#17905](https://github.com/qmk/qmk_firmware/pull/17905))
+* Always run pointing device init ([#17936](https://github.com/qmk/qmk_firmware/pull/17936))
+* Align TO() max layers with other keycodes ([#17989](https://github.com/qmk/qmk_firmware/pull/17989))
+* Fix Bépo's BP_NNBS (narrow non-breaking space) ([#17999](https://github.com/qmk/qmk_firmware/pull/17999))
+* Move Encoder+Encoder Map from generic features ([#18018](https://github.com/qmk/qmk_firmware/pull/18018))
+* Fix wrong varaible in encoder block ([#18020](https://github.com/qmk/qmk_firmware/pull/18020))
+* Fix LV_CCAR and LV_NCED in keymap_latvian.h ([#18025](https://github.com/qmk/qmk_firmware/pull/18025))
+* Use ANSI ASCII art and fix comments for LT_COLN and LT_UNDS in keymap_lithuanian_qwerty.h ([#18028](https://github.com/qmk/qmk_firmware/pull/18028))
+* Partially revert some WB32 specific changes ([#18038](https://github.com/qmk/qmk_firmware/pull/18038))
+* Fix Emulated EEPROM issue with F466 ([#18039](https://github.com/qmk/qmk_firmware/pull/18039))
+* Fix DV_SCLN and DV_COLN in keymap_spanish_dvorak.h ([#18043](https://github.com/qmk/qmk_firmware/pull/18043))
+* Fix missing development_board schema entry ([#18050](https://github.com/qmk/qmk_firmware/pull/18050))
+* Add key event check to `is_tap_record` and remove `is_tap_key` ([#18063](https://github.com/qmk/qmk_firmware/pull/18063))
+* Fix GD32VF103 WS2812 PWM driver ([#18067](https://github.com/qmk/qmk_firmware/pull/18067))
+* Fix new-keyboard default for RP2040 bootloader ([#18100](https://github.com/qmk/qmk_firmware/pull/18100))
+* Fixup F4xx wear-leveling bootloader check ([#18102](https://github.com/qmk/qmk_firmware/pull/18102))
+* Fix PID value for the Keyboardio Atreus 2 bootloader ([#18116](https://github.com/qmk/qmk_firmware/pull/18116))
+* Add missing SS_LOPT and SS_ROPT defines ([#18175](https://github.com/qmk/qmk_firmware/pull/18175))

docs/ChangeLog/20221126.md

@@ -0,0 +1,510 @@
+# QMK Breaking Changes - 2022 November 26 Changelog
+
+## Notable Features :id=notable-features
+
+### Autocorrect ([#15699](https://github.com/qmk/qmk_firmware/pull/15699)) :id=autocorrect
+
+_@getreuer_ in their infinite wisdom decided that autocorrect was a feature needed by QMK. As is customary, _@drashna_ adapted it to core and got it into a state that everyone else can use it. See [Feature: Autocorrect](feature_autocorrect.md) for more ifnormation (grin).
+
+## Changes Requiring User Action :id=changes-requiring-user-action
+
+### Updated Keyboard Codebases :id=updated-keyboard-codebases
+
+The following keyboards have had their source moved within QMK:
+
+| Old Keyboard Name                    | New Keyboard Name                    |
+|--------------------------------------|--------------------------------------|
+| converter/numeric_keypad_IIe         | converter/numeric_keypad_iie         |
+| durgod/k3x0/k310                     | durgod/k310                          |
+| durgod/k3x0/k320                     | durgod/k320                          |
+| emptystring/NQG                      | emptystring/nqg                      |
+| handwired/hillside/46                | hillside/46                          |
+| handwired/hillside/48                | hillside/48                          |
+| handwired/hillside/52                | hillside/52                          |
+| maple_computing/christmas_tree/V2017 | maple_computing/christmas_tree/v2017 |
+
+### Keycodes refactoring :id=keycodes-overhaul-user-action
+
+QMK's keycodes got a very significant overhaul this breaking changes cycle, with the bulk of the work done by _@zvecr_ and _@fauxpark_ -- renaming, reordering, removing has been their focus in this area. In an attempt to standardise interoperation with host applications, keycode values now have strong versioning so that any connected application has confidence that the keys it thinks exist on the board actually match up with what's compiled in. These strongly-versioned keycode definitions are now published online and will not change, so tools that remap keycodes have a reference to work with. In future versions of QMK, any new or changed keycodes will result in a new version specification. See [API docs](api_docs.md#qmk-constants) for more information on the published versions if you're writing a tool to manage keycodes.
+
+In most cases user keymaps in the repository have already been updated to reflect the new naming scheme. In some cases user keymaps outside the repository may strike a missing keycode with the old name -- it's highly likely that the name had already been deprecated for some time, and should have been updated previously.
+
+See below for the full list of changesets.
+
+!> Keycode aliases have been put in place in most cases to cater for "old names" being mapped to "new names" -- the documentation already reflects all the new naming of keys.
+
+### Configuration Item Refactoring :id=config-refactoring
+
+A number of configuration items have been renamed for consistency.
+
+RGB Matrix configuration:
+
+| Old Config              | New Config              |
+|-------------------------|-------------------------|
+| DRIVER_LED_COUNT        | RGB_MATRIX_LED_COUNT    |
+| RGB_DISABLE_TIMEOUT     | RGB_MATRIX_TIMEOUT      |
+| RGB_MATRIX_STARTUP_HUE  | RGB_MATRIX_DEFAULT_HUE  |
+| RGB_MATRIX_STARTUP_MODE | RGB_MATRIX_DEFAULT_MODE |
+| RGB_MATRIX_STARTUP_SAT  | RGB_MATRIX_DEFAULT_SAT  |
+| RGB_MATRIX_STARTUP_SPD  | RGB_MATRIX_DEFAULT_SPD  |
+| RGB_MATRIX_STARTUP_VAL  | RGB_MATRIX_DEFAULT_VAL  |
+
+LED Matrix configuration:
+
+| Old Config              | New Config              |
+|-------------------------|-------------------------|
+| DRIVER_LED_COUNT        | LED_MATRIX_LED_COUNT    |
+| LED_DISABLE_TIMEOUT     | LED_MATRIX_TIMEOUT      |
+| LED_MATRIX_STARTUP_MODE | LED_MATRIX_DEFAULT_MODE |
+| LED_MATRIX_STARTUP_SPD  | LED_MATRIX_DEFAULT_SPD  |
+| LED_MATRIX_STARTUP_VAL  | LED_MATRIX_DEFAULT_VAL  |
+
+Joystick configuration:
+
+| Old Config               | New Config               |
+|--------------------------|--------------------------|
+| JOYSTICK_AXES_COUNT      | JOYSTICK_AXIS_COUNT      |
+| JOYSTICK_AXES_RESOLUTION | JOYSTICK_AXIS_RESOLUTION |
+
+### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) :id=usb-ids-Refactoring
+
+QMK has decided to deprecate the specification of USB IDs inside `config.h` in favour of `info.json`, leaving data-driven as the only method to specify USB information. As per the deprecation schedule put forward last breaking changes cycle, USB information must be specified in `info.json` instead.
+
+Previously in `config.h`:
+```c
+#define VENDOR_ID    0x1234
+#define PRODUCT_ID   0x5678
+#define DEVICE_VER   0x0001
+#define MANUFACTURER Me
+#define PRODUCT      MyKeyboard
+```
+
+Replaced by `info.json`:
+```json
+{
+    "keyboard_name": "MyKeyboard",
+    "manufacturer": "Me",
+    "usb": {
+        "vid": "0x1234",
+        "pid": "0x5678",
+        "device_version": "0.0.1"
+    }
+}
+```
+
+### LED Indicator callback refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/18450)) :id=led-callback-refactor
+
+_RGB Matrix_ and _LED Matrix_ Indicator display code was traditionally difficult to override in keymaps as they did not follow the standard pattern of `bool *_kb()` deferring to `bool *_user()` functions, allowing signalling to the higher level that processing had already been done.
+
+This changes the standard callback model to allow for a base implementation to be provided by a keyboard, but also still allow for keymap-level overrides without needing to modify the keyboard's code.
+
+The old RGB Matrix keymap code went something like this:
+
+```c
+void rgb_matrix_indicators_user(void) {
+    // keymap LED code
+}
+```
+
+...but the new RGB Matrix keymap code looks like this:
+```c
+bool rgb_matrix_indicators_user(void) {
+    // keymap LED code
+    return false;
+}
+```
+
+Keyboard designers should now structure their keyboard-level routines like the following, in order to allow for keymap overrides:
+
+```c
+bool rgb_matrix_indicators_kb(void) {
+    // Defer to the keymap if they want to override
+    if (!rgb_matrix_indicators_user()) { return false; }
+
+    // keyboard LED code
+    return true;
+}
+```
+
+The equivalent transformations should be done for LED Matrix boards.
+
+### Unicode mode refactoring :id=unicode-mode-renaming
+
+Unicode modes were renamed in order to prevent collision with equivalent keycodes. The available values for `UNICODE_SELECTED_MODES` changed -- see [Feature: Unicode](feature_unicode.md#setting-the-input-mode) for the new list of values and how to configure them.
+
+## Notable core changes :id=notable-core
+
+This breaking changes cycle, a lot of the core changes are related to cleanup and refactoring -- commonly called "tech debt".
+
+### Keycodes refactoring :id=keycodes-overhaul-core-changes
+
+We aren't going to list each and every change -- they're far too numerous -- instead, we'll just list the related PRs in order to convey just how wide-reaching these changes were:
+
+* Align audio keycode names ([#18962](https://github.com/qmk/qmk_firmware/pull/18962))
+* Align dynamic tapping term keycode names ([#18963](https://github.com/qmk/qmk_firmware/pull/18963))
+* Align haptic feedback keycode names ([#18964](https://github.com/qmk/qmk_firmware/pull/18964))
+* Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` ([#18834](https://github.com/qmk/qmk_firmware/pull/18834))
+* Deprecate `KC_LEAD` for `QK_LEAD` ([#18792](https://github.com/qmk/qmk_firmware/pull/18792))
+* Deprecate `KC_LOCK` for `QK_LOCK` ([#18796](https://github.com/qmk/qmk_firmware/pull/18796))
+* Deprecate `KEY_OVERRIDE_*` keycodes for `KO_*` ([#18843](https://github.com/qmk/qmk_firmware/pull/18843))
+* Deprecate `ONESHOT_*` keycodes for `QK_ONE_SHOT_*` ([#18844](https://github.com/qmk/qmk_firmware/pull/18844))
+* Deprecate `SECURE_*` keycodes for `QK_SECURE_*` ([#18847](https://github.com/qmk/qmk_firmware/pull/18847))
+* Deprecate `VLK_TOG` for `VK_TOGG` ([#18807](https://github.com/qmk/qmk_firmware/pull/18807))
+* Initial DD keycode migration ([#18643](https://github.com/qmk/qmk_firmware/pull/18643))
+* Macro keycode name refactoring ([#18958](https://github.com/qmk/qmk_firmware/pull/18958))
+* Move mousekey keycodes into newly freed up keycode block ([#16076](https://github.com/qmk/qmk_firmware/pull/16076))
+* Normalise Auto Shift keycodes ([#18892](https://github.com/qmk/qmk_firmware/pull/18892))
+* Normalise Autocorrect keycodes ([#18893](https://github.com/qmk/qmk_firmware/pull/18893))
+* Normalise Combo keycodes ([#18877](https://github.com/qmk/qmk_firmware/pull/18877))
+* Normalise Dynamic Macro keycodes ([#18939](https://github.com/qmk/qmk_firmware/pull/18939))
+* Normalise Joystick and Programmable Button keycodes ([#18832](https://github.com/qmk/qmk_firmware/pull/18832))
+* Normalise MIDI keycodes ([#18972](https://github.com/qmk/qmk_firmware/pull/18972))
+* Normalise output selection (Bluetooth) keycodes ([#19004](https://github.com/qmk/qmk_firmware/pull/19004))
+* Normalise Space Cadet keycodes ([#18864](https://github.com/qmk/qmk_firmware/pull/18864))
+* Normalise Unicode keycodes ([#18898](https://github.com/qmk/qmk_firmware/pull/18898))
+* Publish constants metadata to API ([#19143](https://github.com/qmk/qmk_firmware/pull/19143))
+* Relocate US ANSI shifted keycode aliases ([#18634](https://github.com/qmk/qmk_firmware/pull/18634))
+* Remove `KC_DELT` ([#18882](https://github.com/qmk/qmk_firmware/pull/18882))
+* Remove `UNICODE_KEY_OSX` and `UC_OSX` ([#18290](https://github.com/qmk/qmk_firmware/pull/18290))
+* Remove deprecated RESET keycode alias ([#18271](https://github.com/qmk/qmk_firmware/pull/18271))
+* Remove legacy Debug keycode ([#18769](https://github.com/qmk/qmk_firmware/pull/18769))
+* Remove legacy EEPROM clear keycodes ([#18782](https://github.com/qmk/qmk_firmware/pull/18782))
+* Remove legacy fauxclicky and unicode keycodes ([#18800](https://github.com/qmk/qmk_firmware/pull/18800))
+* Remove legacy Grave Escape keycodes ([#18787](https://github.com/qmk/qmk_firmware/pull/18787))
+* Remove legacy international keycodes ([#18588](https://github.com/qmk/qmk_firmware/pull/18588))
+* Remove legacy keycodes, part 2 ([#18660](https://github.com/qmk/qmk_firmware/pull/18660))
+* Remove legacy keycodes, part 3 ([#18669](https://github.com/qmk/qmk_firmware/pull/18669))
+* Remove legacy keycodes, part 4 ([#18683](https://github.com/qmk/qmk_firmware/pull/18683))
+* Remove legacy keycodes, part 5 ([#18710](https://github.com/qmk/qmk_firmware/pull/18710))
+* Remove legacy keycodes, part 6 ([#18740](https://github.com/qmk/qmk_firmware/pull/18740))
+* Remove legacy locking caps/num/scroll keycodes ([#18601](https://github.com/qmk/qmk_firmware/pull/18601))
+* Remove legacy sendstring keycodes ([#18749](https://github.com/qmk/qmk_firmware/pull/18749))
+* Reworked backlight keycodes. ([#18961](https://github.com/qmk/qmk_firmware/pull/18961))
+
+### Board Converters :id=board-converters
+
+There was additional work in the space of board converters -- historically QMK allowed for "converting" a Pro Micro build to a QMK Proton-C build. The last few versions of QMK have added support for replacement boards much like the Proton-C, and this quarter was no exception:
+
+* Add Bonsai C4 as a platform board file ([#18901](https://github.com/qmk/qmk_firmware/pull/18901))
+* Add converter support to keymap.json ([#18776](https://github.com/qmk/qmk_firmware/pull/18776))
+* Add Elite-C to converters ([#18309](https://github.com/qmk/qmk_firmware/pull/18309))
+* Add Elite-Pi converter ([#18236](https://github.com/qmk/qmk_firmware/pull/18236))
+* Allow QK_MAKE to work with converters ([#18637](https://github.com/qmk/qmk_firmware/pull/18637))
+
+See [Feature: Converters](feature_converters.md) for the full list of board conversions available.
+
+### Pointing and Digitizer device updates :id=pointing-and-digitizer
+
+Both pointing devices and digitizer got a host of updates this cycle. Inertia, automatic mouse layers, fixes for preventing sleep... you even get more buttons with digitizers!
+
+* add "inertia" mode for mouse keys ([#18774](https://github.com/qmk/qmk_firmware/pull/18774))
+* Digitizer feature improvements ([#19034](https://github.com/qmk/qmk_firmware/pull/19034))
+* Enabling Pointing Device support in register code functions ([#18363](https://github.com/qmk/qmk_firmware/pull/18363))
+* Feature: pointing device automatic mouse layer ([#17962](https://github.com/qmk/qmk_firmware/pull/17962))
+* Fix mouse report comparison failing on shared EP (fixes KB preventing sleep) ([#18060](https://github.com/qmk/qmk_firmware/pull/18060))
+* Fix mouse use within send_string ([#18659](https://github.com/qmk/qmk_firmware/pull/18659))
+* Handle mouse keys more consistently ([#18513](https://github.com/qmk/qmk_firmware/pull/18513))
+* Invert pointing device motion pin for cirque touchpads ([#18404](https://github.com/qmk/qmk_firmware/pull/18404))
+* Refactor more host code (programmable button & digitizer) ([#18565](https://github.com/qmk/qmk_firmware/pull/18565))
+
+## Full changelist :id=full-changelist
+
+Core:
+* quantum: led: split out led_update_ports() for customization of led behaviour ([#14452](https://github.com/qmk/qmk_firmware/pull/14452))
+* Add getreuer's Autocorrect feature to core ([#15699](https://github.com/qmk/qmk_firmware/pull/15699))
+* Move mousekey keycodes into newly freed up keycode block ([#16076](https://github.com/qmk/qmk_firmware/pull/16076))
+* Introduce pointing device specific debug messages ([#17663](https://github.com/qmk/qmk_firmware/pull/17663))
+* PWM Backlight for RP2040 ([#17706](https://github.com/qmk/qmk_firmware/pull/17706))
+* Adjust PWM hardware audio driver for RP2040 ([#17723](https://github.com/qmk/qmk_firmware/pull/17723))
+* Prevent tap dance from wiping dynamic macros ([#17880](https://github.com/qmk/qmk_firmware/pull/17880))
+* Feature: pointing device automatic mouse layer ([#17962](https://github.com/qmk/qmk_firmware/pull/17962))
+* Allow custom timings for WS2812 PIO driver ([#18006](https://github.com/qmk/qmk_firmware/pull/18006))
+* Use `TAP_CODE_DELAY` for encoder mapping by default. Add docs. ([#18098](https://github.com/qmk/qmk_firmware/pull/18098))
+* Move Oneshot mod callbacks to after mods are set ([#18101](https://github.com/qmk/qmk_firmware/pull/18101))
+* mcp23018: add return status to init ([#18178](https://github.com/qmk/qmk_firmware/pull/18178))
+* Switch over MANUFACTURER and PRODUCT to string literals ([#18183](https://github.com/qmk/qmk_firmware/pull/18183))
+* Remove deprecated USBasp and bootloadHID bootloader types ([#18195](https://github.com/qmk/qmk_firmware/pull/18195))
+* Chromeos keycodes ([#18212](https://github.com/qmk/qmk_firmware/pull/18212))
+* VIA V3 - The Custom UI Update ([#18222](https://github.com/qmk/qmk_firmware/pull/18222))
+* Move bootloader.mk to platforms ([#18228](https://github.com/qmk/qmk_firmware/pull/18228))
+* Simplify extrakeys sending at the host driver level ([#18230](https://github.com/qmk/qmk_firmware/pull/18230))
+* Add unicode mode change callbacks ([#18235](https://github.com/qmk/qmk_firmware/pull/18235))
+* Add Elite-Pi converter ([#18236](https://github.com/qmk/qmk_firmware/pull/18236))
+* Better handle EEPROM reset keycode ([#18244](https://github.com/qmk/qmk_firmware/pull/18244))
+* Work around WinCompose issue for U+Axxx or U+Exxx ([#18260](https://github.com/qmk/qmk_firmware/pull/18260))
+* Remove deprecated RESET keycode alias ([#18271](https://github.com/qmk/qmk_firmware/pull/18271))
+* Move Bluetooth-related function calls up to host/keyboard level ([#18274](https://github.com/qmk/qmk_firmware/pull/18274))
+* Added analog support for WB32 MCU. ([#18289](https://github.com/qmk/qmk_firmware/pull/18289))
+* Remove `UNICODE_KEY_OSX` and `UC_OSX` ([#18290](https://github.com/qmk/qmk_firmware/pull/18290))
+* Add Elite-C to converters ([#18309](https://github.com/qmk/qmk_firmware/pull/18309))
+* RN42 driver: small cleanups ([#18310](https://github.com/qmk/qmk_firmware/pull/18310))
+* Reboot wb32 devices after flashing ([#18323](https://github.com/qmk/qmk_firmware/pull/18323))
+* Refactor Unicode feature ([#18333](https://github.com/qmk/qmk_firmware/pull/18333))
+* Move fake EE_HANDS from EEPROM init. ([#18352](https://github.com/qmk/qmk_firmware/pull/18352))
+* Enabling Pointing Device support in register code functions ([#18363](https://github.com/qmk/qmk_firmware/pull/18363))
+* Start Bluetooth API ([#18366](https://github.com/qmk/qmk_firmware/pull/18366))
+* Add UART support for Kinetis boards ([#18370](https://github.com/qmk/qmk_firmware/pull/18370))
+* [QP] Add RGB565 surface. Docs clarification, cleanup, tabsification, and reordering. ([#18396](https://github.com/qmk/qmk_firmware/pull/18396))
+* Change `DRIVER_LED_COUNT` to `{LED,RGB}_MATRIX_LED_COUNT` ([#18399](https://github.com/qmk/qmk_firmware/pull/18399))
+* Invert pointing device motion pin for cirque touchpads ([#18404](https://github.com/qmk/qmk_firmware/pull/18404))
+* Change `{LED,RGB}_DISABLE_TIMEOUT` to `{LED,RGB}_MATRIX_TIMEOUT` ([#18415](https://github.com/qmk/qmk_firmware/pull/18415))
+* rewrite locking in split transaction handlers ([#18417](https://github.com/qmk/qmk_firmware/pull/18417))
+* remove busy waiting from rgblight functions ([#18418](https://github.com/qmk/qmk_firmware/pull/18418))
+* Serial-protocol: always clear receive queue on main half of split keyboard ([#18419](https://github.com/qmk/qmk_firmware/pull/18419))
+* Stabilize RP2040 Half-duplex PIO split comms take 2 ([#18421](https://github.com/qmk/qmk_firmware/pull/18421))
+* Copy RP2040 vector table to RAM on startup ([#18424](https://github.com/qmk/qmk_firmware/pull/18424))
+* Further refactoring of joystick feature ([#18437](https://github.com/qmk/qmk_firmware/pull/18437))
+* Start moving towards introspection-based data retrieval ([#18441](https://github.com/qmk/qmk_firmware/pull/18441))
+* RP2040: use built-in integer hardware divider and optimized i64 multiplication ([#18464](https://github.com/qmk/qmk_firmware/pull/18464))
+* Only trigger encoder callbacks on primary side ([#18467](https://github.com/qmk/qmk_firmware/pull/18467))
+* Handle mouse keys more consistently ([#18513](https://github.com/qmk/qmk_firmware/pull/18513))
+* Gentoo install script — build newlib with `nano` USE flag ([#18527](https://github.com/qmk/qmk_firmware/pull/18527))
+* Small un/register_code() cleanups ([#18544](https://github.com/qmk/qmk_firmware/pull/18544))
+* Refactor more host code (programmable button & digitizer) ([#18565](https://github.com/qmk/qmk_firmware/pull/18565))
+* Don't clear keys on layer change unless STRICT_LAYER_RELEASE is enabled ([#18577](https://github.com/qmk/qmk_firmware/pull/18577))
+* Remove legacy international keycodes ([#18588](https://github.com/qmk/qmk_firmware/pull/18588))
+* onekey: Enable ADC for STM32F072 Discovery ([#18592](https://github.com/qmk/qmk_firmware/pull/18592))
+* Implement split comms watchdog ([#18599](https://github.com/qmk/qmk_firmware/pull/18599))
+* Remove legacy locking caps/num/scroll keycodes ([#18601](https://github.com/qmk/qmk_firmware/pull/18601))
+* Use `get_u16_str` instead of `snprintf` in `autoshift_timer_report` ([#18606](https://github.com/qmk/qmk_firmware/pull/18606))
+* Refactor `send_extra` ([#18615](https://github.com/qmk/qmk_firmware/pull/18615))
+* LUFA: Consolidate report sending code ([#18629](https://github.com/qmk/qmk_firmware/pull/18629))
+* Relocate US ANSI shifted keycode aliases ([#18634](https://github.com/qmk/qmk_firmware/pull/18634))
+* Allow QK_MAKE to work with converters ([#18637](https://github.com/qmk/qmk_firmware/pull/18637))
+* Programmable Button API refactor and improve docs ([#18641](https://github.com/qmk/qmk_firmware/pull/18641))
+* Initial DD keycode migration ([#18643](https://github.com/qmk/qmk_firmware/pull/18643))
+* Remove legacy keycodes, part 2 ([#18660](https://github.com/qmk/qmk_firmware/pull/18660))
+* Remove legacy keycodes, part 3 ([#18669](https://github.com/qmk/qmk_firmware/pull/18669))
+* Remove legacy keycodes, part 4 ([#18683](https://github.com/qmk/qmk_firmware/pull/18683))
+* Revert "mcp23018: add return status to init" ([#18709](https://github.com/qmk/qmk_firmware/pull/18709))
+* Remove legacy keycodes, part 5 ([#18710](https://github.com/qmk/qmk_firmware/pull/18710))
+* Make QP driver init functions weak. ([#18717](https://github.com/qmk/qmk_firmware/pull/18717))
+* Add unit tests for HOLD_ON_OTHER_KEY_PRESS ([#18721](https://github.com/qmk/qmk_firmware/pull/18721))
+* Remove legacy keycodes, part 6 ([#18740](https://github.com/qmk/qmk_firmware/pull/18740))
+* Remove legacy sendstring keycodes ([#18749](https://github.com/qmk/qmk_firmware/pull/18749))
+* 4 Driver support for IS31FL3737 ([#18750](https://github.com/qmk/qmk_firmware/pull/18750))
+* Remove quantum/audio from global VPATH ([#18753](https://github.com/qmk/qmk_firmware/pull/18753))
+* Widen the ARM Cortex-M family support. Allow USB peripheral change. ([#18767](https://github.com/qmk/qmk_firmware/pull/18767))
+* Remove legacy Debug keycode ([#18769](https://github.com/qmk/qmk_firmware/pull/18769))
+* add "inertia" mode for mouse keys ([#18774](https://github.com/qmk/qmk_firmware/pull/18774))
+* Remove legacy EEPROM clear keycodes ([#18782](https://github.com/qmk/qmk_firmware/pull/18782))
+* Remove legacy Grave Escape keycodes ([#18787](https://github.com/qmk/qmk_firmware/pull/18787))
+* Deprecate `KC_LEAD` for `QK_LEAD` ([#18792](https://github.com/qmk/qmk_firmware/pull/18792))
+* Deprecate `KC_LOCK` for `QK_LOCK` ([#18796](https://github.com/qmk/qmk_firmware/pull/18796))
+* Remove legacy fauxclicky and unicode keycodes ([#18800](https://github.com/qmk/qmk_firmware/pull/18800))
+* Generalise CTPC logic from common_features ([#18803](https://github.com/qmk/qmk_firmware/pull/18803))
+* Deprecate `VLK_TOG` for `VK_TOGG` ([#18807](https://github.com/qmk/qmk_firmware/pull/18807))
+* ChibiOS USB: Add a dummy IN callback to work around LLD bugs ([#18811](https://github.com/qmk/qmk_firmware/pull/18811))
+* Normalise Joystick and Programmable Button keycodes ([#18832](https://github.com/qmk/qmk_firmware/pull/18832))
+* Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` ([#18834](https://github.com/qmk/qmk_firmware/pull/18834))
+* added BS_TOGG so BS_SWAP and BS_NORM can be on a single key ([#18837](https://github.com/qmk/qmk_firmware/pull/18837))
+* Remove some assumptions on sequential keycode ranges ([#18838](https://github.com/qmk/qmk_firmware/pull/18838))
+* Deprecate `KEY_OVERRIDE_*` keycodes for `KO_*` ([#18843](https://github.com/qmk/qmk_firmware/pull/18843))
+* Deprecate `ONESHOT_*` keycodes for `QK_ONE_SHOT_*` ([#18844](https://github.com/qmk/qmk_firmware/pull/18844))
+* Deprecate `SECURE_*` keycodes for `QK_SECURE_*` ([#18847](https://github.com/qmk/qmk_firmware/pull/18847))
+* Normalise Space Cadet keycodes ([#18864](https://github.com/qmk/qmk_firmware/pull/18864))
+* Allow overriding of dynamic keymap start address. ([#18867](https://github.com/qmk/qmk_firmware/pull/18867))
+* Formalise keyboard- and user-specific EEPROM blocks ([#18874](https://github.com/qmk/qmk_firmware/pull/18874))
+* Normalise Combo keycodes ([#18877](https://github.com/qmk/qmk_firmware/pull/18877))
+* Remove rgblight_list.h ([#18878](https://github.com/qmk/qmk_firmware/pull/18878))
+* Remove `KC_DELT` ([#18882](https://github.com/qmk/qmk_firmware/pull/18882))
+* Simplify Keymap Config EEPROM ([#18886](https://github.com/qmk/qmk_firmware/pull/18886))
+* Normalise Auto Shift keycodes ([#18892](https://github.com/qmk/qmk_firmware/pull/18892))
+* Normalise Autocorrect keycodes ([#18893](https://github.com/qmk/qmk_firmware/pull/18893))
+* Normalise Unicode keycodes ([#18898](https://github.com/qmk/qmk_firmware/pull/18898))
+* Add Bonsai C4 as a platform board file ([#18901](https://github.com/qmk/qmk_firmware/pull/18901))
+* Normalise Dynamic Macro keycodes ([#18939](https://github.com/qmk/qmk_firmware/pull/18939))
+* Reduce includes for sequencer header ([#18946](https://github.com/qmk/qmk_firmware/pull/18946))
+* Reduce includes for crc header ([#18947](https://github.com/qmk/qmk_firmware/pull/18947))
+* Reduce includes for caps_word header ([#18948](https://github.com/qmk/qmk_firmware/pull/18948))
+* Reduce includes for wpm header ([#18949](https://github.com/qmk/qmk_firmware/pull/18949))
+* Reduce includes for dip_switch header ([#18951](https://github.com/qmk/qmk_firmware/pull/18951))
+* Reduce includes for send_string header ([#18952](https://github.com/qmk/qmk_firmware/pull/18952))
+* Macro keycode name refactoring ([#18958](https://github.com/qmk/qmk_firmware/pull/18958))
+* Remove thermal printer. ([#18959](https://github.com/qmk/qmk_firmware/pull/18959))
+* Reworked backlight keycodes. ([#18961](https://github.com/qmk/qmk_firmware/pull/18961))
+* Align audio keycode names ([#18962](https://github.com/qmk/qmk_firmware/pull/18962))
+* Align dynamic tapping term keycode names ([#18963](https://github.com/qmk/qmk_firmware/pull/18963))
+* Align haptic feedback keycode names ([#18964](https://github.com/qmk/qmk_firmware/pull/18964))
+* NVRAM refactor, phase 1. ([#18969](https://github.com/qmk/qmk_firmware/pull/18969))
+* Normalise MIDI keycodes ([#18972](https://github.com/qmk/qmk_firmware/pull/18972))
+* Normalise output selection (Bluetooth) keycodes ([#19004](https://github.com/qmk/qmk_firmware/pull/19004))
+* Move EFL wear-leveling driver to be default for F1, F3, F4, L4, G4, WB32, GD32V. ([#19020](https://github.com/qmk/qmk_firmware/pull/19020))
+* Digitizer feature improvements ([#19034](https://github.com/qmk/qmk_firmware/pull/19034))
+* Joystick feature improvements ([#19052](https://github.com/qmk/qmk_firmware/pull/19052))
+* Add default limit to OLED dirty processing ([#19068](https://github.com/qmk/qmk_firmware/pull/19068))
+* Change `RGB_MATRIX_STARTUP_*` defines to `RGB_MATRIX_DEFAULT_*` ([#19079](https://github.com/qmk/qmk_firmware/pull/19079))
+* Change `LED_MATRIX_STARTUP_*` defines to `LED_MATRIX_DEFAULT_*` ([#19080](https://github.com/qmk/qmk_firmware/pull/19080))
+* Extend eeconfig kb/user datablock API ([#19094](https://github.com/qmk/qmk_firmware/pull/19094))
+* Remove .noci functionality ([#19122](https://github.com/qmk/qmk_firmware/pull/19122))
+
+CLI:
+* Reject json with duplicate keys ([#18108](https://github.com/qmk/qmk_firmware/pull/18108))
+* Add pointing device support to data driven config ([#18215](https://github.com/qmk/qmk_firmware/pull/18215))
+* Disconnect `usb.device_ver` ([#18259](https://github.com/qmk/qmk_firmware/pull/18259))
+* Normalise info_config.h define generation ([#18439](https://github.com/qmk/qmk_firmware/pull/18439))
+* Generate DD RGBLight/LED/RGB Matrix animation defines ([#18459](https://github.com/qmk/qmk_firmware/pull/18459))
+* Add converter support to keymap.json ([#18776](https://github.com/qmk/qmk_firmware/pull/18776))
+* Ensure consistent clean behaviour ([#18781](https://github.com/qmk/qmk_firmware/pull/18781))
+* Format DD mappings and schemas ([#18924](https://github.com/qmk/qmk_firmware/pull/18924))
+* Publish hjson files as json ([#18996](https://github.com/qmk/qmk_firmware/pull/18996))
+* Add raw output option for QGF/QFF files. ([#18998](https://github.com/qmk/qmk_firmware/pull/18998))
+* Improve LED config parsing error messages ([#19007](https://github.com/qmk/qmk_firmware/pull/19007))
+* Revert "Add pointing device support to data driven config (#18215)" ([#19063](https://github.com/qmk/qmk_firmware/pull/19063))
+* Additional DD backlight config ([#19124](https://github.com/qmk/qmk_firmware/pull/19124))
+* Publish constants metadata to API ([#19143](https://github.com/qmk/qmk_firmware/pull/19143))
+
+Submodule updates:
+* Use a macro to compute the size of arrays at compile time ([#18044](https://github.com/qmk/qmk_firmware/pull/18044))
+* Update pico-sdk to version 1.4.0 ([#18423](https://github.com/qmk/qmk_firmware/pull/18423))
+
+Keyboards:
+* Rework PS/2 driver selection ([#17892](https://github.com/qmk/qmk_firmware/pull/17892))
+* Durgod K310/K320 Refactor ([#18224](https://github.com/qmk/qmk_firmware/pull/18224))
+* Optimise LAYOUT macro generation ([#18262](https://github.com/qmk/qmk_firmware/pull/18262))
+* Rename keyboards with uppercase letters ([#18268](https://github.com/qmk/qmk_firmware/pull/18268))
+* Remove legacy USE_SERIAL define ([#18292](https://github.com/qmk/qmk_firmware/pull/18292))
+* Resolve conflict merging master to develop ([#18297](https://github.com/qmk/qmk_firmware/pull/18297))
+* Remove legacy define USE_SERIAL_PD2 ([#18298](https://github.com/qmk/qmk_firmware/pull/18298))
+* Remove legacy define SERIAL_USE_MULTI_TRANSACTION ([#18299](https://github.com/qmk/qmk_firmware/pull/18299))
+* Adapt spidey3 userspace to recent unicode refactoring ([#18345](https://github.com/qmk/qmk_firmware/pull/18345))
+* Remove remaining use of terminal keys and related comment labels ([#18402](https://github.com/qmk/qmk_firmware/pull/18402))
+* Add DD mapping for LED/RGB Matrix center ([#18432](https://github.com/qmk/qmk_firmware/pull/18432))
+* develop updates for Drashna Keymaps ([#18472](https://github.com/qmk/qmk_firmware/pull/18472))
+* Remove lingering `DRIVER_LED_TOTAL` references ([#18475](https://github.com/qmk/qmk_firmware/pull/18475))
+* Remove lingering `DRIVER_LED_TOTAL` references ([#18594](https://github.com/qmk/qmk_firmware/pull/18594))
+* update andrebrait GMMK Pro keymap ([#18608](https://github.com/qmk/qmk_firmware/pull/18608))
+* AnnePro2: Adjust RGB flushing ([#18640](https://github.com/qmk/qmk_firmware/pull/18640))
+* Remove lingering `DRIVER_LED_TOTAL` references ([#18662](https://github.com/qmk/qmk_firmware/pull/18662))
+* Update snowe's KC_RESET to use QK_BOOT ([#18667](https://github.com/qmk/qmk_firmware/pull/18667))
+* Remove some .gitignore files ([#18689](https://github.com/qmk/qmk_firmware/pull/18689))
+* Remove keymaps that still reference legacy macros ([#18690](https://github.com/qmk/qmk_firmware/pull/18690))
+* Remove keymaps that still reference legacy macros ([#18693](https://github.com/qmk/qmk_firmware/pull/18693))
+* Remove stale userspace/keymaps ([#18700](https://github.com/qmk/qmk_firmware/pull/18700))
+* Update keyboards readme ([#18714](https://github.com/qmk/qmk_firmware/pull/18714))
+* Allow changes to the moonlander default music map ([#18715](https://github.com/qmk/qmk_firmware/pull/18715))
+* led_update_kb -> led_update_ports where appropriate ([#18716](https://github.com/qmk/qmk_firmware/pull/18716))
+* Update converter/usb_usb user keymaps to use LAYOUT_fullsize ([#18720](https://github.com/qmk/qmk_firmware/pull/18720))
+* Remove RGBLIGHT_ANIMATION and clean up effect defines for G-K ([#18726](https://github.com/qmk/qmk_firmware/pull/18726))
+* Remove RGBLIGHT_ANIMATION and clean up effect defines for L-Q ([#18727](https://github.com/qmk/qmk_firmware/pull/18727))
+* Remove RGBLIGHT_ANIMATION and clean up effect defines for R-Z ([#18728](https://github.com/qmk/qmk_firmware/pull/18728))
+* Remove RGBLIGHT_ANIMATION and clean up effect defines for layouts+users ([#18729](https://github.com/qmk/qmk_firmware/pull/18729))
+* Update info.json configs to explicitly list RGBLIGHT animations ([#18730](https://github.com/qmk/qmk_firmware/pull/18730))
+* A little personal cleanup after #18726 and #18729 ([#18734](https://github.com/qmk/qmk_firmware/pull/18734))
+* Move Hillside out of handwired ([#18751](https://github.com/qmk/qmk_firmware/pull/18751))
+* wilba_tech: allow keymaps to override backlight_effect_indicators() ([#18791](https://github.com/qmk/qmk_firmware/pull/18791))
+* Remove broken userspace and keymaps ([#18806](https://github.com/qmk/qmk_firmware/pull/18806))
+* Add support for KBDfans Odin V2 ([#18910](https://github.com/qmk/qmk_firmware/pull/18910))
+* Remove more `UNUSED_PINS` defines ([#18940](https://github.com/qmk/qmk_firmware/pull/18940))
+* Remove hardcoded VIA keycode range ([#18956](https://github.com/qmk/qmk_firmware/pull/18956))
+* KC_GESC -> QK_GESC, better alignment for OCD ([#19018](https://github.com/qmk/qmk_firmware/pull/19018))
+* Add missing `manufacturer` fields ([#19065](https://github.com/qmk/qmk_firmware/pull/19065))
+* Update use of legacy keycodes ([#19120](https://github.com/qmk/qmk_firmware/pull/19120))
+
+Keyboard fixes:
+* [GMMK Pro] Fix unintentional taps to the volume keys when using the encoder ([#17129](https://github.com/qmk/qmk_firmware/pull/17129))
+* Luna keyboard pet OLED timeout fix ([#17189](https://github.com/qmk/qmk_firmware/pull/17189))
+* Handle escaping of manufacturer/product strings ([#18194](https://github.com/qmk/qmk_firmware/pull/18194))
+* kegen/gboy: add manufacturer string ([#18196](https://github.com/qmk/qmk_firmware/pull/18196))
+* Ensure all keyboards have a bootloader set ([#18234](https://github.com/qmk/qmk_firmware/pull/18234))
+* Reverse keymap search order ([#18449](https://github.com/qmk/qmk_firmware/pull/18449))
+* Fixup cradio bootloader/processor ([#18477](https://github.com/qmk/qmk_firmware/pull/18477))
+* onekey: enable ADC for Bluepill and Blackpill ([#18545](https://github.com/qmk/qmk_firmware/pull/18545))
+* Fixup controllerworks/mini42 ([#18553](https://github.com/qmk/qmk_firmware/pull/18553))
+* RESET -> QK_BOOT user keymaps ([#18560](https://github.com/qmk/qmk_firmware/pull/18560))
+* Fixup linworks/fave84h ([#18593](https://github.com/qmk/qmk_firmware/pull/18593))
+* Fix compilation of 1upkeyboards on develop ([#18618](https://github.com/qmk/qmk_firmware/pull/18618))
+* Various keyboard fixes ([#18649](https://github.com/qmk/qmk_firmware/pull/18649))
+* Fixup twig50 ([#18651](https://github.com/qmk/qmk_firmware/pull/18651))
+* Fixup handwired/jopr — remove deprecated keycode ([#18668](https://github.com/qmk/qmk_firmware/pull/18668))
+* Fixup keychron/q3 ([#18687](https://github.com/qmk/qmk_firmware/pull/18687))
+* Fixup dumbpad/v3x ([#18692](https://github.com/qmk/qmk_firmware/pull/18692))
+* Fix aurora/sweep ([#18701](https://github.com/qmk/qmk_firmware/pull/18701))
+* Fix build failures uncovered by #18753 ([#18789](https://github.com/qmk/qmk_firmware/pull/18789))
+* Fixup emptystring/nqg ([#18804](https://github.com/qmk/qmk_firmware/pull/18804))
+* Fixup controllerwords/mini36 ([#18840](https://github.com/qmk/qmk_firmware/pull/18840))
+* Fixup 1upkeyboards/pi60_rgb ([#18858](https://github.com/qmk/qmk_firmware/pull/18858))
+* Fixup doio/kb16 ([#18859](https://github.com/qmk/qmk_firmware/pull/18859))
+* Fixup keebio/sinc/rev3 ([#18866](https://github.com/qmk/qmk_firmware/pull/18866))
+* elephant42: fix default keymap ([#18884](https://github.com/qmk/qmk_firmware/pull/18884))
+* Properly fix elephant42 ([#18908](https://github.com/qmk/qmk_firmware/pull/18908))
+* Fix syntax error introduced in #18800 ([#18933](https://github.com/qmk/qmk_firmware/pull/18933))
+* Resolve info.json/rules.mk feature conflicts in three boards ([#18942](https://github.com/qmk/qmk_firmware/pull/18942))
+* Fix DD warnings for RGBKB boards ([#18944](https://github.com/qmk/qmk_firmware/pull/18944))
+* Fix "no matrix definition" errors for some boards ([#18954](https://github.com/qmk/qmk_firmware/pull/18954))
+* LED config fixes ([#18973](https://github.com/qmk/qmk_firmware/pull/18973))
+* `handwired/swiftrax/walter`: fix layout mismatch ([#18974](https://github.com/qmk/qmk_firmware/pull/18974))
+* Fix use of shifted custom keycode ([#18978](https://github.com/qmk/qmk_firmware/pull/18978))
+* `pizzakeyboards/pizza65`: fix layouts ([#18979](https://github.com/qmk/qmk_firmware/pull/18979))
+* `cannonkeys/db60/hotswap`: fix layouts ([#18982](https://github.com/qmk/qmk_firmware/pull/18982))
+* `handwired/swiftrax/cowfish`: fix layouts ([#18984](https://github.com/qmk/qmk_firmware/pull/18984))
+* Fixup hotdox76v2 on develop ([#18991](https://github.com/qmk/qmk_firmware/pull/18991))
+* `mechlovin/adelais/standard_led/avr/rev1`: fix layout ([#18997](https://github.com/qmk/qmk_firmware/pull/18997))
+* `gboards/gergoplex`: fix matrix pins ([#18999](https://github.com/qmk/qmk_firmware/pull/18999))
+* Fixup keychron/q1/iso_encoder ([#19006](https://github.com/qmk/qmk_firmware/pull/19006))
+* Rollback unrelated changes from previous PR. ([#19015](https://github.com/qmk/qmk_firmware/pull/19015))
+* Fixup bn006 on develop ([#19029](https://github.com/qmk/qmk_firmware/pull/19029))
+* onekey: disable NKRO and mousekeys by default ([#19038](https://github.com/qmk/qmk_firmware/pull/19038))
+* Fix up laser_ninja/pumpkin_pad ([#19060](https://github.com/qmk/qmk_firmware/pull/19060))
+* Fixup keychron/q6 ([#19066](https://github.com/qmk/qmk_firmware/pull/19066))
+* Fixup handwired/alcor_dactyl ([#19072](https://github.com/qmk/qmk_firmware/pull/19072))
+* Fix some old keycodes ([#19086](https://github.com/qmk/qmk_firmware/pull/19086))
+* Update more `DRIVER_LED_TOTAL` defines to `RGB_MATRIX_LED_COUNT` ([#19089](https://github.com/qmk/qmk_firmware/pull/19089))
+* Fix references to `mouse_report_t` (which doesnt exist) ([#19107](https://github.com/qmk/qmk_firmware/pull/19107))
+* Fixup keychron/q5 ([#19119](https://github.com/qmk/qmk_firmware/pull/19119))
+* Fixup aeboards/satellite ([#19137](https://github.com/qmk/qmk_firmware/pull/19137))
+* Fixup aurora/corne on develop ([#19144](https://github.com/qmk/qmk_firmware/pull/19144))
+* Minor lint fixes for various info.json ([#19146](https://github.com/qmk/qmk_firmware/pull/19146))
+
+Others:
+* Add DD mapping for LED/RGB Matrix max brightness ([#18403](https://github.com/qmk/qmk_firmware/pull/18403))
+* Add DD mapping for LED/RGB Matrix split count ([#18408](https://github.com/qmk/qmk_firmware/pull/18408))
+* Add DD mapping for LED/RGB Matrix HSVS steps ([#18414](https://github.com/qmk/qmk_firmware/pull/18414))
+* Remove RGBLIGHT_ANIMTION and clean up effect defines for 0-F ([#18725](https://github.com/qmk/qmk_firmware/pull/18725))
+* Merge API update workflow ([#19121](https://github.com/qmk/qmk_firmware/pull/19121))
+
+Bugs:
+* Fix layer switching from tap dances by redoing the keymap lookup ([#17935](https://github.com/qmk/qmk_firmware/pull/17935))
+* ws2812: replace RGBLED_NUM with driver-owned constant to decouple driver from RGBLEDs/RGBMATRIX defines ([#18036](https://github.com/qmk/qmk_firmware/pull/18036))
+* Prevent USB peripheral fault when restarting USB on WB32 MCUs ([#18058](https://github.com/qmk/qmk_firmware/pull/18058))
+* Fix mouse report comparison failing on shared EP (fixes KB preventing sleep) ([#18060](https://github.com/qmk/qmk_firmware/pull/18060))
+* Fix incorrect `bluetooth.driver` rules.mk mapping ([#18205](https://github.com/qmk/qmk_firmware/pull/18205))
+* Adjust `EXTRAKEY_ENABLE` ifdefs for `send_extra()` ([#18249](https://github.com/qmk/qmk_firmware/pull/18249))
+* Fix docs regarding cirque pinnacle attenuation ([#18279](https://github.com/qmk/qmk_firmware/pull/18279))
+* Avoid repeated calls to rgblight_set() in tight succession when setting lighting layers ([#18338](https://github.com/qmk/qmk_firmware/pull/18338))
+* Fix cirque tap from secondary side of split keyboard ([#18351](https://github.com/qmk/qmk_firmware/pull/18351))
+* Fix EECONFIG_KEYMAP_UPPER_BYTE init ([#18394](https://github.com/qmk/qmk_firmware/pull/18394))
+* Fix retain brightness when val is changed while a layer is active ([#18426](https://github.com/qmk/qmk_firmware/pull/18426))
+* Update Chibios to latest 21.11.2 changes for RP2040 XIP deadlock mitigation ([#18428](https://github.com/qmk/qmk_firmware/pull/18428))
+* Fix incorrect g_led_config generation ([#18431](https://github.com/qmk/qmk_firmware/pull/18431))
+* Fix Per Key LED Indicator Callbacks ([#18450](https://github.com/qmk/qmk_firmware/pull/18450))
+* Update chibios-contrib for RP2040 i2c fixes take 2 ([#18455](https://github.com/qmk/qmk_firmware/pull/18455))
+* Fix comment of CM_QUES (Colemak question mark) ([#18557](https://github.com/qmk/qmk_firmware/pull/18557))
+* ChibiOS: Fix USB bus disconnect handling ([#18566](https://github.com/qmk/qmk_firmware/pull/18566))
+* Update ChibiOS-Contrib for USB IRQ and bus handling fixes ([#18574](https://github.com/qmk/qmk_firmware/pull/18574))
+* RP2040: only clear RX FIFO for serial pio driver clear ([#18581](https://github.com/qmk/qmk_firmware/pull/18581))
+* Fix ST7565 handler deadlock ([#18609](https://github.com/qmk/qmk_firmware/pull/18609))
+* Fix/Update ChibiOS hardware ID ([#18613](https://github.com/qmk/qmk_firmware/pull/18613))
+* Fix some rp2040 hardware ID errors ([#18617](https://github.com/qmk/qmk_firmware/pull/18617))
+* Fix joystick functionality for ChibiOS and OTG (Blackpill) ([#18631](https://github.com/qmk/qmk_firmware/pull/18631))
+* fix typo in solenoid.h ([#18635](https://github.com/qmk/qmk_firmware/pull/18635))
+* Fix boundary in `RGB_MATRIX_INDICATOR_SET_COLOR` ([#18650](https://github.com/qmk/qmk_firmware/pull/18650))
+* Fix MIDI output endpoint to use the out direction ([#18654](https://github.com/qmk/qmk_firmware/pull/18654))
+* Fix mouse use within send_string ([#18659](https://github.com/qmk/qmk_firmware/pull/18659))
+* Correctly build keymap.json containing additional config ([#18766](https://github.com/qmk/qmk_firmware/pull/18766))
+* Correctly build out of tree keymap.json containing additional config ([#18775](https://github.com/qmk/qmk_firmware/pull/18775))
+* Fix garbled test output ([#18822](https://github.com/qmk/qmk_firmware/pull/18822))
+* Fix rgb_matrix_set_flags_noeeprom declaration ([#18860](https://github.com/qmk/qmk_firmware/pull/18860))
+* Add missing Space Cadet alias ([#18876](https://github.com/qmk/qmk_firmware/pull/18876))
+* Fix oled_render to render all dirty blocks. ([#18887](https://github.com/qmk/qmk_firmware/pull/18887))
+* compiler.txt: ensure file exists before comparison ([#18921](https://github.com/qmk/qmk_firmware/pull/18921))
+* Fix compilation issue with WPM ([#18965](https://github.com/qmk/qmk_firmware/pull/18965))
+* Fix keycode parameter extraction to match the new DD keycodes ([#18977](https://github.com/qmk/qmk_firmware/pull/18977))
+* Fix jump in mouse_report value when scale changes during cirque get report ([#18992](https://github.com/qmk/qmk_firmware/pull/18992))
+* Fixup WS2812 vendor driver ([#19028](https://github.com/qmk/qmk_firmware/pull/19028))
+* Add missing prototype for get_hold_on_other_key_press to resolve #18855 ([#19056](https://github.com/qmk/qmk_firmware/pull/19056))
+* Fix duplicate key in keyboard.jsonschema ([#19058](https://github.com/qmk/qmk_firmware/pull/19058))
+* Fixup `keyboard.jsonschema`. ([#19059](https://github.com/qmk/qmk_firmware/pull/19059))
+* fixed MOUSEKEY_INERTIA on AVR ([#19096](https://github.com/qmk/qmk_firmware/pull/19096))
+* Fix encoder_init call order in keyboard_init ([#19140](https://github.com/qmk/qmk_firmware/pull/19140))
+* Fixup installation procedure for different Fedora versions. ([#19159](https://github.com/qmk/qmk_firmware/pull/19159))

docs/_summary.md

@@ -4,6 +4,7 @@
   * [Building Your First Firmware](newbs_building_firmware.md)
   * [Flashing Firmware](newbs_flashing.md)
   * [Getting Help/Support](support.md)
+  * [Building With GitHub Userspace](newbs_building_firmware_workflow.md)
   * [Other Resources](newbs_learn_more_resources.md)
   * [Syllabus](syllabus.md)
 
@@ -75,26 +76,30 @@
 
   * Software Features
     * [Auto Shift](feature_auto_shift.md)
+    * [Autocorrect](feature_autocorrect.md)
+    * [Caps Word](feature_caps_word.md)
     * [Combos](feature_combo.md)
     * [Debounce API](feature_debounce_type.md)
+    * [EEPROM](feature_eeprom.md)
     * [Key Lock](feature_key_lock.md)
     * [Key Overrides](feature_key_overrides.md)
     * [Layers](feature_layers.md)
     * [One Shot Keys](one_shot_keys.md)
-    * [Pointing Device](feature_pointing_device.md)
     * [Raw HID](feature_rawhid.md)
+    * [Secure](feature_secure.md)
+    * [Send String](feature_send_string.md)
     * [Sequencer](feature_sequencer.md)
     * [Swap Hands](feature_swap_hands.md)
     * [Tap Dance](feature_tap_dance.md)
     * [Tap-Hold Configuration](tap_hold.md)
-    * [Terminal](feature_terminal.md)
     * [Unicode](feature_unicode.md)
     * [Userspace](feature_userspace.md)
     * [WPM Calculation](feature_wpm.md)
 
   * Hardware Features
     * Displays
-      * [HD44780 LCD Controller](feature_hd44780.md)
+      * [Quantum Painter](quantum_painter.md)
+      * [HD44780 LCD Driver](feature_hd44780.md)
       * [ST7565 LCD Driver](feature_st7565.md)
       * [OLED Driver](feature_oled_driver.md)
     * Lighting
@@ -105,6 +110,7 @@
     * [Audio](feature_audio.md)
     * [Bluetooth](feature_bluetooth.md)
     * [Bootmagic Lite](feature_bootmagic.md)
+    * [Converters](feature_converters.md)
     * [Custom Matrix](custom_matrix.md)
     * [Digitizer](feature_digitizer.md)
     * [DIP Switch](feature_dip_switch.md)
@@ -113,11 +119,10 @@
     * [Joystick](feature_joystick.md)
     * [LED Indicators](feature_led_indicators.md)
     * [MIDI](feature_midi.md)
-    * [Proton C Conversion](proton_c_conversion.md)
+    * [Pointing Device](feature_pointing_device.md)
     * [PS/2 Mouse](feature_ps2_mouse.md)
     * [Split Keyboard](feature_split_keyboard.md)
     * [Stenography](feature_stenography.md)
-    * [Thermal Printer](feature_thermal_printer.md)
     * [Velocikey](feature_velocikey.md)
 
   * Keyboard Building
@@ -131,7 +136,7 @@
   * Breaking Changes
     * [Overview](breaking_changes.md)
     * [My Pull Request Was Flagged](breaking_changes_instructions.md)
-    * [Most Recent ChangeLog](ChangeLog/20220226.md "QMK v0.16.0 - 2022 Feb 26")
+    * [Most Recent ChangeLog](ChangeLog/20221126.md "QMK v0.19.0 - 2022 Nov 26")
     * [Past Breaking Changes](breaking_changes_history.md)
 
   * C Development
@@ -145,9 +150,10 @@
       * [SPI Driver](spi_driver.md)
       * [WS2812 Driver](ws2812_driver.md)
       * [EEPROM Driver](eeprom_driver.md)
+      * [Flash Driver](flash_driver.md)
       * ['serial' Driver](serial_driver.md)
       * [UART Driver](uart_driver.md)
-    * [GPIO Controls](internals_gpio_control.md)
+    * [GPIO Controls](gpio_control.md)
     * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
 
   * Python Development
@@ -163,6 +169,9 @@
     * Arm/ChibiOS
       * [Selecting an MCU](platformdev_selecting_arm_mcu.md)
       * [Early initialization](platformdev_chibios_earlyinit.md)
+      * [Raspberry Pi RP2040](platformdev_rp2040.md)
+      * [Proton C](platformdev_proton_c.md)
+      * [WeAct Blackpill F4x1](platformdev_blackpill_f4x1.md)
 
   * QMK Reference
     * [Contributing to QMK](contributing.md)
@@ -183,10 +192,10 @@
     * [Understanding QMK](understanding_qmk.md)
 
   * QMK Internals (In Progress)
-    * [Defines](internals_defines.md)
-    * [Input Callback Reg](internals_input_callback_reg.md)
-    * [Midi Device](internals_midi_device.md)
-    * [Midi Device Setup Process](internals_midi_device_setup_process.md)
-    * [Midi Util](internals_midi_util.md)
-    * [Send Functions](internals_send_functions.md)
-    * [Sysex Tools](internals_sysex_tools.md)
+    * [Defines](internals/defines.md)
+    * [Input Callback Reg](internals/input_callback_reg.md)
+    * [Midi Device](internals/midi_device.md)
+    * [Midi Device Setup Process](internals/midi_device_setup_process.md)
+    * [Midi Util](internals/midi_util.md)
+    * [Send Functions](internals/send_functions.md)
+    * [Sysex Tools](internals/sysex_tools.md)

docs/api_docs.md

@@ -14,14 +14,14 @@ This service is an asynchronous API for compiling custom keymaps. You POST some
   "keymap": "my_awesome_keymap",
   "layout": "LAYOUT_all",
   "layers": [
-    ["KC_GRV","KC_1","KC_2","KC_3","KC_4","KC_5","KC_6","KC_7","KC_8","KC_9","KC_0","KC_MINS","KC_EQL","KC_GRV","KC_BSPC","KC_PGUP","KC_TAB","KC_Q","KC_W","KC_E","KC_R","KC_T","KC_Y","KC_U","KC_I","KC_O","KC_P","KC_LBRC","KC_RBRC","KC_BSLS","KC_PGDN","KC_CAPS","KC_A","KC_S","KC_D","KC_F","KC_G","KC_H","KC_J","KC_K","KC_L","KC_SCLN","KC_QUOT","KC_NUHS","KC_ENT","KC_LSFT","KC_NUBS","KC_Z","KC_X","KC_C","KC_V","KC_B","KC_N","KC_M","KC_COMM","KC_DOT","KC_SLSH","KC_RO","KC_RSFT","KC_UP","KC_LCTL","KC_LGUI","KC_LALT","KC_MHEN","KC_SPC","KC_SPC","KC_HENK","KC_RALT","KC_RCTL","MO(1)","KC_LEFT","KC_DOWN","KC_RIGHT"],
-    ["KC_ESC","KC_F1","KC_F2","KC_F3","KC_F4","KC_F5","KC_F6","KC_F7","KC_F8","KC_F9","KC_F10","KC_F11","KC_F12","KC_TRNS","KC_DEL","BL_STEP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","_______","KC_TRNS","KC_PSCR","KC_SLCK","KC_PAUS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_PGUP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_LEFT","KC_PGDN","KC_RGHT"],
-    ["KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","RESET","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_TRNS","KC_TRNS","KC_TRNS"]
+    ["KC_GRV","KC_1","KC_2","KC_3","KC_4","KC_5","KC_6","KC_7","KC_8","KC_9","KC_0","KC_MINS","KC_EQL","KC_GRV","KC_BSPC","KC_PGUP","KC_TAB","KC_Q","KC_W","KC_E","KC_R","KC_T","KC_Y","KC_U","KC_I","KC_O","KC_P","KC_LBRC","KC_RBRC","KC_BSLS","KC_PGDN","KC_CAPS","KC_A","KC_S","KC_D","KC_F","KC_G","KC_H","KC_J","KC_K","KC_L","KC_SCLN","KC_QUOT","KC_NUHS","KC_ENT","KC_LSFT","KC_NUBS","KC_Z","KC_X","KC_C","KC_V","KC_B","KC_N","KC_M","KC_COMM","KC_DOT","KC_SLSH","KC_INT1","KC_RSFT","KC_UP","KC_LCTL","KC_LGUI","KC_LALT","KC_INT5","KC_SPC","KC_SPC","KC_INT4","KC_RALT","KC_RCTL","MO(1)","KC_LEFT","KC_DOWN","KC_RIGHT"],
+    ["KC_ESC","KC_F1","KC_F2","KC_F3","KC_F4","KC_F5","KC_F6","KC_F7","KC_F8","KC_F9","KC_F10","KC_F11","KC_F12","KC_TRNS","KC_DEL","BL_STEP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","_______","KC_TRNS","KC_PSCR","KC_SCRL","KC_PAUS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_PGUP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_LEFT","KC_PGDN","KC_RGHT"],
+    ["KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","QK_BOOT","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_TRNS","KC_TRNS","KC_TRNS"]
   ]
 }
 ```
 
-As you can see the payload describes all aspects of a keyboard necessary to create and generate a firmware. Each layer is a single list of QMK keycodes the same length as the keyboard's `LAYOUT` macro. If a keyboard supports mulitple `LAYOUT` macros you can specify which macro to use.
+As you can see the payload describes all aspects of a keyboard necessary to create and generate a firmware. Each layer is a single list of QMK keycodes the same length as the keyboard's `LAYOUT` macro. If a keyboard supports multiple `LAYOUT` macros you can specify which macro to use.
 
 ## Submitting a Compile Job
 
@@ -66,3 +66,41 @@ Once your compile job has finished you'll check the `result` key. The value of t
 * `firmware_keymap_url`: A list of URLs for the `keymap.c`
 * `firmware_source_url`: A list of URLs for the full firmware source code
 * `output`: The stdout and stderr for this compile job. Errors will be found here.
+
+## Constants :id=qmk-constants
+
+If you're writing a tool that leverages constants used within QMK, the API is used to publish "locked-in" versions of those constants in order to ensure that any third-party tooling has a canonical set of information to work with.
+
+The list of available constants can be retrieved by accessing one of the following endpoints:
+
+```
+$ curl https://keyboards.qmk.fm/v1/constants_metadata.json # For `master`
+{"last_updated": "2022-11-26 00:00:00 GMT", "constants": {"keycodes": ["0.0.1"]}}
+
+$ curl https://keyboards.develop.qmk.fm/v1/constants_metadata.json # For `develop`
+{"last_updated": "2022-11-26 12:00:00 GMT", "constants": {"keycodes": ["0.0.1", "0.0.2"]}}
+```
+
+!> Versions exported by the `master` endpoint are locked-in. Any extra versions that exist on the `develop` endpoint which don't exist in `master` are subject to change.
+
+?> Only keycodes are currently published, but over time all other "externally visible" IDs are expected to appear on these endpoints.
+
+To retrieve the constants associated with a subsystem, the endpoint format is as follows:
+```
+# https://keyboards.qmk.fm/v1/constants/{subsystem}_{version}.json
+```
+Which, for the metadata endpoint above results in a request of:
+```
+$ curl https://keyboards.qmk.fm/v1/constants/keycodes_0.0.1.json
+{
+    "ranges": {
+        "0x0000/0x00FF": {
+            "define": "QK_BASIC"
+        },
+        "0x0100/0x1EFF": {
+            "define": "QK_MODS"
+        },
+        "0x2000/0x1FFF": {
+            "define": "QK_MOD_TAP"
+<snip>
+```

docs/audio_driver.md

@@ -113,15 +113,17 @@ Additionally, in the board config, you'll want to make changes to enable the DAC
 
 ### DAC Config
 
-| Define                           | Defaults                   | Description                                                --------------------------------------------------------------------------------------------- |
+| Define                           | Defaults                   | Description                                                                                                                                                           |
+| -------------------------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `AUDIO_DAC_SAMPLE_MAX`           | `4095U`                    | Highest value allowed. Lower value means lower volume. And 4095U is the upper limit, since this is limited to a 12 bit value. Only effects non-pregenerated samples.  |
-| `AUDIO_DAC_OFF_VALUE`            | `AUDIO_DAC_SAMPLE_MAX / 2` | The value of the DAC when notplaying anything. Some setups may require a high (`AUDIO_DAC_SAMPLE_MAX`) or low (`0`) value here.                                        |
+| `AUDIO_DAC_OFF_VALUE`            | `AUDIO_DAC_SAMPLE_MAX / 2` | The value of the DAC when notplaying anything. Some setups may require a high (`AUDIO_DAC_SAMPLE_MAX`) or low (`0`) value here.                                       |
 | `AUDIO_MAX_SIMULTANEOUS_TONES`   | __see next table__         | The number of tones that can be played simultaneously.  A value that is too high may freeze the controller or glitch out when too many tones are being played.        |
-| `AUDIO_DAC_SAMPLE_RATE`          | __see next table__         | Effective bit rate of the DAC (in hertz), higher limits simultaneous tones, and lower sacrifices quality.                                                          |
+| `AUDIO_DAC_SAMPLE_RATE`          | __see next table__         | Effective bit rate of the DAC (in hertz), higher limits simultaneous tones, and lower sacrifices quality.                                                             |
 
 There are a number of predefined quality settings that you can use, with "sane minimum" being the default.  You can use custom values by simply defining the sample rate and number of simultaneous tones, instead of using one of the listed presets. 
 
 | Define                            | Sample Rate | Simultaneous tones  |
+| --------------------------------- | ----------- | ------------------- |
 | `AUDIO_DAC_QUALITY_VERY_LOW`      | `11025U`    | `8`                 |
 | `AUDIO_DAC_QUALITY_LOW`           | `22040U`    | `4`                 |
 | `AUDIO_DAC_QUALITY_HIGH`          | `44100U`    | `2`                 |
@@ -157,7 +159,6 @@ A configuration example for the STM32F103C8 would be:
 //halconf.h:
 #define HAL_USE_PWM                 TRUE
 #define HAL_USE_PAL                 TRUE
-#define HAL_USE_GPT                 TRUE
 #include_next <halconf.h>
 ```
 
@@ -166,8 +167,6 @@ A configuration example for the STM32F103C8 would be:
 #include_next <mcuconf.h>
 #undef STM32_PWM_USE_TIM1
 #define STM32_PWM_USE_TIM1                  TRUE
-#undef STM32_GPT_USE_TIM4
-#define STM32_GPT_USE_TIM4                  TRUE
 ```
 
 If we now target pin A8, looking through the data-sheet of the STM32F103C8, for the timers and alternate functions
@@ -182,7 +181,6 @@ with all this information, the configuration would contain these lines:
 #define AUDIO_PIN A8
 #define AUDIO_PWM_DRIVER PWMD1
 #define AUDIO_PWM_CHANNEL 1
-#define AUDIO_STATE_TIMER GPTD4
 ```
 
 ChibiOS uses GPIOv1 for the F103, which only knows of one alternate function.
@@ -205,15 +203,15 @@ You can also change the timer used for software PWM by defining the driver.  For
 
 While not an exhaustive list, the following table provides the scenarios that have been partially validated:
 
-|                          | DAC basic          | DAC additive       | PWM hardware       | PWM software       |
-|--------------------------|--------------------|--------------------|--------------------|--------------------|
+|                          |     DAC basic      |    DAC additive    |    PWM hardware    |    PWM software    |
+| ------------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
 | Atmega32U4               | :o:                | :o:                | :heavy_check_mark: | :o:                |
+| RP2040                   | :x:                | :x:                | :heavy_check_mark: | ?                  |
 | STM32F103C8 (bluepill)   | :x:                | :x:                | :heavy_check_mark: | :heavy_check_mark: |
 | STM32F303CCT6 (proton-c) | :heavy_check_mark: | :heavy_check_mark: | ?                  | :heavy_check_mark: |
 | STM32F405VG              | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | L0xx                     | :x: (no Tim8)      | ?                  | ?                  | ?                  |
 
-
 :heavy_check_mark: : works and was tested  
 :o: : does not apply  
 :x: : not supported by MCU

docs/breaking_changes.md

@@ -8,6 +8,9 @@ The breaking change period is when we will merge PR's that change QMK in dangero
 
 ## What has been included in past Breaking Changes?
 
+* [2022 Nov 26](ChangeLog/20221126.md)
+* [2022 Aug 27](ChangeLog/20220827.md)
+* [2022 May 28](ChangeLog/20220528.md)
 * [2022 Feb 26](ChangeLog/20220226.md)
 * [2021 Nov 27](ChangeLog/20211127.md)
 * [2021 Aug 28](ChangeLog/20210828.md)
@@ -21,17 +24,18 @@ The breaking change period is when we will merge PR's that change QMK in dangero
 
 ## When is the next Breaking Change?
 
-The next Breaking Change is scheduled for May 28, 2022.
+The next Breaking Change is scheduled for February 26, 2023.
 
 ### Important Dates
 
-* [x] 2022 Feb 26 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
-* [ ] 2022 Apr 31 - `develop` closed to new PR's.
-* [ ] 2022 Apr 31 - Call for testers.
-* [ ] 2022 May 14 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
-* [ ] 2022 May 26 - `master` is locked, no PR's merged.
-* [ ] 2022 May 28 - Merge `develop` to `master`.
-* [ ] 2022 May 28 - `master` is unlocked. PR's can be merged again.
+* 2022 Nov 26 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
+* 2022 Jan 29 - `develop` closed to new PR's.
+* 2022 Jan 29 - Call for testers.
+* 2022 Feb 12 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
+* 2022 Feb 19 - `develop` is locked, only critical bugfix PR's merged.
+* 2022 Feb 24 - `master` is locked, no PR's merged.
+* 2022 Feb 26 - Merge `develop` to `master`.
+* 2023 Feb 26 - `master` is unlocked. PR's can be merged again.
 
 ## What changes will be included?
 
@@ -42,80 +46,132 @@ If you want your breaking change to be included in this round you need to create
 Criteria for acceptance:
 
 * The PR is complete and ready to merge
-* The PR has a ChangeLog file describing the changes under `<qmk_firmware>/docs/Changelog/20220226`.
+* The PR has a ChangeLog file describing the changes under `<qmk_firmware>/docs/Changelog/20221126`.
     * This should be in Markdown format, with a name in the format `PR12345.md`, substituting the digits for your PR's ID.
     * One strong recommendation that the ChangeLog document matches the PR description on GitHub, so as to ensure traceability.
 
-# Checklists
+## Checklists
 
 This section documents various processes we use when running the Breaking Changes process.
 
-## Creating the `develop` branch
-
-This happens immediately after the previous `develop` branch is merged.
-
-* `qmk_firmware` git commands
-    * [ ] `git checkout master`
-    * [ ] `git pull --ff-only`
-    * [ ] `git checkout -b develop`
-    * [ ] Edit `readme.md`
-        * [ ] Add a big notice at the top that this is a testing branch.
-        * [ ] Include a link to this document
-    * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'`
-    * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>`
-    * [ ] `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing
-    * [ ] `git push upstream develop`
-    * [ ] `git push --tags`
-
-## 4 Weeks Before Merge
+### 4 Weeks Before Merge
 
 * `develop` is now closed to new PR's, only fixes for current PR's may be merged
-* Post call for testers
-    * [ ] Discord
-    * [ ] GitHub PR
-    * [ ] https://reddit.com/r/olkb
+* Post call for testers: message `@Breaking Changes Updates` on `#qmk_firmware` in Discord:
+    * `@Breaking Changes Updates -- Hey folks, last day for functional PRs to be raised against qmk_firmware for this breaking changes cycle is today.`
 
-## 2 Weeks Before Merge
+### 2 Weeks Before Merge
 
 * `develop` is now closed to existing PR merges, only bugfixes for previous merges may be included
-* Post call for testers
-    * [ ] Discord
-    * [ ] GitHub PR
-    * [ ] https://reddit.com/r/olkb
+* Post call for testers: message `@Breaking Changes Updates` on `#qmk_firmware` in Discord.
+    * `@Breaking Changes Updates -- Hey folks, last day for functional PRs to be merged into qmk_firmware for this breaking changes cycle is today. After that, we're handling bugfixes only.`
 
-## 1 Week Before Merge
+### 1 Week Before Merge
 
-* Announce that master will be closed from <2 Days Before> to <Day of Merge>
-    * [ ] Discord
-    * [ ] GitHub PR
-    * [ ] https://reddit.com/r/olkb
+* `develop` is now closed to PR merges, only critical bugfixes may be included
+* Announce that master will be closed from <2 Days Before> to <Day of Merge> -- message `@Breaking Changes Updates` on `#qmk_firmware` in Discord:
+    * `@Breaking Changes Updates -- Hey folks, last day for functional PRs to be merged into qmk_firmware for this breaking changes cycle is today. After that, we're handling bugfixes only.`
 
-## 2 Days Before Merge
+### 2 Days Before Merge
 
+* `master` is now closed to PR merges
 * Announce that master is closed for 2 days
-    * [ ] Discord
-    * [ ] GitHub PR
-    * [ ] https://reddit.com/r/olkb
+    * `@Breaking Changes Updates -- Hey folks, the master branch of qmk_firmware is now locked for the next couple of days while we prepare to merge the newest batch of changes from develop.`
 
-## Day Of Merge
+### Day Of Merge
 
 * `qmk_firmware` git commands
-    * [ ] `git checkout develop`
-    * [ ] `git pull --ff-only`
-    * [ ] Edit `readme.md`
-        * [ ] Remove the notes about `develop`
-    * [ ] Roll up the ChangeLog into one file.
-    * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'`
-    * [ ] `git push upstream develop`
+    * `git checkout develop`
+    * `git pull --ff-only`
+    * Edit `readme.md`
+        * Remove the notes about `develop`
+    * Roll up the ChangeLog into one file.
+    * `git commit -m 'Merge point for <DATE> Breaking Change'`
+    * `git push upstream develop`
 * GitHub Actions
-    * [ ] Create a PR for `develop`
-    * [ ] **Turn off 'Automatically delete head branches' for the repository** -- confirm with @qmk/directors that it is done before continuing
+    * Create a PR for `develop`
+    * **Turn off 'Automatically delete head branches' for the repository** -- confirm with @qmk/directors that it is done before continuing
 * `qmk_firmware` git commands
-    * [ ] `git checkout master`
-    * [ ] `git pull --ff-only`
-    * [ ] `git merge --no-ff develop`
-    * [ ] `git push upstream master`
+    * `git checkout master`
+    * `git pull --ff-only`
+    * `git merge --no-ff develop`
+    * `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing
+    * `git push upstream <next_version>`
+    * `git push upstream master`
 
 ## Post-merge operations
 
+### Updating the `develop` branch
+
+This happens immediately after the previous `develop` branch is merged to `master`.
+
+* `qmk_firmware` git commands
+    * `git checkout master`
+    * `git pull --ff-only`
+    * `git checkout develop`
+    * `git pull --ff-only`
+    * `git merge --no-ff master`
+    * Edit `readme.md`
+        * Add a big notice at the top that this is a testing branch. See previous revisions of the `develop` branch.
+        * Include a link to this document
+    * `git commit -m 'Branch point for <DATE> Breaking Change'`
+    * `git tag breakpoint_<YYYY>_<MM>_<DD>`
+    * `git push upstream breakpoint_<YYYY>_<MM>_<DD>`
+
+* All submodules under `lib` now need to be checked against their QMK-based forks:
+    * `git submodule foreach git log -n1`
+    * Validate each submodule SHA1 matches the qmk fork, e.g. for ChibiOS:
+        * Go to [qmk/ChibiOS](https://github.com/qmk/ChibiOS)
+        * Compare the commit hash in the above output to the commit hash in the repository
+        * If there's a mismatch, that repository needs to have its `master` branch updated to match (otherwise Configurator won't work):
+            * `cd lib/chibios`
+            * `git fetch --all`
+            * `git checkout master`
+            * `git reset --hard <commit hash>`
+            * `git push origin master --force-with-lease`
+
+* Announce that both `master` and `develop` are now unlocked -- message `@Breaking Changes Updates` on `#qmk_firmware` in Discord:
+    * `@Breaking Changes Updates -- Hey folks, develop has now been merged into master -- newest batch of changes are now available for everyone to use!`
+
 * (Optional) [update ChibiOS + ChibiOS-Contrib on `develop`](chibios_upgrade_instructions.md)
+
+
+### Set up Discord events for the next cycle
+
+* Update this file with the new dates: `docs/breaking_changes.md`
+* Create Events on the QMK Discord - "Somewhere Else" => "GitHub":
+    * Event #1:
+        | Field       | Value                                                                                                                                                                                                                 |
+        |-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+        | Topic       | Last `develop` functionality PRs to be raised                                                                                                                                                                         |
+        | Start Date  | ((5 weeks before merge)), 12:00am                                                                                                                                                                                     |
+        | End Date    | ((4 weeks before merge)), 12:00am                                                                                                                                                                                     |
+        | Description | This is the last window for functional PRs to be raised against `develop` for the current breaking changes cycle. After ((4 weeks before merge)), any new PRs targeting `develop` will be deferred to the next cycle. |
+    * Event #2:
+        | Field       | Value                                                                                                                                                                                                            |
+        |-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+        | Topic       | Last `develop` functionality PRs to be merged                                                                                                                                                                    |
+        | Start Date  | ((4 weeks before merge)), 12:00am                                                                                                                                                                                |
+        | End Date    | ((2 weeks before merge)), 12:00am                                                                                                                                                                                |
+        | Description | This is the last window for functional PRs to be merged into `develop` for the current breaking changes cycle. After ((2 weeks before merge)), only bugfix PRs targeting `develop` will be considered for merge. |
+    * Event #3:
+        | Field       | Value                                                                                                                                                                                                                           |
+        |-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+        | Topic       | `develop` closed for merges                                                                                                                                                                                                     |
+        | Start Date  | ((2 weeks before merge)), 12:00am                                                                                                                                                                                               |
+        | End Date    | ((day of merge)), 12:00am                                                                                                                                                                                                       |
+        | Description | This is the deadline for functionality bugfix PRs to be merged into `develop` for the current breaking changes cycle. After ((1 week before merge)), only critical bugfix PRs targeting `develop` will be considered for merge. |
+    * Event #4:
+        | Field       | Value                                                                                                                |
+        |-------------|----------------------------------------------------------------------------------------------------------------------|
+        | Topic       | `master` closed for merges                                                                                           |
+        | Start Date  | ((2 days before merge)), 12:00am                                                                                     |
+        | End Date    | ((day of merge)), 12:00am                                                                                            |
+        | Description | This is the period that no PRs are to be merged to `master`, so that the merge of `develop` into `master` is stable. |
+    * Event #5:
+        | Field       | Value                                                                                                                                      |
+        |-------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+        | Topic       | `develop` merges to `master`                                                                                                               |
+        | Start Date  | ((day of merge)), 12:00am                                                                                                                  |
+        | End Date    | ((day of merge)), 11:45pm                                                                                                                  |
+        | Description | At some point, QMK will merge `develop` into `master` and everyone will be able to reap the benefits of the newest batch of functionality. |

docs/breaking_changes_history.md

@@ -2,6 +2,9 @@
 
 This page links to all previous changelogs from the QMK Breaking Changes process.
 
+* [2022 Nov 26](ChangeLog/20221126.md) - version 0.19.0
+* [2022 Aug 27](ChangeLog/20220827.md) - version 0.18.0
+* [2022 May 28](ChangeLog/20220528.md) - version 0.17.0
 * [2022 Feb 26](ChangeLog/20220226.md) - version 0.16.0
 * [2021 Nov 27](ChangeLog/20211127.md) - version 0.15.0
 * [2021 Aug 28](ChangeLog/20210828.md) - version 0.14.0

docs/cli_commands.md

@@ -90,6 +90,8 @@ This command is similar to `qmk compile`, but can also target a bootloader. The
 
 This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory.
 
+This command can also flash binary firmware files (hex or bin) such as the ones produced by [Configurator](https://config.qmk.fm).
+
 **Usage for Configurator Exports**:
 
 ```
@@ -102,6 +104,21 @@ qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configurat
 qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]
 ```
 
+**Usage for pre-compiled firmwares**:
+
+**Note**: The microcontroller needs to be specified (`-m` argument) for keyboards with the following bootloaders:
+* HalfKay
+* QMK HID
+* USBaspLoader
+
+ISP flashing is also supported with the following flashers and require the microcontroller to be specified:
+* USBasp
+* USBtinyISP
+
+```
+qmk flash [-m <microcontroller>] <compiledFirmware.[bin|hex]>
+```
+
 **Listing the Bootloaders**
 
 ```
@@ -206,7 +223,7 @@ Check your environment and report problems only:
 
 ## `qmk format-json`
 
-Formats a JSON file in a (mostly) human-friendly way. Will usually correctly detect the format of the JSON (info.json or keymap.json) but you can override this with `--format` if neccesary.
+Formats a JSON file in a (mostly) human-friendly way. Will usually correctly detect the format of the JSON (info.json or keymap.json) but you can override this with `--format` if necessary.
 
 **Usage**:
 
@@ -335,6 +352,90 @@ This command cleans up the `.build` folder. If `--all` is passed, any .hex or .b
 qmk clean [-a]
 ```
 
+## `qmk via2json`
+
+This command an generate a keymap.json from a VIA keymap backup. Both the layers and the macros are converted, enabling users to easily move away from a VIA-enabled firmware without writing any code or reimplementing their keymaps in QMK Configurator.
+
+**Usage**:
+
+```
+qmk via2json -kb KEYBOARD [-l LAYOUT] [-km KEYMAP] [-o OUTPUT] filename
+```
+
+**Example:**
+
+```
+$ qmk via2json -kb ai03/polaris -o polaris_keymap.json polaris_via_backup.json
+Ψ Wrote keymap to /home/you/qmk_firmware/polaris_keymap.json
+```
+
+## `qmk import-keyboard`
+
+This command imports a data-driven `info.json` keyboard into the repo.
+
+**Usage**:
+
+```
+usage: qmk import-keyboard [-h] filename
+```
+
+**Example:**
+
+```
+$ qmk import-keyboard ~/Downloads/forever60.json
+Ψ Importing forever60.json.
+
+Ψ Imported a new keyboard named forever60.
+Ψ To start working on things, `cd` into keyboards/forever60,
+Ψ or open the directory in your preferred text editor.
+Ψ And build with qmk compile -kb forever60 -km default.
+```
+
+## `qmk import-keymap`
+
+This command imports a data-driven `keymap.json` keymap into the repo.
+
+**Usage**:
+
+```
+usage: qmk import-keymap [-h] filename
+```
+
+**Example:**
+
+```
+qmk import-keymap ~/Downloads/asdf2.json
+Ψ Importing asdf2.json.
+
+Ψ Imported a new keymap named asdf2.
+Ψ To start working on things, `cd` into keyboards/takashicompany/dogtag/keymaps/asdf2,
+Ψ or open the directory in your preferred text editor.
+Ψ And build with qmk compile -kb takashicompany/dogtag -km asdf2.
+```
+
+## `qmk import-kbfirmware`
+
+This command creates a new keyboard based on a [Keyboard Firmware Builder](https://kbfirmware.com/) export.
+
+**Usage**:
+
+```
+usage: qmk import-kbfirmware [-h] filename
+```
+
+**Example:**
+
+```
+$ qmk import-kbfirmware ~/Downloads/gh62.json
+Ψ Importing gh62.json.
+
+⚠ Support here is basic - Consider using 'qmk new-keyboard' instead
+Ψ Imported a new keyboard named gh62.
+Ψ To start working on things, `cd` into keyboards/gh62,
+Ψ or open the directory in your preferred text editor.
+Ψ And build with qmk compile -kb gh62 -km default.
+```
+
 ---
 
 # Developer Commands
@@ -498,3 +599,16 @@ Run single test:
 
     qmk pytest -t qmk.tests.test_cli_commands.test_c2json
     qmk pytest -t qmk.tests.test_qmk_path
+
+## `qmk painter-convert-graphics`
+
+This command converts images to a format usable by QMK, i.e. the QGF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
+
+## `qmk painter-make-font-image`
+
+This command converts a TTF font to an intermediate format for editing, before converting to the QFF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
+
+## `qmk painter-convert-font-image`
+
+This command converts an intermediate font image to the QFF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
+

docs/cli_development.md

@@ -162,7 +162,7 @@ del(cli.config.<section>.<key>)
 
 ## Writing The Configuration File
 
-The configuration is not written out when it is changed. Most commands do not need to do this. We prefer to have the user change their configuration deliberitely using `qmk config`.
+The configuration is not written out when it is changed. Most commands do not need to do this. We prefer to have the user change their configuration deliberately using `qmk config`.
 
 You can use `cli.save_config()` to write out the configuration.
 
@@ -188,7 +188,7 @@ cli.log.info('Reading from %s and writing to %s', cli.args.filename, cli.args.ou
 
 # Testing, and Linting, and Formatting (oh my!)
 
-We use nose2, flake8, and yapf to test, lint, and format code. You can use the `pytest` and `format-py` subcommands to run these tests:
+We use nose2, flake8, and yapf to test, lint, and format code. You can use the `pytest` and `format-python` subcommands to run these tests:
 
 ### Testing and Linting
 
@@ -196,7 +196,7 @@ We use nose2, flake8, and yapf to test, lint, and format code. You can use the `
 
 ### Formatting
 
-    qmk format-py
+    qmk format-python
 
 ## Formatting Details
 

docs/cli_tab_complete.md

@@ -14,6 +14,10 @@ Add this to the end of your `.profile` or `.bashrc`:
 
 If you put `qmk_firmware` into another location you will need to adjust this path.
 
+Zsh users will need to load `bashcompinit`. The following can be added to `~/.zshrc` file:
+
+    autoload -Uz bashcompinit && bashcompinit
+
 ### System Wide Symlink
 
 If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script:

docs/coding_conventions_c.md

@@ -24,7 +24,7 @@ Most of our style is pretty easy to pick up on, but right now it's not entirely
   * Readability is more important than consistency.
   * Follow the file's existing style. If the file is mixed, follow the style that makes sense for the section you are modifying.
   * When indenting, keep the hash at the start of the line and add whitespace between `#` and `if`, starting with 4 spaces after the `#`.
-  * You can follow the indention level of the surrounding C code, or preprocessor directives can have their own indentation levels. Choose the style that best communicates the intent of your code.
+  * You can follow the indentation level of the surrounding C code, or preprocessor directives can have their own indentation levels. Choose the style that best communicates the intent of your code.
 
 Here is an example for easy reference:
 

docs/coding_conventions_python.md

@@ -2,7 +2,7 @@
 
 Most of our style follows PEP8 with some local modifications to make things less nit-picky. 
 
-* We target Python 3.7 for compatability with all supported platforms.
+* We target Python 3.7 for compatibility with all supported platforms.
 * We indent using four (4) spaces (soft tabs)
 * We encourage liberal use of comments
   * Think of them as a story describing the feature
@@ -21,7 +21,7 @@ You can use [yapf](https://github.com/google/yapf) to style your code. We provid
 
 We don't have a hard and fast rule for when to use `import ...` vs `from ... import ...`. Understandability and maintainability is our ultimate goal.
 
-Generally we prefer to import specific function and class names from a module to keep code shorter and easier to understand. Sometimes this results in a name that is ambiguous, and in such cases we prefer to import the module instead. You should avoid using the "as" keyword when importing, unless you are importing a compatability module.
+Generally we prefer to import specific function and class names from a module to keep code shorter and easier to understand. Sometimes this results in a name that is ambiguous, and in such cases we prefer to import the module instead. You should avoid using the "as" keyword when importing, unless you are importing a compatibility module.
 
 Imports should be one line per module. We group import statements together using the standard python rules- system, 3rd party, local.
 

docs/compatible_microcontrollers.md

@@ -2,6 +2,8 @@
 
 QMK runs on any USB-capable AVR or ARM microcontroller with enough flash space - generally 32kB+ for AVR, and 64kB+ for ARM. With significant disabling of features, QMK may *just* squeeze into 16kB AVR MCUs.
 
+Features within QMK may or may not be compatible with every microcontroller.
+
 ## Atmel AVR
 
 The following use [LUFA](https://www.fourwalledcubicle.com/LUFA.php) as the USB stack:
@@ -51,6 +53,7 @@ You can also use any ARM chip with USB that [ChibiOS](https://www.chibios.org) s
 ### WestBerryTech (WB32)
 
  * [WB32F3G71xx](http://www.westberrytech.com)
+ * [WB32FQ95xx](http://www.westberrytech.com)
 
 ### NXP (Kinetis)
 
@@ -59,9 +62,17 @@ You can also use any ARM chip with USB that [ChibiOS](https://www.chibios.org) s
  * [MK20DX128](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/k-series-cortex-m4/k2x-usb/kinetis-k20-50-mhz-full-speed-usb-mixed-signal-integration-microcontrollers-based-on-arm-cortex-m4-core:K20_50)
  * [MK20DX256](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/k-series-cortex-m4/k2x-usb/kinetis-k20-72-mhz-full-speed-usb-mixed-signal-integration-microcontrollers-mcus-based-on-arm-cortex-m4-core:K20_72)
    * PJRC Teensy 3.2
+ * [MK64FX512](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/k-series-cortex-m4/k6x-ethernet/kinetis-k64-120-mhz-256-kb-sram-microcontrollers-mcus-based-on-arm-cortex-m4-core:K64_120)
+   * PJRC Teensy 3.5
  * [MK66FX1M0](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/k-series-cortex-m4/k6x-ethernet/kinetis-k66-180-mhz-dual-high-speed-full-speed-usbs-2mb-flash-microcontrollers-mcus-based-on-arm-cortex-m4-core:K66_180)
    * PJRC Teensy 3.6
 
+### Raspberry Pi
+
+* [RP2040](https://www.raspberrypi.com/documentation/microcontrollers/rp2040.html)
+
+For a detailed overview about the RP2040 support by QMK see the [dedicated RP2040 page](platformdev_rp2040.md).
+
 ## Atmel ATSAM
 
 There is limited support for one of Atmel's ATSAM microcontrollers, that being the [ATSAMD51J18A](https://www.microchip.com/wwwproducts/en/ATSAMD51J18A) used by the [Massdrop keyboards](https://github.com/qmk/qmk_firmware/tree/master/keyboards/massdrop). However, it is not recommended to design a board with this microcontroller as the support is quite specialized to Massdrop hardware.

docs/config_options.md

@@ -2,7 +2,17 @@
 
 QMK is nearly infinitely configurable. Wherever possible we err on the side of allowing users to customize their keyboard, even at the expense of code size. That level of flexibility makes for a daunting configuration experience, however.
 
-There are two main types of configuration files in QMK- `config.h` and `rules.mk`. These files exist at various levels in QMK and all files of the same type are combined to build the final configuration. The levels, from lowest priority to highest priority, are:
+There are three main types of configuration files in QMK:
+
+* `config.h`, which contains various preprocessor directives (`#define`, `#ifdef`)
+* `rules.mk`, which contains additional variables
+* `info.json`, which is utilized for [data-driven configuration](https://docs.qmk.fm/#/data_driven_config)
+
+This page will only discuss the first two types, `config.h` and `rules.mk`.
+
+?> While not all settings have data-driven equivalents yet, keyboard makers are encouraged to utilize the `info.json` file to set the metadata for their boards when possible. See the [`info.json` Format](https://docs.qmk.fm/#/reference_info_json) page for more details.
+
+These files exist at various levels in QMK and all files of the same type are combined to build the final configuration. The levels, from lowest priority to highest priority, are:
 
 * QMK Default
 * Keyboard
@@ -39,11 +49,11 @@ This is a C header file that is one of the first things included, and will persi
   * defines your VID, and for most DIY projects, can be whatever you want
 * `#define PRODUCT_ID 0x5678`
   * defines your PID, and for most DIY projects, can be whatever you want
-* `#define DEVICE_VER 0`
+* `#define DEVICE_VER 0x0100`
   * defines the device version (often used for revisions)
-* `#define MANUFACTURER Me`
+* `#define MANUFACTURER "Me"`
   * generally who/whatever brand produced the board
-* `#define PRODUCT Board`
+* `#define PRODUCT "Board"`
   * the name of the keyboard
 * `#define MATRIX_ROWS 5`
   * the number of rows in your keyboard's matrix
@@ -57,8 +67,6 @@ This is a C header file that is one of the first things included, and will persi
   * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information.
 * `#define MATRIX_IO_DELAY 30`
   * the delay in microseconds when between changing matrix pin state and reading values
-* `#define UNUSED_PINS { D1, D2, D3, B1, B2, B3 }`
-  * pins unused by the keyboard for reference
 * `#define MATRIX_HAS_GHOST`
   * define is matrix has ghost (unlikely)
 * `#define MATRIX_UNSELECT_DRIVE_HIGH`
@@ -107,8 +115,10 @@ This is a C header file that is one of the first things included, and will persi
   * sets the maximum power (in mA) over USB for the device (default: 500)
 * `#define USB_POLLING_INTERVAL_MS 10`
   * sets the USB polling rate in milliseconds for the keyboard, mouse, and shared (NKRO/media keys) interfaces
-* `#define USB_SUSPEND_WAKEUP_DELAY 200`
-  * set the number of milliseconde to pause after sending a wakeup packet
+* `#define USB_SUSPEND_WAKEUP_DELAY 0`
+  * sets the number of milliseconds to pause after sending a wakeup packet.
+    Disabled by default, you might want to set this to 200 (or higher) if the
+    keyboard does not wake up properly after suspending.
 * `#define F_SCL 100000L`
   * sets the I2C clock rate speed for keyboards using I2C. The default is `400000L`, except for keyboards using `split_common`, where the default is `100000L`.
 
@@ -131,6 +141,8 @@ If you define these options you will disable the associated feature, which can s
 
 If you define these options you will enable the associated feature, which may increase your code size.
 
+* `#define ENABLE_COMPILE_KEYCODE`
+  * Enables the `QK_MAKE` keycode
 * `#define FORCE_NKRO`
   * NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
 * `#define STRICT_LAYER_RELEASE`
@@ -139,7 +151,7 @@ If you define these options you will enable the associated feature, which may in
 ## Behaviors That Can Be Configured
 
 * `#define TAPPING_TERM 200`
-  * how long before a tap becomes a hold, if set above 500, a key tapped during the tapping term will turn it into a hold too
+  * how long before a key press becomes a hold
 * `#define TAPPING_TERM_PER_KEY`
   * enables handling for per key `TAPPING_TERM` settings
 * `#define RETRO_TAPPING`
@@ -172,27 +184,20 @@ If you define these options you will enable the associated feature, which may in
   * sets the timer for leader key chords to run on each key press rather than overall
 * `#define LEADER_KEY_STRICT_KEY_PROCESSING`
   * Disables keycode filtering for Mod-Tap and Layer-Tap keycodes. Eg, if you enable this, you would need to specify `MT(MOD_CTL, KC_A)` if you want to use `KC_A`.
+* `#define MOUSE_EXTENDED_REPORT`
+  * Enables support for extended reports (-32767 to 32767, instead of -127 to 127), which may allow for smoother reporting, and prevent maxing out of the reports. Applies to both Pointing Device and Mousekeys.
 * `#define ONESHOT_TIMEOUT 300`
   * how long before oneshot times out
 * `#define ONESHOT_TAP_TOGGLE 2`
   * how many taps before oneshot toggle is triggered
-* `#define QMK_KEYS_PER_SCAN 4`
-  * Allows sending more than one key per scan. By default, only one key event gets
-    sent via `process_record()` per scan. This has little impact on most typing, but
-    if you're doing a lot of chords, or your scan rate is slow to begin with, you can
-    have some delay in processing key events. Each press and release is a separate
-    event. For a keyboard with 1ms or so scan times, even a very fast typist isn't
-    going to produce the 500 keystrokes a second needed to actually get more than a
-    few ms of delay from this. But if you're doing chording on something with 3-4ms
-    scan times? You probably want this.
 * `#define COMBO_COUNT 2`
   * Set this to the number of combos that you're using in the [Combo](feature_combo.md) feature. Or leave it undefined and programmatically set the count.
 * `#define COMBO_TERM 200`
   * how long for the Combo keys to be detected. Defaults to `TAPPING_TERM` if not defined.
 * `#define COMBO_MUST_HOLD_MODS`
-  * Flag for enabling extending timeout on Combos containing modifers
+  * Flag for enabling extending timeout on Combos containing modifiers
 * `#define COMBO_MOD_TERM 200`
-  * Allows for extending COMBO_TERM for mod keys while mid-combo. 
+  * Allows for extending COMBO_TERM for mod keys while mid-combo.
 * `#define COMBO_MUST_HOLD_PER_COMBO`
   * Flag to enable per-combo COMBO_TERM extension and `get_combo_must_hold()` function
 * `#define COMBO_TERM_PER_COMBO`
@@ -202,7 +207,7 @@ If you define these options you will enable the associated feature, which may in
 * `#define COMBO_NO_TIMER`
   * Disable the combo timer completely for relaxed combos.
 * `#define TAP_CODE_DELAY 100`
-  * Sets the delay between `register_code` and `unregister_code`, if you're having issues with it registering properly (common on VUSB boards). The value is in milliseconds.
+  * Sets the delay between `register_code` and `unregister_code`, if you're having issues with it registering properly (common on VUSB boards). The value is in milliseconds and defaults to `0`.
 * `#define TAP_HOLD_CAPS_DELAY 80`
   * Sets the delay for Tap Hold keys (`LT`, `MT`) when using `KC_CAPS_LOCK` keycode, as this has some special handling on MacOS.  The value is in milliseconds, and defaults to 80 ms if not defined. For macOS, you may want to set this to 200 or higher.
 * `#define KEY_OVERRIDE_REPEAT_DELAY 500`
@@ -212,14 +217,12 @@ If you define these options you will enable the associated feature, which may in
 
 * `#define RGB_DI_PIN D7`
   * pin the DI on the WS2812 is hooked-up to
-* `#define RGBLIGHT_ANIMATIONS`
-  * run RGB animations
 * `#define RGBLIGHT_LAYERS`
   * Lets you define [lighting layers](feature_rgblight.md?id=lighting-layers) that can be toggled on or off. Great for showing the current keyboard layer or caps lock state.
 * `#define RGBLIGHT_MAX_LAYERS`
   * Defaults to 8. Can be expanded up to 32 if more [lighting layers](feature_rgblight.md?id=lighting-layers) are needed.
   * Note: Increasing the maximum will increase the firmware size and slow sync on split keyboards.
-* `#define RGBLIGHT_LAYER_BLINK` 
+* `#define RGBLIGHT_LAYER_BLINK`
   * Adds ability to [blink](feature_rgblight.md?id=lighting-layer-blink) a lighting layer for a specified number of milliseconds (e.g. to acknowledge an action).
 * `#define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF`
   * If defined, then [lighting layers](feature_rgblight?id=overriding-rgb-lighting-onoff-status) will be shown even if RGB Light is off.
@@ -322,6 +325,13 @@ There are a few different ways to set handedness for split keyboards (listed in
 
 * `#define SPLIT_USB_TIMEOUT_POLL 10`
   * Poll frequency when detecting master/slave when using `SPLIT_USB_DETECT`
+  
+* `#define SPLIT_WATCHDOG_ENABLE`
+  * Reboot slave if no communication from master within timeout.
+  * Helps resolve issue where both sides detect as slave using `SPLIT_USB_DETECT`
+
+* `#define SPLIT_WATCHDOG_TIMEOUT 3000`
+  * Maximum slave timeout when waiting for communication from master when using `SPLIT_WATCHDOG_ENABLE`
 
 * `#define FORCED_SYNC_THROTTLE_MS 100`
   * Deadline for synchronizing data from master to slave when using the QMK-provided split transport.
@@ -364,8 +374,8 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i
 * `SRC`
   * Used to add files to the compilation/linking list.
 * `LIB_SRC`
-  * Used to add files as a library to the compilation/linking list.  
-    The files specified by `LIB_SRC` is linked after the files specified by `SRC`.  
+  * Used to add files as a library to the compilation/linking list.
+    The files specified by `LIB_SRC` is linked after the files specified by `SRC`.
     For example, if you specify:
     ```
     SRC += a.c
@@ -418,7 +428,7 @@ Use these to enable or disable building certain features. The more you have enab
 * `NKRO_ENABLE`
   * USB N-Key Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 * `RING_BUFFERED_6KRO_REPORT_ENABLE`
-  * USB 6-Key Rollover - Instead of stopping any new input once 6 keys are pressed, the oldest key is released and the new key is pressed. 
+  * USB 6-Key Rollover - Instead of stopping any new input once 6 keys are pressed, the oldest key is released and the new key is pressed.
 * `AUDIO_ENABLE`
   * Enable the audio subsystem.
 * `KEY_OVERRIDE_ENABLE`

docs/configurator_default_keymaps.md

@@ -56,7 +56,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   [1] = LAYOUT_all(
     KC_TRNS,          KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RGB_TOG, RGB_MOD, RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, RGB_VAD, RGB_VAI,             BL_TOGG, BL_DEC,  BL_INC,
     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    KC_TRNS, KC_TRNS, KC_VOLU,
-    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RESET,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,             KC_MPLY, KC_MNXT, KC_VOLD,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, QK_BOOT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,             KC_MPLY, KC_MNXT, KC_VOLD,
     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,                      KC_TRNS,
     KC_TRNS, KC_TRNS, KC_TRNS,                            KC_TRNS,                            KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,             KC_TRNS, KC_TRNS, KC_TRNS),
@@ -84,7 +84,7 @@ The default keymap uses the `LAYOUT_all` macro, so that will be the value of the
     [
       "KC_TRNS",            "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "RGB_TOG", "RGB_MOD", "RGB_HUD", "RGB_HUI", "RGB_SAD", "RGB_SAI", "RGB_VAD", "RGB_VAI",               "BL_TOGG", "BL_DEC",  "BL_INC",
       "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",    "KC_TRNS", "KC_TRNS", "KC_VOLU",
-      "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "RESET",   "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",               "KC_MPLY", "KC_MNXT", "KC_VOLD",
+      "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "QK_BOOT", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",               "KC_MPLY", "KC_MNXT", "KC_VOLD",
       "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",
       "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",                          "KC_TRNS",
       "KC_TRNS", "KC_TRNS", "KC_TRNS",                                  "KC_TRNS",                                  "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",               "KC_TRNS", "KC_TRNS", "KC_TRNS"
@@ -122,26 +122,26 @@ There is a way to support custom keycodes: if the logic for a custom keycode is
 
 ```c
 enum custom_keycodes {
-    MACRO_1 = SAFE_RANGE,
-    MACRO_2,
-    MACRO_3
+    CUSTOM_1 = SAFE_RANGE,
+    CUSTOM_2,
+    CUSTOM_3
 };
 ...
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
     switch(keycode) {
-        case MACRO_1:
+        case CUSTOM_1:
             if (record->event.pressed) {
-                SEND_STRING("This is macro #1.");
+                SEND_STRING("This is custom keycode #1.");
             }
             return false;
-        case MACRO_2:
+        case CUSTOM_2:
             if (record->event.pressed) {
-                SEND_STRING("This is macro #2.");
+                SEND_STRING("This is custom keycode #2.");
             }
             return false;
-        case MACRO_3:
+        case CUSTOM_3:
             if (record->event.pressed) {
-                SEND_STRING("This is macro #3.");
+                SEND_STRING("This is custom keycode #3.");
             }
             return false;
     }
@@ -153,9 +153,9 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 
 ```c
 enum keyboard_keycodes {
-    MACRO_1 = SAFE_RANGE,
-    MACRO_2,
-    MACRO_3,
+    CUSTOM_1 = SAFE_RANGE,
+    CUSTOM_2,
+    CUSTOM_3,
     NEW_SAFE_RANGE  // Important!
 };
 ```
@@ -165,19 +165,19 @@ enum keyboard_keycodes {
 ```c
 bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
     switch(keycode) {
-        case MACRO_1:
+        case CUSTOM_1:
             if (record->event.pressed) {
-                SEND_STRING("This is macro #1.");
+                SEND_STRING("This is custom keycode #1.");
             }
             return false;
-        case MACRO_2:
+        case CUSTOM_2:
             if (record->event.pressed) {
-                SEND_STRING("This is macro #2.");
+                SEND_STRING("This is custom keycode #2.");
             }
             return false;
-        case MACRO_3:
+        case CUSTOM_3:
             if (record->event.pressed) {
-                SEND_STRING("This is macro #3.");
+                SEND_STRING("This is custom keycode #3.");
             }
             return false;
     }

docs/custom_matrix.md

@@ -81,17 +81,17 @@ void matrix_init(void) {
 }
 
 uint8_t matrix_scan(void) {
-    bool matrix_has_changed = false;
+    bool changed = false;
 
     // TODO: add matrix scanning routine here
 
     // Unless hardware debouncing - use the configured debounce routine
-    debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
+    changed = debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
 
     // This *must* be called for correct keyboard behavior
     matrix_scan_quantum();
 
-    return matrix_has_changed;
+    return changed;
 }
 ```
 

docs/custom_quantum_functions.md

@@ -102,11 +102,11 @@ These are the three main initialization functions, listed in the order that they
 
 ## Keyboard Pre Initialization code
 
-This runs very early during startup, even before the USB has been started. 
+This runs very early during startup, even before the USB has been started.
 
 Shortly after this, the matrix is initialized.
 
-For most users, this shouldn't be used, as it's primarily for hardware oriented initialization. 
+For most users, this shouldn't be used, as it's primarily for hardware oriented initialization.
 
 However, if you have hardware stuff that you need initialized, this is the best place for it (such as initializing LED pins).
 
@@ -134,9 +134,9 @@ void keyboard_pre_init_user(void) {
 
 ## Matrix Initialization Code
 
-This is called when the matrix is initialized, and after some of the hardware has been set up, but before many of the features have been initialized. 
+This is called when the matrix is initialized, and after some of the hardware has been set up, but before many of the features have been initialized.
 
-This is useful for setting up stuff that you may need elsewhere, but isn't hardware related nor is dependant on where it's started. 
+This is useful for setting up stuff that you may need elsewhere, but isn't hardware related nor is dependant on where it's started.
 
 
 ### `matrix_init_*` Function Documentation
@@ -227,190 +227,11 @@ void suspend_wakeup_init_user(void) {
 * Keyboard/Revision: `void suspend_power_down_kb(void)` and `void suspend_wakeup_init_user(void)`
 * Keymap: `void suspend_power_down_kb(void)` and `void suspend_wakeup_init_user(void)`
 
-# Layer Change Code :id=layer-change-code
-
-This runs code every time that the layers get changed.  This can be useful for layer indication, or custom layer handling.
-
-### Example `layer_state_set_*` Implementation
-
-This example shows how to set the [RGB Underglow](feature_rgblight.md) lights based on the layer, using the Planck as an example.
-
-```c
-layer_state_t layer_state_set_user(layer_state_t state) {
-    switch (get_highest_layer(state)) {
-    case _RAISE:
-        rgblight_setrgb (0x00,  0x00, 0xFF);
-        break;
-    case _LOWER:
-        rgblight_setrgb (0xFF,  0x00, 0x00);
-        break;
-    case _PLOVER:
-        rgblight_setrgb (0x00,  0xFF, 0x00);
-        break;
-    case _ADJUST:
-        rgblight_setrgb (0x7A,  0x00, 0xFF);
-        break;
-    default: //  for any other layers, or the default layer
-        rgblight_setrgb (0x00,  0xFF, 0xFF);
-        break;
-    }
-  return state;
-}
-```
-
-Use the `IS_LAYER_ON_STATE(state, layer)` and `IS_LAYER_OFF_STATE(state, layer)` macros to check the status of a particular layer.
-
-Outside of `layer_state_set_*` functions, you can use the `IS_LAYER_ON(layer)` and `IS_LAYER_OFF(layer)` macros to check global layer state.
-
-### `layer_state_set_*` Function Documentation
-
-* Keyboard/Revision: `layer_state_t layer_state_set_kb(layer_state_t state)`
-* Keymap: `layer_state_t layer_state_set_user(layer_state_t state)`
-
-
-The `state` is the bitmask of the active layers, as explained in the [Keymap Overview](keymap.md#keymap-layer-status)
-
-
-# Persistent Configuration (EEPROM)
-
-This allows you to configure persistent settings for your keyboard.  These settings are stored in the EEPROM of your controller, and are retained even after power loss. The settings can be read with `eeconfig_read_kb` and `eeconfig_read_user`, and can be written to using `eeconfig_update_kb` and `eeconfig_update_user`. This is useful for features that you want to be able to toggle (like toggling rgb layer indication).  Additionally, you can use `eeconfig_init_kb` and `eeconfig_init_user` to set the default values for the EEPROM. 
-
-The complicated part here, is that there are a bunch of ways that you can store and access data via EEPROM, and there is no "correct" way to do this.  However, you only have a DWORD (4 bytes) for each function.
-
-Keep in mind that EEPROM has a limited number of writes. While this is very high, it's not the only thing writing to the EEPROM, and if you write too often, you can potentially drastically shorten the life of your MCU.
-
-* If you don't understand the example, then you may want to avoid using this feature, as it is rather complicated. 
-
-### Example Implementation
-
-This is an example of how to add settings, and read and write it. We're using the user keymap for the example here.  This is a complex function, and has a lot going on.  In fact, it uses a lot of the above functions to work! 
-
-
-In your keymap.c file, add this to the top:
-```c
-typedef union {
-  uint32_t raw;
-  struct {
-    bool     rgb_layer_change :1;
-  };
-} user_config_t;
-
-user_config_t user_config;
-```
-
-This sets up a 32 bit structure that we can store settings with in memory, and write to the EEPROM. Using this removes the need to define variables, since they're defined in this structure. Remember that `bool` (boolean) values use 1 bit, `uint8_t` uses 8 bits, `uint16_t` uses up 16 bits.  You can mix and match, but changing the order can cause issues, as it will change the values that are read and written. 
-
-We're using `rgb_layer_change`, for the `layer_state_set_*` function, and use `keyboard_post_init_user` and `process_record_user` to configure everything. 
-
-Now, using the `keyboard_post_init_user` code above, you want to add `eeconfig_read_user()` to it, to populate the structure you've just created. And you can then immediately use this structure to control functionality in your keymap.  And It should look like: 
-```c
-void keyboard_post_init_user(void) {
-  // Call the keymap level matrix init.
-
-  // Read the user config from EEPROM
-  user_config.raw = eeconfig_read_user();
-
-  // Set default layer, if enabled
-  if (user_config.rgb_layer_change) {
-    rgblight_enable_noeeprom();
-    rgblight_sethsv_noeeprom_cyan();
-    rgblight_mode_noeeprom(1);
-  }
-}
-```
-The above function will use the EEPROM config immediately after reading it, to set the default layer's RGB color. The "raw" value of it is converted in a usable structure based on the "union" that you created above. 
-
-```c
-layer_state_t layer_state_set_user(layer_state_t state) {
-    switch (get_highest_layer(state)) {
-    case _RAISE:
-        if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_magenta(); rgblight_mode_noeeprom(1); }
-        break;
-    case _LOWER:
-        if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_red(); rgblight_mode_noeeprom(1); }
-        break;
-    case _PLOVER:
-        if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_green(); rgblight_mode_noeeprom(1); }
-        break;
-    case _ADJUST:
-        if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_white(); rgblight_mode_noeeprom(1); }
-        break;
-    default: //  for any other layers, or the default layer
-        if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_cyan(); rgblight_mode_noeeprom(1); }
-        break;
-    }
-  return state;
-}
-```
-This will cause the RGB underglow to be changed ONLY if the value was enabled.  Now to configure this value, create a new keycode for `process_record_user` called `RGB_LYR`. Additionally, we want to make sure that if you use the normal RGB codes, that it turns off  Using the example above, make it look this:
-```c
-
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-  switch (keycode) {
-    case FOO:
-      if (record->event.pressed) {
-        // Do something when pressed
-      } else {
-        // Do something else when release
-      }
-      return false; // Skip all further processing of this key
-    case KC_ENTER:
-        // Play a tone when enter is pressed
-        if (record->event.pressed) {
-            PLAY_SONG(tone_qwerty);
-        }
-        return true; // Let QMK send the enter press/release events
-    case RGB_LYR:  // This allows me to use underglow as layer indication, or as normal
-        if (record->event.pressed) {
-            user_config.rgb_layer_change ^= 1; // Toggles the status
-            eeconfig_update_user(user_config.raw); // Writes the new status to EEPROM
-            if (user_config.rgb_layer_change) { // if layer state indication is enabled,
-                layer_state_set(layer_state);   // then immediately update the layer color
-            }
-        }
-        return false;
-    case RGB_MODE_FORWARD ... RGB_MODE_GRADIENT: // For any of the RGB codes (see quantum_keycodes.h, L400 for reference)
-        if (record->event.pressed) { //This disables layer indication, as it's assumed that if you're changing this ... you want that disabled
-            if (user_config.rgb_layer_change) {        // only if this is enabled
-                user_config.rgb_layer_change = false;  // disable it, and
-                eeconfig_update_user(user_config.raw); // write the setings to EEPROM
-            }
-        }
-        return true; break;
-    default:
-      return true; // Process all other keycodes normally
-  }
-}
-```
-And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EEP_RST` keycode or [Bootmagic Lite](feature_bootmagic.md) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued.
-
-```c
-void eeconfig_init_user(void) {  // EEPROM is getting reset!
-  user_config.raw = 0;
-  user_config.rgb_layer_change = true; // We want this enabled by default
-  eeconfig_update_user(user_config.raw); // Write default value to EEPROM now
-
-  // use the non noeeprom versions, to write these values to EEPROM too
-  rgblight_enable(); // Enable RGB by default
-  rgblight_sethsv_cyan();  // Set it to CYAN by default
-  rgblight_mode(1); // set to solid by default
-}
-```
-
-And you're done.  The RGB layer indication will only work if you want it to. And it will be saved, even after unplugging the board. And if you use any of the RGB codes, it will disable the layer indication, so that it stays on the mode and color that you set it to. 
-
-### 'EECONFIG' Function Documentation
-
-* Keyboard/Revision: `void eeconfig_init_kb(void)`, `uint32_t eeconfig_read_kb(void)` and `void eeconfig_update_kb(uint32_t val)`
-* Keymap: `void eeconfig_init_user(void)`, `uint32_t eeconfig_read_user(void)` and `void eeconfig_update_user(uint32_t val)`
-
-The `val` is the value of the data that you want to write to EEPROM.  And the `eeconfig_read_*` function return a 32 bit (DWORD) value from the EEPROM. 
-
-### Deferred Execution :id=deferred-execution
+# Deferred Execution :id=deferred-execution
 
 QMK has the ability to execute a callback after a specified period of time, rather than having to manually manage timers. To enable this functionality, set `DEFERRED_EXEC_ENABLE = yes` in rules.mk.
 
-#### Deferred executor callbacks
+## Deferred executor callbacks
 
 All _deferred executor callbacks_ have a common function signature and look like:
 
@@ -430,7 +251,7 @@ The return value is the number of milliseconds to use if the function should be
 
 ?> Note that the returned delay will be applied to the intended trigger time, not the time of callback invocation. This allows for generally consistent timing even in the face of occasional late execution.
 
-#### Deferred executor registration
+## Deferred executor registration
 
 Once a callback has been defined, it can be scheduled using the following API:
 
@@ -444,7 +265,7 @@ The third parameter is the `cb_arg` that gets passed to the callback at the poin
 
 The return value is a `deferred_token` that can consequently be used to cancel the deferred executor callback before it's invoked. If a failure occurs, the returned value will be `INVALID_DEFERRED_TOKEN`. Usually this will be as a result of supplying `0` to the delay, or a `NULL` for the callback. The other failure case is if there are too many deferred executions "in flight" -- this can be increased by changing the limit, described below.
 
-#### Extending a deferred execution
+## Extending a deferred execution
 
 The `deferred_token` returned by `defer_exec()` can be used to extend a the duration a pending execution waits before it gets invoked:
 ```c
@@ -452,7 +273,7 @@ The `deferred_token` returned by `defer_exec()` can be used to extend a the dura
 extend_deferred_exec(my_token, 800);
 ```
 
-#### Cancelling a deferred execution
+## Cancelling a deferred execution
 
 The `deferred_token` returned by `defer_exec()` can be used to cancel a pending execution before it gets invoked:
 ```c
@@ -462,7 +283,7 @@ cancel_deferred_exec(my_token);
 
 Once a token has been canceled, it should be considered invalid. Reusing the same token is not supported.
 
-#### Deferred callback limits
+## Deferred callback limits
 
 There are a maximum number of deferred callbacks that can be scheduled, controlled by the value of the define `MAX_DEFERRED_EXECUTORS`.
 
@@ -471,3 +292,15 @@ If registrations fail, then you can increase this value in your keyboard or keym
 ```c
 #define MAX_DEFERRED_EXECUTORS 16
 ```
+
+# Advanced topics :id=advanced-topics
+
+This page used to encompass a large set of features. We have moved many sections that used to be part of this page to their own pages. Everything below this point is simply a redirect so that people following old links on the web find what they're looking for.
+
+## Layer Change Code :id=layer-change-code
+
+[Layer change code](feature_layers.md#layer-change-code)
+
+## Persistent Configuration (EEPROM) :id=persistent-configuration-eeprom
+
+[Persistent Configuration (EEPROM)](feature_eeprom.md)

docs/data_driven_config.md

@@ -22,7 +22,7 @@ You will then need to add support for your new configuration to `info.json`. The
 
 1. Add it to the schema in `data/schemas/keyboards.jsonschema`
 1. Add a mapping in `data/maps`
-1. (optional and discoraged) Add code to extract/generate it to:
+1. (optional and discouraged) Add code to extract/generate it to:
   * `lib/python/qmk/info.py`
   * `lib/python/qmk/cli/generate/config_h.py`
   * `lib/python/qmk/cli/generate/rules_mk.py`
@@ -41,10 +41,10 @@ In other cases you should group like options together in an `object`. This is pa
 
 ### Add a mapping
 
-In most cases you can add a simple mapping. These are maintained as JSON files in `data/mappings/info_config.json` and `data/mappings/info_rules.json`, and control mapping for `config.h` and `rules.mk`, respectively. Each mapping is keyed by the `config.h` or `rules.mk` variable, and the value is a hash with the following keys:
+In most cases you can add a simple mapping. These are maintained as JSON files in `data/mappings/info_config.hjson` and `data/mappings/info_rules.hjson`, and control mapping for `config.h` and `rules.mk`, respectively. Each mapping is keyed by the `config.h` or `rules.mk` variable, and the value is a hash with the following keys:
 
 * `info_key`: (required) The location within `info.json` for this value. See below.
-* `value_type`: (optional) Default `str`. The format for this variable's value. See below.
+* `value_type`: (optional) Default `raw`. The format for this variable's value. See below.
 * `to_json`: (optional) Default `true`. Set to `false` to exclude this mapping from info.json
 * `to_c`: (optional) Default `true`. Set to `false` to exclude this mapping from config.h
 * `warn_duplicate`: (optional) Default `true`. Set to `false` to turn off warning when a value exists in both places
@@ -57,7 +57,7 @@ Under the hood we use [Dotty Dict](https://dotty-dict.readthedocs.io/en/latest/)
 
 #### Value Types
 
-By default we treat all values as simple strings. If your value is more complex you can use one of these types to intelligently parse the data:
+By default we treat all values as unquoted "raw" data. If your value is more complex you can use one of these types to intelligently parse the data:
 
 * `array`: A comma separated array of strings
 * `array.int`: A comma separated array of integers
@@ -65,6 +65,7 @@ By default we treat all values as simple strings. If your value is more complex
 * `hex`: A number formatted as hex
 * `list`: A space separate array of strings
 * `mapping`: A hash of key/value pairs
+* `str`: A quoted string literal
 
 ### Add code to extract it
 

docs/documentation_templates.md

@@ -4,7 +4,7 @@ This page documents the templates you should use when submitting new Keymaps and
 
 ## Keymap `readme.md` Template :id=keyboard-readmemd-template
 
-Most keymaps have an image depicting the layout. You can use [Keyboard Layout Editor](https://keyboard-layout-editor.com) to create an image. Upload it to [Imgur](https://imgur.com) or another hosting service, please do not include images in your Pull Request.
+Most keymaps have an image depicting the layout. You can use [Keyboard Layout Editor](http://keyboard-layout-editor.com) to create an image. Upload it to [Imgur](https://imgur.com) or another hosting service, please do not include images in your Pull Request.
 
 Below the image you should write a short description to help people understand your keymap.
 

docs/driver_installation_zadig.md

@@ -8,7 +8,7 @@ We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have
 
 ## Installation
 
-Put your keyboard into bootloader mode, either by hitting the `RESET` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic Lite](feature_bootmagic.md) docs for more details). Some boards use [Command](feature_command.md) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in.
+Put your keyboard into bootloader mode, either by hitting the `QK_BOOT` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic Lite](feature_bootmagic.md) docs for more details). Some boards use [Command](feature_command.md) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in.
 Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic Lite](feature_bootmagic.md) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure.
 
 To put a device in bootloader mode with USBaspLoader, tap the `RESET` button while holding down the `BOOT` button.

docs/eeprom_driver.md

@@ -2,12 +2,15 @@
 
 The EEPROM driver can be swapped out depending on the needs of the keyboard, or whether extra hardware is present.
 
+Selecting the EEPROM driver is done in your keyboard's `rules.mk`:
+
 Driver                             | Description
 -----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 `EEPROM_DRIVER = vendor` (default) | Uses the on-chip driver provided by the chip manufacturer. For AVR, this is provided by avr-libc. This is supported on ARM for a subset of chips -- STM32F3xx, STM32F1xx, and STM32F072xB will be emulated by writing to flash. STM32L0xx and STM32L1xx will use the onboard dedicated true EEPROM. Other chips will generally act as "transient" below.
 `EEPROM_DRIVER = i2c`              | Supports writing to I2C-based 24xx EEPROM chips. See the driver section below.
 `EEPROM_DRIVER = spi`              | Supports writing to SPI-based 25xx EEPROM chips. See the driver section below.
 `EEPROM_DRIVER = transient`        | Fake EEPROM driver -- supports reading/writing to RAM, and will be discarded when power is lost.
+`EEPROM_DRIVER = wear_leveling`    | Frontend driver for the wear_leveling system, allowing for EEPROM emulation on top of flash -- both in-MCU and external SPI NOR flash.
 
 ## Vendor Driver Configuration :id=vendor-eeprom-driver-configuration
 
@@ -43,8 +46,9 @@ Module           | Equivalent `#define`            | Source
 -----------------|---------------------------------|------------------------------------------
 CAT24C512 EEPROM | `#define EEPROM_I2C_CAT24C512`  | <https://www.sparkfun.com/products/14764>
 RM24C512C EEPROM | `#define EEPROM_I2C_RM24C512C`  | <https://www.sparkfun.com/products/14764>
-24LC64 EEPROM    | `#define EEPROM_I2C_24LC64`     | <https://www.microchip.com/wwwproducts/en/24LC64>
-24LC128 EEPROM   | `#define EEPROM_I2C_24LC128`    | <https://www.microchip.com/wwwproducts/en/24LC128>
+24LC32A EEPROM   | `#define EEPROM_I2C_24LC32A`    | <https://www.microchip.com/en-us/product/24LC32A>
+24LC64 EEPROM    | `#define EEPROM_I2C_24LC64`     | <https://www.microchip.com/en-us/product/24LC64>
+24LC128 EEPROM   | `#define EEPROM_I2C_24LC128`    | <https://www.microchip.com/en-us/product/24LC128>
 24LC256 EEPROM   | `#define EEPROM_I2C_24LC256`    | <https://www.sparkfun.com/products/525>
 MB85RC256V FRAM  | `#define EEPROM_I2C_MB85RC256V` | <https://www.adafruit.com/product/1895>
 
@@ -54,13 +58,13 @@ MB85RC256V FRAM  | `#define EEPROM_I2C_MB85RC256V` | <https://www.adafruit.com/p
 
 Currently QMK supports 25xx-series chips over SPI. As such, requires a working spi_master driver configuration. You can override the driver configuration via your config.h:
 
-`config.h` override                            | Description                                                                          | Default Value
------------------------------------------------|--------------------------------------------------------------------------------------|--------------
-`#define EXTERNAL_EEPROM_SPI_SLAVE_SELECT_PIN` | SPI Slave select pin in order to inform that the EEPROM is currently being addressed | _none_
-`#define EXTERNAL_EEPROM_SPI_CLOCK_DIVISOR`    | Clock divisor used to divide the peripheral clock to derive the SPI frequency        | `64`
-`#define EXTERNAL_EEPROM_BYTE_COUNT`           | Total size of the EEPROM in bytes                                                    | 8192
-`#define EXTERNAL_EEPROM_PAGE_SIZE`            | Page size of the EEPROM in bytes, as specified in the datasheet                      | 32
-`#define EXTERNAL_EEPROM_ADDRESS_SIZE`         | The number of bytes to transmit for the memory location within the EEPROM            | 2
+`config.h` override                            | Default Value | Description
+-----------------------------------------------|---------------|-------------------------------------------------------------------------------------
+`#define EXTERNAL_EEPROM_SPI_SLAVE_SELECT_PIN` | _none_        | SPI Slave select pin in order to inform that the EEPROM is currently being addressed
+`#define EXTERNAL_EEPROM_SPI_CLOCK_DIVISOR`    | `64`          | Clock divisor used to divide the peripheral clock to derive the SPI frequency
+`#define EXTERNAL_EEPROM_BYTE_COUNT`           | `8192`        | Total size of the EEPROM in bytes
+`#define EXTERNAL_EEPROM_PAGE_SIZE`            | `32`          | Page size of the EEPROM in bytes, as specified in the datasheet
+`#define EXTERNAL_EEPROM_ADDRESS_SIZE`         | `2`           | The number of bytes to transmit for the memory location within the EEPROM
 
 !> There's no way to determine if there is an SPI EEPROM actually responding. Generally, this will result in reads of nothing but zero.
 
@@ -73,3 +77,84 @@ The only configurable item for the transient EEPROM driver is its size:
 `#define TRANSIENT_EEPROM_SIZE` | Total size of the EEPROM storage in bytes | 64
 
 Default values and extended descriptions can be found in `drivers/eeprom/eeprom_transient.h`.
+
+## Wear-leveling Driver Configuration :id=wear_leveling-eeprom-driver-configuration
+
+The wear-leveling driver uses an algorithm to minimise the number of erase cycles on the underlying MCU flash memory.
+
+There is no specific configuration for this driver, but the wear-leveling system used by this driver may need configuration. See the [wear-leveling configuration](#wear_leveling-configuration) section for more information.
+
+# Wear-leveling Configuration :id=wear_leveling-configuration
+
+The wear-leveling driver has a few possible _backing stores_ that may be used by adding to your keyboard's `rules.mk` file:
+
+Driver                                  | Description
+----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+`WEAR_LEVELING_DRIVER = embedded_flash` | This driver is used for emulating EEPROM by writing to embedded flash on the MCU.
+`WEAR_LEVELING_DRIVER = spi_flash`      | This driver is used to address external SPI NOR Flash peripherals.
+`WEAR_LEVELING_DRIVER = rp2040_flash`   | This driver is used to write to the same storage the RP2040 executes code from.
+`WEAR_LEVELING_DRIVER = legacy`         | This driver is the "legacy" emulated EEPROM provided in historical revisions of QMK. Currently used for STM32F0xx and STM32F4x1, but slated for deprecation and removal once `embedded_flash` support for those MCU families is complete.
+
+!> All wear-leveling drivers require an amount of RAM equivalent to the selected logical EEPROM size. Increasing the size to 32kB of EEPROM requires 32kB of RAM, which a significant number of MCUs simply do not have.
+
+## Wear-leveling Embedded Flash Driver Configuration :id=wear_leveling-efl-driver-configuration
+
+This driver performs writes to the embedded flash storage embedded in the MCU. In most circumstances, the last few of sectors of flash are used in order to minimise the likelihood of collision with program code.
+
+Configurable options in your keyboard's `config.h`:
+
+`config.h` override                      | Default     | Description
+-----------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+`#define WEAR_LEVELING_EFL_FIRST_SECTOR` | _unset_     | The first sector on the MCU to use. By default this is not defined and calculated at runtime based on the MCU. However, different flash sizes on MCUs may require custom configuration.
+`#define WEAR_LEVELING_EFL_FLASH_SIZE`   | _unset_     | Allows overriding the flash size available for use for wear-leveling. Under normal circumstances this is automatically calculated and should not need to be overridden. Specifying a size larger than the amount actually available in flash will usually prevent the MCU from booting.
+`#define WEAR_LEVELING_LOGICAL_SIZE`     | `1024`      | Number of bytes "exposed" to the rest of QMK and denotes the size of the usable EEPROM.
+`#define WEAR_LEVELING_BACKING_SIZE`     | `2048`      | Number of bytes used by the wear-leveling algorithm for its underlying storage, and needs to be a multiple of the logical size.
+`#define BACKING_STORE_WRITE_SIZE`       | _automatic_ | The byte width of the underlying write used on the MCU, and is usually automatically determined from the selected MCU family. If an error occurs in the auto-detection, you'll need to consult the MCU's datasheet and determine this value, specifying it directly.
+
+!> If your MCU does not boot after swapping to the EFL wear-leveling driver, it's likely that the flash size is incorrectly detected, usually as an MCU with larger flash and may require overriding.
+
+## Wear-leveling SPI Flash Driver Configuration :id=wear_leveling-flash_spi-driver-configuration
+
+This driver performs writes to an external SPI NOR Flash peripheral. It also requires a working configuration for the SPI NOR Flash peripheral -- see the [flash driver](flash_driver.md) documentation for more information.
+
+Configurable options in your keyboard's `config.h`:
+
+`config.h` override                                 | Default                        | Description
+----------------------------------------------------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------
+`#define WEAR_LEVELING_EXTERNAL_FLASH_BLOCK_COUNT`  | `1`                            | Number of blocks in the external flash used by the wear-leveling algorithm.
+`#define WEAR_LEVELING_EXTERNAL_FLASH_BLOCK_OFFSET` | `0`                            | The index first block in the external flash used by the wear-leveling algorithm.
+`#define WEAR_LEVELING_LOGICAL_SIZE`                | `((block_count*block_size)/2)` | Number of bytes "exposed" to the rest of QMK and denotes the size of the usable EEPROM. Result must be <= 64kB.
+`#define WEAR_LEVELING_BACKING_SIZE`                | `(block_count*block_size)`     | Number of bytes used by the wear-leveling algorithm for its underlying storage, and needs to be a multiple of the logical size.
+`#define BACKING_STORE_WRITE_SIZE`                  | `8`                            | The write width used whenever a write is performed on the external flash peripheral.
+
+!> There is currently a limit of 64kB for the EEPROM subsystem within QMK, so using a larger flash is not going to be beneficial as the logical size cannot be increased beyond 65536. The backing size may be increased to a larger value, but erase timing may suffer as a result.
+
+## Wear-leveling RP2040 Driver Configuration :id=wear_leveling-rp2040-driver-configuration
+
+This driver performs writes to the same underlying storage that the RP2040 executes its code.
+
+Configurable options in your keyboard's `config.h`:
+
+`config.h` override                       | Default                    | Description
+------------------------------------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------
+`#define WEAR_LEVELING_RP2040_FLASH_SIZE` | `PICO_FLASH_SIZE_BYTES`    | Number of bytes of flash on the board.
+`#define WEAR_LEVELING_RP2040_FLASH_BASE` | `(flash_size-sector_size)` | The byte-wise location that the backing storage should be located.
+`#define WEAR_LEVELING_LOGICAL_SIZE`      | `4096`                     | Number of bytes "exposed" to the rest of QMK and denotes the size of the usable EEPROM.
+`#define WEAR_LEVELING_BACKING_SIZE`      | `8192`                     | Number of bytes used by the wear-leveling algorithm for its underlying storage, and needs to be a multiple of the logical size as well as the sector size.
+`#define BACKING_STORE_WRITE_SIZE`        | `2`                        | The write width used whenever a write is performed on the external flash peripheral.
+
+## Wear-leveling Legacy EEPROM Emulation Driver Configuration :id=wear_leveling-legacy-driver-configuration
+
+This driver performs writes to the embedded flash storage embedded in the MCU much like the normal Embedded Flash Driver, and is only for use with STM32F0xx and STM32F4x1 devices. This flash implementation is still currently provided as the EFL driver is currently non-functional for the previously mentioned families.
+
+By default, `1024` bytes of emulated EEPROM is provided:
+
+MCU       | EEPROM Provided | Flash Used
+----------|-----------------|--------------
+STM32F042 | `1024` bytes    | `2048` bytes
+STM32F070 | `1024` bytes    | `2048` bytes
+STM32F072 | `1024` bytes    | `2048` bytes
+STM32F401 | `1024` bytes    | `16384` bytes
+STM32F411 | `1024` bytes    | `16384` bytes
+
+Under normal circumstances configuration of this driver requires intimate knowledge of the MCU's flash structure -- reconfiguration is at your own risk and will require referring to the code.

docs/faq_debug.md

@@ -4,7 +4,7 @@ This page details various common questions people have about troubleshooting the
 
 ## Debugging :id=debugging
 
-Your keyboard will output debug information if you have `CONSOLE_ENABLE = yes` in your `rules.mk`. By default the output is very limited, but you can turn on debug mode to increase the amount of debug output. Use the `DEBUG` keycode in your keymap, use the [Command](feature_command.md) feature to enable debug mode, or add the following code to your keymap.
+Your keyboard will output debug information if you have `CONSOLE_ENABLE = yes` in your `rules.mk`. By default the output is very limited, but you can turn on debug mode to increase the amount of debug output. Use the `DB_TOGG` keycode in your keymap, use the [Command](feature_command.md) feature to enable debug mode, or add the following code to your keymap.
 
 ```c
 void keyboard_post_init_user(void) {
@@ -59,7 +59,7 @@ When porting, or when attempting to diagnose pcb issues, it can be useful to kno
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
   // If console is enabled, it will print the matrix position and status of each key pressed
 #ifdef CONSOLE_ENABLE
-    uprintf("KL: kc: 0x%04X, col: %u, row: %u, pressed: %b, time: %u, interrupt: %b, count: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed, record->event.time, record->tap.interrupted, record->tap.count);
+    uprintf("KL: kc: 0x%04X, col: %2u, row: %2u, pressed: %u, time: %5u, int: %u, count: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed, record->event.time, record->tap.interrupted, record->tap.count);
 #endif 
   return true;
 }
@@ -69,12 +69,12 @@ Example output
 ```
 Waiting for device:.......
 Listening:
-KL: kc: 169, col: 0, row: 0, pressed: 1
-KL: kc: 169, col: 0, row: 0, pressed: 0
-KL: kc: 174, col: 1, row: 0, pressed: 1
-KL: kc: 174, col: 1, row: 0, pressed: 0
-KL: kc: 172, col: 2, row: 0, pressed: 1
-KL: kc: 172, col: 2, row: 0, pressed: 0
+KL: kc: 169, col: 0, row: 0, pressed: 1, time: 15505, int: 0, count: 0
+KL: kc: 169, col: 0, row: 0, pressed: 0, time: 15510, int: 0, count: 0
+KL: kc: 174, col: 1, row: 0, pressed: 1, time: 15703, int: 0, count: 0
+KL: kc: 174, col: 1, row: 0, pressed: 0, time: 15843, int: 0, count: 0
+KL: kc: 172, col: 2, row: 0, pressed: 1, time: 16303, int: 0, count: 0
+KL: kc: 172, col: 2, row: 0, pressed: 0, time: 16411, int: 0, count: 0
 ```
 
 ### How long did it take to scan for a keypress?
@@ -133,3 +133,4 @@ Check:
 - Set `debug_enable=true`. See [Debugging](#debugging)
 - Try using `print` function instead of debug print. See **common/print.h**.
 - Disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
+- Ensure all strings end with a newline character (`\n`). QMK Toolbox prints console output on a per-line basis.

docs/faq_keymap.md

@@ -3,6 +3,7 @@
 This page covers questions people often have about keymaps. If you haven't you should read [Keymap Overview](keymap.md) first.
 
 ## What Keycodes Can I Use?
+
 See [Keycodes](keycodes.md) for an index of keycodes available to you. These link to more extensive documentation when available.
 
 Keycodes are actually defined in [quantum/keycode.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/keycode.h).
@@ -25,25 +26,30 @@ Sometimes, for readability's sake, it's useful to define custom names for some k
 
 This will allow you to use `FN_CAPS` and `ALT_TAB` in your keymap, keeping it more readable.
 
+## My Keymap Doesn't Update When I Flash It
+
+This is usually due to VIA, and has to do with how it deals with keymaps.
+
+On first run, the VIA code in the firmware will copy the keymap from flash memory into EEPROM so that it can be rewritten at runtime by the VIA app. From this point QMK will use the keymap stored in EEPROM instead of flash, and so updates to your `keymap.c` will not be reflected.
+
+The simple fix for this is to clear the EEPROM. You can do this in several ways:
+
+* Hold the Bootmagic Lite key (usually top left/Escape) while plugging the board in, which will also place the board into bootloader mode; then unplug and replug the board.
+* Press the `QK_CLEAR_EEPROM`/`EE_CLR` keycode if it is accessible on your keymap.
+* Place the board into bootloader mode and hit the "Clear EEPROM" button. This may not be available for all bootloaders, and you may need to reflash the board afterwards.
+
 ## Some Of My Keys Are Swapped Or Not Working
 
-QMK has two features, Bootmagic and Command, which allow you to change the behavior of your keyboard on the fly. This includes, but is not limited to, swapping Ctrl/Caps, disabling Gui, swapping Alt/Gui, swapping Backspace/Backslash, disabling all keys, and other behavioral modifications. 
+QMK has a couple of features which allow you to change the behavior of your keyboard on the fly. This includes, but is not limited to, swapping Ctrl/Caps, disabling GUI, swapping Alt/GUI, swapping Backspace/Backslash, disabling all keys, and other behavioral modifications.
 
-As a quick fix try holding down `Space`+`Backspace` while you plug in your keyboard. This will reset the stored settings on your keyboard, returning those keys to normal operation. If that doesn't work look here:
+Refer to the EEPROM clearing methods above, which should return those keys to normal operation. If that doesn't work, look here:
 
-* [Bootmagic Lite](feature_bootmagic.md)
-* [Command](feature_command.md) 
+* [Magic Keycodes](keycodes_magic.md)
+* [Command](feature_command.md)
 
 ## The Menu Key Isn't Working
 
-The key found on most modern keyboards that is located between `KC_RGUI` and `KC_RCTL` is actually called `KC_APP`. This is because when that key was invented there was already a key named `MENU` in the relevant standards, so MS chose to call that the `APP` key.
-
-## `KC_SYSTEM_REQUEST` Isn't Working
-Use keycode for Print Screen (`KC_PRINT_SCREEN`/`KC_PSCR`) instead of `KC_SYSTEM_REQUEST`. Key combination of 'Alt + Print Screen' is recognized as 'System request'.
-
-See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and
-* https://en.wikipedia.org/wiki/Magic_SysRq_key
-* https://en.wikipedia.org/wiki/System_request
+The key found on most modern keyboards that is located between `KC_RGUI` and `KC_RCTL` is actually called `KC_APP`. This is because when the key was invented, there was already a key named "Menu" in the HID specification, so for whatever reason, Microsoft chose to create a new key and call it "Application".
 
 ## Power Keys Aren't Working
 
@@ -52,10 +58,12 @@ Somewhat confusingly, there are two "Power" keycodes in QMK: `KC_KB_POWER` in th
 The former is only recognized on macOS, while the latter, `KC_SLEP` and `KC_WAKE` are supported by all three major operating systems, so it is recommended to use those instead. Under Windows, these keys take effect immediately, however on macOS they must be held down until a dialog appears.
 
 ## One Shot Modifier
+
 Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'.  One Shot Shift mitigates this for me.
 https://github.com/tmk/tmk_keyboard/issues/67
 
 ## Modifier/Layer Stuck
+
 Modifier keys or layers can be stuck unless layer switching is configured properly.
 For Modifier keys and layer actions you have to place `KC_TRNS` on same position of destination layer to  unregister the modifier key or return to previous layer on release event.
 
@@ -63,12 +71,11 @@ For Modifier keys and layer actions you have to place `KC_TRNS` on same position
 * https://geekhack.org/index.php?topic=57008.msg1492604#msg1492604
 * https://github.com/tmk/tmk_keyboard/issues/248
 
-
 ## Mechanical Lock Switch Support
 
 This feature is for *mechanical lock switch* like [this Alps one](https://deskthority.net/wiki/Alps_SKCL_Lock). You can enable it by adding this to your `config.h`:
 
-```
+```c
 #define LOCKING_SUPPORT_ENABLE
 #define LOCKING_RESYNC_ENABLE
 ```
@@ -91,6 +98,7 @@ Even worse, it is not recognized unless the keyboard's VID and PID match that of
 See [this issue](https://github.com/qmk/qmk_firmware/issues/2179) for detailed information.
 
 ## Keys Supported in Mac OSX?
+
 You can know which keycodes are supported in OSX from this source code.
 
 `usb_2_adb_keymap` array maps Keyboard/Keypad Page usages to ADB scancodes(OSX internal keycodes).
@@ -101,8 +109,8 @@ And `IOHIDConsumer::dispatchConsumerEvent` handles Consumer page usages.
 
 https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp
 
-
 ## JIS Keys in Mac OSX
+
 Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)`, `ひらがな(hiragana)` are not recognized on OSX. You can use **Seil** to enable those keys, try following options.
 
 * Enable NFER Key on PC keyboard
@@ -111,8 +119,8 @@ Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)`
 
 https://pqrs.org/osx/karabiner/seil.html
 
-
 ## RN-42 Bluetooth Doesn't Work with Karabiner
+
 Karabiner - Keymapping tool on Mac OSX - ignores inputs from RN-42 module by default. You have to enable this option to make Karabiner working with your keyboard.
 https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237
 
@@ -120,37 +128,24 @@ See these for the detail of this problem.
 https://github.com/tmk/tmk_keyboard/issues/213
 https://github.com/tekezo/Karabiner/issues/403
 
-
 ## Esc and <code>&#96;</code> on a Single Key
 
 See the [Grave Escape](feature_grave_esc.md) feature.
 
 ## Eject on Mac OSX
+
 `KC_EJCT` keycode works on OSX. https://github.com/tmk/tmk_keyboard/issues/250
 It seems Windows 10 ignores the code and Linux/Xorg recognizes but has no mapping by default.
 
-Not sure what keycode Eject is on genuine Apple keyboard actually. HHKB uses `F20` for Eject key(`Fn+f`) on Mac mode but this is not same as Apple Eject keycode probably.
+Not sure what keycode Eject is on genuine Apple keyboard actually. HHKB uses `F20` for Eject key(`Fn+F`) on Mac mode but this is not same as Apple Eject keycode probably.
 
+## What are "Real" and "Weak" modifiers?
 
-## What's `weak_mods` and `real_mods` in `action_util.c`
-___TO BE IMPROVED___
+Real modifiers refer to the state of the real/physical modifier keys, while weak modifiers are the state of "virtual" or temporary modifiers which should not interfere with the internal state of the real modifier keys.
 
-real_mods is intended to retains state of real/physical modifier key state, while
-weak_mods retains state of virtual or temporary modifiers which should not affect state real modifier key.
+The real and weak modifier states are ORed together when the keyboard report is sent, so if you release a weak modifier while the same real modifier is still held, the report does not change:
 
-Let's say you hold down physical left shift key and type ACTION_MODS_KEY(LSHIFT, KC_A),
-
-with weak_mods,
-* (1) hold down left shift: real_mods |= MOD_BIT(LSHIFT)
-* (2) press ACTION_MODS_KEY(LSHIFT, KC_A): weak_mods |= MOD_BIT(LSHIFT)
-* (3) release ACTION_MODS_KEY(LSHIFT, KC_A): weak_mods &= ~MOD_BIT(LSHIFT)
-real_mods still keeps modifier state.
-
-without weak mods,
-* (1) hold down left shift: real_mods |= MOD_BIT(LSHIFT)
-* (2) press ACTION_MODS_KEY(LSHIFT, KC_A): real_mods |= MOD_BIT(LSHIFT)
-* (3) release ACTION_MODS_KEY(LSHIFT, KC_A): real_mods &= ~MOD_BIT(LSHIFT)
-here real_mods lost state for 'physical left shift'.
-
-weak_mods is ORed with real_mods when keyboard report is sent.
-https://github.com/tmk/tmk_core/blob/master/common/action_util.c#L57
+ 1. **Hold down physical Left Shift:** Real mods now contains Left Shift, final state is Left Shift
+ 2. **Add weak Left Shift:** Weak mods now contains Left Shift, final state is Left Shift
+ 3. **Remove weak Left Shift:** Weak mods now contains nothing, final state is Left Shift
+ 4. **Release physical Left Shift:** Real mods now contains nothing, final state is nothing

docs/faq_misc.md

@@ -10,7 +10,7 @@ You probably don't want to "brick" your keyboard, making it impossible
 to rewrite firmware onto it.  Here are some of the parameters to show
 what things are (and likely aren't) too risky.
 
-- If your keyboard map does not include RESET, then, to get into DFU
+- If your keyboard map does not include QK_BOOT, then, to get into DFU
   mode, you will need to press the reset button on the PCB, which
   requires unscrewing the bottom.
 - Messing with tmk_core / common files might make the keyboard

docs/feature_advanced_keycodes.md

@@ -39,7 +39,7 @@ In practice, this means that you can check whether a given modifier is active wi
 
 To check that *only* a specific set of mods is active at a time, AND the modifier state and your desired mod mask as explained above and compare the result to the mod mask itself: `get_mods() & <mod mask> == <mod mask>`.
 
-For example, let's say you want to trigger a piece of custom code if one-shot left control and one-shot left shift are on but every other one-shot mods are off. To do so, you can compose the desired mod mask by combining the mod bits for left control and shift with `(MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))` and then plug it in: `get_oneshot_mods & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT)) == (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))`. Using `MOD_MASK_CS` instead for the mod bitmask would have forced you to press four modifier keys (both versions of control and shift) to fulfill the condition.
+For example, let's say you want to trigger a piece of custom code if one-shot left control and one-shot left shift are on but every other one-shot mods are off. To do so, you can compose the desired mod mask by combining the mod bits for left control and shift with `(MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))` and then plug it in: `get_oneshot_mods() & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT)) == (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))`. Using `MOD_MASK_CS` instead for the mod bitmask would have forced you to press four modifier keys (both versions of control and shift) to fulfill the condition.
 
 The full list of mod masks is as follows:
 
@@ -161,7 +161,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 };
 ```
 
-# Legacy Content :id=legacy-content
+# Advanced topics :id=advanced-topics
 
 This page used to encompass a large set of features. We have moved many sections that used to be part of this page to their own pages. Everything below this point is simply a redirect so that people following old links on the web find what they're looking for.
 

docs/feature_audio.md

@@ -114,7 +114,7 @@ The audio core offers interface functions to get/set/change the tone multiplexin
 There's a couple of different sounds that will automatically be enabled without any other configuration:
 ```
 STARTUP_SONG // plays when the keyboard starts up (audio.c)
-GOODBYE_SONG // plays when you press the RESET key (quantum.c)
+GOODBYE_SONG // plays when you press the QK_BOOT key (quantum.c)
 AG_NORM_SONG // plays when you press AG_NORM (quantum.c)
 AG_SWAP_SONG // plays when you press AG_SWAP (quantum.c)
 CG_NORM_SONG // plays when you press CG_NORM (quantum.c)
@@ -161,9 +161,11 @@ It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif
 
 The available keycodes for audio are: 
 
-* `AU_ON` - Turn Audio Feature on
-* `AU_OFF` - Turn Audio Feature off
-* `AU_TOG` - Toggle Audio Feature state
+|Key                      |Aliases  |Description                                |
+|-------------------------|---------|-------------------------------------------|
+|`QK_AUDIO_ON`            |`AU_ON`  |Turns on Audio Feature                     |
+|`QK_AUDIO_OFF`           |`AU_OFF` |Turns off Audio Feature                    |
+|`QK_AUDIO_TOGGLE`        |`AU_TOGG`|Toggles Audio state                        |
 
 !> These keycodes turn all of the audio functionality on and off.  Turning it off means that audio feedback, audio clicky, music mode, etc. are disabled, completely.
 
@@ -177,7 +179,7 @@ The available keycodes for audio are:
 |`AUDIO_INIT_DELAY`               | *Not defined*        |Enables delay during startup song to accomidate for USB startup issues.        |
 |`AUDIO_ENABLE_TONE_MULTIPLEXING` | *Not defined*        |Enables time splicing/multiplexing to create multiple tones simutaneously.     |
 |`STARTUP_SONG`                   | `STARTUP_SOUND`      |Plays when the keyboard starts up (audio.c)                                    |
-|`GOODBYE_SONG`                   | `GOODBYE_SOUND`      |Plays when you press the RESET key (quantum.c)                                 |
+|`GOODBYE_SONG`                   | `GOODBYE_SOUND`      |Plays when you press the QK_BOOT key (quantum.c)                               |
 |`AG_NORM_SONG`                   | `AG_NORM_SOUND`      |Plays when you press AG_NORM (process_magic.c)                                 |
 |`AG_SWAP_SONG`                   | `AG_SWAP_SOUND`      |Plays when you press AG_SWAP (process_magic.c)                                 |
 |`CG_NORM_SONG`                   | `AG_NORM_SOUND`      |Plays when you press CG_NORM (process_magic.c)                                 |
@@ -219,6 +221,12 @@ Aka "audio effects", different ones can be enabled by setting in `config.h` thes
 `#define AUDIO_VOICES` to enable the feature, and `#define AUDIO_VOICE_DEFAULT something` to select a specific effect
 for details see quantum/audio/voices.h and .c
 
+Keycodes available:
+
+|Key                      |Aliases  |Description                                |
+|-------------------------|---------|-------------------------------------------|
+|`QK_AUDIO_VOICE_NEXT`    |`AU_NEXT`|Cycles through the audio voices            |
+|`QK_AUDIO_VOICE_PREVIOUS`|`AU_PREV`|Cycles through the audio voices in reverse |
 
 ## Music Mode
 
@@ -228,10 +236,14 @@ Recording is experimental due to some memory issues - if you experience some wei
 
 Keycodes available:
 
-* `MU_ON` - Turn music mode on
-* `MU_OFF` - Turn music mode off
-* `MU_TOG` - Toggle music mode
-* `MU_MOD` - Cycle through the music modes:
+|Key                      |Aliases  |Description                                |
+|-------------------------|---------|-------------------------------------------|
+|`QK_MUSIC_ON`            |`MU_ON`  |Turns on Music Mode                        |
+|`QK_MUSIC_OFF`           |`MU_OFF` |Turns off Music Mode                       |
+|`QK_MUSIC_TOGGLE`        |`MU_TOGG`|Toggles Music Mode                         |
+|`QK_MUSIC_MODE_NEXT`     |`MU_NEXT`|Cycles through the music modes             |
+
+Available Modes:
   * `CHROMATIC_MODE` - Chromatic scale, row changes the octave
   * `GUITAR_MODE` - Chromatic scale, but the row changes the string (+5 st)
   * `VIOLIN_MODE` - Chromatic scale, but the row changes the string (+7 st)
@@ -300,13 +312,16 @@ You can look at the [Planck Keyboard](https://github.com/qmk/qmk_firmware/blob/e
 
 This adds a click sound each time you hit a button, to simulate click sounds from the keyboard. And the sounds are slightly different for each keypress, so it doesn't sound like a single long note, if you type rapidly. 
 
-* `CK_TOGG` - Toggles the status (will play sound if enabled)
-* `CK_ON` - Turns on Audio Click (plays sound)
-* `CK_OFF` - Turns off Audio Click (doesn't play sound)
-* `CK_RST` - Resets the frequency to the default state (plays sound at default frequency)
-* `CK_UP` - Increases the frequency of the clicks (plays sound at new frequency)
-* `CK_DOWN` - Decreases the frequency of the clicks (plays sound at new frequency)
+Keycodes available:
 
+|Key                      |Aliases  |Description                                |
+|-------------------------|---------|-------------------------------------------|
+|`QK_AUDIO_CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode                  |
+|`QK_AUDIO_CLICKY_ON`     |`CK_ON`  |Turns on Audio clicky mode                 |
+|`QK_AUDIO_CLICKY_OFF`    |`CK_OFF` |Turns on Audio clicky mode                 |
+|`QK_AUDIO_CLICKY_UP`     |`CK_UP`  |Increases frequency of the clicks          |
+|`QK_AUDIO_CLICKY_DOWN`   |`CK_DOWN`|Decreases frequency of the clicks          |
+|`QK_AUDIO_CLICKY_RESET`  |`CK_RST` |Resets frequency to default                |
 
 The feature is disabled by default, to save space.  To enable it, add this to your `config.h`:
 
@@ -333,16 +348,20 @@ See [MIDI](feature_midi.md)
 
 ## Audio Keycodes
 
-|Key             |Aliases  |Description                       |
-|----------------|---------|----------------------------------|
-|`AU_ON`         |         |Audio mode on                     |
-|`AU_OFF`        |         |Audio mode off                    |
-|`AU_TOG`        |         |Toggles Audio mode                |
-|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode         |
-|`CLICKY_UP`     |`CK_UP`  |Increases frequency of the clicks |
-|`CLICKY_DOWN`   |`CK_DOWN`|Decreases frequency of the clicks |
-|`CLICKY_RESET`  |`CK_RST` |Resets frequency to default       |
-|`MU_ON`         |         |Turns on Music Mode               |
-|`MU_OFF`        |         |Turns off Music Mode              |
-|`MU_TOG`        |         |Toggles Music Mode                |
-|`MU_MOD`        |         |Cycles through the music modes    |
+|Key                      |Aliases  |Description                                |
+|-------------------------|---------|-------------------------------------------|
+|`QK_AUDIO_ON`            |`AU_ON`  |Turns on Audio Feature                     |
+|`QK_AUDIO_OFF`           |`AU_OFF` |Turns off Audio Feature                    |
+|`QK_AUDIO_TOGGLE`        |`AU_TOGG`|Toggles Audio state                        |
+|`QK_AUDIO_CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode                  |
+|`QK_AUDIO_CLICKY_ON`     |`CK_ON`  |Turns on Audio clicky mode                 |
+|`QK_AUDIO_CLICKY_OFF`    |`CK_OFF` |Turns on Audio clicky mode                 |
+|`QK_AUDIO_CLICKY_UP`     |`CK_UP`  |Increases frequency of the clicks          |
+|`QK_AUDIO_CLICKY_DOWN`   |`CK_DOWN`|Decreases frequency of the clicks          |
+|`QK_AUDIO_CLICKY_RESET`  |`CK_RST` |Resets frequency to default                |
+|`QK_MUSIC_ON`            |`MU_ON`  |Turns on Music Mode                        |
+|`QK_MUSIC_OFF`           |`MU_OFF` |Turns off Music Mode                       |
+|`QK_MUSIC_TOGGLE`        |`MU_TOGG`|Toggles Music Mode                         |
+|`QK_MUSIC_MODE_NEXT`     |`MU_NEXT`|Cycles through the music modes             |
+|`QK_AUDIO_VOICE_NEXT`    |`AU_NEXT`|Cycles through the audio voices            |
+|`QK_AUDIO_VOICE_PREVIOUS`|`AU_PREV`|Cycles through the audio voices in reverse |

docs/feature_auto_shift.md

@@ -300,14 +300,14 @@ This will enable you to define three keys temporarily to increase, decrease and
 
 Map three keys temporarily in your keymap:
 
-| Key Name | Description                                         |
-|----------|-----------------------------------------------------|
-| KC_ASDN  | Lower the Auto Shift timeout variable (down)        |
-| KC_ASUP  | Raise the Auto Shift timeout variable (up)          |
-| KC_ASRP  | Report your current Auto Shift timeout value        |
-| KC_ASON  | Turns on the Auto Shift Function                    |
-| KC_ASOFF | Turns off the Auto Shift Function                   |
-| KC_ASTG  | Toggles the state of the Auto Shift feature         |
+|Keycode               |Aliases  |Description                                 |
+|----------------------|---------|--------------------------------------------|
+|`QK_AUTO_SHIFT_DOWN`  |`AS_DOWN`|Lower the Auto Shift timeout variable (down)|
+|`QK_AUTO_SHIFT_UP`    |`AS_UP`  |Raise the Auto Shift timeout variable (up)  |
+|`QK_AUTO_SHIFT_REPORT`|`AS_RPT` |Report your current Auto Shift timeout value|
+|`QK_AUTO_SHIFT_ON`    |`AS_ON`  |Turns on the Auto Shift Function            |
+|`QK_AUTO_SHIFT_OFF`   |`AS_OFF` |Turns off the Auto Shift Function           |
+|`QK_AUTO_SHIFT_TOGGLE`|`AS_TOGG`|Toggles the state of the Auto Shift feature |
 
 Compile and upload your new firmware.
 
@@ -318,18 +318,18 @@ completely normal and with no intention of shifted keys.
 
 1. Type multiple sentences of alphabetical letters.
 2. Observe any upper case letters.
-3. If there are none, press the key you have mapped to `KC_ASDN` to decrease
+3. If there are none, press the key you have mapped to `AS_DOWN` to decrease
    time Auto Shift timeout value and go back to step 1.
 4. If there are some upper case letters, decide if you need to work on tapping
    those keys with less down time, or if you need to increase the timeout.
 5. If you decide to increase the timeout, press the key you have mapped to
-   `KC_ASUP` and go back to step 1.
+   `AS_UP` and go back to step 1.
 6. Once you are happy with your results, press the key you have mapped to
-   `KC_ASRP`. The keyboard will type by itself the value of your
+   `AS_RPT`. The keyboard will type by itself the value of your
    `AUTO_SHIFT_TIMEOUT`.
 7. Update `AUTO_SHIFT_TIMEOUT` in your `config.h` with the value reported.
 8. Add `AUTO_SHIFT_NO_SETUP` to your `config.h`.
-9. Remove the key bindings `KC_ASDN`, `KC_ASUP` and `KC_ASRP`.
+9. Remove the key bindings `AS_DOWN`, `AS_UP` and `AS_RPT`.
 10. Compile and upload your new firmware.
 
 #### An Example Run
@@ -337,17 +337,17 @@ completely normal and with no intention of shifted keys.
     hello world. my name is john doe. i am a computer programmer playing with
     keyboards right now.
 
-    [PRESS KC_ASDN quite a few times]
+    [PRESS AS_DOWN quite a few times]
 
     heLLo woRLd. mY nAMe is JOHn dOE. i AM A compUTeR proGRaMMER PlAYiNG witH
     KEYboArDS RiGHT NOw.
 
-    [PRESS KC_ASUP a few times]
+    [PRESS AS_UP a few times]
 
     hello world. my name is john Doe. i am a computer programmer playing with
     keyboarDs right now.
 
-    [PRESS KC_ASRP]
+    [PRESS AS_RPT]
 
     115
 

docs/feature_autocorrect.md

@@ -0,0 +1,295 @@
+# Autocorrect
+
+There are a lot of words that are prone to being typed incorrectly, due to habit, sequence or just user error.  This feature leverages your firmware to automatically correct these errors, to help reduce typos.
+
+## How does it work? :id=how-does-it-work
+
+The feature maintains a small buffer of recent key presses. On each key press, it checks whether the buffer ends in a recognized typo, and if so, automatically sends keystrokes to correct it.
+
+The tricky part is how to efficiently check the buffer for typos. We don’t want to spend too much memory or time on storing or searching the typos. A good solution is to represent the typos with a trie data structure. A trie is a tree data structure where each node is a letter, and words are formed by following a path to one of the leaves.
+
+![An example trie](https://i.imgur.com/HL5DP8H.png)
+
+Since we search whether the buffer ends in a typo, we store the trie writing in reverse. The trie is queried starting from the last letter, then second to last letter, and so on, until either a letter doesn’t match or we reach a leaf, meaning a typo was found.
+
+## How do I enable Autocorrection :id=how-do-i-enable-autocorrection
+
+In your `rules.mk`, add this:
+
+```make
+AUTOCORRECT_ENABLE = yes
+```
+
+Additionally, you will need a library for autocorrection.  A small sample library is included by default, so that you can get up and running right away, but you can provide a customized library.
+
+By default, autocorrect is disabled.  To enable it, you need to use the `AC_TOGG` keycode to enable it. The status is stored in persistent memory, so you shouldn't need to enabled it again.
+
+## Customizing autocorrect library :id=customizing-autocorrect-library
+
+To provide a custom library, you need to create a text file with the corrections.  For instance:
+
+```text
+:thier        -> their
+fitler        -> filter
+lenght        -> length
+ouput         -> output
+widht         -> width
+```
+
+The syntax is `typo  ->  correction`. Typos and corrections are case insensitive, and any whitespace before or after the typo and correction is ignored. The typo must be only the letters a–z, or the special character : representing a word break. The correction may have any non-unicode characters.
+
+Then, run:
+
+```sh
+qmk generate-autocorrect-data autocorrect_dictionary.txt
+```
+
+This will process the file and produce an `autocorrect_data.h` file with the trie library, in the folder that you are at.  You can specify the keyboard and keymap (eg `-kb planck/rev6 -km jackhumbert`), and it will place the file in that folder instead. But as long as the file is located in your keymap folder, or user folder, it should be picked up automatically.
+
+This file will look like this:
+
+```c
+// :thier        -> their
+// fitler        -> filter
+// lenght        -> length
+// ouput         -> output
+// widht         -> width
+
+#define AUTOCORRECT_MIN_LENGTH 5  // "ouput"
+#define AUTOCORRECT_MAX_LENGTH 6  // ":thier"
+
+#define DICTIONARY_SIZE 74
+
+static const uint8_t autocorrect_data[DICTIONARY_SIZE] PROGMEM = {85, 7, 0, 23, 35, 0, 0, 8, 0, 76, 16, 0, 15, 25, 0, 0,
+    11, 23, 44, 0, 130, 101, 105, 114, 0, 23, 12, 9, 0, 131, 108, 116, 101, 114, 0, 75, 42, 0, 24, 64, 0, 0, 71, 49, 0,
+    10, 56, 0, 0, 12, 26, 0, 129, 116, 104, 0, 17, 8, 15, 0, 129, 116, 104, 0, 19, 24, 18, 0, 130, 116, 112, 117, 116,
+    0};
+```
+
+### Avoiding false triggers :id=avoiding-false-triggers
+
+By default, typos are searched within words, to find typos within longer identifiers like maxFitlerOuput. While this is useful, a consequence is that autocorrection will falsely trigger when a typo happens to be a substring of a correctly-spelled word. For instance, if we had thier -> their as an entry, it would falsely trigger on (correct, though relatively uncommon) words like “wealthier” and “filthier.”
+
+The solution is to set a word break : before and/or after the typo to constrain matching. : matches space, period, comma, underscore, digits, and most other non-alpha characters.
+
+|Text             |thier   |:thier  |thier:  |:thier: |
+|-----------------|:------:|:------:|:------:|:------:|
+|see `thier` typo |matches |matches |matches |matches |
+|it’s `thiers`    |matches |matches |no      |no      |
+|wealthier words  |matches |no      |matches |no      |
+
+:thier: is most restrictive, matching only when thier is a whole word.
+
+The `qmk generate-autocorrect-data` commands can make an effort to check for entries that would false trigger as substrings of correct words. It searches each typo against a dictionary of 25K English words from the english_words Python package, provided it’s installed. (run `python3 -m pip install english_words` to install it.)
+
+?> Unfortunately, this is limited to just english words, at this point.
+
+## Overriding Autocorrect
+
+Occasionally you might actually want to type a typo (for instance, while editing autocorrection_dict.txt) without being autocorrected. There are a couple of ways to do this:
+
+1. Begin typing the typo.
+2. Before typing the last letter, press and release the Ctrl or Alt key.
+3. Type the remaining letters.
+
+This works because the autocorrection implementation doesn’t understand hotkeys, so it resets itself whenever a modifier other than shift is held.
+
+Additionally, you can use the `AC_TOGG` keycode to toggle the on/off status for Autocorrect.
+
+### Keycodes :id=keycodes
+
+|Keycode                |Aliases  |Description                                   |
+|-----------------------|---------|----------------------------------------------|
+|`QK_AUTOCORRECT_ON`    |`AC_ON`  |Turns on the Autocorrect feature.             |
+|`QK_AUTOCORRECT_OFF`   |`AC_OFF` |Turns off the Autocorrect feature.            |
+|`QK_AUTOCORRECT_TOGGLE`|`AC_TOGG`|Toggles the status of the Autocorrect feature.|
+
+## User Callback Functions
+
+### Process Autocorrect
+
+Callback function `bool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods)` is available to customise incoming keycodes and handle exceptions. You can use this function to sanitise input before they are passed onto the autocorrect engine
+
+?> Sanitisation of input is required because autocorrect will only match 8-bit [basic keycodes](keycodes_basic.md) for typos. If valid modifier keys or 16-bit keycodes that are part of a user's word input (such as Shift + A) is passed through, they will fail typo letter detection. For example a [Mod-Tap](mod_tap.md) key such as `LCTL_T(KC_A)` is 16-bit and should be masked for the 8-bit `KC_A`.
+
+The default user callback function is found inside `quantum/process_keycode/process_autocorrect.c`. It covers most use-cases for QMK special functions and quantum keycodes, including [overriding autocorrect](#overriding-autocorrect) with a modifier other than shift. The `process_autocorrect_user` function is `weak` defined to allow user's copy inside `keymap.c` (or code files) to overwrite it.
+
+#### Process Autocorrect Example
+
+If you have a custom keycode `QMKBEST` that should be ignored as part of a word, and another custom keycode `QMKLAYER` that should override autocorrect, both can be added to the bottom of the `process_autocorrect_user` `switch` statement in your source code:
+
+```c
+bool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods) {
+    // See quantum_keycodes.h for reference on these matched ranges.
+    switch (*keycode) {
+        // Exclude these keycodes from processing.
+        case KC_LSFT:
+        case KC_RSFT:
+        case KC_CAPS:
+        case QK_TO ... QK_ONE_SHOT_LAYER_MAX:
+        case QK_LAYER_TAP_TOGGLE ... QK_LAYER_MOD_MAX:
+        case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX:
+            return false;
+
+        // Mask for base keycode from shifted keys.
+        case QK_LSFT ... QK_LSFT + 255:
+        case QK_RSFT ... QK_RSFT + 255:
+            if (*keycode >= QK_LSFT && *keycode <= (QK_LSFT + 255)) {
+                *mods |= MOD_LSFT;
+            } else {
+                *mods |= MOD_RSFT;
+            }
+            *keycode &= 0xFF; // Get the basic keycode.
+            return true;
+#ifndef NO_ACTION_TAPPING
+        // Exclude tap-hold keys when they are held down
+        // and mask for base keycode when they are tapped.
+        case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
+#    ifdef NO_ACTION_LAYER
+            // Exclude Layer Tap, if layers are disabled
+            // but action tapping is still enabled.
+            return false;
+#    endif
+        case QK_MOD_TAP ... QK_MOD_TAP_MAX:
+            // Exclude hold if mods other than Shift is not active
+            if (!record->tap.count) {
+                return false;
+            }
+            *keycode &= 0xFF;
+            break;
+#else
+        case QK_MOD_TAP ... QK_MOD_TAP_MAX:
+        case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
+            // Exclude if disabled
+            return false;
+#endif
+        // Exclude swap hands keys when they are held down
+        // and mask for base keycode when they are tapped.
+        case QK_SWAP_HANDS ... QK_SWAP_HANDS_MAX:
+#ifdef SWAP_HANDS_ENABLE
+            if (*keycode >= 0x56F0 || !record->tap.count) {
+                return false;
+            }
+            *keycode &= 0xFF;
+            break;
+#else
+            // Exclude if disabled
+            return false;
+#endif
+        // Handle custom keycodes
+        case QMKBEST:
+            return false;
+        case QMKLAYER:
+            *typo_buffer_size = 0;
+            return false;
+    }
+
+    // Disable autocorrect while a mod other than shift is active.
+    if ((*mods & ~MOD_MASK_SHIFT) != 0) {
+        *typo_buffer_size = 0;
+        return false;
+    }
+
+    return true;
+}
+```
+
+?> In this callback function, `return false` will skip processing of that keycode for autocorrect. Adding `*typo_buffer_size = 0` will also reset the autocorrect buffer at the same time, cancelling any current letters already stored in the buffer.
+
+### Apply Autocorrect
+
+Additionally, `apply_autocorrect(uint8_t backspaces, const char *str)` allows for users to add additional handling to the autocorrection, or replace the functionality entirely. This passes on the number of backspaces needed to replace the words, as well as the replacement string (partial word, not the full word).
+
+#### Apply Autocorrect Example
+
+This following example will play a sound when a typo is autocorrected and execute the autocorrection itself:
+
+```c
+#ifdef AUDIO_ENABLE
+float autocorrect_song[][2] = SONG(TERMINAL_SOUND);
+#endif
+
+bool apply_autocorrect(uint8_t backspaces, const char *str) {
+#ifdef AUDIO_ENABLE
+    PLAY_SONG(autocorrect_song);
+#endif
+    for (uint8_t i = 0; i < backspaces; ++i) {
+        tap_code(KC_BSPC);
+    }
+    send_string_P(str);
+    return false;
+}
+```
+
+?> In this callback function, `return false` will stop the normal processing of autocorrect, which requires manually handling of removing the "bad" characters and typing the new characters.
+
+!> ***IMPORTANT***: `str` is a pointer to `PROGMEM` data for the autocorrection.  If you return false, and want to send the string, this needs to use `send_string_P` and not `send_string` or `SEND_STRING`.
+
+You can also use `apply_autocorrect` to detect and display the event but allow internal code to execute the autocorrection with `return true`:
+
+```c
+bool apply_autocorrect(uint8_t backspaces, const char *str) {
+#ifdef OLED_ENABLE
+    oled_write_P(PSTR("Auto-corrected"), false);
+#endif
+    return true;
+}
+```
+
+## Appendix: Trie binary data format :id=appendix
+
+This section details how the trie is serialized to byte data in autocorrection_data. You don’t need to care about this to use this autocorrection implementation. But it is documented for the record in case anyone is interested in modifying the implementation, or just curious how it works.
+
+What I did here is fairly arbitrary, but it is simple to decode and gets the job done.
+
+### Encoding :id=encoding
+
+All autocorrection data is stored in a single flat array autocorrection_data. Each trie node is associated with a byte offset into this array, where data for that node is encoded, beginning with root at offset 0. There are three kinds of nodes. The highest two bits of the first byte of the node indicate what kind:
+
+* 00 ⇒ chain node: a trie node with a single child.
+* 01 ⇒ branching node: a trie node with multiple children.
+* 10 ⇒ leaf node: a leaf, corresponding to a typo and storing its correction.
+
+![An example trie](https://i.imgur.com/HL5DP8H.png)
+
+**Branching node**. Each branch is encoded with one byte for the keycode (KC_A–KC_Z) followed by a link to the child node. Links between nodes are 16-bit byte offsets relative to the beginning of the array, serialized in little endian order.
+
+All branches are serialized this way, one after another, and terminated with a zero byte. As described above, the node is identified as a branch by setting the two high bits of the first byte to 01, done by bitwise ORing the first keycode with 64. keycode. The root node for the above figure would be serialized like:
+
+```
++-------+-------+-------+-------+-------+-------+-------+
+| R|64  |    node 2     |   T   |    node 3     |   0   |
++-------+-------+-------+-------+-------+-------+-------+
+```
+
+**Chain node**. Tries tend to have long chains of single-child nodes, as seen in the example above with f-i-t-l in fitler. So to save space, we use a different format to encode chains than branching nodes. A chain is encoded as a string of keycodes, beginning with the node closest to the root, and terminated with a zero byte. The child of the last node in the chain is encoded immediately after. That child could be either a branching node or a leaf.
+
+In the figure above, the f-i-t-l chain is encoded as
+
+```
++-------+-------+-------+-------+-------+
+|   L   |   T   |   I   |   F   |   0   |
++-------+-------+-------+-------+-------+
+```
+
+If we were to encode this chain using the same format used for branching nodes, we would encode a 16-bit node link with every node, costing 8 more bytes in this example. Across the whole trie, this adds up. Conveniently, we can point to intermediate points in the chain and interpret the bytes in the same way as before. E.g. starting at the i instead of the l, and the subchain has the same format.
+
+**Leaf node**. A leaf node corresponds to a particular typo and stores data to correct the typo. The leaf begins with a byte for the number of backspaces to type, and is followed by a null-terminated ASCII string of the replacement text. The idea is, after tapping backspace the indicated number of times, we can simply pass this string to the `send_string_P` function. For fitler, we need to tap backspace 3 times (not 4, because we catch the typo as the final ‘r’ is pressed) and replace it with lter. To identify the node as a leaf, the two high bits are set to 10 by ORing the backspace count with 128:
+
+```
++-------+-------+-------+-------+-------+-------+
+| 3|128 |  'l'  |  't'  |  'e'  |  'r'  |   0   |
++-------+-------+-------+-------+-------+-------+
+```
+
+### Decoding :id=decoding
+
+This format is by design decodable with fairly simple logic. A 16-bit variable state represents our current position in the trie, initialized with 0 to start at the root node. Then, for each keycode, test the highest two bits in the byte at state to identify the kind of node.
+
+* 00 ⇒ **chain node**: If the node’s byte matches the keycode, increment state by one to go to the next byte. If the next byte is zero, increment again to go to the following node.
+* 01 ⇒ **branching node**: Search the branches for one that matches the keycode, and follow its node link.
+* 10 ⇒ **leaf node**: a typo has been found! We read its first byte for the number of backspaces to type, then pass its following bytes to send_string_P to type the correction.
+
+## Credits
+
+Credit goes to [getreuer](https://github.com/getreuer) for originally implementing this [here](https://getreuer.info/posts/keyboards/autocorrection/#how-does-it-work).  As well as to [filterpaper](https://github.com/filterpaper) for converting the code to use PROGMEM, and additional improvements.