Skip to contentSkip to conversation

dt-bindings: mfd: Convert TI TWL6040 to DT schema

PATCH Superseded Eduard Bostina 2 participants 3 messages Aug 15

Subsystems (2)

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dt-bindings: mfd: Convert TI TWL6040 to DT schema

Convert the Texas Instruments TWL6040 audio codecs family bindings to DT schema.

During the conversion, the following updates were made:
- Changed 'twl6040,audpwron-gpio' to 'ti,audpwron-gpio', which was misnamed in the old txt binding.
- Made 'gpio-controller', '#gpio-cells', and 'ti,audpwron-gpio' optional because modern platforms do not require them.

---
 .../devicetree/bindings/mfd/ti,twl6040.yaml   | 142 ++++++++++++++++++
 .../devicetree/bindings/mfd/twl6040.txt       |  67 ---------
 2 files changed, 142 insertions(+), 67 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mfd/ti,twl6040.yaml
 delete mode 100644 Documentation/devicetree/bindings/mfd/twl6040.txt
Documentation/devicetree/bindings/mfd/ti,twl6040.yaml new file +142 -0
new file mode 100644
index 000000000000..a93835aa9153
@@ -0,0 +1,142 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/ti,twl6040.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments TWL6040 family audio codec
+
+maintainers:
+  - Eduard Bostina <[email protected]>
+
+description:
+  The TWL6040s are 8-channel high quality low-power audio codecs providing
+  audio, vibra and GPO functionality on OMAP4+ platforms. They are connected
+  to the host processor via i2c for commands, McPDM for audio data and
+  commands.
+
+properties:
+  compatible:
+    enum:
+      - ti,twl6040
+      - ti,twl6041
+
+  reg:
+    const: 0x4b
+
+  interrupts:
+    maxItems: 1
+
+  gpio-controller: true
+
+  "#gpio-cells":
+    const: 1
+
+  "#clock-cells":
+    const: 0
+
+  ti,audpwron-gpio:
+    maxItems: 1
+    description: Power on GPIO line for the twl6040
+
+  vio-supply:
+    description: Regulator for the twl6040 VIO supply
+
+  v2v1-supply:
+    description: Regulator for the twl6040 V2V1 supply
+
+  enable-active-high:
+    type: boolean
+    description: To power on the twl6040 during boot.
+
+  clocks:
+    minItems: 1
+    maxItems: 2
+
+  clock-names:
+    minItems: 1
+    maxItems: 2
+    items:
+      enum:
+        - clk32k
+        - mclk
+
+  vddvibl-supply:
+    description: Regulator for the left vibra motor
+
+  vddvibr-supply:
+    description: Regulator for the right vibra motor
+
+  vibra:
+    type: object
+    additionalProperties: false
+    properties:
+      ti,vibldrv-res:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: Resistance parameter for left driver
+      ti,vibrdrv-res:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: Resistance parameter for right driver
+      ti,viblmotor-res:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: Resistance parameter for left motor
+      ti,vibrmotor-res:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: Resistance parameter for right motor
+      vddvibl_uV:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: vddvibl default voltage if it needs to be changed
+      vddvibr_uV:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: vddvibr default voltage if it needs to be changed
+
+    required:
+      - ti,vibldrv-res
+      - ti,vibrdrv-res
+      - ti,viblmotor-res
+      - ti,vibrmotor-res
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - "#clock-cells"
+  - vio-supply
+  - v2v1-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        audio-codec@4b {
+            compatible = "ti,twl6040";
+            reg = <0x4b>;
+            interrupts = <0 119 IRQ_TYPE_LEVEL_HIGH>;
+            interrupt-parent = <&gic>;
+            gpio-controller;
+            #gpio-cells = <1>;
+            #clock-cells = <0>;
+            ti,audpwron-gpio = <&gpio4 31 0>;
+
+            vio-supply = <&v1v8>;
+            v2v1-supply = <&v2v1>;
+            enable-active-high;
+
+            /* regulators for vibra motor */
+            vddvibl-supply = <&vbat>;
+            vddvibr-supply = <&vbat>;
+
+            vibra {
+                ti,vibldrv-res = <8>;
+                ti,vibrdrv-res = <3>;
+                ti,viblmotor-res = <10>;
+                ti,vibrmotor-res = <10>;
+            };
+        };
+    };
Documentation/devicetree/bindings/mfd/twl6040.txt deleted +0 -67

67 lines not on this page · raw message

Signature · 1 line
2.43.0
#1 lore raw
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] The YAML schema defines incorrect property names for the vibra default voltages, mismatching the…

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] The YAML schema defines incorrect property names for the vibra default voltages, mismatching the driver's requirements and breaking schema validation. --

