max15301.rst 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. .. SPDX-License-Identifier: GPL-2.0
  2. Kernel driver max15301
  3. ======================
  4. Supported chips:
  5. * Maxim MAX15301
  6. Prefix: 'max15301', 'bmr461'
  7. Addresses scanned: -
  8. Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX15301.pdf
  9. Author: Erik Rosen <[email protected]>
  10. Description
  11. -----------
  12. This driver supports hardware monitoring for Maxim MAX15301 controller chip and
  13. compatible modules.
  14. The driver is a client driver to the core PMBus driver. Please see
  15. Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
  16. on PMBus client drivers.
  17. Usage Notes
  18. -----------
  19. This driver does not auto-detect devices. You will have to instantiate the
  20. devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
  21. details.
  22. Platform data support
  23. ---------------------
  24. The driver supports standard PMBus driver platform data.
  25. Module parameters
  26. -----------------
  27. delay
  28. -----
  29. The controller requires a minimum interval between I2C bus accesses.
  30. The default interval is set to 100 us. For manual override, the driver
  31. provides a writeable module parameter, 'delay', which can be used to
  32. set the interval to a value between 0 and 65,535 microseconds.
  33. Sysfs entries
  34. -------------
  35. The following attributes are supported. Limits are read-write; all other
  36. attributes are read-only.
  37. ======================= ========================================================
  38. in1_label "vin"
  39. in1_input Measured input voltage.
  40. in1_lcrit Critical minimum input voltage.
  41. in1_crit Critical maximum input voltage.
  42. in1_lcrit_alarm Input voltage critical low alarm.
  43. in1_crit_alarm Input voltage critical high alarm.
  44. in2_label "vout1"
  45. in2_input Measured output voltage.
  46. in2_lcrit Critical minimum output Voltage.
  47. in2_crit Critical maximum output voltage.
  48. in2_lcrit_alarm Critical output voltage critical low alarm.
  49. in2_crit_alarm Critical output voltage critical high alarm.
  50. curr1_label "iout1"
  51. curr1_input Measured output current.
  52. curr1_crit Critical maximum output current.
  53. curr1_crit_alarm Output current critical high alarm.
  54. temp1_input Measured maximum temperature of all phases.
  55. temp1_max Maximum temperature limit.
  56. temp1_max_alarm High temperature alarm.
  57. temp1_crit Critical maximum temperature limit.
  58. temp1_crit_alarm Critical maximum temperature alarm.
  59. ======================= ========================================================