[linux-block.git] / drivers / tty / serial / apbuart.c

// SPDX-License-Identifier: GPL-2.0
/*
 *  Driver for GRLIB serial ports (APBUART)
 *
 *  Based on linux/drivers/serial/amba.c
 *
 *  Copyright (C) 2000 Deep Blue Solutions Ltd.
 *  Copyright (C) 2003 Konrad Eisele <eiselekd@web.de>
 *  Copyright (C) 2006 Daniel Hellstrom <daniel@gaisler.com>, Aeroflex Gaisler AB
 *  Copyright (C) 2008 Gilead Kutnick <kutnickg@zin-tech.com>
 *  Copyright (C) 2009 Kristoffer Glembo <kristoffer@gaisler.com>, Aeroflex Gaisler AB
 */

#if defined(CONFIG_SERIAL_GRLIB_GAISLER_APBUART_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
#define SUPPORT_SYSRQ
#endif

#include <linux/module.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>
#include <linux/ioport.h>
#include <linux/init.h>
#include <linux/serial.h>
#include <linux/console.h>
#include <linux/sysrq.h>
#include <linux/kthread.h>
#include <linux/device.h>
#include <linux/of.h>
#include <linux/of_device.h>
#include <linux/of_platform.h>
#include <linux/of_irq.h>
#include <linux/platform_device.h>
#include <linux/io.h>
#include <linux/serial_core.h>
#include <asm/irq.h>

#include "apbuart.h"

#define SERIAL_APBUART_MAJOR	TTY_MAJOR
#define SERIAL_APBUART_MINOR	64
#define UART_DUMMY_RSR_RX	0x8000	/* for ignore all read */

static void apbuart_tx_chars(struct uart_port *port);

static void apbuart_stop_tx(struct uart_port *port)
{
	unsigned int cr;

	cr = UART_GET_CTRL(port);
	cr &= ~UART_CTRL_TI;
	UART_PUT_CTRL(port, cr);
}

static void apbuart_start_tx(struct uart_port *port)
{
	unsigned int cr;

	cr = UART_GET_CTRL(port);
	cr |= UART_CTRL_TI;
	UART_PUT_CTRL(port, cr);

	if (UART_GET_STATUS(port) & UART_STATUS_THE)
		apbuart_tx_chars(port);
}

static void apbuart_stop_rx(struct uart_port *port)
{
	unsigned int cr;

	cr = UART_GET_CTRL(port);
	cr &= ~(UART_CTRL_RI);
	UART_PUT_CTRL(port, cr);
}

static void apbuart_rx_chars(struct uart_port *port)
{
	unsigned int status, ch, rsr, flag;
	unsigned int max_chars = port->fifosize;

	status = UART_GET_STATUS(port);

	while (UART_RX_DATA(status) && (max_chars--)) {

		ch = UART_GET_CHAR(port);
		flag = TTY_NORMAL;

		port->icount.rx++;

		rsr = UART_GET_STATUS(port) | UART_DUMMY_RSR_RX;
		UART_PUT_STATUS(port, 0);
		if (rsr & UART_STATUS_ERR) {

			if (rsr & UART_STATUS_BR) {
				rsr &= ~(UART_STATUS_FE | UART_STATUS_PE);
				port->icount.brk++;
				if (uart_handle_break(port))
					goto ignore_char;
			} else if (rsr & UART_STATUS_PE) {
				port->icount.parity++;
			} else if (rsr & UART_STATUS_FE) {
				port->icount.frame++;
			}
			if (rsr & UART_STATUS_OE)
				port->icount.overrun++;

			rsr &= port->read_status_mask;

			if (rsr & UART_STATUS_PE)
				flag = TTY_PARITY;
			else if (rsr & UART_STATUS_FE)
				flag = TTY_FRAME;
		}

		if (uart_handle_sysrq_char(port, ch))
			goto ignore_char;

		uart_insert_char(port, rsr, UART_STATUS_OE, ch, flag);


	      ignore_char:
		status = UART_GET_STATUS(port);
	}

	spin_unlock(&port->lock);
	tty_flip_buffer_push(&port->state->port);
	spin_lock(&port->lock);
}

static void apbuart_tx_chars(struct uart_port *port)
{
	struct circ_buf *xmit = &port->state->xmit;
	int count;

	if (port->x_char) {
		UART_PUT_CHAR(port, port->x_char);
		port->icount.tx++;
		port->x_char = 0;
		return;
	}

	if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
		apbuart_stop_tx(port);
		return;
	}

	/* amba: fill FIFO */
	count = port->fifosize >> 1;
	do {
		UART_PUT_CHAR(port, xmit->buf[xmit->tail]);
		xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
		port->icount.tx++;
		if (uart_circ_empty(xmit))
			break;
	} while (--count > 0);

	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
		uart_write_wakeup(port);

	if (uart_circ_empty(xmit))
		apbuart_stop_tx(port);
}

static irqreturn_t apbuart_int(int irq, void *dev_id)
{
	struct uart_port *port = dev_id;
	unsigned int status;

	spin_lock(&port->lock);

	status = UART_GET_STATUS(port);
	if (status & UART_STATUS_DR)
		apbuart_rx_chars(port);
	if (status & UART_STATUS_THE)
		apbuart_tx_chars(port);

	spin_unlock(&port->lock);

	return IRQ_HANDLED;
}

static unsigned int apbuart_tx_empty(struct uart_port *port)
{
	unsigned int status = UART_GET_STATUS(port);
	return status & UART_STATUS_THE ? TIOCSER_TEMT : 0;
}

static unsigned int apbuart_get_mctrl(struct uart_port *port)
{
	/* The GRLIB APBUART handles flow control in hardware */
	return TIOCM_CAR | TIOCM_DSR | TIOCM_CTS;
}

