Linux Audio

Check our new training course

Loading...
v6.8
  1// SPDX-License-Identifier: GPL-2.0+
  2/****************************************************************************/
  3
  4/*
  5 *	mcf.c -- Freescale ColdFire UART driver
  6 *
  7 *	(C) Copyright 2003-2007, Greg Ungerer <gerg@uclinux.org>
 
 
 
 
 
  8 */
  9
 10/****************************************************************************/
 11
 12#include <linux/kernel.h>
 13#include <linux/init.h>
 14#include <linux/interrupt.h>
 15#include <linux/module.h>
 16#include <linux/console.h>
 17#include <linux/tty.h>
 18#include <linux/tty_flip.h>
 19#include <linux/serial.h>
 20#include <linux/serial_core.h>
 21#include <linux/io.h>
 22#include <linux/uaccess.h>
 23#include <linux/platform_device.h>
 24#include <asm/coldfire.h>
 25#include <asm/mcfsim.h>
 26#include <asm/mcfuart.h>
 27#include <asm/nettel.h>
 28
 29/****************************************************************************/
 30
 31/*
 32 *	Some boards implement the DTR/DCD lines using GPIO lines, most
 33 *	don't. Dummy out the access macros for those that don't. Those
 34 *	that do should define these macros somewhere in there board
 35 *	specific inlude files.
 36 */
 37#if !defined(mcf_getppdcd)
 38#define	mcf_getppdcd(p)		(1)
 39#endif
 40#if !defined(mcf_getppdtr)
 41#define	mcf_getppdtr(p)		(1)
 42#endif
 43#if !defined(mcf_setppdtr)
 44#define	mcf_setppdtr(p, v)	do { } while (0)
 45#endif
 46
 47/****************************************************************************/
 48
 49/*
 50 *	Local per-uart structure.
 51 */
 52struct mcf_uart {
 53	struct uart_port	port;
 54	unsigned int		sigs;		/* Local copy of line sigs */
 55	unsigned char		imr;		/* Local IMR mirror */
 56};
 57
 58/****************************************************************************/
 59
 60static unsigned int mcf_tx_empty(struct uart_port *port)
 61{
 62	return (readb(port->membase + MCFUART_USR) & MCFUART_USR_TXEMPTY) ?
 63		TIOCSER_TEMT : 0;
 64}
 65
 66/****************************************************************************/
 67
 68static unsigned int mcf_get_mctrl(struct uart_port *port)
 69{
 70	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
 71	unsigned int sigs;
 72
 73	sigs = (readb(port->membase + MCFUART_UIPR) & MCFUART_UIPR_CTS) ?
 74		0 : TIOCM_CTS;
 75	sigs |= (pp->sigs & TIOCM_RTS);
 76	sigs |= (mcf_getppdcd(port->line) ? TIOCM_CD : 0);
 77	sigs |= (mcf_getppdtr(port->line) ? TIOCM_DTR : 0);
 78
 79	return sigs;
 80}
 81
 82/****************************************************************************/
 83
 84static void mcf_set_mctrl(struct uart_port *port, unsigned int sigs)
 85{
 86	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
 87
 88	pp->sigs = sigs;
 89	mcf_setppdtr(port->line, (sigs & TIOCM_DTR));
 90	if (sigs & TIOCM_RTS)
 91		writeb(MCFUART_UOP_RTS, port->membase + MCFUART_UOP1);
 92	else
 93		writeb(MCFUART_UOP_RTS, port->membase + MCFUART_UOP0);
 94}
 95
 96/****************************************************************************/
 97
 98static void mcf_start_tx(struct uart_port *port)
 99{
100	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
101
102	if (port->rs485.flags & SER_RS485_ENABLED) {
103		/* Enable Transmitter */
104		writeb(MCFUART_UCR_TXENABLE, port->membase + MCFUART_UCR);
105		/* Manually assert RTS */
106		writeb(MCFUART_UOP_RTS, port->membase + MCFUART_UOP1);
107	}
108	pp->imr |= MCFUART_UIR_TXREADY;
109	writeb(pp->imr, port->membase + MCFUART_UIMR);
110}
111
112/****************************************************************************/
113
114static void mcf_stop_tx(struct uart_port *port)
115{
116	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
117
118	pp->imr &= ~MCFUART_UIR_TXREADY;
119	writeb(pp->imr, port->membase + MCFUART_UIMR);
120}
121
122/****************************************************************************/
123
124static void mcf_stop_rx(struct uart_port *port)
125{
126	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
127
128	pp->imr &= ~MCFUART_UIR_RXREADY;
129	writeb(pp->imr, port->membase + MCFUART_UIMR);
130}
131
132/****************************************************************************/
133
134static void mcf_break_ctl(struct uart_port *port, int break_state)
135{
136	unsigned long flags;
137
138	uart_port_lock_irqsave(port, &flags);
139	if (break_state == -1)
140		writeb(MCFUART_UCR_CMDBREAKSTART, port->membase + MCFUART_UCR);
141	else
142		writeb(MCFUART_UCR_CMDBREAKSTOP, port->membase + MCFUART_UCR);
143	uart_port_unlock_irqrestore(port, flags);
144}
145
146/****************************************************************************/
147
148static int mcf_startup(struct uart_port *port)
149{
150	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
151	unsigned long flags;
152
153	uart_port_lock_irqsave(port, &flags);
154
155	/* Reset UART, get it into known state... */
156	writeb(MCFUART_UCR_CMDRESETRX, port->membase + MCFUART_UCR);
157	writeb(MCFUART_UCR_CMDRESETTX, port->membase + MCFUART_UCR);
158
159	/* Enable the UART transmitter and receiver */
160	writeb(MCFUART_UCR_RXENABLE | MCFUART_UCR_TXENABLE,
161		port->membase + MCFUART_UCR);
162
163	/* Enable RX interrupts now */
164	pp->imr = MCFUART_UIR_RXREADY;
165	writeb(pp->imr, port->membase + MCFUART_UIMR);
166
167	uart_port_unlock_irqrestore(port, flags);
168
169	return 0;
170}
171
172/****************************************************************************/
173
174static void mcf_shutdown(struct uart_port *port)
175{
176	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
177	unsigned long flags;
178
179	uart_port_lock_irqsave(port, &flags);
180
181	/* Disable all interrupts now */
182	pp->imr = 0;
183	writeb(pp->imr, port->membase + MCFUART_UIMR);
184
185	/* Disable UART transmitter and receiver */
186	writeb(MCFUART_UCR_CMDRESETRX, port->membase + MCFUART_UCR);
187	writeb(MCFUART_UCR_CMDRESETTX, port->membase + MCFUART_UCR);
188
189	uart_port_unlock_irqrestore(port, flags);
190}
191
192/****************************************************************************/
193
194static void mcf_set_termios(struct uart_port *port, struct ktermios *termios,
195			    const struct ktermios *old)
196{
197	unsigned long flags;
198	unsigned int baud, baudclk;
199#if defined(CONFIG_M5272)
200	unsigned int baudfr;
201#endif
202	unsigned char mr1, mr2;
203
204	baud = uart_get_baud_rate(port, termios, old, 0, 230400);
205#if defined(CONFIG_M5272)
206	baudclk = (MCF_BUSCLK / baud) / 32;
207	baudfr = (((MCF_BUSCLK / baud) + 1) / 2) % 16;
208#else
209	baudclk = ((MCF_BUSCLK / baud) + 16) / 32;
210#endif
211
212	mr1 = MCFUART_MR1_RXIRQRDY | MCFUART_MR1_RXERRCHAR;
213	mr2 = 0;
214
215	switch (termios->c_cflag & CSIZE) {
216	case CS5: mr1 |= MCFUART_MR1_CS5; break;
217	case CS6: mr1 |= MCFUART_MR1_CS6; break;
218	case CS7: mr1 |= MCFUART_MR1_CS7; break;
219	case CS8:
220	default:  mr1 |= MCFUART_MR1_CS8; break;
221	}
222
223	if (termios->c_cflag & PARENB) {
224		if (termios->c_cflag & CMSPAR) {
225			if (termios->c_cflag & PARODD)
226				mr1 |= MCFUART_MR1_PARITYMARK;
227			else
228				mr1 |= MCFUART_MR1_PARITYSPACE;
229		} else {
230			if (termios->c_cflag & PARODD)
231				mr1 |= MCFUART_MR1_PARITYODD;
232			else
233				mr1 |= MCFUART_MR1_PARITYEVEN;
234		}
235	} else {
236		mr1 |= MCFUART_MR1_PARITYNONE;
237	}
238
239	/*
240	 * FIXME: port->read_status_mask and port->ignore_status_mask
241	 * need to be initialized based on termios settings for
242	 * INPCK, IGNBRK, IGNPAR, PARMRK, BRKINT
243	 */
244
245	if (termios->c_cflag & CSTOPB)
246		mr2 |= MCFUART_MR2_STOP2;
247	else
248		mr2 |= MCFUART_MR2_STOP1;
249
250	if (termios->c_cflag & CRTSCTS) {
251		mr1 |= MCFUART_MR1_RXRTS;
252		mr2 |= MCFUART_MR2_TXCTS;
253	}
254
255	uart_port_lock_irqsave(port, &flags);
256	if (port->rs485.flags & SER_RS485_ENABLED) {
257		dev_dbg(port->dev, "Setting UART to RS485\n");
258		mr2 |= MCFUART_MR2_TXRTS;
259	}
260
261	uart_update_timeout(port, termios->c_cflag, baud);
262	writeb(MCFUART_UCR_CMDRESETRX, port->membase + MCFUART_UCR);
263	writeb(MCFUART_UCR_CMDRESETTX, port->membase + MCFUART_UCR);
264	writeb(MCFUART_UCR_CMDRESETMRPTR, port->membase + MCFUART_UCR);
265	writeb(mr1, port->membase + MCFUART_UMR);
266	writeb(mr2, port->membase + MCFUART_UMR);
267	writeb((baudclk & 0xff00) >> 8, port->membase + MCFUART_UBG1);
268	writeb((baudclk & 0xff), port->membase + MCFUART_UBG2);
269#if defined(CONFIG_M5272)
270	writeb((baudfr & 0x0f), port->membase + MCFUART_UFPD);
271#endif
272	writeb(MCFUART_UCSR_RXCLKTIMER | MCFUART_UCSR_TXCLKTIMER,
273		port->membase + MCFUART_UCSR);
274	writeb(MCFUART_UCR_RXENABLE | MCFUART_UCR_TXENABLE,
275		port->membase + MCFUART_UCR);
276	uart_port_unlock_irqrestore(port, flags);
277}
278
279/****************************************************************************/
280
281static void mcf_rx_chars(struct mcf_uart *pp)
282{
283	struct uart_port *port = &pp->port;
284	u8 status, ch, flag;
285
286	while ((status = readb(port->membase + MCFUART_USR)) & MCFUART_USR_RXREADY) {
287		ch = readb(port->membase + MCFUART_URB);
288		flag = TTY_NORMAL;
289		port->icount.rx++;
290
291		if (status & MCFUART_USR_RXERR) {
292			writeb(MCFUART_UCR_CMDRESETERR,
293				port->membase + MCFUART_UCR);
294
295			if (status & MCFUART_USR_RXBREAK) {
296				port->icount.brk++;
297				if (uart_handle_break(port))
298					continue;
299			} else if (status & MCFUART_USR_RXPARITY) {
300				port->icount.parity++;
301			} else if (status & MCFUART_USR_RXOVERRUN) {
302				port->icount.overrun++;
303			} else if (status & MCFUART_USR_RXFRAMING) {
304				port->icount.frame++;
305			}
306
307			status &= port->read_status_mask;
308
309			if (status & MCFUART_USR_RXBREAK)
310				flag = TTY_BREAK;
311			else if (status & MCFUART_USR_RXPARITY)
312				flag = TTY_PARITY;
313			else if (status & MCFUART_USR_RXFRAMING)
314				flag = TTY_FRAME;
315		}
316
317		if (uart_handle_sysrq_char(port, ch))
318			continue;
319		uart_insert_char(port, status, MCFUART_USR_RXOVERRUN, ch, flag);
320	}
321
 
322	tty_flip_buffer_push(&port->state->port);
 
323}
324
325/****************************************************************************/
326
327static void mcf_tx_chars(struct mcf_uart *pp)
328{
329	struct uart_port *port = &pp->port;
330	bool pending;
331	u8 ch;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
332
333	pending = uart_port_tx(port, ch,
334		readb(port->membase + MCFUART_USR) & MCFUART_USR_TXREADY,
335		writeb(ch, port->membase + MCFUART_UTB));
336
337	/* Disable TX to negate RTS automatically */
338	if (!pending && (port->rs485.flags & SER_RS485_ENABLED))
339		writeb(MCFUART_UCR_TXDISABLE, port->membase + MCFUART_UCR);
 
 
 
 
340}
341
342/****************************************************************************/
343
344static irqreturn_t mcf_interrupt(int irq, void *data)
345{
346	struct uart_port *port = data;
347	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
348	unsigned int isr;
349	irqreturn_t ret = IRQ_NONE;
350
351	isr = readb(port->membase + MCFUART_UISR) & pp->imr;
352
353	uart_port_lock(port);
354	if (isr & MCFUART_UIR_RXREADY) {
355		mcf_rx_chars(pp);
356		ret = IRQ_HANDLED;
357	}
358	if (isr & MCFUART_UIR_TXREADY) {
359		mcf_tx_chars(pp);
360		ret = IRQ_HANDLED;
361	}
362	uart_port_unlock(port);
363
364	return ret;
365}
366
367/****************************************************************************/
368
369static void mcf_config_port(struct uart_port *port, int flags)
370{
371	port->type = PORT_MCF;
372	port->fifosize = MCFUART_TXFIFOSIZE;
373
374	/* Clear mask, so no surprise interrupts. */
375	writeb(0, port->membase + MCFUART_UIMR);
376
377	if (request_irq(port->irq, mcf_interrupt, 0, "UART", port))
378		printk(KERN_ERR "MCF: unable to attach ColdFire UART %d "
379			"interrupt vector=%d\n", port->line, port->irq);
380}
381
382/****************************************************************************/
383
384static const char *mcf_type(struct uart_port *port)
385{
386	return (port->type == PORT_MCF) ? "ColdFire UART" : NULL;
387}
388
389/****************************************************************************/
390
391static int mcf_request_port(struct uart_port *port)
392{
393	/* UARTs always present */
394	return 0;
395}
396
397/****************************************************************************/
398
399static void mcf_release_port(struct uart_port *port)
400{
401	/* Nothing to release... */
402}
403
404/****************************************************************************/
405
406static int mcf_verify_port(struct uart_port *port, struct serial_struct *ser)
407{
408	if ((ser->type != PORT_UNKNOWN) && (ser->type != PORT_MCF))
409		return -EINVAL;
410	return 0;
411}
412
413/****************************************************************************/
414
415/* Enable or disable the RS485 support */
416static int mcf_config_rs485(struct uart_port *port, struct ktermios *termios,
417			    struct serial_rs485 *rs485)
418{
419	unsigned char mr1, mr2;
420
421	/* Get mode registers */
422	mr1 = readb(port->membase + MCFUART_UMR);
423	mr2 = readb(port->membase + MCFUART_UMR);
424	if (rs485->flags & SER_RS485_ENABLED) {
425		dev_dbg(port->dev, "Setting UART to RS485\n");
426		/* Automatically negate RTS after TX completes */
427		mr2 |= MCFUART_MR2_TXRTS;
428	} else {
429		dev_dbg(port->dev, "Setting UART to RS232\n");
430		mr2 &= ~MCFUART_MR2_TXRTS;
431	}
432	writeb(mr1, port->membase + MCFUART_UMR);
433	writeb(mr2, port->membase + MCFUART_UMR);
 
434
435	return 0;
436}
437
438static const struct serial_rs485 mcf_rs485_supported = {
439	.flags = SER_RS485_ENABLED | SER_RS485_RTS_AFTER_SEND,
440};
441
442/****************************************************************************/
443
444/*
445 *	Define the basic serial functions we support.
446 */
447static const struct uart_ops mcf_uart_ops = {
448	.tx_empty	= mcf_tx_empty,
449	.get_mctrl	= mcf_get_mctrl,
450	.set_mctrl	= mcf_set_mctrl,
451	.start_tx	= mcf_start_tx,
452	.stop_tx	= mcf_stop_tx,
453	.stop_rx	= mcf_stop_rx,
454	.break_ctl	= mcf_break_ctl,
455	.startup	= mcf_startup,
456	.shutdown	= mcf_shutdown,
457	.set_termios	= mcf_set_termios,
458	.type		= mcf_type,
459	.request_port	= mcf_request_port,
460	.release_port	= mcf_release_port,
461	.config_port	= mcf_config_port,
462	.verify_port	= mcf_verify_port,
463};
464
465static struct mcf_uart mcf_ports[4];
466
467#define	MCF_MAXPORTS	ARRAY_SIZE(mcf_ports)
468
469/****************************************************************************/
470#if defined(CONFIG_SERIAL_MCF_CONSOLE)
471/****************************************************************************/
472
473int __init early_mcf_setup(struct mcf_platform_uart *platp)
474{
475	struct uart_port *port;
476	int i;
477
478	for (i = 0; ((i < MCF_MAXPORTS) && (platp[i].mapbase)); i++) {
479		port = &mcf_ports[i].port;
480
481		port->line = i;
482		port->type = PORT_MCF;
483		port->mapbase = platp[i].mapbase;
484		port->membase = (platp[i].membase) ? platp[i].membase :
485			(unsigned char __iomem *) port->mapbase;
486		port->iotype = SERIAL_IO_MEM;
487		port->irq = platp[i].irq;
488		port->uartclk = MCF_BUSCLK;
489		port->flags = UPF_BOOT_AUTOCONF;
490		port->rs485_config = mcf_config_rs485;
491		port->rs485_supported = mcf_rs485_supported;
492		port->ops = &mcf_uart_ops;
493	}
494
495	return 0;
496}
497
498/****************************************************************************/
499
500static void mcf_console_putc(struct console *co, const char c)
501{
502	struct uart_port *port = &(mcf_ports + co->index)->port;
503	int i;
504
505	for (i = 0; (i < 0x10000); i++) {
506		if (readb(port->membase + MCFUART_USR) & MCFUART_USR_TXREADY)
507			break;
508	}
509	writeb(c, port->membase + MCFUART_UTB);
510	for (i = 0; (i < 0x10000); i++) {
511		if (readb(port->membase + MCFUART_USR) & MCFUART_USR_TXREADY)
512			break;
513	}
514}
515
516/****************************************************************************/
517
518static void mcf_console_write(struct console *co, const char *s, unsigned int count)
519{
520	for (; (count); count--, s++) {
521		mcf_console_putc(co, *s);
522		if (*s == '\n')
523			mcf_console_putc(co, '\r');
524	}
525}
526
527/****************************************************************************/
528
529static int __init mcf_console_setup(struct console *co, char *options)
530{
531	struct uart_port *port;
532	int baud = CONFIG_SERIAL_MCF_BAUDRATE;
533	int bits = 8;
534	int parity = 'n';
535	int flow = 'n';
536
537	if ((co->index < 0) || (co->index >= MCF_MAXPORTS))
538		co->index = 0;
539	port = &mcf_ports[co->index].port;
540	if (port->membase == 0)
541		return -ENODEV;
542
543	if (options)
544		uart_parse_options(options, &baud, &parity, &bits, &flow);
545
546	return uart_set_options(port, co, baud, parity, bits, flow);
547}
548
549/****************************************************************************/
550
551static struct uart_driver mcf_driver;
552
553static struct console mcf_console = {
554	.name		= "ttyS",
555	.write		= mcf_console_write,
556	.device		= uart_console_device,
557	.setup		= mcf_console_setup,
558	.flags		= CON_PRINTBUFFER,
559	.index		= -1,
560	.data		= &mcf_driver,
561};
562
563static int __init mcf_console_init(void)
564{
565	register_console(&mcf_console);
566	return 0;
567}
568
569console_initcall(mcf_console_init);
570
571#define	MCF_CONSOLE	&mcf_console
572
573/****************************************************************************/
574#else
575/****************************************************************************/
576
577#define	MCF_CONSOLE	NULL
578
579/****************************************************************************/
580#endif /* CONFIG_SERIAL_MCF_CONSOLE */
581/****************************************************************************/
582
583/*
584 *	Define the mcf UART driver structure.
585 */
586static struct uart_driver mcf_driver = {
587	.owner		= THIS_MODULE,
588	.driver_name	= "mcf",
589	.dev_name	= "ttyS",
590	.major		= TTY_MAJOR,
591	.minor		= 64,
592	.nr		= MCF_MAXPORTS,
593	.cons		= MCF_CONSOLE,
594};
595
596/****************************************************************************/
597
598static int mcf_probe(struct platform_device *pdev)
599{
600	struct mcf_platform_uart *platp = dev_get_platdata(&pdev->dev);
601	struct uart_port *port;
602	int i;
603
604	for (i = 0; ((i < MCF_MAXPORTS) && (platp[i].mapbase)); i++) {
605		port = &mcf_ports[i].port;
606
607		port->line = i;
608		port->type = PORT_MCF;
609		port->mapbase = platp[i].mapbase;
610		port->membase = (platp[i].membase) ? platp[i].membase :
611			(unsigned char __iomem *) platp[i].mapbase;
612		port->dev = &pdev->dev;
613		port->iotype = SERIAL_IO_MEM;
614		port->irq = platp[i].irq;
615		port->uartclk = MCF_BUSCLK;
616		port->ops = &mcf_uart_ops;
617		port->flags = UPF_BOOT_AUTOCONF;
618		port->rs485_config = mcf_config_rs485;
619		port->rs485_supported = mcf_rs485_supported;
620		port->has_sysrq = IS_ENABLED(CONFIG_SERIAL_MCF_CONSOLE);
621
622		uart_add_one_port(&mcf_driver, port);
623	}
624
625	return 0;
626}
627
628/****************************************************************************/
629
630static void mcf_remove(struct platform_device *pdev)
631{
632	struct uart_port *port;
633	int i;
634
635	for (i = 0; (i < MCF_MAXPORTS); i++) {
636		port = &mcf_ports[i].port;
637		if (port)
638			uart_remove_one_port(&mcf_driver, port);
639	}
 
 
640}
641
642/****************************************************************************/
643
644static struct platform_driver mcf_platform_driver = {
645	.probe		= mcf_probe,
646	.remove_new	= mcf_remove,
647	.driver		= {
648		.name	= "mcfuart",
649	},
650};
651
652/****************************************************************************/
653
654static int __init mcf_init(void)
655{
656	int rc;
657
658	printk("ColdFire internal UART serial driver\n");
659
660	rc = uart_register_driver(&mcf_driver);
661	if (rc)
662		return rc;
663	rc = platform_driver_register(&mcf_platform_driver);
664	if (rc) {
665		uart_unregister_driver(&mcf_driver);
666		return rc;
667	}
668	return 0;
669}
670
671/****************************************************************************/
672
673static void __exit mcf_exit(void)
674{
675	platform_driver_unregister(&mcf_platform_driver);
676	uart_unregister_driver(&mcf_driver);
677}
678
679/****************************************************************************/
680
681module_init(mcf_init);
682module_exit(mcf_exit);
683
684MODULE_AUTHOR("Greg Ungerer <gerg@uclinux.org>");
685MODULE_DESCRIPTION("Freescale ColdFire UART driver");
686MODULE_LICENSE("GPL");
687MODULE_ALIAS("platform:mcfuart");
688
689/****************************************************************************/
v4.10.11
 
  1/****************************************************************************/
  2
  3/*
  4 *	mcf.c -- Freescale ColdFire UART driver
  5 *
  6 *	(C) Copyright 2003-2007, Greg Ungerer <gerg@uclinux.org>
  7 *
  8 * This program is free software; you can redistribute it and/or modify
  9 * it under the terms of the GNU General Public License as published by
 10 * the Free Software Foundation; either version 2 of the License, or
 11 * (at your option) any later version.
 12 */
 13
 14/****************************************************************************/
 15
 16#include <linux/kernel.h>
 17#include <linux/init.h>
 18#include <linux/interrupt.h>
 19#include <linux/module.h>
 20#include <linux/console.h>
 21#include <linux/tty.h>
 22#include <linux/tty_flip.h>
 23#include <linux/serial.h>
 24#include <linux/serial_core.h>
 25#include <linux/io.h>
 26#include <linux/uaccess.h>
 27#include <linux/platform_device.h>
 28#include <asm/coldfire.h>
 29#include <asm/mcfsim.h>
 30#include <asm/mcfuart.h>
 31#include <asm/nettel.h>
 32
 33/****************************************************************************/
 34
 35/*
 36 *	Some boards implement the DTR/DCD lines using GPIO lines, most
 37 *	don't. Dummy out the access macros for those that don't. Those
 38 *	that do should define these macros somewhere in there board
 39 *	specific inlude files.
 40 */
 41#if !defined(mcf_getppdcd)
 42#define	mcf_getppdcd(p)		(1)
 43#endif
 44#if !defined(mcf_getppdtr)
 45#define	mcf_getppdtr(p)		(1)
 46#endif
 47#if !defined(mcf_setppdtr)
 48#define	mcf_setppdtr(p, v)	do { } while (0)
 49#endif
 50
 51/****************************************************************************/
 52
 53/*
 54 *	Local per-uart structure.
 55 */
 56struct mcf_uart {
 57	struct uart_port	port;
 58	unsigned int		sigs;		/* Local copy of line sigs */
 59	unsigned char		imr;		/* Local IMR mirror */
 60};
 61
 62/****************************************************************************/
 63
 64static unsigned int mcf_tx_empty(struct uart_port *port)
 65{
 66	return (readb(port->membase + MCFUART_USR) & MCFUART_USR_TXEMPTY) ?
 67		TIOCSER_TEMT : 0;
 68}
 69
 70/****************************************************************************/
 71
 72static unsigned int mcf_get_mctrl(struct uart_port *port)
 73{
 74	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
 75	unsigned int sigs;
 76
 77	sigs = (readb(port->membase + MCFUART_UIPR) & MCFUART_UIPR_CTS) ?
 78		0 : TIOCM_CTS;
 79	sigs |= (pp->sigs & TIOCM_RTS);
 80	sigs |= (mcf_getppdcd(port->line) ? TIOCM_CD : 0);
 81	sigs |= (mcf_getppdtr(port->line) ? TIOCM_DTR : 0);
 82
 83	return sigs;
 84}
 85
 86/****************************************************************************/
 87
 88static void mcf_set_mctrl(struct uart_port *port, unsigned int sigs)
 89{
 90	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
 91
 92	pp->sigs = sigs;
 93	mcf_setppdtr(port->line, (sigs & TIOCM_DTR));
 94	if (sigs & TIOCM_RTS)
 95		writeb(MCFUART_UOP_RTS, port->membase + MCFUART_UOP1);
 96	else
 97		writeb(MCFUART_UOP_RTS, port->membase + MCFUART_UOP0);
 98}
 99
