max34440.rst 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. Kernel driver max34440
  2. ======================
  3. Supported chips:
  4. * Maxim MAX34440
  5. Prefixes: 'max34440'
  6. Addresses scanned: -
  7. Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX34440.pdf
  8. * Maxim MAX34441
  9. PMBus 5-Channel Power-Supply Manager and Intelligent Fan Controller
  10. Prefixes: 'max34441'
  11. Addresses scanned: -
  12. Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX34441.pdf
  13. * Maxim MAX34446
  14. PMBus Power-Supply Data Logger
  15. Prefixes: 'max34446'
  16. Addresses scanned: -
  17. Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX34446.pdf
  18. * Maxim MAX34451
  19. PMBus 16-Channel V/I Monitor and 12-Channel Sequencer/Marginer
  20. Prefixes: 'max34451'
  21. Addresses scanned: -
  22. Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX34451.pdf
  23. * Maxim MAX34460
  24. PMBus 12-Channel Voltage Monitor & Sequencer
  25. Prefix: 'max34460'
  26. Addresses scanned: -
  27. Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX34460.pdf
  28. * Maxim MAX34461
  29. PMBus 16-Channel Voltage Monitor & Sequencer
  30. Prefix: 'max34461'
  31. Addresses scanned: -
  32. Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX34461.pdf
  33. Author: Guenter Roeck <linux@roeck-us.net>
  34. Description
  35. -----------
  36. This driver supports hardware monitoring for Maxim MAX34440 PMBus 6-Channel
  37. Power-Supply Manager, MAX34441 PMBus 5-Channel Power-Supply Manager
  38. and Intelligent Fan Controller, and MAX34446 PMBus Power-Supply Data Logger.
  39. It also supports the MAX34451, MAX34460, and MAX34461 PMBus Voltage Monitor &
  40. Sequencers. The MAX34451 supports monitoring voltage or current of 12 channels
  41. based on GIN pins. The MAX34460 supports 12 voltage channels, and the MAX34461
  42. supports 16 voltage channels.
  43. The driver is a client driver to the core PMBus driver. Please see
  44. Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
  45. Usage Notes
  46. -----------
  47. This driver does not auto-detect devices. You will have to instantiate the
  48. devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
  49. details.
  50. For MAX34446, the value of the currX_crit attribute determines if current or
  51. voltage measurement is enabled for a given channel. Voltage measurement is
  52. enabled if currX_crit is set to 0; current measurement is enabled if the
  53. attribute is set to a positive value. Power measurement is only enabled if
  54. channel 1 (3) is configured for voltage measurement, and channel 2 (4) is
  55. configured for current measurement.
  56. Platform data support
  57. ---------------------
  58. The driver supports standard PMBus driver platform data.
  59. Sysfs entries
  60. -------------
  61. The following attributes are supported. Limits are read-write; all other
  62. attributes are read-only.
  63. In
  64. ~~
  65. ======================= =======================================================
  66. in[1-6]_label "vout[1-6]".
  67. in[1-6]_input Measured voltage. From READ_VOUT register.
  68. in[1-6]_min Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
  69. in[1-6]_max Maximum voltage. From VOUT_OV_WARN_LIMIT register.
  70. in[1-6]_lcrit Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
  71. in[1-6]_crit Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
  72. register.
  73. in[1-6]_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
  74. in[1-6]_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
  75. in[1-6]_lcrit_alarm Voltage critical low alarm. From VOLTAGE_UV_FAULT
  76. status.
  77. in[1-6]_crit_alarm Voltage critical high alarm. From VOLTAGE_OV_FAULT
  78. status.
  79. in[1-6]_lowest Historical minimum voltage.
  80. in[1-6]_highest Historical maximum voltage.
  81. in[1-6]_reset_history Write any value to reset history.
  82. ======================= =======================================================
  83. .. note:: MAX34446 only supports in[1-4].
  84. Curr
  85. ~~~~
  86. ======================= ========================================================
  87. curr[1-6]_label "iout[1-6]".
  88. curr[1-6]_input Measured current. From READ_IOUT register.
  89. curr[1-6]_max Maximum current. From IOUT_OC_WARN_LIMIT register.
  90. curr[1-6]_crit Critical maximum current. From IOUT_OC_FAULT_LIMIT
  91. register.
  92. curr[1-6]_max_alarm Current high alarm. From IOUT_OC_WARNING status.
  93. curr[1-6]_crit_alarm Current critical high alarm. From IOUT_OC_FAULT status.
  94. curr[1-4]_average Historical average current (MAX34446/34451 only).
  95. curr[1-6]_highest Historical maximum current.
  96. curr[1-6]_reset_history Write any value to reset history.
  97. ======================= ========================================================
  98. .. note::
  99. - in6 and curr6 attributes only exist for MAX34440.
  100. - MAX34446 only supports curr[1-4].
  101. Power
  102. ~~~~~
  103. ======================= ========================================================
  104. power[1,3]_label "pout[1,3]"
  105. power[1,3]_input Measured power.
  106. power[1,3]_average Historical average power.
  107. power[1,3]_highest Historical maximum power.
  108. ======================= ========================================================
  109. .. note:: Power attributes only exist for MAX34446.
  110. Temp
  111. ~~~~
  112. ======================= ========================================================
  113. temp[1-8]_input Measured temperatures. From READ_TEMPERATURE_1 register.
  114. temp1 is the chip's internal temperature. temp2..temp5
  115. are remote I2C temperature sensors. For MAX34441, temp6
  116. is a remote thermal-diode sensor. For MAX34440, temp6..8
  117. are remote I2C temperature sensors.
  118. temp[1-8]_max Maximum temperature. From OT_WARN_LIMIT register.
  119. temp[1-8]_crit Critical high temperature. From OT_FAULT_LIMIT register.
  120. temp[1-8]_max_alarm Temperature high alarm.
  121. temp[1-8]_crit_alarm Temperature critical high alarm.
  122. temp[1-8]_average Historical average temperature (MAX34446 only).
  123. temp[1-8]_highest Historical maximum temperature.
  124. temp[1-8]_reset_history Write any value to reset history.
  125. ======================= ========================================================
  126. .. note::
  127. - temp7 and temp8 attributes only exist for MAX34440.
  128. - MAX34446 only supports temp[1-3].
  129. .. note::
  130. - MAX34451 supports attribute groups in[1-16] (or curr[1-16] based on
  131. input pins) and temp[1-5].
  132. - MAX34460 supports attribute groups in[1-12] and temp[1-5].
  133. - MAX34461 supports attribute groups in[1-16] and temp[1-5].