Breaking changes develop merge to master, 2021Q3 edition. (qmk#14196)

.github/workflows/format.yaml

@@ -31,12 +31,12 @@ jobs:
  output: ' '
  fileOutput: ' '
 
- - name: Run qmk cformat and qmk pyformat
+ - name: Run qmk format-c and qmk format-python
  shell: 'bash {0}'
  run: |
- qmk cformat --core-only -n $(< ~/files.txt)
- cformat_exit=$?
- qmk pyformat -n
- pyformat_exit=$?
+ qmk format-c --core-only -n $(< ~/files.txt)
+ format_c_exit=$?
+ qmk format-python -n
+ format_python_exit=$?
 
- exit $((cformat_exit + pyformat_exit))
+ exit $((format_c_exit + format_python_exit))

.gitignore

@@ -20,7 +20,6 @@
 api_data/v1
 doxygen/
 quantum/version.h
-!quantum/tools/eeprom_reset.hex
 *.bin
 *.eep
 *.hex

Makefile

@@ -557,29 +557,14 @@ git-submodule:
  git submodule sync --recursive
  git submodule update --init --recursive --progress
 
-ifdef SKIP_VERSION
-SKIP_GIT := yes
-endif
-
 # Generate the version.h file
-ifndef SKIP_GIT
- GIT_VERSION := $(shell git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
- CHIBIOS_VERSION := $(shell cd lib/chibios && git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
- CHIBIOS_CONTRIB_VERSION := $(shell cd lib/chibios-contrib && git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
-else
- GIT_VERSION := NA
- CHIBIOS_VERSION := NA
- CHIBIOS_CONTRIB_VERSION := NA
+ifdef SKIP_GIT
+VERSION_H_FLAGS := --skip-git
 endif
-ifndef SKIP_VERSION
-BUILD_DATE := $(shell date +"%Y-%m-%d-%H:%M:%S")
-else
-BUILD_DATE := 2020-01-01-00:00:00
+ifdef SKIP_VERSION
+VERSION_H_FLAGS := --skip-all
+SKIP_GIT := yes
 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)
+$(shell $(QMK_BIN) generate-version-h $(VERSION_H_FLAGS) -q -o quantum/version.h)
 
 include $(ROOT_DIR)/testlist.mk

Vagrantfile

@@ -6,7 +6,7 @@ Vagrant.configure(2) do |config|
  config.vm.define "qmk_firmware"
 
  # VMware/Virtualbox ( and also Hyperv/Parallels) 64 bit
- config.vm.box = "generic/debian9"
+ config.vm.box = "generic/debian10"
 
  config.vm.synced_folder '.', '/vagrant'
 

bootloader.mk

@@ -26,6 +26,7 @@
 # atmel-dfu Atmel factory DFU
 # lufa-dfu LUFA DFU
 # qmk-dfu QMK DFU (LUFA + blinkenlight)
+# qmk-hid QMK HID (LUFA + blinkenlight)
 # bootloadHID HIDBootFlash compatible (ATmega32A)
 # USBasp USBaspLoader (ATmega328P)
 # ARM:
@@ -67,6 +68,11 @@ ifeq ($(strip $(BOOTLOADER)), qmk-dfu)
  BOOTLOADER_SIZE = 8192
  endif
 endif
+ifeq ($(strip $(BOOTLOADER)), qmk-hid)
+ OPT_DEFS += -DBOOTLOADER_QMK_HID
+ OPT_DEFS += -DBOOTLOADER_HID
+ BOOTLOADER_SIZE = 4096
+endif
 ifeq ($(strip $(BOOTLOADER)), halfkay)
  OPT_DEFS += -DBOOTLOADER_HALFKAY
  ifeq ($(strip $(MCU)), atmega32u4)

build_json.mk

@@ -1,31 +1,17 @@
 # Look for a json keymap file
 ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.json)","")
- KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
  KEYMAP_JSON := $(MAIN_KEYMAP_PATH_5)/keymap.json
  KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.json)","")
- KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
  KEYMAP_JSON := $(MAIN_KEYMAP_PATH_4)/keymap.json
  KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.json)","")
- KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
  KEYMAP_JSON := $(MAIN_KEYMAP_PATH_3)/keymap.json
  KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.json)","")
- KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
  KEYMAP_JSON := $(MAIN_KEYMAP_PATH_2)/keymap.json
  KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.json)","")
- KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
  KEYMAP_JSON := $(MAIN_KEYMAP_PATH_1)/keymap.json
  KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
 endif
-
-# Load the keymap-level rules.mk if exists
-ifneq ("$(wildcard $(KEYMAP_PATH))", "")
- -include $(KEYMAP_PATH)/rules.mk
-endif
-
-# Generate the keymap.c
-$(KEYBOARD_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
- $(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON)

build_keyboard.mk

@@ -23,6 +23,15 @@ KEYBOARD_OUTPUT := $(BUILD_DIR)/obj_$(KEYBOARD_FILESAFE)
 # Force expansion
 TARGET := $(TARGET)
 
+ifneq ($(FORCE_LAYOUT),)
+ TARGET := $(TARGET)_$(FORCE_LAYOUT)
+endif
+
+# Object files and generated keymap directory
+# To put object files in current directory, use a dot (.), do NOT make
+# this an empty or blank macro!
+KEYMAP_OUTPUT := $(BUILD_DIR)/obj_$(TARGET)
+
 # For split boards we need to set a master half.
 MASTER ?= left
 ifdef master
@@ -100,7 +109,7 @@ MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
 MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
 
 # Pull in rules from info.json
-INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/rules.mk)
+INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/info_rules.mk)
 include $(INFO_RULES_MK)
 
 # Check for keymap.json first, so we can regenerate keymap.c
@@ -137,16 +146,35 @@ ifeq ("$(wildcard $(KEYMAP_PATH))", "")
  endif
 endif
 
