i2c-i801.c 39.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
/*
    Copyright (c) 1998 - 2002  Frodo Looijaard <frodol@dds.nl>,
    Philip Edelbrock <phil@netroedge.com>, and Mark D. Studebaker
    <mdsxyz123@yahoo.com>
5
    Copyright (C) 2007 - 2014  Jean Delvare <jdelvare@suse.de>
6 7
    Copyright (C) 2010         Intel Corporation,
                               David Woodhouse <dwmw2@infradead.org>
L
Linus Torvalds 已提交
8 9 10 11 12 13 14 15 16 17 18 19 20

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
*/

/*
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
 * Supports the following Intel I/O Controller Hubs (ICH):
 *
 *					I/O			Block	I2C
 *					region	SMBus	Block	proc.	block
 * Chip name			PCI ID	size	PEC	buffer	call	read
 * ---------------------------------------------------------------------------
 * 82801AA (ICH)		0x2413	16	no	no	no	no
 * 82801AB (ICH0)		0x2423	16	no	no	no	no
 * 82801BA (ICH2)		0x2443	16	no	no	no	no
 * 82801CA (ICH3)		0x2483	32	soft	no	no	no
 * 82801DB (ICH4)		0x24c3	32	hard	yes	no	no
 * 82801E (ICH5)		0x24d3	32	hard	yes	yes	yes
 * 6300ESB			0x25a4	32	hard	yes	yes	yes
 * 82801F (ICH6)		0x266a	32	hard	yes	yes	yes
 * 6310ESB/6320ESB		0x269b	32	hard	yes	yes	yes
 * 82801G (ICH7)		0x27da	32	hard	yes	yes	yes
 * 82801H (ICH8)		0x283e	32	hard	yes	yes	yes
 * 82801I (ICH9)		0x2930	32	hard	yes	yes	yes
 * EP80579 (Tolapai)		0x5032	32	hard	yes	yes	yes
 * ICH10			0x3a30	32	hard	yes	yes	yes
 * ICH10			0x3a60	32	hard	yes	yes	yes
 * 5/3400 Series (PCH)		0x3b30	32	hard	yes	yes	yes
 * 6 Series (PCH)		0x1c22	32	hard	yes	yes	yes
 * Patsburg (PCH)		0x1d22	32	hard	yes	yes	yes
 * Patsburg (PCH) IDF		0x1d70	32	hard	yes	yes	yes
 * Patsburg (PCH) IDF		0x1d71	32	hard	yes	yes	yes
 * Patsburg (PCH) IDF		0x1d72	32	hard	yes	yes	yes
 * DH89xxCC (PCH)		0x2330	32	hard	yes	yes	yes
 * Panther Point (PCH)		0x1e22	32	hard	yes	yes	yes
 * Lynx Point (PCH)		0x8c22	32	hard	yes	yes	yes
 * Lynx Point-LP (PCH)		0x9c22	32	hard	yes	yes	yes
 * Avoton (SOC)			0x1f3c	32	hard	yes	yes	yes
 * Wellsburg (PCH)		0x8d22	32	hard	yes	yes	yes
 * Wellsburg (PCH) MS		0x8d7d	32	hard	yes	yes	yes
 * Wellsburg (PCH) MS		0x8d7e	32	hard	yes	yes	yes
 * Wellsburg (PCH) MS		0x8d7f	32	hard	yes	yes	yes
 * Coleto Creek (PCH)		0x23b0	32	hard	yes	yes	yes
58
 * Wildcat Point (PCH)		0x8ca2	32	hard	yes	yes	yes
59 60
 * Wildcat Point-LP (PCH)	0x9ca2	32	hard	yes	yes	yes
 * BayTrail (SOC)		0x0f12	32	hard	yes	yes	yes
61
 * Sunrise Point-H (PCH) 	0xa123  32	hard	yes	yes	yes
62
 * Sunrise Point-LP (PCH)	0x9d23	32	hard	yes	yes	yes
63 64 65 66 67 68 69 70 71 72 73 74
 *
 * Features supported by this driver:
 * Software PEC				no
 * Hardware PEC				yes
 * Block buffer				yes
 * Block process call transaction	no
 * I2C block read transaction		yes (doesn't use the block buffer)
 * Slave mode				no
 * Interrupt processing			yes
 *
 * See the file Documentation/i2c/busses/i2c-i801 for details.
 */
L
Linus Torvalds 已提交
75

76
#include <linux/interrupt.h>
L
Linus Torvalds 已提交
77 78 79 80 81 82 83 84
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/kernel.h>
#include <linux/stddef.h>
#include <linux/delay.h>
#include <linux/ioport.h>
#include <linux/init.h>
#include <linux/i2c.h>
85
#include <linux/acpi.h>
86
#include <linux/io.h>
87
#include <linux/dmi.h>
B
Ben Hutchings 已提交
88
#include <linux/slab.h>
89
#include <linux/wait.h>
90 91
#include <linux/err.h>

92 93
#if (defined CONFIG_I2C_MUX_GPIO || defined CONFIG_I2C_MUX_GPIO_MODULE) && \
		defined CONFIG_DMI
94 95 96 97
#include <linux/gpio.h>
#include <linux/i2c-mux-gpio.h>
#include <linux/platform_device.h>
#endif
L
Linus Torvalds 已提交
98 99

/* I801 SMBus address offsets */
100 101 102 103 104 105 106 107 108 109
#define SMBHSTSTS(p)	(0 + (p)->smba)
#define SMBHSTCNT(p)	(2 + (p)->smba)
#define SMBHSTCMD(p)	(3 + (p)->smba)
#define SMBHSTADD(p)	(4 + (p)->smba)
#define SMBHSTDAT0(p)	(5 + (p)->smba)
#define SMBHSTDAT1(p)	(6 + (p)->smba)
#define SMBBLKDAT(p)	(7 + (p)->smba)
#define SMBPEC(p)	(8 + (p)->smba)		/* ICH3 and later */
#define SMBAUXSTS(p)	(12 + (p)->smba)	/* ICH4 and later */
#define SMBAUXCTL(p)	(13 + (p)->smba)	/* ICH4 and later */
L
Linus Torvalds 已提交
110 111

/* PCI Address Constants */
112
#define SMBBAR		4
113
#define SMBPCICTL	0x004
114
#define SMBPCISTS	0x006
L
Linus Torvalds 已提交
115 116
#define SMBHSTCFG	0x040

117 118 119
/* Host status bits for SMBPCISTS */
#define SMBPCISTS_INTS		0x08

120 121 122
/* Control bits for SMBPCICTL */
#define SMBPCICTL_INTDIS	0x0400

L
Linus Torvalds 已提交
123 124 125 126 127
/* Host configuration bits for SMBHSTCFG */
#define SMBHSTCFG_HST_EN	1
#define SMBHSTCFG_SMB_SMI_EN	2
#define SMBHSTCFG_I2C_EN	4

L
Lucas De Marchi 已提交
128
/* Auxiliary control register bits, ICH4+ only */
O
Oleg Ryjkov 已提交
129 130 131
#define SMBAUXCTL_CRC		1
#define SMBAUXCTL_E32B		2

