Linux 6.9-rc6
[sfrench/cifs-2.6.git] / Documentation / hwmon / lm25066.rst
1 Kernel driver lm25066
2 =====================
3
4 Supported 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
61 Author: Guenter Roeck <linux@roeck-us.net>
62
63
64 Description
65 -----------
66
67 This driver supports hardware monitoring for National Semiconductor / TI LM25056,
68 LM25066, LM5064, and LM5066/LM5066I Power Management, Monitoring,
69 Control, and Protection ICs.
70
71 The driver is a client driver to the core PMBus driver. Please see
72 Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
73
74
75 Usage Notes
76 -----------
77
78 This driver does not auto-detect devices. You will have to instantiate the
79 devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
80 details.
81
82 The shunt (sense) resistor value can be configured by a device tree property;
83 see Documentation/devicetree/bindings/hwmon/pmbus/ti,lm25066.yaml for details.
84
85 Platform data support
86 ---------------------
87
88 The driver supports standard PMBus driver platform data.
89
90
91 Sysfs entries
92 -------------
93
94 The following attributes are supported. Limits are read-write; all other
95 attributes are read-only.
96
97 ======================= =======================================================
98 in1_label               "vin"
99 in1_input               Measured input voltage.
100 in1_average             Average measured input voltage.
101 in1_min                 Minimum input voltage.
102 in1_max                 Maximum input voltage.
103 in1_min_alarm           Input voltage low alarm.
104 in1_max_alarm           Input voltage high alarm.
105
106 in2_label               "vmon"
107 in2_input               Measured voltage on VAUX pin
108 in2_min                 Minimum VAUX voltage (LM25056 only).
109 in2_max                 Maximum VAUX voltage (LM25056 only).
110 in2_min_alarm           VAUX voltage low alarm (LM25056 only).
111 in2_max_alarm           VAUX voltage high alarm (LM25056 only).
112
113 in3_label               "vout1"
114                         Not supported on LM25056.
115 in3_input               Measured output voltage.
116 in3_average             Average measured output voltage.
117 in3_min                 Minimum output voltage.
118 in3_min_alarm           Output voltage low alarm.
119
120 curr1_label             "iin"
121 curr1_input             Measured input current.
122 curr1_average           Average measured input current.
123 curr1_max               Maximum input current.
124 curr1_max_alarm         Input current high alarm.
125
126 power1_label            "pin"
127 power1_input            Measured input power.
128 power1_average          Average measured input power.
129 power1_max              Maximum input power limit.
130 power1_alarm            Input power alarm
131 power1_input_highest    Historical maximum power.
132 power1_reset_history    Write any value to reset maximum power history.
133
134 temp1_input             Measured temperature.
135 temp1_max               Maximum temperature.
136 temp1_crit              Critical high temperature.
137 temp1_max_alarm         Chip temperature high alarm.
138 temp1_crit_alarm        Chip temperature critical high alarm.
139 ======================= =======================================================