[PATCH v1 3/4] dt-bindings: hwmon: Add binding for max6639

[PATCH v1 3/4] dt-bindings: hwmon: Add binding for max6639

[Marcello Sylvester Bauer]

Add Devicetree binding documentation for Maxim MAX6639 temperature
monitor with PWM fan-speed controller.

The devicetree documentation for the SD3078 device tree.

Signed-off-by: Marcello Sylvester Bauer <sylv@sylv.io>
---
 .../bindings/hwmon/maxim,max6639.yaml         | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml

diff --git a/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml b/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
new file mode 100644
index 000000000000..136ed37b6aac
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
@@ -0,0 +1,71 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+
+$id: http://devicetree.org/schemas/hwmon/maxim,max6639.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim max6639
+
+maintainers:
+  - Roland Stigge <stigge@antcom.de>
+
+description: |
+  The MAX6639 is a 2-channel temperature monitor with dual, automatic, PWM
+  fan-speed controller.  It monitors its own temperature and one external
+  diode-connected transistor or the temperatures of two external diode-connected
+  transistors, typically available in CPUs, FPGAs, or GPUs.
+
+  Datasheets:
+    https://datasheets.maximintegrated.com/en/ds/MAX6639-MAX6639F.pdf
+
+properties:
+  compatible:
+    enum:
+      - maxim,max6639
+
+  reg:
+    maxItems: 1
+
+  polarity:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [0, 1]
+    description:
+      PWM output is low at 100% duty cycle when this bit is set to zero. PWM
+      output is high at 100% duty cycle when this bit is set to 1.
+      Fans PWM polarity is set to high (1) by default.
+
+  pulses-per-revolution:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [1, 2, 3, 4]
+    description:
+      Value specifying the number of pulses per revolution of the controlled
+      FAN.
+
+  rpm-range:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [2000, 4000, 8000, 16000]
+    description:
+      Scales the tachometer counter by setting the maximum (full-scale) value
+      of the RPM range.
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      max6639@10 {
+        compatible = "maxim,max6639";
+        reg = <0x10>;
+        polarity = <1>;
+        pulses-per-revolution = <2>;
+        rpm-range = <4000>;
+      };
+    };
-- 
2.33.1

[PATCH v1 3/4] dt-bindings: hwmon: Add binding for max6639

[Marcello Sylvester Bauer]

Add Devicetree binding documentation for Maxim MAX6639 temperature
monitor with PWM fan-speed controller.

The devicetree documentation for the SD3078 device tree.

Signed-off-by: Marcello Sylvester Bauer <sylv@sylv.io>
---
 .../bindings/hwmon/maxim,max6639.yaml         | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml

diff --git a/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml b/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
new file mode 100644
index 000000000000..136ed37b6aac
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
@@ -0,0 +1,71 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+
+$id: http://devicetree.org/schemas/hwmon/maxim,max6639.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim max6639
+
+maintainers:
+  - Roland Stigge <stigge@antcom.de>
+
+description: |
+  The MAX6639 is a 2-channel temperature monitor with dual, automatic, PWM
+  fan-speed controller.  It monitors its own temperature and one external
+  diode-connected transistor or the temperatures of two external diode-connected
+  transistors, typically available in CPUs, FPGAs, or GPUs.
+
+  Datasheets:
+    https://datasheets.maximintegrated.com/en/ds/MAX6639-MAX6639F.pdf
+
+properties:
+  compatible:
+    enum:
+      - maxim,max6639
+
+  reg:
+    maxItems: 1
+
+  polarity:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [0, 1]
+    description:
+      PWM output is low at 100% duty cycle when this bit is set to zero. PWM
+      output is high at 100% duty cycle when this bit is set to 1.
+      Fans PWM polarity is set to high (1) by default.
+
+  pulses-per-revolution:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [1, 2, 3, 4]
+    description:
+      Value specifying the number of pulses per revolution of the controlled
+      FAN.
+
+  rpm-range:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [2000, 4000, 8000, 16000]
+    description:
+      Scales the tachometer counter by setting the maximum (full-scale) value
+      of the RPM range.
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      max6639@10 {
+        compatible = "maxim,max6639";
+        reg = <0x10>;
+        polarity = <1>;
+        pulses-per-revolution = <2>;
+        rpm-range = <4000>;
+      };
+    };
-- 
2.33.1

Re: [PATCH v1 3/4] dt-bindings: hwmon: Add binding for max6639

[Guenter Roeck]

