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   * Intersil / Zilker Labs ZL9101M
  38     Prefix: 'zl9101'
  39     Addresses scanned: -
  40     Datasheet: http://www.intersil.com/data/fn/fn7669.pdf
  41   * Intersil / Zilker Labs ZL9117M
  42     Prefix: 'zl9117'
  43     Addresses scanned: -
  44     Datasheet: http://www.intersil.com/data/fn/fn7914.pdf
  45   * Ericsson BMR450, BMR451
  46     Prefix: 'bmr450', 'bmr451'
  47     Addresses scanned: -
  48     Datasheet:
  49 http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146401
  50   * Ericsson BMR462, BMR463, BMR464
  51     Prefixes: 'bmr462', 'bmr463', 'bmr464'
  52     Addresses scanned: -
  53     Datasheet:
  54 http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146256
  55
  56
  57 Author: Guenter Roeck <linux@roeck-us.net>
  58
  59
  60 Description
  61 -----------
  62
  63 This driver supports hardware montoring for Intersil / Zilker Labs ZL6100 and
  64 compatible digital DC-DC controllers.
  65
  66 The driver is a client driver to the core PMBus driver. Please see
  67 Documentation/hwmon/pmbus and Documentation.hwmon/pmbus-core for details
  68 on PMBus client drivers.
  69
  70
  71 Usage Notes
  72 -----------
  73
  74 This driver does not auto-detect devices. You will have to instantiate the
  75 devices explicitly. Please see Documentation/i2c/instantiating-devices for
  76 details.
  77
  78 WARNING: Do not access chip registers using the i2cdump command, and do not use
  79 any of the i2ctools commands on a command register used to save and restore
  80 configuration data (0x11, 0x12, 0x15, 0x16, and 0xf4). The chips supported by
  81 this driver interpret any access to those command registers (including read
  82 commands) as request to execute the command in question. Unless write accesses
  83 to those registers are protected, this may result in power loss, board resets,
  84 and/or Flash corruption. Worst case, your board may turn into a brick.
  85
  86
  87 Platform data support
  88 ---------------------
  89
  90 The driver supports standard PMBus driver platform data.
  91
  92
  93 Module parameters
  94 -----------------
  95
  96 delay
  97 -----
  98
  99 Intersil/Zilker Labs DC-DC controllers require a minimum interval between I2C
 100 bus accesses. According to Intersil, the minimum interval is 2 ms, though 1 ms
 101 appears to be sufficient and has not caused any problems in testing. The problem
 102 is known to affect all currently supported chips. For manual override, the
 103 driver provides a writeable module parameter, 'delay', which can be used to set
 104 the interval to a value between 0 and 65,535 microseconds.
 105
 106
 107 Sysfs entries
 108 -------------
 109
 110 The following attributes are supported. Limits are read-write; all other
 111 attributes are read-only.
 112
 113 in1_label               "vin"
 114 in1_input               Measured input voltage.
 115 in1_min                 Minimum input voltage.
 116 in1_max                 Maximum input voltage.
 117 in1_lcrit               Critical minimum input voltage.
 118 in1_crit                Critical maximum input voltage.
 119 in1_min_alarm           Input voltage low alarm.
 120 in1_max_alarm           Input voltage high alarm.
 121 in1_lcrit_alarm         Input voltage critical low alarm.
 122 in1_crit_alarm          Input voltage critical high alarm.
 123
 124 in2_label               "vmon"
 125 in2_input               Measured voltage on VMON (ZL2004) or VDRV (ZL9101M,
 126                         ZL9117M) pin. Reported voltage is 16x the voltage on the
 127                         pin (adjusted internally by the chip).
 128 in2_lcrit               Critical minimum VMON/VDRV Voltage.
 129 in2_crit                Critical maximum VMON/VDRV voltage.
 130 in2_lcrit_alarm         VMON/VDRV voltage critical low alarm.
 131 in2_crit_alarm          VMON/VDRV voltage critical high alarm.
 132
 133                         vmon attributes are supported on ZL2004, ZL9101M,
 134                         and ZL9117M only.
 135
 136 inX_label               "vout1"
 137 inX_input               Measured output voltage.
 138 inX_lcrit               Critical minimum output Voltage.
 139 inX_crit                Critical maximum output voltage.
 140 inX_lcrit_alarm         Critical output voltage critical low alarm.
 141 inX_crit_alarm          Critical output voltage critical high alarm.
 142
 143                         X is 3 for ZL2004, ZL9101M, and ZL9117M, 2 otherwise.
 144
 145 curr1_label             "iout1"
 146 curr1_input             Measured output current.
 147 curr1_lcrit             Critical minimum output current.
 148 curr1_crit              Critical maximum output current.
 149 curr1_lcrit_alarm       Output current critical low alarm.
 150 curr1_crit_alarm        Output current critical high alarm.
 151
 152 temp[12]_input          Measured temperature.
 153 temp[12]_min            Minimum temperature.
 154 temp[12]_max            Maximum temperature.
 155 temp[12]_lcrit          Critical low temperature.
 156 temp[12]_crit           Critical high temperature.
 157 temp[12]_min_alarm      Chip temperature low alarm.
 158 temp[12]_max_alarm      Chip temperature high alarm.
 159 temp[12]_lcrit_alarm    Chip temperature critical low alarm.
 160 temp[12]_crit_alarm     Chip temperature critical high alarm.