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