[PATCH v4] dt-bindings: mfd: twl: Add missing sub-nodes for TWL4030 & TWL603x

Jihed Chaibi posted 1 patch 1 month ago
There is a newer version of this series
.../devicetree/bindings/mfd/ti,twl.yaml       | 208 +++++++++++++++++-
.../devicetree/bindings/mfd/twl4030-power.txt |  48 ----
.../devicetree/bindings/pwm/ti,twl-pwm.txt    |  17 --
.../devicetree/bindings/pwm/ti,twl-pwmled.txt |  17 --
4 files changed, 206 insertions(+), 84 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/mfd/twl4030-power.txt
delete mode 100644 Documentation/devicetree/bindings/pwm/ti,twl-pwm.txt
delete mode 100644 Documentation/devicetree/bindings/pwm/ti,twl-pwmled.txt
[PATCH v4] dt-bindings: mfd: twl: Add missing sub-nodes for TWL4030 & TWL603x
Posted by Jihed Chaibi 1 month ago
Update the main TI TWL-family binding to be self-contained and to fix
pre-existing validation errors.

Following maintainer feedback, the simple power and PWM bindings are
now defined directly within this file, and their legacy .txt files
are removed.

To ensure future patches are bisectable, child nodes whose bindings
are in other patches (audio, keypad, usb, etc.) are now defined using
a flexible 'additionalProperties: true' pattern. This removes hard
dependencies between the MFD and subsystem bindings.

The complete dtbs_check for this binding is clean except for two
warnings originating from pre-existing bugs in the OMAP DTS files,
for which fixes have already been submitted separately [1][2].

Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>

---
Changes in v4:
  - Reworked binding to be independent and bisectable per maintainer
    feedback by using 'additionalProperties: true' for child nodes.
  - Added board-specific compatibles to the 'power' node enum.
  - Added definitions for 'clocks' and 'clock-names' properties.
  - Renamed 'twl6030-usb' child node to 'usb-comparator' to match
    existing Device Tree usage (twl6030.dtsi).
  - Fixed some spelling/grammar erros in the description.

Changes in v3:
  - New patch to consolidate simple bindings (power, pwm) and add
    definitions for all child nodes to fix dtbs_check validation
    errors found in v2.

Changes in v2:
  - This patch is split from larger series [3] per maintainer feedback.
  - Added missing sub-node definitions, resolving dtbs_check errors.

[1] https://lore.kernel.org/all/20250822222530.113520-1-jihed.chaibi.dev@gmail.com/
[2] https://lore.kernel.org/all/20250822225052.136919-1-jihed.chaibi.dev@gmail.com/
[3] https://lore.kernel.org/all/20250816021523.167049-1-jihed.chaibi.dev@gmail.com/

---
 .../devicetree/bindings/mfd/ti,twl.yaml       | 208 +++++++++++++++++-
 .../devicetree/bindings/mfd/twl4030-power.txt |  48 ----
 .../devicetree/bindings/pwm/ti,twl-pwm.txt    |  17 --
 .../devicetree/bindings/pwm/ti,twl-pwmled.txt |  17 --
 4 files changed, 206 insertions(+), 84 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/mfd/twl4030-power.txt
 delete mode 100644 Documentation/devicetree/bindings/pwm/ti,twl-pwm.txt
 delete mode 100644 Documentation/devicetree/bindings/pwm/ti,twl-pwmled.txt

diff --git a/Documentation/devicetree/bindings/mfd/ti,twl.yaml b/Documentation/devicetree/bindings/mfd/ti,twl.yaml
index f162ab60c..444e2b2b5 100644
--- a/Documentation/devicetree/bindings/mfd/ti,twl.yaml
+++ b/Documentation/devicetree/bindings/mfd/ti,twl.yaml
@@ -11,9 +11,9 @@ maintainers:
 
 description: |
   The TWLs are Integrated Power Management Chips.
-  Some version might contain much more analog function like
+  Some versions might contain much more analog functionality like
   USB transceiver or Audio amplifier.
-  These chips are connected to an i2c bus.
+  These chips are connected to an I2C bus.
 
 allOf:
   - if:
@@ -76,6 +76,107 @@ allOf:
           properties:
             compatible:
               const: ti,twl4030-wdt