100/****************************************************************************/
101
102static void mcf_start_tx(struct uart_port *port)
103{
104	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
105
106	if (port->rs485.flags & SER_RS485_ENABLED) {
107		/* Enable Transmitter */
108		writeb(MCFUART_UCR_TXENABLE, port->membase + MCFUART_UCR);
109		/* Manually assert RTS */
110		writeb(MCFUART_UOP_RTS, port->membase + MCFUART_UOP1);
111	}
112	pp->imr |= MCFUART_UIR_TXREADY;
113	writeb(pp->imr, port->membase + MCFUART_UIMR);
114}
115
116/****************************************************************************/
117
118static void mcf_stop_tx(struct uart_port *port)
119{
120	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
121
122	pp->imr &= ~MCFUART_UIR_TXREADY;
123	writeb(pp->imr, port->membase + MCFUART_UIMR);
124}
125
126/****************************************************************************/
127
128static void mcf_stop_rx(struct uart_port *port)
129{
130	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
131
132	pp->imr &= ~MCFUART_UIR_RXREADY;
133	writeb(pp->imr, port->membase + MCFUART_UIMR);
134}
135
136/****************************************************************************/
137
138static void mcf_break_ctl(struct uart_port *port, int break_state)
139{
140	unsigned long flags;
141
142	spin_lock_irqsave(&port->lock, flags);
143	if (break_state == -1)
144		writeb(MCFUART_UCR_CMDBREAKSTART, port->membase + MCFUART_UCR);
145	else
146		writeb(MCFUART_UCR_CMDBREAKSTOP, port->membase + MCFUART_UCR);
147	spin_unlock_irqrestore(&port->lock, flags);
148}
149
150/****************************************************************************/
151
152static int mcf_startup(struct uart_port *port)
153{
154	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
155	unsigned long flags;
156
157	spin_lock_irqsave(&port->lock, flags);
158
159	/* Reset UART, get it into known state... */
160	writeb(MCFUART_UCR_CMDRESETRX, port->membase + MCFUART_UCR);
161	writeb(MCFUART_UCR_CMDRESETTX, port->membase + MCFUART_UCR);
162
163	/* Enable the UART transmitter and receiver */
164	writeb(MCFUART_UCR_RXENABLE | MCFUART_UCR_TXENABLE,
165		port->membase + MCFUART_UCR);
166
167	/* Enable RX interrupts now */
168	pp->imr = MCFUART_UIR_RXREADY;
169	writeb(pp->imr, port->membase + MCFUART_UIMR);
170
171	spin_unlock_irqrestore(&port->lock, flags);
172
173	return 0;
174}
175
176/****************************************************************************/
177
178static void mcf_shutdown(struct uart_port *port)
179{
180	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
181	unsigned long flags;
182
183	spin_lock_irqsave(&port->lock, flags);
184
185	/* Disable all interrupts now */
186	pp->imr = 0;
187	writeb(pp->imr, port->membase + MCFUART_UIMR);
188
189	/* Disable UART transmitter and receiver */
190	writeb(MCFUART_UCR_CMDRESETRX, port->membase + MCFUART_UCR);
191	writeb(MCFUART_UCR_CMDRESETTX, port->membase + MCFUART_UCR);
192
193	spin_unlock_irqrestore(&port->lock, flags);
194}
195
196/****************************************************************************/
197
198static void mcf_set_termios(struct uart_port *port, struct ktermios *termios,
199	struct ktermios *old)
200{
201	unsigned long flags;
202	unsigned int baud, baudclk;
203#if defined(CONFIG_M5272)
204	unsigned int baudfr;
205#endif
206	unsigned char mr1, mr2;
207
208	baud = uart_get_baud_rate(port, termios, old, 0, 230400);
209#if defined(CONFIG_M5272)
210	baudclk = (MCF_BUSCLK / baud) / 32;
211	baudfr = (((MCF_BUSCLK / baud) + 1) / 2) % 16;
212#else
213	baudclk = ((MCF_BUSCLK / baud) + 16) / 32;
214#endif
215
216	mr1 = MCFUART_MR1_RXIRQRDY | MCFUART_MR1_RXERRCHAR;
217	mr2 = 0;
218
219	switch (termios->c_cflag & CSIZE) {
220	case CS5: mr1 |= MCFUART_MR1_CS5; break;
221	case CS6: mr1 |= MCFUART_MR1_CS6; break;
222	case CS7: mr1 |= MCFUART_MR1_CS7; break;
223	case CS8:
224	default:  mr1 |= MCFUART_MR1_CS8; break;
225	}
226
227	if (termios->c_cflag & PARENB) {
228		if (termios->c_cflag & CMSPAR) {
229			if (termios->c_cflag & PARODD)
230				mr1 |= MCFUART_MR1_PARITYMARK;
231			else
232				mr1 |= MCFUART_MR1_PARITYSPACE;
233		} else {
234			if (termios->c_cflag & PARODD)
235				mr1 |= MCFUART_MR1_PARITYODD;
236			else
237				mr1 |= MCFUART_MR1_PARITYEVEN;
238		}
239	} else {
240		mr1 |= MCFUART_MR1_PARITYNONE;
241	}
242
243	/*
244	 * FIXME: port->read_status_mask and port->ignore_status_mask
245	 * need to be initialized based on termios settings for
246	 * INPCK, IGNBRK, IGNPAR, PARMRK, BRKINT
247	 */
248
249	if (termios->c_cflag & CSTOPB)
250		mr2 |= MCFUART_MR2_STOP2;
251	else
252		mr2 |= MCFUART_MR2_STOP1;
253
254	if (termios->c_cflag & CRTSCTS) {
255		mr1 |= MCFUART_MR1_RXRTS;
256		mr2 |= MCFUART_MR2_TXCTS;
257	}
258
259	spin_lock_irqsave(&port->lock, flags);
260	if (port->rs485.flags & SER_RS485_ENABLED) {
261		dev_dbg(port->dev, "Setting UART to RS485\n");
262		mr2 |= MCFUART_MR2_TXRTS;
263	}
264
265	uart_update_timeout(port, termios->c_cflag, baud);
266	writeb(MCFUART_UCR_CMDRESETRX, port->membase + MCFUART_UCR);
267	writeb(MCFUART_UCR_CMDRESETTX, port->membase + MCFUART_UCR);
268	writeb(MCFUART_UCR_CMDRESETMRPTR, port->membase + MCFUART_UCR);
269	writeb(mr1, port->membase + MCFUART_UMR);
270	writeb(mr2, port->membase + MCFUART_UMR);
271	writeb((baudclk & 0xff00) >> 8, port->membase + MCFUART_UBG1);
272	writeb((baudclk & 0xff), port->membase + MCFUART_UBG2);
273#if defined(CONFIG_M5272)
274	writeb((baudfr & 0x0f), port->membase + MCFUART_UFPD);
275#endif
276	writeb(MCFUART_UCSR_RXCLKTIMER | MCFUART_UCSR_TXCLKTIMER,
277		port->membase + MCFUART_UCSR);
278	writeb(MCFUART_UCR_RXENABLE | MCFUART_UCR_TXENABLE,
279		port->membase + MCFUART_UCR);
280	spin_unlock_irqrestore(&port->lock, flags);
281}
282
283/****************************************************************************/
284
285static void mcf_rx_chars(struct mcf_uart *pp)
286{
287	struct uart_port *port = &pp->port;
288	unsigned char status, ch, flag;
289
290	while ((status = readb(port->membase + MCFUART_USR)) & MCFUART_USR_RXREADY) {
291		ch = readb(port->membase + MCFUART_URB);
292		flag = TTY_NORMAL;
293		port->icount.rx++;
294
295		if (status & MCFUART_USR_RXERR) {
296			writeb(MCFUART_UCR_CMDRESETERR,
297				port->membase + MCFUART_UCR);
298
299			if (status & MCFUART_USR_RXBREAK) {
300				port->icount.brk++;
301				if (uart_handle_break(port))
302					continue;
303			} else if (status & MCFUART_USR_RXPARITY) {
304				port->icount.parity++;
305			} else if (status & MCFUART_USR_RXOVERRUN) {
306				port->icount.overrun++;
307			} else if (status & MCFUART_USR_RXFRAMING) {
308				port->icount.frame++;
309			}
310
311			status &= port->read_status_mask;
312
313			if (status & MCFUART_USR_RXBREAK)
314				flag = TTY_BREAK;
315			else if (status & MCFUART_USR_RXPARITY)
316				flag = TTY_PARITY;
317			else if (status & MCFUART_USR_RXFRAMING)
318				flag = TTY_FRAME;
319		}
320
321		if (uart_handle_sysrq_char(port, ch))
322			continue;
323		uart_insert_char(port, status, MCFUART_USR_RXOVERRUN, ch, flag);
324	}
325
326	spin_unlock(&port->lock);
327	tty_flip_buffer_push(&port->state->port);
328	spin_lock(&port->lock);
329}
330
331/****************************************************************************/
332
333static void mcf_tx_chars(struct mcf_uart *pp)
334{
335	struct uart_port *port = &pp->port;
336	struct circ_buf *xmit = &port->state->xmit;
337
338	if (port->x_char) {
339		/* Send special char - probably flow control */
340		writeb(port->x_char, port->membase + MCFUART_UTB);
341		port->x_char = 0;
342		port->icount.tx++;
343		return;
344	}
345
346	while (readb(port->membase + MCFUART_USR) & MCFUART_USR_TXREADY) {
347		if (xmit->head == xmit->tail)
348			break;
349		writeb(xmit->buf[xmit->tail], port->membase + MCFUART_UTB);
350		xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE -1);
351		port->icount.tx++;
352	}
353
354	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
355		uart_write_wakeup(port);
356
357	if (xmit->head == xmit->tail) {
358		pp->imr &= ~MCFUART_UIR_TXREADY;
359		writeb(pp->imr, port->membase + MCFUART_UIMR);
360		/* Disable TX to negate RTS automatically */
361		if (port->rs485.flags & SER_RS485_ENABLED)
362			writeb(MCFUART_UCR_TXDISABLE,
363				port->membase + MCFUART_UCR);
364	}
365}
366
367/****************************************************************************/
368
369static irqreturn_t mcf_interrupt(int irq, void *data)
370{
371	struct uart_port *port = data;
372	struct mcf_uart *pp = container_of(port, struct mcf_uart, port);
373	unsigned int isr;
374	irqreturn_t ret = IRQ_NONE;
375
376	isr = readb(port->membase + MCFUART_UISR) & pp->imr;
377
378	spin_lock(&port->lock);
379	if (isr & MCFUART_UIR_RXREADY) {
380		mcf_rx_chars(pp);
381		ret = IRQ_HANDLED;
382	}
383	if (isr & MCFUART_UIR_TXREADY) {
384		mcf_tx_chars(pp);
385		ret = IRQ_HANDLED;
386	}
387	spin_unlock(&port->lock);
388
389	return ret;
390}
391
392/****************************************************************************/
393
394static void mcf_config_port(struct uart_port *port, int flags)
395{
396	port->type = PORT_MCF;
397	port->fifosize = MCFUART_TXFIFOSIZE;
398
399	/* Clear mask, so no surprise interrupts. */
400	writeb(0, port->membase + MCFUART_UIMR);
401
402	if (request_irq(port->irq, mcf_interrupt, 0, "UART", port))
403		printk(KERN_ERR "MCF: unable to attach ColdFire UART %d "
404			"interrupt vector=%d\n", port->line, port->irq);
405}
406
407/****************************************************************************/
408
409static const char *mcf_type(struct uart_port *port)
410{
411	return (port->type == PORT_MCF) ? "ColdFire UART" : NULL;
412}
413
414/****************************************************************************/
415
416static int mcf_request_port(struct uart_port *port)
417{
418	/* UARTs always present */
419	return 0;
420}
421
422/****************************************************************************/
423
424static void mcf_release_port(struct uart_port *port)
425{
426	/* Nothing to release... */
427}
428
429/****************************************************************************/
430
431static int mcf_verify_port(struct uart_port *port, struct serial_struct *ser)
432{
433	if ((ser->type != PORT_UNKNOWN) && (ser->type != PORT_MCF))
434		return -EINVAL;
435	return 0;
436}
437
438/****************************************************************************/
439
440/* Enable or disable the RS485 support */
441static int mcf_config_rs485(struct uart_port *port, struct serial_rs485 *rs485)
 
