scx200_acb.c 14.1 KB
Newer Older
1
/*
L
Linus Torvalds 已提交
2 3 4
    Copyright (c) 2001,2002 Christer Weinigel <wingel@nano-system.com>

    National Semiconductor SCx200 ACCESS.bus support
5
    Also supports the AMD CS5535 and AMD CS5536
6

L
Linus Torvalds 已提交
7 8 9
    Based on i2c-keywest.c which is:
        Copyright (c) 2001 Benjamin Herrenschmidt <benh@kernel.crashing.org>
        Copyright (c) 2000 Philip Edelbrock <phil@stimpy.netroedge.com>
10

L
Linus Torvalds 已提交
11 12 13 14
    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.
15

L
Linus Torvalds 已提交
16 17 18 19
    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.
20

L
Linus Torvalds 已提交
21 22 23 24 25 26 27 28 29 30 31 32 33
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include <linux/module.h>
#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/i2c.h>
#include <linux/smp_lock.h>
#include <linux/pci.h>
#include <linux/delay.h>
34
#include <linux/mutex.h>
L
Linus Torvalds 已提交
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
#include <asm/io.h>

#include <linux/scx200.h>

#define NAME "scx200_acb"

MODULE_AUTHOR("Christer Weinigel <wingel@nano-system.com>");
MODULE_DESCRIPTION("NatSemi SCx200 ACCESS.bus Driver");
MODULE_LICENSE("GPL");

#define MAX_DEVICES 4
static int base[MAX_DEVICES] = { 0x820, 0x840 };
module_param_array(base, int, NULL, 0);
MODULE_PARM_DESC(base, "Base addresses for the ACCESS.bus controllers");

50
#define POLL_TIMEOUT	(HZ/5)
L
Linus Torvalds 已提交
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

enum scx200_acb_state {
	state_idle,
	state_address,
	state_command,
	state_repeat_start,
	state_quick,
	state_read,
	state_write,
};

static const char *scx200_acb_state_name[] = {
	"idle",
	"address",
	"command",
	"repeat_start",
	"quick",
	"read",
	"write",
};

/* Physical interface */
73
struct scx200_acb_iface {
L
Linus Torvalds 已提交
74 75 76
	struct scx200_acb_iface *next;
	struct i2c_adapter adapter;
	unsigned base;
77
	struct mutex mutex;
L
Linus Torvalds 已提交
78 79 80 81 82 83 84 85 86

	/* State machine data */
	enum scx200_acb_state state;
	int result;
	u8 address_byte;
	u8 command;
	u8 *ptr;
	char needs_reset;
	unsigned len;
87 88 89 90

	/* PCI device info */
	struct pci_dev *pdev;
	int bar;
L
Linus Torvalds 已提交
91 92 93 94 95 96
};

/* Register Definitions */
#define ACBSDA		(iface->base + 0)
#define ACBST		(iface->base + 1)
#define    ACBST_SDAST		0x40 /* SDA Status */
97
#define    ACBST_BER		0x20
L
Linus Torvalds 已提交
98 99 100 101 102 103 104 105
#define    ACBST_NEGACK		0x10 /* Negative Acknowledge */
#define    ACBST_STASTR		0x08 /* Stall After Start */
#define    ACBST_MASTER		0x02
#define ACBCST		(iface->base + 2)
#define    ACBCST_BB		0x02
#define ACBCTL1		(iface->base + 3)
#define    ACBCTL1_STASTRE	0x80
#define    ACBCTL1_NMINTE	0x40
106 107 108
#define    ACBCTL1_ACK		0x10
#define    ACBCTL1_STOP		0x02
#define    ACBCTL1_START	0x01
L
Linus Torvalds 已提交
109 110 111 112 113 114 115 116 117 118
#define ACBADDR		(iface->base + 4)
#define ACBCTL2		(iface->base + 5)
#define    ACBCTL2_ENABLE	0x01

/************************************************************************/