static void apbuart_set_mctrl(struct uart_port *port, unsigned int mctrl)
{
	/* The GRLIB APBUART handles flow control in hardware */
}

static void apbuart_break_ctl(struct uart_port *port, int break_state)
{
	/* We don't support sending break */
}

static int apbuart_startup(struct uart_port *port)
{
	int retval;
	unsigned int cr;

	/* Allocate the IRQ */
	retval = request_irq(port->irq, apbuart_int, 0, "apbuart", port);
	if (retval)
		return retval;

	/* Finally, enable interrupts */
	cr = UART_GET_CTRL(port);
	UART_PUT_CTRL(port,
		      cr | UART_CTRL_RE | UART_CTRL_TE |
		      UART_CTRL_RI | UART_CTRL_TI);

	return 0;
}

static void apbuart_shutdown(struct uart_port *port)
{
	unsigned int cr;

	/* disable all interrupts, disable the port */
	cr = UART_GET_CTRL(port);
	UART_PUT_CTRL(port,
		      cr & ~(UART_CTRL_RE | UART_CTRL_TE |
			     UART_CTRL_RI | UART_CTRL_TI));

	/* Free the interrupt */
	free_irq(port->irq, port);
}

static void apbuart_set_termios(struct uart_port *port,
				struct ktermios *termios, struct ktermios *old)
{
	unsigned int cr;
	unsigned long flags;
	unsigned int baud, quot;

	/* Ask the core to calculate the divisor for us. */
	baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk / 16);
	if (baud == 0)
		panic("invalid baudrate %i\n", port->uartclk / 16);

	/* uart_get_divisor calc a *16 uart freq, apbuart is *8 */
	quot = (uart_get_divisor(port, baud)) * 2;
	cr = UART_GET_CTRL(port);
	cr &= ~(UART_CTRL_PE | UART_CTRL_PS);

	if (termios->c_cflag & PARENB) {
		cr |= UART_CTRL_PE;
		if ((termios->c_cflag & PARODD))
			cr |= UART_CTRL_PS;
	}

	/* Enable flow control. */
	if (termios->c_cflag & CRTSCTS)
		cr |= UART_CTRL_FL;

	spin_lock_irqsave(&port->lock, flags);

	/* Update the per-port timeout. */
	uart_update_timeout(port, termios->c_cflag, baud);

	port->read_status_mask = UART_STATUS_OE;
	if (termios->c_iflag & INPCK)
		port->read_status_mask |= UART_STATUS_FE | UART_STATUS_PE;

	/* Characters to ignore */
	port->ignore_status_mask = 0;
	if (termios->c_iflag & IGNPAR)
		port->ignore_status_mask |= UART_STATUS_FE | UART_STATUS_PE;

	/* Ignore all characters if CREAD is not set. */
	if ((termios->c_cflag & CREAD) == 0)
		port->ignore_status_mask |= UART_DUMMY_RSR_RX;

	/* Set baud rate */
	quot -= 1;
	UART_PUT_SCAL(port, quot);
	UART_PUT_CTRL(port, cr);

	spin_unlock_irqrestore(&port->lock, flags);
}

static const char *apbuart_type(struct uart_port *port)
{
	return port->type == PORT_APBUART ? "GRLIB/APBUART" : NULL;
}

static void apbuart_release_port(struct uart_port *port)
{
	release_mem_region(port->mapbase, 0x100);
}

static int apbuart_request_port(struct uart_port *port)
{
	return request_mem_region(port->mapbase, 0x100, "grlib-apbuart")
	    != NULL ? 0 : -EBUSY;
	return 0;
}

/* Configure/autoconfigure the port */
static void apbuart_config_port(struct uart_port *port, int flags)
{
	if (flags & UART_CONFIG_TYPE) {
		port->type = PORT_APBUART;
		apbuart_request_port(port);
	}
}

/* Verify the new serial_struct (for TIOCSSERIAL) */
static int apbuart_verify_port(struct uart_port *port,
			       struct serial_struct *ser)
{
	int ret = 0;
	if (ser->type != PORT_UNKNOWN && ser->type != PORT_APBUART)
		ret = -EINVAL;
	if (ser->irq < 0 || ser->irq >= NR_IRQS)
		ret = -EINVAL;
	if (ser->baud_base < 9600)
		ret = -EINVAL;
	return ret;
}

static const struct uart_ops grlib_apbuart_ops = {
	.tx_empty = apbuart_tx_empty,
	.set_mctrl = apbuart_set_mctrl,
	.get_mctrl = apbuart_get_mctrl,
	.stop_tx = apbuart_stop_tx,
	.start_tx = apbuart_start_tx,
	.stop_rx = apbuart_stop_rx,
	.break_ctl = apbuart_break_ctl,
	.startup = apbuart_startup,
	.shutdown = apbuart_shutdown,
	.set_termios = apbuart_set_termios,
	.type = apbuart_type,
	.release_port = apbuart_release_port,
	.request_port = apbuart_request_port,
	.config_port = apbuart_config_port,
	.verify_port = apbuart_verify_port,
};

static struct uart_port grlib_apbuart_ports[UART_NR];
static struct device_node *grlib_apbuart_nodes[UART_NR];

