Blame - Documentation/hwmon/adm1275 - SHIFTPHONES/kernel/common

blob: 39033538eb030c80a503e164391fe54e674f197b [file] [log] [blame]

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