Merge remote-tracking branch 'stable/linux-5.15.y' into rpi-5.15.y
[platform/kernel/linux-rpi.git] / Documentation / hwmon / ltc4260.rst
1 Kernel driver ltc4260
2 =====================
3
4 Supported chips:
5
6   * Linear Technology LTC4260
7
8     Prefix: 'ltc4260'
9
10     Addresses scanned: -
11
12     Datasheet:
13
14         http://cds.linear.com/docs/en/datasheet/4260fc.pdf
15
16 Author: Guenter Roeck <linux@roeck-us.net>
17
18
19 Description
20 -----------
21
22 The LTC4260 Hot Swap controller allows a board to be safely inserted
23 and removed from a live backplane.
24
25
26 Usage Notes
27 -----------
28
29 This driver does not probe for LTC4260 devices, since there is no register
30 which can be safely used to identify the chip. You will have to instantiate
31 the devices explicitly.
32
33 Example: the following will load the driver for an LTC4260 at address 0x10
34 on I2C bus #1::
35
36         $ modprobe ltc4260
37         $ echo ltc4260 0x10 > /sys/bus/i2c/devices/i2c-1/new_device
38
39
40 Sysfs entries
41 -------------
42
43 Voltage readings provided by this driver are reported as obtained from the ADC
44 registers. If a set of voltage divider resistors is installed, calculate the
45 real voltage by multiplying the reported value with (R1+R2)/R2, where R1 is the
46 value of the divider resistor against the measured voltage and R2 is the value
47 of the divider resistor against Ground.
48
49 Current reading provided by this driver is reported as obtained from the ADC
50 Current Sense register. The reported value assumes that a 1 mOhm sense resistor
51 is installed. If a different sense resistor is installed, calculate the real
52 current by dividing the reported value by the sense resistor value in mOhm.
53
54 ======================= =======================
55 in1_input               SOURCE voltage (mV)
56 in1_min_alarm           Undervoltage alarm
57 in1_max_alarm           Overvoltage alarm
58
59 in2_input               ADIN voltage (mV)
60 in2_alarm               Power bad alarm
61
62 curr1_input             SENSE current (mA)
63 curr1_alarm             SENSE overcurrent alarm
64 ======================= =======================