static int apbuart_scan_fifo_size(struct uart_port *port, int portnumber)
{
	int ctrl, loop = 0;
	int status;
	int fifosize;
	unsigned long flags;

	ctrl = UART_GET_CTRL(port);

	/*
	 * Enable the transceiver and wait for it to be ready to send data.
	 * Clear interrupts so that this process will not be externally
	 * interrupted in the middle (which can cause the transceiver to
	 * drain prematurely).
	 */

	local_irq_save(flags);

	UART_PUT_CTRL(port, ctrl | UART_CTRL_TE);

	while (!UART_TX_READY(UART_GET_STATUS(port)))
		loop++;

	/*
	 * Disable the transceiver so data isn't actually sent during the
	 * actual test.
	 */

	UART_PUT_CTRL(port, ctrl & ~(UART_CTRL_TE));

	fifosize = 1;
	UART_PUT_CHAR(port, 0);

	/*
	 * So long as transmitting a character increments the tranceivier FIFO
	 * length the FIFO must be at least that big. These bytes will
	 * automatically drain off of the FIFO.
	 */

	status = UART_GET_STATUS(port);
	while (((status >> 20) & 0x3F) == fifosize) {
		fifosize++;
		UART_PUT_CHAR(port, 0);
		status = UART_GET_STATUS(port);
	}

	fifosize--;

	UART_PUT_CTRL(port, ctrl);
	local_irq_restore(flags);

	if (fifosize == 0)
		fifosize = 1;

	return fifosize;
}

static void apbuart_flush_fifo(struct uart_port *port)
{
	int i;

	for (i = 0; i < port->fifosize; i++)
		UART_GET_CHAR(port);
}


/* ======================================================================== */
/* Console driver, if enabled                                               */
/* ======================================================================== */

#ifdef CONFIG_SERIAL_GRLIB_GAISLER_APBUART_CONSOLE

static void apbuart_console_putchar(struct uart_port *port, int ch)
{
	unsigned int status;
	do {
		status = UART_GET_STATUS(port);
	} while (!UART_TX_READY(status));
	UART_PUT_CHAR(port, ch);
}

static void
apbuart_console_write(struct console *co, const char *s, unsigned int count)
{
	struct uart_port *port = &grlib_apbuart_ports[co->index];
	unsigned int status, old_cr, new_cr;

	/* First save the CR then disable the interrupts */
	old_cr = UART_GET_CTRL(port);
	new_cr = old_cr & ~(UART_CTRL_RI | UART_CTRL_TI);
	UART_PUT_CTRL(port, new_cr);

	uart_console_write(port, s, count, apbuart_console_putchar);

	/*
	 *      Finally, wait for transmitter to become empty
	 *      and restore the TCR
	 */
	do {
		status = UART_GET_STATUS(port);
	} while (!UART_TX_READY(status));
	UART_PUT_CTRL(port, old_cr);
}

static void __init
apbuart_console_get_options(struct uart_port *port, int *baud,
			    int *parity, int *bits)
{
	if (UART_GET_CTRL(port) & (UART_CTRL_RE | UART_CTRL_TE)) {

		unsigned int quot, status;
		status = UART_GET_STATUS(port);

		*parity = 'n';
		if (status & UART_CTRL_PE) {
			if ((status & UART_CTRL_PS) == 0)
				*parity = 'e';
			else
				*parity = 'o';
		}

		*bits = 8;
		quot = UART_GET_SCAL(port) / 8;
		*baud = port->uartclk / (16 * (quot + 1));
	}
}

static int __init apbuart_console_setup(struct console *co, char *options)
{
	struct uart_port *port;
	int baud = 38400;
	int bits = 8;
	int parity = 'n';
	int flow = 'n';

	pr_debug("apbuart_console_setup co=%p, co->index=%i, options=%s\n",
		 co, co->index, options);

	/*
	 * Check whether an invalid uart number has been specified, and
	 * if so, search for the first available port that does have
	 * console support.
	 */
	if (co->index >= grlib_apbuart_port_nr)
		co->index = 0;

	port = &grlib_apbuart_ports[co->index];

	spin_lock_init(&port->lock);

	if (options)
		uart_parse_options(options, &baud, &parity, &bits, &flow);
	else
		apbuart_console_get_options(port, &baud, &parity, &bits);

	return uart_set_options(port, co, baud, parity, bits, flow);
}

static struct uart_driver grlib_apbuart_driver;

static struct console grlib_apbuart_console = {
	.name = "ttyS",
	.write = apbuart_console_write,
	.device = uart_console_device,
	.setup = apbuart_console_setup,
	.flags = CON_PRINTBUFFER,
	.index = -1,
	.data = &grlib_apbuart_driver,
};


static int grlib_apbuart_configure(void);

static int __init apbuart_console_init(void)
{
	if (grlib_apbuart_configure())
		return -ENODEV;
	register_console(&grlib_apbuart_console);
	return 0;
}

console_initcall(apbuart_console_init);

#define APBUART_CONSOLE	(&grlib_apbuart_console)
#else
#define APBUART_CONSOLE	NULL
#endif

static struct uart_driver grlib_apbuart_driver = {
	.owner = THIS_MODULE,
	.driver_name = "serial",
	.dev_name = "ttyS",
	.major = SERIAL_APBUART_MAJOR,
	.minor = SERIAL_APBUART_MINOR,
	.nr = UART_NR,
	.cons = APBUART_CONSOLE,
};


/* ======================================================================== */
/* OF Platform Driver                                                       */
/* ======================================================================== */

static int apbuart_probe(struct platform_device *op)
{
	int i;
	struct uart_port *port = NULL;

	for (i = 0; i < grlib_apbuart_port_nr; i++) {
		if (op->dev.of_node == grlib_apbuart_nodes[i])
			break;
	}

	port = &grlib_apbuart_ports[i];
	port->dev = &op->dev;
	port->irq = op->archdata.irqs[0];

	uart_add_one_port(&grlib_apbuart_driver, (struct uart_port *) port);

	apbuart_flush_fifo((struct uart_port *) port);

	printk(KERN_INFO "grlib-apbuart at 0x%llx, irq %d\n",
	       (unsigned long long) port->mapbase, port->irq);
	return 0;
}

static const struct of_device_id apbuart_match[] = {
	{
	 .name = "GAISLER_APBUART",
	 },
	{
	 .name = "01_00c",
	 },
	{},
};
MODULE_DEVICE_TABLE(of, apbuart_match);

