arm_atsam: temporarily lower raw HID endpoint/report size (#11554)

Custom layout for macropad. It shows the usage of macros with unicode,
and other layouts (ISO-DE) with unicode, emojis, and git commands.

.github/workflows/auto_tag.yaml

@@ -0,0 +1,33 @@
+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/develop_api.yml

@@ -0,0 +1,42 @@
+name: Update Develop API Data
+
+on:
+  push:
+    branches:
+    - develop
+    paths:
+    - 'keyboards/**'
+    - 'layouts/community/**'
+
+jobs:
+  api_data:
+    runs-on: ubuntu-latest
+    container: qmkfm/base_container
+
+    # 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: Install rsync
+      run: |
+        apt-get update && apt-get install -y rsync
+
+    - name: Upload API Data
+      uses: JamesIves/github-pages-deploy-action@3.7.1
+      with:
+        ACCESS_TOKEN: ${{ secrets.API_TOKEN_GITHUB }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        BRANCH: main
+        FOLDER: api_data/v1
+        CLEAN: true
+        GIT_CONFIG_EMAIL: hello@qmk.fm
+        REPOSITORY_NAME: qmk/qmk_keyboards_devel
+        TARGET_FOLDER: v1

.github/workflows/develop_update.yml

@@ -0,0 +1,37 @@
+name: Update develop after master merge
+
+on:
+  push:
+    branches:
+    - master
+
+
+jobs:
+  develop_update:
+    runs-on: ubuntu-latest
+
+    if: github.repository == 'qmk/qmk_firmware'
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - 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"
+        git merge origin/master
+        git push origin develop

.github/workflows/format.yaml

@@ -0,0 +1,37 @@
+name: Format Codebase
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    container: qmkfm/base_container
+
+    # protect against those who develop with their fork on master
+    if: github.repository == 'qmk/qmk_firmware'
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        token: ${{ secrets.API_TOKEN_GITHUB }}
+
+    - name: Install dependencies
+      run: |
+        apt-get update && apt-get install -y dos2unix
+
+    - name: Format files
+      run: |
+        bin/qmk cformat -a
+        bin/qmk pyformat
+        bin/qmk fileformat
+
+    - name: Commit files
+      uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: Format code according to conventions for $GITHUB_SHA
+        commit_user_name: QMK Bot
+        commit_user_email: hello@qmk.fm
+        commit_author: QMK Bot <hello@qmk.fm>

.travis.yml

@@ -19,7 +19,6 @@ addons:
       - llvm-toolchain-trusty-7
     packages:
     - diffutils
-    - dos2unix
     - clang-format-7
     - libstdc++-7-dev
 script:

Makefile

@@ -68,71 +68,15 @@ PATH_ELEMENTS := $(subst /, ,$(STARTING_DIR))
 # Initialize the path elements list for further processing
 $(eval $(call NEXT_PATH_ELEMENT))
 
-# This function sets the KEYBOARD; KEYMAP and SUBPROJECT to the correct
-# variables depending on which directory you stand in.
-# It's really a very simple if else chain, if you squint enough,
-# but the makefile syntax makes it very verbose.
-# If we are in a subfolder of keyboards
-#
-# *** No longer needed **
-#
-# ifeq ($(CURRENT_PATH_ELEMENT),keyboards)
-#     $(eval $(call NEXT_PATH_ELEMENT))
-#     KEYBOARD := $(CURRENT_PATH_ELEMENT)
-#     $(eval $(call NEXT_PATH_ELEMENT))
-#     # If we are in a subfolder of keymaps, or in other words in a keymap
-#     # folder
-#     ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
-#         $(eval $(call NEXT_PATH_ELEMENT))
-#         KEYMAP := $(CURRENT_PATH_ELEMENT)
-#      # else if we are not in the keyboard folder itself
-#     else ifneq ($(CURRENT_PATH_ELEMENT),)
-#         # the we can assume it's a subproject, as no other folders
-#         # should have make files in them
-#         SUBPROJECT := $(CURRENT_PATH_ELEMENT)
-#         $(eval $(call NEXT_PATH_ELEMENT))
-#         # if we are inside a keymap folder of a subproject
-#         ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
-#             $(eval $(call NEXT_PATH_ELEMENT))
-#             KEYMAP := $(CURRENT_PATH_ELEMENT)
-#         endif
-#     endif
-# endif
-
-define GET_KEYBOARDS
-ifndef ALT_GET_KEYBOARDS
-    All_RULES_MK := $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/rules.mk))
-    All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/rules.mk))
-    All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/rules.mk))
-    All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/*/rules.mk))
-
-    KEYMAPS_MK := $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/keymaps/*/rules.mk))
-    KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/keymaps/*/rules.mk))
-    KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/keymaps/*/rules.mk))
-    KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/*/keymaps/*/rules.mk))
-
-    KEYBOARDS := $$(sort $$(filter-out $$(KEYMAPS_MK), $$(All_RULES_MK)))
-else
-    KEYBOARDS := $(shell find keyboards/ -type f -iname "rules.mk" | grep -v keymaps | sed 's!keyboards/\(.*\)/rules.mk!\1!' | sort | uniq)
-endif
-endef
-
-$(eval $(call GET_KEYBOARDS))
-
-# Only consider folders with makefiles, to prevent errors in case there are extra folders
-#KEYBOARDS += $(patsubst $(ROOD_DIR)/keyboards/%/rules.mk,%,$(wildcard $(ROOT_DIR)/keyboards/*/*/rules.mk))
 
+# Phony targets to enable a few simple make commands outside the main processing below.
 .PHONY: list-keyboards
 list-keyboards:
-	echo $(KEYBOARDS)
-
-define PRINT_KEYBOARD
-	$(info $(PRINTING_KEYBOARD))
-endef
+	util/list_keyboards.sh | sort -u | tr '\n' ' '
 
 .PHONY: generate-keyboards-file
 generate-keyboards-file:
-	$(foreach PRINTING_KEYBOARD,$(KEYBOARDS),$(eval $(call PRINT_KEYBOARD)))
+	util/list_keyboards.sh | sort -u
 
 .PHONY: clean
 clean:
@@ -158,8 +102,6 @@ endif
 # Uncomment these for debugging
 # $(info Keyboard: $(KEYBOARD))
 # $(info Keymap: $(KEYMAP))
-# $(info Subproject: $(SUBPROJECT))
-# $(info Keyboards: $(KEYBOARDS))
 
 
 # Set the default goal depending on where we are running make from
@@ -217,7 +159,6 @@ endef
 # A recursive helper function for finding the longest match
 # $1 The list to be checked
 # It works by always removing the currently matched item from the list
-# and call itself recursively, until a match is found
 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
     # Stop the recursion when the list is empty
     ifneq ($1,)
@@ -272,16 +213,29 @@ endef
 define PARSE_RULE
     RULE := $1
     COMMANDS :=
+    REQUIRE_PLATFORM_KEY :=
     # If the rule starts with all, then continue the parsing from
     # PARSE_ALL_KEYBOARDS
     ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
         KEYBOARD_RULE=all
         $$(eval $$(call PARSE_ALL_KEYBOARDS))
+    else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-avr),true)
+        KEYBOARD_RULE=all
+        REQUIRE_PLATFORM_KEY := avr
+        $$(eval $$(call PARSE_ALL_KEYBOARDS))
+    else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-chibios),true)
+        KEYBOARD_RULE=all
+        REQUIRE_PLATFORM_KEY := chibios
+        $$(eval $$(call PARSE_ALL_KEYBOARDS))
+    else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-arm_atsam),true)
+        KEYBOARD_RULE=all
+        REQUIRE_PLATFORM_KEY := arm_atsam
+        $$(eval $$(call PARSE_ALL_KEYBOARDS))
     else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,test),true)
         $$(eval $$(call PARSE_TEST))
     # If the rule starts with the name of a known keyboard, then continue
     # the parsing from PARSE_KEYBOARD
-    else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYBOARDS)),true)
+    else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(shell util/list_keyboards.sh | sort -u)),true)
         KEYBOARD_RULE=$$(MATCHED_ITEM)
         $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
     # Otherwise use the KEYBOARD variable, which is determined either by
@@ -398,26 +352,9 @@ 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,$(KEYBOARDS)))
+    $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell util/list_keyboards.sh noci | sort -u)))
 endef
 
-# $1 Subproject
-# When entering this, the keyboard and subproject are known, so now we need
-# to determine which keymaps are going to get compiled
-# define PARSE_SUBPROJECT
-
-# endef
-
-# If we want to parse all subprojects, but the keyboard doesn't have any,
-# then use defaultsp instead
-# define PARSE_ALL_SUBPROJECTS
-#     ifeq ($$(SUBPROJECTS),)
-#         $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
-#     else
-#         $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$$(SUBPROJECTS)))
-#     endif
-# endef
-
 # Prints a list of all known keymaps for the given keyboard
 define LIST_ALL_KEYMAPS
     COMMAND_true_LIST_KEYMAPS := \
@@ -447,7 +384,7 @@ define PARSE_KEYMAP
     # Format it in bold
     KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
     # Specify the variables that we are passing forward to submake
-    MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM)
+    MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM) REQUIRE_PLATFORM_KEY=$$(REQUIRE_PLATFORM_KEY)
     # And the first part of the make command
     MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
     # The message to display
@@ -466,6 +403,8 @@ define BUILD
         LOG=$$$$($$(MAKE_CMD) $$(MAKE_VARS) SILENT=true 2>&1) ; \
         if [ $$$$? -gt 0 ]; \
             then $$(PRINT_ERROR_PLAIN); \
+        elif [ "$$$$LOG" = "skipped" ] ; \
+            then $$(PRINT_SKIPPED_PLAIN); \
         elif [ "$$$$LOG" != "" ] ; \
             then $$(PRINT_WARNING_PLAIN); \
         else \
@@ -557,12 +496,12 @@ if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
 
 endef
 
-# Let's match everything, we handle all the rule parsing ourselves
+# Catch everything and parse the command line ourselves.
 .PHONY: %
 %:
 	# Check if we have the CMP tool installed
 	cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
-	# Ensure that bin/qmk works. This will be a failing check after the next develop merge on 2020 Aug 29.
+	# Ensure that bin/qmk works. This will be a failing check after the next develop merge
 	if ! bin/qmk hello 1> /dev/null 2>&1; then printf "$(MSG_PYTHON_MISSING)"; fi
 	# Check if the submodules are dirty, and display a warning if they are
 ifndef SKIP_GIT
@@ -593,25 +532,6 @@ endif
 	$(foreach TEST,$(sort $(TESTS)),$(RUN_TEST))
 	if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
 
-# These no longer work because of the colon system
-
-# All should compile everything
-# .PHONY: all
-# all: all-keyboards test-all
-
-# Define some shortcuts, mostly for compatibility with the old syntax
-# .PHONY: all-keyboards
-# all-keyboards: all\:all\:all
-
-# .PHONY: all-keyboards-defaults
-# all-keyboards-defaults: all\:default
-
-# .PHONY: test
-# test: test-all
-
-# .PHONY: test-clean
-# test-clean: test-all-clean
-
 lib/%:
 	git submodule sync $?
 	git submodule update --init $?
@@ -637,12 +557,13 @@ else
 endif
 ifndef SKIP_VERSION
 BUILD_DATE := $(shell date +"%Y-%m-%d-%H:%M:%S")
