Documentation/hwmon/zl6100

   1 Kernel driver zl6100
   2 ====================
   3
   4 Supported chips:
   5   * Intersil / Zilker Labs ZL2004
   6     Prefix: 'zl2004'
   7     Addresses scanned: -
   8     Datasheet: http://www.intersil.com/data/fn/fn6847.pdf
   9   * Intersil / Zilker Labs ZL2005
  10     Prefix: 'zl2005'
  11     Addresses scanned: -
  12     Datasheet: http://www.intersil.com/data/fn/fn6848.pdf
  13   * Intersil / Zilker Labs ZL2006
  14     Prefix: 'zl2006'
  15     Addresses scanned: -
  16     Datasheet: http://www.intersil.com/data/fn/fn6850.pdf
  17   * Intersil / Zilker Labs ZL2008
  18     Prefix: 'zl2008'
  19     Addresses scanned: -
  20     Datasheet: http://www.intersil.com/data/fn/fn6859.pdf
  21   * Intersil / Zilker Labs ZL2105
  22     Prefix: 'zl2105'
  23     Addresses scanned: -
  24     Datasheet: http://www.intersil.com/data/fn/fn6851.pdf
  25   * Intersil / Zilker Labs ZL2106
  26     Prefix: 'zl2106'
  27     Addresses scanned: -
  28     Datasheet: http://www.intersil.com/data/fn/fn6852.pdf
  29   * Intersil / Zilker Labs ZL6100
  30     Prefix: 'zl6100'
  31     Addresses scanned: -
  32     Datasheet: http://www.intersil.com/data/fn/fn6876.pdf
  33   * Intersil / Zilker Labs ZL6105
  34     Prefix: 'zl6105'
  35     Addresses scanned: -
  36     Datasheet: http://www.intersil.com/data/fn/fn6906.pdf
  37   * Ericsson BMR450, BMR451
  38     Prefix: 'bmr450', 'bmr451'
  39     Addresses scanned: -
  40     Datasheet:
  41 http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146401
  42   * Ericsson BMR462, BMR463, BMR464
  43     Prefixes: 'bmr462', 'bmr463', 'bmr464'
  44     Addresses scanned: -
  45     Datasheet:
  46 http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146256
  47
  48
  49 Author: Guenter Roeck <guenter.roeck@ericsson.com>
  50
  51
  52 Description
  53 -----------
  54
  55 This driver supports hardware montoring for Intersil / Zilker Labs ZL6100 and
  56 compatible digital DC-DC controllers.
  57
  58 The driver is a client driver to the core PMBus driver. Please see
  59 Documentation/hwmon/pmbus and Documentation.hwmon/pmbus-core for details
  60 on PMBus client drivers.
  61
  62
  63 Usage Notes
  64 -----------
  65
  66 This driver does not auto-detect devices. You will have to instantiate the
  67 devices explicitly. Please see Documentation/i2c/instantiating-devices for
  68 details.
  69
  70 WARNING: Do not access chip registers using the i2cdump command, and do not use
  71 any of the i2ctools commands on a command register used to save and restore
  72 configuration data (0x11, 0x12, 0x15, 0x16, and 0xf4). The chips supported by
  73 this driver interpret any access to those command registers (including read
  74 commands) as request to execute the command in question. Unless write accesses
  75 to those registers are protected, this may result in power loss, board resets,
  76 and/or Flash corruption. Worst case, your board may turn into a brick.
  77
  78
  79 Platform data support
  80 ---------------------
  81
  82 The driver supports standard PMBus driver platform data.
  83
  84
  85 Module parameters
  86 -----------------
  87
  88 delay
  89 -----
  90
  91 Some Intersil/Zilker Labs DC-DC controllers require a minimum interval between
  92 I2C bus accesses. According to Intersil, the minimum interval is 2 ms, though
  93 1 ms appears to be sufficient and has not caused any problems in testing.
  94 The problem is known to affect ZL6100, ZL2105, and ZL2008. It is known not to
  95 affect ZL2004 and ZL6105. The driver automatically sets the interval to 1 ms
  96 except for ZL2004 and ZL6105. To enable manual override, the driver provides a
  97 writeable module parameter, 'delay', which can be used to set the interval to
  98 a value between 0 and 65,535 microseconds.
  99
 100
 101 Sysfs entries
 102 -------------
 103
 104 The following attributes are supported. Limits are read-write; all other
 105 attributes are read-only.
 106
 107 in1_label               "vin"
 108 in1_input               Measured input voltage.
 109 in1_min                 Minimum input voltage.
 110 in1_max                 Maximum input voltage.
 111 in1_lcrit               Critical minumum input voltage.
 112 in1_crit                Critical maximum input voltage.
 113 in1_min_alarm           Input voltage low alarm.
 114 in1_max_alarm           Input voltage high alarm.
 115 in1_lcrit_alarm         Input voltage critical low alarm.
 116 in1_crit_alarm          Input voltage critical high alarm.
 117
 118 in2_label               "vout1"
 119 in2_input               Measured output voltage.
 120 in2_lcrit               Critical minumum output Voltage.
 121 in2_crit                Critical maximum output voltage.
 122 in2_lcrit_alarm         Critical output voltage critical low alarm.
 123 in2_crit_alarm          Critical output voltage critical high alarm.
 124
 125 curr1_label             "iout1"
 126 curr1_input             Measured output current.
 127 curr1_lcrit             Critical minimum output current.
 128 curr1_crit              Critical maximum output current.
 129 curr1_lcrit_alarm       Output current critical low alarm.
 130 curr1_crit_alarm        Output current critical high alarm.
 131
 132 temp[12]_input          Measured temperature.
 133 temp[12]_min            Minimum temperature.
 134 temp[12]_max            Maximum temperature.
 135 temp[12]_lcrit          Critical low temperature.
 136 temp[12]_crit           Critical high temperature.
 137 temp[12]_min_alarm      Chip temperature low alarm.
 138 temp[12]_max_alarm      Chip temperature high alarm.
 139 temp[12]_lcrit_alarm    Chip temperature critical low alarm.
 140 temp[12]_crit_alarm     Chip temperature critical high alarm.