static struct platform_driver grlib_apbuart_of_driver = {
	.probe = apbuart_probe,
	.driver = {
		.name = "grlib-apbuart",
		.of_match_table = apbuart_match,
	},
};


static int __init grlib_apbuart_configure(void)
{
	struct device_node *np;
	int line = 0;

	for_each_matching_node(np, apbuart_match) {
		const int *ampopts;
		const u32 *freq_hz;
		const struct amba_prom_registers *regs;
		struct uart_port *port;
		unsigned long addr;

		ampopts = of_get_property(np, "ampopts", NULL);
		if (ampopts && (*ampopts == 0))
			continue; /* Ignore if used by another OS instance */
		regs = of_get_property(np, "reg", NULL);
		/* Frequency of APB Bus is frequency of UART */
		freq_hz = of_get_property(np, "freq", NULL);

		if (!regs || !freq_hz || (*freq_hz == 0))
			continue;

		grlib_apbuart_nodes[line] = np;

		addr = regs->phys_addr;

		port = &grlib_apbuart_ports[line];

		port->mapbase = addr;
		port->membase = ioremap(addr, sizeof(struct grlib_apbuart_regs_map));
		port->irq = 0;
		port->iotype = UPIO_MEM;
		port->ops = &grlib_apbuart_ops;
		port->flags = UPF_BOOT_AUTOCONF;
		port->line = line;
		port->uartclk = *freq_hz;
		port->fifosize = apbuart_scan_fifo_size((struct uart_port *) port, line);
		line++;

		/* We support maximum UART_NR uarts ... */
		if (line == UART_NR)
			break;
	}

	grlib_apbuart_driver.nr = grlib_apbuart_port_nr = line;
	return line ? 0 : -ENODEV;
}

static int __init grlib_apbuart_init(void)
{
	int ret;

	/* Find all APBUARTS in device the tree and initialize their ports */
	ret = grlib_apbuart_configure();
	if (ret)
		return ret;

	printk(KERN_INFO "Serial: GRLIB APBUART driver\n");

	ret = uart_register_driver(&grlib_apbuart_driver);

	if (ret) {
		printk(KERN_ERR "%s: uart_register_driver failed (%i)\n",
		       __FILE__, ret);
		return ret;
	}

	ret = platform_driver_register(&grlib_apbuart_of_driver);
	if (ret) {
		printk(KERN_ERR
		       "%s: platform_driver_register failed (%i)\n",
		       __FILE__, ret);
		uart_unregister_driver(&grlib_apbuart_driver);
		return ret;
	}

	return ret;
}

static void __exit grlib_apbuart_exit(void)
{
	int i;

	for (i = 0; i < grlib_apbuart_port_nr; i++)
		uart_remove_one_port(&grlib_apbuart_driver,
				     &grlib_apbuart_ports[i]);

	uart_unregister_driver(&grlib_apbuart_driver);
	platform_driver_unregister(&grlib_apbuart_of_driver);
}

module_init(grlib_apbuart_init);
module_exit(grlib_apbuart_exit);

MODULE_AUTHOR("Aeroflex Gaisler AB");
MODULE_DESCRIPTION("GRLIB APBUART serial driver");
MODULE_VERSION("2.1");
MODULE_LICENSE("GPL");
Commit	Line	Data
e3b3d0f5	1	// SPDX-License-Identifier: GPL-2.0
d4ac42a5 KG	2	/*
	3	* Driver for GRLIB serial ports (APBUART)
	4	*
	5	* Based on linux/drivers/serial/amba.c
	6	*
	7	* Copyright (C) 2000 Deep Blue Solutions Ltd.
	8	* Copyright (C) 2003 Konrad Eisele <eiselekd@web.de>
	9	* Copyright (C) 2006 Daniel Hellstrom <daniel@gaisler.com>, Aeroflex Gaisler AB
	10	* Copyright (C) 2008 Gilead Kutnick <kutnickg@zin-tech.com>
	11	* Copyright (C) 2009 Kristoffer Glembo <kristoffer@gaisler.com>, Aeroflex Gaisler AB
	12	*/
	13
	14	#if defined(CONFIG_SERIAL_GRLIB_GAISLER_APBUART_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
	15	#define SUPPORT_SYSRQ
	16	#endif
	17
	18	#include <linux/module.h>
	19	#include <linux/tty.h>
ee160a38	20	#include <linux/tty_flip.h>
d4ac42a5 KG	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/kthread.h>
	27	#include <linux/device.h>
	28	#include <linux/of.h>
	29	#include <linux/of_device.h>
ddaf1b27	30	#include <linux/of_platform.h>
f28f3313	31	#include <linux/of_irq.h>
d4ac42a5 KG	32	#include <linux/platform_device.h>
	33	#include <linux/io.h>
	34	#include <linux/serial_core.h>
	35	#include <asm/irq.h>
d4ac42a5 KG	36
	37	#include "apbuart.h"
	38
	39	#define SERIAL_APBUART_MAJOR TTY_MAJOR
	40	#define SERIAL_APBUART_MINOR 64
	41	#define UART_DUMMY_RSR_RX 0x8000 /* for ignore all read */
	42
	43	static void apbuart_tx_chars(struct uart_port *port);
	44
	45	static void apbuart_stop_tx(struct uart_port *port)
	46	{
	47	unsigned int cr;
	48
	49	cr = UART_GET_CTRL(port);
	50	cr &= ~UART_CTRL_TI;
	51	UART_PUT_CTRL(port, cr);
	52	}
	53
	54	static void apbuart_start_tx(struct uart_port *port)
	55	{
	56	unsigned int cr;
	57
	58	cr = UART_GET_CTRL(port);
	59	cr \|= UART_CTRL_TI;
	60	UART_PUT_CTRL(port, cr);
	61
	62	if (UART_GET_STATUS(port) & UART_STATUS_THE)
	63	apbuart_tx_chars(port);
	64	}
	65
	66	static void apbuart_stop_rx(struct uart_port *port)
	67	{
	68	unsigned int cr;
	69
	70	cr = UART_GET_CTRL(port);
	71	cr &= ~(UART_CTRL_RI);
	72	UART_PUT_CTRL(port, cr);
	73	}
	74
