1 // SPDX-License-Identifier: GPL-2.0+
3 * Driver for CPM (SCC/SMC) serial ports; core driver
5 * Based on arch/ppc/cpm2_io/uart.c by Dan Malek
6 * Based on ppc8xx.c by Thomas Gleixner
7 * Based on drivers/serial/amba.c by Russell King
9 * Maintainer: Kumar Gala (galak@kernel.crashing.org) (CPM2)
10 * Pantelis Antoniou (panto@intracom.gr) (CPM1)
12 * Copyright (C) 2004, 2007 Freescale Semiconductor, Inc.
13 * (C) 2004 Intracom, S.A.
14 * (C) 2005-2006 MontaVista Software, Inc.
15 * Vitaly Bordug <vbordug@ru.mvista.com>
18 #include <linux/module.h>
19 #include <linux/tty.h>
20 #include <linux/tty_flip.h>
21 #include <linux/ioport.h>
22 #include <linux/init.h>
23 #include <linux/serial.h>
24 #include <linux/console.h>
25 #include <linux/sysrq.h>
26 #include <linux/device.h>
27 #include <linux/memblock.h>
28 #include <linux/dma-mapping.h>
29 #include <linux/fs_uart_pd.h>
30 #include <linux/of_address.h>
31 #include <linux/of_irq.h>
32 #include <linux/of_platform.h>
33 #include <linux/gpio/consumer.h>
34 #include <linux/clk.h>
38 #include <asm/delay.h>
39 #include <asm/fs_pd.h>
42 #include <linux/serial_core.h>
43 #include <linux/kernel.h>
48 /**************************************************************/
50 static int cpm_uart_tx_pump(struct uart_port *port);
51 static void cpm_uart_init_smc(struct uart_cpm_port *pinfo);
52 static void cpm_uart_init_scc(struct uart_cpm_port *pinfo);
53 static void cpm_uart_initbd(struct uart_cpm_port *pinfo);
55 /**************************************************************/
57 #define HW_BUF_SPD_THRESHOLD 2400
60 * Check, if transmit buffers are processed
62 static unsigned int cpm_uart_tx_empty(struct uart_port *port)
64 struct uart_cpm_port *pinfo =
65 container_of(port, struct uart_cpm_port, port);
66 cbd_t __iomem *bdp = pinfo->tx_bd_base;
70 if (in_be16(&bdp->cbd_sc) & BD_SC_READY)
73 if (in_be16(&bdp->cbd_sc) & BD_SC_WRAP) {
80 pr_debug("CPM uart[%d]:tx_empty: %d\n", port->line, ret);
85 static void cpm_uart_set_mctrl(struct uart_port *port, unsigned int mctrl)
87 struct uart_cpm_port *pinfo =
88 container_of(port, struct uart_cpm_port, port);
90 if (pinfo->gpios[GPIO_RTS])
91 gpiod_set_value(pinfo->gpios[GPIO_RTS], !(mctrl & TIOCM_RTS));
93 if (pinfo->gpios[GPIO_DTR])
94 gpiod_set_value(pinfo->gpios[GPIO_DTR], !(mctrl & TIOCM_DTR));
97 static unsigned int cpm_uart_get_mctrl(struct uart_port *port)
99 struct uart_cpm_port *pinfo =
100 container_of(port, struct uart_cpm_port, port);
101 unsigned int mctrl = TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
103 if (pinfo->gpios[GPIO_CTS]) {
104 if (gpiod_get_value(pinfo->gpios[GPIO_CTS]))
108 if (pinfo->gpios[GPIO_DSR]) {
109 if (gpiod_get_value(pinfo->gpios[GPIO_DSR]))
113 if (pinfo->gpios[GPIO_DCD]) {
114 if (gpiod_get_value(pinfo->gpios[GPIO_DCD]))
118 if (pinfo->gpios[GPIO_RI]) {
119 if (!gpiod_get_value(pinfo->gpios[GPIO_RI]))
129 static void cpm_uart_stop_tx(struct uart_port *port)
131 struct uart_cpm_port *pinfo =
132 container_of(port, struct uart_cpm_port, port);
133 smc_t __iomem *smcp = pinfo->smcp;
134 scc_t __iomem *sccp = pinfo->sccp;
136 pr_debug("CPM uart[%d]:stop tx\n", port->line);
139 clrbits8(&smcp->smc_smcm, SMCM_TX);
141 clrbits16(&sccp->scc_sccm, UART_SCCM_TX);
147 static void cpm_uart_start_tx(struct uart_port *port)
149 struct uart_cpm_port *pinfo =
150 container_of(port, struct uart_cpm_port, port);
151 smc_t __iomem *smcp = pinfo->smcp;
152 scc_t __iomem *sccp = pinfo->sccp;
154 pr_debug("CPM uart[%d]:start tx\n", port->line);
157 if (in_8(&smcp->smc_smcm) & SMCM_TX)
160 if (in_be16(&sccp->scc_sccm) & UART_SCCM_TX)
164 if (cpm_uart_tx_pump(port) != 0) {
166 setbits8(&smcp->smc_smcm, SMCM_TX);
168 setbits16(&sccp->scc_sccm, UART_SCCM_TX);
176 static void cpm_uart_stop_rx(struct uart_port *port)
178 struct uart_cpm_port *pinfo =
179 container_of(port, struct uart_cpm_port, port);
180 smc_t __iomem *smcp = pinfo->smcp;
181 scc_t __iomem *sccp = pinfo->sccp;
183 pr_debug("CPM uart[%d]:stop rx\n", port->line);
186 clrbits8(&smcp->smc_smcm, SMCM_RX);
188 clrbits16(&sccp->scc_sccm, UART_SCCM_RX);
194 static void cpm_uart_break_ctl(struct uart_port *port, int break_state)
196 struct uart_cpm_port *pinfo =
197 container_of(port, struct uart_cpm_port, port);
199 pr_debug("CPM uart[%d]:break ctrl, break_state: %d\n", port->line,
203 cpm_line_cr_cmd(pinfo, CPM_CR_STOP_TX);
205 cpm_line_cr_cmd(pinfo, CPM_CR_RESTART_TX);
209 * Transmit characters, refill buffer descriptor, if possible
211 static void cpm_uart_int_tx(struct uart_port *port)
213 pr_debug("CPM uart[%d]:TX INT\n", port->line);
215 cpm_uart_tx_pump(port);
218 #ifdef CONFIG_CONSOLE_POLL
219 static int serial_polled;
225 static void cpm_uart_int_rx(struct uart_port *port)
230 struct tty_port *tport = &port->state->port;
231 struct uart_cpm_port *pinfo =
232 container_of(port, struct uart_cpm_port, port);
237 pr_debug("CPM uart[%d]:RX INT\n", port->line);
239 /* Just loop through the closed BDs and copy the characters into
244 #ifdef CONFIG_CONSOLE_POLL
245 if (unlikely(serial_polled)) {
251 status = in_be16(&bdp->cbd_sc);
252 /* If this one is empty, return happy */
253 if (status & BD_SC_EMPTY)
256 /* get number of characters, and check spce in flip-buffer */
257 i = in_be16(&bdp->cbd_datlen);
259 /* If we have not enough room in tty flip buffer, then we try
260 * later, which will be the next rx-interrupt or a timeout
262 if (tty_buffer_request_room(tport, i) < i) {
263 printk(KERN_WARNING "No room in flip buffer\n");
268 cp = cpm2cpu_addr(in_be32(&bdp->cbd_bufaddr), pinfo);
270 /* loop through the buffer */
277 (BD_SC_BR | BD_SC_FR | BD_SC_PR | BD_SC_OV))
279 if (uart_handle_sysrq_char(port, ch))
281 #ifdef CONFIG_CONSOLE_POLL
282 if (unlikely(serial_polled)) {
288 tty_insert_flip_char(tport, ch, flg);
290 } /* End while (i--) */
292 /* This BD is ready to be used again. Clear status. get next */
293 clrbits16(&bdp->cbd_sc, BD_SC_BR | BD_SC_FR | BD_SC_PR |
294 BD_SC_OV | BD_SC_ID);
295 setbits16(&bdp->cbd_sc, BD_SC_EMPTY);
297 if (in_be16(&bdp->cbd_sc) & BD_SC_WRAP)
298 bdp = pinfo->rx_bd_base;
304 /* Write back buffer pointer */
307 /* activate BH processing */
308 tty_flip_buffer_push(tport);
312 /* Error processing */
316 if (status & BD_SC_BR)
318 if (status & BD_SC_PR)
319 port->icount.parity++;
320 if (status & BD_SC_FR)
321 port->icount.frame++;
322 if (status & BD_SC_OV)
323 port->icount.overrun++;
325 /* Mask out ignored conditions */
326 status &= port->read_status_mask;
328 /* Handle the remaining ones */
329 if (status & BD_SC_BR)
331 else if (status & BD_SC_PR)
333 else if (status & BD_SC_FR)
336 /* overrun does not affect the current character ! */
337 if (status & BD_SC_OV) {
340 /* We skip this buffer */
341 /* CHECK: Is really nothing senseful there */
342 /* ASSUMPTION: it contains nothing valid */
350 * Asynchron mode interrupt handler
352 static irqreturn_t cpm_uart_int(int irq, void *data)
355 struct uart_port *port = data;
356 struct uart_cpm_port *pinfo = (struct uart_cpm_port *)port;
357 smc_t __iomem *smcp = pinfo->smcp;
358 scc_t __iomem *sccp = pinfo->sccp;
360 pr_debug("CPM uart[%d]:IRQ\n", port->line);
363 events = in_8(&smcp->smc_smce);
364 out_8(&smcp->smc_smce, events);
365 if (events & SMCM_BRKE)
366 uart_handle_break(port);
367 if (events & SMCM_RX)
368 cpm_uart_int_rx(port);
369 if (events & SMCM_TX)
370 cpm_uart_int_tx(port);
372 events = in_be16(&sccp->scc_scce);
373 out_be16(&sccp->scc_scce, events);
374 if (events & UART_SCCM_BRKE)
375 uart_handle_break(port);
376 if (events & UART_SCCM_RX)
377 cpm_uart_int_rx(port);
378 if (events & UART_SCCM_TX)
379 cpm_uart_int_tx(port);
381 return (events) ? IRQ_HANDLED : IRQ_NONE;
384 static int cpm_uart_startup(struct uart_port *port)
387 struct uart_cpm_port *pinfo =
388 container_of(port, struct uart_cpm_port, port);
390 pr_debug("CPM uart[%d]:startup\n", port->line);
392 /* If the port is not the console, make sure rx is disabled. */
393 if (!(pinfo->flags & FLAG_CONSOLE)) {
394 /* Disable UART rx */
396 clrbits16(&pinfo->smcp->smc_smcmr, SMCMR_REN);
397 clrbits8(&pinfo->smcp->smc_smcm, SMCM_RX);
399 clrbits32(&pinfo->sccp->scc_gsmrl, SCC_GSMRL_ENR);
400 clrbits16(&pinfo->sccp->scc_sccm, UART_SCCM_RX);
402 cpm_uart_initbd(pinfo);
404 out_be32(&pinfo->smcup->smc_rstate, 0);
405 out_be32(&pinfo->smcup->smc_tstate, 0);
406 out_be16(&pinfo->smcup->smc_rbptr,
407 in_be16(&pinfo->smcup->smc_rbase));
408 out_be16(&pinfo->smcup->smc_tbptr,
409 in_be16(&pinfo->smcup->smc_tbase));
411 cpm_line_cr_cmd(pinfo, CPM_CR_INIT_TRX);
414 /* Install interrupt handler. */
415 retval = request_irq(port->irq, cpm_uart_int, 0, "cpm_uart", port);
421 setbits8(&pinfo->smcp->smc_smcm, SMCM_RX);
422 setbits16(&pinfo->smcp->smc_smcmr, (SMCMR_REN | SMCMR_TEN));
424 setbits16(&pinfo->sccp->scc_sccm, UART_SCCM_RX);
425 setbits32(&pinfo->sccp->scc_gsmrl, (SCC_GSMRL_ENR | SCC_GSMRL_ENT));
431 inline void cpm_uart_wait_until_send(struct uart_cpm_port *pinfo)
433 set_current_state(TASK_UNINTERRUPTIBLE);
434 schedule_timeout(pinfo->wait_closing);
440 static void cpm_uart_shutdown(struct uart_port *port)
442 struct uart_cpm_port *pinfo =
443 container_of(port, struct uart_cpm_port, port);
445 pr_debug("CPM uart[%d]:shutdown\n", port->line);
447 /* free interrupt handler */
448 free_irq(port->irq, port);
450 /* If the port is not the console, disable Rx and Tx. */
451 if (!(pinfo->flags & FLAG_CONSOLE)) {
452 /* Wait for all the BDs marked sent */
453 while(!cpm_uart_tx_empty(port)) {
454 set_current_state(TASK_UNINTERRUPTIBLE);
458 if (pinfo->wait_closing)
459 cpm_uart_wait_until_send(pinfo);
463 smc_t __iomem *smcp = pinfo->smcp;
464 clrbits16(&smcp->smc_smcmr, SMCMR_REN | SMCMR_TEN);
465 clrbits8(&smcp->smc_smcm, SMCM_RX | SMCM_TX);
467 scc_t __iomem *sccp = pinfo->sccp;
468 clrbits32(&sccp->scc_gsmrl, SCC_GSMRL_ENR | SCC_GSMRL_ENT);
469 clrbits16(&sccp->scc_sccm, UART_SCCM_TX | UART_SCCM_RX);
472 /* Shut them really down and reinit buffer descriptors */
474 out_be16(&pinfo->smcup->smc_brkcr, 0);
475 cpm_line_cr_cmd(pinfo, CPM_CR_STOP_TX);
477 out_be16(&pinfo->sccup->scc_brkcr, 0);
478 cpm_line_cr_cmd(pinfo, CPM_CR_GRA_STOP_TX);
481 cpm_uart_initbd(pinfo);
485 static void cpm_uart_set_termios(struct uart_port *port,
486 struct ktermios *termios,
487 struct ktermios *old)
491 u16 cval, scval, prev_mode;
493 struct uart_cpm_port *pinfo =
494 container_of(port, struct uart_cpm_port, port);
495 smc_t __iomem *smcp = pinfo->smcp;
496 scc_t __iomem *sccp = pinfo->sccp;
499 pr_debug("CPM uart[%d]:set_termios\n", port->line);
501 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk / 16);
502 if (baud < HW_BUF_SPD_THRESHOLD ||
503 (pinfo->port.state && pinfo->port.state->port.low_latency))
504 pinfo->rx_fifosize = 1;
506 pinfo->rx_fifosize = RX_BUF_SIZE;
508 /* MAXIDL is the timeout after which a receive buffer is closed
509 * when not full if no more characters are received.
510 * We calculate it from the baudrate so that the duration is
511 * always the same at standard rates: about 4ms.
513 maxidl = baud / 2400;
519 /* Character length programmed into the mode register is the
520 * sum of: 1 start bit, number of data bits, 0 or 1 parity bit,
521 * 1 or 2 stop bits, minus 1.
522 * The value 'bits' counts this for us.
528 switch (termios->c_cflag & CSIZE) {
541 /* Never happens, but GCC is too dumb to figure it out */
548 if (termios->c_cflag & CSTOPB) {
549 cval |= SMCMR_SL; /* Two stops */
550 scval |= SCU_PSMR_SL;
554 if (termios->c_cflag & PARENB) {
556 scval |= SCU_PSMR_PEN;
558 if (!(termios->c_cflag & PARODD)) {
559 cval |= SMCMR_PM_EVEN;
560 scval |= (SCU_PSMR_REVP | SCU_PSMR_TEVP);
567 uart_update_timeout(port, termios->c_cflag, baud);
570 * Set up parity check flag
572 port->read_status_mask = (BD_SC_EMPTY | BD_SC_OV);
573 if (termios->c_iflag & INPCK)
574 port->read_status_mask |= BD_SC_FR | BD_SC_PR;
575 if ((termios->c_iflag & BRKINT) || (termios->c_iflag & PARMRK))
576 port->read_status_mask |= BD_SC_BR;
579 * Characters to ignore
581 port->ignore_status_mask = 0;
582 if (termios->c_iflag & IGNPAR)
583 port->ignore_status_mask |= BD_SC_PR | BD_SC_FR;
584 if (termios->c_iflag & IGNBRK) {
585 port->ignore_status_mask |= BD_SC_BR;
587 * If we're ignore parity and break indicators, ignore
588 * overruns too. (For real raw support).
590 if (termios->c_iflag & IGNPAR)
591 port->ignore_status_mask |= BD_SC_OV;
594 * !!! ignore all characters if CREAD is not set
596 if ((termios->c_cflag & CREAD) == 0)
597 port->read_status_mask &= ~BD_SC_EMPTY;
599 spin_lock_irqsave(&port->lock, flags);
601 /* Start bit has not been added (so don't, because we would just
602 * subtract it later), and we need to add one for the number of
603 * stops bits (there is always at least one).
608 * MRBLR can be changed while an SMC/SCC is operating only
609 * if it is done in a single bus cycle with one 16-bit move
610 * (not two 8-bit bus cycles back-to-back). This occurs when
611 * the cp shifts control to the next RxBD, so the change does
612 * not take effect immediately. To guarantee the exact RxBD
613 * on which the change occurs, change MRBLR only while the
614 * SMC/SCC receiver is disabled.
616 out_be16(&pinfo->smcup->smc_mrblr, pinfo->rx_fifosize);
617 out_be16(&pinfo->smcup->smc_maxidl, maxidl);
619 /* Set the mode register. We want to keep a copy of the
620 * enables, because we want to put them back if they were
623 prev_mode = in_be16(&smcp->smc_smcmr) & (SMCMR_REN | SMCMR_TEN);
624 /* Output in *one* operation, so we don't interrupt RX/TX if they
625 * were already enabled. */
626 out_be16(&smcp->smc_smcmr, smcr_mk_clen(bits) | cval |
627 SMCMR_SM_UART | prev_mode);
629 out_be16(&pinfo->sccup->scc_genscc.scc_mrblr, pinfo->rx_fifosize);
630 out_be16(&pinfo->sccup->scc_maxidl, maxidl);
631 out_be16(&sccp->scc_psmr, (sbits << 12) | scval);
635 clk_set_rate(pinfo->clk, baud);
637 cpm_set_brg(pinfo->brg - 1, baud);
638 spin_unlock_irqrestore(&port->lock, flags);
641 static const char *cpm_uart_type(struct uart_port *port)
643 pr_debug("CPM uart[%d]:uart_type\n", port->line);
645 return port->type == PORT_CPM ? "CPM UART" : NULL;
649 * verify the new serial_struct (for TIOCSSERIAL).
651 static int cpm_uart_verify_port(struct uart_port *port,
652 struct serial_struct *ser)
656 pr_debug("CPM uart[%d]:verify_port\n", port->line);
658 if (ser->type != PORT_UNKNOWN && ser->type != PORT_CPM)
660 if (ser->irq < 0 || ser->irq >= nr_irqs)
662 if (ser->baud_base < 9600)
668 * Transmit characters, refill buffer descriptor, if possible
670 static int cpm_uart_tx_pump(struct uart_port *port)
675 struct uart_cpm_port *pinfo =
676 container_of(port, struct uart_cpm_port, port);
677 struct circ_buf *xmit = &port->state->xmit;
679 /* Handle xon/xoff */
681 /* Pick next descriptor and fill from buffer */
684 p = cpm2cpu_addr(in_be32(&bdp->cbd_bufaddr), pinfo);
688 out_be16(&bdp->cbd_datlen, 1);
689 setbits16(&bdp->cbd_sc, BD_SC_READY);
691 if (in_be16(&bdp->cbd_sc) & BD_SC_WRAP)
692 bdp = pinfo->tx_bd_base;
702 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
703 cpm_uart_stop_tx(port);
707 /* Pick next descriptor and fill from buffer */
710 while (!(in_be16(&bdp->cbd_sc) & BD_SC_READY) &&
711 xmit->tail != xmit->head) {
713 p = cpm2cpu_addr(in_be32(&bdp->cbd_bufaddr), pinfo);
714 while (count < pinfo->tx_fifosize) {
715 *p++ = xmit->buf[xmit->tail];
716 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
719 if (xmit->head == xmit->tail)
722 out_be16(&bdp->cbd_datlen, count);
723 setbits16(&bdp->cbd_sc, BD_SC_READY);
725 if (in_be16(&bdp->cbd_sc) & BD_SC_WRAP)
726 bdp = pinfo->tx_bd_base;
732 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
733 uart_write_wakeup(port);
735 if (uart_circ_empty(xmit)) {
736 cpm_uart_stop_tx(port);
744 * init buffer descriptors
746 static void cpm_uart_initbd(struct uart_cpm_port *pinfo)
752 pr_debug("CPM uart[%d]:initbd\n", pinfo->port.line);
754 /* Set the physical address of the host memory
755 * buffers in the buffer descriptors, and the
756 * virtual address for us to work with.
758 mem_addr = pinfo->mem_addr;
759 bdp = pinfo->rx_cur = pinfo->rx_bd_base;
760 for (i = 0; i < (pinfo->rx_nrfifos - 1); i++, bdp++) {
761 out_be32(&bdp->cbd_bufaddr, cpu2cpm_addr(mem_addr, pinfo));
762 out_be16(&bdp->cbd_sc, BD_SC_EMPTY | BD_SC_INTRPT);
763 mem_addr += pinfo->rx_fifosize;
766 out_be32(&bdp->cbd_bufaddr, cpu2cpm_addr(mem_addr, pinfo));
767 out_be16(&bdp->cbd_sc, BD_SC_WRAP | BD_SC_EMPTY | BD_SC_INTRPT);
769 /* Set the physical address of the host memory
770 * buffers in the buffer descriptors, and the
771 * virtual address for us to work with.
773 mem_addr = pinfo->mem_addr + L1_CACHE_ALIGN(pinfo->rx_nrfifos * pinfo->rx_fifosize);
774 bdp = pinfo->tx_cur = pinfo->tx_bd_base;
775 for (i = 0; i < (pinfo->tx_nrfifos - 1); i++, bdp++) {
776 out_be32(&bdp->cbd_bufaddr, cpu2cpm_addr(mem_addr, pinfo));
777 out_be16(&bdp->cbd_sc, BD_SC_INTRPT);
778 mem_addr += pinfo->tx_fifosize;
781 out_be32(&bdp->cbd_bufaddr, cpu2cpm_addr(mem_addr, pinfo));
782 out_be16(&bdp->cbd_sc, BD_SC_WRAP | BD_SC_INTRPT);
785 static void cpm_uart_init_scc(struct uart_cpm_port *pinfo)
788 scc_uart_t __iomem *sup;
790 pr_debug("CPM uart[%d]:init_scc\n", pinfo->port.line);
796 out_be16(&pinfo->sccup->scc_genscc.scc_rbase,
797 (u8 __iomem *)pinfo->rx_bd_base - DPRAM_BASE);
798 out_be16(&pinfo->sccup->scc_genscc.scc_tbase,
799 (u8 __iomem *)pinfo->tx_bd_base - DPRAM_BASE);
801 /* Set up the uart parameters in the
805 cpm_set_scc_fcr(sup);
807 out_be16(&sup->scc_genscc.scc_mrblr, pinfo->rx_fifosize);
808 out_be16(&sup->scc_maxidl, 0x10);
809 out_be16(&sup->scc_brkcr, 1);
810 out_be16(&sup->scc_parec, 0);
811 out_be16(&sup->scc_frmec, 0);
812 out_be16(&sup->scc_nosec, 0);
813 out_be16(&sup->scc_brkec, 0);
814 out_be16(&sup->scc_uaddr1, 0);
815 out_be16(&sup->scc_uaddr2, 0);
816 out_be16(&sup->scc_toseq, 0);
817 out_be16(&sup->scc_char1, 0x8000);
818 out_be16(&sup->scc_char2, 0x8000);
819 out_be16(&sup->scc_char3, 0x8000);
820 out_be16(&sup->scc_char4, 0x8000);
821 out_be16(&sup->scc_char5, 0x8000);
822 out_be16(&sup->scc_char6, 0x8000);
823 out_be16(&sup->scc_char7, 0x8000);
824 out_be16(&sup->scc_char8, 0x8000);
825 out_be16(&sup->scc_rccm, 0xc0ff);
827 /* Send the CPM an initialize command.
829 cpm_line_cr_cmd(pinfo, CPM_CR_INIT_TRX);
831 /* Set UART mode, 8 bit, no parity, one stop.
832 * Enable receive and transmit.
834 out_be32(&scp->scc_gsmrh, 0);
835 out_be32(&scp->scc_gsmrl,
836 SCC_GSMRL_MODE_UART | SCC_GSMRL_TDCR_16 | SCC_GSMRL_RDCR_16);
838 /* Enable rx interrupts and clear all pending events. */
839 out_be16(&scp->scc_sccm, 0);
840 out_be16(&scp->scc_scce, 0xffff);
841 out_be16(&scp->scc_dsr, 0x7e7e);
842 out_be16(&scp->scc_psmr, 0x3000);
844 setbits32(&scp->scc_gsmrl, SCC_GSMRL_ENR | SCC_GSMRL_ENT);
847 static void cpm_uart_init_smc(struct uart_cpm_port *pinfo)
850 smc_uart_t __iomem *up;
852 pr_debug("CPM uart[%d]:init_smc\n", pinfo->port.line);
858 out_be16(&pinfo->smcup->smc_rbase,
859 (u8 __iomem *)pinfo->rx_bd_base - DPRAM_BASE);
860 out_be16(&pinfo->smcup->smc_tbase,
861 (u8 __iomem *)pinfo->tx_bd_base - DPRAM_BASE);
864 * In case SMC is being relocated...
866 out_be16(&up->smc_rbptr, in_be16(&pinfo->smcup->smc_rbase));
867 out_be16(&up->smc_tbptr, in_be16(&pinfo->smcup->smc_tbase));
868 out_be32(&up->smc_rstate, 0);
869 out_be32(&up->smc_tstate, 0);
870 out_be16(&up->smc_brkcr, 1); /* number of break chars */
871 out_be16(&up->smc_brkec, 0);
873 /* Set up the uart parameters in the
878 /* Using idle character time requires some additional tuning. */
879 out_be16(&up->smc_mrblr, pinfo->rx_fifosize);
880 out_be16(&up->smc_maxidl, 0x10);
881 out_be16(&up->smc_brklen, 0);
882 out_be16(&up->smc_brkec, 0);
883 out_be16(&up->smc_brkcr, 1);
885 /* Set UART mode, 8 bit, no parity, one stop.
886 * Enable receive and transmit.
888 out_be16(&sp->smc_smcmr, smcr_mk_clen(9) | SMCMR_SM_UART);
890 /* Enable only rx interrupts clear all pending events. */
891 out_8(&sp->smc_smcm, 0);
892 out_8(&sp->smc_smce, 0xff);
894 setbits16(&sp->smc_smcmr, SMCMR_REN | SMCMR_TEN);
898 * Initialize port. This is called from early_console stuff
899 * so we have to be careful here !
901 static int cpm_uart_request_port(struct uart_port *port)
903 struct uart_cpm_port *pinfo =
904 container_of(port, struct uart_cpm_port, port);
907 pr_debug("CPM uart[%d]:request port\n", port->line);
909 if (pinfo->flags & FLAG_CONSOLE)
913 clrbits8(&pinfo->smcp->smc_smcm, SMCM_RX | SMCM_TX);
914 clrbits16(&pinfo->smcp->smc_smcmr, SMCMR_REN | SMCMR_TEN);
916 clrbits16(&pinfo->sccp->scc_sccm, UART_SCCM_TX | UART_SCCM_RX);
917 clrbits32(&pinfo->sccp->scc_gsmrl, SCC_GSMRL_ENR | SCC_GSMRL_ENT);
920 ret = cpm_uart_allocbuf(pinfo, 0);
925 cpm_uart_initbd(pinfo);
927 cpm_uart_init_smc(pinfo);
929 cpm_uart_init_scc(pinfo);
934 static void cpm_uart_release_port(struct uart_port *port)
936 struct uart_cpm_port *pinfo =
937 container_of(port, struct uart_cpm_port, port);
939 if (!(pinfo->flags & FLAG_CONSOLE))
940 cpm_uart_freebuf(pinfo);
944 * Configure/autoconfigure the port.
946 static void cpm_uart_config_port(struct uart_port *port, int flags)
948 pr_debug("CPM uart[%d]:config_port\n", port->line);
950 if (flags & UART_CONFIG_TYPE) {
951 port->type = PORT_CPM;
952 cpm_uart_request_port(port);
956 #if defined(CONFIG_CONSOLE_POLL) || defined(CONFIG_SERIAL_CPM_CONSOLE)
958 * Write a string to the serial port
959 * Note that this is called with interrupts already disabled
961 static void cpm_uart_early_write(struct uart_cpm_port *pinfo,
962 const char *string, u_int count, bool handle_linefeed)
965 cbd_t __iomem *bdp, *bdbase;
966 unsigned char *cpm_outp_addr;
968 /* Get the address of the host memory buffer.
971 bdbase = pinfo->tx_bd_base;
974 * Now, do each character. This is not as bad as it looks
975 * since this is a holding FIFO and not a transmitting FIFO.
976 * We could add the complexity of filling the entire transmit
977 * buffer, but we would just wait longer between accesses......
979 for (i = 0; i < count; i++, string++) {
980 /* Wait for transmitter fifo to empty.
981 * Ready indicates output is ready, and xmt is doing
982 * that, not that it is ready for us to send.
984 while ((in_be16(&bdp->cbd_sc) & BD_SC_READY) != 0)
987 /* Send the character out.
988 * If the buffer address is in the CPM DPRAM, don't
991 cpm_outp_addr = cpm2cpu_addr(in_be32(&bdp->cbd_bufaddr),
993 *cpm_outp_addr = *string;
995 out_be16(&bdp->cbd_datlen, 1);
996 setbits16(&bdp->cbd_sc, BD_SC_READY);
998 if (in_be16(&bdp->cbd_sc) & BD_SC_WRAP)
1003 /* if a LF, also do CR... */
1004 if (handle_linefeed && *string == 10) {
1005 while ((in_be16(&bdp->cbd_sc) & BD_SC_READY) != 0)
1008 cpm_outp_addr = cpm2cpu_addr(in_be32(&bdp->cbd_bufaddr),
1010 *cpm_outp_addr = 13;
1012 out_be16(&bdp->cbd_datlen, 1);
1013 setbits16(&bdp->cbd_sc, BD_SC_READY);
1015 if (in_be16(&bdp->cbd_sc) & BD_SC_WRAP)
1023 * Finally, Wait for transmitter & holding register to empty
1024 * and restore the IER
1026 while ((in_be16(&bdp->cbd_sc) & BD_SC_READY) != 0)
1029 pinfo->tx_cur = bdp;
1033 #ifdef CONFIG_CONSOLE_POLL
1034 /* Serial polling routines for writing and reading from the uart while
1035 * in an interrupt or debug context.
1038 #define GDB_BUF_SIZE 512 /* power of 2, please */
1040 static char poll_buf[GDB_BUF_SIZE];
1042 static int poll_chars;
1044 static int poll_wait_key(char *obuf, struct uart_cpm_port *pinfo)
1047 volatile cbd_t *bdp;
1050 /* Get the address of the host memory buffer.
1052 bdp = pinfo->rx_cur;
1053 if (bdp->cbd_sc & BD_SC_EMPTY)
1054 return NO_POLL_CHAR;
1056 /* If the buffer address is in the CPM DPRAM, don't
1059 cp = cpm2cpu_addr(bdp->cbd_bufaddr, pinfo);
1062 i = c = bdp->cbd_datlen;
1067 bdp->cbd_sc &= ~(BD_SC_BR | BD_SC_FR | BD_SC_PR | BD_SC_OV | BD_SC_ID);
1068 bdp->cbd_sc |= BD_SC_EMPTY;
1070 if (bdp->cbd_sc & BD_SC_WRAP)
1071 bdp = pinfo->rx_bd_base;
1074 pinfo->rx_cur = (cbd_t *)bdp;
1079 static int cpm_get_poll_char(struct uart_port *port)
1081 struct uart_cpm_port *pinfo =
1082 container_of(port, struct uart_cpm_port, port);
1084 if (!serial_polled) {
1088 if (poll_chars <= 0) {
1089 int ret = poll_wait_key(poll_buf, pinfo);
1091 if (ret == NO_POLL_CHAR)
1100 static void cpm_put_poll_char(struct uart_port *port,
1103 struct uart_cpm_port *pinfo =
1104 container_of(port, struct uart_cpm_port, port);
1108 cpm_uart_early_write(pinfo, ch, 1, false);
1110 #endif /* CONFIG_CONSOLE_POLL */
1112 static const struct uart_ops cpm_uart_pops = {
1113 .tx_empty = cpm_uart_tx_empty,
1114 .set_mctrl = cpm_uart_set_mctrl,
1115 .get_mctrl = cpm_uart_get_mctrl,
1116 .stop_tx = cpm_uart_stop_tx,
1117 .start_tx = cpm_uart_start_tx,
1118 .stop_rx = cpm_uart_stop_rx,
1119 .break_ctl = cpm_uart_break_ctl,
1120 .startup = cpm_uart_startup,
1121 .shutdown = cpm_uart_shutdown,
1122 .set_termios = cpm_uart_set_termios,
1123 .type = cpm_uart_type,
1124 .release_port = cpm_uart_release_port,
1125 .request_port = cpm_uart_request_port,
1126 .config_port = cpm_uart_config_port,
1127 .verify_port = cpm_uart_verify_port,
1128 #ifdef CONFIG_CONSOLE_POLL
1129 .poll_get_char = cpm_get_poll_char,
1130 .poll_put_char = cpm_put_poll_char,
1134 struct uart_cpm_port cpm_uart_ports[UART_NR];
1136 static int cpm_uart_init_port(struct device_node *np,
1137 struct uart_cpm_port *pinfo)
1140 void __iomem *mem, *pram;
1141 struct device *dev = pinfo->port.dev;
1146 data = of_get_property(np, "clock", NULL);
1148 struct clk *clk = clk_get(NULL, (const char*)data);
1153 data = of_get_property(np, "fsl,cpm-brg", &len);
1154 if (!data || len != 4) {
1155 printk(KERN_ERR "CPM UART %pOFn has no/invalid "
1156 "fsl,cpm-brg property.\n", np);
1162 data = of_get_property(np, "fsl,cpm-command", &len);
1163 if (!data || len != 4) {
1164 printk(KERN_ERR "CPM UART %pOFn has no/invalid "
1165 "fsl,cpm-command property.\n", np);
1168 pinfo->command = *data;
1170 mem = of_iomap(np, 0);
1174 if (of_device_is_compatible(np, "fsl,cpm1-scc-uart") ||
1175 of_device_is_compatible(np, "fsl,cpm2-scc-uart")) {
1177 pinfo->sccup = pram = cpm_uart_map_pram(pinfo, np);
1178 } else if (of_device_is_compatible(np, "fsl,cpm1-smc-uart") ||
1179 of_device_is_compatible(np, "fsl,cpm2-smc-uart")) {
1180 pinfo->flags |= FLAG_SMC;
1182 pinfo->smcup = pram = cpm_uart_map_pram(pinfo, np);
1193 pinfo->tx_nrfifos = TX_NUM_FIFO;
1194 pinfo->tx_fifosize = TX_BUF_SIZE;
1195 pinfo->rx_nrfifos = RX_NUM_FIFO;
1196 pinfo->rx_fifosize = RX_BUF_SIZE;
1198 pinfo->port.uartclk = ppc_proc_freq;
1199 pinfo->port.mapbase = (unsigned long)mem;
1200 pinfo->port.type = PORT_CPM;
1201 pinfo->port.ops = &cpm_uart_pops;
1202 pinfo->port.has_sysrq = IS_ENABLED(CONFIG_SERIAL_CPM_CONSOLE);
1203 pinfo->port.iotype = UPIO_MEM;
1204 pinfo->port.fifosize = pinfo->tx_nrfifos * pinfo->tx_fifosize;
1205 spin_lock_init(&pinfo->port.lock);
1207 pinfo->port.irq = irq_of_parse_and_map(np, 0);
1208 if (pinfo->port.irq == NO_IRQ) {
1213 for (i = 0; i < NUM_GPIOS; i++) {
1214 struct gpio_desc *gpiod;
1216 pinfo->gpios[i] = NULL;
1218 gpiod = devm_gpiod_get_index_optional(dev, NULL, i, GPIOD_ASIS);
1220 if (IS_ERR(gpiod)) {
1221 ret = PTR_ERR(gpiod);
1226 if (i == GPIO_RTS || i == GPIO_DTR)
1227 ret = gpiod_direction_output(gpiod, 0);
1229 ret = gpiod_direction_input(gpiod);
1231 pr_err("can't set direction for gpio #%d: %d\n",
1235 pinfo->gpios[i] = gpiod;
1239 #ifdef CONFIG_PPC_EARLY_DEBUG_CPM
1243 return cpm_uart_request_port(&pinfo->port);
1246 irq_dispose_mapping(pinfo->port.irq);
1248 cpm_uart_unmap_pram(pinfo, pram);
1254 #ifdef CONFIG_SERIAL_CPM_CONSOLE
1256 * Print a string to the serial port trying not to disturb
1257 * any possible real use of the port...
1259 * Note that this is called with interrupts already disabled
1261 static void cpm_uart_console_write(struct console *co, const char *s,
1264 struct uart_cpm_port *pinfo = &cpm_uart_ports[co->index];
1265 unsigned long flags;
1267 if (unlikely(oops_in_progress)) {
1268 local_irq_save(flags);
1269 cpm_uart_early_write(pinfo, s, count, true);
1270 local_irq_restore(flags);
1272 spin_lock_irqsave(&pinfo->port.lock, flags);
1273 cpm_uart_early_write(pinfo, s, count, true);
1274 spin_unlock_irqrestore(&pinfo->port.lock, flags);
1279 static int __init cpm_uart_console_setup(struct console *co, char *options)
1286 struct uart_cpm_port *pinfo;
1287 struct uart_port *port;
1289 struct device_node *np;
1292 if (co->index >= UART_NR) {
1293 printk(KERN_ERR "cpm_uart: console index %d too high\n",
1298 for_each_node_by_type(np, "serial") {
1299 if (!of_device_is_compatible(np, "fsl,cpm1-smc-uart") &&
1300 !of_device_is_compatible(np, "fsl,cpm1-scc-uart") &&
1301 !of_device_is_compatible(np, "fsl,cpm2-smc-uart") &&
1302 !of_device_is_compatible(np, "fsl,cpm2-scc-uart"))
1305 if (i++ == co->index)
1312 pinfo = &cpm_uart_ports[co->index];
1314 pinfo->flags |= FLAG_CONSOLE;
1315 port = &pinfo->port;
1317 ret = cpm_uart_init_port(np, pinfo);
1323 uart_parse_options(options, &baud, &parity, &bits, &flow);
1325 if ((baud = uart_baudrate()) == -1)
1329 if (IS_SMC(pinfo)) {
1330 out_be16(&pinfo->smcup->smc_brkcr, 0);
1331 cpm_line_cr_cmd(pinfo, CPM_CR_STOP_TX);
1332 clrbits8(&pinfo->smcp->smc_smcm, SMCM_RX | SMCM_TX);
1333 clrbits16(&pinfo->smcp->smc_smcmr, SMCMR_REN | SMCMR_TEN);
1335 out_be16(&pinfo->sccup->scc_brkcr, 0);
1336 cpm_line_cr_cmd(pinfo, CPM_CR_GRA_STOP_TX);
1337 clrbits16(&pinfo->sccp->scc_sccm, UART_SCCM_TX | UART_SCCM_RX);
1338 clrbits32(&pinfo->sccp->scc_gsmrl, SCC_GSMRL_ENR | SCC_GSMRL_ENT);
1341 ret = cpm_uart_allocbuf(pinfo, 1);
1346 cpm_uart_initbd(pinfo);
1349 cpm_uart_init_smc(pinfo);
1351 cpm_uart_init_scc(pinfo);
1353 uart_set_options(port, co, baud, parity, bits, flow);
1354 cpm_line_cr_cmd(pinfo, CPM_CR_RESTART_TX);
1359 static struct uart_driver cpm_reg;
1360 static struct console cpm_scc_uart_console = {
1362 .write = cpm_uart_console_write,
1363 .device = uart_console_device,
1364 .setup = cpm_uart_console_setup,
1365 .flags = CON_PRINTBUFFER,
1370 static int __init cpm_uart_console_init(void)
1373 register_console(&cpm_scc_uart_console);
1377 console_initcall(cpm_uart_console_init);
1379 #define CPM_UART_CONSOLE &cpm_scc_uart_console
1381 #define CPM_UART_CONSOLE NULL
1384 static struct uart_driver cpm_reg = {
1385 .owner = THIS_MODULE,
1386 .driver_name = "ttyCPM",
1387 .dev_name = "ttyCPM",
1388 .major = SERIAL_CPM_MAJOR,
1389 .minor = SERIAL_CPM_MINOR,
1390 .cons = CPM_UART_CONSOLE,
1394 static int probe_index;
1396 static int cpm_uart_probe(struct platform_device *ofdev)
1398 int index = probe_index++;
1399 struct uart_cpm_port *pinfo = &cpm_uart_ports[index];
1402 pinfo->port.line = index;
1404 if (index >= UART_NR)
1407 platform_set_drvdata(ofdev, pinfo);
1409 /* initialize the device pointer for the port */
1410 pinfo->port.dev = &ofdev->dev;
1412 ret = cpm_uart_init_port(ofdev->dev.of_node, pinfo);
1416 return uart_add_one_port(&cpm_reg, &pinfo->port);
1419 static int cpm_uart_remove(struct platform_device *ofdev)
1421 struct uart_cpm_port *pinfo = platform_get_drvdata(ofdev);
1422 return uart_remove_one_port(&cpm_reg, &pinfo->port);
1425 static const struct of_device_id cpm_uart_match[] = {
1427 .compatible = "fsl,cpm1-smc-uart",
1430 .compatible = "fsl,cpm1-scc-uart",
1433 .compatible = "fsl,cpm2-smc-uart",
1436 .compatible = "fsl,cpm2-scc-uart",
1440 MODULE_DEVICE_TABLE(of, cpm_uart_match);
1442 static struct platform_driver cpm_uart_driver = {
1445 .of_match_table = cpm_uart_match,
1447 .probe = cpm_uart_probe,
1448 .remove = cpm_uart_remove,
1451 static int __init cpm_uart_init(void)
1453 int ret = uart_register_driver(&cpm_reg);
1457 ret = platform_driver_register(&cpm_uart_driver);
1459 uart_unregister_driver(&cpm_reg);
1464 static void __exit cpm_uart_exit(void)
1466 platform_driver_unregister(&cpm_uart_driver);
1467 uart_unregister_driver(&cpm_reg);
1470 module_init(cpm_uart_init);
1471 module_exit(cpm_uart_exit);
1473 MODULE_AUTHOR("Kumar Gala/Antoniou Pantelis");
1474 MODULE_DESCRIPTION("CPM SCC/SMC port driver $Revision: 0.01 $");
1475 MODULE_LICENSE("GPL");
1476 MODULE_ALIAS_CHARDEV(SERIAL_CPM_MAJOR, SERIAL_CPM_MINOR);