rgblight: driver selection cleanups (qmk#21558)

jesperhellberg · Sep 9, 2023 · a9af991 · a9af991
1 parent 1e4507d
commit a9af991
Show file tree

Hide file tree

Showing 43 changed files with 27 additions and 44 deletions.
diff --git a/builddefs/common_features.mk b/builddefs/common_features.mk
@@ -317,14 +317,10 @@ ifneq ($(strip $(FLASH_DRIVER)), none)
 endif
 
 RGBLIGHT_ENABLE ?= no
-VALID_RGBLIGHT_TYPES := WS2812 APA102 custom
-
-ifeq ($(strip $(RGBLIGHT_CUSTOM_DRIVER)), yes)
-    RGBLIGHT_DRIVER ?= custom
-endif
+VALID_RGBLIGHT_TYPES := ws2812 apa102 custom
 
 ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
-    RGBLIGHT_DRIVER ?= WS2812
+    RGBLIGHT_DRIVER ?= ws2812
 
     ifeq ($(filter $(RGBLIGHT_DRIVER),$(VALID_RGBLIGHT_TYPES)),)
         $(call CATASTROPHIC_ERROR,Invalid RGBLIGHT_DRIVER,RGBLIGHT_DRIVER="$(RGBLIGHT_DRIVER)" is not a valid RGB type)
@@ -338,11 +334,11 @@ ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
         RGB_KEYCODES_ENABLE := yes
     endif
 
-    ifeq ($(strip $(RGBLIGHT_DRIVER)), WS2812)
+    ifeq ($(strip $(RGBLIGHT_DRIVER)), ws2812)
         WS2812_DRIVER_REQUIRED := yes
     endif
 
-    ifeq ($(strip $(RGBLIGHT_DRIVER)), APA102)
+    ifeq ($(strip $(RGBLIGHT_DRIVER)), apa102)
         APA102_DRIVER_REQUIRED := yes
     endif
 

diff --git a/builddefs/show_options.mk b/builddefs/show_options.mk
@@ -17,7 +17,7 @@ HARDWARE_OPTION_NAMES = \
   BACKLIGHT_ENABLE \
   BACKLIGHT_DRIVER \
   RGBLIGHT_ENABLE \
-  RGBLIGHT_CUSTOM_DRIVER \
+  RGBLIGHT_DRIVER \
   RGB_MATRIX_ENABLE \
   RGB_MATRIX_DRIVER \
   CIE1931_CURVE \

diff --git a/data/mappings/info_rules.hjson b/data/mappings/info_rules.hjson
@@ -35,6 +35,7 @@
     "PS2_ENABLE": {"info_key": "ps2.enabled", "value_type": "bool"},
     "PS2_MOUSE_ENABLE": {"info_key": "ps2.mouse_enabled", "value_type": "bool"},
     "RGB_MATRIX_DRIVER": {"info_key": "rgb_matrix.driver"},
+    "RGBLIGHT_DRIVER": {"info_key": "rgblight.driver"},
     "SECURE_ENABLE": {"info_key": "secure.enabled", "value_type": "bool"},
     "SPLIT_KEYBOARD": {"info_key": "split.enabled", "value_type": "bool"},
     "SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "to_c": false},

diff --git a/data/schemas/keyboard.jsonschema b/data/schemas/keyboard.jsonschema
@@ -477,6 +477,10 @@
                     }
                 },
                 "brightness_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                "driver": {
+                    "type": "string",
+                    "enum": ["apa102", "custom", "ws2812"]
+                },
                 "hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
                 "layers": {
                     "type": "object",

diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
@@ -28,7 +28,7 @@ For APA102 LEDs, add the following to your `rules.mk`:
 
 ```make
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_DRIVER = APA102
+RGBLIGHT_DRIVER = apa102
 ```
 
 At minimum you must define the data pin your LED strip is connected to, and the number of LEDs in the strip, in your `config.h`. For APA102 LEDs, you must also define the clock pin. If your keyboard has onboard RGB LEDs, and you are simply creating a keymap, you usually won't need to modify these.

diff --git a/keyboards/capsunlocked/cu75/info.json b/keyboards/capsunlocked/cu75/info.json
@@ -18,6 +18,7 @@
     "levels": 8
   },
   "rgblight": {
+    "driver": "custom",
     "hue_steps": 10,
     "led_count": 24
   },

