1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl>,
4 Philip Edelbrock <phil@netroedge.com>, and Mark D. Studebaker
5 <mdsxyz123@yahoo.com>
6 Copyright (C) 2007 - 2014 Jean Delvare <jdelvare@suse.de>
7 Copyright (C) 2010 Intel Corporation,
8 David Woodhouse <dwmw2@infradead.org>
9
10 */
11
12 /*
13 * Supports the following Intel I/O Controller Hubs (ICH):
14 *
15 * I/O Block I2C
16 * region SMBus Block proc. block
17 * Chip name PCI ID size PEC buffer call read
18 * ---------------------------------------------------------------------------
19 * 82801AA (ICH) 0x2413 16 no no no no
20 * 82801AB (ICH0) 0x2423 16 no no no no
21 * 82801BA (ICH2) 0x2443 16 no no no no
22 * 82801CA (ICH3) 0x2483 32 soft no no no
23 * 82801DB (ICH4) 0x24c3 32 hard yes no no
24 * 82801E (ICH5) 0x24d3 32 hard yes yes yes
25 * 6300ESB 0x25a4 32 hard yes yes yes
26 * 82801F (ICH6) 0x266a 32 hard yes yes yes
27 * 6310ESB/6320ESB 0x269b 32 hard yes yes yes
28 * 82801G (ICH7) 0x27da 32 hard yes yes yes
29 * 82801H (ICH8) 0x283e 32 hard yes yes yes
30 * 82801I (ICH9) 0x2930 32 hard yes yes yes
31 * EP80579 (Tolapai) 0x5032 32 hard yes yes yes
32 * ICH10 0x3a30 32 hard yes yes yes
33 * ICH10 0x3a60 32 hard yes yes yes
34 * 5/3400 Series (PCH) 0x3b30 32 hard yes yes yes
35 * 6 Series (PCH) 0x1c22 32 hard yes yes yes
36 * Patsburg (PCH) 0x1d22 32 hard yes yes yes
37 * Patsburg (PCH) IDF 0x1d70 32 hard yes yes yes
38 * Patsburg (PCH) IDF 0x1d71 32 hard yes yes yes
39 * Patsburg (PCH) IDF 0x1d72 32 hard yes yes yes
40 * DH89xxCC (PCH) 0x2330 32 hard yes yes yes
41 * Panther Point (PCH) 0x1e22 32 hard yes yes yes
42 * Lynx Point (PCH) 0x8c22 32 hard yes yes yes
43 * Lynx Point-LP (PCH) 0x9c22 32 hard yes yes yes
44 * Avoton (SOC) 0x1f3c 32 hard yes yes yes
45 * Wellsburg (PCH) 0x8d22 32 hard yes yes yes
46 * Wellsburg (PCH) MS 0x8d7d 32 hard yes yes yes
47 * Wellsburg (PCH) MS 0x8d7e 32 hard yes yes yes
48 * Wellsburg (PCH) MS 0x8d7f 32 hard yes yes yes
49 * Coleto Creek (PCH) 0x23b0 32 hard yes yes yes
50 * Wildcat Point (PCH) 0x8ca2 32 hard yes yes yes
51 * Wildcat Point-LP (PCH) 0x9ca2 32 hard yes yes yes
52 * BayTrail (SOC) 0x0f12 32 hard yes yes yes
53 * Braswell (SOC) 0x2292 32 hard yes yes yes
54 * Sunrise Point-H (PCH) 0xa123 32 hard yes yes yes
55 * Sunrise Point-LP (PCH) 0x9d23 32 hard yes yes yes
56 * DNV (SOC) 0x19df 32 hard yes yes yes
57 * Emmitsburg (PCH) 0x1bc9 32 hard yes yes yes
58 * Broxton (SOC) 0x5ad4 32 hard yes yes yes
59 * Lewisburg (PCH) 0xa1a3 32 hard yes yes yes
60 * Lewisburg Supersku (PCH) 0xa223 32 hard yes yes yes
61 * Kaby Lake PCH-H (PCH) 0xa2a3 32 hard yes yes yes
62 * Gemini Lake (SOC) 0x31d4 32 hard yes yes yes
63 * Cannon Lake-H (PCH) 0xa323 32 hard yes yes yes
64 * Cannon Lake-LP (PCH) 0x9da3 32 hard yes yes yes
65 * Cedar Fork (PCH) 0x18df 32 hard yes yes yes
66 * Ice Lake-LP (PCH) 0x34a3 32 hard yes yes yes
67 * Ice Lake-N (PCH) 0x38a3 32 hard yes yes yes
68 * Comet Lake (PCH) 0x02a3 32 hard yes yes yes
69 * Comet Lake-H (PCH) 0x06a3 32 hard yes yes yes
70 * Elkhart Lake (PCH) 0x4b23 32 hard yes yes yes
71 * Tiger Lake-LP (PCH) 0xa0a3 32 hard yes yes yes
72 * Tiger Lake-H (PCH) 0x43a3 32 hard yes yes yes
73 * Jasper Lake (SOC) 0x4da3 32 hard yes yes yes
74 * Comet Lake-V (PCH) 0xa3a3 32 hard yes yes yes
75 * Alder Lake-S (PCH) 0x7aa3 32 hard yes yes yes
76 * Alder Lake-P (PCH) 0x51a3 32 hard yes yes yes
77 * Alder Lake-M (PCH) 0x54a3 32 hard yes yes yes
78 * Raptor Lake-S (PCH) 0x7a23 32 hard yes yes yes
79 * Meteor Lake-P (SOC) 0x7e22 32 hard yes yes yes
80 *
81 * Features supported by this driver:
82 * Software PEC no
83 * Hardware PEC yes
84 * Block buffer yes
85 * Block process call transaction yes
86 * I2C block read transaction yes (doesn't use the block buffer)
87 * Slave mode no
88 * SMBus Host Notify yes
89 * Interrupt processing yes
90 *
91 * See the file Documentation/i2c/busses/i2c-i801.rst for details.
92 */
93
94 #define DRV_NAME "i801_smbus"
95
96 #include <linux/interrupt.h>
97 #include <linux/module.h>
98 #include <linux/pci.h>
99 #include <linux/kernel.h>
100 #include <linux/stddef.h>
101 #include <linux/delay.h>
102 #include <linux/ioport.h>
103 #include <linux/init.h>
104 #include <linux/i2c.h>
105 #include <linux/i2c-smbus.h>
106 #include <linux/acpi.h>
107 #include <linux/io.h>
108 #include <linux/dmi.h>
109 #include <linux/slab.h>
110 #include <linux/string.h>
111 #include <linux/completion.h>
112 #include <linux/err.h>
113 #include <linux/platform_device.h>
114 #include <linux/platform_data/itco_wdt.h>
115 #include <linux/platform_data/x86/p2sb.h>
116 #include <linux/pm_runtime.h>
117 #include <linux/mutex.h>
118
119 #if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
120 #include <linux/gpio/machine.h>
121 #include <linux/platform_data/i2c-mux-gpio.h>
122 #endif
123
124 /* I801 SMBus address offsets */
125 #define SMBHSTSTS(p) (0 + (p)->smba)
126 #define SMBHSTCNT(p) (2 + (p)->smba)
127 #define SMBHSTCMD(p) (3 + (p)->smba)
128 #define SMBHSTADD(p) (4 + (p)->smba)
129 #define SMBHSTDAT0(p) (5 + (p)->smba)
130 #define SMBHSTDAT1(p) (6 + (p)->smba)
131 #define SMBBLKDAT(p) (7 + (p)->smba)
132 #define SMBPEC(p) (8 + (p)->smba) /* ICH3 and later */
133 #define SMBAUXSTS(p) (12 + (p)->smba) /* ICH4 and later */
134 #define SMBAUXCTL(p) (13 + (p)->smba) /* ICH4 and later */
135 #define SMBSLVSTS(p) (16 + (p)->smba) /* ICH3 and later */
136 #define SMBSLVCMD(p) (17 + (p)->smba) /* ICH3 and later */
137 #define SMBNTFDADD(p) (20 + (p)->smba) /* ICH3 and later */
138
139 /* PCI Address Constants */
140 #define SMBBAR 4
141 #define SMBHSTCFG 0x040
142 #define TCOBASE 0x050
143 #define TCOCTL 0x054
144
145 #define SBREG_SMBCTRL 0xc6000c
146 #define SBREG_SMBCTRL_DNV 0xcf000c
147
148 /* Host configuration bits for SMBHSTCFG */
149 #define SMBHSTCFG_HST_EN BIT(0)
150 #define SMBHSTCFG_SMB_SMI_EN BIT(1)
151 #define SMBHSTCFG_I2C_EN BIT(2)
152 #define SMBHSTCFG_SPD_WD BIT(4)
153
154 /* TCO configuration bits for TCOCTL */
155 #define TCOCTL_EN BIT(8)
156
157 /* Auxiliary status register bits, ICH4+ only */
158 #define SMBAUXSTS_CRCE BIT(0)
159 #define SMBAUXSTS_STCO BIT(1)
160
161 /* Auxiliary control register bits, ICH4+ only */
162 #define SMBAUXCTL_CRC BIT(0)
163 #define SMBAUXCTL_E32B BIT(1)
164
165 /* I801 command constants */
166 #define I801_QUICK 0x00
167 #define I801_BYTE 0x04
168 #define I801_BYTE_DATA 0x08
169 #define I801_WORD_DATA 0x0C
170 #define I801_PROC_CALL 0x10
171 #define I801_BLOCK_DATA 0x14
172 #define I801_I2C_BLOCK_DATA 0x18 /* ICH5 and later */
173 #define I801_BLOCK_PROC_CALL 0x1C
174
175 /* I801 Host Control register bits */
176 #define SMBHSTCNT_INTREN BIT(0)
177 #define SMBHSTCNT_KILL BIT(1)
178 #define SMBHSTCNT_LAST_BYTE BIT(5)
179 #define SMBHSTCNT_START BIT(6)
180 #define SMBHSTCNT_PEC_EN BIT(7) /* ICH3 and later */
181
182 /* I801 Hosts Status register bits */
183 #define SMBHSTSTS_BYTE_DONE BIT(7)
184 #define SMBHSTSTS_INUSE_STS BIT(6)
185 #define SMBHSTSTS_SMBALERT_STS BIT(5)
186 #define SMBHSTSTS_FAILED BIT(4)
187 #define SMBHSTSTS_BUS_ERR BIT(3)
188 #define SMBHSTSTS_DEV_ERR BIT(2)
189 #define SMBHSTSTS_INTR BIT(1)
190 #define SMBHSTSTS_HOST_BUSY BIT(0)
191
192 /* Host Notify Status register bits */
193 #define SMBSLVSTS_HST_NTFY_STS BIT(0)
194
195 /* Host Notify Command register bits */
196 #define SMBSLVCMD_SMBALERT_DISABLE BIT(2)
197 #define SMBSLVCMD_HST_NTFY_INTREN BIT(0)
198
199 #define STATUS_ERROR_FLAGS (SMBHSTSTS_FAILED | SMBHSTSTS_BUS_ERR | \
200 SMBHSTSTS_DEV_ERR)
201
202 #define STATUS_FLAGS (SMBHSTSTS_BYTE_DONE | SMBHSTSTS_INTR | \
203 STATUS_ERROR_FLAGS)
204
205 /* Older devices have their ID defined in <linux/pci_ids.h> */
206 #define PCI_DEVICE_ID_INTEL_COMETLAKE_SMBUS 0x02a3
207 #define PCI_DEVICE_ID_INTEL_COMETLAKE_H_SMBUS 0x06a3
208 #define PCI_DEVICE_ID_INTEL_BAYTRAIL_SMBUS 0x0f12
209 #define PCI_DEVICE_ID_INTEL_CDF_SMBUS 0x18df
210 #define PCI_DEVICE_ID_INTEL_DNV_SMBUS 0x19df
211 #define PCI_DEVICE_ID_INTEL_EBG_SMBUS 0x1bc9
212 #define PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS 0x1c22
213 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS 0x1d22
214 /* Patsburg also has three 'Integrated Device Function' SMBus controllers */
215 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0 0x1d70
216 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1 0x1d71
217 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2 0x1d72
218 #define PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS 0x1e22
219 #define PCI_DEVICE_ID_INTEL_AVOTON_SMBUS 0x1f3c
220 #define PCI_DEVICE_ID_INTEL_BRASWELL_SMBUS 0x2292
221 #define PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS 0x2330
222 #define PCI_DEVICE_ID_INTEL_COLETOCREEK_SMBUS 0x23b0
223 #define PCI_DEVICE_ID_INTEL_GEMINILAKE_SMBUS 0x31d4
224 #define PCI_DEVICE_ID_INTEL_ICELAKE_LP_SMBUS 0x34a3
225 #define PCI_DEVICE_ID_INTEL_ICELAKE_N_SMBUS 0x38a3
226 #define PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS 0x3b30
227 #define PCI_DEVICE_ID_INTEL_TIGERLAKE_H_SMBUS 0x43a3
228 #define PCI_DEVICE_ID_INTEL_ELKHART_LAKE_SMBUS 0x4b23
229 #define PCI_DEVICE_ID_INTEL_JASPER_LAKE_SMBUS 0x4da3
230 #define PCI_DEVICE_ID_INTEL_ALDER_LAKE_P_SMBUS 0x51a3
231 #define PCI_DEVICE_ID_INTEL_ALDER_LAKE_M_SMBUS 0x54a3
232 #define PCI_DEVICE_ID_INTEL_BROXTON_SMBUS 0x5ad4
233 #define PCI_DEVICE_ID_INTEL_RAPTOR_LAKE_S_SMBUS 0x7a23
234 #define PCI_DEVICE_ID_INTEL_ALDER_LAKE_S_SMBUS 0x7aa3
235 #define PCI_DEVICE_ID_INTEL_METEOR_LAKE_P_SMBUS 0x7e22
236 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS 0x8c22
237 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_SMBUS 0x8ca2
238 #define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS 0x8d22
239 #define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0 0x8d7d
240 #define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1 0x8d7e
241 #define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2 0x8d7f
242 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS 0x9c22
243 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_SMBUS 0x9ca2
244 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS 0x9d23
245 #define PCI_DEVICE_ID_INTEL_CANNONLAKE_LP_SMBUS 0x9da3
246 #define PCI_DEVICE_ID_INTEL_TIGERLAKE_LP_SMBUS 0xa0a3
247 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS 0xa123
248 #define PCI_DEVICE_ID_INTEL_LEWISBURG_SMBUS 0xa1a3
249 #define PCI_DEVICE_ID_INTEL_LEWISBURG_SSKU_SMBUS 0xa223
250 #define PCI_DEVICE_ID_INTEL_KABYLAKE_PCH_H_SMBUS 0xa2a3
251 #define PCI_DEVICE_ID_INTEL_CANNONLAKE_H_SMBUS 0xa323
252 #define PCI_DEVICE_ID_INTEL_COMETLAKE_V_SMBUS 0xa3a3
253
254 struct i801_mux_config {
255 char *gpio_chip;
256 unsigned values[3];
257 int n_values;
258 unsigned classes[3];
259 unsigned gpios[2]; /* Relative to gpio_chip->base */
260 int n_gpios;
261 };
262
263 struct i801_priv {
264 struct i2c_adapter adapter;
265 unsigned long smba;
266 unsigned char original_hstcfg;
267 unsigned char original_hstcnt;
268 unsigned char original_slvcmd;
269 struct pci_dev *pci_dev;
270 unsigned int features;
271
272 /* isr processing */
273 struct completion done;
274 u8 status;
275
276 /* Command state used by isr for byte-by-byte block transactions */
277 u8 cmd;
278 bool is_read;
279 int count;
280 int len;
281 u8 *data;
282
283 #if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
284 const struct i801_mux_config *mux_drvdata;
285 struct platform_device *mux_pdev;
286 struct gpiod_lookup_table *lookup;
287 #endif
288 struct platform_device *tco_pdev;
289
290 /*
291 * If set to true the host controller registers are reserved for
292 * ACPI AML use. Protected by acpi_lock.
293 */
294 bool acpi_reserved;
295 struct mutex acpi_lock;
296 };
297
298 #define FEATURE_SMBUS_PEC BIT(0)
299 #define FEATURE_BLOCK_BUFFER BIT(1)
300 #define FEATURE_BLOCK_PROC BIT(2)
301 #define FEATURE_I2C_BLOCK_READ BIT(3)
302 #define FEATURE_IRQ BIT(4)
303 #define FEATURE_HOST_NOTIFY BIT(5)
304 /* Not really a feature, but it's convenient to handle it as such */
305 #define FEATURE_IDF BIT(15)
306 #define FEATURE_TCO_SPT BIT(16)
307 #define FEATURE_TCO_CNL BIT(17)
308
309 static const char *i801_feature_names[] = {
310 "SMBus PEC",
311 "Block buffer",
312 "Block process call",
313 "I2C block read",
314 "Interrupt",
315 "SMBus Host Notify",
316 };
317
318 static unsigned int disable_features;
319 module_param(disable_features, uint, S_IRUGO | S_IWUSR);
320 MODULE_PARM_DESC(disable_features, "Disable selected driver features:\n"
321 "\t\t 0x01 disable SMBus PEC\n"
322 "\t\t 0x02 disable the block buffer\n"
323 "\t\t 0x08 disable the I2C block read functionality\n"
324 "\t\t 0x10 don't use interrupts\n"
325 "\t\t 0x20 disable SMBus Host Notify ");
326
327 /* Make sure the SMBus host is ready to start transmitting.
328 Return 0 if it is, -EBUSY if it is not. */
i801_check_pre(struct i801_priv * priv)329 static int i801_check_pre(struct i801_priv *priv)
330 {
331 int status;
332
333 status = inb_p(SMBHSTSTS(priv));
334 if (status & SMBHSTSTS_HOST_BUSY) {
335 pci_err(priv->pci_dev, "SMBus is busy, can't use it!\n");
336 return -EBUSY;
337 }
338
339 status &= STATUS_FLAGS;
340 if (status) {
341 pci_dbg(priv->pci_dev, "Clearing status flags (%02x)\n", status);
342 outb_p(status, SMBHSTSTS(priv));
343 }
344
345 /*
346 * Clear CRC status if needed.
347 * During normal operation, i801_check_post() takes care
348 * of it after every operation. We do it here only in case
349 * the hardware was already in this state when the driver
350 * started.
351 */
352 if (priv->features & FEATURE_SMBUS_PEC) {
353 status = inb_p(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE;
354 if (status) {
355 pci_dbg(priv->pci_dev, "Clearing aux status flags (%02x)\n", status);
356 outb_p(status, SMBAUXSTS(priv));
357 }
358 }
359
360 return 0;
361 }
362
i801_check_post(struct i801_priv * priv,int status)363 static int i801_check_post(struct i801_priv *priv, int status)
364 {
365 int result = 0;
366
367 /*
368 * If the SMBus is still busy, we give up
369 */
370 if (unlikely(status < 0)) {
371 dev_err(&priv->pci_dev->dev, "Transaction timeout\n");
372 /* try to stop the current command */
373 dev_dbg(&priv->pci_dev->dev, "Terminating the current operation\n");
374 outb_p(SMBHSTCNT_KILL, SMBHSTCNT(priv));
375 usleep_range(1000, 2000);
376 outb_p(0, SMBHSTCNT(priv));
377
378 /* Check if it worked */
379 status = inb_p(SMBHSTSTS(priv));
380 if ((status & SMBHSTSTS_HOST_BUSY) ||
381 !(status & SMBHSTSTS_FAILED))
382 dev_err(&priv->pci_dev->dev,
383 "Failed terminating the transaction\n");
384 return -ETIMEDOUT;
385 }
386
387 if (status & SMBHSTSTS_FAILED) {
388 result = -EIO;
389 dev_err(&priv->pci_dev->dev, "Transaction failed\n");
390 }
391 if (status & SMBHSTSTS_DEV_ERR) {
392 /*
393 * This may be a PEC error, check and clear it.
394 *
395 * AUXSTS is handled differently from HSTSTS.
396 * For HSTSTS, i801_isr() or i801_wait_intr()
397 * has already cleared the error bits in hardware,
398 * and we are passed a copy of the original value
399 * in "status".
400 * For AUXSTS, the hardware register is left
401 * for us to handle here.
402 * This is asymmetric, slightly iffy, but safe,
403 * since all this code is serialized and the CRCE
404 * bit is harmless as long as it's cleared before
405 * the next operation.
406 */
407 if ((priv->features & FEATURE_SMBUS_PEC) &&
408 (inb_p(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE)) {
409 outb_p(SMBAUXSTS_CRCE, SMBAUXSTS(priv));
410 result = -EBADMSG;
411 dev_dbg(&priv->pci_dev->dev, "PEC error\n");
412 } else {
413 result = -ENXIO;
414 dev_dbg(&priv->pci_dev->dev, "No response\n");
415 }
416 }
417 if (status & SMBHSTSTS_BUS_ERR) {
418 result = -EAGAIN;
419 dev_dbg(&priv->pci_dev->dev, "Lost arbitration\n");
420 }
421
422 return result;
423 }
424
425 /* Wait for BUSY being cleared and either INTR or an error flag being set */
i801_wait_intr(struct i801_priv * priv)426 static int i801_wait_intr(struct i801_priv *priv)
427 {
428 unsigned long timeout = jiffies + priv->adapter.timeout;
429 int status, busy;
430
431 do {
432 usleep_range(250, 500);
433 status = inb_p(SMBHSTSTS(priv));
434 busy = status & SMBHSTSTS_HOST_BUSY;
435 status &= STATUS_ERROR_FLAGS | SMBHSTSTS_INTR;
436 if (!busy && status)
437 return status;
438 } while (time_is_after_eq_jiffies(timeout));
439
440 return -ETIMEDOUT;
441 }
442
443 /* Wait for either BYTE_DONE or an error flag being set */
i801_wait_byte_done(struct i801_priv * priv)444 static int i801_wait_byte_done(struct i801_priv *priv)
445 {
446 unsigned long timeout = jiffies + priv->adapter.timeout;
447 int status;
448
449 do {
450 usleep_range(250, 500);
451 status = inb_p(SMBHSTSTS(priv));
452 if (status & (STATUS_ERROR_FLAGS | SMBHSTSTS_BYTE_DONE))
453 return status & STATUS_ERROR_FLAGS;
454 } while (time_is_after_eq_jiffies(timeout));
455
456 return -ETIMEDOUT;
457 }
458
i801_transaction(struct i801_priv * priv,int xact)459 static int i801_transaction(struct i801_priv *priv, int xact)
460 {
461 int status;
462 unsigned long result;
463 const struct i2c_adapter *adap = &priv->adapter;
464
465 status = i801_check_pre(priv);
466 if (status < 0)
467 return status;
468
469 if (priv->features & FEATURE_IRQ) {
470 reinit_completion(&priv->done);
471 outb_p(xact | SMBHSTCNT_INTREN | SMBHSTCNT_START,
472 SMBHSTCNT(priv));
473 result = wait_for_completion_timeout(&priv->done, adap->timeout);
474 return i801_check_post(priv, result ? priv->status : -ETIMEDOUT);
475 }
476
477 outb_p(xact | SMBHSTCNT_START, SMBHSTCNT(priv));
478
479 status = i801_wait_intr(priv);
480 return i801_check_post(priv, status);
481 }
482
i801_block_transaction_by_block(struct i801_priv * priv,union i2c_smbus_data * data,char read_write,int command)483 static int i801_block_transaction_by_block(struct i801_priv *priv,
484 union i2c_smbus_data *data,
485 char read_write, int command)
486 {
487 int i, len, status, xact;
488
489 switch (command) {
490 case I2C_SMBUS_BLOCK_PROC_CALL:
491 xact = I801_BLOCK_PROC_CALL;
492 break;
493 case I2C_SMBUS_BLOCK_DATA:
494 xact = I801_BLOCK_DATA;
495 break;
496 default:
497 return -EOPNOTSUPP;
498 }
499
500 /* Set block buffer mode */
501 outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_E32B, SMBAUXCTL(priv));
502
503 inb_p(SMBHSTCNT(priv)); /* reset the data buffer index */
504
505 if (read_write == I2C_SMBUS_WRITE) {
506 len = data->block[0];
507 outb_p(len, SMBHSTDAT0(priv));
508 for (i = 0; i < len; i++)
509 outb_p(data->block[i+1], SMBBLKDAT(priv));
510 }
511
512 status = i801_transaction(priv, xact);
513 if (status)
514 return status;
515
516 if (read_write == I2C_SMBUS_READ ||
517 command == I2C_SMBUS_BLOCK_PROC_CALL) {
518 len = inb_p(SMBHSTDAT0(priv));
519 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX)
520 return -EPROTO;
521
522 data->block[0] = len;
523 for (i = 0; i < len; i++)
524 data->block[i + 1] = inb_p(SMBBLKDAT(priv));
525 }
526 return 0;
527 }
528
i801_isr_byte_done(struct i801_priv * priv)529 static void i801_isr_byte_done(struct i801_priv *priv)
530 {
531 if (priv->is_read) {
532 /* For SMBus block reads, length is received with first byte */
533 if (((priv->cmd & 0x1c) == I801_BLOCK_DATA) &&
534 (priv->count == 0)) {
535 priv->len = inb_p(SMBHSTDAT0(priv));
536 if (priv->len < 1 || priv->len > I2C_SMBUS_BLOCK_MAX) {
537 dev_err(&priv->pci_dev->dev,
538 "Illegal SMBus block read size %d\n",
539 priv->len);
540 /* FIXME: Recover */
541 priv->len = I2C_SMBUS_BLOCK_MAX;
542 }
543 priv->data[-1] = priv->len;
544 }
545
546 /* Read next byte */
547 if (priv->count < priv->len)
548 priv->data[priv->count++] = inb(SMBBLKDAT(priv));
549 else
550 dev_dbg(&priv->pci_dev->dev,
551 "Discarding extra byte on block read\n");
552
553 /* Set LAST_BYTE for last byte of read transaction */
554 if (priv->count == priv->len - 1)
555 outb_p(priv->cmd | SMBHSTCNT_LAST_BYTE,
556 SMBHSTCNT(priv));
557 } else if (priv->count < priv->len - 1) {
558 /* Write next byte, except for IRQ after last byte */
559 outb_p(priv->data[++priv->count], SMBBLKDAT(priv));
560 }
561
562 /* Clear BYTE_DONE to continue with next byte */
563 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
564 }
565
i801_host_notify_isr(struct i801_priv * priv)566 static irqreturn_t i801_host_notify_isr(struct i801_priv *priv)
567 {
568 unsigned short addr;
569
570 addr = inb_p(SMBNTFDADD(priv)) >> 1;
571
572 /*
573 * With the tested platforms, reading SMBNTFDDAT (22 + (p)->smba)
574 * always returns 0. Our current implementation doesn't provide
575 * data, so we just ignore it.
576 */
577 i2c_handle_smbus_host_notify(&priv->adapter, addr);
578
579 /* clear Host Notify bit and return */
580 outb_p(SMBSLVSTS_HST_NTFY_STS, SMBSLVSTS(priv));
581 return IRQ_HANDLED;
582 }
583
584 /*
585 * There are three kinds of interrupts:
586 *
587 * 1) i801 signals transaction completion with one of these interrupts:
588 * INTR - Success
589 * DEV_ERR - Invalid command, NAK or communication timeout
590 * BUS_ERR - SMI# transaction collision
591 * FAILED - transaction was canceled due to a KILL request
592 * When any of these occur, update ->status and signal completion.
593 * ->status must be cleared before kicking off the next transaction.
594 *
595 * 2) For byte-by-byte (I2C read/write) transactions, one BYTE_DONE interrupt
596 * occurs for each byte of a byte-by-byte to prepare the next byte.
597 *
598 * 3) Host Notify interrupts
599 */
i801_isr(int irq,void * dev_id)600 static irqreturn_t i801_isr(int irq, void *dev_id)
601 {
602 struct i801_priv *priv = dev_id;
603 u16 pcists;
604 u8 status;
605
606 /* Confirm this is our interrupt */
607 pci_read_config_word(priv->pci_dev, PCI_STATUS, &pcists);
608 if (!(pcists & PCI_STATUS_INTERRUPT))
609 return IRQ_NONE;
610
611 if (priv->features & FEATURE_HOST_NOTIFY) {
612 status = inb_p(SMBSLVSTS(priv));
613 if (status & SMBSLVSTS_HST_NTFY_STS)
614 return i801_host_notify_isr(priv);
615 }
616
617 status = inb_p(SMBHSTSTS(priv));
618 if (status & SMBHSTSTS_BYTE_DONE)
619 i801_isr_byte_done(priv);
620
621 /*
622 * Clear remaining IRQ sources: Completion of last command, errors
623 * and the SMB_ALERT signal. SMB_ALERT status is set after signal
624 * assertion independently of the interrupt generation being blocked
625 * or not so clear it always when the status is set.
626 */
627 status &= SMBHSTSTS_INTR | STATUS_ERROR_FLAGS | SMBHSTSTS_SMBALERT_STS;
628 if (status)
629 outb_p(status, SMBHSTSTS(priv));
630 status &= ~SMBHSTSTS_SMBALERT_STS; /* SMB_ALERT not reported */
631 /*
632 * Report transaction result.
633 * ->status must be cleared before the next transaction is started.
634 */
635 if (status) {
636 priv->status = status;
637 complete(&priv->done);
638 }
639
640 return IRQ_HANDLED;
641 }
642
643 /*
644 * For "byte-by-byte" block transactions:
645 * I2C write uses cmd=I801_BLOCK_DATA, I2C_EN=1
646 * I2C read uses cmd=I801_I2C_BLOCK_DATA
647 */
i801_block_transaction_byte_by_byte(struct i801_priv * priv,union i2c_smbus_data * data,char read_write,int command)648 static int i801_block_transaction_byte_by_byte(struct i801_priv *priv,
649 union i2c_smbus_data *data,
650 char read_write, int command)
651 {
652 int i, len;
653 int smbcmd;
654 int status;
655 unsigned long result;
656 const struct i2c_adapter *adap = &priv->adapter;
657
658 if (command == I2C_SMBUS_BLOCK_PROC_CALL)
659 return -EOPNOTSUPP;
660
661 status = i801_check_pre(priv);
662 if (status < 0)
663 return status;
664
665 len = data->block[0];
666
667 if (read_write == I2C_SMBUS_WRITE) {
668 outb_p(len, SMBHSTDAT0(priv));
669 outb_p(data->block[1], SMBBLKDAT(priv));
670 }
671
672 if (command == I2C_SMBUS_I2C_BLOCK_DATA &&
673 read_write == I2C_SMBUS_READ)
674 smbcmd = I801_I2C_BLOCK_DATA;
675 else
676 smbcmd = I801_BLOCK_DATA;
677
678 if (priv->features & FEATURE_IRQ) {
679 priv->is_read = (read_write == I2C_SMBUS_READ);
680 if (len == 1 && priv->is_read)
681 smbcmd |= SMBHSTCNT_LAST_BYTE;
682 priv->cmd = smbcmd | SMBHSTCNT_INTREN;
683 priv->len = len;
684 priv->count = 0;
685 priv->data = &data->block[1];
686
687 reinit_completion(&priv->done);
688 outb_p(priv->cmd | SMBHSTCNT_START, SMBHSTCNT(priv));
689 result = wait_for_completion_timeout(&priv->done, adap->timeout);
690 return i801_check_post(priv, result ? priv->status : -ETIMEDOUT);
691 }
692
693 for (i = 1; i <= len; i++) {
694 if (i == len && read_write == I2C_SMBUS_READ)
695 smbcmd |= SMBHSTCNT_LAST_BYTE;
696 outb_p(smbcmd, SMBHSTCNT(priv));
697
698 if (i == 1)
699 outb_p(inb(SMBHSTCNT(priv)) | SMBHSTCNT_START,
700 SMBHSTCNT(priv));
701
702 status = i801_wait_byte_done(priv);
703 if (status)
704 goto exit;
705
706 if (i == 1 && read_write == I2C_SMBUS_READ
707 && command != I2C_SMBUS_I2C_BLOCK_DATA) {
708 len = inb_p(SMBHSTDAT0(priv));
709 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX) {
710 dev_err(&priv->pci_dev->dev,
711 "Illegal SMBus block read size %d\n",
712 len);
713 /* Recover */
714 while (inb_p(SMBHSTSTS(priv)) &
715 SMBHSTSTS_HOST_BUSY)
716 outb_p(SMBHSTSTS_BYTE_DONE,
717 SMBHSTSTS(priv));
718 outb_p(SMBHSTSTS_INTR, SMBHSTSTS(priv));
719 return -EPROTO;
720 }
721 data->block[0] = len;
722 }
723
724 /* Retrieve/store value in SMBBLKDAT */
725 if (read_write == I2C_SMBUS_READ)
726 data->block[i] = inb_p(SMBBLKDAT(priv));
727 if (read_write == I2C_SMBUS_WRITE && i+1 <= len)
728 outb_p(data->block[i+1], SMBBLKDAT(priv));
729
730 /* signals SMBBLKDAT ready */
731 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
732 }
733
734 status = i801_wait_intr(priv);
735 exit:
736 return i801_check_post(priv, status);
737 }
738
739 /* Block transaction function */
i801_block_transaction(struct i801_priv * priv,union i2c_smbus_data * data,char read_write,int command)740 static int i801_block_transaction(struct i801_priv *priv, union i2c_smbus_data *data,
741 char read_write, int command)
742 {
743 int result = 0;
744 unsigned char hostc;
745
746 if (read_write == I2C_SMBUS_READ && command == I2C_SMBUS_BLOCK_DATA)
747 data->block[0] = I2C_SMBUS_BLOCK_MAX;
748 else if (data->block[0] < 1 || data->block[0] > I2C_SMBUS_BLOCK_MAX)
749 return -EPROTO;
750
751 if (command == I2C_SMBUS_I2C_BLOCK_DATA) {
752 if (read_write == I2C_SMBUS_WRITE) {
753 /* set I2C_EN bit in configuration register */
754 pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &hostc);
755 pci_write_config_byte(priv->pci_dev, SMBHSTCFG,
756 hostc | SMBHSTCFG_I2C_EN);
757 } else if (!(priv->features & FEATURE_I2C_BLOCK_READ)) {
758 dev_err(&priv->pci_dev->dev,
759 "I2C block read is unsupported!\n");
760 return -EOPNOTSUPP;
761 }
762 }
763
764 /* Experience has shown that the block buffer can only be used for
765 SMBus (not I2C) block transactions, even though the datasheet
766 doesn't mention this limitation. */
767 if ((priv->features & FEATURE_BLOCK_BUFFER) &&
768 command != I2C_SMBUS_I2C_BLOCK_DATA)
769 result = i801_block_transaction_by_block(priv, data,
770 read_write,
771 command);
772 else
773 result = i801_block_transaction_byte_by_byte(priv, data,
774 read_write,
775 command);
776
777 if (command == I2C_SMBUS_I2C_BLOCK_DATA
778 && read_write == I2C_SMBUS_WRITE) {
779 /* restore saved configuration register value */
780 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, hostc);
781 }
782 return result;
783 }
784
785 /* Return negative errno on error. */
i801_access(struct i2c_adapter * adap,u16 addr,unsigned short flags,char read_write,u8 command,int size,union i2c_smbus_data * data)786 static s32 i801_access(struct i2c_adapter *adap, u16 addr,
787 unsigned short flags, char read_write, u8 command,
788 int size, union i2c_smbus_data *data)
789 {
790 int hwpec;
791 int block = 0;
792 int ret, xact;
793 struct i801_priv *priv = i2c_get_adapdata(adap);
794
795 mutex_lock(&priv->acpi_lock);
796 if (priv->acpi_reserved) {
797 mutex_unlock(&priv->acpi_lock);
798 return -EBUSY;
799 }
800
801 pm_runtime_get_sync(&priv->pci_dev->dev);
802
803 hwpec = (priv->features & FEATURE_SMBUS_PEC) && (flags & I2C_CLIENT_PEC)
804 && size != I2C_SMBUS_QUICK
805 && size != I2C_SMBUS_I2C_BLOCK_DATA;
806
807 switch (size) {
808 case I2C_SMBUS_QUICK:
809 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
810 SMBHSTADD(priv));
811 xact = I801_QUICK;
812 break;
813 case I2C_SMBUS_BYTE:
814 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
815 SMBHSTADD(priv));
816 if (read_write == I2C_SMBUS_WRITE)
817 outb_p(command, SMBHSTCMD(priv));
818 xact = I801_BYTE;
819 break;
820 case I2C_SMBUS_BYTE_DATA:
821 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
822 SMBHSTADD(priv));
823 outb_p(command, SMBHSTCMD(priv));
824 if (read_write == I2C_SMBUS_WRITE)
825 outb_p(data->byte, SMBHSTDAT0(priv));
826 xact = I801_BYTE_DATA;
827 break;
828 case I2C_SMBUS_WORD_DATA:
829 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
830 SMBHSTADD(priv));
831 outb_p(command, SMBHSTCMD(priv));
832 if (read_write == I2C_SMBUS_WRITE) {
833 outb_p(data->word & 0xff, SMBHSTDAT0(priv));
834 outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1(priv));
835 }
836 xact = I801_WORD_DATA;
837 break;
838 case I2C_SMBUS_PROC_CALL:
839 outb_p((addr & 0x7f) << 1, SMBHSTADD(priv));
840 outb_p(command, SMBHSTCMD(priv));
841 outb_p(data->word & 0xff, SMBHSTDAT0(priv));
842 outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1(priv));
843 xact = I801_PROC_CALL;
844 read_write = I2C_SMBUS_READ;
845 break;
846 case I2C_SMBUS_BLOCK_DATA:
847 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
848 SMBHSTADD(priv));
849 outb_p(command, SMBHSTCMD(priv));
850 block = 1;
851 break;
852 case I2C_SMBUS_I2C_BLOCK_DATA:
853 /*
854 * NB: page 240 of ICH5 datasheet shows that the R/#W
855 * bit should be cleared here, even when reading.
856 * However if SPD Write Disable is set (Lynx Point and later),
857 * the read will fail if we don't set the R/#W bit.
858 */
859 outb_p(((addr & 0x7f) << 1) |
860 ((priv->original_hstcfg & SMBHSTCFG_SPD_WD) ?
861 (read_write & 0x01) : 0),
862 SMBHSTADD(priv));
863 if (read_write == I2C_SMBUS_READ) {
864 /* NB: page 240 of ICH5 datasheet also shows
865 * that DATA1 is the cmd field when reading */
866 outb_p(command, SMBHSTDAT1(priv));
867 } else
868 outb_p(command, SMBHSTCMD(priv));
869 block = 1;
870 break;
871 case I2C_SMBUS_BLOCK_PROC_CALL:
872 /*
873 * Bit 0 of the slave address register always indicate a write
874 * command.
875 */
876 outb_p((addr & 0x7f) << 1, SMBHSTADD(priv));
877 outb_p(command, SMBHSTCMD(priv));
878 block = 1;
879 break;
880 default:
881 dev_err(&priv->pci_dev->dev, "Unsupported transaction %d\n",
882 size);
883 ret = -EOPNOTSUPP;
884 goto out;
885 }
886
887 if (hwpec) /* enable/disable hardware PEC */
888 outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_CRC, SMBAUXCTL(priv));
889 else
890 outb_p(inb_p(SMBAUXCTL(priv)) & (~SMBAUXCTL_CRC),
891 SMBAUXCTL(priv));
892
893 if (block)
894 ret = i801_block_transaction(priv, data, read_write, size);
895 else
896 ret = i801_transaction(priv, xact);
897
898 /* Some BIOSes don't like it when PEC is enabled at reboot or resume
899 time, so we forcibly disable it after every transaction. Turn off
900 E32B for the same reason. */
901 if (hwpec || block)
902 outb_p(inb_p(SMBAUXCTL(priv)) &
903 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
904
905 if (block)
906 goto out;
907 if (ret)
908 goto out;
909 if ((read_write == I2C_SMBUS_WRITE) || (xact == I801_QUICK))
910 goto out;
911
912 switch (xact) {
913 case I801_BYTE: /* Result put in SMBHSTDAT0 */
914 case I801_BYTE_DATA:
915 data->byte = inb_p(SMBHSTDAT0(priv));
916 break;
917 case I801_WORD_DATA:
918 case I801_PROC_CALL:
919 data->word = inb_p(SMBHSTDAT0(priv)) +
920 (inb_p(SMBHSTDAT1(priv)) << 8);
921 break;
922 }
923
924 out:
925 /*
926 * Unlock the SMBus device for use by BIOS/ACPI,
927 * and clear status flags if not done already.
928 */
929 outb_p(SMBHSTSTS_INUSE_STS | STATUS_FLAGS, SMBHSTSTS(priv));
930
931 pm_runtime_mark_last_busy(&priv->pci_dev->dev);
932 pm_runtime_put_autosuspend(&priv->pci_dev->dev);
933 mutex_unlock(&priv->acpi_lock);
934 return ret;
935 }
936
937
i801_func(struct i2c_adapter * adapter)938 static u32 i801_func(struct i2c_adapter *adapter)
939 {
940 struct i801_priv *priv = i2c_get_adapdata(adapter);
941
942 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
943 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
944 I2C_FUNC_SMBUS_PROC_CALL |
945 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK |
946 ((priv->features & FEATURE_SMBUS_PEC) ? I2C_FUNC_SMBUS_PEC : 0) |
947 ((priv->features & FEATURE_BLOCK_PROC) ?
948 I2C_FUNC_SMBUS_BLOCK_PROC_CALL : 0) |
949 ((priv->features & FEATURE_I2C_BLOCK_READ) ?
950 I2C_FUNC_SMBUS_READ_I2C_BLOCK : 0) |
951 ((priv->features & FEATURE_HOST_NOTIFY) ?
952 I2C_FUNC_SMBUS_HOST_NOTIFY : 0);
953 }
954
i801_enable_host_notify(struct i2c_adapter * adapter)955 static void i801_enable_host_notify(struct i2c_adapter *adapter)
956 {
957 struct i801_priv *priv = i2c_get_adapdata(adapter);
958
959 if (!(priv->features & FEATURE_HOST_NOTIFY))
960 return;
961
962 /*
963 * Enable host notify interrupt and block the generation of interrupt
964 * from the SMB_ALERT signal because the driver does not support
965 * SMBus Alert.
966 */
967 outb_p(SMBSLVCMD_HST_NTFY_INTREN | SMBSLVCMD_SMBALERT_DISABLE |
968 priv->original_slvcmd, SMBSLVCMD(priv));
969
970 /* clear Host Notify bit to allow a new notification */
971 outb_p(SMBSLVSTS_HST_NTFY_STS, SMBSLVSTS(priv));
972 }
973
i801_disable_host_notify(struct i801_priv * priv)974 static void i801_disable_host_notify(struct i801_priv *priv)
975 {
976 if (!(priv->features & FEATURE_HOST_NOTIFY))
977 return;
978
979 outb_p(priv->original_slvcmd, SMBSLVCMD(priv));
980 }
981
982 static const struct i2c_algorithm smbus_algorithm = {
983 .smbus_xfer = i801_access,
984 .functionality = i801_func,
985 };
986
987 #define FEATURES_ICH5 (FEATURE_BLOCK_PROC | FEATURE_I2C_BLOCK_READ | \
988 FEATURE_IRQ | FEATURE_SMBUS_PEC | \
989 FEATURE_BLOCK_BUFFER | FEATURE_HOST_NOTIFY)
990 #define FEATURES_ICH4 (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER | \
991 FEATURE_HOST_NOTIFY)
992
993 static const struct pci_device_id i801_ids[] = {
994 { PCI_DEVICE_DATA(INTEL, 82801AA_3, 0) },
995 { PCI_DEVICE_DATA(INTEL, 82801AB_3, 0) },
996 { PCI_DEVICE_DATA(INTEL, 82801BA_2, 0) },
997 { PCI_DEVICE_DATA(INTEL, 82801CA_3, FEATURE_HOST_NOTIFY) },
998 { PCI_DEVICE_DATA(INTEL, 82801DB_3, FEATURES_ICH4) },
999 { PCI_DEVICE_DATA(INTEL, 82801EB_3, FEATURES_ICH5) },
1000 { PCI_DEVICE_DATA(INTEL, ESB_4, FEATURES_ICH5) },
1001 { PCI_DEVICE_DATA(INTEL, ICH6_16, FEATURES_ICH5) },
1002 { PCI_DEVICE_DATA(INTEL, ICH7_17, FEATURES_ICH5) },
1003 { PCI_DEVICE_DATA(INTEL, ESB2_17, FEATURES_ICH5) },
1004 { PCI_DEVICE_DATA(INTEL, ICH8_5, FEATURES_ICH5) },
1005 { PCI_DEVICE_DATA(INTEL, ICH9_6, FEATURES_ICH5) },
1006 { PCI_DEVICE_DATA(INTEL, EP80579_1, FEATURES_ICH5) },
1007 { PCI_DEVICE_DATA(INTEL, ICH10_4, FEATURES_ICH5) },
1008 { PCI_DEVICE_DATA(INTEL, ICH10_5, FEATURES_ICH5) },
1009 { PCI_DEVICE_DATA(INTEL, 5_3400_SERIES_SMBUS, FEATURES_ICH5) },
1010 { PCI_DEVICE_DATA(INTEL, COUGARPOINT_SMBUS, FEATURES_ICH5) },
1011 { PCI_DEVICE_DATA(INTEL, PATSBURG_SMBUS, FEATURES_ICH5) },
1012 { PCI_DEVICE_DATA(INTEL, PATSBURG_SMBUS_IDF0, FEATURES_ICH5 | FEATURE_IDF) },
1013 { PCI_DEVICE_DATA(INTEL, PATSBURG_SMBUS_IDF1, FEATURES_ICH5 | FEATURE_IDF) },
1014 { PCI_DEVICE_DATA(INTEL, PATSBURG_SMBUS_IDF2, FEATURES_ICH5 | FEATURE_IDF) },
1015 { PCI_DEVICE_DATA(INTEL, DH89XXCC_SMBUS, FEATURES_ICH5) },
1016 { PCI_DEVICE_DATA(INTEL, PANTHERPOINT_SMBUS, FEATURES_ICH5) },
1017 { PCI_DEVICE_DATA(INTEL, LYNXPOINT_SMBUS, FEATURES_ICH5) },
1018 { PCI_DEVICE_DATA(INTEL, LYNXPOINT_LP_SMBUS, FEATURES_ICH5) },
1019 { PCI_DEVICE_DATA(INTEL, AVOTON_SMBUS, FEATURES_ICH5) },
1020 { PCI_DEVICE_DATA(INTEL, WELLSBURG_SMBUS, FEATURES_ICH5) },
1021 { PCI_DEVICE_DATA(INTEL, WELLSBURG_SMBUS_MS0, FEATURES_ICH5 | FEATURE_IDF) },
1022 { PCI_DEVICE_DATA(INTEL, WELLSBURG_SMBUS_MS1, FEATURES_ICH5 | FEATURE_IDF) },
1023 { PCI_DEVICE_DATA(INTEL, WELLSBURG_SMBUS_MS2, FEATURES_ICH5 | FEATURE_IDF) },
1024 { PCI_DEVICE_DATA(INTEL, COLETOCREEK_SMBUS, FEATURES_ICH5) },
1025 { PCI_DEVICE_DATA(INTEL, GEMINILAKE_SMBUS, FEATURES_ICH5) },
1026 { PCI_DEVICE_DATA(INTEL, WILDCATPOINT_SMBUS, FEATURES_ICH5) },
1027 { PCI_DEVICE_DATA(INTEL, WILDCATPOINT_LP_SMBUS, FEATURES_ICH5) },
1028 { PCI_DEVICE_DATA(INTEL, BAYTRAIL_SMBUS, FEATURES_ICH5) },
1029 { PCI_DEVICE_DATA(INTEL, BRASWELL_SMBUS, FEATURES_ICH5) },
1030 { PCI_DEVICE_DATA(INTEL, SUNRISEPOINT_H_SMBUS, FEATURES_ICH5 | FEATURE_TCO_SPT) },
1031 { PCI_DEVICE_DATA(INTEL, SUNRISEPOINT_LP_SMBUS, FEATURES_ICH5 | FEATURE_TCO_SPT) },
1032 { PCI_DEVICE_DATA(INTEL, CDF_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1033 { PCI_DEVICE_DATA(INTEL, DNV_SMBUS, FEATURES_ICH5 | FEATURE_TCO_SPT) },
1034 { PCI_DEVICE_DATA(INTEL, EBG_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1035 { PCI_DEVICE_DATA(INTEL, BROXTON_SMBUS, FEATURES_ICH5) },
1036 { PCI_DEVICE_DATA(INTEL, LEWISBURG_SMBUS, FEATURES_ICH5 | FEATURE_TCO_SPT) },
1037 { PCI_DEVICE_DATA(INTEL, LEWISBURG_SSKU_SMBUS, FEATURES_ICH5 | FEATURE_TCO_SPT) },
1038 { PCI_DEVICE_DATA(INTEL, KABYLAKE_PCH_H_SMBUS, FEATURES_ICH5 | FEATURE_TCO_SPT) },
1039 { PCI_DEVICE_DATA(INTEL, CANNONLAKE_H_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1040 { PCI_DEVICE_DATA(INTEL, CANNONLAKE_LP_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1041 { PCI_DEVICE_DATA(INTEL, ICELAKE_LP_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1042 { PCI_DEVICE_DATA(INTEL, ICELAKE_N_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1043 { PCI_DEVICE_DATA(INTEL, COMETLAKE_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1044 { PCI_DEVICE_DATA(INTEL, COMETLAKE_H_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1045 { PCI_DEVICE_DATA(INTEL, COMETLAKE_V_SMBUS, FEATURES_ICH5 | FEATURE_TCO_SPT) },
1046 { PCI_DEVICE_DATA(INTEL, ELKHART_LAKE_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1047 { PCI_DEVICE_DATA(INTEL, TIGERLAKE_LP_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1048 { PCI_DEVICE_DATA(INTEL, TIGERLAKE_H_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1049 { PCI_DEVICE_DATA(INTEL, JASPER_LAKE_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1050 { PCI_DEVICE_DATA(INTEL, ALDER_LAKE_S_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1051 { PCI_DEVICE_DATA(INTEL, ALDER_LAKE_P_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1052 { PCI_DEVICE_DATA(INTEL, ALDER_LAKE_M_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1053 { PCI_DEVICE_DATA(INTEL, RAPTOR_LAKE_S_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1054 { PCI_DEVICE_DATA(INTEL, METEOR_LAKE_P_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1055 { 0, }
1056 };
1057
1058 MODULE_DEVICE_TABLE(pci, i801_ids);
1059
1060 #if defined CONFIG_X86 && defined CONFIG_DMI
1061 static unsigned char apanel_addr;
1062
1063 /* Scan the system ROM for the signature "FJKEYINF" */
bios_signature(const void __iomem * bios)1064 static __init const void __iomem *bios_signature(const void __iomem *bios)
1065 {
1066 ssize_t offset;
1067 const unsigned char signature[] = "FJKEYINF";
1068
1069 for (offset = 0; offset < 0x10000; offset += 0x10) {
1070 if (check_signature(bios + offset, signature,
1071 sizeof(signature)-1))
1072 return bios + offset;
1073 }
1074 return NULL;
1075 }
1076
input_apanel_init(void)1077 static void __init input_apanel_init(void)
1078 {
1079 void __iomem *bios;
1080 const void __iomem *p;
1081
1082 bios = ioremap(0xF0000, 0x10000); /* Can't fail */
1083 p = bios_signature(bios);
1084 if (p) {
1085 /* just use the first address */
1086 apanel_addr = readb(p + 8 + 3) >> 1;
1087 }
1088 iounmap(bios);
1089 }
1090
1091 struct dmi_onboard_device_info {
1092 const char *name;
1093 u8 type;
1094 unsigned short i2c_addr;
1095 const char *i2c_type;
1096 };
1097
1098 static const struct dmi_onboard_device_info dmi_devices[] = {
1099 { "Syleus", DMI_DEV_TYPE_OTHER, 0x73, "fscsyl" },
1100 { "Hermes", DMI_DEV_TYPE_OTHER, 0x73, "fscher" },
1101 { "Hades", DMI_DEV_TYPE_OTHER, 0x73, "fschds" },
1102 };
1103
dmi_check_onboard_device(u8 type,const char * name,struct i2c_adapter * adap)1104 static void dmi_check_onboard_device(u8 type, const char *name,
1105 struct i2c_adapter *adap)
1106 {
1107 int i;
1108 struct i2c_board_info info;
1109
1110 for (i = 0; i < ARRAY_SIZE(dmi_devices); i++) {
1111 /* & ~0x80, ignore enabled/disabled bit */
1112 if ((type & ~0x80) != dmi_devices[i].type)
1113 continue;
1114 if (strcasecmp(name, dmi_devices[i].name))
1115 continue;
1116
1117 memset(&info, 0, sizeof(struct i2c_board_info));
1118 info.addr = dmi_devices[i].i2c_addr;
1119 strscpy(info.type, dmi_devices[i].i2c_type, I2C_NAME_SIZE);
1120 i2c_new_client_device(adap, &info);
1121 break;
1122 }
1123 }
1124
1125 /* We use our own function to check for onboard devices instead of
1126 dmi_find_device() as some buggy BIOS's have the devices we are interested
1127 in marked as disabled */
dmi_check_onboard_devices(const struct dmi_header * dm,void * adap)1128 static void dmi_check_onboard_devices(const struct dmi_header *dm, void *adap)
1129 {
1130 int i, count;
1131
1132 if (dm->type != 10)
1133 return;
1134
1135 count = (dm->length - sizeof(struct dmi_header)) / 2;
1136 for (i = 0; i < count; i++) {
1137 const u8 *d = (char *)(dm + 1) + (i * 2);
1138 const char *name = ((char *) dm) + dm->length;
1139 u8 type = d[0];
1140 u8 s = d[1];
1141
1142 if (!s)
1143 continue;
1144 s--;
1145 while (s > 0 && name[0]) {
1146 name += strlen(name) + 1;
1147 s--;
1148 }
1149 if (name[0] == 0) /* Bogus string reference */
1150 continue;
1151
1152 dmi_check_onboard_device(type, name, adap);
1153 }
1154 }
1155
1156 /* NOTE: Keep this list in sync with drivers/platform/x86/dell-smo8800.c */
1157 static const char *const acpi_smo8800_ids[] = {
1158 "SMO8800",
1159 "SMO8801",
1160 "SMO8810",
1161 "SMO8811",
1162 "SMO8820",
1163 "SMO8821",
1164 "SMO8830",
1165 "SMO8831",
1166 };
1167
check_acpi_smo88xx_device(acpi_handle obj_handle,u32 nesting_level,void * context,void ** return_value)1168 static acpi_status check_acpi_smo88xx_device(acpi_handle obj_handle,
1169 u32 nesting_level,
1170 void *context,
1171 void **return_value)
1172 {
1173 struct acpi_device_info *info;
1174 acpi_status status;
1175 char *hid;
1176 int i;
1177
1178 status = acpi_get_object_info(obj_handle, &info);
1179 if (ACPI_FAILURE(status))
1180 return AE_OK;
1181
1182 if (!(info->valid & ACPI_VALID_HID))
1183 goto smo88xx_not_found;
1184
1185 hid = info->hardware_id.string;
1186 if (!hid)
1187 goto smo88xx_not_found;
1188
1189 i = match_string(acpi_smo8800_ids, ARRAY_SIZE(acpi_smo8800_ids), hid);
1190 if (i < 0)
1191 goto smo88xx_not_found;
1192
1193 kfree(info);
1194
1195 *return_value = NULL;
1196 return AE_CTRL_TERMINATE;
1197
1198 smo88xx_not_found:
1199 kfree(info);
1200 return AE_OK;
1201 }
1202
is_dell_system_with_lis3lv02d(void)1203 static bool is_dell_system_with_lis3lv02d(void)
1204 {
1205 void *err = ERR_PTR(-ENOENT);
1206
1207 if (!dmi_match(DMI_SYS_VENDOR, "Dell Inc."))
1208 return false;
1209
1210 /*
1211 * Check that ACPI device SMO88xx is present and is functioning.
1212 * Function acpi_get_devices() already filters all ACPI devices
1213 * which are not present or are not functioning.
1214 * ACPI device SMO88xx represents our ST microelectronics lis3lv02d
1215 * accelerometer but unfortunately ACPI does not provide any other
1216 * information (like I2C address).
1217 */
1218 acpi_get_devices(NULL, check_acpi_smo88xx_device, NULL, &err);
1219
1220 return !IS_ERR(err);
1221 }
1222
1223 /*
1224 * Accelerometer's I2C address is not specified in DMI nor ACPI,
1225 * so it is needed to define mapping table based on DMI product names.
1226 */
1227 static const struct {
1228 const char *dmi_product_name;
1229 unsigned short i2c_addr;
1230 } dell_lis3lv02d_devices[] = {
1231 /*
1232 * Dell platform team told us that these Latitude devices have
1233 * ST microelectronics accelerometer at I2C address 0x29.
1234 */
1235 { "Latitude E5250", 0x29 },
1236 { "Latitude E5450", 0x29 },
1237 { "Latitude E5550", 0x29 },
1238 { "Latitude E6440", 0x29 },
1239 { "Latitude E6440 ATG", 0x29 },
1240 { "Latitude E6540", 0x29 },
1241 /*
1242 * Additional individual entries were added after verification.
1243 */
1244 { "Latitude 5480", 0x29 },
1245 { "Vostro V131", 0x1d },
1246 { "Vostro 5568", 0x29 },
1247 };
1248
register_dell_lis3lv02d_i2c_device(struct i801_priv * priv)1249 static void register_dell_lis3lv02d_i2c_device(struct i801_priv *priv)
1250 {
1251 struct i2c_board_info info;
1252 const char *dmi_product_name;
1253 int i;
1254
1255 dmi_product_name = dmi_get_system_info(DMI_PRODUCT_NAME);
1256 for (i = 0; i < ARRAY_SIZE(dell_lis3lv02d_devices); ++i) {
1257 if (strcmp(dmi_product_name,
1258 dell_lis3lv02d_devices[i].dmi_product_name) == 0)
1259 break;
1260 }
1261
1262 if (i == ARRAY_SIZE(dell_lis3lv02d_devices)) {
1263 dev_warn(&priv->pci_dev->dev,
1264 "Accelerometer lis3lv02d is present on SMBus but its"
1265 " address is unknown, skipping registration\n");
1266 return;
1267 }
1268
1269 memset(&info, 0, sizeof(struct i2c_board_info));
1270 info.addr = dell_lis3lv02d_devices[i].i2c_addr;
1271 strscpy(info.type, "lis3lv02d", I2C_NAME_SIZE);
1272 i2c_new_client_device(&priv->adapter, &info);
1273 }
1274
1275 /* Register optional slaves */
i801_probe_optional_slaves(struct i801_priv * priv)1276 static void i801_probe_optional_slaves(struct i801_priv *priv)
1277 {
1278 /* Only register slaves on main SMBus channel */
1279 if (priv->features & FEATURE_IDF)
1280 return;
1281
1282 if (apanel_addr) {
1283 struct i2c_board_info info = {
1284 .addr = apanel_addr,
1285 .type = "fujitsu_apanel",
1286 };
1287
1288 i2c_new_client_device(&priv->adapter, &info);
1289 }
1290
1291 if (dmi_name_in_vendors("FUJITSU"))
1292 dmi_walk(dmi_check_onboard_devices, &priv->adapter);
1293
1294 if (is_dell_system_with_lis3lv02d())
1295 register_dell_lis3lv02d_i2c_device(priv);
1296
1297 /* Instantiate SPD EEPROMs unless the SMBus is multiplexed */
1298 #if IS_ENABLED(CONFIG_I2C_MUX_GPIO)
1299 if (!priv->mux_drvdata)
1300 #endif
1301 i2c_register_spd(&priv->adapter);
1302 }
1303 #else
input_apanel_init(void)1304 static void __init input_apanel_init(void) {}
i801_probe_optional_slaves(struct i801_priv * priv)1305 static void i801_probe_optional_slaves(struct i801_priv *priv) {}
1306 #endif /* CONFIG_X86 && CONFIG_DMI */
1307
1308 #if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
1309 static struct i801_mux_config i801_mux_config_asus_z8_d12 = {
1310 .gpio_chip = "gpio_ich",
1311 .values = { 0x02, 0x03 },
1312 .n_values = 2,
1313 .classes = { I2C_CLASS_SPD, I2C_CLASS_SPD },
1314 .gpios = { 52, 53 },
1315 .n_gpios = 2,
1316 };
1317
1318 static struct i801_mux_config i801_mux_config_asus_z8_d18 = {
1319 .gpio_chip = "gpio_ich",
1320 .values = { 0x02, 0x03, 0x01 },
1321 .n_values = 3,
1322 .classes = { I2C_CLASS_SPD, I2C_CLASS_SPD, I2C_CLASS_SPD },
1323 .gpios = { 52, 53 },
1324 .n_gpios = 2,
1325 };
1326
1327 static const struct dmi_system_id mux_dmi_table[] = {
1328 {
1329 .matches = {
1330 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1331 DMI_MATCH(DMI_BOARD_NAME, "Z8NA-D6(C)"),
1332 },
1333 .driver_data = &i801_mux_config_asus_z8_d12,
1334 },
1335 {
1336 .matches = {
1337 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1338 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)E-D12(X)"),
1339 },
1340 .driver_data = &i801_mux_config_asus_z8_d12,
1341 },
1342 {
1343 .matches = {
1344 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1345 DMI_MATCH(DMI_BOARD_NAME, "Z8NH-D12"),
1346 },
1347 .driver_data = &i801_mux_config_asus_z8_d12,
1348 },
1349 {
1350 .matches = {
1351 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1352 DMI_MATCH(DMI_BOARD_NAME, "Z8PH-D12/IFB"),
1353 },
1354 .driver_data = &i801_mux_config_asus_z8_d12,
1355 },
1356 {
1357 .matches = {
1358 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1359 DMI_MATCH(DMI_BOARD_NAME, "Z8NR-D12"),
1360 },
1361 .driver_data = &i801_mux_config_asus_z8_d12,
1362 },
1363 {
1364 .matches = {
1365 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1366 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)H-D12"),
1367 },
1368 .driver_data = &i801_mux_config_asus_z8_d12,
1369 },
1370 {
1371 .matches = {
1372 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1373 DMI_MATCH(DMI_BOARD_NAME, "Z8PG-D18"),
1374 },
1375 .driver_data = &i801_mux_config_asus_z8_d18,
1376 },
1377 {
1378 .matches = {
1379 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1380 DMI_MATCH(DMI_BOARD_NAME, "Z8PE-D18"),
1381 },
1382 .driver_data = &i801_mux_config_asus_z8_d18,
1383 },
1384 {
1385 .matches = {
1386 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1387 DMI_MATCH(DMI_BOARD_NAME, "Z8PS-D12"),
1388 },
1389 .driver_data = &i801_mux_config_asus_z8_d12,
1390 },
1391 { }
1392 };
1393
1394 /* Setup multiplexing if needed */
i801_add_mux(struct i801_priv * priv)1395 static void i801_add_mux(struct i801_priv *priv)
1396 {
1397 struct device *dev = &priv->adapter.dev;
1398 const struct i801_mux_config *mux_config;
1399 struct i2c_mux_gpio_platform_data gpio_data;
1400 struct gpiod_lookup_table *lookup;
1401 int i;
1402
1403 if (!priv->mux_drvdata)
1404 return;
1405 mux_config = priv->mux_drvdata;
1406
1407 /* Prepare the platform data */
1408 memset(&gpio_data, 0, sizeof(struct i2c_mux_gpio_platform_data));
1409 gpio_data.parent = priv->adapter.nr;
1410 gpio_data.values = mux_config->values;
1411 gpio_data.n_values = mux_config->n_values;
1412 gpio_data.classes = mux_config->classes;
1413 gpio_data.idle = I2C_MUX_GPIO_NO_IDLE;
1414
1415 /* Register GPIO descriptor lookup table */
1416 lookup = devm_kzalloc(dev,
1417 struct_size(lookup, table, mux_config->n_gpios + 1),
1418 GFP_KERNEL);
1419 if (!lookup)
1420 return;
1421 lookup->dev_id = "i2c-mux-gpio";
1422 for (i = 0; i < mux_config->n_gpios; i++)
1423 lookup->table[i] = GPIO_LOOKUP(mux_config->gpio_chip,
1424 mux_config->gpios[i], "mux", 0);
1425 gpiod_add_lookup_table(lookup);
1426 priv->lookup = lookup;
1427
1428 /*
1429 * Register the mux device, we use PLATFORM_DEVID_NONE here
1430 * because since we are referring to the GPIO chip by name we are
1431 * anyways in deep trouble if there is more than one of these
1432 * devices, and there should likely only be one platform controller
1433 * hub.
1434 */
1435 priv->mux_pdev = platform_device_register_data(dev, "i2c-mux-gpio",
1436 PLATFORM_DEVID_NONE, &gpio_data,
1437 sizeof(struct i2c_mux_gpio_platform_data));
1438 if (IS_ERR(priv->mux_pdev)) {
1439 gpiod_remove_lookup_table(lookup);
1440 dev_err(dev, "Failed to register i2c-mux-gpio device\n");
1441 }
1442 }
1443
i801_del_mux(struct i801_priv * priv)1444 static void i801_del_mux(struct i801_priv *priv)
1445 {
1446 platform_device_unregister(priv->mux_pdev);
1447 gpiod_remove_lookup_table(priv->lookup);
1448 }
1449
i801_get_adapter_class(struct i801_priv * priv)1450 static unsigned int i801_get_adapter_class(struct i801_priv *priv)
1451 {
1452 const struct dmi_system_id *id;
1453 const struct i801_mux_config *mux_config;
1454 unsigned int class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
1455 int i;
1456
1457 id = dmi_first_match(mux_dmi_table);
1458 if (id) {
1459 /* Remove branch classes from trunk */
1460 mux_config = id->driver_data;
1461 for (i = 0; i < mux_config->n_values; i++)
1462 class &= ~mux_config->classes[i];
1463
1464 /* Remember for later */
1465 priv->mux_drvdata = mux_config;
1466 }
1467
1468 return class;
1469 }
1470 #else
i801_add_mux(struct i801_priv * priv)1471 static inline void i801_add_mux(struct i801_priv *priv) { }
i801_del_mux(struct i801_priv * priv)1472 static inline void i801_del_mux(struct i801_priv *priv) { }
1473
i801_get_adapter_class(struct i801_priv * priv)1474 static inline unsigned int i801_get_adapter_class(struct i801_priv *priv)
1475 {
1476 return I2C_CLASS_HWMON | I2C_CLASS_SPD;
1477 }
1478 #endif
1479
1480 static struct platform_device *
i801_add_tco_spt(struct i801_priv * priv,struct pci_dev * pci_dev,struct resource * tco_res)1481 i801_add_tco_spt(struct i801_priv *priv, struct pci_dev *pci_dev,
1482 struct resource *tco_res)
1483 {
1484 static const struct itco_wdt_platform_data pldata = {
1485 .name = "Intel PCH",
1486 .version = 4,
1487 };
1488 struct resource *res;
1489 int ret;
1490
1491 /*
1492 * We must access the NO_REBOOT bit over the Primary to Sideband
1493 * (P2SB) bridge.
1494 */
1495
1496 res = &tco_res[1];
1497 ret = p2sb_bar(pci_dev->bus, 0, res);
1498 if (ret)
1499 return ERR_PTR(ret);
1500
1501 if (pci_dev->device == PCI_DEVICE_ID_INTEL_DNV_SMBUS)
1502 res->start += SBREG_SMBCTRL_DNV;
1503 else
1504 res->start += SBREG_SMBCTRL;
1505
1506 res->end = res->start + 3;
1507
1508 return platform_device_register_resndata(&pci_dev->dev, "iTCO_wdt", -1,
1509 tco_res, 2, &pldata, sizeof(pldata));
1510 }
1511
1512 static struct platform_device *
i801_add_tco_cnl(struct i801_priv * priv,struct pci_dev * pci_dev,struct resource * tco_res)1513 i801_add_tco_cnl(struct i801_priv *priv, struct pci_dev *pci_dev,
1514 struct resource *tco_res)
1515 {
1516 static const struct itco_wdt_platform_data pldata = {
1517 .name = "Intel PCH",
1518 .version = 6,
1519 };
1520
1521 return platform_device_register_resndata(&pci_dev->dev, "iTCO_wdt", -1,
1522 tco_res, 1, &pldata, sizeof(pldata));
1523 }
1524
i801_add_tco(struct i801_priv * priv)1525 static void i801_add_tco(struct i801_priv *priv)
1526 {
1527 struct pci_dev *pci_dev = priv->pci_dev;
1528 struct resource tco_res[2], *res;
1529 u32 tco_base, tco_ctl;
1530
1531 /* If we have ACPI based watchdog use that instead */
1532 if (acpi_has_watchdog())
1533 return;
1534
1535 if (!(priv->features & (FEATURE_TCO_SPT | FEATURE_TCO_CNL)))
1536 return;
1537
1538 pci_read_config_dword(pci_dev, TCOBASE, &tco_base);
1539 pci_read_config_dword(pci_dev, TCOCTL, &tco_ctl);
1540 if (!(tco_ctl & TCOCTL_EN))
1541 return;
1542
1543 memset(tco_res, 0, sizeof(tco_res));
1544 /*
1545 * Always populate the main iTCO IO resource here. The second entry
1546 * for NO_REBOOT MMIO is filled by the SPT specific function.
1547 */
1548 res = &tco_res[0];
1549 res->start = tco_base & ~1;
1550 res->end = res->start + 32 - 1;
1551 res->flags = IORESOURCE_IO;
1552
1553 if (priv->features & FEATURE_TCO_CNL)
1554 priv->tco_pdev = i801_add_tco_cnl(priv, pci_dev, tco_res);
1555 else
1556 priv->tco_pdev = i801_add_tco_spt(priv, pci_dev, tco_res);
1557
1558 if (IS_ERR(priv->tco_pdev))
1559 dev_warn(&pci_dev->dev, "failed to create iTCO device\n");
1560 }
1561
1562 #ifdef CONFIG_ACPI
i801_acpi_is_smbus_ioport(const struct i801_priv * priv,acpi_physical_address address)1563 static bool i801_acpi_is_smbus_ioport(const struct i801_priv *priv,
1564 acpi_physical_address address)
1565 {
1566 return address >= priv->smba &&
1567 address <= pci_resource_end(priv->pci_dev, SMBBAR);
1568 }
1569
1570 static acpi_status
i801_acpi_io_handler(u32 function,acpi_physical_address address,u32 bits,u64 * value,void * handler_context,void * region_context)1571 i801_acpi_io_handler(u32 function, acpi_physical_address address, u32 bits,
1572 u64 *value, void *handler_context, void *region_context)
1573 {
1574 struct i801_priv *priv = handler_context;
1575 struct pci_dev *pdev = priv->pci_dev;
1576 acpi_status status;
1577
1578 /*
1579 * Once BIOS AML code touches the OpRegion we warn and inhibit any
1580 * further access from the driver itself. This device is now owned
1581 * by the system firmware.
1582 */
1583 mutex_lock(&priv->acpi_lock);
1584
1585 if (!priv->acpi_reserved && i801_acpi_is_smbus_ioport(priv, address)) {
1586 priv->acpi_reserved = true;
1587
1588 dev_warn(&pdev->dev, "BIOS is accessing SMBus registers\n");
1589 dev_warn(&pdev->dev, "Driver SMBus register access inhibited\n");
1590
1591 /*
1592 * BIOS is accessing the host controller so prevent it from
1593 * suspending automatically from now on.
1594 */
1595 pm_runtime_get_sync(&pdev->dev);
1596 }
1597
1598 if ((function & ACPI_IO_MASK) == ACPI_READ)
1599 status = acpi_os_read_port(address, (u32 *)value, bits);
1600 else
1601 status = acpi_os_write_port(address, (u32)*value, bits);
1602
1603 mutex_unlock(&priv->acpi_lock);
1604
1605 return status;
1606 }
1607
i801_acpi_probe(struct i801_priv * priv)1608 static int i801_acpi_probe(struct i801_priv *priv)
1609 {
1610 acpi_handle ah = ACPI_HANDLE(&priv->pci_dev->dev);
1611 acpi_status status;
1612
1613 status = acpi_install_address_space_handler(ah, ACPI_ADR_SPACE_SYSTEM_IO,
1614 i801_acpi_io_handler, NULL, priv);
1615 if (ACPI_SUCCESS(status))
1616 return 0;
1617
1618 return acpi_check_resource_conflict(&priv->pci_dev->resource[SMBBAR]);
1619 }
1620
i801_acpi_remove(struct i801_priv * priv)1621 static void i801_acpi_remove(struct i801_priv *priv)
1622 {
1623 acpi_handle ah = ACPI_HANDLE(&priv->pci_dev->dev);
1624
1625 acpi_remove_address_space_handler(ah, ACPI_ADR_SPACE_SYSTEM_IO, i801_acpi_io_handler);
1626 }
1627 #else
i801_acpi_probe(struct i801_priv * priv)1628 static inline int i801_acpi_probe(struct i801_priv *priv) { return 0; }
i801_acpi_remove(struct i801_priv * priv)1629 static inline void i801_acpi_remove(struct i801_priv *priv) { }
1630 #endif
1631
i801_setup_hstcfg(struct i801_priv * priv)1632 static void i801_setup_hstcfg(struct i801_priv *priv)
1633 {
1634 unsigned char hstcfg = priv->original_hstcfg;
1635
1636 hstcfg &= ~SMBHSTCFG_I2C_EN; /* SMBus timing */
1637 hstcfg |= SMBHSTCFG_HST_EN;
1638 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, hstcfg);
1639 }
1640
i801_probe(struct pci_dev * dev,const struct pci_device_id * id)1641 static int i801_probe(struct pci_dev *dev, const struct pci_device_id *id)
1642 {
1643 int err, i;
1644 struct i801_priv *priv;
1645
1646 priv = devm_kzalloc(&dev->dev, sizeof(*priv), GFP_KERNEL);
1647 if (!priv)
1648 return -ENOMEM;
1649
1650 i2c_set_adapdata(&priv->adapter, priv);
1651 priv->adapter.owner = THIS_MODULE;
1652 priv->adapter.class = i801_get_adapter_class(priv);
1653 priv->adapter.algo = &smbus_algorithm;
1654 priv->adapter.dev.parent = &dev->dev;
1655 ACPI_COMPANION_SET(&priv->adapter.dev, ACPI_COMPANION(&dev->dev));
1656 priv->adapter.retries = 3;
1657 mutex_init(&priv->acpi_lock);
1658
1659 priv->pci_dev = dev;
1660 priv->features = id->driver_data;
1661
1662 /* Disable features on user request */
1663 for (i = 0; i < ARRAY_SIZE(i801_feature_names); i++) {
1664 if (priv->features & disable_features & (1 << i))
1665 dev_notice(&dev->dev, "%s disabled by user\n",
1666 i801_feature_names[i]);
1667 }
1668 priv->features &= ~disable_features;
1669
1670 err = pcim_enable_device(dev);
1671 if (err) {
1672 dev_err(&dev->dev, "Failed to enable SMBus PCI device (%d)\n",
1673 err);
1674 return err;
1675 }
1676 pcim_pin_device(dev);
1677
1678 /* Determine the address of the SMBus area */
1679 priv->smba = pci_resource_start(dev, SMBBAR);
1680 if (!priv->smba) {
1681 dev_err(&dev->dev,
1682 "SMBus base address uninitialized, upgrade BIOS\n");
1683 return -ENODEV;
1684 }
1685
1686 if (i801_acpi_probe(priv))
1687 return -ENODEV;
1688
1689 err = pcim_iomap_regions(dev, 1 << SMBBAR, DRV_NAME);
1690 if (err) {
1691 dev_err(&dev->dev,
1692 "Failed to request SMBus region 0x%lx-0x%Lx\n",
1693 priv->smba,
1694 (unsigned long long)pci_resource_end(dev, SMBBAR));
1695 i801_acpi_remove(priv);
1696 return err;
1697 }
1698
1699 pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &priv->original_hstcfg);
1700 i801_setup_hstcfg(priv);
1701 if (!(priv->original_hstcfg & SMBHSTCFG_HST_EN))
1702 dev_info(&dev->dev, "Enabling SMBus device\n");
1703
1704 if (priv->original_hstcfg & SMBHSTCFG_SMB_SMI_EN) {
1705 dev_dbg(&dev->dev, "SMBus using interrupt SMI#\n");
1706 /* Disable SMBus interrupt feature if SMBus using SMI# */
1707 priv->features &= ~FEATURE_IRQ;
1708 }
1709 if (priv->original_hstcfg & SMBHSTCFG_SPD_WD)
1710 dev_info(&dev->dev, "SPD Write Disable is set\n");
1711
1712 /* Clear special mode bits */
1713 if (priv->features & (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER))
1714 outb_p(inb_p(SMBAUXCTL(priv)) &
1715 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
1716
1717 /* Remember original Interrupt and Host Notify settings */
1718 priv->original_hstcnt = inb_p(SMBHSTCNT(priv)) & ~SMBHSTCNT_KILL;
1719 if (priv->features & FEATURE_HOST_NOTIFY)
1720 priv->original_slvcmd = inb_p(SMBSLVCMD(priv));
1721
1722 /* Default timeout in interrupt mode: 200 ms */
1723 priv->adapter.timeout = HZ / 5;
1724
1725 if (dev->irq == IRQ_NOTCONNECTED)
1726 priv->features &= ~FEATURE_IRQ;
1727
1728 if (priv->features & FEATURE_IRQ) {
1729 u16 pcists;
1730
1731 /* Complain if an interrupt is already pending */
1732 pci_read_config_word(priv->pci_dev, PCI_STATUS, &pcists);
1733 if (pcists & PCI_STATUS_INTERRUPT)
1734 dev_warn(&dev->dev, "An interrupt is pending!\n");
1735 }
1736
1737 if (priv->features & FEATURE_IRQ) {
1738 init_completion(&priv->done);
1739
1740 err = devm_request_irq(&dev->dev, dev->irq, i801_isr,
1741 IRQF_SHARED, DRV_NAME, priv);
1742 if (err) {
1743 dev_err(&dev->dev, "Failed to allocate irq %d: %d\n",
1744 dev->irq, err);
1745 priv->features &= ~FEATURE_IRQ;
1746 }
1747 }
1748 dev_info(&dev->dev, "SMBus using %s\n",
1749 priv->features & FEATURE_IRQ ? "PCI interrupt" : "polling");
1750
1751 i801_add_tco(priv);
1752
1753 snprintf(priv->adapter.name, sizeof(priv->adapter.name),
1754 "SMBus I801 adapter at %04lx", priv->smba);
1755 err = i2c_add_adapter(&priv->adapter);
1756 if (err) {
1757 i801_acpi_remove(priv);
1758 return err;
1759 }
1760
1761 i801_enable_host_notify(&priv->adapter);
1762
1763 i801_probe_optional_slaves(priv);
1764 /* We ignore errors - multiplexing is optional */
1765 i801_add_mux(priv);
1766
1767 pci_set_drvdata(dev, priv);
1768
1769 dev_pm_set_driver_flags(&dev->dev, DPM_FLAG_NO_DIRECT_COMPLETE);
1770 pm_runtime_set_autosuspend_delay(&dev->dev, 1000);
1771 pm_runtime_use_autosuspend(&dev->dev);
1772 pm_runtime_put_autosuspend(&dev->dev);
1773 pm_runtime_allow(&dev->dev);
1774
1775 return 0;
1776 }
1777
i801_remove(struct pci_dev * dev)1778 static void i801_remove(struct pci_dev *dev)
1779 {
1780 struct i801_priv *priv = pci_get_drvdata(dev);
1781
1782 outb_p(priv->original_hstcnt, SMBHSTCNT(priv));
1783 i801_disable_host_notify(priv);
1784 i801_del_mux(priv);
1785 i2c_del_adapter(&priv->adapter);
1786 i801_acpi_remove(priv);
1787 pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1788
1789 platform_device_unregister(priv->tco_pdev);
1790
1791 /* if acpi_reserved is set then usage_count is incremented already */
1792 if (!priv->acpi_reserved)
1793 pm_runtime_get_noresume(&dev->dev);
1794
1795 /*
1796 * do not call pci_disable_device(dev) since it can cause hard hangs on
1797 * some systems during power-off (eg. Fujitsu-Siemens Lifebook E8010)
1798 */
1799 }
1800
i801_shutdown(struct pci_dev * dev)1801 static void i801_shutdown(struct pci_dev *dev)
1802 {
1803 struct i801_priv *priv = pci_get_drvdata(dev);
1804
1805 /* Restore config registers to avoid hard hang on some systems */
1806 outb_p(priv->original_hstcnt, SMBHSTCNT(priv));
1807 i801_disable_host_notify(priv);
1808 pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1809 }
1810
1811 #ifdef CONFIG_PM_SLEEP
i801_suspend(struct device * dev)1812 static int i801_suspend(struct device *dev)
1813 {
1814 struct i801_priv *priv = dev_get_drvdata(dev);
1815
1816 outb_p(priv->original_hstcnt, SMBHSTCNT(priv));
1817 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, priv->original_hstcfg);
1818 return 0;
1819 }
1820
i801_resume(struct device * dev)1821 static int i801_resume(struct device *dev)
1822 {
1823 struct i801_priv *priv = dev_get_drvdata(dev);
1824
1825 i801_setup_hstcfg(priv);
1826 i801_enable_host_notify(&priv->adapter);
1827
1828 return 0;
1829 }
1830 #endif
1831
1832 static SIMPLE_DEV_PM_OPS(i801_pm_ops, i801_suspend, i801_resume);
1833
1834 static struct pci_driver i801_driver = {
1835 .name = DRV_NAME,
1836 .id_table = i801_ids,
1837 .probe = i801_probe,
1838 .remove = i801_remove,
1839 .shutdown = i801_shutdown,
1840 .driver = {
1841 .pm = &i801_pm_ops,
1842 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1843 },
1844 };
1845
i2c_i801_init(void)1846 static int __init i2c_i801_init(void)
1847 {
1848 if (dmi_name_in_vendors("FUJITSU"))
1849 input_apanel_init();
1850 return pci_register_driver(&i801_driver);
1851 }
1852
i2c_i801_exit(void)1853 static void __exit i2c_i801_exit(void)
1854 {
1855 pci_unregister_driver(&i801_driver);
1856 }
1857
1858 MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>");
1859 MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>");
1860 MODULE_DESCRIPTION("I801 SMBus driver");
1861 MODULE_LICENSE("GPL");
1862
1863 module_init(i2c_i801_init);
1864 module_exit(i2c_i801_exit);
1865