Re: [PATCH v2 1/3] dt-bindings: hwmon: g762: Convert to yaml schema

From: Guenter Roeck
Date: Wed May 29 2024 - 18:48:24 EST


On Sun, May 26, 2024 at 08:45:23PM +0200, Christian Marangi wrote:
> Convert g762 Documentation to yaml schema.
>
> Since it supports various device, change the name to g76x and add the
> vendor prefix.

The file name should not change. This document does not cover g76[0,4-9],
after all.

Guenter

>
> Signed-off-by: Christian Marangi <ansuelsmth@xxxxxxxxx>
> ---
> .../devicetree/bindings/hwmon/g762.txt | 47 -----------
> .../devicetree/bindings/hwmon/gmt,g76x.yaml | 83 +++++++++++++++++++
> 2 files changed, 83 insertions(+), 47 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/hwmon/g762.txt
> create mode 100644 Documentation/devicetree/bindings/hwmon/gmt,g76x.yaml
>
> diff --git a/Documentation/devicetree/bindings/hwmon/g762.txt b/Documentation/devicetree/bindings/hwmon/g762.txt
> deleted file mode 100644
> index 6d154c4923de..000000000000
> --- a/Documentation/devicetree/bindings/hwmon/g762.txt
> +++ /dev/null
> @@ -1,47 +0,0 @@
> -GMT G762/G763 PWM Fan controller
> -
> -Required node properties:
> -
> - - "compatible": must be either "gmt,g762" or "gmt,g763"
> - - "reg": I2C bus address of the device
> - - "clocks": a fixed clock providing input clock frequency
> - on CLK pin of the chip.
> -
> -Optional properties:
> -
> - - "fan_startv": fan startup voltage. Accepted values are 0, 1, 2 and 3.
> - The higher the more.
> -
> - - "pwm_polarity": pwm polarity. Accepted values are 0 (positive duty)
> - and 1 (negative duty).
> -
> - - "fan_gear_mode": fan gear mode. Supported values are 0, 1 and 2.
> -
> -If an optional property is not set in .dts file, then current value is kept
> -unmodified (e.g. u-boot installed value).
> -
> -Additional information on operational parameters for the device is available
> -in Documentation/hwmon/g762.rst. A detailed datasheet for the device is available
> -at http://natisbad.org/NAS/refs/GMT_EDS-762_763-080710-0.2.pdf.
> -
> -Example g762 node:
> -
> - clocks {
> - #address-cells = <1>;
> - #size-cells = <0>;
> -
> - g762_clk: fixedclk {
> - compatible = "fixed-clock";
> - #clock-cells = <0>;
> - clock-frequency = <8192>;
> - }
> - }
> -
> - g762: g762@3e {
> - compatible = "gmt,g762";
> - reg = <0x3e>;
> - clocks = <&g762_clk>
> - fan_gear_mode = <0>; /* chip default */
> - fan_startv = <1>; /* chip default */
> - pwm_polarity = <0>; /* chip default */
> - };
> diff --git a/Documentation/devicetree/bindings/hwmon/gmt,g76x.yaml b/Documentation/devicetree/bindings/hwmon/gmt,g76x.yaml
> new file mode 100644
> index 000000000000..bfefe49f54bf
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/gmt,g76x.yaml
> @@ -0,0 +1,83 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/hwmon/gmt,g76x.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: GMT G762/G763 PWM Fan controller
> +
> +maintainers:
> + - Christian Marangi <ansuelsmth@xxxxxxxxx>
> +
> +description: |
> + GMT G762/G763 PWM Fan controller.
> +
> + If an optional property is not set in DT, then current value is kept
> + unmodified (e.g. bootloader installed value).
> +
> + Additional information on operational parameters for the device is available
> + in Documentation/hwmon/g762.rst. A detailed datasheet for the device is available
> + at http://natisbad.org/NAS/refs/GMT_EDS-762_763-080710-0.2.pdf.
> +
> +properties:
> + compatible:
> + enum:
> + - gmt,g762
> + - gmt,g763
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + description: a fixed clock providing input clock frequency on CLK
> + pin of the chip.
> + maxItems: 1
> +
> + fan_startv:
> + description: Fan startup voltage step
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [0, 1, 2, 3]
> +
> + pwm_polarity:
> + description: PWM polarity (psotivie or negative duty)
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [0, 1]
> +
> + fan_gear_mode:
> + description: FAN gear mode. Configure High speed fan setting factor
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [0, 1, 2]
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + clocks {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + g762_clk: fixedclk {
> + compatible = "fixed-clock";
> + #clock-cells = <0>;
> + clock-frequency = <8192>;
> + };
> + };
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + g762@3e {
> + compatible = "gmt,g762";
> + reg = <0x3e>;
> + clocks = <&g762_clk>;
> + fan_gear_mode = <0>;
> + fan_startv = <1>;
> + pwm_polarity = <0>;
> + };
> + };