xref: /linux/Documentation/hwmon/max15301.rst (revision 1260ed77798502de9c98020040d2995008de10cc)
11e406332SErik Rosen.. SPDX-License-Identifier: GPL-2.0
21e406332SErik Rosen
31e406332SErik RosenKernel driver max15301
41e406332SErik Rosen======================
51e406332SErik Rosen
61e406332SErik RosenSupported chips:
71e406332SErik Rosen
81e406332SErik Rosen  * Maxim MAX15301
91e406332SErik Rosen
101e406332SErik Rosen    Prefix: 'max15301', 'bmr461'
111e406332SErik Rosen
121e406332SErik Rosen    Addresses scanned: -
131e406332SErik Rosen
141e406332SErik Rosen    Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX15301.pdf
151e406332SErik Rosen
16*788bd792SNuno Sa  * Maxim MAX15303
17*788bd792SNuno Sa
18*788bd792SNuno Sa    Prefix: 'max15303'
19*788bd792SNuno Sa
20*788bd792SNuno Sa    Addresses scanned: -
21*788bd792SNuno Sa
22*788bd792SNuno Sa    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max15303.pdf
23*788bd792SNuno Sa
241e406332SErik RosenAuthor: Erik Rosen <erik.rosen@metormote.com>
251e406332SErik Rosen
261e406332SErik Rosen
271e406332SErik RosenDescription
281e406332SErik Rosen-----------
291e406332SErik Rosen
301e406332SErik RosenThis driver supports hardware monitoring for Maxim MAX15301 controller chip and
311e406332SErik Rosencompatible modules.
321e406332SErik Rosen
331e406332SErik RosenThe driver is a client driver to the core PMBus driver. Please see
341e406332SErik RosenDocumentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
351e406332SErik Rosenon PMBus client drivers.
361e406332SErik Rosen
371e406332SErik Rosen
381e406332SErik RosenUsage Notes
391e406332SErik Rosen-----------
401e406332SErik Rosen
411e406332SErik RosenThis driver does not auto-detect devices. You will have to instantiate the
421e406332SErik Rosendevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
431e406332SErik Rosendetails.
441e406332SErik Rosen
451e406332SErik Rosen
461e406332SErik RosenPlatform data support
471e406332SErik Rosen---------------------
481e406332SErik Rosen
491e406332SErik RosenThe driver supports standard PMBus driver platform data.
501e406332SErik Rosen
511e406332SErik Rosen
521e406332SErik RosenModule parameters
531e406332SErik Rosen-----------------
541e406332SErik Rosen
551e406332SErik Rosendelay
561e406332SErik Rosen-----
571e406332SErik Rosen
581e406332SErik RosenThe controller requires a minimum interval between I2C bus accesses.
591e406332SErik RosenThe default interval is set to 100 us. For manual override, the driver
601e406332SErik Rosenprovides a writeable module parameter, 'delay', which can be used to
611e406332SErik Rosenset the interval to a value between 0 and 65,535 microseconds.
621e406332SErik Rosen
631e406332SErik Rosen
641e406332SErik RosenSysfs entries
651e406332SErik Rosen-------------
661e406332SErik Rosen
671e406332SErik RosenThe following attributes are supported. Limits are read-write; all other
681e406332SErik Rosenattributes are read-only.
691e406332SErik Rosen
701e406332SErik Rosen======================= ========================================================
711e406332SErik Rosenin1_label		"vin"
721e406332SErik Rosenin1_input		Measured input voltage.
731e406332SErik Rosenin1_lcrit		Critical minimum input voltage.
741e406332SErik Rosenin1_crit		Critical maximum input voltage.
751e406332SErik Rosenin1_lcrit_alarm		Input voltage critical low alarm.
761e406332SErik Rosenin1_crit_alarm		Input voltage critical high alarm.
771e406332SErik Rosen
781e406332SErik Rosenin2_label		"vout1"
791e406332SErik Rosenin2_input		Measured output voltage.
801e406332SErik Rosenin2_lcrit		Critical minimum output Voltage.
811e406332SErik Rosenin2_crit		Critical maximum output voltage.
821e406332SErik Rosenin2_lcrit_alarm		Critical output voltage critical low alarm.
831e406332SErik Rosenin2_crit_alarm		Critical output voltage critical high alarm.
841e406332SErik Rosen
851e406332SErik Rosencurr1_label		"iout1"
861e406332SErik Rosencurr1_input		Measured output current.
871e406332SErik Rosencurr1_crit		Critical maximum output current.
881e406332SErik Rosencurr1_crit_alarm	Output current critical high alarm.
891e406332SErik Rosen
901e406332SErik Rosentemp1_input		Measured maximum temperature of all phases.
911e406332SErik Rosentemp1_max		Maximum temperature limit.
921e406332SErik Rosentemp1_max_alarm		High temperature alarm.
931e406332SErik Rosentemp1_crit		Critical maximum temperature limit.
941e406332SErik Rosentemp1_crit_alarm	Critical maximum temperature alarm.
951e406332SErik Rosen======================= ========================================================
96