Documentation/hwmon/stpddc60.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 Kernel driver stpddc60
   4 ======================
   5
   6 Supported chips:
   7
   8   * ST STPDDC60
   9
  10     Prefix: 'stpddc60', 'bmr481'
  11
  12     Addresses scanned: -
  13
  14     Datasheet: https://flexpowermodules.com/documents/fpm-techspec-bmr481
  15
  16 Author: Erik Rosen <erik.rosen@metormote.com>
  17
  18
  19 Description
  20 -----------
  21
  22 This driver supports hardware monitoring for ST STPDDC60 controller chip and
  23 compatible modules.
  24
  25 The driver is a client driver to the core PMBus driver. Please see
  26 Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
  27 on PMBus client drivers.
  28
  29
  30 Usage Notes
  31 -----------
  32
  33 This driver does not auto-detect devices. You will have to instantiate the
  34 devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
  35 details.
  36
  37 The vout under- and over-voltage limits are set in relation to the commanded
  38 output voltage as a positive or negative offset in the interval 50mV to 400mV
  39 in 50mV steps. This means that the absolute values of the limits will change
  40 when the commanded output voltage changes. Also, care should be taken when
  41 writing to those limits since in the worst case the commanded output voltage
  42 could change at the same time as the limit is written to, wich will lead to
  43 unpredictable results.
  44
  45
  46 Platform data support
  47 ---------------------
  48
  49 The driver supports standard PMBus driver platform data.
  50
  51
  52 Sysfs entries
  53 -------------
  54
  55 The following attributes are supported. Vin, iout, pout and temp limits
  56 are read-write; all other attributes are read-only.
  57
  58 ======================= ========================================================
  59 in1_label               "vin"
  60 in1_input               Measured input voltage.
  61 in1_lcrit               Critical minimum input voltage.
  62 in1_crit                Critical maximum input voltage.
  63 in1_lcrit_alarm         Input voltage critical low alarm.
  64 in1_crit_alarm          Input voltage critical high alarm.
  65
  66 in2_label               "vout1"
  67 in2_input               Measured output voltage.
  68 in2_lcrit               Critical minimum output voltage.
  69 in2_crit                Critical maximum output voltage.
  70 in2_lcrit_alarm         Critical output voltage critical low alarm.
  71 in2_crit_alarm          Critical output voltage critical high alarm.
  72
  73 curr1_label             "iout1"
  74 curr1_input             Measured output current.
  75 curr1_max               Maximum output current.
  76 curr1_max_alarm         Output current high alarm.
  77 curr1_crit              Critical maximum output current.
  78 curr1_crit_alarm        Output current critical high alarm.
  79
  80 power1_label            "pout1"
  81 power1_input            Measured output power.
  82 power1_crit             Critical maximum output power.
  83 power1_crit_alarm       Output power critical high alarm.
  84
  85 temp1_input             Measured maximum temperature of all phases.
  86 temp1_max               Maximum temperature limit.
  87 temp1_max_alarm         High temperature alarm.
  88 temp1_crit              Critical maximum temperature limit.
  89 temp1_crit_alarm        Critical maximum temperature alarm.
  90 ======================= ========================================================