static void scx200_acb_machine(struct scx200_acb_iface *iface, u8 status)
{
	const char *errmsg;

119 120
	dev_dbg(&iface->adapter.dev, "state %s, status = 0x%02x\n",
		scx200_acb_state_name[iface->state], status);
L
Linus Torvalds 已提交
121 122 123 124 125 126 127 128 129

	if (status & ACBST_BER) {
		errmsg = "bus error";
		goto error;
	}
	if (!(status & ACBST_MASTER)) {
		errmsg = "not master";
		goto error;
	}
130 131 132 133 134 135 136 137 138
	if (status & ACBST_NEGACK) {
		dev_dbg(&iface->adapter.dev, "negative ack in state %s\n",
			scx200_acb_state_name[iface->state]);

		iface->state = state_idle;
		iface->result = -ENXIO;

		outb(inb(ACBCTL1) | ACBCTL1_STOP, ACBCTL1);
		outb(ACBST_STASTR | ACBST_NEGACK, ACBST);
139 140 141

		/* Reset the status register */
		outb(0, ACBST);
142 143
		return;
	}
L
Linus Torvalds 已提交
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168

	switch (iface->state) {
	case state_idle:
		dev_warn(&iface->adapter.dev, "interrupt in idle state\n");
		break;

	case state_address:
		/* Do a pointer write first */
		outb(iface->address_byte & ~1, ACBSDA);

		iface->state = state_command;
		break;

	case state_command:
		outb(iface->command, ACBSDA);

		if (iface->address_byte & 1)
			iface->state = state_repeat_start;
		else
			iface->state = state_write;
		break;

	case state_repeat_start:
		outb(inb(ACBCTL1) | ACBCTL1_START, ACBCTL1);
		/* fallthrough */
169

L
Linus Torvalds 已提交
170 171
	case state_quick:
		if (iface->address_byte & 1) {
172
			if (iface->len == 1)
L
Linus Torvalds 已提交
173 174 175 176 177 178 179 180 181 182 183 184 185 186
				outb(inb(ACBCTL1) | ACBCTL1_ACK, ACBCTL1);
			else
				outb(inb(ACBCTL1) & ~ACBCTL1_ACK, ACBCTL1);
			outb(iface->address_byte, ACBSDA);

			iface->state = state_read;
		} else {
			outb(iface->address_byte, ACBSDA);

			iface->state = state_write;
		}
		break;

	case state_read:
187 188
		/* Set ACK if _next_ byte will be the last one */
		if (iface->len == 2)
L
Linus Torvalds 已提交
189 190 191 192
			outb(inb(ACBCTL1) | ACBCTL1_ACK, ACBCTL1);
		else
			outb(inb(ACBCTL1) & ~ACBCTL1_ACK, ACBCTL1);

193
		if (iface->len == 1) {
L
Linus Torvalds 已提交
194 195 196 197 198
			iface->result = 0;
			iface->state = state_idle;
			outb(inb(ACBCTL1) | ACBCTL1_STOP, ACBCTL1);
		}

199 200 201
		*iface->ptr++ = inb(ACBSDA);
		--iface->len;

L
Linus Torvalds 已提交
202 203 204 205 206 207 208 209 210
		break;

	case state_write:
		if (iface->len == 0) {
			iface->result = 0;
			iface->state = state_idle;
			outb(inb(ACBCTL1) | ACBCTL1_STOP, ACBCTL1);
			break;
		}
211

L
Linus Torvalds 已提交
212 213
		outb(*iface->ptr++, ACBSDA);
		--iface->len;
214

L
Linus Torvalds 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
		break;
	}

	return;

 error:
	dev_err(&iface->adapter.dev, "%s in state %s\n", errmsg,
		scx200_acb_state_name[iface->state]);

	iface->state = state_idle;
	iface->result = -EIO;
	iface->needs_reset = 1;
}

static void scx200_acb_poll(struct scx200_acb_iface *iface)
{
231
	u8 status;
L
Linus Torvalds 已提交
232 233 234 235 236
	unsigned long timeout;

	timeout = jiffies + POLL_TIMEOUT;
	while (time_before(jiffies, timeout)) {
		status = inb(ACBST);
237 238 239 240

		/* Reset the status register to avoid the hang */
		outb(0, ACBST);

L
Linus Torvalds 已提交
241 242 243 244
		if ((status & (ACBST_SDAST|ACBST_BER|ACBST_NEGACK)) != 0) {
			scx200_acb_machine(iface, status);
			return;
		}
245
		yield();
L
Linus Torvalds 已提交
246 247
	}

248 249 250 251 252 253
	dev_err(&iface->adapter.dev, "timeout in state %s\n",
		scx200_acb_state_name[iface->state]);

	iface->state = state_idle;
	iface->result = -EIO;
	iface->needs_reset = 1;
L
Linus Torvalds 已提交
254 255 256 257 258
}

