hwmon: (gpio-fan) allow to use alarm support alone from DT
[firefly-linux-kernel-4.4.55.git] / Documentation / devicetree / bindings / gpio / gpio-fan.txt
1 Bindings for fan connected to GPIO lines
2
3 Required properties:
4 - compatible : "gpio-fan"
5
6 Optional properties:
7 - gpios: Specifies the pins that map to bits in the control value,
8   ordered MSB-->LSB.
9 - gpio-fan,speed-map: A mapping of possible fan RPM speeds and the
10   control value that should be set to achieve them. This array
11   must have the RPM values in ascending order.
12 - alarm-gpios: This pin going active indicates something is wrong with
13   the fan, and a udev event will be fired.
14
15 Note: At least one the "gpios" or "alarm-gpios" properties must be set.
16
17 Examples:
18
19         gpio_fan {
20                 compatible = "gpio-fan";
21                 gpios = <&gpio1 14 1
22                          &gpio1 13 1>;
23                 gpio-fan,speed-map = <0    0
24                                       3000 1
25                                       6000 2>;
26                 alarm-gpios = <&gpio1 15 1>;
27         };