Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / 381bd3fa8306a56b4bb8703966e6372f1b83762e / . / Documentation / hwmon / lineage-pem.rst
blob: 10c271dc20e830221837356d1f25b9c1970aebd3 [file] [log] [blame]
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]1Kernel driver lineage-pem
2=========================
3
4Supported devices:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]5
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]6 * Lineage Compact Power Line Power Entry Modules
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]7
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]8 Prefix: 'lineage-pem'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]9
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]10 Addresses scanned: -
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]11
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]12 Documentation:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]13
14 http://www.lineagepower.com/oem/pdf/CPLI2C.pdf
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]15
Guenter Roecke3333e52013-02-20 20:58:42 -0800[diff] [blame]16Author: Guenter Roeck <linux@roeck-us.net>
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]17
18
19Description
20-----------
21
22This driver supports various Lineage Compact Power Line DC/DC and AC/DC
23converters such as CP1800, CP2000AC, CP2000DC, CP2100DC, and others.
24
25Lineage CPL power entry modules are nominally PMBus compliant. However, most
26standard PMBus commands are not supported. Specifically, all hardware monitoring
27and status reporting commands are non-standard. For this reason, a standard
28PMBus driver can not be used.
29
30
31Usage Notes
32-----------
33
34This driver does not probe for Lineage CPL devices, since there is no register
35which can be safely used to identify the chip. You will have to instantiate
36the devices explicitly.
37
38Example: the following will load the driver for a Lineage PEM at address 0x40
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]39on I2C bus #1::
40
41 $ modprobe lineage-pem
42 $ echo lineage-pem 0x40 > /sys/bus/i2c/devices/i2c-1/new_device
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]43
44All Lineage CPL power entry modules have a built-in I2C bus master selector
45(PCA9541). To ensure device access, this driver should only be used as client
46driver to the pca9541 I2C master selector driver.
47
48
49Sysfs entries
50-------------
51
52All Lineage CPL devices report output voltage and device temperature as well as
53alarms for output voltage, temperature, input voltage, input current, input power,
54and fan status.
55
56Input voltage, input current, input power, and fan speed measurement is only
57supported on newer devices. The driver detects if those attributes are supported,
58and only creates respective sysfs entries if they are.
59
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]60======================= ===============================
Guenter Roeck502b5a02010-09-29 20:12:08 -0700[diff] [blame]61in1_input Output voltage (mV)
62in1_min_alarm Output undervoltage alarm
63in1_max_alarm Output overvoltage alarm
64in1_crit Output voltage critical alarm
65
66in2_input Input voltage (mV, optional)
67in2_alarm Input voltage alarm
68
69curr1_input Input current (mA, optional)
70curr1_alarm Input overcurrent alarm
71
72power1_input Input power (uW, optional)
73power1_alarm Input power alarm
74
75fan1_input Fan 1 speed (rpm, optional)
76fan2_input Fan 2 speed (rpm, optional)
77fan3_input Fan 3 speed (rpm, optional)
78
79temp1_input
80temp1_max
81temp1_crit
82temp1_alarm
83temp1_crit_alarm
84temp1_fault
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]85======================= ===============================