uartlite.c 15.2 KB
Newer Older
1 2 3
/*
 * uartlite.c: Serial driver for Xilinx uartlite serial controller
 *
4 5
 * Copyright (C) 2006 Peter Korsgaard <jacmet@sunsite.dk>
 * Copyright (C) 2007 Secret Lab Technologies Ltd.
6 7 8 9 10 11 12 13 14 15 16 17
 *
 * This file is licensed under the terms of the GNU General Public License
 * version 2.  This program is licensed "as is" without any warranty of any
 * kind, whether express or implied.
 */

#include <linux/platform_device.h>
#include <linux/module.h>
#include <linux/console.h>
#include <linux/serial.h>
#include <linux/serial_core.h>
#include <linux/tty.h>
18
#include <linux/tty_flip.h>
19 20
#include <linux/delay.h>
#include <linux/interrupt.h>
21
#include <linux/init.h>
22
#include <asm/io.h>
23
#include <linux/of.h>
24
#include <linux/of_address.h>
25 26
#include <linux/of_device.h>
#include <linux/of_platform.h>
27

28
#define ULITE_NAME		"ttyUL"
29 30 31 32
#define ULITE_MAJOR		204
#define ULITE_MINOR		187
#define ULITE_NR_UARTS		4

33 34 35 36
/* ---------------------------------------------------------------------
 * Register definitions
 *
 * For register details see datasheet:
37
 * http://www.xilinx.com/support/documentation/ip_documentation/opb_uartlite.pdf 
38 39
 */

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
#define ULITE_RX		0x00
#define ULITE_TX		0x04
#define ULITE_STATUS		0x08
#define ULITE_CONTROL		0x0c

#define ULITE_REGION		16

#define ULITE_STATUS_RXVALID	0x01
#define ULITE_STATUS_RXFULL	0x02
#define ULITE_STATUS_TXEMPTY	0x04
#define ULITE_STATUS_TXFULL	0x08
#define ULITE_STATUS_IE		0x10
#define ULITE_STATUS_OVERRUN	0x20
#define ULITE_STATUS_FRAME	0x40
#define ULITE_STATUS_PARITY	0x80

#define ULITE_CONTROL_RST_TX	0x01
#define ULITE_CONTROL_RST_RX	0x02
#define ULITE_CONTROL_IE	0x10


61
static struct uart_port ulite_ports[ULITE_NR_UARTS];
62

63 64 65 66
/* ---------------------------------------------------------------------
 * Core UART driver operations
 */

67 68
static int ulite_receive(struct uart_port *port, int stat)
{
A
Alan Cox 已提交
69
	struct tty_struct *tty = port->state->port.tty;
70 71 72 73 74 75 76 77 78 79
	unsigned char ch = 0;
	char flag = TTY_NORMAL;

	if ((stat & (ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
		     | ULITE_STATUS_FRAME)) == 0)
		return 0;

	/* stats */
	if (stat & ULITE_STATUS_RXVALID) {
		port->icount.rx++;
80
		ch = ioread32be(port->membase + ULITE_RX);
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

		if (stat & ULITE_STATUS_PARITY)
			port->icount.parity++;
	}

	if (stat & ULITE_STATUS_OVERRUN)
		port->icount.overrun++;

	if (stat & ULITE_STATUS_FRAME)
		port->icount.frame++;


	/* drop byte with parity error if IGNPAR specificed */
	if (stat & port->ignore_status_mask & ULITE_STATUS_PARITY)
		stat &= ~ULITE_STATUS_RXVALID;

	stat &= port->read_status_mask;

	if (stat & ULITE_STATUS_PARITY)
		flag = TTY_PARITY;


	stat &= ~port->ignore_status_mask;

	if (stat & ULITE_STATUS_RXVALID)
		tty_insert_flip_char(tty, ch, flag);

	if (stat & ULITE_STATUS_FRAME)
		tty_insert_flip_char(tty, 0, TTY_FRAME);

	if (stat & ULITE_STATUS_OVERRUN)
		tty_insert_flip_char(tty, 0, TTY_OVERRUN);

	return 1;
}

