build_keyboard.mk 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  1. # Determine what keyboard we are building and setup the build environment.
  2. #
  3. # We support folders up to 5 levels deep below `keyboards/`. This file is
  4. # responsible for determining which folder is being used and doing the
  5. # corresponding environment setup.
  6. ifndef VERBOSE
  7. .SILENT:
  8. endif
  9. .DEFAULT_GOAL := all
  10. include common.mk
  11. # Set the filename for the final firmware binary
  12. KEYBOARD_FILESAFE := $(subst /,_,$(KEYBOARD))
  13. TARGET ?= $(KEYBOARD_FILESAFE)_$(KEYMAP)
  14. KEYBOARD_OUTPUT := $(BUILD_DIR)/obj_$(KEYBOARD_FILESAFE)
  15. STM32_PATH := quantum/stm32
  16. # Force expansion
  17. TARGET := $(TARGET)
  18. # For split boards we need to set a master half.
  19. MASTER ?= left
  20. ifdef master
  21. MASTER = $(master)
  22. endif
  23. ifeq ($(MASTER),right)
  24. OPT_DEFS += -DMASTER_IS_ON_RIGHT
  25. else
  26. ifneq ($(MASTER),left)
  27. $(error MASTER does not have a valid value(left/right))
  28. endif
  29. endif
  30. # Determine which subfolders exist.
  31. KEYBOARD_FOLDER_PATH_1 := $(KEYBOARD)
  32. KEYBOARD_FOLDER_PATH_2 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_1)))
  33. KEYBOARD_FOLDER_PATH_3 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_2)))
  34. KEYBOARD_FOLDER_PATH_4 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_3)))
  35. KEYBOARD_FOLDER_PATH_5 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_4)))
  36. KEYBOARD_FOLDER_1 := $(notdir $(KEYBOARD_FOLDER_PATH_1))
  37. KEYBOARD_FOLDER_2 := $(notdir $(KEYBOARD_FOLDER_PATH_2))
  38. KEYBOARD_FOLDER_3 := $(notdir $(KEYBOARD_FOLDER_PATH_3))
  39. KEYBOARD_FOLDER_4 := $(notdir $(KEYBOARD_FOLDER_PATH_4))
  40. KEYBOARD_FOLDER_5 := $(notdir $(KEYBOARD_FOLDER_PATH_5))
  41. KEYBOARD_PATHS :=
  42. KEYBOARD_PATH_1 := keyboards/$(KEYBOARD_FOLDER_PATH_1)
  43. KEYBOARD_PATH_2 := keyboards/$(KEYBOARD_FOLDER_PATH_2)
  44. KEYBOARD_PATH_3 := keyboards/$(KEYBOARD_FOLDER_PATH_3)
  45. KEYBOARD_PATH_4 := keyboards/$(KEYBOARD_FOLDER_PATH_4)
  46. KEYBOARD_PATH_5 := keyboards/$(KEYBOARD_FOLDER_PATH_5)
  47. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/)","")
  48. KEYBOARD_PATHS += $(KEYBOARD_PATH_5)
  49. endif
  50. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/)","")
  51. KEYBOARD_PATHS += $(KEYBOARD_PATH_4)
  52. endif
  53. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/)","")
  54. KEYBOARD_PATHS += $(KEYBOARD_PATH_3)
  55. endif
  56. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/)","")
  57. KEYBOARD_PATHS += $(KEYBOARD_PATH_2)
  58. endif
  59. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/)","")
  60. KEYBOARD_PATHS += $(KEYBOARD_PATH_1)
  61. endif
  62. # Pull in rules.mk files from all our subfolders
  63. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/rules.mk)","")
  64. include $(KEYBOARD_PATH_5)/rules.mk
  65. endif
  66. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/rules.mk)","")
  67. include $(KEYBOARD_PATH_4)/rules.mk
  68. endif
  69. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/rules.mk)","")
  70. include $(KEYBOARD_PATH_3)/rules.mk
  71. endif
  72. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/rules.mk)","")
  73. include $(KEYBOARD_PATH_2)/rules.mk
  74. endif
  75. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/rules.mk)","")
  76. include $(KEYBOARD_PATH_1)/rules.mk
  77. endif
  78. ifeq ($(strip $(PROTON)), yes)
  79. OPT_DEFS += -DPROTON_CONVERSION
  80. include $(STM32_PATH)/proton_c.mk
  81. endif
  82. include quantum/mcu_selection.mk
  83. ifdef MCU_FAMILY
  84. OPT_DEFS += -DQMK_STM32
  85. KEYBOARD_PATHS += $(STM32_PATH)
  86. endif
  87. # Find all the C source files to be compiled in subfolders.
  88. KEYBOARD_SRC :=
  89. KEYBOARD_C_1 := $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).c
  90. KEYBOARD_C_2 := $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).c
  91. KEYBOARD_C_3 := $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).c
  92. KEYBOARD_C_4 := $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).c
  93. KEYBOARD_C_5 := $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).c
  94. ifneq ("$(wildcard $(KEYBOARD_C_5))","")
  95. KEYBOARD_SRC += $(KEYBOARD_C_5)
  96. endif
  97. ifneq ("$(wildcard $(KEYBOARD_C_4))","")
  98. KEYBOARD_SRC += $(KEYBOARD_C_4)
  99. endif
  100. ifneq ("$(wildcard $(KEYBOARD_C_3))","")
  101. KEYBOARD_SRC += $(KEYBOARD_C_3)
  102. endif
  103. ifneq ("$(wildcard $(KEYBOARD_C_2))","")
  104. KEYBOARD_SRC += $(KEYBOARD_C_2)
  105. endif
  106. ifneq ("$(wildcard $(KEYBOARD_C_1))","")
  107. KEYBOARD_SRC += $(KEYBOARD_C_1)
  108. endif
  109. # Generate KEYBOARD_name_subname for all levels of the keyboard folder
  110. KEYBOARD_FILESAFE_1 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_1)))
  111. KEYBOARD_FILESAFE_2 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_2)))
  112. KEYBOARD_FILESAFE_3 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_3)))
  113. KEYBOARD_FILESAFE_4 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_4)))
  114. KEYBOARD_FILESAFE_5 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_5)))
  115. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/)","")
  116. OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_5)
  117. endif
  118. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/)","")
  119. OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_4)
  120. endif
  121. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/)","")
  122. OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_3)
  123. endif
  124. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/)","")
  125. OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_2)
  126. endif
  127. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/)","")
  128. OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_1)
  129. endif
  130. # Setup the define for QMK_KEYBOARD_H. This is used inside of keymaps so
  131. # that the same keymap may be used on multiple keyboards.
  132. #
  133. # We grab the most top-level include file that we can. That file should
  134. # use #ifdef statements to include all the neccesary subfolder includes,
  135. # as described here:
  136. #
  137. # https://docs.qmk.fm/#/feature_layouts?id=tips-for-making-layouts-keyboard-agnostic
  138. #
  139. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).h)","")
  140. QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_1).h
  141. endif
  142. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).h)","")
  143. QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_2).h
  144. endif
  145. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).h)","")
  146. QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_3).h
  147. endif
  148. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).h)","")
  149. QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_4).h
  150. endif
  151. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).h)","")
  152. QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_5).h
  153. endif
  154. # Determine and set parameters based on the keyboard's processor family.
  155. # We can assume a ChibiOS target When MCU_FAMILY is defined since it's
  156. # not used for LUFA
  157. ifdef MCU_FAMILY
  158. FIRMWARE_FORMAT?=bin
  159. PLATFORM=CHIBIOS
  160. else ifdef ARM_ATSAM
  161. PLATFORM=ARM_ATSAM
  162. FIRMWARE_FORMAT=bin
  163. else
  164. PLATFORM=AVR
  165. FIRMWARE_FORMAT?=hex
  166. endif
  167. ifeq ($(PLATFORM),CHIBIOS)
  168. include $(TMK_PATH)/chibios.mk
  169. OPT_OS = chibios
  170. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/bootloader_defs.h)","")
  171. OPT_DEFS += -include $(KEYBOARD_PATH_5)/bootloader_defs.h
  172. else ifneq ("$(wildcard $(KEYBOARD_PATH_5)/boards/$(BOARD)/bootloader_defs.h)","")
  173. OPT_DEFS += -include $(KEYBOARD_PATH_5)/boards/$(BOARD)/bootloader_defs.h
  174. else ifneq ("$(wildcard $(KEYBOARD_PATH_4)/bootloader_defs.h)","")
  175. OPT_DEFS += -include $(KEYBOARD_PATH_4)/bootloader_defs.h
  176. else ifneq ("$(wildcard $(KEYBOARD_PATH_4)/boards/$(BOARD)/bootloader_defs.h)","")
  177. OPT_DEFS += -include $(KEYBOARD_PATH_4)/boards/$(BOARD)/bootloader_defs.h
  178. else ifneq ("$(wildcard $(KEYBOARD_PATH_3)/bootloader_defs.h)","")
  179. OPT_DEFS += -include $(KEYBOARD_PATH_3)/bootloader_defs.h
  180. else ifneq ("$(wildcard $(KEYBOARD_PATH_3)/boards/$(BOARD)/bootloader_defs.h)","")
  181. OPT_DEFS += -include $(KEYBOARD_PATH_3)/boards/$(BOARD)/bootloader_defs.h
  182. else ifneq ("$(wildcard $(KEYBOARD_PATH_2)/bootloader_defs.h)","")
  183. OPT_DEFS += -include $(KEYBOARD_PATH_2)/bootloader_defs.h
  184. else ifneq ("$(wildcard $(KEYBOARD_PATH_2)/boards/$(BOARD)/bootloader_defs.h)","")
  185. OPT_DEFS += -include $(KEYBOARD_PATH_2)/boards/$(BOARD)/bootloader_defs.h
  186. else ifneq ("$(wildcard $(KEYBOARD_PATH_1)/bootloader_defs.h)","")
  187. OPT_DEFS += -include $(KEYBOARD_PATH_1)/bootloader_defs.h
  188. else ifneq ("$(wildcard $(KEYBOARD_PATH_1)/boards/$(BOARD)/bootloader_defs.h)","")
  189. OPT_DEFS += -include $(KEYBOARD_PATH_1)/boards/$(BOARD)/bootloader_defs.h
  190. else ifneq ("$(wildcard $(TOP_DIR)/drivers/boards/$(BOARD)/bootloader_defs.h)","")
  191. OPT_DEFS += -include $(TOP_DIR)/drivers/boards/$(BOARD)/bootloader_defs.h
  192. endif
  193. endif
  194. # Find all of the config.h files and add them to our CONFIG_H define.
  195. CONFIG_H :=
  196. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
  197. CONFIG_H += $(KEYBOARD_PATH_5)/config.h
  198. endif
  199. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/config.h)","")
  200. CONFIG_H += $(KEYBOARD_PATH_4)/config.h
  201. endif
  202. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/config.h)","")
  203. CONFIG_H += $(KEYBOARD_PATH_3)/config.h
  204. endif
  205. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/config.h)","")
  206. CONFIG_H += $(KEYBOARD_PATH_2)/config.h
  207. endif
  208. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/config.h)","")
  209. CONFIG_H += $(KEYBOARD_PATH_1)/config.h
  210. endif
  211. # Save the defines and includes here, so we don't include any keymap specific ones
  212. PROJECT_DEFS := $(OPT_DEFS)
  213. PROJECT_INC := $(VPATH) $(EXTRAINCDIRS) $(KEYBOARD_PATHS)
  214. PROJECT_CONFIG := $(CONFIG_H)
  215. MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
  216. MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
  217. MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
  218. MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
  219. MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
  220. ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","")
  221. -include $(MAIN_KEYMAP_PATH_5)/rules.mk
  222. KEYMAP_C := $(MAIN_KEYMAP_PATH_5)/keymap.c
  223. KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
  224. else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.c)","")
  225. -include $(MAIN_KEYMAP_PATH_4)/rules.mk
  226. KEYMAP_C := $(MAIN_KEYMAP_PATH_4)/keymap.c
  227. KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
  228. else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.c)","")
  229. -include $(MAIN_KEYMAP_PATH_3)/rules.mk
  230. KEYMAP_C := $(MAIN_KEYMAP_PATH_3)/keymap.c
  231. KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
  232. else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.c)","")
  233. -include $(MAIN_KEYMAP_PATH_2)/rules.mk
  234. KEYMAP_C := $(MAIN_KEYMAP_PATH_2)/keymap.c
  235. KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
  236. else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.c)","")
  237. -include $(MAIN_KEYMAP_PATH_1)/rules.mk
  238. KEYMAP_C := $(MAIN_KEYMAP_PATH_1)/keymap.c
  239. KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
  240. else ifneq ($(LAYOUTS),)
  241. include build_layout.mk
  242. else
  243. $(error Could not find keymap)
  244. # this state should never be reached
  245. endif
  246. # Userspace setup and definitions
  247. ifeq ("$(USER_NAME)","")
  248. USER_NAME := $(KEYMAP)
  249. endif
  250. USER_PATH := users/$(USER_NAME)
  251. -include $(USER_PATH)/rules.mk
  252. ifneq ("$(wildcard $(USER_PATH)/config.h)","")
  253. CONFIG_H += $(USER_PATH)/config.h
  254. endif
  255. # Object files directory
  256. # To put object files in current directory, use a dot (.), do NOT make
  257. # this an empty or blank macro!
  258. KEYMAP_OUTPUT := $(BUILD_DIR)/obj_$(TARGET)
  259. ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
  260. CONFIG_H += $(KEYMAP_PATH)/config.h
  261. endif
  262. # # project specific files
  263. SRC += $(KEYBOARD_SRC) \
  264. $(KEYMAP_C) \
  265. $(QUANTUM_SRC)
  266. # Optimize size but this may cause error "relocation truncated to fit"
  267. #EXTRALDFLAGS = -Wl,--relax
  268. # Search Path
  269. VPATH += $(KEYMAP_PATH)
  270. VPATH += $(KEYBOARD_PATHS)
  271. VPATH += $(COMMON_VPATH)
  272. VPATH += $(USER_PATH)
  273. include common_features.mk
  274. include $(TMK_PATH)/protocol.mk
  275. include $(TMK_PATH)/common.mk
  276. include bootloader.mk
  277. SRC += $(TMK_COMMON_SRC)
  278. OPT_DEFS += $(TMK_COMMON_DEFS)
  279. EXTRALDFLAGS += $(TMK_COMMON_LDFLAGS)
  280. ifeq ($(PLATFORM),AVR)
  281. ifeq ($(strip $(PROTOCOL)), VUSB)
  282. include $(TMK_PATH)/protocol/vusb.mk
  283. else
  284. include $(TMK_PATH)/protocol/lufa.mk
  285. endif
  286. include $(TMK_PATH)/avr.mk
  287. endif
  288. ifeq ($(PLATFORM),ARM_ATSAM)
  289. include $(TMK_PATH)/arm_atsam.mk
  290. include $(TMK_PATH)/protocol/arm_atsam.mk
  291. endif
  292. ifeq ($(PLATFORM),CHIBIOS)
  293. include $(TMK_PATH)/protocol/chibios.mk
  294. endif
  295. ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
  296. VISUALIZER_DIR = $(QUANTUM_DIR)/visualizer
  297. VISUALIZER_PATH = $(QUANTUM_PATH)/visualizer
  298. include $(VISUALIZER_PATH)/visualizer.mk
  299. endif
  300. ALL_CONFIGS := $(PROJECT_CONFIG) $(CONFIG_H)
  301. OUTPUTS := $(KEYMAP_OUTPUT) $(KEYBOARD_OUTPUT)
  302. $(KEYMAP_OUTPUT)_SRC := $(SRC)
  303. $(KEYMAP_OUTPUT)_DEFS := $(OPT_DEFS) $(GFXDEFS) \
  304. -DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(QMK_KEYBOARD_H)\" -DQMK_KEYBOARD_CONFIG_H=\"$(KEYBOARD_PATH_1)/config.h\" \
  305. -DQMK_KEYMAP=\"$(KEYMAP)\" -DQMK_KEYMAP_H=\"$(KEYMAP).h\" -DQMK_KEYMAP_CONFIG_H=\"$(KEYMAP_PATH)/config.h\" \
  306. -DQMK_SUBPROJECT -DQMK_SUBPROJECT_H -DQMK_SUBPROJECT_CONFIG_H
  307. $(KEYMAP_OUTPUT)_INC := $(VPATH) $(EXTRAINCDIRS)
  308. $(KEYMAP_OUTPUT)_CONFIG := $(CONFIG_H)
  309. $(KEYBOARD_OUTPUT)_SRC := $(CHIBISRC) $(GFXSRC)
  310. $(KEYBOARD_OUTPUT)_DEFS := $(PROJECT_DEFS) $(GFXDEFS)
  311. $(KEYBOARD_OUTPUT)_INC := $(PROJECT_INC) $(GFXINC)
  312. $(KEYBOARD_OUTPUT)_CONFIG := $(PROJECT_CONFIG)
  313. # Default target.
  314. all: build check-size
  315. build: elf cpfirmware
  316. include $(TMK_PATH)/rules.mk