diff mbox series

[v2,2/2] dt-bindings: hwmon: Add AXI FAN Control documentation

Message ID 20191009102806.262241-2-nuno.sa@analog.com (mailing list archive)
State Accepted
Headers show
Series [v2,1/2] hwmon: Support ADI Fan Control IP | expand

Commit Message

Nuno Sa Oct. 9, 2019, 10:28 a.m. UTC
Document the AXI FAN Control IP core devicetree bindings.

Signed-off-by: Nuno Sá <nuno.sa@analog.com>
---
Changes in v2:
 * Set the correct license for new bindings;
 * Fix wrong compatible in the example;
 * Wrap long line;
 * Update adi,pulses-per-revolution with accepted values.

 .../bindings/hwmon/adi,axi-fan-control.yaml   | 62 +++++++++++++++++++
 MAINTAINERS                                   |  1 +
 2 files changed, 63 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml

Comments

Rob Herring (Arm) Oct. 11, 2019, 4:59 p.m. UTC | #1
On Wed, Oct 09, 2019 at 12:28:06PM +0200, Nuno Sá wrote:
> Document the AXI FAN Control IP core devicetree bindings.
> 
> Signed-off-by: Nuno Sá <nuno.sa@analog.com>
> ---
> Changes in v2:
>  * Set the correct license for new bindings;
>  * Fix wrong compatible in the example;
>  * Wrap long line;
>  * Update adi,pulses-per-revolution with accepted values.
> 
>  .../bindings/hwmon/adi,axi-fan-control.yaml   | 62 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  2 files changed, 63 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml b/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
> new file mode 100644
> index 000000000000..dc82b9748c9d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
> @@ -0,0 +1,62 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright 2019 Analog Devices Inc.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/bindings/hwmon/adi,axi-fan-control.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices AXI FAN Control Device Tree Bindings
> +
> +maintainers:
> +  - Nuno Sá <nuno.sa@analog.com>
> +
> +description: |+
> +  Bindings for the Analog Devices AXI FAN Control driver. Spefications of the
> +  core can be found in:
> +
> +  https://wiki.analog.com/resources/fpga/docs/axi_fan_control
> +
> +properties:
> +  compatible:
> +    enum:
> +        - adi,axi-fan-control-1.00.a
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  adi,pulses-per-revolution:

We already have 'pulses-per-revolution' in pwm-fan binding, so use that.

With that changed,

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

