[mirror_ubuntu-bionic-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

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


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

This driver supports hardware montoring for Analog Devices ADM1075, ADM1275,
and ADM1276 Hot-Swap Controller and Digital Power Monitor.

ADM1075, ADM1275, and ADM1276 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.

in1_label		"vin1" or "vout1" depending on chip variant and
			configuration. On ADM1075, vout1 reports the voltage on
			the VAUX pin.
in1_input		Measured voltage.
in1_min			Minimum Voltage.
in1_max			Maximum voltage.
in1_min_alarm		Voltage low alarm.
in1_max_alarm		Voltage high alarm.
in1_highest		Historical maximum voltage.
in1_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_reset_history	Write any value to reset history.

			Power attributes are supported on ADM1075 and ADM1276
			only.
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
83f7649c GR	17
	18	Author: Guenter Roeck <guenter.roeck@ericsson.com>
	19
	20
	21	Description
	22	-----------
	23
92711269 GR	24	This driver supports hardware montoring for Analog Devices ADM1075, ADM1275,
92711269 GR	25	and ADM1276 Hot-Swap Controller and Digital Power Monitor.
83f7649c	26
92711269 GR	27	ADM1075, ADM1275, and ADM1276 are hot-swap controllers that allow a circuit
	28	board to be removed from or inserted into a live backplane. They also feature
	29	current and voltage readback via an integrated 12-bit analog-to-digital
	30	converter (ADC), accessed using a PMBus interface.
83f7649c GR	31
	32	The driver is a client driver to the core PMBus driver. Please see
	33	Documentation/hwmon/pmbus for details on PMBus client drivers.
	34
	35
	36	Usage Notes
	37	-----------
	38
	39	This driver does not auto-detect devices. You will have to instantiate the
	40	devices explicitly. Please see Documentation/i2c/instantiating-devices for
	41	details.
	42
92711269 GR	43	The ADM1075, unlike many other PMBus devices, does not support internal voltage
	44	or current scaling. Reported voltages, currents, and power are raw measurements,
	45	and will typically have to be scaled.
	46
83f7649c GR	47
	48	Platform data support
	49	---------------------
	50
	51	The driver supports standard PMBus driver platform data. Please see
	52	Documentation/hwmon/pmbus for details.
	53
	54
	55	Sysfs entries
	56	-------------
	57
c576e30c GR	58	The following attributes are supported. Limits are read-write, history reset
c576e30c GR	59	attributes are write-only, all other attributes are read-only.
83f7649c GR	60
83f7649c GR	61	in1_label "vin1" or "vout1" depending on chip variant and
92711269 GR	62	configuration. On ADM1075, vout1 reports the voltage on
92711269 GR	63	the VAUX pin.
5cf231a3	64	in1_input Measured voltage.
40e47125	65	in1_min Minimum Voltage.
5cf231a3 GR	66	in1_max Maximum voltage.
	67	in1_min_alarm Voltage low alarm.
	68	in1_max_alarm Voltage high alarm.
c576e30c GR	69	in1_highest Historical maximum voltage.
c576e30c GR	70	in1_reset_history Write any value to reset history.
83f7649c GR	71
83f7649c GR	72	curr1_label "iout1"
5cf231a3 GR	73	curr1_input Measured current.
	74	curr1_max Maximum current.
	75	curr1_max_alarm Current high alarm.
c5e67636 GR	76	curr1_lcrit Critical minimum current. Depending on the chip
	77	configuration, either curr1_lcrit or curr1_crit is
	78	supported, but not both.
	79	curr1_lcrit_alarm Critical current low alarm.
	80	curr1_crit Critical maximum current. Depending on the chip
	81	configuration, either curr1_lcrit or curr1_crit is
	82	supported, but not both.
	83	curr1_crit_alarm Critical current high alarm.
c576e30c GR	84	curr1_highest Historical maximum current.
c576e30c GR	85	curr1_reset_history Write any value to reset history.
92711269 GR	86
	87	power1_label "pin1"
	88	power1_input Input power.
	89	power1_reset_history Write any value to reset history.
	90
	91	Power attributes are supported on ADM1075 and ADM1276
	92	only.