Documentation/hwmon/ltc4286.rst

   1 .. SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 Kernel driver ltc4286
   4 =====================
   5
   6 Supported chips:
   7
   8   * Analog Devices LTC4286
   9
  10     Prefix: 'ltc4286'
  11
  12     Addresses scanned: -
  13
  14     Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ltc4286.pdf
  15
  16   * Analog Devices LTC4287
  17
  18     Prefix: 'ltc4287'
  19
  20     Addresses scanned: -
  21
  22     Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ltc4287.pdf
  23
  24 Author: Delphine CC Chiu <Delphine_CC_Chiu@Wiwynn.com>
  25
  26
  27 Description
  28 -----------
  29
  30 This driver supports hardware monitoring for Analog Devices LTC4286
  31 and LTC4287 Hot-Swap Controller and Digital Power Monitors.
  32
  33 LTC4286 and LTC4287 are hot-swap controllers that allow a circuit board
  34 to be removed from or inserted into a live backplane. They also feature
  35 current and voltage readback via an integrated 12 bit analog-to-digital
  36 converter (ADC), accessed using a PMBus interface.
  37
  38 The driver is a client driver to the core PMBus driver. Please see
  39 Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
  40
  41
  42 Usage Notes
  43 -----------
  44
  45 This driver does not auto-detect devices. You will have to instantiate the
  46 devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
  47 details.
  48
  49 The shunt value in micro-ohms can be set via device tree at compile-time. Please
  50 refer to the Documentation/devicetree/bindings/hwmon/lltc,ltc4286.yaml for bindings
  51 if the device tree is used.
  52
  53
  54 Platform data support
  55 ---------------------
  56
  57 The driver supports standard PMBus driver platform data. Please see
  58 Documentation/hwmon/pmbus.rst for details.
  59
  60
  61 Sysfs entries
  62 -------------
  63
  64 The following attributes are supported. Limits are read-write, history reset
  65 attributes are write-only, all other attributes are read-only.
  66
  67 ======================= =======================================================
  68 in1_label               "vin"
  69 in1_input               Measured voltage.
  70 in1_alarm               Input voltage alarm.
  71 in1_min                 Minimum input voltage.
  72 in1_max                 Maximum input voltage.
  73
  74 in2_label               "vout1"
  75 in2_input               Measured voltage.
  76 in2_alarm               Output voltage alarm.
  77 in2_min                 Minimum output voltage.
  78 in2_max                 Maximum output voltage.
  79
  80 curr1_label             "iout1"
  81 curr1_input             Measured current.
  82 curr1_alarm             Output current alarm.
  83 curr1_max               Maximum current.
  84
  85 power1_label            "pin"
  86 power1_input            Input power.
  87 power1_alarm            Input power alarm.
  88 power1_max              Maximum poewr.
  89
  90 temp1_input             Chip temperature.
  91 temp1_min               Minimum chip temperature.
  92 temp1_max               Maximum chip temperature.
  93 temp1_crit              Critical chip temperature.
  94 temp1_alarm             Chip temperature alarm.
  95 ======================= =======================================================