drivers/i2c/busses/i2c-i801.c

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