static int ulite_transmit(struct uart_port *port, int stat)
{
A
Alan Cox 已提交
119
	struct circ_buf *xmit  = &port->state->xmit;
120 121 122 123 124

	if (stat & ULITE_STATUS_TXFULL)
		return 0;

	if (port->x_char) {
125
		iowrite32be(port->x_char, port->membase + ULITE_TX);
126 127 128 129 130 131 132 133
		port->x_char = 0;
		port->icount.tx++;
		return 1;
	}

	if (uart_circ_empty(xmit) || uart_tx_stopped(port))
		return 0;

134
	iowrite32be(xmit->buf[xmit->tail], port->membase + ULITE_TX);
135 136 137 138 139 140 141 142 143 144 145 146
	xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE-1);
	port->icount.tx++;

	/* wake up */
	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
		uart_write_wakeup(port);

	return 1;
}

static irqreturn_t ulite_isr(int irq, void *dev_id)
{
147
	struct uart_port *port = dev_id;
148
	int busy, n = 0;
149 150

	do {
151
		int stat = ioread32be(port->membase + ULITE_STATUS);
152 153
		busy  = ulite_receive(port, stat);
		busy |= ulite_transmit(port, stat);
154
		n++;
155 156
	} while (busy);

157 158 159 160 161 162 163
	/* work done? */
	if (n > 1) {
		tty_flip_buffer_push(port->state->port.tty);
		return IRQ_HANDLED;
	} else {
		return IRQ_NONE;
	}
164 165 166 167 168 169 170 171
}

static unsigned int ulite_tx_empty(struct uart_port *port)
{
	unsigned long flags;
	unsigned int ret;

	spin_lock_irqsave(&port->lock, flags);
172
	ret = ioread32be(port->membase + ULITE_STATUS);
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
	spin_unlock_irqrestore(&port->lock, flags);

	return ret & ULITE_STATUS_TXEMPTY ? TIOCSER_TEMT : 0;
}

static unsigned int ulite_get_mctrl(struct uart_port *port)
{
	return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
}

static void ulite_set_mctrl(struct uart_port *port, unsigned int mctrl)
{
	/* N/A */
}

static void ulite_stop_tx(struct uart_port *port)
{
	/* N/A */
}

static void ulite_start_tx(struct uart_port *port)
{
195
	ulite_transmit(port, ioread32be(port->membase + ULITE_STATUS));
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
}

static void ulite_stop_rx(struct uart_port *port)
{
	/* don't forward any more data (like !CREAD) */
	port->ignore_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
		| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;
}

static void ulite_enable_ms(struct uart_port *port)
{
	/* N/A */
}

static void ulite_break_ctl(struct uart_port *port, int ctl)
{
	/* N/A */
}

static int ulite_startup(struct uart_port *port)
{
	int ret;

	ret = request_irq(port->irq, ulite_isr,
220
			  IRQF_SHARED | IRQF_SAMPLE_RANDOM, "uartlite", port);
221 222 223
	if (ret)
		return ret;

224
	iowrite32be(ULITE_CONTROL_RST_RX | ULITE_CONTROL_RST_TX,
225
	       port->membase + ULITE_CONTROL);
226
	iowrite32be(ULITE_CONTROL_IE, port->membase + ULITE_CONTROL);
227 228 229 230 231 232

	return 0;
}

static void ulite_shutdown(struct uart_port *port)
{
233 234
	iowrite32be(0, port->membase + ULITE_CONTROL);
	ioread32be(port->membase + ULITE_CONTROL); /* dummy */
235 236 237
	free_irq(port->irq, port);
}

238 239
static void ulite_set_termios(struct uart_port *port, struct ktermios *termios,
			      struct ktermios *old)
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
{
	unsigned long flags;
	unsigned int baud;

	spin_lock_irqsave(&port->lock, flags);

	port->read_status_mask = ULITE_STATUS_RXVALID | ULITE_STATUS_OVERRUN
		| ULITE_STATUS_TXFULL;

	if (termios->c_iflag & INPCK)
		port->read_status_mask |=
			ULITE_STATUS_PARITY | ULITE_STATUS_FRAME;

	port->ignore_status_mask = 0;
	if (termios->c_iflag & IGNPAR)
		port->ignore_status_mask |= ULITE_STATUS_PARITY
			| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;

	/* ignore all characters if CREAD is not set */
	if ((termios->c_cflag & CREAD) == 0)
		port->ignore_status_mask |=
			ULITE_STATUS_RXVALID | ULITE_STATUS_PARITY
			| ULITE_STATUS_FRAME | ULITE_STATUS_OVERRUN;

	/* update timeout */
	baud = uart_get_baud_rate(port, termios, old, 0, 460800);
	uart_update_timeout(port, termios->c_cflag, baud);

	spin_unlock_irqrestore(&port->lock, flags);
}

