Documentation/hwmon/bel-pfe.rst

   1 Kernel driver bel-pfe
   2 ======================
   3
   4 Supported chips:
   5
   6   * BEL PFE1100
   7
   8     Prefixes: 'pfe1100'
   9
  10     Addresses scanned: -
  11
  12     Datasheet: https://www.belfuse.com/resources/datasheets/powersolutions/ds-bps-pfe1100-12-054xa.pdf
  13
  14   * BEL PFE3000
  15
  16     Prefixes: 'pfe3000'
  17
  18     Addresses scanned: -
  19
  20     Datasheet: https://www.belfuse.com/resources/datasheets/powersolutions/ds-bps-pfe3000-series.pdf
  21
  22 Author: Tao Ren <rentao.bupt@gmail.com>
  23
  24
  25 Description
  26 -----------
  27
  28 This driver supports hardware monitoring for below power supply devices
  29 which support PMBus Protocol:
  30
  31   * BEL PFE1100
  32
  33     1100 Watt AC to DC power-factor-corrected (PFC) power supply.
  34     PMBus Communication Manual is not publicly available.
  35
  36   * BEL PFE3000
  37
  38     3000 Watt AC/DC power-factor-corrected (PFC) and DC-DC power supply.
  39     PMBus Communication Manual is not publicly available.
  40
  41 The driver is a client driver to the core PMBus driver. Please see
  42 Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
  43
  44
  45 Usage Notes
  46 -----------
  47
  48 This driver does not auto-detect devices. You will have to instantiate the
  49 devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
  50 details.
  51
  52 Example: the following will load the driver for an PFE3000 at address 0x20
  53 on I2C bus #1::
  54
  55         $ modprobe bel-pfe
  56         $ echo pfe3000 0x20 > /sys/bus/i2c/devices/i2c-1/new_device
  57
  58
  59 Platform data support
  60 ---------------------
  61
  62 The driver supports standard PMBus driver platform data.
  63
  64
  65 Sysfs entries
  66 -------------
  67
  68 ======================= =======================================================
  69 curr1_label             "iin"
  70 curr1_input             Measured input current
  71 curr1_max               Input current max value
  72 curr1_max_alarm         Input current max alarm
  73
  74 curr[2-3]_label         "iout[1-2]"
  75 curr[2-3]_input         Measured output current
  76 curr[2-3]_max           Output current max value
  77 curr[2-3]_max_alarm     Output current max alarm
  78
  79 fan[1-2]_input          Fan 1 and 2 speed in RPM
  80 fan1_target             Set fan speed reference for both fans
  81
  82 in1_label               "vin"
  83 in1_input               Measured input voltage
  84 in1_crit                Input voltage critical max value
  85 in1_crit_alarm          Input voltage critical max alarm
  86 in1_lcrit               Input voltage critical min value
  87 in1_lcrit_alarm         Input voltage critical min alarm
  88 in1_max                 Input voltage max value
  89 in1_max_alarm           Input voltage max alarm
  90
  91 in2_label               "vcap"
  92 in2_input               Hold up capacitor voltage
  93
  94 in[3-8]_label           "vout[1-3,5-7]"
  95 in[3-8]_input           Measured output voltage
  96 in[3-4]_alarm           vout[1-2] output voltage alarm
  97
  98 power[1-2]_label        "pin[1-2]"
  99 power[1-2]_input        Measured input power
 100 power[1-2]_alarm        Input power high alarm
 101
 102 power[3-4]_label        "pout[1-2]"
 103 power[3-4]_input        Measured output power
 104
 105 temp[1-3]_input         Measured temperature
 106 temp[1-3]_alarm         Temperature alarm
 107 ======================= =======================================================
 108
 109 .. note::
 110
 111     - curr3, fan2, vout[2-7], vcap, pin2, pout2 and temp3 attributes only
 112       exist for PFE3000.