+else
+BUILD_DATE := 2020-01-01-00:00:00
+endif
+
 $(shell echo '#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR)/quantum/version.h)
 $(shell echo '#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR)/quantum/version.h)
 $(shell echo '#define CHIBIOS_VERSION "$(CHIBIOS_VERSION)"' >> $(ROOT_DIR)/quantum/version.h)
 $(shell echo '#define CHIBIOS_CONTRIB_VERSION "$(CHIBIOS_CONTRIB_VERSION)"' >> $(ROOT_DIR)/quantum/version.h)
-else
-BUILD_DATE := NA
-endif
 
 include $(ROOT_DIR)/testlist.mk

build_full_test.mk

@@ -30,4 +30,4 @@ $(TEST)_SRC += $(patsubst $(ROOTDIR)/%,%,$(wildcard $(TEST_PATH)/*.cpp))
 
 $(TEST)_DEFS=$(TMK_COMMON_DEFS) $(OPT_DEFS)
 $(TEST)_CONFIG=$(TEST_PATH)/config.h
-VPATH+=$(TOP_DIR)/tests/test_common
+VPATH+=$(TOP_DIR)/tests/test_common

build_keyboard.mk

@@ -317,6 +317,13 @@ SRC += $(TMK_COMMON_SRC)
 OPT_DEFS += $(TMK_COMMON_DEFS)
 EXTRALDFLAGS += $(TMK_COMMON_LDFLAGS)
 
+SKIP_COMPILE := no
+ifneq ($(REQUIRE_PLATFORM_KEY),)
+    ifneq ($(REQUIRE_PLATFORM_KEY),$(PLATFORM_KEY))
+        SKIP_COMPILE := yes
+    endif
+endif
+
 include $(TMK_PATH)/$(PLATFORM_KEY).mk
 ifneq ($(strip $(PROTOCOL)),)
     include $(TMK_PATH)/protocol/$(strip $(shell echo $(PROTOCOL) | tr '[:upper:]' '[:lower:]')).mk
@@ -352,9 +359,16 @@ $(KEYBOARD_OUTPUT)_INC := $(PROJECT_INC) $(GFXINC)
 $(KEYBOARD_OUTPUT)_CONFIG := $(PROJECT_CONFIG)
 
 # Default target.
+ifeq ($(SKIP_COMPILE),no)
 all: build check-size
+else
+all:
+	echo "skipped" >&2
+endif
+
 build: elf cpfirmware
 check-size: build
+check-md5: build
 objs-size: build
 
 include show_options.mk

build_test.mk

@@ -17,7 +17,7 @@ OUTPUTS := $(TEST_OBJ)/$(TEST) $(GTEST_OUTPUT)
 GTEST_INC := \
 	$(LIB_PATH)/googletest/googletest/include\
 	$(LIB_PATH)/googletest/googlemock/include\
-	
+
 GTEST_INTERNAL_INC :=\
 	$(LIB_PATH)/googletest/googletest\
 	$(LIB_PATH)/googletest/googlemock
@@ -27,7 +27,7 @@ $(GTEST_OUTPUT)_SRC :=\
 	googletest/src/gtest_main.cc\
 	googlemock/src/gmock-all.cc
 
-$(GTEST_OUTPUT)_DEFS := 
+$(GTEST_OUTPUT)_DEFS :=
 $(GTEST_OUTPUT)_INC := $(GTEST_INC) $(GTEST_INTERNAL_INC)
 
 LDFLAGS += -lstdc++ -lpthread -shared-libgcc
@@ -49,6 +49,7 @@ endif
 
 include common_features.mk
 include $(TMK_PATH)/common.mk
+include $(QUANTUM_PATH)/sequencer/tests/rules.mk
 include $(QUANTUM_PATH)/serial_link/tests/rules.mk
 ifneq ($(filter $(FULL_TESTS),$(TEST)),)
 include build_full_test.mk
@@ -65,4 +66,3 @@ include $(TMK_PATH)/rules.mk
 
 $(shell mkdir -p $(BUILD_DIR)/test 2>/dev/null)
 $(shell mkdir -p $(TEST_OBJ) 2>/dev/null)
-

common.mk

@@ -21,4 +21,5 @@ COMMON_VPATH += $(QUANTUM_PATH)/keymap_extras
 COMMON_VPATH += $(QUANTUM_PATH)/audio
 COMMON_VPATH += $(QUANTUM_PATH)/process_keycode
 COMMON_VPATH += $(QUANTUM_PATH)/api
+COMMON_VPATH += $(QUANTUM_PATH)/sequencer
 COMMON_VPATH += $(DRIVER_PATH)

common_features.mk

@@ -21,6 +21,11 @@ QUANTUM_SRC += \
     $(QUANTUM_DIR)/keymap_common.c \
     $(QUANTUM_DIR)/keycode_config.c
 
+ifeq ($(strip $(DEBUG_MATRIX_SCAN_RATE_ENABLE)), yes)
+    OPT_DEFS += -DDEBUG_MATRIX_SCAN_RATE
+    CONSOLE_ENABLE = yes
+endif
+
 ifeq ($(strip $(API_SYSEX_ENABLE)), yes)
     OPT_DEFS += -DAPI_SYSEX_ENABLE
     OPT_DEFS += -DAPI_ENABLE
@@ -39,6 +44,13 @@ ifeq ($(strip $(AUDIO_ENABLE)), yes)
     SRC += $(QUANTUM_DIR)/audio/luts.c
 endif
 
+ifeq ($(strip $(SEQUENCER_ENABLE)), yes)
+    OPT_DEFS += -DSEQUENCER_ENABLE
+    MUSIC_ENABLE = yes
+    SRC += $(QUANTUM_DIR)/sequencer/sequencer.c
+    SRC += $(QUANTUM_DIR)/process_keycode/process_sequencer.c
+endif
+
 ifeq ($(strip $(MIDI_ENABLE)), yes)
     OPT_DEFS += -DMIDI_ENABLE
     MUSIC_ENABLE = yes
@@ -156,12 +168,14 @@ ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
     endif
 endif
 
-VALID_MATRIX_TYPES := yes IS31FL3731 IS31FL3733 IS31FL3737 IS31FL3741 WS2812 custom
 
 LED_MATRIX_ENABLE ?= no
-ifneq ($(strip $(LED_MATRIX_ENABLE)), no)
-    ifeq ($(filter $(LED_MATRIX_ENABLE),$(VALID_MATRIX_TYPES)),)
-        $(error LED_MATRIX_ENABLE="$(LED_MATRIX_ENABLE)" is not a valid matrix type)
+VALID_LED_MATRIX_TYPES := IS31FL3731 custom
+# TODO: IS31FL3733 IS31FL3737 IS31FL3741
+
+ifeq ($(strip $(LED_MATRIX_ENABLE)), yes)
+    ifeq ($(filter $(LED_MATRIX_DRIVER),$(VALID_LED_MATRIX_TYPES)),)
+        $(error LED_MATRIX_DRIVER="$(LED_MATRIX_DRIVER)" is not a valid matrix type)
     else
         BACKLIGHT_ENABLE = yes
         BACKLIGHT_DRIVER = custom
@@ -169,21 +183,22 @@ ifneq ($(strip $(LED_MATRIX_ENABLE)), no)
         SRC += $(QUANTUM_DIR)/led_matrix.c
         SRC += $(QUANTUM_DIR)/led_matrix_drivers.c
     endif
-endif
 
-ifeq ($(strip $(LED_MATRIX_ENABLE)), IS31FL3731)
-    OPT_DEFS += -DIS31FL3731
-    COMMON_VPATH += $(DRIVER_PATH)/issi
-    SRC += is31fl3731-simple.c
-    QUANTUM_LIB_SRC += i2c_master.c
+    ifeq ($(strip $(LED_MATRIX_DRIVER)), IS31FL3731)
+        OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
+        COMMON_VPATH += $(DRIVER_PATH)/issi
+        SRC += is31fl3731-simple.c
+        QUANTUM_LIB_SRC += i2c_master.c
+    endif
 endif
 
 RGB_MATRIX_ENABLE ?= no
+VALID_RGB_MATRIX_TYPES := IS31FL3731 IS31FL3733 IS31FL3737 IS31FL3741 WS2812 custom
 
-ifneq ($(strip $(RGB_MATRIX_ENABLE)), no)
-ifeq ($(filter $(RGB_MATRIX_ENABLE),$(VALID_MATRIX_TYPES)),)
-    $(error RGB_MATRIX_ENABLE="$(RGB_MATRIX_ENABLE)" is not a valid matrix type)
-endif
+ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
+    ifeq ($(filter $(RGB_MATRIX_DRIVER),$(VALID_RGB_MATRIX_TYPES)),)
+        $(error "$(RGB_MATRIX_DRIVER)" is not a valid matrix type)
+    endif
     OPT_DEFS += -DRGB_MATRIX_ENABLE
 ifneq (,$(filter $(MCU), atmega16u2 atmega32u2))
     # ATmegaxxU2 does not have hardware MUL instruction - lib8tion must be told to use software multiplication routines
@@ -194,51 +209,47 @@ endif
     SRC += $(QUANTUM_DIR)/rgb_matrix_drivers.c
     CIE1931_CURVE := yes
     RGB_KEYCODES_ENABLE := yes
-endif
 
-ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
-	RGB_MATRIX_ENABLE := IS31FL3731
-endif
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3731)
+        OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
+        COMMON_VPATH += $(DRIVER_PATH)/issi
+        SRC += is31fl3731.c
+        QUANTUM_LIB_SRC += i2c_master.c
+    endif
 
-ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3731)
-    OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-    COMMON_VPATH += $(DRIVER_PATH)/issi
-    SRC += is31fl3731.c
-    QUANTUM_LIB_SRC += i2c_master.c
-endif
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3733)
+        OPT_DEFS += -DIS31FL3733 -DSTM32_I2C -DHAL_USE_I2C=TRUE
+        COMMON_VPATH += $(DRIVER_PATH)/issi
+        SRC += is31fl3733.c
+        QUANTUM_LIB_SRC += i2c_master.c
+    endif
 
-ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3733)
-    OPT_DEFS += -DIS31FL3733 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-    COMMON_VPATH += $(DRIVER_PATH)/issi
-    SRC += is31fl3733.c
-    QUANTUM_LIB_SRC += i2c_master.c
-endif
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3737)
+        OPT_DEFS += -DIS31FL3737 -DSTM32_I2C -DHAL_USE_I2C=TRUE
+        COMMON_VPATH += $(DRIVER_PATH)/issi
+        SRC += is31fl3737.c
+        QUANTUM_LIB_SRC += i2c_master.c
+    endif
 
-ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3737)
-    OPT_DEFS += -DIS31FL3737 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-    COMMON_VPATH += $(DRIVER_PATH)/issi
-    SRC += is31fl3737.c
-    QUANTUM_LIB_SRC += i2c_master.c
-endif
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3741)
+        OPT_DEFS += -DIS31FL3741 -DSTM32_I2C -DHAL_USE_I2C=TRUE
+        COMMON_VPATH += $(DRIVER_PATH)/issi
+        SRC += is31fl3741.c
+        QUANTUM_LIB_SRC += i2c_master.c
+    endif
 
-ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3741)
-    OPT_DEFS += -DIS31FL3741 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-    COMMON_VPATH += $(DRIVER_PATH)/issi
-    SRC += is31fl3741.c
-    QUANTUM_LIB_SRC += i2c_master.c
-endif
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), WS2812)
+        OPT_DEFS += -DWS2812
+        WS2812_DRIVER_REQUIRED := yes
+    endif
 
-ifeq ($(strip $(RGB_MATRIX_ENABLE)), WS2812)
-    OPT_DEFS += -DWS2812
-    WS2812_DRIVER_REQUIRED := yes
-endif
+    ifeq ($(strip $(RGB_MATRIX_CUSTOM_KB)), yes)
+        OPT_DEFS += -DRGB_MATRIX_CUSTOM_KB
+    endif
 
-ifeq ($(strip $(RGB_MATRIX_CUSTOM_KB)), yes)
-    OPT_DEFS += -DRGB_MATRIX_CUSTOM_KB
-endif
-
-ifeq ($(strip $(RGB_MATRIX_CUSTOM_USER)), yes)
-    OPT_DEFS += -DRGB_MATRIX_CUSTOM_USER
+    ifeq ($(strip $(RGB_MATRIX_CUSTOM_USER)), yes)
+        OPT_DEFS += -DRGB_MATRIX_CUSTOM_USER
+    endif
 endif
 
 ifeq ($(strip $(RGB_KEYCODES_ENABLE)), yes)
@@ -444,11 +455,14 @@ ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
         # Functions added via QUANTUM_LIB_SRC are only included in the final binary if they're called.
         # Unused functions are pruned away, which is why we can add multiple drivers here without bloat.
         ifeq ($(PLATFORM),AVR)
-            QUANTUM_LIB_SRC += i2c_master.c \
-                               i2c_slave.c
+            ifneq ($(NO_I2C),yes)
+                QUANTUM_LIB_SRC += i2c_master.c \
+                                   i2c_slave.c
+            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

docs/ChangeLog/20190830.md

@@ -50,4 +50,3 @@ This document marks the inaugural Breaking Change merge. A list of changes follo
 * `KC_DELT` was a redundant, undocumented alias for `KC_DELETE`
 * It has been removed and all its uses replaced with the more common `KC_DEL` alias
 * Around 90 keymaps (mostly for ErgoDox boards) have been modified as a result
-

docs/ChangeLog/20201128.md

@@ -0,0 +1,150 @@
+# QMK Breaking Change - 2020 Nov 28 Changelog
+
+Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps.
+
+
+## Changes Requiring User Action :id=changes-requiring-user-action
+
+### Relocated Keyboards :id-relocated-keyboards
+
+#### Reduce Helix keyboard build variation ([#8669](https://github.com/qmk/qmk_firmware/pull/8669))
+
+The build commands for the Helix keyboard are:
+
+```
+make <helix_build_name>:<keymap_name>
+```
+
+For `<helix_build_name>`, specify the one in the rightmost column of the table below, such as `helix`,` helix/pico`.
+
+| before Oct 17 2019   |  Oct 17 2019            | Mar 10 2020             | Nov 28 2020             |
+| ---------------------|-------------------------|-------------------------| ------------------------|
+| helix/rev1           | helix/rev1              | helix/rev1              | helix/rev1              |
+| helix/pico           | helix/pico              | helix/pico              | helix/pico              |
+|                      | helix/pico/back         | helix/pico/back         | helix/pico/back         |
+|                      | helix/pico/under        | helix/pico/under        | helix/pico/under        |
+|                      |                         | helix/pico/sc           | --                      |
+|                      |                         | helix/pico/sc/back      | helix/pico/sc           |
+|                      |                         | helix/pico/sc/under     | --                      |
+| helix/rev2 (=helix)  | helix/rev2 (=helix)     | helix/rev2 (=helix)     | --                      |
+|                      | helix/rev2/back         | helix/rev2/back         | --                      |
+|                      | helix/rev2/back/oled    | helix/rev2/back/oled    | ( --> helix/rev2/back)  |
+|                      | helix/rev2/oled         | helix/rev2/oled         | helix/rev2　(=helix)     |
+|                      | helix/rev2/oled/back    | helix/rev2/oled/back    | helix/rev2/back         |
+|                      | helix/rev2/oled/under   | helix/rev2/oled/under   | helix/rev2/under        |
+|                      |                         | helix/rev2/sc           | --                      |
+|                      |                         | helix/rev2/sc/back      | --                      |
+|                      |                         | helix/rev2/sc/oled      | --                      |
+|                      |                         | helix/rev2/sc/oledback  | helix/rev2/sc           |
+|                      |                         | helix/rev2/sc/oledunder | --                      |
+|                      |                         | helix/rev2/sc/under     | --                      |
+|                      | helix/rev2/under        | helix/rev2/under        | --                      |
+|                      | helix/rev2/under/oled   | helix/rev2/under/oled   | ( --> helix/rev2/under) |
+
+#### Update the Speedo firmware for v3.0 ([#10657](https://github.com/qmk/qmk_firmware/pull/10657))
+
+The Speedo keyboard has moved to `cozykeys/speedo/v2` as the designer prepares to release the Speedo v3.0.
+
+| Previous Name | New Name                   |
+| :------------ | :------------------------- |
+| speedo        | cozykeys/speedo/v2         |
+| --            | cozykeys/speedo/v3 **new** |
+
+#### Maartenwut/Maarten name change to evyd13/Evy ([#10274](https://github.com/qmk/qmk_firmware/pull/10274))
+
+Maartenwut has rebranded as @evyd13, and all released Maartenwut boards have moved.
+
+| Previous Name          | New Name           |
+| :--------------------- | :----------------- |
+| maartenwut/atom47/rev2 | evyd13/atom47/rev2 |
+| maartenwut/atom47/rev3 | evyd13/atom47/rev3 |
+| maartenwut/eon40       | evyd13/eon40       |
+| maartenwut/eon65       | evyd13/eon65       |
+| maartenwut/eon75       | evyd13/eon75       |
+| maartenwut/eon87       | evyd13/eon87       |
+| maartenwut/eon95       | evyd13/eon95       |
+| maartenwut/gh80_1800   | evyd13/gh80_1800   |
+| maartenwut/gh80_3700   | evyd13/gh80_3700   |
+| maartenwut/minitomic   | evyd13/minitomic   |
+| maartenwut/mx5160      | evyd13/mx5160      |
+| maartenwut/nt660       | evyd13/nt660       |
+| maartenwut/omrontkl    | evyd13/omrontkl    |
+| maartenwut/plain60     | evyd13/plain60     |
+| maartenwut/pockettype  | evyd13/pockettype  |
+| maartenwut/quackfire   | evyd13/quackfire   |
+| maartenwut/solheim68   | evyd13/solheim68   |
+| maartenwut/ta65        | evyd13/ta65        |
+| maartenwut/wasdat      | evyd13/wasdat      |
+| maartenwut/wasdat_code | evyd13/wasdat_code |
+| maartenwut/wonderland  | evyd13/wonderland  |
+
+#### Xelus Valor and Dawn60 Refactors ([#10512](https://github.com/qmk/qmk_firmware/pull/10512), [#10584](https://github.com/qmk/qmk_firmware/pull/10584))
+
+The Valor and Dawn60 keyboards by Xelus22 both now require their revisions to be specified when compiling.
+
+| Previous Name | New Name          |
+| :------------ | :---------------- |
+| xelus/dawn60  | xelus/dawn60/rev1 |
+| xelus/valor   | xelus/valor/rev1  |
+
+
+### Updated Keyboard Codebases :id=keyboard-updates
+
+#### AEboards EXT65 Refactor ([#10820](https://github.com/qmk/qmk_firmware/pull/10820))
+
+The EXT65 codebase has been reworked so keymaps can be used with either revision.
+
+
+## Core Changes :id=core-changes
+
+### Fixes :id=core-fixes
+
+* Reconnect the USB if users wake up a computer from the keyboard to restore the USB state ([#10088](https://github.com/qmk/qmk_firmware/pull/10088))
+* Fix cursor position bug in oled_write_raw functions ([#10800](https://github.com/qmk/qmk_firmware/pull/10800))
+
+### Additions and Enhancements :id=core-additions
+
+* Allow MATRIX_ROWS to be greater than 32 ([#10183](https://github.com/qmk/qmk_firmware/pull/10183))
+* Add support for soft serial to ATmega32U2 ([#10204](https://github.com/qmk/qmk_firmware/pull/10204))
+* Allow direct control of MIDI velocity value ([#9940](https://github.com/qmk/qmk_firmware/pull/9940))
+* Joystick 16-bit support ([#10439](https://github.com/qmk/qmk_firmware/pull/10439))
+* Allow encoder resolutions to be set per encoder ([#10259](https://github.com/qmk/qmk_firmware/pull/10259))
+* Share button state from mousekey to pointing_device ([#10179](https://github.com/qmk/qmk_firmware/pull/10179))
+* Add advanced/efficient RGB Matrix Indicators ([#8564](https://github.com/qmk/qmk_firmware/pull/8564))
+* OLED display update interval support ([#10388](https://github.com/qmk/qmk_firmware/pull/10388))
+* Per-Key Retro Tapping ([#10622](https://github.com/qmk/qmk_firmware/pull/10622))
+* Allow backlight duty cycle limit ([#10260](https://github.com/qmk/qmk_firmware/pull/10260))
+* Add step sequencer feature ([#9703](https://github.com/qmk/qmk_firmware/pull/9703))
+* Added `add_oneshot_mods` & `del_oneshot_mods` ([#10549](https://github.com/qmk/qmk_firmware/pull/10549))
+* Add AT90USB support for serial.c ([#10706](https://github.com/qmk/qmk_firmware/pull/10706))
+* Auto shift: support repeats and early registration (#9826)
+
+### Clean-ups and Optimizations :id=core-optimizations
+
+* Haptic and solenoid cleanup ([#9700](https://github.com/qmk/qmk_firmware/pull/9700))
+* XD75 cleanup ([#10524](https://github.com/qmk/qmk_firmware/pull/10524))
+* Minor change to behavior allowing display updates to continue between task ticks ([#10750](https://github.com/qmk/qmk_firmware/pull/10750))
+* Change some GPIO manipulations in matrix.c to be atomic ([#10491](https://github.com/qmk/qmk_firmware/pull/10491))
+* combine repeated lines of code for ATmega32U2, ATmega16U2, ATmega328 and ATmega328P ([#10837](https://github.com/qmk/qmk_firmware/pull/10837))
+* Remove references to HD44780 ([#10735](https://github.com/qmk/qmk_firmware/pull/10735))
+
+
+## QMK Infrastructure and Internals :id=qmk-internals
+
+* Add ability to build a subset of all keyboards based on platform. ([#10420](https://github.com/qmk/qmk_firmware/pull/10420))
+* Initialise EEPROM drivers at startup, instead of upon first execution ([#10438](https://github.com/qmk/qmk_firmware/pull/10438))
+* Make bootloader_jump weak for ChibiOS ([#10417](https://github.com/qmk/qmk_firmware/pull/10417))
+* Support for STM32 GPIOF,G,H,I,J,K ([#10206](https://github.com/qmk/qmk_firmware/pull/10206))
+* Add milc as a dependency and remove the installed milc ([#10563](https://github.com/qmk/qmk_firmware/pull/10563))
+* ChibiOS upgrade: early init conversions ([#10214](https://github.com/qmk/qmk_firmware/pull/10214))
+* ChibiOS upgrade: configuration file migrator ([#9952](https://github.com/qmk/qmk_firmware/pull/9952))
+* Add definition based on currently-selected serial driver. ([#10716](https://github.com/qmk/qmk_firmware/pull/10716))
+* Allow for modification of output RGB values when using rgblight/rgb_matrix. ([#10638](https://github.com/qmk/qmk_firmware/pull/10638))
+* Allow keyboards/keymaps to execute code at each main loop iteration ([#10530](https://github.com/qmk/qmk_firmware/pull/10530))
+* qmk cformat ([#10767](https://github.com/qmk/qmk_firmware/pull/10767))
+* Add a Make variable to easily enable DEBUG_MATRIX_SCAN_RATE on the command line ([#10824](https://github.com/qmk/qmk_firmware/pull/10824))
+* update Chibios OS USB for the OTG driver ([#8893](https://github.com/qmk/qmk_firmware/pull/8893))
+* Fixup version.h writing when using `SKIP_VERSION=yes` ([#10972](https://github.com/qmk/qmk_firmware/pull/10972), [#10974](https://github.com/qmk/qmk_firmware/pull/10974))
+* Rename ledmatrix.h to match .c file ([#7949](https://github.com/qmk/qmk_firmware/pull/7949))
+* Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER ([#10231](https://github.com/qmk/qmk_firmware/pull/10231))
+* Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER ([#10840](https://github.com/qmk/qmk_firmware/pull/10840))

docs/README.md

@@ -24,7 +24,7 @@ Totally new to QMK? There are two ways to get started:
 
 ## Make It Yours
 
-QMK has lots of [features](features.md) to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md).
+QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md).
 
 ## Need help?
 

docs/_summary.md

@@ -80,6 +80,7 @@
     * [One Shot Keys](one_shot_keys.md)
     * [Pointing Device](feature_pointing_device.md)
     * [Raw HID](feature_rawhid.md)
+    * [Sequencer](feature_sequencer.md)
     * [Swap Hands](feature_swap_hands.md)
     * [Tap Dance](feature_tap_dance.md)
     * [Tap-Hold Configuration](tap_hold.md)
@@ -119,6 +120,7 @@
     * [Overview](breaking_changes.md)
     * [My Pull Request Was Flagged](breaking_changes_instructions.md)
     * History
+      * [2020 Nov 28](ChangeLog/20201128.md)
       * [2020 Aug 29](ChangeLog/20200829.md)
       * [2020 May 30](ChangeLog/20200530.md)
       * [2020 Feb 29](ChangeLog/20200229.md)

docs/breaking_changes.md

@@ -6,6 +6,7 @@ The breaking change period is when we will merge PR's that change QMK in dangero
 
 ## What has been included in past Breaking Changes?
 
+* [2020 Nov 28](ChangeLog/20201128.md)
 * [2020 Aug 29](ChangeLog/20200829.md)
 * [2020 May 30](ChangeLog/20200530.md)
 * [2020 Feb 29](ChangeLog/20200229.md)
@@ -13,16 +14,16 @@ 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 November 28, 2020.
+The next Breaking Change is scheduled for February 27, 2021.
 
 ### Important Dates
 
-* [x] 2020 Aug 29 - `develop` is created. It will be rebased weekly.
-* [ ] 2020 Oct 31 - `develop` closed to new PR's.
-* [ ] 2020 Oct 31 - Call for testers.
-* [ ] 2020 Nov 26 - `master` is locked, no PR's merged.
-* [ ] 2020 Nov 28 - Merge `develop` to `master`.
-* [ ] 2020 Nov 28 - `master` is unlocked. PR's can be merged again.
+* [x] 2020 Nov 28 - `develop` is created. Each push to `master` is subsequently merged to `develop`
+* [ ] 2021 Jan 30 - `develop` closed to new PR's.
+* [ ] 2021 Jan 30 - Call for testers.
+* [ ] 2021 Feb 25 - `master` is locked, no PR's merged.
+* [ ] 2021 Feb 27 - Merge `develop` to `master`.
+* [ ] 2021 Feb 27 - `master` is unlocked. PR's can be merged again.
 
 ## What changes will be included?
 
@@ -39,21 +40,6 @@ Criteria for acceptance:
 
 This section documents various processes we use when running the Breaking Changes process.
 
-## Rebase `develop` from `master`
-
-This is run every Friday while `develop` is open.
-
-Process:
-
-```
-cd qmk_firmware
-git checkout master
-git pull --ff-only
-git checkout develop
-git rebase master
-git push --force
-```
-
 ## Creating the `develop` branch
 
 This happens immediately after the previous `develop` branch is merged.

docs/cli_commands.md

@@ -175,7 +175,7 @@ Creates a keymap.json from a keymap.c.
 **Usage**:
 
 ```
-qmk c2json [--no-cpp] [-o OUTPUT] filename
+qmk c2json -km KEYMAP -kb KEYBOARD [-q] [--no-cpp] [-o OUTPUT] filename
 ```
 
 ## `qmk lint`
@@ -296,6 +296,16 @@ This command allows you to generate QMK documentation locally. It can be uses fo
 qmk generate-docs
 ```
 
+## `qmk generate-rgb-breathe-table`
+
+This command generates a lookup table (LUT) header file for the [RGB Lighting](feature_rgblight.md) feature's breathing animation. Place this file in your keyboard or keymap directory as `rgblight_breathe_table.h` to override the default LUT in `quantum/`.
+
+**Usage**:
+
+```
+qmk generate-rgb-breathe-table [-q] [-o OUTPUT] [-m MAX] [-c CENTER]
+```
+
 ## `qmk kle2json`
 
 This command allows you to convert from raw KLE data to QMK Configurator JSON. It accepts either an absolute file path, or a file name in the current directory. By default it will not overwrite `info.json` if it is already present. Use the `-f` or `--force` flag to overwrite.

docs/config_options.md

@@ -29,7 +29,9 @@ This level contains all of the options for that particular keymap. If you wish t
 
 This is a C header file that is one of the first things included, and will persist over the whole project (if included). Lots of variables can be set here and accessed elsewhere. The `config.h` file shouldn't be including other `config.h` files, or anything besides this:
 
-    #include "config_common.h"
+```c
+#include "config_common.h"
+```
 
 
 ## Hardware Options
@@ -135,6 +137,8 @@ If you define these options you will enable the associated feature, which may in
 * `#define RETRO_TAPPING`
   * tap anyway, even after TAPPING_TERM, if there was no other key interruption between press and release
   * See [Retro Tapping](tap_hold.md#retro-tapping) for details
+* `#define RETRO_TAPPING_PER_KEY`
+  * enables handling for per key `RETRO_TAPPING` settings
 * `#define TAPPING_TOGGLE 2`
   * how many taps before triggering the toggle
 * `#define PERMISSIVE_HOLD`

docs/custom_quantum_functions.md

@@ -185,6 +185,14 @@ This function gets called at every matrix scan, which is basically as often as t
 
 You should use this function if you need custom matrix scanning code. It can also be used for custom status output (such as LEDs or a display) or other functionality that you want to trigger regularly even when the user isn't typing.
 
+# Keyboard housekeeping
+
+* Keyboard/Revision: `void housekeeping_task_kb(void)`
+* Keymap: `void housekeeping_task_user(void)`
+
+This function gets called at the end of all QMK processing, before starting the next iteration. You can safely assume that QMK has dealt with the last matrix scan at the time that these functions are invoked -- layer states have been updated, USB reports have been sent, LEDs have been updated, and displays have been drawn.
+
+Similar to `matrix_scan_*`, these are called as often as the MCU can handle. To keep your board responsive, it's suggested to do as little as possible during these function calls, potentially throtting their behaviour if you do indeed require implementing something special.
 
 # Keyboard Idling/Wake Code
 

docs/de/newbs_testing_debugging.md

@@ -41,7 +41,9 @@ Bevorzugst Du es lieber auf der Befehlszeile zu debuggen? Dafür eignet sich das
 
 Manchmal ist es hilfreich Debug-Nachrichten innerhalb deines eigenen [Custom Codes](de/custom_quantum_functions.md) zu drucken. Das ist ziemlich einfach. Beginne damit `print.h` am Anfang deiner Datei zu inkludieren:
 
-    #include <print.h>
+```c
+#include "print.h"
+```
 
 Danach stehen dir verschiedene Druck-Funktionen zur Verfügung:
 

docs/driver_installation_zadig.md

@@ -14,16 +14,11 @@ Some keyboards may have specific instructions for entering the bootloader. For e
 To put a device in bootloader mode with USBaspLoader, tap the `RESET` button while holding down the `BOOT` button.
 Alternatively, hold `BOOT` while inserting the USB cable.
 
-Zadig will automatically detect the bootloader device. You may sometimes need to check **Options → List All Devices**.
-
- - For keyboards with Atmel AVR MCUs, the bootloader will be named something similar to `ATm32U4DFU`, and have a Vendor ID of `03EB`.
- - USBasp bootloaders will appear as `USBasp`, with a VID/PID of `16C0:05DC`.
- - AVR keyboards flashed with the QMK-DFU bootloader will be named `<keyboard name> Bootloader` and will also have the VID `03EB`.
- - For most ARM keyboards, it will be called `STM32 BOOTLOADER`, and have a VID/PID of `0483:DF11`.
+Zadig should automatically detect the bootloader device, but you may sometimes need to check **Options → List All Devices** and select the device from the dropdown instead.
 
 !> If Zadig lists one or more devices with the `HidUsb` driver, your keyboard is probably not in bootloader mode. The arrow will be colored orange and you will be asked to confirm modifying a system driver. **Do not** proceed if this is the case!
 
-If the arrow appears green, select the driver, and click **Install Driver**. The `libusb-win32` driver will usually work for AVR, and `WinUSB` for ARM, but if you still cannot flash the board, try installing a different driver from the list. USBAspLoader devices must use the `libusbK` driver.
+If the arrow appears green, select the driver, and click **Install Driver**. See the [list of known bootloaders](#list-of-known-bootloaders) for the correct driver to install.
 
 ![Zadig with a bootloader driver correctly installed](https://i.imgur.com/b8VgXzx.png)
 
@@ -43,6 +38,40 @@ Right-click it and hit **Uninstall device**. Make sure to tick **Delete the driv
 
 ![The Device Uninstall dialog, with the "delete driver" checkbox ticked](https://i.imgur.com/aEs2RuA.png)
 
-Click **Action → Scan for hardware changes**. At this point, you should be able to type again. Double check in Zadig that the keyboard device(s) are using the `HidUsb` driver. If so, you're all done, and your board should be functional again!
+Click **Action → Scan for hardware changes**. At this point, you should be able to type again. Double check in Zadig that the keyboard device(s) are using the `HidUsb` driver. If so, you're all done, and your board should be functional again! Otherwise, repeat the process until Zadig reports the correct driver.
 
 ?> A full reboot of your computer may sometimes be necessary at this point, to get Windows to pick up the new driver.
+
+## List of Known Bootloaders
+
+This is a list of known bootloader devices and their USB vendor and product IDs, as well as the correct driver to assign for flashing with QMK. Note that the usbser and HidUsb drivers are built in to Windows, and cannot be assigned with Zadig - if your device has an incorrect driver, you must use the Device Manager to uninstall it as described in the previous section.
+
+The device name here is the name that appears in Zadig, and may not be what the Device Manager or QMK Toolbox displays.
+
+|Bootloader   |Device Name                   |VID/PID       |Driver |
+|-------------|------------------------------|--------------|-------|
+|`atmel-dfu`  |ATmega16u2 DFU                |`03EB:2FEF`   |libusb0|
+|`atmel-dfu`  |ATmega32U2 DFU                |`03EB:2FF0`   |libusb0|
+|`atmel-dfu`  |ATm16U4 DFU V1.0.2            |`03EB:2FF3`   |libusb0|
+|`atmel-dfu`  |ATm32U4DFU                    |`03EB:2FF4`   |libusb0|
+|`atmel-dfu`  |*none* (AT90USB64)            |`03EB:2FF9`   |libusb0|
+|`atmel-dfu`  |AT90USB128 DFU                |`03EB:2FFB`   |libusb0|
+|`qmk-dfu`    |(keyboard name) Bootloader    |As `atmel-dfu`|libusb0|
+|`halfkay`    |*none*                        |`16C0:0478`   |HidUsb |
+|`caterina`   |Pro Micro 3.3V                |`1B4F:9203`   |usbser |
+|`caterina`   |Pro Micro 5V                  |`1B4F:9205`   |usbser |
+|`caterina`   |LilyPadUSB                    |`1B4F:9207`   |usbser |
+|`caterina`   |Pololu A-Star 32U4 Bootloader |`1FFB:0101`   |usbser |
+|`caterina`   |Arduino Leonardo              |`2341:0036`   |usbser |
+|`caterina`   |Arduino Micro                 |`2341:0037`   |usbser |
+|`caterina`   |Adafruit Feather 32u4         |`239A:000C`   |usbser |
+|`caterina`   |Adafruit ItsyBitsy 32u4 3V    |`239A:000D`   |usbser |
+|`caterina`   |Adafruit ItsyBitsy 32u4 5V    |`239A:000E`   |usbser |
+|`caterina`   |Arduino Leonardo              |`2A03:0036`   |usbser |
+|`caterina`   |Arduino Micro                 |`2A03:0037`   |usbser |
+|`bootloadHID`|HIDBoot                       |`16C0:05DF`   |HidUsb |
+|`USBasp`     |USBasp                        |`16C0:05DC`   |libusbK|
+|`apm32-dfu`  |APM32 DFU ISP Mode            |`314B:0106`   |WinUSB |
+|`stm32-dfu`  |STM32 BOOTLOADER              |`0483:DF11`   |WinUSB |
+|`kiibohd`    |Kiibohd DFU Bootloader        |`1C11:B007`   |WinUSB |
+|`stm32duino` |Maple 003                     |`1EAF:0003`   |WinUSB |

docs/eeprom_driver.md

@@ -40,6 +40,7 @@ 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>
 24LC256 EEPROM   | `#define EEPROM_I2C_24LC256`    | <https://www.sparkfun.com/products/525>
 MB85RC256V FRAM  | `#define EEPROM_I2C_MB85RC256V` | <https://www.adafruit.com/product/1895>

docs/es/hardware_drivers.md

@@ -33,4 +33,3 @@ Soporte para hasta 2 controladores. Cada controlador implementa 2 matrices charl
 ## IS31FL3733
 
 Soporte para hasta un solo controlador con espacio para expansión. Cada controlador puede controlar 192 LEDs individuales o 64 LEDs RGB. Para obtener más información sobre cómo configurar el controlador, consulta la página de [Matriz RGB](feature_rgb_matrix.md).
-

docs/es/newbs_testing_debugging.md

@@ -41,7 +41,9 @@ Para plataformas compatibles, [QMK Toolbox](https://github.com/qmk/qmk_toolbox)
 
 A veces, es útil imprimir mensajes de depuración desde tu [código personalizado](custom_quantum_functions.md). Hacerlo es bastante simple. Comienza incluyendo `print.h` al principio de tu fichero:
 
-    #include <print.h>
+```c
+#include "print.h"
+```
 
 Después de eso puedes utilzar algunas funciones print diferentes:
 

docs/feature_auto_shift.md

@@ -15,25 +15,31 @@ problem.
 When you tap a key, it stays depressed for a short period of time before it is
 then released. This depressed time is a different length for everyone. Auto Shift
 defines a constant `AUTO_SHIFT_TIMEOUT` which is typically set to twice your
-normal pressed state time. When you press a key, a timer starts and then stops
-when you release the key. If the time depressed is greater than or equal to the
-`AUTO_SHIFT_TIMEOUT`, then a shifted version of the key is emitted. If the time
-is less than the `AUTO_SHIFT_TIMEOUT` time, then the normal state is emitted.
+normal pressed state time. When you press a key, a timer starts, and if you
+have not released the key after the `AUTO_SHIFT_TIMEOUT` period, then a shifted
+version of the key is emitted. If the time is less than the `AUTO_SHIFT_TIMEOUT`
+time, or you press another key, then the normal state is emitted.
+
+If `AUTO_SHIFT_REPEAT` is defined, there is keyrepeat support. Holding the key
+down will repeat the shifted key, though this can be disabled with
+`AUTO_SHIFT_NO_AUTO_REPEAT`. If you want to repeat the normal key, then tap it
+once then immediately (within `TAPPING_TERM`) hold it down again (this works
+with the shifted value as well if auto-repeat is disabled).
 
 ## Are There Limitations to Auto Shift?
 
 Yes, unfortunately.
 
-1. Key repeat will cease to work. For example, before if you wanted 20 'a'
-   characters, you could press and hold the 'a' key for a second or two. This no
-   longer works with Auto Shift because it is timing your depressed time instead
-   of emitting a depressed key state to your operating system.
-2. You will have characters that are shifted when you did not intend on shifting, and
-   other characters you wanted shifted, but were not. This simply comes down to
-   practice. As we get in a hurry, we think we have hit the key long enough
-   for a shifted version, but we did not. On the other hand, we may think we are
-   tapping the keys, but really we have held it for a little longer than
-   anticipated.
+You will have characters that are shifted when you did not intend on shifting, and
+other characters you wanted shifted, but were not. This simply comes down to
+practice. As we get in a hurry, we think we have hit the key long enough for a
+shifted version, but we did not. On the other hand, we may think we are tapping
+the keys, but really we have held it for a little longer than anticipated.
+
+Additionally, with keyrepeat the desired shift state can get mixed up. It will
+always 'belong' to the last key pressed. For example, keyrepeating a capital
+and then tapping something lowercase (whether or not it's an Auto Shift key)
+will result in the capital's *key* still being held, but shift not.
 
 ## How Do I Enable Auto Shift?
 
@@ -103,6 +109,14 @@ Do not Auto Shift numeric keys, zero through nine.
 
 Do not Auto Shift alpha characters, which include A through Z.
 
+### AUTO_SHIFT_REPEAT (simple define)
+
+Enables keyrepeat.
+
+### AUTO_SHIFT_NO_AUTO_REPEAT (simple define)
+
+Disables automatically keyrepeating when `AUTO_SHIFT_TIMEOUT` is exceeded.
+
 ## Using Auto Shift Setup
 
 This will enable you to define three keys temporarily to increase, decrease and report your `AUTO_SHIFT_TIMEOUT`.

docs/feature_backlight.md

@@ -62,14 +62,15 @@ Valid driver values are `pwm`, `software`, `custom` or `no`. See below for help
 
 To configure the backlighting, `#define` these in your `config.h`:
 
-|Define               |Default      |Description                                                                          |
-|---------------------|-------------|-------------------------------------------------------------------------------------|
-|`BACKLIGHT_PIN`      |*Not defined*|The pin that controls the LED(s)                                                     |
-|`BACKLIGHT_LEVELS`   |`3`          |The number of brightness levels (maximum 31 excluding off)                           |
-|`BACKLIGHT_CAPS_LOCK`|*Not defined*|Enable Caps Lock indicator using backlight (for keyboards without dedicated LED)     |
-|`BACKLIGHT_BREATHING`|*Not defined*|Enable backlight breathing, if supported                                             |
-|`BREATHING_PERIOD`   |`6`          |The length of one backlight "breath" in seconds                                      |
-|`BACKLIGHT_ON_STATE` |`1`          |The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low|
+| Define                 | Default       | Description                                                                                                       |
+|------------------------|---------------|-------------------------------------------------------------------------------------------------------------------|
+| `BACKLIGHT_PIN`        | *Not defined* | The pin that controls the LED(s)                                                                                  |
+| `BACKLIGHT_LEVELS`     | `3`           | The number of brightness levels (maximum 31 excluding off)                                                        |
+| `BACKLIGHT_CAPS_LOCK`  | *Not defined* | Enable Caps Lock indicator using backlight (for keyboards without dedicated LED)                                  |
+| `BACKLIGHT_BREATHING`  | *Not defined* | Enable backlight breathing, if supported                                                                          |
+| `BREATHING_PERIOD`     | `6`           | The length of one backlight "breath" in seconds                                                                   |
+| `BACKLIGHT_ON_STATE`   | `1`           | The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low                             |
+| `BACKLIGHT_LIMIT_VAL ` | `255`         | The maximum duty cycle of the backlight -- `255` allows for full brightness, any lower will decrease the maximum. |
 
 Unless you are designing your own keyboard, you generally should not need to change the `BACKLIGHT_PIN` or `BACKLIGHT_ON_STATE`.
 

docs/feature_debounce_type.md

@@ -148,4 +148,3 @@ The following old names for existing algorithms will continue to be supported, h
 * eager_pk - old name for sym_eager_pk
 * sym_pk - old name for sym_defer_pk
 * eager_pr - old name for sym_eager_pr
-

docs/feature_encoders.md

@@ -32,13 +32,20 @@ Additionally, the resolution, which defines how many pulses the encoder register
 #define ENCODER_RESOLUTION 4
 ```
 
+It can also be defined per-encoder, by instead defining:
+
+```c
+#define ENCODER_RESOLUTIONS { 4, 2 }
+```
+
 ## Split Keyboards
 
-If you are using different pinouts for the encoders on each half of a split keyboard, you can define the pinout for the right half like this:
+If you are using different pinouts for the encoders on each half of a split keyboard, you can define the pinout (and optionally, resolutions) for the right half like this:
 
 ```c
 #define ENCODERS_PAD_A_RIGHT { encoder1a, encoder2a }
 #define ENCODERS_PAD_B_RIGHT { encoder1b, encoder2b }
+#define ENCODER_RESOLUTIONS_RIGHT { 2, 4 }
 ```
 
 ## Callbacks

docs/feature_haptic_feedback.md

@@ -42,14 +42,21 @@ First you will need a build a circuit to drive the solenoid through a mosfet as
 [Wiring diagram provided by Adafruit](https://playground.arduino.cc/uploads/Learning/solenoid_driver.pdf)
 
 
-| Settings                 | Default       | Description                                           |
-|--------------------------|---------------|-------------------------------------------------------|
-|`SOLENOID_PIN`            | *Not defined* |Configures the pin that the Solenoid is connected to.  |
-|`SOLENOID_DEFAULT_DWELL`  | `12` ms       |Configures the default dwell time for the solenoid.    |
-|`SOLENOID_MIN_DWELL`      | `4` ms        |Sets the lower limit for the dwell.                    |
-|`SOLENOID_MAX_DWELL`      | `100` ms      |Sets the upper limit for the dwell.                    |
+| Settings                   | Default              | Description                                           |
+|----------------------------|----------------------|-------------------------------------------------------|
+|`SOLENOID_PIN`              | *Not defined*        |Configures the pin that the Solenoid is connected to.  |
+|`SOLENOID_DEFAULT_DWELL`    | `12` ms              |Configures the default dwell time for the solenoid.    |
+|`SOLENOID_MIN_DWELL`        | `4` ms               |Sets the lower limit for the dwell.                    |
+|`SOLENOID_MAX_DWELL`        | `100` ms             |Sets the upper limit for the dwell.                    |
+|`SOLENOID_DWELL_STEP_SIZE`  | `1` ms               |The step size to use when `HPT_DWL*` keycodes are sent |
+|`SOLENOID_DEFAULT_BUZZ`     | `0` (disabled)       |On HPT_RST buzz is set "on" if this is "1"             |
+|`SOLENOID_BUZZ_ACTUATED`    | `SOLENOID_MIN_DWELL` |Actuated-time when the solenoid is in buzz mode        |
+|`SOLENOID_BUZZ_NONACTUATED` | `SOLENOID_MIN_DWELL` |Non-Actuated-time when the solenoid is in buzz mode    |
 
-?> Dwell time is how long the "plunger" stays activated.  The dwell time changes how the solenoid sounds.
+* If solenoid buzz is off, then dwell time is how long the "plunger" stays activated. The dwell time changes how the solenoid sounds.
+* If solenoid buzz is on, then dwell time sets the length of the buzz, while `SOLENOID_BUZZ_ACTUATED` and `SOLENOID_BUZZ_NONACTUATED` set the (non-)actuation times withing the buzz period.
+* With the current implementation, for any of the above time settings, the precision of these settings may be affected by how fast the keyboard is able to scan the matrix.
+  Therefore, if the keyboards scanning routine is slow, it may be preferable to set `SOLENOID_DWELL_STEP_SIZE` to a value slightly smaller than the time it takes to scan the keyboard.
 
 Beware that some pins may be powered during bootloader (ie. A13 on the STM32F303 chip) and will result in the solenoid kept in the on state through the whole flashing process. This may overheat and damage the solenoid. If you find that the pin the solenoid is connected to is triggering the solenoid during bootloader/DFU, select another pin.
 

docs/feature_joystick.md

@@ -141,6 +141,12 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 }
 ```
 
+### Axis Resolution
+
+By default, the resolution of each axis is 8 bit, giving a range of -127 to +127. If you need higher precision, you can increase it by defining eg. `JOYSTICK_AXES_RESOLUTION 12` in your `config.h`. The resolution must be between 8 and 16.
+
+Note that the supported AVR MCUs have a 10-bit ADC, and 12-bit for most STM32 MCUs.
+
 ### Triggering Joystick Buttons
 
 Joystick buttons are normal Quantum keycodes, defined as `JS_BUTTON0` to `JS_BUTTON31`, depending on the number of buttons you have configured.

docs/feature_led_matrix.md

@@ -10,7 +10,8 @@ If you want to use RGB LED's you should use the [RGB Matrix Subsystem](feature_r
 
 There is basic support for addressable LED matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
 
-    LED_MATRIX_ENABLE = IS31FL3731
+    LED_MATRIX_ENABLE = yes
+    LED_MATRIX_DRIVER = IS31FL3731
     
 You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N>` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
 

docs/feature_macros.md

@@ -182,7 +182,9 @@ Which would send Left Control+`a` (Left Control down, `a`, Left Control up) - no
 
 By default, it assumes a US keymap with a QWERTY layout; if you want to change that (e.g. if your OS uses software Colemak), include this somewhere in your keymap:
 
-    #include <sendstring_colemak.h>
+```c
+#include "sendstring_colemak.h"
+```
 
 ### Strings in Memory
 
@@ -207,7 +209,7 @@ SEND_STRING(".."SS_TAP(X_END));
 
 There are some functions you may find useful in macro-writing. Keep in mind that while you can write some fairly advanced code within a macro, if your functionality gets too complex you may want to define a custom keycode instead. Macros are meant to be simple.
 
-?> You can also use the functions described in [Useful function](ref_functions.md) for additional functionality. For example `reset_keyboard()` allows you to reset the keyboard as part of a macro.
+?> You can also use the functions described in [Useful functions](ref_functions.md) for additional functionality. For example `reset_keyboard()` allows you to reset the keyboard as part of a macro.
 
 ### `record->event.pressed`
 

docs/feature_mouse_keys.md

@@ -140,3 +140,7 @@ To use constant speed mode, you must at least define `MK_COMBINED` in your keyma
 ```c
 #define MK_COMBINED
 ```
+
+## Use with PS/2 Mouse and Pointing Device
+
+Mouse keys button state is shared with [PS/2 mouse](feature_ps2_mouse.md) and [pointing device](feature_pointing_device.md) so mouse keys button presses can be used for clicks and drags.

docs/feature_oled_driver.md

@@ -150,6 +150,7 @@ void oled_task_user(void) {
 |`OLED_IC`                  |`OLED_IC_SSD1306`|Set to `OLED_IC_SH1106` if you're using the SH1106 OLED controller.                                                       |
 |`OLED_COLUMN_OFFSET`       |`0`              |(SH1106 only.) Shift output to the right this many pixels.<br />Useful for 128x64 displays centered on a 132x64 SH1106 IC.|
 |`OLED_BRIGHTNESS`          |`255`            |The default brightness level of the OLED, from 0 to 255.                                                                  |
+|`OLED_UPDATE_INTERVAL`     |`0`              |Set the time interval for updating the OLED display in ms. This will improve the matrix scan rate.                        |
 
  ## 128x64 & Custom sized OLED Displays
 

docs/feature_rawhid.md

@@ -29,7 +29,7 @@ void raw_hid_receive(uint8_t *data, uint8_t length) {
 }
 ```
 
-`raw_hid_receive` can receive variable size packets from host with maximum length `RAW_EPSIZE`. `raw_hid_send` on the other hand can send packets to host of exactly `RAW_EPSIZE` length, therefore it should be used with data of length `RAW_EPSIZE`.
+These two functions send and receive packets of length `RAW_EPSIZE` bytes to and from the host (32 on LUFA/ChibiOS/V-USB, 64 on ATSAM).
 
 Make sure to flash raw enabled firmware before proceeding with working on the host side.
 

docs/feature_rgb_matrix.md

@@ -11,7 +11,8 @@ If you want to use single color LED's you should use the [LED Matrix Subsystem](
 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
 
 ```makefile
-RGB_MATRIX_ENABLE = IS31FL3731
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = IS31FL3731
 ```
 
 Configure the hardware via your `config.h`:
@@ -62,7 +63,8 @@ Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet]
 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3733 RGB controller. To enable it, add this to your `rules.mk`:
 
 ```makefile
-RGB_MATRIX_ENABLE = IS31FL3733
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = IS31FL3733
 ```
 
 Configure the hardware via your `config.h`:
@@ -112,7 +114,8 @@ Where `X_Y` is the location of the LED in the matrix defined by [the datasheet](
 There is basic support for addressable RGB matrix lighting with a WS2811/WS2812{a,b,c} addressable LED strand. To enable it, add this to your `rules.mk`:
 
 ```makefile
-RGB_MATRIX_ENABLE = WS2812
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = WS2812
 ```
 
 Configure the hardware via your `config.h`:
@@ -293,6 +296,19 @@ You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `con
 |`#define DISABLE_RGB_MATRIX_SOLID_SPLASH`              |Disables `RGB_MATRIX_SOLID_SPLASH`             |
 |`#define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH`         |Disables `RGB_MATRIX_SOLID_MULTISPLASH`        |
 
+### RGB Matrix Effect Typing Heatmap :id=rgb-matrix-effect-typing-heatmap
+
+This effect will color the RGB matrix according to a heatmap of recently pressed
+keys. Whenever a key is pressed its "temperature" increases as well as that of
+its neighboring keys. The temperature of each key is then decreased
+automatically every 25 milliseconds by default.
+
+In order to change the delay of temperature decrease define
+`RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS`:
+
+```c
+#define RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS 50
+```
 
 ## Custom RGB Matrix Effects :id=custom-rgb-matrix-effects
 
@@ -303,6 +319,12 @@ To declare new effects, create a new `rgb_matrix_user/kb.inc` that looks somethi
 `rgb_matrix_user.inc` should go in the root of the keymap directory.
 `rgb_matrix_kb.inc` should go in the root of the keyboard directory.
 
+To use custom effects in your code, simply prepend `RGB_MATRIX_CUSTOM_` to the effect name specified in `RGB_MATRIX_EFFECT()`. For example, an effect declared as `RGB_MATRIX_EFFECT(my_cool_effect)` would be referenced with:
+
+```c
+rgb_matrix_mode(RGB_MATRIX_CUSTOM_my_cool_effect);
+```
+
 ```c
 // !!! DO NOT ADD #pragma once !!! //
 
@@ -482,6 +504,14 @@ void rgb_matrix_indicators_kb(void) {
 }
 ```
 
+In addition, there are the advanced indicator functions.  These are aimed at those with heavily customized displays, where rendering every LED per cycle is expensive.  Such as some of the "drashna" layouts.  This includes a special macro to help make this easier to use: `RGB_MATRIX_INDICATOR_SET_COLOR(i, r, g, b)`.
+
+```c
+void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+    RGB_MATRIX_INDICATOR_SET_COLOR(index, red, green, blue);
+}
+```
+
 ### Suspended state :id=suspended-state
 To use the suspend feature, make sure that `#define RGB_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file. 
 

docs/feature_rgblight.md

@@ -187,6 +187,8 @@ const uint8_t RGBLED_GRADIENT_RANGES[] PROGMEM = {255, 170, 127, 85, 64};
 
 ## Lighting Layers
 
+?> **Note:** Lighting Layers is an RGB Light feature, it will not work for RGB Matrix. See [RGB Matrix Indicators](feature_rgb_matrix.md?indicators) for details on how to do so.
+
 By including `#define RGBLIGHT_LAYERS` in your `config.h` file you can enable lighting layers. These make
 it easy to use your underglow LEDs as status indicators to show which keyboard layer is currently active, or the state of caps lock, all without disrupting any animations. [Here's a video](https://youtu.be/uLGE1epbmdY) showing an example of what you can do.
 
@@ -368,14 +370,14 @@ rgblight_sethsv(HSV_GREEN, 2); // led 2
 |`rgblight_increase_hue_noeeprom()`          |Increase the hue for effect range LEDs. This wraps around at maximum hue (not written to EEPROM) |
 |`rgblight_decrease_hue()`                   |Decrease the hue for effect range LEDs. This wraps around at minimum hue |
 |`rgblight_decrease_hue_noeeprom()`          |Decrease the hue for effect range LEDs. This wraps around at minimum hue (not written to EEPROM) |
-|`rgblight_increase_sat()`                   |Increase the saturation for effect range LEDs. This wraps around at maximum saturation |
-|`rgblight_increase_sat_noeeprom()`          |Increase the saturation for effect range LEDs. This wraps around at maximum saturation (not written to EEPROM) |
-|`rgblight_decrease_sat()`                   |Decrease the saturation for effect range LEDs. This wraps around at minimum saturation |
-|`rgblight_decrease_sat_noeeprom()`          |Decrease the saturation for effect range LEDs. This wraps around at minimum saturation (not written to EEPROM) |
-|`rgblight_increase_val()`                   |Increase the value for effect range LEDs. This wraps around at maximum value |
-|`rgblight_increase_val_noeeprom()`          |Increase the value for effect range LEDs. This wraps around at maximum value (not written to EEPROM) |
-|`rgblight_decrease_val()`                   |Decrease the value for effect range LEDs. This wraps around at minimum value |
-|`rgblight_decrease_val_noeeprom()`          |Decrease the value for effect range LEDs. This wraps around at minimum value (not written to EEPROM) |
+|`rgblight_increase_sat()`                   |Increase the saturation for effect range LEDs. This stops at maximum saturation |
+|`rgblight_increase_sat_noeeprom()`          |Increase the saturation for effect range LEDs. This stops at maximum saturation (not written to EEPROM) |
+|`rgblight_decrease_sat()`                   |Decrease the saturation for effect range LEDs. This stops at minimum saturation |
+|`rgblight_decrease_sat_noeeprom()`          |Decrease the saturation for effect range LEDs. This stops at minimum saturation (not written to EEPROM) |
+|`rgblight_increase_val()`                   |Increase the value for effect range LEDs. This stops at maximum value |
+|`rgblight_increase_val_noeeprom()`          |Increase the value for effect range LEDs. This stops at maximum value (not written to EEPROM) |
+|`rgblight_decrease_val()`                   |Decrease the value for effect range LEDs. This stops at minimum value |
+|`rgblight_decrease_val_noeeprom()`          |Decrease the value for effect range LEDs. This stops at minimum value (not written to EEPROM) |
 |`rgblight_sethsv(h, s, v)`                  |Set effect range LEDs to the given HSV value where `h`/`s`/`v` are between 0 and 255 |
 |`rgblight_sethsv_noeeprom(h, s, v)`         |Set effect range LEDs to the given HSV value where `h`/`s`/`v` are between 0 and 255 (not written to EEPROM) |
 

docs/feature_sequencer.md

@@ -0,0 +1,87 @@
+# Sequencer
+
+Since QMK has experimental support for MIDI, you can now turn your keyboard into a [step sequencer](https://en.wikipedia.org/wiki/Music_sequencer#Step_sequencers)!
+
+!> **IMPORTANT:** This feature is highly experimental, it has only been tested on a Planck EZ so far. Also, the scope will be limited to support the drum machine use-case to start with.
+
+## Enable the step sequencer
+
+Add the following line to your `rules.mk`:
+
+```make
+SEQUENCER_ENABLE = yes
+```
+
+By default the sequencer has 16 steps, but you can override this setting in your `config.h`:
+
+```c
+#define SEQUENCER_STEPS 32
+```
+
+## Tracks
+
+You can program up to 8 independent tracks with the step sequencer. Select the tracks you want to edit, enable or disable some steps, and start the sequence!
+
+## Resolutions
+
+While the tempo defines the absolute speed at which the sequencer goes through the steps, the resolution defines the granularity of these steps (from coarser to finer).
+
+|Resolution   |Description            |
+|----------   |-----------            |
+|`SQ_RES_2`   |Every other beat       |
+|`SQ_RES_2T`  |Every 1.5 beats        |
+|`SQ_RES_4`   |Every beat             |
+|`SQ_RES_4T`  |Three times per 2 beats|
+|`SQ_RES_8`   |Twice per beat         |
+|`SQ_RES_8T`  |Three times per beat   |
+|`SQ_RES_16`  |Four times per beat    |
+|`SQ_RES_16T` |Six times per beat     |
+|`SQ_RES_32`  |Eight times per beat   |
+
+## Keycodes
+
+|Keycode  |Description                                        |
+|-------  |-----------                                        |
+|`SQ_ON`  |Start the step sequencer                           |
+|`SQ_OFF` |Stop the step sequencer                            |
+|`SQ_TOG` |Toggle the step sequencer playback                 |
+|`SQ_SALL`|Enable all the steps                               |
+|`SQ_SCLR`|Disable all the steps                              |
+|`SQ_S(n)`|Toggle the step `n`                                |
+|`SQ_TMPD`|Decrease the tempo                                 |
+|`SQ_TMPU`|Increase the tempo                                 |
+|`SQ_R(n)`|Set the resolution to n                            |
+|`SQ_RESD`|Change to the slower resolution                    |
+|`SQ_RESU`|Change to the faster resolution                    |
+|`SQ_T(n)`|Set `n` as the only active track or deactivate all |
+
+## Functions
+
+|Function                                                             |Description                                            |
+|--------                                                             |-----------                                            |
+|`bool is_sequencer_on(void);`                                        |Return whether the sequencer is playing                |
+|`void sequencer_toggle(void);`                                       |Toggle the step sequencer playback                     |
+|`void sequencer_on(void);`                                           |Start the step sequencer                               |
+|`void sequencer_off(void);`                                          |Stop the step sequencer                                |
+|`bool is_sequencer_step_on(uint8_t step);`                           |Return whether the step is currently enabled           |
+|`void sequencer_set_step(uint8_t step, bool value);`                 |Enable or disable the step                             |
+|`void sequencer_set_step_on();`                                      |Enable the step                                        |
+|`void sequencer_set_step_off();`                                     |Disable the step                                       |
+|`void sequencer_toggle_step(uint8_t step);`                          |Toggle the step                                        |
+|`void sequencer_set_all_steps(bool value);`                          |Enable or disable all the steps                        |
+|`void sequencer_set_all_steps_on();`                                 |Enable all the steps                                   |
+|`void sequencer_set_all_steps_off();`                                |Disable all the steps                                  |
+|`uint8_t sequencer_get_tempo(void);`                                 |Return the current tempo                               |
+|`void sequencer_set_tempo(uint8_t tempo);`                           |Set the tempo to `tempo` (between 1 and 255)           |
+|`void sequencer_increase_tempo(void);`                               |Increase the tempo                                     |
+|`void sequencer_decrease_tempo(void);`                               |Decrease the tempo                                     |
+|`sequencer_resolution_t sequencer_get_resolution(void);`             |Return the current resolution                          |
+|`void sequencer_set_resolution(sequencer_resolution_t resolution);`  |Set the resolution to `resolution`                     |
+|`void sequencer_increase_resolution(void);`                          |Change to the faster resolution                        |
+|`void sequencer_decrease_resolution(void);`                          |Change to the slower resolution                        |
+|`bool is_sequencer_track_active(uint8_t track);`                     |Return whether the track is active                     |
+|`void sequencer_set_track_activation(uint8_t track, bool value);`    |Activate or deactivate the `track`                     |
+|`void sequencer_toggle_track_activation(uint8_t track);`             |Toggle the `track`                                     |
+|`void sequencer_activate_track(uint8_t track);`                      |Activate the `track`                                   |
+|`void sequencer_deactivate_track(uint8_t track);`                    |Deactivate the `track`                                 |
+|`void sequencer_toggle_single_active_track(uint8_t track);`          |Set `track` as the only active track or deactivate all |

docs/feature_split_keyboard.md

@@ -237,6 +237,26 @@ This sets the maximum timeout when detecting master/slave when using `SPLIT_USB_
 ```
 This sets the poll frequency when detecting master/slave when using `SPLIT_USB_DETECT`
 
+## Hardware Considerations and Mods
+
+While most any Pro Micro can be used, micro controllers like the AVR Teensys and most (if not all) ARM boards require the Split USB Detect.
+
+However, with the Teensy 2.0 and Teensy++ 2.0, there is a simple hardware mod that you can perform to add VBUS detection, so you don't need the Split USB detection option.
+
+You'll only need a few things:
+
+* A knife (x-acto knife, ideally)
+* A solder station or hot air station
+* An appropriate Schottky diode, such as the [PMEG2005EH](https://www.digikey.com/en/products/detail/nexperia-usa-inc/PMEG2005EH,115/1589924)
+
+You'll need to cut the small trace between the 5V and center pads on the back of the Teensy.
+
+Once you have done that, you will want to solder the diode from the 5V pad to the center pad.
+
+You may need to use the 5V pad from the regulator block above as the pads were too small and placed too closely together to place the Schottky diode properly.
+
+![Teensy++ 2.0](https://i.imgur.com/BPEC5n5.png)
+
 ## Additional Resources
 
 Nicinabox has a [very nice and detailed guide](https://github.com/nicinabox/lets-split-guide) for the Let's Split keyboard, that covers most everything you need to know, including troubleshooting information. 

docs/feature_stenography.md

@@ -129,4 +129,3 @@ As defined in `keymap_steno.h`.
 |`STN_RES1`||(GeminiPR only)|
 |`STN_RES2`||(GeminiPR only)|
 |`STN_PWR`||(GeminiPR only)|
-

docs/feature_unicode.md

@@ -87,7 +87,7 @@ const qk_ucis_symbol_t ucis_symbol_table[] = UCIS_TABLE(
     UCIS_SYM("poop", 0x1F4A9),                // 💩
     UCIS_SYM("rofl", 0x1F923),                // 🤣
     UCIS_SYM("cuba", 0x1F1E8, 0x1F1FA),       // 🇨🇺
-    UCIS_SYM("look", 0x0CA0, 0x005F, 0x0CA0), // ಠ_ಠ
+    UCIS_SYM("look", 0x0CA0, 0x005F, 0x0CA0)  // ಠ_ಠ
 );
 ```
 

docs/feature_userspace.md

@@ -184,7 +184,7 @@ If you wanted to consolidate macros and other functions into your userspace for
 
 First, you'd want to go through all of your `keymap.c` files and replace `process_record_user` with `process_record_keymap` instead.   This way, you can still use keyboard specific codes on those boards, and use your custom "global" keycodes as well.   You'll also want to replace `SAFE_RANGE` with `NEW_SAFE_RANGE` so that you wont have any overlapping keycodes
 
-Then add `#include <name.h>` to all of your keymap.c files.  This allows you to use these new keycodes without having to redefine them in each keymap.
+Then add `#include "<name>.h"` to all of your keymap.c files.  This allows you to use these new keycodes without having to redefine them in each keymap.
 
 Once you've done that, you'll want to set the keycode definitions that you need to the `<name>.h`  file. For instance:
 ```c

docs/fr-fr/newbs_testing_debugging.md

@@ -42,7 +42,9 @@ Vous préférez une solution basée sur le terminal? [hid_listen](https://www.pj
 
 Parfois, il est utile d'afficher des messages de débugage depuis votre [code custom](custom_quantum_functions.md). Le faire est assez simple. Commencez par ajouter `print.h` au début de votre fichier:
 
-    #include <print.h>
+```c
+#include "print.h"
+```
 
 Une fois fait, vous pouvez utiliser les fonctions print suivantes:
 

docs/fuse.txt

@@ -47,4 +47,3 @@ This configuration is from usbasploader's Makefile.
 #             |     |   +----- LB 2..1 (No memory lock features enabled)
 #             |     +--------- BLB0 2..1 (No restrictions for SPM or LPM accessing the Application section)
 #             +--------------- BLB1 2..1 (No restrictions for SPM or LPM accessing the Boot Loader section)
-

docs/hand_wire.md

@@ -78,7 +78,7 @@ Established materials and techniques include:
 | Short lengths of wire | [u/xicolinguada's ortho build](https://www.reddit.com/r/MechanicalKeyboards/comments/c39k4f/my_first_hand_wired_keyboard_its_not_perfect_but/) | Easier to strip the wire | More difficult to place | ![individual wire lengths](https://i.imgur.com/mBe5vkL.jpg)
 | Magnet/Enamelled wire | [Brett Kosinski's handwired alpha](http://blog.b-ark.ca/Blog-2019-01-27) and [fknraiden's custom board](https://geekhack.org/index.php?topic=74223.0) | Can be directly soldered onto (insulation burns off with heat) | Appearance? | ![Magnet wire](https://i.imgur.com/b4b7KDb.jpg)
 | Bending the legs of the diodes for the rows | [Matt3o's Brownfox](https://deskthority.net/viewtopic.php?f=7&t=6050) | Fewer solder joints required | Uninsulated | ![Bent diode legs](https://i.imgur.com/aTnG8TV.jpg)
-| Using ridid wiring (e.g. brass tube) | [u/d_stilgar's invisible hardline](https://www.reddit.com/r/MechanicalKeyboards/comments/8aw5j2/invisible_hardline_keyboard_progress_update_april/) and [u/jonasfasler's first attempt](https://www.reddit.com/r/MechanicalKeyboards/comments/de1jyv/my_first_attempt_at_handwiring_a_keyboard/) | Very pretty | More difficult. No physical insulation | ![Hardline hand wire](https://i.imgur.com/CnASmPo.jpg)
+| Using rigid wiring (e.g. brass tube) | [u/d_stilgar's invisible hardline](https://www.reddit.com/r/MechanicalKeyboards/comments/8aw5j2/invisible_hardline_keyboard_progress_update_april/) and [u/jonasfasler's first attempt](https://www.reddit.com/r/MechanicalKeyboards/comments/de1jyv/my_first_attempt_at_handwiring_a_keyboard/) | Very pretty | More difficult. No physical insulation | ![Hardline hand wire](https://i.imgur.com/CnASmPo.jpg)
 | Bare wire with insulation added after (e.g. kapton tape) | [Matt3o's 65% on his website](https://matt3o.com/hand-wiring-a-custom-keyboard/) | Easier (no wire stripping required) | Not as attractive | ![Bare wire](https://i.imgur.com/AvXZShD.jpg)
 | Copper tape | [ManuForm Dactyl](https://github.com/tshort/dactyl-keyboard) | Very easy | Only really works when your plate/case aligns with the bottom of your switches | ![Copper tape](https://i.imgur.com/RFyNMlL.jpg)
 
@@ -121,7 +121,7 @@ Letting the diode rest, grab your solder, and touch both it and the soldering ir
 
 The smoke that the rosin releases is harmful, so be careful not to breath it or get it in your eyes/face.
 
-After soldering things in place, it may be helpful to blow on the joint to push the smoke away from your face, and cool the solder quicker. You should see the solder develop a matte (not shiny) surface as it solidifies. Keep in mind that it will still be very hot afterwards, and will take a couple minutes to be cool to touch. Blow on it will accelerate this process.
+After soldering things in place, it may be helpful to blow on the joint to push the smoke away from your face, and cool the solder quicker. You should see the solder develop a matte (not shiny) surface as it solidifies. Keep in mind that it will still be very hot afterwards, and will take a couple minutes to be cool to touch. Blowing on it will accelerate this process.
 
 When the first diode is complete, the next one will need to be soldered to both the keyswitch, and the previous diode at the new elbow. That will look something like this:
 

docs/hardware_avr.md

@@ -77,7 +77,7 @@ Do change the `MANUFACTURER` and `PRODUCT` lines to accurately reflect your keyb
 #define PRODUCT         my_awesome_keyboard
 ```
 
-?> Windows and macOS will display the `MANUFACTURER` and `PRODUCT` in the list of USB devices. `lsusb` on Linux instead takes these from the list maintained by the [USB ID Repository](http://www.linux-usb.org/usb-ids.html) by default. `lsusb -v` will show the values reported by the device, and they are also present in kernel logs after plugging it in.
+?> Windows and macOS will display the `MANUFACTURER` and `PRODUCT` in the list of USB devices. `lsusb` on Linux instead prefers the values in the list maintained by the [USB ID Repository](http://www.linux-usb.org/usb-ids.html). By default, it will only use `MANUFACTURER` and `PRODUCT` if the list does not contain that `VENDOR_ID` / `PRODUCT_ID`. `sudo lsusb -v` will show the values reported by the device, and they are also present in kernel logs after plugging it in.
 
 ### Keyboard Matrix Configuration
 

docs/he-il/documentation_best_practices.md

@@ -64,4 +64,4 @@
 ```
 
 מקמו את התיעוד שלכם בתוך  `docs/feature_<my_cool_feature>.md`, והוסיפו קישור לקובץ זה במקום המתאים ב `docs/_sidebar.md`. אם הוספתם קודי מקשים נוספים, תקפידו להוסיף אותם ל-  `docs/keycodes.md` עם לינק לעמוד היכולת שלכם.
-</div>
+</div>

docs/he-il/faq.md

@@ -5,4 +5,4 @@
 * [בנייה או קומפילציה של QMK](faq_build.md)
 * [דיבאגינג ופתרון בעיות של QMK](faq_debug.md)
 * [מיפוי מקשים](faq_keymap.md)
-</div>
+</div>

docs/he-il/faq_general.md

@@ -14,4 +14,4 @@ TMK עוצב ומומש במקור ע״י [Jun Wako](https://github.com/tmk). QM
 מנק׳ מבט של הפרוייקט וניהול הקהילה, TMK מנהל את כל המקלדות הנתמכות בעצמו, עם מעט תמיכה מהקהילה. כל אחד יכול לעשות פורק מהפרוייקט עבור מקלדות אחרות. רק מס׳ מיפויי מקשים נמצאים בברירת המחדל כך שאנשים בד״כ לא משתפים מיפויי מקשים זה עם זה. QMK מעודד את השיתוף של המקלדות וקודי המקשים דרך רפוזיטורי בניהול מרכזי, אשר מקבל את כל בקשות ה- Pull Requests שעומדות בסטנדרט האיכות. רובם מנוהלות ע״י הקהילה, אבל הצוות של QMK עוזר כשנדרש.
 
 לשתי הגישות יש יתרונות וחסרונות וקוד עובר בחופשיות בין TMK ל- QMK כשצריך.
-</div>
+</div>

docs/he-il/getting_started_getting_help.md

@@ -14,4 +14,4 @@
 ## סוגיות GitHub
 
 ניתן לפתוח [סוגייה ב-GitHub](https://github.com/qmk/qmk_firmware/issues). הדבר שימושי במיוחד כאשר הסוגיה דורשת דיון עמוק וארוך או דיבאגינג.
-</div>
+</div>

docs/he-il/hardware.md

@@ -7,4 +7,4 @@ QMK רצה על מגוון של חומרות. אם המעבד שלך יכול ל
 * [מעבדי AVR](hardware_avr.md)
 * מעבדי ARM (TBD)
 * [מנהלי התקנים](hardware_drivers.md)
-</div>
+</div>

docs/he-il/newbs_learn_more_resources.md

@@ -13,4 +13,4 @@
 מקורות לפקודות שורה (Command Line):
 
 * [מדריך טוב על Command Line](https://www.codecademy.com/learn/learn-the-command-line)
-</div>
+</div>

docs/index.html

@@ -126,6 +126,10 @@
         headings: 'h1, h2',
         title: 'Table of Contents',
       },
+      tabs: {
+        persist    : false,
+        tabComments: false,
+      },
       plugins: [
         function (hook, vm) {
           hook.beforeEach(function (html) {
@@ -148,6 +152,7 @@
   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
   <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
   <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+  <script src="//unpkg.com/docsify-tabs@1"></script>
   <script src="//unpkg.com/docsify-copy-code@2"></script>
   <script src="//unpkg.com/docsify-toc@1.0.0/dist/toc.js"></script>
   <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>

docs/internals_gpio_control.md

@@ -21,3 +21,22 @@ The following functions can provide basic control of GPIOs and are found in `qua
 ## Advanced Settings :id=advanced-settings
 
 Each microcontroller can have multiple advanced settings regarding its GPIO. This abstraction layer does not limit the use of architecture-specific functions. Advanced users should consult the datasheet of their desired device and include any needed libraries. For AVR, the standard avr/io.h library is used; for STM32, the ChibiOS [PAL library](http://chibios.sourceforge.net/docs3/hal/group___p_a_l.html) is used.
+
+## Atomic Operation
+
+The above functions are not always guaranteed to work atomically. Therefore, if you want to prevent interruptions in the middle of operations when using multiple combinations of the above functions, use the following `ATOMIC_BLOCK_FORCEON` macro.
+
+eg.
+```c
+void some_function() {
+     // some process
+     ATOMIC_BLOCK_FORCEON {
+        // Atomic Processing
+     }
+     // some process
+}
+```
+
+`ATOMIC_BLOCK_FORCEON` forces interrupts to be disabled before the block is executed, without regard to whether they are enabled or disabled. Then, after the block is executed, the interrupt is enabled.
+
+Note that `ATOMIC_BLOCK_FORCEON` can therefore be used if you know that interrupts are enabled before the execution of the block, or if you know that it is OK to enable interrupts at the completion of the block.

docs/ja/_summary.md

@@ -103,6 +103,7 @@
     * [DIP スイッチ](ja/feature_dip_switch.md)
     * [エンコーダ](ja/feature_encoders.md)
     * [触覚フィードバック](ja/feature_haptic_feedback.md)
+    * [LED インジケータ](ja/feature_led_indicators.md)
     * [Proton C 変換](ja/proton_c_conversion.md)
     * [PS/2 マウス](ja/feature_ps2_mouse.md)
     * [分割キーボード](ja/feature_split_keyboard.md)

docs/ja/config_options.md

@@ -34,7 +34,9 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
 
 これは最初に include されるものの 1 つである C ヘッダファイルで、プロジェクト全体(もし含まれる場合)にわたって持続します。多くの変数をここで設定し、他の場所からアクセスすることができます。`config.h` ファイルでは、以下のもの以外の、他の `config.h`  ファイルやその他のファイルの include をしないでください:
 
-    #include "config_common.h"
+```c
+#include "config_common.h"
+```
 
 
 ## ハードウェアオプション

docs/ja/custom_quantum_functions.md

@@ -1,8 +1,8 @@
 # キーボードの挙動をカスタマイズする方法
 
 <!---
-  original document: 0.10.33:docs/custom_quantum_functions.md
-  git diff 0.10.33 HEAD -- docs/custom_quantum_functions.md | cat
+  original document: 0.10.52:docs/custom_quantum_functions.md
+  git diff 0.10.52 HEAD -- docs/custom_quantum_functions.md | cat
 -->
 
 多くの人にとって、カスタムキーボードはボタンの押下をコンピュータに送信するだけではありません。単純なボタンの押下やマクロよりも複雑なことを実行できるようにしたいでしょう。QMK にはコードを挿入したり、機能を上書きしたり、様々な状況でキーボードの挙動をカスタマイズできるフックがあります。
@@ -93,106 +93,6 @@ keyrecord_t record {
 }
 ```
 
-# LED 制御
-
-QMK は HID 仕様で定義された5つの LED の読み取りメソッドを提供します:
-
-* Num Lock
-* Caps Lock
-* Scroll Lock
-* Compose
-* Kana
-
-ロック LED の状態を取得するには2つの方法があります:
-
-* `bool led_update_kb(led_t led_state)` あるいは `_user(led_t led_state)` を実装する、または
-* `led_t host_keyboard_led_state()` を呼び出す
-
-!> `host_keyboard_led_state()` は `led_update_user()` が呼ばれる前に新しい値を既に反映している場合があります。
-
-LED の状態を `uint8_t` として提供する2つの非推奨の関数があります:
-
-* `uint8_t led_set_kb(uint8_t usb_led)` と `_user(uint8_t usb_led)`
-* `uint8_t host_keyboard_leds()`
-
-## `led_update_user()`
-
-この関数はこれら5つの LED のいずれかの状態が変化すると呼ばれます。LED の状態を構造体のパラメータとして受け取ります。
-
-慣例により、`led_update_kb()` にそのコードを実行するようフックさせるために `led_update_user()` から `true` を返し、`led_update_kb()` でコードを実行したくない場合は `false` を返します。
-
-以下はいくつかの例です:
-
-- レイヤー表示のような何かのために LED を使うために LED を上書きする
-   - `_kb()` 関数を実行したくないので、`false`  を返します。これはレイヤーの挙動を上書きするためです。
-- LED がオンあるいはオフになった時に音楽を再生する。
-   - `_kb` 関数を実行したいので、`true` を返します。これはデフォルトの LED の挙動に追加されます。
-
-?> `led_set_*` 関数は `bool` の代わりに `void` を返すため、キーボードの LED 制御を上書きすることができません。従って、代わりに `led_update_*` を使うことをお勧めします。
-
-### `led_update_kb()` の実装例
-
-```c
-bool led_update_kb(led_t led_state) {
-    bool res = led_update_user(led_state);
-    if(res) {
-        // writePin は 1 でピンを high に、0 で low に設定します。
-        // この例では、ピンは反転していて、
-        // low/0 は LED がオンになり、high/1 は LED がオフになります。
-        // この挙動は、LED がピンと VCC の間にあるか、ピンと GND の間にあるかどうかに依存します。
-        writePin(B0, !led_state.num_lock);
-        writePin(B1, !led_state.caps_lock);
-        writePin(B2, !led_state.scroll_lock);
-        writePin(B3, !led_state.compose);
-        writePin(B4, !led_state.kana);
-    }
-    return res;
-}
-```
-
-### `led_update_user()` の実装例
-
-この不完全な例は Caps Lock がオンまたはオフになった場合に音を再生します。また LED の状態を保持する必要があるため、`true` を返します。
-
-```c
-#ifdef AUDIO_ENABLE
-  float caps_on[][2] = SONG(CAPS_LOCK_ON_SOUND);
-  float caps_off[][2] = SONG(CAPS_LOCK_OFF_SOUND);
-#endif
-
-bool led_update_user(led_t led_state) {
-    #ifdef AUDIO_ENABLE
-    static uint8_t caps_state = 0;
-    if (caps_state != led_state.caps_lock) {
-        led_state.caps_lock ? PLAY_SONG(caps_on) : PLAY_SONG(caps_off);
-        caps_state = led_state.caps_lock;
-    }
-    #endif
-    return true;
-}
-```
-
-### `led_update_*` 関数のドキュメント
-
-* キーボード/リビジョン: `bool led_update_kb(led_t led_state)`
-* キーマップ: `bool led_update_user(led_t led_state)`
-
-## `host_keyboard_led_state()`
-
-最後に受信した LED の状態を `led_t` として取得するためにこの関数を呼びます。これは、`led_update_*` の外部から、例えば [`matrix_scan_user()`](#matrix-scanning-code) の中で LED の状態を読み取るのに便利です。
-
-## 物理的な LED の状態の設定
-
-一部のキーボードの実装は、物理的な LED の状態を設定するための便利なメソッドを提供しています。
-
-### Ergodox キーボード
-
-Ergodox の実装は、個々の LED をオンあるいはオフにするために `ergodox_right_led_1`/`2`/`3_on`/`off()` と、インデックスによってそれらをオンあるいはオフにするために `ergodox_right_led_on`/`off(uint8_t led)` を提供します。
-
-さらに、LED の明度を指定することができます。全ての LED に同じ明度を指定するなら `ergodox_led_all_set(uint8_t n)` を使い、個別の LED の明度を指定するなら `ergodox_right_led_1`/`2`/`3_set(uint8_t n)` を使い、LED のインデックスを指定して明度を指定するには  `ergodox_right_led_set(uint8_t led, uint8_t n)` を使います。
-
-Ergodox キーボードは、最低の明度として `LED_BRIGHTNESS_LO` を、最高の輝度(これはデフォルトです)として `LED_BRIGHTNESS_HI` も定義しています。
-
 # キーボードの初期化コード
 
 キーボードの初期化プロセスには幾つかのステップがあります。何をしたいかによって、どの関数を使うべきかに影響します。
@@ -347,7 +247,7 @@ layer_state_t layer_state_set_user(layer_state_t state) {
 }
 ```
 
-特定のレイヤーの状態を確認するには、 `IS_LAYER_ON_STATE(state, layer)` と `IS_LAYER_OFF_STATE(state, layer)` マクロを使います。
+特定のレイヤーの状態を確認するには、`IS_LAYER_ON_STATE(state, layer)` と `IS_LAYER_OFF_STATE(state, layer)` マクロを使います。
 
 `layer_state_set_*` 関数の外では、グローバルなレイヤー状態を確認するために `IS_LAYER_ON(layer)` と `IS_LAYER_OFF(layer)` マクロを使えます。
 

docs/ja/feature_debounce_type.md

@@ -43,5 +43,3 @@ endif
 * eager_pk - キーごとにデバウンスします。状態が変化すると、応答は即座に行われ、その後そのキーは ```DEBOUNCE``` ミリ秒の間入力されません。
 * sym_g - キーボードごとにデバウンスします。状態が変化すると、グローバルタイマが設定されます。```DEBOUNCE``` ミリ秒の間何も変化がなければ、全ての入力の変更がプッシュされます。
 * sym_pk - キーごとにデバウンスします。状態が変化すると、キーごとのタイマーが設定されます。```DEBOUNCE``` ミリ秒の間そのキーに変化がなければ、キーの状態の変更がプッシュされます。
-
-

docs/ja/feature_led_indicators.md

@@ -0,0 +1,119 @@
+# LED インジケータ
+
+<!---
+  original document: 0.10.52:docs/feature_led_indicators.md
+  git diff 0.10.52 HEAD -- docs/feature_led_indicators.md | cat
+-->
+
+QMK は HID 仕様で定義された5つの LED の読み取りメソッドを提供します:
+
+* Num Lock
+* Caps Lock
+* Scroll Lock
+* Compose
+* Kana
+
+ロック LED の状態を取得するには3つの方法があります:
+* `config.h` で設定オプションを指定する
+* `bool led_update_kb(led_t led_state)` あるいは `_user(led_t led_state)` を実装する、または
+* `led_t host_keyboard_led_state()` を呼び出す
+
+!> `host_keyboard_led_state()` は `led_update_user()` が呼ばれる前に新しい値を既に反映している場合があります。
+
+LED の状態を `uint8_t` として提供する2つの非推奨の関数があります:
+
+* `uint8_t led_set_kb(uint8_t usb_led)` と `_user(uint8_t usb_led)`
+* `uint8_t host_keyboard_leds()`
+
+## 設定オプション
+
+インジケータを設定するには、`config.h` で以下の `#define` をします:
+
+| 定義                  | 既定値     | 説明                             |
+|-----------------------|------------|----------------------------------|
+| `LED_NUM_LOCK_PIN`    | *定義なし* | `Num Lock` LED を制御するピン    |
+| `LED_CAPS_LOCK_PIN`   | *定義なし* | `Caps Lock` LED を制御するピン   |
+| `LED_SCROLL_LOCK_PIN` | *定義なし* | `Scroll Lock` LED を制御するピン |
+| `LED_COMPOSE_PIN`     | *定義なし* | `Compose` LED を制御するピン     |
+| `LED_KANA_PIN`        | *定義なし* | `Kana` LED を制御するピン        |
+| `LED_PIN_ON_STATE`    | `1`        | LED が "オン" の時のインジケータピンの状態 - high の場合は`1`、low の場合は`0` |
+
+独自のキーボードを設計しているわけではない限り、通常は上記の設定オプションを変更する必要はありません。
+
+## `led_update_*()`
+
+設定オプションが十分な柔軟性を提供しない場合は、提供される API フックにより LED の挙動の独自の制御ができます。これらの関数はこれら5つの LED のいずれかの状態が変化すると呼ばれます。LED の状態を構造体のパラメータとして受け取ります。
+
+慣例により、`led_update_kb()` にそのコードを実行するようフックさせるために `led_update_user()` から `true` を返し、`led_update_kb()` でコードを実行したくない場合は `false` を返します。
+
+以下はいくつかの例です:
+
+- レイヤー表示のような何かのために LED を使うために LED を上書きする
+   - `_kb()` 関数を実行したくないので、`false`  を返します。これはレイヤーの挙動を上書きするためです。
+- LED がオンあるいはオフになった時に音楽を再生する。
+   - `_kb` 関数を実行したいので、`true` を返します。これはデフォルトの LED の挙動に追加されます。
+
+?> `led_set_*` 関数は `bool` の代わりに `void` を返すため、キーボードの LED 制御を上書きすることができません。従って、代わりに `led_update_*` を使うことをお勧めします。
+
+### `led_update_kb()` の実装例
+
+```c
+bool led_update_kb(led_t led_state) {
+    bool res = led_update_user(led_state);
+    if(res) {
+        // writePin は 1 でピンを high に、0 で low に設定します。
+        // この例では、ピンは反転していて、
+        // low/0 は LED がオンになり、high/1 は LED がオフになります。
+        // この挙動は、LED がピンと VCC の間にあるか、ピンと GND の間にあるかどうかに依存します。
+        writePin(B0, !led_state.num_lock);
+        writePin(B1, !led_state.caps_lock);
+        writePin(B2, !led_state.scroll_lock);
+        writePin(B3, !led_state.compose);
+        writePin(B4, !led_state.kana);
+    }
+    return res;
+}
+```
+
+### `led_update_user()` の実装例
+
+この不完全な例は Caps Lock がオンまたはオフになった場合に音を再生します。また LED の状態を保持する必要があるため、`true` を返します。
+
+```c
+#ifdef AUDIO_ENABLE
+  float caps_on[][2] = SONG(CAPS_LOCK_ON_SOUND);
+  float caps_off[][2] = SONG(CAPS_LOCK_OFF_SOUND);
+#endif
+
+bool led_update_user(led_t led_state) {
+    #ifdef AUDIO_ENABLE
+    static uint8_t caps_state = 0;
+    if (caps_state != led_state.caps_lock) {
+        led_state.caps_lock ? PLAY_SONG(caps_on) : PLAY_SONG(caps_off);
+        caps_state = led_state.caps_lock;
+    }
+    #endif
+    return true;
+}
+```
+
+### `led_update_*` 関数のドキュメント
+
+* キーボード/リビジョン: `bool led_update_kb(led_t led_state)`
+* キーマップ: `bool led_update_user(led_t led_state)`
+
+## `host_keyboard_led_state()`
+
+最後に受信した LED の状態を `led_t` として取得するためにこの関数を呼びます。これは、`led_update_*` の外部から、例えば [`matrix_scan_user()`](#matrix-scanning-code) の中で LED の状態を読み取るのに便利です。
+
+## 物理的な LED の状態の設定
+
+一部のキーボードの実装は、物理的な LED の状態を設定するための便利なメソッドを提供しています。
+
+### Ergodox キーボード
+
+Ergodox の実装は、個々の LED をオンあるいはオフにするために `ergodox_right_led_1`/`2`/`3_on`/`off()` と、インデックスによってそれらをオンあるいはオフにするために `ergodox_right_led_on`/`off(uint8_t led)` を提供します。
+
+さらに、LED の明度を指定することができます。全ての LED に同じ明度を指定するなら `ergodox_led_all_set(uint8_t n)` を使い、個別の LED の明度を指定するなら `ergodox_right_led_1`/`2`/`3_set(uint8_t n)` を使い、LED のインデックスを指定して明度を指定するには  `ergodox_right_led_set(uint8_t led, uint8_t n)` を使います。
+
+Ergodox キーボードは、最低の明度として `LED_BRIGHTNESS_LO` を、最高の輝度(これはデフォルトです)として `LED_BRIGHTNESS_HI` も定義しています。

docs/ja/feature_led_matrix.md

@@ -15,7 +15,8 @@ RGB LED を使いたい場合は、代わりに [RGB マトリックスサブシ
 
 I2C IS31FL3731 RGB コントローラを使ったアドレス指定可能な LED マトリックスライトのための基本的なサポートがあります:有効にするには、`rules.mk` に以下を追加します:
 
-    LED_MATRIX_ENABLE = IS31FL3731
+    LED_MATRIX_ENABLE = yes
+    LED_MATRIX_DRIVER = IS31FL3731
 
 1から4個の IS31FL3731 IC を使うことができます。キーボード上に存在しない IC の `LED_DRIVER_ADDR_<N>` 定義を指定しないでください。`config.h` に以下の項目を定義することができます:
 

docs/ja/feature_macros.md

@@ -187,7 +187,9 @@ void post_process_record_user(uint16_t keycode, keyrecord_t *record) {
 
 デフォルトでは、QWERTY レイアウトの US キーマップを想定しています; それを変更したい場合(例えば OS がソフトウェア Colemak を使う場合)、キーマップのどこかに以下を含めます:
 
-    #include <sendstring_colemak.h>
+```c
+#include "sendstring_colemak.h"
+```
 
 ### メモリ内の文字列
 

docs/ja/feature_rawhid.md

@@ -0,0 +1,74 @@
+# Raw HID
+
+<!---
+  original document: 0.10.47:docs/feature_rawhid.md
+  git diff 0.10.47 HEAD -- docs/feature_rawhid.md | cat
+-->
+
+Raw HID は、HID インタフェースを介して QMK とホストコンピュータ間の双方向通信を可能にします。これには、キーマップをその場で切り替えたり、RGB LED の色とモードを変更したりなど、多くの潜在的な使用方法があります。
+
+キーボードで raw HID を機能させるには、2つの主要なコンポーネントがあります。
+
+## キーボードファームウェア
+
+ファームウェアの実装はとても簡単です。
+`rules.mk` に以下を追加します:
+
+```make
+RAW_ENABLE = yes
+```
+
+`keymap.c` に `"raw_hid.h"` を include し、以下を実装します:
+
+```C
+void raw_hid_receive(uint8_t *data, uint8_t length) {
+    // ここにコードを書きます。data はホストから受信したパケットです。
+}
+```
+
+`"raw_hid.h"` ヘッダは、キーボードからホストにパケットを送信できる `void raw_hid_send(uint8_t *data, uint8_t length);` も宣言します。例として、全てのデータをホストに返すことで、ホストアプリケーションを構築する時のデバッグに使うこともできます。
+
+```C
+void raw_hid_receive(uint8_t *data, uint8_t length) {
+    raw_hid_send(data, length);
+}
+```
+
+`raw_hid_receive` はホストから最大長 `RAW_EPSIZE` の可変サイズのパケットを受信することができます。一方、`raw_hid_send` はパケットを厳密に `RAW_EPSIZE` の長さで送信するため、長さ `RAW_EPSIZE` のデータを使う必要があります。
+
+ホスト側での作業を進める前に、raw 対応のファームウェアを書き込むようにしてください。
+
+## ホスト (Windows/macOS/Linux)
+
+これは幾つかの掘り下げが必要になるため、より複雑な部分です。
+
+ホストコンピュータを raw HID を使ってキーボードに接続するには、キーボードについての4つの情報が必要です。
+
+1. Vendor ID
+2. Product ID
+3. Usage Page
+4. Usage
+
+前半の2つは、キーボードのメインディレクトリにあるキーボードの `config.h` で、`VENDOR_ID` と `PRODUCT_ID` で簡単に見つかります。
+
+後半の2つは、キーボードのメインディレクトリにあるキーボードの `config.h` で、値を再定義することで上書きすることができます: `#define RAW_USAGE_PAGE 0xFF60` と `#define RAW_USAGE_ID 0x61`。
+
+デフォルトでは、**Usage Page** は `0xFF60` で、**Usage** は `0x61` です。
+
+### ホストの構築
+
+独自に作成したくない場合は、利用可能な HID 実装ライブラリがある任意の言語を使ってホストを構築することができます。人気のある言語でよく使われるライブラリは以下の通りです:
+
+* Node: [node-hid](https://github.com/node-hid/node-hid)。
+* C: [hidapi](https://github.com/libusb/hidapi)。
+* Java: [purejavahidapi](https://github.com/nyholku/purejavahidapi) と [hid4java](https://github.com/gary-rowe/hid4java)。
+* Python: [pyhidapi](https://pypi.org/project/hid/)。
+
+これは完全なクロスプラットフォームのリストではありませんが、最初に始めるのに十分なはずです。raw HID を使うための特別な要件は無いため、どの HID ライブラリでも動作するはずです。
+
+これで、キーボードへの HID インタフェースを開くために必要な4つの情報全てが揃いました。必要なのは、ライブラリの利用可能な関数を使って ID パラメータを使ってデバイスを開くことだけです。
+
+Vendor ID と Product ID はデバイスを開くために実際には必要ないことに注意してください。それらは接続した多くの HID デバイスから特定のデバイスをフィルターするためだけに使われます。多くのライブラリでは、代わりに製品名と製造元名を使ってデバイスを開くオプションがあります。`node-hid` が代表的な例です。これは USB ハブが組み込まれているデバイスや、同じ製品名または同じ製造元の複数のインタフェースがある特別な HID インタフェースで問題になります。Product ID と Vendor ID を合わせると単一のインタフェースの固有名を作成できるため、この問題を防げます。したがって、ライブラリで必要が無い場合でも、この問題を防ぐためにそれらを使うことをお勧めします。
+ただし、Vendor ID や Product ID と異なり、Usage Page と Usage は通信を成功させるために必要です。
+
+言うまでもなく、使っているライブラリに関係なく、終了したらインタフェースを必ず閉じる必要があります。オペレーティングシステムと特定の環境によっては、明示的に接続が閉じられていない場合、後で他のクライアントまたは同じクライアントの他のインスタンスに接続しなおした時に問題が発生する可能性があります。

docs/ja/feature_userspace.md

@@ -189,7 +189,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 
 最初に、全ての `keymap.c` ファイルを調べ、代わりに `process_record_user` を `process_record_keymap` に置き換えます。この方法では、これらのキーボードでキーボード固有のコードを使用でき、カスタムの "global" キーコードも使うことができます。また、`SAFE_RANGE` を `NEW_SAFE_RANGE` に置き換えて、キーコードが重複しないようにすることもできます。
 
-次に、全ての keymap.c ファイルに `#include <name.h>` を追加します。これにより、各キーマップでそれらを再定義することなく新しいキーコードを使うことができます。
+次に、全ての keymap.c ファイルに `#include "<name>.h"` を追加します。これにより、各キーマップでそれらを再定義することなく新しいキーコードを使うことができます。
 
 それが完了したら、必要なキーコードの定義を `<name>.h` ファイルに設定します。例えば:
 ```c

docs/ja/internals_input_callback_reg.md

@@ -171,4 +171,3 @@
 * `device` 関連するデバイス
 
 * `func` 登録するコールバック関数
-

docs/ja/newbs_testing_debugging.md

@@ -45,7 +45,9 @@ void keyboard_post_init_user(void) {
 
 [custom code](ja/custom_quantum_functions.md)内からデバッグメッセージを出力すると便利な場合があります。それはとても簡単です。ファイルの先頭に`print.h`のインクルードを追加します:
 
-    #include <print.h>
+```c
+#include "print.h"
+```
 
 そのあとは、いくつかの異なった print 関数を使用することが出来ます。
 

docs/ja/reference_keymap_extras.md

@@ -51,6 +51,7 @@ HID Keyboard/Keypad usage ページでは 256 未満の usage が定義されて
 | Norwegian                   | `keymap_norwegian.h`             |
 | Polish                      | `keymap_polish.h`                |
 | Portuguese                  | `keymap_portuguese.h`            |
+| Portuguese (macOS, ISO)     | `keymap_portuguese_osx_iso.h`    |
 | Portuguese (Brazil)         | `keymap_br_abnt2.h`              |
 | Romanian                    | `keymap_romanian.h`              |
 | Russian*                    | `keymap_russian.h`               |

docs/keycodes.md

@@ -124,17 +124,17 @@ See also: [Basic Keycodes](keycodes_basic.md)
 |`KC_F22`               |                              |F22                                            |✔            |             |✔                |
 |`KC_F23`               |                              |F23                                            |✔            |             |✔                |
 |`KC_F24`               |                              |F24                                            |✔            |             |✔                |
-|`KC_EXECUTE`           |`KC_EXEC`                     |Execute                                        |            |             |✔                |
-|`KC_HELP`              |                              |Help                                           |            |             |✔                |
-|`KC_MENU`              |                              |Menu                                           |            |             |✔                |
-|`KC_SELECT`            |`KC_SLCT`                     |Select                                         |            |             |✔                |
-|`KC_STOP`              |                              |Stop                                           |            |             |✔                |
-|`KC_AGAIN`             |`KC_AGIN`                     |Again                                          |            |             |✔                |
-|`KC_UNDO`              |                              |Undo                                           |            |             |✔                |
-|`KC_CUT`               |                              |Cut                                            |            |             |✔                |
-|`KC_COPY`              |                              |Copy                                           |            |             |✔                |
-|`KC_PASTE`             |`KC_PSTE`                     |Paste                                          |            |             |✔                |
-|`KC_FIND`              |                              |Find                                           |            |             |✔                |
+|`KC_EXECUTE`           |`KC_EXEC`                     |Execute                                        |             |             |✔                |
+|`KC_HELP`              |                              |Help                                           |             |             |✔                |
+|`KC_MENU`              |                              |Menu                                           |             |             |✔                |
+|`KC_SELECT`            |`KC_SLCT`                     |Select                                         |             |             |✔                |
+|`KC_STOP`              |                              |Stop                                           |             |             |✔                |
+|`KC_AGAIN`             |`KC_AGIN`                     |Again                                          |             |             |✔                |
+|`KC_UNDO`              |                              |Undo                                           |             |             |✔                |
+|`KC_CUT`               |                              |Cut                                            |             |             |✔                |
+|`KC_COPY`              |                              |Copy                                           |             |             |✔                |
+|`KC_PASTE`             |`KC_PSTE`                     |Paste                                          |             |             |✔                |
+|`KC_FIND`              |                              |Find                                           |             |             |✔                |
 |`KC__MUTE`             |                              |Mute                                           |             |✔            |✔                |
 |`KC__VOLUP`            |                              |Volume Up                                      |             |✔            |✔                |
 |`KC__VOLDOWN`          |                              |Volume Down                                    |             |✔            |✔                |

docs/keycodes_basic.md

@@ -144,48 +144,48 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07
 
 ## Commands
 
-|Key               |Aliases                       |Description                   |
-|------------------|------------------------------|------------------------------|
-|`KC_PSCREEN`      |`KC_PSCR`                     |Print Screen                  |
-|`KC_PAUSE`        |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS)  |
-|`KC_INSERT`       |`KC_INS`                      |Insert                        |
-|`KC_HOME`         |                              |Home                          |
-|`KC_PGUP`         |                              |Page Up                       |
-|`KC_DELETE`       |`KC_DEL`                      |Forward Delete                |
-|`KC_END`          |                              |End                           |
-|`KC_PGDOWN`       |`KC_PGDN`                     |Page Down                     |
-|`KC_RIGHT`        |`KC_RGHT`                     |Right Arrow                   |
-|`KC_LEFT`         |                              |Left Arrow                    |
-|`KC_DOWN`         |                              |Down Arrow                    |
-|`KC_UP`           |                              |Up Arrow                      |
-|`KC_APPLICATION`  |`KC_APP`                      |Application (Windows Menu Key)|
-|`KC_POWER`        |                              |System Power (macOS/Linux)    |
-|`KC_EXECUTE`      |`KC_EXEC`                     |Execute                       |
-|`KC_HELP`         |                              |Help                          |
-|`KC_MENU`         |                              |Menu                          |
-|`KC_SELECT`       |`KC_SLCT`                     |Select                        |
-|`KC_STOP`         |                              |Stop                          |
-|`KC_AGAIN`        |`KC_AGIN`                     |Again                         |
-|`KC_UNDO`         |                              |Undo                          |
-|`KC_CUT`          |                              |Cut                           |
-|`KC_COPY`         |                              |Copy                          |
-|`KC_PASTE`        |`KC_PSTE`                     |Paste                         |
-|`KC_FIND`         |                              |Find                          |
-|`KC__MUTE`        |                              |Mute (macOS)                  |
-|`KC__VOLUP`       |                              |Volume Up (macOS)             |
-|`KC__VOLDOWN`     |                              |Volume Down (macOS)           |
-|`KC_ALT_ERASE`    |`KC_ERAS`                     |Alternate Erase               |
-|`KC_SYSREQ`       |                              |SysReq/Attention              |
-|`KC_CANCEL`       |                              |Cancel                        |
-|`KC_CLEAR`        |`KC_CLR`                      |Clear                         |
-|`KC_PRIOR`        |                              |Prior                         |
-|`KC_RETURN`       |                              |Return                        |
-|`KC_SEPARATOR`    |                              |Separator                     |
-|`KC_OUT`          |                              |Out                           |
-|`KC_OPER`         |                              |Oper                          |
-|`KC_CLEAR_AGAIN`  |                              |Clear/Again                   |
-|`KC_CRSEL`        |                              |CrSel/Props                   |
-|`KC_EXSEL`        |                              |ExSel                         |
+|Key               |Aliases                       |Description                           |
+|------------------|------------------------------|--------------------------------------|
+|`KC_PSCREEN`      |`KC_PSCR`                     |Print Screen                          |
+|`KC_PAUSE`        |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS)          |
+|`KC_INSERT`       |`KC_INS`                      |Insert                                |
+|`KC_HOME`         |                              |Home                                  |
+|`KC_PGUP`         |                              |Page Up                               |
+|`KC_DELETE`       |`KC_DEL`                      |Forward Delete                        |
+|`KC_END`          |                              |End                                   |
+|`KC_PGDOWN`       |`KC_PGDN`                     |Page Down                             |
+|`KC_RIGHT`        |`KC_RGHT`                     |Right Arrow                           |
+|`KC_LEFT`         |                              |Left Arrow                            |
+|`KC_DOWN`         |                              |Down Arrow                            |
+|`KC_UP`           |                              |Up Arrow                              |
+|`KC_APPLICATION`  |`KC_APP`                      |Application (Windows Context Menu Key)|
+|`KC_POWER`        |                              |System Power                          |
+|`KC_EXECUTE`      |`KC_EXEC`                     |Execute                               |
+|`KC_HELP`         |                              |Help                                  |
+|`KC_MENU`         |                              |Menu                                  |
+|`KC_SELECT`       |`KC_SLCT`                     |Select                                |
+|`KC_STOP`         |                              |Stop                                  |
+|`KC_AGAIN`        |`KC_AGIN`                     |Again                                 |
+|`KC_UNDO`         |                              |Undo                                  |
+|`KC_CUT`          |                              |Cut                                   |
+|`KC_COPY`         |                              |Copy                                  |
+|`KC_PASTE`        |`KC_PSTE`                     |Paste                                 |
+|`KC_FIND`         |                              |Find                                  |
+|`KC__MUTE`        |                              |Mute                                  |
+|`KC__VOLUP`       |                              |Volume Up                             |
+|`KC__VOLDOWN`     |                              |Volume Down                           |
+|`KC_ALT_ERASE`    |`KC_ERAS`                     |Alternate Erase                       |
+|`KC_SYSREQ`       |                              |SysReq/Attention                      |
+|`KC_CANCEL`       |                              |Cancel                                |
+|`KC_CLEAR`        |`KC_CLR`                      |Clear                                 |
+|`KC_PRIOR`        |                              |Prior                                 |
+|`KC_RETURN`       |                              |Return                                |
+|`KC_SEPARATOR`    |                              |Separator                             |
+|`KC_OUT`          |                              |Out                                   |
+|`KC_OPER`         |                              |Oper                                  |
+|`KC_CLEAR_AGAIN`  |                              |Clear/Again                           |
+|`KC_CRSEL`        |                              |CrSel/Props                           |
+|`KC_EXSEL`        |                              |ExSel                                 |
 
 ## Media Keys
 
@@ -193,34 +193,34 @@ These keycodes are not part of the Keyboard/Keypad usage page. The `SYSTEM_` key
 
 ?> Some of these keycodes may behave differently depending on the OS. For example, on macOS, the keycodes `KC_MEDIA_FAST_FORWARD`, `KC_MEDIA_REWIND`, `KC_MEDIA_NEXT_TRACK` and `KC_MEDIA_PREV_TRACK` skip within the current track when held, but skip the entire track when tapped.
 
-|Key                    |Aliases  |Description                  |
-|-----------------------|---------|-----------------------------|
-|`KC_SYSTEM_POWER`      |`KC_PWR` |System Power Down            |
-|`KC_SYSTEM_SLEEP`      |`KC_SLEP`|System Sleep                 |
-|`KC_SYSTEM_WAKE`       |`KC_WAKE`|System Wake                  |
-|`KC_AUDIO_MUTE`        |`KC_MUTE`|Mute                         |
-|`KC_AUDIO_VOL_UP`      |`KC_VOLU`|Volume Up                    |
-|`KC_AUDIO_VOL_DOWN`    |`KC_VOLD`|Volume Down                  |
-|`KC_MEDIA_NEXT_TRACK`  |`KC_MNXT`|Next Track                   |
-|`KC_MEDIA_PREV_TRACK`  |`KC_MPRV`|Previous Track               |
-|`KC_MEDIA_STOP`        |`KC_MSTP`|Stop Track (Windows)         |
-|`KC_MEDIA_PLAY_PAUSE`  |`KC_MPLY`|Play/Pause Track             |
-|`KC_MEDIA_SELECT`      |`KC_MSEL`|Launch Media Player (Windows)|
-|`KC_MEDIA_EJECT`       |`KC_EJCT`|Eject (macOS)                |
-|`KC_MAIL`              |         |Launch Mail (Windows)        |
-|`KC_CALCULATOR`        |`KC_CALC`|Launch Calculator (Windows)  |
-|`KC_MY_COMPUTER`       |`KC_MYCM`|Launch My Computer (Windows) |
-|`KC_WWW_SEARCH`        |`KC_WSCH`|Browser Search (Windows)     |
-|`KC_WWW_HOME`          |`KC_WHOM`|Browser Home (Windows)       |
-|`KC_WWW_BACK`          |`KC_WBAK`|Browser Back (Windows)       |
-|`KC_WWW_FORWARD`       |`KC_WFWD`|Browser Forward (Windows)    |
-|`KC_WWW_STOP`          |`KC_WSTP`|Browser Stop (Windows)       |
-|`KC_WWW_REFRESH`       |`KC_WREF`|Browser Refresh (Windows)    |
-|`KC_WWW_FAVORITES`     |`KC_WFAV`|Browser Favorites (Windows)  |
-|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track (macOS)           |
-|`KC_MEDIA_REWIND`      |`KC_MRWD`|Previous Track (macOS)       |
-|`KC_BRIGHTNESS_UP`     |`KC_BRIU`|Brightness Up                |
-|`KC_BRIGHTNESS_DOWN`   |`KC_BRID`|Brightness Down              |
+|Key                    |Aliases  |Description        |
+|-----------------------|---------|-------------------|
+|`KC_SYSTEM_POWER`      |`KC_PWR` |System Power Down  |
+|`KC_SYSTEM_SLEEP`      |`KC_SLEP`|System Sleep       |
+|`KC_SYSTEM_WAKE`       |`KC_WAKE`|System Wake        |
+|`KC_AUDIO_MUTE`        |`KC_MUTE`|Mute               |
+|`KC_AUDIO_VOL_UP`      |`KC_VOLU`|Volume Up          |
+|`KC_AUDIO_VOL_DOWN`    |`KC_VOLD`|Volume Down        |
+|`KC_MEDIA_NEXT_TRACK`  |`KC_MNXT`|Next Track         |
+|`KC_MEDIA_PREV_TRACK`  |`KC_MPRV`|Previous Track     |
+|`KC_MEDIA_STOP`        |`KC_MSTP`|Stop Track         |
+|`KC_MEDIA_PLAY_PAUSE`  |`KC_MPLY`|Play/Pause Track   |
+|`KC_MEDIA_SELECT`      |`KC_MSEL`|Launch Media Player|
+|`KC_MEDIA_EJECT`       |`KC_EJCT`|Eject              |
+|`KC_MAIL`              |         |Launch Mail        |
+|`KC_CALCULATOR`        |`KC_CALC`|Launch Calculator  |
+|`KC_MY_COMPUTER`       |`KC_MYCM`|Launch My Computer |
+|`KC_WWW_SEARCH`        |`KC_WSCH`|Browser Search     |
+|`KC_WWW_HOME`          |`KC_WHOM`|Browser Home       |
+|`KC_WWW_BACK`          |`KC_WBAK`|Browser Back       |
+|`KC_WWW_FORWARD`       |`KC_WFWD`|Browser Forward    |
+|`KC_WWW_STOP`          |`KC_WSTP`|Browser Stop       |
+|`KC_WWW_REFRESH`       |`KC_WREF`|Browser Refresh    |
+|`KC_WWW_FAVORITES`     |`KC_WFAV`|Browser Favorites  |
+|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track         |
+|`KC_MEDIA_REWIND`      |`KC_MRWD`|Previous Track     |
+|`KC_BRIGHTNESS_UP`     |`KC_BRIU`|Brightness Up      |
+|`KC_BRIGHTNESS_DOWN`   |`KC_BRID`|Brightness Down    |
 
 ## Number Pad
 
@@ -248,7 +248,7 @@ These keycodes are not part of the Keyboard/Keypad usage page. The `SYSTEM_` key
 
 ## Special Keys
 
-In addition to these, keycodes in the range of `0xA5-DF` are reserved for internal use by TMK.
+In addition to these, keycodes in the range of `0xA5-DF` are reserved for internal use.
 
 |Key             |Aliases             |Description                            |
 |----------------|--------------------|---------------------------------------|

docs/newbs_getting_started.md

@@ -37,56 +37,134 @@ We've tried to make QMK as easy to set up as possible. You only have to prepare
 [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<br>
 [Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
 
-### Windows
+<!-- tabs:start -->
 
-You will need to install MSYS2, Git, and the QMK CLI.
+### ** Windows **
 
-Follow the installation instructions on the [MSYS2 homepage](http://www.msys2.org). Close any open MSYS terminals and open a new MinGW 64-bit terminal. **NOTE: This is *not* the same as the MSYS terminal that opens when installation is completed.**
+QMK maintains a Bundle of MSYS2, the CLI and all necessary dependencies. It also provides a handy `QMK MSYS` terminal shortcut to boot you directly into the correct environment.
 
-Then, run the following:
+#### Prerequisites
+
+You will need to install `QMK MSYS`. The latest release is available at https://msys.qmk.fm/.
+
+Alternatively, if you'd like to manually install msys2, the following section will walk you through the process.
+
+<details>
+  <summary>Manual Install</summary>
+
+?> Ignore the following steps if you use `QMK MSYS`.
+
+#### Prerequisites
+
+You will need to install MSYS2, Git and Python. Follow the installation instructions on https://www.msys2.org.
+
+Once MSYS2 is installed, close any open MSYS terminals and open a new MinGW 64-bit terminal.
+
+!> **NOTE:** The MinGW 64-bit terminal is *not* the same as the MSYS terminal that opens when installation is completed. Your prompt should say "MINGW64" in purple text, rather than "MSYS". See [this page](https://www.msys2.org/wiki/MSYS2-introduction/#subsystems) for more information on the differences.
+
+Then run the following command:
 
     pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-toolchain mingw-w64-x86_64-python3-pip
+
+#### Installation
+
+Install the QMK CLI by running:
+
     python3 -m pip install qmk
 
-### macOS
+</details>
 
-You will need to install Homebrew. Follow the instructions on the [Homebrew homepage](https://brew.sh).
+### ** macOS **
 
-After Homebrew is installed run this command:
+QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies.
+
+#### Prerequisites
+
+You will need to install Homebrew. Follow the instructions on https://brew.sh.
+
+#### Installation
+
+Install the QMK CLI by running:
 
     brew install qmk/qmk/qmk
 
-### Linux
+### ** Linux/WSL **
+
+#### Prerequisites
 
 You will need to install Git and Python. It's very likely that you already have both, but if not, one of the following commands should install them:
 
-* Debian / Ubuntu / Devuan: `sudo apt install git python3 python3-pip`
-* Fedora / Red Hat / CentOS: `sudo yum install git python3 python3-pip`
-* Arch / Manjaro: `sudo pacman -S git python python-pip python-setuptools libffi`
+* Debian / Ubuntu / Devuan: `sudo apt install -y git python3-pip`
+* Fedora / Red Hat / CentOS: `sudo yum -y install git python3-pip`
+* Arch / Manjaro: `sudo pacman --needed --noconfirm -S git python-pip libffi`
+* Void: `sudo xbps-install -y git python3-pip`
+* Solus: `sudo eopkg -y install git python3`
+* Sabayon: `sudo equo install dev-vcs/git dev-python/pip`
+* Gentoo: `sudo emerge dev-vcs/git dev-python/pip`
 
-Install the global CLI to bootstrap your system:
+#### Installation
 
-`python3 -m pip install --user qmk` (on Arch-based distros you can also try the `qmk` package from AUR (**note**: it's maintained by a community member): `yay -S qmk`)
+Install the QMK CLI by running:
 
-### FreeBSD
+    python3 -m pip install --user qmk
+
+#### Community Packages
+
+These packages are maintained by community members, so may not be up to date or completely functional. If you encounter problems, please report them to their respective maintainers.
+
+On Arch-based distros you can install the CLI from the official repositories (NOTE: at the time of writing this package marks some dependencies as optional that should not be):
+
+    sudo pacman -S qmk
+
+You can also try the `qmk-git` package from AUR:
+
+    yay -S qmk-git
+
+###  ** FreeBSD **
+
+#### Prerequisites
 
 You will need to install Git and Python. It's possible that you already have both, but if not, run the following commands to install them:
 
     pkg install git python3
 
-Make sure that `$HOME/.local/bin` is added to your `$PATH` so that locally install Python packages are available.
+Make sure that `$HOME/.local/bin` is added to your `$PATH` so that locally installed Python packages are available.
 
-Once installed, you can install QMK CLI:
+#### Installation
+
+Install the QMK CLI by running:
 
     python3 -m pip install --user qmk
 
+<!-- tabs:end -->
+
 ## 3. Run QMK Setup :id=set-up-qmk
 
+<!-- tabs:start -->
+
+### ** Windows **
+
 After installing QMK you can set it up with this command:
 
     qmk setup
 
-In most situations you will want to answer Yes to all of the prompts.
+In most situations you will want to answer `y` to all of the prompts.
+
+### ** macOS **
+
+After installing QMK you can set it up with this command:
+
+    qmk setup
+
+In most situations you will want to answer `y` to all of the prompts.
+
+### ** Linux/WSL **
+
+After installing QMK you can set it up with this command:
+
+    qmk setup
+
+In most situations you will want to answer `y` to all of the prompts.
 
 ?>**Note on Debian, Ubuntu and their derivatives**:
 It's possible, that you will get an error saying something like: `bash: qmk: command not found`.
@@ -94,12 +172,22 @@ This is due to a [bug](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=839155)
 Sadly, Ubuntu reitroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562).
 Luckily, the fix is easy. Run this as your user: `echo 'PATH="$HOME/.local/bin:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc`
 
+###  ** FreeBSD **
+
+After installing QMK you can set it up with this command:
+
+    qmk setup
+
+In most situations you will want to answer `y` to all of the prompts.
+
 ?>**Note on FreeBSD**:
 It is suggested to run `qmk setup` as a non-`root` user to start with, but this will likely identify packages that need to be installed to your
 base system using `pkg`. However the installation will probably fail when run as an unprivileged user.
 To manually install the base dependencies, run `./util/qmk_install.sh` either as `root`, or with `sudo`.
 Once that completes, re-run `qmk setup` to complete the setup and checks.
 
+<!-- tabs:end -->
+
 ?> If you already know [how to use GitHub](getting_started_github.md), we recommend that you create your own fork and use `qmk setup <github_username>/qmk_firmware` to clone your personal fork. If you don't know what that means you can safely ignore this message.
 
 ## 4. Test Your Build Environment

docs/newbs_testing_debugging.md

@@ -36,7 +36,9 @@ Prefer a terminal based solution? [hid_listen](https://www.pjrc.com/teensy/hid_l
 
 Sometimes it's useful to print debug messages from within your [custom code](custom_quantum_functions.md). Doing so is pretty simple. Start by including `print.h` at the top of your file:
 
-    #include <print.h>
+```c
+#include "print.h"
+```
 
 After that you can use a few different print functions:
 

docs/one_shot_keys.md

@@ -22,7 +22,7 @@ Sometimes, you want to activate a one-shot key as part of a macro or tap dance r
 
 For one shot layers, you need to call `set_oneshot_layer(LAYER, ONESHOT_START)` on key down, and `clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED)` on key up. If you want to cancel the oneshot, call `reset_oneshot_layer()`.
 
-For one shot mods, you need to call `set_oneshot_mods(MOD)` to set it, or `clear_oneshot_mods()` to cancel it.
+For one shot mods, you need to call `set_oneshot_mods(MOD_BIT(KC_*))` to set it, or `clear_oneshot_mods()` to cancel it.
 
 !> If you're having issues with OSM translating over Remote Desktop Connection, this can be fixed by opening the settings, going to the "Local Resources" tap, and in the keyboard section, change the drop down to "On this Computer".  This will fix the issue and allow OSM to function properly over Remote Desktop.
 

docs/platformdev_chibios_earlyinit.md

@@ -61,4 +61,4 @@ To implement your own version of this function, in your keyboard's source files:
 void board_init(void) {
     // initialize anything that requires ChibiOS
 }
-```
+```

docs/qmk_custom_dark.css

@@ -27,3 +27,20 @@
 .markdown-section hr, .search {
     border-bottom: 1px solid #777 !important;
 }
+
+
+:root {
+    --docsifytabs-border-color: #555;
+    --docsifytabs-tab-highlight-color: var(--theme-color,#ea6f5a);
+
+    --docsifytabs-tab-background: #444;
+    --docsifytabs-tab-background-active: #3f3f3f;
+}
+
+.docsify-tabs__tab:focus {
+    outline: none !important;
+}
+
+.docsify-tabs__content .anchor {
+    transition: none;
+}

docs/qmk_custom_light.css

@@ -28,3 +28,20 @@
 .markdown-section pre {
   padding: 0;
 }
+
+
+:root {
+  --docsifytabs-border-color: #ddd;
+  --docsifytabs-tab-highlight-color: var(--theme-color, #0074d9);
+
+  --docsifytabs-tab-background: #f8f8f8;
+  --docsifytabs-tab-background-active: transparent;
+}
+
+.docsify-tabs__tab:focus {
+  outline: none !important;
+}
+
+.docsify-tabs__content .anchor {
+  transition: none;
+}

docs/reference_keymap_extras.md

@@ -46,6 +46,7 @@ To use these, simply `#include` the corresponding [header file](https://github.c
 |Norwegian                  |`keymap_norwegian.h`            |
 |Polish                     |`keymap_polish.h`               |
 |Portuguese                 |`keymap_portuguese.h`           |
+|Portuguese (macOS, ISO)    |`keymap_portuguese_osx_iso.h`   |
 |Portuguese (Brazil)        |`keymap_br_abnt2.h`             |
 |Romanian                   |`keymap_romanian.h`             |
 |Russian*                   |`keymap_russian.h`              |

docs/tap_hold.md

@@ -179,6 +179,25 @@ Holding and releasing a dual function key without pressing another key will resu
 
 For instance, holding and releasing `LT(2, KC_SPACE)` without hitting another key will result in nothing happening. With this enabled, it will send `KC_SPACE` instead.
 
+For more granular control of this feature, you can add the following to your `config.h`:
+
+```c
+#define RETRO_TAPPING_PER_KEY
+```
+
+You can then add the following function to your keymap:
+
+```c
+bool get_retro_tapping(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case LT(2, KC_SPACE):
+            return true;
+        default:
+            return false;
+    }
+}
+```
+
 ## Why do we include the key record for the per key functions?
 
 One thing that you may notice is that we include the key record for all of the "per key" functions, and may be wondering why we do that.

docs/ws2812_driver.md

@@ -28,6 +28,17 @@ The default setting is 280 µs, which should work for most cases, but this can b
 #define WS2812_TRST_US 80
 ```
 
+#### Byte Order
+
+Some variants of the WS2812 may have their color components in a different physical or logical order. For example, the WS2812B-2020 has physically swapped red and green LEDs, which causes the wrong color to be displayed, because the default order of the bytes sent over the wire is defined as GRB.
+In this case, you can change the byte order by defining `WS2812_BYTE_ORDER` as one of the following values:
+
+| Byte order                        | Known devices                 |
+|-----------------------------------|-------------------------------|
+| `WS2812_BYTE_ORDER_GRB` (default) | Most WS2812's, SK6812, SK6805 |
+| `WS2812_BYTE_ORDER_RGB`           | WS2812B-2020                  |
+
+
 ### Bitbang
 Default driver, the absence of configuration assumes this driver. To configure it, add this to your rules.mk:
 

docs/zh-cn/newbs_testing_debugging.md

@@ -34,7 +34,9 @@ void keyboard_post_init_user(void) {
 
 有时用[custom code](custom_quantum_functions.md)发送自定义调试信息很有用. 这么做很简单. 首先在你文件头部包含`print.h`:
 
-    #include <print.h>
+```c
+#include "print.h"
+```
 
 之后，您可以使用一些不同的打印功能:
 

drivers/avr/hd44780.h

@@ -1,5 +1,3 @@
-#ifndef LCD_H
-#define LCD_H
 /*************************************************************************
  Title	:   C include file for the HD44780U LCD library (lcd.c)
  Author:    Peter Fleury <pfleury@gmx.ch>  http://tinyurl.com/peterfleury
@@ -43,6 +41,8 @@
 
 */
 
+#pragma once
+
 #include <inttypes.h>
 #include <avr/pgmspace.h>
 
@@ -346,5 +346,3 @@ extern void lcd_data(uint8_t data);
 #define lcd_puts_P(__s) lcd_puts_p(PSTR(__s))
 
 /**@}*/
-
-#endif  // LCD_H

drivers/avr/i2c_master.h

@@ -17,8 +17,7 @@
  * GitHub repository: https://github.com/g4lvanix/I2C-master-lib
  */
 
-#ifndef I2C_MASTER_H
-#define I2C_MASTER_H
+#pragma once
 
 #define I2C_READ 0x01
 #define I2C_WRITE 0x00
@@ -42,5 +41,3 @@ i2c_status_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16
 i2c_status_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout);
 i2c_status_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);
 void         i2c_stop(void);
-
-#endif  // I2C_MASTER_H

drivers/avr/i2c_slave.h

@@ -20,8 +20,7 @@
        Read or write to the necessary buffer according to the opperation.
  */
 
-#ifndef I2C_SLAVE_H
-#define I2C_SLAVE_H
+#pragma once
 
 #define I2C_SLAVE_REG_COUNT 30
 
@@ -29,5 +28,3 @@ extern volatile uint8_t i2c_slave_reg[I2C_SLAVE_REG_COUNT];
 
 void i2c_slave_init(uint8_t address);
 void i2c_slave_stop(void);
-
-#endif  // I2C_SLAVE_H

drivers/avr/serial.c

@@ -20,50 +20,111 @@
 
 #ifdef SOFT_SERIAL_PIN
 
-#    ifdef __AVR_ATmega32U4__
-// if using ATmega32U4 I2C, can not use PD0 and PD1 in soft serial.
-#        ifdef USE_AVR_I2C
-#            if SOFT_SERIAL_PIN == D0 || SOFT_SERIAL_PIN == D1
-#                error Using ATmega32U4 I2C, so can not use PD0, PD1
-#            endif
+#    if !(defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
+#        error serial.c is not supported for the currently selected MCU
+#    endif
+// if using ATmega32U4/2, AT90USBxxx I2C, can not use PD0 and PD1 in soft serial.
+#    if defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)
+#        if defined(USE_AVR_I2C) && (SOFT_SERIAL_PIN == D0 || SOFT_SERIAL_PIN == D1)
+#            error Using I2C, so can not use PD0, PD1
 #        endif
+#    endif
+// PD0..PD3, common config
+#    if SOFT_SERIAL_PIN == D0
+#        define EIMSK_BIT _BV(INT0)
+#        define EICRx_BIT (~(_BV(ISC00) | _BV(ISC01)))
+#        define SERIAL_PIN_INTERRUPT INT0_vect
+#        define EICRx EICRA
+#    elif SOFT_SERIAL_PIN == D1
+#        define EIMSK_BIT _BV(INT1)
+#        define EICRx_BIT (~(_BV(ISC10) | _BV(ISC11)))
+#        define SERIAL_PIN_INTERRUPT INT1_vect
+#        define EICRx EICRA
+#    elif SOFT_SERIAL_PIN == D2
+#        define EIMSK_BIT _BV(INT2)
+#        define EICRx_BIT (~(_BV(ISC20) | _BV(ISC21)))
+#        define SERIAL_PIN_INTERRUPT INT2_vect
+#        define EICRx EICRA
+#    elif SOFT_SERIAL_PIN == D3
+#        define EIMSK_BIT _BV(INT3)
+#        define EICRx_BIT (~(_BV(ISC30) | _BV(ISC31)))
+#        define SERIAL_PIN_INTERRUPT INT3_vect
+#        define EICRx EICRA
+#    endif
 
-#        define setPinInputHigh(pin) (DDRx_ADDRESS(pin) &= ~_BV((pin)&0xF), PORTx_ADDRESS(pin) |= _BV((pin)&0xF))
-#        define setPinOutput(pin) (DDRx_ADDRESS(pin) |= _BV((pin)&0xF))
-#        define writePinHigh(pin) (PORTx_ADDRESS(pin) |= _BV((pin)&0xF))
-#        define writePinLow(pin) (PORTx_ADDRESS(pin) &= ~_BV((pin)&0xF))
-#        define readPin(pin) ((bool)(PINx_ADDRESS(pin) & _BV((pin)&0xF)))
+// ATmegaxxU2 specific config
+#    if defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__)
+// PD4(INT5), PD6(INT6), PD7(INT7), PC7(INT4)
+#        if SOFT_SERIAL_PIN == D4
+#            define EIMSK_BIT _BV(INT5)
+#            define EICRx_BIT (~(_BV(ISC50) | _BV(ISC51)))
+#            define SERIAL_PIN_INTERRUPT INT5_vect
+#            define EICRx EICRB
+#        elif SOFT_SERIAL_PIN == D6
+#            define EIMSK_BIT _BV(INT6)
+#            define EICRx_BIT (~(_BV(ISC60) | _BV(ISC61)))
+#            define SERIAL_PIN_INTERRUPT INT6_vect
+#            define EICRx EICRB
+#        elif SOFT_SERIAL_PIN == D7
+#            define EIMSK_BIT _BV(INT7)
+#            define EICRx_BIT (~(_BV(ISC70) | _BV(ISC71)))
+#            define SERIAL_PIN_INTERRUPT INT7_vect
+#            define EICRx EICRB
+#        elif SOFT_SERIAL_PIN == C7
+#            define EIMSK_BIT _BV(INT4)
+#            define EICRx_BIT (~(_BV(ISC40) | _BV(ISC41)))
+#            define SERIAL_PIN_INTERRUPT INT4_vect
+#            define EICRx EICRB
+#        endif
+#    endif
 
-#        if SOFT_SERIAL_PIN >= D0 && SOFT_SERIAL_PIN <= D3
-#            if SOFT_SERIAL_PIN == D0
-#                define EIMSK_BIT _BV(INT0)
-#                define EICRx_BIT (~(_BV(ISC00) | _BV(ISC01)))
-#                define SERIAL_PIN_INTERRUPT INT0_vect
-#            elif SOFT_SERIAL_PIN == D1
-#                define EIMSK_BIT _BV(INT1)
-#                define EICRx_BIT (~(_BV(ISC10) | _BV(ISC11)))
-#                define SERIAL_PIN_INTERRUPT INT1_vect
-#            elif SOFT_SERIAL_PIN == D2
-#                define EIMSK_BIT _BV(INT2)
-#                define EICRx_BIT (~(_BV(ISC20) | _BV(ISC21)))
-#                define SERIAL_PIN_INTERRUPT INT2_vect
-#            elif SOFT_SERIAL_PIN == D3
-#                define EIMSK_BIT _BV(INT3)
-#                define EICRx_BIT (~(_BV(ISC30) | _BV(ISC31)))
-#                define SERIAL_PIN_INTERRUPT INT3_vect
-#            endif
+// ATmegaxxU4 specific config
+#    if defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__)
+// PE6(INT6)
+#        if SOFT_SERIAL_PIN == E6
+#            define EIMSK_BIT _BV(INT6)
+#            define EICRx_BIT (~(_BV(ISC60) | _BV(ISC61)))
+#            define SERIAL_PIN_INTERRUPT INT6_vect
+#            define EICRx EICRB
+#        endif
+#    endif
+
+// AT90USBxxx specific config
+#    if defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)
+// PE4..PE7(INT4..INT7)
+#        if SOFT_SERIAL_PIN == E4
+#            define EIMSK_BIT _BV(INT4)
+#            define EICRx_BIT (~(_BV(ISC40) | _BV(ISC41)))
+#            define SERIAL_PIN_INTERRUPT INT4_vect
+#            define EICRx EICRB
+#        elif SOFT_SERIAL_PIN == E5
+#            define EIMSK_BIT _BV(INT5)
+#            define EICRx_BIT (~(_BV(ISC50) | _BV(ISC51)))
+#            define SERIAL_PIN_INTERRUPT INT5_vect
+#            define EICRx EICRB
 #        elif SOFT_SERIAL_PIN == E6
 #            define EIMSK_BIT _BV(INT6)
 #            define EICRx_BIT (~(_BV(ISC60) | _BV(ISC61)))
 #            define SERIAL_PIN_INTERRUPT INT6_vect
-#        else
-#            error invalid SOFT_SERIAL_PIN value
+#            define EICRx EICRB
+#        elif SOFT_SERIAL_PIN == E7
+#            define EIMSK_BIT _BV(INT7)
+#            define EICRx_BIT (~(_BV(ISC70) | _BV(ISC71)))
+#            define SERIAL_PIN_INTERRUPT INT7_vect
+#            define EICRx EICRB
 #        endif
-
-#    else
-#        error serial.c now support ATmega32U4 only
 #    endif
 
+#    ifndef SERIAL_PIN_INTERRUPT
+#        error invalid SOFT_SERIAL_PIN value
+#    endif
+
+#    define setPinInputHigh(pin) (DDRx_ADDRESS(pin) &= ~_BV((pin)&0xF), PORTx_ADDRESS(pin) |= _BV((pin)&0xF))
+#    define setPinOutput(pin) (DDRx_ADDRESS(pin) |= _BV((pin)&0xF))
+#    define writePinHigh(pin) (PORTx_ADDRESS(pin) |= _BV((pin)&0xF))
+#    define writePinLow(pin) (PORTx_ADDRESS(pin) &= ~_BV((pin)&0xF))
+#    define readPin(pin) ((bool)(PINx_ADDRESS(pin) & _BV((pin)&0xF)))
+
 #    define ALWAYS_INLINE __attribute__((always_inline))
 #    define NO_INLINE __attribute__((noinline))
 #    define _delay_sub_us(x) __builtin_avr_delay_cycles(x)
@@ -210,15 +271,9 @@ void soft_serial_target_init(SSTD_t *sstd_table, int sstd_table_size) {
     Transaction_table_size = (uint8_t)sstd_table_size;
     serial_input_with_pullup();
 
-    // Enable INT0-INT3,INT6
+    // Enable INT0-INT7
     EIMSK |= EIMSK_BIT;
-#    if SOFT_SERIAL_PIN == E6
-    // Trigger on falling edge of INT6
-    EICRB &= EICRx_BIT;
-#    else
-    // Trigger on falling edge of INT0-INT3
-    EICRA &= EICRx_BIT;
-#    endif
+    EICRx &= EICRx_BIT;
 }
 
 // Used by the sender to synchronize timing with the reciver.

drivers/avr/spi_master.c

@@ -140,27 +140,33 @@ spi_status_t spi_read() {
 }
 
 spi_status_t spi_transmit(const uint8_t *data, uint16_t length) {
-    spi_status_t status = SPI_STATUS_ERROR;
+    spi_status_t status;
 
     for (uint16_t i = 0; i < length; i++) {
         status = spi_write(data[i]);
+
+        if (status < 0) {
+            return status;
+        }
     }
 
-    return status;
+    return SPI_STATUS_SUCCESS;
 }
 
 spi_status_t spi_receive(uint8_t *data, uint16_t length) {
-    spi_status_t status = SPI_STATUS_ERROR;
+    spi_status_t status;
 
     for (uint16_t i = 0; i < length; i++) {
         status = spi_read();
 
-        if (status > 0) {
+        if (status >= 0) {
             data[i] = status;
+        } else {
+            return status;
         }
     }
 
-    return (status < 0) ? status : SPI_STATUS_SUCCESS;
+    return SPI_STATUS_SUCCESS;
 }
 
 void spi_stop(void) {

drivers/avr/ssd1306.h

@@ -1,5 +1,4 @@
-#ifndef SSD1306_H
-#define SSD1306_H
+#pragma once
 
 #include <stdbool.h>
 #include <stdio.h>
@@ -86,5 +85,3 @@ void matrix_write_char(struct CharacterMatrix *matrix, uint8_t c);
 void matrix_write(struct CharacterMatrix *matrix, const char *data);
 void matrix_write_P(struct CharacterMatrix *matrix, const char *data);
 void matrix_render(struct CharacterMatrix *matrix);
-
-#endif

drivers/chibios/analog.c

@@ -16,7 +16,7 @@
 
 #include "quantum.h"
 #include "analog.h"
-#include "ch.h"
+#include <ch.h>
 #include <hal.h>
 
 #if !HAL_USE_ADC

drivers/chibios/i2c_master.c

@@ -58,18 +58,23 @@ static i2c_status_t chibios_to_qmk(const msg_t* status) {
 }
 
 __attribute__((weak)) void i2c_init(void) {
-    // Try releasing special pins for a short time
-    palSetPadMode(I2C1_SCL_BANK, I2C1_SCL, PAL_MODE_INPUT);
-    palSetPadMode(I2C1_SDA_BANK, I2C1_SDA, PAL_MODE_INPUT);
+    static bool is_initialised = false;
+    if (!is_initialised) {
+        is_initialised = true;
 
-    chThdSleepMilliseconds(10);
+        // Try releasing special pins for a short time
+        palSetPadMode(I2C1_SCL_BANK, I2C1_SCL, PAL_MODE_INPUT);
+        palSetPadMode(I2C1_SDA_BANK, I2C1_SDA, PAL_MODE_INPUT);
+
+        chThdSleepMilliseconds(10);
 #if defined(USE_GPIOV1)
-    palSetPadMode(I2C1_SCL_BANK, I2C1_SCL, I2C1_SCL_PAL_MODE);
-    palSetPadMode(I2C1_SDA_BANK, I2C1_SDA, I2C1_SDA_PAL_MODE);
+        palSetPadMode(I2C1_SCL_BANK, I2C1_SCL, I2C1_SCL_PAL_MODE);
+        palSetPadMode(I2C1_SDA_BANK, I2C1_SDA, I2C1_SDA_PAL_MODE);
 #else
-    palSetPadMode(I2C1_SCL_BANK, I2C1_SCL, PAL_MODE_ALTERNATE(I2C1_SCL_PAL_MODE) | PAL_STM32_OTYPE_OPENDRAIN);
-    palSetPadMode(I2C1_SDA_BANK, I2C1_SDA, PAL_MODE_ALTERNATE(I2C1_SDA_PAL_MODE) | PAL_STM32_OTYPE_OPENDRAIN);
+        palSetPadMode(I2C1_SCL_BANK, I2C1_SCL, PAL_MODE_ALTERNATE(I2C1_SCL_PAL_MODE) | PAL_STM32_OTYPE_OPENDRAIN);
+        palSetPadMode(I2C1_SDA_BANK, I2C1_SDA, PAL_MODE_ALTERNATE(I2C1_SDA_PAL_MODE) | PAL_STM32_OTYPE_OPENDRAIN);
 #endif
+    }
 }
 
 i2c_status_t i2c_start(uint8_t address) {

drivers/chibios/i2c_master.h

@@ -24,7 +24,7 @@
  */
 #pragma once
 
-#include "ch.h"
+#include <ch.h>
 #include <hal.h>
 
 #ifdef I2C1_BANK

drivers/chibios/serial.c

@@ -6,7 +6,7 @@
 #include "serial.h"
 #include "wait.h"
 
-#include "hal.h"
+#include <hal.h>
 
 // TODO: resolve/remove build warnings
 #if defined(RGBLIGHT_ENABLE) && defined(RGBLED_SPLIT) && defined(PROTOCOL_CHIBIOS) && defined(WS2812_DRIVER_BITBANG)

drivers/chibios/serial_usart.c

@@ -1,9 +1,9 @@
 #include "quantum.h"
 #include "serial.h"
-#include "printf.h"
+#include "print.h"
 
-#include "ch.h"
-#include "hal.h"
+#include <ch.h>
+#include <hal.h>
 
 #ifndef USART_CR1_M0
 #    define USART_CR1_M0 USART_CR1_M  // some platforms (f1xx) dont have this so

drivers/chibios/spi_master.c

@@ -22,21 +22,26 @@ static pin_t     currentSlavePin = NO_PIN;
 static SPIConfig spiConfig       = {false, NULL, 0, 0, 0, 0};
 
 __attribute__((weak)) void spi_init(void) {
-    // Try releasing special pins for a short time
-    palSetPadMode(PAL_PORT(SPI_SCK_PIN), PAL_PAD(SPI_SCK_PIN), PAL_MODE_INPUT);
-    palSetPadMode(PAL_PORT(SPI_MOSI_PIN), PAL_PAD(SPI_MOSI_PIN), PAL_MODE_INPUT);
-    palSetPadMode(PAL_PORT(SPI_MISO_PIN), PAL_PAD(SPI_MISO_PIN), PAL_MODE_INPUT);
+    static bool is_initialised = false;
+    if (!is_initialised) {
+        is_initialised = true;
 
-    chThdSleepMilliseconds(10);
+        // Try releasing special pins for a short time
+        palSetPadMode(PAL_PORT(SPI_SCK_PIN), PAL_PAD(SPI_SCK_PIN), PAL_MODE_INPUT);
+        palSetPadMode(PAL_PORT(SPI_MOSI_PIN), PAL_PAD(SPI_MOSI_PIN), PAL_MODE_INPUT);
+        palSetPadMode(PAL_PORT(SPI_MISO_PIN), PAL_PAD(SPI_MISO_PIN), PAL_MODE_INPUT);
+
+        chThdSleepMilliseconds(10);
 #if defined(USE_GPIOV1)
-    palSetPadMode(PAL_PORT(SPI_SCK_PIN), PAL_PAD(SPI_SCK_PIN), PAL_MODE_STM32_ALTERNATE_PUSHPULL);
-    palSetPadMode(PAL_PORT(SPI_MOSI_PIN), PAL_PAD(SPI_MOSI_PIN), PAL_MODE_STM32_ALTERNATE_PUSHPULL);
-    palSetPadMode(PAL_PORT(SPI_MISO_PIN), PAL_PAD(SPI_MISO_PIN), PAL_MODE_STM32_ALTERNATE_PUSHPULL);
+        palSetPadMode(PAL_PORT(SPI_SCK_PIN), PAL_PAD(SPI_SCK_PIN), PAL_MODE_STM32_ALTERNATE_PUSHPULL);
+        palSetPadMode(PAL_PORT(SPI_MOSI_PIN), PAL_PAD(SPI_MOSI_PIN), PAL_MODE_STM32_ALTERNATE_PUSHPULL);
+        palSetPadMode(PAL_PORT(SPI_MISO_PIN), PAL_PAD(SPI_MISO_PIN), PAL_MODE_STM32_ALTERNATE_PUSHPULL);
 #else
-    palSetPadMode(PAL_PORT(SPI_SCK_PIN), PAL_PAD(SPI_SCK_PIN), PAL_MODE_ALTERNATE(SPI_SCK_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL | PAL_STM32_OSPEED_HIGHEST);
-    palSetPadMode(PAL_PORT(SPI_MOSI_PIN), PAL_PAD(SPI_MOSI_PIN), PAL_MODE_ALTERNATE(SPI_MOSI_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL | PAL_STM32_OSPEED_HIGHEST);
-    palSetPadMode(PAL_PORT(SPI_MISO_PIN), PAL_PAD(SPI_MISO_PIN), PAL_MODE_ALTERNATE(SPI_MISO_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL | PAL_STM32_OSPEED_HIGHEST);
+        palSetPadMode(PAL_PORT(SPI_SCK_PIN), PAL_PAD(SPI_SCK_PIN), PAL_MODE_ALTERNATE(SPI_SCK_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL | PAL_STM32_OSPEED_HIGHEST);
+        palSetPadMode(PAL_PORT(SPI_MOSI_PIN), PAL_PAD(SPI_MOSI_PIN), PAL_MODE_ALTERNATE(SPI_MOSI_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL | PAL_STM32_OSPEED_HIGHEST);
+        palSetPadMode(PAL_PORT(SPI_MISO_PIN), PAL_PAD(SPI_MISO_PIN), PAL_MODE_ALTERNATE(SPI_MISO_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL | PAL_STM32_OSPEED_HIGHEST);
 #endif
+    }
 }
 
 bool spi_start(pin_t slavePin, bool lsbFirst, uint8_t mode, uint16_t divisor) {
@@ -110,11 +115,17 @@ bool spi_start(pin_t slavePin, bool lsbFirst, uint8_t mode, uint16_t divisor) {
     return true;
 }
 
-spi_status_t spi_write(uint8_t data) { return spi_transmit(&data, 1); }
+spi_status_t spi_write(uint8_t data) {
+    uint8_t rxData;
+    spiExchange(&SPI_DRIVER, 1, &data, &rxData);
+
+    return rxData;
+}
 
 spi_status_t spi_read(void) {
     uint8_t data = 0;
-    spi_receive(&data, 1);
+    spiReceive(&SPI_DRIVER, 1, &data);
+
     return data;
 }
 

drivers/chibios/spi_master.h

@@ -18,7 +18,7 @@
 
 #include <ch.h>
 #include <hal.h>
-#include <quantum.h>
+#include "quantum.h"
 
 #ifndef SPI_DRIVER
 #    define SPI_DRIVER SPID2

drivers/chibios/ws2812.c

@@ -1,7 +1,7 @@
 #include "quantum.h"
 #include "ws2812.h"
-#include "ch.h"
-#include "hal.h"
+#include <ch.h>
+#include <hal.h>
 
 /* Adapted from https://github.com/bigjosh/SimpleNeoPixelDemo/ */
 
@@ -89,9 +89,16 @@ void ws2812_setleds(LED_TYPE *ledarray, uint16_t leds) {
 
     for (uint8_t i = 0; i < leds; i++) {
         // WS2812 protocol dictates grb order
+#if (WS2812_BYTE_ORDER == WS2812_BYTE_ORDER_GRB)
         sendByte(ledarray[i].g);
         sendByte(ledarray[i].r);
         sendByte(ledarray[i].b);
+#elif (WS2812_BYTE_ORDER == WS2812_BYTE_ORDER_RGB)
+        sendByte(ledarray[i].r);
+        sendByte(ledarray[i].g);
+        sendByte(ledarray[i].b);
+#endif
+
 #ifdef RGBW
         sendByte(ledarray[i].w);
 #endif

drivers/chibios/ws2812_pwm.c

@@ -1,6 +1,6 @@
 #include "ws2812.h"
 #include "quantum.h"
-#include "hal.h"
+#include <hal.h>
 
 /* Adapted from https://github.com/joewa/WS2812-LED-Driver_ChibiOS/ */
 
@@ -107,6 +107,7 @@
  */
 #define WS2812_BIT(led, byte, bit) (24 * (led) + 8 * (byte) + (7 - (bit)))
 
+#if (WS2812_BYTE_ORDER == WS2812_BYTE_ORDER_GRB)
 /**
  * @brief   Determine the index in @ref ws2812_frame_buffer "the frame buffer" of a given red bit
  *
@@ -117,7 +118,7 @@
  *
  * @return                          The bit index
  */
-#define WS2812_RED_BIT(led, bit) WS2812_BIT((led), 1, (bit))
+#    define WS2812_RED_BIT(led, bit) WS2812_BIT((led), 1, (bit))
 
 /**
  * @brief   Determine the index in @ref ws2812_frame_buffer "the frame buffer" of a given green bit
@@ -129,7 +130,7 @@
  *
  * @return                          The bit index
  */
-#define WS2812_GREEN_BIT(led, bit) WS2812_BIT((led), 0, (bit))
+#    define WS2812_GREEN_BIT(led, bit) WS2812_BIT((led), 0, (bit))
 
 /**
  * @brief   Determine the index in @ref ws2812_frame_buffer "the frame buffer" of a given blue bit
@@ -141,7 +142,45 @@
  *
  * @return                          The bit index
  */
-#define WS2812_BLUE_BIT(led, bit) WS2812_BIT((led), 2, (bit))
+#    define WS2812_BLUE_BIT(led, bit) WS2812_BIT((led), 2, (bit))
+
+#elif (WS2812_BYTE_ORDER == WS2812_BYTE_ORDER_RGB)
+/**
+ * @brief   Determine the index in @ref ws2812_frame_buffer "the frame buffer" of a given red bit
+ *
+ * @note    The red byte is the middle byte in the color packet
+ *
+ * @param[in] led:                  The led index [0, @ref RGBLED_NUM)
+ * @param[in] bit:                  The bit number [0, 7]
+ *
+ * @return                          The bit index
+ */
+#    define WS2812_RED_BIT(led, bit) WS2812_BIT((led), 0, (bit))
+
+/**
+ * @brief   Determine the index in @ref ws2812_frame_buffer "the frame buffer" of a given green bit
+ *
+ * @note    The red byte is the first byte in the color packet
+ *
+ * @param[in] led:                  The led index [0, @ref RGBLED_NUM)
+ * @param[in] bit:                  The bit number [0, 7]
+ *
+ * @return                          The bit index
+ */
+#    define WS2812_GREEN_BIT(led, bit) WS2812_BIT((led), 1, (bit))
+
+/**
+ * @brief   Determine the index in @ref ws2812_frame_buffer "the frame buffer" of a given blue bit
+ *
+ * @note    The red byte is the last byte in the color packet
+ *
+ * @param[in] led:                  The led index [0, @ref RGBLED_NUM)
+ * @param[in] bit:                  The bit index [0, 7]
+ *
+ * @return                          The bit index
+ */
+#    define WS2812_BLUE_BIT(led, bit) WS2812_BIT((led), 2, (bit))
+#endif
 
 /* --- PRIVATE VARIABLES ---------------------------------------------------- */
 

drivers/chibios/ws2812_spi.c

@@ -62,9 +62,15 @@ static uint8_t get_protocol_eq(uint8_t data, int pos) {
 static void set_led_color_rgb(LED_TYPE color, int pos) {
     uint8_t* tx_start = &txbuf[PREAMBLE_SIZE];
 
+#if (WS2812_BYTE_ORDER == WS2812_BYTE_ORDER_GRB)
     for (int j = 0; j < 4; j++) tx_start[BYTES_FOR_LED * pos + j] = get_protocol_eq(color.g, j);
     for (int j = 0; j < 4; j++) tx_start[BYTES_FOR_LED * pos + BYTES_FOR_LED_BYTE + j] = get_protocol_eq(color.r, j);
     for (int j = 0; j < 4; j++) tx_start[BYTES_FOR_LED * pos + BYTES_FOR_LED_BYTE * 2 + j] = get_protocol_eq(color.b, j);
+#elif (WS2812_BYTE_ORDER == WS2812_BYTE_ORDER_RGB)
+    for (int j = 0; j < 4; j++) tx_start[BYTES_FOR_LED * pos + j] = get_protocol_eq(color.r, j);
+    for (int j = 0; j < 4; j++) tx_start[BYTES_FOR_LED * pos + BYTES_FOR_LED_BYTE + j] = get_protocol_eq(color.g, j);
+    for (int j = 0; j < 4; j++) tx_start[BYTES_FOR_LED * pos + BYTES_FOR_LED_BYTE * 2 + j] = get_protocol_eq(color.b, j);
+#endif
 }
 
 void ws2812_init(void) {

drivers/eeprom/eeprom_i2c.c

@@ -42,14 +42,6 @@
 #    include "debug.h"
 #endif  // DEBUG_EEPROM_OUTPUT
 
-static inline void init_i2c_if_required(void) {
-    static int done = 0;
-    if (!done) {
-        i2c_init();
-        done = 1;
-    }
-}
-
 static inline void fill_target_address(uint8_t *buffer, const void *addr) {
     uintptr_t p = (uintptr_t)addr;
     for (int i = 0; i < EXTERNAL_EEPROM_ADDRESS_SIZE; ++i) {
@@ -58,7 +50,7 @@ static inline void fill_target_address(uint8_t *buffer, const void *addr) {
     }
 }
 
-void eeprom_driver_init(void) {}
+void eeprom_driver_init(void) { i2c_init(); }
 
 void eeprom_driver_erase(void) {
 #if defined(CONSOLE_ENABLE) && defined(DEBUG_EEPROM_OUTPUT)
@@ -80,7 +72,6 @@ void eeprom_read_block(void *buf, const void *addr, size_t len) {
     uint8_t complete_packet[EXTERNAL_EEPROM_ADDRESS_SIZE];
     fill_target_address(complete_packet, addr);
 
-    init_i2c_if_required();
     i2c_transmit(EXTERNAL_EEPROM_I2C_ADDRESS((uintptr_t)addr), complete_packet, EXTERNAL_EEPROM_ADDRESS_SIZE, 100);
     i2c_receive(EXTERNAL_EEPROM_I2C_ADDRESS((uintptr_t)addr), buf, len, 100);
 
@@ -98,7 +89,6 @@ void eeprom_write_block(const void *buf, void *addr, size_t len) {
     uint8_t * read_buf    = (uint8_t *)buf;
     uintptr_t target_addr = (uintptr_t)addr;
 
-    init_i2c_if_required();
     while (len > 0) {
         uintptr_t page_offset  = target_addr % EXTERNAL_EEPROM_PAGE_SIZE;
         int       write_length = EXTERNAL_EEPROM_PAGE_SIZE - page_offset;

drivers/eeprom/eeprom_i2c.h

@@ -49,6 +49,11 @@
 #    define EXTERNAL_EEPROM_PAGE_SIZE 64
 #    define EXTERNAL_EEPROM_ADDRESS_SIZE 2
 #    define EXTERNAL_EEPROM_WRITE_TIME 5
+#elif defined(EEPROM_I2C_24LC64)
+#    define EXTERNAL_EEPROM_BYTE_COUNT 8192
+#    define EXTERNAL_EEPROM_PAGE_SIZE 32
+#    define EXTERNAL_EEPROM_ADDRESS_SIZE 2
+#    define EXTERNAL_EEPROM_WRITE_TIME 5
 #elif defined(EEPROM_I2C_MB85RC256V)
 #    define EXTERNAL_EEPROM_BYTE_COUNT 32768
 #    define EXTERNAL_EEPROM_PAGE_SIZE 128

drivers/eeprom/eeprom_spi.c

@@ -55,14 +55,6 @@
 #    include "debug.h"
 #endif  // CONSOLE_ENABLE
 
-static void init_spi_if_required(void) {
-    static int done = 0;
-    if (!done) {
-        spi_init();
-        done = 1;
-    }
-}
-
 static bool spi_eeprom_start(void) { return spi_start(EXTERNAL_EEPROM_SPI_SLAVE_SELECT_PIN, EXTERNAL_EEPROM_SPI_LSBFIRST, EXTERNAL_EEPROM_SPI_MODE, EXTERNAL_EEPROM_SPI_CLOCK_DIVISOR); }
 
 static spi_status_t spi_eeprom_wait_while_busy(int timeout) {
@@ -91,7 +83,7 @@ static void spi_eeprom_transmit_address(uintptr_t addr) {
 
 //----------------------------------------------------------------------------------------------------------------------
 
-void eeprom_driver_init(void) {}
+void eeprom_driver_init(void) { spi_init(); }
 
 void eeprom_driver_erase(void) {
 #if defined(CONSOLE_ENABLE) && defined(DEBUG_EEPROM_OUTPUT)
@@ -110,8 +102,6 @@ void eeprom_driver_erase(void) {
 }
 
 void eeprom_read_block(void *buf, const void *addr, size_t len) {
-    init_spi_if_required();
-
     //-------------------------------------------------
     // Wait for the write-in-progress bit to be cleared
     bool res = spi_eeprom_start();
@@ -154,8 +144,6 @@ void eeprom_read_block(void *buf, const void *addr, size_t len) {
 }
 
 void eeprom_write_block(const void *buf, void *addr, size_t len) {
-    init_spi_if_required();
-
     bool      res;
     uint8_t * read_buf    = (uint8_t *)buf;
     uintptr_t target_addr = (uintptr_t)addr;

drivers/eeprom/eeprom_stm32_L0_L1.c

@@ -17,7 +17,7 @@
 #include <stdint.h>
 #include <string.h>
 
-#include "hal.h"
+#include <hal.h>
 #include "eeprom_driver.h"
 #include "eeprom_stm32_L0_L1.h"
 

drivers/haptic/DRV2605L.c

@@ -21,8 +21,6 @@
 #include <math.h>
 
 uint8_t DRV2605L_transfer_buffer[2];
-uint8_t DRV2605L_tx_register[0];
-uint8_t DRV2605L_read_buffer[0];
 uint8_t DRV2605L_read_register;
 
 void DRV_write(uint8_t drv_register, uint8_t settings) {
@@ -32,8 +30,7 @@ void DRV_write(uint8_t drv_register, uint8_t settings) {
 }
 
 uint8_t DRV_read(uint8_t regaddress) {
-    i2c_readReg(DRV2605L_BASE_ADDRESS << 1, regaddress, DRV2605L_read_buffer, 1, 100);
-    DRV2605L_read_register = (uint8_t)DRV2605L_read_buffer[0];
+    i2c_readReg(DRV2605L_BASE_ADDRESS << 1, regaddress, &DRV2605L_read_register, 1, 100);
 
     return DRV2605L_read_register;
 }

drivers/haptic/DRV2605L.h

@@ -403,4 +403,4 @@ typedef union DRVREG_CTRL5 { /* register 0x1F */
         uint8_t C5_LRA_AUTO_OPEN_LOOP : 1;
         uint8_t C5_AUTO_OL_CNT : 2;
     } Bits;
-} DRVREG_CTRL5;
+} DRVREG_CTRL5;