[mirror_ubuntu-artful-kernel.git] / Documentation / hwmon / adm1275

Kernel driver adm1275
=====================

Supported chips:
  * Analog Devices ADM1075
    Prefix: 'adm1075'
    Addresses scanned: -
    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1075.pdf
  * Analog Devices ADM1275
    Prefix: 'adm1275'
    Addresses scanned: -
    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf
  * Analog Devices ADM1276
    Prefix: 'adm1276'
    Addresses scanned: -
    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf
  * Analog Devices ADM1278
    Prefix: 'adm1278'
    Addresses scanned: -
    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1278.pdf
  * Analog Devices ADM1293/ADM1294
    Prefix: 'adm1293', 'adm1294'
    Addresses scanned: -
    Datasheet: http://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf

Author: Guenter Roeck <linux@roeck-us.net>


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

This driver supports hardware monitoring for Analog Devices ADM1075, ADM1275,
ADM1276, ADM1278, ADM1293, and ADM1294 Hot-Swap Controller and Digital
Power Monitors.

ADM1075, ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 are hot-swap
controllers that allow a circuit board to be removed from or inserted into
a live backplane. They also feature current and voltage readback via an
integrated 12 bit analog-to-digital converter (ADC), accessed using a
PMBus interface.

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.

The ADM1075, unlike many other PMBus devices, does not support internal voltage
or current scaling. Reported voltages, currents, and power are raw measurements,
and will typically have to be scaled.


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

The driver supports standard PMBus driver platform data. Please see
Documentation/hwmon/pmbus for details.


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

The following attributes are supported. Limits are read-write, history reset
attributes are write-only, all other attributes are read-only.

inX_label		"vin1" or "vout1" depending on chip variant and
			configuration. On ADM1075, ADM1293, and ADM1294,
			vout1 reports the voltage on the VAUX pin.
inX_input		Measured voltage.
inX_min			Minimum Voltage.
inX_max			Maximum voltage.
inX_min_alarm		Voltage low alarm.
inX_max_alarm		Voltage high alarm.
inX_highest		Historical maximum voltage.
inX_reset_history	Write any value to reset history.

curr1_label		"iout1"
curr1_input		Measured current.
curr1_max		Maximum current.
curr1_max_alarm		Current high alarm.
curr1_lcrit		Critical minimum current. Depending on the chip
			configuration, either curr1_lcrit or curr1_crit is
			supported, but not both.
curr1_lcrit_alarm	Critical current low alarm.
curr1_crit		Critical maximum current. Depending on the chip
			configuration, either curr1_lcrit or curr1_crit is
			supported, but not both.
curr1_crit_alarm	Critical current high alarm.
curr1_highest		Historical maximum current.
curr1_reset_history	Write any value to reset history.

power1_label		"pin1"
power1_input		Input power.
power1_input_lowest	Lowest observed input power. ADM1293 and ADM1294 only.
power1_input_highest	Highest observed input power.
power1_reset_history	Write any value to reset history.

			Power attributes are supported on ADM1075, ADM1276,
			ADM1293, and ADM1294.

temp1_input		Chip temperature.
			Temperature attributes are only available on ADM1278.
temp1_max		Maximum chip temperature.
temp1_max_alarm		Temperature alarm.
temp1_crit		Critical chip temperature.
temp1_crit_alarm	Critical temperature high alarm.
temp1_highest		Highest observed temperature.
temp1_reset_history	Write any value to reset history.

			Temperature attributes are supported on ADM1278.
Commit	Line	Data
83f7649c GR	1	Kernel driver adm1275
	2	=====================
	3
	4	Supported chips:
92711269 GR	5	* Analog Devices ADM1075
	6	Prefix: 'adm1075'
	7	Addresses scanned: -
	8	Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1075.pdf
83f7649c GR	9	* Analog Devices ADM1275
	10	Prefix: 'adm1275'
	11	Addresses scanned: -
	12	Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf
5cf231a3 GR	13	* Analog Devices ADM1276
	14	Prefix: 'adm1276'
	15	Addresses scanned: -
	16	Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf
709066ac GR	17	* Analog Devices ADM1278
	18	Prefix: 'adm1278'
	19	Addresses scanned: -
	20	Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1278.pdf
