xref: /linux/Documentation/hwmon/isl68137.rst (revision 53597deca0e38c30e6cd4ba2114fa42d2bcd85bb)
1Kernel driver isl68137
2======================
3
4Supported chips:
5
6  * Renesas ISL68137
7
8    Prefix: 'isl68137'
9
10    Addresses scanned: -
11
12    Datasheet:
13
14      Publicly available at the Renesas website
15      https://www.renesas.com/us/en/www/doc/datasheet/isl68137.pdf
16
17  * Renesas ISL68220
18
19    Prefix: 'isl68220'
20
21    Addresses scanned: -
22
23    Datasheet:
24
25      Publicly available (after August 2020 launch) at the Renesas website
26
27  * Renesas ISL68221
28
29    Prefix: 'isl68221'
30
31    Addresses scanned: -
32
33    Datasheet:
34
35      Publicly available (after August 2020 launch) at the Renesas website
36
37  * Renesas ISL68222
38
39    Prefix: 'isl68222'
40
41    Addresses scanned: -
42
43    Datasheet:
44
45      Publicly available (after August 2020 launch) at the Renesas website
46
47  * Renesas ISL68223
48
49    Prefix: 'isl68223'
50
51    Addresses scanned: -
52
53    Datasheet:
54
55      Publicly available (after August 2020 launch) at the Renesas website
56
57  * Renesas ISL68224
58
59    Prefix: 'isl68224'
60
61    Addresses scanned: -
62
63    Datasheet:
64
65      Publicly available (after August 2020 launch) at the Renesas website
66
67  * Renesas ISL68225
68
69    Prefix: 'isl68225'
70
71    Addresses scanned: -
72
73    Datasheet:
74
75      Publicly available (after August 2020 launch) at the Renesas website
76
77  * Renesas ISL68226
78
79    Prefix: 'isl68226'
80
81    Addresses scanned: -
82
83    Datasheet:
84
85      Publicly available (after August 2020 launch) at the Renesas website
86
87  * Renesas ISL68227
88
89    Prefix: 'isl68227'
90
91    Addresses scanned: -
92
93    Datasheet:
94
95      Publicly available (after August 2020 launch) at the Renesas website
96
97  * Renesas ISL68229
98
99    Prefix: 'isl68229'
100
101    Addresses scanned: -
102
103    Datasheet:
104
105      Publicly available (after August 2020 launch) at the Renesas website
106
107  * Renesas ISL68233
108
109    Prefix: 'isl68233'
110
111    Addresses scanned: -
112
113    Datasheet:
114
115      Publicly available (after August 2020 launch) at the Renesas website
116
117  * Renesas ISL68239
118
119    Prefix: 'isl68239'
120
121    Addresses scanned: -
122
123    Datasheet:
124
125      Publicly available (after August 2020 launch) at the Renesas website
126
127  * Renesas ISL69222
128
129    Prefix: 'isl69222'
130
131    Addresses scanned: -
132
133    Datasheet:
134
135      Publicly available (after August 2020 launch) at the Renesas website
136
137  * Renesas ISL69223
138
139    Prefix: 'isl69223'
140
141    Addresses scanned: -
142
143    Datasheet:
144
145      Publicly available (after August 2020 launch) at the Renesas website
146
147  * Renesas ISL69224
148
149    Prefix: 'isl69224'
150
151    Addresses scanned: -
152
153    Datasheet:
154
155      Publicly available (after August 2020 launch) at the Renesas website
156
157  * Renesas ISL69225
158
159    Prefix: 'isl69225'
160
161    Addresses scanned: -
162
163    Datasheet:
164
165      Publicly available (after August 2020 launch) at the Renesas website
166
167  * Renesas ISL69227
168
169    Prefix: 'isl69227'
170
171    Addresses scanned: -
172
173    Datasheet:
174
175      Publicly available (after August 2020 launch) at the Renesas website
176
177  * Renesas ISL69228
178
179    Prefix: 'isl69228'
180
181    Addresses scanned: -
182
183    Datasheet:
184
185      Publicly available (after August 2020 launch) at the Renesas website
186
187  * Renesas ISL69234
188
189    Prefix: 'isl69234'
190
191    Addresses scanned: -
192
193    Datasheet:
194
195      Publicly available (after August 2020 launch) at the Renesas website
196
197  * Renesas ISL69236
198
199    Prefix: 'isl69236'
200
201    Addresses scanned: -
202
203    Datasheet:
204
205      Publicly available (after August 2020 launch) at the Renesas website
206
207  * Renesas ISL69239
208
209    Prefix: 'isl69239'
210
211    Addresses scanned: -
212
213    Datasheet:
214
215      Publicly available (after August 2020 launch) at the Renesas website
216
217  * Renesas ISL69242
218
219    Prefix: 'isl69242'
220
221    Addresses scanned: -
222
223    Datasheet:
224
225      Publicly available (after August 2020 launch) at the Renesas website
226
227  * Renesas ISL69243
228
229    Prefix: 'isl69243'
230
231    Addresses scanned: -
232
233    Datasheet:
234
235      Publicly available (after August 2020 launch) at the Renesas website
236
237  * Renesas ISL69247
238
239    Prefix: 'isl69247'
240
241    Addresses scanned: -
242
243    Datasheet:
244
245      Publicly available (after August 2020 launch) at the Renesas website
246
247  * Renesas ISL69248
248
249    Prefix: 'isl69248'
250
251    Addresses scanned: -
252
253    Datasheet:
254
255      Publicly available (after August 2020 launch) at the Renesas website
256
257  * Renesas ISL69254
258
259    Prefix: 'isl69254'
260
261    Addresses scanned: -
262
263    Datasheet:
264
265      Publicly available (after August 2020 launch) at the Renesas website
266
267  * Renesas ISL69255
268
269    Prefix: 'isl69255'
270
271    Addresses scanned: -
272
273    Datasheet:
274
275      Publicly available (after August 2020 launch) at the Renesas website
276
277  * Renesas ISL69256
278
279    Prefix: 'isl69256'
280
281    Addresses scanned: -
282
283    Datasheet:
284
285      Publicly available (after August 2020 launch) at the Renesas website
286
287  * Renesas ISL69259
288
289    Prefix: 'isl69259'
290
291    Addresses scanned: -
292
293    Datasheet:
294
295      Publicly available (after August 2020 launch) at the Renesas website
296
297  * Renesas ISL69260
298
299    Prefix: 'isl69260'
300
301    Addresses scanned: -
302
303    Datasheet:
304
305      Publicly available (after August 2020 launch) at the Renesas website
306
307  * Renesas ISL69268
308
309    Prefix: 'isl69268'
310
311    Addresses scanned: -
312
313    Datasheet:
314
315      Publicly available (after August 2020 launch) at the Renesas website
316
317  * Renesas ISL69269
318
319    Prefix: 'isl69269'
320
321    Addresses scanned: -
322
323    Datasheet:
324
325      Publicly available (after August 2020 launch) at the Renesas website
326
327  * Renesas ISL69298
328
329    Prefix: 'isl69298'
330
331    Addresses scanned: -
332
333    Datasheet:
334
335      Publicly available (after August 2020 launch) at the Renesas website
336
337  * Renesas RAA228000
338
339    Prefix: 'raa228000'
340
341    Addresses scanned: -
342
343    Datasheet:
344
345      Publicly available (after August 2020 launch) at the Renesas website
346
347  * Renesas RAA228004
348
349    Prefix: 'raa228004'
350
351    Addresses scanned: -
352
353    Datasheet:
354
355      Publicly available (after August 2020 launch) at the Renesas website
356
357  * Renesas RAA228006
358
359    Prefix: 'raa228006'
360
361    Addresses scanned: -
362
363    Datasheet:
364
365      Publicly available (after August 2020 launch) at the Renesas website
366
367  * Renesas RAA228228
368
369    Prefix: 'raa228228'
370
371    Addresses scanned: -
372
373    Datasheet:
374
375      Publicly available (after August 2020 launch) at the Renesas website
376
377  * Renesas RAA228244
378
379    Prefix: 'raa228244'
380
381    Addresses scanned: -
382
383    Datasheet:
384
385      Provided by Renesas upon request and NDA
386
387  * Renesas RAA228246
388
389    Prefix: 'raa228246'
390
391    Addresses scanned: -
392
393    Datasheet:
394
395      Provided by Renesas upon request and NDA
396
397  * Renesas RAA228942
398
399    Prefix: 'raa228942'
400
401    Addresses scanned: -
402
403    Datasheet:
404
405      Provided by Renesas upon request and NDA
406
407  * Renesas RAA228943
408
409    Prefix: 'raa228943'
410
411    Addresses scanned: -
412
413    Datasheet:
414
415      Provided by Renesas upon request and NDA
416
417  * Renesas RAA229001
418
419    Prefix: 'raa229001'
420
421    Addresses scanned: -
422
423    Datasheet:
424
425      Publicly available (after August 2020 launch) at the Renesas website
426
427  * Renesas RAA229004
428
429    Prefix: 'raa229004'
430
431    Addresses scanned: -
432
433    Datasheet:
434
435      Publicly available (after August 2020 launch) at the Renesas website
436
437  * Renesas RAA229141
438
439    Prefix: 'raa229141'
440
441    Addresses scanned: -
442
443    Datasheet:
444
445      Provided by Renesas upon request and NDA
446
447Authors:
448      - Maxim Sloyko <maxims@google.com>
449      - Robert Lippert <rlippert@google.com>
450      - Patrick Venture <venture@google.com>
451      - Grant Peltier <grant.peltier.jg@renesas.com>
452
453Description
454-----------
455
456This driver supports the Renesas ISL68137 and all 2nd generation Renesas
457digital multiphase voltage regulators (raa_dmpvr2). The ISL68137 is a digital
458output 7-phase configurable PWM controller with an AVSBus interface. 2nd
459generation devices are grouped into 4 distinct configurations: '1rail' for
460single-rail devices, '2rail' for dual-rail devices, '3rail' for 3-rail devices,
461and 'hv' for high voltage single-rail devices. Consult the individual datasheets
462for more information.
463
464Usage Notes
465-----------
466
467This driver does not probe for PMBus devices. You will have to instantiate
468devices explicitly.
469
470The ISL68137 AVS operation mode must be enabled/disabled at runtime.
471
472Beyond the normal sysfs pmbus attributes, the driver exposes a control attribute
473for the ISL68137.
474
475For 2nd generation Renesas digital multiphase voltage regulators, only the
476normal sysfs pmbus attributes are supported.
477
478ISL68137 sysfs attributes
479-------------------------
480
481======================= ====================================
482avs(0|1)_enable		Controls the AVS state of each rail.
483
484curr1_label		"iin"
485curr1_input		Measured input current
486curr1_crit		Critical maximum current
487curr1_crit_alarm	Current critical high alarm
488
489curr[2-3]_label		"iout[1-2]"
490curr[2-3]_input		Measured output current
491curr[2-3]_crit		Critical maximum current
492curr[2-3]_crit_alarm	Current critical high alarm
493
494in1_label		"vin"
495in1_input		Measured input voltage
496in1_lcrit		Critical minimum input voltage
497in1_lcrit_alarm		Input voltage critical low alarm
498in1_crit		Critical maximum input voltage
499in1_crit_alarm		Input voltage critical high alarm
500
501in[2-3]_label		"vout[1-2]"
502in[2-3]_input		Measured output voltage
503in[2-3]_lcrit		Critical minimum output voltage
504in[2-3]_lcrit_alarm	Output voltage critical low alarm
505in[2-3]_crit		Critical maximum output voltage
506in[2-3]_crit_alarm	Output voltage critical high alarm
507
508power1_label		"pin"
509power1_input		Measured input power
510power1_alarm		Input power high alarm
511
512power[2-3]_label	"pout[1-2]"
513power[2-3]_input	Measured output power
514
515temp[1-3]_input		Measured temperature
516temp[1-3]_crit		Critical high temperature
517temp[1-3]_crit_alarm	Chip temperature critical high alarm
518temp[1-3]_max		Maximum temperature
519temp[1-3]_max_alarm	Chip temperature high alarm
520======================= ====================================
521
522raa_dmpvr2_1rail/hv sysfs attributes
523------------------------------------
524
525======================= ==========================================
526curr1_label		"iin"
527curr1_input		Measured input current
528curr1_crit		Critical maximum current
529curr1_crit_alarm	Current critical high alarm
530
531curr2_label		"iout"
532curr2_input		Measured output current
533curr2_crit		Critical maximum current
534curr2_crit_alarm	Current critical high alarm
535
536in1_label		"vin"
537in1_input		Measured input voltage
538in1_lcrit		Critical minimum input voltage
539in1_lcrit_alarm		Input voltage critical low alarm
540in1_crit		Critical maximum input voltage
541in1_crit_alarm		Input voltage critical high alarm
542
543in2_label		"vmon"
544in2_input		Scaled VMON voltage read from the VMON pin
545
546in3_label		"vout"
547in3_input		Measured output voltage
548in3_lcrit		Critical minimum output voltage
549in3_lcrit_alarm         Output voltage critical low alarm
550in3_crit		Critical maximum output voltage
551in3_crit_alarm          Output voltage critical high alarm
552
553power1_label		"pin"
554power1_input		Measured input power
555power1_alarm		Input power high alarm
556
557power2_label	        "pout"
558power2_input	        Measured output power
559
560temp[1-3]_input		Measured temperature
561temp[1-3]_crit		Critical high temperature
562temp[1-3]_crit_alarm	Chip temperature critical high alarm
563temp[1-3]_max		Maximum temperature
564temp[1-3]_max_alarm	Chip temperature high alarm
565======================= ==========================================
566
567raa_dmpvr2_2rail sysfs attributes
568---------------------------------
569
570======================= ==========================================
571curr[1-2]_label		"iin[1-2]"
572curr[1-2]_input		Measured input current
573curr[1-2]_crit		Critical maximum current
574curr[1-2]_crit_alarm	Current critical high alarm
575
576curr[3-4]_label		"iout[1-2]"
577curr[3-4]_input		Measured output current
578curr[3-4]_crit		Critical maximum current
579curr[3-4]_crit_alarm	Current critical high alarm
580
581in1_label		"vin"
582in1_input		Measured input voltage
583in1_lcrit		Critical minimum input voltage
584in1_lcrit_alarm		Input voltage critical low alarm
585in1_crit		Critical maximum input voltage
586in1_crit_alarm		Input voltage critical high alarm
587
588in2_label		"vmon"
589in2_input		Scaled VMON voltage read from the VMON pin
590
591in[3-4]_label		"vout[1-2]"
592in[3-4]_input		Measured output voltage
593in[3-4]_lcrit		Critical minimum output voltage
594in[3-4]_lcrit_alarm	Output voltage critical low alarm
595in[3-4]_crit		Critical maximum output voltage
596in[3-4]_crit_alarm	Output voltage critical high alarm
597
598power[1-2]_label	"pin[1-2]"
599power[1-2]_input	Measured input power
600power[1-2]_alarm	Input power high alarm
601
602power[3-4]_label	"pout[1-2]"
603power[3-4]_input	Measured output power
604
605temp[1-5]_input		Measured temperature
606temp[1-5]_crit		Critical high temperature
607temp[1-5]_crit_alarm	Chip temperature critical high alarm
608temp[1-5]_max		Maximum temperature
609temp[1-5]_max_alarm	Chip temperature high alarm
610======================= ==========================================
611
612raa_dmpvr2_3rail sysfs attributes
613---------------------------------
614
615======================= ==========================================
616curr[1-3]_label		"iin[1-3]"
617curr[1-3]_input		Measured input current
618curr[1-3]_crit		Critical maximum current
619curr[1-3]_crit_alarm	Current critical high alarm
620
621curr[4-6]_label		"iout[1-3]"
622curr[4-6]_input		Measured output current
623curr[4-6]_crit		Critical maximum current
624curr[4-6]_crit_alarm	Current critical high alarm
625
626in1_label		"vin"
627in1_input		Measured input voltage
628in1_lcrit		Critical minimum input voltage
629in1_lcrit_alarm		Input voltage critical low alarm
630in1_crit		Critical maximum input voltage
631in1_crit_alarm		Input voltage critical high alarm
632
633in2_label		"vmon"
634in2_input		Scaled VMON voltage read from the VMON pin
635
636in[3-5]_label		"vout[1-3]"
637in[3-5]_input		Measured output voltage
638in[3-5]_lcrit		Critical minimum output voltage
639in[3-5]_lcrit_alarm	Output voltage critical low alarm
640in[3-5]_crit		Critical maximum output voltage
641in[3-5]_crit_alarm	Output voltage critical high alarm
642
643power[1-3]_label	"pin[1-3]"
644power[1-3]_input	Measured input power
645power[1-3]_alarm	Input power high alarm
646
647power[4-6]_label	"pout[1-3]"
648power[4-6]_input	Measured output power
649
650temp[1-7]_input		Measured temperature
651temp[1-7]_crit		Critical high temperature
652temp[1-7]_crit_alarm	Chip temperature critical high alarm
653temp[1-7]_max		Maximum temperature
654temp[1-7]_max_alarm	Chip temperature high alarm
655======================= ==========================================
656