Documentation/hwmon/nct6775.rst

   1 Kernel driver NCT6775
   2 =====================
   3
   4 .. note::
   5
   6     This driver supersedes the NCT6775F and NCT6776F support in the W83627EHF
   7     driver.
   8
   9 Supported chips:
  10
  11   * Nuvoton NCT6102D/NCT6104D/NCT6106D
  12
  13     Prefix: 'nct6106'
  14
  15     Addresses scanned: ISA address retrieved from Super I/O registers
  16
  17     Datasheet: Available from the Nuvoton web site
  18
  19   * Nuvoton NCT5572D/NCT6771F/NCT6772F/NCT6775F/W83677HG-I
  20
  21     Prefix: 'nct6775'
  22
  23     Addresses scanned: ISA address retrieved from Super I/O registers
  24
  25     Datasheet: Available from Nuvoton upon request
  26
  27   * Nuvoton NCT5573D/NCT5577D/NCT6776D/NCT6776F
  28
  29     Prefix: 'nct6776'
  30
  31     Addresses scanned: ISA address retrieved from Super I/O registers
  32
  33     Datasheet: Available from Nuvoton upon request
  34
  35   * Nuvoton NCT5532D/NCT6779D
  36
  37     Prefix: 'nct6779'
  38
  39     Addresses scanned: ISA address retrieved from Super I/O registers
  40
  41     Datasheet: Available from Nuvoton upon request
  42
  43   * Nuvoton NCT6791D
  44
  45     Prefix: 'nct6791'
  46
  47     Addresses scanned: ISA address retrieved from Super I/O registers
  48
  49     Datasheet: Available from Nuvoton upon request
  50
  51   * Nuvoton NCT6792D
  52
  53     Prefix: 'nct6792'
  54
  55     Addresses scanned: ISA address retrieved from Super I/O registers
  56
  57     Datasheet: Available from Nuvoton upon request
  58
  59   * Nuvoton NCT6793D
  60
  61     Prefix: 'nct6793'
  62
  63     Addresses scanned: ISA address retrieved from Super I/O registers
  64
  65     Datasheet: Available from Nuvoton upon request
  66
  67   * Nuvoton NCT6795D
  68
  69     Prefix: 'nct6795'
  70
  71     Addresses scanned: ISA address retrieved from Super I/O registers
  72
  73     Datasheet: Available from Nuvoton upon request
  74
  75   * Nuvoton NCT6796D
  76
  77     Prefix: 'nct6796'
  78
  79     Addresses scanned: ISA address retrieved from Super I/O registers
  80
  81     Datasheet: Available from Nuvoton upon request
  82
  83
  84
  85 Authors:
  86
  87         Guenter Roeck <linux@roeck-us.net>
  88
  89 Description
  90 -----------
  91
  92 This driver implements support for the Nuvoton NCT6775F, NCT6776F, and NCT6779D
  93 and compatible super I/O chips.
  94
  95 The chips support up to 25 temperature monitoring sources. Up to 6 of those are
  96 direct temperature sensor inputs, the others are special sources such as PECI,
  97 PCH, and SMBUS. Depending on the chip type, 2 to 6 of the temperature sources
  98 can be monitored and compared against minimum, maximum, and critical
  99 temperatures. The driver reports up to 10 of the temperatures to the user.
 100 There are 4 to 5 fan rotation speed sensors, 8 to 15 analog voltage sensors,
 101 one VID, alarms with beep warnings (control unimplemented), and some automatic
 102 fan regulation strategies (plus manual fan control mode).
 103
 104 The temperature sensor sources on all chips are configurable. The configured
 105 source for each of the temperature sensors is provided in tempX_label.
 106
 107 Temperatures are measured in degrees Celsius and measurement resolution is
 108 either 1 degC or 0.5 degC, depending on the temperature source and
 109 configuration. An alarm is triggered when the temperature gets higher than
 110 the high limit; it stays on until the temperature falls below the hysteresis
 111 value. Alarms are only supported for temp1 to temp6, depending on the chip type.
 112
 113 Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
 114 triggered if the rotation speed has dropped below a programmable limit. On
 115 NCT6775F, fan readings can be divided by a programmable divider (1, 2, 4, 8,
 116 16, 32, 64 or 128) to give the readings more range or accuracy; the other chips
 117 do not have a fan speed divider. The driver sets the most suitable fan divisor
 118 itself; specifically, it increases the divider value each time a fan speed
 119 reading returns an invalid value, and it reduces it if the fan speed reading
 120 is lower than optimal. Some fans might not be present because they share pins
 121 with other functions.
 122
 123 Voltage sensors (also known as IN sensors) report their values in millivolts.
 124 An alarm is triggered if the voltage has crossed a programmable minimum
 125 or maximum limit.
 126
 127 The driver supports automatic fan control mode known as Thermal Cruise.
 128 In this mode, the chip attempts to keep the measured temperature in a
 129 predefined temperature range. If the temperature goes out of range, fan
 130 is driven slower/faster to reach the predefined range again.
 131
 132 The mode works for fan1-fan5.
 133
 134 sysfs attributes
 135 ----------------
 136
 137 pwm[1-7]
 138     - this file stores PWM duty cycle or DC value (fan speed) in range:
 139
 140            0 (lowest speed) to 255 (full)
 141
 142 pwm[1-7]_enable
 143     - this file controls mode of fan/temperature control:
 144
 145         * 0 Fan control disabled (fans set to maximum speed)
 146         * 1 Manual mode, write to pwm[0-5] any value 0-255
 147         * 2 "Thermal Cruise" mode
 148         * 3 "Fan Speed Cruise" mode
 149         * 4 "Smart Fan III" mode (NCT6775F only)
 150         * 5 "Smart Fan IV" mode
 151
 152 pwm[1-7]_mode
 153     - controls if output is PWM or DC level
 154
 155         * 0 DC output
 156         * 1 PWM output
 157
 158 Common fan control attributes
 159 -----------------------------
 160
 161 pwm[1-7]_temp_sel
 162                         Temperature source. Value is temperature sensor index.
 163                         For example, select '1' for temp1_input.
 164
 165 pwm[1-7]_weight_temp_sel
 166                         Secondary temperature source. Value is temperature
 167                         sensor index. For example, select '1' for temp1_input.
 168                         Set to 0 to disable secondary temperature control.
 169
 170 If secondary temperature functionality is enabled, it is controlled with the
 171 following attributes.
 172
 173 pwm[1-7]_weight_duty_step
 174                         Duty step size.
 175
 176 pwm[1-7]_weight_temp_step
 177                         Temperature step size. With each step over
 178                         temp_step_base, the value of weight_duty_step is added
 179                         to the current pwm value.
 180
 181 pwm[1-7]_weight_temp_step_base
 182                         Temperature at which secondary temperature control kicks
 183                         in.
 184
 185 pwm[1-7]_weight_temp_step_tol
 186                         Temperature step tolerance.
 187
 188 Thermal Cruise mode (2)
 189 -----------------------
 190
 191 If the temperature is in the range defined by:
 192
 193 pwm[1-7]_target_temp
 194                         Target temperature, unit millidegree Celsius
 195                         (range 0 - 127000)
 196
 197 pwm[1-7]_temp_tolerance
 198                         Target temperature tolerance, unit millidegree Celsius
 199
 200 There are no changes to fan speed. Once the temperature leaves the interval, fan
 201 speed increases (if temperature is higher that desired) or decreases (if
 202 temperature is lower than desired), using the following limits and time
 203 intervals.
 204
 205 pwm[1-7]_start
 206                         fan pwm start value (range 1 - 255), to start fan
 207                         when the temperature is above defined range.
 208
 209 pwm[1-7]_floor
 210                         lowest fan pwm (range 0 - 255) if temperature is below
 211                         the defined range. If set to 0, the fan is expected to
 212                         stop if the temperature is below the defined range.
 213
 214 pwm[1-7]_step_up_time
 215                         milliseconds before fan speed is increased
 216
 217 pwm[1-7]_step_down_time
 218                         milliseconds before fan speed is decreased
 219
 220 pwm[1-7]_stop_time
 221                         how many milliseconds must elapse to switch
 222                         corresponding fan off (when the temperature was below
 223                         defined range).
 224
 225 Speed Cruise mode (3)
 226 ---------------------
 227
 228 This modes tries to keep the fan speed constant.
 229
 230 fan[1-7]_target
 231                         Target fan speed
 232
 233 fan[1-7]_tolerance
 234                         Target speed tolerance
 235
 236
 237 Untested; use at your own risk.
 238
 239 Smart Fan IV mode (5)
 240 ---------------------
 241
 242 This mode offers multiple slopes to control the fan speed. The slopes can be
 243 controlled by setting the pwm and temperature attributes. When the temperature
 244 rises, the chip will calculate the DC/PWM output based on the current slope.
 245 There are up to seven data points depending on the chip type. Subsequent data
 246 points should be set to higher temperatures and higher pwm values to achieve
 247 higher fan speeds with increasing temperature. The last data point reflects
 248 critical temperature mode, in which the fans should run at full speed.
 249
 250 pwm[1-7]_auto_point[1-7]_pwm
 251                         pwm value to be set if temperature reaches matching
 252                         temperature range.
 253
 254 pwm[1-7]_auto_point[1-7]_temp
 255                         Temperature over which the matching pwm is enabled.
 256
 257 pwm[1-7]_temp_tolerance
 258                         Temperature tolerance, unit millidegree Celsius
 259
 260 pwm[1-7]_crit_temp_tolerance
 261                         Temperature tolerance for critical temperature,
 262                         unit millidegree Celsius
 263
 264 pwm[1-7]_step_up_time
 265                         milliseconds before fan speed is increased
 266
 267 pwm[1-7]_step_down_time
 268                         milliseconds before fan speed is decreased
 269
 270 Usage Notes
 271 -----------
 272
 273 On various ASUS boards with NCT6776F, it appears that CPUTIN is not really
 274 connected to anything and floats, or that it is connected to some non-standard
 275 temperature measurement device. As a result, the temperature reported on CPUTIN
 276 will not reflect a usable value. It often reports unreasonably high
 277 temperatures, and in some cases the reported temperature declines if the actual
 278 temperature increases (similar to the raw PECI temperature value - see PECI
 279 specification for details). CPUTIN should therefore be ignored on ASUS
 280 boards. The CPU temperature on ASUS boards is reported from PECI 0.