d4ac42a5 KG	75	static void apbuart_rx_chars(struct uart_port *port)
d4ac42a5 KG	76	{
d4ac42a5 KG	77	unsigned int status, ch, rsr, flag;
	78	unsigned int max_chars = port->fifosize;
	79
	80	status = UART_GET_STATUS(port);
	81
	82	while (UART_RX_DATA(status) && (max_chars--)) {
	83
	84	ch = UART_GET_CHAR(port);
	85	flag = TTY_NORMAL;
	86
	87	port->icount.rx++;
	88
	89	rsr = UART_GET_STATUS(port) \| UART_DUMMY_RSR_RX;
	90	UART_PUT_STATUS(port, 0);
	91	if (rsr & UART_STATUS_ERR) {
	92
	93	if (rsr & UART_STATUS_BR) {
	94	rsr &= ~(UART_STATUS_FE \| UART_STATUS_PE);
	95	port->icount.brk++;
	96	if (uart_handle_break(port))
	97	goto ignore_char;
	98	} else if (rsr & UART_STATUS_PE) {
	99	port->icount.parity++;
	100	} else if (rsr & UART_STATUS_FE) {
	101	port->icount.frame++;
	102	}
	103	if (rsr & UART_STATUS_OE)
	104	port->icount.overrun++;
	105
	106	rsr &= port->read_status_mask;
	107
	108	if (rsr & UART_STATUS_PE)
	109	flag = TTY_PARITY;
	110	else if (rsr & UART_STATUS_FE)
	111	flag = TTY_FRAME;
	112	}
	113
	114	if (uart_handle_sysrq_char(port, ch))
	115	goto ignore_char;
	116
	117	uart_insert_char(port, rsr, UART_STATUS_OE, ch, flag);
	118
	119
	120	ignore_char:
	121	status = UART_GET_STATUS(port);
	122	}
	123
78d34d75	124	spin_unlock(&port->lock);
2e124b4a	125	tty_flip_buffer_push(&port->state->port);
78d34d75	126	spin_lock(&port->lock);
d4ac42a5 KG	127	}
	128
	129	static void apbuart_tx_chars(struct uart_port *port)
	130	{
	131	struct circ_buf *xmit = &port->state->xmit;
	132	int count;
	133
	134	if (port->x_char) {
	135	UART_PUT_CHAR(port, port->x_char);
	136	port->icount.tx++;
	137	port->x_char = 0;
	138	return;
	139	}
	140
	141	if (uart_circ_empty(xmit) \|\| uart_tx_stopped(port)) {
	142	apbuart_stop_tx(port);
	143	return;
	144	}
	145
	146	/* amba: fill FIFO */
	147	count = port->fifosize >> 1;
	148	do {
	149	UART_PUT_CHAR(port, xmit->buf[xmit->tail]);
	150	xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
	151	port->icount.tx++;
	152	if (uart_circ_empty(xmit))
	153	break;
	154	} while (--count > 0);
	155
	156	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
	157	uart_write_wakeup(port);
	158
	159	if (uart_circ_empty(xmit))
	160	apbuart_stop_tx(port);
	161	}
	162
	163	static irqreturn_t apbuart_int(int irq, void *dev_id)
	164	{
	165	struct uart_port *port = dev_id;
	166	unsigned int status;
	167
	168	spin_lock(&port->lock);
	169
	170	status = UART_GET_STATUS(port);
	171	if (status & UART_STATUS_DR)
	172	apbuart_rx_chars(port);
	173	if (status & UART_STATUS_THE)
	174	apbuart_tx_chars(port);
	175
	176	spin_unlock(&port->lock);
	177
	178	return IRQ_HANDLED;
	179	}
	180
	181	static unsigned int apbuart_tx_empty(struct uart_port *port)
	182	{
	183	unsigned int status = UART_GET_STATUS(port);
	184	return status & UART_STATUS_THE ? TIOCSER_TEMT : 0;
	185	}
	186
	187	static unsigned int apbuart_get_mctrl(struct uart_port *port)
	188	{
	189	/* The GRLIB APBUART handles flow control in hardware */
	190	return TIOCM_CAR \| TIOCM_DSR \| TIOCM_CTS;
191	}
192
193	static void apbuart_set_mctrl(struct uart_port *port, unsigned int mctrl)
194	{
195	/* The GRLIB APBUART handles flow control in hardware */
196	}
197
198	static void apbuart_break_ctl(struct uart_port *port, int break_state)
199	{
200	/* We don't support sending break */
201	}
202
203	static int apbuart_startup(struct uart_port *port)
204	{
205	int retval;
206	unsigned int cr;
207
208	/* Allocate the IRQ */
209	retval = request_irq(port->irq, apbuart_int, 0, "apbuart", port);
210	if (retval)
211	return retval;
212
213	/* Finally, enable interrupts */
214	cr = UART_GET_CTRL(port);
215	UART_PUT_CTRL(port,
216	cr \| UART_CTRL_RE \| UART_CTRL_TE \|
217	UART_CTRL_RI \| UART_CTRL_TI);
218
219	return 0;
220	}
221
222	static void apbuart_shutdown(struct uart_port *port)
223	{
224	unsigned int cr;
225
226	/* disable all interrupts, disable the port */
227	cr = UART_GET_CTRL(port);
228	UART_PUT_CTRL(port,
229	cr & ~(UART_CTRL_RE \| UART_CTRL_TE \|
230	UART_CTRL_RI \| UART_CTRL_TI));
231
232	/* Free the interrupt */
233	free_irq(port->irq, port);
234	}
235
236	static void apbuart_set_termios(struct uart_port *port,
237	struct ktermios termios, struct ktermios old)
238	{
239	unsigned int cr;
240	unsigned long flags;
241	unsigned int baud, quot;
242
243	/* Ask the core to calculate the divisor for us. */
244	baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk / 16);
245	if (baud == 0)
246	panic("invalid baudrate %i\n", port->uartclk / 16);
247
248	/* uart_get_divisor calc a 16 uart freq, apbuart is 8 */
249	quot = (uart_get_divisor(port, baud)) * 2;
250	cr = UART_GET_CTRL(port);
251	cr &= ~(UART_CTRL_PE \| UART_CTRL_PS);
252
253	if (termios->c_cflag & PARENB) {
254	cr \|= UART_CTRL_PE;
255	if ((termios->c_cflag & PARODD))
256	cr \|= UART_CTRL_PS;
257	}
258
259	/* Enable flow control. */
260	if (termios->c_cflag & CRTSCTS)
261	cr \|= UART_CTRL_FL;
262
263	spin_lock_irqsave(&port->lock, flags);
264
265	/* Update the per-port timeout. */
266	uart_update_timeout(port, termios->c_cflag, baud);
267
268	port->read_status_mask = UART_STATUS_OE;
269	if (termios->c_iflag & INPCK)
270	port->read_status_mask \|= UART_STATUS_FE \| UART_STATUS_PE;
271
272	/* Characters to ignore */
273	port->ignore_status_mask = 0;
274	if (termios->c_iflag & IGNPAR)
275	port->ignore_status_mask \|= UART_STATUS_FE \| UART_STATUS_PE;
276
277	/* Ignore all characters if CREAD is not set. */
278	if ((termios->c_cflag & CREAD) == 0)
279	port->ignore_status_mask \|= UART_DUMMY_RSR_RX;
280
281	/* Set baud rate */
282	quot -= 1;
283	UART_PUT_SCAL(port, quot);
284	UART_PUT_CTRL(port, cr);
285
286	spin_unlock_irqrestore(&port->lock, flags);
287	}
288
289	static const char apbuart_type(struct uart_port port)
290	{
291	return port->type == PORT_APBUART ? "GRLIB/APBUART" : NULL;
292	}
293
294	static void apbuart_release_port(struct uart_port *port)
295	{
296	release_mem_region(port->mapbase, 0x100);
297	}
298
299	static int apbuart_request_port(struct uart_port *port)
300	{
301	return request_mem_region(port->mapbase, 0x100, "grlib-apbuart")
302	!= NULL ? 0 : -EBUSY;
303	return 0;
304	}
305
306	/* Configure/autoconfigure the port */
307	static void apbuart_config_port(struct uart_port *port, int flags)
308	{
309	if (flags & UART_CONFIG_TYPE) {
310	port->type = PORT_APBUART;
311	apbuart_request_port(port);
312	}
313	}
314
315	/* Verify the new serial_struct (for TIOCSSERIAL) */
316	static int apbuart_verify_port(struct uart_port *port,
317	struct serial_struct *ser)
318	{
319	int ret = 0;
320	if (ser->type != PORT_UNKNOWN && ser->type != PORT_APBUART)
321	ret = -EINVAL;
322	if (ser->irq < 0 \|\| ser->irq >= NR_IRQS)
323	ret = -EINVAL;
324	if (ser->baud_base < 9600)
325	ret = -EINVAL;
326	return ret;
327	}
328
57495265	329	static const struct uart_ops grlib_apbuart_ops = {
d4ac42a5 KG	330	.tx_empty = apbuart_tx_empty,
	331	.set_mctrl = apbuart_set_mctrl,
	332	.get_mctrl = apbuart_get_mctrl,
	333	.stop_tx = apbuart_stop_tx,
	334	.start_tx = apbuart_start_tx,
	335	.stop_rx = apbuart_stop_rx,
d4ac42a5 KG	336	.break_ctl = apbuart_break_ctl,
	337	.startup = apbuart_startup,
	338	.shutdown = apbuart_shutdown,
	339	.set_termios = apbuart_set_termios,
	340	.type = apbuart_type,
	341	.release_port = apbuart_release_port,
	342	.request_port = apbuart_request_port,
	343	.config_port = apbuart_config_port,
	344	.verify_port = apbuart_verify_port,
	345	};
	346
	347	static struct uart_port grlib_apbuart_ports[UART_NR];
	348	static struct device_node *grlib_apbuart_nodes[UART_NR];
	349
	350	static int apbuart_scan_fifo_size(struct uart_port *port, int portnumber)
	351	{
	352	int ctrl, loop = 0;
	353	int status;
	354	int fifosize;
	355	unsigned long flags;
	356
	357	ctrl = UART_GET_CTRL(port);
	358
	359	/*
	360	* Enable the transceiver and wait for it to be ready to send data.
	361	* Clear interrupts so that this process will not be externally
	362	* interrupted in the middle (which can cause the transceiver to
	363	* drain prematurely).
	364	*/
	365
	366	local_irq_save(flags);
	367
	368	UART_PUT_CTRL(port, ctrl \| UART_CTRL_TE);
	369
	370	while (!UART_TX_READY(UART_GET_STATUS(port)))
	371	loop++;
	372
	373	/*
	374	* Disable the transceiver so data isn't actually sent during the
	375	* actual test.
	376	*/
	377
	378	UART_PUT_CTRL(port, ctrl & ~(UART_CTRL_TE));
	379
	380	fifosize = 1;
	381	UART_PUT_CHAR(port, 0);
	382
	383	/*
	384	* So long as transmitting a character increments the tranceivier FIFO
	385	* length the FIFO must be at least that big. These bytes will
	386	* automatically drain off of the FIFO.
	387	*/
	388
	389	status = UART_GET_STATUS(port);
	390	while (((status >> 20) & 0x3F) == fifosize) {
	391	fifosize++;
	392	UART_PUT_CHAR(port, 0);
	393	status = UART_GET_STATUS(port);
	394	}
	395
	396	fifosize--;
	397
	398	UART_PUT_CTRL(port, ctrl);
	399	local_irq_restore(flags);
400
401	if (fifosize == 0)
402	fifosize = 1;
403
404	return fifosize;
405	}
406
407	static void apbuart_flush_fifo(struct uart_port *port)
408	{
409	int i;
410
411	for (i = 0; i < port->fifosize; i++)
412	UART_GET_CHAR(port);
413	}
414
415
416	/* ======================================================================== */
417	/* Console driver, if enabled */
418	/* ======================================================================== */
419
420	#ifdef CONFIG_SERIAL_GRLIB_GAISLER_APBUART_CONSOLE
421
422	static void apbuart_console_putchar(struct uart_port *port, int ch)
423	{
424	unsigned int status;
425	do {
426	status = UART_GET_STATUS(port);
427	} while (!UART_TX_READY(status));
428	UART_PUT_CHAR(port, ch);
429	}
430
431	static void
432	apbuart_console_write(struct console co, const char s, unsigned int count)
433	{
434	struct uart_port *port = &grlib_apbuart_ports[co->index];
435	unsigned int status, old_cr, new_cr;
436
437	/* First save the CR then disable the interrupts */
438	old_cr = UART_GET_CTRL(port);
439	new_cr = old_cr & ~(UART_CTRL_RI \| UART_CTRL_TI);
440	UART_PUT_CTRL(port, new_cr);
441
442	uart_console_write(port, s, count, apbuart_console_putchar);
443
444	/*
445	* Finally, wait for transmitter to become empty
446	* and restore the TCR
447	*/
448	do {
449	status = UART_GET_STATUS(port);
450	} while (!UART_TX_READY(status));
451	UART_PUT_CTRL(port, old_cr);
452	}
453
454	static void __init
455	apbuart_console_get_options(struct uart_port port, int baud,
456	int parity, int bits)
457	{
458	if (UART_GET_CTRL(port) & (UART_CTRL_RE \| UART_CTRL_TE)) {
459
460	unsigned int quot, status;
461	status = UART_GET_STATUS(port);
462
463	*parity = 'n';
464	if (status & UART_CTRL_PE) {
465	if ((status & UART_CTRL_PS) == 0)
466	*parity = 'e';
467	else
468	*parity = 'o';
469	}
470
471	*bits = 8;
472	quot = UART_GET_SCAL(port) / 8;
473	baud = port->uartclk / (16 (quot + 1));
474	}
475	}
476
477	static int __init apbuart_console_setup(struct console co, char options)
478	{
479	struct uart_port *port;
480	int baud = 38400;
481	int bits = 8;
482	int parity = 'n';
483	int flow = 'n';
484
485	pr_debug("apbuart_console_setup co=%p, co->index=%i, options=%s\n",
486	co, co->index, options);
487
488	/*
489	* Check whether an invalid uart number has been specified, and
490	* if so, search for the first available port that does have
491	* console support.
492	*/
493	if (co->index >= grlib_apbuart_port_nr)
494	co->index = 0;
495
496	port = &grlib_apbuart_ports[co->index];
497
498	spin_lock_init(&port->lock);
499
500	if (options)
501	uart_parse_options(options, &baud, &parity, &bits, &flow);
502	else
503	apbuart_console_get_options(port, &baud, &parity, &bits);
504
505	return uart_set_options(port, co, baud, parity, bits, flow);
506	}
507
508	static struct uart_driver grlib_apbuart_driver;
509
510	static struct console grlib_apbuart_console = {
511	.name = "ttyS",
512	.write = apbuart_console_write,
513	.device = uart_console_device,
514	.setup = apbuart_console_setup,
515	.flags = CON_PRINTBUFFER,
516	.index = -1,
517	.data = &grlib_apbuart_driver,
518	};
519
520
568389c2	521	static int grlib_apbuart_configure(void);
d4ac42a5 KG	522
	523	static int __init apbuart_console_init(void)
	524	{
568389c2 TG	525	if (grlib_apbuart_configure())
568389c2 TG	526	return -ENODEV;
d4ac42a5 KG	527	register_console(&grlib_apbuart_console);
	528	return 0;
	529	}
	530
	531	console_initcall(apbuart_console_init);
	532
	533	#define APBUART_CONSOLE (&grlib_apbuart_console)
	534	#else
	535	#define APBUART_CONSOLE NULL
	536	#endif
	537
	538	static struct uart_driver grlib_apbuart_driver = {
	539	.owner = THIS_MODULE,
	540	.driver_name = "serial",
	541	.dev_name = "ttyS",
	542	.major = SERIAL_APBUART_MAJOR,
	543	.minor = SERIAL_APBUART_MINOR,
	544	.nr = UART_NR,
	545	.cons = APBUART_CONSOLE,
	546	};
	547
	548
	549	/* ======================================================================== */
	550	/* OF Platform Driver */
	551	/* ======================================================================== */
	552
