max15301.rst 2.5 KB

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