Convert the legacy TXT binding for the TWL4030 power module to the modern YAML DT schema format. This adds formal validation and improves documentation. Changes in v2: Simplified the description field by removing redundant '|' as it does not affect formatting in this context. Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@xxxxxxxxx> --- .../bindings/mfd/ti,twl4030-power.yaml | 69 +++++++++++++++++++ .../devicetree/bindings/mfd/twl4030-power.txt | 48 ------------- 2 files changed, 69 insertions(+), 48 deletions(-) create mode 100644 Documentation/devicetree/bindings/mfd/ti,twl4030-power.yaml delete mode 100644 Documentation/devicetree/bindings/mfd/twl4030-power.txt diff --git a/Documentation/devicetree/bindings/mfd/ti,twl4030-power.yaml b/Documentation/devicetree/bindings/mfd/ti,twl4030-power.yaml new file mode 100644 index 000000000..713e2facf --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/ti,twl4030-power.yaml @@ -0,0 +1,69 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/ti,twl4030-power.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Texas Instruments TWL4030-family Power Management Module + +maintainers: + - Peter Ujfalusi <peter.ujfalusi@xxxxxxxxx> + +description: + 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. + +properties: + compatible: + description: | + The compatible string determines the specific power configuration. + "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. + + enum: + - ti,twl4030-power + - ti,twl4030-power-reset + - ti,twl4030-power-idle + - ti,twl4030-power-idle-osc-off + + ti,system-power-controller: + type: boolean + description: + Indicates that the TWL4030 is the power supply master of the system, + allowing it to initiate system power-off. + + ti,use_poweroff: + type: boolean + description: Deprecated name for ti,system-power-controller. + deprecated: true + +required: + - compatible + +additionalProperties: false + +examples: + - | + i2c { + clock-frequency = <2600000>; + #address-cells = <1>; + #size-cells = <0>; + + 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/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; - }; - }; -}; -- 2.39.5