9671f099	553	static int apbuart_probe(struct platform_device *op)
d4ac42a5	554	{
10544f12	555	int i;
d4ac42a5 KG	556	struct uart_port *port = NULL;
d4ac42a5 KG	557
d4ac42a5	558	for (i = 0; i < grlib_apbuart_port_nr; i++) {
61c7a080	559	if (op->dev.of_node == grlib_apbuart_nodes[i])
d4ac42a5 KG	560	break;
	561	}
	562
	563	port = &grlib_apbuart_ports[i];
	564	port->dev = &op->dev;
10544f12	565	port->irq = op->archdata.irqs[0];
d4ac42a5 KG	566
	567	uart_add_one_port(&grlib_apbuart_driver, (struct uart_port *) port);
	568
	569	apbuart_flush_fifo((struct uart_port *) port);
	570
384a17b2 DM	571	printk(KERN_INFO "grlib-apbuart at 0x%llx, irq %d\n",
384a17b2 DM	572	(unsigned long long) port->mapbase, port->irq);
d4ac42a5	573	return 0;
d4ac42a5 KG	574	}
d4ac42a5 KG	575
ed0bb232	576	static const struct of_device_id apbuart_match[] = {
d4ac42a5 KG	577	{
	578	.name = "GAISLER_APBUART",
	579	},
d89ddf0d DH	580	{
	581	.name = "01_00c",
	582	},
d4ac42a5 KG	583	{},
d4ac42a5 KG	584	};
50a84487	585	MODULE_DEVICE_TABLE(of, apbuart_match);
d4ac42a5	586
793218df	587	static struct platform_driver grlib_apbuart_of_driver = {
d4ac42a5 KG	588	.probe = apbuart_probe,
d4ac42a5 KG	589	.driver = {
4018294b GL	590	.name = "grlib-apbuart",
	591	.of_match_table = apbuart_match,
	592	},
d4ac42a5 KG	593	};
	594
	595