L
Linus Torvalds 已提交
132
/* Other settings */
133
#define MAX_RETRIES		400
L
Linus Torvalds 已提交
134 135 136 137 138 139

/* I801 command constants */
#define I801_QUICK		0x00
#define I801_BYTE		0x04
#define I801_BYTE_DATA		0x08
#define I801_WORD_DATA		0x0C
140
#define I801_PROC_CALL		0x10	/* unimplemented */
L
Linus Torvalds 已提交
141
#define I801_BLOCK_DATA		0x14
142
#define I801_I2C_BLOCK_DATA	0x18	/* ICH5 and later */
143 144 145 146 147 148 149

/* I801 Host Control register bits */
#define SMBHSTCNT_INTREN	0x01
#define SMBHSTCNT_KILL		0x02
#define SMBHSTCNT_LAST_BYTE	0x20
#define SMBHSTCNT_START		0x40
#define SMBHSTCNT_PEC_EN	0x80	/* ICH3 and later */
L
Linus Torvalds 已提交
150

O
Oleg Ryjkov 已提交
151 152 153 154 155 156 157 158 159
/* I801 Hosts Status register bits */
#define SMBHSTSTS_BYTE_DONE	0x80
#define SMBHSTSTS_INUSE_STS	0x40
#define SMBHSTSTS_SMBALERT_STS	0x20
#define SMBHSTSTS_FAILED	0x10
#define SMBHSTSTS_BUS_ERR	0x08
#define SMBHSTSTS_DEV_ERR	0x04
#define SMBHSTSTS_INTR		0x02
#define SMBHSTSTS_HOST_BUSY	0x01
L
Linus Torvalds 已提交
160

161 162 163 164 165
#define STATUS_ERROR_FLAGS	(SMBHSTSTS_FAILED | SMBHSTSTS_BUS_ERR | \
				 SMBHSTSTS_DEV_ERR)

#define STATUS_FLAGS		(SMBHSTSTS_BYTE_DONE | SMBHSTSTS_INTR | \
				 STATUS_ERROR_FLAGS)
166

167
/* Older devices have their ID defined in <linux/pci_ids.h> */
168
#define PCI_DEVICE_ID_INTEL_BAYTRAIL_SMBUS		0x0f12
169
#define PCI_DEVICE_ID_INTEL_BRASWELL_SMBUS		0x2292
170 171
#define PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS		0x1c22
#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS		0x1d22
172
/* Patsburg also has three 'Integrated Device Function' SMBus controllers */
173 174 175 176 177 178 179 180 181
#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0		0x1d70
#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1		0x1d71
#define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2		0x1d72
#define PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS		0x1e22
#define PCI_DEVICE_ID_INTEL_AVOTON_SMBUS		0x1f3c
#define PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS		0x2330
#define PCI_DEVICE_ID_INTEL_COLETOCREEK_SMBUS		0x23b0
#define PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS		0x3b30
#define PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS		0x8c22
182
#define PCI_DEVICE_ID_INTEL_WILDCATPOINT_SMBUS		0x8ca2
183 184 185 186 187
#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS		0x8d22
#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0		0x8d7d
#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1		0x8d7e
#define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2		0x8d7f
#define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS		0x9c22
188
#define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_SMBUS	0x9ca2
189
#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS	0xa123
190
#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS	0x9d23
191

192 193 194 195 196 197 198 199 200
struct i801_mux_config {
	char *gpio_chip;
	unsigned values[3];
	int n_values;
	unsigned classes[3];
	unsigned gpios[2];		/* Relative to gpio_chip->base */
	int n_gpios;
};

201 202 203 204 205 206
struct i801_priv {
	struct i2c_adapter adapter;
	unsigned long smba;
	unsigned char original_hstcfg;
	struct pci_dev *pci_dev;
	unsigned int features;
207 208 209 210

	/* isr processing */
	wait_queue_head_t waitq;
	u8 status;
211 212 213 214 215 216 217

	/* Command state used by isr for byte-by-byte block transactions */
	u8 cmd;
	bool is_read;
	int count;
	int len;
	u8 *data;
218

219 220
#if (defined CONFIG_I2C_MUX_GPIO || defined CONFIG_I2C_MUX_GPIO_MODULE) && \
		defined CONFIG_DMI
221 222 223
	const struct i801_mux_config *mux_drvdata;
	struct platform_device *mux_pdev;
#endif
224 225
};

226 227 228 229
#define FEATURE_SMBUS_PEC	(1 << 0)
#define FEATURE_BLOCK_BUFFER	(1 << 1)
#define FEATURE_BLOCK_PROC	(1 << 2)
#define FEATURE_I2C_BLOCK_READ	(1 << 3)
230
#define FEATURE_IRQ		(1 << 4)
231 232
/* Not really a feature, but it's convenient to handle it as such */
#define FEATURE_IDF		(1 << 15)
L
Linus Torvalds 已提交
233

234 235 236 237 238
static const char *i801_feature_names[] = {
	"SMBus PEC",
	"Block buffer",
	"Block process call",
	"I2C block read",
239
	"Interrupt",
240 241 242 243
};

static unsigned int disable_features;
module_param(disable_features, uint, S_IRUGO | S_IWUSR);
244 245 246 247 248
MODULE_PARM_DESC(disable_features, "Disable selected driver features:\n"
	"\t\t  0x01  disable SMBus PEC\n"
	"\t\t  0x02  disable the block buffer\n"
	"\t\t  0x08  disable the I2C block read functionality\n"
	"\t\t  0x10  don't use interrupts ");
249

250 251
/* Make sure the SMBus host is ready to start transmitting.
   Return 0 if it is, -EBUSY if it is not. */
252
static int i801_check_pre(struct i801_priv *priv)
L
Linus Torvalds 已提交
253
{
254
	int status;
L
Linus Torvalds 已提交
255

256
	status = inb_p(SMBHSTSTS(priv));
257
	if (status & SMBHSTSTS_HOST_BUSY) {
258
		dev_err(&priv->pci_dev->dev, "SMBus is busy, can't use it!\n");
259 260 261 262 263
		return -EBUSY;
	}

	status &= STATUS_FLAGS;
	if (status) {
264
		dev_dbg(&priv->pci_dev->dev, "Clearing status flags (%02x)\n",
265
			status);
266 267
		outb_p(status, SMBHSTSTS(priv));
		status = inb_p(SMBHSTSTS(priv)) & STATUS_FLAGS;
268
		if (status) {
269
			dev_err(&priv->pci_dev->dev,
270 271
				"Failed clearing status flags (%02x)\n",
				status);
272
			return -EBUSY;
L
Linus Torvalds 已提交
273 274 275
		}
	}

276 277
	return 0;
}
L
Linus Torvalds 已提交
278

J
Jean Delvare 已提交
279 280 281 282 283 284
/*
 * Convert the status register to an error code, and clear it.
 * Note that status only contains the bits we want to clear, not the
 * actual register value.
 */
