[RFC,PATCHv0,2/3] Add DT documentation for G762 PWM fan controller

Commit Message

Arnaud Ebalard April 18, 2013, 10:28 p.m. UTC

Signed-off-by: Arnaud Ebalard <[e-mail]>
---
 Documentation/devicetree/bindings/hwmon/g762.txt |   37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/g762.txt

Patch

diff --git a/Documentation/devicetree/bindings/hwmon/g762.txt b/Documentation/devicetree/bindings/hwmon/g762.txt
new file mode 100644
index 0000000..9eee838
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/g762.txt
@@ -0,0 +1,37 @@ 
+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
+
+Optional properties:
+
+ - "pwm_mode": fan driving mode. 1 for PWM mode, 0 for linear. Default
+               value is 0, i.e. linear.
+ - "pwm_enable": fan speed control. 1 for open-loop, 2 for closed-loop.
+               Default value is 2, i.e. closed-loop.
+ - "pwm_freq": reference clock frequency for PWM mode in Hz. Default is
+               32768.
+ - "fan_pulses": number of pulses per fan revolution. Supported values
+               are 2 and 4. Default is 2.
+ - "fan_div": fan clock frequency divisor value. Supported values are
+              1, 2, 4 and 8. Default is 1.
+ - "fan_target": initial target fan speed in RPM. By default, current
+               value is not modified.
+
+Previous optional properties provides devicetree access to the entries
+described in Documentation/hwmon/g762
+
+Example g762 node:
+
+   g762: g762@3e {
+        compatible = "gmt,g762";
+   	reg = <0x3e>;
+   	pwm_mode = <1>;      /* closed-loop control */
+   	pwm_enable = <2>;    /* PWM mode */
+   	pwm_freq = <8192>;   /* PWM reference clock freq */
+   	fan_pulses = <2>;    /* 2 pulses per rev */
+   	fan_div = <2>;       /* fan clock divisor */
+   	fan_target = <2000>; /* target fan speed at 2000 RPM */
+   };