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 * Meteor Lake SoC-S (SOC) 0xae22 32 hard yes yes yes
81 * Meteor Lake PCH-S (PCH) 0x7f23 32 hard yes yes yes
82 * Birch Stream (SOC) 0x5796 32 hard yes yes yes
83 * Arrow Lake-H (SOC) 0x7722 32 hard yes yes yes
84 * Panther Lake-H (SOC) 0xe322 32 hard yes yes yes
85 * Panther Lake-P (SOC) 0xe422 32 hard yes yes yes
86 * Wildcat Lake-U (SOC) 0x4d22 32 hard yes yes yes
87 *
88 * Features supported by this driver:
89 * Software PEC no
90 * Hardware PEC yes
91 * Block buffer yes
92 * Block process call transaction yes
93 * I2C block read transaction yes (doesn't use the block buffer)
94 * Target mode no
95 * SMBus Host Notify yes
96 * Interrupt processing yes
97 *
98 * See the file Documentation/i2c/busses/i2c-i801.rst for details.
99 */
100
101#define DRV_NAME "i801_smbus"
102
103#include <linux/interrupt.h>
104#include <linux/module.h>
105#include <linux/pci.h>
106#include <linux/kernel.h>
107#include <linux/stddef.h>
108#include <linux/delay.h>
109#include <linux/ioport.h>
110#include <linux/init.h>
111#include <linux/i2c.h>
112#include <linux/i2c-mux.h>
113#include <linux/i2c-smbus.h>
114#include <linux/acpi.h>
115#include <linux/io.h>
116#include <linux/dmi.h>
117#include <linux/slab.h>
118#include <linux/string.h>
119#include <linux/completion.h>
120#include <linux/err.h>
121#include <linux/platform_device.h>
122#include <linux/platform_data/itco_wdt.h>
123#include <linux/platform_data/x86/p2sb.h>
124#include <linux/pm_runtime.h>
125#include <linux/mutex.h>
126
127#ifdef CONFIG_I2C_I801_MUX
128#include <linux/gpio/machine.h>
129#include <linux/platform_data/i2c-mux-gpio.h>
130#endif
131
132/* I801 SMBus address offsets */
133#define SMBHSTSTS(p) (0 + (p)->smba)
134#define SMBHSTCNT(p) (2 + (p)->smba)
135#define SMBHSTCMD(p) (3 + (p)->smba)
136#define SMBHSTADD(p) (4 + (p)->smba)
137#define SMBHSTDAT0(p) (5 + (p)->smba)
138#define SMBHSTDAT1(p) (6 + (p)->smba)
139#define SMBBLKDAT(p) (7 + (p)->smba)
140#define SMBPEC(p) (8 + (p)->smba) /* ICH3 and later */
141#define SMBAUXSTS(p) (12 + (p)->smba) /* ICH4 and later */
142#define SMBAUXCTL(p) (13 + (p)->smba) /* ICH4 and later */
143#define SMBSLVSTS(p) (16 + (p)->smba) /* ICH3 and later */
144#define SMBSLVCMD(p) (17 + (p)->smba) /* ICH3 and later */
145#define SMBNTFDADD(p) (20 + (p)->smba) /* ICH3 and later */
146
147/* PCI Address Constants */
148#define SMBBAR_MMIO 0
149#define SMBBAR 4
150#define SMBHSTCFG 0x040
151#define TCOBASE 0x050
152#define TCOCTL 0x054
153
154#define SBREG_SMBCTRL 0xc6000c
155#define SBREG_SMBCTRL_DNV 0xcf000c
156
157/* Host configuration bits for SMBHSTCFG */
158#define SMBHSTCFG_HST_EN BIT(0)
159#define SMBHSTCFG_SMB_SMI_EN BIT(1)
160#define SMBHSTCFG_I2C_EN BIT(2)
161#define SMBHSTCFG_SPD_WD BIT(4)
162
163/* TCO configuration bits for TCOCTL */
164#define TCOCTL_EN BIT(8)
165
166/* Auxiliary status register bits, ICH4+ only */
167#define SMBAUXSTS_CRCE BIT(0)
168#define SMBAUXSTS_STCO BIT(1)
169
170/* Auxiliary control register bits, ICH4+ only */
171#define SMBAUXCTL_CRC BIT(0)
172#define SMBAUXCTL_E32B BIT(1)
173
174/* I801 command constants */
175#define I801_QUICK 0x00
176#define I801_BYTE 0x04
177#define I801_BYTE_DATA 0x08
178#define I801_WORD_DATA 0x0C
179#define I801_PROC_CALL 0x10
180#define I801_BLOCK_DATA 0x14
181#define I801_I2C_BLOCK_DATA 0x18 /* ICH5 and later */
182#define I801_BLOCK_PROC_CALL 0x1C
183
184/* I801 Host Control register bits */
185#define SMBHSTCNT_INTREN BIT(0)
186#define SMBHSTCNT_KILL BIT(1)
187#define SMBHSTCNT_LAST_BYTE BIT(5)
188#define SMBHSTCNT_START BIT(6)
189#define SMBHSTCNT_PEC_EN BIT(7) /* ICH3 and later */
190
191/* I801 Hosts Status register bits */
192#define SMBHSTSTS_BYTE_DONE BIT(7)
193#define SMBHSTSTS_INUSE_STS BIT(6)
194#define SMBHSTSTS_SMBALERT_STS BIT(5)
195#define SMBHSTSTS_FAILED BIT(4)
196#define SMBHSTSTS_BUS_ERR BIT(3)
197#define SMBHSTSTS_DEV_ERR BIT(2)
198#define SMBHSTSTS_INTR BIT(1)
199#define SMBHSTSTS_HOST_BUSY BIT(0)
200
201/* Host Notify Status register bits */
202#define SMBSLVSTS_HST_NTFY_STS BIT(0)
203
204/* Host Notify Command register bits */
205#define SMBSLVCMD_SMBALERT_DISABLE BIT(2)
206#define SMBSLVCMD_HST_NTFY_INTREN BIT(0)
207
208#define STATUS_ERROR_FLAGS (SMBHSTSTS_FAILED | SMBHSTSTS_BUS_ERR | \
209 SMBHSTSTS_DEV_ERR)
210
211#define STATUS_FLAGS (SMBHSTSTS_BYTE_DONE | SMBHSTSTS_INTR | \
212 STATUS_ERROR_FLAGS)
213
214#define SMBUS_LEN_SENTINEL (I2C_SMBUS_BLOCK_MAX + 1)
215
216/* Older devices have their ID defined in <linux/pci_ids.h> */
217#define PCI_DEVICE_ID_INTEL_COMETLAKE_SMBUS 0x02a3
218#define PCI_DEVICE_ID_INTEL_COMETLAKE_H_SMBUS 0x06a3
219#define PCI_DEVICE_ID_INTEL_BAYTRAIL_SMBUS 0x0f12
220#define PCI_DEVICE_ID_INTEL_CDF_SMBUS 0x18df
221#define PCI_DEVICE_ID_INTEL_DNV_SMBUS 0x19df
222#define PCI_DEVICE_ID_INTEL_EBG_SMBUS 0x1bc9
223#define PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS 0x1c22
224#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS 0x1d22
225/* Patsburg also has three 'Integrated Device Function' SMBus controllers */
226#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0 0x1d70
227#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1 0x1d71
228#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2 0x1d72
229#define PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS 0x1e22
230#define PCI_DEVICE_ID_INTEL_AVOTON_SMBUS 0x1f3c
231#define PCI_DEVICE_ID_INTEL_BRASWELL_SMBUS 0x2292
232#define PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS 0x2330
233#define PCI_DEVICE_ID_INTEL_COLETOCREEK_SMBUS 0x23b0
234#define PCI_DEVICE_ID_INTEL_GEMINILAKE_SMBUS 0x31d4
235#define PCI_DEVICE_ID_INTEL_ICELAKE_LP_SMBUS 0x34a3
236#define PCI_DEVICE_ID_INTEL_ICELAKE_N_SMBUS 0x38a3
237#define PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS 0x3b30
238#define PCI_DEVICE_ID_INTEL_TIGERLAKE_H_SMBUS 0x43a3
239#define PCI_DEVICE_ID_INTEL_ELKHART_LAKE_SMBUS 0x4b23
240#define PCI_DEVICE_ID_INTEL_WILDCAT_LAKE_U_SMBUS 0x4d22
241#define PCI_DEVICE_ID_INTEL_JASPER_LAKE_SMBUS 0x4da3
242#define PCI_DEVICE_ID_INTEL_ALDER_LAKE_P_SMBUS 0x51a3
243#define PCI_DEVICE_ID_INTEL_ALDER_LAKE_M_SMBUS 0x54a3
244#define PCI_DEVICE_ID_INTEL_BIRCH_STREAM_SMBUS 0x5796
245#define PCI_DEVICE_ID_INTEL_BROXTON_SMBUS 0x5ad4
246#define PCI_DEVICE_ID_INTEL_ARROW_LAKE_H_SMBUS 0x7722
247#define PCI_DEVICE_ID_INTEL_RAPTOR_LAKE_S_SMBUS 0x7a23
248#define PCI_DEVICE_ID_INTEL_ALDER_LAKE_S_SMBUS 0x7aa3
249#define PCI_DEVICE_ID_INTEL_METEOR_LAKE_P_SMBUS 0x7e22
250#define PCI_DEVICE_ID_INTEL_METEOR_LAKE_PCH_S_SMBUS 0x7f23
251#define PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS 0x8c22
252#define PCI_DEVICE_ID_INTEL_WILDCATPOINT_SMBUS 0x8ca2
253#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS 0x8d22
254#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0 0x8d7d
255#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1 0x8d7e
256#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2 0x8d7f
257#define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS 0x9c22
258#define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_SMBUS 0x9ca2
259#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS 0x9d23
260#define PCI_DEVICE_ID_INTEL_CANNONLAKE_LP_SMBUS 0x9da3
261#define PCI_DEVICE_ID_INTEL_TIGERLAKE_LP_SMBUS 0xa0a3
262#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS 0xa123
263#define PCI_DEVICE_ID_INTEL_LEWISBURG_SMBUS 0xa1a3
264#define PCI_DEVICE_ID_INTEL_LEWISBURG_SSKU_SMBUS 0xa223
265#define PCI_DEVICE_ID_INTEL_KABYLAKE_PCH_H_SMBUS 0xa2a3
266#define PCI_DEVICE_ID_INTEL_CANNONLAKE_H_SMBUS 0xa323
267#define PCI_DEVICE_ID_INTEL_COMETLAKE_V_SMBUS 0xa3a3
268#define PCI_DEVICE_ID_INTEL_METEOR_LAKE_SOC_S_SMBUS 0xae22
269#define PCI_DEVICE_ID_INTEL_PANTHER_LAKE_H_SMBUS 0xe322
270#define PCI_DEVICE_ID_INTEL_PANTHER_LAKE_P_SMBUS 0xe422
271
272struct i801_mux_config {
273 char *gpio_chip;
274 unsigned values[3];
275 int n_values;
276 unsigned gpios[2]; /* Relative to gpio_chip->base */
277 int n_gpios;
278};
279
280struct i801_priv {
281 struct i2c_adapter adapter;
282 void __iomem *smba;
283 unsigned char original_hstcfg;
284 unsigned char original_hstcnt;
285 unsigned char original_slvcmd;
286 struct pci_dev *pci_dev;
287 unsigned int features;
288
289 /* isr processing */
290 struct completion done;
291 u8 status;
292
293 /* Command state used by isr for byte-by-byte block transactions */
294 u8 cmd;
295 bool is_read;
296 int count;
297 int len;
298 u8 *data;
299
300#ifdef CONFIG_I2C_I801_MUX
301 struct platform_device *mux_pdev;
302 struct gpiod_lookup_table *lookup;
303 struct notifier_block mux_notifier_block;
304#endif
305 struct platform_device *tco_pdev;
306
307 /*
308 * If set to true the host controller registers are reserved for
309 * ACPI AML use.
310 */
311 bool acpi_reserved;
312};
313
314#define FEATURE_SMBUS_PEC BIT(0)
315#define FEATURE_BLOCK_BUFFER BIT(1)
316#define FEATURE_BLOCK_PROC BIT(2)
317#define FEATURE_I2C_BLOCK_READ BIT(3)
318#define FEATURE_IRQ BIT(4)
319#define FEATURE_HOST_NOTIFY BIT(5)
320/* Not really a feature, but it's convenient to handle it as such */
321#define FEATURE_IDF BIT(15)
322#define FEATURE_TCO_SPT BIT(16)
323#define FEATURE_TCO_CNL BIT(17)
324
325static const char *i801_feature_names[] = {
326 "SMBus PEC",
327 "Block buffer",
328 "Block process call",
329 "I2C block read",
330 "Interrupt",
331 "SMBus Host Notify",
332};
333
334static unsigned int disable_features;
335module_param(disable_features, uint, S_IRUGO | S_IWUSR);
336MODULE_PARM_DESC(disable_features, "Disable selected driver features:\n"
337 "\t\t 0x01 disable SMBus PEC\n"
338 "\t\t 0x02 disable the block buffer\n"
339 "\t\t 0x08 disable the I2C block read functionality\n"
340 "\t\t 0x10 don't use interrupts\n"
341 "\t\t 0x20 disable SMBus Host Notify ");
342
343/* Wait for BUSY being cleared and either INTR or an error flag being set */
344static int i801_wait_intr(struct i801_priv *priv)
345{
346 unsigned long timeout = jiffies + priv->adapter.timeout;
347 int status, busy;
348
349 do {
350 usleep_range(min: 250, max: 500);
351 status = ioread8(SMBHSTSTS(priv));
352 busy = status & SMBHSTSTS_HOST_BUSY;
353 status &= STATUS_ERROR_FLAGS | SMBHSTSTS_INTR;
354 if (!busy && status)
355 return status & STATUS_ERROR_FLAGS;
356 } while (time_is_after_eq_jiffies(timeout));
357
358 return -ETIMEDOUT;
359}
360
361/* Wait for either BYTE_DONE or an error flag being set */
362static int i801_wait_byte_done(struct i801_priv *priv)
363{
364 unsigned long timeout = jiffies + priv->adapter.timeout;
365 int status;
366
367 do {
368 usleep_range(min: 250, max: 500);
369 status = ioread8(SMBHSTSTS(priv));
370 if (status & (STATUS_ERROR_FLAGS | SMBHSTSTS_BYTE_DONE))
371 return status & STATUS_ERROR_FLAGS;
372 } while (time_is_after_eq_jiffies(timeout));
373
374 return -ETIMEDOUT;
375}
376
377static int i801_get_block_len(struct i801_priv *priv)
378{
379 u8 len = ioread8(SMBHSTDAT0(priv));
380
381 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX) {
382 pci_err(priv->pci_dev, "Illegal SMBus block read size %u\n", len);
383 return -EPROTO;
384 }
385
386 return len;
387}
388
389static int i801_check_and_clear_pec_error(struct i801_priv *priv)
390{
391 u8 status;
392
393 if (!(priv->features & FEATURE_SMBUS_PEC))
394 return 0;
395
396 status = ioread8(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE;
397 if (status) {
398 iowrite8(status, SMBAUXSTS(priv));
399 return -EBADMSG;
400 }
401
402 return 0;
403}
404
405/* Make sure the SMBus host is ready to start transmitting.
406 Return 0 if it is, -EBUSY if it is not. */
407static int i801_check_pre(struct i801_priv *priv)
408{
409 int status, result;
410
411 status = ioread8(SMBHSTSTS(priv));
412 if (status & SMBHSTSTS_HOST_BUSY) {
413 pci_err(priv->pci_dev, "SMBus is busy, can't use it!\n");
414 return -EBUSY;
415 }
416
417 status &= STATUS_FLAGS;
418 if (status) {
419 pci_dbg(priv->pci_dev, "Clearing status flags (%02x)\n", status);
420 iowrite8(status, SMBHSTSTS(priv));
421 }
422
423 /*
424 * Clear CRC status if needed.
425 * During normal operation, i801_check_post() takes care
426 * of it after every operation. We do it here only in case
427 * the hardware was already in this state when the driver
428 * started.
429 */
430 result = i801_check_and_clear_pec_error(priv);
431 if (result)
432 pci_dbg(priv->pci_dev, "Clearing aux status flag CRCE\n");
433
434 return 0;
435}
436
437static int i801_check_post(struct i801_priv *priv, int status)
438{
439 int result = 0;
440
441 /*
442 * If the SMBus is still busy, we give up
443 */
444 if (unlikely(status < 0)) {
445 /* try to stop the current command */
446 iowrite8(SMBHSTCNT_KILL, SMBHSTCNT(priv));
447 status = i801_wait_intr(priv);
448 iowrite8(0, SMBHSTCNT(priv));
449
450 /* Check if it worked */
451 if (status < 0 || !(status & SMBHSTSTS_FAILED))
452 pci_dbg(priv->pci_dev, "Failed terminating the transaction\n");
453 return -ETIMEDOUT;
454 }
455
456 if (status & SMBHSTSTS_FAILED) {
457 result = -EIO;
458 pci_err(priv->pci_dev, "Transaction failed\n");
459 }
460 if (status & SMBHSTSTS_DEV_ERR) {
461 /*
462 * This may be a PEC error, check and clear it.
463 *
464 * AUXSTS is handled differently from HSTSTS.
465 * For HSTSTS, i801_isr() or i801_wait_intr()
466 * has already cleared the error bits in hardware,
467 * and we are passed a copy of the original value
468 * in "status".
469 * For AUXSTS, the hardware register is left
470 * for us to handle here.
471 * This is asymmetric, slightly iffy, but safe,
472 * since all this code is serialized and the CRCE
473 * bit is harmless as long as it's cleared before
474 * the next operation.
475 */
476 result = i801_check_and_clear_pec_error(priv);
477 if (result) {
478 pci_dbg(priv->pci_dev, "PEC error\n");
479 } else {
480 result = -ENXIO;
481 pci_dbg(priv->pci_dev, "No response\n");
482 }
483 }
484 if (status & SMBHSTSTS_BUS_ERR) {
485 result = -EAGAIN;
486 pci_dbg(priv->pci_dev, "Lost arbitration\n");
487 }
488
489 return result;
490}
491
492static int i801_transaction(struct i801_priv *priv, int xact)
493{
494 unsigned long result;
495 const struct i2c_adapter *adap = &priv->adapter;
496
497 if (priv->features & FEATURE_IRQ) {
498 reinit_completion(x: &priv->done);
499 iowrite8(xact | SMBHSTCNT_INTREN | SMBHSTCNT_START,
500 SMBHSTCNT(priv));
501 result = wait_for_completion_timeout(x: &priv->done, timeout: adap->timeout);
502 return result ? priv->status : -ETIMEDOUT;
503 }
504
505 iowrite8(xact | SMBHSTCNT_START, SMBHSTCNT(priv));
506
507 return i801_wait_intr(priv);
508}
509
510static int i801_block_transaction_by_block(struct i801_priv *priv,
511 union i2c_smbus_data *data,
512 char read_write, int command)
513{
514 int len, status, xact;
515
516 switch (command) {
517 case I2C_SMBUS_BLOCK_PROC_CALL:
518 xact = I801_BLOCK_PROC_CALL;
519 break;
520 case I2C_SMBUS_BLOCK_DATA:
521 xact = I801_BLOCK_DATA;
522 break;
523 default:
524 return -EOPNOTSUPP;
525 }
526
527 /* Set block buffer mode */
528 iowrite8(ioread8(SMBAUXCTL(priv)) | SMBAUXCTL_E32B, SMBAUXCTL(priv));
529
530 if (read_write == I2C_SMBUS_WRITE) {
531 len = data->block[0];
532 iowrite8(len, SMBHSTDAT0(priv));
533 ioread8(SMBHSTCNT(priv)); /* reset the data buffer index */
534 iowrite8_rep(SMBBLKDAT(priv), buf: data->block + 1, count: len);
535 }
536
537 status = i801_transaction(priv, xact);
538 if (status)
539 goto out;
540
541 if (read_write == I2C_SMBUS_READ ||
542 command == I2C_SMBUS_BLOCK_PROC_CALL) {
543 len = i801_get_block_len(priv);
544 if (len < 0) {
545 status = len;
546 goto out;
547 }
548
549 data->block[0] = len;
550 ioread8(SMBHSTCNT(priv)); /* reset the data buffer index */
551 ioread8_rep(SMBBLKDAT(priv), buf: data->block + 1, count: len);
552 }
553out:
554 iowrite8(ioread8(SMBAUXCTL(priv)) & ~SMBAUXCTL_E32B, SMBAUXCTL(priv));
555 return status;
556}
557
558static void i801_isr_byte_done(struct i801_priv *priv)
559{
560 if (priv->is_read) {
561 /*
562 * At transfer start i801_smbus_block_transaction() marks
563 * the block length as invalid. Check for this sentinel value
564 * and read the block length from SMBHSTDAT0.
565 */
566 if (priv->len == SMBUS_LEN_SENTINEL) {
567 priv->len = i801_get_block_len(priv);
568 if (priv->len < 0)
569 /* FIXME: Recover */
570 priv->len = I2C_SMBUS_BLOCK_MAX;
571
572 priv->data[-1] = priv->len;
573 }
574
575 /* Read next byte */
576 if (priv->count < priv->len)
577 priv->data[priv->count++] = ioread8(SMBBLKDAT(priv));
578 else
579 pci_dbg(priv->pci_dev, "Discarding extra byte on block read\n");
580
581 /* Set LAST_BYTE for last byte of read transaction */
582 if (priv->count == priv->len - 1)
583 iowrite8(priv->cmd | SMBHSTCNT_LAST_BYTE,
584 SMBHSTCNT(priv));
585 } else if (priv->count < priv->len - 1) {
586 /* Write next byte, except for IRQ after last byte */
587 iowrite8(priv->data[++priv->count], SMBBLKDAT(priv));
588 }
589}
590
591static irqreturn_t i801_host_notify_isr(struct i801_priv *priv)
592{
593 unsigned short addr;
594
595 addr = ioread8(SMBNTFDADD(priv)) >> 1;
596
597 /*
598 * With the tested platforms, reading SMBNTFDDAT (22 + (p)->smba)
599 * always returns 0. Our current implementation doesn't provide
600 * data, so we just ignore it.
601 */
602 i2c_handle_smbus_host_notify(adap: &priv->adapter, addr);
603
604 /* clear Host Notify bit and return */
605 iowrite8(SMBSLVSTS_HST_NTFY_STS, SMBSLVSTS(priv));
606 return IRQ_HANDLED;
607}
608
609/*
610 * There are three kinds of interrupts:
611 *
612 * 1) i801 signals transaction completion with one of these interrupts:
613 * INTR - Success
614 * DEV_ERR - Invalid command, NAK or communication timeout
615 * BUS_ERR - SMI# transaction collision
616 * FAILED - transaction was canceled due to a KILL request
617 * When any of these occur, update ->status and signal completion.
618 *
619 * 2) For byte-by-byte (I2C read/write) transactions, one BYTE_DONE interrupt
620 * occurs for each byte of a byte-by-byte to prepare the next byte.
621 *
622 * 3) Host Notify interrupts
623 */
624static irqreturn_t i801_isr(int irq, void *dev_id)
625{
626 struct i801_priv *priv = dev_id;
627 u16 pcists;
628 u8 status;
629
630 /* Confirm this is our interrupt */
631 pci_read_config_word(dev: priv->pci_dev, PCI_STATUS, val: &pcists);
632 if (!(pcists & PCI_STATUS_INTERRUPT))
633 return IRQ_NONE;
634
635 if (priv->features & FEATURE_HOST_NOTIFY) {
636 status = ioread8(SMBSLVSTS(priv));
637 if (status & SMBSLVSTS_HST_NTFY_STS)
638 return i801_host_notify_isr(priv);
639 }
640
641 status = ioread8(SMBHSTSTS(priv));
642 if ((status & (SMBHSTSTS_BYTE_DONE | STATUS_ERROR_FLAGS)) == SMBHSTSTS_BYTE_DONE)
643 i801_isr_byte_done(priv);
644
645 /*
646 * Clear IRQ sources: SMB_ALERT status is set after signal assertion
647 * independently of the interrupt generation being blocked or not
648 * so clear it always when the status is set.
649 */
650 status &= STATUS_FLAGS | SMBHSTSTS_SMBALERT_STS;
651 iowrite8(status, SMBHSTSTS(priv));
652
653 status &= STATUS_ERROR_FLAGS | SMBHSTSTS_INTR;
654 if (status) {
655 priv->status = status & STATUS_ERROR_FLAGS;
656 complete(&priv->done);
657 }
658
659 return IRQ_HANDLED;
660}
661
662/*
663 * For "byte-by-byte" block transactions:
664 * I2C write uses cmd=I801_BLOCK_DATA, I2C_EN=1
665 * I2C read uses cmd=I801_I2C_BLOCK_DATA
666 */
667static int i801_block_transaction_byte_by_byte(struct i801_priv *priv,
668 union i2c_smbus_data *data,
669 char read_write, int command)
670{
671 int i, len;
672 int smbcmd;
673 int status;
674 unsigned long result;
675 const struct i2c_adapter *adap = &priv->adapter;
676
677 if (command == I2C_SMBUS_BLOCK_PROC_CALL)
678 return -EOPNOTSUPP;
679
680 len = data->block[0];
681
682 if (read_write == I2C_SMBUS_WRITE) {
683 iowrite8(len, SMBHSTDAT0(priv));
684 iowrite8(data->block[1], SMBBLKDAT(priv));
685 }
686
687 if (command == I2C_SMBUS_I2C_BLOCK_DATA &&
688 read_write == I2C_SMBUS_READ)
689 smbcmd = I801_I2C_BLOCK_DATA;
690 else
691 smbcmd = I801_BLOCK_DATA;
692
693 if (priv->features & FEATURE_IRQ) {
694 priv->is_read = (read_write == I2C_SMBUS_READ);
695 if (len == 1 && priv->is_read)
696 smbcmd |= SMBHSTCNT_LAST_BYTE;
697 priv->cmd = smbcmd | SMBHSTCNT_INTREN;
698 priv->len = len;
699 priv->count = 0;
700 priv->data = &data->block[1];
701
702 reinit_completion(x: &priv->done);
703 iowrite8(priv->cmd | SMBHSTCNT_START, SMBHSTCNT(priv));
704 result = wait_for_completion_timeout(x: &priv->done, timeout: adap->timeout);
705 return result ? priv->status : -ETIMEDOUT;
706 }
707
708 if (len == 1 && read_write == I2C_SMBUS_READ)
709 smbcmd |= SMBHSTCNT_LAST_BYTE;
710 iowrite8(smbcmd | SMBHSTCNT_START, SMBHSTCNT(priv));
711
712 for (i = 1; i <= len; i++) {
713 status = i801_wait_byte_done(priv);
714 if (status)
715 return status;
716
717 /*
718 * At transfer start i801_smbus_block_transaction() marks
719 * the block length as invalid. Check for this sentinel value
720 * and read the block length from SMBHSTDAT0.
721 */
722 if (len == SMBUS_LEN_SENTINEL) {
723 len = i801_get_block_len(priv);
724 if (len < 0) {
725 /* Recover */
726 while (ioread8(SMBHSTSTS(priv)) &
727 SMBHSTSTS_HOST_BUSY)
728 iowrite8(SMBHSTSTS_BYTE_DONE,
729 SMBHSTSTS(priv));
730 iowrite8(SMBHSTSTS_INTR, SMBHSTSTS(priv));
731 return -EPROTO;
732 }
733 data->block[0] = len;
734 }
735
736 if (read_write == I2C_SMBUS_READ) {
737 data->block[i] = ioread8(SMBBLKDAT(priv));
738 if (i == len - 1)
739 iowrite8(smbcmd | SMBHSTCNT_LAST_BYTE, SMBHSTCNT(priv));
740 }
741
742 if (read_write == I2C_SMBUS_WRITE && i+1 <= len)
743 iowrite8(data->block[i+1], SMBBLKDAT(priv));
744
745 /* signals SMBBLKDAT ready */
746 iowrite8(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
747 }
748
749 return i801_wait_intr(priv);
750}
751
752static void i801_set_hstadd(struct i801_priv *priv, u8 addr, char read_write)
753{
754 iowrite8((addr << 1) | (read_write & 0x01), SMBHSTADD(priv));
755}
756
757/* Single value transaction function */
758static int i801_simple_transaction(struct i801_priv *priv, union i2c_smbus_data *data,
759 u8 addr, u8 hstcmd, char read_write, int command)
760{
761 int xact, ret;
762
763 switch (command) {
764 case I2C_SMBUS_QUICK:
765 i801_set_hstadd(priv, addr, read_write);
766 xact = I801_QUICK;
767 break;
768 case I2C_SMBUS_BYTE:
769 i801_set_hstadd(priv, addr, read_write);
770 if (read_write == I2C_SMBUS_WRITE)
771 iowrite8(hstcmd, SMBHSTCMD(priv));
772 xact = I801_BYTE;
773 break;
774 case I2C_SMBUS_BYTE_DATA:
775 i801_set_hstadd(priv, addr, read_write);
776 if (read_write == I2C_SMBUS_WRITE)
777 iowrite8(data->byte, SMBHSTDAT0(priv));
778 iowrite8(hstcmd, SMBHSTCMD(priv));
779 xact = I801_BYTE_DATA;
780 break;
781 case I2C_SMBUS_WORD_DATA:
782 i801_set_hstadd(priv, addr, read_write);
783 if (read_write == I2C_SMBUS_WRITE) {
784 iowrite8(data->word & 0xff, SMBHSTDAT0(priv));
785 iowrite8((data->word & 0xff00) >> 8, SMBHSTDAT1(priv));
786 }
787 iowrite8(hstcmd, SMBHSTCMD(priv));
788 xact = I801_WORD_DATA;
789 break;
790 case I2C_SMBUS_PROC_CALL:
791 i801_set_hstadd(priv, addr, I2C_SMBUS_WRITE);
792 iowrite8(data->word & 0xff, SMBHSTDAT0(priv));
793 iowrite8((data->word & 0xff00) >> 8, SMBHSTDAT1(priv));
794 iowrite8(hstcmd, SMBHSTCMD(priv));
795 read_write = I2C_SMBUS_READ;
796 xact = I801_PROC_CALL;
797 break;
798 default:
799 pci_err(priv->pci_dev, "Unsupported transaction %d\n", command);
800 return -EOPNOTSUPP;
801 }
802
803 ret = i801_transaction(priv, xact);
804 if (ret || read_write == I2C_SMBUS_WRITE)
805 return ret;
806
807 switch (command) {
808 case I2C_SMBUS_BYTE:
809 case I2C_SMBUS_BYTE_DATA:
810 data->byte = ioread8(SMBHSTDAT0(priv));
811 break;
812 case I2C_SMBUS_WORD_DATA:
813 case I2C_SMBUS_PROC_CALL:
814 data->word = ioread8(SMBHSTDAT0(priv)) +
815 (ioread8(SMBHSTDAT1(priv)) << 8);
816 break;
817 }
818
819 return 0;
820}
821
822static int i801_smbus_block_transaction(struct i801_priv *priv, union i2c_smbus_data *data,
823 u8 addr, u8 hstcmd, char read_write, int command)
824{
825 if (read_write == I2C_SMBUS_READ && command == I2C_SMBUS_BLOCK_DATA)
826 /* Mark block length as invalid */
827 data->block[0] = SMBUS_LEN_SENTINEL;
828 else if (data->block[0] < 1 || data->block[0] > I2C_SMBUS_BLOCK_MAX)
829 return -EPROTO;
830
831 if (command == I2C_SMBUS_BLOCK_PROC_CALL)
832 /* Needs to be flagged as write transaction */
833 i801_set_hstadd(priv, addr, I2C_SMBUS_WRITE);
834 else
835 i801_set_hstadd(priv, addr, read_write);
836 iowrite8(hstcmd, SMBHSTCMD(priv));
837
838 if (priv->features & FEATURE_BLOCK_BUFFER)
839 return i801_block_transaction_by_block(priv, data, read_write, command);
840 else
841 return i801_block_transaction_byte_by_byte(priv, data, read_write, command);
842}
843
844static int i801_i2c_block_transaction(struct i801_priv *priv, union i2c_smbus_data *data,
845 u8 addr, u8 hstcmd, char read_write, int command)
846{
847 int result;
848 u8 hostc;
849
850 if (data->block[0] < 1 || data->block[0] > I2C_SMBUS_BLOCK_MAX)
851 return -EPROTO;
852 /*
853 * NB: page 240 of ICH5 datasheet shows that the R/#W bit should be cleared here,
854 * even when reading. However if SPD Write Disable is set (Lynx Point and later),
855 * the read will fail if we don't set the R/#W bit.
856 */
857 i801_set_hstadd(priv, addr,
858 read_write: priv->original_hstcfg & SMBHSTCFG_SPD_WD ? read_write : I2C_SMBUS_WRITE);
859
860 /* NB: page 240 of ICH5 datasheet shows that DATA1 is the cmd field when reading */
861 if (read_write == I2C_SMBUS_READ)
862 iowrite8(hstcmd, SMBHSTDAT1(priv));
863 else
864 iowrite8(hstcmd, SMBHSTCMD(priv));
865
866 if (read_write == I2C_SMBUS_WRITE) {
867 /* set I2C_EN bit in configuration register */
868 pci_read_config_byte(dev: priv->pci_dev, SMBHSTCFG, val: &hostc);
869 pci_write_config_byte(dev: priv->pci_dev, SMBHSTCFG, val: hostc | SMBHSTCFG_I2C_EN);
870 } else if (!(priv->features & FEATURE_I2C_BLOCK_READ)) {
871 pci_err(priv->pci_dev, "I2C block read is unsupported!\n");
872 return -EOPNOTSUPP;
873 }
874
875 /* Block buffer isn't supported for I2C block transactions */
876 result = i801_block_transaction_byte_by_byte(priv, data, read_write, command);
877
878 /* restore saved configuration register value */
879 if (read_write == I2C_SMBUS_WRITE)
880 pci_write_config_byte(dev: priv->pci_dev, SMBHSTCFG, val: hostc);
881
882 return result;
883}
884
885/* Return negative errno on error. */
886static s32 i801_access(struct i2c_adapter *adap, u16 addr,
887 unsigned short flags, char read_write, u8 command,
888 int size, union i2c_smbus_data *data)
889{
890 int hwpec, ret;
891 struct i801_priv *priv = i2c_get_adapdata(adap);
892
893 if (priv->acpi_reserved)
894 return -EBUSY;
895
896 pm_runtime_get_sync(dev: &priv->pci_dev->dev);
897
898 ret = i801_check_pre(priv);
899 if (ret)
900 goto out;
901
902 hwpec = (priv->features & FEATURE_SMBUS_PEC) && (flags & I2C_CLIENT_PEC)
903 && size != I2C_SMBUS_QUICK
904 && size != I2C_SMBUS_I2C_BLOCK_DATA;
905
906 if (hwpec) /* enable/disable hardware PEC */
907 iowrite8(ioread8(SMBAUXCTL(priv)) | SMBAUXCTL_CRC, SMBAUXCTL(priv));
908 else
909 iowrite8(ioread8(SMBAUXCTL(priv)) & (~SMBAUXCTL_CRC),
910 SMBAUXCTL(priv));
911
912 if (size == I2C_SMBUS_BLOCK_DATA || size == I2C_SMBUS_BLOCK_PROC_CALL)
913 ret = i801_smbus_block_transaction(priv, data, addr, hstcmd: command, read_write, command: size);
914 else if (size == I2C_SMBUS_I2C_BLOCK_DATA)
915 ret = i801_i2c_block_transaction(priv, data, addr, hstcmd: command, read_write, command: size);
916 else
917 ret = i801_simple_transaction(priv, data, addr, hstcmd: command, read_write, command: size);
918
919 ret = i801_check_post(priv, status: ret);
920
921 /* Some BIOSes don't like it when PEC is enabled at reboot or resume
922 * time, so we forcibly disable it after every transaction.
923 */
924 if (hwpec)
925 iowrite8(ioread8(SMBAUXCTL(priv)) & ~SMBAUXCTL_CRC, SMBAUXCTL(priv));
926out:
927 /*
928 * Unlock the SMBus device for use by BIOS/ACPI,
929 * and clear status flags if not done already.
930 */
931 iowrite8(SMBHSTSTS_INUSE_STS | STATUS_FLAGS, SMBHSTSTS(priv));
932
933 pm_runtime_mark_last_busy(dev: &priv->pci_dev->dev);
934 pm_runtime_put_autosuspend(dev: &priv->pci_dev->dev);
935 return ret;
936}
937
938
939static u32 i801_func(struct i2c_adapter *adapter)
940{
941 struct i801_priv *priv = i2c_get_adapdata(adap: adapter);
942
943 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
944 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
945 I2C_FUNC_SMBUS_PROC_CALL |
946 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK |
947 ((priv->features & FEATURE_SMBUS_PEC) ? I2C_FUNC_SMBUS_PEC : 0) |
948 ((priv->features & FEATURE_BLOCK_PROC) ?
949 I2C_FUNC_SMBUS_BLOCK_PROC_CALL : 0) |
950 ((priv->features & FEATURE_I2C_BLOCK_READ) ?
951 I2C_FUNC_SMBUS_READ_I2C_BLOCK : 0) |
952 ((priv->features & FEATURE_HOST_NOTIFY) ?
953 I2C_FUNC_SMBUS_HOST_NOTIFY : 0);
954}
955
956static void i801_enable_host_notify(struct i2c_adapter *adapter)
957{
958 struct i801_priv *priv = i2c_get_adapdata(adap: adapter);
959
960 if (!(priv->features & FEATURE_HOST_NOTIFY))
961 return;
962
963 /*
964 * Enable host notify interrupt and block the generation of interrupt
965 * from the SMB_ALERT signal because the driver does not support
966 * SMBus Alert.
967 */
968 iowrite8(SMBSLVCMD_HST_NTFY_INTREN | SMBSLVCMD_SMBALERT_DISABLE |
969 priv->original_slvcmd, SMBSLVCMD(priv));
970
971 /* clear Host Notify bit to allow a new notification */
972 iowrite8(SMBSLVSTS_HST_NTFY_STS, SMBSLVSTS(priv));
973}
974
975static void i801_disable_host_notify(struct i801_priv *priv)
976{
977 if (!(priv->features & FEATURE_HOST_NOTIFY))
978 return;
979
980 iowrite8(priv->original_slvcmd, SMBSLVCMD(priv));
981}
982
983static const struct i2c_algorithm smbus_algorithm = {
984 .smbus_xfer = i801_access,
985 .functionality = i801_func,
986};
987
988#define FEATURES_ICH4 (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER | \
989 FEATURE_HOST_NOTIFY)
990#define FEATURES_ICH5 (FEATURES_ICH4 | FEATURE_BLOCK_PROC | \
991 FEATURE_I2C_BLOCK_READ | FEATURE_IRQ)
992
993static 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 { PCI_DEVICE_DATA(INTEL, METEOR_LAKE_SOC_S_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1056 { PCI_DEVICE_DATA(INTEL, METEOR_LAKE_PCH_S_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1057 { PCI_DEVICE_DATA(INTEL, BIRCH_STREAM_SMBUS, FEATURES_ICH5) },
1058 { PCI_DEVICE_DATA(INTEL, ARROW_LAKE_H_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1059 { PCI_DEVICE_DATA(INTEL, PANTHER_LAKE_H_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1060 { PCI_DEVICE_DATA(INTEL, PANTHER_LAKE_P_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1061 { PCI_DEVICE_DATA(INTEL, WILDCAT_LAKE_U_SMBUS, FEATURES_ICH5 | FEATURE_TCO_CNL) },
1062 { 0, }
1063};
1064
1065MODULE_DEVICE_TABLE(pci, i801_ids);
1066
1067#if defined CONFIG_X86 && defined CONFIG_DMI
1068static unsigned char apanel_addr __ro_after_init;
1069
1070/* Scan the system ROM for the signature "FJKEYINF" */
1071static __init const void __iomem *bios_signature(const void __iomem *bios)
1072{
1073 ssize_t offset;
1074 const unsigned char signature[] = "FJKEYINF";
1075
1076 for (offset = 0; offset < 0x10000; offset += 0x10) {
1077 if (check_signature(io_addr: bios + offset, signature,
1078 length: sizeof(signature)-1))
1079 return bios + offset;
1080 }
1081 return NULL;
1082}
1083
1084static void __init input_apanel_init(void)
1085{
1086 void __iomem *bios;
1087 const void __iomem *p;
1088
1089 bios = ioremap(offset: 0xF0000, size: 0x10000); /* Can't fail */
1090 p = bios_signature(bios);
1091 if (p) {
1092 /* just use the first address */
1093 apanel_addr = readb(addr: p + 8 + 3) >> 1;
1094 }
1095 iounmap(addr: bios);
1096}
1097
1098struct dmi_onboard_device_info {
1099 const char *name;
1100 u8 type;
1101 unsigned short i2c_addr;
1102 const char *i2c_type;
1103};
1104
1105static const struct dmi_onboard_device_info dmi_devices[] = {
1106 { "Syleus", DMI_DEV_TYPE_OTHER, 0x73, "fscsyl" },
1107 { "Hermes", DMI_DEV_TYPE_OTHER, 0x73, "fscher" },
1108 { "Hades", DMI_DEV_TYPE_OTHER, 0x73, "fschds" },
1109};
1110
1111static void dmi_check_onboard_device(u8 type, const char *name,
1112 struct i2c_adapter *adap)
1113{
1114 int i;
1115 struct i2c_board_info info;
1116
1117 for (i = 0; i < ARRAY_SIZE(dmi_devices); i++) {
1118 /* & ~0x80, ignore enabled/disabled bit */
1119 if ((type & ~0x80) != dmi_devices[i].type)
1120 continue;
1121 if (strcasecmp(s1: name, s2: dmi_devices[i].name))
1122 continue;
1123
1124 memset(s: &info, c: 0, n: sizeof(struct i2c_board_info));
1125 info.addr = dmi_devices[i].i2c_addr;
1126 strscpy(info.type, dmi_devices[i].i2c_type, I2C_NAME_SIZE);
1127 i2c_new_client_device(adap, info: &info);
1128 break;
1129 }
1130}
1131
1132/* We use our own function to check for onboard devices instead of
1133 dmi_find_device() as some buggy BIOS's have the devices we are interested
1134 in marked as disabled */
1135static void dmi_check_onboard_devices(const struct dmi_header *dm, void *adap)
1136{
1137 int i, count;
1138
1139 if (dm->type != DMI_ENTRY_ONBOARD_DEVICE)
1140 return;
1141
1142 count = (dm->length - sizeof(struct dmi_header)) / 2;
1143 for (i = 0; i < count; i++) {
1144 const u8 *d = (char *)(dm + 1) + (i * 2);
1145 const char *name = ((char *) dm) + dm->length;
1146 u8 type = d[0];
1147 u8 s = d[1];
1148
1149 if (!s)
1150 continue;
1151 s--;
1152 while (s > 0 && name[0]) {
1153 name += strlen(name) + 1;
1154 s--;
1155 }
1156 if (name[0] == 0) /* Bogus string reference */
1157 continue;
1158
1159 dmi_check_onboard_device(type, name, adap);
1160 }
1161}
1162
1163/* Register optional targets */
1164static void i801_probe_optional_targets(struct i801_priv *priv)
1165{
1166 /* Only register targets on main SMBus channel */
1167 if (priv->features & FEATURE_IDF)
1168 return;
1169
1170 if (apanel_addr) {
1171 struct i2c_board_info info = {
1172 .addr = apanel_addr,
1173 .type = "fujitsu_apanel",
1174 };
1175
1176 i2c_new_client_device(adap: &priv->adapter, info: &info);
1177 }
1178
1179 if (dmi_name_in_vendors(str: "FUJITSU"))
1180 dmi_walk(decode: dmi_check_onboard_devices, private_data: &priv->adapter);
1181
1182 /* Instantiate SPD EEPROMs unless the SMBus is multiplexed */
1183#ifdef CONFIG_I2C_I801_MUX
1184 if (!priv->mux_pdev)
1185#endif
1186 i2c_register_spd_write_enable(adap: &priv->adapter);
1187}
1188#else
1189static void __init input_apanel_init(void) {}
1190static void i801_probe_optional_targets(struct i801_priv *priv) {}
1191#endif /* CONFIG_X86 && CONFIG_DMI */
1192
1193#ifdef CONFIG_I2C_I801_MUX
1194static struct i801_mux_config i801_mux_config_asus_z8_d12 = {
1195 .gpio_chip = "gpio_ich",
1196 .values = { 0x02, 0x03 },
1197 .n_values = 2,
1198 .gpios = { 52, 53 },
1199 .n_gpios = 2,
1200};
1201
1202static struct i801_mux_config i801_mux_config_asus_z8_d18 = {
1203 .gpio_chip = "gpio_ich",
1204 .values = { 0x02, 0x03, 0x01 },
1205 .n_values = 3,
1206 .gpios = { 52, 53 },
1207 .n_gpios = 2,
1208};
1209
1210static const struct dmi_system_id mux_dmi_table[] = {
1211 {
1212 .matches = {
1213 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1214 DMI_MATCH(DMI_BOARD_NAME, "Z8NA-D6(C)"),
1215 },
1216 .driver_data = &i801_mux_config_asus_z8_d12,
1217 },
1218 {
1219 .matches = {
1220 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1221 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)E-D12(X)"),
1222 },
1223 .driver_data = &i801_mux_config_asus_z8_d12,
1224 },
1225 {
1226 .matches = {
1227 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1228 DMI_MATCH(DMI_BOARD_NAME, "Z8NH-D12"),
1229 },
1230 .driver_data = &i801_mux_config_asus_z8_d12,
1231 },
1232 {
1233 .matches = {
1234 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1235 DMI_MATCH(DMI_BOARD_NAME, "Z8PH-D12/IFB"),
1236 },
1237 .driver_data = &i801_mux_config_asus_z8_d12,
1238 },
1239 {
1240 .matches = {
1241 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1242 DMI_MATCH(DMI_BOARD_NAME, "Z8NR-D12"),
1243 },
1244 .driver_data = &i801_mux_config_asus_z8_d12,
1245 },
1246 {
1247 .matches = {
1248 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1249 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)H-D12"),
1250 },
1251 .driver_data = &i801_mux_config_asus_z8_d12,
1252 },
1253 {
1254 .matches = {
1255 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1256 DMI_MATCH(DMI_BOARD_NAME, "Z8PG-D18"),
1257 },
1258 .driver_data = &i801_mux_config_asus_z8_d18,
1259 },
1260 {
1261 .matches = {
1262 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1263 DMI_MATCH(DMI_BOARD_NAME, "Z8PE-D18"),
1264 },
1265 .driver_data = &i801_mux_config_asus_z8_d18,
1266 },
1267 {
1268 .matches = {
1269 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1270 DMI_MATCH(DMI_BOARD_NAME, "Z8PS-D12"),
1271 },
1272 .driver_data = &i801_mux_config_asus_z8_d12,
1273 },
1274 { }
1275};
1276
1277static int i801_notifier_call(struct notifier_block *nb, unsigned long action,
1278 void *data)
1279{
1280 struct i801_priv *priv = container_of(nb, struct i801_priv, mux_notifier_block);
1281 struct device *dev = data;
1282
1283 if (action != BUS_NOTIFY_ADD_DEVICE ||
1284 dev->type != &i2c_adapter_type ||
1285 i2c_root_adapter(dev) != &priv->adapter)
1286 return NOTIFY_DONE;
1287
1288 /* Call i2c_register_spd for muxed child segments */
1289 i2c_register_spd_write_enable(to_i2c_adapter(dev));
1290
1291 return NOTIFY_OK;
1292}
1293
1294/* Setup multiplexing if needed */
1295static void i801_add_mux(struct i801_priv *priv)
1296{
1297 struct device *dev = &priv->adapter.dev;
1298 const struct i801_mux_config *mux_config;
1299 struct i2c_mux_gpio_platform_data gpio_data;
1300 struct gpiod_lookup_table *lookup;
1301 const struct dmi_system_id *id;
1302 int i;
1303
1304 id = dmi_first_match(mux_dmi_table);
1305 if (!id)
1306 return;
1307
1308 mux_config = id->driver_data;
1309
1310 /* Prepare the platform data */
1311 memset(&gpio_data, 0, sizeof(struct i2c_mux_gpio_platform_data));
1312 gpio_data.parent = priv->adapter.nr;
1313 gpio_data.values = mux_config->values;
1314 gpio_data.n_values = mux_config->n_values;
1315 gpio_data.idle = I2C_MUX_GPIO_NO_IDLE;
1316
1317 /* Register GPIO descriptor lookup table */
1318 lookup = devm_kzalloc(dev,
1319 struct_size(lookup, table, mux_config->n_gpios + 1),
1320 GFP_KERNEL);
1321 if (!lookup)
1322 return;
1323 lookup->dev_id = "i2c-mux-gpio";
1324 for (i = 0; i < mux_config->n_gpios; i++)
1325 lookup->table[i] = GPIO_LOOKUP(mux_config->gpio_chip,
1326 mux_config->gpios[i], "mux", 0);
1327 gpiod_add_lookup_table(lookup);
1328
1329 priv->mux_notifier_block.notifier_call = i801_notifier_call;
1330 if (bus_register_notifier(&i2c_bus_type, &priv->mux_notifier_block))
1331 return;
1332 /*
1333 * Register the mux device, we use PLATFORM_DEVID_NONE here
1334 * because since we are referring to the GPIO chip by name we are
1335 * anyways in deep trouble if there is more than one of these
1336 * devices, and there should likely only be one platform controller
1337 * hub.
1338 */
1339 priv->mux_pdev = platform_device_register_data(dev, "i2c-mux-gpio",
1340 PLATFORM_DEVID_NONE, &gpio_data,
1341 sizeof(struct i2c_mux_gpio_platform_data));
1342 if (IS_ERR(priv->mux_pdev)) {
1343 gpiod_remove_lookup_table(lookup);
1344 devm_kfree(dev, lookup);
1345 dev_err(dev, "Failed to register i2c-mux-gpio device\n");
1346 } else {
1347 priv->lookup = lookup;
1348 }
1349}
1350
1351static void i801_del_mux(struct i801_priv *priv)
1352{
1353 bus_unregister_notifier(&i2c_bus_type, &priv->mux_notifier_block);
1354 platform_device_unregister(priv->mux_pdev);
1355 gpiod_remove_lookup_table(priv->lookup);
1356}
1357#else
1358static inline void i801_add_mux(struct i801_priv *priv) { }
1359static inline void i801_del_mux(struct i801_priv *priv) { }
1360#endif
1361
1362static struct platform_device *
1363i801_add_tco_spt(struct pci_dev *pci_dev, struct resource *tco_res)
1364{
1365 static const struct itco_wdt_platform_data pldata = {
1366 .name = "Intel PCH",
1367 .version = 4,
1368 };
1369 struct resource *res;
1370 int ret;
1371
1372 /*
1373 * We must access the NO_REBOOT bit over the Primary to Sideband
1374 * (P2SB) bridge.
1375 */
1376
1377 res = &tco_res[1];
1378 ret = p2sb_bar(bus: pci_dev->bus, devfn: 0, mem: res);
1379 if (ret)
1380 return ERR_PTR(error: ret);
1381
1382 if (pci_dev->device == PCI_DEVICE_ID_INTEL_DNV_SMBUS)
1383 res->start += SBREG_SMBCTRL_DNV;
1384 else
1385 res->start += SBREG_SMBCTRL;
1386
1387 res->end = res->start + 3;
1388
1389 return platform_device_register_resndata(parent: &pci_dev->dev, name: "iTCO_wdt", id: -1,
1390 res: tco_res, num: 2, data: &pldata, size: sizeof(pldata));
1391}
1392
1393static struct platform_device *
1394i801_add_tco_cnl(struct pci_dev *pci_dev, struct resource *tco_res)
1395{
1396 static const struct itco_wdt_platform_data pldata = {
1397 .name = "Intel PCH",
1398 .version = 6,
1399 };
1400
1401 return platform_device_register_resndata(parent: &pci_dev->dev, name: "iTCO_wdt", id: -1,
1402 res: tco_res, num: 1, data: &pldata, size: sizeof(pldata));
1403}
1404
1405static void i801_add_tco(struct i801_priv *priv)
1406{
1407 struct pci_dev *pci_dev = priv->pci_dev;
1408 struct resource tco_res[2], *res;
1409 u32 tco_base, tco_ctl;
1410
1411 /* If we have ACPI based watchdog use that instead */
1412 if (acpi_has_watchdog())
1413 return;
1414
1415 if (!(priv->features & (FEATURE_TCO_SPT | FEATURE_TCO_CNL)))
1416 return;
1417
1418 pci_read_config_dword(dev: pci_dev, TCOBASE, val: &tco_base);
1419 pci_read_config_dword(dev: pci_dev, TCOCTL, val: &tco_ctl);
1420 if (!(tco_ctl & TCOCTL_EN))
1421 return;
1422
1423 memset(s: tco_res, c: 0, n: sizeof(tco_res));
1424 /*
1425 * Always populate the main iTCO IO resource here. The second entry
1426 * for NO_REBOOT MMIO is filled by the SPT specific function.
1427 */
1428 res = &tco_res[0];
1429 res->start = tco_base & ~1;
1430 res->end = res->start + 32 - 1;
1431 res->flags = IORESOURCE_IO;
1432
1433 if (priv->features & FEATURE_TCO_CNL)
1434 priv->tco_pdev = i801_add_tco_cnl(pci_dev, tco_res);
1435 else
1436 priv->tco_pdev = i801_add_tco_spt(pci_dev, tco_res);
1437
1438 if (IS_ERR(ptr: priv->tco_pdev))
1439 pci_warn(pci_dev, "failed to create iTCO device\n");
1440}
1441
1442#ifdef CONFIG_ACPI
1443static bool i801_acpi_is_smbus_ioport(const struct i801_priv *priv,
1444 acpi_physical_address address)
1445{
1446 return address >= pci_resource_start(priv->pci_dev, SMBBAR) &&
1447 address <= pci_resource_end(priv->pci_dev, SMBBAR);
1448}
1449
1450static acpi_status
1451i801_acpi_io_handler(u32 function, acpi_physical_address address, u32 bits,
1452 u64 *value, void *handler_context, void *region_context)
1453{
1454 struct i801_priv *priv = handler_context;
1455 struct pci_dev *pdev = priv->pci_dev;
1456 acpi_status status;
1457
1458 /*
1459 * Once BIOS AML code touches the OpRegion we warn and inhibit any
1460 * further access from the driver itself. This device is now owned
1461 * by the system firmware.
1462 */
1463 i2c_lock_bus(adapter: &priv->adapter, I2C_LOCK_SEGMENT);
1464
1465 if (!priv->acpi_reserved && i801_acpi_is_smbus_ioport(priv, address)) {
1466 priv->acpi_reserved = true;
1467
1468 pci_warn(pdev, "BIOS is accessing SMBus registers\n");
1469 pci_warn(pdev, "Driver SMBus register access inhibited\n");
1470
1471 /*
1472 * BIOS is accessing the host controller so prevent it from
1473 * suspending automatically from now on.
1474 */
1475 pm_runtime_get_sync(dev: &pdev->dev);
1476 }
1477
1478 if ((function & ACPI_IO_MASK) == ACPI_READ)
1479 status = acpi_os_read_port(address, value: (u32 *)value, width: bits);
1480 else
1481 status = acpi_os_write_port(address, value: (u32)*value, width: bits);
1482
1483 i2c_unlock_bus(adapter: &priv->adapter, I2C_LOCK_SEGMENT);
1484
1485 return status;
1486}
1487
1488static int i801_acpi_probe(struct i801_priv *priv)
1489{
1490 acpi_handle ah = ACPI_HANDLE(&priv->pci_dev->dev);
1491 acpi_status status;
1492
1493 status = acpi_install_address_space_handler(device: ah, ACPI_ADR_SPACE_SYSTEM_IO,
1494 handler: i801_acpi_io_handler, NULL, context: priv);
1495 if (ACPI_SUCCESS(status))
1496 return 0;
1497
1498 return acpi_check_resource_conflict(res: &priv->pci_dev->resource[SMBBAR]);
1499}
1500
1501static void i801_acpi_remove(struct i801_priv *priv)
1502{
1503 acpi_handle ah = ACPI_HANDLE(&priv->pci_dev->dev);
1504
1505 acpi_remove_address_space_handler(device: ah, ACPI_ADR_SPACE_SYSTEM_IO, handler: i801_acpi_io_handler);
1506}
1507#else
1508static inline int i801_acpi_probe(struct i801_priv *priv) { return 0; }
1509static inline void i801_acpi_remove(struct i801_priv *priv) { }
1510#endif
1511
1512static void i801_setup_hstcfg(struct i801_priv *priv)
1513{
1514 unsigned char hstcfg = priv->original_hstcfg;
1515
1516 hstcfg &= ~SMBHSTCFG_I2C_EN; /* SMBus timing */
1517 hstcfg |= SMBHSTCFG_HST_EN;
1518 pci_write_config_byte(dev: priv->pci_dev, SMBHSTCFG, val: hstcfg);
1519}
1520
1521static void i801_restore_regs(struct i801_priv *priv)
1522{
1523 iowrite8(priv->original_hstcnt, SMBHSTCNT(priv));
1524 pci_write_config_byte(dev: priv->pci_dev, SMBHSTCFG, val: priv->original_hstcfg);
1525}
1526
1527static int i801_probe(struct pci_dev *dev, const struct pci_device_id *id)
1528{
1529 int err, i, bar = SMBBAR;
1530 struct i801_priv *priv;
1531
1532 priv = devm_kzalloc(dev: &dev->dev, size: sizeof(*priv), GFP_KERNEL);
1533 if (!priv)
1534 return -ENOMEM;
1535
1536 i2c_set_adapdata(adap: &priv->adapter, data: priv);
1537 priv->adapter.owner = THIS_MODULE;
1538 priv->adapter.class = I2C_CLASS_HWMON;
1539 priv->adapter.algo = &smbus_algorithm;
1540 priv->adapter.dev.parent = &dev->dev;
1541 acpi_use_parent_companion(dev: &priv->adapter.dev);
1542 priv->adapter.retries = 3;
1543
1544 priv->pci_dev = dev;
1545 priv->features = id->driver_data;
1546
1547 /* Disable features on user request */
1548 for (i = 0; i < ARRAY_SIZE(i801_feature_names); i++) {
1549 if (priv->features & disable_features & (1 << i))
1550 pci_notice(dev, "%s disabled by user\n", i801_feature_names[i]);
1551 }
1552 priv->features &= ~disable_features;
1553
1554 /* The block process call uses block buffer mode */
1555 if (!(priv->features & FEATURE_BLOCK_BUFFER))
1556 priv->features &= ~FEATURE_BLOCK_PROC;
1557
1558 /*
1559 * Do not call pcim_enable_device(), because the device has to remain
1560 * enabled on driver detach. See i801_remove() for the reasoning.
1561 */
1562 err = pci_enable_device(dev);
1563 if (err) {
1564 pci_err(dev, "Failed to enable SMBus PCI device (%d)\n", err);
1565 return err;
1566 }
1567
1568 /* Determine the address of the SMBus area */
1569 if (!pci_resource_start(dev, SMBBAR)) {
1570 pci_err(dev, "SMBus base address uninitialized, upgrade BIOS\n");
1571 return -ENODEV;
1572 }
1573
1574 if (i801_acpi_probe(priv))
1575 return -ENODEV;
1576
1577 if (pci_resource_flags(dev, SMBBAR_MMIO) & IORESOURCE_MEM)
1578 bar = SMBBAR_MMIO;
1579
1580 priv->smba = pcim_iomap_region(pdev: dev, bar, DRV_NAME);
1581 if (IS_ERR(ptr: priv->smba)) {
1582 pci_err(dev, "Failed to request SMBus region %pr\n",
1583 pci_resource_n(dev, bar));
1584 i801_acpi_remove(priv);
1585 return PTR_ERR(ptr: priv->smba);
1586 }
1587
1588 pci_read_config_byte(dev, SMBHSTCFG, val: &priv->original_hstcfg);
1589 i801_setup_hstcfg(priv);
1590 if (!(priv->original_hstcfg & SMBHSTCFG_HST_EN))
1591 pci_info(dev, "Enabling SMBus device\n");
1592
1593 if (priv->original_hstcfg & SMBHSTCFG_SMB_SMI_EN) {
1594 pci_dbg(dev, "SMBus using interrupt SMI#\n");
1595 /* Disable SMBus interrupt feature if SMBus using SMI# */
1596 priv->features &= ~FEATURE_IRQ;
1597 }
1598 if (priv->original_hstcfg & SMBHSTCFG_SPD_WD)
1599 pci_info(dev, "SPD Write Disable is set\n");
1600
1601 /* Clear special mode bits */
1602 if (priv->features & (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER))
1603 iowrite8(ioread8(SMBAUXCTL(priv)) &
1604 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
1605
1606 /* Default timeout in interrupt mode: 200 ms */
1607 priv->adapter.timeout = HZ / 5;
1608
1609 if (dev->irq == IRQ_NOTCONNECTED)
1610 priv->features &= ~FEATURE_IRQ;
1611
1612 if (priv->features & FEATURE_IRQ) {
1613 u16 pcists;
1614
1615 /* Complain if an interrupt is already pending */
1616 pci_read_config_word(dev: priv->pci_dev, PCI_STATUS, val: &pcists);
1617 if (pcists & PCI_STATUS_INTERRUPT)
1618 pci_warn(dev, "An interrupt is pending!\n");
1619 }
1620
1621 if (priv->features & FEATURE_IRQ) {
1622 init_completion(x: &priv->done);
1623
1624 err = devm_request_irq(dev: &dev->dev, irq: dev->irq, handler: i801_isr,
1625 IRQF_SHARED, DRV_NAME, dev_id: priv);
1626 if (err) {
1627 pci_err(dev, "Failed to allocate irq %d: %d\n", dev->irq, err);
1628 priv->features &= ~FEATURE_IRQ;
1629 }
1630 }
1631 pci_info(dev, "SMBus using %s\n",
1632 priv->features & FEATURE_IRQ ? "PCI interrupt" : "polling");
1633
1634 /* Host notification uses an interrupt */
1635 if (!(priv->features & FEATURE_IRQ))
1636 priv->features &= ~FEATURE_HOST_NOTIFY;
1637
1638 /* Remember original Interrupt and Host Notify settings */
1639 priv->original_hstcnt = ioread8(SMBHSTCNT(priv)) & ~SMBHSTCNT_KILL;
1640 if (priv->features & FEATURE_HOST_NOTIFY)
1641 priv->original_slvcmd = ioread8(SMBSLVCMD(priv));
1642
1643 i801_add_tco(priv);
1644
1645 /*
1646 * adapter.name is used by platform code to find the main I801 adapter
1647 * to instantiante i2c_clients, do not change.
1648 */
1649 snprintf(buf: priv->adapter.name, size: sizeof(priv->adapter.name),
1650 fmt: "SMBus %s adapter at %s",
1651 (priv->features & FEATURE_IDF) ? "I801 IDF" : "I801",
1652 pci_name(pdev: dev));
1653
1654 err = i2c_add_adapter(adap: &priv->adapter);
1655 if (err) {
1656 platform_device_unregister(priv->tco_pdev);
1657 i801_acpi_remove(priv);
1658 i801_restore_regs(priv);
1659 return err;
1660 }
1661
1662 i801_enable_host_notify(adapter: &priv->adapter);
1663
1664 /* We ignore errors - multiplexing is optional */
1665 i801_add_mux(priv);
1666 i801_probe_optional_targets(priv);
1667
1668 pci_set_drvdata(pdev: dev, data: priv);
1669
1670 dev_pm_set_driver_flags(dev: &dev->dev, DPM_FLAG_NO_DIRECT_COMPLETE);
1671 pm_runtime_set_autosuspend_delay(dev: &dev->dev, delay: 1000);
1672 pm_runtime_use_autosuspend(dev: &dev->dev);
1673 pm_runtime_put_autosuspend(dev: &dev->dev);
1674 pm_runtime_allow(dev: &dev->dev);
1675
1676 return 0;
1677}
1678
1679static void i801_remove(struct pci_dev *dev)
1680{
1681 struct i801_priv *priv = pci_get_drvdata(pdev: dev);
1682
1683 i801_disable_host_notify(priv);
1684 i801_del_mux(priv);
1685 i2c_del_adapter(adap: &priv->adapter);
1686 i801_acpi_remove(priv);
1687
1688 platform_device_unregister(priv->tco_pdev);
1689
1690 /* if acpi_reserved is set then usage_count is incremented already */
1691 if (!priv->acpi_reserved)
1692 pm_runtime_get_noresume(dev: &dev->dev);
1693
1694 i801_restore_regs(priv);
1695
1696 /*
1697 * do not call pci_disable_device(dev) since it can cause hard hangs on
1698 * some systems during power-off (eg. Fujitsu-Siemens Lifebook E8010)
1699 */
1700}
1701
1702static void i801_shutdown(struct pci_dev *dev)
1703{
1704 struct i801_priv *priv = pci_get_drvdata(pdev: dev);
1705
1706 i801_disable_host_notify(priv);
1707 /* Restore config registers to avoid hard hang on some systems */
1708 i801_restore_regs(priv);
1709}
1710
1711static int i801_suspend(struct device *dev)
1712{
1713 struct i801_priv *priv = dev_get_drvdata(dev);
1714
1715 i2c_mark_adapter_suspended(adap: &priv->adapter);
1716 i801_restore_regs(priv);
1717
1718 return 0;
1719}
1720
1721static int i801_resume(struct device *dev)
1722{
1723 struct i801_priv *priv = dev_get_drvdata(dev);
1724
1725 i801_setup_hstcfg(priv);
1726 i801_enable_host_notify(adapter: &priv->adapter);
1727 i2c_mark_adapter_resumed(adap: &priv->adapter);
1728
1729 return 0;
1730}
1731
1732static DEFINE_SIMPLE_DEV_PM_OPS(i801_pm_ops, i801_suspend, i801_resume);
1733
1734static struct pci_driver i801_driver = {
1735 .name = DRV_NAME,
1736 .id_table = i801_ids,
1737 .probe = i801_probe,
1738 .remove = i801_remove,
1739 .shutdown = i801_shutdown,
1740 .driver = {
1741 .pm = pm_sleep_ptr(&i801_pm_ops),
1742 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1743 },
1744};
1745
1746static int __init i2c_i801_init(struct pci_driver *drv)
1747{
1748 if (dmi_name_in_vendors(str: "FUJITSU"))
1749 input_apanel_init();
1750 return pci_register_driver(drv);
1751}
1752
1753MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>");
1754MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>");
1755MODULE_DESCRIPTION("I801 SMBus driver");
1756MODULE_LICENSE("GPL");
1757
1758module_driver(i801_driver, i2c_i801_init, pci_unregister_driver);
1759