static const char *ulite_type(struct uart_port *port)
{
	return port->type == PORT_UARTLITE ? "uartlite" : NULL;
}

static void ulite_release_port(struct uart_port *port)
{
	release_mem_region(port->mapbase, ULITE_REGION);
	iounmap(port->membase);
280
	port->membase = NULL;
281 282 283 284
}

static int ulite_request_port(struct uart_port *port)
{
285 286
	pr_debug("ulite console: port=%p; port->mapbase=%llx\n",
		 port, (unsigned long long) port->mapbase);
287

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
	if (!request_mem_region(port->mapbase, ULITE_REGION, "uartlite")) {
		dev_err(port->dev, "Memory region busy\n");
		return -EBUSY;
	}

	port->membase = ioremap(port->mapbase, ULITE_REGION);
	if (!port->membase) {
		dev_err(port->dev, "Unable to map registers\n");
		release_mem_region(port->mapbase, ULITE_REGION);
		return -EBUSY;
	}

	return 0;
}

static void ulite_config_port(struct uart_port *port, int flags)
{
305 306
	if (!ulite_request_port(port))
		port->type = PORT_UARTLITE;
307 308 309 310 311 312 313 314
}

static int ulite_verify_port(struct uart_port *port, struct serial_struct *ser)
{
	/* we don't want the core code to modify any port params */
	return -EINVAL;
}

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
#ifdef CONFIG_CONSOLE_POLL
static int ulite_get_poll_char(struct uart_port *port)
{
	if (!(ioread32be(port->membase + ULITE_STATUS)
						& ULITE_STATUS_RXVALID))
		return NO_POLL_CHAR;

	return ioread32be(port->membase + ULITE_RX);
}

static void ulite_put_poll_char(struct uart_port *port, unsigned char ch)
{
	while (ioread32be(port->membase + ULITE_STATUS) & ULITE_STATUS_TXFULL)
		cpu_relax();

	/* write char to device */
	iowrite32be(ch, port->membase + ULITE_TX);
}
#endif

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
static struct uart_ops ulite_ops = {
	.tx_empty	= ulite_tx_empty,
	.set_mctrl	= ulite_set_mctrl,
	.get_mctrl	= ulite_get_mctrl,
	.stop_tx	= ulite_stop_tx,
	.start_tx	= ulite_start_tx,
	.stop_rx	= ulite_stop_rx,
	.enable_ms	= ulite_enable_ms,
	.break_ctl	= ulite_break_ctl,
	.startup	= ulite_startup,
	.shutdown	= ulite_shutdown,
	.set_termios	= ulite_set_termios,
	.type		= ulite_type,
	.release_port	= ulite_release_port,
	.request_port	= ulite_request_port,
	.config_port	= ulite_config_port,
351 352 353 354 355
	.verify_port	= ulite_verify_port,
#ifdef CONFIG_CONSOLE_POLL
	.poll_get_char	= ulite_get_poll_char,
	.poll_put_char	= ulite_put_poll_char,
#endif
356 357
};

358 359 360 361
/* ---------------------------------------------------------------------
 * Console driver operations
 */

362 363 364 365
#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
static void ulite_console_wait_tx(struct uart_port *port)
{
	int i;
366
	u8 val;
367

368 369
	/* Spin waiting for TX fifo to have space available */
	for (i = 0; i < 100000; i++) {
370
		val = ioread32be(port->membase + ULITE_STATUS);
371
		if ((val & ULITE_STATUS_TXFULL) == 0)
372
			break;
373
		cpu_relax();
374 375 376 377 378 379
	}
}

static void ulite_console_putchar(struct uart_port *port, int ch)
{
	ulite_console_wait_tx(port);
380
	iowrite32be(ch, port->membase + ULITE_TX);
381 382 383 384 385
}