442{
443	unsigned char mr1, mr2;
444
445	/* Get mode registers */
446	mr1 = readb(port->membase + MCFUART_UMR);
447	mr2 = readb(port->membase + MCFUART_UMR);
448	if (rs485->flags & SER_RS485_ENABLED) {
449		dev_dbg(port->dev, "Setting UART to RS485\n");
450		/* Automatically negate RTS after TX completes */
451		mr2 |= MCFUART_MR2_TXRTS;
452	} else {
453		dev_dbg(port->dev, "Setting UART to RS232\n");
454		mr2 &= ~MCFUART_MR2_TXRTS;
455	}
456	writeb(mr1, port->membase + MCFUART_UMR);
457	writeb(mr2, port->membase + MCFUART_UMR);
458	port->rs485 = *rs485;
459
460	return 0;
461}
462
 
 
 
 
463/****************************************************************************/
464
465/*
466 *	Define the basic serial functions we support.
467 */
468static const struct uart_ops mcf_uart_ops = {
469	.tx_empty	= mcf_tx_empty,
470	.get_mctrl	= mcf_get_mctrl,
471	.set_mctrl	= mcf_set_mctrl,
472	.start_tx	= mcf_start_tx,
473	.stop_tx	= mcf_stop_tx,
474	.stop_rx	= mcf_stop_rx,
475	.break_ctl	= mcf_break_ctl,
476	.startup	= mcf_startup,
477	.shutdown	= mcf_shutdown,
478	.set_termios	= mcf_set_termios,
479	.type		= mcf_type,
480	.request_port	= mcf_request_port,
481	.release_port	= mcf_release_port,
482	.config_port	= mcf_config_port,
483	.verify_port	= mcf_verify_port,
484};
485
486static struct mcf_uart mcf_ports[4];
487
488#define	MCF_MAXPORTS	ARRAY_SIZE(mcf_ports)
489
490/****************************************************************************/
491#if defined(CONFIG_SERIAL_MCF_CONSOLE)
492/****************************************************************************/
493
494int __init early_mcf_setup(struct mcf_platform_uart *platp)
495{
496	struct uart_port *port;
497	int i;
498
499	for (i = 0; ((i < MCF_MAXPORTS) && (platp[i].mapbase)); i++) {
500		port = &mcf_ports[i].port;
501
502		port->line = i;
503		port->type = PORT_MCF;
504		port->mapbase = platp[i].mapbase;
505		port->membase = (platp[i].membase) ? platp[i].membase :
506			(unsigned char __iomem *) port->mapbase;
507		port->iotype = SERIAL_IO_MEM;
508		port->irq = platp[i].irq;
509		port->uartclk = MCF_BUSCLK;
510		port->flags = UPF_BOOT_AUTOCONF;
511		port->rs485_config = mcf_config_rs485;
 
512		port->ops = &mcf_uart_ops;
513	}
514
515	return 0;
516}
517
518/****************************************************************************/
519
520static void mcf_console_putc(struct console *co, const char c)
521{
522	struct uart_port *port = &(mcf_ports + co->index)->port;
523	int i;
524
525	for (i = 0; (i < 0x10000); i++) {
526		if (readb(port->membase + MCFUART_USR) & MCFUART_USR_TXREADY)
527			break;
528	}
529	writeb(c, port->membase + MCFUART_UTB);
530	for (i = 0; (i < 0x10000); i++) {
531		if (readb(port->membase + MCFUART_USR) & MCFUART_USR_TXREADY)
532			break;
533	}
534}
535
536/****************************************************************************/
537
538static void mcf_console_write(struct console *co, const char *s, unsigned int count)
539{
540	for (; (count); count--, s++) {
541		mcf_console_putc(co, *s);
542		if (*s == '\n')
543			mcf_console_putc(co, '\r');
544	}
545}
546
547/****************************************************************************/
548
549static int __init mcf_console_setup(struct console *co, char *options)
550{
551	struct uart_port *port;
552	int baud = CONFIG_SERIAL_MCF_BAUDRATE;
553	int bits = 8;
554	int parity = 'n';
555	int flow = 'n';
556
557	if ((co->index < 0) || (co->index >= MCF_MAXPORTS))
558		co->index = 0;
559	port = &mcf_ports[co->index].port;
560	if (port->membase == 0)
561		return -ENODEV;
562
563	if (options)
564		uart_parse_options(options, &baud, &parity, &bits, &flow);
565
566	return uart_set_options(port, co, baud, parity, bits, flow);
567}
568
569/****************************************************************************/
570
571static struct uart_driver mcf_driver;
572
573static struct console mcf_console = {
574	.name		= "ttyS",
575	.write		= mcf_console_write,
576	.device		= uart_console_device,
577	.setup		= mcf_console_setup,
578	.flags		= CON_PRINTBUFFER,
579	.index		= -1,
580	.data		= &mcf_driver,
581};
582
583static int __init mcf_console_init(void)
584{
585	register_console(&mcf_console);
586	return 0;
587}
588
589console_initcall(mcf_console_init);
590
591#define	MCF_CONSOLE	&mcf_console
592
593/****************************************************************************/
594#else
595/****************************************************************************/
596
597#define	MCF_CONSOLE	NULL
598
599/****************************************************************************/
600#endif /* CONFIG_SERIAL_MCF_CONSOLE */
601/****************************************************************************/
602
603/*
604 *	Define the mcf UART driver structure.
605 */
606static struct uart_driver mcf_driver = {
607	.owner		= THIS_MODULE,
608	.driver_name	= "mcf",
609	.dev_name	= "ttyS",
610	.major		= TTY_MAJOR,
611	.minor		= 64,
612	.nr		= MCF_MAXPORTS,
613	.cons		= MCF_CONSOLE,
614};
615
616/****************************************************************************/
617
618static int mcf_probe(struct platform_device *pdev)
619{
620	struct mcf_platform_uart *platp = dev_get_platdata(&pdev->dev);
621	struct uart_port *port;
622	int i;
623
624	for (i = 0; ((i < MCF_MAXPORTS) && (platp[i].mapbase)); i++) {
625		port = &mcf_ports[i].port;
626
627		port->line = i;
628		port->type = PORT_MCF;
629		port->mapbase = platp[i].mapbase;
630		port->membase = (platp[i].membase) ? platp[i].membase :
631			(unsigned char __iomem *) platp[i].mapbase;
632		port->dev = &pdev->dev;
633		port->iotype = SERIAL_IO_MEM;
634		port->irq = platp[i].irq;
635		port->uartclk = MCF_BUSCLK;
636		port->ops = &mcf_uart_ops;
637		port->flags = UPF_BOOT_AUTOCONF;
638		port->rs485_config = mcf_config_rs485;
 
 
639
640		uart_add_one_port(&mcf_driver, port);
641	}
642
643	return 0;
644}
645
646/****************************************************************************/
647
648static int mcf_remove(struct platform_device *pdev)
649{
650	struct uart_port *port;
651	int i;
652
653	for (i = 0; (i < MCF_MAXPORTS); i++) {
654		port = &mcf_ports[i].port;
655		if (port)
656			uart_remove_one_port(&mcf_driver, port);
657	}
658
659	return 0;
660}
661
662/****************************************************************************/
663
664static struct platform_driver mcf_platform_driver = {
665	.probe		= mcf_probe,
666	.remove		= mcf_remove,
667	.driver		= {
668		.name	= "mcfuart",
669	},
670};
671
672/****************************************************************************/
673
674static int __init mcf_init(void)
675{
676	int rc;
677
678	printk("ColdFire internal UART serial driver\n");
679
680	rc = uart_register_driver(&mcf_driver);
681	if (rc)
682		return rc;
683	rc = platform_driver_register(&mcf_platform_driver);
684	if (rc) {
685		uart_unregister_driver(&mcf_driver);
686		return rc;
687	}
688	return 0;
689}
690
691/****************************************************************************/
692
693static void __exit mcf_exit(void)
694{
695	platform_driver_unregister(&mcf_platform_driver);
696	uart_unregister_driver(&mcf_driver);
697}
698
699/****************************************************************************/
700
701module_init(mcf_init);
702module_exit(mcf_exit);
703
704MODULE_AUTHOR("Greg Ungerer <gerg@uclinux.org>");
705MODULE_DESCRIPTION("Freescale ColdFire UART driver");
706MODULE_LICENSE("GPL");
707MODULE_ALIAS("platform:mcfuart");
708
709/****************************************************************************/