dme1737.rst 13 KB

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