static void ulite_console_write(struct console *co, const char *s,
				unsigned int count)
{
386
	struct uart_port *port = &ulite_ports[co->index];
387 388 389 390 391 392 393 394 395 396
	unsigned long flags;
	unsigned int ier;
	int locked = 1;

	if (oops_in_progress) {
		locked = spin_trylock_irqsave(&port->lock, flags);
	} else
		spin_lock_irqsave(&port->lock, flags);

	/* save and disable interrupt */
397 398
	ier = ioread32be(port->membase + ULITE_STATUS) & ULITE_STATUS_IE;
	iowrite32be(0, port->membase + ULITE_CONTROL);
399 400 401 402 403 404 405

	uart_console_write(port, s, count, ulite_console_putchar);

	ulite_console_wait_tx(port);

	/* restore interrupt state */
	if (ier)
406
		iowrite32be(ULITE_CONTROL_IE, port->membase + ULITE_CONTROL);
407 408 409 410 411

	if (locked)
		spin_unlock_irqrestore(&port->lock, flags);
}

412
static int __devinit ulite_console_setup(struct console *co, char *options)
413 414 415 416 417 418 419 420 421 422
{
	struct uart_port *port;
	int baud = 9600;
	int bits = 8;
	int parity = 'n';
	int flow = 'n';

	if (co->index < 0 || co->index >= ULITE_NR_UARTS)
		return -EINVAL;

423
	port = &ulite_ports[co->index];
424

425
	/* Has the device been initialized yet? */
426 427 428 429 430
	if (!port->mapbase) {
		pr_debug("console on ttyUL%i not present\n", co->index);
		return -ENODEV;
	}

431
	/* not initialized yet? */
432
	if (!port->membase) {
433 434
		if (ulite_request_port(port))
			return -ENODEV;
435
	}
436 437 438 439 440 441 442 443 444 445

	if (options)
		uart_parse_options(options, &baud, &parity, &bits, &flow);

	return uart_set_options(port, co, baud, parity, bits, flow);
}

static struct uart_driver ulite_uart_driver;

static struct console ulite_console = {
446
	.name	= ULITE_NAME,
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
	.write	= ulite_console_write,
	.device	= uart_console_device,
	.setup	= ulite_console_setup,
	.flags	= CON_PRINTBUFFER,
	.index	= -1, /* Specified on the cmdline (e.g. console=ttyUL0 ) */
	.data	= &ulite_uart_driver,
};

static int __init ulite_console_init(void)
{
	register_console(&ulite_console);
	return 0;
}

console_initcall(ulite_console_init);

#endif /* CONFIG_SERIAL_UARTLITE_CONSOLE */

static struct uart_driver ulite_uart_driver = {
	.owner		= THIS_MODULE,
	.driver_name	= "uartlite",
468
	.dev_name	= ULITE_NAME,
469 470 471 472 473 474 475 476
	.major		= ULITE_MAJOR,
	.minor		= ULITE_MINOR,
	.nr		= ULITE_NR_UARTS,
#ifdef CONFIG_SERIAL_UARTLITE_CONSOLE
	.cons		= &ulite_console,
#endif
};

477 478 479 480 481 482 483 484 485 486 487 488 489
/* ---------------------------------------------------------------------
 * Port assignment functions (mapping devices to uart_port structures)
 */

/** ulite_assign: register a uartlite device with the driver
 *
 * @dev: pointer to device structure
 * @id: requested id number.  Pass -1 for automatic port assignment
 * @base: base address of uartlite registers
 * @irq: irq number for uartlite
 *
 * Returns: 0 on success, <0 otherwise
 */
490
static int __devinit ulite_assign(struct device *dev, int id, u32 base, int irq)
491 492
{
	struct uart_port *port;
493
	int rc;
494

495 496 497 498 499 500 501 502
	/* if id = -1; then scan for a free id and use that */
	if (id < 0) {
		for (id = 0; id < ULITE_NR_UARTS; id++)
			if (ulite_ports[id].mapbase == 0)
				break;
	}
	if (id < 0 || id >= ULITE_NR_UARTS) {
		dev_err(dev, "%s%i too large\n", ULITE_NAME, id);
503
		return -EINVAL;
504
	}
505

506
	if ((ulite_ports[id].mapbase) && (ulite_ports[id].mapbase != base)) {
507 508
		dev_err(dev, "cannot assign to %s%i; it is already in use\n",
			ULITE_NAME, id);
509
		return -EBUSY;
510
	}
511

512
	port = &ulite_ports[id];
513

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
	spin_lock_init(&port->lock);
	port->fifosize = 16;
	port->regshift = 2;
	port->iotype = UPIO_MEM;
	port->iobase = 1; /* mark port in use */
	port->mapbase = base;
	port->membase = NULL;
	port->ops = &ulite_ops;
	port->irq = irq;
	port->flags = UPF_BOOT_AUTOCONF;
	port->dev = dev;
	port->type = PORT_UNKNOWN;
	port->line = id;

	dev_set_drvdata(dev, port);

	/* Register the port */
	rc = uart_add_one_port(&ulite_uart_driver, port);
	if (rc) {
		dev_err(dev, "uart_add_one_port() failed; err=%i\n", rc);
		port->mapbase = 0;
		dev_set_drvdata(dev, NULL);
		return rc;
	}
538

539 540
	return 0;
}
541

