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