max8688.rst 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. Kernel driver max8688
  2. =====================
  3. Supported chips:
  4. * Maxim MAX8688
  5. Prefix: 'max8688'
  6. Addresses scanned: -
  7. Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf
  8. Author: Guenter Roeck <linux@roeck-us.net>
  9. Description
  10. -----------
  11. This driver supports hardware monitoring for Maxim MAX8688 Digital Power-Supply
  12. Controller/Monitor with PMBus Interface.
  13. The driver is a client driver to the core PMBus driver. Please see
  14. Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
  15. Usage Notes
  16. -----------
  17. This driver does not auto-detect devices. You will have to instantiate the
  18. devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
  19. details.
  20. Platform data support
  21. ---------------------
  22. The driver supports standard PMBus driver platform data.
  23. Sysfs entries
  24. -------------
  25. The following attributes are supported. Limits are read-write; all other
  26. attributes are read-only.
  27. ======================= ========================================================
  28. in1_label "vout1"
  29. in1_input Measured voltage. From READ_VOUT register.
  30. in1_min Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
  31. in1_max Maximum voltage. From VOUT_OV_WARN_LIMIT register.
  32. in1_lcrit Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
  33. in1_crit Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
  34. register.
  35. in1_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
  36. in1_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
  37. in1_lcrit_alarm Voltage critical low alarm. From VOLTAGE_UV_FAULT
  38. status.
  39. in1_crit_alarm Voltage critical high alarm. From VOLTAGE_OV_FAULT
  40. status.
  41. in1_highest Historical maximum voltage.
  42. in1_reset_history Write any value to reset history.
  43. curr1_label "iout1"
  44. curr1_input Measured current. From READ_IOUT register.
  45. curr1_max Maximum current. From IOUT_OC_WARN_LIMIT register.
  46. curr1_crit Critical maximum current. From IOUT_OC_FAULT_LIMIT
  47. register.
  48. curr1_max_alarm Current high alarm. From IOUT_OC_WARN_LIMIT register.
  49. curr1_crit_alarm Current critical high alarm. From IOUT_OC_FAULT status.
  50. curr1_highest Historical maximum current.
  51. curr1_reset_history Write any value to reset history.
  52. temp1_input Measured temperature. From READ_TEMPERATURE_1 register.
  53. temp1_max Maximum temperature. From OT_WARN_LIMIT register.
  54. temp1_crit Critical high temperature. From OT_FAULT_LIMIT register.
  55. temp1_max_alarm Chip temperature high alarm. Set by comparing
  56. READ_TEMPERATURE_1 with OT_WARN_LIMIT if TEMP_OT_WARNING
  57. status is set.
  58. temp1_crit_alarm Chip temperature critical high alarm. Set by comparing
  59. READ_TEMPERATURE_1 with OT_FAULT_LIMIT if TEMP_OT_FAULT
  60. status is set.
  61. temp1_highest Historical maximum temperature.
  62. temp1_reset_history Write any value to reset history.
  63. ======================= ========================================================