Documentation/hwmon/zl6100.rst

   1 Kernel driver zl6100
   2 ====================
   3
   4 Supported chips:
   5
   6   * Intersil / Zilker Labs ZL2004
   7
   8     Prefix: 'zl2004'
   9
  10     Addresses scanned: -
  11
  12     Datasheet: http://www.intersil.com/data/fn/fn6847.pdf
  13
  14   * Intersil / Zilker Labs ZL2005
  15
  16     Prefix: 'zl2005'
  17
  18     Addresses scanned: -
  19
  20     Datasheet: http://www.intersil.com/data/fn/fn6848.pdf
  21
  22   * Intersil / Zilker Labs ZL2006
  23
  24     Prefix: 'zl2006'
  25
  26     Addresses scanned: -
  27
  28     Datasheet: http://www.intersil.com/data/fn/fn6850.pdf
  29
  30   * Intersil / Zilker Labs ZL2008
  31
  32     Prefix: 'zl2008'
  33
  34     Addresses scanned: -
  35
  36     Datasheet: http://www.intersil.com/data/fn/fn6859.pdf
  37
  38   * Intersil / Zilker Labs ZL2105
  39
  40     Prefix: 'zl2105'
  41
  42     Addresses scanned: -
  43
  44     Datasheet: http://www.intersil.com/data/fn/fn6851.pdf
  45
  46   * Intersil / Zilker Labs ZL2106
  47
  48     Prefix: 'zl2106'
  49
  50     Addresses scanned: -
  51
  52     Datasheet: http://www.intersil.com/data/fn/fn6852.pdf
  53
  54   * Intersil / Zilker Labs ZL6100
  55
  56     Prefix: 'zl6100'
  57
  58     Addresses scanned: -
  59
  60     Datasheet: http://www.intersil.com/data/fn/fn6876.pdf
  61
  62   * Intersil / Zilker Labs ZL6105
  63
  64     Prefix: 'zl6105'
  65
  66     Addresses scanned: -
  67
  68     Datasheet: http://www.intersil.com/data/fn/fn6906.pdf
  69
  70   * Intersil / Zilker Labs ZL9101M
  71
  72     Prefix: 'zl9101'
  73
  74     Addresses scanned: -
  75
  76     Datasheet: http://www.intersil.com/data/fn/fn7669.pdf
  77
  78   * Intersil / Zilker Labs ZL9117M
  79
  80     Prefix: 'zl9117'
  81
  82     Addresses scanned: -
  83
  84     Datasheet: http://www.intersil.com/data/fn/fn7914.pdf
  85
  86   * Ericsson BMR450, BMR451
  87
  88     Prefix: 'bmr450', 'bmr451'
  89
  90     Addresses scanned: -
  91
  92     Datasheet:
  93
  94 http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146401
  95
  96   * Ericsson BMR462, BMR463, BMR464
  97
  98     Prefixes: 'bmr462', 'bmr463', 'bmr464'
  99
 100     Addresses scanned: -
 101
 102     Datasheet:
 103
 104         http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146256
 105
 106 Author: Guenter Roeck <linux@roeck-us.net>
 107
 108
 109 Description
 110 -----------
 111
 112 This driver supports hardware monitoring for Intersil / Zilker Labs ZL6100 and
 113 compatible digital DC-DC controllers.
 114
 115 The driver is a client driver to the core PMBus driver. Please see
 116 Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
 117 on PMBus client drivers.
 118
 119
 120 Usage Notes
 121 -----------
 122
 123 This driver does not auto-detect devices. You will have to instantiate the
 124 devices explicitly. Please see Documentation/i2c/instantiating-devices for
 125 details.
 126
 127 .. warning::
 128
 129   Do not access chip registers using the i2cdump command, and do not use
 130   any of the i2ctools commands on a command register used to save and restore
 131   configuration data (0x11, 0x12, 0x15, 0x16, and 0xf4). The chips supported by
 132   this driver interpret any access to those command registers (including read
 133   commands) as request to execute the command in question. Unless write accesses
 134   to those registers are protected, this may result in power loss, board resets,
 135   and/or Flash corruption. Worst case, your board may turn into a brick.
 136
 137
 138 Platform data support
 139 ---------------------
 140
 141 The driver supports standard PMBus driver platform data.
 142
 143
 144 Module parameters
 145 -----------------
 146
 147 delay
 148 -----
 149
 150 Intersil/Zilker Labs DC-DC controllers require a minimum interval between I2C
 151 bus accesses. According to Intersil, the minimum interval is 2 ms, though 1 ms
 152 appears to be sufficient and has not caused any problems in testing. The problem
 153 is known to affect all currently supported chips. For manual override, the
 154 driver provides a writeable module parameter, 'delay', which can be used to set
 155 the interval to a value between 0 and 65,535 microseconds.
 156
 157
 158 Sysfs entries
 159 -------------
 160
 161 The following attributes are supported. Limits are read-write; all other
 162 attributes are read-only.
 163
 164 ======================= ========================================================
 165 in1_label               "vin"
 166 in1_input               Measured input voltage.
 167 in1_min                 Minimum input voltage.
 168 in1_max                 Maximum input voltage.
 169 in1_lcrit               Critical minimum input voltage.
 170 in1_crit                Critical maximum input voltage.
 171 in1_min_alarm           Input voltage low alarm.
 172 in1_max_alarm           Input voltage high alarm.
 173 in1_lcrit_alarm         Input voltage critical low alarm.
 174 in1_crit_alarm          Input voltage critical high alarm.
 175
 176 in2_label               "vmon"
 177 in2_input               Measured voltage on VMON (ZL2004) or VDRV (ZL9101M,
 178                         ZL9117M) pin. Reported voltage is 16x the voltage on the
 179                         pin (adjusted internally by the chip).
 180 in2_lcrit               Critical minimum VMON/VDRV Voltage.
 181 in2_crit                Critical maximum VMON/VDRV voltage.
 182 in2_lcrit_alarm         VMON/VDRV voltage critical low alarm.
 183 in2_crit_alarm          VMON/VDRV voltage critical high alarm.
 184
 185                         vmon attributes are supported on ZL2004, ZL9101M,
 186                         and ZL9117M only.
 187
 188 inX_label               "vout1"
 189 inX_input               Measured output voltage.
 190 inX_lcrit               Critical minimum output Voltage.
 191 inX_crit                Critical maximum output voltage.
 192 inX_lcrit_alarm         Critical output voltage critical low alarm.
 193 inX_crit_alarm          Critical output voltage critical high alarm.
 194
 195                         X is 3 for ZL2004, ZL9101M, and ZL9117M, 2 otherwise.
 196
 197 curr1_label             "iout1"
 198 curr1_input             Measured output current.
 199 curr1_lcrit             Critical minimum output current.
 200 curr1_crit              Critical maximum output current.
 201 curr1_lcrit_alarm       Output current critical low alarm.
 202 curr1_crit_alarm        Output current critical high alarm.
 203
 204 temp[12]_input          Measured temperature.
 205 temp[12]_min            Minimum temperature.
 206 temp[12]_max            Maximum temperature.
 207 temp[12]_lcrit          Critical low temperature.
 208 temp[12]_crit           Critical high temperature.
 209 temp[12]_min_alarm      Chip temperature low alarm.
 210 temp[12]_max_alarm      Chip temperature high alarm.
 211 temp[12]_lcrit_alarm    Chip temperature critical low alarm.
 212 temp[12]_crit_alarm     Chip temperature critical high alarm.
 213 ======================= ========================================================