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