static int i801_check_post(struct i801_priv *priv, int status)
285 286
{
	int result = 0;
L
Linus Torvalds 已提交
287

288 289 290 291 292 293
	/*
	 * If the SMBus is still busy, we give up
	 * Note: This timeout condition only happens when using polling
	 * transactions.  For interrupt operation, NAK/timeout is indicated by
	 * DEV_ERR.
	 */
J
Jean Delvare 已提交
294
	if (unlikely(status < 0)) {
295
		dev_err(&priv->pci_dev->dev, "Transaction timeout\n");
O
Oleg Ryjkov 已提交
296
		/* try to stop the current command */
297 298 299
		dev_dbg(&priv->pci_dev->dev, "Terminating the current operation\n");
		outb_p(inb_p(SMBHSTCNT(priv)) | SMBHSTCNT_KILL,
		       SMBHSTCNT(priv));
300
		usleep_range(1000, 2000);
301 302
		outb_p(inb_p(SMBHSTCNT(priv)) & (~SMBHSTCNT_KILL),
		       SMBHSTCNT(priv));
303 304

		/* Check if it worked */
305
		status = inb_p(SMBHSTSTS(priv));
306 307
		if ((status & SMBHSTSTS_HOST_BUSY) ||
		    !(status & SMBHSTSTS_FAILED))
308
			dev_err(&priv->pci_dev->dev,
309
				"Failed terminating the transaction\n");
310
		outb_p(STATUS_FLAGS, SMBHSTSTS(priv));
311
		return -ETIMEDOUT;
L
Linus Torvalds 已提交
312 313
	}

314
	if (status & SMBHSTSTS_FAILED) {
315
		result = -EIO;
316
		dev_err(&priv->pci_dev->dev, "Transaction failed\n");
317 318 319
	}
	if (status & SMBHSTSTS_DEV_ERR) {
		result = -ENXIO;
320
		dev_dbg(&priv->pci_dev->dev, "No response\n");
L
Linus Torvalds 已提交
321
	}
322
	if (status & SMBHSTSTS_BUS_ERR) {
323
		result = -EAGAIN;
324
		dev_dbg(&priv->pci_dev->dev, "Lost arbitration\n");
L
Linus Torvalds 已提交
325 326
	}

J
Jean Delvare 已提交
327 328
	/* Clear status flags except BYTE_DONE, to be cleared by caller */
	outb_p(status, SMBHSTSTS(priv));
L
Linus Torvalds 已提交
329 330 331 332

	return result;
}

J
Jean Delvare 已提交
333 334
/* Wait for BUSY being cleared and either INTR or an error flag being set */
static int i801_wait_intr(struct i801_priv *priv)
335 336
{
	int timeout = 0;
J
Jean Delvare 已提交
337
	int status;
338 339 340

	/* We will always wait for a fraction of a second! */
	do {
341
		usleep_range(250, 500);
342
		status = inb_p(SMBHSTSTS(priv));
J
Jean Delvare 已提交
343 344 345
	} while (((status & SMBHSTSTS_HOST_BUSY) ||
		  !(status & (STATUS_ERROR_FLAGS | SMBHSTSTS_INTR))) &&
		 (timeout++ < MAX_RETRIES));
346

J
Jean Delvare 已提交
347 348 349 350 351
	if (timeout > MAX_RETRIES) {
		dev_dbg(&priv->pci_dev->dev, "INTR Timeout!\n");
		return -ETIMEDOUT;
	}
	return status & (STATUS_ERROR_FLAGS | SMBHSTSTS_INTR);
352 353
}

J
Jean Delvare 已提交
354 355
/* Wait for either BYTE_DONE or an error flag being set */
static int i801_wait_byte_done(struct i801_priv *priv)
O
Oleg Ryjkov 已提交
356 357
{
	int timeout = 0;
358
	int status;
O
Oleg Ryjkov 已提交
359

J
Jean Delvare 已提交
360
	/* We will always wait for a fraction of a second! */
O
Oleg Ryjkov 已提交
361
	do {
362
		usleep_range(250, 500);
363
		status = inb_p(SMBHSTSTS(priv));
J
Jean Delvare 已提交
364 365 366 367 368 369 370 371 372 373 374 375 376 377
	} while (!(status & (STATUS_ERROR_FLAGS | SMBHSTSTS_BYTE_DONE)) &&
		 (timeout++ < MAX_RETRIES));

	if (timeout > MAX_RETRIES) {
		dev_dbg(&priv->pci_dev->dev, "BYTE_DONE Timeout!\n");
		return -ETIMEDOUT;
	}
	return status & STATUS_ERROR_FLAGS;
}

static int i801_transaction(struct i801_priv *priv, int xact)
{
	int status;
	int result;
378
	const struct i2c_adapter *adap = &priv->adapter;
O
Oleg Ryjkov 已提交
379

J
Jean Delvare 已提交
380 381 382
	result = i801_check_pre(priv);
	if (result < 0)
		return result;
R
Roel Kluin 已提交
383

384 385 386
	if (priv->features & FEATURE_IRQ) {
		outb_p(xact | SMBHSTCNT_INTREN | SMBHSTCNT_START,
		       SMBHSTCNT(priv));
387 388 389 390 391 392 393 394
		result = wait_event_timeout(priv->waitq,
					    (status = priv->status),
					    adap->timeout);
		if (!result) {
			status = -ETIMEDOUT;
			dev_warn(&priv->pci_dev->dev,
				 "Timeout waiting for interrupt!\n");
		}
395 396 397 398
		priv->status = 0;
		return i801_check_post(priv, status);
	}

J
Jean Delvare 已提交
399 400 401 402 403 404
	/* the current contents of SMBHSTCNT can be overwritten, since PEC,
	 * SMBSCMD are passed in xact */
	outb_p(xact | SMBHSTCNT_START, SMBHSTCNT(priv));

	status = i801_wait_intr(priv);
	return i801_check_post(priv, status);
O
Oleg Ryjkov 已提交
405 406
}

407 408
static int i801_block_transaction_by_block(struct i801_priv *priv,
					   union i2c_smbus_data *data,
409 410 411
					   char read_write, int hwpec)
{
	int i, len;
412
	int status;
413

414
	inb_p(SMBHSTCNT(priv)); /* reset the data buffer index */
415 416 417 418

	/* Use 32-byte buffer to process this transaction */
	if (read_write == I2C_SMBUS_WRITE) {
		len = data->block[0];
419
		outb_p(len, SMBHSTDAT0(priv));
420
		for (i = 0; i < len; i++)
421
			outb_p(data->block[i+1], SMBBLKDAT(priv));
422 423
	}

D
Daniel Kurtz 已提交
424
	status = i801_transaction(priv, I801_BLOCK_DATA |
425
				  (hwpec ? SMBHSTCNT_PEC_EN : 0));
426 427
	if (status)
		return status;
428 429

	if (read_write == I2C_SMBUS_READ) {
430
		len = inb_p(SMBHSTDAT0(priv));
431
		if (len < 1 || len > I2C_SMBUS_BLOCK_MAX)
432
			return -EPROTO;
433 434 435

		data->block[0] = len;
		for (i = 0; i < len; i++)
436
			data->block[i + 1] = inb_p(SMBBLKDAT(priv));
437 438 439 440
	}
	return 0;
}

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
static void i801_isr_byte_done(struct i801_priv *priv)
{
	if (priv->is_read) {
		/* For SMBus block reads, length is received with first byte */
		if (((priv->cmd & 0x1c) == I801_BLOCK_DATA) &&
		    (priv->count == 0)) {
			priv->len = inb_p(SMBHSTDAT0(priv));
			if (priv->len < 1 || priv->len > I2C_SMBUS_BLOCK_MAX) {
				dev_err(&priv->pci_dev->dev,
					"Illegal SMBus block read size %d\n",
					priv->len);
				/* FIXME: Recover */
				priv->len = I2C_SMBUS_BLOCK_MAX;
			} else {
				dev_dbg(&priv->pci_dev->dev,
					"SMBus block read size is %d\n",
					priv->len);
			}
			priv->data[-1] = priv->len;
		}

		/* Read next byte */
		if (priv->count < priv->len)
			priv->data[priv->count++] = inb(SMBBLKDAT(priv));
		else
			dev_dbg(&priv->pci_dev->dev,
				"Discarding extra byte on block read\n");

		/* Set LAST_BYTE for last byte of read transaction */
		if (priv->count == priv->len - 1)
			outb_p(priv->cmd | SMBHSTCNT_LAST_BYTE,
			       SMBHSTCNT(priv));
	} else if (priv->count < priv->len - 1) {
		/* Write next byte, except for IRQ after last byte */
		outb_p(priv->data[++priv->count], SMBBLKDAT(priv));
	}

	/* Clear BYTE_DONE to continue with next byte */
	outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
}

