You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

541 lines
20 KiB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
2020 November 28 Breaking Changes Update (#11053) * Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
3 years ago
2020 November 28 Breaking Changes Update (#11053) * Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
3 years ago
2020 November 28 Breaking Changes Update (#11053) * Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
3 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
2020 November 28 Breaking Changes Update (#11053) * Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
3 years ago
  1. ifndef VERBOSE
  2. .SILENT:
  3. endif
  4. # Never run this makefile in parallel, as it could screw things up
  5. # It won't affect the submakes, so you still get the speedup from specifying -jx
  6. .NOTPARALLEL:
  7. # Allow the silent with lower caps to work the same way as upper caps
  8. ifdef silent
  9. SILENT = $(silent)
  10. endif
  11. ifdef SILENT
  12. SUB_IS_SILENT := $(SILENT)
  13. endif
  14. # We need to make sure that silent is always turned off at the top level
  15. # Otherwise the [OK], [ERROR] and [WARN] messages won't be displayed correctly
  16. override SILENT := false
  17. ifndef SUB_IS_SILENT
  18. ifndef SKIP_GIT
  19. QMK_VERSION := $(shell git describe --abbrev=0 --tags 2>/dev/null)
  20. endif
  21. ifneq ($(QMK_VERSION),)
  22. $(info QMK Firmware $(QMK_VERSION))
  23. endif
  24. endif
  25. # Determine which qmk cli to use
  26. ifeq (,$(shell which qmk))
  27. QMK_BIN = bin/qmk
  28. else
  29. QMK_BIN = qmk
  30. endif
  31. # avoid 'Entering|Leaving directory' messages
  32. MAKEFLAGS += --no-print-directory
  33. ON_ERROR := error_occurred=1
  34. BREAK_ON_ERRORS = no
  35. STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST))
  36. ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST))
  37. ROOT_DIR := $(dir $(ROOT_MAKEFILE))
  38. ifeq ($(ROOT_DIR),)
  39. ROOT_DIR := .
  40. endif
  41. ABS_STARTING_MAKEFILE := $(abspath $(STARTING_MAKEFILE))
  42. ABS_ROOT_MAKEFILE := $(abspath $(ROOT_MAKEFILE))
  43. ABS_STARTING_DIR := $(dir $(ABS_STARTING_MAKEFILE))
  44. ABS_ROOT_DIR := $(dir $(ABS_ROOT_MAKEFILE))
  45. STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR))
  46. BUILD_DIR := $(ROOT_DIR)/.build
  47. TEST_DIR := $(BUILD_DIR)/test
  48. ERROR_FILE := $(BUILD_DIR)/error_occurred
  49. MAKEFILE_INCLUDED=yes
  50. # Helper function to process the newt element of a space separated path
  51. # It works a bit like the traditional functional head tail
  52. # so the CURRENT_PATH_ELEMENT will become the new head
  53. # and the PATH_ELEMENTS are the rest that are still unprocessed
  54. define NEXT_PATH_ELEMENT
  55. $$(eval CURRENT_PATH_ELEMENT := $$(firstword $$(PATH_ELEMENTS)))
  56. $$(eval PATH_ELEMENTS := $$(wordlist 2,9999,$$(PATH_ELEMENTS)))
  57. endef
  58. # We change the / to spaces so that we more easily can work with the elements
  59. # separately
  60. PATH_ELEMENTS := $(subst /, ,$(STARTING_DIR))
  61. # Initialize the path elements list for further processing
  62. $(eval $(call NEXT_PATH_ELEMENT))
  63. # Phony targets to enable a few simple make commands outside the main processing below.
  64. .PHONY: list-keyboards
  65. list-keyboards:
  66. util/list_keyboards.sh | sort -u | tr '\n' ' '
  67. .PHONY: generate-keyboards-file
  68. generate-keyboards-file:
  69. util/list_keyboards.sh | sort -u
  70. .PHONY: clean
  71. clean:
  72. echo -n 'Deleting .build/ ... '
  73. rm -rf $(BUILD_DIR)
  74. echo 'done.'
  75. .PHONY: distclean
  76. distclean: clean
  77. echo -n 'Deleting *.bin, *.hex, and *.uf2 ... '
  78. rm -f *.bin *.hex *.uf2
  79. echo 'done.'
  80. #Compatibility with the old make variables, anything you specify directly on the command line
  81. # always overrides the detected folders
  82. ifdef keyboard
  83. KEYBOARD := $(keyboard)
  84. endif
  85. ifdef keymap
  86. KEYMAP := $(keymap)
  87. endif
  88. # Uncomment these for debugging
  89. # $(info Keyboard: $(KEYBOARD))
  90. # $(info Keymap: $(KEYMAP))
  91. # Set the default goal depending on where we are running make from
  92. # this handles the case where you run make without any arguments
  93. .DEFAULT_GOAL := all:all
  94. ifneq ($(KEYMAP),)
  95. .DEFAULT_GOAL := $(KEYBOARD):$(KEYMAP)
  96. else ifneq ($(KEYBOARD),)
  97. # Inside a keyboard folder, build all keymaps for all subprojects
  98. # Note that this is different from the old behaviour, which would
  99. # build only the default keymap of the default keyboard
  100. .DEFAULT_GOAL := $(KEYBOARD):all
  101. endif
  102. # Compare the start of the RULE variable with the first argument($1)
  103. # If the rules equals $1 or starts with $1:, RULE_FOUND is set to true
  104. # and $1 is removed from the RULE variable
  105. # Otherwise the RULE_FOUND variable is set to false, and RULE left as it was
  106. # The function is a bit tricky, since there's no built in $(startswith) function
  107. define COMPARE_AND_REMOVE_FROM_RULE_HELPER
  108. ifeq ($1,$$(RULE))
  109. RULE:=
  110. RULE_FOUND := true
  111. else
  112. STARTCOLON_REMOVED=$$(subst START$1:,,START$$(RULE))
  113. ifneq ($$(STARTCOLON_REMOVED),START$$(RULE))
  114. RULE_FOUND := true
  115. RULE := $$(STARTCOLON_REMOVED)
  116. else
  117. RULE_FOUND := false
  118. endif
  119. endif
  120. endef
  121. # This makes it easier to call COMPARE_AND_REMOVE_FROM_RULE, since it makes it behave like
  122. # a function that returns the value
  123. COMPARE_AND_REMOVE_FROM_RULE = $(eval $(call COMPARE_AND_REMOVE_FROM_RULE_HELPER,$1))$(RULE_FOUND)
  124. # Recursively try to find a match for the start of the rule to be checked
  125. # $1 The list to be checked
  126. # If a match is found, then RULE_FOUND is set to true
  127. # and MATCHED_ITEM to the item that was matched
  128. define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
  129. ifneq ($1,)
  130. ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,$$(firstword $1)),true)
  131. MATCHED_ITEM := $$(firstword $1)
  132. else
  133. $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$$(wordlist 2,9999,$1)))
  134. endif
  135. endif
  136. endef
  137. # A recursive helper function for finding the longest match
  138. # $1 The list to be checked
  139. # It works by always removing the currently matched item from the list
  140. define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
  141. # Stop the recursion when the list is empty
  142. ifneq ($1,)
  143. RULE_BEFORE := $$(RULE)
  144. $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$1))
  145. # If a match is found in the current list, otherwise just return what we had before
  146. ifeq ($$(RULE_FOUND),true)
  147. # Save the best match so far and call itself recursively
  148. BEST_MATCH := $$(MATCHED_ITEM)
  149. BEST_MATCH_RULE := $$(RULE)
  150. RULE_FOUND := false
  151. RULE := $$(RULE_BEFORE)
  152. $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$$(filter-out $$(MATCHED_ITEM),$1)))
  153. endif
  154. endif
  155. endef
  156. # Recursively try to find the longest match for the start of the rule to be checked
  157. # $1 The list to be checked
  158. # If a match is found, then RULE_FOUND is set to true
  159. # and MATCHED_ITEM to the item that was matched
  160. define TRY_TO_MATCH_RULE_FROM_LIST_HELPER
  161. BEST_MATCH :=
  162. $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$1))
  163. ifneq ($$(BEST_MATCH),)
  164. RULE_FOUND := true
  165. RULE := $$(BEST_MATCH_RULE)
  166. MATCHED_ITEM := $$(BEST_MATCH)
  167. else
  168. RULE_FOUND := false
  169. MATCHED_ITEM :=
  170. endif
  171. endef
  172. # Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
  173. TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
  174. define ALL_IN_LIST_LOOP
  175. OLD_RULE$1 := $$(RULE)
  176. $$(eval $$(call $1,$$(ITEM$1)))
  177. RULE := $$(OLD_RULE$1)
  178. endef
  179. define PARSE_ALL_IN_LIST
  180. $$(foreach ITEM$1,$2,$$(eval $$(call ALL_IN_LIST_LOOP,$1)))
  181. endef
  182. # The entry point for rule parsing
  183. # parses a rule in the format <keyboard>:<keymap>:<target>
  184. # but this particular function only deals with the first <keyboard> part
  185. define PARSE_RULE
  186. RULE := $1
  187. COMMANDS :=
  188. REQUIRE_PLATFORM_KEY :=
  189. # If the rule starts with all, then continue the parsing from
  190. # PARSE_ALL_KEYBOARDS
  191. ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
  192. KEYBOARD_RULE=all
  193. $$(eval $$(call PARSE_ALL_KEYBOARDS))
  194. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-avr),true)
  195. KEYBOARD_RULE=all
  196. REQUIRE_PLATFORM_KEY := avr
  197. $$(eval $$(call PARSE_ALL_KEYBOARDS))
  198. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-chibios),true)
  199. KEYBOARD_RULE=all
  200. REQUIRE_PLATFORM_KEY := chibios
  201. $$(eval $$(call PARSE_ALL_KEYBOARDS))
  202. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all-arm_atsam),true)
  203. KEYBOARD_RULE=all
  204. REQUIRE_PLATFORM_KEY := arm_atsam
  205. $$(eval $$(call PARSE_ALL_KEYBOARDS))
  206. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,test),true)
  207. $$(eval $$(call PARSE_TEST))
  208. # If the rule starts with the name of a known keyboard, then continue
  209. # the parsing from PARSE_KEYBOARD
  210. else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(shell util/list_keyboards.sh | sort -u)),true)
  211. KEYBOARD_RULE=$$(MATCHED_ITEM)
  212. $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
  213. # Otherwise use the KEYBOARD variable, which is determined either by
  214. # the current directory you run make from, or passed in as an argument
  215. else ifneq ($$(KEYBOARD),)
  216. $$(eval $$(call PARSE_KEYBOARD,$$(KEYBOARD)))
  217. else
  218. $$(info make: *** No rule to make target '$1'. Stop.)
  219. $$(info |)
  220. $$(info | QMK's make format is:)
  221. $$(info | make keyboard_folder:keymap_folder[:target])
  222. $$(info |)
  223. $$(info | Where `keyboard_folder` is the path to the keyboard relative to)
  224. $$(info | `qmk_firmware/keyboards/`, and `keymap_folder` is the name of the)
  225. $$(info | keymap folder under that board's `keymaps/` directory.)
  226. $$(info |)
  227. $$(info | Examples:)
  228. $$(info | keyboards/dz60, keyboards/dz60/keymaps/default)
  229. $$(info | -> make dz60:default)
  230. $$(info | -> qmk compile -kb dz60 -km default)
  231. $$(info | keyboards/planck/rev6, keyboards/planck/keymaps/default)
  232. $$(info | -> make planck/rev6:default:flash)
  233. $$(info | -> qmk flash -kb planck/rev6 -km default)
  234. $$(info |)
  235. endif
  236. endef
  237. # $1 = Keyboard
  238. # Parses a rule in the format <keymap>:<target>
  239. # the keyboard is already known when entering this function
  240. define PARSE_KEYBOARD
  241. # If we want to compile the default subproject, then we need to
  242. # include the correct makefile to determine the actual name of it
  243. CURRENT_KB := $1
  244. # KEYBOARD_FOLDERS := $$(subst /, , $(CURRENT_KB))
  245. DEFAULT_FOLDER := $$(CURRENT_KB)
  246. # We assume that every rules.mk will contain the full default value
  247. $$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/rules.mk)
  248. ifneq ($$(DEFAULT_FOLDER),$$(CURRENT_KB))
  249. $$(eval include $(ROOT_DIR)/keyboards/$$(DEFAULT_FOLDER)/rules.mk)
  250. endif
  251. CURRENT_KB := $$(DEFAULT_FOLDER)
  252. # 5/4/3/2/1
  253. KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
  254. KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
  255. KEYBOARD_FOLDER_PATH_3 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_2)))
  256. KEYBOARD_FOLDER_PATH_4 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_3)))
  257. KEYBOARD_FOLDER_PATH_5 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_4)))
  258. KEYMAPS :=
  259. # get a list of all keymaps
  260. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/keymaps/*/.)))
  261. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/keymaps/*/.)))
  262. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/keymaps/*/.)))
  263. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/keymaps/*/.)))
  264. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/keymaps/*/.)))
  265. KEYBOARD_LAYOUTS := $(shell $(QMK_BIN) list-layouts --keyboard $1)
  266. LAYOUT_KEYMAPS :=
  267. $$(foreach LAYOUT,$$(KEYBOARD_LAYOUTS),$$(eval LAYOUT_KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/layouts/*/$$(LAYOUT)/*/.)))))
  268. KEYMAPS := $$(sort $$(KEYMAPS) $$(LAYOUT_KEYMAPS))
  269. # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
  270. # compile all the keymaps
  271. ifeq ($$(RULE),)
  272. $$(eval $$(call PARSE_ALL_KEYMAPS))
  273. # The same if all was specified
  274. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
  275. $$(eval $$(call PARSE_ALL_KEYMAPS))
  276. # List all keymaps for the given keyboard
  277. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,list-keymaps),true)
  278. $$(eval $$(call LIST_ALL_KEYMAPS))
  279. # Try to match the specified keyamp with the list of known keymaps
  280. else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYMAPS)),true)
  281. $$(eval $$(call PARSE_KEYMAP,$$(MATCHED_ITEM)))
  282. # Otherwise try to match the keymap from the current folder, or arguments to the make command
  283. else ifneq ($$(KEYMAP),)
  284. $$(eval $$(call PARSE_KEYMAP,$$(KEYMAP)))
  285. # Otherwise if we are running make all:<user> just skip
  286. else ifeq ($$(KEYBOARD_RULE),all)
  287. # $$(info Skipping: No user keymap for $$(CURRENT_KB))
  288. # Otherwise, make all keymaps, again this is consistent with how it works without
  289. # any arguments
  290. else
  291. $$(eval $$(call PARSE_ALL_KEYMAPS))
  292. endif
  293. endef
  294. # if we are going to compile all keyboards, match the rest of the rule
  295. # for each of them
  296. define PARSE_ALL_KEYBOARDS
  297. $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell util/list_keyboards.sh noci | sort -u)))
  298. endef
  299. # Prints a list of all known keymaps for the given keyboard
  300. define LIST_ALL_KEYMAPS
  301. COMMAND_true_LIST_KEYMAPS := \
  302. printf "$$(KEYMAPS)\n";
  303. COMMAND_false_LIST_KEYMAPS := \
  304. printf "$$(MSG_AVAILABLE_KEYMAPS)\n"; \
  305. printf "$$(KEYMAPS)\n";
  306. COMMANDS += LIST_KEYMAPS
  307. endef
  308. # $1 Keymap
  309. # This is the meat of compiling a keyboard, when entering this, everything is known
  310. # keyboard, subproject, and keymap
  311. # Note that we are not directly calling the command here, but instead building a list,
  312. # which will later be processed
  313. define PARSE_KEYMAP
  314. CURRENT_KM = $1
  315. # The rest of the rule is the target
  316. # Remove the leading ":" from the target, as it acts as a separator
  317. MAKE_TARGET := $$(patsubst :%,%,$$(RULE))
  318. # We need to generate an unique indentifer to append to the COMMANDS list
  319. CURRENT_KB_UNDER := $$(subst /,_,$$(CURRENT_KB))
  320. COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB_UNDER)_KEYMAP_$$(CURRENT_KM)
  321. # If we are compiling a keyboard without a subproject, we want to display just the name
  322. # of the keyboard, otherwise keyboard/subproject
  323. KB_SP := $$(CURRENT_KB)
  324. # Format it in bold
  325. KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
  326. # Specify the variables that we are passing forward to submake
  327. MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM) REQUIRE_PLATFORM_KEY=$$(REQUIRE_PLATFORM_KEY) QMK_BIN=$$(QMK_BIN)
  328. # And the first part of the make command
  329. MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
  330. # The message to display
  331. MAKE_MSG := $$(MSG_MAKE_KB)
  332. # We run the command differently, depending on if we want more output or not
  333. # The true version for silent output and the false version otherwise
  334. $$(eval $$(call BUILD))
  335. endef
  336. define BUILD
  337. MAKE_VARS += VERBOSE=$(VERBOSE) COLOR=$(COLOR)
  338. COMMANDS += $$(COMMAND)
  339. COMMAND_true_$$(COMMAND) := \
  340. printf "$$(MAKE_MSG)" | \
  341. $$(MAKE_MSG_FORMAT); \
  342. LOG=$$$$($$(MAKE_CMD) $$(MAKE_VARS) SILENT=true 2>&1) ; \
  343. if [ $$$$? -gt 0 ]; \
  344. then $$(PRINT_ERROR_PLAIN); \
  345. elif [ "$$$$LOG" = "skipped" ] ; \
  346. then $$(PRINT_SKIPPED_PLAIN); \
  347. elif [ "$$$$LOG" != "" ] ; \
  348. then $$(PRINT_WARNING_PLAIN); \
  349. else \
  350. $$(PRINT_OK); \
  351. fi;
  352. COMMAND_false_$$(COMMAND) := \
  353. printf "$$(MAKE_MSG)\n\n"; \
  354. $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false; \
  355. if [ $$$$? -gt 0 ]; \
  356. then error_occurred=1; \
  357. fi;
  358. endef
  359. # Just parse all the keymaps for a specific keyboard
  360. define PARSE_ALL_KEYMAPS
  361. $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS)))
  362. endef
  363. define BUILD_TEST
  364. TEST_NAME := $1
  365. MAKE_TARGET := $2
  366. COMMAND := $1
  367. MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_test.mk $$(MAKE_TARGET)
  368. MAKE_VARS := TEST=$$(TEST_NAME) FULL_TESTS="$$(FULL_TESTS)"
  369. MAKE_MSG := $$(MSG_MAKE_TEST)
  370. $$(eval $$(call BUILD))
  371. ifneq ($$(MAKE_TARGET),clean)
  372. TEST_EXECUTABLE := $$(TEST_DIR)/$$(TEST_NAME).elf
  373. TESTS += $$(TEST_NAME)
  374. TEST_MSG := $$(MSG_TEST)
  375. $$(TEST_NAME)_COMMAND := \
  376. printf "$$(TEST_MSG)\n"; \
  377. $$(TEST_EXECUTABLE); \
  378. if [ $$$$? -gt 0 ]; \
  379. then error_occurred=1; \
  380. fi; \
  381. printf "\n";
  382. endif
  383. endef
  384. define PARSE_TEST
  385. TESTS :=
  386. TEST_NAME := $$(firstword $$(subst :, ,$$(RULE)))
  387. TEST_TARGET := $$(subst $$(TEST_NAME),,$$(subst $$(TEST_NAME):,,$$(RULE)))
  388. ifeq ($$(TEST_NAME),all)
  389. MATCHED_TESTS := $$(TEST_LIST)
  390. else
  391. MATCHED_TESTS := $$(foreach TEST,$$(TEST_LIST),$$(if $$(findstring $$(TEST_NAME),$$(TEST)),$$(TEST),))
  392. endif
  393. $$(foreach TEST,$$(MATCHED_TESTS),$$(eval $$(call BUILD_TEST,$$(TEST),$$(TEST_TARGET))))
  394. endef
  395. # Set the silent mode depending on if we are trying to compile multiple keyboards or not
  396. # By default it's on in that case, but it can be overridden by specifying silent=false
  397. # from the command line
  398. define SET_SILENT_MODE
  399. ifdef SUB_IS_SILENT
  400. SILENT_MODE := $(SUB_IS_SILENT)
  401. else ifeq ($$(words $$(COMMANDS)),1)
  402. SILENT_MODE := false
  403. else
  404. SILENT_MODE := true
  405. endif
  406. endef
  407. include $(ROOT_DIR)/message.mk
  408. ifeq ($(strip $(BREAK_ON_ERRORS)), yes)
  409. HANDLE_ERROR = exit 1
  410. else
  411. HANDLE_ERROR = echo $$error_occurred > $(ERROR_FILE)
  412. endif
  413. # The empty line is important here, as it will force a new shell to be created for each command
  414. # Otherwise the command line will become too long with a lot of keyboards and keymaps
  415. define RUN_COMMAND
  416. +error_occurred=0;\
  417. $(COMMAND_$(SILENT_MODE)_$(COMMAND))\
  418. if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
  419. endef
  420. define RUN_TEST
  421. +error_occurred=0;\
  422. $($(TEST)_COMMAND)\
  423. if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
  424. endef
  425. # Catch everything and parse the command line ourselves.
  426. .PHONY: %
  427. %:
  428. # Check if we have the CMP tool installed
  429. cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
  430. # Ensure that $(QMK_BIN) works.
  431. if ! $(QMK_BIN) hello 1> /dev/null 2>&1; then printf "$(MSG_PYTHON_MISSING)"; exit 1; fi
  432. # Check if the submodules are dirty, and display a warning if they are
  433. ifndef SKIP_GIT
  434. if [ ! -e lib/chibios ]; then git submodule sync lib/chibios && git submodule update --depth 50 --init lib/chibios; fi
  435. if [ ! -e lib/chibios-contrib ]; then git submodule sync lib/chibios-contrib && git submodule update --depth 50 --init lib/chibios-contrib; fi
  436. if [ ! -e lib/ugfx ]; then git submodule sync lib/ugfx && git submodule update --depth 50 --init lib/ugfx; fi
  437. if [ ! -e lib/lufa ]; then git submodule sync lib/lufa && git submodule update --depth 50 --init lib/lufa; fi
  438. if [ ! -e lib/vusb ]; then git submodule sync lib/vusb && git submodule update --depth 50 --init lib/vusb; fi
  439. if [ ! -e lib/printf ]; then git submodule sync lib/printf && git submodule update --depth 50 --init lib/printf; fi
  440. git submodule status --recursive 2>/dev/null | \
  441. while IFS= read -r x; do \
  442. case "$$x" in \
  443. \ *) ;; \
  444. *) printf "$(MSG_SUBMODULE_DIRTY)";break;; \
  445. esac \
  446. done
  447. endif
  448. rm -f $(ERROR_FILE) > /dev/null 2>&1
  449. $(eval $(call PARSE_RULE,$@))
  450. $(eval $(call SET_SILENT_MODE))
  451. # Run all the commands in the same shell, notice the + at the first line
  452. # it has to be there to allow parallel execution of the submake
  453. # This always tries to compile everything, even if error occurs in the middle
  454. # But we return the error code at the end, to trigger travis failures
  455. # The sort at this point is to remove duplicates
  456. $(foreach COMMAND,$(sort $(COMMANDS)),$(RUN_COMMAND))
  457. if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
  458. $(foreach TEST,$(sort $(TESTS)),$(RUN_TEST))
  459. if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
  460. lib/%:
  461. git submodule sync $?
  462. git submodule update --init $?
  463. .PHONY: git-submodule
  464. git-submodule:
  465. git submodule sync --recursive
  466. git submodule update --init --recursive --progress
  467. # Generate the version.h file
  468. ifdef SKIP_GIT
  469. VERSION_H_FLAGS := --skip-git
  470. endif
  471. ifdef SKIP_VERSION
  472. VERSION_H_FLAGS := --skip-all
  473. SKIP_GIT := yes
  474. endif
  475. $(shell $(QMK_BIN) generate-version-h $(VERSION_H_FLAGS) -q -o quantum/version.h)
  476. include $(ROOT_DIR)/testlist.mk