xref: /linux/Documentation/hwmon/zl6100.rst (revision 40d269c000bda9fcd276a0412a9cebd3f6e344c5)
1Kernel driver zl6100
2====================
3
4Supported chips:
5
6  * Renesas / Intersil / Zilker Labs ZL2004
7
8    Prefix: 'zl2004'
9
10    Addresses scanned: -
11
12    Datasheet: https://www.renesas.com/us/en/document/dst/zl2004-datasheet.pdf
13
14  * Renesas / Intersil / Zilker Labs ZL2005
15
16    Prefix: 'zl2005'
17
18    Addresses scanned: -
19
20    Datasheet: https://www.renesas.com/us/en/document/dst/zl2005-datasheet.pdf
21
22  * Renesas / Intersil / Zilker Labs ZL2006
23
24    Prefix: 'zl2006'
25
26    Addresses scanned: -
27
28    Datasheet: https://www.renesas.com/us/en/document/dst/zl2006-datasheet.pdf
29
30  * Renesas / Intersil / Zilker Labs ZL2008
31
32    Prefix: 'zl2008'
33
34    Addresses scanned: -
35
36    Datasheet: https://www.renesas.com/us/en/document/dst/zl2008-datasheet.pdf
37
38  * Renesas / Intersil / Zilker Labs ZL2105
39
40    Prefix: 'zl2105'
41
42    Addresses scanned: -
43
44    Datasheet: https://www.renesas.com/us/en/document/dst/zl2105-datasheet.pdf
45
46  * Renesas / Intersil / Zilker Labs ZL2106
47
48    Prefix: 'zl2106'
49
50    Addresses scanned: -
51
52    Datasheet: https://www.renesas.com/us/en/document/dst/zl2106-datasheet.pdf
53
54  * Renesas / Intersil / Zilker Labs ZL6100
55
56    Prefix: 'zl6100'
57
58    Addresses scanned: -
59
60    Datasheet: https://www.renesas.com/us/en/document/dst/zl6100-datasheet.pdf
61
62  * Renesas / Intersil / Zilker Labs ZL6105
63
64    Prefix: 'zl6105'
65
66    Addresses scanned: -
67
68    Datasheet: https://www.renesas.com/us/en/document/dst/zl6105-datasheet.pdf
69
70  * Renesas / Intersil / Zilker Labs ZL8802
71
72    Prefix: 'zl8802'
73
74    Addresses scanned: -
75
76    Datasheet: https://www.renesas.com/us/en/document/dst/zl8802-datasheet
77
78  * Renesas / Intersil / Zilker Labs ZL9101M
79
80    Prefix: 'zl9101'
81
82    Addresses scanned: -
83
84    Datasheet: https://www.renesas.com/us/en/document/dst/zl9101m-datasheet
85
86  * Renesas / Intersil / Zilker Labs ZL9117M
87
88    Prefix: 'zl9117'
89
90    Addresses scanned: -
91
92    Datasheet: https://www.renesas.com/us/en/document/dst/zl9117m-datasheet
93
94  * Renesas / Intersil / Zilker Labs ZLS1003, ZLS4009
95
96    Prefix: 'zls1003', zls4009
97
98    Addresses scanned: -
99
100    Datasheet: Not published
101
102  * Flex BMR450, BMR451
103
104    Prefix: 'bmr450', 'bmr451'
105
106    Addresses scanned: -
107
108    Datasheet:
109
110https://flexpowermodules.com/resources/fpm-techspec-bmr450-digital-pol-regulators-20a
111
112  * Flex BMR462, BMR463, BMR464
113
114    Prefixes: 'bmr462', 'bmr463', 'bmr464'
115
116    Addresses scanned: -
117
118    Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr462
119
120  * Flex BMR465, BMR467
121
122    Prefixes: 'bmr465', 'bmr467'
123
124    Addresses scanned: -
125
126    Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr465-digital-pol
127
128  * Flex BMR466
129
130    Prefixes: 'bmr466'
131
132    Addresses scanned: -
133
134    Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr466-8x12
135
136  * Flex BMR469
137
138    Prefixes: 'bmr469'
139
140    Addresses scanned: -
141
142    Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr4696001
143
144Author: Guenter Roeck <linux@roeck-us.net>
145
146
147Description
148-----------
149
150This driver supports hardware monitoring for Renesas / Intersil / Zilker Labs
151ZL6100 and compatible digital DC-DC controllers.
152
153The driver is a client driver to the core PMBus driver. Please see
154Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
155on PMBus client drivers.
156
157
158Usage Notes
159-----------
160
161This driver does not auto-detect devices. You will have to instantiate the
162devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
163details.
164
165.. warning::
166
167  Do not access chip registers using the i2cdump command, and do not use
168  any of the i2ctools commands on a command register used to save and restore
169  configuration data (0x11, 0x12, 0x15, 0x16, and 0xf4). The chips supported by
170  this driver interpret any access to those command registers (including read
171  commands) as request to execute the command in question. Unless write accesses
172  to those registers are protected, this may result in power loss, board resets,
173  and/or Flash corruption. Worst case, your board may turn into a brick.
174
175
176Platform data support
177---------------------
178
179The driver supports standard PMBus driver platform data.
180
181
182Module parameters
183-----------------
184
185delay
186-----
187
188Renesas/Intersil/Zilker Labs DC-DC controllers require a minimum interval
189between I2C bus accesses. According to Intersil, the minimum interval is 2 ms,
190though 1 ms appears to be sufficient and has not caused any problems in testing.
191The problem is known to affect all currently supported chips. For manual override,
192the driver provides a writeable module parameter, 'delay', which can be used
193to set the interval to a value between 0 and 65,535 microseconds.
194
195
196Sysfs entries
197-------------
198
199The following attributes are supported. Limits are read-write; all other
200attributes are read-only.
201
202======================= ========================================================
203in1_label		"vin"
204in1_input		Measured input voltage.
205in1_min			Minimum input voltage.
206in1_max			Maximum input voltage.
207in1_lcrit		Critical minimum input voltage.
208in1_crit		Critical maximum input voltage.
209in1_min_alarm		Input voltage low alarm.
210in1_max_alarm		Input voltage high alarm.
211in1_lcrit_alarm		Input voltage critical low alarm.
212in1_crit_alarm		Input voltage critical high alarm.
213
214in2_label		"vmon"
215in2_input		Measured voltage on VMON (ZL2004) or VDRV (ZL9101M,
216			ZL9117M) pin. Reported voltage is 16x the voltage on the
217			pin (adjusted internally by the chip).
218in2_lcrit		Critical minimum VMON/VDRV Voltage.
219in2_crit		Critical maximum VMON/VDRV voltage.
220in2_lcrit_alarm		VMON/VDRV voltage critical low alarm.
221in2_crit_alarm		VMON/VDRV voltage critical high alarm.
222
223			vmon attributes are supported on ZL2004, ZL8802,
224			ZL9101M, ZL9117M and ZLS4009 only.
225
226inX_label		"vout[12]"
227inX_input		Measured output voltage.
228inX_lcrit		Critical minimum output Voltage.
229inX_crit		Critical maximum output voltage.
230inX_lcrit_alarm		Critical output voltage critical low alarm.
231inX_crit_alarm		Critical output voltage critical high alarm.
232
233			X is 3 for ZL2004, ZL9101M, and ZL9117M,
234			3, 4 for ZL8802 and 2 otherwise.
235
236curr1_label		"iin"
237curr1_input		Measured input current.
238
239			iin attributes are supported on ZL8802 only
240
241currY_label		"iout[12]"
242currY_input		Measured output current.
243currY_lcrit		Critical minimum output current.
244currY_crit		Critical maximum output current.
245currY_lcrit_alarm	Output current critical low alarm.
246currY_crit_alarm	Output current critical high alarm.
247
248			Y is 2, 3 for ZL8802, 1 otherwise
249
250temp[12]_input		Measured temperature.
251temp[12]_min		Minimum temperature.
252temp[12]_max		Maximum temperature.
253temp[12]_lcrit		Critical low temperature.
254temp[12]_crit		Critical high temperature.
255temp[12]_min_alarm	Chip temperature low alarm.
256temp[12]_max_alarm	Chip temperature high alarm.
257temp[12]_lcrit_alarm	Chip temperature critical low alarm.
258temp[12]_crit_alarm	Chip temperature critical high alarm.
259======================= ========================================================
260