diff mbox series

[v4,1/4] Documentation: ti,tps6594: Add DT bindings for the TPS6594x PMIC

Message ID 20221118092218.480147-2-mranostay@ti.com
State New
Headers show
Series [v4,1/4] Documentation: ti,tps6594: Add DT bindings for the TPS6594x PMIC | expand

Commit Message

Matt Ranostay Nov. 18, 2022, 9:22 a.m. UTC
Add documentation for the TPS6594x PMIC including its RTC and GPIO
functionalities.

Signed-off-by: Matt Ranostay <mranostay@ti.com>
---
 .../devicetree/bindings/mfd/ti,tps6594.yaml   | 65 +++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/ti,tps6594.yaml

Comments

Matt Ranostay Nov. 19, 2022, 4:23 a.m. UTC | #1
On Fri, Nov 18, 2022 at 11:21:57AM +0100, Krzysztof Kozlowski wrote:
> On 18/11/2022 10:22, Matt Ranostay wrote:
> > Add documentation for the TPS6594x PMIC including its RTC and GPIO
> > functionalities.
> > 
> 
> This is a friendly reminder during the review process.
> 
> It seems my previous comments were not fully addressed. Maybe my
> feedback got lost between the quotes, maybe you just forgot to apply it.
> Please go back to the previous discussion and either implement all
> requested changes or keep discussing them.
>
I missed serveral feedback suggestions in the last revision. Will try to be
a little more careful in the future.

> Thank you.
> 
> The comment was about proper subject prefix. Drop also redundant, second
> "DT bindings" from the subject.
> 
> 
> > Signed-off-by: Matt Ranostay <mranostay@ti.com>
> > ---
> >  .../devicetree/bindings/mfd/ti,tps6594.yaml   | 65 +++++++++++++++++++
> >  1 file changed, 65 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/mfd/ti,tps6594.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/mfd/ti,tps6594.yaml b/Documentation/devicetree/bindings/mfd/ti,tps6594.yaml
> > new file mode 100644
> > index 000000000000..81613bcef39d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/mfd/ti,tps6594.yaml
> > @@ -0,0 +1,65 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/mfd/ti,tps6594x.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: TPS6594x Power Management Integrated Circuit (PMIC)
> > +
> > +maintainers:
> > +  - Keerthy <j-keerthy@ti.com>
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - ti,tps6594
> 
> tps6594 is the model name? So what was previous tps6594x used also in
> title? This does not look correct.
>

So the actual part number is TPS6594-Q1. Would tps6594q1 be more concise
for naming across the device tree, and drivers?

- Matt

> > +
> > +  reg:
> > +    const: 0x48
> > +
> > +  ti,system-power-controller:
> > +    type: boolean
> > +    description: PMIC is controlling the system power.
> > +
> > +  rtc:
> > +    type: object
> > +    $ref: /schemas/rtc/rtc.yaml#
> > +    unevaluatedProperties: false
> > +    properties:
> > +      compatible:
> > +        const: ti,tps6594-rtc
> 
> Same problem.
> 
> > +
> > +  gpio:
> > +    type: object
> > +    unevaluatedProperties: false
> > +    properties:
> > +      compatible:
> > +        const: ti,tps6594x-gpio
> 
> 
> Not fixed.
> 
> 
> 
> > +
> > +additionalProperties: false
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +examples:
> > +  - |
> > +    i2c0 {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        pmic: pmic@48 {
> > +            compatible = "ti,tps6594";
> > +            reg = <0x48>;
> > +
> > +            rtc {
> > +                compatible = "ti,tps6594-rtc";
> > +            };
> > +
> > +            gpio {
> > +                compatible = "ti,tps6594-gpio";
> 
> Does not look like you tested the bindings. Please run `make
> dt_binding_check` (see
> Documentation/devicetree/bindings/writing-schema.rst for instructions).
> 
> 
> Best regards,
> Krzysztof
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/mfd/ti,tps6594.yaml b/Documentation/devicetree/bindings/mfd/ti,tps6594.yaml
new file mode 100644
index 000000000000..81613bcef39d
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/ti,tps6594.yaml
@@ -0,0 +1,65 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/ti,tps6594x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TPS6594x Power Management Integrated Circuit (PMIC)
+
+maintainers:
+  - Keerthy <j-keerthy@ti.com>
+
+properties:
+  compatible:
+    enum:
+      - ti,tps6594
+
+  reg:
+    const: 0x48
+
+  ti,system-power-controller:
+    type: boolean
+    description: PMIC is controlling the system power.
+
+  rtc:
+    type: object
+    $ref: /schemas/rtc/rtc.yaml#
+    unevaluatedProperties: false
+    properties:
+      compatible:
+        const: ti,tps6594-rtc
+
+  gpio:
+    type: object
+    unevaluatedProperties: false
+    properties:
+      compatible:
+        const: ti,tps6594x-gpio
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    i2c0 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        pmic: pmic@48 {
+            compatible = "ti,tps6594";
+            reg = <0x48>;
+
+            rtc {
+                compatible = "ti,tps6594-rtc";
+            };
+
+            gpio {
+                compatible = "ti,tps6594-gpio";
+            };
+        };
+    };
+
+...