+# Have we found a keymap.json?
+ifneq ("$(wildcard $(KEYMAP_JSON))", "")
+ KEYMAP_C := $(KEYMAP_OUTPUT)/src/keymap.c
+ KEYMAP_H := $(KEYMAP_OUTPUT)/src/config.h
+
+ # Load the keymap-level rules.mk if exists
+ -include $(KEYMAP_PATH)/rules.mk
+
+ # Load any rules.mk content from keymap.json
+ INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --keymap $(KEYMAP) --output $(KEYMAP_OUTPUT)/src/rules.mk)
+ include $(INFO_RULES_MK)
+
+# Add rules to generate the keymap files - indentation here is important
+$(KEYMAP_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
+ $(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON)
+
+$(KEYMAP_OUTPUT)/src/config.h: $(KEYMAP_JSON)
+ $(QMK_BIN) generate-config-h --quiet --keyboard $(KEYBOARD) --keymap $(KEYMAP) --output $(KEYMAP_H)
+
+generated-files: $(KEYMAP_OUTPUT)/src/config.h $(KEYMAP_OUTPUT)/src/keymap.c
+
+endif
+
 ifeq ($(strip $(CTPC)), yes)
  CONVERT_TO_PROTON_C=yes
 endif
 
 ifeq ($(strip $(CONVERT_TO_PROTON_C)), yes)
- include platforms/chibios/QMK_PROTON_C/convert_to_proton_c.mk
-endif
-
-ifneq ($(FORCE_LAYOUT),)
- TARGET := $(TARGET)_$(FORCE_LAYOUT)
+ include platforms/chibios/boards/QMK_PROTON_C/convert_to_proton_c.mk
 endif
 
 include quantum/mcu_selection.mk
@@ -232,6 +260,7 @@ ifdef MCU_FAMILY
  PLATFORM=CHIBIOS
  PLATFORM_KEY=chibios
  FIRMWARE_FORMAT?=bin
+ OPT_DEFS += -DMCU_$(MCU_FAMILY)
 else ifdef ARM_ATSAM
  PLATFORM=ARM_ATSAM
  PLATFORM_KEY=arm_atsam
@@ -327,19 +356,19 @@ endif
 # Disable features that a keyboard doesn't support
 -include disable_features.mk
 
-# Object files directory
-# To put object files in current directory, use a dot (.), do NOT make
-# this an empty or blank macro!
-KEYMAP_OUTPUT := $(BUILD_DIR)/obj_$(TARGET)
-
 ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
  CONFIG_H += $(KEYMAP_PATH)/config.h
 endif
+ifneq ("$(KEYMAP_H)","")
+ CONFIG_H += $(KEYMAP_H)
+endif
 
 # project specific files
-SRC += $(KEYBOARD_SRC) \
+SRC += \
+ $(KEYBOARD_SRC) \
  $(KEYMAP_C) \
- $(QUANTUM_SRC)
+ $(QUANTUM_SRC) \
+ $(QUANTUM_DIR)/main.c \
 
 # Optimize size but this may cause error "relocation truncated to fit"
 #EXTRALDFLAGS = -Wl,--relax
@@ -374,6 +403,7 @@ ifneq ($(strip $(PROTOCOL)),)
 else
  include $(TMK_PATH)/protocol/$(PLATFORM_KEY).mk
 endif
+-include $(TOP_DIR)/platforms/$(PLATFORM_KEY)/flash.mk
 
 # TODO: remove this bodge?
 PROJECT_DEFS := $(OPT_DEFS)

build_layout.mk

@@ -7,7 +7,6 @@ define SEARCH_LAYOUTS_REPO
  LAYOUT_KEYMAP_C := $$(LAYOUT_KEYMAP_PATH)/keymap.c
  ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_JSON))","")
  -include $$(LAYOUT_KEYMAP_PATH)/rules.mk
- KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
  KEYMAP_JSON := $$(LAYOUT_KEYMAP_JSON)
  KEYMAP_PATH := $$(LAYOUT_KEYMAP_PATH)
  else ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_C))","")
@@ -31,6 +30,3 @@ ifneq ($(FORCE_LAYOUT),)
 endif
 
 $(foreach LAYOUT,$(LAYOUTS),$(eval $(call SEARCH_LAYOUTS)))
-
-# Use rule from build_json.mk, but update prerequisite in case KEYMAP_JSON was updated
-$(KEYBOARD_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)

build_test.mk

@@ -53,16 +53,18 @@ endif
 
 include common_features.mk
 include $(TMK_PATH)/common.mk
+include $(QUANTUM_PATH)/debounce/tests/rules.mk
 include $(QUANTUM_PATH)/sequencer/tests/rules.mk
 include $(QUANTUM_PATH)/serial_link/tests/rules.mk
+include $(TMK_PATH)/common/test/rules.mk
 ifneq ($(filter $(FULL_TESTS),$(TEST)),)
 include build_full_test.mk
 endif
 
 $(TEST)_SRC += \
  tests/test_common/main.c \
  $(LIB_PATH)/printf/printf.c \
- $(COMMON_DIR)/printf.c
+ $(QUANTUM_PATH)/logging/print.c
 
 $(TEST_OBJ)/$(TEST)_SRC := $($(TEST)_SRC)
 $(TEST_OBJ)/$(TEST)_INC := $($(TEST)_INC) $(VPATH) $(GTEST_INC)

common.mk

@@ -12,6 +12,9 @@ QUANTUM_PATH = $(QUANTUM_DIR)
 DRIVER_DIR = drivers
 DRIVER_PATH = $(DRIVER_DIR)
 
+PLATFORM_DIR = platforms
+PLATFORM_PATH = $(PLATFORM_DIR)
+
 BUILD_DIR := .build
 
 COMMON_VPATH := $(TOP_DIR)