[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
  * Maxim MAX34446
    PMBus Power-Supply Data Logger
    Prefixes: 'max34446'
    Addresses scanned: -
    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34446.pdf

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


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

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

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.

For MAX34446, the value of the currX_crit attribute determines if current or
voltage measurement is enabled for a given channel. Voltage measurement is
enabled if currX_crit is set to 0; current measurement is enabled if the
attribute is set to a positive value. Power measurement is only enabled if
channel 1 (3) is configured for voltage measurement, and channel 2 (4) is
configured for current measurement.


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		Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
in[1-6]_max		Maximum voltage. From VOUT_OV_WARN_LIMIT register.
in[1-6]_lcrit		Critical minimum 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]_lowest		Historical minimum voltage.
in[1-6]_highest		Historical maximum voltage.
in[1-6]_reset_history	Write any value to reset history.

			MAX34446 only supports in[1-4].

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-4]_average	Historical average current (MAX34446 only).
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.
			MAX34446 only supports curr[1-4].

power[1,3]_label	"pout[1,3]"
power[1,3]_input	Measured power.
power[1,3]_average	Historical average power.
power[1,3]_highest	Historical maximum power.

			Power attributes only exist for MAX34446.

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]_average	Historical average temperature (MAX34446 only).
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.
			MAX34446 only supports temp[1-3].
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
590defe5 GR	14	* Maxim MAX34446
	15	PMBus Power-Supply Data Logger
	16	Prefixes: 'max34446'
	17	Addresses scanned: -
	18	Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34446.pdf
e428d8d3 GR	19
	20	Author: Guenter Roeck <guenter.roeck@ericsson.com>
	21
	22
	23	Description
	24	-----------
	25
	26	This driver supports hardware montoring for Maxim MAX34440 PMBus 6-Channel
590defe5 GR	27	Power-Supply Manager, MAX34441 PMBus 5-Channel Power-Supply Manager
590defe5 GR	28	and Intelligent Fan Controller, and MAX34446 PMBus Power-Supply Data Logger.
e428d8d3 GR	29
	30	The driver is a client driver to the core PMBus driver. Please see
	31	Documentation/hwmon/pmbus for details on PMBus client drivers.
	32
	33
	34	Usage Notes
	35	-----------
	36
	37	This driver does not auto-detect devices. You will have to instantiate the
	38	devices explicitly. Please see Documentation/i2c/instantiating-devices for
	39	details.
	40
590defe5 GR	41	For MAX34446, the value of the currX_crit attribute determines if current or
	42	voltage measurement is enabled for a given channel. Voltage measurement is
	43	enabled if currX_crit is set to 0; current measurement is enabled if the
	44	attribute is set to a positive value. Power measurement is only enabled if
	45	channel 1 (3) is configured for voltage measurement, and channel 2 (4) is
	46	configured for current measurement.
	47
e428d8d3 GR	48
	49	Platform data support
	50	---------------------
	51
	52	The driver supports standard PMBus driver platform data.
	53
	54
	55	Sysfs entries
	56	-------------
	57
	58	The following attributes are supported. Limits are read-write; all other
	59	attributes are read-only.
	60
	61	in[1-6]_label "vout[1-6]".
	62	in[1-6]_input Measured voltage. From READ_VOUT register.
40e47125	63	in[1-6]_min Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
e428d8d3	64	in[1-6]_max Maximum voltage. From VOUT_OV_WARN_LIMIT register.
40e47125	65	in[1-6]_lcrit Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
e428d8d3 GR	66	in[1-6]_crit Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
	67	in[1-6]_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
	68	in[1-6]_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
	69	in[1-6]_lcrit_alarm Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
	70	in[1-6]_crit_alarm Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
56aad5d1	71	in[1-6]_lowest Historical minimum voltage.
98591dbe GR	72	in[1-6]_highest Historical maximum voltage.
98591dbe GR	73	in[1-6]_reset_history Write any value to reset history.
e428d8d3	74
590defe5 GR	75	MAX34446 only supports in[1-4].
590defe5 GR	76
e428d8d3 GR	77	curr[1-6]_label "iout[1-6]".
	78	curr[1-6]_input Measured current. From READ_IOUT register.
	79	curr[1-6]_max Maximum current. From IOUT_OC_WARN_LIMIT register.
	80	curr[1-6]_crit Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
	81	curr[1-6]_max_alarm Current high alarm. From IOUT_OC_WARNING status.
	82	curr[1-6]_crit_alarm Current critical high alarm. From IOUT_OC_FAULT status.
590defe5	83	curr[1-4]_average Historical average current (MAX34446 only).
98591dbe GR	84	curr[1-6]_highest Historical maximum current.
98591dbe GR	85	curr[1-6]_reset_history Write any value to reset history.
e428d8d3 GR	86
e428d8d3 GR	87	in6 and curr6 attributes only exist for MAX34440.
590defe5 GR	88	MAX34446 only supports curr[1-4].
	89
	90	power[1,3]_label "pout[1,3]"
	91	power[1,3]_input Measured power.
	92	power[1,3]_average Historical average power.
	93	power[1,3]_highest Historical maximum power.
	94
	95	Power attributes only exist for MAX34446.
e428d8d3 GR	96
	97	temp[1-8]_input Measured temperatures. From READ_TEMPERATURE_1 register.
	98	temp1 is the chip's internal temperature. temp2..temp5
	99	are remote I2C temperature sensors. For MAX34441, temp6
	100	is a remote thermal-diode sensor. For MAX34440, temp6..8
	101	are remote I2C temperature sensors.
	102	temp[1-8]_max Maximum temperature. From OT_WARN_LIMIT register.
	103	temp[1-8]_crit Critical high temperature. From OT_FAULT_LIMIT register.
	104	temp[1-8]_max_alarm Temperature high alarm.
	105	temp[1-8]_crit_alarm Temperature critical high alarm.
590defe5	106	temp[1-8]_average Historical average temperature (MAX34446 only).
98591dbe GR	107	temp[1-8]_highest Historical maximum temperature.
98591dbe GR	108	temp[1-8]_reset_history Write any value to reset history.
e428d8d3 GR	109
e428d8d3 GR	110	temp7 and temp8 attributes only exist for MAX34440.
590defe5	111	MAX34446 only supports temp[1-3].