Move Bluetooth config to common_features.mk (qmk#14404)

* Move Bluetooth config to common_features.mk * Update common_features.mk Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: Drashna Jaelre <[email protected]>
BorisTestov · Sep 12, 2021 · 3522267 · 3522267
1 parent 8270d43
commit 3522267
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 59 deletions.
diff --git a/common_features.mk b/common_features.mk
@@ -745,3 +745,26 @@ ifeq ($(strip $(USBPD_ENABLE)), yes)
         endif
     endif
 endif
+
+BLUETOOTH_ENABLE ?= no
+VALID_BLUETOOTH_DRIVER_TYPES = AdafruitBLE RN42 custom
+ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
+    ifeq ($(filter $(strip $(BLUETOOTH_DRIVER)),$(VALID_BLUETOOTH_DRIVER_TYPES)),)
+        $(error "$(BLUETOOTH_DRIVER)" is not a valid Bluetooth driver type)
+    endif
+    OPT_DEFS += -DBLUETOOTH_ENABLE
+    NO_USB_STARTUP_CHECK := yes
+    SRC += outputselect.c
+
+    ifeq ($(strip $(BLUETOOTH_DRIVER)), AdafruitBLE)
+        OPT_DEFS += -DMODULE_ADAFRUIT_BLE
+        SRC += analog.c
+        SRC += $(LUFA_DIR)/adafruit_ble.cpp
+        QUANTUM_LIB_SRC += spi_master.c
+    endif
+
+    ifeq ($(strip $(BLUETOOTH_DRIVER)), RN42)
+        OPT_DEFS += DMODULE_RN42
+        SRC += $(TMK_DIR)/protocol/serial_uart.c
+    endif
+endif
diff --git a/disable_features.mk b/disable_features.mk
@@ -1,7 +1,6 @@
 # Unconditionally disable features that a keyboard advertises it doesn't support
 
 FEATURE_NAMES :=
-FEATURE_NAMES += ADAFRUIT_BLE
 FEATURE_NAMES += AUDIO
 FEATURE_NAMES += BACKLIGHT
 FEATURE_NAMES += BLUETOOTH

diff --git a/docs/feature_bluetooth.md b/docs/feature_bluetooth.md
@@ -4,10 +4,10 @@
 
 Currently Bluetooth support is limited to AVR based chips. For Bluetooth 2.1, QMK has support for RN-42 modules. For more recent BLE protocols, currently only the Adafruit Bluefruit SPI Friend is directly supported. BLE is needed to connect to iOS devices. Note iOS does not support mouse input.
 
-|Board                                                           |Bluetooth Protocol          |Connection Type |rules.mk                   |Bluetooth Chip|
-|----------------------------------------------------------------|----------------------------|----------------|---------------------------|--------------|
-|Roving Networks RN-42 (Sparkfun Bluesmirf)                       |Bluetooth Classic           | UART           |`BLUETOOTH = RN42`          | RN-42        |
-|[Bluefruit LE SPI Friend](https://www.adafruit.com/product/2633)|Bluetooth Low Energy        | SPI            |`BLUETOOTH = AdafruitBLE`   | nRF51822      |
+|Board                                                           |Bluetooth Protocol  |Connection Type|rules.mk                        |Bluetooth Chip|
+|----------------------------------------------------------------|--------------------|---------------|--------------------------------|--------------|
+|Roving Networks RN-42 (Sparkfun Bluesmirf)                      |Bluetooth Classic   |UART           |`BLUETOOTH_DRIVER = RN42`       |RN-42         |
+|[Bluefruit LE SPI Friend](https://www.adafruit.com/product/2633)|Bluetooth Low Energy|SPI            |`BLUETOOTH_DRIVER = AdafruitBLE`|nRF51822      |
 
 Not Supported Yet but possible:
 * [Bluefruit LE UART Friend](https://www.adafruit.com/product/2479). [Possible tmk implementation found in](https://github.com/tmk/tmk_keyboard/issues/514)
@@ -23,16 +23,17 @@ Currently The only bluetooth chipset supported by QMK is the Adafruit Bluefruit
 
 A Bluefruit UART friend can be converted to an SPI friend, however this [requires](https://github.com/qmk/qmk_firmware/issues/2274) some reflashing and soldering directly to the MDBT40 chip.
 
-
 <!-- FIXME: Document bluetooth support more completely. -->
 ## Bluetooth Rules.mk Options
 
 The currently supported Bluetooth chipsets do not support [N-Key Rollover (NKRO)](reference_glossary.md#n-key-rollover-nkro), so `rules.mk` must contain `NKRO_ENABLE = no`.
 
-Use only one of these to enable Bluetooth:
-* BLUETOOTH_ENABLE = yes (Legacy Option)
-* BLUETOOTH = RN42
-* BLUETOOTH = AdafruitBLE
+Add the following to your `rules.mk`:
+
+```makefile
+BLUETOOTH_ENABLE = yes
+BLUETOOTH_DRIVER = AdafruitBLE # or RN42
+```
 
 ## Bluetooth Keycodes
 

diff --git a/show_options.mk b/show_options.mk
@@ -25,6 +25,7 @@ HARDWARE_OPTION_NAMES = \
   CIE1931_CURVE \
   MIDI_ENABLE \
   BLUETOOTH_ENABLE \
+  BLUETOOTH_DRIVER \
   AUDIO_ENABLE \
   HD44780_ENABLE \
   ENCODER_ENABLE \
@@ -57,7 +58,6 @@ OTHER_OPTION_NAMES = \
   LED_ANIMATIONS \
   IOS_DEVICE_ENABLE \
   HELIX ZINC \
-  ADAFRUIT_BLE_ENABLE \
   AUTOLOG_ENABLE \
   DEBUG_ENABLE \
   ENCODER_ENABLE_CUSTOM \

diff --git a/tmk_core/common.mk b/tmk_core/common.mk
@@ -55,8 +55,6 @@ ifeq ($(strip $(NKRO_ENABLE)), yes)
         $(info NKRO is not currently supported on V-USB, and has been disabled.)
     else ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
         $(info NKRO is not currently supported with Bluetooth, and has been disabled.)
-    else ifneq ($(BLUETOOTH),)
-        $(info NKRO is not currently supported with Bluetooth, and has been disabled.)
     else
         TMK_COMMON_DEFS += -DNKRO_ENABLE
         SHARED_EP_ENABLE = yes
@@ -77,23 +75,6 @@ ifeq ($(strip $(NO_SUSPEND_POWER_DOWN)), yes)
     TMK_COMMON_DEFS += -DNO_SUSPEND_POWER_DOWN
 endif
 
-ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
-    TMK_COMMON_DEFS += -DBLUETOOTH_ENABLE
-	TMK_COMMON_DEFS += -DNO_USB_STARTUP_CHECK
-endif
-
-ifeq ($(strip $(BLUETOOTH)), AdafruitBLE)
-	TMK_COMMON_DEFS += -DBLUETOOTH_ENABLE
-	TMK_COMMON_DEFS += -DMODULE_ADAFRUIT_BLE
-	TMK_COMMON_DEFS += -DNO_USB_STARTUP_CHECK
-endif
-
-ifeq ($(strip $(BLUETOOTH)), RN42)
-	TMK_COMMON_DEFS += -DBLUETOOTH_ENABLE
-	TMK_COMMON_DEFS += -DMODULE_RN42
-	TMK_COMMON_DEFS += -DNO_USB_STARTUP_CHECK
-endif
-
 ifeq ($(strip $(SWAP_HANDS_ENABLE)), yes)
     TMK_COMMON_DEFS += -DSWAP_HANDS_ENABLE
 endif

diff --git a/tmk_core/protocol/lufa.mk b/tmk_core/protocol/lufa.mk
@@ -3,7 +3,6 @@ LUFA_DIR = protocol/lufa
 # Path to the LUFA library
 LUFA_PATH = $(LIB_PATH)/lufa
 
-
 # Create the LUFA source path variables by including the LUFA makefile
 ifneq (, $(wildcard $(LUFA_PATH)/LUFA/Build/lufa_sources.mk))
     # New build system from 20120730
@@ -22,23 +21,6 @@ ifeq ($(strip $(MIDI_ENABLE)), yes)
 	include $(TMK_PATH)/protocol/midi.mk
 endif
 
-ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
-	LUFA_SRC += outputselect.c \
-		$(TMK_DIR)/protocol/serial_uart.c
-endif
-
-ifeq ($(strip $(BLUETOOTH)), AdafruitBLE)
-	LUFA_SRC += spi_master.c \
-		analog.c \
-		outputselect.c \
-		$(LUFA_DIR)/adafruit_ble.cpp
-endif
-
-ifeq ($(strip $(BLUETOOTH)), RN42)
-	LUFA_SRC += outputselect.c \
-		$(TMK_DIR)/protocol/serial_uart.c
-endif
-
 ifeq ($(strip $(VIRTSER_ENABLE)), yes)
 	LUFA_SRC += $(LUFA_ROOT_PATH)/Drivers/USB/Class/Device/CDCClassDevice.c
 endif
@@ -50,19 +32,10 @@ SRC += $(LUFA_DIR)/usb_util.c
 VPATH += $(TMK_PATH)/$(LUFA_DIR)
 VPATH += $(LUFA_PATH)
 
-# Option modules
-#ifdef $(or MOUSEKEY_ENABLE, PS2_MOUSE_ENABLE)
-#endif
-
-#ifdef EXTRAKEY_ENABLE
-#endif
-
 # LUFA library compile-time options and predefined tokens
 LUFA_OPTS  = -DUSB_DEVICE_ONLY
 LUFA_OPTS += -DUSE_FLASH_DESCRIPTORS
 LUFA_OPTS += -DUSE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
-#LUFA_OPTS += -DINTERRUPT_CONTROL_ENDPOINT
-LUFA_OPTS += -DFIXED_CONTROL_ENDPOINT_SIZE=8
 LUFA_OPTS += -DFIXED_CONTROL_ENDPOINT_SIZE=8
 LUFA_OPTS += -DFIXED_NUM_CONFIGURATIONS=1
 

diff --git a/users/wanleg/rules.mk b/users/wanleg/rules.mk
@@ -21,8 +21,8 @@ ifeq ($(strip $(BT)), yes)
   #opt_defs for alternate pin usage
   OPT_DEFS += -DBLUEFRUIT
   #Adafruit Bluefruit controller settings
-  BLUETOOTH = AdafruitBLE
   BLUETOOTH_ENABLE = yes
+  BLUETOOTH_DRIVER = AdafruitBLE
   F_CPU = 8000000
   CONSOLE_ENABLE = no 		# Console for debug(+400)
   COMMAND_ENABLE = no 		# Commands for debug and configuration
@@ -42,4 +42,4 @@ endif
 #example usage: make gherkin:wanleg flip=yes
 ifeq ($(strip $(flip)), yes)
 	OPT_DEFS += -DFLIP
-endif
+endif