Skip to contentSkip to conversation

dt-bindings: mfd: as3722: Convert to DT schema

PATCH In review Shaunak Datar 3 participants 3 messages Sep 14 – Sep 18

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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

Convert the AS3722 PMIC binding from the text format to YAML Schema to enable DT Schema validation.

---
 .../devicetree/bindings/mfd/ams,as3722.yaml   | 230 ++++++++++++++++++
 .../devicetree/bindings/mfd/as3722.txt        | 214 ----------------
 2 files changed, 230 insertions(+), 214 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mfd/ams,as3722.yaml
 delete mode 100644 Documentation/devicetree/bindings/mfd/as3722.txt
Documentation/devicetree/bindings/mfd/ams,as3722.yaml new file +230 -0
new file mode 100644
index 000000000000..065537f50e06
@@ -0,0 +1,230 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/ams,as3722.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ams AS3722 Power Management Integrated Circuit
+
+maintainers:
+  - Laxman Dewangan <[email protected]>
+
+properties:
+  compatible:
+    const: ams,as3722
+
+  reg:
+    description: I2C device address.
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  interrupt-controller: true
+
+  "#interrupt-cells":
+    const: 2
+    description: |
+      Should be set to 2 for IRQ number and flags.
+      The first cell is the IRQ number. IRQ numbers for different interrupt
+      source of AS3722 are defined at dt-bindings/mfd/as3722.h
+      The second cell is the flags, encoded as the trigger masks from
+      dt-bindings/interrupt-controller/irq.h
+
+  gpio-controller: true
+
+  "#gpio-cells":
+    const: 2
+    description:
+      The first cell is the pin number and the second cell is used to
+      specify the GPIO polarity.
+
+  ams,enable-internal-int-pullup:
+    type: boolean
+    description:
+      Boolean property, to enable internal pullup on interrupt pin. Missing
+      this will disable internal pullup on INT pin.
+
+  ams,enable-internal-i2c-pullup:
+    type: boolean
+    description:
+      Boolean property, to enable internal pullup on i2c scl/sda pins.
+      Missing this will disable internal pullup on i2c scl/sda lines.
+
+  ams,enable-ac-ok-power-on:
+    type: boolean
+    description:
+      Boolean property, to enable exit out of power off mode with AC_OK pin
+      (pin enabled in power off mode).
+
+  ams,system-power-controller:
+    type: boolean
+    description:
+      Boolean, to enable the power off functionality through this device.
+
+  pinmux:
+    type: object
+    additionalProperties: false
+    description:
+      Pin control setting at boot. Each subnode represents some desired
+      configuration for a list of pins. This configuration can include the
+      mux function to select on those pin(s), and various pin configuration
+      parameters, such as pull-up, open drain.
+
+    patternProperties:
+      "^gpio[0-9_-]+$":
+        type: object
+        $ref: /schemas/pinctrl/pinmux-node.yaml#
+        unevaluatedProperties: false
+
+        properties:
+          pins:
+            description: List of pins.
+            items:
+              enum: [gpio0, gpio1, gpio2, gpio3, gpio4, gpio5, gpio6, gpio7]
+
+          function:
+            enum: [gpio, interrupt-out, gpio-in-interrupt,
+                   vsup-vbat-low-undebounce-out, vsup-vbat-low-debounce-out,
+                   voltage-in-standby, oc-pg-sd0, oc-pg-sd6, powergood-out,
+                   pwm-in, pwm-out, clk32k-out, watchdog-in, soft-reset-in]
+
+          bias-disable: true
+          bias-pull-up: true
+          bias-pull-down: true
+          bias-high-impedance: true
+          drive-open-drain: true
+
+        required:
+          - pins
+
+  regulators:
+    type: object
+    additionalProperties: false
+    description:
+      Container for the regulator subnodes and their input supplies.
+
+    properties:
+      vsup-sd2-supply:
+        description: Input supply for SD2.
+      vsup-sd3-supply:
+        description: Input supply for SD3.
+      vsup-sd4-supply:
+        description: Input supply for SD4.
+      vsup-sd5-supply:
+        description: Input supply for SD5.
+      vin-ldo0-supply:
+        description: Input supply for LDO0.
+      vin-ldo1-6-supply:
+        description: Input supply for LDO1 and LDO6.
+      vin-ldo2-5-7-supply:
+        description: Input supply for LDO2, LDO5 and LDO7.
+      vin-ldo3-4-supply:
+        description: Input supply for LDO3 and LDO4.
+      vin-ldo9-10-supply:
+        description: Input supply for LDO9 and LDO10.
+      vin-ldo11-supply:
+        description: Input supply for LDO11.
+
+    patternProperties:
+      "^(sd[0-6]|ldo[0-79]|ldo1[01])$":
+        type: object
+        $ref: /schemas/regulator/regulator.yaml#
+        unevaluatedProperties: false
+
+        properties:
+          ams,ext-control:
+            $ref: /schemas/types.yaml#/definitions/uint32
+            enum: [0, 1, 2, 3]
+            description: |
+              External control of the rail. The option of this properties
+              will tell which external input is controlling this rail.
+              Valid values are 0, 1, 2 and 3.
+                0: There is no external control of this rail.
+                1: Rail is controlled by ENABLE1 input pin.
+                2: Rail is controlled by ENABLE2 input pin.
+                3: Rail is controlled by ENABLE3 input pin.
+              Missing this property on DT will be assumed as no external
+              control. The external control pin macros are defined at
+              dt-bindings/mfd/as3722.h
+
+          ams,enable-tracking:
+            type: boolean
+            description:
+              Enable tracking with SD1, only supported by LDO3.
+
+required:
+  - compatible
+  - reg
+  - interrupt-controller
+  - "#interrupt-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/mfd/as3722.h>
+
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        pmic@40 {
+            compatible = "ams,as3722";
+            reg = <0x40>;
+            interrupts = <GIC_SPI 86 IRQ_TYPE_LEVEL_HIGH>;
+
+            ams,system-power-controller;
+
+            interrupt-controller;
+            #interrupt-cells = <2>;
+
+            gpio-controller;
+            #gpio-cells = <2>;
+
+            pinctrl-names = "default";
+            pinctrl-0 = <&as3722_default>;
+
+            as3722_default: pinmux {
+                gpio0 {
+                    pins = "gpio0";
+                    function = "gpio";
+                    bias-pull-down;
+                };
+
+                gpio1_2_4_7 {
+                    pins = "gpio1", "gpio2", "gpio4", "gpio7";
+                    function = "gpio";
+                    bias-pull-up;
+                };
+
+                gpio3_5_6 {
+                    pins = "gpio3", "gpio5", "gpio6";
+                    bias-high-impedance;
+                };
+            };
+
+            regulators {
+                vsup-sd2-supply = <&vdd_5v0_sys>;
+                vsup-sd3-supply = <&vdd_5v0_sys>;
+                vin-ldo0-supply = <&vdd_1v35_lp0>;
+
+                sd0 {
+                    regulator-name = "vdd_cpu";
+                    regulator-min-microvolt = <700000>;
+                    regulator-max-microvolt = <1400000>;
+                    regulator-always-on;
+                    ams,ext-control = <AS3722_EXT_CONTROL_PIN_ENABLE2>;
+                };
+
+                ldo3 {
+                    regulator-name = "vdd_rtc";
+                    regulator-min-microvolt = <1200000>;
+                    regulator-max-microvolt = <1200000>;
+                    regulator-always-on;
+                    ams,enable-tracking;
+                };
+            };
+        };
+    };
Documentation/devicetree/bindings/mfd/as3722.txt deleted +0 -214