68a40382 GR	21	* Analog Devices ADM1293/ADM1294
	22	Prefix: 'adm1293', 'adm1294'
	23	Addresses scanned: -
	24	Datasheet: http://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf
83f7649c	25
e3333e57	26	Author: Guenter Roeck <linux@roeck-us.net>
83f7649c GR	27
	28
	29	Description
	30	-----------
	31
92417dad	32	This driver supports hardware monitoring for Analog Devices ADM1075, ADM1275,
709066ac GR	33	ADM1276, ADM1278, ADM1293, and ADM1294 Hot-Swap Controller and Digital
709066ac GR	34	Power Monitors.
83f7649c	35
709066ac GR	36	ADM1075, ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 are hot-swap
	37	controllers that allow a circuit board to be removed from or inserted into
	38	a live backplane. They also feature current and voltage readback via an
	39	integrated 12 bit analog-to-digital converter (ADC), accessed using a
	40	PMBus interface.
83f7649c GR	41
	42	The driver is a client driver to the core PMBus driver. Please see
	43	Documentation/hwmon/pmbus for details on PMBus client drivers.
	44
	45
	46	Usage Notes
	47	-----------
	48
	49	This driver does not auto-detect devices. You will have to instantiate the
	50	devices explicitly. Please see Documentation/i2c/instantiating-devices for
	51	details.
	52
92711269 GR	53	The ADM1075, unlike many other PMBus devices, does not support internal voltage
	54	or current scaling. Reported voltages, currents, and power are raw measurements,
	55	and will typically have to be scaled.
	56
83f7649c GR	57
	58	Platform data support
	59	---------------------
	60
	61	The driver supports standard PMBus driver platform data. Please see
	62	Documentation/hwmon/pmbus for details.
	63
	64
	65	Sysfs entries
	66	-------------
	67
c576e30c GR	68	The following attributes are supported. Limits are read-write, history reset
c576e30c GR	69	attributes are write-only, all other attributes are read-only.
83f7649c	70
68a40382 GR	71	inX_label "vin1" or "vout1" depending on chip variant and
	72	configuration. On ADM1075, ADM1293, and ADM1294,
	73	vout1 reports the voltage on the VAUX pin.
	74	inX_input Measured voltage.
	75	inX_min Minimum Voltage.
	76	inX_max Maximum voltage.
	77	inX_min_alarm Voltage low alarm.
	78	inX_max_alarm Voltage high alarm.
	79	inX_highest Historical maximum voltage.
	80	inX_reset_history Write any value to reset history.
83f7649c GR	81
83f7649c GR	82	curr1_label "iout1"
5cf231a3 GR	83	curr1_input Measured current.
	84	curr1_max Maximum current.
	85	curr1_max_alarm Current high alarm.
c5e67636 GR	86	curr1_lcrit Critical minimum current. Depending on the chip
	87	configuration, either curr1_lcrit or curr1_crit is
	88	supported, but not both.
	89	curr1_lcrit_alarm Critical current low alarm.
	90	curr1_crit Critical maximum current. Depending on the chip
	91	configuration, either curr1_lcrit or curr1_crit is
	92	supported, but not both.
	93	curr1_crit_alarm Critical current high alarm.
c576e30c GR	94	curr1_highest Historical maximum current.
c576e30c GR	95	curr1_reset_history Write any value to reset history.
92711269 GR	96
	97	power1_label "pin1"
	98	power1_input Input power.
68a40382 GR	99	power1_input_lowest Lowest observed input power. ADM1293 and ADM1294 only.
68a40382 GR	100	power1_input_highest Highest observed input power.
92711269 GR	101	power1_reset_history Write any value to reset history.
92711269 GR	102
68a40382 GR	103	Power attributes are supported on ADM1075, ADM1276,
68a40382 GR	104	ADM1293, and ADM1294.
709066ac GR	105
	106	temp1_input Chip temperature.
	107	Temperature attributes are only available on ADM1278.
	108	temp1_max Maximum chip temperature.
	109	temp1_max_alarm Temperature alarm.
	110	temp1_crit Critical chip temperature.
	111	temp1_crit_alarm Critical temperature high alarm.
	112	temp1_highest Highest observed temperature.
	113	temp1_reset_history Write any value to reset history.
	114
	115	Temperature attributes are supported on ADM1278.