diff --git a/keyboards/capsunlocked/cu75/keymaps/default/rules.mk b/keyboards/capsunlocked/cu75/keymaps/default/rules.mk
@@ -7,7 +7,6 @@ NKRO_ENABLE = yes
 BACKLIGHT_ENABLE = yes           # Disable keyboard backlight functionality
 AUDIO_ENABLE = no               # Audio output
 RGBLIGHT_ENABLE = yes          	# Disable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = yes               # If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/capsunlocked/cu75/keymaps/iso/rules.mk b/keyboards/capsunlocked/cu75/keymaps/iso/rules.mk
@@ -7,7 +7,6 @@ NKRO_ENABLE = yes
 # BACKLIGHT_ENABLE = no           # Disable keyboard backlight functionality
 AUDIO_ENABLE = no               # Audio output
 RGBLIGHT_ENABLE = no          	# Disable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = no               # If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/handwired/onekey/keymaps/apa102/rules.mk b/keyboards/handwired/onekey/keymaps/apa102/rules.mk
@@ -1,2 +1,2 @@
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_DRIVER = APA102
+RGBLIGHT_DRIVER = apa102
diff --git a/keyboards/handwired/uthol/rev2/rules.mk b/keyboards/handwired/uthol/rev2/rules.mk
@@ -6,4 +6,3 @@ EXTRAKEY_ENABLE = yes
 NKRO_ENABLE = yes
 LTO_ENABLE = yes
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_DRIVER = WS2812
diff --git a/keyboards/handwired/uthol/rev3/rules.mk b/keyboards/handwired/uthol/rev3/rules.mk
@@ -9,4 +9,3 @@ WPM_ENABLE = yes
 EXTRAKEY_ENABLE = yes
 ENCODER_ENABLE = yes
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_DRIVER = WS2812
diff --git a/keyboards/kprepublic/jj40/keymaps/fun40/rules.mk b/keyboards/kprepublic/jj40/keymaps/fun40/rules.mk
@@ -13,9 +13,5 @@ UNICODE_ENABLE = no         # Unicode
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_CUSTOM_DRIVER = yes
-DISABLE_WS2812 = yes
-
 
 SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
-
diff --git a/keyboards/kprepublic/jj40/keymaps/waples/rules.mk b/keyboards/kprepublic/jj40/keymaps/waples/rules.mk
@@ -6,5 +6,4 @@ CONSOLE_ENABLE = no
 COMMAND_ENABLE = yes
 BACKLIGHT_ENABLE = yes
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_CUSTOM_DRIVER = yes
 KEY_LOCK_ENABLE = yes
diff --git a/keyboards/lfkeyboards/lfk78/keymaps/ca178858/rules.mk b/keyboards/lfkeyboards/lfk78/keymaps/ca178858/rules.mk
@@ -10,7 +10,6 @@ AUDIO_ENABLE = no              # Audio output on port C6
 UNICODE_ENABLE = no             # Unicode
 BLUETOOTH_ENABLE = no           # Disable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = no           # Enable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = no    # RGB code is implemented in lefkeyboards, not WS2812
 SLEEP_LED_ENABLE = yes
 TAP_DANCE_ENABLE = yes
 

diff --git a/keyboards/lfkeyboards/lfk78/revb/info.json b/keyboards/lfkeyboards/lfk78/revb/info.json
@@ -18,6 +18,7 @@
         "levels": 8
     },
     "rgblight": {
+        "driver": "custom",
         "hue_steps": 10,
         "led_count": 31
     },

diff --git a/keyboards/lfkeyboards/lfk78/revc/info.json b/keyboards/lfkeyboards/lfk78/revc/info.json
@@ -18,6 +18,7 @@
         "levels": 8
     },
     "rgblight": {
+        "driver": "custom",
         "hue_steps": 10,
         "led_count": 27
     },

