pmbus.rst 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. Kernel driver pmbus
  2. ===================
  3. Supported chips:
  4. * Ericsson BMR453, BMR454
  5. Prefixes: 'bmr453', 'bmr454'
  6. Addresses scanned: -
  7. Datasheet:
  8. http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146395
  9. * ON Semiconductor ADP4000, NCP4200, NCP4208
  10. Prefixes: 'adp4000', 'ncp4200', 'ncp4208'
  11. Addresses scanned: -
  12. Datasheets:
  13. https://www.onsemi.com/pub_link/Collateral/ADP4000-D.PDF
  14. https://www.onsemi.com/pub_link/Collateral/NCP4200-D.PDF
  15. https://www.onsemi.com/pub_link/Collateral/JUNE%202009-%20REV.%200.PDF
  16. * Lineage Power
  17. Prefixes: 'mdt040', 'pdt003', 'pdt006', 'pdt012', 'udt020'
  18. Addresses scanned: -
  19. Datasheets:
  20. http://www.lineagepower.com/oem/pdf/PDT003A0X.pdf
  21. http://www.lineagepower.com/oem/pdf/PDT006A0X.pdf
  22. http://www.lineagepower.com/oem/pdf/PDT012A0X.pdf
  23. http://www.lineagepower.com/oem/pdf/UDT020A0X.pdf
  24. http://www.lineagepower.com/oem/pdf/MDT040A0X.pdf
  25. * Texas Instruments TPS40400, TPS544B20, TPS544B25, TPS544C20, TPS544C25
  26. Prefixes: 'tps40400', 'tps544b20', 'tps544b25', 'tps544c20', 'tps544c25'
  27. Addresses scanned: -
  28. Datasheets:
  29. https://www.ti.com/lit/gpn/tps40400
  30. https://www.ti.com/lit/gpn/tps544b20
  31. https://www.ti.com/lit/gpn/tps544b25
  32. https://www.ti.com/lit/gpn/tps544c20
  33. https://www.ti.com/lit/gpn/tps544c25
  34. * Maxim MAX20796
  35. Prefix: 'max20796'
  36. Addresses scanned: -
  37. Datasheet:
  38. Not published
  39. * Generic PMBus devices
  40. Prefix: 'pmbus'
  41. Addresses scanned: -
  42. Datasheet: n.a.
  43. Author: Guenter Roeck <linux@roeck-us.net>
  44. Description
  45. -----------
  46. This driver supports hardware monitoring for various PMBus compliant devices.
  47. It supports voltage, current, power, and temperature sensors as supported
  48. by the device.
  49. Each monitored channel has its own high and low limits, plus a critical
  50. limit.
  51. Fan support will be added in a later version of this driver.
  52. Usage Notes
  53. -----------
  54. This driver does not probe for PMBus devices, since there is no register
  55. which can be safely used to identify the chip (The MFG_ID register is not
  56. supported by all chips), and since there is no well defined address range for
  57. PMBus devices. You will have to instantiate the devices explicitly.
  58. Example: the following will load the driver for an LTC2978 at address 0x60
  59. on I2C bus #1::
  60. $ modprobe pmbus
  61. $ echo ltc2978 0x60 > /sys/bus/i2c/devices/i2c-1/new_device
  62. Platform data support
  63. ---------------------
  64. Support for additional PMBus chips can be added by defining chip parameters in
  65. a new chip specific driver file. For example, (untested) code to add support for
  66. Emerson DS1200 power modules might look as follows::
  67. static struct pmbus_driver_info ds1200_info = {
  68. .pages = 1,
  69. /* Note: All other sensors are in linear mode */
  70. .direct[PSC_VOLTAGE_OUT] = true,
  71. .direct[PSC_TEMPERATURE] = true,
  72. .direct[PSC_CURRENT_OUT] = true,
  73. .m[PSC_VOLTAGE_IN] = 1,
  74. .b[PSC_VOLTAGE_IN] = 0,
  75. .R[PSC_VOLTAGE_IN] = 3,
  76. .m[PSC_VOLTAGE_OUT] = 1,
  77. .b[PSC_VOLTAGE_OUT] = 0,
  78. .R[PSC_VOLTAGE_OUT] = 3,
  79. .m[PSC_TEMPERATURE] = 1,
  80. .b[PSC_TEMPERATURE] = 0,
  81. .R[PSC_TEMPERATURE] = 3,
  82. .func[0] = PMBUS_HAVE_VIN | PMBUS_HAVE_IIN | PMBUS_HAVE_STATUS_INPUT
  83. | PMBUS_HAVE_VOUT | PMBUS_HAVE_STATUS_VOUT
  84. | PMBUS_HAVE_IOUT | PMBUS_HAVE_STATUS_IOUT
  85. | PMBUS_HAVE_PIN | PMBUS_HAVE_POUT
  86. | PMBUS_HAVE_TEMP | PMBUS_HAVE_STATUS_TEMP
  87. | PMBUS_HAVE_FAN12 | PMBUS_HAVE_STATUS_FAN12,
  88. };
  89. static int ds1200_probe(struct i2c_client *client)
  90. {
  91. return pmbus_do_probe(client, &ds1200_info);
  92. }
  93. static int ds1200_remove(struct i2c_client *client)
  94. {
  95. return pmbus_do_remove(client);
  96. }
  97. static const struct i2c_device_id ds1200_id[] = {
  98. {"ds1200", 0},
  99. {}
  100. };
  101. MODULE_DEVICE_TABLE(i2c, ds1200_id);
  102. /* This is the driver that will be inserted */
  103. static struct i2c_driver ds1200_driver = {
  104. .driver = {
  105. .name = "ds1200",
  106. },
  107. .probe_new = ds1200_probe,
  108. .remove = ds1200_remove,
  109. .id_table = ds1200_id,
  110. };
  111. static int __init ds1200_init(void)
  112. {
  113. return i2c_add_driver(&ds1200_driver);
  114. }
  115. static void __exit ds1200_exit(void)
  116. {
  117. i2c_del_driver(&ds1200_driver);
  118. }
  119. Sysfs entries
  120. -------------
  121. When probing the chip, the driver identifies which PMBus registers are
  122. supported, and determines available sensors from this information.
  123. Attribute files only exist if respective sensors are supported by the chip.
  124. Labels are provided to inform the user about the sensor associated with
  125. a given sysfs entry.
  126. The following attributes are supported. Limits are read-write; all other
  127. attributes are read-only.
  128. ======================= ========================================================
  129. inX_input Measured voltage. From READ_VIN or READ_VOUT register.
  130. inX_min Minimum Voltage.
  131. From VIN_UV_WARN_LIMIT or VOUT_UV_WARN_LIMIT register.
  132. inX_max Maximum voltage.
  133. From VIN_OV_WARN_LIMIT or VOUT_OV_WARN_LIMIT register.
  134. inX_lcrit Critical minimum Voltage.
  135. From VIN_UV_FAULT_LIMIT or VOUT_UV_FAULT_LIMIT register.
  136. inX_crit Critical maximum voltage.
  137. From VIN_OV_FAULT_LIMIT or VOUT_OV_FAULT_LIMIT register.
  138. inX_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
  139. inX_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
  140. inX_lcrit_alarm Voltage critical low alarm.
  141. From VOLTAGE_UV_FAULT status.
  142. inX_crit_alarm Voltage critical high alarm.
  143. From VOLTAGE_OV_FAULT status.
  144. inX_label "vin", "vcap", or "voutY"
  145. inX_rated_min Minimum rated voltage.
  146. From MFR_VIN_MIN or MFR_VOUT_MIN register.
  147. inX_rated_max Maximum rated voltage.
  148. From MFR_VIN_MAX or MFR_VOUT_MAX register.
  149. currX_input Measured current. From READ_IIN or READ_IOUT register.
  150. currX_max Maximum current.
  151. From IIN_OC_WARN_LIMIT or IOUT_OC_WARN_LIMIT register.
  152. currX_lcrit Critical minimum output current.
  153. From IOUT_UC_FAULT_LIMIT register.
  154. currX_crit Critical maximum current.
  155. From IIN_OC_FAULT_LIMIT or IOUT_OC_FAULT_LIMIT register.
  156. currX_alarm Current high alarm.
  157. From IIN_OC_WARNING or IOUT_OC_WARNING status.
  158. currX_max_alarm Current high alarm.
  159. From IIN_OC_WARN_LIMIT or IOUT_OC_WARN_LIMIT status.
  160. currX_lcrit_alarm Output current critical low alarm.
  161. From IOUT_UC_FAULT status.
  162. currX_crit_alarm Current critical high alarm.
  163. From IIN_OC_FAULT or IOUT_OC_FAULT status.
  164. currX_label "iin", "iinY", "iinY.Z", "ioutY", or "ioutY.Z",
  165. where Y reflects the page number and Z reflects the
  166. phase.
  167. currX_rated_max Maximum rated current.
  168. From MFR_IIN_MAX or MFR_IOUT_MAX register.
  169. powerX_input Measured power. From READ_PIN or READ_POUT register.
  170. powerX_cap Output power cap. From POUT_MAX register.
  171. powerX_max Power limit. From PIN_OP_WARN_LIMIT or
  172. POUT_OP_WARN_LIMIT register.
  173. powerX_crit Critical output power limit.
  174. From POUT_OP_FAULT_LIMIT register.
  175. powerX_alarm Power high alarm.
  176. From PIN_OP_WARNING or POUT_OP_WARNING status.
  177. powerX_crit_alarm Output power critical high alarm.
  178. From POUT_OP_FAULT status.
  179. powerX_label "pin", "pinY", "pinY.Z", "poutY", or "poutY.Z",
  180. where Y reflects the page number and Z reflects the
  181. phase.
  182. powerX_rated_max Maximum rated power.
  183. From MFR_PIN_MAX or MFR_POUT_MAX register.
  184. tempX_input Measured temperature.
  185. From READ_TEMPERATURE_X register.
  186. tempX_min Minimum temperature. From UT_WARN_LIMIT register.
  187. tempX_max Maximum temperature. From OT_WARN_LIMIT register.
  188. tempX_lcrit Critical low temperature.
  189. From UT_FAULT_LIMIT register.
  190. tempX_crit Critical high temperature.
  191. From OT_FAULT_LIMIT register.
  192. tempX_min_alarm Chip temperature low alarm. Set by comparing
  193. READ_TEMPERATURE_X with UT_WARN_LIMIT if
  194. TEMP_UT_WARNING status is set.
  195. tempX_max_alarm Chip temperature high alarm. Set by comparing
  196. READ_TEMPERATURE_X with OT_WARN_LIMIT if
  197. TEMP_OT_WARNING status is set.
  198. tempX_lcrit_alarm Chip temperature critical low alarm. Set by comparing
  199. READ_TEMPERATURE_X with UT_FAULT_LIMIT if
  200. TEMP_UT_FAULT status is set.
  201. tempX_crit_alarm Chip temperature critical high alarm. Set by comparing
  202. READ_TEMPERATURE_X with OT_FAULT_LIMIT if
  203. TEMP_OT_FAULT status is set.
  204. tempX_rated_min Minimum rated temperature.
  205. From MFR_TAMBIENT_MIN register.
  206. tempX_rated_max Maximum rated temperature.
  207. From MFR_TAMBIENT_MAX, MFR_MAX_TEMP_1, MFR_MAX_TEMP_2 or
  208. MFR_MAX_TEMP_3 register.
  209. ======================= ========================================================