[PATCH v3 1/2] dt-bindings: regulator: add PF0900 regulator yaml

Joy Zou posted 2 patches 2 months ago
[PATCH v3 1/2] dt-bindings: regulator: add PF0900 regulator yaml
Posted by Joy Zou 2 months ago
Add device binding doc for PF0900 PMIC driver.

Can not get the I2C_CRC_EN config by reading register. If the PMIC
OTP_I2C_CRC_EN is enable, need to add the nxp,i2c-crc-enable property.

Signed-off-by: Joy Zou <joy.zou@nxp.com>
---
Changes for v3:
1. change regulator node names into lowercase.
2. add the following description for nxp,i2c-crc-enable.
   The CRC enabled during register read/write. Controlled by customer
   unviewable fuse bits OTP_I2C_CRC_EN. Check chip part number.
   So can not get the I2C_CRC_EN config by reading register.
   If the PMIC OTP_I2C_CRC_EN is enable, need to add this
   property.
3. add more nxp,i2c-crc-enable description for commit message.
4. remove the unnecessary nxp,dvs-run/standby-voltage.
   These changes come from review comments:
   https://lore.kernel.org/imx/e9f38e38-7df7-4d19-b5c0-2f18aeebcc78@kernel.org/
5. add regulator-state-mem property for example.

Changes for v2:
1. modify the binding file name to match compatible string.
2. add one space for dt_binding_check warning.
3. remove unnecessary quotes from "VAON".
4. remove the unnecessary empty line.
5. move unevaluatedProperties after the $ref.
6. move additionalProperties after regulator type.
7. remove unnecessary regulator description
---
 .../devicetree/bindings/regulator/nxp,pf0900.yaml  | 163 +++++++++++++++++++++
 1 file changed, 163 insertions(+)

diff --git a/Documentation/devicetree/bindings/regulator/nxp,pf0900.yaml b/Documentation/devicetree/bindings/regulator/nxp,pf0900.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..8c8fc2cd4cedb0bef220d73f5cbc9a5f83072608
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/nxp,pf0900.yaml
@@ -0,0 +1,163 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/regulator/nxp,pf0900.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP PF0900 Power Management Integrated Circuit regulators
+
+maintainers:
+  - Joy Zou <joy.zou@nxp.com>
+
+description:
+  The PF0900 is a power management integrated circuit (PMIC) optimized
+  for high performance i.MX9x based applications. It features five high
+  efficiency buck converters, three linear and one vaon regulators. It
+  provides low quiescent current in Standby and low power off Modes.
+
+properties:
+  compatible:
+    enum:
+      - nxp,pf0900
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  regulators:
+    type: object
+    additionalProperties: false
+
+    properties:
+      vaon:
+        type: object
+        $ref: regulator.yaml#
+        unevaluatedProperties: false
+
+    patternProperties:
+      "^ldo[1-3]$":
+        type: object
+        $ref: regulator.yaml#
+        unevaluatedProperties: false
+
+      "^sw[1-5]$":
+        type: object
+        $ref: regulator.yaml#
+        unevaluatedProperties: false
+
+  nxp,i2c-crc-enable:
+    type: boolean
+    description:
+      The CRC enabled during register read/write. Controlled by customer
+      unviewable fuse bits OTP_I2C_CRC_EN. Check chip part number.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - regulators
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        pmic@8 {
+            compatible = "nxp,pf0900";
+            reg = <0x08>;
+            interrupt-parent = <&pcal6524>;
+            interrupts = <89 IRQ_TYPE_LEVEL_LOW>;
+            nxp,i2c-crc-enable;
+
+            regulators {
+                vaon {
+                    regulator-name = "VAON";
+                    regulator-min-microvolt = <1800000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                };
+
+                sw1 {
+                    regulator-name = "SW1";
+                    regulator-min-microvolt = <500000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                    regulator-ramp-delay = <1950>;
+                    regulator-state-mem {
+                        regulator-on-in-suspend;
+                        regulator-suspend-max-microvolt = <650000>;
+                        regulator-suspend-min-microvolt = <650000>;
+                    };
+                };
+
+                sw2 {
+                    regulator-name = "SW2";
+                    regulator-min-microvolt = <300000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                    regulator-ramp-delay = <1950>;
+                };
+
+                sw3 {
+                    regulator-name = "SW3";
+                    regulator-min-microvolt = <300000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                    regulator-ramp-delay = <1950>;
+                };
+
+                sw4 {
+                    regulator-name = "SW4";
+                    regulator-min-microvolt = <300000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                    regulator-ramp-delay = <1950>;
+                };
+
+                sw5 {
+                    regulator-name = "SW5";
+                    regulator-min-microvolt = <300000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                    regulator-ramp-delay = <1950>;
+                };
+
+                ldo1 {
+                    regulator-name = "LDO1";
+                    regulator-min-microvolt = <750000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                };
+
+                ldo2 {
+                    regulator-name = "LDO2";
+                    regulator-min-microvolt = <650000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                };
+
+                ldo3 {
+                    regulator-name = "LDO3";
+                    regulator-min-microvolt = <650000>;
+                    regulator-max-microvolt = <3300000>;
+                    regulator-boot-on;
+                    regulator-always-on;
+                };
+            };
+        };
+     };