diff --git a/keyboards/lfkeyboards/lfk78/revj/info.json b/keyboards/lfkeyboards/lfk78/revj/info.json
@@ -18,6 +18,7 @@
         "levels": 8
     },
     "rgblight": {
+        "driver": "custom",
         "hue_steps": 10,
         "led_count": 27
     },

diff --git a/keyboards/lfkeyboards/lfk78/rules.mk b/keyboards/lfkeyboards/lfk78/rules.mk
@@ -10,7 +10,6 @@ NKRO_ENABLE = yes           # Enable N-Key Rollover
 BACKLIGHT_ENABLE = yes          # Enable keyboard backlight functionality
 AUDIO_ENABLE = no               # Audio output
 RGBLIGHT_ENABLE = yes           # Enable WS2812 RGB underlight.
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lfkeyboards, not qmk base
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = yes               # If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/lfkeyboards/lfk87/info.json b/keyboards/lfkeyboards/lfk87/info.json
@@ -12,6 +12,9 @@
     "driver": "custom",
     "levels": 10
   },
+  "rgblight": {
+    "driver": "custom"
+  },
   "ws2812": {
     "pin": "F4"
   },

diff --git a/keyboards/lfkeyboards/lfk87/keymaps/ca178858/rules.mk b/keyboards/lfkeyboards/lfk87/keymaps/ca178858/rules.mk
@@ -10,7 +10,6 @@ AUDIO_ENABLE = yes              # Audio output on port C6
 UNICODE_ENABLE = no             # Unicode
 BLUETOOTH_ENABLE = no           # Disable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = yes           # Enable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
 SLEEP_LED_ENABLE = yes
 TAP_DANCE_ENABLE = yes
 

diff --git a/keyboards/lfkeyboards/lfk87/keymaps/default/rules.mk b/keyboards/lfkeyboards/lfk87/keymaps/default/rules.mk
@@ -7,7 +7,6 @@ NKRO_ENABLE = yes
 BACKLIGHT_ENABLE = yes           # Enable keyboard backlight functionality
 AUDIO_ENABLE = yes              # Audio output
 RGBLIGHT_ENABLE = yes           # Enable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = yes			# If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/lfkeyboards/lfk87/keymaps/gbchk/rules.mk b/keyboards/lfkeyboards/lfk87/keymaps/gbchk/rules.mk
@@ -10,7 +10,6 @@ AUDIO_ENABLE = yes              # Audio output on port C6
 UNICODE_ENABLE = no             # Unicode
 BLUETOOTH_ENABLE = no           # Enable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = yes           # Enable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = yes			# If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/lfkeyboards/lfk87/keymaps/iso/rules.mk b/keyboards/lfkeyboards/lfk87/keymaps/iso/rules.mk
@@ -7,7 +7,6 @@ NKRO_ENABLE = yes
 BACKLIGHT_ENABLE = yes          # Enable keyboard backlight functionality
 AUDIO_ENABLE = yes              # Audio output
 RGBLIGHT_ENABLE = yes           # Enable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = yes               # If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/lfkeyboards/lfk87/rules.mk b/keyboards/lfkeyboards/lfk87/rules.mk
@@ -11,7 +11,6 @@ NKRO_ENABLE = yes           # Enable N-Key Rollover
 BACKLIGHT_ENABLE = yes          # Enable keyboard backlight functionality
 AUDIO_ENABLE = yes              # Audio output
 RGBLIGHT_ENABLE = yes           # Enable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = yes			# If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/lfkeyboards/lfkpad/info.json b/keyboards/lfkeyboards/lfkpad/info.json
@@ -9,6 +9,7 @@
         "device_version": "0.0.1"
     },
     "rgblight": {
+        "driver": "custom",
         "hue_steps": 10,
         "led_count": 28
     },

diff --git a/keyboards/lfkeyboards/lfkpad/rules.mk b/keyboards/lfkeyboards/lfkpad/rules.mk
@@ -9,7 +9,6 @@ COMMAND_ENABLE = no          # Commands for debug and configuration
 NKRO_ENABLE = no            # Enable N-Key Rollover
 BACKLIGHT_ENABLE = no        # Enable keyboard backlight functionality
 RGBLIGHT_ENABLE = yes        # Enable keyboard RGB underglow