static void scx200_acb_reset(struct scx200_acb_iface *iface)
{
	/* Disable the ACCESS.bus device and Configure the SCL
259
	   frequency: 16 clock cycles */
L
Linus Torvalds 已提交
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
	outb(0x70, ACBCTL2);
	/* Polling mode */
	outb(0, ACBCTL1);
	/* Disable slave address */
	outb(0, ACBADDR);
	/* Enable the ACCESS.bus device */
	outb(inb(ACBCTL2) | ACBCTL2_ENABLE, ACBCTL2);
	/* Free STALL after START */
	outb(inb(ACBCTL1) & ~(ACBCTL1_STASTRE | ACBCTL1_NMINTE), ACBCTL1);
	/* Send a STOP */
	outb(inb(ACBCTL1) | ACBCTL1_STOP, ACBCTL1);
	/* Clear BER, NEGACK and STASTR bits */
	outb(ACBST_BER | ACBST_NEGACK | ACBST_STASTR, ACBST);
	/* Clear BB bit */
	outb(inb(ACBCST) | ACBCST_BB, ACBCST);
}

static s32 scx200_acb_smbus_xfer(struct i2c_adapter *adapter,
278 279 280
				 u16 address, unsigned short flags,
				 char rw, u8 command, int size,
				 union i2c_smbus_data *data)
L
Linus Torvalds 已提交
281 282 283 284 285 286 287 288 289
{
	struct scx200_acb_iface *iface = i2c_get_adapdata(adapter);
	int len;
	u8 *buffer;
	u16 cur_word;
	int rc;

	switch (size) {
	case I2C_SMBUS_QUICK:
290 291 292 293
		len = 0;
		buffer = NULL;
		break;

L
Linus Torvalds 已提交
294
	case I2C_SMBUS_BYTE:
295 296
		len = 1;
		buffer = rw ? &data->byte : &command;
297 298
		break;

L
Linus Torvalds 已提交
299
	case I2C_SMBUS_BYTE_DATA:
300 301 302 303
		len = 1;
		buffer = &data->byte;
		break;

L
Linus Torvalds 已提交
304 305
	case I2C_SMBUS_WORD_DATA:
		len = 2;
306 307
		cur_word = cpu_to_le16(data->word);
		buffer = (u8 *)&cur_word;
L
Linus Torvalds 已提交
308
		break;
309

L
Linus Torvalds 已提交
310
	case I2C_SMBUS_BLOCK_DATA:
311 312
		len = data->block[0];
		buffer = &data->block[1];
L
Linus Torvalds 已提交
313
		break;
314

L
Linus Torvalds 已提交
315
	default:
316
		return -EINVAL;
L
Linus Torvalds 已提交
317 318
	}

319 320 321
	dev_dbg(&adapter->dev,
		"size=%d, address=0x%x, command=0x%x, len=%d, read=%d\n",
		size, address, command, len, rw);
L
Linus Torvalds 已提交
322 323

	if (!len && rw == I2C_SMBUS_READ) {
324
		dev_dbg(&adapter->dev, "zero length read\n");
L
Linus Torvalds 已提交
325 326 327
		return -EINVAL;
	}

328
	mutex_lock(&iface->mutex);
L
Linus Torvalds 已提交
329

330
	iface->address_byte = (address << 1) | rw;
L
Linus Torvalds 已提交
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
	iface->command = command;
	iface->ptr = buffer;
	iface->len = len;
	iface->result = -EINVAL;
	iface->needs_reset = 0;

	outb(inb(ACBCTL1) | ACBCTL1_START, ACBCTL1);

	if (size == I2C_SMBUS_QUICK || size == I2C_SMBUS_BYTE)
		iface->state = state_quick;
	else
		iface->state = state_address;

	while (iface->state != state_idle)
		scx200_acb_poll(iface);

	if (iface->needs_reset)
		scx200_acb_reset(iface);

	rc = iface->result;

352
	mutex_unlock(&iface->mutex);
L
Linus Torvalds 已提交
353 354

	if (rc == 0 && size == I2C_SMBUS_WORD_DATA && rw == I2C_SMBUS_READ)
355
		data->word = le16_to_cpu(cur_word);
L
Linus Torvalds 已提交
356 357

#ifdef DEBUG
358
	dev_dbg(&adapter->dev, "transfer done, result: %d", rc);
L
Linus Torvalds 已提交
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
	if (buffer) {
		int i;
		printk(" data:");
		for (i = 0; i < len; ++i)
			printk(" %02x", buffer[i]);
	}
	printk("\n");
#endif

	return rc;
}

static u32 scx200_acb_func(struct i2c_adapter *adapter)
{
	return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
	       I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
	       I2C_FUNC_SMBUS_BLOCK_DATA;
}

/* For now, we only handle combined mode (smbus) */
static struct i2c_algorithm scx200_acb_algorithm = {
	.smbus_xfer	= scx200_acb_smbus_xfer,
	.functionality	= scx200_acb_func,
};

