1 /****************************************************************************/
4 * mcf.c -- Freescale ColdFire UART driver
6 * (C) Copyright 2003-2007, Greg Ungerer <gerg@snapgear.com>
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.
14 /****************************************************************************/
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>
26 #include <asm/coldfire.h>
27 #include <asm/mcfsim.h>
28 #include <asm/mcfuart.h>
29 #include <asm/nettel.h>
31 /****************************************************************************/
34 * Some boards implement the DTR/DCD lines using GPIO lines, most
35 * don't. Dummy out the access macros for those that don't. Those
36 * that do should define these macros somewhere in there board
37 * specific inlude files.
39 #if !defined(mcf_getppdcd)
40 #define mcf_getppdcd(p) (1)
42 #if !defined(mcf_getppdtr)
43 #define mcf_getppdtr(p) (1)
45 #if !defined(mcf_setppdtr)
46 #define mcf_setppdtr(p, v) do { } while (0)
49 /****************************************************************************/
52 * Local per-uart structure.
55 struct uart_port port
;
56 unsigned int sigs
; /* Local copy of line sigs */
57 unsigned char imr
; /* Local IMR mirror */
60 /****************************************************************************/
62 static unsigned int mcf_tx_empty(struct uart_port
*port
)
64 return (readb(port
->membase
+ MCFUART_USR
) & MCFUART_USR_TXEMPTY
) ?
68 /****************************************************************************/
70 static unsigned int mcf_get_mctrl(struct uart_port
*port
)
72 struct mcf_uart
*pp
= container_of(port
, struct mcf_uart
, port
);
76 spin_lock_irqsave(&port
->lock
, flags
);
77 sigs
= (readb(port
->membase
+ MCFUART_UIPR
) & MCFUART_UIPR_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 spin_unlock_irqrestore(&port
->lock
, flags
);
86 /****************************************************************************/
88 static void mcf_set_mctrl(struct uart_port
*port
, unsigned int sigs
)
90 struct mcf_uart
*pp
= container_of(port
, struct mcf_uart
, port
);
93 spin_lock_irqsave(&port
->lock
, flags
);
95 mcf_setppdtr(port
->line
, (sigs
& TIOCM_DTR
));
97 writeb(MCFUART_UOP_RTS
, port
->membase
+ MCFUART_UOP1
);
99 writeb(MCFUART_UOP_RTS
, port
->membase
+ MCFUART_UOP0
);
100 spin_unlock_irqrestore(&port
->lock
, flags
);
103 /****************************************************************************/
105 static void mcf_start_tx(struct uart_port
*port
)
107 struct mcf_uart
*pp
= container_of(port
, struct mcf_uart
, port
);
110 spin_lock_irqsave(&port
->lock
, flags
);
111 pp
->imr
|= MCFUART_UIR_TXREADY
;
112 writeb(pp
->imr
, port
->membase
+ MCFUART_UIMR
);
113 spin_unlock_irqrestore(&port
->lock
, flags
);
116 /****************************************************************************/
118 static void mcf_stop_tx(struct uart_port
*port
)
120 struct mcf_uart
*pp
= container_of(port
, struct mcf_uart
, port
);
123 spin_lock_irqsave(&port
->lock
, flags
);
124 pp
->imr
&= ~MCFUART_UIR_TXREADY
;
125 writeb(pp
->imr
, port
->membase
+ MCFUART_UIMR
);
126 spin_unlock_irqrestore(&port
->lock
, flags
);
129 /****************************************************************************/
131 static void mcf_stop_rx(struct uart_port
*port
)
133 struct mcf_uart
*pp
= container_of(port
, struct mcf_uart
, port
);
136 spin_lock_irqsave(&port
->lock
, flags
);
137 pp
->imr
&= ~MCFUART_UIR_RXREADY
;
138 writeb(pp
->imr
, port
->membase
+ MCFUART_UIMR
);
139 spin_unlock_irqrestore(&port
->lock
, flags
);
142 /****************************************************************************/
144 static void mcf_break_ctl(struct uart_port
*port
, int break_state
)
148 spin_lock_irqsave(&port
->lock
, flags
);
149 if (break_state
== -1)
150 writeb(MCFUART_UCR_CMDBREAKSTART
, port
->membase
+ MCFUART_UCR
);
152 writeb(MCFUART_UCR_CMDBREAKSTOP
, port
->membase
+ MCFUART_UCR
);
153 spin_unlock_irqrestore(&port
->lock
, flags
);
156 /****************************************************************************/
158 static void mcf_enable_ms(struct uart_port
*port
)
162 /****************************************************************************/
164 static int mcf_startup(struct uart_port
*port
)
166 struct mcf_uart
*pp
= container_of(port
, struct mcf_uart
, port
);
169 spin_lock_irqsave(&port
->lock
, flags
);
171 /* Reset UART, get it into known state... */
172 writeb(MCFUART_UCR_CMDRESETRX
, port
->membase
+ MCFUART_UCR
);
173 writeb(MCFUART_UCR_CMDRESETTX
, port
->membase
+ MCFUART_UCR
);
175 /* Enable the UART transmitter and receiver */
176 writeb(MCFUART_UCR_RXENABLE
| MCFUART_UCR_TXENABLE
,
177 port
->membase
+ MCFUART_UCR
);
179 /* Enable RX interrupts now */
180 pp
->imr
= MCFUART_UIR_RXREADY
;
181 writeb(pp
->imr
, port
->membase
+ MCFUART_UIMR
);
183 spin_unlock_irqrestore(&port
->lock
, flags
);
188 /****************************************************************************/
190 static void mcf_shutdown(struct uart_port
*port
)
192 struct mcf_uart
*pp
= container_of(port
, struct mcf_uart
, port
);
195 spin_lock_irqsave(&port
->lock
, flags
);
197 /* Disable all interrupts now */
199 writeb(pp
->imr
, port
->membase
+ MCFUART_UIMR
);
201 /* Disable UART transmitter and receiver */
202 writeb(MCFUART_UCR_CMDRESETRX
, port
->membase
+ MCFUART_UCR
);
203 writeb(MCFUART_UCR_CMDRESETTX
, port
->membase
+ MCFUART_UCR
);
205 spin_unlock_irqrestore(&port
->lock
, flags
);
208 /****************************************************************************/
210 static void mcf_set_termios(struct uart_port
*port
, struct ktermios
*termios
,
211 struct ktermios
*old
)
214 unsigned int baud
, baudclk
;
215 #if defined(CONFIG_M5272)
218 unsigned char mr1
, mr2
;
220 baud
= uart_get_baud_rate(port
, termios
, old
, 0, 230400);
221 #if defined(CONFIG_M5272)
222 baudclk
= (MCF_BUSCLK
/ baud
) / 32;
223 baudfr
= (((MCF_BUSCLK
/ baud
) + 1) / 2) % 16;
225 baudclk
= ((MCF_BUSCLK
/ baud
) + 16) / 32;
228 mr1
= MCFUART_MR1_RXIRQRDY
| MCFUART_MR1_RXERRCHAR
;
231 switch (termios
->c_cflag
& CSIZE
) {
232 case CS5
: mr1
|= MCFUART_MR1_CS5
; break;
233 case CS6
: mr1
|= MCFUART_MR1_CS6
; break;
234 case CS7
: mr1
|= MCFUART_MR1_CS7
; break;
236 default: mr1
|= MCFUART_MR1_CS8
; break;
239 if (termios
->c_cflag
& PARENB
) {
240 if (termios
->c_cflag
& CMSPAR
) {
241 if (termios
->c_cflag
& PARODD
)
242 mr1
|= MCFUART_MR1_PARITYMARK
;
244 mr1
|= MCFUART_MR1_PARITYSPACE
;
246 if (termios
->c_cflag
& PARODD
)
247 mr1
|= MCFUART_MR1_PARITYODD
;
249 mr1
|= MCFUART_MR1_PARITYEVEN
;
252 mr1
|= MCFUART_MR1_PARITYNONE
;
255 if (termios
->c_cflag
& CSTOPB
)
256 mr2
|= MCFUART_MR2_STOP2
;
258 mr2
|= MCFUART_MR2_STOP1
;
260 if (termios
->c_cflag
& CRTSCTS
) {
261 mr1
|= MCFUART_MR1_RXRTS
;
262 mr2
|= MCFUART_MR2_TXCTS
;
265 spin_lock_irqsave(&port
->lock
, flags
);
266 uart_update_timeout(port
, termios
->c_cflag
, baud
);
267 writeb(MCFUART_UCR_CMDRESETRX
, port
->membase
+ MCFUART_UCR
);
268 writeb(MCFUART_UCR_CMDRESETTX
, port
->membase
+ MCFUART_UCR
);
269 writeb(MCFUART_UCR_CMDRESETMRPTR
, port
->membase
+ MCFUART_UCR
);
270 writeb(mr1
, port
->membase
+ MCFUART_UMR
);
271 writeb(mr2
, port
->membase
+ MCFUART_UMR
);
272 writeb((baudclk
& 0xff00) >> 8, port
->membase
+ MCFUART_UBG1
);
273 writeb((baudclk
& 0xff), port
->membase
+ MCFUART_UBG2
);
274 #if defined(CONFIG_M5272)
275 writeb((baudfr
& 0x0f), port
->membase
+ MCFUART_UFPD
);
277 writeb(MCFUART_UCSR_RXCLKTIMER
| MCFUART_UCSR_TXCLKTIMER
,
278 port
->membase
+ MCFUART_UCSR
);
279 writeb(MCFUART_UCR_RXENABLE
| MCFUART_UCR_TXENABLE
,
280 port
->membase
+ MCFUART_UCR
);
281 spin_unlock_irqrestore(&port
->lock
, flags
);
284 /****************************************************************************/
286 static void mcf_rx_chars(struct mcf_uart
*pp
)
288 struct uart_port
*port
= &pp
->port
;
289 unsigned char status
, ch
, flag
;
291 while ((status
= readb(port
->membase
+ MCFUART_USR
)) & MCFUART_USR_RXREADY
) {
292 ch
= readb(port
->membase
+ MCFUART_URB
);
296 if (status
& MCFUART_USR_RXERR
) {
297 writeb(MCFUART_UCR_CMDRESETERR
,
298 port
->membase
+ MCFUART_UCR
);
300 if (status
& MCFUART_USR_RXBREAK
) {
302 if (uart_handle_break(port
))
304 } else if (status
& MCFUART_USR_RXPARITY
) {
305 port
->icount
.parity
++;
306 } else if (status
& MCFUART_USR_RXOVERRUN
) {
307 port
->icount
.overrun
++;
308 } else if (status
& MCFUART_USR_RXFRAMING
) {
309 port
->icount
.frame
++;
312 status
&= port
->read_status_mask
;
314 if (status
& MCFUART_USR_RXBREAK
)
316 else if (status
& MCFUART_USR_RXPARITY
)
318 else if (status
& MCFUART_USR_RXFRAMING
)
322 if (uart_handle_sysrq_char(port
, ch
))
324 uart_insert_char(port
, status
, MCFUART_USR_RXOVERRUN
, ch
, flag
);
327 tty_flip_buffer_push(port
->state
->port
.tty
);
330 /****************************************************************************/
332 static void mcf_tx_chars(struct mcf_uart
*pp
)
334 struct uart_port
*port
= &pp
->port
;
335 struct circ_buf
*xmit
= &port
->state
->xmit
;
338 /* Send special char - probably flow control */
339 writeb(port
->x_char
, port
->membase
+ MCFUART_UTB
);
345 while (readb(port
->membase
+ MCFUART_USR
) & MCFUART_USR_TXREADY
) {
346 if (xmit
->head
== xmit
->tail
)
348 writeb(xmit
->buf
[xmit
->tail
], port
->membase
+ MCFUART_UTB
);
349 xmit
->tail
= (xmit
->tail
+ 1) & (UART_XMIT_SIZE
-1);
353 if (uart_circ_chars_pending(xmit
) < WAKEUP_CHARS
)
354 uart_write_wakeup(port
);
356 if (xmit
->head
== xmit
->tail
) {
357 pp
->imr
&= ~MCFUART_UIR_TXREADY
;
358 writeb(pp
->imr
, port
->membase
+ MCFUART_UIMR
);
362 /****************************************************************************/
364 static irqreturn_t
mcf_interrupt(int irq
, void *data
)
366 struct uart_port
*port
= data
;
367 struct mcf_uart
*pp
= container_of(port
, struct mcf_uart
, port
);
370 isr
= readb(port
->membase
+ MCFUART_UISR
) & pp
->imr
;
371 if (isr
& MCFUART_UIR_RXREADY
)
373 if (isr
& MCFUART_UIR_TXREADY
)
378 /****************************************************************************/
380 static void mcf_config_port(struct uart_port
*port
, int flags
)
382 port
->type
= PORT_MCF
;
383 port
->fifosize
= MCFUART_TXFIFOSIZE
;
385 /* Clear mask, so no surprise interrupts. */
386 writeb(0, port
->membase
+ MCFUART_UIMR
);
388 if (request_irq(port
->irq
, mcf_interrupt
, IRQF_DISABLED
, "UART", port
))
389 printk(KERN_ERR
"MCF: unable to attach ColdFire UART %d "
390 "interrupt vector=%d\n", port
->line
, port
->irq
);
393 /****************************************************************************/
395 static const char *mcf_type(struct uart_port
*port
)
397 return (port
->type
== PORT_MCF
) ? "ColdFire UART" : NULL
;
400 /****************************************************************************/
402 static int mcf_request_port(struct uart_port
*port
)
404 /* UARTs always present */
408 /****************************************************************************/
410 static void mcf_release_port(struct uart_port
*port
)
412 /* Nothing to release... */
415 /****************************************************************************/
417 static int mcf_verify_port(struct uart_port
*port
, struct serial_struct
*ser
)
419 if ((ser
->type
!= PORT_UNKNOWN
) && (ser
->type
!= PORT_MCF
))
424 /****************************************************************************/
427 * Define the basic serial functions we support.
429 static const struct uart_ops mcf_uart_ops
= {
430 .tx_empty
= mcf_tx_empty
,
431 .get_mctrl
= mcf_get_mctrl
,
432 .set_mctrl
= mcf_set_mctrl
,
433 .start_tx
= mcf_start_tx
,
434 .stop_tx
= mcf_stop_tx
,
435 .stop_rx
= mcf_stop_rx
,
436 .enable_ms
= mcf_enable_ms
,
437 .break_ctl
= mcf_break_ctl
,
438 .startup
= mcf_startup
,
439 .shutdown
= mcf_shutdown
,
440 .set_termios
= mcf_set_termios
,
442 .request_port
= mcf_request_port
,
443 .release_port
= mcf_release_port
,
444 .config_port
= mcf_config_port
,
445 .verify_port
= mcf_verify_port
,
448 static struct mcf_uart mcf_ports
[4];
450 #define MCF_MAXPORTS ARRAY_SIZE(mcf_ports)
452 /****************************************************************************/
453 #if defined(CONFIG_SERIAL_MCF_CONSOLE)
454 /****************************************************************************/
456 int __init
early_mcf_setup(struct mcf_platform_uart
*platp
)
458 struct uart_port
*port
;
461 for (i
= 0; ((i
< MCF_MAXPORTS
) && (platp
[i
].mapbase
)); i
++) {
462 port
= &mcf_ports
[i
].port
;
465 port
->type
= PORT_MCF
;
466 port
->mapbase
= platp
[i
].mapbase
;
467 port
->membase
= (platp
[i
].membase
) ? platp
[i
].membase
:
468 (unsigned char __iomem
*) port
->mapbase
;
469 port
->iotype
= SERIAL_IO_MEM
;
470 port
->irq
= platp
[i
].irq
;
471 port
->uartclk
= MCF_BUSCLK
;
472 port
->flags
= ASYNC_BOOT_AUTOCONF
;
473 port
->ops
= &mcf_uart_ops
;
479 /****************************************************************************/
481 static void mcf_console_putc(struct console
*co
, const char c
)
483 struct uart_port
*port
= &(mcf_ports
+ co
->index
)->port
;
486 for (i
= 0; (i
< 0x10000); i
++) {
487 if (readb(port
->membase
+ MCFUART_USR
) & MCFUART_USR_TXREADY
)
490 writeb(c
, port
->membase
+ MCFUART_UTB
);
491 for (i
= 0; (i
< 0x10000); i
++) {
492 if (readb(port
->membase
+ MCFUART_USR
) & MCFUART_USR_TXREADY
)
497 /****************************************************************************/
499 static void mcf_console_write(struct console
*co
, const char *s
, unsigned int count
)
501 for (; (count
); count
--, s
++) {
502 mcf_console_putc(co
, *s
);
504 mcf_console_putc(co
, '\r');
508 /****************************************************************************/
510 static int __init
mcf_console_setup(struct console
*co
, char *options
)
512 struct uart_port
*port
;
513 int baud
= CONFIG_SERIAL_MCF_BAUDRATE
;
518 if ((co
->index
< 0) || (co
->index
>= MCF_MAXPORTS
))
520 port
= &mcf_ports
[co
->index
].port
;
521 if (port
->membase
== 0)
525 uart_parse_options(options
, &baud
, &parity
, &bits
, &flow
);
527 return uart_set_options(port
, co
, baud
, parity
, bits
, flow
);
530 /****************************************************************************/
532 static struct uart_driver mcf_driver
;
534 static struct console mcf_console
= {
536 .write
= mcf_console_write
,
537 .device
= uart_console_device
,
538 .setup
= mcf_console_setup
,
539 .flags
= CON_PRINTBUFFER
,
544 static int __init
mcf_console_init(void)
546 register_console(&mcf_console
);
550 console_initcall(mcf_console_init
);
552 #define MCF_CONSOLE &mcf_console
554 /****************************************************************************/
556 /****************************************************************************/
558 #define MCF_CONSOLE NULL
560 /****************************************************************************/
561 #endif /* CONFIG_MCF_CONSOLE */
562 /****************************************************************************/
565 * Define the mcf UART driver structure.
567 static struct uart_driver mcf_driver
= {
568 .owner
= THIS_MODULE
,
569 .driver_name
= "mcf",
577 /****************************************************************************/
579 static int __devinit
mcf_probe(struct platform_device
*pdev
)
581 struct mcf_platform_uart
*platp
= pdev
->dev
.platform_data
;
582 struct uart_port
*port
;
585 for (i
= 0; ((i
< MCF_MAXPORTS
) && (platp
[i
].mapbase
)); i
++) {
586 port
= &mcf_ports
[i
].port
;
589 port
->type
= PORT_MCF
;
590 port
->mapbase
= platp
[i
].mapbase
;
591 port
->membase
= (platp
[i
].membase
) ? platp
[i
].membase
:
592 (unsigned char __iomem
*) platp
[i
].mapbase
;
593 port
->iotype
= SERIAL_IO_MEM
;
594 port
->irq
= platp
[i
].irq
;
595 port
->uartclk
= MCF_BUSCLK
;
596 port
->ops
= &mcf_uart_ops
;
597 port
->flags
= ASYNC_BOOT_AUTOCONF
;
599 uart_add_one_port(&mcf_driver
, port
);
605 /****************************************************************************/
607 static int __devexit
mcf_remove(struct platform_device
*pdev
)
609 struct uart_port
*port
;
612 for (i
= 0; (i
< MCF_MAXPORTS
); i
++) {
613 port
= &mcf_ports
[i
].port
;
615 uart_remove_one_port(&mcf_driver
, port
);
621 /****************************************************************************/
623 static struct platform_driver mcf_platform_driver
= {
625 .remove
= __devexit_p(mcf_remove
),
628 .owner
= THIS_MODULE
,
632 /****************************************************************************/
634 static int __init
mcf_init(void)
638 printk("ColdFire internal UART serial driver\n");
640 rc
= uart_register_driver(&mcf_driver
);
643 rc
= platform_driver_register(&mcf_platform_driver
);
649 /****************************************************************************/
651 static void __exit
mcf_exit(void)
653 platform_driver_unregister(&mcf_platform_driver
);
654 uart_unregister_driver(&mcf_driver
);
657 /****************************************************************************/
659 module_init(mcf_init
);
660 module_exit(mcf_exit
);
662 MODULE_AUTHOR("Greg Ungerer <gerg@snapgear.com>");
663 MODULE_DESCRIPTION("Freescale ColdFire UART driver");
664 MODULE_LICENSE("GPL");
665 MODULE_ALIAS("platform:mcfuart");
667 /****************************************************************************/