214 lines not on this page · raw message

base-commit: cba2348ab114391f5b1a00fa65c5b739f13f0563

Signature · 1 line
2.54.0
#1 lore raw
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:

Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:

New issues:
- [Medium] The YAML schema artificially restricts the PMIC to a single pinmux state node by hardcoding the node name to pinmux.
- [Medium] The interrupts property is missing from the required list in the YAML binding despite being strictly required by the MFD driver.

Pre-existing issues:
- [High] The regulator driver incorrectly rejects ams,ext-control = <3>, preventing configuration of the ENABLE3 external control pin. --

commit a75df0e5820c75f9d84e306c3842971fc178f5d3
Author: Shaunak Datar <[email protected]>

dt-bindings: mfd: as3722: Convert to DT schema

Convert the AS3722 PMIC binding from the text format to YAML Schema to enable DT Schema validation.

Quoted 5 lines
Documentation/devicetree/bindings/mfd/ams,as3722.yaml new file +0 -0
new file mode 100644
index 0000000000000..065537f50e063

[ ... ]

Documentation/devicetree/bindings/mfd/ams,as3722.yaml line 67

Quoted 8 lines
Documentation/devicetree/bindings/mfd/ams,as3722.yaml new file +8 -0
+  ams,system-power-controller:
+    type: boolean
+    description:
+      Boolean, to enable the power off functionality through this device.
+
+  pinmux:
+    type: object
+    additionalProperties: false