482
/*
483 484 485 486 487 488 489 490 491 492 493 494
 * There are two kinds of interrupts:
 *
 * 1) i801 signals transaction completion with one of these interrupts:
 *      INTR - Success
 *      DEV_ERR - Invalid command, NAK or communication timeout
 *      BUS_ERR - SMI# transaction collision
 *      FAILED - transaction was canceled due to a KILL request
 *    When any of these occur, update ->status and wake up the waitq.
 *    ->status must be cleared before kicking off the next transaction.
 *
 * 2) For byte-by-byte (I2C read/write) transactions, one BYTE_DONE interrupt
 *    occurs for each byte of a byte-by-byte to prepare the next byte.
495 496 497 498 499 500 501 502 503 504 505 506 507
 */
static irqreturn_t i801_isr(int irq, void *dev_id)
{
	struct i801_priv *priv = dev_id;
	u16 pcists;
	u8 status;

	/* Confirm this is our interrupt */
	pci_read_config_word(priv->pci_dev, SMBPCISTS, &pcists);
	if (!(pcists & SMBPCISTS_INTS))
		return IRQ_NONE;

	status = inb_p(SMBHSTSTS(priv));
508 509 510
	if (status & SMBHSTSTS_BYTE_DONE)
		i801_isr_byte_done(priv);

511 512 513 514 515 516 517 518 519 520 521 522 523 524
	/*
	 * Clear irq sources and report transaction result.
	 * ->status must be cleared before the next transaction is started.
	 */
	status &= SMBHSTSTS_INTR | STATUS_ERROR_FLAGS;
	if (status) {
		outb_p(status, SMBHSTSTS(priv));
		priv->status |= status;
		wake_up(&priv->waitq);
	}

	return IRQ_HANDLED;
}

525 526 527 528 529
/*
 * For "byte-by-byte" block transactions:
 *   I2C write uses cmd=I801_BLOCK_DATA, I2C_EN=1
 *   I2C read uses cmd=I801_I2C_BLOCK_DATA
 */
530 531
static int i801_block_transaction_byte_by_byte(struct i801_priv *priv,
					       union i2c_smbus_data *data,
532 533
					       char read_write, int command,
					       int hwpec)
L
Linus Torvalds 已提交
534 535 536
{
	int i, len;
	int smbcmd;
537
	int status;
538
	int result;
539
	const struct i2c_adapter *adap = &priv->adapter;
540

541
	result = i801_check_pre(priv);
542 543
	if (result < 0)
		return result;
L
Linus Torvalds 已提交
544

545
	len = data->block[0];
L
Linus Torvalds 已提交
546 547

	if (read_write == I2C_SMBUS_WRITE) {
548 549
		outb_p(len, SMBHSTDAT0(priv));
		outb_p(data->block[1], SMBBLKDAT(priv));
L
Linus Torvalds 已提交
550 551
	}

552 553 554 555 556 557
	if (command == I2C_SMBUS_I2C_BLOCK_DATA &&
	    read_write == I2C_SMBUS_READ)
		smbcmd = I801_I2C_BLOCK_DATA;
	else
		smbcmd = I801_BLOCK_DATA;

558 559 560 561 562 563 564 565 566 567
	if (priv->features & FEATURE_IRQ) {
		priv->is_read = (read_write == I2C_SMBUS_READ);
		if (len == 1 && priv->is_read)
			smbcmd |= SMBHSTCNT_LAST_BYTE;
		priv->cmd = smbcmd | SMBHSTCNT_INTREN;
		priv->len = len;
		priv->count = 0;
		priv->data = &data->block[1];

		outb_p(priv->cmd | SMBHSTCNT_START, SMBHSTCNT(priv));
568 569 570 571 572 573 574 575
		result = wait_event_timeout(priv->waitq,
					    (status = priv->status),
					    adap->timeout);
		if (!result) {
			status = -ETIMEDOUT;
			dev_warn(&priv->pci_dev->dev,
				 "Timeout waiting for interrupt!\n");
		}
576 577 578 579
		priv->status = 0;
		return i801_check_post(priv, status);
	}

L
Linus Torvalds 已提交
580
	for (i = 1; i <= len; i++) {
581
		if (i == len && read_write == I2C_SMBUS_READ)
582
			smbcmd |= SMBHSTCNT_LAST_BYTE;
D
Daniel Kurtz 已提交
583
		outb_p(smbcmd, SMBHSTCNT(priv));
L
Linus Torvalds 已提交
584 585

		if (i == 1)
586
			outb_p(inb(SMBHSTCNT(priv)) | SMBHSTCNT_START,
587
			       SMBHSTCNT(priv));
L
Linus Torvalds 已提交
588

J
Jean Delvare 已提交
589 590 591
		status = i801_wait_byte_done(priv);
		if (status)
			goto exit;
L
Linus Torvalds 已提交
592

593 594
		if (i == 1 && read_write == I2C_SMBUS_READ
		 && command != I2C_SMBUS_I2C_BLOCK_DATA) {
595
			len = inb_p(SMBHSTDAT0(priv));
596
			if (len < 1 || len > I2C_SMBUS_BLOCK_MAX) {
597
				dev_err(&priv->pci_dev->dev,
598 599 600
					"Illegal SMBus block read size %d\n",
					len);
				/* Recover */
601 602 603 604 605
				while (inb_p(SMBHSTSTS(priv)) &
				       SMBHSTSTS_HOST_BUSY)
					outb_p(SMBHSTSTS_BYTE_DONE,
					       SMBHSTSTS(priv));
				outb_p(SMBHSTSTS_INTR, SMBHSTSTS(priv));
606
				return -EPROTO;
607
			}
L
Linus Torvalds 已提交
608 609 610 611 612
			data->block[0] = len;
		}

		/* Retrieve/store value in SMBBLKDAT */
		if (read_write == I2C_SMBUS_READ)
613
			data->block[i] = inb_p(SMBBLKDAT(priv));
L
Linus Torvalds 已提交
614
		if (read_write == I2C_SMBUS_WRITE && i+1 <= len)
615
			outb_p(data->block[i+1], SMBBLKDAT(priv));
L
Linus Torvalds 已提交
616

617
		/* signals SMBBLKDAT ready */
J
Jean Delvare 已提交
618
		outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
L
Linus Torvalds 已提交
619
	}
620

J
Jean Delvare 已提交
621 622 623
	status = i801_wait_intr(priv);
exit:
	return i801_check_post(priv, status);
624
}
L
Linus Torvalds 已提交
625

