• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *  Based on meson_uart.c, by AMLOGIC, INC.
4  *
5  * Copyright (C) 2014 Carlo Caione <carlo@caione.org>
6  */
7 
8 #include <linux/clk.h>
9 #include <linux/console.h>
10 #include <linux/delay.h>
11 #include <linux/init.h>
12 #include <linux/io.h>
13 #include <linux/iopoll.h>
14 #include <linux/module.h>
15 #include <linux/kernel.h>
16 #include <linux/of.h>
17 #include <linux/platform_device.h>
18 #include <linux/serial.h>
19 #include <linux/serial_core.h>
20 #include <linux/tty.h>
21 #include <linux/tty_flip.h>
22 
23 /* Register offsets */
24 #define AML_UART_WFIFO			0x00
25 #define AML_UART_RFIFO			0x04
26 #define AML_UART_CONTROL		0x08
27 #define AML_UART_STATUS			0x0c
28 #define AML_UART_MISC			0x10
29 #define AML_UART_REG5			0x14
30 
31 /* AML_UART_CONTROL bits */
32 #define AML_UART_TX_EN			BIT(12)
33 #define AML_UART_RX_EN			BIT(13)
34 #define AML_UART_TWO_WIRE_EN		BIT(15)
35 #define AML_UART_STOP_BIT_LEN_MASK	(0x03 << 16)
36 #define AML_UART_STOP_BIT_1SB		(0x00 << 16)
37 #define AML_UART_STOP_BIT_2SB		(0x01 << 16)
38 #define AML_UART_PARITY_TYPE		BIT(18)
39 #define AML_UART_PARITY_EN		BIT(19)
40 #define AML_UART_TX_RST			BIT(22)
41 #define AML_UART_RX_RST			BIT(23)
42 #define AML_UART_CLEAR_ERR		BIT(24)
43 #define AML_UART_RX_INT_EN		BIT(27)
44 #define AML_UART_TX_INT_EN		BIT(28)
45 #define AML_UART_DATA_LEN_MASK		(0x03 << 20)
46 #define AML_UART_DATA_LEN_8BIT		(0x00 << 20)
47 #define AML_UART_DATA_LEN_7BIT		(0x01 << 20)
48 #define AML_UART_DATA_LEN_6BIT		(0x02 << 20)
49 #define AML_UART_DATA_LEN_5BIT		(0x03 << 20)
50 
51 /* AML_UART_STATUS bits */
52 #define AML_UART_PARITY_ERR		BIT(16)
53 #define AML_UART_FRAME_ERR		BIT(17)
54 #define AML_UART_TX_FIFO_WERR		BIT(18)
55 #define AML_UART_RX_EMPTY		BIT(20)
56 #define AML_UART_TX_FULL		BIT(21)
57 #define AML_UART_TX_EMPTY		BIT(22)
58 #define AML_UART_XMIT_BUSY		BIT(25)
59 #define AML_UART_ERR			(AML_UART_PARITY_ERR | \
60 					 AML_UART_FRAME_ERR  | \
61 					 AML_UART_TX_FIFO_WERR)
62 
63 /* AML_UART_MISC bits */
64 #define AML_UART_XMIT_IRQ(c)		(((c) & 0xff) << 8)
65 #define AML_UART_RECV_IRQ(c)		((c) & 0xff)
66 
67 /* AML_UART_REG5 bits */
68 #define AML_UART_BAUD_MASK		0x7fffff
69 #define AML_UART_BAUD_USE		BIT(23)
70 #define AML_UART_BAUD_XTAL		BIT(24)
71 
72 #define AML_UART_PORT_NUM		12
73 #define AML_UART_PORT_OFFSET		6
74 #define AML_UART_DEV_NAME		"ttyAML"
75 
76 #define AML_UART_POLL_USEC		5
77 #define AML_UART_TIMEOUT_USEC		10000
78 
79 static struct uart_driver meson_uart_driver;
80 
81 static struct uart_port *meson_ports[AML_UART_PORT_NUM];
82 
meson_uart_set_mctrl(struct uart_port * port,unsigned int mctrl)83 static void meson_uart_set_mctrl(struct uart_port *port, unsigned int mctrl)
84 {
85 }
86 
meson_uart_get_mctrl(struct uart_port * port)87 static unsigned int meson_uart_get_mctrl(struct uart_port *port)
88 {
89 	return TIOCM_CTS;
90 }
91 
meson_uart_tx_empty(struct uart_port * port)92 static unsigned int meson_uart_tx_empty(struct uart_port *port)
93 {
94 	u32 val;
95 
96 	val = readl(port->membase + AML_UART_STATUS);
97 	val &= (AML_UART_TX_EMPTY | AML_UART_XMIT_BUSY);
98 	return (val == AML_UART_TX_EMPTY) ? TIOCSER_TEMT : 0;
99 }
100 
meson_uart_stop_tx(struct uart_port * port)101 static void meson_uart_stop_tx(struct uart_port *port)
102 {
103 	u32 val;
104 
105 	val = readl(port->membase + AML_UART_CONTROL);
106 	val &= ~AML_UART_TX_INT_EN;
107 	writel(val, port->membase + AML_UART_CONTROL);
108 }
109 
meson_uart_stop_rx(struct uart_port * port)110 static void meson_uart_stop_rx(struct uart_port *port)
111 {
112 	u32 val;
113 
114 	val = readl(port->membase + AML_UART_CONTROL);
115 	val &= ~AML_UART_RX_EN;
116 	writel(val, port->membase + AML_UART_CONTROL);
117 }
118 
meson_uart_shutdown(struct uart_port * port)119 static void meson_uart_shutdown(struct uart_port *port)
120 {
121 	unsigned long flags;
122 	u32 val;
123 
124 	free_irq(port->irq, port);
125 
126 	spin_lock_irqsave(&port->lock, flags);
127 
128 	val = readl(port->membase + AML_UART_CONTROL);
129 	val &= ~AML_UART_RX_EN;
130 	val &= ~(AML_UART_RX_INT_EN | AML_UART_TX_INT_EN);
131 	writel(val, port->membase + AML_UART_CONTROL);
132 
133 	spin_unlock_irqrestore(&port->lock, flags);
134 }
135 
meson_uart_start_tx(struct uart_port * port)136 static void meson_uart_start_tx(struct uart_port *port)
137 {
138 	struct circ_buf *xmit = &port->state->xmit;
139 	unsigned int ch;
140 	u32 val;
141 
142 	if (uart_tx_stopped(port)) {
143 		meson_uart_stop_tx(port);
144 		return;
145 	}
146 
147 	while (!(readl(port->membase + AML_UART_STATUS) & AML_UART_TX_FULL)) {
148 		if (port->x_char) {
149 			writel(port->x_char, port->membase + AML_UART_WFIFO);
150 			port->icount.tx++;
151 			port->x_char = 0;
152 			continue;
153 		}
154 
155 		if (uart_circ_empty(xmit))
156 			break;
157 
158 		ch = xmit->buf[xmit->tail];
159 		writel(ch, port->membase + AML_UART_WFIFO);
160 		xmit->tail = (xmit->tail+1) & (SERIAL_XMIT_SIZE - 1);
161 		port->icount.tx++;
162 	}
163 
164 	if (!uart_circ_empty(xmit)) {
165 		val = readl(port->membase + AML_UART_CONTROL);
166 		val |= AML_UART_TX_INT_EN;
167 		writel(val, port->membase + AML_UART_CONTROL);
168 	}
169 
170 	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
171 		uart_write_wakeup(port);
172 }
173 
meson_receive_chars(struct uart_port * port)174 static void meson_receive_chars(struct uart_port *port)
175 {
176 	struct tty_port *tport = &port->state->port;
177 	char flag;
178 	u32 ostatus, status, ch, mode;
179 
180 	do {
181 		flag = TTY_NORMAL;
182 		port->icount.rx++;
183 		ostatus = status = readl(port->membase + AML_UART_STATUS);
184 
185 		if (status & AML_UART_ERR) {
186 			if (status & AML_UART_TX_FIFO_WERR)
187 				port->icount.overrun++;
188 			else if (status & AML_UART_FRAME_ERR)
189 				port->icount.frame++;
190 			else if (status & AML_UART_PARITY_ERR)
191 				port->icount.frame++;
192 
193 			mode = readl(port->membase + AML_UART_CONTROL);
194 			mode |= AML_UART_CLEAR_ERR;
195 			writel(mode, port->membase + AML_UART_CONTROL);
196 
197 			/* It doesn't clear to 0 automatically */
198 			mode &= ~AML_UART_CLEAR_ERR;
199 			writel(mode, port->membase + AML_UART_CONTROL);
200 
201 			status &= port->read_status_mask;
202 			if (status & AML_UART_FRAME_ERR)
203 				flag = TTY_FRAME;
204 			else if (status & AML_UART_PARITY_ERR)
205 				flag = TTY_PARITY;
206 		}
207 
208 		ch = readl(port->membase + AML_UART_RFIFO);
209 		ch &= 0xff;
210 
211 		if ((ostatus & AML_UART_FRAME_ERR) && (ch == 0)) {
212 			port->icount.brk++;
213 			flag = TTY_BREAK;
214 			if (uart_handle_break(port))
215 				continue;
216 		}
217 
218 		if (uart_handle_sysrq_char(port, ch))
219 			continue;
220 
221 		if ((status & port->ignore_status_mask) == 0)
222 			tty_insert_flip_char(tport, ch, flag);
223 
224 		if (status & AML_UART_TX_FIFO_WERR)
225 			tty_insert_flip_char(tport, 0, TTY_OVERRUN);
226 
227 	} while (!(readl(port->membase + AML_UART_STATUS) & AML_UART_RX_EMPTY));
228 
229 	spin_unlock(&port->lock);
230 	tty_flip_buffer_push(tport);
231 	spin_lock(&port->lock);
232 }
233 
meson_uart_interrupt(int irq,void * dev_id)234 static irqreturn_t meson_uart_interrupt(int irq, void *dev_id)
235 {
236 	struct uart_port *port = (struct uart_port *)dev_id;
237 
238 	spin_lock(&port->lock);
239 
240 	if (!(readl(port->membase + AML_UART_STATUS) & AML_UART_RX_EMPTY))
241 		meson_receive_chars(port);
242 
243 	if (!(readl(port->membase + AML_UART_STATUS) & AML_UART_TX_FULL)) {
244 		if (readl(port->membase + AML_UART_CONTROL) & AML_UART_TX_INT_EN)
245 			meson_uart_start_tx(port);
246 	}
247 
248 	spin_unlock(&port->lock);
249 
250 	return IRQ_HANDLED;
251 }
252 
meson_uart_type(struct uart_port * port)253 static const char *meson_uart_type(struct uart_port *port)
254 {
255 	return (port->type == PORT_MESON) ? "meson_uart" : NULL;
256 }
257 
258 /*
259  * This function is called only from probe() using a temporary io mapping
260  * in order to perform a reset before setting up the device. Since the
261  * temporarily mapped region was successfully requested, there can be no
262  * console on this port at this time. Hence it is not necessary for this
263  * function to acquire the port->lock. (Since there is no console on this
264  * port at this time, the port->lock is not initialized yet.)
265  */
meson_uart_reset(struct uart_port * port)266 static void meson_uart_reset(struct uart_port *port)
267 {
268 	u32 val;
269 
270 	val = readl(port->membase + AML_UART_CONTROL);
271 	val |= (AML_UART_RX_RST | AML_UART_TX_RST | AML_UART_CLEAR_ERR);
272 	writel(val, port->membase + AML_UART_CONTROL);
273 
274 	val &= ~(AML_UART_RX_RST | AML_UART_TX_RST | AML_UART_CLEAR_ERR);
275 	writel(val, port->membase + AML_UART_CONTROL);
276 }
277 
meson_uart_startup(struct uart_port * port)278 static int meson_uart_startup(struct uart_port *port)
279 {
280 	unsigned long flags;
281 	u32 val;
282 	int ret = 0;
283 
284 	spin_lock_irqsave(&port->lock, flags);
285 
286 	val = readl(port->membase + AML_UART_CONTROL);
287 	val |= AML_UART_CLEAR_ERR;
288 	writel(val, port->membase + AML_UART_CONTROL);
289 	val &= ~AML_UART_CLEAR_ERR;
290 	writel(val, port->membase + AML_UART_CONTROL);
291 
292 	val |= (AML_UART_RX_EN | AML_UART_TX_EN);
293 	writel(val, port->membase + AML_UART_CONTROL);
294 
295 	val |= (AML_UART_RX_INT_EN | AML_UART_TX_INT_EN);
296 	writel(val, port->membase + AML_UART_CONTROL);
297 
298 	val = (AML_UART_RECV_IRQ(1) | AML_UART_XMIT_IRQ(port->fifosize / 2));
299 	writel(val, port->membase + AML_UART_MISC);
300 
301 	spin_unlock_irqrestore(&port->lock, flags);
302 
303 	ret = request_irq(port->irq, meson_uart_interrupt, 0,
304 			  port->name, port);
305 
306 	return ret;
307 }
308 
meson_uart_change_speed(struct uart_port * port,unsigned long baud)309 static void meson_uart_change_speed(struct uart_port *port, unsigned long baud)
310 {
311 	u32 val;
312 
313 	while (!meson_uart_tx_empty(port))
314 		cpu_relax();
315 
316 	if (port->uartclk == 24000000) {
317 		val = ((port->uartclk / 3) / baud) - 1;
318 		val |= AML_UART_BAUD_XTAL;
319 	} else {
320 		val = ((port->uartclk * 10 / (baud * 4) + 5) / 10) - 1;
321 	}
322 	val |= AML_UART_BAUD_USE;
323 	writel(val, port->membase + AML_UART_REG5);
324 }
325 
meson_uart_set_termios(struct uart_port * port,struct ktermios * termios,struct ktermios * old)326 static void meson_uart_set_termios(struct uart_port *port,
327 				   struct ktermios *termios,
328 				   struct ktermios *old)
329 {
330 	unsigned int cflags, iflags, baud;
331 	unsigned long flags;
332 	u32 val;
333 
334 	spin_lock_irqsave(&port->lock, flags);
335 
336 	cflags = termios->c_cflag;
337 	iflags = termios->c_iflag;
338 
339 	val = readl(port->membase + AML_UART_CONTROL);
340 
341 	val &= ~AML_UART_DATA_LEN_MASK;
342 	switch (cflags & CSIZE) {
343 	case CS8:
344 		val |= AML_UART_DATA_LEN_8BIT;
345 		break;
346 	case CS7:
347 		val |= AML_UART_DATA_LEN_7BIT;
348 		break;
349 	case CS6:
350 		val |= AML_UART_DATA_LEN_6BIT;
351 		break;
352 	case CS5:
353 		val |= AML_UART_DATA_LEN_5BIT;
354 		break;
355 	}
356 
357 	if (cflags & PARENB)
358 		val |= AML_UART_PARITY_EN;
359 	else
360 		val &= ~AML_UART_PARITY_EN;
361 
362 	if (cflags & PARODD)
363 		val |= AML_UART_PARITY_TYPE;
364 	else
365 		val &= ~AML_UART_PARITY_TYPE;
366 
367 	val &= ~AML_UART_STOP_BIT_LEN_MASK;
368 	if (cflags & CSTOPB)
369 		val |= AML_UART_STOP_BIT_2SB;
370 	else
371 		val |= AML_UART_STOP_BIT_1SB;
372 
373 	if (cflags & CRTSCTS)
374 		val &= ~AML_UART_TWO_WIRE_EN;
375 	else
376 		val |= AML_UART_TWO_WIRE_EN;
377 
378 	writel(val, port->membase + AML_UART_CONTROL);
379 
380 	baud = uart_get_baud_rate(port, termios, old, 50, 4000000);
381 	meson_uart_change_speed(port, baud);
382 
383 	port->read_status_mask = AML_UART_TX_FIFO_WERR;
384 	if (iflags & INPCK)
385 		port->read_status_mask |= AML_UART_PARITY_ERR |
386 					  AML_UART_FRAME_ERR;
387 
388 	port->ignore_status_mask = 0;
389 	if (iflags & IGNPAR)
390 		port->ignore_status_mask |= AML_UART_PARITY_ERR |
391 					    AML_UART_FRAME_ERR;
392 
393 	uart_update_timeout(port, termios->c_cflag, baud);
394 	spin_unlock_irqrestore(&port->lock, flags);
395 }
396 
meson_uart_verify_port(struct uart_port * port,struct serial_struct * ser)397 static int meson_uart_verify_port(struct uart_port *port,
398 				  struct serial_struct *ser)
399 {
400 	int ret = 0;
401 
402 	if (port->type != PORT_MESON)
403 		ret = -EINVAL;
404 	if (port->irq != ser->irq)
405 		ret = -EINVAL;
406 	if (ser->baud_base < 9600)
407 		ret = -EINVAL;
408 	return ret;
409 }
410 
meson_uart_release_port(struct uart_port * port)411 static void meson_uart_release_port(struct uart_port *port)
412 {
413 	devm_iounmap(port->dev, port->membase);
414 	port->membase = NULL;
415 	devm_release_mem_region(port->dev, port->mapbase, port->mapsize);
416 }
417 
meson_uart_request_port(struct uart_port * port)418 static int meson_uart_request_port(struct uart_port *port)
419 {
420 	if (!devm_request_mem_region(port->dev, port->mapbase, port->mapsize,
421 				     dev_name(port->dev))) {
422 		dev_err(port->dev, "Memory region busy\n");
423 		return -EBUSY;
424 	}
425 
426 	port->membase = devm_ioremap(port->dev, port->mapbase,
427 					     port->mapsize);
428 	if (!port->membase)
429 		return -ENOMEM;
430 
431 	return 0;
432 }
433 
meson_uart_config_port(struct uart_port * port,int flags)434 static void meson_uart_config_port(struct uart_port *port, int flags)
435 {
436 	if (flags & UART_CONFIG_TYPE) {
437 		port->type = PORT_MESON;
438 		meson_uart_request_port(port);
439 	}
440 }
441 
442 #ifdef CONFIG_CONSOLE_POLL
443 /*
444  * Console polling routines for writing and reading from the uart while
445  * in an interrupt or debug context (i.e. kgdb).
446  */
447 
meson_uart_poll_get_char(struct uart_port * port)448 static int meson_uart_poll_get_char(struct uart_port *port)
449 {
450 	u32 c;
451 	unsigned long flags;
452 
453 	spin_lock_irqsave(&port->lock, flags);
454 
455 	if (readl(port->membase + AML_UART_STATUS) & AML_UART_RX_EMPTY)
456 		c = NO_POLL_CHAR;
457 	else
458 		c = readl(port->membase + AML_UART_RFIFO);
459 
460 	spin_unlock_irqrestore(&port->lock, flags);
461 
462 	return c;
463 }
464 
meson_uart_poll_put_char(struct uart_port * port,unsigned char c)465 static void meson_uart_poll_put_char(struct uart_port *port, unsigned char c)
466 {
467 	unsigned long flags;
468 	u32 reg;
469 	int ret;
470 
471 	spin_lock_irqsave(&port->lock, flags);
472 
473 	/* Wait until FIFO is empty or timeout */
474 	ret = readl_poll_timeout_atomic(port->membase + AML_UART_STATUS, reg,
475 					reg & AML_UART_TX_EMPTY,
476 					AML_UART_POLL_USEC,
477 					AML_UART_TIMEOUT_USEC);
478 	if (ret == -ETIMEDOUT) {
479 		dev_err(port->dev, "Timeout waiting for UART TX EMPTY\n");
480 		goto out;
481 	}
482 
483 	/* Write the character */
484 	writel(c, port->membase + AML_UART_WFIFO);
485 
486 	/* Wait until FIFO is empty or timeout */
487 	ret = readl_poll_timeout_atomic(port->membase + AML_UART_STATUS, reg,
488 					reg & AML_UART_TX_EMPTY,
489 					AML_UART_POLL_USEC,
490 					AML_UART_TIMEOUT_USEC);
491 	if (ret == -ETIMEDOUT)
492 		dev_err(port->dev, "Timeout waiting for UART TX EMPTY\n");
493 
494 out:
495 	spin_unlock_irqrestore(&port->lock, flags);
496 }
497 
498 #endif /* CONFIG_CONSOLE_POLL */
499 
500 static const struct uart_ops meson_uart_ops = {
501 	.set_mctrl      = meson_uart_set_mctrl,
502 	.get_mctrl      = meson_uart_get_mctrl,
503 	.tx_empty	= meson_uart_tx_empty,
504 	.start_tx	= meson_uart_start_tx,
505 	.stop_tx	= meson_uart_stop_tx,
506 	.stop_rx	= meson_uart_stop_rx,
507 	.startup	= meson_uart_startup,
508 	.shutdown	= meson_uart_shutdown,
509 	.set_termios	= meson_uart_set_termios,
510 	.type		= meson_uart_type,
511 	.config_port	= meson_uart_config_port,
512 	.request_port	= meson_uart_request_port,
513 	.release_port	= meson_uart_release_port,
514 	.verify_port	= meson_uart_verify_port,
515 #ifdef CONFIG_CONSOLE_POLL
516 	.poll_get_char	= meson_uart_poll_get_char,
517 	.poll_put_char	= meson_uart_poll_put_char,
518 #endif
519 };
520 
521 #ifdef CONFIG_SERIAL_MESON_CONSOLE
meson_uart_enable_tx_engine(struct uart_port * port)522 static void meson_uart_enable_tx_engine(struct uart_port *port)
523 {
524 	u32 val;
525 
526 	val = readl(port->membase + AML_UART_CONTROL);
527 	val |= AML_UART_TX_EN;
528 	writel(val, port->membase + AML_UART_CONTROL);
529 }
530 
meson_console_putchar(struct uart_port * port,int ch)531 static void meson_console_putchar(struct uart_port *port, int ch)
532 {
533 	if (!port->membase)
534 		return;
535 
536 	while (readl(port->membase + AML_UART_STATUS) & AML_UART_TX_FULL)
537 		cpu_relax();
538 	writel(ch, port->membase + AML_UART_WFIFO);
539 }
540 
meson_serial_port_write(struct uart_port * port,const char * s,u_int count)541 static void meson_serial_port_write(struct uart_port *port, const char *s,
542 				    u_int count)
543 {
544 	unsigned long flags;
545 	int locked;
546 	u32 val, tmp;
547 
548 	local_irq_save(flags);
549 	if (port->sysrq) {
550 		locked = 0;
551 	} else if (oops_in_progress) {
552 		locked = spin_trylock(&port->lock);
553 	} else {
554 		spin_lock(&port->lock);
555 		locked = 1;
556 	}
557 
558 	val = readl(port->membase + AML_UART_CONTROL);
559 	tmp = val & ~(AML_UART_TX_INT_EN | AML_UART_RX_INT_EN);
560 	writel(tmp, port->membase + AML_UART_CONTROL);
561 
562 	uart_console_write(port, s, count, meson_console_putchar);
563 	writel(val, port->membase + AML_UART_CONTROL);
564 
565 	if (locked)
566 		spin_unlock(&port->lock);
567 	local_irq_restore(flags);
568 }
569 
meson_serial_console_write(struct console * co,const char * s,u_int count)570 static void meson_serial_console_write(struct console *co, const char *s,
571 				       u_int count)
572 {
573 	struct uart_port *port;
574 
575 	port = meson_ports[co->index];
576 	if (!port)
577 		return;
578 
579 	meson_serial_port_write(port, s, count);
580 }
581 
meson_serial_console_setup(struct console * co,char * options)582 static int meson_serial_console_setup(struct console *co, char *options)
583 {
584 	struct uart_port *port;
585 	int baud = 115200;
586 	int bits = 8;
587 	int parity = 'n';
588 	int flow = 'n';
589 
590 	if (co->index < 0 || co->index >= AML_UART_PORT_NUM)
591 		return -EINVAL;
592 
593 	port = meson_ports[co->index];
594 	if (!port || !port->membase)
595 		return -ENODEV;
596 
597 	meson_uart_enable_tx_engine(port);
598 
599 	if (options)
600 		uart_parse_options(options, &baud, &parity, &bits, &flow);
601 
602 	return uart_set_options(port, co, baud, parity, bits, flow);
603 }
604 
605 static struct console meson_serial_console = {
606 	.name		= AML_UART_DEV_NAME,
607 	.write		= meson_serial_console_write,
608 	.device		= uart_console_device,
609 	.setup		= meson_serial_console_setup,
610 	.flags		= CON_PRINTBUFFER,
611 	.index		= -1,
612 	.data		= &meson_uart_driver,
613 };
614 
meson_serial_console_init(void)615 static int __init meson_serial_console_init(void)
616 {
617 	register_console(&meson_serial_console);
618 	return 0;
619 }
620 console_initcall(meson_serial_console_init);
621 
meson_serial_early_console_write(struct console * co,const char * s,u_int count)622 static void meson_serial_early_console_write(struct console *co,
623 					     const char *s,
624 					     u_int count)
625 {
626 	struct earlycon_device *dev = co->data;
627 
628 	meson_serial_port_write(&dev->port, s, count);
629 }
630 
631 static int __init
meson_serial_early_console_setup(struct earlycon_device * device,const char * opt)632 meson_serial_early_console_setup(struct earlycon_device *device, const char *opt)
633 {
634 	if (!device->port.membase)
635 		return -ENODEV;
636 
637 	meson_uart_enable_tx_engine(&device->port);
638 	device->con->write = meson_serial_early_console_write;
639 	return 0;
640 }
641 /* Legacy bindings, should be removed when no more used */
642 OF_EARLYCON_DECLARE(meson, "amlogic,meson-uart",
643 		    meson_serial_early_console_setup);
644 /* Stable bindings */
645 OF_EARLYCON_DECLARE(meson, "amlogic,meson-ao-uart",
646 		    meson_serial_early_console_setup);
647 
648 #define MESON_SERIAL_CONSOLE	(&meson_serial_console)
649 #else
650 #define MESON_SERIAL_CONSOLE	NULL
651 #endif
652 
653 static struct uart_driver meson_uart_driver = {
654 	.owner		= THIS_MODULE,
655 	.driver_name	= "meson_uart",
656 	.dev_name	= AML_UART_DEV_NAME,
657 	.nr		= AML_UART_PORT_NUM,
658 	.cons		= MESON_SERIAL_CONSOLE,
659 };
660 
meson_uart_probe_clock(struct device * dev,const char * id)661 static inline struct clk *meson_uart_probe_clock(struct device *dev,
662 						 const char *id)
663 {
664 	struct clk *clk = NULL;
665 	int ret;
666 
667 	clk = devm_clk_get(dev, id);
668 	if (IS_ERR(clk))
669 		return clk;
670 
671 	ret = clk_prepare_enable(clk);
672 	if (ret) {
673 		dev_err(dev, "couldn't enable clk\n");
674 		return ERR_PTR(ret);
675 	}
676 
677 	devm_add_action_or_reset(dev,
678 			(void(*)(void *))clk_disable_unprepare,
679 			clk);
680 
681 	return clk;
682 }
683 
684 /*
685  * This function gets clocks in the legacy non-stable DT bindings.
686  * This code will be remove once all the platforms switch to the
687  * new DT bindings.
688  */
meson_uart_probe_clocks_legacy(struct platform_device * pdev,struct uart_port * port)689 static int meson_uart_probe_clocks_legacy(struct platform_device *pdev,
690 					  struct uart_port *port)
691 {
692 	struct clk *clk = NULL;
693 
694 	clk = meson_uart_probe_clock(&pdev->dev, NULL);
695 	if (IS_ERR(clk))
696 		return PTR_ERR(clk);
697 
698 	port->uartclk = clk_get_rate(clk);
699 
700 	return 0;
701 }
702 
meson_uart_probe_clocks(struct platform_device * pdev,struct uart_port * port)703 static int meson_uart_probe_clocks(struct platform_device *pdev,
704 				   struct uart_port *port)
705 {
706 	struct clk *clk_xtal = NULL;
707 	struct clk *clk_pclk = NULL;
708 	struct clk *clk_baud = NULL;
709 
710 	clk_pclk = meson_uart_probe_clock(&pdev->dev, "pclk");
711 	if (IS_ERR(clk_pclk))
712 		return PTR_ERR(clk_pclk);
713 
714 	clk_xtal = meson_uart_probe_clock(&pdev->dev, "xtal");
715 	if (IS_ERR(clk_xtal))
716 		return PTR_ERR(clk_xtal);
717 
718 	clk_baud = meson_uart_probe_clock(&pdev->dev, "baud");
719 	if (IS_ERR(clk_baud))
720 		return PTR_ERR(clk_baud);
721 
722 	port->uartclk = clk_get_rate(clk_baud);
723 
724 	return 0;
725 }
726 
meson_uart_probe(struct platform_device * pdev)727 static int meson_uart_probe(struct platform_device *pdev)
728 {
729 	struct resource *res_mem, *res_irq;
730 	struct uart_port *port;
731 	int ret = 0;
732 	int id = -1;
733 
734 	if (pdev->dev.of_node)
735 		pdev->id = of_alias_get_id(pdev->dev.of_node, "serial");
736 
737 	if (pdev->id < 0) {
738 		for (id = AML_UART_PORT_OFFSET; id < AML_UART_PORT_NUM; id++) {
739 			if (!meson_ports[id]) {
740 				pdev->id = id;
741 				break;
742 			}
743 		}
744 	}
745 
746 	if (pdev->id < 0 || pdev->id >= AML_UART_PORT_NUM)
747 		return -EINVAL;
748 
749 	res_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
750 	if (!res_mem)
751 		return -ENODEV;
752 
753 	res_irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
754 	if (!res_irq)
755 		return -ENODEV;
756 
757 	if (meson_ports[pdev->id]) {
758 		dev_err(&pdev->dev, "port %d already allocated\n", pdev->id);
759 		return -EBUSY;
760 	}
761 
762 	port = devm_kzalloc(&pdev->dev, sizeof(struct uart_port), GFP_KERNEL);
763 	if (!port)
764 		return -ENOMEM;
765 
766 	/* Use legacy way until all platforms switch to new bindings */
767 	if (of_device_is_compatible(pdev->dev.of_node, "amlogic,meson-uart"))
768 		ret = meson_uart_probe_clocks_legacy(pdev, port);
769 	else
770 		ret = meson_uart_probe_clocks(pdev, port);
771 
772 	if (ret)
773 		return ret;
774 
775 	port->iotype = UPIO_MEM;
776 	port->mapbase = res_mem->start;
777 	port->mapsize = resource_size(res_mem);
778 	port->irq = res_irq->start;
779 	port->flags = UPF_BOOT_AUTOCONF | UPF_LOW_LATENCY;
780 	port->has_sysrq = IS_ENABLED(CONFIG_SERIAL_MESON_CONSOLE);
781 	port->dev = &pdev->dev;
782 	port->line = pdev->id;
783 	port->type = PORT_MESON;
784 	port->x_char = 0;
785 	port->ops = &meson_uart_ops;
786 	port->fifosize = 64;
787 
788 	meson_ports[pdev->id] = port;
789 	platform_set_drvdata(pdev, port);
790 
791 	/* reset port before registering (and possibly registering console) */
792 	if (meson_uart_request_port(port) >= 0) {
793 		meson_uart_reset(port);
794 		meson_uart_release_port(port);
795 	}
796 
797 	ret = uart_add_one_port(&meson_uart_driver, port);
798 	if (ret)
799 		meson_ports[pdev->id] = NULL;
800 
801 	return ret;
802 }
803 
meson_uart_remove(struct platform_device * pdev)804 static int meson_uart_remove(struct platform_device *pdev)
805 {
806 	struct uart_port *port;
807 
808 	port = platform_get_drvdata(pdev);
809 	uart_remove_one_port(&meson_uart_driver, port);
810 	meson_ports[pdev->id] = NULL;
811 
812 	return 0;
813 }
814 
815 static const struct of_device_id meson_uart_dt_match[] = {
816 	/* Legacy bindings, should be removed when no more used */
817 	{ .compatible = "amlogic,meson-uart" },
818 	/* Stable bindings */
819 	{ .compatible = "amlogic,meson6-uart" },
820 	{ .compatible = "amlogic,meson8-uart" },
821 	{ .compatible = "amlogic,meson8b-uart" },
822 	{ .compatible = "amlogic,meson-gx-uart" },
823 	{ /* sentinel */ },
824 };
825 MODULE_DEVICE_TABLE(of, meson_uart_dt_match);
826 
827 static  struct platform_driver meson_uart_platform_driver = {
828 	.probe		= meson_uart_probe,
829 	.remove		= meson_uart_remove,
830 	.driver		= {
831 		.name		= "meson_uart",
832 		.of_match_table	= meson_uart_dt_match,
833 	},
834 };
835 
meson_uart_init(void)836 static int __init meson_uart_init(void)
837 {
838 	int ret;
839 
840 	ret = uart_register_driver(&meson_uart_driver);
841 	if (ret)
842 		return ret;
843 
844 	ret = platform_driver_register(&meson_uart_platform_driver);
845 	if (ret)
846 		uart_unregister_driver(&meson_uart_driver);
847 
848 	return ret;
849 }
850 
meson_uart_exit(void)851 static void __exit meson_uart_exit(void)
852 {
853 	platform_driver_unregister(&meson_uart_platform_driver);
854 	uart_unregister_driver(&meson_uart_driver);
855 }
856 
857 module_init(meson_uart_init);
858 module_exit(meson_uart_exit);
859 
860 MODULE_AUTHOR("Carlo Caione <carlo@caione.org>");
861 MODULE_DESCRIPTION("Amlogic Meson serial port driver");
862 MODULE_LICENSE("GPL v2");
863