static struct scx200_acb_iface *scx200_acb_list;
385
static DECLARE_MUTEX(scx200_acb_list_mutex);
L
Linus Torvalds 已提交
386

387
static __init int scx200_acb_probe(struct scx200_acb_iface *iface)
L
Linus Torvalds 已提交
388 389 390 391
{
	u8 val;

	/* Disable the ACCESS.bus device and Configure the SCL
392
	   frequency: 16 clock cycles */
L
Linus Torvalds 已提交
393 394 395
	outb(0x70, ACBCTL2);

	if (inb(ACBCTL2) != 0x70) {
396
		pr_debug(NAME ": ACBCTL2 readback failed\n");
L
Linus Torvalds 已提交
397 398 399 400 401 402 403
		return -ENXIO;
	}

	outb(inb(ACBCTL1) | ACBCTL1_NMINTE, ACBCTL1);

	val = inb(ACBCTL1);
	if (val) {
404 405
		pr_debug(NAME ": disabled, but ACBCTL1=0x%02x\n",
			val);
L
Linus Torvalds 已提交
406 407 408 409 410 411 412 413 414
		return -ENXIO;
	}

	outb(inb(ACBCTL2) | ACBCTL2_ENABLE, ACBCTL2);

	outb(inb(ACBCTL1) | ACBCTL1_NMINTE, ACBCTL1);

	val = inb(ACBCTL1);
	if ((val & ACBCTL1_NMINTE) != ACBCTL1_NMINTE) {
415 416
		pr_debug(NAME ": enabled, but NMINTE won't be set, "
			 "ACBCTL1=0x%02x\n", val);
L
Linus Torvalds 已提交
417 418 419 420 421 422
		return -ENXIO;
	}

	return 0;
}

423 424
static __init struct scx200_acb_iface *scx200_create_iface(const char *text,
		int index)
L
Linus Torvalds 已提交
425 426 427 428
{
	struct scx200_acb_iface *iface;
	struct i2c_adapter *adapter;

429
	iface = kzalloc(sizeof(*iface), GFP_KERNEL);
L
Linus Torvalds 已提交
430 431
	if (!iface) {
		printk(KERN_ERR NAME ": can't allocate memory\n");
432
		return NULL;
L
Linus Torvalds 已提交
433 434 435 436
	}

	adapter = &iface->adapter;
	i2c_set_adapdata(adapter, iface);
437
	snprintf(adapter->name, I2C_NAME_SIZE, "%s ACB%d", text, index);
L
Linus Torvalds 已提交
438
	adapter->owner = THIS_MODULE;
439
	adapter->id = I2C_HW_SMBUS_SCX200;
L
Linus Torvalds 已提交
440 441 442
	adapter->algo = &scx200_acb_algorithm;
	adapter->class = I2C_CLASS_HWMON;

443
	mutex_init(&iface->mutex);
L
Linus Torvalds 已提交
444

445 446 447 448 449 450 451 452 453
	return iface;
}

static int __init scx200_acb_create(struct scx200_acb_iface *iface)
{
	struct i2c_adapter *adapter;
	int rc;

	adapter = &iface->adapter;
L
Linus Torvalds 已提交
454 455 456

	rc = scx200_acb_probe(iface);
	if (rc) {
457
		printk(KERN_WARNING NAME ": probe failed\n");
458
		return rc;
L
Linus Torvalds 已提交
459 460 461 462 463
	}

	scx200_acb_reset(iface);

	if (i2c_add_adapter(adapter) < 0) {
464
		printk(KERN_ERR NAME ": failed to register\n");
465
		return -ENODEV;
L
Linus Torvalds 已提交
466 467
	}

468
	down(&scx200_acb_list_mutex);
L
Linus Torvalds 已提交
469 470
	iface->next = scx200_acb_list;
	scx200_acb_list = iface;
471
	up(&scx200_acb_list_mutex);
L
Linus Torvalds 已提交
472 473

	return 0;
474
}
L
Linus Torvalds 已提交
475

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
static __init int scx200_create_pci(const char *text, struct pci_dev *pdev,
		int bar)
{
	struct scx200_acb_iface *iface;
	int rc;

	iface = scx200_create_iface(text, 0);

	if (iface == NULL)
		return -ENOMEM;

	iface->pdev = pdev;
	iface->bar = bar;

	pci_enable_device_bars(iface->pdev, 1 << iface->bar);

	rc = pci_request_region(iface->pdev, iface->bar, iface->adapter.name);

	if (rc != 0) {
		printk(KERN_ERR NAME ": can't allocate PCI BAR %d\n",
				iface->bar);
		goto errout_free;
	}

	iface->base = pci_resource_start(iface->pdev, iface->bar);
	rc = scx200_acb_create(iface);

	if (rc == 0)
		return 0;

	pci_release_region(iface->pdev, iface->bar);
	pci_dev_put(iface->pdev);
508 509
 errout_free:
	kfree(iface);
L
Linus Torvalds 已提交
510 511 512
	return rc;
}