626
static int i801_set_block_buffer_mode(struct i801_priv *priv)
627
{
628 629
	outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_E32B, SMBAUXCTL(priv));
	if ((inb_p(SMBAUXCTL(priv)) & SMBAUXCTL_E32B) == 0)
630
		return -EIO;
631 632 633 634
	return 0;
}

/* Block transaction function */
635 636
static int i801_block_transaction(struct i801_priv *priv,
				  union i2c_smbus_data *data, char read_write,
637 638 639 640 641 642 643 644
				  int command, int hwpec)
{
	int result = 0;
	unsigned char hostc;

	if (command == I2C_SMBUS_I2C_BLOCK_DATA) {
		if (read_write == I2C_SMBUS_WRITE) {
			/* set I2C_EN bit in configuration register */
645 646
			pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &hostc);
			pci_write_config_byte(priv->pci_dev, SMBHSTCFG,
647
					      hostc | SMBHSTCFG_I2C_EN);
648 649
		} else if (!(priv->features & FEATURE_I2C_BLOCK_READ)) {
			dev_err(&priv->pci_dev->dev,
650
				"I2C block read is unsupported!\n");
651
			return -EOPNOTSUPP;
652 653 654
		}
	}

655 656
	if (read_write == I2C_SMBUS_WRITE
	 || command == I2C_SMBUS_I2C_BLOCK_DATA) {
657 658 659 660 661
		if (data->block[0] < 1)
			data->block[0] = 1;
		if (data->block[0] > I2C_SMBUS_BLOCK_MAX)
			data->block[0] = I2C_SMBUS_BLOCK_MAX;
	} else {
662
		data->block[0] = 32;	/* max for SMBus block reads */
663 664
	}

665 666 667
	/* Experience has shown that the block buffer can only be used for
	   SMBus (not I2C) block transactions, even though the datasheet
	   doesn't mention this limitation. */
668
	if ((priv->features & FEATURE_BLOCK_BUFFER)
669
	 && command != I2C_SMBUS_I2C_BLOCK_DATA
670 671 672
	 && i801_set_block_buffer_mode(priv) == 0)
		result = i801_block_transaction_by_block(priv, data,
							 read_write, hwpec);
673
	else
674 675
		result = i801_block_transaction_byte_by_byte(priv, data,
							     read_write,
676
							     command, hwpec);
677

678 679
	if (command == I2C_SMBUS_I2C_BLOCK_DATA
	 && read_write == I2C_SMBUS_WRITE) {
L
Linus Torvalds 已提交
680
		/* restore saved configuration register value */
681
		pci_write_config_byte(priv->pci_dev, SMBHSTCFG, hostc);
L
Linus Torvalds 已提交
682 683 684 685
	}
	return result;
}

686
/* Return negative errno on error. */
687
static s32 i801_access(struct i2c_adapter *adap, u16 addr,
L
Linus Torvalds 已提交
688
		       unsigned short flags, char read_write, u8 command,
689
		       int size, union i2c_smbus_data *data)
L
Linus Torvalds 已提交
690
{
691
	int hwpec;
L
Linus Torvalds 已提交
692 693
	int block = 0;
	int ret, xact = 0;
694
	struct i801_priv *priv = i2c_get_adapdata(adap);
L
Linus Torvalds 已提交
695

696
	hwpec = (priv->features & FEATURE_SMBUS_PEC) && (flags & I2C_CLIENT_PEC)
697 698
		&& size != I2C_SMBUS_QUICK
		&& size != I2C_SMBUS_I2C_BLOCK_DATA;
L
Linus Torvalds 已提交
699 700 701 702

	switch (size) {
	case I2C_SMBUS_QUICK:
		outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
703
		       SMBHSTADD(priv));
L
Linus Torvalds 已提交
704 705 706 707
		xact = I801_QUICK;
		break;
	case I2C_SMBUS_BYTE:
		outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
708
		       SMBHSTADD(priv));
L
Linus Torvalds 已提交
709
		if (read_write == I2C_SMBUS_WRITE)
710
			outb_p(command, SMBHSTCMD(priv));
L
Linus Torvalds 已提交
711 712 713 714
		xact = I801_BYTE;
		break;
	case I2C_SMBUS_BYTE_DATA:
		outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
715 716
		       SMBHSTADD(priv));
		outb_p(command, SMBHSTCMD(priv));
L
Linus Torvalds 已提交
717
		if (read_write == I2C_SMBUS_WRITE)
718
			outb_p(data->byte, SMBHSTDAT0(priv));
L
Linus Torvalds 已提交
719 720 721 722
		xact = I801_BYTE_DATA;
		break;
	case I2C_SMBUS_WORD_DATA:
		outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
723 724
		       SMBHSTADD(priv));
		outb_p(command, SMBHSTCMD(priv));
L
Linus Torvalds 已提交
725
		if (read_write == I2C_SMBUS_WRITE) {
726 727
			outb_p(data->word & 0xff, SMBHSTDAT0(priv));
			outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1(priv));
L
Linus Torvalds 已提交
728 729 730 731 732
		}
		xact = I801_WORD_DATA;
		break;
	case I2C_SMBUS_BLOCK_DATA:
		outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
733 734
		       SMBHSTADD(priv));
		outb_p(command, SMBHSTCMD(priv));
L
Linus Torvalds 已提交
735 736
		block = 1;
		break;
737 738 739
	case I2C_SMBUS_I2C_BLOCK_DATA:
		/* NB: page 240 of ICH5 datasheet shows that the R/#W
		 * bit should be cleared here, even when reading */
740
		outb_p((addr & 0x7f) << 1, SMBHSTADD(priv));
741 742 743
		if (read_write == I2C_SMBUS_READ) {
			/* NB: page 240 of ICH5 datasheet also shows
			 * that DATA1 is the cmd field when reading */
744
			outb_p(command, SMBHSTDAT1(priv));
745
		} else
746
			outb_p(command, SMBHSTCMD(priv));
747 748
		block = 1;
		break;
L
Linus Torvalds 已提交
749
	default:
750 751
		dev_err(&priv->pci_dev->dev, "Unsupported transaction %d\n",
			size);
752
		return -EOPNOTSUPP;
L
Linus Torvalds 已提交
753 754
	}

O
Oleg Ryjkov 已提交
755
	if (hwpec)	/* enable/disable hardware PEC */
756
		outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_CRC, SMBAUXCTL(priv));
O
Oleg Ryjkov 已提交
757
	else
758 759
		outb_p(inb_p(SMBAUXCTL(priv)) & (~SMBAUXCTL_CRC),
		       SMBAUXCTL(priv));
760

761
	if (block)
