Documentation/hwmon/isl68137.rst

   1 Kernel driver isl68137
   2 ======================
   3
   4 Supported 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 RAA229001
 378
 379     Prefix: 'raa229001'
 380
 381     Addresses scanned: -
 382
 383     Datasheet:
 384
 385       Publicly available (after August 2020 launch) at the Renesas website
 386
 387   * Renesas RAA229004
 388
 389     Prefix: 'raa229004'
 390
 391     Addresses scanned: -
 392
 393     Datasheet:
 394
 395       Publicly available (after August 2020 launch) at the Renesas website
 396
 397 Authors:
 398       - Maxim Sloyko <maxims@google.com>
 399       - Robert Lippert <rlippert@google.com>
 400       - Patrick Venture <venture@google.com>
 401       - Grant Peltier <grant.peltier.jg@renesas.com>
 402
 403 Description
 404 -----------
 405
 406 This driver supports the Renesas ISL68137 and all 2nd generation Renesas
 407 digital multiphase voltage regulators (raa_dmpvr2). The ISL68137 is a digital
 408 output 7-phase configurable PWM controller with an AVSBus interface. 2nd
 409 generation devices are grouped into 4 distinct configurations: '1rail' for
 410 single-rail devices, '2rail' for dual-rail devices, '3rail' for 3-rail devices,
 411 and 'hv' for high voltage single-rail devices. Consult the individual datasheets
 412 for more information.
 413
 414 Usage Notes
 415 -----------
 416
 417 This driver does not probe for PMBus devices. You will have to instantiate
 418 devices explicitly.
 419
 420 The ISL68137 AVS operation mode must be enabled/disabled at runtime.
 421
 422 Beyond the normal sysfs pmbus attributes, the driver exposes a control attribute
 423 for the ISL68137.
 424
 425 For 2nd generation Renesas digital multiphase voltage regulators, only the
 426 normal sysfs pmbus attributes are supported.
 427
 428 ISL68137 sysfs attributes
 429 -------------------------
 430
 431 ======================= ====================================
 432 avs(0|1)_enable         Controls the AVS state of each rail.
 433
 434 curr1_label             "iin"
 435 curr1_input             Measured input current
 436 curr1_crit              Critical maximum current
 437 curr1_crit_alarm        Current critical high alarm
 438
 439 curr[2-3]_label         "iout[1-2]"
 440 curr[2-3]_input         Measured output current
 441 curr[2-3]_crit          Critical maximum current
 442 curr[2-3]_crit_alarm    Current critical high alarm
 443
 444 in1_label               "vin"
 445 in1_input               Measured input voltage
 446 in1_lcrit               Critical minimum input voltage
 447 in1_lcrit_alarm         Input voltage critical low alarm
 448 in1_crit                Critical maximum input voltage
 449 in1_crit_alarm          Input voltage critical high alarm
 450
 451 in[2-3]_label           "vout[1-2]"
 452 in[2-3]_input           Measured output voltage
 453 in[2-3]_lcrit           Critical minimum output voltage
 454 in[2-3]_lcrit_alarm     Output voltage critical low alarm
 455 in[2-3]_crit            Critical maximum output voltage
 456 in[2-3]_crit_alarm      Output voltage critical high alarm
 457
 458 power1_label            "pin"
 459 power1_input            Measured input power
 460 power1_alarm            Input power high alarm
 461
 462 power[2-3]_label        "pout[1-2]"
 463 power[2-3]_input        Measured output power
 464
 465 temp[1-3]_input         Measured temperature
 466 temp[1-3]_crit          Critical high temperature
 467 temp[1-3]_crit_alarm    Chip temperature critical high alarm
 468 temp[1-3]_max           Maximum temperature
 469 temp[1-3]_max_alarm     Chip temperature high alarm
 470 ======================= ====================================
 471
 472 raa_dmpvr2_1rail/hv sysfs attributes
 473 ------------------------------------
 474
 475 ======================= ==========================================
 476 curr1_label             "iin"
 477 curr1_input             Measured input current
 478 curr1_crit              Critical maximum current
 479 curr1_crit_alarm        Current critical high alarm
 480
 481 curr2_label             "iout"
 482 curr2_input             Measured output current
 483 curr2_crit              Critical maximum current
 484 curr2_crit_alarm        Current critical high alarm
 485
 486 in1_label               "vin"
 487 in1_input               Measured input voltage
 488 in1_lcrit               Critical minimum input voltage
 489 in1_lcrit_alarm         Input voltage critical low alarm
 490 in1_crit                Critical maximum input voltage
 491 in1_crit_alarm          Input voltage critical high alarm
 492
 493 in2_label               "vmon"
 494 in2_input               Scaled VMON voltage read from the VMON pin
 495
 496 in3_label               "vout"
 497 in3_input               Measured output voltage
 498 in3_lcrit               Critical minimum output voltage
 499 in3_lcrit_alarm         Output voltage critical low alarm
 500 in3_crit                Critical maximum output voltage
 501 in3_crit_alarm          Output voltage critical high alarm
 502
 503 power1_label            "pin"
 504 power1_input            Measured input power
 505 power1_alarm            Input power high alarm
 506
 507 power2_label            "pout"
 508 power2_input            Measured output power
 509
 510 temp[1-3]_input         Measured temperature
 511 temp[1-3]_crit          Critical high temperature
 512 temp[1-3]_crit_alarm    Chip temperature critical high alarm
 513 temp[1-3]_max           Maximum temperature
 514 temp[1-3]_max_alarm     Chip temperature high alarm
 515 ======================= ==========================================
 516
 517 raa_dmpvr2_2rail sysfs attributes
 518 ---------------------------------
 519
 520 ======================= ==========================================
 521 curr[1-2]_label         "iin[1-2]"
 522 curr[1-2]_input         Measured input current
 523 curr[1-2]_crit          Critical maximum current
 524 curr[1-2]_crit_alarm    Current critical high alarm
 525
 526 curr[3-4]_label         "iout[1-2]"
 527 curr[3-4]_input         Measured output current
 528 curr[3-4]_crit          Critical maximum current
 529 curr[3-4]_crit_alarm    Current critical high alarm
 530
 531 in1_label               "vin"
 532 in1_input               Measured input voltage
 533 in1_lcrit               Critical minimum input voltage
 534 in1_lcrit_alarm         Input voltage critical low alarm
 535 in1_crit                Critical maximum input voltage
 536 in1_crit_alarm          Input voltage critical high alarm
 537
 538 in2_label               "vmon"
 539 in2_input               Scaled VMON voltage read from the VMON pin
 540
 541 in[3-4]_label           "vout[1-2]"
 542 in[3-4]_input           Measured output voltage
 543 in[3-4]_lcrit           Critical minimum output voltage
 544 in[3-4]_lcrit_alarm     Output voltage critical low alarm
 545 in[3-4]_crit            Critical maximum output voltage
 546 in[3-4]_crit_alarm      Output voltage critical high alarm
 547
 548 power[1-2]_label        "pin[1-2]"
 549 power[1-2]_input        Measured input power
 550 power[1-2]_alarm        Input power high alarm
 551
 552 power[3-4]_label        "pout[1-2]"
 553 power[3-4]_input        Measured output power
 554
 555 temp[1-5]_input         Measured temperature
 556 temp[1-5]_crit          Critical high temperature
 557 temp[1-5]_crit_alarm    Chip temperature critical high alarm
 558 temp[1-5]_max           Maximum temperature
 559 temp[1-5]_max_alarm     Chip temperature high alarm
 560 ======================= ==========================================
 561
 562 raa_dmpvr2_3rail sysfs attributes
 563 ---------------------------------
 564
 565 ======================= ==========================================
 566 curr[1-3]_label         "iin[1-3]"
 567 curr[1-3]_input         Measured input current
 568 curr[1-3]_crit          Critical maximum current
 569 curr[1-3]_crit_alarm    Current critical high alarm
 570
 571 curr[4-6]_label         "iout[1-3]"
 572 curr[4-6]_input         Measured output current
 573 curr[4-6]_crit          Critical maximum current
 574 curr[4-6]_crit_alarm    Current critical high alarm
 575
 576 in1_label               "vin"
 577 in1_input               Measured input voltage
 578 in1_lcrit               Critical minimum input voltage
 579 in1_lcrit_alarm         Input voltage critical low alarm
 580 in1_crit                Critical maximum input voltage
 581 in1_crit_alarm          Input voltage critical high alarm
 582
 583 in2_label               "vmon"
 584 in2_input               Scaled VMON voltage read from the VMON pin
 585
 586 in[3-5]_label           "vout[1-3]"
 587 in[3-5]_input           Measured output voltage
 588 in[3-5]_lcrit           Critical minimum output voltage
 589 in[3-5]_lcrit_alarm     Output voltage critical low alarm
 590 in[3-5]_crit            Critical maximum output voltage
 591 in[3-5]_crit_alarm      Output voltage critical high alarm
 592
 593 power[1-3]_label        "pin[1-3]"
 594 power[1-3]_input        Measured input power
 595 power[1-3]_alarm        Input power high alarm
 596
 597 power[4-6]_label        "pout[1-3]"
 598 power[4-6]_input        Measured output power
 599
 600 temp[1-7]_input         Measured temperature
 601 temp[1-7]_crit          Critical high temperature
 602 temp[1-7]_crit_alarm    Chip temperature critical high alarm
 603 temp[1-7]_max           Maximum temperature
 604 temp[1-7]_max_alarm     Chip temperature high alarm
 605 ======================= ==========================================