On Mon, Jan 03, 2022 at 05:33:48PM +0100, Marcello Sylvester Bauer wrote:
> Add Devicetree binding documentation for Maxim MAX6639 temperature
> monitor with PWM fan-speed controller.
> 
> The devicetree documentation for the SD3078 device tree.
> 
> Signed-off-by: Marcello Sylvester Bauer <sylv@sylv.io>
> ---
>  .../bindings/hwmon/maxim,max6639.yaml         | 71 +++++++++++++++++++
>  1 file changed, 71 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml b/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
> new file mode 100644
> index 000000000000..136ed37b6aac
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
> @@ -0,0 +1,71 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +
> +$id: http://devicetree.org/schemas/hwmon/maxim,max6639.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Maxim max6639
> +
> +maintainers:
> +  - Roland Stigge <stigge@antcom.de>
> +
> +description: |
> +  The MAX6639 is a 2-channel temperature monitor with dual, automatic, PWM
> +  fan-speed controller.  It monitors its own temperature and one external
> +  diode-connected transistor or the temperatures of two external diode-connected
> +  transistors, typically available in CPUs, FPGAs, or GPUs.
> +
> +  Datasheets:
> +    https://datasheets.maximintegrated.com/en/ds/MAX6639-MAX6639F.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - maxim,max6639
> +
> +  reg:
> +    maxItems: 1
> +
> +  polarity:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    enum: [0, 1]
> +    description:
> +      PWM output is low at 100% duty cycle when this bit is set to zero. PWM
> +      output is high at 100% duty cycle when this bit is set to 1.
> +      Fans PWM polarity is set to high (1) by default.

Should probably be pwm-polarity.

> +
> +  pulses-per-revolution:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    enum: [1, 2, 3, 4]
> +    description:
> +      Value specifying the number of pulses per revolution of the controlled
> +      FAN.

Is there a fan in the world with pulses-per-revolution == 3 ?
Valid values should probably be 1, 2, 4.

> +
> +  rpm-range:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    enum: [2000, 4000, 8000, 16000]
> +    description:
> +      Scales the tachometer counter by setting the maximum (full-scale) value
> +      of the RPM range.

The above need to be per channel in devicetree data.

On higher level, max6639_platform_data should be removed entirely.
It isn't used by any in-kernel driver, and all its parameters are
per device and not per channel as they should be.

Guenter

> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      max6639@10 {
> +        compatible = "maxim,max6639";
> +        reg = <0x10>;
> +        polarity = <1>;
> +        pulses-per-revolution = <2>;
> +        rpm-range = <4000>;
> +      };
> +    };

Re: [PATCH v1 3/4] dt-bindings: hwmon: Add binding for max6639

[sylv]

Hi Guenter,

Thanks for your review.

On Sun, 2022-01-09 at 17:22 -0800, Guenter Roeck wrote:
> On Mon, Jan 03, 2022 at 05:33:48PM +0100, Marcello Sylvester Bauer wrote:
> > Add Devicetree binding documentation for Maxim MAX6639 temperature
> > monitor with PWM fan-speed controller.
> > 
> > The devicetree documentation for the SD3078 device tree.
> > 
> > Signed-off-by: Marcello Sylvester Bauer <sylv@sylv.io>
> > ---
> >  .../bindings/hwmon/maxim,max6639.yaml         | 71 +++++++++++++++++++
> >  1 file changed, 71 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml b/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
> > new file mode 100644
> > index 000000000000..136ed37b6aac
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/hwmon/maxim,max6639.yaml
> > @@ -0,0 +1,71 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +
> > +$id: http://devicetree.org/schemas/hwmon/maxim,max6639.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Maxim max6639
> > +
> > +maintainers:
> > +  - Roland Stigge <stigge@antcom.de>
> > +
> > +description: |
> > +  The MAX6639 is a 2-channel temperature monitor with dual, automatic, PWM
> > +  fan-speed controller.  It monitors its own temperature and one external
> > +  diode-connected transistor or the temperatures of two external diode-connected
> > +  transistors, typically available in CPUs, FPGAs, or GPUs.
> > +
> > +  Datasheets:
> > +    https://datasheets.maximintegrated.com/en/ds/MAX6639-MAX6639F.pdf
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - maxim,max6639
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  polarity:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    enum: [0, 1]
> > +    description:
> > +      PWM output is low at 100% duty cycle when this bit is set to zero. PWM
> > +      output is high at 100% duty cycle when this bit is set to 1.
> > +      Fans PWM polarity is set to high (1) by default.
> 
> Should probably be pwm-polarity.
> 

indeed.

> > +
> > +  pulses-per-revolution:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    enum: [1, 2, 3, 4]
> > +    description:
> > +      Value specifying the number of pulses per revolution of the controlled
> > +      FAN.
> 
> Is there a fan in the world with pulses-per-revolution == 3 ?
> Valid values should probably be 1, 2, 4.
> 

No sure but regarding the data sheet, it is a valid value for ppr:
https://datasheets.maximintegrated.com/en/ds/MAX6639-MAX6639F.pdf
Page 16, Table 10

In my view we should keep it, since the IC does allow this values to be
set accordingly.

> > +
> > +  rpm-range:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    enum: [2000, 4000, 8000, 16000]
> > +    description:
> > +      Scales the tachometer counter by setting the maximum (full-scale) value
> > +      of the RPM range.
> 
> The above need to be per channel in devicetree data.
> 
> On higher level, max6639_platform_data should be removed entirely.
> It isn't used by any in-kernel driver, and all its parameters are
> per device and not per channel as they should be.

Sounds great. In this way we could get rid of get_pdata_from_dt_node
and make it easier to add additional proprieties in future.

I'll adapt v2 to implement this change.

Marcello

> 
> Guenter
> 
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    i2c {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +
> > +      max6639@10 {
> > +        compatible = "maxim,max6639";
> > +        reg = <0x10>;
> > +        polarity = <1>;
> > +        pulses-per-revolution = <2>;
> > +        rpm-range = <4000>;
> > +      };
> > +    };