ab17da5c	596	static int __init grlib_apbuart_configure(void)
d4ac42a5	597	{
c897dcf6 DH	598	struct device_node *np;
c897dcf6 DH	599	int line = 0;
d4ac42a5	600
d4ac42a5	601	for_each_matching_node(np, apbuart_match) {
10544f12	602	const int *ampopts;
c897dcf6	603	const u32 *freq_hz;
35c64e5d TG	604	const struct amba_prom_registers *regs;
	605	struct uart_port *port;
	606	unsigned long addr;
d4ac42a5	607
56b85f32	608	ampopts = of_get_property(np, "ampopts", NULL);
f28f3313 DH	609	if (ampopts && (*ampopts == 0))
f28f3313 DH	610	continue; /* Ignore if used by another OS instance */
35c64e5d	611	regs = of_get_property(np, "reg", NULL);
c897dcf6 DH	612	/* Frequency of APB Bus is frequency of UART */
c897dcf6 DH	613	freq_hz = of_get_property(np, "freq", NULL);
d4ac42a5	614
c897dcf6	615	if (!regs \|\| !freq_hz \|\| (*freq_hz == 0))
56b85f32	616	continue;
d4ac42a5 KG	617
	618	grlib_apbuart_nodes[line] = np;
	619
	620	addr = regs->phys_addr;
d4ac42a5 KG	621
	622	port = &grlib_apbuart_ports[line];
	623
	624	port->mapbase = addr;
	625	port->membase = ioremap(addr, sizeof(struct grlib_apbuart_regs_map));
10544f12	626	port->irq = 0;
d4ac42a5 KG	627	port->iotype = UPIO_MEM;
	628	port->ops = &grlib_apbuart_ops;
	629	port->flags = UPF_BOOT_AUTOCONF;
	630	port->line = line;
c897dcf6	631	port->uartclk = *freq_hz;
d4ac42a5 KG	632	port->fifosize = apbuart_scan_fifo_size((struct uart_port *) port, line);
	633	line++;
	634
	635	/* We support maximum UART_NR uarts ... */
	636	if (line == UART_NR)
	637	break;
d4ac42a5 KG	638	}
d4ac42a5 KG	639
d4ac42a5	640	grlib_apbuart_driver.nr = grlib_apbuart_port_nr = line;
35c64e5d	641	return line ? 0 : -ENODEV;
d4ac42a5 KG	642	}
	643
	644	static int __init grlib_apbuart_init(void)
	645	{
	646	int ret;
	647
	648	/* Find all APBUARTS in device the tree and initialize their ports */
35c64e5d TG	649	ret = grlib_apbuart_configure();
	650	if (ret)
	651	return ret;
d4ac42a5 KG	652
	653	printk(KERN_INFO "Serial: GRLIB APBUART driver\n");
	654
	655	ret = uart_register_driver(&grlib_apbuart_driver);
	656
	657	if (ret) {
	658	printk(KERN_ERR "%s: uart_register_driver failed (%i)\n",
	659	__FILE__, ret);
	660	return ret;
	661	}
	662
793218df	663	ret = platform_driver_register(&grlib_apbuart_of_driver);
d4ac42a5 KG	664	if (ret) {
d4ac42a5 KG	665	printk(KERN_ERR
793218df	666	"%s: platform_driver_register failed (%i)\n",
d4ac42a5 KG	667	__FILE__, ret);
	668	uart_unregister_driver(&grlib_apbuart_driver);
	669	return ret;
	670	}
	671
	672	return ret;
	673	}
	674
	675	static void __exit grlib_apbuart_exit(void)
	676	{
	677	int i;
	678
	679	for (i = 0; i < grlib_apbuart_port_nr; i++)
	680	uart_remove_one_port(&grlib_apbuart_driver,
	681	&grlib_apbuart_ports[i]);
	682
	683	uart_unregister_driver(&grlib_apbuart_driver);
793218df	684	platform_driver_unregister(&grlib_apbuart_of_driver);
d4ac42a5 KG	685	}
	686
	687	module_init(grlib_apbuart_init);
	688	module_exit(grlib_apbuart_exit);
	689
	690	MODULE_AUTHOR("Aeroflex Gaisler AB");
	691	MODULE_DESCRIPTION("GRLIB APBUART serial driver");
	692	MODULE_VERSION("2.1");
	693	MODULE_LICENSE("GPL");