xref: /linux/Documentation/hwmon/lm25066.rst (revision 24168c5e6dfbdd5b414f048f47f75d64533296ca) 
1Kernel driver lm25066
2=====================
3
4Supported chips:
5
6  * TI LM25056
7
8    Prefix: 'lm25056'
9
10    Addresses scanned: -
11
12    Datasheets:
13
14	https://www.ti.com/lit/gpn/lm25056
15
16	https://www.ti.com/lit/gpn/lm25056a
17
18  * National Semiconductor LM25066
19
20    Prefix: 'lm25066'
21
22    Addresses scanned: -
23
24    Datasheets:
25
26	http://www.national.com/pf/LM/LM25066.html
27
28	http://www.national.com/pf/LM/LM25066A.html
29
30  * National Semiconductor LM5064
31
32    Prefix: 'lm5064'
33
34    Addresses scanned: -
35
36    Datasheet:
37
38	http://www.national.com/pf/LM/LM5064.html
39
40  * National Semiconductor LM5066
41
42    Prefix: 'lm5066'
43
44    Addresses scanned: -
45
46    Datasheet:
47
48	http://www.national.com/pf/LM/LM5066.html
49
50  * Texas Instruments LM5066I
51
52    Prefix: 'lm5066i'
53
54    Addresses scanned: -
55
56	Datasheet:
57
58    https://www.ti.com/product/LM5066I
59
60
61Author: Guenter Roeck <linux@roeck-us.net>
62
63
64Description
65-----------
66
67This driver supports hardware monitoring for National Semiconductor / TI LM25056,
68LM25066, LM5064, and LM5066/LM5066I Power Management, Monitoring,
69Control, and Protection ICs.
70
71The driver is a client driver to the core PMBus driver. Please see
72Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
73
74
75Usage Notes
76-----------
77
78This driver does not auto-detect devices. You will have to instantiate the
79devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
80details.
81
82The shunt (sense) resistor value can be configured by a device tree property;
83see Documentation/devicetree/bindings/hwmon/pmbus/ti,lm25066.yaml for details.
84
85Platform data support
86---------------------
87
88The driver supports standard PMBus driver platform data.
89
90
91Sysfs entries
92-------------
93
94The following attributes are supported. Limits are read-write; all other
95attributes are read-only.
96
97======================= =======================================================
98in1_label		"vin"
99in1_input		Measured input voltage.
100in1_average		Average measured input voltage.
101in1_min			Minimum input voltage.
102in1_max			Maximum input voltage.
103in1_min_alarm		Input voltage low alarm.
104in1_max_alarm		Input voltage high alarm.
105
106in2_label		"vmon"
107in2_input		Measured voltage on VAUX pin
108in2_min			Minimum VAUX voltage (LM25056 only).
109in2_max			Maximum VAUX voltage (LM25056 only).
110in2_min_alarm		VAUX voltage low alarm (LM25056 only).
111in2_max_alarm		VAUX voltage high alarm (LM25056 only).
112
113in3_label		"vout1"
114			Not supported on LM25056.
115in3_input		Measured output voltage.
116in3_average		Average measured output voltage.
117in3_min			Minimum output voltage.
118in3_min_alarm		Output voltage low alarm.
119
120curr1_label		"iin"
121curr1_input		Measured input current.
122curr1_average		Average measured input current.
123curr1_max		Maximum input current.
124curr1_max_alarm		Input current high alarm.
125
126power1_label		"pin"
127power1_input		Measured input power.
128power1_average		Average measured input power.
129power1_max		Maximum input power limit.
130power1_alarm		Input power alarm
131power1_input_highest	Historical maximum power.
132power1_reset_history	Write any value to reset maximum power history.
133
134temp1_input		Measured temperature.
135temp1_max		Maximum temperature.
136temp1_crit		Critical high temperature.
137temp1_max_alarm		Chip temperature high alarm.
138temp1_crit_alarm	Chip temperature critical high alarm.
139======================= =======================================================
140