513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
static int __init scx200_create_isa(const char *text, unsigned long base,
		int index)
{
	struct scx200_acb_iface *iface;
	int rc;

	iface = scx200_create_iface(text, index);

	if (iface == NULL)
		return -ENOMEM;

	if (request_region(base, 8, iface->adapter.name) == 0) {
		printk(KERN_ERR NAME ": can't allocate io 0x%lx-0x%lx\n",
		       base, base + 8 - 1);
		rc = -EBUSY;
		goto errout_free;
	}

	iface->base = base;
	rc = scx200_acb_create(iface);

	if (rc == 0)
		return 0;
L
Linus Torvalds 已提交
536

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
	release_region(base, 8);
 errout_free:
	kfree(iface);
	return rc;
}

/* Driver data is an index into the scx200_data array that indicates
 * the name and the BAR where the I/O address resource is located.  ISA
 * devices are flagged with a bar value of -1 */

static struct pci_device_id scx200_pci[] = {
	{ PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_SCx200_BRIDGE),
	  .driver_data = 0 },
	{ PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_SC1100_BRIDGE),
	  .driver_data = 0 },
	{ PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_CS5535_ISA),
	  .driver_data = 1 },
	{ PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_CS5536_ISA),
	  .driver_data = 2 }
556 557
};

558 559 560 561 562 563 564 565
static struct {
	const char *name;
	int bar;
} scx200_data[] = {
	{ "SCx200", -1 },
	{ "CS5535",  0 },
	{ "CS5536",  0 }
};
566

567
static __init int scx200_scan_pci(void)
568
{
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
	int data, dev;
	int rc = -ENODEV;
	struct pci_dev *pdev;

	for(dev = 0; dev < ARRAY_SIZE(scx200_pci); dev++) {
		pdev = pci_get_device(scx200_pci[dev].vendor,
				scx200_pci[dev].device, NULL);

		if (pdev == NULL)
			continue;

		data = scx200_pci[dev].driver_data;

		/* if .bar is greater or equal to zero, this is a
		 * PCI device - otherwise, we assume
		   that the ports are ISA based
		*/

		if (scx200_data[data].bar >= 0)
			rc = scx200_create_pci(scx200_data[data].name, pdev,
					scx200_data[data].bar);
		else {
			int i;

			for (i = 0; i < MAX_DEVICES; ++i) {
				if (base[i] == 0)
					continue;

				rc = scx200_create_isa(scx200_data[data].name,
						base[i],
						i);
			}
		}
602

603
		break;
604 605
	}

606
	return rc;
607 608
}

L
Linus Torvalds 已提交
609 610
static int __init scx200_acb_init(void)
{
611
	int rc;
L
Linus Torvalds 已提交
612 613 614

	pr_debug(NAME ": NatSemi SCx200 ACCESS.bus Driver\n");

615
	rc = scx200_scan_pci();
L
Linus Torvalds 已提交
616

617 618 619
	/* If at least one bus was created, init must succeed */
	if (scx200_acb_list)
		return 0;
L
Linus Torvalds 已提交
620 621 622 623 624 625
	return rc;
}

static void __exit scx200_acb_cleanup(void)
{
	struct scx200_acb_iface *iface;
626

627
	down(&scx200_acb_list_mutex);
L
Linus Torvalds 已提交
628 629
	while ((iface = scx200_acb_list) != NULL) {
		scx200_acb_list = iface->next;
630
		up(&scx200_acb_list_mutex);
L
Linus Torvalds 已提交
631 632

		i2c_del_adapter(&iface->adapter);
633 634 635 636 637 638 639 640

		if (iface->pdev) {
			pci_release_region(iface->pdev, iface->bar);
			pci_dev_put(iface->pdev);
		}
		else
			release_region(iface->base, 8);

L
Linus Torvalds 已提交
641
		kfree(iface);
642
		down(&scx200_acb_list_mutex);
L
Linus Torvalds 已提交
643
	}
644
	up(&scx200_acb_list_mutex);
L
Linus Torvalds 已提交
645 646 647 648
}

module_init(scx200_acb_init);
module_exit(scx200_acb_cleanup);