build_keyboard.mk 12 KB

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