Reword a note about the MANUFACTURER and PRODUCT defines in hardware_avr.md (#6558)
[jackhill/qmk/firmware.git] / tmk_core / common.mk
1 COMMON_DIR = common
2 ifeq ($(PLATFORM),AVR)
3 PLATFORM_COMMON_DIR = $(COMMON_DIR)/avr
4 else ifeq ($(PLATFORM),CHIBIOS)
5 PLATFORM_COMMON_DIR = $(COMMON_DIR)/chibios
6 else ifeq ($(PLATFORM),ARM_ATSAM)
7 PLATFORM_COMMON_DIR = $(COMMON_DIR)/arm_atsam
8 else
9 PLATFORM_COMMON_DIR = $(COMMON_DIR)/test
10 endif
11
12 TMK_COMMON_SRC += $(COMMON_DIR)/host.c \
13 $(COMMON_DIR)/keyboard.c \
14 $(COMMON_DIR)/action.c \
15 $(COMMON_DIR)/action_tapping.c \
16 $(COMMON_DIR)/action_macro.c \
17 $(COMMON_DIR)/action_layer.c \
18 $(COMMON_DIR)/action_util.c \
19 $(COMMON_DIR)/print.c \
20 $(COMMON_DIR)/debug.c \
21 $(COMMON_DIR)/util.c \
22 $(COMMON_DIR)/eeconfig.c \
23 $(COMMON_DIR)/report.c \
24 $(PLATFORM_COMMON_DIR)/suspend.c \
25 $(PLATFORM_COMMON_DIR)/timer.c \
26 $(PLATFORM_COMMON_DIR)/bootloader.c \
27
28 ifeq ($(PLATFORM),AVR)
29 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/xprintf.S
30 endif
31
32 ifeq ($(PLATFORM),CHIBIOS)
33 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/printf.c
34 ifeq ($(MCU_SERIES), STM32F3xx)
35 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/eeprom_stm32.c
36 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/flash_stm32.c
37 TMK_COMMON_DEFS += -DEEPROM_EMU_STM32F303xC
38 TMK_COMMON_DEFS += -DSTM32_EEPROM_ENABLE
39 else ifeq ($(MCU_SERIES), STM32F1xx)
40 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/eeprom_stm32.c
41 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/flash_stm32.c
42 TMK_COMMON_DEFS += -DEEPROM_EMU_STM32F103xB
43 TMK_COMMON_DEFS += -DSTM32_EEPROM_ENABLE
44 else ifeq ($(MCU_SERIES)_$(MCU_LDSCRIPT), STM32F0xx_STM32F072xB)
45 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/eeprom_stm32.c
46 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/flash_stm32.c
47 TMK_COMMON_DEFS += -DEEPROM_EMU_STM32F072xB
48 TMK_COMMON_DEFS += -DSTM32_EEPROM_ENABLE
49 else
50 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/eeprom_teensy.c
51 endif
52 ifeq ($(strip $(AUTO_SHIFT_ENABLE)), yes)
53 TMK_COMMON_SRC += $(CHIBIOS)/os/various/syscalls.c
54 else ifeq ($(strip $(TERMINAL_ENABLE)), yes)
55 TMK_COMMON_SRC += $(CHIBIOS)/os/various/syscalls.c
56 endif
57 endif
58
59 ifeq ($(PLATFORM),ARM_ATSAM)
60 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/printf.c
61 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/eeprom.c
62 endif
63
64 ifeq ($(PLATFORM),TEST)
65 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/eeprom.c
66 endif
67
68
69
70 # Option modules
71 BOOTMAGIC_ENABLE ?= no
72 VALID_MAGIC_TYPES := yes full lite
73 ifneq ($(strip $(BOOTMAGIC_ENABLE)), no)
74 ifeq ($(filter $(BOOTMAGIC_ENABLE),$(VALID_MAGIC_TYPES)),)
75 $(error BOOTMAGIC_ENABLE="$(BOOTMAGIC_ENABLE)" is not a valid type of magic)
76 endif
77 ifeq ($(strip $(BOOTMAGIC_ENABLE)), lite)
78 TMK_COMMON_DEFS += -DBOOTMAGIC_LITE
79 TMK_COMMON_DEFS += -DMAGIC_ENABLE
80 TMK_COMMON_SRC += $(COMMON_DIR)/magic.c
81 else
82 TMK_COMMON_DEFS += -DBOOTMAGIC_ENABLE
83 TMK_COMMON_SRC += $(COMMON_DIR)/bootmagic.c
84 endif
85 else
86 TMK_COMMON_DEFS += -DMAGIC_ENABLE
87 TMK_COMMON_SRC += $(COMMON_DIR)/magic.c
88 endif
89
90 SHARED_EP_ENABLE = no
91 MOUSE_SHARED_EP ?= yes
92 ifeq ($(strip $(KEYBOARD_SHARED_EP)), yes)
93 TMK_COMMON_DEFS += -DKEYBOARD_SHARED_EP
94 SHARED_EP_ENABLE = yes
95 # With the current usb_descriptor.c code,
96 # you can't share kbd without sharing mouse;
97 # that would be a very unexpected use case anyway
98 MOUSE_SHARED_EP = yes
99 endif
100
101 ifeq ($(strip $(MOUSEKEY_ENABLE)), yes)
102 TMK_COMMON_SRC += $(COMMON_DIR)/mousekey.c
103 TMK_COMMON_DEFS += -DMOUSEKEY_ENABLE
104 TMK_COMMON_DEFS += -DMOUSE_ENABLE
105
106 ifeq ($(strip $(MOUSE_SHARED_EP)), yes)
107 TMK_COMMON_DEFS += -DMOUSE_SHARED_EP
108 SHARED_EP_ENABLE = yes
109 endif
110 endif
111
112 ifeq ($(strip $(EXTRAKEY_ENABLE)), yes)
113 TMK_COMMON_DEFS += -DEXTRAKEY_ENABLE
114 SHARED_EP_ENABLE = yes
115 endif
116
117 ifeq ($(strip $(RAW_ENABLE)), yes)
118 TMK_COMMON_DEFS += -DRAW_ENABLE
119 endif
120
121 ifeq ($(strip $(CONSOLE_ENABLE)), yes)
122 TMK_COMMON_DEFS += -DCONSOLE_ENABLE
123 else
124 TMK_COMMON_DEFS += -DNO_PRINT
125 TMK_COMMON_DEFS += -DNO_DEBUG
126 endif
127
128 ifeq ($(strip $(COMMAND_ENABLE)), yes)
129 TMK_COMMON_SRC += $(COMMON_DIR)/command.c
130 TMK_COMMON_DEFS += -DCOMMAND_ENABLE
131 endif
132
133 ifeq ($(strip $(NKRO_ENABLE)), yes)
134 TMK_COMMON_DEFS += -DNKRO_ENABLE
135 SHARED_EP_ENABLE = yes
136 endif
137
138 ifeq ($(strip $(USB_6KRO_ENABLE)), yes)
139 TMK_COMMON_DEFS += -DUSB_6KRO_ENABLE
140 endif
141
142 ifeq ($(strip $(SLEEP_LED_ENABLE)), yes)
143 TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/sleep_led.c
144 TMK_COMMON_DEFS += -DSLEEP_LED_ENABLE
145 TMK_COMMON_DEFS += -DNO_SUSPEND_POWER_DOWN
146 endif
147
148 ifeq ($(strip $(NO_UART)), yes)
149 TMK_COMMON_DEFS += -DNO_UART
150 endif
151
152 ifeq ($(strip $(NO_SUSPEND_POWER_DOWN)), yes)
153 TMK_COMMON_DEFS += -DNO_SUSPEND_POWER_DOWN
154 endif
155
156 ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
157 TMK_COMMON_SRC += $(COMMON_DIR)/backlight.c
158 TMK_COMMON_DEFS += -DBACKLIGHT_ENABLE
159 endif
160
161 ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
162 TMK_COMMON_DEFS += -DBLUETOOTH_ENABLE
163 TMK_COMMON_DEFS += -DNO_USB_STARTUP_CHECK
164 endif
165
166 ifeq ($(strip $(BLUETOOTH)), AdafruitBLE)
167 TMK_COMMON_DEFS += -DBLUETOOTH_ENABLE
168 TMK_COMMON_DEFS += -DMODULE_ADAFRUIT_BLE
169 TMK_COMMON_DEFS += -DNO_USB_STARTUP_CHECK
170 endif
171
172 ifeq ($(strip $(BLUETOOTH)), AdafruitEZKey)
173 TMK_COMMON_DEFS += -DBLUETOOTH_ENABLE
174 TMK_COMMON_DEFS += -DMODULE_ADAFRUIT_EZKEY
175 TMK_COMMON_DEFS += -DNO_USB_STARTUP_CHECK
176 endif
177
178 ifeq ($(strip $(BLUETOOTH)), RN42)
179 TMK_COMMON_DEFS += -DBLUETOOTH_ENABLE
180 TMK_COMMON_DEFS += -DMODULE_RN42
181 TMK_COMMON_DEFS += -DNO_USB_STARTUP_CHECK
182 endif
183
184 ifeq ($(strip $(ONEHAND_ENABLE)), yes)
185 SWAP_HANDS_ENABLE = yes # backwards compatibility
186 endif
187 ifeq ($(strip $(SWAP_HANDS_ENABLE)), yes)
188 TMK_COMMON_DEFS += -DSWAP_HANDS_ENABLE
189 endif
190
191 ifeq ($(strip $(NO_USB_STARTUP_CHECK)), yes)
192 TMK_COMMON_DEFS += -DNO_USB_STARTUP_CHECK
193 endif
194
195 ifeq ($(strip $(KEYMAP_SECTION_ENABLE)), yes)
196 TMK_COMMON_DEFS += -DKEYMAP_SECTION_ENABLE
197
198 ifeq ($(strip $(MCU)),atmega32u2)
199 TMK_COMMON_LDFLAGS = -Wl,-L$(TMK_DIR),-Tldscript_keymap_avr35.x
200 else ifeq ($(strip $(MCU)),atmega32u4)
201 TMK_COMMON_LDFLAGS = -Wl,-L$(TMK_DIR),-Tldscript_keymap_avr5.x
202 else
203 TMK_COMMON_LDFLAGS = $(error no ldscript for keymap section)
204 endif
205 endif
206
207 ifeq ($(strip $(SHARED_EP_ENABLE)), yes)
208 TMK_COMMON_DEFS += -DSHARED_EP_ENABLE
209 endif
210
211
212 ifeq ($(strip $(LINK_TIME_OPTIMIZATION_ENABLE)), yes)
213 EXTRAFLAGS += -flto
214 TMK_COMMON_DEFS += -DLINK_TIME_OPTIMIZATION_ENABLE
215 TMK_COMMON_DEFS += -DNO_ACTION_MACRO
216 TMK_COMMON_DEFS += -DNO_ACTION_FUNCTION
217 endif
218 # Bootloader address
219 ifdef STM32_BOOTLOADER_ADDRESS
220 TMK_COMMON_DEFS += -DSTM32_BOOTLOADER_ADDRESS=$(STM32_BOOTLOADER_ADDRESS)
221 endif
222
223 # Search Path
224 VPATH += $(TMK_PATH)/$(COMMON_DIR)
225 ifeq ($(PLATFORM),CHIBIOS)
226 VPATH += $(TMK_PATH)/$(COMMON_DIR)/chibios
227 endif