181 lines · plain
1Kernel driver w83791d2=====================3 4Supported chips:5 6 * Winbond W83791D7 8 Prefix: 'w83791d'9 10 Addresses scanned: I2C 0x2c - 0x2f11 12 Datasheet: http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83791D_W83791Gb.pdf13 14Author: Charles Spirakis <bezaur@gmail.com>15 16This driver was derived from the w83781d.c and w83792d.c source files.17 18Credits:19 20 w83781d.c:21 22 - Frodo Looijaard <frodol@dds.nl>,23 - Philip Edelbrock <phil@netroedge.com>,24 - Mark Studebaker <mdsxyz123@yahoo.com>25 26 w83792d.c:27 28 - Shane Huang (Winbond),29 - Rudolf Marek <r.marek@assembler.cz>30 31Additional contributors:32 33 - Sven Anders <anders@anduras.de>34 - Marc Hulsman <m.hulsman@tudelft.nl>35 36Module Parameters37-----------------38 39* init boolean40 (default 0)41 42 Use 'init=1' to have the driver do extra software initializations.43 The default behavior is to do the minimum initialization possible44 and depend on the BIOS to properly setup the chip. If you know you45 have a w83791d and you're having problems, try init=1 before trying46 reset=1.47 48* reset boolean49 (default 0)50 51 Use 'reset=1' to reset the chip (via index 0x40, bit 7). The default52 behavior is no chip reset to preserve BIOS settings.53 54* force_subclients=bus,caddr,saddr,saddr55 This is used to force the i2c addresses for subclients of56 a certain chip. Example usage is `force_subclients=0,0x2f,0x4a,0x4b`57 to force the subclients of chip 0x2f on bus 0 to i2c addresses58 0x4a and 0x4b.59 60 61Description62-----------63 64This driver implements support for the Winbond W83791D chip. The W83791G65chip appears to be the same as the W83791D but is lead free.66 67Detection of the chip can sometimes be foiled because it can be in an68internal state that allows no clean access (Bank with ID register is not69currently selected). If you know the address of the chip, use a 'force'70parameter; this will put it into a more well-behaved state first.71 72The driver implements three temperature sensors, ten voltage sensors,73five fan rotation speed sensors and manual PWM control of each fan.74 75Temperatures are measured in degrees Celsius and measurement resolution is 176degC for temp1 and 0.5 degC for temp2 and temp3. An alarm is triggered when77the temperature gets higher than the Overtemperature Shutdown value; it stays78on until the temperature falls below the Hysteresis value.79 80Voltage sensors (also known as IN sensors) report their values in millivolts.81An alarm is triggered if the voltage has crossed a programmable minimum82or maximum limit.83 84Fan rotation speeds are reported in RPM (rotations per minute). An alarm is85triggered if the rotation speed has dropped below a programmable limit. Fan86readings can be divided by a programmable divider (1, 2, 4, 8, 16,8732, 64 or 128 for all fans) to give the readings more range or accuracy.88 89Each fan controlled is controlled by PWM. The PWM duty cycle can be read and90set for each fan separately. Valid values range from 0 (stop) to 255 (full).91PWM 1-3 support Thermal Cruise mode, in which the PWMs are automatically92regulated to keep respectively temp 1-3 at a certain target temperature.93See below for the description of the sysfs-interface.94 95The w83791d has a global bit used to enable beeping from the speaker when an96alarm is triggered as well as a bitmask to enable or disable the beep for97specific alarms. You need both the global beep enable bit and the98corresponding beep bit to be on for a triggered alarm to sound a beep.99 100The sysfs interface to the global enable is via the sysfs beep_enable file.101This file is used for both legacy and new code.102 103The sysfs interface to the beep bitmask has migrated from the original legacy104method of a single sysfs beep_mask file to a newer method using multiple105`*_beep` files as described in `Documentation/hwmon/sysfs-interface.rst`.106 107A similar change has occurred for the bitmap corresponding to the alarms. The108original legacy method used a single sysfs alarms file containing a bitmap109of triggered alarms. The newer method uses multiple sysfs `*_alarm` files110(again following the pattern described in sysfs-interface).111 112Since both methods read and write the underlying hardware, they can be used113interchangeably and changes in one will automatically be reflected by114the other. If you use the legacy bitmask method, your user-space code is115responsible for handling the fact that the alarms and beep_mask bitmaps116are not the same (see the table below).117 118NOTE: All new code should be written to use the newer sysfs-interface119specification as that avoids bitmap problems and is the preferred interface120going forward.121 122The driver reads the hardware chip values at most once every three seconds.123User mode code requesting values more often will receive cached values.124 125/sys files126----------127The sysfs-interface is documented in the 'sysfs-interface' file. Only128chip-specific options are documented here.129 130======================= =======================================================131pwm[1-3]_enable this file controls mode of fan/temperature control for132 fan 1-3. Fan/PWM 4-5 only support manual mode.133 134 * 1 Manual mode135 * 2 Thermal Cruise mode136 * 3 Fan Speed Cruise mode (no further support)137 138temp[1-3]_target defines the target temperature for Thermal Cruise mode.139 Unit: millidegree Celsius140 RW141 142temp[1-3]_tolerance temperature tolerance for Thermal Cruise mode.143 Specifies an interval around the target temperature144 in which the fan speed is not changed.145 Unit: millidegree Celsius146 RW147======================= =======================================================148 149Alarms bitmap vs. beep_mask bitmask150-----------------------------------151 152For legacy code using the alarms and beep_mask files:153 154============= ======== ========= ==========================155Signal Alarms beep_mask Obs156============= ======== ========= ==========================157in0 (VCORE) 0x000001 0x000001158in1 (VINR0) 0x000002 0x002000 <== mismatch159in2 (+3.3VIN) 0x000004 0x000004160in3 (5VDD) 0x000008 0x000008161in4 (+12VIN) 0x000100 0x000100162in5 (-12VIN) 0x000200 0x000200163in6 (-5VIN) 0x000400 0x000400164in7 (VSB) 0x080000 0x010000 <== mismatch165in8 (VBAT) 0x100000 0x020000 <== mismatch166in9 (VINR1) 0x004000 0x004000167temp1 0x000010 0x000010168temp2 0x000020 0x000020169temp3 0x002000 0x000002 <== mismatch170fan1 0x000040 0x000040171fan2 0x000080 0x000080172fan3 0x000800 0x000800173fan4 0x200000 0x200000174fan5 0x400000 0x400000175tart1 0x010000 0x040000 <== mismatch176tart2 0x020000 0x080000 <== mismatch177tart3 0x040000 0x100000 <== mismatch178case_open 0x001000 0x001000179global_enable - 0x800000 (modified via beep_enable)180============= ======== ========= ==========================181