aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2019-05-02 08:03:42 -0700
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-05-02 08:03:42 -0700
commit7e655a207e58fb8e5c7d76bd5727558e6b4c8b0c (patch)
tree3fc26c13ac531dbe71d18571e7ede29e5e39fea5
parent55d37d9fbcd85a49acbf539d751f0003e7b770ed (diff)
downloadqmk_firmware-7e655a207e58fb8e5c7d76bd5727558e6b4c8b0c.tar.gz
qmk_firmware-7e655a207e58fb8e5c7d76bd5727558e6b4c8b0c.zip
Add option to enable LTO easily (#5674)
* Add option to enable LTO easily and disable features that cause compiling errors with LTO * Add documentation about LTO option * Add to show_options
-rw-r--r--docs/config_options.md2
-rw-r--r--show_options.mk3
-rw-r--r--tmk_core/common.mk7
3 files changed, 11 insertions, 1 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 8f229a2cb..3ef00394d 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -330,6 +330,8 @@ Use these to enable or disable building certain features. The more you have enab
330 * Forces the keyboard to wait for a USB connection to be established before it starts up 330 * Forces the keyboard to wait for a USB connection to be established before it starts up
331* `NO_USB_STARTUP_CHECK` 331* `NO_USB_STARTUP_CHECK`
332 * Disables usb suspend check after keyboard startup. Usually the keyboard waits for the host to wake it up before any tasks are performed. This is useful for split keyboards as one half will not get a wakeup call but must send commands to the master. 332 * Disables usb suspend check after keyboard startup. Usually the keyboard waits for the host to wake it up before any tasks are performed. This is useful for split keyboards as one half will not get a wakeup call but must send commands to the master.
333* `LINK_TIME_OPTIMIZATION_ENABLE`
334 = Enables Link Time Optimization (`LTO`) when compiling the keyboard. This makes the process take longer, but can significantly reduce the compiled size (and since the firmware is small, the added time is not noticable). However, this will automatically disable the old Macros and Functions features automatically, as these break when `LTO` is enabled. It does this by automatically defining `NO_ACTION_MACRO` and `NO_ACTION_FUNCTION`
333 335
334## USB Endpoint Limitations 336## USB Endpoint Limitations
335 337
diff --git a/show_options.mk b/show_options.mk
index c72059118..02e062a8d 100644
--- a/show_options.mk
+++ b/show_options.mk
@@ -88,7 +88,8 @@ OTHER_OPTION_NAMES = \
88 RGB_MATRIX_KEYPRESSES \ 88 RGB_MATRIX_KEYPRESSES \
89 LED_MIRRORED \ 89 LED_MIRRORED \
90 RGBLIGHT_FULL_POWER \ 90 RGBLIGHT_FULL_POWER \
91 Link_Time_Optimization 91 Link_Time_Optimization \
92 LINK_TIME_OPTIMIZATION_ENABLE
92 93
93define NAME_ECHO 94define NAME_ECHO
94 @echo " $1 = $($1) # $(origin $1)" 95 @echo " $1 = $($1) # $(origin $1)"
diff --git a/tmk_core/common.mk b/tmk_core/common.mk
index 94f3c2380..221688755 100644
--- a/tmk_core/common.mk
+++ b/tmk_core/common.mk
@@ -208,6 +208,13 @@ ifeq ($(strip $(SHARED_EP_ENABLE)), yes)
208 TMK_COMMON_DEFS += -DSHARED_EP_ENABLE 208 TMK_COMMON_DEFS += -DSHARED_EP_ENABLE
209endif 209endif
210 210
211
212ifeq ($(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
217endif
211# Bootloader address 218# Bootloader address
212ifdef STM32_BOOTLOADER_ADDRESS 219ifdef STM32_BOOTLOADER_ADDRESS
213 TMK_COMMON_DEFS += -DSTM32_BOOTLOADER_ADDRESS=$(STM32_BOOTLOADER_ADDRESS) 220 TMK_COMMON_DEFS += -DSTM32_BOOTLOADER_ADDRESS=$(STM32_BOOTLOADER_ADDRESS)