+
+        audio:
+          type: object
+          properties:
+            compatible: true
+          additionalProperties: true
+
+        keypad:
+          type: object
+          properties:
+            compatible: true
+          additionalProperties: true
+
+        pwm:
+          type: object
+          $ref: /schemas/pwm/pwm.yaml#
+          description: PWM1 and PWM2
+          properties:
+            compatible:
+              enum:
+                - ti,twl4030-pwm
+            '#pwm-cells':
+              const: 2
+          required:
+            - compatible
+            - '#pwm-cells'
+          additionalProperties: true
+
+        pwmled:
+          type: object
+          $ref: /schemas/pwm/pwm.yaml#
+          description: PWMA and PWMB (connected to LEDA & LEDB terminals)
+          properties:
+            compatible:
+              enum:
+                - ti,twl4030-pwmled
+            '#pwm-cells':
+              const: 2
+          required:
+            - compatible
+            - '#pwm-cells'
+          additionalProperties: true
+
+        twl4030-usb:
+          type: object
+          properties:
+            compatible: true
+          additionalProperties: true
+
+        gpio:
+          type: object
+          properties:
+            compatible: true
+          additionalProperties: true
+
+        power:
+          type: object
+          additionalProperties: false
+          description:
+            The power management module inside the TWL4030 provides several facilities
+            to control the power resources, including power scripts. For now, the
+            binding only supports the complete shutdown of the system after poweroff.
+          properties:
+            compatible:
+              description: |
+                The compatible string determines the specific power configuration.
+                Multiple compatible strings may be used to specify fallback configurations.
+                "ti,twl4030-power": Standard power control.
+                "ti,twl4030-power-reset": Recommended for OMAP3530 and similar SoCs
+                  that require a special configuration for warm reset to work correctly.
+                "ti,twl4030-power-idle": Loads the TI-recommended configuration for
+                  idle modes into the PMIC.
+                "ti,twl4030-power-idle-osc-off": Uses the recommended idle configuration
+                  but also shuts down the external oscillator. This may not work on all
+                  boards depending on the oscillator wiring.
+                Board-specific compatible strings may also be used.
+              maxItems: 2
+              items:
+                enum:
+                  - ti,twl4030-power
+                  - ti,twl4030-power-reset
+                  - ti,twl4030-power-idle
+                  - ti,twl4030-power-idle-osc-off
+                  - ti,twl4030-power-beagleboard-xm
+                  - ti,twl4030-power-omap3-evm
+                  - ti,twl4030-power-n900
+
+            ti,system-power-controller:
+              type: boolean
+              deprecated: true
+              description: |
+                DEPRECATED. The standard 'system-power-controller' property
+                on the parent node should be used instead.
+
+            ti,use_poweroff:
+              type: boolean
+              deprecated: true
+
+          required:
+            - compatible
+
   - if:
       properties:
         compatible:
@@ -115,6 +216,43 @@ allOf:
           properties:
             compatible:
               const: ti,twl6030-gpadc
+
+        pwm:
+          type: object
+          $ref: /schemas/pwm/pwm.yaml#
+          description: PWM0 and PWM1
+          properties:
+            compatible:
+              enum:
+                - ti,twl6030-pwm
+            '#pwm-cells':
+              const: 2
+          required:
+            - compatible
+            - '#pwm-cells'
+          additionalProperties: true
+
+        pwmled:
+          type: object
+          $ref: /schemas/pwm/pwm.yaml#
+          description: LED PWM (mainly used as charging indicator LED)
+          properties:
+            compatible:
+              enum:
+                - ti,twl6030-pwmled
+            '#pwm-cells':
+              const: 2
+          required:
+            - compatible
+            - '#pwm-cells'
+          additionalProperties: true
+
+        usb-comparator:
+          type: object
+          properties:
+            compatible: true
+          additionalProperties: true
+
   - if:
       properties:
         compatible:
@@ -154,6 +292,42 @@ allOf:
             compatible:
               const: ti,twl6032-gpadc
 
