[deliverable/linux.git] / Documentation / hwmon / max34440

Kernel driver max34440
======================

Supported chips:
  * Maxim MAX34440
    Prefixes: 'max34440'
    Addresses scanned: -
    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34440.pdf
  * Maxim MAX34441
    PMBus 5-Channel Power-Supply Manager and Intelligent Fan Controller
    Prefixes: 'max34441'
    Addresses scanned: -
    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34441.pdf

Author: Guenter Roeck <guenter.roeck@ericsson.com>


Description
-----------

This driver supports hardware montoring for Maxim MAX34440 PMBus 6-Channel
Power-Supply Manager and MAX34441 PMBus 5-Channel Power-Supply Manager
and Intelligent Fan Controller.

The driver is a client driver to the core PMBus driver. Please see
Documentation/hwmon/pmbus for details on PMBus client drivers.


Usage Notes
-----------

This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for
details.


Platform data support
---------------------

The driver supports standard PMBus driver platform data.


Sysfs entries
-------------

The following attributes are supported. Limits are read-write; all other
attributes are read-only.

in[1-6]_label		"vout[1-6]".
in[1-6]_input		Measured voltage. From READ_VOUT register.
in[1-6]_min		Minumum Voltage. From VOUT_UV_WARN_LIMIT register.
in[1-6]_max		Maximum voltage. From VOUT_OV_WARN_LIMIT register.
in[1-6]_lcrit		Critical minumum Voltage. VOUT_UV_FAULT_LIMIT register.
in[1-6]_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
in[1-6]_min_alarm	Voltage low alarm. From VOLTAGE_UV_WARNING status.
in[1-6]_max_alarm	Voltage high alarm. From VOLTAGE_OV_WARNING status.
in[1-6]_lcrit_alarm	Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
in[1-6]_crit_alarm	Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
in[1-6]_highest		Historical maximum voltage.
in[1-6]_reset_history	Write any value to reset history.

curr[1-6]_label		"iout[1-6]".
curr[1-6]_input		Measured current. From READ_IOUT register.
curr[1-6]_max		Maximum current. From IOUT_OC_WARN_LIMIT register.
curr[1-6]_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
curr[1-6]_max_alarm	Current high alarm. From IOUT_OC_WARNING status.
curr[1-6]_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.
curr[1-6]_highest	Historical maximum current.
curr[1-6]_reset_history	Write any value to reset history.

			in6 and curr6 attributes only exist for MAX34440.

temp[1-8]_input		Measured temperatures. From READ_TEMPERATURE_1 register.
			temp1 is the chip's internal temperature. temp2..temp5
			are remote I2C temperature sensors. For MAX34441, temp6
			is a remote thermal-diode sensor. For MAX34440, temp6..8
			are remote I2C temperature sensors.
temp[1-8]_max		Maximum temperature. From OT_WARN_LIMIT register.
temp[1-8]_crit		Critical high temperature. From OT_FAULT_LIMIT register.
temp[1-8]_max_alarm	Temperature high alarm.
temp[1-8]_crit_alarm	Temperature critical high alarm.
temp[1-8]_highest	Historical maximum temperature.
temp[1-8]_reset_history	Write any value to reset history.

			temp7 and temp8 attributes only exist for MAX34440.
Commit	Line	Data
e428d8d3 GR	1	Kernel driver max34440
	2	======================
	3
	4	Supported chips:
	5	* Maxim MAX34440
	6	Prefixes: 'max34440'
	7	Addresses scanned: -
	8	Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34440.pdf
	9	* Maxim MAX34441
	10	PMBus 5-Channel Power-Supply Manager and Intelligent Fan Controller
	11	Prefixes: 'max34441'
	12	Addresses scanned: -
	13	Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34441.pdf
	14
	15	Author: Guenter Roeck <guenter.roeck@ericsson.com>
	16
	17
	18	Description
	19	-----------
	20
	21	This driver supports hardware montoring for Maxim MAX34440 PMBus 6-Channel
	22	Power-Supply Manager and MAX34441 PMBus 5-Channel Power-Supply Manager
	23	and Intelligent Fan Controller.
	24
	25	The driver is a client driver to the core PMBus driver. Please see
	26	Documentation/hwmon/pmbus for details on PMBus client drivers.
	27
	28
	29	Usage Notes
	30	-----------
	31
	32	This driver does not auto-detect devices. You will have to instantiate the
	33	devices explicitly. Please see Documentation/i2c/instantiating-devices for
	34	details.
	35
	36
	37	Platform data support
	38	---------------------
	39
	40	The driver supports standard PMBus driver platform data.
	41
	42
	43	Sysfs entries
	44	-------------
	45
	46	The following attributes are supported. Limits are read-write; all other
	47	attributes are read-only.
	48
	49	in[1-6]_label "vout[1-6]".
	50	in[1-6]_input Measured voltage. From READ_VOUT register.
	51	in[1-6]_min Minumum Voltage. From VOUT_UV_WARN_LIMIT register.
	52	in[1-6]_max Maximum voltage. From VOUT_OV_WARN_LIMIT register.
	53	in[1-6]_lcrit Critical minumum Voltage. VOUT_UV_FAULT_LIMIT register.
	54	in[1-6]_crit Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
	55	in[1-6]_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
	56	in[1-6]_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
	57	in[1-6]_lcrit_alarm Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
	58	in[1-6]_crit_alarm Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
98591dbe GR	59	in[1-6]_highest Historical maximum voltage.
98591dbe GR	60	in[1-6]_reset_history Write any value to reset history.
e428d8d3 GR	61
	62	curr[1-6]_label "iout[1-6]".
	63	curr[1-6]_input Measured current. From READ_IOUT register.
	64	curr[1-6]_max Maximum current. From IOUT_OC_WARN_LIMIT register.
	65	curr[1-6]_crit Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
	66	curr[1-6]_max_alarm Current high alarm. From IOUT_OC_WARNING status.
	67	curr[1-6]_crit_alarm Current critical high alarm. From IOUT_OC_FAULT status.
98591dbe GR	68	curr[1-6]_highest Historical maximum current.
98591dbe GR	69	curr[1-6]_reset_history Write any value to reset history.
e428d8d3 GR	70
	71	in6 and curr6 attributes only exist for MAX34440.
	72
	73	temp[1-8]_input Measured temperatures. From READ_TEMPERATURE_1 register.
	74	temp1 is the chip's internal temperature. temp2..temp5
	75	are remote I2C temperature sensors. For MAX34441, temp6
	76	is a remote thermal-diode sensor. For MAX34440, temp6..8
	77	are remote I2C temperature sensors.
	78	temp[1-8]_max Maximum temperature. From OT_WARN_LIMIT register.
	79	temp[1-8]_crit Critical high temperature. From OT_FAULT_LIMIT register.
	80	temp[1-8]_max_alarm Temperature high alarm.
	81	temp[1-8]_crit_alarm Temperature critical high alarm.
98591dbe GR	82	temp[1-8]_highest Historical maximum temperature.
98591dbe GR	83	temp[1-8]_reset_history Write any value to reset history.
e428d8d3 GR	84
e428d8d3 GR	85	temp7 and temp8 attributes only exist for MAX34440.