[Severity: Medium]
Does this hardcoded node name artificially restrict the PMIC to a single pinmux state node?

Device trees requiring multiple pinctrl states (e.g., default and sleep) will fail schema validation if they define multiple state nodes. The schema uses a fixed pinmux property name and additionalProperties: false on the root, which rejects any other node names. Would it be better to use patternProperties (e.g., "^pinmux(-[a-z0-9-]+)?$") to allow multiple state nodes?

Quoted 2 lines
Documentation/devicetree/bindings/mfd/ams,as3722.yaml new file +2 -0
+    description:
+      Pin control setting at boot. Each subnode represents some desired

[ ... ]

Documentation/devicetree/bindings/mfd/ams,as3722.yaml line 160

Quoted 10 lines
Documentation/devicetree/bindings/mfd/ams,as3722.yaml new file +10 -0
+          ams,enable-tracking:
+            type: boolean
+            description:
+              Enable tracking with SD1, only supported by LDO3.
+
+required:
+  - compatible
+  - reg
+  - interrupt-controller
+  - "#interrupt-cells"

[Severity: Medium]
Is the interrupts property missing from this required list?

The PMIC driver unconditionally fails to probe with -EINVAL at runtime if the interrupt is absent (as3722_i2c_probe() calls irq_get_irq_data(i2c->irq)). Device trees missing the interrupts property will silently pass schema validation but fail at runtime. Adding interrupts to the required list would accurately reflect the hardware and driver dependencies.

[ ... ]

While reviewing this binding conversion, I also noticed a pre-existing issue in the regulator driver.

drivers/regulator/as3722-regulator.c:as3722_get_regulator_dt_data() {
    ...
		ret = of_property_read_u32(reg_node, "ams,ext-control", &prop);
		if (!ret) {
			if (prop < 3)
				reg_config->ext_control = prop;
			else
				dev_warn(&pdev->dev,
					"ext-control have invalid option: %u\n",
					prop);
		}
    ...
}

[Severity: High]
This is a pre-existing issue, but does this off-by-one check incorrectly reject ams,ext-control = <3>?

A valid device tree specifying ams,ext-control = <3> is validated with if (prop < 3), which rejects 3, warns the user, and defaults to 0 (no external control), despite as3722_extreg_init() explicitly supporting AS3722_EXT_CONTROL_ENABLE3 (3). Should this check be prop <= 3 so the ENABLE3 hardware pin can be correctly configured?

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
maintainer Reviewed-by on v1 1/1
#2 lore raw
In reply to Shaunak Datar
Quoted 11 lines · Shaunak Datar

Convert the AS3722 PMIC binding from the text format to YAML Schema to enable DT Schema validation.

---
 .../devicetree/bindings/mfd/ams,as3722.yaml   | 230 ++++++++++++++++++
 .../devicetree/bindings/mfd/as3722.txt        | 214 ----------------
 2 files changed, 230 insertions(+), 214 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mfd/ams,as3722.yaml
 delete mode 100644 Documentation/devicetree/bindings/mfd/as3722.txt