762 763
		ret = i801_block_transaction(priv, data, read_write, size,
					     hwpec);
764
	else
D
Daniel Kurtz 已提交
765
		ret = i801_transaction(priv, xact);
L
Linus Torvalds 已提交
766

767
	/* Some BIOSes don't like it when PEC is enabled at reboot or resume
768 769
	   time, so we forcibly disable it after every transaction. Turn off
	   E32B for the same reason. */
770
	if (hwpec || block)
771 772
		outb_p(inb_p(SMBAUXCTL(priv)) &
		       ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
773

774
	if (block)
L
Linus Torvalds 已提交
775
		return ret;
776
	if (ret)
777
		return ret;
L
Linus Torvalds 已提交
778 779 780 781 782 783
	if ((read_write == I2C_SMBUS_WRITE) || (xact == I801_QUICK))
		return 0;

	switch (xact & 0x7f) {
	case I801_BYTE:	/* Result put in SMBHSTDAT0 */
	case I801_BYTE_DATA:
784
		data->byte = inb_p(SMBHSTDAT0(priv));
L
Linus Torvalds 已提交
785 786
		break;
	case I801_WORD_DATA:
787 788
		data->word = inb_p(SMBHSTDAT0(priv)) +
			     (inb_p(SMBHSTDAT1(priv)) << 8);
L
Linus Torvalds 已提交
789 790 791 792 793 794 795 796
		break;
	}
	return 0;
}


static u32 i801_func(struct i2c_adapter *adapter)
{
797 798
	struct i801_priv *priv = i2c_get_adapdata(adapter);

L
Linus Torvalds 已提交
799
	return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
800 801
	       I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
	       I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK |
802 803
	       ((priv->features & FEATURE_SMBUS_PEC) ? I2C_FUNC_SMBUS_PEC : 0) |
	       ((priv->features & FEATURE_I2C_BLOCK_READ) ?
804
		I2C_FUNC_SMBUS_READ_I2C_BLOCK : 0);
L
Linus Torvalds 已提交
805 806
}

807
static const struct i2c_algorithm smbus_algorithm = {
L
Linus Torvalds 已提交
808 809 810 811
	.smbus_xfer	= i801_access,
	.functionality	= i801_func,
};

812
static const struct pci_device_id i801_ids[] = {
L
Linus Torvalds 已提交
813 814 815 816 817 818 819 820 821
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AA_3) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AB_3) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801BA_2) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801CA_3) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_3) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801EB_3) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB_4) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_16) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH7_17) },
822
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB2_17) },
823
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH8_5) },
824
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH9_6) },
825
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_EP80579_1) },
826 827
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_4) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_5) },
828 829
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS) },
830
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS) },
831 832 833
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2) },
834
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS) },
835
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS) },
836
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS) },
837
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS) },
838
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_AVOTON_SMBUS) },
839 840 841 842
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1) },
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2) },
843
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_COLETOCREEK_SMBUS) },
844
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WILDCATPOINT_SMBUS) },
845
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_SMBUS) },
846
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BAYTRAIL_SMBUS) },
847
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BRASWELL_SMBUS) },
848
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS) },
849
	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS) },
L
Linus Torvalds 已提交
850 851 852
	{ 0, }
};

853
MODULE_DEVICE_TABLE(pci, i801_ids);
L
Linus Torvalds 已提交
854

855
#if defined CONFIG_X86 && defined CONFIG_DMI
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
static unsigned char apanel_addr;

/* Scan the system ROM for the signature "FJKEYINF" */
static __init const void __iomem *bios_signature(const void __iomem *bios)
{
	ssize_t offset;
	const unsigned char signature[] = "FJKEYINF";

	for (offset = 0; offset < 0x10000; offset += 0x10) {
		if (check_signature(bios + offset, signature,
				    sizeof(signature)-1))
			return bios + offset;
	}
	return NULL;
}

static void __init input_apanel_init(void)
{
	void __iomem *bios;
	const void __iomem *p;

	bios = ioremap(0xF0000, 0x10000); /* Can't fail */
	p = bios_signature(bios);
	if (p) {
		/* just use the first address */
		apanel_addr = readb(p + 8 + 3) >> 1;
	}
	iounmap(bios);
}

886 887 888 889 890 891 892
struct dmi_onboard_device_info {
	const char *name;
	u8 type;
	unsigned short i2c_addr;
	const char *i2c_type;
};

893
static const struct dmi_onboard_device_info dmi_devices[] = {
894 895 896 897 898
	{ "Syleus", DMI_DEV_TYPE_OTHER, 0x73, "fscsyl" },
	{ "Hermes", DMI_DEV_TYPE_OTHER, 0x73, "fscher" },
	{ "Hades",  DMI_DEV_TYPE_OTHER, 0x73, "fschds" },
};

899 900
static void dmi_check_onboard_device(u8 type, const char *name,
				     struct i2c_adapter *adap)
901 902 903 904 905 906 907 908
{
	int i;
	struct i2c_board_info info;

	for (i = 0; i < ARRAY_SIZE(dmi_devices); i++) {
		/* & ~0x80, ignore enabled/disabled bit */
		if ((type & ~0x80) != dmi_devices[i].type)
			continue;
909
		if (strcasecmp(name, dmi_devices[i].name))
910 911 912 913 914 915 916 917 918 919 920 921 922
			continue;

		memset(&info, 0, sizeof(struct i2c_board_info));
		info.addr = dmi_devices[i].i2c_addr;
		strlcpy(info.type, dmi_devices[i].i2c_type, I2C_NAME_SIZE);
		i2c_new_device(adap, &info);
		break;
	}
}

/* We use our own function to check for onboard devices instead of
   dmi_find_device() as some buggy BIOS's have the devices we are interested
   in marked as disabled */
923
static void dmi_check_onboard_devices(const struct dmi_header *dm, void *adap)
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
{
	int i, count;

	if (dm->type != 10)
		return;

	count = (dm->length - sizeof(struct dmi_header)) / 2;
	for (i = 0; i < count; i++) {
		const u8 *d = (char *)(dm + 1) + (i * 2);
		const char *name = ((char *) dm) + dm->length;
		u8 type = d[0];
		u8 s = d[1];

		if (!s)
			continue;
		s--;
		while (s > 0 && name[0]) {
			name += strlen(name) + 1;
			s--;
		}
		if (name[0] == 0) /* Bogus string reference */
			continue;

		dmi_check_onboard_device(type, name, adap);
	}
}

951
/* Register optional slaves */
952
static void i801_probe_optional_slaves(struct i801_priv *priv)
953 954 955 956 957 958 959 960 961 962 963 964 965
{
	/* Only register slaves on main SMBus channel */
	if (priv->features & FEATURE_IDF)
		return;

	if (apanel_addr) {
		struct i2c_board_info info;

		memset(&info, 0, sizeof(struct i2c_board_info));
		info.addr = apanel_addr;
		strlcpy(info.type, "fujitsu_apanel", I2C_NAME_SIZE);
		i2c_new_device(&priv->adapter, &info);
	}
966

967 968 969
	if (dmi_name_in_vendors("FUJITSU"))
		dmi_walk(dmi_check_onboard_devices, &priv->adapter);
}
970 971
#else
static void __init input_apanel_init(void) {}
972
static void i801_probe_optional_slaves(struct i801_priv *priv) {}
973
#endif	/* CONFIG_X86 && CONFIG_DMI */
974