+        pwm:
+          type: object
+          $ref: /schemas/pwm/pwm.yaml#
+          description: PWM0 and PWM1
+          properties:
+            compatible:
+              enum:
+                - ti,twl6030-pwm
+            '#pwm-cells':
+              const: 2
+          required:
+            - compatible
+            - '#pwm-cells'
+          additionalProperties: true
+
+        pwmled:
+          type: object
+          $ref: /schemas/pwm/pwm.yaml#
+          description: LED PWM (mainly used as charging indicator LED)
+          properties:
+            compatible:
+              enum:
+                - ti,twl6030-pwmled
+            '#pwm-cells':
+              const: 2
+          required:
+            - compatible
+            - '#pwm-cells'
+          additionalProperties: true
+
+        usb-comparator:
+          type: object
+          properties:
+            compatible: true
+          additionalProperties: true
+
 properties:
   compatible:
     description:
@@ -181,6 +355,12 @@ properties:
   "#clock-cells":
     const: 1
 
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    const: fck
+
   charger:
     type: object
     additionalProperties: true
@@ -271,6 +451,16 @@ examples:
           compatible = "ti,twl6030-vmmc";
           ti,retain-on-reset;
         };
+
+        pwm {
+          compatible = "ti,twl6030-pwm";
+          #pwm-cells = <2>;
+        };
+
+        pwmled {
+          compatible = "ti,twl6030-pwmled";
+          #pwm-cells = <2>;
+        };
       };
     };
 
@@ -325,6 +515,20 @@ examples:
         watchdog {
           compatible = "ti,twl4030-wdt";
         };
+
+        power {
+          compatible = "ti,twl4030-power";
+        };
+
+        pwm {
+          compatible = "ti,twl4030-pwm";
+          #pwm-cells = <2>;
+        };
+
+        pwmled {
+          compatible = "ti,twl4030-pwmled";
+          #pwm-cells = <2>;
+        };
       };
     };
 ...
