xref: /linux/Documentation/hwmon/ltc4286.rst (revision e91c37f1)
1.. SPDX-License-Identifier: GPL-2.0-or-later
2
3Kernel driver ltc4286
4=====================
5
6Supported chips:
7
8  * Analog Devices LTC4286
9
10    Prefix: 'ltc4286'
11
12    Addresses scanned: -
13
14    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ltc4286.pdf
15
16  * Analog Devices LTC4287
17
18    Prefix: 'ltc4287'
19
20    Addresses scanned: -
21
22    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ltc4287.pdf
23
24Author: Delphine CC Chiu <Delphine_CC_Chiu@Wiwynn.com>
25
26
27Description
28-----------
29
30This driver supports hardware monitoring for Analog Devices LTC4286
31and LTC4287 Hot-Swap Controller and Digital Power Monitors.
32
33LTC4286 and LTC4287 are hot-swap controllers that allow a circuit board
34to be removed from or inserted into a live backplane. They also feature
35current and voltage readback via an integrated 12 bit analog-to-digital
36converter (ADC), accessed using a PMBus interface.
37
38The driver is a client driver to the core PMBus driver. Please see
39Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
40
41
42Usage Notes
43-----------
44
45This driver does not auto-detect devices. You will have to instantiate the
46devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
47details.
48
49The shunt value in micro-ohms can be set via device tree at compile-time. Please
50refer to the Documentation/devicetree/bindings/hwmon/lltc,ltc4286.yaml for bindings
51if the device tree is used.
52
53
54Platform data support
55---------------------
56
57The driver supports standard PMBus driver platform data. Please see
58Documentation/hwmon/pmbus.rst for details.
59
60
61Sysfs entries
62-------------
63
64The following attributes are supported. Limits are read-write, history reset
65attributes are write-only, all other attributes are read-only.
66
67======================= =======================================================
68in1_label		"vin"
69in1_input		Measured voltage.
70in1_alarm		Input voltage alarm.
71in1_min 		Minimum input voltage.
72in1_max 		Maximum input voltage.
73
74in2_label		"vout1"
75in2_input		Measured voltage.
76in2_alarm		Output voltage alarm.
77in2_min 		Minimum output voltage.
78in2_max 		Maximum output voltage.
79
80curr1_label		"iout1"
81curr1_input		Measured current.
82curr1_alarm		Output current alarm.
83curr1_max		Maximum current.
84
85power1_label		"pin"
86power1_input		Input power.
87power1_alarm		Input power alarm.
88power1_max		Maximum poewr.
89
90temp1_input		Chip temperature.
91temp1_min		Minimum chip temperature.
92temp1_max		Maximum chip temperature.
93temp1_crit		Critical chip temperature.
94temp1_alarm		Chip temperature alarm.
95======================= =======================================================
96