Documentation/devicetree/bindings/hwmon/adi,axi-fan-control.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 # Copyright 2019 Analog Devices Inc.
   3 %YAML 1.2
   4 ---
   5 $id: http://devicetree.org/schemas/hwmon/adi,axi-fan-control.yaml#
   6 $schema: http://devicetree.org/meta-schemas/core.yaml#
   7
   8 title: Analog Devices AXI FAN Control Device Tree Bindings
   9
  10 maintainers:
  11   - Nuno Sá <nuno.sa@analog.com>
  12
  13 description: |+
  14   Bindings for the Analog Devices AXI FAN Control driver. Spefications of the
  15   core can be found in:
  16
  17   https://wiki.analog.com/resources/fpga/docs/axi_fan_control
  18
  19 properties:
  20   compatible:
  21     enum:
  22         - adi,axi-fan-control-1.00.a
  23
  24   reg:
  25     maxItems: 1
  26
  27   clocks:
  28     maxItems: 1
  29
  30   interrupts:
  31     maxItems: 1
  32
  33   pulses-per-revolution:
  34     description:
  35       Value specifying the number of pulses per revolution of the controlled
  36       FAN.
  37     $ref: /schemas/types.yaml#/definitions/uint32
  38     enum: [1, 2, 4]
  39
  40 required:
  41   - compatible
  42   - reg
  43   - clocks
  44   - interrupts
  45   - pulses-per-revolution
  46
  47 examples:
  48   - |
  49     fpga_axi: fpga-axi {
  50             #address-cells = <0x2>;
  51             #size-cells = <0x1>;
  52
  53             axi_fan_control: axi-fan-control@80000000 {
  54                     compatible = "adi,axi-fan-control-1.00.a";
  55                     reg = <0x0 0x80000000 0x10000>;
  56                     clocks = <&clk 71>;
  57                     interrupts = <0 110 0>;
  58                     pulses-per-revolution = <2>;
  59             };
  60     };
  61 ...