blob: ed07f9002710eced6a2bce173c91243d5a9515e8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl>,
3 Philip Edelbrock <phil@netroedge.com>, and Mark D. Studebaker
4 <mdsxyz123@yahoo.com>
Jean Delvareb3b8df92014-11-12 10:20:40 +01005 Copyright (C) 2007 - 2014 Jean Delvare <jdelvare@suse.de>
David Woodhouse0cd96eb2010-10-31 21:06:59 +01006 Copyright (C) 2010 Intel Corporation,
7 David Woodhouse <dwmw2@infradead.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070018*/
19
20/*
Jean Delvarece316112014-07-17 15:03:24 +020021 * Supports the following Intel I/O Controller Hubs (ICH):
22 *
23 * I/O Block I2C
24 * region SMBus Block proc. block
25 * Chip name PCI ID size PEC buffer call read
26 * ---------------------------------------------------------------------------
27 * 82801AA (ICH) 0x2413 16 no no no no
28 * 82801AB (ICH0) 0x2423 16 no no no no
29 * 82801BA (ICH2) 0x2443 16 no no no no
30 * 82801CA (ICH3) 0x2483 32 soft no no no
31 * 82801DB (ICH4) 0x24c3 32 hard yes no no
32 * 82801E (ICH5) 0x24d3 32 hard yes yes yes
33 * 6300ESB 0x25a4 32 hard yes yes yes
34 * 82801F (ICH6) 0x266a 32 hard yes yes yes
35 * 6310ESB/6320ESB 0x269b 32 hard yes yes yes
36 * 82801G (ICH7) 0x27da 32 hard yes yes yes
37 * 82801H (ICH8) 0x283e 32 hard yes yes yes
38 * 82801I (ICH9) 0x2930 32 hard yes yes yes
39 * EP80579 (Tolapai) 0x5032 32 hard yes yes yes
40 * ICH10 0x3a30 32 hard yes yes yes
41 * ICH10 0x3a60 32 hard yes yes yes
42 * 5/3400 Series (PCH) 0x3b30 32 hard yes yes yes
43 * 6 Series (PCH) 0x1c22 32 hard yes yes yes
44 * Patsburg (PCH) 0x1d22 32 hard yes yes yes
45 * Patsburg (PCH) IDF 0x1d70 32 hard yes yes yes
46 * Patsburg (PCH) IDF 0x1d71 32 hard yes yes yes
47 * Patsburg (PCH) IDF 0x1d72 32 hard yes yes yes
48 * DH89xxCC (PCH) 0x2330 32 hard yes yes yes
49 * Panther Point (PCH) 0x1e22 32 hard yes yes yes
50 * Lynx Point (PCH) 0x8c22 32 hard yes yes yes
51 * Lynx Point-LP (PCH) 0x9c22 32 hard yes yes yes
52 * Avoton (SOC) 0x1f3c 32 hard yes yes yes
53 * Wellsburg (PCH) 0x8d22 32 hard yes yes yes
54 * Wellsburg (PCH) MS 0x8d7d 32 hard yes yes yes
55 * Wellsburg (PCH) MS 0x8d7e 32 hard yes yes yes
56 * Wellsburg (PCH) MS 0x8d7f 32 hard yes yes yes
57 * Coleto Creek (PCH) 0x23b0 32 hard yes yes yes
Jean Delvareb299de82014-07-17 15:04:41 +020058 * Wildcat Point (PCH) 0x8ca2 32 hard yes yes yes
Jean Delvarece316112014-07-17 15:03:24 +020059 * Wildcat Point-LP (PCH) 0x9ca2 32 hard yes yes yes
60 * BayTrail (SOC) 0x0f12 32 hard yes yes yes
Jarkko Nikula15407792018-02-16 11:24:29 +020061 * Braswell (SOC) 0x2292 32 hard yes yes yes
james.d.ralston@intel.com3e27a842014-10-13 15:20:24 -070062 * Sunrise Point-H (PCH) 0xa123 32 hard yes yes yes
Devin Ryles3eee17992014-11-05 16:30:03 -050063 * Sunrise Point-LP (PCH) 0x9d23 32 hard yes yes yes
Mika Westerberg84d7f2e2015-10-13 15:41:39 +030064 * DNV (SOC) 0x19df 32 hard yes yes yes
Jarkko Nikuladd77f422015-10-22 17:16:58 +030065 * Broxton (SOC) 0x5ad4 32 hard yes yes yes
Alexandra Yatescdc5a312015-11-05 11:40:25 -080066 * Lewisburg (PCH) 0xa1a3 32 hard yes yes yes
67 * Lewisburg Supersku (PCH) 0xa223 32 hard yes yes yes
Andy Shevchenko31158762016-09-23 11:56:01 +030068 * Kaby Lake PCH-H (PCH) 0xa2a3 32 hard yes yes yes
Mika Westerberg9827f9e2017-02-01 19:20:59 +030069 * Gemini Lake (SOC) 0x31d4 32 hard yes yes yes
Srinivas Pandruvada09a1de02017-05-18 11:23:06 +030070 * Cannon Lake-H (PCH) 0xa323 32 hard yes yes yes
71 * Cannon Lake-LP (PCH) 0x9da3 32 hard yes yes yes
Jarkko Nikulacb09d942017-09-21 16:23:16 +030072 * Cedar Fork (PCH) 0x18df 32 hard yes yes yes
Jean Delvarece316112014-07-17 15:03:24 +020073 *
74 * Features supported by this driver:
75 * Software PEC no
76 * Hardware PEC yes
77 * Block buffer yes
78 * Block process call transaction no
79 * I2C block read transaction yes (doesn't use the block buffer)
80 * Slave mode no
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +020081 * SMBus Host Notify yes
Jean Delvarece316112014-07-17 15:03:24 +020082 * Interrupt processing yes
83 *
84 * See the file Documentation/i2c/busses/i2c-i801 for details.
85 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Daniel Kurtz636752b2012-07-24 14:13:58 +020087#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070088#include <linux/module.h>
89#include <linux/pci.h>
90#include <linux/kernel.h>
91#include <linux/stddef.h>
92#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070093#include <linux/ioport.h>
94#include <linux/init.h>
95#include <linux/i2c.h>
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +020096#include <linux/i2c-smbus.h>
Jean Delvare54fb4a052008-07-14 22:38:33 +020097#include <linux/acpi.h>
Jean Delvare1561bfe2009-01-07 14:29:17 +010098#include <linux/io.h>
Hans de Goedefa5bfab2009-03-30 21:46:44 +020099#include <linux/dmi.h>
Ben Hutchings665a96b2011-01-10 22:11:22 +0100100#include <linux/slab.h>
Daniel Kurtz636752b2012-07-24 14:13:58 +0200101#include <linux/wait.h>
Jean Delvare3ad7ea12012-10-05 22:23:53 +0200102#include <linux/err.h>
Mika Westerberg94246932015-08-06 13:46:25 +0100103#include <linux/platform_device.h>
104#include <linux/platform_data/itco_wdt.h>
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200105#include <linux/pm_runtime.h>
Jean Delvare3ad7ea12012-10-05 22:23:53 +0200106
Javier Martinez Canillas175c7082016-07-21 12:11:01 -0400107#if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
Jean Delvare3ad7ea12012-10-05 22:23:53 +0200108#include <linux/gpio.h>
109#include <linux/i2c-mux-gpio.h>
Jean Delvare3ad7ea12012-10-05 22:23:53 +0200110#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112/* I801 SMBus address offsets */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100113#define SMBHSTSTS(p) (0 + (p)->smba)
114#define SMBHSTCNT(p) (2 + (p)->smba)
115#define SMBHSTCMD(p) (3 + (p)->smba)
116#define SMBHSTADD(p) (4 + (p)->smba)
117#define SMBHSTDAT0(p) (5 + (p)->smba)
118#define SMBHSTDAT1(p) (6 + (p)->smba)
119#define SMBBLKDAT(p) (7 + (p)->smba)
120#define SMBPEC(p) (8 + (p)->smba) /* ICH3 and later */
121#define SMBAUXSTS(p) (12 + (p)->smba) /* ICH4 and later */
122#define SMBAUXCTL(p) (13 + (p)->smba) /* ICH4 and later */
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200123#define SMBSLVSTS(p) (16 + (p)->smba) /* ICH3 and later */
124#define SMBSLVCMD(p) (17 + (p)->smba) /* ICH3 and later */
125#define SMBNTFDADD(p) (20 + (p)->smba) /* ICH3 and later */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
127/* PCI Address Constants */
Jean Delvare6dcc19d2006-06-12 21:53:02 +0200128#define SMBBAR 4
Jean Delvareaeb8a3d2014-11-12 10:25:37 +0100129#define SMBPCICTL 0x004
Daniel Kurtz636752b2012-07-24 14:13:58 +0200130#define SMBPCISTS 0x006
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131#define SMBHSTCFG 0x040
Mika Westerberg94246932015-08-06 13:46:25 +0100132#define TCOBASE 0x050
133#define TCOCTL 0x054
134
135#define ACPIBASE 0x040
136#define ACPIBASE_SMI_OFF 0x030
137#define ACPICTRL 0x044
138#define ACPICTRL_EN 0x080
139
140#define SBREG_BAR 0x10
141#define SBREG_SMBCTRL 0xc6000c
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Daniel Kurtz636752b2012-07-24 14:13:58 +0200143/* Host status bits for SMBPCISTS */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200144#define SMBPCISTS_INTS BIT(3)
Daniel Kurtz636752b2012-07-24 14:13:58 +0200145
Jean Delvareaeb8a3d2014-11-12 10:25:37 +0100146/* Control bits for SMBPCICTL */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200147#define SMBPCICTL_INTDIS BIT(10)
Jean Delvareaeb8a3d2014-11-12 10:25:37 +0100148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149/* Host configuration bits for SMBHSTCFG */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200150#define SMBHSTCFG_HST_EN BIT(0)
151#define SMBHSTCFG_SMB_SMI_EN BIT(1)
152#define SMBHSTCFG_I2C_EN BIT(2)
153#define SMBHSTCFG_SPD_WD BIT(4)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Mika Westerberg94246932015-08-06 13:46:25 +0100155/* TCO configuration bits for TCOCTL */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200156#define TCOCTL_EN BIT(8)
Mika Westerberg94246932015-08-06 13:46:25 +0100157
Ellen Wang97d34ec2016-07-01 22:42:15 +0200158/* Auxiliary status register bits, ICH4+ only */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200159#define SMBAUXSTS_CRCE BIT(0)
160#define SMBAUXSTS_STCO BIT(1)
Ellen Wang97d34ec2016-07-01 22:42:15 +0200161
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300162/* Auxiliary control register bits, ICH4+ only */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200163#define SMBAUXCTL_CRC BIT(0)
164#define SMBAUXCTL_E32B BIT(1)
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200165
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166/* Other settings */
Jean Delvare84c1af42012-03-26 21:47:19 +0200167#define MAX_RETRIES 400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169/* I801 command constants */
170#define I801_QUICK 0x00
171#define I801_BYTE 0x04
172#define I801_BYTE_DATA 0x08
173#define I801_WORD_DATA 0x0C
Jean Delvareae7b0492008-01-27 18:14:49 +0100174#define I801_PROC_CALL 0x10 /* unimplemented */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175#define I801_BLOCK_DATA 0x14
Jean Delvare63420642008-01-27 18:14:50 +0100176#define I801_I2C_BLOCK_DATA 0x18 /* ICH5 and later */
Daniel Kurtzedbeea62012-07-24 14:13:58 +0200177
178/* I801 Host Control register bits */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200179#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200185/* I801 Hosts Status register bits */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200186#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Benjamin Tissoires9786b1f2016-10-13 14:10:36 +0200195/* Host Notify Status register bits */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200196#define SMBSLVSTS_HST_NTFY_STS BIT(0)
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200197
Benjamin Tissoires9786b1f2016-10-13 14:10:36 +0200198/* Host Notify Command register bits */
Benjamin Tissoiresfe9ba3e2016-10-13 14:10:37 +0200199#define SMBSLVCMD_HST_NTFY_INTREN BIT(0)
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200200
Daniel Kurtz70a1cc12012-07-24 14:13:58 +0200201#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)
Jean Delvarecf898dc2008-07-14 22:38:33 +0200206
Jean Delvarea6e5e2b2011-05-01 18:18:49 +0200207/* Older devices have their ID defined in <linux/pci_ids.h> */
Jean Delvarece316112014-07-17 15:03:24 +0200208#define PCI_DEVICE_ID_INTEL_BAYTRAIL_SMBUS 0x0f12
Jarkko Nikulacb09d942017-09-21 16:23:16 +0300209#define PCI_DEVICE_ID_INTEL_CDF_SMBUS 0x18df
Andy Shevchenko34b57f42016-03-09 14:14:17 +0200210#define PCI_DEVICE_ID_INTEL_DNV_SMBUS 0x19df
Jean Delvarece316112014-07-17 15:03:24 +0200211#define PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS 0x1c22
212#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS 0x1d22
David Woodhouse55fee8d2010-10-31 21:07:00 +0100213/* Patsburg also has three 'Integrated Device Function' SMBus controllers */
Jean Delvarece316112014-07-17 15:03:24 +0200214#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0 0x1d70
215#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1 0x1d71
216#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2 0x1d72
217#define PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS 0x1e22
218#define PCI_DEVICE_ID_INTEL_AVOTON_SMBUS 0x1f3c
Andy Shevchenko34b57f42016-03-09 14:14:17 +0200219#define PCI_DEVICE_ID_INTEL_BRASWELL_SMBUS 0x2292
Jean Delvarece316112014-07-17 15:03:24 +0200220#define PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS 0x2330
221#define PCI_DEVICE_ID_INTEL_COLETOCREEK_SMBUS 0x23b0
Mika Westerberg9827f9e2017-02-01 19:20:59 +0300222#define PCI_DEVICE_ID_INTEL_GEMINILAKE_SMBUS 0x31d4
Jean Delvarece316112014-07-17 15:03:24 +0200223#define PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS 0x3b30
Andy Shevchenko34b57f42016-03-09 14:14:17 +0200224#define PCI_DEVICE_ID_INTEL_BROXTON_SMBUS 0x5ad4
Jean Delvarece316112014-07-17 15:03:24 +0200225#define PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS 0x8c22
Jean Delvareb299de82014-07-17 15:04:41 +0200226#define PCI_DEVICE_ID_INTEL_WILDCATPOINT_SMBUS 0x8ca2
Jean Delvarece316112014-07-17 15:03:24 +0200227#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS 0x8d22
228#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0 0x8d7d
229#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1 0x8d7e
230#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2 0x8d7f
231#define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS 0x9c22
James Ralstonafc65922013-11-04 09:29:48 -0800232#define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_SMBUS 0x9ca2
Devin Ryles3eee17992014-11-05 16:30:03 -0500233#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS 0x9d23
Srinivas Pandruvada09a1de02017-05-18 11:23:06 +0300234#define PCI_DEVICE_ID_INTEL_CANNONLAKE_LP_SMBUS 0x9da3
Andy Shevchenko34b57f42016-03-09 14:14:17 +0200235#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS 0xa123
Alexandra Yatescdc5a312015-11-05 11:40:25 -0800236#define PCI_DEVICE_ID_INTEL_LEWISBURG_SMBUS 0xa1a3
237#define PCI_DEVICE_ID_INTEL_LEWISBURG_SSKU_SMBUS 0xa223
Andy Shevchenko31158762016-09-23 11:56:01 +0300238#define PCI_DEVICE_ID_INTEL_KABYLAKE_PCH_H_SMBUS 0xa2a3
Srinivas Pandruvada09a1de02017-05-18 11:23:06 +0300239#define PCI_DEVICE_ID_INTEL_CANNONLAKE_H_SMBUS 0xa323
David Woodhouse55fee8d2010-10-31 21:07:00 +0100240
Jean Delvare3ad7ea12012-10-05 22:23:53 +0200241struct i801_mux_config {
242 char *gpio_chip;
243 unsigned values[3];
244 int n_values;
245 unsigned classes[3];
246 unsigned gpios[2]; /* Relative to gpio_chip->base */
247 int n_gpios;
248};
249
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100250struct i801_priv {
251 struct i2c_adapter adapter;
252 unsigned long smba;
253 unsigned char original_hstcfg;
Benjamin Tissoires22e94bd2016-10-13 14:10:35 +0200254 unsigned char original_slvcmd;
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100255 struct pci_dev *pci_dev;
256 unsigned int features;
Daniel Kurtz636752b2012-07-24 14:13:58 +0200257
258 /* isr processing */
259 wait_queue_head_t waitq;
260 u8 status;
Daniel Kurtzd3ff6ce2012-07-24 14:13:59 +0200261
262 /* Command state used by isr for byte-by-byte block transactions */
263 u8 cmd;
264 bool is_read;
265 int count;
266 int len;
267 u8 *data;
Jean Delvare3ad7ea12012-10-05 22:23:53 +0200268
Javier Martinez Canillas175c7082016-07-21 12:11:01 -0400269#if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
Jean Delvare3ad7ea12012-10-05 22:23:53 +0200270 const struct i801_mux_config *mux_drvdata;
Jean Delvare3ad7ea12012-10-05 22:23:53 +0200271 struct platform_device *mux_pdev;
272#endif
Mika Westerberg94246932015-08-06 13:46:25 +0100273 struct platform_device *tco_pdev;
Mika Westerberga7ae8192016-06-09 16:56:28 +0300274
275 /*
276 * If set to true the host controller registers are reserved for
277 * ACPI AML use. Protected by acpi_lock.
278 */
279 bool acpi_reserved;
280 struct mutex acpi_lock;
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100281};
282
Benjamin Tissoiresf91fba62016-10-13 14:10:38 +0200283#define FEATURE_SMBUS_PEC BIT(0)
284#define FEATURE_BLOCK_BUFFER BIT(1)
285#define FEATURE_BLOCK_PROC BIT(2)
286#define FEATURE_I2C_BLOCK_READ BIT(3)
287#define FEATURE_IRQ BIT(4)
288#define FEATURE_HOST_NOTIFY BIT(5)
Jean Delvaree7198fb2011-05-24 20:58:49 +0200289/* Not really a feature, but it's convenient to handle it as such */
Benjamin Tissoiresf91fba62016-10-13 14:10:38 +0200290#define FEATURE_IDF BIT(15)
291#define FEATURE_TCO BIT(16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Jean Delvareadff6872010-05-21 18:40:54 +0200293static const char *i801_feature_names[] = {
294 "SMBus PEC",
295 "Block buffer",
296 "Block process call",
297 "I2C block read",
Daniel Kurtz636752b2012-07-24 14:13:58 +0200298 "Interrupt",
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200299 "SMBus Host Notify",
Jean Delvareadff6872010-05-21 18:40:54 +0200300};
301
302static unsigned int disable_features;
303module_param(disable_features, uint, S_IRUGO | S_IWUSR);
Jean Delvare53229342013-05-15 02:44:10 +0000304MODULE_PARM_DESC(disable_features, "Disable selected driver features:\n"
305 "\t\t 0x01 disable SMBus PEC\n"
306 "\t\t 0x02 disable the block buffer\n"
307 "\t\t 0x08 disable the I2C block read functionality\n"
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200308 "\t\t 0x10 don't use interrupts\n"
309 "\t\t 0x20 disable SMBus Host Notify ");
Jean Delvareadff6872010-05-21 18:40:54 +0200310
Jean Delvarecf898dc2008-07-14 22:38:33 +0200311/* Make sure the SMBus host is ready to start transmitting.
312 Return 0 if it is, -EBUSY if it is not. */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100313static int i801_check_pre(struct i801_priv *priv)
Jean Delvarecf898dc2008-07-14 22:38:33 +0200314{
315 int status;
316
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100317 status = inb_p(SMBHSTSTS(priv));
Jean Delvarecf898dc2008-07-14 22:38:33 +0200318 if (status & SMBHSTSTS_HOST_BUSY) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100319 dev_err(&priv->pci_dev->dev, "SMBus is busy, can't use it!\n");
Jean Delvarecf898dc2008-07-14 22:38:33 +0200320 return -EBUSY;
321 }
322
323 status &= STATUS_FLAGS;
324 if (status) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100325 dev_dbg(&priv->pci_dev->dev, "Clearing status flags (%02x)\n",
Jean Delvarecf898dc2008-07-14 22:38:33 +0200326 status);
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100327 outb_p(status, SMBHSTSTS(priv));
328 status = inb_p(SMBHSTSTS(priv)) & STATUS_FLAGS;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200329 if (status) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100330 dev_err(&priv->pci_dev->dev,
Jean Delvarecf898dc2008-07-14 22:38:33 +0200331 "Failed clearing status flags (%02x)\n",
332 status);
333 return -EBUSY;
334 }
335 }
336
Ellen Wang97d34ec2016-07-01 22:42:15 +0200337 /*
338 * Clear CRC status if needed.
339 * During normal operation, i801_check_post() takes care
340 * of it after every operation. We do it here only in case
341 * the hardware was already in this state when the driver
342 * started.
343 */
344 if (priv->features & FEATURE_SMBUS_PEC) {
345 status = inb_p(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE;
346 if (status) {
347 dev_dbg(&priv->pci_dev->dev,
348 "Clearing aux status flags (%02x)\n", status);
349 outb_p(status, SMBAUXSTS(priv));
350 status = inb_p(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE;
351 if (status) {
352 dev_err(&priv->pci_dev->dev,
353 "Failed clearing aux status flags (%02x)\n",
354 status);
355 return -EBUSY;
356 }
357 }
358 }
359
Jean Delvarecf898dc2008-07-14 22:38:33 +0200360 return 0;
361}
362
Jean Delvare6cad93c2012-07-24 14:13:58 +0200363/*
364 * Convert the status register to an error code, and clear it.
365 * Note that status only contains the bits we want to clear, not the
366 * actual register value.
367 */
368static int i801_check_post(struct i801_priv *priv, int status)
Jean Delvarecf898dc2008-07-14 22:38:33 +0200369{
370 int result = 0;
371
Daniel Kurtz636752b2012-07-24 14:13:58 +0200372 /*
373 * If the SMBus is still busy, we give up
374 * Note: This timeout condition only happens when using polling
375 * transactions. For interrupt operation, NAK/timeout is indicated by
376 * DEV_ERR.
377 */
Jean Delvare6cad93c2012-07-24 14:13:58 +0200378 if (unlikely(status < 0)) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100379 dev_err(&priv->pci_dev->dev, "Transaction timeout\n");
Jean Delvarecf898dc2008-07-14 22:38:33 +0200380 /* try to stop the current command */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100381 dev_dbg(&priv->pci_dev->dev, "Terminating the current operation\n");
382 outb_p(inb_p(SMBHSTCNT(priv)) | SMBHSTCNT_KILL,
383 SMBHSTCNT(priv));
Jean Delvare84c1af42012-03-26 21:47:19 +0200384 usleep_range(1000, 2000);
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100385 outb_p(inb_p(SMBHSTCNT(priv)) & (~SMBHSTCNT_KILL),
386 SMBHSTCNT(priv));
Jean Delvarecf898dc2008-07-14 22:38:33 +0200387
388 /* Check if it worked */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100389 status = inb_p(SMBHSTSTS(priv));
Jean Delvarecf898dc2008-07-14 22:38:33 +0200390 if ((status & SMBHSTSTS_HOST_BUSY) ||
391 !(status & SMBHSTSTS_FAILED))
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100392 dev_err(&priv->pci_dev->dev,
Jean Delvarecf898dc2008-07-14 22:38:33 +0200393 "Failed terminating the transaction\n");
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100394 outb_p(STATUS_FLAGS, SMBHSTSTS(priv));
Jean Delvarecf898dc2008-07-14 22:38:33 +0200395 return -ETIMEDOUT;
396 }
397
398 if (status & SMBHSTSTS_FAILED) {
399 result = -EIO;
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100400 dev_err(&priv->pci_dev->dev, "Transaction failed\n");
Jean Delvarecf898dc2008-07-14 22:38:33 +0200401 }
402 if (status & SMBHSTSTS_DEV_ERR) {
Ellen Wang97d34ec2016-07-01 22:42:15 +0200403 /*
404 * This may be a PEC error, check and clear it.
405 *
406 * AUXSTS is handled differently from HSTSTS.
407 * For HSTSTS, i801_isr() or i801_wait_intr()
408 * has already cleared the error bits in hardware,
409 * and we are passed a copy of the original value
410 * in "status".
411 * For AUXSTS, the hardware register is left
412 * for us to handle here.
413 * This is asymmetric, slightly iffy, but safe,
414 * since all this code is serialized and the CRCE
415 * bit is harmless as long as it's cleared before
416 * the next operation.
417 */
418 if ((priv->features & FEATURE_SMBUS_PEC) &&
419 (inb_p(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE)) {
420 outb_p(SMBAUXSTS_CRCE, SMBAUXSTS(priv));
421 result = -EBADMSG;
422 dev_dbg(&priv->pci_dev->dev, "PEC error\n");
423 } else {
424 result = -ENXIO;
425 dev_dbg(&priv->pci_dev->dev, "No response\n");
426 }
Jean Delvarecf898dc2008-07-14 22:38:33 +0200427 }
428 if (status & SMBHSTSTS_BUS_ERR) {
429 result = -EAGAIN;
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100430 dev_dbg(&priv->pci_dev->dev, "Lost arbitration\n");
Jean Delvarecf898dc2008-07-14 22:38:33 +0200431 }
432
Jean Delvare6cad93c2012-07-24 14:13:58 +0200433 /* Clear status flags except BYTE_DONE, to be cleared by caller */
434 outb_p(status, SMBHSTSTS(priv));
Jean Delvarecf898dc2008-07-14 22:38:33 +0200435
436 return result;
437}
438
Jean Delvare6cad93c2012-07-24 14:13:58 +0200439/* Wait for BUSY being cleared and either INTR or an error flag being set */
440static int i801_wait_intr(struct i801_priv *priv)
441{
442 int timeout = 0;
443 int status;
444
445 /* We will always wait for a fraction of a second! */
446 do {
447 usleep_range(250, 500);
448 status = inb_p(SMBHSTSTS(priv));
449 } while (((status & SMBHSTSTS_HOST_BUSY) ||
450 !(status & (STATUS_ERROR_FLAGS | SMBHSTSTS_INTR))) &&
451 (timeout++ < MAX_RETRIES));
452
453 if (timeout > MAX_RETRIES) {
454 dev_dbg(&priv->pci_dev->dev, "INTR Timeout!\n");
455 return -ETIMEDOUT;
456 }
457 return status & (STATUS_ERROR_FLAGS | SMBHSTSTS_INTR);
458}
459
460/* Wait for either BYTE_DONE or an error flag being set */
461static int i801_wait_byte_done(struct i801_priv *priv)
462{
463 int timeout = 0;
464 int status;
465
466 /* We will always wait for a fraction of a second! */
467 do {
468 usleep_range(250, 500);
469 status = inb_p(SMBHSTSTS(priv));
470 } while (!(status & (STATUS_ERROR_FLAGS | SMBHSTSTS_BYTE_DONE)) &&
471 (timeout++ < MAX_RETRIES));
472
473 if (timeout > MAX_RETRIES) {
474 dev_dbg(&priv->pci_dev->dev, "BYTE_DONE Timeout!\n");
475 return -ETIMEDOUT;
476 }
477 return status & STATUS_ERROR_FLAGS;
478}
479
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100480static int i801_transaction(struct i801_priv *priv, int xact)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481{
Jean Delvare2b738092008-07-14 22:38:32 +0200482 int status;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200483 int result;
Jean Delvareb3b8df92014-11-12 10:20:40 +0100484 const struct i2c_adapter *adap = &priv->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100486 result = i801_check_pre(priv);
Jean Delvarecf898dc2008-07-14 22:38:33 +0200487 if (result < 0)
488 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
Daniel Kurtz636752b2012-07-24 14:13:58 +0200490 if (priv->features & FEATURE_IRQ) {
491 outb_p(xact | SMBHSTCNT_INTREN | SMBHSTCNT_START,
492 SMBHSTCNT(priv));
Jean Delvareb3b8df92014-11-12 10:20:40 +0100493 result = wait_event_timeout(priv->waitq,
494 (status = priv->status),
495 adap->timeout);
496 if (!result) {
497 status = -ETIMEDOUT;
498 dev_warn(&priv->pci_dev->dev,
499 "Timeout waiting for interrupt!\n");
500 }
Daniel Kurtz636752b2012-07-24 14:13:58 +0200501 priv->status = 0;
502 return i801_check_post(priv, status);
503 }
504
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200505 /* the current contents of SMBHSTCNT can be overwritten, since PEC,
Daniel Kurtz37af8712012-07-24 14:13:58 +0200506 * SMBSCMD are passed in xact */
Daniel Kurtzedbeea62012-07-24 14:13:58 +0200507 outb_p(xact | SMBHSTCNT_START, SMBHSTCNT(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Jean Delvare6cad93c2012-07-24 14:13:58 +0200509 status = i801_wait_intr(priv);
510 return i801_check_post(priv, status);
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200511}
512
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100513static int i801_block_transaction_by_block(struct i801_priv *priv,
514 union i2c_smbus_data *data,
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200515 char read_write, int hwpec)
516{
517 int i, len;
David Brownell97140342008-07-14 22:38:25 +0200518 int status;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200519
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100520 inb_p(SMBHSTCNT(priv)); /* reset the data buffer index */
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200521
522 /* Use 32-byte buffer to process this transaction */
523 if (read_write == I2C_SMBUS_WRITE) {
524 len = data->block[0];
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100525 outb_p(len, SMBHSTDAT0(priv));
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200526 for (i = 0; i < len; i++)
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100527 outb_p(data->block[i+1], SMBBLKDAT(priv));
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200528 }
529
Daniel Kurtz37af8712012-07-24 14:13:58 +0200530 status = i801_transaction(priv, I801_BLOCK_DATA |
Daniel Kurtzedbeea62012-07-24 14:13:58 +0200531 (hwpec ? SMBHSTCNT_PEC_EN : 0));
David Brownell97140342008-07-14 22:38:25 +0200532 if (status)
533 return status;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200534
535 if (read_write == I2C_SMBUS_READ) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100536 len = inb_p(SMBHSTDAT0(priv));
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200537 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX)
David Brownell97140342008-07-14 22:38:25 +0200538 return -EPROTO;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200539
540 data->block[0] = len;
541 for (i = 0; i < len; i++)
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100542 data->block[i + 1] = inb_p(SMBBLKDAT(priv));
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200543 }
544 return 0;
545}
546
Daniel Kurtzd3ff6ce2012-07-24 14:13:59 +0200547static void i801_isr_byte_done(struct i801_priv *priv)
548{
549 if (priv->is_read) {
550 /* For SMBus block reads, length is received with first byte */
551 if (((priv->cmd & 0x1c) == I801_BLOCK_DATA) &&
552 (priv->count == 0)) {
553 priv->len = inb_p(SMBHSTDAT0(priv));
554 if (priv->len < 1 || priv->len > I2C_SMBUS_BLOCK_MAX) {
555 dev_err(&priv->pci_dev->dev,
556 "Illegal SMBus block read size %d\n",
557 priv->len);
558 /* FIXME: Recover */
559 priv->len = I2C_SMBUS_BLOCK_MAX;
560 } else {
561 dev_dbg(&priv->pci_dev->dev,
562 "SMBus block read size is %d\n",
563 priv->len);
564 }
565 priv->data[-1] = priv->len;
566 }
567
568 /* Read next byte */
569 if (priv->count < priv->len)
570 priv->data[priv->count++] = inb(SMBBLKDAT(priv));
571 else
572 dev_dbg(&priv->pci_dev->dev,
573 "Discarding extra byte on block read\n");
574
575 /* Set LAST_BYTE for last byte of read transaction */
576 if (priv->count == priv->len - 1)
577 outb_p(priv->cmd | SMBHSTCNT_LAST_BYTE,
578 SMBHSTCNT(priv));
579 } else if (priv->count < priv->len - 1) {
580 /* Write next byte, except for IRQ after last byte */
581 outb_p(priv->data[++priv->count], SMBBLKDAT(priv));
582 }
583
584 /* Clear BYTE_DONE to continue with next byte */
585 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
586}
587
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200588static irqreturn_t i801_host_notify_isr(struct i801_priv *priv)
589{
590 unsigned short addr;
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200591
592 addr = inb_p(SMBNTFDADD(priv)) >> 1;
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200593
Benjamin Tissoiresc912a252016-10-13 14:10:39 +0200594 /*
595 * With the tested platforms, reading SMBNTFDDAT (22 + (p)->smba)
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +0200596 * always returns 0. Our current implementation doesn't provide
597 * data, so we just ignore it.
Benjamin Tissoiresc912a252016-10-13 14:10:39 +0200598 */
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +0200599 i2c_handle_smbus_host_notify(&priv->adapter, addr);
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200600
601 /* clear Host Notify bit and return */
602 outb_p(SMBSLVSTS_HST_NTFY_STS, SMBSLVSTS(priv));
603 return IRQ_HANDLED;
604}
605
Daniel Kurtzefa3cb12012-07-24 14:13:57 +0200606/*
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200607 * There are three kinds of interrupts:
Daniel Kurtzd3ff6ce2012-07-24 14:13:59 +0200608 *
609 * 1) i801 signals transaction completion with one of these interrupts:
610 * INTR - Success
611 * DEV_ERR - Invalid command, NAK or communication timeout
612 * BUS_ERR - SMI# transaction collision
613 * FAILED - transaction was canceled due to a KILL request
614 * When any of these occur, update ->status and wake up the waitq.
615 * ->status must be cleared before kicking off the next transaction.
616 *
617 * 2) For byte-by-byte (I2C read/write) transactions, one BYTE_DONE interrupt
618 * occurs for each byte of a byte-by-byte to prepare the next byte.
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200619 *
620 * 3) Host Notify interrupts
Daniel Kurtz636752b2012-07-24 14:13:58 +0200621 */
622static irqreturn_t i801_isr(int irq, void *dev_id)
623{
624 struct i801_priv *priv = dev_id;
625 u16 pcists;
626 u8 status;
627
628 /* Confirm this is our interrupt */
629 pci_read_config_word(priv->pci_dev, SMBPCISTS, &pcists);
630 if (!(pcists & SMBPCISTS_INTS))
631 return IRQ_NONE;
632
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200633 if (priv->features & FEATURE_HOST_NOTIFY) {
634 status = inb_p(SMBSLVSTS(priv));
635 if (status & SMBSLVSTS_HST_NTFY_STS)
636 return i801_host_notify_isr(priv);
637 }
638
Daniel Kurtz636752b2012-07-24 14:13:58 +0200639 status = inb_p(SMBHSTSTS(priv));
Daniel Kurtzd3ff6ce2012-07-24 14:13:59 +0200640 if (status & SMBHSTSTS_BYTE_DONE)
641 i801_isr_byte_done(priv);
642
Daniel Kurtz636752b2012-07-24 14:13:58 +0200643 /*
644 * Clear irq sources and report transaction result.
645 * ->status must be cleared before the next transaction is started.
646 */
647 status &= SMBHSTSTS_INTR | STATUS_ERROR_FLAGS;
648 if (status) {
649 outb_p(status, SMBHSTSTS(priv));
Jean Delvarea90bc5d2016-05-25 09:37:02 +0200650 priv->status = status;
Daniel Kurtz636752b2012-07-24 14:13:58 +0200651 wake_up(&priv->waitq);
652 }
653
654 return IRQ_HANDLED;
655}
656
657/*
Daniel Kurtzefa3cb12012-07-24 14:13:57 +0200658 * For "byte-by-byte" block transactions:
659 * I2C write uses cmd=I801_BLOCK_DATA, I2C_EN=1
660 * I2C read uses cmd=I801_I2C_BLOCK_DATA
661 */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100662static int i801_block_transaction_byte_by_byte(struct i801_priv *priv,
663 union i2c_smbus_data *data,
Jean Delvare63420642008-01-27 18:14:50 +0100664 char read_write, int command,
665 int hwpec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666{
667 int i, len;
668 int smbcmd;
Jean Delvare2b738092008-07-14 22:38:32 +0200669 int status;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200670 int result;
Jean Delvareb3b8df92014-11-12 10:20:40 +0100671 const struct i2c_adapter *adap = &priv->adapter;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200672
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100673 result = i801_check_pre(priv);
Jean Delvarecf898dc2008-07-14 22:38:33 +0200674 if (result < 0)
675 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200677 len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
679 if (read_write == I2C_SMBUS_WRITE) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100680 outb_p(len, SMBHSTDAT0(priv));
681 outb_p(data->block[1], SMBBLKDAT(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 }
683
Daniel Kurtzefa3cb12012-07-24 14:13:57 +0200684 if (command == I2C_SMBUS_I2C_BLOCK_DATA &&
685 read_write == I2C_SMBUS_READ)
686 smbcmd = I801_I2C_BLOCK_DATA;
687 else
688 smbcmd = I801_BLOCK_DATA;
689
Daniel Kurtzd3ff6ce2012-07-24 14:13:59 +0200690 if (priv->features & FEATURE_IRQ) {
691 priv->is_read = (read_write == I2C_SMBUS_READ);
692 if (len == 1 && priv->is_read)
693 smbcmd |= SMBHSTCNT_LAST_BYTE;
694 priv->cmd = smbcmd | SMBHSTCNT_INTREN;
695 priv->len = len;
696 priv->count = 0;
697 priv->data = &data->block[1];
698
699 outb_p(priv->cmd | SMBHSTCNT_START, SMBHSTCNT(priv));
Jean Delvareb3b8df92014-11-12 10:20:40 +0100700 result = wait_event_timeout(priv->waitq,
701 (status = priv->status),
702 adap->timeout);
703 if (!result) {
704 status = -ETIMEDOUT;
705 dev_warn(&priv->pci_dev->dev,
706 "Timeout waiting for interrupt!\n");
707 }
Daniel Kurtzd3ff6ce2012-07-24 14:13:59 +0200708 priv->status = 0;
709 return i801_check_post(priv, status);
710 }
711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 for (i = 1; i <= len; i++) {
Daniel Kurtzefa3cb12012-07-24 14:13:57 +0200713 if (i == len && read_write == I2C_SMBUS_READ)
Daniel Kurtzedbeea62012-07-24 14:13:58 +0200714 smbcmd |= SMBHSTCNT_LAST_BYTE;
Daniel Kurtz37af8712012-07-24 14:13:58 +0200715 outb_p(smbcmd, SMBHSTCNT(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 if (i == 1)
Daniel Kurtzedbeea62012-07-24 14:13:58 +0200718 outb_p(inb(SMBHSTCNT(priv)) | SMBHSTCNT_START,
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100719 SMBHSTCNT(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
Jean Delvare6cad93c2012-07-24 14:13:58 +0200721 status = i801_wait_byte_done(priv);
722 if (status)
723 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Jean Delvare63420642008-01-27 18:14:50 +0100725 if (i == 1 && read_write == I2C_SMBUS_READ
726 && command != I2C_SMBUS_I2C_BLOCK_DATA) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100727 len = inb_p(SMBHSTDAT0(priv));
Jean Delvarecf898dc2008-07-14 22:38:33 +0200728 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100729 dev_err(&priv->pci_dev->dev,
Jean Delvarecf898dc2008-07-14 22:38:33 +0200730 "Illegal SMBus block read size %d\n",
731 len);
732 /* Recover */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100733 while (inb_p(SMBHSTSTS(priv)) &
734 SMBHSTSTS_HOST_BUSY)
735 outb_p(SMBHSTSTS_BYTE_DONE,
736 SMBHSTSTS(priv));
737 outb_p(SMBHSTSTS_INTR, SMBHSTSTS(priv));
David Brownell97140342008-07-14 22:38:25 +0200738 return -EPROTO;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200739 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 data->block[0] = len;
741 }
742
743 /* Retrieve/store value in SMBBLKDAT */
744 if (read_write == I2C_SMBUS_READ)
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100745 data->block[i] = inb_p(SMBBLKDAT(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 if (read_write == I2C_SMBUS_WRITE && i+1 <= len)
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100747 outb_p(data->block[i+1], SMBBLKDAT(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Jean Delvarecf898dc2008-07-14 22:38:33 +0200749 /* signals SMBBLKDAT ready */
Jean Delvare6cad93c2012-07-24 14:13:58 +0200750 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200751 }
Jean Delvarecf898dc2008-07-14 22:38:33 +0200752
Jean Delvare6cad93c2012-07-24 14:13:58 +0200753 status = i801_wait_intr(priv);
754exit:
755 return i801_check_post(priv, status);
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200756}
757
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100758static int i801_set_block_buffer_mode(struct i801_priv *priv)
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200759{
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100760 outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_E32B, SMBAUXCTL(priv));
761 if ((inb_p(SMBAUXCTL(priv)) & SMBAUXCTL_E32B) == 0)
David Brownell97140342008-07-14 22:38:25 +0200762 return -EIO;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200763 return 0;
764}
765
766/* Block transaction function */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100767static int i801_block_transaction(struct i801_priv *priv,
768 union i2c_smbus_data *data, char read_write,
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200769 int command, int hwpec)
770{
771 int result = 0;
772 unsigned char hostc;
773
774 if (command == I2C_SMBUS_I2C_BLOCK_DATA) {
775 if (read_write == I2C_SMBUS_WRITE) {
776 /* set I2C_EN bit in configuration register */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100777 pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &hostc);
778 pci_write_config_byte(priv->pci_dev, SMBHSTCFG,
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200779 hostc | SMBHSTCFG_I2C_EN);
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100780 } else if (!(priv->features & FEATURE_I2C_BLOCK_READ)) {
781 dev_err(&priv->pci_dev->dev,
Jean Delvare63420642008-01-27 18:14:50 +0100782 "I2C block read is unsupported!\n");
David Brownell97140342008-07-14 22:38:25 +0200783 return -EOPNOTSUPP;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200784 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 }
786
Jean Delvare63420642008-01-27 18:14:50 +0100787 if (read_write == I2C_SMBUS_WRITE
788 || command == I2C_SMBUS_I2C_BLOCK_DATA) {
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200789 if (data->block[0] < 1)
790 data->block[0] = 1;
791 if (data->block[0] > I2C_SMBUS_BLOCK_MAX)
792 data->block[0] = I2C_SMBUS_BLOCK_MAX;
793 } else {
Jean Delvare63420642008-01-27 18:14:50 +0100794 data->block[0] = 32; /* max for SMBus block reads */
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200795 }
796
Jean Delvarec074c392010-03-13 20:56:53 +0100797 /* Experience has shown that the block buffer can only be used for
798 SMBus (not I2C) block transactions, even though the datasheet
799 doesn't mention this limitation. */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100800 if ((priv->features & FEATURE_BLOCK_BUFFER)
Jean Delvarec074c392010-03-13 20:56:53 +0100801 && command != I2C_SMBUS_I2C_BLOCK_DATA
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100802 && i801_set_block_buffer_mode(priv) == 0)
803 result = i801_block_transaction_by_block(priv, data,
804 read_write, hwpec);
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200805 else
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100806 result = i801_block_transaction_byte_by_byte(priv, data,
807 read_write,
Jean Delvare63420642008-01-27 18:14:50 +0100808 command, hwpec);
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200809
Jean Delvare63420642008-01-27 18:14:50 +0100810 if (command == I2C_SMBUS_I2C_BLOCK_DATA
811 && read_write == I2C_SMBUS_WRITE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 /* restore saved configuration register value */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100813 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, hostc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 }
815 return result;
816}
817
David Brownell97140342008-07-14 22:38:25 +0200818/* Return negative errno on error. */
Ivo Manca3fb21c62010-05-21 18:40:55 +0200819static s32 i801_access(struct i2c_adapter *adap, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 unsigned short flags, char read_write, u8 command,
Ivo Manca3fb21c62010-05-21 18:40:55 +0200821 int size, union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
Jean Delvaree8aac4a2005-10-26 21:34:42 +0200823 int hwpec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 int block = 0;
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200825 int ret = 0, xact = 0;
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100826 struct i801_priv *priv = i2c_get_adapdata(adap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827
Mika Westerberga7ae8192016-06-09 16:56:28 +0300828 mutex_lock(&priv->acpi_lock);
829 if (priv->acpi_reserved) {
830 mutex_unlock(&priv->acpi_lock);
831 return -EBUSY;
832 }
833
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200834 pm_runtime_get_sync(&priv->pci_dev->dev);
835
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100836 hwpec = (priv->features & FEATURE_SMBUS_PEC) && (flags & I2C_CLIENT_PEC)
Jean Delvaree8aac4a2005-10-26 21:34:42 +0200837 && size != I2C_SMBUS_QUICK
838 && size != I2C_SMBUS_I2C_BLOCK_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
840 switch (size) {
841 case I2C_SMBUS_QUICK:
842 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100843 SMBHSTADD(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 xact = I801_QUICK;
845 break;
846 case I2C_SMBUS_BYTE:
847 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100848 SMBHSTADD(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 if (read_write == I2C_SMBUS_WRITE)
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100850 outb_p(command, SMBHSTCMD(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 xact = I801_BYTE;
852 break;
853 case I2C_SMBUS_BYTE_DATA:
854 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100855 SMBHSTADD(priv));
856 outb_p(command, SMBHSTCMD(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 if (read_write == I2C_SMBUS_WRITE)
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100858 outb_p(data->byte, SMBHSTDAT0(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 xact = I801_BYTE_DATA;
860 break;
861 case I2C_SMBUS_WORD_DATA:
862 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100863 SMBHSTADD(priv));
864 outb_p(command, SMBHSTCMD(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 if (read_write == I2C_SMBUS_WRITE) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100866 outb_p(data->word & 0xff, SMBHSTDAT0(priv));
867 outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 }
869 xact = I801_WORD_DATA;
870 break;
871 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100873 SMBHSTADD(priv));
874 outb_p(command, SMBHSTCMD(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 block = 1;
876 break;
Jean Delvare63420642008-01-27 18:14:50 +0100877 case I2C_SMBUS_I2C_BLOCK_DATA:
Jean Delvareba9ad2a2016-10-11 13:13:27 +0200878 /*
879 * NB: page 240 of ICH5 datasheet shows that the R/#W
880 * bit should be cleared here, even when reading.
881 * However if SPD Write Disable is set (Lynx Point and later),
882 * the read will fail if we don't set the R/#W bit.
883 */
884 outb_p(((addr & 0x7f) << 1) |
885 ((priv->original_hstcfg & SMBHSTCFG_SPD_WD) ?
886 (read_write & 0x01) : 0),
887 SMBHSTADD(priv));
Jean Delvare63420642008-01-27 18:14:50 +0100888 if (read_write == I2C_SMBUS_READ) {
889 /* NB: page 240 of ICH5 datasheet also shows
890 * that DATA1 is the cmd field when reading */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100891 outb_p(command, SMBHSTDAT1(priv));
Jean Delvare63420642008-01-27 18:14:50 +0100892 } else
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100893 outb_p(command, SMBHSTCMD(priv));
Jean Delvare63420642008-01-27 18:14:50 +0100894 block = 1;
895 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 default:
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100897 dev_err(&priv->pci_dev->dev, "Unsupported transaction %d\n",
898 size);
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200899 ret = -EOPNOTSUPP;
900 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 }
902
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200903 if (hwpec) /* enable/disable hardware PEC */
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100904 outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_CRC, SMBAUXCTL(priv));
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200905 else
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100906 outb_p(inb_p(SMBAUXCTL(priv)) & (~SMBAUXCTL_CRC),
907 SMBAUXCTL(priv));
Jean Delvaree8aac4a2005-10-26 21:34:42 +0200908
Ivo Manca3fb21c62010-05-21 18:40:55 +0200909 if (block)
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100910 ret = i801_block_transaction(priv, data, read_write, size,
911 hwpec);
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200912 else
Daniel Kurtz37af8712012-07-24 14:13:58 +0200913 ret = i801_transaction(priv, xact);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914
Jean Delvarec79cfba2006-04-20 02:43:18 -0700915 /* Some BIOSes don't like it when PEC is enabled at reboot or resume
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200916 time, so we forcibly disable it after every transaction. Turn off
917 E32B for the same reason. */
Jean Delvarea0921b62008-01-27 18:14:50 +0100918 if (hwpec || block)
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100919 outb_p(inb_p(SMBAUXCTL(priv)) &
920 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
Jean Delvarec79cfba2006-04-20 02:43:18 -0700921
Ivo Manca3fb21c62010-05-21 18:40:55 +0200922 if (block)
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200923 goto out;
Ivo Manca3fb21c62010-05-21 18:40:55 +0200924 if (ret)
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200925 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 if ((read_write == I2C_SMBUS_WRITE) || (xact == I801_QUICK))
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200927 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928
929 switch (xact & 0x7f) {
930 case I801_BYTE: /* Result put in SMBHSTDAT0 */
931 case I801_BYTE_DATA:
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100932 data->byte = inb_p(SMBHSTDAT0(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 break;
934 case I801_WORD_DATA:
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100935 data->word = inb_p(SMBHSTDAT0(priv)) +
936 (inb_p(SMBHSTDAT1(priv)) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 break;
938 }
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200939
940out:
941 pm_runtime_mark_last_busy(&priv->pci_dev->dev);
942 pm_runtime_put_autosuspend(&priv->pci_dev->dev);
Mika Westerberga7ae8192016-06-09 16:56:28 +0300943 mutex_unlock(&priv->acpi_lock);
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +0200944 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945}
946
947
948static u32 i801_func(struct i2c_adapter *adapter)
949{
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100950 struct i801_priv *priv = i2c_get_adapdata(adapter);
951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
Jean Delvare369f6f42008-01-27 18:14:50 +0100953 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
954 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK |
David Woodhouse0cd96eb2010-10-31 21:06:59 +0100955 ((priv->features & FEATURE_SMBUS_PEC) ? I2C_FUNC_SMBUS_PEC : 0) |
956 ((priv->features & FEATURE_I2C_BLOCK_READ) ?
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200957 I2C_FUNC_SMBUS_READ_I2C_BLOCK : 0) |
958 ((priv->features & FEATURE_HOST_NOTIFY) ?
959 I2C_FUNC_SMBUS_HOST_NOTIFY : 0);
960}
961
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +0200962static void i801_enable_host_notify(struct i2c_adapter *adapter)
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200963{
964 struct i801_priv *priv = i2c_get_adapdata(adapter);
965
966 if (!(priv->features & FEATURE_HOST_NOTIFY))
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +0200967 return;
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200968
Benjamin Tissoires22e94bd2016-10-13 14:10:35 +0200969 if (!(SMBSLVCMD_HST_NTFY_INTREN & priv->original_slvcmd))
970 outb_p(SMBSLVCMD_HST_NTFY_INTREN | priv->original_slvcmd,
971 SMBSLVCMD(priv));
972
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +0200973 /* clear Host Notify bit to allow a new notification */
974 outb_p(SMBSLVSTS_HST_NTFY_STS, SMBSLVSTS(priv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975}
976
Benjamin Tissoires22e94bd2016-10-13 14:10:35 +0200977static void i801_disable_host_notify(struct i801_priv *priv)
978{
979 if (!(priv->features & FEATURE_HOST_NOTIFY))
980 return;
981
982 outb_p(priv->original_slvcmd, SMBSLVCMD(priv));
983}
984
Jean Delvare8f9082c2006-09-03 22:39:46 +0200985static const struct i2c_algorithm smbus_algorithm = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 .smbus_xfer = i801_access,
987 .functionality = i801_func,
988};
989
Jingoo Han392debf2013-12-03 08:11:20 +0900990static const struct pci_device_id i801_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AA_3) },
992 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AB_3) },
993 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801BA_2) },
994 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801CA_3) },
995 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_3) },
996 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801EB_3) },
997 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB_4) },
998 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_16) },
999 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH7_17) },
Jason Gastonb0a70b52005-04-16 15:24:45 -07001000 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB2_17) },
Jason Gaston8254fc42006-01-09 10:58:08 -08001001 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH8_5) },
Jason Gastonadbc2a12006-11-22 15:19:12 -08001002 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH9_6) },
Seth Heasleycb04e952010-10-04 13:27:14 -07001003 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_EP80579_1) },
Gaston, Jason Dd28dc712008-02-24 20:03:42 +01001004 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_4) },
1005 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_5) },
Seth Heasleycb04e952010-10-04 13:27:14 -07001006 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS) },
1007 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS) },
Seth Heasleye30d9852010-10-31 21:06:59 +01001008 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS) },
David Woodhouse55fee8d2010-10-31 21:07:00 +01001009 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0) },
1010 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1) },
1011 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2) },
Seth Heasley662cda82011-03-20 14:50:53 +01001012 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS) },
Seth Heasley6e2a8512011-05-24 20:58:49 +02001013 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS) },
Seth Heasley062737f2012-03-26 21:47:19 +02001014 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS) },
James Ralston4a8f1dd2012-09-10 10:14:02 +02001015 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS) },
Seth Heasleyc2db409c2013-01-30 15:25:32 +00001016 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_AVOTON_SMBUS) },
James Ralstona3fc0ff2013-02-14 09:15:33 +00001017 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS) },
1018 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0) },
1019 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1) },
1020 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2) },
Seth Heasleyf39901c2013-06-19 16:59:57 -07001021 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_COLETOCREEK_SMBUS) },
Mika Westerberg9827f9e2017-02-01 19:20:59 +03001022 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_GEMINILAKE_SMBUS) },
Jean Delvareb299de82014-07-17 15:04:41 +02001023 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WILDCATPOINT_SMBUS) },
James Ralstonafc65922013-11-04 09:29:48 -08001024 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_SMBUS) },
Chew, Kean ho1b31e9b2014-03-01 00:03:56 +08001025 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BAYTRAIL_SMBUS) },
Alan Cox39e8e302014-08-19 17:37:28 +03001026 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BRASWELL_SMBUS) },
james.d.ralston@intel.com3e27a842014-10-13 15:20:24 -07001027 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS) },
Devin Ryles3eee17992014-11-05 16:30:03 -05001028 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS) },
Jarkko Nikulacb09d942017-09-21 16:23:16 +03001029 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_CDF_SMBUS) },
Mika Westerberg84d7f2e2015-10-13 15:41:39 +03001030 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_DNV_SMBUS) },
Jarkko Nikuladd77f422015-10-22 17:16:58 +03001031 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BROXTON_SMBUS) },
Alexandra Yatescdc5a312015-11-05 11:40:25 -08001032 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LEWISBURG_SMBUS) },
1033 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LEWISBURG_SSKU_SMBUS) },
Andy Shevchenko31158762016-09-23 11:56:01 +03001034 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_KABYLAKE_PCH_H_SMBUS) },
Srinivas Pandruvada09a1de02017-05-18 11:23:06 +03001035 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_CANNONLAKE_H_SMBUS) },
1036 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_CANNONLAKE_LP_SMBUS) },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 { 0, }
1038};
1039
Ivo Manca3fb21c62010-05-21 18:40:55 +02001040MODULE_DEVICE_TABLE(pci, i801_ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
Jean Delvare8eacfce2011-05-24 20:58:49 +02001042#if defined CONFIG_X86 && defined CONFIG_DMI
Jean Delvare1561bfe2009-01-07 14:29:17 +01001043static unsigned char apanel_addr;
1044
1045/* Scan the system ROM for the signature "FJKEYINF" */
1046static __init const void __iomem *bios_signature(const void __iomem *bios)
1047{
1048 ssize_t offset;
1049 const unsigned char signature[] = "FJKEYINF";
1050
1051 for (offset = 0; offset < 0x10000; offset += 0x10) {
1052 if (check_signature(bios + offset, signature,
1053 sizeof(signature)-1))
1054 return bios + offset;
1055 }
1056 return NULL;
1057}
1058
1059static void __init input_apanel_init(void)
1060{
1061 void __iomem *bios;
1062 const void __iomem *p;
1063
1064 bios = ioremap(0xF0000, 0x10000); /* Can't fail */
1065 p = bios_signature(bios);
1066 if (p) {
1067 /* just use the first address */
1068 apanel_addr = readb(p + 8 + 3) >> 1;
1069 }
1070 iounmap(bios);
1071}
Jean Delvare1561bfe2009-01-07 14:29:17 +01001072
Hans de Goedefa5bfab2009-03-30 21:46:44 +02001073struct dmi_onboard_device_info {
1074 const char *name;
1075 u8 type;
1076 unsigned short i2c_addr;
1077 const char *i2c_type;
1078};
1079
Bill Pemberton0b255e92012-11-27 15:59:38 -05001080static const struct dmi_onboard_device_info dmi_devices[] = {
Hans de Goedefa5bfab2009-03-30 21:46:44 +02001081 { "Syleus", DMI_DEV_TYPE_OTHER, 0x73, "fscsyl" },
1082 { "Hermes", DMI_DEV_TYPE_OTHER, 0x73, "fscher" },
1083 { "Hades", DMI_DEV_TYPE_OTHER, 0x73, "fschds" },
1084};
1085
Bill Pemberton0b255e92012-11-27 15:59:38 -05001086static void dmi_check_onboard_device(u8 type, const char *name,
1087 struct i2c_adapter *adap)
Hans de Goedefa5bfab2009-03-30 21:46:44 +02001088{
1089 int i;
1090 struct i2c_board_info info;
1091
1092 for (i = 0; i < ARRAY_SIZE(dmi_devices); i++) {
1093 /* & ~0x80, ignore enabled/disabled bit */
1094 if ((type & ~0x80) != dmi_devices[i].type)
1095 continue;
Jean Delvarefaabd472010-07-09 16:22:51 +02001096 if (strcasecmp(name, dmi_devices[i].name))
Hans de Goedefa5bfab2009-03-30 21:46:44 +02001097 continue;
1098
1099 memset(&info, 0, sizeof(struct i2c_board_info));
1100 info.addr = dmi_devices[i].i2c_addr;
1101 strlcpy(info.type, dmi_devices[i].i2c_type, I2C_NAME_SIZE);
1102 i2c_new_device(adap, &info);
1103 break;
1104 }
1105}
1106
1107/* We use our own function to check for onboard devices instead of
1108 dmi_find_device() as some buggy BIOS's have the devices we are interested
1109 in marked as disabled */
Bill Pemberton0b255e92012-11-27 15:59:38 -05001110static void dmi_check_onboard_devices(const struct dmi_header *dm, void *adap)
Hans de Goedefa5bfab2009-03-30 21:46:44 +02001111{
1112 int i, count;
1113
1114 if (dm->type != 10)
1115 return;
1116
1117 count = (dm->length - sizeof(struct dmi_header)) / 2;
1118 for (i = 0; i < count; i++) {
1119 const u8 *d = (char *)(dm + 1) + (i * 2);
1120 const char *name = ((char *) dm) + dm->length;
1121 u8 type = d[0];
1122 u8 s = d[1];
1123
1124 if (!s)
1125 continue;
1126 s--;
1127 while (s > 0 && name[0]) {
1128 name += strlen(name) + 1;
1129 s--;
1130 }
1131 if (name[0] == 0) /* Bogus string reference */
1132 continue;
1133
1134 dmi_check_onboard_device(type, name, adap);
1135 }
1136}
Hans de Goedefa5bfab2009-03-30 21:46:44 +02001137
Jean Delvaree7198fb2011-05-24 20:58:49 +02001138/* Register optional slaves */
Bill Pemberton0b255e92012-11-27 15:59:38 -05001139static void i801_probe_optional_slaves(struct i801_priv *priv)
Jean Delvaree7198fb2011-05-24 20:58:49 +02001140{
1141 /* Only register slaves on main SMBus channel */
1142 if (priv->features & FEATURE_IDF)
1143 return;
1144
Jean Delvaree7198fb2011-05-24 20:58:49 +02001145 if (apanel_addr) {
1146 struct i2c_board_info info;
1147
1148 memset(&info, 0, sizeof(struct i2c_board_info));
1149 info.addr = apanel_addr;
1150 strlcpy(info.type, "fujitsu_apanel", I2C_NAME_SIZE);
1151 i2c_new_device(&priv->adapter, &info);
1152 }
Jean Delvare8eacfce2011-05-24 20:58:49 +02001153
Jean Delvaree7198fb2011-05-24 20:58:49 +02001154 if (dmi_name_in_vendors("FUJITSU"))
1155 dmi_walk(dmi_check_onboard_devices, &priv->adapter);
Jean Delvaree7198fb2011-05-24 20:58:49 +02001156}
Jean Delvare8eacfce2011-05-24 20:58:49 +02001157#else
1158static void __init input_apanel_init(void) {}
Bill Pemberton0b255e92012-11-27 15:59:38 -05001159static void i801_probe_optional_slaves(struct i801_priv *priv) {}
Jean Delvare8eacfce2011-05-24 20:58:49 +02001160#endif /* CONFIG_X86 && CONFIG_DMI */
Jean Delvaree7198fb2011-05-24 20:58:49 +02001161
Javier Martinez Canillas175c7082016-07-21 12:11:01 -04001162#if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001163static struct i801_mux_config i801_mux_config_asus_z8_d12 = {
1164 .gpio_chip = "gpio_ich",
1165 .values = { 0x02, 0x03 },
1166 .n_values = 2,
1167 .classes = { I2C_CLASS_SPD, I2C_CLASS_SPD },
1168 .gpios = { 52, 53 },
1169 .n_gpios = 2,
1170};
1171
1172static struct i801_mux_config i801_mux_config_asus_z8_d18 = {
1173 .gpio_chip = "gpio_ich",
1174 .values = { 0x02, 0x03, 0x01 },
1175 .n_values = 3,
1176 .classes = { I2C_CLASS_SPD, I2C_CLASS_SPD, I2C_CLASS_SPD },
1177 .gpios = { 52, 53 },
1178 .n_gpios = 2,
1179};
1180
Bill Pemberton0b255e92012-11-27 15:59:38 -05001181static const struct dmi_system_id mux_dmi_table[] = {
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001182 {
1183 .matches = {
1184 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1185 DMI_MATCH(DMI_BOARD_NAME, "Z8NA-D6(C)"),
1186 },
1187 .driver_data = &i801_mux_config_asus_z8_d12,
1188 },
1189 {
1190 .matches = {
1191 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1192 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)E-D12(X)"),
1193 },
1194 .driver_data = &i801_mux_config_asus_z8_d12,
1195 },
1196 {
1197 .matches = {
1198 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1199 DMI_MATCH(DMI_BOARD_NAME, "Z8NH-D12"),
1200 },
1201 .driver_data = &i801_mux_config_asus_z8_d12,
1202 },
1203 {
1204 .matches = {
1205 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1206 DMI_MATCH(DMI_BOARD_NAME, "Z8PH-D12/IFB"),
1207 },
1208 .driver_data = &i801_mux_config_asus_z8_d12,
1209 },
1210 {
1211 .matches = {
1212 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1213 DMI_MATCH(DMI_BOARD_NAME, "Z8NR-D12"),
1214 },
1215 .driver_data = &i801_mux_config_asus_z8_d12,
1216 },
1217 {
1218 .matches = {
1219 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1220 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)H-D12"),
1221 },
1222 .driver_data = &i801_mux_config_asus_z8_d12,
1223 },
1224 {
1225 .matches = {
1226 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1227 DMI_MATCH(DMI_BOARD_NAME, "Z8PG-D18"),
1228 },
1229 .driver_data = &i801_mux_config_asus_z8_d18,
1230 },
1231 {
1232 .matches = {
1233 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1234 DMI_MATCH(DMI_BOARD_NAME, "Z8PE-D18"),
1235 },
1236 .driver_data = &i801_mux_config_asus_z8_d18,
1237 },
1238 {
1239 .matches = {
1240 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1241 DMI_MATCH(DMI_BOARD_NAME, "Z8PS-D12"),
1242 },
1243 .driver_data = &i801_mux_config_asus_z8_d12,
1244 },
1245 { }
1246};
1247
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001248/* Setup multiplexing if needed */
Bill Pemberton0b255e92012-11-27 15:59:38 -05001249static int i801_add_mux(struct i801_priv *priv)
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001250{
1251 struct device *dev = &priv->adapter.dev;
1252 const struct i801_mux_config *mux_config;
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001253 struct i2c_mux_gpio_platform_data gpio_data;
Jean Delvaref82b8622012-10-05 22:23:54 +02001254 int err;
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001255
1256 if (!priv->mux_drvdata)
1257 return 0;
1258 mux_config = priv->mux_drvdata;
1259
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001260 /* Prepare the platform data */
1261 memset(&gpio_data, 0, sizeof(struct i2c_mux_gpio_platform_data));
1262 gpio_data.parent = priv->adapter.nr;
1263 gpio_data.values = mux_config->values;
1264 gpio_data.n_values = mux_config->n_values;
1265 gpio_data.classes = mux_config->classes;
Jean Delvaref82b8622012-10-05 22:23:54 +02001266 gpio_data.gpio_chip = mux_config->gpio_chip;
1267 gpio_data.gpios = mux_config->gpios;
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001268 gpio_data.n_gpios = mux_config->n_gpios;
1269 gpio_data.idle = I2C_MUX_GPIO_NO_IDLE;
1270
1271 /* Register the mux device */
1272 priv->mux_pdev = platform_device_register_data(dev, "i2c-mux-gpio",
Jean Delvaref82b8622012-10-05 22:23:54 +02001273 PLATFORM_DEVID_AUTO, &gpio_data,
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001274 sizeof(struct i2c_mux_gpio_platform_data));
1275 if (IS_ERR(priv->mux_pdev)) {
1276 err = PTR_ERR(priv->mux_pdev);
1277 priv->mux_pdev = NULL;
1278 dev_err(dev, "Failed to register i2c-mux-gpio device\n");
1279 return err;
1280 }
1281
1282 return 0;
1283}
1284
Bill Pemberton0b255e92012-11-27 15:59:38 -05001285static void i801_del_mux(struct i801_priv *priv)
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001286{
1287 if (priv->mux_pdev)
1288 platform_device_unregister(priv->mux_pdev);
1289}
1290
Bill Pemberton0b255e92012-11-27 15:59:38 -05001291static unsigned int i801_get_adapter_class(struct i801_priv *priv)
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001292{
1293 const struct dmi_system_id *id;
1294 const struct i801_mux_config *mux_config;
1295 unsigned int class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
1296 int i;
1297
1298 id = dmi_first_match(mux_dmi_table);
1299 if (id) {
Jean Delvare28901f52012-10-28 21:37:01 +01001300 /* Remove branch classes from trunk */
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001301 mux_config = id->driver_data;
1302 for (i = 0; i < mux_config->n_values; i++)
1303 class &= ~mux_config->classes[i];
1304
1305 /* Remember for later */
1306 priv->mux_drvdata = mux_config;
1307 }
1308
1309 return class;
1310}
1311#else
1312static inline int i801_add_mux(struct i801_priv *priv) { return 0; }
1313static inline void i801_del_mux(struct i801_priv *priv) { }
1314
1315static inline unsigned int i801_get_adapter_class(struct i801_priv *priv)
1316{
1317 return I2C_CLASS_HWMON | I2C_CLASS_SPD;
1318}
1319#endif
1320
Mika Westerberg94246932015-08-06 13:46:25 +01001321static const struct itco_wdt_platform_data tco_platform_data = {
1322 .name = "Intel PCH",
1323 .version = 4,
1324};
1325
1326static DEFINE_SPINLOCK(p2sb_spinlock);
1327
1328static void i801_add_tco(struct i801_priv *priv)
1329{
1330 struct pci_dev *pci_dev = priv->pci_dev;
1331 struct resource tco_res[3], *res;
1332 struct platform_device *pdev;
1333 unsigned int devfn;
1334 u32 tco_base, tco_ctl;
1335 u32 base_addr, ctrl_val;
1336 u64 base64_addr;
Qiuxu Zhuobfd44732017-08-15 00:04:50 +08001337 u8 hidden;
Mika Westerberg94246932015-08-06 13:46:25 +01001338
1339 if (!(priv->features & FEATURE_TCO))
1340 return;
1341
1342 pci_read_config_dword(pci_dev, TCOBASE, &tco_base);
1343 pci_read_config_dword(pci_dev, TCOCTL, &tco_ctl);
1344 if (!(tco_ctl & TCOCTL_EN))
1345 return;
1346
1347 memset(tco_res, 0, sizeof(tco_res));
1348
1349 res = &tco_res[ICH_RES_IO_TCO];
1350 res->start = tco_base & ~1;
1351 res->end = res->start + 32 - 1;
1352 res->flags = IORESOURCE_IO;
1353
1354 /*
1355 * Power Management registers.
1356 */
1357 devfn = PCI_DEVFN(PCI_SLOT(pci_dev->devfn), 2);
1358 pci_bus_read_config_dword(pci_dev->bus, devfn, ACPIBASE, &base_addr);
1359
1360 res = &tco_res[ICH_RES_IO_SMI];
1361 res->start = (base_addr & ~1) + ACPIBASE_SMI_OFF;
1362 res->end = res->start + 3;
1363 res->flags = IORESOURCE_IO;
1364
1365 /*
1366 * Enable the ACPI I/O space.
1367 */
1368 pci_bus_read_config_dword(pci_dev->bus, devfn, ACPICTRL, &ctrl_val);
1369 ctrl_val |= ACPICTRL_EN;
1370 pci_bus_write_config_dword(pci_dev->bus, devfn, ACPICTRL, ctrl_val);
1371
1372 /*
1373 * We must access the NO_REBOOT bit over the Primary to Sideband
1374 * bridge (P2SB). The BIOS prevents the P2SB device from being
1375 * enumerated by the PCI subsystem, so we need to unhide/hide it
1376 * to lookup the P2SB BAR.
1377 */
1378 spin_lock(&p2sb_spinlock);
1379
1380 devfn = PCI_DEVFN(PCI_SLOT(pci_dev->devfn), 1);
1381
Qiuxu Zhuobfd44732017-08-15 00:04:50 +08001382 /* Unhide the P2SB device, if it is hidden */
1383 pci_bus_read_config_byte(pci_dev->bus, devfn, 0xe1, &hidden);
1384 if (hidden)
1385 pci_bus_write_config_byte(pci_dev->bus, devfn, 0xe1, 0x0);
Mika Westerberg94246932015-08-06 13:46:25 +01001386
1387 pci_bus_read_config_dword(pci_dev->bus, devfn, SBREG_BAR, &base_addr);
1388 base64_addr = base_addr & 0xfffffff0;
1389
1390 pci_bus_read_config_dword(pci_dev->bus, devfn, SBREG_BAR + 0x4, &base_addr);
1391 base64_addr |= (u64)base_addr << 32;
1392
Qiuxu Zhuobfd44732017-08-15 00:04:50 +08001393 /* Hide the P2SB device, if it was hidden before */
1394 if (hidden)
1395 pci_bus_write_config_byte(pci_dev->bus, devfn, 0xe1, hidden);
Mika Westerberg94246932015-08-06 13:46:25 +01001396 spin_unlock(&p2sb_spinlock);
1397
1398 res = &tco_res[ICH_RES_MEM_OFF];
1399 res->start = (resource_size_t)base64_addr + SBREG_SMBCTRL;
1400 res->end = res->start + 3;
1401 res->flags = IORESOURCE_MEM;
1402
1403 pdev = platform_device_register_resndata(&pci_dev->dev, "iTCO_wdt", -1,
1404 tco_res, 3, &tco_platform_data,
1405 sizeof(tco_platform_data));
1406 if (IS_ERR(pdev)) {
1407 dev_warn(&pci_dev->dev, "failed to create iTCO device\n");
1408 return;
1409 }
1410
1411 priv->tco_pdev = pdev;
1412}
1413
Mika Westerberga7ae8192016-06-09 16:56:28 +03001414#ifdef CONFIG_ACPI
1415static acpi_status
1416i801_acpi_io_handler(u32 function, acpi_physical_address address, u32 bits,
1417 u64 *value, void *handler_context, void *region_context)
1418{
1419 struct i801_priv *priv = handler_context;
1420 struct pci_dev *pdev = priv->pci_dev;
1421 acpi_status status;
1422
1423 /*
1424 * Once BIOS AML code touches the OpRegion we warn and inhibit any
1425 * further access from the driver itself. This device is now owned
1426 * by the system firmware.
1427 */
1428 mutex_lock(&priv->acpi_lock);
1429
1430 if (!priv->acpi_reserved) {
1431 priv->acpi_reserved = true;
1432
1433 dev_warn(&pdev->dev, "BIOS is accessing SMBus registers\n");
1434 dev_warn(&pdev->dev, "Driver SMBus register access inhibited\n");
1435
1436 /*
1437 * BIOS is accessing the host controller so prevent it from
1438 * suspending automatically from now on.
1439 */
1440 pm_runtime_get_sync(&pdev->dev);
1441 }
1442
1443 if ((function & ACPI_IO_MASK) == ACPI_READ)
1444 status = acpi_os_read_port(address, (u32 *)value, bits);
1445 else
1446 status = acpi_os_write_port(address, (u32)*value, bits);
1447
1448 mutex_unlock(&priv->acpi_lock);
1449
1450 return status;
1451}
1452
1453static int i801_acpi_probe(struct i801_priv *priv)
1454{
1455 struct acpi_device *adev;
1456 acpi_status status;
1457
1458 adev = ACPI_COMPANION(&priv->pci_dev->dev);
1459 if (adev) {
1460 status = acpi_install_address_space_handler(adev->handle,
1461 ACPI_ADR_SPACE_SYSTEM_IO, i801_acpi_io_handler,
1462 NULL, priv);
1463 if (ACPI_SUCCESS(status))
1464 return 0;
1465 }
1466
1467 return acpi_check_resource_conflict(&priv->pci_dev->resource[SMBBAR]);
1468}
1469
1470static void i801_acpi_remove(struct i801_priv *priv)
1471{
1472 struct acpi_device *adev;
1473
1474 adev = ACPI_COMPANION(&priv->pci_dev->dev);
1475 if (!adev)
1476 return;
1477
1478 acpi_remove_address_space_handler(adev->handle,
1479 ACPI_ADR_SPACE_SYSTEM_IO, i801_acpi_io_handler);
1480
1481 mutex_lock(&priv->acpi_lock);
1482 if (priv->acpi_reserved)
1483 pm_runtime_put(&priv->pci_dev->dev);
1484 mutex_unlock(&priv->acpi_lock);
1485}
1486#else
1487static inline int i801_acpi_probe(struct i801_priv *priv) { return 0; }
1488static inline void i801_acpi_remove(struct i801_priv *priv) { }
1489#endif
1490
Bill Pemberton0b255e92012-11-27 15:59:38 -05001491static int i801_probe(struct pci_dev *dev, const struct pci_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492{
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001493 unsigned char temp;
Jean Delvareadff6872010-05-21 18:40:54 +02001494 int err, i;
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001495 struct i801_priv *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Jarkko Nikula1621c592015-02-13 15:52:23 +02001497 priv = devm_kzalloc(&dev->dev, sizeof(*priv), GFP_KERNEL);
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001498 if (!priv)
1499 return -ENOMEM;
1500
1501 i2c_set_adapdata(&priv->adapter, priv);
1502 priv->adapter.owner = THIS_MODULE;
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001503 priv->adapter.class = i801_get_adapter_class(priv);
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001504 priv->adapter.algo = &smbus_algorithm;
Dustin Byford8eb5c872015-10-23 12:27:07 -07001505 priv->adapter.dev.parent = &dev->dev;
1506 ACPI_COMPANION_SET(&priv->adapter.dev, ACPI_COMPANION(&dev->dev));
1507 priv->adapter.retries = 3;
Mika Westerberga7ae8192016-06-09 16:56:28 +03001508 mutex_init(&priv->acpi_lock);
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001509
1510 priv->pci_dev = dev;
Jean Delvare250d1bd2006-12-10 21:21:33 +01001511 switch (dev->device) {
Mika Westerberg94246932015-08-06 13:46:25 +01001512 case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS:
1513 case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS:
Srinivas Pandruvada09a1de02017-05-18 11:23:06 +03001514 case PCI_DEVICE_ID_INTEL_CANNONLAKE_H_SMBUS:
1515 case PCI_DEVICE_ID_INTEL_CANNONLAKE_LP_SMBUS:
Alexandra Yates1a1503c2016-02-17 18:21:21 -08001516 case PCI_DEVICE_ID_INTEL_LEWISBURG_SMBUS:
1517 case PCI_DEVICE_ID_INTEL_LEWISBURG_SSKU_SMBUS:
Jarkko Nikulacb09d942017-09-21 16:23:16 +03001518 case PCI_DEVICE_ID_INTEL_CDF_SMBUS:
Mika Westerberg84d7f2e2015-10-13 15:41:39 +03001519 case PCI_DEVICE_ID_INTEL_DNV_SMBUS:
Andy Shevchenko31158762016-09-23 11:56:01 +03001520 case PCI_DEVICE_ID_INTEL_KABYLAKE_PCH_H_SMBUS:
Mika Westerberg94246932015-08-06 13:46:25 +01001521 priv->features |= FEATURE_I2C_BLOCK_READ;
1522 priv->features |= FEATURE_IRQ;
1523 priv->features |= FEATURE_SMBUS_PEC;
1524 priv->features |= FEATURE_BLOCK_BUFFER;
Mika Westerberg1f6dbb02016-09-20 15:30:53 +03001525 /* If we have ACPI based watchdog use that instead */
1526 if (!acpi_has_watchdog())
1527 priv->features |= FEATURE_TCO;
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +02001528 priv->features |= FEATURE_HOST_NOTIFY;
Mika Westerberg94246932015-08-06 13:46:25 +01001529 break;
1530
Jean Delvaree7198fb2011-05-24 20:58:49 +02001531 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0:
1532 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1:
1533 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2:
James Ralstona3fc0ff2013-02-14 09:15:33 +00001534 case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0:
1535 case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1:
1536 case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2:
Jean Delvaree7198fb2011-05-24 20:58:49 +02001537 priv->features |= FEATURE_IDF;
1538 /* fall through */
Jean Delvaree0e8398c2010-05-21 18:40:55 +02001539 default:
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001540 priv->features |= FEATURE_I2C_BLOCK_READ;
Jean Delvare6676a842012-12-16 21:11:55 +01001541 priv->features |= FEATURE_IRQ;
Jean Delvare63420642008-01-27 18:14:50 +01001542 /* fall through */
1543 case PCI_DEVICE_ID_INTEL_82801DB_3:
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001544 priv->features |= FEATURE_SMBUS_PEC;
1545 priv->features |= FEATURE_BLOCK_BUFFER;
Jean Delvaree0e8398c2010-05-21 18:40:55 +02001546 /* fall through */
1547 case PCI_DEVICE_ID_INTEL_82801CA_3:
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +02001548 priv->features |= FEATURE_HOST_NOTIFY;
1549 /* fall through */
Jean Delvaree0e8398c2010-05-21 18:40:55 +02001550 case PCI_DEVICE_ID_INTEL_82801BA_2:
1551 case PCI_DEVICE_ID_INTEL_82801AB_3:
1552 case PCI_DEVICE_ID_INTEL_82801AA_3:
Jean Delvare250d1bd2006-12-10 21:21:33 +01001553 break;
Jean Delvare250d1bd2006-12-10 21:21:33 +01001554 }
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001555
Jean Delvareadff6872010-05-21 18:40:54 +02001556 /* Disable features on user request */
1557 for (i = 0; i < ARRAY_SIZE(i801_feature_names); i++) {
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001558 if (priv->features & disable_features & (1 << i))
Jean Delvareadff6872010-05-21 18:40:54 +02001559 dev_notice(&dev->dev, "%s disabled by user\n",
1560 i801_feature_names[i]);
1561 }
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001562 priv->features &= ~disable_features;
Jean Delvareadff6872010-05-21 18:40:54 +02001563
Jarkko Nikulafef220d2015-02-13 15:52:25 +02001564 err = pcim_enable_device(dev);
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001565 if (err) {
1566 dev_err(&dev->dev, "Failed to enable SMBus PCI device (%d)\n",
1567 err);
Jarkko Nikulafef220d2015-02-13 15:52:25 +02001568 return err;
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001569 }
Jarkko Nikulafef220d2015-02-13 15:52:25 +02001570 pcim_pin_device(dev);
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001571
1572 /* Determine the address of the SMBus area */
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001573 priv->smba = pci_resource_start(dev, SMBBAR);
1574 if (!priv->smba) {
Jarkko Nikula9cbbf3d2015-02-13 15:52:21 +02001575 dev_err(&dev->dev,
1576 "SMBus base address uninitialized, upgrade BIOS\n");
Jarkko Nikulafef220d2015-02-13 15:52:25 +02001577 return -ENODEV;
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001578 }
1579
Mika Westerberga7ae8192016-06-09 16:56:28 +03001580 if (i801_acpi_probe(priv))
Jarkko Nikulafef220d2015-02-13 15:52:25 +02001581 return -ENODEV;
Jean Delvare54fb4a052008-07-14 22:38:33 +02001582
Jarkko Nikulafef220d2015-02-13 15:52:25 +02001583 err = pcim_iomap_regions(dev, 1 << SMBBAR,
1584 dev_driver_string(&dev->dev));
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001585 if (err) {
Jarkko Nikula9cbbf3d2015-02-13 15:52:21 +02001586 dev_err(&dev->dev,
1587 "Failed to request SMBus region 0x%lx-0x%Lx\n",
1588 priv->smba,
Andrew Morton598736c2006-06-30 01:56:20 -07001589 (unsigned long long)pci_resource_end(dev, SMBBAR));
Mika Westerberga7ae8192016-06-09 16:56:28 +03001590 i801_acpi_remove(priv);
Jarkko Nikulafef220d2015-02-13 15:52:25 +02001591 return err;
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001592 }
1593
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001594 pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &temp);
1595 priv->original_hstcfg = temp;
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001596 temp &= ~SMBHSTCFG_I2C_EN; /* SMBus timing */
1597 if (!(temp & SMBHSTCFG_HST_EN)) {
1598 dev_info(&dev->dev, "Enabling SMBus device\n");
1599 temp |= SMBHSTCFG_HST_EN;
1600 }
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001601 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, temp);
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001602
Daniel Kurtz636752b2012-07-24 14:13:58 +02001603 if (temp & SMBHSTCFG_SMB_SMI_EN) {
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001604 dev_dbg(&dev->dev, "SMBus using interrupt SMI#\n");
Daniel Kurtz636752b2012-07-24 14:13:58 +02001605 /* Disable SMBus interrupt feature if SMBus using SMI# */
1606 priv->features &= ~FEATURE_IRQ;
Daniel Kurtz636752b2012-07-24 14:13:58 +02001607 }
Jean Delvareba9ad2a2016-10-11 13:13:27 +02001608 if (temp & SMBHSTCFG_SPD_WD)
1609 dev_info(&dev->dev, "SPD Write Disable is set\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610
Jean Delvarea0921b62008-01-27 18:14:50 +01001611 /* Clear special mode bits */
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001612 if (priv->features & (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER))
1613 outb_p(inb_p(SMBAUXCTL(priv)) &
1614 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
Jean Delvarea0921b62008-01-27 18:14:50 +01001615
Jean Delvarea086bb82018-04-11 18:03:31 +02001616 /* Remember original Host Notify setting */
1617 if (priv->features & FEATURE_HOST_NOTIFY)
1618 priv->original_slvcmd = inb_p(SMBSLVCMD(priv));
1619
Jean Delvareb3b8df92014-11-12 10:20:40 +01001620 /* Default timeout in interrupt mode: 200 ms */
1621 priv->adapter.timeout = HZ / 5;
1622
Hans de Goede6e0c9502017-11-22 12:28:17 +01001623 if (dev->irq == IRQ_NOTCONNECTED)
1624 priv->features &= ~FEATURE_IRQ;
1625
Daniel Kurtz636752b2012-07-24 14:13:58 +02001626 if (priv->features & FEATURE_IRQ) {
Jean Delvareaeb8a3d2014-11-12 10:25:37 +01001627 u16 pcictl, pcists;
1628
1629 /* Complain if an interrupt is already pending */
1630 pci_read_config_word(priv->pci_dev, SMBPCISTS, &pcists);
1631 if (pcists & SMBPCISTS_INTS)
1632 dev_warn(&dev->dev, "An interrupt is pending!\n");
1633
1634 /* Check if interrupts have been disabled */
1635 pci_read_config_word(priv->pci_dev, SMBPCICTL, &pcictl);
1636 if (pcictl & SMBPCICTL_INTDIS) {
1637 dev_info(&dev->dev, "Interrupts are disabled\n");
1638 priv->features &= ~FEATURE_IRQ;
1639 }
1640 }
1641
1642 if (priv->features & FEATURE_IRQ) {
Daniel Kurtz636752b2012-07-24 14:13:58 +02001643 init_waitqueue_head(&priv->waitq);
1644
Jarkko Nikula1621c592015-02-13 15:52:23 +02001645 err = devm_request_irq(&dev->dev, dev->irq, i801_isr,
1646 IRQF_SHARED,
1647 dev_driver_string(&dev->dev), priv);
Daniel Kurtz636752b2012-07-24 14:13:58 +02001648 if (err) {
1649 dev_err(&dev->dev, "Failed to allocate irq %d: %d\n",
1650 dev->irq, err);
Jean Delvareae944712014-11-12 10:24:07 +01001651 priv->features &= ~FEATURE_IRQ;
Daniel Kurtz636752b2012-07-24 14:13:58 +02001652 }
1653 }
Jean Delvareae944712014-11-12 10:24:07 +01001654 dev_info(&dev->dev, "SMBus using %s\n",
1655 priv->features & FEATURE_IRQ ? "PCI interrupt" : "polling");
Daniel Kurtz636752b2012-07-24 14:13:58 +02001656
Mika Westerberg94246932015-08-06 13:46:25 +01001657 i801_add_tco(priv);
1658
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001659 snprintf(priv->adapter.name, sizeof(priv->adapter.name),
1660 "SMBus I801 adapter at %04lx", priv->smba);
1661 err = i2c_add_adapter(&priv->adapter);
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001662 if (err) {
Mika Westerberga7ae8192016-06-09 16:56:28 +03001663 i801_acpi_remove(priv);
Jarkko Nikulafef220d2015-02-13 15:52:25 +02001664 return err;
Jean Delvare02dd7ae2006-06-12 21:53:41 +02001665 }
Jean Delvare1561bfe2009-01-07 14:29:17 +01001666
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +02001667 i801_enable_host_notify(&priv->adapter);
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +02001668
Jean Delvaree7198fb2011-05-24 20:58:49 +02001669 i801_probe_optional_slaves(priv);
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001670 /* We ignore errors - multiplexing is optional */
1671 i801_add_mux(priv);
Jean Delvare1561bfe2009-01-07 14:29:17 +01001672
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001673 pci_set_drvdata(dev, priv);
Daniel Kurtz636752b2012-07-24 14:13:58 +02001674
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +02001675 pm_runtime_set_autosuspend_delay(&dev->dev, 1000);
1676 pm_runtime_use_autosuspend(&dev->dev);
1677 pm_runtime_put_autosuspend(&dev->dev);
1678 pm_runtime_allow(&dev->dev);
1679
Daniel Ritzd6fcb3b2006-06-27 18:40:54 +02001680 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681}
1682
Bill Pemberton0b255e92012-11-27 15:59:38 -05001683static void i801_remove(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684{
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001685 struct i801_priv *priv = pci_get_drvdata(dev);
1686
Jarkko Nikulaa7401ca2016-03-10 14:12:22 +02001687 pm_runtime_forbid(&dev->dev);
1688 pm_runtime_get_noresume(&dev->dev);
1689
Benjamin Tissoires22e94bd2016-10-13 14:10:35 +02001690 i801_disable_host_notify(priv);
Jean Delvare3ad7ea12012-10-05 22:23:53 +02001691 i801_del_mux(priv);
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001692 i2c_del_adapter(&priv->adapter);
Mika Westerberga7ae8192016-06-09 16:56:28 +03001693 i801_acpi_remove(priv);
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001694 pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
Daniel Kurtz636752b2012-07-24 14:13:58 +02001695
Mika Westerberg94246932015-08-06 13:46:25 +01001696 platform_device_unregister(priv->tco_pdev);
1697
Daniel Ritzd6fcb3b2006-06-27 18:40:54 +02001698 /*
1699 * do not call pci_disable_device(dev) since it can cause hard hangs on
1700 * some systems during power-off (eg. Fujitsu-Siemens Lifebook E8010)
1701 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702}
1703
Jean Delvaref7f6d912018-04-11 18:05:34 +02001704static void i801_shutdown(struct pci_dev *dev)
1705{
1706 struct i801_priv *priv = pci_get_drvdata(dev);
1707
1708 /* Restore config registers to avoid hard hang on some systems */
1709 i801_disable_host_notify(priv);
1710 pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1711}
1712
Jean Delvarea5aaea32007-03-22 19:49:01 +01001713#ifdef CONFIG_PM
Jarkko Nikula2ee73c42016-03-10 14:12:21 +02001714static int i801_suspend(struct device *dev)
Jean Delvarea5aaea32007-03-22 19:49:01 +01001715{
Jarkko Nikula2ee73c42016-03-10 14:12:21 +02001716 struct pci_dev *pci_dev = to_pci_dev(dev);
1717 struct i801_priv *priv = pci_get_drvdata(pci_dev);
David Woodhouse0cd96eb2010-10-31 21:06:59 +01001718
Jarkko Nikula2ee73c42016-03-10 14:12:21 +02001719 pci_write_config_byte(pci_dev, SMBHSTCFG, priv->original_hstcfg);
Jean Delvarea5aaea32007-03-22 19:49:01 +01001720 return 0;
1721}
1722
Jarkko Nikula2ee73c42016-03-10 14:12:21 +02001723static int i801_resume(struct device *dev)
Jean Delvarea5aaea32007-03-22 19:49:01 +01001724{
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +02001725 struct pci_dev *pci_dev = to_pci_dev(dev);
1726 struct i801_priv *priv = pci_get_drvdata(pci_dev);
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +02001727
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +02001728 i801_enable_host_notify(&priv->adapter);
Benjamin Tissoires7b0ed332016-06-24 16:39:49 +02001729
Jarkko Nikulaf85da3f2015-02-13 15:52:24 +02001730 return 0;
Jean Delvarea5aaea32007-03-22 19:49:01 +01001731}
Jean Delvarea5aaea32007-03-22 19:49:01 +01001732#endif
1733
Jean Delvarea9c80882018-04-25 11:53:40 +02001734static SIMPLE_DEV_PM_OPS(i801_pm_ops, i801_suspend, i801_resume);
Jarkko Nikula2ee73c42016-03-10 14:12:21 +02001735
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736static struct pci_driver i801_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 .name = "i801_smbus",
1738 .id_table = i801_ids,
1739 .probe = i801_probe,
Bill Pemberton0b255e92012-11-27 15:59:38 -05001740 .remove = i801_remove,
Jean Delvaref7f6d912018-04-11 18:05:34 +02001741 .shutdown = i801_shutdown,
Jarkko Nikula2ee73c42016-03-10 14:12:21 +02001742 .driver = {
1743 .pm = &i801_pm_ops,
1744 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745};
1746
1747static int __init i2c_i801_init(void)
1748{
Jean Delvare6aa14642011-05-24 20:58:49 +02001749 if (dmi_name_in_vendors("FUJITSU"))
1750 input_apanel_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 return pci_register_driver(&i801_driver);
1752}
1753
1754static void __exit i2c_i801_exit(void)
1755{
1756 pci_unregister_driver(&i801_driver);
1757}
1758
Jean Delvare7c81c60f2014-01-29 20:40:08 +01001759MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>, Jean Delvare <jdelvare@suse.de>");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760MODULE_DESCRIPTION("I801 SMBus driver");
1761MODULE_LICENSE("GPL");
1762
1763module_init(i2c_i801_init);
1764module_exit(i2c_i801_exit);