2 * linux/drivers/char/atmel_serial.c
4 * Driver for Atmel AT91 / AT32 Serial ports
5 * Copyright (C) 2003 Rick Bronson
7 * Based on drivers/char/serial_sa1100.c, by Deep Blue Solutions Ltd.
8 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
10 * DMA support added by Chip Coldwell.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <linux/module.h>
28 #include <linux/tty.h>
29 #include <linux/ioport.h>
30 #include <linux/slab.h>
31 #include <linux/init.h>
32 #include <linux/serial.h>
33 #include <linux/clk.h>
34 #include <linux/console.h>
35 #include <linux/sysrq.h>
36 #include <linux/tty_flip.h>
37 #include <linux/platform_device.h>
38 #include <linux/dma-mapping.h>
39 #include <linux/atmel_pdc.h>
40 #include <linux/atmel_serial.h>
44 #include <asm/mach/serial_at91.h>
45 #include <asm/arch/board.h>
48 #include <asm/arch/cpu.h>
49 #include <asm/arch/gpio.h>
52 #define PDC_BUFFER_SIZE 512
53 /* Revisit: We should calculate this based on the actual port settings */
54 #define PDC_RX_TIMEOUT (3 * 10) /* 3 bytes */
56 #if defined(CONFIG_SERIAL_ATMEL_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
60 #include <linux/serial_core.h>
62 #ifdef CONFIG_SERIAL_ATMEL_TTYAT
64 /* Use device name ttyAT, major 204 and minor 154-169. This is necessary if we
65 * should coexist with the 8250 driver, such as if we have an external 16C550
67 #define SERIAL_ATMEL_MAJOR 204
68 #define MINOR_START 154
69 #define ATMEL_DEVICENAME "ttyAT"
73 /* Use device name ttyS, major 4, minor 64-68. This is the usual serial port
74 * name, but it is legally reserved for the 8250 driver. */
75 #define SERIAL_ATMEL_MAJOR TTY_MAJOR
76 #define MINOR_START 64
77 #define ATMEL_DEVICENAME "ttyS"
81 #define ATMEL_ISR_PASS_LIMIT 256
83 /* UART registers. CR is write-only, hence no GET macro */
84 #define UART_PUT_CR(port,v) __raw_writel(v, (port)->membase + ATMEL_US_CR)
85 #define UART_GET_MR(port) __raw_readl((port)->membase + ATMEL_US_MR)
86 #define UART_PUT_MR(port,v) __raw_writel(v, (port)->membase + ATMEL_US_MR)
87 #define UART_PUT_IER(port,v) __raw_writel(v, (port)->membase + ATMEL_US_IER)
88 #define UART_PUT_IDR(port,v) __raw_writel(v, (port)->membase + ATMEL_US_IDR)
89 #define UART_GET_IMR(port) __raw_readl((port)->membase + ATMEL_US_IMR)
90 #define UART_GET_CSR(port) __raw_readl((port)->membase + ATMEL_US_CSR)
91 #define UART_GET_CHAR(port) __raw_readl((port)->membase + ATMEL_US_RHR)
92 #define UART_PUT_CHAR(port,v) __raw_writel(v, (port)->membase + ATMEL_US_THR)
93 #define UART_GET_BRGR(port) __raw_readl((port)->membase + ATMEL_US_BRGR)
94 #define UART_PUT_BRGR(port,v) __raw_writel(v, (port)->membase + ATMEL_US_BRGR)
95 #define UART_PUT_RTOR(port,v) __raw_writel(v, (port)->membase + ATMEL_US_RTOR)
98 #define UART_PUT_PTCR(port,v) __raw_writel(v, (port)->membase + ATMEL_PDC_PTCR)
99 #define UART_GET_PTSR(port) __raw_readl((port)->membase + ATMEL_PDC_PTSR)
101 #define UART_PUT_RPR(port,v) __raw_writel(v, (port)->membase + ATMEL_PDC_RPR)
102 #define UART_GET_RPR(port) __raw_readl((port)->membase + ATMEL_PDC_RPR)
103 #define UART_PUT_RCR(port,v) __raw_writel(v, (port)->membase + ATMEL_PDC_RCR)
104 #define UART_PUT_RNPR(port,v) __raw_writel(v, (port)->membase + ATMEL_PDC_RNPR)
105 #define UART_PUT_RNCR(port,v) __raw_writel(v, (port)->membase + ATMEL_PDC_RNCR)
107 #define UART_PUT_TPR(port,v) __raw_writel(v, (port)->membase + ATMEL_PDC_TPR)
108 #define UART_PUT_TCR(port,v) __raw_writel(v, (port)->membase + ATMEL_PDC_TCR)
109 #define UART_GET_TCR(port) __raw_readl((port)->membase + ATMEL_PDC_TCR)
111 static int (*atmel_open_hook)(struct uart_port *);
112 static void (*atmel_close_hook)(struct uart_port *);
114 struct atmel_dma_buffer {
117 unsigned int dma_size;
121 struct atmel_uart_char {
126 #define ATMEL_SERIAL_RINGSIZE 1024
129 * We wrap our port structure around the generic uart_port.
131 struct atmel_uart_port {
132 struct uart_port uart; /* uart */
133 struct clk *clk; /* uart clock */
134 unsigned short suspended; /* is port suspended? */
135 int break_active; /* break being received */
137 short use_dma_rx; /* enable PDC receiver */
138 short pdc_rx_idx; /* current PDC RX buffer */
139 struct atmel_dma_buffer pdc_rx[2]; /* PDC receier */
141 short use_dma_tx; /* enable PDC transmitter */
142 struct atmel_dma_buffer pdc_tx; /* PDC transmitter */
144 struct tasklet_struct tasklet;
145 unsigned int irq_status;
146 unsigned int irq_status_prev;
148 struct circ_buf rx_ring;
151 static struct atmel_uart_port atmel_ports[ATMEL_MAX_UART];
154 static struct console atmel_console;
157 static inline struct atmel_uart_port *
158 to_atmel_uart_port(struct uart_port *uart)
160 return container_of(uart, struct atmel_uart_port, uart);
163 #ifdef CONFIG_SERIAL_ATMEL_PDC
164 static bool atmel_use_dma_rx(struct uart_port *port)
166 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
168 return atmel_port->use_dma_rx;
171 static bool atmel_use_dma_tx(struct uart_port *port)
173 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
175 return atmel_port->use_dma_tx;
178 static bool atmel_use_dma_rx(struct uart_port *port)
183 static bool atmel_use_dma_tx(struct uart_port *port)
190 * Return TIOCSER_TEMT when transmitter FIFO and Shift register is empty.
192 static u_int atmel_tx_empty(struct uart_port *port)
194 return (UART_GET_CSR(port) & ATMEL_US_TXEMPTY) ? TIOCSER_TEMT : 0;
198 * Set state of the modem control output lines
200 static void atmel_set_mctrl(struct uart_port *port, u_int mctrl)
202 unsigned int control = 0;
205 #ifdef CONFIG_ARCH_AT91RM9200
206 if (cpu_is_at91rm9200()) {
208 * AT91RM9200 Errata #39: RTS0 is not internally connected
209 * to PA21. We need to drive the pin manually.
211 if (port->mapbase == AT91RM9200_BASE_US0) {
212 if (mctrl & TIOCM_RTS)
213 at91_set_gpio_value(AT91_PIN_PA21, 0);
215 at91_set_gpio_value(AT91_PIN_PA21, 1);
220 if (mctrl & TIOCM_RTS)
221 control |= ATMEL_US_RTSEN;
223 control |= ATMEL_US_RTSDIS;
225 if (mctrl & TIOCM_DTR)
226 control |= ATMEL_US_DTREN;
228 control |= ATMEL_US_DTRDIS;
230 UART_PUT_CR(port, control);
232 /* Local loopback mode? */
233 mode = UART_GET_MR(port) & ~ATMEL_US_CHMODE;
234 if (mctrl & TIOCM_LOOP)
235 mode |= ATMEL_US_CHMODE_LOC_LOOP;
237 mode |= ATMEL_US_CHMODE_NORMAL;
238 UART_PUT_MR(port, mode);
242 * Get state of the modem control input lines
244 static u_int atmel_get_mctrl(struct uart_port *port)
246 unsigned int status, ret = 0;
248 status = UART_GET_CSR(port);
251 * The control signals are active low.
253 if (!(status & ATMEL_US_DCD))
255 if (!(status & ATMEL_US_CTS))
257 if (!(status & ATMEL_US_DSR))
259 if (!(status & ATMEL_US_RI))
268 static void atmel_stop_tx(struct uart_port *port)
270 if (atmel_use_dma_tx(port)) {
271 /* disable PDC transmit */
272 UART_PUT_PTCR(port, ATMEL_PDC_TXTDIS);
273 UART_PUT_IDR(port, ATMEL_US_ENDTX | ATMEL_US_TXBUFE);
275 UART_PUT_IDR(port, ATMEL_US_TXRDY);
279 * Start transmitting.
281 static void atmel_start_tx(struct uart_port *port)
283 if (atmel_use_dma_tx(port)) {
284 if (UART_GET_PTSR(port) & ATMEL_PDC_TXTEN)
285 /* The transmitter is already running. Yes, we
289 UART_PUT_IER(port, ATMEL_US_ENDTX | ATMEL_US_TXBUFE);
290 /* re-enable PDC transmit */
291 UART_PUT_PTCR(port, ATMEL_PDC_TXTEN);
293 UART_PUT_IER(port, ATMEL_US_TXRDY);
297 * Stop receiving - port is in process of being closed.
299 static void atmel_stop_rx(struct uart_port *port)
301 if (atmel_use_dma_rx(port)) {
302 /* disable PDC receive */
303 UART_PUT_PTCR(port, ATMEL_PDC_RXTDIS);
304 UART_PUT_IDR(port, ATMEL_US_ENDRX | ATMEL_US_TIMEOUT);
306 UART_PUT_IDR(port, ATMEL_US_RXRDY);
310 * Enable modem status interrupts
312 static void atmel_enable_ms(struct uart_port *port)
314 UART_PUT_IER(port, ATMEL_US_RIIC | ATMEL_US_DSRIC
315 | ATMEL_US_DCDIC | ATMEL_US_CTSIC);
319 * Control the transmission of a break signal
321 static void atmel_break_ctl(struct uart_port *port, int break_state)
323 if (break_state != 0)
324 UART_PUT_CR(port, ATMEL_US_STTBRK); /* start break */
326 UART_PUT_CR(port, ATMEL_US_STPBRK); /* stop break */
330 * Stores the incoming character in the ring buffer
333 atmel_buffer_rx_char(struct uart_port *port, unsigned int status,
336 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
337 struct circ_buf *ring = &atmel_port->rx_ring;
338 struct atmel_uart_char *c;
340 if (!CIRC_SPACE(ring->head, ring->tail, ATMEL_SERIAL_RINGSIZE))
341 /* Buffer overflow, ignore char */
344 c = &((struct atmel_uart_char *)ring->buf)[ring->head];
348 /* Make sure the character is stored before we update head. */
351 ring->head = (ring->head + 1) & (ATMEL_SERIAL_RINGSIZE - 1);
355 * Deal with parity, framing and overrun errors.
357 static void atmel_pdc_rxerr(struct uart_port *port, unsigned int status)
360 UART_PUT_CR(port, ATMEL_US_RSTSTA);
362 if (status & ATMEL_US_RXBRK) {
363 /* ignore side-effect */
364 status &= ~(ATMEL_US_PARE | ATMEL_US_FRAME);
367 if (status & ATMEL_US_PARE)
368 port->icount.parity++;
369 if (status & ATMEL_US_FRAME)
370 port->icount.frame++;
371 if (status & ATMEL_US_OVRE)
372 port->icount.overrun++;
376 * Characters received (called from interrupt handler)
378 static void atmel_rx_chars(struct uart_port *port)
380 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
381 unsigned int status, ch;
383 status = UART_GET_CSR(port);
384 while (status & ATMEL_US_RXRDY) {
385 ch = UART_GET_CHAR(port);
388 * note that the error handling code is
389 * out of the main execution path
391 if (unlikely(status & (ATMEL_US_PARE | ATMEL_US_FRAME
392 | ATMEL_US_OVRE | ATMEL_US_RXBRK)
393 || atmel_port->break_active)) {
396 UART_PUT_CR(port, ATMEL_US_RSTSTA);
398 if (status & ATMEL_US_RXBRK
399 && !atmel_port->break_active) {
400 atmel_port->break_active = 1;
401 UART_PUT_IER(port, ATMEL_US_RXBRK);
404 * This is either the end-of-break
405 * condition or we've received at
406 * least one character without RXBRK
407 * being set. In both cases, the next
408 * RXBRK will indicate start-of-break.
410 UART_PUT_IDR(port, ATMEL_US_RXBRK);
411 status &= ~ATMEL_US_RXBRK;
412 atmel_port->break_active = 0;
416 atmel_buffer_rx_char(port, status, ch);
417 status = UART_GET_CSR(port);
420 tasklet_schedule(&atmel_port->tasklet);
424 * Transmit characters (called from tasklet with TXRDY interrupt
427 static void atmel_tx_chars(struct uart_port *port)
429 struct circ_buf *xmit = &port->info->xmit;
431 if (port->x_char && UART_GET_CSR(port) & ATMEL_US_TXRDY) {
432 UART_PUT_CHAR(port, port->x_char);
436 if (uart_circ_empty(xmit) || uart_tx_stopped(port))
439 while (UART_GET_CSR(port) & ATMEL_US_TXRDY) {
440 UART_PUT_CHAR(port, xmit->buf[xmit->tail]);
441 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
443 if (uart_circ_empty(xmit))
447 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
448 uart_write_wakeup(port);
450 if (!uart_circ_empty(xmit))
451 UART_PUT_IER(port, ATMEL_US_TXRDY);
455 * receive interrupt handler.
458 atmel_handle_receive(struct uart_port *port, unsigned int pending)
460 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
462 if (atmel_use_dma_rx(port)) {
464 * PDC receive. Just schedule the tasklet and let it
465 * figure out the details.
467 * TODO: We're not handling error flags correctly at
470 if (pending & (ATMEL_US_ENDRX | ATMEL_US_TIMEOUT)) {
471 UART_PUT_IDR(port, (ATMEL_US_ENDRX
472 | ATMEL_US_TIMEOUT));
473 tasklet_schedule(&atmel_port->tasklet);
476 if (pending & (ATMEL_US_RXBRK | ATMEL_US_OVRE |
477 ATMEL_US_FRAME | ATMEL_US_PARE))
478 atmel_pdc_rxerr(port, pending);
481 /* Interrupt receive */
482 if (pending & ATMEL_US_RXRDY)
483 atmel_rx_chars(port);
484 else if (pending & ATMEL_US_RXBRK) {
486 * End of break detected. If it came along with a
487 * character, atmel_rx_chars will handle it.
489 UART_PUT_CR(port, ATMEL_US_RSTSTA);
490 UART_PUT_IDR(port, ATMEL_US_RXBRK);
491 atmel_port->break_active = 0;
496 * transmit interrupt handler. (Transmit is IRQF_NODELAY safe)
499 atmel_handle_transmit(struct uart_port *port, unsigned int pending)
501 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
503 if (atmel_use_dma_tx(port)) {
505 if (pending & (ATMEL_US_ENDTX | ATMEL_US_TXBUFE)) {
506 UART_PUT_IDR(port, ATMEL_US_ENDTX | ATMEL_US_TXBUFE);
507 tasklet_schedule(&atmel_port->tasklet);
510 /* Interrupt transmit */
511 if (pending & ATMEL_US_TXRDY) {
512 UART_PUT_IDR(port, ATMEL_US_TXRDY);
513 tasklet_schedule(&atmel_port->tasklet);
519 * status flags interrupt handler.
522 atmel_handle_status(struct uart_port *port, unsigned int pending,
525 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
527 if (pending & (ATMEL_US_RIIC | ATMEL_US_DSRIC | ATMEL_US_DCDIC
529 atmel_port->irq_status = status;
530 tasklet_schedule(&atmel_port->tasklet);
537 static irqreturn_t atmel_interrupt(int irq, void *dev_id)
539 struct uart_port *port = dev_id;
540 unsigned int status, pending, pass_counter = 0;
543 status = UART_GET_CSR(port);
544 pending = status & UART_GET_IMR(port);
548 atmel_handle_receive(port, pending);
549 atmel_handle_status(port, pending, status);
550 atmel_handle_transmit(port, pending);
551 } while (pass_counter++ < ATMEL_ISR_PASS_LIMIT);
553 return pass_counter ? IRQ_HANDLED : IRQ_NONE;
557 * Called from tasklet with ENDTX and TXBUFE interrupts disabled.
559 static void atmel_tx_dma(struct uart_port *port)
561 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
562 struct circ_buf *xmit = &port->info->xmit;
563 struct atmel_dma_buffer *pdc = &atmel_port->pdc_tx;
566 /* nothing left to transmit? */
567 if (UART_GET_TCR(port))
570 xmit->tail += pdc->ofs;
571 xmit->tail &= UART_XMIT_SIZE - 1;
573 port->icount.tx += pdc->ofs;
576 /* more to transmit - setup next transfer */
578 /* disable PDC transmit */
579 UART_PUT_PTCR(port, ATMEL_PDC_TXTDIS);
581 if (!uart_circ_empty(xmit)) {
582 dma_sync_single_for_device(port->dev,
587 count = CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE);
590 UART_PUT_TPR(port, pdc->dma_addr + xmit->tail);
591 UART_PUT_TCR(port, count);
592 /* re-enable PDC transmit and interrupts */
593 UART_PUT_PTCR(port, ATMEL_PDC_TXTEN);
594 UART_PUT_IER(port, ATMEL_US_ENDTX | ATMEL_US_TXBUFE);
597 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
598 uart_write_wakeup(port);
601 static void atmel_rx_from_ring(struct uart_port *port)
603 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
604 struct circ_buf *ring = &atmel_port->rx_ring;
608 while (ring->head != ring->tail) {
609 struct atmel_uart_char c;
611 /* Make sure c is loaded after head. */
614 c = ((struct atmel_uart_char *)ring->buf)[ring->tail];
616 ring->tail = (ring->tail + 1) & (ATMEL_SERIAL_RINGSIZE - 1);
623 * note that the error handling code is
624 * out of the main execution path
626 if (unlikely(status & (ATMEL_US_PARE | ATMEL_US_FRAME
627 | ATMEL_US_OVRE | ATMEL_US_RXBRK))) {
628 if (status & ATMEL_US_RXBRK) {
629 /* ignore side-effect */
630 status &= ~(ATMEL_US_PARE | ATMEL_US_FRAME);
633 if (uart_handle_break(port))
636 if (status & ATMEL_US_PARE)
637 port->icount.parity++;
638 if (status & ATMEL_US_FRAME)
639 port->icount.frame++;
640 if (status & ATMEL_US_OVRE)
641 port->icount.overrun++;
643 status &= port->read_status_mask;
645 if (status & ATMEL_US_RXBRK)
647 else if (status & ATMEL_US_PARE)
649 else if (status & ATMEL_US_FRAME)
654 if (uart_handle_sysrq_char(port, c.ch))
657 uart_insert_char(port, status, ATMEL_US_OVRE, c.ch, flg);
661 * Drop the lock here since it might end up calling
662 * uart_start(), which takes the lock.
664 spin_unlock(&port->lock);
665 tty_flip_buffer_push(port->info->port.tty);
666 spin_lock(&port->lock);
669 static void atmel_rx_from_dma(struct uart_port *port)
671 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
672 struct tty_struct *tty = port->info->port.tty;
673 struct atmel_dma_buffer *pdc;
674 int rx_idx = atmel_port->pdc_rx_idx;
680 /* Reset the UART timeout early so that we don't miss one */
681 UART_PUT_CR(port, ATMEL_US_STTTO);
683 pdc = &atmel_port->pdc_rx[rx_idx];
684 head = UART_GET_RPR(port) - pdc->dma_addr;
687 /* If the PDC has switched buffers, RPR won't contain
688 * any address within the current buffer. Since head
689 * is unsigned, we just need a one-way comparison to
692 * In this case, we just need to consume the entire
693 * buffer and resubmit it for DMA. This will clear the
694 * ENDRX bit as well, so that we can safely re-enable
695 * all interrupts below.
697 head = min(head, pdc->dma_size);
699 if (likely(head != tail)) {
700 dma_sync_single_for_cpu(port->dev, pdc->dma_addr,
701 pdc->dma_size, DMA_FROM_DEVICE);
704 * head will only wrap around when we recycle
705 * the DMA buffer, and when that happens, we
706 * explicitly set tail to 0. So head will
707 * always be greater than tail.
711 tty_insert_flip_string(tty, pdc->buf + pdc->ofs, count);
713 dma_sync_single_for_device(port->dev, pdc->dma_addr,
714 pdc->dma_size, DMA_FROM_DEVICE);
716 port->icount.rx += count;
721 * If the current buffer is full, we need to check if
722 * the next one contains any additional data.
724 if (head >= pdc->dma_size) {
726 UART_PUT_RNPR(port, pdc->dma_addr);
727 UART_PUT_RNCR(port, pdc->dma_size);
730 atmel_port->pdc_rx_idx = rx_idx;
732 } while (head >= pdc->dma_size);
735 * Drop the lock here since it might end up calling
736 * uart_start(), which takes the lock.
738 spin_unlock(&port->lock);
739 tty_flip_buffer_push(tty);
740 spin_lock(&port->lock);
742 UART_PUT_IER(port, ATMEL_US_ENDRX | ATMEL_US_TIMEOUT);
746 * tasklet handling tty stuff outside the interrupt handler.
748 static void atmel_tasklet_func(unsigned long data)
750 struct uart_port *port = (struct uart_port *)data;
751 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
753 unsigned int status_change;
755 /* The interrupt handler does not take the lock */
756 spin_lock(&port->lock);
758 if (atmel_use_dma_tx(port))
761 atmel_tx_chars(port);
763 status = atmel_port->irq_status;
764 status_change = status ^ atmel_port->irq_status_prev;
766 if (status_change & (ATMEL_US_RI | ATMEL_US_DSR
767 | ATMEL_US_DCD | ATMEL_US_CTS)) {
768 /* TODO: All reads to CSR will clear these interrupts! */
769 if (status_change & ATMEL_US_RI)
771 if (status_change & ATMEL_US_DSR)
773 if (status_change & ATMEL_US_DCD)
774 uart_handle_dcd_change(port, !(status & ATMEL_US_DCD));
775 if (status_change & ATMEL_US_CTS)
776 uart_handle_cts_change(port, !(status & ATMEL_US_CTS));
778 wake_up_interruptible(&port->info->delta_msr_wait);
780 atmel_port->irq_status_prev = status;
783 if (atmel_use_dma_rx(port))
784 atmel_rx_from_dma(port);
786 atmel_rx_from_ring(port);
788 spin_unlock(&port->lock);
792 * Perform initialization and enable port for reception
794 static int atmel_startup(struct uart_port *port)
796 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
797 struct tty_struct *tty = port->info->port.tty;
801 * Ensure that no interrupts are enabled otherwise when
802 * request_irq() is called we could get stuck trying to
803 * handle an unexpected interrupt
805 UART_PUT_IDR(port, -1);
810 retval = request_irq(port->irq, atmel_interrupt, IRQF_SHARED,
811 tty ? tty->name : "atmel_serial", port);
813 printk("atmel_serial: atmel_startup - Can't get irq\n");
818 * Initialize DMA (if necessary)
820 if (atmel_use_dma_rx(port)) {
823 for (i = 0; i < 2; i++) {
824 struct atmel_dma_buffer *pdc = &atmel_port->pdc_rx[i];
826 pdc->buf = kmalloc(PDC_BUFFER_SIZE, GFP_KERNEL);
827 if (pdc->buf == NULL) {
829 dma_unmap_single(port->dev,
830 atmel_port->pdc_rx[0].dma_addr,
833 kfree(atmel_port->pdc_rx[0].buf);
835 free_irq(port->irq, port);
838 pdc->dma_addr = dma_map_single(port->dev,
842 pdc->dma_size = PDC_BUFFER_SIZE;
846 atmel_port->pdc_rx_idx = 0;
848 UART_PUT_RPR(port, atmel_port->pdc_rx[0].dma_addr);
849 UART_PUT_RCR(port, PDC_BUFFER_SIZE);
851 UART_PUT_RNPR(port, atmel_port->pdc_rx[1].dma_addr);
852 UART_PUT_RNCR(port, PDC_BUFFER_SIZE);
854 if (atmel_use_dma_tx(port)) {
855 struct atmel_dma_buffer *pdc = &atmel_port->pdc_tx;
856 struct circ_buf *xmit = &port->info->xmit;
858 pdc->buf = xmit->buf;
859 pdc->dma_addr = dma_map_single(port->dev,
863 pdc->dma_size = UART_XMIT_SIZE;
868 * If there is a specific "open" function (to register
869 * control line interrupts)
871 if (atmel_open_hook) {
872 retval = atmel_open_hook(port);
874 free_irq(port->irq, port);
880 * Finally, enable the serial port
882 UART_PUT_CR(port, ATMEL_US_RSTSTA | ATMEL_US_RSTRX);
883 /* enable xmit & rcvr */
884 UART_PUT_CR(port, ATMEL_US_TXEN | ATMEL_US_RXEN);
886 if (atmel_use_dma_rx(port)) {
887 /* set UART timeout */
888 UART_PUT_RTOR(port, PDC_RX_TIMEOUT);
889 UART_PUT_CR(port, ATMEL_US_STTTO);
891 UART_PUT_IER(port, ATMEL_US_ENDRX | ATMEL_US_TIMEOUT);
892 /* enable PDC controller */
893 UART_PUT_PTCR(port, ATMEL_PDC_RXTEN);
895 /* enable receive only */
896 UART_PUT_IER(port, ATMEL_US_RXRDY);
905 static void atmel_shutdown(struct uart_port *port)
907 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
909 * Ensure everything is stopped.
917 if (atmel_use_dma_rx(port)) {
920 for (i = 0; i < 2; i++) {
921 struct atmel_dma_buffer *pdc = &atmel_port->pdc_rx[i];
923 dma_unmap_single(port->dev,
930 if (atmel_use_dma_tx(port)) {
931 struct atmel_dma_buffer *pdc = &atmel_port->pdc_tx;
933 dma_unmap_single(port->dev,
940 * Disable all interrupts, port and break condition.
942 UART_PUT_CR(port, ATMEL_US_RSTSTA);
943 UART_PUT_IDR(port, -1);
948 free_irq(port->irq, port);
951 * If there is a specific "close" function (to unregister
952 * control line interrupts)
954 if (atmel_close_hook)
955 atmel_close_hook(port);
959 * Flush any TX data submitted for DMA. Called when the TX circular
962 static void atmel_flush_buffer(struct uart_port *port)
964 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
966 if (atmel_use_dma_tx(port)) {
967 UART_PUT_TCR(port, 0);
968 atmel_port->pdc_tx.ofs = 0;
973 * Power / Clock management.
975 static void atmel_serial_pm(struct uart_port *port, unsigned int state,
976 unsigned int oldstate)
978 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
983 * Enable the peripheral clock for this serial port.
984 * This is called on uart_open() or a resume event.
986 clk_enable(atmel_port->clk);
990 * Disable the peripheral clock for this serial port.
991 * This is called on uart_close() or a suspend event.
993 clk_disable(atmel_port->clk);
996 printk(KERN_ERR "atmel_serial: unknown pm %d\n", state);
1001 * Change the port parameters
1003 static void atmel_set_termios(struct uart_port *port, struct ktermios *termios,
1004 struct ktermios *old)
1006 unsigned long flags;
1007 unsigned int mode, imr, quot, baud;
1009 /* Get current mode register */
1010 mode = UART_GET_MR(port) & ~(ATMEL_US_USCLKS | ATMEL_US_CHRL
1011 | ATMEL_US_NBSTOP | ATMEL_US_PAR);
1013 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk / 16);
1014 quot = uart_get_divisor(port, baud);
1016 if (quot > 65535) { /* BRGR is 16-bit, so switch to slower clock */
1018 mode |= ATMEL_US_USCLKS_MCK_DIV8;
1022 switch (termios->c_cflag & CSIZE) {
1024 mode |= ATMEL_US_CHRL_5;
1027 mode |= ATMEL_US_CHRL_6;
1030 mode |= ATMEL_US_CHRL_7;
1033 mode |= ATMEL_US_CHRL_8;
1038 if (termios->c_cflag & CSTOPB)
1039 mode |= ATMEL_US_NBSTOP_2;
1042 if (termios->c_cflag & PARENB) {
1043 /* Mark or Space parity */
1044 if (termios->c_cflag & CMSPAR) {
1045 if (termios->c_cflag & PARODD)
1046 mode |= ATMEL_US_PAR_MARK;
1048 mode |= ATMEL_US_PAR_SPACE;
1049 } else if (termios->c_cflag & PARODD)
1050 mode |= ATMEL_US_PAR_ODD;
1052 mode |= ATMEL_US_PAR_EVEN;
1054 mode |= ATMEL_US_PAR_NONE;
1056 spin_lock_irqsave(&port->lock, flags);
1058 port->read_status_mask = ATMEL_US_OVRE;
1059 if (termios->c_iflag & INPCK)
1060 port->read_status_mask |= (ATMEL_US_FRAME | ATMEL_US_PARE);
1061 if (termios->c_iflag & (BRKINT | PARMRK))
1062 port->read_status_mask |= ATMEL_US_RXBRK;
1064 if (atmel_use_dma_rx(port))
1065 /* need to enable error interrupts */
1066 UART_PUT_IER(port, port->read_status_mask);
1069 * Characters to ignore
1071 port->ignore_status_mask = 0;
1072 if (termios->c_iflag & IGNPAR)
1073 port->ignore_status_mask |= (ATMEL_US_FRAME | ATMEL_US_PARE);
1074 if (termios->c_iflag & IGNBRK) {
1075 port->ignore_status_mask |= ATMEL_US_RXBRK;
1077 * If we're ignoring parity and break indicators,
1078 * ignore overruns too (for real raw support).
1080 if (termios->c_iflag & IGNPAR)
1081 port->ignore_status_mask |= ATMEL_US_OVRE;
1083 /* TODO: Ignore all characters if CREAD is set.*/
1085 /* update the per-port timeout */
1086 uart_update_timeout(port, termios->c_cflag, baud);
1088 /* save/disable interrupts and drain transmitter */
1089 imr = UART_GET_IMR(port);
1090 UART_PUT_IDR(port, -1);
1091 while (!(UART_GET_CSR(port) & ATMEL_US_TXEMPTY))
1094 /* disable receiver and transmitter */
1095 UART_PUT_CR(port, ATMEL_US_TXDIS | ATMEL_US_RXDIS);
1097 /* set the parity, stop bits and data size */
1098 UART_PUT_MR(port, mode);
1100 /* set the baud rate */
1101 UART_PUT_BRGR(port, quot);
1102 UART_PUT_CR(port, ATMEL_US_RSTSTA | ATMEL_US_RSTRX);
1103 UART_PUT_CR(port, ATMEL_US_TXEN | ATMEL_US_RXEN);
1105 /* restore interrupts */
1106 UART_PUT_IER(port, imr);
1108 /* CTS flow-control and modem-status interrupts */
1109 if (UART_ENABLE_MS(port, termios->c_cflag))
1110 port->ops->enable_ms(port);
1112 spin_unlock_irqrestore(&port->lock, flags);
1116 * Return string describing the specified port
1118 static const char *atmel_type(struct uart_port *port)
1120 return (port->type == PORT_ATMEL) ? "ATMEL_SERIAL" : NULL;
1124 * Release the memory region(s) being used by 'port'.
1126 static void atmel_release_port(struct uart_port *port)
1128 struct platform_device *pdev = to_platform_device(port->dev);
1129 int size = pdev->resource[0].end - pdev->resource[0].start + 1;
1131 release_mem_region(port->mapbase, size);
1133 if (port->flags & UPF_IOREMAP) {
1134 iounmap(port->membase);
1135 port->membase = NULL;
1140 * Request the memory region(s) being used by 'port'.
1142 static int atmel_request_port(struct uart_port *port)
1144 struct platform_device *pdev = to_platform_device(port->dev);
1145 int size = pdev->resource[0].end - pdev->resource[0].start + 1;
1147 if (!request_mem_region(port->mapbase, size, "atmel_serial"))
1150 if (port->flags & UPF_IOREMAP) {
1151 port->membase = ioremap(port->mapbase, size);
1152 if (port->membase == NULL) {
1153 release_mem_region(port->mapbase, size);
1162 * Configure/autoconfigure the port.
1164 static void atmel_config_port(struct uart_port *port, int flags)
1166 if (flags & UART_CONFIG_TYPE) {
1167 port->type = PORT_ATMEL;
1168 atmel_request_port(port);
1173 * Verify the new serial_struct (for TIOCSSERIAL).
1175 static int atmel_verify_port(struct uart_port *port, struct serial_struct *ser)
1178 if (ser->type != PORT_UNKNOWN && ser->type != PORT_ATMEL)
1180 if (port->irq != ser->irq)
1182 if (ser->io_type != SERIAL_IO_MEM)
1184 if (port->uartclk / 16 != ser->baud_base)
1186 if ((void *)port->mapbase != ser->iomem_base)
1188 if (port->iobase != ser->port)
1195 static struct uart_ops atmel_pops = {
1196 .tx_empty = atmel_tx_empty,
1197 .set_mctrl = atmel_set_mctrl,
1198 .get_mctrl = atmel_get_mctrl,
1199 .stop_tx = atmel_stop_tx,
1200 .start_tx = atmel_start_tx,
1201 .stop_rx = atmel_stop_rx,
1202 .enable_ms = atmel_enable_ms,
1203 .break_ctl = atmel_break_ctl,
1204 .startup = atmel_startup,
1205 .shutdown = atmel_shutdown,
1206 .flush_buffer = atmel_flush_buffer,
1207 .set_termios = atmel_set_termios,
1209 .release_port = atmel_release_port,
1210 .request_port = atmel_request_port,
1211 .config_port = atmel_config_port,
1212 .verify_port = atmel_verify_port,
1213 .pm = atmel_serial_pm,
1217 * Configure the port from the platform device resource info.
1219 static void __devinit atmel_init_port(struct atmel_uart_port *atmel_port,
1220 struct platform_device *pdev)
1222 struct uart_port *port = &atmel_port->uart;
1223 struct atmel_uart_data *data = pdev->dev.platform_data;
1225 port->iotype = UPIO_MEM;
1226 port->flags = UPF_BOOT_AUTOCONF;
1227 port->ops = &atmel_pops;
1229 port->line = pdev->id;
1230 port->dev = &pdev->dev;
1232 port->mapbase = pdev->resource[0].start;
1233 port->irq = pdev->resource[1].start;
1235 tasklet_init(&atmel_port->tasklet, atmel_tasklet_func,
1236 (unsigned long)port);
1238 memset(&atmel_port->rx_ring, 0, sizeof(atmel_port->rx_ring));
1241 /* Already mapped by setup code */
1242 port->membase = data->regs;
1244 port->flags |= UPF_IOREMAP;
1245 port->membase = NULL;
1248 /* for console, the clock could already be configured */
1249 if (!atmel_port->clk) {
1250 atmel_port->clk = clk_get(&pdev->dev, "usart");
1251 clk_enable(atmel_port->clk);
1252 port->uartclk = clk_get_rate(atmel_port->clk);
1255 atmel_port->use_dma_rx = data->use_dma_rx;
1256 atmel_port->use_dma_tx = data->use_dma_tx;
1257 if (atmel_use_dma_tx(port))
1258 port->fifosize = PDC_BUFFER_SIZE;
1262 * Register board-specific modem-control line handlers.
1264 void __init atmel_register_uart_fns(struct atmel_port_fns *fns)
1267 atmel_pops.enable_ms = fns->enable_ms;
1269 atmel_pops.get_mctrl = fns->get_mctrl;
1271 atmel_pops.set_mctrl = fns->set_mctrl;
1272 atmel_open_hook = fns->open;
1273 atmel_close_hook = fns->close;
1274 atmel_pops.pm = fns->pm;
1275 atmel_pops.set_wake = fns->set_wake;
1278 #ifdef CONFIG_SERIAL_ATMEL_CONSOLE
1279 static void atmel_console_putchar(struct uart_port *port, int ch)
1281 while (!(UART_GET_CSR(port) & ATMEL_US_TXRDY))
1283 UART_PUT_CHAR(port, ch);
1287 * Interrupts are disabled on entering
1289 static void atmel_console_write(struct console *co, const char *s, u_int count)
1291 struct uart_port *port = &atmel_ports[co->index].uart;
1292 unsigned int status, imr;
1293 unsigned int pdc_tx;
1296 * First, save IMR and then disable interrupts
1298 imr = UART_GET_IMR(port);
1299 UART_PUT_IDR(port, ATMEL_US_RXRDY | ATMEL_US_TXRDY);
1301 /* Store PDC transmit status and disable it */
1302 pdc_tx = UART_GET_PTSR(port) & ATMEL_PDC_TXTEN;
1303 UART_PUT_PTCR(port, ATMEL_PDC_TXTDIS);
1305 uart_console_write(port, s, count, atmel_console_putchar);
1308 * Finally, wait for transmitter to become empty
1312 status = UART_GET_CSR(port);
1313 } while (!(status & ATMEL_US_TXRDY));
1315 /* Restore PDC transmit status */
1317 UART_PUT_PTCR(port, ATMEL_PDC_TXTEN);
1319 /* set interrupts back the way they were */
1320 UART_PUT_IER(port, imr);
1324 * If the port was already initialised (eg, by a boot loader),
1325 * try to determine the current setup.
1327 static void __init atmel_console_get_options(struct uart_port *port, int *baud,
1328 int *parity, int *bits)
1330 unsigned int mr, quot;
1333 * If the baud rate generator isn't running, the port wasn't
1334 * initialized by the boot loader.
1336 quot = UART_GET_BRGR(port) & ATMEL_US_CD;
1340 mr = UART_GET_MR(port) & ATMEL_US_CHRL;
1341 if (mr == ATMEL_US_CHRL_8)
1346 mr = UART_GET_MR(port) & ATMEL_US_PAR;
1347 if (mr == ATMEL_US_PAR_EVEN)
1349 else if (mr == ATMEL_US_PAR_ODD)
1353 * The serial core only rounds down when matching this to a
1354 * supported baud rate. Make sure we don't end up slightly
1355 * lower than one of those, as it would make us fall through
1356 * to a much lower baud rate than we really want.
1358 *baud = port->uartclk / (16 * (quot - 1));
1361 static int __init atmel_console_setup(struct console *co, char *options)
1363 struct uart_port *port = &atmel_ports[co->index].uart;
1369 if (port->membase == NULL) {
1370 /* Port not initialized yet - delay setup */
1374 UART_PUT_IDR(port, -1);
1375 UART_PUT_CR(port, ATMEL_US_RSTSTA | ATMEL_US_RSTRX);
1376 UART_PUT_CR(port, ATMEL_US_TXEN | ATMEL_US_RXEN);
1379 uart_parse_options(options, &baud, &parity, &bits, &flow);
1381 atmel_console_get_options(port, &baud, &parity, &bits);
1383 return uart_set_options(port, co, baud, parity, bits, flow);
1386 static struct uart_driver atmel_uart;
1388 static struct console atmel_console = {
1389 .name = ATMEL_DEVICENAME,
1390 .write = atmel_console_write,
1391 .device = uart_console_device,
1392 .setup = atmel_console_setup,
1393 .flags = CON_PRINTBUFFER,
1395 .data = &atmel_uart,
1398 #define ATMEL_CONSOLE_DEVICE &atmel_console
1401 * Early console initialization (before VM subsystem initialized).
1403 static int __init atmel_console_init(void)
1405 if (atmel_default_console_device) {
1406 add_preferred_console(ATMEL_DEVICENAME,
1407 atmel_default_console_device->id, NULL);
1408 atmel_init_port(&atmel_ports[atmel_default_console_device->id],
1409 atmel_default_console_device);
1410 register_console(&atmel_console);
1416 console_initcall(atmel_console_init);
1419 * Late console initialization.
1421 static int __init atmel_late_console_init(void)
1423 if (atmel_default_console_device
1424 && !(atmel_console.flags & CON_ENABLED))
1425 register_console(&atmel_console);
1430 core_initcall(atmel_late_console_init);
1432 static inline bool atmel_is_console_port(struct uart_port *port)
1434 return port->cons && port->cons->index == port->line;
1438 #define ATMEL_CONSOLE_DEVICE NULL
1440 static inline bool atmel_is_console_port(struct uart_port *port)
1446 static struct uart_driver atmel_uart = {
1447 .owner = THIS_MODULE,
1448 .driver_name = "atmel_serial",
1449 .dev_name = ATMEL_DEVICENAME,
1450 .major = SERIAL_ATMEL_MAJOR,
1451 .minor = MINOR_START,
1452 .nr = ATMEL_MAX_UART,
1453 .cons = ATMEL_CONSOLE_DEVICE,
1457 static bool atmel_serial_clk_will_stop(void)
1459 #ifdef CONFIG_ARCH_AT91
1460 return at91_suspend_entering_slow_clock();
1466 static int atmel_serial_suspend(struct platform_device *pdev,
1469 struct uart_port *port = platform_get_drvdata(pdev);
1470 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
1472 if (atmel_is_console_port(port) && console_suspend_enabled) {
1473 /* Drain the TX shifter */
1474 while (!(UART_GET_CSR(port) & ATMEL_US_TXEMPTY))
1478 if (device_may_wakeup(&pdev->dev)
1479 && !atmel_serial_clk_will_stop())
1480 enable_irq_wake(port->irq);
1482 uart_suspend_port(&atmel_uart, port);
1483 atmel_port->suspended = 1;
1489 static int atmel_serial_resume(struct platform_device *pdev)
1491 struct uart_port *port = platform_get_drvdata(pdev);
1492 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
1494 if (atmel_port->suspended) {
1495 uart_resume_port(&atmel_uart, port);
1496 atmel_port->suspended = 0;
1498 disable_irq_wake(port->irq);
1503 #define atmel_serial_suspend NULL
1504 #define atmel_serial_resume NULL
1507 static int __devinit atmel_serial_probe(struct platform_device *pdev)
1509 struct atmel_uart_port *port;
1513 BUILD_BUG_ON(!is_power_of_2(ATMEL_SERIAL_RINGSIZE));
1515 port = &atmel_ports[pdev->id];
1516 atmel_init_port(port, pdev);
1518 if (!atmel_use_dma_rx(&port->uart)) {
1520 data = kmalloc(sizeof(struct atmel_uart_char)
1521 * ATMEL_SERIAL_RINGSIZE, GFP_KERNEL);
1523 goto err_alloc_ring;
1524 port->rx_ring.buf = data;
1527 ret = uart_add_one_port(&atmel_uart, &port->uart);
1531 device_init_wakeup(&pdev->dev, 1);
1532 platform_set_drvdata(pdev, port);
1537 kfree(port->rx_ring.buf);
1538 port->rx_ring.buf = NULL;
1540 if (!atmel_is_console_port(&port->uart)) {
1541 clk_disable(port->clk);
1549 static int __devexit atmel_serial_remove(struct platform_device *pdev)
1551 struct uart_port *port = platform_get_drvdata(pdev);
1552 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
1555 device_init_wakeup(&pdev->dev, 0);
1556 platform_set_drvdata(pdev, NULL);
1558 ret = uart_remove_one_port(&atmel_uart, port);
1560 tasklet_kill(&atmel_port->tasklet);
1561 kfree(atmel_port->rx_ring.buf);
1563 /* "port" is allocated statically, so we shouldn't free it */
1565 clk_disable(atmel_port->clk);
1566 clk_put(atmel_port->clk);
1571 static struct platform_driver atmel_serial_driver = {
1572 .probe = atmel_serial_probe,
1573 .remove = __devexit_p(atmel_serial_remove),
1574 .suspend = atmel_serial_suspend,
1575 .resume = atmel_serial_resume,
1577 .name = "atmel_usart",
1578 .owner = THIS_MODULE,
1582 static int __init atmel_serial_init(void)
1586 ret = uart_register_driver(&atmel_uart);
1590 ret = platform_driver_register(&atmel_serial_driver);
1592 uart_unregister_driver(&atmel_uart);
1597 static void __exit atmel_serial_exit(void)
1599 platform_driver_unregister(&atmel_serial_driver);
1600 uart_unregister_driver(&atmel_uart);
1603 module_init(atmel_serial_init);
1604 module_exit(atmel_serial_exit);
1606 MODULE_AUTHOR("Rick Bronson");
1607 MODULE_DESCRIPTION("Atmel AT91 / AT32 serial port driver");
1608 MODULE_LICENSE("GPL");
1609 MODULE_ALIAS("platform:atmel_usart");