542 543 544 545
/** ulite_release: register a uartlite device with the driver
 *
 * @dev: pointer to device structure
 */
546
static int __devexit ulite_release(struct device *dev)
547 548 549
{
	struct uart_port *port = dev_get_drvdata(dev);
	int rc = 0;
550

551 552 553 554 555
	if (port) {
		rc = uart_remove_one_port(&ulite_uart_driver, port);
		dev_set_drvdata(dev, NULL);
		port->mapbase = 0;
	}
556

557
	return rc;
558 559
}

560 561 562 563
/* ---------------------------------------------------------------------
 * Platform bus binding
 */

564 565 566 567 568 569 570 571 572 573
#if defined(CONFIG_OF)
/* Match table for of_platform binding */
static struct of_device_id ulite_of_match[] __devinitdata = {
	{ .compatible = "xlnx,opb-uartlite-1.00.b", },
	{ .compatible = "xlnx,xps-uartlite-1.00.a", },
	{}
};
MODULE_DEVICE_TABLE(of, ulite_of_match);
#endif /* CONFIG_OF */

574
static int __devinit ulite_probe(struct platform_device *pdev)
575
{
576
	struct resource *res, *res2;
577 578 579 580 581 582 583 584
	int id = pdev->id;
#ifdef CONFIG_OF
	const __be32 *prop;

	prop = of_get_property(pdev->dev.of_node, "port-number", NULL);
	if (prop)
		id = be32_to_cpup(prop);
#endif
585

586 587 588
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res)
		return -ENODEV;
589

590 591 592
	res2 = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
	if (!res2)
		return -ENODEV;
593

594
	return ulite_assign(&pdev->dev, id, res->start, res2->start);
595
}
596

597
static int __devexit ulite_remove(struct platform_device *pdev)
598 599
{
	return ulite_release(&pdev->dev);
600 601
}

602 603 604
/* work with hotplug and coldplug */
MODULE_ALIAS("platform:uartlite");

605
static struct platform_driver ulite_platform_driver = {
606 607
	.probe = ulite_probe,
	.remove = __devexit_p(ulite_remove),
608
	.driver = {
609
		.owner = THIS_MODULE,
610
		.name  = "uartlite",
611
		.of_match_table = of_match_ptr(ulite_of_match),
612 613 614
	},
};

615 616 617 618
/* ---------------------------------------------------------------------
 * Module setup/teardown
 */

619 620 621 622
int __init ulite_init(void)
{
	int ret;

623
	pr_debug("uartlite: calling uart_register_driver()\n");
624 625
	ret = uart_register_driver(&ulite_uart_driver);
	if (ret)
626 627 628
		goto err_uart;

	pr_debug("uartlite: calling platform_driver_register()\n");
629 630
	ret = platform_driver_register(&ulite_platform_driver);
	if (ret)
631 632 633
		goto err_plat;

	return 0;
634

635 636 637 638
err_plat:
	uart_unregister_driver(&ulite_uart_driver);
err_uart:
	printk(KERN_ERR "registering uartlite driver failed: err=%i", ret);
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
	return ret;
}

void __exit ulite_exit(void)
{
	platform_driver_unregister(&ulite_platform_driver);
	uart_unregister_driver(&ulite_uart_driver);
}

module_init(ulite_init);
module_exit(ulite_exit);

MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
MODULE_DESCRIPTION("Xilinx uartlite serial driver");
MODULE_LICENSE("GPL");
反馈
建议
客服 返回
顶部