-RGBLIGHT_CUSTOM_DRIVER = yes # RGB code is implemented in lfkeyboards, not qmk base
 AUDIO_ENABLE = no            # Audio output
 SLEEP_LED_ENABLE = yes
 

diff --git a/keyboards/lfkeyboards/mini1800/info.json b/keyboards/lfkeyboards/mini1800/info.json
@@ -18,6 +18,7 @@
         "levels": 10
     },
     "rgblight": {
+        "driver": "custom",
         "hue_steps": 10,
         "led_count": 26
     },

diff --git a/keyboards/lfkeyboards/mini1800/reva/rules.mk b/keyboards/lfkeyboards/mini1800/reva/rules.mk
@@ -10,9 +10,6 @@ NKRO_ENABLE = yes           # Enable N-Key Rollover
 BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
 RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
 AUDIO_ENABLE = yes          # Audio output
-
-# RGB code is implemented in lfkeyboards, not WS2812
-RGBLIGHT_CUSTOM_DRIVER = yes
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = yes           # If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/lfkeyboards/mini1800/revc/rules.mk b/keyboards/lfkeyboards/mini1800/revc/rules.mk
@@ -10,9 +10,6 @@ NKRO_ENABLE = yes           # Enable N-Key Rollover
 BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
 RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
 AUDIO_ENABLE = yes          # Audio output
-
-# RGB code is implemented in lfkeyboards, not WS2812
-RGBLIGHT_CUSTOM_DRIVER = yes
 SLEEP_LED_ENABLE = yes
 
 ISSI_ENABLE = yes           # If the I2C pullup resistors aren't install this must be disabled

diff --git a/keyboards/lfkeyboards/smk65/revb/info.json b/keyboards/lfkeyboards/smk65/revb/info.json
@@ -6,6 +6,7 @@
         "levels": 8
     },
     "rgblight": {
+        "driver": "custom",
         "hue_steps": 10,
         "led_count": 20
     },

diff --git a/keyboards/lfkeyboards/smk65/revb/rules.mk b/keyboards/lfkeyboards/smk65/revb/rules.mk
@@ -3,7 +3,6 @@
 #
 BACKLIGHT_ENABLE = no           # Enable keyboard backlight functionality
 RGBLIGHT_ENABLE = no            # Enable keyboard RGB underglow
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
 AUDIO_ENABLE = no               # Audio output
 
 # Extra source files for IS3731 lighting

diff --git a/keyboards/lfkeyboards/smk65/revf/info.json b/keyboards/lfkeyboards/smk65/revf/info.json
@@ -5,6 +5,7 @@
     "processor": "atmega32u4",
     "bootloader": "halfkay",
     "rgblight": {
+        "driver": "custom",
         "led_count": 28
     },
     "layouts": {

diff --git a/keyboards/lfkeyboards/smk65/revf/rules.mk b/keyboards/lfkeyboards/smk65/revf/rules.mk
@@ -2,4 +2,3 @@
 #   change yes to no to disable
 #
 RGBLIGHT_ENABLE = no        	# TODO: Enable keyboard RGB underglow
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
diff --git a/keyboards/matrix/noah/info.json b/keyboards/matrix/noah/info.json
@@ -9,6 +9,7 @@
     "device_version": "0.0.1"
   },
   "rgblight": {
+    "driver": "custom",
     "led_count": 7
   },
   "ws2812": {

diff --git a/keyboards/matrix/noah/rules.mk b/keyboards/matrix/noah/rules.mk
@@ -27,7 +27,6 @@ NO_USB_STARTUP_CHECK = yes	# Disable initialization only when usb is plugged in
 RGB_MATRIX_ENABLE = yes
 
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_CUSTOM_DRIVER = yes
 WS2812_DRIVER_REQUIRED = yes
 
 CUSTOM_MATRIX = yes

diff --git a/keyboards/pearl/keymaps/cijanzen/rules.mk b/keyboards/pearl/keymaps/cijanzen/rules.mk
@@ -6,6 +6,5 @@ CONSOLE_ENABLE = no
 COMMAND_ENABLE = yes
 BACKLIGHT_ENABLE = yes
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_CUSTOM_DRIVER = yes
 # TAP_DANCE_ENABLE = yes
 AUTO_SHIFT_ENABLE = yes
diff --git a/keyboards/prototypist/oceanographer/rules.mk b/keyboards/prototypist/oceanographer/rules.mk
@@ -2,5 +2,4 @@ OLED_ENABLE = yes
 AUDIO_ENABLE = yes
 LTO_ENABLE = yes
 RGBLIGHT_ENABLE = yes
-RGBLIGHT_DRIVER = WS2812
 ENCODER_ENABLE = yes
diff --git a/keyboards/v60_type_r/info.json b/keyboards/v60_type_r/info.json
@@ -19,6 +19,7 @@
     "on_state": 0
   },
   "rgblight": {
+    "driver": "custom",
     "led_count": 1
   },
   "processor": "atmega32u4",

