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)
110 static int (*atmel_open_hook)(struct uart_port *);
111 static void (*atmel_close_hook)(struct uart_port *);
113 struct atmel_dma_buffer {
116 unsigned int dma_size;
120 struct atmel_uart_char {
125 #define ATMEL_SERIAL_RINGSIZE 1024
128 * We wrap our port structure around the generic uart_port.
130 struct atmel_uart_port {
131 struct uart_port uart; /* uart */
132 struct clk *clk; /* uart clock */
133 unsigned short suspended; /* is port suspended? */
134 int break_active; /* break being received */
136 short use_dma_rx; /* enable PDC receiver */
137 short pdc_rx_idx; /* current PDC RX buffer */
138 struct atmel_dma_buffer pdc_rx[2]; /* PDC receier */
140 short use_dma_tx; /* enable PDC transmitter */
141 struct atmel_dma_buffer pdc_tx; /* PDC transmitter */
143 struct tasklet_struct tasklet;
144 unsigned int irq_status;
145 unsigned int irq_status_prev;
147 struct circ_buf rx_ring;
150 static struct atmel_uart_port atmel_ports[ATMEL_MAX_UART];
153 static struct console atmel_console;
156 static inline struct atmel_uart_port *
157 to_atmel_uart_port(struct uart_port *uart)
159 return container_of(uart, struct atmel_uart_port, uart);
162 #ifdef CONFIG_SERIAL_ATMEL_PDC
163 static bool atmel_use_dma_rx(struct uart_port *port)
165 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
167 return atmel_port->use_dma_rx;
170 static bool atmel_use_dma_tx(struct uart_port *port)
172 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
174 return atmel_port->use_dma_tx;
177 static bool atmel_use_dma_rx(struct uart_port *port)
182 static bool atmel_use_dma_tx(struct uart_port *port)
189 * Return TIOCSER_TEMT when transmitter FIFO and Shift register is empty.
191 static u_int atmel_tx_empty(struct uart_port *port)
193 return (UART_GET_CSR(port) & ATMEL_US_TXEMPTY) ? TIOCSER_TEMT : 0;
197 * Set state of the modem control output lines
199 static void atmel_set_mctrl(struct uart_port *port, u_int mctrl)
201 unsigned int control = 0;
204 #ifdef CONFIG_ARCH_AT91RM9200
205 if (cpu_is_at91rm9200()) {
207 * AT91RM9200 Errata #39: RTS0 is not internally connected
208 * to PA21. We need to drive the pin manually.
210 if (port->mapbase == AT91RM9200_BASE_US0) {
211 if (mctrl & TIOCM_RTS)
212 at91_set_gpio_value(AT91_PIN_PA21, 0);
214 at91_set_gpio_value(AT91_PIN_PA21, 1);
219 if (mctrl & TIOCM_RTS)
220 control |= ATMEL_US_RTSEN;
222 control |= ATMEL_US_RTSDIS;
224 if (mctrl & TIOCM_DTR)
225 control |= ATMEL_US_DTREN;
227 control |= ATMEL_US_DTRDIS;
229 UART_PUT_CR(port, control);
231 /* Local loopback mode? */
232 mode = UART_GET_MR(port) & ~ATMEL_US_CHMODE;
233 if (mctrl & TIOCM_LOOP)
234 mode |= ATMEL_US_CHMODE_LOC_LOOP;
236 mode |= ATMEL_US_CHMODE_NORMAL;
237 UART_PUT_MR(port, mode);
241 * Get state of the modem control input lines
243 static u_int atmel_get_mctrl(struct uart_port *port)
245 unsigned int status, ret = 0;
247 status = UART_GET_CSR(port);
250 * The control signals are active low.
252 if (!(status & ATMEL_US_DCD))
254 if (!(status & ATMEL_US_CTS))
256 if (!(status & ATMEL_US_DSR))
258 if (!(status & ATMEL_US_RI))
267 static void atmel_stop_tx(struct uart_port *port)
269 if (atmel_use_dma_tx(port)) {
270 /* disable PDC transmit */
271 UART_PUT_PTCR(port, ATMEL_PDC_TXTDIS);
272 UART_PUT_IDR(port, ATMEL_US_ENDTX | ATMEL_US_TXBUFE);
274 UART_PUT_IDR(port, ATMEL_US_TXRDY);
278 * Start transmitting.
280 static void atmel_start_tx(struct uart_port *port)
282 if (atmel_use_dma_tx(port)) {
283 if (UART_GET_PTSR(port) & ATMEL_PDC_TXTEN)
284 /* The transmitter is already running. Yes, we
288 UART_PUT_IER(port, ATMEL_US_ENDTX | ATMEL_US_TXBUFE);
289 /* re-enable PDC transmit */
290 UART_PUT_PTCR(port, ATMEL_PDC_TXTEN);
292 UART_PUT_IER(port, ATMEL_US_TXRDY);
296 * Stop receiving - port is in process of being closed.
298 static void atmel_stop_rx(struct uart_port *port)
300 if (atmel_use_dma_rx(port)) {
301 /* disable PDC receive */
302 UART_PUT_PTCR(port, ATMEL_PDC_RXTDIS);
303 UART_PUT_IDR(port, ATMEL_US_ENDRX | ATMEL_US_TIMEOUT);
305 UART_PUT_IDR(port, ATMEL_US_RXRDY);
309 * Enable modem status interrupts
311 static void atmel_enable_ms(struct uart_port *port)
313 UART_PUT_IER(port, ATMEL_US_RIIC | ATMEL_US_DSRIC
314 | ATMEL_US_DCDIC | ATMEL_US_CTSIC);
318 * Control the transmission of a break signal
320 static void atmel_break_ctl(struct uart_port *port, int break_state)
322 if (break_state != 0)
323 UART_PUT_CR(port, ATMEL_US_STTBRK); /* start break */
325 UART_PUT_CR(port, ATMEL_US_STPBRK); /* stop break */
329 * Stores the incoming character in the ring buffer
332 atmel_buffer_rx_char(struct uart_port *port, unsigned int status,
335 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
336 struct circ_buf *ring = &atmel_port->rx_ring;
337 struct atmel_uart_char *c;
339 if (!CIRC_SPACE(ring->head, ring->tail, ATMEL_SERIAL_RINGSIZE))
340 /* Buffer overflow, ignore char */
343 c = &((struct atmel_uart_char *)ring->buf)[ring->head];
347 /* Make sure the character is stored before we update head. */
350 ring->head = (ring->head + 1) & (ATMEL_SERIAL_RINGSIZE - 1);
354 * Deal with parity, framing and overrun errors.
356 static void atmel_pdc_rxerr(struct uart_port *port, unsigned int status)
359 UART_PUT_CR(port, ATMEL_US_RSTSTA);
361 if (status & ATMEL_US_RXBRK) {
362 /* ignore side-effect */
363 status &= ~(ATMEL_US_PARE | ATMEL_US_FRAME);
366 if (status & ATMEL_US_PARE)
367 port->icount.parity++;
368 if (status & ATMEL_US_FRAME)
369 port->icount.frame++;
370 if (status & ATMEL_US_OVRE)
371 port->icount.overrun++;
375 * Characters received (called from interrupt handler)
377 static void atmel_rx_chars(struct uart_port *port)
379 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
380 unsigned int status, ch;
382 status = UART_GET_CSR(port);
383 while (status & ATMEL_US_RXRDY) {
384 ch = UART_GET_CHAR(port);
387 * note that the error handling code is
388 * out of the main execution path
390 if (unlikely(status & (ATMEL_US_PARE | ATMEL_US_FRAME
391 | ATMEL_US_OVRE | ATMEL_US_RXBRK)
392 || atmel_port->break_active)) {
395 UART_PUT_CR(port, ATMEL_US_RSTSTA);
397 if (status & ATMEL_US_RXBRK
398 && !atmel_port->break_active) {
399 atmel_port->break_active = 1;
400 UART_PUT_IER(port, ATMEL_US_RXBRK);
403 * This is either the end-of-break
404 * condition or we've received at
405 * least one character without RXBRK
406 * being set. In both cases, the next
407 * RXBRK will indicate start-of-break.
409 UART_PUT_IDR(port, ATMEL_US_RXBRK);
410 status &= ~ATMEL_US_RXBRK;
411 atmel_port->break_active = 0;
415 atmel_buffer_rx_char(port, status, ch);
416 status = UART_GET_CSR(port);
419 tasklet_schedule(&atmel_port->tasklet);
423 * Transmit characters (called from tasklet with TXRDY interrupt
426 static void atmel_tx_chars(struct uart_port *port)
428 struct circ_buf *xmit = &port->info->xmit;
430 if (port->x_char && UART_GET_CSR(port) & ATMEL_US_TXRDY) {
431 UART_PUT_CHAR(port, port->x_char);
435 if (uart_circ_empty(xmit) || uart_tx_stopped(port))
438 while (UART_GET_CSR(port) & ATMEL_US_TXRDY) {
439 UART_PUT_CHAR(port, xmit->buf[xmit->tail]);
440 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
442 if (uart_circ_empty(xmit))
446 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
447 uart_write_wakeup(port);
449 if (!uart_circ_empty(xmit))
450 UART_PUT_IER(port, ATMEL_US_TXRDY);
454 * receive interrupt handler.
457 atmel_handle_receive(struct uart_port *port, unsigned int pending)
459 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
461 if (atmel_use_dma_rx(port)) {
463 * PDC receive. Just schedule the tasklet and let it
464 * figure out the details.
466 * TODO: We're not handling error flags correctly at
469 if (pending & (ATMEL_US_ENDRX | ATMEL_US_TIMEOUT)) {
470 UART_PUT_IDR(port, (ATMEL_US_ENDRX
471 | ATMEL_US_TIMEOUT));
472 tasklet_schedule(&atmel_port->tasklet);
475 if (pending & (ATMEL_US_RXBRK | ATMEL_US_OVRE |
476 ATMEL_US_FRAME | ATMEL_US_PARE))
477 atmel_pdc_rxerr(port, pending);
480 /* Interrupt receive */
481 if (pending & ATMEL_US_RXRDY)
482 atmel_rx_chars(port);
483 else if (pending & ATMEL_US_RXBRK) {
485 * End of break detected. If it came along with a
486 * character, atmel_rx_chars will handle it.
488 UART_PUT_CR(port, ATMEL_US_RSTSTA);
489 UART_PUT_IDR(port, ATMEL_US_RXBRK);
490 atmel_port->break_active = 0;
495 * transmit interrupt handler. (Transmit is IRQF_NODELAY safe)
498 atmel_handle_transmit(struct uart_port *port, unsigned int pending)
500 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
502 if (atmel_use_dma_tx(port)) {
504 if (pending & (ATMEL_US_ENDTX | ATMEL_US_TXBUFE)) {
505 UART_PUT_IDR(port, ATMEL_US_ENDTX | ATMEL_US_TXBUFE);
506 tasklet_schedule(&atmel_port->tasklet);
509 /* Interrupt transmit */
510 if (pending & ATMEL_US_TXRDY) {
511 UART_PUT_IDR(port, ATMEL_US_TXRDY);
512 tasklet_schedule(&atmel_port->tasklet);
518 * status flags interrupt handler.
521 atmel_handle_status(struct uart_port *port, unsigned int pending,
524 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
526 if (pending & (ATMEL_US_RIIC | ATMEL_US_DSRIC | ATMEL_US_DCDIC
528 atmel_port->irq_status = status;
529 tasklet_schedule(&atmel_port->tasklet);
536 static irqreturn_t atmel_interrupt(int irq, void *dev_id)
538 struct uart_port *port = dev_id;
539 unsigned int status, pending, pass_counter = 0;
542 status = UART_GET_CSR(port);
543 pending = status & UART_GET_IMR(port);
547 atmel_handle_receive(port, pending);
548 atmel_handle_status(port, pending, status);
549 atmel_handle_transmit(port, pending);
550 } while (pass_counter++ < ATMEL_ISR_PASS_LIMIT);
556 * Called from tasklet with ENDTX and TXBUFE interrupts disabled.
558 static void atmel_tx_dma(struct uart_port *port)
560 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
561 struct circ_buf *xmit = &port->info->xmit;
562 struct atmel_dma_buffer *pdc = &atmel_port->pdc_tx;
565 xmit->tail += pdc->ofs;
566 xmit->tail &= UART_XMIT_SIZE - 1;
568 port->icount.tx += pdc->ofs;
571 if (!uart_circ_empty(xmit)) {
572 /* more to transmit - setup next transfer */
574 /* disable PDC transmit */
575 UART_PUT_PTCR(port, ATMEL_PDC_TXTDIS);
576 dma_sync_single_for_device(port->dev,
581 count = CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE);
584 UART_PUT_TPR(port, pdc->dma_addr + xmit->tail);
585 UART_PUT_TCR(port, count);
586 /* re-enable PDC transmit and interrupts */
587 UART_PUT_PTCR(port, ATMEL_PDC_TXTEN);
588 UART_PUT_IER(port, ATMEL_US_ENDTX | ATMEL_US_TXBUFE);
590 /* nothing left to transmit - disable the transmitter */
592 /* disable PDC transmit */
593 UART_PUT_PTCR(port, ATMEL_PDC_TXTDIS);
596 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
597 uart_write_wakeup(port);
600 static void atmel_rx_from_ring(struct uart_port *port)
602 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
603 struct circ_buf *ring = &atmel_port->rx_ring;
607 while (ring->head != ring->tail) {
608 struct atmel_uart_char c;
610 /* Make sure c is loaded after head. */
613 c = ((struct atmel_uart_char *)ring->buf)[ring->tail];
615 ring->tail = (ring->tail + 1) & (ATMEL_SERIAL_RINGSIZE - 1);
622 * note that the error handling code is
623 * out of the main execution path
625 if (unlikely(status & (ATMEL_US_PARE | ATMEL_US_FRAME
626 | ATMEL_US_OVRE | ATMEL_US_RXBRK))) {
627 if (status & ATMEL_US_RXBRK) {
628 /* ignore side-effect */
629 status &= ~(ATMEL_US_PARE | ATMEL_US_FRAME);
632 if (uart_handle_break(port))
635 if (status & ATMEL_US_PARE)
636 port->icount.parity++;
637 if (status & ATMEL_US_FRAME)
638 port->icount.frame++;
639 if (status & ATMEL_US_OVRE)
640 port->icount.overrun++;
642 status &= port->read_status_mask;
644 if (status & ATMEL_US_RXBRK)
646 else if (status & ATMEL_US_PARE)
648 else if (status & ATMEL_US_FRAME)
653 if (uart_handle_sysrq_char(port, c.ch))
656 uart_insert_char(port, status, ATMEL_US_OVRE, c.ch, flg);
660 * Drop the lock here since it might end up calling
661 * uart_start(), which takes the lock.
663 spin_unlock(&port->lock);
664 tty_flip_buffer_push(port->info->tty);
665 spin_lock(&port->lock);
668 static void atmel_rx_from_dma(struct uart_port *port)
670 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
671 struct tty_struct *tty = port->info->tty;
672 struct atmel_dma_buffer *pdc;
673 int rx_idx = atmel_port->pdc_rx_idx;
679 /* Reset the UART timeout early so that we don't miss one */
680 UART_PUT_CR(port, ATMEL_US_STTTO);
682 pdc = &atmel_port->pdc_rx[rx_idx];
683 head = UART_GET_RPR(port) - pdc->dma_addr;
686 /* If the PDC has switched buffers, RPR won't contain
687 * any address within the current buffer. Since head
688 * is unsigned, we just need a one-way comparison to
691 * In this case, we just need to consume the entire
692 * buffer and resubmit it for DMA. This will clear the
693 * ENDRX bit as well, so that we can safely re-enable
694 * all interrupts below.
696 head = min(head, pdc->dma_size);
698 if (likely(head != tail)) {
699 dma_sync_single_for_cpu(port->dev, pdc->dma_addr,
700 pdc->dma_size, DMA_FROM_DEVICE);
703 * head will only wrap around when we recycle
704 * the DMA buffer, and when that happens, we
705 * explicitly set tail to 0. So head will
706 * always be greater than tail.
710 tty_insert_flip_string(tty, pdc->buf + pdc->ofs, count);
712 dma_sync_single_for_device(port->dev, pdc->dma_addr,
713 pdc->dma_size, DMA_FROM_DEVICE);
715 port->icount.rx += count;
720 * If the current buffer is full, we need to check if
721 * the next one contains any additional data.
723 if (head >= pdc->dma_size) {
725 UART_PUT_RNPR(port, pdc->dma_addr);
726 UART_PUT_RNCR(port, pdc->dma_size);
729 atmel_port->pdc_rx_idx = rx_idx;
731 } while (head >= pdc->dma_size);
734 * Drop the lock here since it might end up calling
735 * uart_start(), which takes the lock.
737 spin_unlock(&port->lock);
738 tty_flip_buffer_push(tty);
739 spin_lock(&port->lock);
741 UART_PUT_IER(port, ATMEL_US_ENDRX | ATMEL_US_TIMEOUT);
745 * tasklet handling tty stuff outside the interrupt handler.
747 static void atmel_tasklet_func(unsigned long data)
749 struct uart_port *port = (struct uart_port *)data;
750 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
752 unsigned int status_change;
754 /* The interrupt handler does not take the lock */
755 spin_lock(&port->lock);
757 if (atmel_use_dma_tx(port))
760 atmel_tx_chars(port);
762 status = atmel_port->irq_status;
763 status_change = status ^ atmel_port->irq_status_prev;
765 if (status_change & (ATMEL_US_RI | ATMEL_US_DSR
766 | ATMEL_US_DCD | ATMEL_US_CTS)) {
767 /* TODO: All reads to CSR will clear these interrupts! */
768 if (status_change & ATMEL_US_RI)
770 if (status_change & ATMEL_US_DSR)
772 if (status_change & ATMEL_US_DCD)
773 uart_handle_dcd_change(port, !(status & ATMEL_US_DCD));
774 if (status_change & ATMEL_US_CTS)
775 uart_handle_cts_change(port, !(status & ATMEL_US_CTS));
777 wake_up_interruptible(&port->info->delta_msr_wait);
779 atmel_port->irq_status_prev = status;
782 if (atmel_use_dma_rx(port))
783 atmel_rx_from_dma(port);
785 atmel_rx_from_ring(port);
787 spin_unlock(&port->lock);
791 * Perform initialization and enable port for reception
793 static int atmel_startup(struct uart_port *port)
795 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
796 struct tty_struct *tty = port->info->tty;
800 * Ensure that no interrupts are enabled otherwise when
801 * request_irq() is called we could get stuck trying to
802 * handle an unexpected interrupt
804 UART_PUT_IDR(port, -1);
809 retval = request_irq(port->irq, atmel_interrupt, IRQF_SHARED,
810 tty ? tty->name : "atmel_serial", port);
812 printk("atmel_serial: atmel_startup - Can't get irq\n");
817 * Initialize DMA (if necessary)
819 if (atmel_use_dma_rx(port)) {
822 for (i = 0; i < 2; i++) {
823 struct atmel_dma_buffer *pdc = &atmel_port->pdc_rx[i];
825 pdc->buf = kmalloc(PDC_BUFFER_SIZE, GFP_KERNEL);
826 if (pdc->buf == NULL) {
828 dma_unmap_single(port->dev,
829 atmel_port->pdc_rx[0].dma_addr,
832 kfree(atmel_port->pdc_rx[0].buf);
834 free_irq(port->irq, port);
837 pdc->dma_addr = dma_map_single(port->dev,
841 pdc->dma_size = PDC_BUFFER_SIZE;
845 atmel_port->pdc_rx_idx = 0;
847 UART_PUT_RPR(port, atmel_port->pdc_rx[0].dma_addr);
848 UART_PUT_RCR(port, PDC_BUFFER_SIZE);
850 UART_PUT_RNPR(port, atmel_port->pdc_rx[1].dma_addr);
851 UART_PUT_RNCR(port, PDC_BUFFER_SIZE);
853 if (atmel_use_dma_tx(port)) {
854 struct atmel_dma_buffer *pdc = &atmel_port->pdc_tx;
855 struct circ_buf *xmit = &port->info->xmit;
857 pdc->buf = xmit->buf;
858 pdc->dma_addr = dma_map_single(port->dev,
862 pdc->dma_size = UART_XMIT_SIZE;
867 * If there is a specific "open" function (to register
868 * control line interrupts)
870 if (atmel_open_hook) {
871 retval = atmel_open_hook(port);
873 free_irq(port->irq, port);
879 * Finally, enable the serial port
881 UART_PUT_CR(port, ATMEL_US_RSTSTA | ATMEL_US_RSTRX);
882 /* enable xmit & rcvr */
883 UART_PUT_CR(port, ATMEL_US_TXEN | ATMEL_US_RXEN);
885 if (atmel_use_dma_rx(port)) {
886 /* set UART timeout */
887 UART_PUT_RTOR(port, PDC_RX_TIMEOUT);
888 UART_PUT_CR(port, ATMEL_US_STTTO);
890 UART_PUT_IER(port, ATMEL_US_ENDRX | ATMEL_US_TIMEOUT);
891 /* enable PDC controller */
892 UART_PUT_PTCR(port, ATMEL_PDC_RXTEN);
894 /* enable receive only */
895 UART_PUT_IER(port, ATMEL_US_RXRDY);
904 static void atmel_shutdown(struct uart_port *port)
906 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
908 * Ensure everything is stopped.
916 if (atmel_use_dma_rx(port)) {
919 for (i = 0; i < 2; i++) {
920 struct atmel_dma_buffer *pdc = &atmel_port->pdc_rx[i];
922 dma_unmap_single(port->dev,
929 if (atmel_use_dma_tx(port)) {
930 struct atmel_dma_buffer *pdc = &atmel_port->pdc_tx;
932 dma_unmap_single(port->dev,
939 * Disable all interrupts, port and break condition.
941 UART_PUT_CR(port, ATMEL_US_RSTSTA);
942 UART_PUT_IDR(port, -1);
947 free_irq(port->irq, port);
950 * If there is a specific "close" function (to unregister
951 * control line interrupts)
953 if (atmel_close_hook)
954 atmel_close_hook(port);
958 * Power / Clock management.
960 static void atmel_serial_pm(struct uart_port *port, unsigned int state,
961 unsigned int oldstate)
963 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
968 * Enable the peripheral clock for this serial port.
969 * This is called on uart_open() or a resume event.
971 clk_enable(atmel_port->clk);
975 * Disable the peripheral clock for this serial port.
976 * This is called on uart_close() or a suspend event.
978 clk_disable(atmel_port->clk);
981 printk(KERN_ERR "atmel_serial: unknown pm %d\n", state);
986 * Change the port parameters
988 static void atmel_set_termios(struct uart_port *port, struct ktermios *termios,
989 struct ktermios *old)
992 unsigned int mode, imr, quot, baud;
994 /* Get current mode register */
995 mode = UART_GET_MR(port) & ~(ATMEL_US_USCLKS | ATMEL_US_CHRL
996 | ATMEL_US_NBSTOP | ATMEL_US_PAR);
998 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk / 16);
999 quot = uart_get_divisor(port, baud);
1001 if (quot > 65535) { /* BRGR is 16-bit, so switch to slower clock */
1003 mode |= ATMEL_US_USCLKS_MCK_DIV8;
1007 switch (termios->c_cflag & CSIZE) {
1009 mode |= ATMEL_US_CHRL_5;
1012 mode |= ATMEL_US_CHRL_6;
1015 mode |= ATMEL_US_CHRL_7;
1018 mode |= ATMEL_US_CHRL_8;
1023 if (termios->c_cflag & CSTOPB)
1024 mode |= ATMEL_US_NBSTOP_2;
1027 if (termios->c_cflag & PARENB) {
1028 /* Mark or Space parity */
1029 if (termios->c_cflag & CMSPAR) {
1030 if (termios->c_cflag & PARODD)
1031 mode |= ATMEL_US_PAR_MARK;
1033 mode |= ATMEL_US_PAR_SPACE;
1034 } else if (termios->c_cflag & PARODD)
1035 mode |= ATMEL_US_PAR_ODD;
1037 mode |= ATMEL_US_PAR_EVEN;
1039 mode |= ATMEL_US_PAR_NONE;
1041 spin_lock_irqsave(&port->lock, flags);
1043 port->read_status_mask = ATMEL_US_OVRE;
1044 if (termios->c_iflag & INPCK)
1045 port->read_status_mask |= (ATMEL_US_FRAME | ATMEL_US_PARE);
1046 if (termios->c_iflag & (BRKINT | PARMRK))
1047 port->read_status_mask |= ATMEL_US_RXBRK;
1049 if (atmel_use_dma_rx(port))
1050 /* need to enable error interrupts */
1051 UART_PUT_IER(port, port->read_status_mask);
1054 * Characters to ignore
1056 port->ignore_status_mask = 0;
1057 if (termios->c_iflag & IGNPAR)
1058 port->ignore_status_mask |= (ATMEL_US_FRAME | ATMEL_US_PARE);
1059 if (termios->c_iflag & IGNBRK) {
1060 port->ignore_status_mask |= ATMEL_US_RXBRK;
1062 * If we're ignoring parity and break indicators,
1063 * ignore overruns too (for real raw support).
1065 if (termios->c_iflag & IGNPAR)
1066 port->ignore_status_mask |= ATMEL_US_OVRE;
1068 /* TODO: Ignore all characters if CREAD is set.*/
1070 /* update the per-port timeout */
1071 uart_update_timeout(port, termios->c_cflag, baud);
1073 /* save/disable interrupts and drain transmitter */
1074 imr = UART_GET_IMR(port);
1075 UART_PUT_IDR(port, -1);
1076 while (!(UART_GET_CSR(port) & ATMEL_US_TXEMPTY))
1079 /* disable receiver and transmitter */
1080 UART_PUT_CR(port, ATMEL_US_TXDIS | ATMEL_US_RXDIS);
1082 /* set the parity, stop bits and data size */
1083 UART_PUT_MR(port, mode);
1085 /* set the baud rate */
1086 UART_PUT_BRGR(port, quot);
1087 UART_PUT_CR(port, ATMEL_US_RSTSTA | ATMEL_US_RSTRX);
1088 UART_PUT_CR(port, ATMEL_US_TXEN | ATMEL_US_RXEN);
1090 /* restore interrupts */
1091 UART_PUT_IER(port, imr);
1093 /* CTS flow-control and modem-status interrupts */
1094 if (UART_ENABLE_MS(port, termios->c_cflag))
1095 port->ops->enable_ms(port);
1097 spin_unlock_irqrestore(&port->lock, flags);
1101 * Return string describing the specified port
1103 static const char *atmel_type(struct uart_port *port)
1105 return (port->type == PORT_ATMEL) ? "ATMEL_SERIAL" : NULL;
1109 * Release the memory region(s) being used by 'port'.
1111 static void atmel_release_port(struct uart_port *port)
1113 struct platform_device *pdev = to_platform_device(port->dev);
1114 int size = pdev->resource[0].end - pdev->resource[0].start + 1;
1116 release_mem_region(port->mapbase, size);
1118 if (port->flags & UPF_IOREMAP) {
1119 iounmap(port->membase);
1120 port->membase = NULL;
1125 * Request the memory region(s) being used by 'port'.
1127 static int atmel_request_port(struct uart_port *port)
1129 struct platform_device *pdev = to_platform_device(port->dev);
1130 int size = pdev->resource[0].end - pdev->resource[0].start + 1;
1132 if (!request_mem_region(port->mapbase, size, "atmel_serial"))
1135 if (port->flags & UPF_IOREMAP) {
1136 port->membase = ioremap(port->mapbase, size);
1137 if (port->membase == NULL) {
1138 release_mem_region(port->mapbase, size);
1147 * Configure/autoconfigure the port.
1149 static void atmel_config_port(struct uart_port *port, int flags)
1151 if (flags & UART_CONFIG_TYPE) {
1152 port->type = PORT_ATMEL;
1153 atmel_request_port(port);
1158 * Verify the new serial_struct (for TIOCSSERIAL).
1160 static int atmel_verify_port(struct uart_port *port, struct serial_struct *ser)
1163 if (ser->type != PORT_UNKNOWN && ser->type != PORT_ATMEL)
1165 if (port->irq != ser->irq)
1167 if (ser->io_type != SERIAL_IO_MEM)
1169 if (port->uartclk / 16 != ser->baud_base)
1171 if ((void *)port->mapbase != ser->iomem_base)
1173 if (port->iobase != ser->port)
1180 static struct uart_ops atmel_pops = {
1181 .tx_empty = atmel_tx_empty,
1182 .set_mctrl = atmel_set_mctrl,
1183 .get_mctrl = atmel_get_mctrl,
1184 .stop_tx = atmel_stop_tx,
1185 .start_tx = atmel_start_tx,
1186 .stop_rx = atmel_stop_rx,
1187 .enable_ms = atmel_enable_ms,
1188 .break_ctl = atmel_break_ctl,
1189 .startup = atmel_startup,
1190 .shutdown = atmel_shutdown,
1191 .set_termios = atmel_set_termios,
1193 .release_port = atmel_release_port,
1194 .request_port = atmel_request_port,
1195 .config_port = atmel_config_port,
1196 .verify_port = atmel_verify_port,
1197 .pm = atmel_serial_pm,
1201 * Configure the port from the platform device resource info.
1203 static void __devinit atmel_init_port(struct atmel_uart_port *atmel_port,
1204 struct platform_device *pdev)
1206 struct uart_port *port = &atmel_port->uart;
1207 struct atmel_uart_data *data = pdev->dev.platform_data;
1209 port->iotype = UPIO_MEM;
1210 port->flags = UPF_BOOT_AUTOCONF;
1211 port->ops = &atmel_pops;
1213 port->line = pdev->id;
1214 port->dev = &pdev->dev;
1216 port->mapbase = pdev->resource[0].start;
1217 port->irq = pdev->resource[1].start;
1219 tasklet_init(&atmel_port->tasklet, atmel_tasklet_func,
1220 (unsigned long)port);
1222 memset(&atmel_port->rx_ring, 0, sizeof(atmel_port->rx_ring));
1225 /* Already mapped by setup code */
1226 port->membase = data->regs;
1228 port->flags |= UPF_IOREMAP;
1229 port->membase = NULL;
1232 /* for console, the clock could already be configured */
1233 if (!atmel_port->clk) {
1234 atmel_port->clk = clk_get(&pdev->dev, "usart");
1235 clk_enable(atmel_port->clk);
1236 port->uartclk = clk_get_rate(atmel_port->clk);
1239 atmel_port->use_dma_rx = data->use_dma_rx;
1240 atmel_port->use_dma_tx = data->use_dma_tx;
1241 if (atmel_use_dma_tx(port))
1242 port->fifosize = PDC_BUFFER_SIZE;
1246 * Register board-specific modem-control line handlers.
1248 void __init atmel_register_uart_fns(struct atmel_port_fns *fns)
1251 atmel_pops.enable_ms = fns->enable_ms;
1253 atmel_pops.get_mctrl = fns->get_mctrl;
1255 atmel_pops.set_mctrl = fns->set_mctrl;
1256 atmel_open_hook = fns->open;
1257 atmel_close_hook = fns->close;
1258 atmel_pops.pm = fns->pm;
1259 atmel_pops.set_wake = fns->set_wake;
1262 #ifdef CONFIG_SERIAL_ATMEL_CONSOLE
1263 static void atmel_console_putchar(struct uart_port *port, int ch)
1265 while (!(UART_GET_CSR(port) & ATMEL_US_TXRDY))
1267 UART_PUT_CHAR(port, ch);
1271 * Interrupts are disabled on entering
1273 static void atmel_console_write(struct console *co, const char *s, u_int count)
1275 struct uart_port *port = &atmel_ports[co->index].uart;
1276 unsigned int status, imr;
1279 * First, save IMR and then disable interrupts
1281 imr = UART_GET_IMR(port);
1282 UART_PUT_IDR(port, ATMEL_US_RXRDY | ATMEL_US_TXRDY);
1284 uart_console_write(port, s, count, atmel_console_putchar);
1287 * Finally, wait for transmitter to become empty
1291 status = UART_GET_CSR(port);
1292 } while (!(status & ATMEL_US_TXRDY));
1293 /* set interrupts back the way they were */
1294 UART_PUT_IER(port, imr);
1298 * If the port was already initialised (eg, by a boot loader),
1299 * try to determine the current setup.
1301 static void __init atmel_console_get_options(struct uart_port *port, int *baud,
1302 int *parity, int *bits)
1304 unsigned int mr, quot;
1307 * If the baud rate generator isn't running, the port wasn't
1308 * initialized by the boot loader.
1310 quot = UART_GET_BRGR(port);
1314 mr = UART_GET_MR(port) & ATMEL_US_CHRL;
1315 if (mr == ATMEL_US_CHRL_8)
1320 mr = UART_GET_MR(port) & ATMEL_US_PAR;
1321 if (mr == ATMEL_US_PAR_EVEN)
1323 else if (mr == ATMEL_US_PAR_ODD)
1327 * The serial core only rounds down when matching this to a
1328 * supported baud rate. Make sure we don't end up slightly
1329 * lower than one of those, as it would make us fall through
1330 * to a much lower baud rate than we really want.
1332 *baud = port->uartclk / (16 * (quot - 1));
1335 static int __init atmel_console_setup(struct console *co, char *options)
1337 struct uart_port *port = &atmel_ports[co->index].uart;
1343 if (port->membase == NULL) {
1344 /* Port not initialized yet - delay setup */
1348 UART_PUT_IDR(port, -1);
1349 UART_PUT_CR(port, ATMEL_US_RSTSTA | ATMEL_US_RSTRX);
1350 UART_PUT_CR(port, ATMEL_US_TXEN | ATMEL_US_RXEN);
1353 uart_parse_options(options, &baud, &parity, &bits, &flow);
1355 atmel_console_get_options(port, &baud, &parity, &bits);
1357 return uart_set_options(port, co, baud, parity, bits, flow);
1360 static struct uart_driver atmel_uart;
1362 static struct console atmel_console = {
1363 .name = ATMEL_DEVICENAME,
1364 .write = atmel_console_write,
1365 .device = uart_console_device,
1366 .setup = atmel_console_setup,
1367 .flags = CON_PRINTBUFFER,
1369 .data = &atmel_uart,
1372 #define ATMEL_CONSOLE_DEVICE &atmel_console
1375 * Early console initialization (before VM subsystem initialized).
1377 static int __init atmel_console_init(void)
1379 if (atmel_default_console_device) {
1380 add_preferred_console(ATMEL_DEVICENAME,
1381 atmel_default_console_device->id, NULL);
1382 atmel_init_port(&atmel_ports[atmel_default_console_device->id],
1383 atmel_default_console_device);
1384 register_console(&atmel_console);
1390 console_initcall(atmel_console_init);
1393 * Late console initialization.
1395 static int __init atmel_late_console_init(void)
1397 if (atmel_default_console_device
1398 && !(atmel_console.flags & CON_ENABLED))
1399 register_console(&atmel_console);
1404 core_initcall(atmel_late_console_init);
1406 static inline bool atmel_is_console_port(struct uart_port *port)
1408 return port->cons && port->cons->index == port->line;
1412 #define ATMEL_CONSOLE_DEVICE NULL
1414 static inline bool atmel_is_console_port(struct uart_port *port)
1420 static struct uart_driver atmel_uart = {
1421 .owner = THIS_MODULE,
1422 .driver_name = "atmel_serial",
1423 .dev_name = ATMEL_DEVICENAME,
1424 .major = SERIAL_ATMEL_MAJOR,
1425 .minor = MINOR_START,
1426 .nr = ATMEL_MAX_UART,
1427 .cons = ATMEL_CONSOLE_DEVICE,
1431 static int atmel_serial_suspend(struct platform_device *pdev,
1434 struct uart_port *port = platform_get_drvdata(pdev);
1435 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
1437 if (device_may_wakeup(&pdev->dev)
1438 && !at91_suspend_entering_slow_clock())
1439 enable_irq_wake(port->irq);
1441 uart_suspend_port(&atmel_uart, port);
1442 atmel_port->suspended = 1;
1448 static int atmel_serial_resume(struct platform_device *pdev)
1450 struct uart_port *port = platform_get_drvdata(pdev);
1451 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
1453 if (atmel_port->suspended) {
1454 uart_resume_port(&atmel_uart, port);
1455 atmel_port->suspended = 0;
1457 disable_irq_wake(port->irq);
1462 #define atmel_serial_suspend NULL
1463 #define atmel_serial_resume NULL
1466 static int __devinit atmel_serial_probe(struct platform_device *pdev)
1468 struct atmel_uart_port *port;
1472 BUILD_BUG_ON(!is_power_of_2(ATMEL_SERIAL_RINGSIZE));
1474 port = &atmel_ports[pdev->id];
1475 atmel_init_port(port, pdev);
1477 if (!atmel_use_dma_rx(&port->uart)) {
1479 data = kmalloc(sizeof(struct atmel_uart_char)
1480 * ATMEL_SERIAL_RINGSIZE, GFP_KERNEL);
1482 goto err_alloc_ring;
1483 port->rx_ring.buf = data;
1486 ret = uart_add_one_port(&atmel_uart, &port->uart);
1490 device_init_wakeup(&pdev->dev, 1);
1491 platform_set_drvdata(pdev, port);
1496 kfree(port->rx_ring.buf);
1497 port->rx_ring.buf = NULL;
1499 if (!atmel_is_console_port(&port->uart)) {
1500 clk_disable(port->clk);
1508 static int __devexit atmel_serial_remove(struct platform_device *pdev)
1510 struct uart_port *port = platform_get_drvdata(pdev);
1511 struct atmel_uart_port *atmel_port = to_atmel_uart_port(port);
1514 device_init_wakeup(&pdev->dev, 0);
1515 platform_set_drvdata(pdev, NULL);
1517 ret = uart_remove_one_port(&atmel_uart, port);
1519 tasklet_kill(&atmel_port->tasklet);
1520 kfree(atmel_port->rx_ring.buf);
1522 /* "port" is allocated statically, so we shouldn't free it */
1524 clk_disable(atmel_port->clk);
1525 clk_put(atmel_port->clk);
1530 static struct platform_driver atmel_serial_driver = {
1531 .probe = atmel_serial_probe,
1532 .remove = __devexit_p(atmel_serial_remove),
1533 .suspend = atmel_serial_suspend,
1534 .resume = atmel_serial_resume,
1536 .name = "atmel_usart",
1537 .owner = THIS_MODULE,
1541 static int __init atmel_serial_init(void)
1545 ret = uart_register_driver(&atmel_uart);
1549 ret = platform_driver_register(&atmel_serial_driver);
1551 uart_unregister_driver(&atmel_uart);
1556 static void __exit atmel_serial_exit(void)
1558 platform_driver_unregister(&atmel_serial_driver);
1559 uart_unregister_driver(&atmel_uart);
1562 module_init(atmel_serial_init);
1563 module_exit(atmel_serial_exit);
1565 MODULE_AUTHOR("Rick Bronson");
1566 MODULE_DESCRIPTION("Atmel AT91 / AT32 serial port driver");
1567 MODULE_LICENSE("GPL");