> +    description:
> +      Value specifying the number of pulses per revolution of the controlled
> +      FAN.
> +    allOf:
> +      - $ref: /schemas/types.yaml#/definitions/uint32
> +    enum: [1, 2, 4]
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - interrupts
> +  - adi,pulses-per-revolution
> +
> +examples:
> +  - |
> +    fpga_axi: fpga-axi@0 {
> +            #address-cells = <0x2>;
> +            #size-cells = <0x1>;
> +
> +            axi_fan_control: axi-fan-control@80000000 {
> +                    compatible = "adi,axi-fan-control-1.00.a";
> +                    reg = <0x0 0x80000000 0x10000>;
> +                    clocks = <&clk 71>;
> +                    interrupts = <0 110 0>;
> +                    adi,pulses-per-revolution = <2>;
> +            };
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index caa80ae1925e..74ddcb3e1fd9 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -2879,6 +2879,7 @@ W:	http://ez.analog.com/community/linux-device-drivers
>  L:	linux-hwmon@vger.kernel.org
>  S:	Supported
>  F:	drivers/hwmon/axi-fan-control.c
> +F:	Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
>  
>  AXXIA I2C CONTROLLER
>  M:	Krzysztof Adamski <krzysztof.adamski@nokia.com>
> -- 
> 2.23.0
>
Guenter Roeck Oct. 20, 2019, 4:12 p.m. UTC | #2
On Wed, Oct 09, 2019 at 12:28:06PM +0200, Nuno Sá wrote:
> Document the AXI FAN Control IP core devicetree bindings.
> 
> Signed-off-by: Nuno Sá <nuno.sa@analog.com>
> Reviewed-by: Rob Herring <robh@kernel.org>

Applied to hwmon-next.

Thanks,
Guenter

> ---
> Changes in v2:
>  * Set the correct license for new bindings;
>  * Fix wrong compatible in the example;
>  * Wrap long line;
>  * Update adi,pulses-per-revolution with accepted values.
> 
>  .../bindings/hwmon/adi,axi-fan-control.yaml   | 62 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  2 files changed, 63 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml b/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
> new file mode 100644
> index 000000000000..dc82b9748c9d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
> @@ -0,0 +1,62 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright 2019 Analog Devices Inc.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/bindings/hwmon/adi,axi-fan-control.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices AXI FAN Control Device Tree Bindings
> +
> +maintainers:
> +  - Nuno Sá <nuno.sa@analog.com>
> +
> +description: |+
> +  Bindings for the Analog Devices AXI FAN Control driver. Spefications of the
> +  core can be found in:
> +
> +  https://wiki.analog.com/resources/fpga/docs/axi_fan_control
> +
> +properties:
> +  compatible:
> +    enum:
> +        - adi,axi-fan-control-1.00.a
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  adi,pulses-per-revolution:
> +    description:
> +      Value specifying the number of pulses per revolution of the controlled
> +      FAN.
> +    allOf:
> +      - $ref: /schemas/types.yaml#/definitions/uint32
> +    enum: [1, 2, 4]
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - interrupts
> +  - adi,pulses-per-revolution
> +
> +examples:
> +  - |
> +    fpga_axi: fpga-axi@0 {
> +            #address-cells = <0x2>;
> +            #size-cells = <0x1>;
> +
> +            axi_fan_control: axi-fan-control@80000000 {
> +                    compatible = "adi,axi-fan-control-1.00.a";
> +                    reg = <0x0 0x80000000 0x10000>;
> +                    clocks = <&clk 71>;
> +                    interrupts = <0 110 0>;
> +                    adi,pulses-per-revolution = <2>;
> +            };
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index caa80ae1925e..74ddcb3e1fd9 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -2879,6 +2879,7 @@ W:	http://ez.analog.com/community/linux-device-drivers
>  L:	linux-hwmon@vger.kernel.org
>  S:	Supported
>  F:	drivers/hwmon/axi-fan-control.c
> +F:	Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
>  
>  AXXIA I2C CONTROLLER
>  M:	Krzysztof Adamski <krzysztof.adamski@nokia.com>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml b/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
new file mode 100644
index 000000000000..dc82b9748c9d
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
@@ -0,0 +1,62 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright 2019 Analog Devices Inc.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/bindings/hwmon/adi,axi-fan-control.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices AXI FAN Control Device Tree Bindings
+
+maintainers:
+  - Nuno Sá <nuno.sa@analog.com>
+
+description: |+
+  Bindings for the Analog Devices AXI FAN Control driver. Spefications of the
+  core can be found in:
+
+  https://wiki.analog.com/resources/fpga/docs/axi_fan_control
+
+properties:
+  compatible:
+    enum:
+        - adi,axi-fan-control-1.00.a
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  adi,pulses-per-revolution:
+    description:
+      Value specifying the number of pulses per revolution of the controlled
+      FAN.
+    allOf:
+      - $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [1, 2, 4]
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - interrupts
+  - adi,pulses-per-revolution
+
+examples:
+  - |
+    fpga_axi: fpga-axi@0 {
+            #address-cells = <0x2>;
+            #size-cells = <0x1>;
+
+            axi_fan_control: axi-fan-control@80000000 {
+                    compatible = "adi,axi-fan-control-1.00.a";
+                    reg = <0x0 0x80000000 0x10000>;
+                    clocks = <&clk 71>;
+                    interrupts = <0 110 0>;
+                    adi,pulses-per-revolution = <2>;
+            };
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index caa80ae1925e..74ddcb3e1fd9 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2879,6 +2879,7 @@  W:	http://ez.analog.com/community/linux-device-drivers
 L:	linux-hwmon@vger.kernel.org
 S:	Supported
 F:	drivers/hwmon/axi-fan-control.c
+F:	Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml
 
 AXXIA I2C CONTROLLER
 M:	Krzysztof Adamski <krzysztof.adamski@nokia.com>