xref: /openbmc/linux/Documentation/hwmon/max8688.rst (revision 976e3645923bdd2fe7893aae33fd7a21098bfb28)
17ebd8b66SMauro Carvalho ChehabKernel driver max8688
27ebd8b66SMauro Carvalho Chehab=====================
37ebd8b66SMauro Carvalho Chehab
47ebd8b66SMauro Carvalho ChehabSupported chips:
57ebd8b66SMauro Carvalho Chehab
67ebd8b66SMauro Carvalho Chehab  * Maxim MAX8688
77ebd8b66SMauro Carvalho Chehab
87ebd8b66SMauro Carvalho Chehab    Prefix: 'max8688'
97ebd8b66SMauro Carvalho Chehab
107ebd8b66SMauro Carvalho Chehab    Addresses scanned: -
117ebd8b66SMauro Carvalho Chehab
127ebd8b66SMauro Carvalho Chehab    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf
137ebd8b66SMauro Carvalho Chehab
147ebd8b66SMauro Carvalho ChehabAuthor: Guenter Roeck <linux@roeck-us.net>
157ebd8b66SMauro Carvalho Chehab
167ebd8b66SMauro Carvalho Chehab
177ebd8b66SMauro Carvalho ChehabDescription
187ebd8b66SMauro Carvalho Chehab-----------
197ebd8b66SMauro Carvalho Chehab
207ebd8b66SMauro Carvalho ChehabThis driver supports hardware monitoring for Maxim MAX8688 Digital Power-Supply
217ebd8b66SMauro Carvalho ChehabController/Monitor with PMBus Interface.
227ebd8b66SMauro Carvalho Chehab
237ebd8b66SMauro Carvalho ChehabThe driver is a client driver to the core PMBus driver. Please see
247ebd8b66SMauro Carvalho ChehabDocumentation/hwmon/pmbus.rst for details on PMBus client drivers.
257ebd8b66SMauro Carvalho Chehab
267ebd8b66SMauro Carvalho Chehab
277ebd8b66SMauro Carvalho ChehabUsage Notes
287ebd8b66SMauro Carvalho Chehab-----------
297ebd8b66SMauro Carvalho Chehab
307ebd8b66SMauro Carvalho ChehabThis driver does not auto-detect devices. You will have to instantiate the
31*ccf988b6SMauro Carvalho Chehabdevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
327ebd8b66SMauro Carvalho Chehabdetails.
337ebd8b66SMauro Carvalho Chehab
347ebd8b66SMauro Carvalho Chehab
357ebd8b66SMauro Carvalho ChehabPlatform data support
367ebd8b66SMauro Carvalho Chehab---------------------
377ebd8b66SMauro Carvalho Chehab
387ebd8b66SMauro Carvalho ChehabThe driver supports standard PMBus driver platform data.
397ebd8b66SMauro Carvalho Chehab
407ebd8b66SMauro Carvalho Chehab
417ebd8b66SMauro Carvalho ChehabSysfs entries
427ebd8b66SMauro Carvalho Chehab-------------
437ebd8b66SMauro Carvalho Chehab
447ebd8b66SMauro Carvalho ChehabThe following attributes are supported. Limits are read-write; all other
457ebd8b66SMauro Carvalho Chehabattributes are read-only.
467ebd8b66SMauro Carvalho Chehab
477ebd8b66SMauro Carvalho Chehab======================= ========================================================
487ebd8b66SMauro Carvalho Chehabin1_label		"vout1"
497ebd8b66SMauro Carvalho Chehabin1_input		Measured voltage. From READ_VOUT register.
507ebd8b66SMauro Carvalho Chehabin1_min			Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
517ebd8b66SMauro Carvalho Chehabin1_max			Maximum voltage. From VOUT_OV_WARN_LIMIT register.
527ebd8b66SMauro Carvalho Chehabin1_lcrit		Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
537ebd8b66SMauro Carvalho Chehabin1_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
547ebd8b66SMauro Carvalho Chehab			register.
557ebd8b66SMauro Carvalho Chehabin1_min_alarm		Voltage low alarm. From VOLTAGE_UV_WARNING status.
567ebd8b66SMauro Carvalho Chehabin1_max_alarm		Voltage high alarm. From VOLTAGE_OV_WARNING status.
577ebd8b66SMauro Carvalho Chehabin1_lcrit_alarm		Voltage critical low alarm. From VOLTAGE_UV_FAULT
587ebd8b66SMauro Carvalho Chehab			status.
597ebd8b66SMauro Carvalho Chehabin1_crit_alarm		Voltage critical high alarm. From VOLTAGE_OV_FAULT
607ebd8b66SMauro Carvalho Chehab			status.
617ebd8b66SMauro Carvalho Chehabin1_highest		Historical maximum voltage.
627ebd8b66SMauro Carvalho Chehabin1_reset_history	Write any value to reset history.
637ebd8b66SMauro Carvalho Chehab
647ebd8b66SMauro Carvalho Chehabcurr1_label		"iout1"
657ebd8b66SMauro Carvalho Chehabcurr1_input		Measured current. From READ_IOUT register.
667ebd8b66SMauro Carvalho Chehabcurr1_max		Maximum current. From IOUT_OC_WARN_LIMIT register.
677ebd8b66SMauro Carvalho Chehabcurr1_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT
687ebd8b66SMauro Carvalho Chehab			register.
697ebd8b66SMauro Carvalho Chehabcurr1_max_alarm		Current high alarm. From IOUT_OC_WARN_LIMIT register.
707ebd8b66SMauro Carvalho Chehabcurr1_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.
717ebd8b66SMauro Carvalho Chehabcurr1_highest		Historical maximum current.
727ebd8b66SMauro Carvalho Chehabcurr1_reset_history	Write any value to reset history.
737ebd8b66SMauro Carvalho Chehab
747ebd8b66SMauro Carvalho Chehabtemp1_input		Measured temperature. From READ_TEMPERATURE_1 register.
757ebd8b66SMauro Carvalho Chehabtemp1_max		Maximum temperature. From OT_WARN_LIMIT register.
767ebd8b66SMauro Carvalho Chehabtemp1_crit		Critical high temperature. From OT_FAULT_LIMIT register.
777ebd8b66SMauro Carvalho Chehabtemp1_max_alarm		Chip temperature high alarm. Set by comparing
787ebd8b66SMauro Carvalho Chehab			READ_TEMPERATURE_1 with OT_WARN_LIMIT if TEMP_OT_WARNING
797ebd8b66SMauro Carvalho Chehab			status is set.
807ebd8b66SMauro Carvalho Chehabtemp1_crit_alarm	Chip temperature critical high alarm. Set by comparing
817ebd8b66SMauro Carvalho Chehab			READ_TEMPERATURE_1 with OT_FAULT_LIMIT if TEMP_OT_FAULT
827ebd8b66SMauro Carvalho Chehab			status is set.
837ebd8b66SMauro Carvalho Chehabtemp1_highest		Historical maximum temperature.
847ebd8b66SMauro Carvalho Chehabtemp1_reset_history	Write any value to reset history.
857ebd8b66SMauro Carvalho Chehab======================= ========================================================
86