[PATCH v3 1/2] dt-bindings: power: supply: add support for MAX17201/MAX17205 fuel gauge

[PATCH v3 1/2] dt-bindings: power: supply: add support for MAX17201/MAX17205 fuel gauge

[Dimitri Fedrau]

Adding documentation for MAXIMs MAX17201/MAX17205 fuel gauge.

Signed-off-by: Dimitri Fedrau <dima.fedrau@gmail.com>
---
 .../bindings/power/supply/maxim,max1720x.yaml | 51 +++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/supply/maxim,max1720x.yaml

diff --git a/Documentation/devicetree/bindings/power/supply/maxim,max1720x.yaml b/Documentation/devicetree/bindings/power/supply/maxim,max1720x.yaml
new file mode 100644
index 000000000000..4414bc6f214f
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/maxim,max1720x.yaml
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/power/supply/maxim,max1720x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX1720x fuel gauge
+
+maintainers:
+  - Dimitri Fedrau <dima.fedrau@gmail.com>
+
+properties:
+  compatible:
+    const: maxim,max1720x
+
+  reg:
+    items:
+      - description: ModelGauge m5 registers
+      - description: Nonvolatile registers
+
+  reg-names:
+    items:
+      - const: m5
+      - const: nvmem
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - reg-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      max17201@36 {
+        compatible = "maxim,max1720x";
+        reg = <0x36>, <0xb>;
+        reg-names = "m5", "nvmem";
+        interrupt-parent = <&gpio0>;
+        interrupts = <31 IRQ_TYPE_LEVEL_LOW>;
+        status = "okay";
+      };
+    };
-- 
2.39.2

Re: [PATCH v3 1/2] dt-bindings: power: supply: add support for MAX17201/MAX17205 fuel gauge

[Krzysztof Kozlowski]

On 15/06/2024 22:33, Dimitri Fedrau wrote:
> Adding documentation for MAXIMs MAX17201/MAX17205 fuel gauge.
> 

Three patchsets within 30 minutes. No changelog et all.

Slow down (one posting per 24h) to give people chances to review. Then
provide changelog under --- and describe what happened.

> Signed-off-by: Dimitri Fedrau <dima.fedrau@gmail.com>
> ---
>  .../bindings/power/supply/maxim,max1720x.yaml | 51 +++++++++++++++++++
>  1 file changed, 51 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/power/supply/maxim,max1720x.yaml
> 
> diff --git a/Documentation/devicetree/bindings/power/supply/maxim,max1720x.yaml b/Documentation/devicetree/bindings/power/supply/maxim,max1720x.yaml
> new file mode 100644
> index 000000000000..4414bc6f214f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/supply/maxim,max1720x.yaml
> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/power/supply/maxim,max1720x.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Maxim MAX1720x fuel gauge
> +
> +maintainers:
> +  - Dimitri Fedrau <dima.fedrau@gmail.com>
> +
> +properties:
> +  compatible:
> +    const: maxim,max1720x

Nope, this must be specific.

Filename follows compatible then.

> +
> +  reg:
> +    items:
> +      - description: ModelGauge m5 registers
> +      - description: Nonvolatile registers
> +
> +  reg-names:
> +    items:
> +      - const: m5
> +      - const: nvmem
> +
> +  interrupts:
> +    maxItems: 1

This is incomplete. Missing battery and probably more... Look how other
bindings are written.

> +
> +required:
> +  - compatible
> +  - reg
> +  - reg-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      max17201@36 {

Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation


> +        compatible = "maxim,max1720x";
> +        reg = <0x36>, <0xb>;
> +        reg-names = "m5", "nvmem";
> +        interrupt-parent = <&gpio0>;
> +        interrupts = <31 IRQ_TYPE_LEVEL_LOW>;
> +        status = "okay";

Drop

Best regards,
Krzysztof

Re: [PATCH v3 1/2] dt-bindings: power: supply: add support for MAX17201/MAX17205 fuel gauge

[Dimitri Fedrau]

Am Sun, Jun 16, 2024 at 09:27:21AM +0200 schrieb Krzysztof Kozlowski:
> On 15/06/2024 22:33, Dimitri Fedrau wrote:
> > Adding documentation for MAXIMs MAX17201/MAX17205 fuel gauge.
> > 
> 
> Three patchsets within 30 minutes. No changelog et all.
>
Sorry, had to fix my mail address in the commit message. Changelog was
in the cover letter. Anyway, could have fixed that in a later version.

> Slow down (one posting per 24h) to give people chances to review. Then
> provide changelog under --- and describe what happened.
> 
[...]
> > +maintainers:
> > +  - Dimitri Fedrau <dima.fedrau@gmail.com>
> > +
> > +properties:
> > +      - description: ModelGauge m5 registers
> > +      - description: Nonvolatile registers
> > +
> > +  reg-names:
> > +    items:
> > +      - const: m5
> > +      - const: nvmem
> > +
> > +  interrupts:
> > +    maxItems: 1
> 
> This is incomplete. Missing battery and probably more... Look how other
> bindings are written.
> 
Some fuel gauges used monitored-battery and/or power-supplies others none
of them(mitsumi,mm8013.yaml). I'm not sure when to use them.

Best regards,
Dimitri Fedrau

Re: [PATCH v3 1/2] dt-bindings: power: supply: add support for MAX17201/MAX17205 fuel gauge

[Krzysztof Kozlowski]

On 17/06/2024 14:59, Dimitri Fedrau wrote:
> Am Sun, Jun 16, 2024 at 09:27:21AM +0200 schrieb Krzysztof Kozlowski:
>> On 15/06/2024 22:33, Dimitri Fedrau wrote:
>>> Adding documentation for MAXIMs MAX17201/MAX17205 fuel gauge.
>>>
>>
>> Three patchsets within 30 minutes. No changelog et all.
>>
> Sorry, had to fix my mail address in the commit message. Changelog was
> in the cover letter. Anyway, could have fixed that in a later version.

There was no cover letter attached to this patchset. If you do not send
cover letter to interested parties, then it does not count.

> 
>> Slow down (one posting per 24h) to give people chances to review. Then
>> provide changelog under --- and describe what happened.
>>
> [...]
>>> +maintainers:
>>> +  - Dimitri Fedrau <dima.fedrau@gmail.com>
>>> +
>>> +properties:
>>> +      - description: ModelGauge m5 registers
>>> +      - description: Nonvolatile registers
>>> +
>>> +  reg-names:
>>> +    items:
>>> +      - const: m5
>>> +      - const: nvmem
>>> +
>>> +  interrupts:
>>> +    maxItems: 1
>>
>> This is incomplete. Missing battery and probably more... Look how other
>> bindings are written.
>>
> Some fuel gauges used monitored-battery and/or power-supplies others none
> of them(mitsumi,mm8013.yaml). I'm not sure when to use them.

Look at your hardware, datasheet if it is available. Then look at
monitored battery properties. If you see anything in common, then that's
a sign.

I did not get your driver changes, so I cannot help here. Kind of your call.

Best regards,
Krzysztof