-- 
2.37.1
Re: [PATCH v3 1/2] dt-bindings: regulator: add PF0900 regulator yaml
Posted by Rob Herring 2 months ago
On Thu, Jul 31, 2025 at 06:44:41PM +0800, Joy Zou wrote:
> Add device binding doc for PF0900 PMIC driver.
> 
> Can not get the I2C_CRC_EN config by reading register. If the PMIC
> OTP_I2C_CRC_EN is enable, need to add the nxp,i2c-crc-enable property.
> 
> Signed-off-by: Joy Zou <joy.zou@nxp.com>
> ---
> Changes for v3:
> 1. change regulator node names into lowercase.
> 2. add the following description for nxp,i2c-crc-enable.
>    The CRC enabled during register read/write. Controlled by customer
>    unviewable fuse bits OTP_I2C_CRC_EN. Check chip part number.
>    So can not get the I2C_CRC_EN config by reading register.
>    If the PMIC OTP_I2C_CRC_EN is enable, need to add this
>    property.
> 3. add more nxp,i2c-crc-enable description for commit message.
> 4. remove the unnecessary nxp,dvs-run/standby-voltage.
>    These changes come from review comments:
>    https://lore.kernel.org/imx/e9f38e38-7df7-4d19-b5c0-2f18aeebcc78@kernel.org/
> 5. add regulator-state-mem property for example.
> 
> Changes for v2:
> 1. modify the binding file name to match compatible string.
> 2. add one space for dt_binding_check warning.
> 3. remove unnecessary quotes from "VAON".
> 4. remove the unnecessary empty line.
> 5. move unevaluatedProperties after the $ref.
> 6. move additionalProperties after regulator type.
> 7. remove unnecessary regulator description
> ---
>  .../devicetree/bindings/regulator/nxp,pf0900.yaml  | 163 +++++++++++++++++++++
>  1 file changed, 163 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/regulator/nxp,pf0900.yaml b/Documentation/devicetree/bindings/regulator/nxp,pf0900.yaml
> new file mode 100644
> index 0000000000000000000000000000000000000000..8c8fc2cd4cedb0bef220d73f5cbc9a5f83072608
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/nxp,pf0900.yaml
> @@ -0,0 +1,163 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/nxp,pf0900.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NXP PF0900 Power Management Integrated Circuit regulators
> +
> +maintainers:
> +  - Joy Zou <joy.zou@nxp.com>
> +
> +description:
> +  The PF0900 is a power management integrated circuit (PMIC) optimized
> +  for high performance i.MX9x based applications. It features five high
> +  efficiency buck converters, three linear and one vaon regulators. It
> +  provides low quiescent current in Standby and low power off Modes.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - nxp,pf0900
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  regulators:
> +    type: object
> +    additionalProperties: false
> +
> +    properties:
> +      vaon:
> +        type: object
> +        $ref: regulator.yaml#
> +        unevaluatedProperties: false
> +
> +    patternProperties:
> +      "^ldo[1-3]$":
> +        type: object
> +        $ref: regulator.yaml#
> +        unevaluatedProperties: false
> +
> +      "^sw[1-5]$":
> +        type: object
> +        $ref: regulator.yaml#
> +        unevaluatedProperties: false
> +
> +  nxp,i2c-crc-enable:
> +    type: boolean
> +    description:
> +      The CRC enabled during register read/write. Controlled by customer
> +      unviewable fuse bits OTP_I2C_CRC_EN. Check chip part number.
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - regulators
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        pmic@8 {
> +            compatible = "nxp,pf0900";
> +            reg = <0x08>;
> +            interrupt-parent = <&pcal6524>;
> +            interrupts = <89 IRQ_TYPE_LEVEL_LOW>;
> +            nxp,i2c-crc-enable;
> +
> +            regulators {
> +                vaon {
> +                    regulator-name = "VAON";
> +                    regulator-min-microvolt = <1800000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                };
> +
> +                sw1 {
> +                    regulator-name = "SW1";
> +                    regulator-min-microvolt = <500000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                    regulator-ramp-delay = <1950>;
> +                    regulator-state-mem {
> +                        regulator-on-in-suspend;
> +                        regulator-suspend-max-microvolt = <650000>;
> +                        regulator-suspend-min-microvolt = <650000>;
> +                    };
> +                };
> +
> +                sw2 {
> +                    regulator-name = "SW2";
> +                    regulator-min-microvolt = <300000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                    regulator-ramp-delay = <1950>;
> +                };
> +
> +                sw3 {
> +                    regulator-name = "SW3";
> +                    regulator-min-microvolt = <300000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                    regulator-ramp-delay = <1950>;
> +                };
> +
> +                sw4 {
> +                    regulator-name = "SW4";
> +                    regulator-min-microvolt = <300000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                    regulator-ramp-delay = <1950>;
> +                };
> +
> +                sw5 {
> +                    regulator-name = "SW5";
> +                    regulator-min-microvolt = <300000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                    regulator-ramp-delay = <1950>;
> +                };
> +
> +                ldo1 {
> +                    regulator-name = "LDO1";
> +                    regulator-min-microvolt = <750000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                };
> +
> +                ldo2 {
> +                    regulator-name = "LDO2";
> +                    regulator-min-microvolt = <650000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                };
> +
> +                ldo3 {
> +                    regulator-name = "LDO3";
> +                    regulator-min-microvolt = <650000>;
> +                    regulator-max-microvolt = <3300000>;
> +                    regulator-boot-on;
> +                    regulator-always-on;
> +                };
> +            };
> +        };
> +     };

Wrong indentation. Otherwise,

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>

Rob