xref: /openbmc/linux/Documentation/hwmon/ltc4286.rst (revision 7cd2c338e27789c4ba81ab0299ee17f99291acf1)
1*7cd2c338SDelphine CC Chiu.. SPDX-License-Identifier: GPL-2.0-or-later
2*7cd2c338SDelphine CC Chiu
3*7cd2c338SDelphine CC ChiuKernel driver ltc4286
4*7cd2c338SDelphine CC Chiu=====================
5*7cd2c338SDelphine CC Chiu
6*7cd2c338SDelphine CC ChiuSupported chips:
7*7cd2c338SDelphine CC Chiu
8*7cd2c338SDelphine CC Chiu  * Analog Devices LTC4286
9*7cd2c338SDelphine CC Chiu
10*7cd2c338SDelphine CC Chiu    Prefix: 'ltc4286'
11*7cd2c338SDelphine CC Chiu
12*7cd2c338SDelphine CC Chiu    Addresses scanned: -
13*7cd2c338SDelphine CC Chiu
14*7cd2c338SDelphine CC Chiu    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ltc4286.pdf
15*7cd2c338SDelphine CC Chiu
16*7cd2c338SDelphine CC Chiu  * Analog Devices LTC4287
17*7cd2c338SDelphine CC Chiu
18*7cd2c338SDelphine CC Chiu    Prefix: 'ltc4287'
19*7cd2c338SDelphine CC Chiu
20*7cd2c338SDelphine CC Chiu    Addresses scanned: -
21*7cd2c338SDelphine CC Chiu
22*7cd2c338SDelphine CC Chiu    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ltc4287.pdf
23*7cd2c338SDelphine CC Chiu
24*7cd2c338SDelphine CC ChiuAuthor: Delphine CC Chiu <Delphine_CC_Chiu@Wiwynn.com>
25*7cd2c338SDelphine CC Chiu
26*7cd2c338SDelphine CC Chiu
27*7cd2c338SDelphine CC ChiuDescription
28*7cd2c338SDelphine CC Chiu-----------
29*7cd2c338SDelphine CC Chiu
30*7cd2c338SDelphine CC ChiuThis driver supports hardware monitoring for Analog Devices LTC4286
31*7cd2c338SDelphine CC Chiuand LTC4287 Hot-Swap Controller and Digital Power Monitors.
32*7cd2c338SDelphine CC Chiu
33*7cd2c338SDelphine CC ChiuLTC4286 and LTC4287 are hot-swap controllers that allow a circuit board
34*7cd2c338SDelphine CC Chiuto be removed from or inserted into a live backplane. They also feature
35*7cd2c338SDelphine CC Chiucurrent and voltage readback via an integrated 12 bit analog-to-digital
36*7cd2c338SDelphine CC Chiuconverter (ADC), accessed using a PMBus interface.
37*7cd2c338SDelphine CC Chiu
38*7cd2c338SDelphine CC ChiuThe driver is a client driver to the core PMBus driver. Please see
39*7cd2c338SDelphine CC ChiuDocumentation/hwmon/pmbus.rst for details on PMBus client drivers.
40*7cd2c338SDelphine CC Chiu
41*7cd2c338SDelphine CC Chiu
42*7cd2c338SDelphine CC ChiuUsage Notes
43*7cd2c338SDelphine CC Chiu-----------
44*7cd2c338SDelphine CC Chiu
45*7cd2c338SDelphine CC ChiuThis driver does not auto-detect devices. You will have to instantiate the
46*7cd2c338SDelphine CC Chiudevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
47*7cd2c338SDelphine CC Chiudetails.
48*7cd2c338SDelphine CC Chiu
49*7cd2c338SDelphine CC ChiuThe shunt value in micro-ohms can be set via device tree at compile-time. Please
50*7cd2c338SDelphine CC Chiurefer to the Documentation/devicetree/bindings/hwmon/lltc,ltc4286.yaml for bindings
51*7cd2c338SDelphine CC Chiuif the device tree is used.
52*7cd2c338SDelphine CC Chiu
53*7cd2c338SDelphine CC Chiu
54*7cd2c338SDelphine CC ChiuPlatform data support
55*7cd2c338SDelphine CC Chiu---------------------
56*7cd2c338SDelphine CC Chiu
57*7cd2c338SDelphine CC ChiuThe driver supports standard PMBus driver platform data. Please see
58*7cd2c338SDelphine CC ChiuDocumentation/hwmon/pmbus.rst for details.
59*7cd2c338SDelphine CC Chiu
60*7cd2c338SDelphine CC Chiu
61*7cd2c338SDelphine CC ChiuSysfs entries
62*7cd2c338SDelphine CC Chiu-------------
63*7cd2c338SDelphine CC Chiu
64*7cd2c338SDelphine CC ChiuThe following attributes are supported. Limits are read-write, history reset
65*7cd2c338SDelphine CC Chiuattributes are write-only, all other attributes are read-only.
66*7cd2c338SDelphine CC Chiu
67*7cd2c338SDelphine CC Chiu======================= =======================================================
68*7cd2c338SDelphine CC Chiuin1_label		"vin"
69*7cd2c338SDelphine CC Chiuin1_input		Measured voltage.
70*7cd2c338SDelphine CC Chiuin1_alarm		Input voltage alarm.
71*7cd2c338SDelphine CC Chiuin1_min 		Minimum input voltage.
72*7cd2c338SDelphine CC Chiuin1_max 		Maximum input voltage.
73*7cd2c338SDelphine CC Chiu
74*7cd2c338SDelphine CC Chiuin2_label		"vout1"
75*7cd2c338SDelphine CC Chiuin2_input		Measured voltage.
76*7cd2c338SDelphine CC Chiuin2_alarm		Output voltage alarm.
77*7cd2c338SDelphine CC Chiuin2_min 		Minimum output voltage.
78*7cd2c338SDelphine CC Chiuin2_max 		Maximum output voltage.
79*7cd2c338SDelphine CC Chiu
80*7cd2c338SDelphine CC Chiucurr1_label		"iout1"
81*7cd2c338SDelphine CC Chiucurr1_input		Measured current.
82*7cd2c338SDelphine CC Chiucurr1_alarm		Output current alarm.
83*7cd2c338SDelphine CC Chiucurr1_max		Maximum current.
84*7cd2c338SDelphine CC Chiu
85*7cd2c338SDelphine CC Chiupower1_label		"pin"
86*7cd2c338SDelphine CC Chiupower1_input		Input power.
87*7cd2c338SDelphine CC Chiupower1_alarm		Input power alarm.
88*7cd2c338SDelphine CC Chiupower1_max		Maximum poewr.
89*7cd2c338SDelphine CC Chiu
90*7cd2c338SDelphine CC Chiutemp1_input		Chip temperature.
91*7cd2c338SDelphine CC Chiutemp1_min		Minimum chip temperature.
92*7cd2c338SDelphine CC Chiutemp1_max		Maximum chip temperature.
93*7cd2c338SDelphine CC Chiutemp1_crit		Critical chip temperature.
94*7cd2c338SDelphine CC Chiutemp1_alarm		Chip temperature alarm.
95*7cd2c338SDelphine CC Chiu======================= =======================================================
96