975 976
#if (defined CONFIG_I2C_MUX_GPIO || defined CONFIG_I2C_MUX_GPIO_MODULE) && \
		defined CONFIG_DMI
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
static struct i801_mux_config i801_mux_config_asus_z8_d12 = {
	.gpio_chip = "gpio_ich",
	.values = { 0x02, 0x03 },
	.n_values = 2,
	.classes = { I2C_CLASS_SPD, I2C_CLASS_SPD },
	.gpios = { 52, 53 },
	.n_gpios = 2,
};

static struct i801_mux_config i801_mux_config_asus_z8_d18 = {
	.gpio_chip = "gpio_ich",
	.values = { 0x02, 0x03, 0x01 },
	.n_values = 3,
	.classes = { I2C_CLASS_SPD, I2C_CLASS_SPD, I2C_CLASS_SPD },
	.gpios = { 52, 53 },
	.n_gpios = 2,
};

995
static const struct dmi_system_id mux_dmi_table[] = {
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8NA-D6(C)"),
		},
		.driver_data = &i801_mux_config_asus_z8_d12,
	},
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)E-D12(X)"),
		},
		.driver_data = &i801_mux_config_asus_z8_d12,
	},
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8NH-D12"),
		},
		.driver_data = &i801_mux_config_asus_z8_d12,
	},
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8PH-D12/IFB"),
		},
		.driver_data = &i801_mux_config_asus_z8_d12,
	},
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8NR-D12"),
		},
		.driver_data = &i801_mux_config_asus_z8_d12,
	},
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)H-D12"),
		},
		.driver_data = &i801_mux_config_asus_z8_d12,
	},
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8PG-D18"),
		},
		.driver_data = &i801_mux_config_asus_z8_d18,
	},
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8PE-D18"),
		},
		.driver_data = &i801_mux_config_asus_z8_d18,
	},
	{
		.matches = {
			DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
			DMI_MATCH(DMI_BOARD_NAME, "Z8PS-D12"),
		},
		.driver_data = &i801_mux_config_asus_z8_d12,
	},
	{ }
};

/* Setup multiplexing if needed */
1063
static int i801_add_mux(struct i801_priv *priv)
1064 1065 1066 1067
{
	struct device *dev = &priv->adapter.dev;
	const struct i801_mux_config *mux_config;
	struct i2c_mux_gpio_platform_data gpio_data;
1068
	int err;
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079

	if (!priv->mux_drvdata)
		return 0;
	mux_config = priv->mux_drvdata;

	/* Prepare the platform data */
	memset(&gpio_data, 0, sizeof(struct i2c_mux_gpio_platform_data));
	gpio_data.parent = priv->adapter.nr;
	gpio_data.values = mux_config->values;
	gpio_data.n_values = mux_config->n_values;
	gpio_data.classes = mux_config->classes;
1080 1081
	gpio_data.gpio_chip = mux_config->gpio_chip;
	gpio_data.gpios = mux_config->gpios;
1082 1083 1084 1085 1086
	gpio_data.n_gpios = mux_config->n_gpios;
	gpio_data.idle = I2C_MUX_GPIO_NO_IDLE;

	/* Register the mux device */
	priv->mux_pdev = platform_device_register_data(dev, "i2c-mux-gpio",
1087
				PLATFORM_DEVID_AUTO, &gpio_data,
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
				sizeof(struct i2c_mux_gpio_platform_data));
	if (IS_ERR(priv->mux_pdev)) {
		err = PTR_ERR(priv->mux_pdev);
		priv->mux_pdev = NULL;
		dev_err(dev, "Failed to register i2c-mux-gpio device\n");
		return err;
	}

	return 0;
}

1099
static void i801_del_mux(struct i801_priv *priv)
1100 1101 1102 1103 1104
{
	if (priv->mux_pdev)
		platform_device_unregister(priv->mux_pdev);
}

1105
static unsigned int i801_get_adapter_class(struct i801_priv *priv)
1106 1107 1108 1109 1110 1111 1112 1113
{
	const struct dmi_system_id *id;
	const struct i801_mux_config *mux_config;
	unsigned int class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
	int i;

	id = dmi_first_match(mux_dmi_table);
	if (id) {
J
Jean Delvare 已提交
1114
		/* Remove branch classes from trunk */
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
		mux_config = id->driver_data;
		for (i = 0; i < mux_config->n_values; i++)
			class &= ~mux_config->classes[i];

		/* Remember for later */
		priv->mux_drvdata = mux_config;
	}

	return class;
}
#else
static inline int i801_add_mux(struct i801_priv *priv) { return 0; }
static inline void i801_del_mux(struct i801_priv *priv) { }

static inline unsigned int i801_get_adapter_class(struct i801_priv *priv)
{
	return I2C_CLASS_HWMON | I2C_CLASS_SPD;
}
#endif

1135
static int i801_probe(struct pci_dev *dev, const struct pci_device_id *id)
L
Linus Torvalds 已提交
1136
{
1137
	unsigned char temp;
1138
	int err, i;
1139 1140
	struct i801_priv *priv;

1141
	priv = devm_kzalloc(&dev->dev, sizeof(*priv), GFP_KERNEL);
1142 1143 1144 1145 1146
	if (!priv)
		return -ENOMEM;

	i2c_set_adapdata(&priv->adapter, priv);
	priv->adapter.owner = THIS_MODULE;
1147
	priv->adapter.class = i801_get_adapter_class(priv);
1148
	priv->adapter.algo = &smbus_algorithm;
L
Linus Torvalds 已提交
1149

1150
	priv->pci_dev = dev;
1151
	switch (dev->device) {
1152 1153 1154
	case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0:
	case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1:
	case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2:
1155 1156 1157
	case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0:
	case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1:
	case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2:
1158 1159
		priv->features |= FEATURE_IDF;
		/* fall through */
1160
	default:
1161
		priv->features |= FEATURE_I2C_BLOCK_READ;
1162
		priv->features |= FEATURE_IRQ;
1163 1164
		/* fall through */
	case PCI_DEVICE_ID_INTEL_82801DB_3:
1165 1166
		priv->features |= FEATURE_SMBUS_PEC;
		priv->features |= FEATURE_BLOCK_BUFFER;
1167 1168 1169 1170 1171
		/* fall through */
	case PCI_DEVICE_ID_INTEL_82801CA_3:
	case PCI_DEVICE_ID_INTEL_82801BA_2:
	case PCI_DEVICE_ID_INTEL_82801AB_3:
	case PCI_DEVICE_ID_INTEL_82801AA_3:
1172 1173
		break;
	}
1174

1175 1176
	/* Disable features on user request */
	for (i = 0; i < ARRAY_SIZE(i801_feature_names); i++) {
1177
		if (priv->features & disable_features & (1 << i))
1178 1179 1180
			dev_notice(&dev->dev, "%s disabled by user\n",
				   i801_feature_names[i]);
	}
1181
	priv->features &= ~disable_features;
1182

1183 1184 1185 1186 1187 1188 1189 1190
	err = pci_enable_device(dev);
	if (err) {
		dev_err(&dev->dev, "Failed to enable SMBus PCI device (%d)\n",
			err);
		goto exit;
	}

	/* Determine the address of the SMBus area */
1191 1192
	priv->smba = pci_resource_start(dev, SMBBAR);
	if (!priv->smba) {
1193 1194
		dev_err(&dev->dev,
			"SMBus base address uninitialized, upgrade BIOS\n");
1195
		err = -ENODEV;
1196
		goto exit;
1197 1198
	}

1199
	err = acpi_check_resource_conflict(&dev->resource[SMBBAR]);
1200 1201
	if (err) {
		err = -ENODEV;
1202
		goto exit;
1203
	}
1204

1205
	err = pci_request_region(dev, SMBBAR, dev_driver_string(&dev->dev));
1206
	if (err) {
1207 1208 1209
		dev_err(&dev->dev,
			"Failed to request SMBus region 0x%lx-0x%Lx\n",
			priv->smba,
1210
			(unsigned long long)pci_resource_end(dev, SMBBAR));
1211
		goto exit;
1212 1213
	}

1214 1215
	pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &temp);
	priv->original_hstcfg = temp;
