Add audio driver to keyboard.json schema (#23616)

2024-12-22 08:26:21 +00:00 · 2024-04-26 05:41:22 +01:00 · 2024-04-26 05:41:22 +01:00 · d333a25868
commit d333a25868
parent 42f61611e8
39 changed files with 59 additions and 22 deletions
--- a/data/mappings/info_rules.hjson
+++ b/data/mappings/info_rules.hjson
@ -11,6 +11,7 @@
    // invalid: Default `false`. Set to `true` to generate errors when a value exists
    // replace_with: use with a key marked deprecated or invalid to designate a replacement

+    "AUDIO_DRIVER": {"info_key": "audio.driver"},
    "BACKLIGHT_DRIVER": {"info_key": "backlight.driver"},
    "BLUETOOTH_DRIVER": {"info_key": "bluetooth.driver"},
    "BOARD": {"info_key": "board"},
--- a/data/schemas/keyboard.jsonschema
+++ b/data/schemas/keyboard.jsonschema
@ -133,6 +133,10 @@
                        "clicky": {"type": "boolean"}
                    }
                },
+                "driver": {
+                    "type": "string",
+                    "enum": ["dac_additive", "dac_basic", "pwm_software", "pwm_hardware"]
+                },
                "macro_beep": {"type": "boolean"},
                "pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
                "power_control": {
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@ -118,6 +118,8 @@ Configures the [Audio](feature_audio.md) feature.
        * `clicky`
            * The default audio clicky enabled state.
            * Default: `true`
+    * `driver`
+        * The driver to use. Must be one of `dac_additive`, `dac_basic`, `pwm_software`, `pwm_hardware`.
    * `macro_beep`
        * Play a short beep for `\a` (ASCII `BEL`) characters in Send String macros.
        * Default: `false`
--- a/keyboards/adafruit/macropad/keyboard.json
+++ b/keyboards/adafruit/macropad/keyboard.json
@ -19,6 +19,7 @@
        "oled": true
    },
    "audio": {
+        "driver": "pwm_hardware",
        "power_control": {
            "pin": "GP14"
        }
--- a/keyboards/adafruit/macropad/rules.mk
+++ b/keyboards/adafruit/macropad/rules.mk
@ -1,2 +1 @@
-AUDIO_DRIVER = pwm_hardware
 OLED_TRANSPORT = spi
--- a/keyboards/arrowmechanics/wings/keyboard.json
+++ b/keyboards/arrowmechanics/wings/keyboard.json
@ -17,6 +17,9 @@
        "mousekey": true,
        "rgb_matrix": true
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "matrix_pins": {
        "cols": ["GP8", "GP9", "GP10", "GP11", "GP12", "GP13", "GP14", "GP15", "GP16"],
        "rows": ["GP22", "GP21", "GP20", "GP19", "GP18", "GP17"]
--- a/keyboards/arrowmechanics/wings/rules.mk
+++ b/keyboards/arrowmechanics/wings/rules.mk
@ -1,2 +1 @@
 SERIAL_DRIVER = vendor
-AUDIO_DRIVER = pwm_hardware
--- a/keyboards/boardsource/equals/48/keyboard.json
+++ b/keyboards/boardsource/equals/48/keyboard.json
@ -10,6 +10,9 @@
        "cols": ["GP0", "GP1", "GP2", "GP3", "GP4", "GP5", "GP6", "GP7", "GP8", "GP9", "GP10", "GP11"],
        "rows": ["GP12", "GP13", "GP16", "GP17"]
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "ws2812": {
        "driver": "vendor",
        "pin": "GP21"
--- a/keyboards/boardsource/equals/48/rules.mk
+++ b/keyboards/boardsource/equals/48/rules.mk
@ -1,2 +1 @@
-AUDIO_DRIVER = pwm_hardware
 QUANTUM_PAINTER_DRIVERS += st7735_spi
--- a/keyboards/boardsource/equals/60/keyboard.json
+++ b/keyboards/boardsource/equals/60/keyboard.json
@ -10,6 +10,9 @@
        "cols": ["GP0", "GP1", "GP2", "GP3", "GP4", "GP5", "GP6", "GP7", "GP8", "GP9", "GP10", "GP11"],
        "rows": ["GP12", "GP13", "GP16", "GP17", "GP18"]
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "ws2812": {
        "driver": "vendor",
        "pin": "GP21"
--- a/keyboards/boardsource/equals/60/rules.mk
+++ b/keyboards/boardsource/equals/60/rules.mk
@ -1,2 +1 @@
-AUDIO_DRIVER = pwm_hardware
 QUANTUM_PAINTER_DRIVERS += st7735_spi
--- a/keyboards/boardsource/unicorne/keyboard.json
+++ b/keyboards/boardsource/unicorne/keyboard.json
@ -32,6 +32,9 @@
        "pid": "0x7563",
        "vid": "0x4273"
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "ws2812": {
        "driver": "vendor",
        "pin": "GP29"
--- a/keyboards/boardsource/unicorne/rules.mk
+++ b/keyboards/boardsource/unicorne/rules.mk
@ -1,3 +1,2 @@
 SERIAL_DRIVER = vendor
-AUDIO_DRIVER = pwm_hardware
 POINTING_DEVICE_DRIVER = analog_joystick
--- a/keyboards/custommk/cmk11/keyboard.json
+++ b/keyboards/custommk/cmk11/keyboard.json
@ -18,6 +18,9 @@
        "nkro": true,
        "rgb_matrix": true
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "matrix_pins": {
        "cols": ["B0", "A1", "A2", "A3", "A6", "B10"],
        "rows": ["A5", "A4"]
--- a/keyboards/custommk/cmk11/rules.mk
+++ b/keyboards/custommk/cmk11/rules.mk
@ -1 +0,0 @@
-AUDIO_DRIVER = pwm_hardware
--- a/keyboards/custommk/ergostrafer/keyboard.json
+++ b/keyboards/custommk/ergostrafer/keyboard.json
@ -17,6 +17,9 @@
        "encoder": true,
        "audio": true
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "matrix_pins": {
        "cols": ["B0", "A1", "A2", "A3", "A6", "B6", "B10"],
        "rows": ["C13", "C14", "C15", "B1", "A7", "A5"]
--- a/keyboards/custommk/ergostrafer/rules.mk
+++ b/keyboards/custommk/ergostrafer/rules.mk
@ -1 +0,0 @@
-AUDIO_DRIVER = pwm_hardware
--- a/keyboards/custommk/evo70_r2/keyboard.json
+++ b/keyboards/custommk/evo70_r2/keyboard.json
@ -51,6 +51,9 @@
            "twinkle": true
        }
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "ws2812": {
        "driver": "pwm",
        "pin": "A10"
--- a/keyboards/custommk/evo70_r2/rules.mk
+++ b/keyboards/custommk/evo70_r2/rules.mk
@ -1,5 +1,3 @@
-AUDIO_DRIVER = pwm_hardware
-
 # project specific files
 SRC += matrix.c 

--- a/keyboards/handwired/macroboard/f411/keyboard.json
+++ b/keyboards/handwired/macroboard/f411/keyboard.json
@ -9,6 +9,9 @@
        "rows": ["A15", "B3", "B4", "B5", "B7"]
    },
    "diode_direction": "COL2ROW",
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "ws2812": {
        "driver": "pwm"
    },
--- a/keyboards/handwired/macroboard/f411/rules.mk
+++ b/keyboards/handwired/macroboard/f411/rules.mk
@ -1 +0,0 @@
-AUDIO_DRIVER = pwm_hardware
--- a/keyboards/handwired/tractyl_manuform/5x6_right/f303/keyboard.json
+++ b/keyboards/handwired/tractyl_manuform/5x6_right/f303/keyboard.json
@ -12,6 +12,9 @@
        "led_count": 20,
        "split_count": [10, 10]
    },
+    "audio": {
+        "driver": "dac_additive"
+    },
    "ws2812": {
        "pin": "A6",
        "driver": "pwm"
--- a/keyboards/handwired/tractyl_manuform/5x6_right/f303/rules.mk
+++ b/keyboards/handwired/tractyl_manuform/5x6_right/f303/rules.mk
@ -1,4 +1,3 @@
 # KEYBOARD_SHARED_EP = yes

 SERIAL_DRIVER = usart
-AUDIO_DRIVER  = dac_additive
--- a/keyboards/handwired/tractyl_manuform/5x6_right/f411/keyboard.json
+++ b/keyboards/handwired/tractyl_manuform/5x6_right/f411/keyboard.json
@ -15,6 +15,9 @@
    "build": {
        "debounce_type": "asym_eager_defer_pk"
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "ws2812": {
        "pin": "A1",
        "driver": "pwm"
--- a/keyboards/handwired/tractyl_manuform/5x6_right/f411/rules.mk
+++ b/keyboards/handwired/tractyl_manuform/5x6_right/f411/rules.mk
@ -2,4 +2,3 @@ KEYBOARD_SHARED_EP = yes
 MOUSE_SHARED_EP    = yes

 SERIAL_DRIVER = usart
-AUDIO_DRIVER  = pwm_hardware
--- a/keyboards/nack/keyboard.json
+++ b/keyboards/nack/keyboard.json
@ -17,6 +17,9 @@
        "rgb_matrix": true,
        "unicode": true
    },
+    "audio": {
+        "driver": "dac_basic"
+    },
    "ws2812": {
        "pin": "B5",
        "driver": "spi"
--- a/keyboards/nack/rules.mk
+++ b/keyboards/nack/rules.mk
@ -1 +0,0 @@
-AUDIO_DRIVER = dac_basic
--- a/keyboards/planck/ez/info.json
+++ b/keyboards/planck/ez/info.json
@ -75,6 +75,9 @@
    "rows": ["A10", "A9", "A8", "B15", "C13", "C14", "C15", "A2"]
  },
  "diode_direction": "COL2ROW",
+  "audio": {
+    "driver": "dac_additive"
+  },
  "encoder": {
    "rotary": [
      {"pin_a": "B12", "pin_b": "B13"}
--- a/keyboards/planck/ez/rules.mk
+++ b/keyboards/planck/ez/rules.mk
@ -1,5 +1,3 @@
-AUDIO_DRIVER = dac_additive
-
 RGBLIGHT_SUPPORTED = no
 BAKCLIGHT_SUPPORTED = no

--- a/keyboards/quokka/keyboard.json
+++ b/keyboards/quokka/keyboard.json
@ -13,6 +13,9 @@
        "oled": true,
        "rgb_matrix": true
    },
+    "audio": {
+        "driver": "pwm_hardware"
+    },
    "matrix_pins": {
        "cols": ["GP8", "GP7", "GP6", "GP5", "GP4"],
        "rows": ["GP10", "GP19", "GP20", "GP18"]
--- a/Show More
+++ b/Show More