diff --git a/Documentation/devicetree/bindings/mfd/twl4030-power.txt b/Documentation/devicetree/bindings/mfd/twl4030-power.txt
deleted file mode 100644
index 3d1996331..000000000
--- a/Documentation/devicetree/bindings/mfd/twl4030-power.txt
+++ /dev/null
@@ -1,48 +0,0 @@
-Texas Instruments TWL family (twl4030) reset and power management module
-
-The power management module inside the TWL family provides several facilities
-to control the power resources, including power scripts. For now, the
-binding only supports the complete shutdown of the system after poweroff.
-
-Required properties:
-- compatible : must be one of the following
-	"ti,twl4030-power"
-	"ti,twl4030-power-reset"
-	"ti,twl4030-power-idle"
-	"ti,twl4030-power-idle-osc-off"
-
-The use of ti,twl4030-power-reset is recommended at least on
-3530 that needs a special configuration for warm reset to work.
-
-When using ti,twl4030-power-idle, the TI recommended configuration
-for idle modes is loaded to the tlw4030 PMIC.
-
-When using ti,twl4030-power-idle-osc-off, the TI recommended
-configuration is used with the external oscillator being shut
-down during off-idle. Note that this does not work on all boards
-depending on how the external oscillator is wired.
-
-Optional properties:
-
-- ti,system-power-controller: This indicates that TWL4030 is the
-  power supply master of the system. With this flag, the chip will
-  initiate an ACTIVE-to-OFF or SLEEP-to-OFF transition when the
-  system poweroffs.
-
-- ti,use_poweroff: Deprecated name for ti,system-power-controller
-
-Example:
-&i2c1 {
-	clock-frequency = <2600000>;
-
-	twl: twl@48 {
-		reg = <0x48>;
-		interrupts = <7>; /* SYS_NIRQ cascaded to intc */
-		interrupt-parent = <&intc>;
-
-		twl_power: power {
-			compatible = "ti,twl4030-power";
-			ti,use_poweroff;
-		};
-	};
-};
diff --git a/Documentation/devicetree/bindings/pwm/ti,twl-pwm.txt b/Documentation/devicetree/bindings/pwm/ti,twl-pwm.txt
deleted file mode 100644
index d97ca1964..000000000
--- a/Documentation/devicetree/bindings/pwm/ti,twl-pwm.txt
+++ /dev/null
@@ -1,17 +0,0 @@
-Texas Instruments TWL series PWM drivers
-
-Supported PWMs:
-On TWL4030 series: PWM1 and PWM2
-On TWL6030 series: PWM0 and PWM1
-
-Required properties:
-- compatible: "ti,twl4030-pwm" or "ti,twl6030-pwm"
-- #pwm-cells: should be 2. See pwm.yaml in this directory for a description of
-  the cells format.
-
-Example:
-
-twl_pwm: pwm {
-	compatible = "ti,twl6030-pwm";
-	#pwm-cells = <2>;
-};
diff --git a/Documentation/devicetree/bindings/pwm/ti,twl-pwmled.txt b/Documentation/devicetree/bindings/pwm/ti,twl-pwmled.txt
deleted file mode 100644
index 31ca1b032..000000000
--- a/Documentation/devicetree/bindings/pwm/ti,twl-pwmled.txt
+++ /dev/null
@@ -1,17 +0,0 @@
-Texas Instruments TWL series PWM drivers connected to LED terminals
-
-Supported PWMs:
-On TWL4030 series: PWMA and PWMB (connected to LEDA and LEDB terminals)
-On TWL6030 series: LED PWM (mainly used as charging indicator LED)
-
-Required properties:
-- compatible: "ti,twl4030-pwmled" or "ti,twl6030-pwmled"
-- #pwm-cells: should be 2. See pwm.yaml in this directory for a description of
-  the cells format.
-
-Example:
-
-twl_pwmled: pwmled {
-	compatible = "ti,twl6030-pwmled";
-	#pwm-cells = <2>;
-};
-- 
2.39.5
Re: [PATCH v4] dt-bindings: mfd: twl: Add missing sub-nodes for TWL4030 & TWL603x
Posted by Krzysztof Kozlowski 1 month ago
On Sat, Aug 30, 2025 at 02:14:21AM +0200, Jihed Chaibi wrote:
> Update the main TI TWL-family binding to be self-contained and to fix
> pre-existing validation errors.
> 
> Following maintainer feedback, the simple power and PWM bindings are
> now defined directly within this file, and their legacy .txt files
> are removed.
> 
> To ensure future patches are bisectable, child nodes whose bindings
> are in other patches (audio, keypad, usb, etc.) are now defined using
> a flexible 'additionalProperties: true' pattern. This removes hard
> dependencies between the MFD and subsystem bindings.
> 
> The complete dtbs_check for this binding is clean except for two
> warnings originating from pre-existing bugs in the OMAP DTS files,
> for which fixes have already been submitted separately [1][2].
> 
> Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
> 
> ---
> Changes in v4:
>   - Reworked binding to be independent and bisectable per maintainer
>     feedback by using 'additionalProperties: true' for child nodes.
>   - Added board-specific compatibles to the 'power' node enum.
>   - Added definitions for 'clocks' and 'clock-names' properties.
>   - Renamed 'twl6030-usb' child node to 'usb-comparator' to match
>     existing Device Tree usage (twl6030.dtsi).
>   - Fixed some spelling/grammar erros in the description.
> 
> Changes in v3:
>   - New patch to consolidate simple bindings (power, pwm) and add
>     definitions for all child nodes to fix dtbs_check validation
>     errors found in v2.
> 
> Changes in v2:
>   - This patch is split from larger series [3] per maintainer feedback.
>   - Added missing sub-node definitions, resolving dtbs_check errors.
> 
> [1] https://lore.kernel.org/all/20250822222530.113520-1-jihed.chaibi.dev@gmail.com/
> [2] https://lore.kernel.org/all/20250822225052.136919-1-jihed.chaibi.dev@gmail.com/
> [3] https://lore.kernel.org/all/20250816021523.167049-1-jihed.chaibi.dev@gmail.com/
> 
> ---
>  .../devicetree/bindings/mfd/ti,twl.yaml       | 208 +++++++++++++++++-
>  .../devicetree/bindings/mfd/twl4030-power.txt |  48 ----
>  .../devicetree/bindings/pwm/ti,twl-pwm.txt    |  17 --
>  .../devicetree/bindings/pwm/ti,twl-pwmled.txt |  17 --
>  4 files changed, 206 insertions(+), 84 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/mfd/twl4030-power.txt
>  delete mode 100644 Documentation/devicetree/bindings/pwm/ti,twl-pwm.txt
>  delete mode 100644 Documentation/devicetree/bindings/pwm/ti,twl-pwmled.txt
> 
> diff --git a/Documentation/devicetree/bindings/mfd/ti,twl.yaml b/Documentation/devicetree/bindings/mfd/ti,twl.yaml
> index f162ab60c..444e2b2b5 100644
> --- a/Documentation/devicetree/bindings/mfd/ti,twl.yaml
> +++ b/Documentation/devicetree/bindings/mfd/ti,twl.yaml
> @@ -11,9 +11,9 @@ maintainers:
>  
>  description: |
>    The TWLs are Integrated Power Management Chips.
> -  Some version might contain much more analog function like
> +  Some versions might contain much more analog functionality like
>    USB transceiver or Audio amplifier.
> -  These chips are connected to an i2c bus.
> +  These chips are connected to an I2C bus.
>  
>  allOf:
>    - if:
> @@ -76,6 +76,107 @@ allOf:
>            properties:
>              compatible:
>                const: ti,twl4030-wdt
> +
> +        audio:
> +          type: object
> +          properties:
> +            compatible: true

