1.. SPDX-License-Identifier: GPL-2.0
2
3Kernel driver gsc-hwmon
4=======================
5
6Supported chips: Gateworks GSC
7Datasheet: http://trac.gateworks.com/wiki/gsc
8Author: Tim Harvey <tharvey@gateworks.com>
9
10Description:
11------------
12
13This driver supports hardware monitoring for the temperature sensor,
14various ADC's connected to the GSC, and optional FAN controller available
15on some boards.
16
17
18Voltage Monitoring
19------------------
20
21The voltage inputs are scaled either internally or by the driver depending
22on the GSC version and firmware. The values returned by the driver do not need
23further scaling. The voltage input labels provide the voltage rail name:
24
25inX_input                  Measured voltage (mV).
26inX_label                  Name of voltage rail.
27
28
29Temperature Monitoring
30----------------------
31
32Temperatures are measured with 12-bit or 10-bit resolution and are scaled
33either internally or by the driver depending on the GSC version and firmware.
34The values returned by the driver reflect millidegree Celsius:
35
36tempX_input                Measured temperature.
37tempX_label                Name of temperature input.
38
39
40PWM Output Control
41------------------
42
43The GSC features 1 PWM output that operates in automatic mode where the
44PWM value will be scaled depending on 6 temperature boundaries.
45The tempeature boundaries are read-write and in millidegree Celsius and the
46read-only PWM values range from 0 (off) to 255 (full speed).
47Fan speed will be set to minimum (off) when the temperature sensor reads
48less than pwm1_auto_point1_temp and maximum when the temperature sensor
49equals or exceeds pwm1_auto_point6_temp.
50
51pwm1_auto_point[1-6]_pwm       PWM value.
52pwm1_auto_point[1-6]_temp      Temperature boundary.
53
54