--- Patch [1]: [PATCH] dt-bindings: mfd: Convert TI TWL6040 to DT schema --- commit c57af8c690b680b78b9119a5988e020149e24c1e
Author: Eduard Bostina <[email protected]>

dt-bindings: mfd: Convert TI TWL6040 to DT schema

Convert the Texas Instruments TWL6040 audio codecs family bindings to DT schema.

Quoted 5 lines
Documentation/devicetree/bindings/mfd/ti,twl6040.yaml new file +0 -0
new file mode 100644
index 0000000000000..a93835aa91535

[ ... ]

Documentation/devicetree/bindings/mfd/ti,twl6040.yaml line 91

Quoted 9 lines
Documentation/devicetree/bindings/mfd/ti,twl6040.yaml new file +9 -0
+      ti,vibrmotor-res:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: Resistance parameter for right motor
+      vddvibl_uV:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: vddvibl default voltage if it needs to be changed
+      vddvibr_uV:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: vddvibr default voltage if it needs to be changed

[Severity: Medium]
Does this incorrectly define the property names for the vibra default voltages?

The twl6040-vibra driver actually expects these properties to be hyphenated and have a "ti," prefix. For example, in drivers/input/misc/twl6040-vibra.c:

twl6040_vibra_probe() {
    ...
    of_property_read_u32(twl6040_core_node, "ti,vddvibl-uV", &vddvibl_uV);
    of_property_read_u32(twl6040_core_node, "ti,vddvibr-uV", &vddvibr_uV);
    ...
}

Since the vibra object sets "additionalProperties: false", won't valid device trees using "ti,vddvibl-uV" fail schema validation?

Conversely, if a device tree uses "vddvibl_uV" to satisfy this schema, won't it be silently ignored by the driver at runtime?

Quoted 6 lines
Documentation/devicetree/bindings/mfd/ti,twl6040.yaml new file +6 -0
+
+    required:
+      - ti,vibldrv-res
+      - ti,vibrdrv-res
+      - ti,viblmotor-res
+      - ti,vibrmotor-res
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
#2 lore raw
Quoted 58 lines · On Sat, Aug 15, 2026 at 11:46 AM <[email protected]> wrote:

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] The YAML schema defines incorrect property names for the vibra default voltages, mismatching the driver's requirements and breaking schema validation. --

--- Patch [1]: [PATCH] dt-bindings: mfd: Convert TI TWL6040 to DT schema --- commit c57af8c690b680b78b9119a5988e020149e24c1e
Author: Eduard Bostina <[email protected]>

dt-bindings: mfd: Convert TI TWL6040 to DT schema

Convert the Texas Instruments TWL6040 audio codecs family bindings to DT schema.

Quoted 5 lines
Documentation/devicetree/bindings/mfd/ti,twl6040.yaml new file +0 -0
new file mode 100644
index 0000000000000..a93835aa91535

[ ... ]

Documentation/devicetree/bindings/mfd/ti,twl6040.yaml line 91

Quoted 9 lines
Documentation/devicetree/bindings/mfd/ti,twl6040.yaml new file +9 -0
+      ti,vibrmotor-res:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: Resistance parameter for right motor
+      vddvibl_uV:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: vddvibl default voltage if it needs to be changed
+      vddvibr_uV:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: vddvibr default voltage if it needs to be changed

[Severity: Medium]
Does this incorrectly define the property names for the vibra default voltages?

The twl6040-vibra driver actually expects these properties to be hyphenated and have a "ti," prefix. For example, in drivers/input/misc/twl6040-vibra.c:

twl6040_vibra_probe() {
    ...
    of_property_read_u32(twl6040_core_node, "ti,vddvibl-uV", &vddvibl_uV);
    of_property_read_u32(twl6040_core_node, "ti,vddvibr-uV", &vddvibr_uV);
    ...
}

Since the vibra object sets "additionalProperties: false", won't valid device trees using "ti,vddvibl-uV" fail schema validation?

Conversely, if a device tree uses "vddvibl_uV" to satisfy this schema, won't it be silently ignored by the driver at runtime?

Documentation/devicetree/bindings/mfd/ti,twl6040.yaml line 97

Quoted 6 lines
Documentation/devicetree/bindings/mfd/ti,twl6040.yaml new file +6 -0
+
+    required:
+      - ti,vibldrv-res
+      - ti,vibrdrv-res
+      - ti,viblmotor-res
+      - ti,vibrmotor-res
Quoted 2 lines

--
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1

No in-tree device tree uses these two optional properties, so dtbs_check never caught them, and I carried the names over from the old txt binding.
I'll fix them in v2.