1216 1217 1218 1219 1220
	temp &= ~SMBHSTCFG_I2C_EN;	/* SMBus timing */
	if (!(temp & SMBHSTCFG_HST_EN)) {
		dev_info(&dev->dev, "Enabling SMBus device\n");
		temp |= SMBHSTCFG_HST_EN;
	}
1221
	pci_write_config_byte(priv->pci_dev, SMBHSTCFG, temp);
1222

1223
	if (temp & SMBHSTCFG_SMB_SMI_EN) {
1224
		dev_dbg(&dev->dev, "SMBus using interrupt SMI#\n");
1225 1226 1227
		/* Disable SMBus interrupt feature if SMBus using SMI# */
		priv->features &= ~FEATURE_IRQ;
	}
L
Linus Torvalds 已提交
1228

1229
	/* Clear special mode bits */
1230 1231 1232
	if (priv->features & (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER))
		outb_p(inb_p(SMBAUXCTL(priv)) &
		       ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
1233

1234 1235 1236
	/* Default timeout in interrupt mode: 200 ms */
	priv->adapter.timeout = HZ / 5;

1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
	if (priv->features & FEATURE_IRQ) {
		u16 pcictl, pcists;

		/* Complain if an interrupt is already pending */
		pci_read_config_word(priv->pci_dev, SMBPCISTS, &pcists);
		if (pcists & SMBPCISTS_INTS)
			dev_warn(&dev->dev, "An interrupt is pending!\n");

		/* Check if interrupts have been disabled */
		pci_read_config_word(priv->pci_dev, SMBPCICTL, &pcictl);
		if (pcictl & SMBPCICTL_INTDIS) {
			dev_info(&dev->dev, "Interrupts are disabled\n");
			priv->features &= ~FEATURE_IRQ;
		}
	}

1253 1254 1255
	if (priv->features & FEATURE_IRQ) {
		init_waitqueue_head(&priv->waitq);

1256 1257 1258
		err = devm_request_irq(&dev->dev, dev->irq, i801_isr,
				       IRQF_SHARED,
				       dev_driver_string(&dev->dev), priv);
1259 1260 1261
		if (err) {
			dev_err(&dev->dev, "Failed to allocate irq %d: %d\n",
				dev->irq, err);
1262
			priv->features &= ~FEATURE_IRQ;
1263 1264
		}
	}
1265 1266
	dev_info(&dev->dev, "SMBus using %s\n",
		 priv->features & FEATURE_IRQ ? "PCI interrupt" : "polling");
1267

1268
	/* set up the sysfs linkage to our parent device */
1269
	priv->adapter.dev.parent = &dev->dev;
L
Linus Torvalds 已提交
1270

J
Jean Delvare 已提交
1271
	/* Retry up to 3 times on lost arbitration */
1272
	priv->adapter.retries = 3;
J
Jean Delvare 已提交
1273

1274 1275 1276
	snprintf(priv->adapter.name, sizeof(priv->adapter.name),
		"SMBus I801 adapter at %04lx", priv->smba);
	err = i2c_add_adapter(&priv->adapter);
1277 1278
	if (err) {
		dev_err(&dev->dev, "Failed to add SMBus adapter\n");
1279
		goto exit_release;
1280
	}
1281

1282
	i801_probe_optional_slaves(priv);
1283 1284
	/* We ignore errors - multiplexing is optional */
	i801_add_mux(priv);
1285

1286
	pci_set_drvdata(dev, priv);
1287

1288
	return 0;
1289

1290
exit_release:
1291
	pci_release_region(dev, SMBBAR);
1292 1293
exit:
	return err;
L
Linus Torvalds 已提交
1294 1295
}

1296
static void i801_remove(struct pci_dev *dev)
L
Linus Torvalds 已提交
1297
{
1298 1299
	struct i801_priv *priv = pci_get_drvdata(dev);

1300
	i801_del_mux(priv);
1301 1302
	i2c_del_adapter(&priv->adapter);
	pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1303

1304
	pci_release_region(dev, SMBBAR);
1305

1306 1307 1308 1309
	/*
	 * do not call pci_disable_device(dev) since it can cause hard hangs on
	 * some systems during power-off (eg. Fujitsu-Siemens Lifebook E8010)
	 */
L
Linus Torvalds 已提交
1310 1311
}

1312 1313 1314
#ifdef CONFIG_PM
static int i801_suspend(struct pci_dev *dev, pm_message_t mesg)
{
1315 1316
	struct i801_priv *priv = pci_get_drvdata(dev);

1317
	pci_save_state(dev);
1318
	pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1319 1320 1321 1322 1323 1324 1325 1326
	pci_set_power_state(dev, pci_choose_state(dev, mesg));
	return 0;
}

static int i801_resume(struct pci_dev *dev)
{
	pci_set_power_state(dev, PCI_D0);
	pci_restore_state(dev);
1327
	return 0;
1328 1329 1330 1331 1332 1333
}
#else
#define i801_suspend NULL
#define i801_resume NULL
#endif

L
Linus Torvalds 已提交
1334 1335 1336 1337
static struct pci_driver i801_driver = {
	.name		= "i801_smbus",
	.id_table	= i801_ids,
	.probe		= i801_probe,
1338
	.remove		= i801_remove,
1339 1340
	.suspend	= i801_suspend,
	.resume		= i801_resume,
L
Linus Torvalds 已提交
1341 1342 1343 1344
};

static int __init i2c_i801_init(void)
{
1345 1346
	if (dmi_name_in_vendors("FUJITSU"))
		input_apanel_init();
L
Linus Torvalds 已提交
1347 1348 1349 1350 1351 1352 1353 1354
	return pci_register_driver(&i801_driver);
}

static void __exit i2c_i801_exit(void)
{
	pci_unregister_driver(&i801_driver);
}

1355
MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>, Jean Delvare <jdelvare@suse.de>");
L
Linus Torvalds 已提交
1356 1357 1358 1359 1360
MODULE_DESCRIPTION("I801 SMBus driver");
MODULE_LICENSE("GPL");

module_init(i2c_i801_init);
module_exit(i2c_i801_exit);