diff --git a/keyboards/v60_type_r/keymaps/ifohancroft/readme.md b/keyboards/v60_type_r/keymaps/ifohancroft/readme.md
@@ -7,7 +7,7 @@
  - Layer 3: An empty layer in-case I need something on-the-fly so I can remap with VIA.
  - Layer 4: An empty layer in-case I need something on-the-fly so I can remap with VIA.
 
-This keymap also sets the polling rate of the keyboard to 1ms, disables the MOUSEKEY, EXTRAKEY, BACKLIGHT, RGBLIGHT and RGBLIGHT_CUSTOM_DRIVER features, and enables the following features:
+This keymap also sets the polling rate of the keyboard to 1ms, disables the MOUSEKEY, EXTRAKEY, BACKLIGHT, and RGBLIGHT features, and enables the following features:
 
  - NKRO (forced on)
  - VIA
diff --git a/keyboards/v60_type_r/keymaps/ifohancroft/rules.mk b/keyboards/v60_type_r/keymaps/ifohancroft/rules.mk
@@ -2,6 +2,5 @@ MOUSEKEY_ENABLE = no
 EXTRAKEY_ENABLE = no
 BACKLIGHT_ENABLE = no
 RGBLIGHT_ENABLE = no
-RGBLIGHT_CUSTOM_DRIVER = no
 NKRO_ENABLE = yes
 VIA_ENABLE = yes
diff --git a/keyboards/v60_type_r/rules.mk b/keyboards/v60_type_r/rules.mk
@@ -9,7 +9,6 @@ COMMAND_ENABLE = yes        # Commands for debug and configuration
 NKRO_ENABLE = no            # Enable N-Key Rollover
 BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
 RGBLIGHT_ENABLE = yes       # Enable the RGB Underglow
-RGBLIGHT_CUSTOM_DRIVER = yes
 AUDIO_ENABLE = no           # Audio output
 
 LTO_ENABLE = yes
diff --git a/keyboards/yandrstudio/buff67v3/rules.mk b/keyboards/yandrstudio/buff67v3/rules.mk
@@ -12,5 +12,4 @@ COMMAND_ENABLE = no         # Commands for debug and configuration
 NKRO_ENABLE = yes           # Enable N-Key Rollover
 BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
-RGBLIGHT_DRIVER = WS2812    # RGB driver support
 AUDIO_ENABLE = no           # Audio output
diff --git a/layouts/community/60_iso/unxmaal/rules.mk b/layouts/community/60_iso/unxmaal/rules.mk
@@ -1,7 +1,7 @@
 # Only enable RGBLIGHT on avr boards
 ifeq ($(strip $(PLATFORM_KEY)),avr)
     # ...that are at least prepared for it
-    ifdef RGBLIGHT_DRIVER
+    ifeq ($(strip $(RGBLIGHT_SUPPORTED)),yes)
         RGBLIGHT_ENABLE = yes          # Enable RGB Underglow
     endif
 endif