xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/gsc-hwmon.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunKernel driver gsc-hwmon
4*4882a593Smuzhiyun=======================
5*4882a593Smuzhiyun
6*4882a593SmuzhiyunSupported chips: Gateworks GSC
7*4882a593SmuzhiyunDatasheet: http://trac.gateworks.com/wiki/gsc
8*4882a593SmuzhiyunAuthor: Tim Harvey <tharvey@gateworks.com>
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunDescription:
11*4882a593Smuzhiyun------------
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunThis driver supports hardware monitoring for the temperature sensor,
14*4882a593Smuzhiyunvarious ADC's connected to the GSC, and optional FAN controller available
15*4882a593Smuzhiyunon some boards.
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun
18*4882a593SmuzhiyunVoltage Monitoring
19*4882a593Smuzhiyun------------------
20*4882a593Smuzhiyun
21*4882a593SmuzhiyunThe voltage inputs are scaled either internally or by the driver depending
22*4882a593Smuzhiyunon the GSC version and firmware. The values returned by the driver do not need
23*4882a593Smuzhiyunfurther scaling. The voltage input labels provide the voltage rail name:
24*4882a593Smuzhiyun
25*4882a593SmuzhiyuninX_input                  Measured voltage (mV).
26*4882a593SmuzhiyuninX_label                  Name of voltage rail.
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunTemperature Monitoring
30*4882a593Smuzhiyun----------------------
31*4882a593Smuzhiyun
32*4882a593SmuzhiyunTemperatures are measured with 12-bit or 10-bit resolution and are scaled
33*4882a593Smuzhiyuneither internally or by the driver depending on the GSC version and firmware.
34*4882a593SmuzhiyunThe values returned by the driver reflect millidegree Celcius:
35*4882a593Smuzhiyun
36*4882a593SmuzhiyuntempX_input                Measured temperature.
37*4882a593SmuzhiyuntempX_label                Name of temperature input.
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun
40*4882a593SmuzhiyunPWM Output Control
41*4882a593Smuzhiyun------------------
42*4882a593Smuzhiyun
43*4882a593SmuzhiyunThe GSC features 1 PWM output that operates in automatic mode where the
44*4882a593SmuzhiyunPWM value will be scalled depending on 6 temperature boundaries.
45*4882a593SmuzhiyunThe tempeature boundaries are read-write and in millidegree Celcius and the
46*4882a593Smuzhiyunread-only PWM values range from 0 (off) to 255 (full speed).
47*4882a593SmuzhiyunFan speed will be set to minimum (off) when the temperature sensor reads
48*4882a593Smuzhiyunless than pwm1_auto_point1_temp and maximum when the temperature sensor
49*4882a593Smuzhiyunequals or exceeds pwm1_auto_point6_temp.
50*4882a593Smuzhiyun
51*4882a593Smuzhiyunpwm1_auto_point[1-6]_pwm       PWM value.
52*4882a593Smuzhiyunpwm1_auto_point[1-6]_temp      Temperature boundary.
53*4882a593Smuzhiyun
54