This should list the compatibles.

> +          additionalProperties: true
> +
> +        keypad:
> +          type: object
> +          properties:
> +            compatible: true
> +          additionalProperties: true
> +
> +        pwm:
> +          type: object
> +          $ref: /schemas/pwm/pwm.yaml#
> +          description: PWM1 and PWM2
> +          properties:
> +            compatible:
> +              enum:
> +                - ti,twl4030-pwm
> +            '#pwm-cells':
> +              const: 2
> +          required:
> +            - compatible
> +            - '#pwm-cells'
> +          additionalProperties: true

This cannot be true.

> +
> +        pwmled:
> +          type: object
> +          $ref: /schemas/pwm/pwm.yaml#
> +          description: PWMA and PWMB (connected to LEDA & LEDB terminals)
> +          properties:
> +            compatible:
> +              enum:
> +                - ti,twl4030-pwmled
> +            '#pwm-cells':
> +              const: 2
> +          required:
> +            - compatible
> +            - '#pwm-cells'
> +          additionalProperties: true

Cannot be true.

> +
> +        twl4030-usb:
> +          type: object
> +          properties:
> +            compatible: true

Missing compatibles.

> +          additionalProperties: true
> +
> +        gpio:
> +          type: object
> +          properties:
> +            compatible: true
> +          additionalProperties: true
> +
> +        power:
> +          type: object
> +          additionalProperties: false
> +          description:
> +            The power management module inside the TWL4030 provides several facilities
> +            to control the power resources, including power scripts. For now, the
> +            binding only supports the complete shutdown of the system after poweroff.
> +          properties:
> +            compatible:
> +              description: |
> +                The compatible string determines the specific power configuration.
> +                Multiple compatible strings may be used to specify fallback configurations.
> +                "ti,twl4030-power": Standard power control.
> +                "ti,twl4030-power-reset": Recommended for OMAP3530 and similar SoCs
> +                  that require a special configuration for warm reset to work correctly.
> +                "ti,twl4030-power-idle": Loads the TI-recommended configuration for
> +                  idle modes into the PMIC.
> +                "ti,twl4030-power-idle-osc-off": Uses the recommended idle configuration
> +                  but also shuts down the external oscillator. This may not work on all
> +                  boards depending on the oscillator wiring.
> +                Board-specific compatible strings may also be used.

Do not add descriptioons to compatible. You are just duplicating the
names. Look at other examples if you want to add description to actual
compatible for some reason.

> +              maxItems: 2
> +              items:
> +                enum:

I really do not know what you want to express here. This is not a
correct syntax.


> +                  - ti,twl4030-power
> +                  - ti,twl4030-power-reset
> +                  - ti,twl4030-power-idle
> +                  - ti,twl4030-power-idle-osc-off
> +                  - ti,twl4030-power-beagleboard-xm

This wasn't in original binding and I did not see explanation of changes
in the commit msg.

> +                  - ti,twl4030-power-omap3-evm
> +                  - ti,twl4030-power-n900
> +
> +            ti,system-power-controller:
> +              type: boolean
> +              deprecated: true
> +              description: |
> +                DEPRECATED. The standard 'system-power-controller' property
> +                on the parent node should be used instead.
> +
> +            ti,use_poweroff:
> +              type: boolean
> +              deprecated: true
> +
> +          required:
> +            - compatible
> +
>    - if:
>        properties:
>          compatible:
> @@ -115,6 +216,43 @@ allOf:
>            properties:
>              compatible:
>                const: ti,twl6030-gpadc
> +
> +        pwm:

Do not define properties in if: block, but in top level.

Best regards,
Krzysztof