linux/Documentation/hwmon/dme1737
<<
>>
Prefs
   1Kernel driver dme1737
   2=====================
   3
   4Supported chips:
   5  * SMSC DME1737 and compatibles (like Asus A8000)
   6    Prefix: 'dme1737'
   7    Addresses scanned: I2C 0x2c, 0x2d, 0x2e
   8    Datasheet: Provided by SMSC upon request and under NDA
   9  * SMSC SCH3112, SCH3114, SCH3116
  10    Prefix: 'sch311x'
  11    Addresses scanned: none, address read from Super-I/O config space
  12    Datasheet: Available on the Internet
  13  * SMSC SCH5027
  14    Prefix: 'sch5027'
  15    Addresses scanned: I2C 0x2c, 0x2d, 0x2e
  16    Datasheet: Provided by SMSC upon request and under NDA
  17  * SMSC SCH5127
  18    Prefix: 'sch5127'
  19    Addresses scanned: none, address read from Super-I/O config space
  20    Datasheet: Provided by SMSC upon request and under NDA
  21
  22Authors:
  23    Juerg Haefliger <juergh@gmail.com>
  24
  25
  26Module Parameters
  27-----------------
  28
  29* force_start: bool     Enables the monitoring of voltage, fan and temp inputs
  30                        and PWM output control functions. Using this parameter
  31                        shouldn't be required since the BIOS usually takes care
  32                        of this.
  33* probe_all_addr: bool  Include non-standard LPC addresses 0x162e and 0x164e
  34                        when probing for ISA devices. This is required for the
  35                        following boards:
  36                        - VIA EPIA SN18000
  37
  38
  39Description
  40-----------
  41
  42This driver implements support for the hardware monitoring capabilities of the
  43SMSC DME1737 and Asus A8000 (which are the same), SMSC SCH5027, SCH311x,
  44and SCH5127 Super-I/O chips. These chips feature monitoring of 3 temp sensors
  45temp[1-3] (2 remote diodes and 1 internal), 8 voltages in[0-7] (7 external and
  461 internal) and up to 6 fan speeds fan[1-6]. Additionally, the chips implement
  47up to 5 PWM outputs pwm[1-3,5-6] for controlling fan speeds both manually and
  48automatically.
  49
  50For the DME1737, A8000 and SCH5027, fan[1-2] and pwm[1-2] are always present.
  51Fan[3-6] and pwm[3,5-6] are optional features and their availability depends on
  52the configuration of the chip. The driver will detect which features are
  53present during initialization and create the sysfs attributes accordingly.
  54
  55For the SCH311x and SCH5127, fan[1-3] and pwm[1-3] are always present and
  56fan[4-6] and pwm[5-6] don't exist.
  57
  58The hardware monitoring features of the DME1737, A8000, and SCH5027 are only
  59accessible via SMBus, while the SCH311x and SCH5127 only provide access via
  60the ISA bus. The driver will therefore register itself as an I2C client driver
  61if it detects a DME1737, A8000, or SCH5027 and as a platform driver if it
  62detects a SCH311x or SCH5127 chip.
  63
  64
  65Voltage Monitoring
  66------------------
  67
  68The voltage inputs are sampled with 12-bit resolution and have internal
  69scaling resistors. The values returned by the driver therefore reflect true
  70millivolts and don't need scaling. The voltage inputs are mapped as follows
  71(the last column indicates the input ranges):
  72
  73DME1737, A8000:
  74        in0: +5VTR      (+5V standby)           0V - 6.64V
  75        in1: Vccp       (processor core)        0V - 3V
  76        in2: VCC        (internal +3.3V)        0V - 4.38V
  77        in3: +5V                                0V - 6.64V
  78        in4: +12V                               0V - 16V
  79        in5: VTR        (+3.3V standby)         0V - 4.38V
  80        in6: Vbat       (+3.0V)                 0V - 4.38V
  81
  82SCH311x:
  83        in0: +2.5V                              0V - 3.32V
  84        in1: Vccp       (processor core)        0V - 2V
  85        in2: VCC        (internal +3.3V)        0V - 4.38V
  86        in3: +5V                                0V - 6.64V
  87        in4: +12V                               0V - 16V
  88        in5: VTR        (+3.3V standby)         0V - 4.38V
  89        in6: Vbat       (+3.0V)                 0V - 4.38V
  90
  91SCH5027:
  92        in0: +5VTR      (+5V standby)           0V - 6.64V
  93        in1: Vccp       (processor core)        0V - 3V
  94        in2: VCC        (internal +3.3V)        0V - 4.38V
  95        in3: V2_IN                              0V - 1.5V
  96        in4: V1_IN                              0V - 1.5V
  97        in5: VTR        (+3.3V standby)         0V - 4.38V
  98        in6: Vbat       (+3.0V)                 0V - 4.38V
  99
 100SCH5127:
 101        in0: +2.5                               0V - 3.32V
 102        in1: Vccp       (processor core)        0V - 3V
 103        in2: VCC        (internal +3.3V)        0V - 4.38V
 104        in3: V2_IN                              0V - 1.5V
 105        in4: V1_IN                              0V - 1.5V
 106        in5: VTR        (+3.3V standby)         0V - 4.38V
 107        in6: Vbat       (+3.0V)                 0V - 4.38V
 108        in7: Vtrip      (+1.5V)                 0V - 1.99V
 109
 110Each voltage input has associated min and max limits which trigger an alarm
 111when crossed.
 112
 113
 114Temperature Monitoring
 115----------------------
 116
 117Temperatures are measured with 12-bit resolution and reported in millidegree
 118Celsius. The chip also features offsets for all 3 temperature inputs which -
 119when programmed - get added to the input readings. The chip does all the
 120scaling by itself and the driver therefore reports true temperatures that don't
 121need any user-space adjustments. The temperature inputs are mapped as follows
 122(the last column indicates the input ranges):
 123
 124        temp1: Remote diode 1 (3904 type) temperature   -127C - +127C
 125        temp2: DME1737 internal temperature             -127C - +127C
 126        temp3: Remote diode 2 (3904 type) temperature   -127C - +127C
 127
 128Each temperature input has associated min and max limits which trigger an alarm
 129when crossed. Additionally, each temperature input has a fault attribute that
 130returns 1 when a faulty diode or an unconnected input is detected and 0
 131otherwise.
 132
 133
 134Fan Monitoring
 135--------------
 136
 137Fan RPMs are measured with 16-bit resolution. The chip provides inputs for 6
 138fan tachometers. All 6 inputs have an associated min limit which triggers an
 139alarm when crossed. Fan inputs 1-4 provide type attributes that need to be set
 140to the number of pulses per fan revolution that the connected tachometer
 141generates. Supported values are 1, 2, and 4. Fan inputs 5-6 only support fans
 142that generate 2 pulses per revolution. Fan inputs 5-6 also provide a max
 143attribute that needs to be set to the maximum attainable RPM (fan at 100% duty-
 144cycle) of the input. The chip adjusts the sampling rate based on this value.
 145
 146
 147PWM Output Control
 148------------------
 149
 150This chip features 5 PWM outputs. PWM outputs 1-3 are associated with fan
 151inputs 1-3 and PWM outputs 5-6 are associated with fan inputs 5-6. PWM outputs
 1521-3 can be configured to operate either in manual or automatic mode by setting
 153the appropriate enable attribute accordingly. PWM outputs 5-6 can only operate
 154in manual mode, their enable attributes are therefore read-only. When set to
 155manual mode, the fan speed is set by writing the duty-cycle value to the
 156appropriate PWM attribute. In automatic mode, the PWM attribute returns the
 157current duty-cycle as set by the fan controller in the chip. All PWM outputs
 158support the setting of the output frequency via the freq attribute.
 159
 160In automatic mode, the chip supports the setting of the PWM ramp rate which
 161defines how fast the PWM output is adjusting to changes of the associated
 162temperature input. Associating PWM outputs to temperature inputs is done via
 163temperature zones. The chip features 3 zones whose assignments to temperature
 164inputs is static and determined during initialization. These assignments can
 165be retrieved via the zone[1-3]_auto_channels_temp attributes. Each PWM output
 166is assigned to one (or hottest of multiple) temperature zone(s) through the
 167pwm[1-3]_auto_channels_zone attributes. Each PWM output has 3 distinct output
 168duty-cycles: full, low, and min. Full is internally hard-wired to 255 (100%)
 169and low and min can be programmed via pwm[1-3]_auto_point1_pwm and
 170pwm[1-3]_auto_pwm_min, respectively. The thermal thresholds of the zones are
 171programmed via zone[1-3]_auto_point[1-3]_temp and
 172zone[1-3]_auto_point1_temp_hyst:
 173
 174        pwm[1-3]_auto_point2_pwm        full-speed duty-cycle (255, i.e., 100%)
 175        pwm[1-3]_auto_point1_pwm        low-speed duty-cycle
 176        pwm[1-3]_auto_pwm_min           min-speed duty-cycle
 177
 178        zone[1-3]_auto_point3_temp      full-speed temp (all outputs)
 179        zone[1-3]_auto_point2_temp      full-speed temp
 180        zone[1-3]_auto_point1_temp      low-speed temp
 181        zone[1-3]_auto_point1_temp_hyst min-speed temp
 182
 183The chip adjusts the output duty-cycle linearly in the range of auto_point1_pwm
 184to auto_point2_pwm if the temperature of the associated zone is between
 185auto_point1_temp and auto_point2_temp. If the temperature drops below the
 186auto_point1_temp_hyst value, the output duty-cycle is set to the auto_pwm_min
 187value which only supports two values: 0 or auto_point1_pwm. That means that the
 188fan either turns completely off or keeps spinning with the low-speed
 189duty-cycle. If any of the temperatures rise above the auto_point3_temp value,
 190all PWM outputs are set to 100% duty-cycle.
 191
 192Following is another representation of how the chip sets the output duty-cycle
 193based on the temperature of the associated thermal zone:
 194
 195                        Duty-Cycle      Duty-Cycle
 196        Temperature     Rising Temp     Falling Temp
 197        -----------     -----------     ------------
 198        full-speed      full-speed      full-speed
 199
 200                        < linearly adjusted duty-cycle >
 201
 202        low-speed       low-speed       low-speed
 203                        min-speed       low-speed
 204        min-speed       min-speed       min-speed
 205                        min-speed       min-speed
 206
 207
 208Sysfs Attributes
 209----------------
 210
 211Following is a list of all sysfs attributes that the driver provides, their
 212permissions and a short description:
 213
 214Name                            Perm    Description
 215----                            ----    -----------
 216cpu0_vid                        RO      CPU core reference voltage in
 217                                        millivolts.
 218vrm                             RW      Voltage regulator module version
 219                                        number.
 220
 221in[0-7]_input                   RO      Measured voltage in millivolts.
 222in[0-7]_min                     RW      Low limit for voltage input.
 223in[0-7]_max                     RW      High limit for voltage input.
 224in[0-7]_alarm                   RO      Voltage input alarm. Returns 1 if
 225                                        voltage input is or went outside the
 226                                        associated min-max range, 0 otherwise.
 227
 228temp[1-3]_input                 RO      Measured temperature in millidegree
 229                                        Celsius.
 230temp[1-3]_min                   RW      Low limit for temp input.
 231temp[1-3]_max                   RW      High limit for temp input.
 232temp[1-3]_offset                RW      Offset for temp input. This value will
 233                                        be added by the chip to the measured
 234                                        temperature.
 235temp[1-3]_alarm                 RO      Alarm for temp input. Returns 1 if temp
 236                                        input is or went outside the associated
 237                                        min-max range, 0 otherwise.
 238temp[1-3]_fault                 RO      Temp input fault. Returns 1 if the chip
 239                                        detects a faulty thermal diode or an
 240                                        unconnected temp input, 0 otherwise.
 241
 242zone[1-3]_auto_channels_temp    RO      Temperature zone to temperature input
 243                                        mapping. This attribute is a bitfield
 244                                        and supports the following values:
 245                                                1: temp1
 246                                                2: temp2
 247                                                4: temp3
 248zone[1-3]_auto_point1_temp_hyst RW      Auto PWM temp point1 hysteresis. The
 249                                        output of the corresponding PWM is set
 250                                        to the pwm_auto_min value if the temp
 251                                        falls below the auto_point1_temp_hyst
 252                                        value.
 253zone[1-3]_auto_point[1-3]_temp  RW      Auto PWM temp points. Auto_point1 is
 254                                        the low-speed temp, auto_point2 is the
 255                                        full-speed temp, and auto_point3 is the
 256                                        temp at which all PWM outputs are set
 257                                        to full-speed (100% duty-cycle).
 258
 259fan[1-6]_input                  RO      Measured fan speed in RPM.
 260fan[1-6]_min                    RW      Low limit for fan input.
 261fan[1-6]_alarm                  RO      Alarm for fan input. Returns 1 if fan
 262                                        input is or went below the associated
 263                                        min value, 0 otherwise.
 264fan[1-4]_type                   RW      Type of attached fan. Expressed in
 265                                        number of pulses per revolution that
 266                                        the fan generates. Supported values are
 267                                        1, 2, and 4.
 268fan[5-6]_max                    RW      Max attainable RPM at 100% duty-cycle.
 269                                        Required for chip to adjust the
 270                                        sampling rate accordingly.
 271
 272pmw[1-3,5-6]                    RO/RW   Duty-cycle of PWM output. Supported
 273                                        values are 0-255 (0%-100%). Only
 274                                        writeable if the associated PWM is in
 275                                        manual mode.
 276pwm[1-3]_enable                 RW      Enable of PWM outputs 1-3. Supported
 277                                        values are:
 278                                                 0: turned off (output @ 100%)
 279                                                 1: manual mode
 280                                                 2: automatic mode
 281pwm[5-6]_enable                 RO      Enable of PWM outputs 5-6. Always
 282                                        returns 1 since these 2 outputs are
 283                                        hard-wired to manual mode.
 284pmw[1-3,5-6]_freq               RW      Frequency of PWM output. Supported
 285                                        values are in the range 11Hz-30000Hz
 286                                        (default is 25000Hz).
 287pmw[1-3]_ramp_rate              RW      Ramp rate of PWM output. Determines how
 288                                        fast the PWM duty-cycle will change
 289                                        when the PWM is in automatic mode.
 290                                        Expressed in ms per PWM step. Supported
 291                                        values are in the range 0ms-206ms
 292                                        (default is 0, which means the duty-
 293                                        cycle changes instantly).
 294pwm[1-3]_auto_channels_zone     RW      PWM output to temperature zone mapping.
 295                                        This attribute is a bitfield and
 296                                        supports the following values:
 297                                                1: zone1
 298                                                2: zone2
 299                                                4: zone3
 300                                                6: highest of zone[2-3]
 301                                                7: highest of zone[1-3]
 302pwm[1-3]_auto_pwm_min           RW      Auto PWM min pwm. Minimum PWM duty-
 303                                        cycle. Supported values are 0 or
 304                                        auto_point1_pwm.
 305pwm[1-3]_auto_point1_pwm        RW      Auto PWM pwm point. Auto_point1 is the
 306                                        low-speed duty-cycle.
 307pwm[1-3]_auto_point2_pwm        RO      Auto PWM pwm point. Auto_point2 is the
 308                                        full-speed duty-cycle which is hard-
 309                                        wired to 255 (100% duty-cycle).
 310
 311Chip Differences
 312----------------
 313
 314Feature                 dme1737 sch311x sch5027 sch5127
 315-------------------------------------------------------
 316temp[1-3]_offset        yes     yes
 317vid                     yes
 318zone3                   yes     yes     yes
 319zone[1-3]_hyst          yes     yes
 320pwm min/off             yes     yes
 321fan3                    opt     yes     opt     yes
 322pwm3                    opt     yes     opt     yes
 323fan4                    opt             opt
 324fan5                    opt             opt
 325pwm5                    opt             opt
 326fan6                    opt             opt
 327pwm6                    opt             opt
 328in7                                             yes
 329
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.