Documentation/hwmon/max15301.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 Kernel driver max15301
   4 ======================
   5
   6 Supported chips:
   7
   8   * Maxim MAX15301
   9
  10     Prefix: 'max15301', 'bmr461'
  11
  12     Addresses scanned: -
  13
  14     Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX15301.pdf
  15
  16 Author: Erik Rosen <erik.rosen@metormote.com>
  17
  18
  19 Description
  20 -----------
  21
  22 This driver supports hardware monitoring for Maxim MAX15301 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
  38 Platform data support
  39 ---------------------
  40
  41 The driver supports standard PMBus driver platform data.
  42
  43
  44 Module parameters
  45 -----------------
  46
  47 delay
  48 -----
  49
  50 The controller requires a minimum interval between I2C bus accesses.
  51 The default interval is set to 100 us. For manual override, the driver
  52 provides a writeable module parameter, 'delay', which can be used to
  53 set the interval to a value between 0 and 65,535 microseconds.
  54
  55
  56 Sysfs entries
  57 -------------
  58
  59 The following attributes are supported. Limits are read-write; all other
  60 attributes are read-only.
  61
  62 ======================= ========================================================
  63 in1_label               "vin"
  64 in1_input               Measured input voltage.
  65 in1_lcrit               Critical minimum input voltage.
  66 in1_crit                Critical maximum input voltage.
  67 in1_lcrit_alarm         Input voltage critical low alarm.
  68 in1_crit_alarm          Input voltage critical high alarm.
  69
  70 in2_label               "vout1"
  71 in2_input               Measured output voltage.
  72 in2_lcrit               Critical minimum output Voltage.
  73 in2_crit                Critical maximum output voltage.
  74 in2_lcrit_alarm         Critical output voltage critical low alarm.
  75 in2_crit_alarm          Critical output voltage critical high alarm.
  76
  77 curr1_label             "iout1"
  78 curr1_input             Measured output current.
  79 curr1_crit              Critical maximum output current.
  80 curr1_crit_alarm        Output current critical high alarm.
  81
  82 temp1_input             Measured maximum temperature of all phases.
  83 temp1_max               Maximum temperature limit.
  84 temp1_max_alarm         High temperature alarm.
  85 temp1_crit              Critical maximum temperature limit.
  86 temp1_crit_alarm        Critical maximum temperature alarm.
  87 ======================= ========================================================