xref: /openbmc/linux/drivers/tty/serial/owl-uart.c (revision 519b58bb)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Actions Semi Owl family serial console
4  *
5  * Copyright 2013 Actions Semi Inc.
6  * Author: Actions Semi, Inc.
7  *
8  * Copyright (c) 2016-2017 Andreas Färber
9  */
10 
11 #include <linux/clk.h>
12 #include <linux/console.h>
13 #include <linux/delay.h>
14 #include <linux/io.h>
15 #include <linux/iopoll.h>
16 #include <linux/module.h>
17 #include <linux/of.h>
18 #include <linux/platform_device.h>
19 #include <linux/serial.h>
20 #include <linux/serial_core.h>
21 #include <linux/tty.h>
22 #include <linux/tty_flip.h>
23 
24 #define OWL_UART_PORT_NUM 7
25 #define OWL_UART_DEV_NAME "ttyOWL"
26 
27 #define OWL_UART_CTL	0x000
28 #define OWL_UART_RXDAT	0x004
29 #define OWL_UART_TXDAT	0x008
30 #define OWL_UART_STAT	0x00c
31 
32 #define OWL_UART_CTL_DWLS_MASK		GENMASK(1, 0)
33 #define OWL_UART_CTL_DWLS_5BITS		(0x0 << 0)
34 #define OWL_UART_CTL_DWLS_6BITS		(0x1 << 0)
35 #define OWL_UART_CTL_DWLS_7BITS		(0x2 << 0)
36 #define OWL_UART_CTL_DWLS_8BITS		(0x3 << 0)
37 #define OWL_UART_CTL_STPS_2BITS		BIT(2)
38 #define OWL_UART_CTL_PRS_MASK		GENMASK(6, 4)
39 #define OWL_UART_CTL_PRS_NONE		(0x0 << 4)
40 #define OWL_UART_CTL_PRS_ODD		(0x4 << 4)
41 #define OWL_UART_CTL_PRS_MARK		(0x5 << 4)
42 #define OWL_UART_CTL_PRS_EVEN		(0x6 << 4)
43 #define OWL_UART_CTL_PRS_SPACE		(0x7 << 4)
44 #define OWL_UART_CTL_AFE		BIT(12)
45 #define OWL_UART_CTL_TRFS_TX		BIT(14)
46 #define OWL_UART_CTL_EN			BIT(15)
47 #define OWL_UART_CTL_RXDE		BIT(16)
48 #define OWL_UART_CTL_TXDE		BIT(17)
49 #define OWL_UART_CTL_RXIE		BIT(18)
50 #define OWL_UART_CTL_TXIE		BIT(19)
51 #define OWL_UART_CTL_LBEN		BIT(20)
52 
53 #define OWL_UART_STAT_RIP		BIT(0)
54 #define OWL_UART_STAT_TIP		BIT(1)
55 #define OWL_UART_STAT_RXER		BIT(2)
56 #define OWL_UART_STAT_TFER		BIT(3)
57 #define OWL_UART_STAT_RXST		BIT(4)
58 #define OWL_UART_STAT_RFEM		BIT(5)
59 #define OWL_UART_STAT_TFFU		BIT(6)
60 #define OWL_UART_STAT_CTSS		BIT(7)
61 #define OWL_UART_STAT_RTSS		BIT(8)
62 #define OWL_UART_STAT_TFES		BIT(10)
63 #define OWL_UART_STAT_TRFL_MASK		GENMASK(16, 11)
64 #define OWL_UART_STAT_UTBB		BIT(17)
65 
66 #define OWL_UART_POLL_USEC		5
67 #define OWL_UART_TIMEOUT_USEC		10000
68 
69 static struct uart_driver owl_uart_driver;
70 
71 struct owl_uart_info {
72 	unsigned int tx_fifosize;
73 };
74 
75 struct owl_uart_port {
76 	struct uart_port port;
77 	struct clk *clk;
78 };
79 
80 #define to_owl_uart_port(prt) container_of(prt, struct owl_uart_port, prt)
81 
82 static struct owl_uart_port *owl_uart_ports[OWL_UART_PORT_NUM];
83 
84 static inline void owl_uart_write(struct uart_port *port, u32 val, unsigned int off)
85 {
86 	writel(val, port->membase + off);
87 }
88 
89 static inline u32 owl_uart_read(struct uart_port *port, unsigned int off)
90 {
91 	return readl(port->membase + off);
92 }
93 
94 static void owl_uart_set_mctrl(struct uart_port *port, unsigned int mctrl)
95 {
96 	u32 ctl;
97 
98 	ctl = owl_uart_read(port, OWL_UART_CTL);
99 
100 	if (mctrl & TIOCM_LOOP)
101 		ctl |= OWL_UART_CTL_LBEN;
102 	else
103 		ctl &= ~OWL_UART_CTL_LBEN;
104 
105 	owl_uart_write(port, ctl, OWL_UART_CTL);
106 }
107 
108 static unsigned int owl_uart_get_mctrl(struct uart_port *port)
109 {
110 	unsigned int mctrl = TIOCM_CAR | TIOCM_DSR;
111 	u32 stat, ctl;
112 
113 	ctl = owl_uart_read(port, OWL_UART_CTL);
114 	stat = owl_uart_read(port, OWL_UART_STAT);
115 	if (stat & OWL_UART_STAT_RTSS)
116 		mctrl |= TIOCM_RTS;
117 	if ((stat & OWL_UART_STAT_CTSS) || !(ctl & OWL_UART_CTL_AFE))
118 		mctrl |= TIOCM_CTS;
119 	return mctrl;
120 }
121 
122 static unsigned int owl_uart_tx_empty(struct uart_port *port)
123 {
124 	unsigned long flags;
125 	u32 val;
126 	unsigned int ret;
127 
128 	spin_lock_irqsave(&port->lock, flags);
129 
130 	val = owl_uart_read(port, OWL_UART_STAT);
131 	ret = (val & OWL_UART_STAT_TFES) ? TIOCSER_TEMT : 0;
132 
133 	spin_unlock_irqrestore(&port->lock, flags);
134 
135 	return ret;
136 }
137 
138 static void owl_uart_stop_rx(struct uart_port *port)
139 {
140 	u32 val;
141 
142 	val = owl_uart_read(port, OWL_UART_CTL);
143 	val &= ~(OWL_UART_CTL_RXIE | OWL_UART_CTL_RXDE);
144 	owl_uart_write(port, val, OWL_UART_CTL);
145 
146 	val = owl_uart_read(port, OWL_UART_STAT);
147 	val |= OWL_UART_STAT_RIP;
148 	owl_uart_write(port, val, OWL_UART_STAT);
149 }
150 
151 static void owl_uart_stop_tx(struct uart_port *port)
152 {
153 	u32 val;
154 
155 	val = owl_uart_read(port, OWL_UART_CTL);
156 	val &= ~(OWL_UART_CTL_TXIE | OWL_UART_CTL_TXDE);
157 	owl_uart_write(port, val, OWL_UART_CTL);
158 
159 	val = owl_uart_read(port, OWL_UART_STAT);
160 	val |= OWL_UART_STAT_TIP;
161 	owl_uart_write(port, val, OWL_UART_STAT);
162 }
163 
164 static void owl_uart_start_tx(struct uart_port *port)
165 {
166 	u32 val;
167 
168 	if (uart_tx_stopped(port)) {
169 		owl_uart_stop_tx(port);
170 		return;
171 	}
172 
173 	val = owl_uart_read(port, OWL_UART_STAT);
174 	val |= OWL_UART_STAT_TIP;
175 	owl_uart_write(port, val, OWL_UART_STAT);
176 
177 	val = owl_uart_read(port, OWL_UART_CTL);
178 	val |= OWL_UART_CTL_TXIE;
179 	owl_uart_write(port, val, OWL_UART_CTL);
180 }
181 
182 static void owl_uart_send_chars(struct uart_port *port)
183 {
184 	struct circ_buf *xmit = &port->state->xmit;
185 	unsigned int ch;
186 
187 	if (port->x_char) {
188 		while (!(owl_uart_read(port, OWL_UART_STAT) & OWL_UART_STAT_TFFU))
189 			cpu_relax();
190 		owl_uart_write(port, port->x_char, OWL_UART_TXDAT);
191 		port->icount.tx++;
192 		port->x_char = 0;
193 	}
194 
195 	if (uart_tx_stopped(port))
196 		return;
197 
198 	while (!(owl_uart_read(port, OWL_UART_STAT) & OWL_UART_STAT_TFFU)) {
199 		if (uart_circ_empty(xmit))
200 			break;
201 
202 		ch = xmit->buf[xmit->tail];
203 		owl_uart_write(port, ch, OWL_UART_TXDAT);
204 		xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
205 		port->icount.tx++;
206 	}
207 
208 	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
209 		uart_write_wakeup(port);
210 
211 	if (uart_circ_empty(xmit))
212 		owl_uart_stop_tx(port);
213 }
214 
215 static void owl_uart_receive_chars(struct uart_port *port)
216 {
217 	u32 stat, val;
218 
219 	val = owl_uart_read(port, OWL_UART_CTL);
220 	val &= ~OWL_UART_CTL_TRFS_TX;
221 	owl_uart_write(port, val, OWL_UART_CTL);
222 
223 	stat = owl_uart_read(port, OWL_UART_STAT);
224 	while (!(stat & OWL_UART_STAT_RFEM)) {
225 		char flag = TTY_NORMAL;
226 
227 		if (stat & OWL_UART_STAT_RXER)
228 			port->icount.overrun++;
229 
230 		if (stat & OWL_UART_STAT_RXST) {
231 			/* We are not able to distinguish the error type. */
232 			port->icount.brk++;
233 			port->icount.frame++;
234 
235 			stat &= port->read_status_mask;
236 			if (stat & OWL_UART_STAT_RXST)
237 				flag = TTY_PARITY;
238 		} else
239 			port->icount.rx++;
240 
241 		val = owl_uart_read(port, OWL_UART_RXDAT);
242 		val &= 0xff;
243 
244 		if ((stat & port->ignore_status_mask) == 0)
245 			tty_insert_flip_char(&port->state->port, val, flag);
246 
247 		stat = owl_uart_read(port, OWL_UART_STAT);
248 	}
249 
250 	tty_flip_buffer_push(&port->state->port);
251 }
252 
253 static irqreturn_t owl_uart_irq(int irq, void *dev_id)
254 {
255 	struct uart_port *port = dev_id;
256 	unsigned long flags;
257 	u32 stat;
258 
259 	spin_lock_irqsave(&port->lock, flags);
260 
261 	stat = owl_uart_read(port, OWL_UART_STAT);
262 
263 	if (stat & OWL_UART_STAT_RIP)
264 		owl_uart_receive_chars(port);
265 
266 	if (stat & OWL_UART_STAT_TIP)
267 		owl_uart_send_chars(port);
268 
269 	stat = owl_uart_read(port, OWL_UART_STAT);
270 	stat |= OWL_UART_STAT_RIP | OWL_UART_STAT_TIP;
271 	owl_uart_write(port, stat, OWL_UART_STAT);
272 
273 	spin_unlock_irqrestore(&port->lock, flags);
274 
275 	return IRQ_HANDLED;
276 }
277 
278 static void owl_uart_shutdown(struct uart_port *port)
279 {
280 	u32 val;
281 	unsigned long flags;
282 
283 	spin_lock_irqsave(&port->lock, flags);
284 
285 	val = owl_uart_read(port, OWL_UART_CTL);
286 	val &= ~(OWL_UART_CTL_TXIE | OWL_UART_CTL_RXIE
287 		| OWL_UART_CTL_TXDE | OWL_UART_CTL_RXDE | OWL_UART_CTL_EN);
288 	owl_uart_write(port, val, OWL_UART_CTL);
289 
290 	spin_unlock_irqrestore(&port->lock, flags);
291 
292 	free_irq(port->irq, port);
293 }
294 
295 static int owl_uart_startup(struct uart_port *port)
296 {
297 	u32 val;
298 	unsigned long flags;
299 	int ret;
300 
301 	ret = request_irq(port->irq, owl_uart_irq, IRQF_TRIGGER_HIGH,
302 			"owl-uart", port);
303 	if (ret)
304 		return ret;
305 
306 	spin_lock_irqsave(&port->lock, flags);
307 
308 	val = owl_uart_read(port, OWL_UART_STAT);
309 	val |= OWL_UART_STAT_RIP | OWL_UART_STAT_TIP
310 		| OWL_UART_STAT_RXER | OWL_UART_STAT_TFER | OWL_UART_STAT_RXST;
311 	owl_uart_write(port, val, OWL_UART_STAT);
312 
313 	val = owl_uart_read(port, OWL_UART_CTL);
314 	val |= OWL_UART_CTL_RXIE | OWL_UART_CTL_TXIE;
315 	val |= OWL_UART_CTL_EN;
316 	owl_uart_write(port, val, OWL_UART_CTL);
317 
318 	spin_unlock_irqrestore(&port->lock, flags);
319 
320 	return 0;
321 }
322 
323 static void owl_uart_change_baudrate(struct owl_uart_port *owl_port,
324 				     unsigned long baud)
325 {
326 	clk_set_rate(owl_port->clk, baud * 8);
327 }
328 
329 static void owl_uart_set_termios(struct uart_port *port,
330 				 struct ktermios *termios,
331 				 const struct ktermios *old)
332 {
333 	struct owl_uart_port *owl_port = to_owl_uart_port(port);
334 	unsigned int baud;
335 	u32 ctl;
336 	unsigned long flags;
337 
338 	spin_lock_irqsave(&port->lock, flags);
339 
340 	ctl = owl_uart_read(port, OWL_UART_CTL);
341 
342 	ctl &= ~OWL_UART_CTL_DWLS_MASK;
343 	switch (termios->c_cflag & CSIZE) {
344 	case CS5:
345 		ctl |= OWL_UART_CTL_DWLS_5BITS;
346 		break;
347 	case CS6:
348 		ctl |= OWL_UART_CTL_DWLS_6BITS;
349 		break;
350 	case CS7:
351 		ctl |= OWL_UART_CTL_DWLS_7BITS;
352 		break;
353 	case CS8:
354 	default:
355 		ctl |= OWL_UART_CTL_DWLS_8BITS;
356 		break;
357 	}
358 
359 	if (termios->c_cflag & CSTOPB)
360 		ctl |= OWL_UART_CTL_STPS_2BITS;
361 	else
362 		ctl &= ~OWL_UART_CTL_STPS_2BITS;
363 
364 	ctl &= ~OWL_UART_CTL_PRS_MASK;
365 	if (termios->c_cflag & PARENB) {
366 		if (termios->c_cflag & CMSPAR) {
367 			if (termios->c_cflag & PARODD)
368 				ctl |= OWL_UART_CTL_PRS_MARK;
369 			else
370 				ctl |= OWL_UART_CTL_PRS_SPACE;
371 		} else if (termios->c_cflag & PARODD)
372 			ctl |= OWL_UART_CTL_PRS_ODD;
373 		else
374 			ctl |= OWL_UART_CTL_PRS_EVEN;
375 	} else
376 		ctl |= OWL_UART_CTL_PRS_NONE;
377 
378 	if (termios->c_cflag & CRTSCTS)
379 		ctl |= OWL_UART_CTL_AFE;
380 	else
381 		ctl &= ~OWL_UART_CTL_AFE;
382 
383 	owl_uart_write(port, ctl, OWL_UART_CTL);
384 
385 	baud = uart_get_baud_rate(port, termios, old, 9600, 3200000);
386 	owl_uart_change_baudrate(owl_port, baud);
387 
388 	/* Don't rewrite B0 */
389 	if (tty_termios_baud_rate(termios))
390 		tty_termios_encode_baud_rate(termios, baud, baud);
391 
392 	port->read_status_mask |= OWL_UART_STAT_RXER;
393 	if (termios->c_iflag & INPCK)
394 		port->read_status_mask |= OWL_UART_STAT_RXST;
395 
396 	uart_update_timeout(port, termios->c_cflag, baud);
397 
398 	spin_unlock_irqrestore(&port->lock, flags);
399 }
400 
401 static void owl_uart_release_port(struct uart_port *port)
402 {
403 	struct platform_device *pdev = to_platform_device(port->dev);
404 	struct resource *res;
405 
406 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
407 	if (!res)
408 		return;
409 
410 	if (port->flags & UPF_IOREMAP) {
411 		devm_release_mem_region(port->dev, port->mapbase,
412 			resource_size(res));
413 		devm_iounmap(port->dev, port->membase);
414 		port->membase = NULL;
415 	}
416 }
417 
418 static int owl_uart_request_port(struct uart_port *port)
419 {
420 	struct platform_device *pdev = to_platform_device(port->dev);
421 	struct resource *res;
422 
423 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
424 	if (!res)
425 		return -ENXIO;
426 
427 	if (!devm_request_mem_region(port->dev, port->mapbase,
428 			resource_size(res), dev_name(port->dev)))
429 		return -EBUSY;
430 
431 	if (port->flags & UPF_IOREMAP) {
432 		port->membase = devm_ioremap(port->dev, port->mapbase,
433 				resource_size(res));
434 		if (!port->membase)
435 			return -EBUSY;
436 	}
437 
438 	return 0;
439 }
440 
441 static const char *owl_uart_type(struct uart_port *port)
442 {
443 	return (port->type == PORT_OWL) ? "owl-uart" : NULL;
444 }
445 
446 static int owl_uart_verify_port(struct uart_port *port,
447 				struct serial_struct *ser)
448 {
449 	if (port->type != PORT_OWL)
450 		return -EINVAL;
451 
452 	if (port->irq != ser->irq)
453 		return -EINVAL;
454 
455 	return 0;
456 }
457 
458 static void owl_uart_config_port(struct uart_port *port, int flags)
459 {
460 	if (flags & UART_CONFIG_TYPE) {
461 		port->type = PORT_OWL;
462 		owl_uart_request_port(port);
463 	}
464 }
465 
466 #ifdef CONFIG_CONSOLE_POLL
467 
468 static int owl_uart_poll_get_char(struct uart_port *port)
469 {
470 	if (owl_uart_read(port, OWL_UART_STAT) & OWL_UART_STAT_RFEM)
471 		return NO_POLL_CHAR;
472 
473 	return owl_uart_read(port, OWL_UART_RXDAT);
474 }
475 
476 static void owl_uart_poll_put_char(struct uart_port *port, unsigned char ch)
477 {
478 	u32 reg;
479 	int ret;
480 
481 	/* Wait while FIFO is full or timeout */
482 	ret = readl_poll_timeout_atomic(port->membase + OWL_UART_STAT, reg,
483 					!(reg & OWL_UART_STAT_TFFU),
484 					OWL_UART_POLL_USEC,
485 					OWL_UART_TIMEOUT_USEC);
486 	if (ret == -ETIMEDOUT) {
487 		dev_err(port->dev, "Timeout waiting while UART TX FULL\n");
488 		return;
489 	}
490 
491 	owl_uart_write(port, ch, OWL_UART_TXDAT);
492 }
493 
494 #endif /* CONFIG_CONSOLE_POLL */
495 
496 static const struct uart_ops owl_uart_ops = {
497 	.set_mctrl = owl_uart_set_mctrl,
498 	.get_mctrl = owl_uart_get_mctrl,
499 	.tx_empty = owl_uart_tx_empty,
500 	.start_tx = owl_uart_start_tx,
501 	.stop_rx = owl_uart_stop_rx,
502 	.stop_tx = owl_uart_stop_tx,
503 	.startup = owl_uart_startup,
504 	.shutdown = owl_uart_shutdown,
505 	.set_termios = owl_uart_set_termios,
506 	.type = owl_uart_type,
507 	.config_port = owl_uart_config_port,
508 	.request_port = owl_uart_request_port,
509 	.release_port = owl_uart_release_port,
510 	.verify_port = owl_uart_verify_port,
511 #ifdef CONFIG_CONSOLE_POLL
512 	.poll_get_char = owl_uart_poll_get_char,
513 	.poll_put_char = owl_uart_poll_put_char,
514 #endif
515 };
516 
517 #ifdef CONFIG_SERIAL_OWL_CONSOLE
518 
519 static void owl_console_putchar(struct uart_port *port, unsigned char ch)
520 {
521 	if (!port->membase)
522 		return;
523 
524 	while (owl_uart_read(port, OWL_UART_STAT) & OWL_UART_STAT_TFFU)
525 		cpu_relax();
526 
527 	owl_uart_write(port, ch, OWL_UART_TXDAT);
528 }
529 
530 static void owl_uart_port_write(struct uart_port *port, const char *s,
531 				u_int count)
532 {
533 	u32 old_ctl, val;
534 	unsigned long flags;
535 	int locked;
536 
537 	local_irq_save(flags);
538 
539 	if (port->sysrq)
540 		locked = 0;
541 	else if (oops_in_progress)
542 		locked = spin_trylock(&port->lock);
543 	else {
544 		spin_lock(&port->lock);
545 		locked = 1;
546 	}
547 
548 	old_ctl = owl_uart_read(port, OWL_UART_CTL);
549 	val = old_ctl | OWL_UART_CTL_TRFS_TX;
550 	/* disable IRQ */
551 	val &= ~(OWL_UART_CTL_RXIE | OWL_UART_CTL_TXIE);
552 	owl_uart_write(port, val, OWL_UART_CTL);
553 
554 	uart_console_write(port, s, count, owl_console_putchar);
555 
556 	/* wait until all contents have been sent out */
557 	while (owl_uart_read(port, OWL_UART_STAT) & OWL_UART_STAT_TRFL_MASK)
558 		cpu_relax();
559 
560 	/* clear IRQ pending */
561 	val = owl_uart_read(port, OWL_UART_STAT);
562 	val |= OWL_UART_STAT_TIP | OWL_UART_STAT_RIP;
563 	owl_uart_write(port, val, OWL_UART_STAT);
564 
565 	owl_uart_write(port, old_ctl, OWL_UART_CTL);
566 
567 	if (locked)
568 		spin_unlock(&port->lock);
569 
570 	local_irq_restore(flags);
571 }
572 
573 static void owl_uart_console_write(struct console *co, const char *s,
574 				   u_int count)
575 {
576 	struct owl_uart_port *owl_port;
577 
578 	owl_port = owl_uart_ports[co->index];
579 	if (!owl_port)
580 		return;
581 
582 	owl_uart_port_write(&owl_port->port, s, count);
583 }
584 
585 static int owl_uart_console_setup(struct console *co, char *options)
586 {
587 	struct owl_uart_port *owl_port;
588 	int baud = 115200;
589 	int bits = 8;
590 	int parity = 'n';
591 	int flow = 'n';
592 
593 	if (co->index < 0 || co->index >= OWL_UART_PORT_NUM)
594 		return -EINVAL;
595 
596 	owl_port = owl_uart_ports[co->index];
597 	if (!owl_port || !owl_port->port.membase)
598 		return -ENODEV;
599 
600 	if (options)
601 		uart_parse_options(options, &baud, &parity, &bits, &flow);
602 
603 	return uart_set_options(&owl_port->port, co, baud, parity, bits, flow);
604 }
605 
606 static struct console owl_uart_console = {
607 	.name = OWL_UART_DEV_NAME,
608 	.write = owl_uart_console_write,
609 	.device = uart_console_device,
610 	.setup = owl_uart_console_setup,
611 	.flags = CON_PRINTBUFFER,
612 	.index = -1,
613 	.data = &owl_uart_driver,
614 };
615 
616 static int __init owl_uart_console_init(void)
617 {
618 	register_console(&owl_uart_console);
619 
620 	return 0;
621 }
622 console_initcall(owl_uart_console_init);
623 
624 static void owl_uart_early_console_write(struct console *co,
625 					 const char *s,
626 					 u_int count)
627 {
628 	struct earlycon_device *dev = co->data;
629 
630 	owl_uart_port_write(&dev->port, s, count);
631 }
632 
633 static int __init
634 owl_uart_early_console_setup(struct earlycon_device *device, const char *opt)
635 {
636 	if (!device->port.membase)
637 		return -ENODEV;
638 
639 	device->con->write = owl_uart_early_console_write;
640 
641 	return 0;
642 }
643 OF_EARLYCON_DECLARE(owl, "actions,owl-uart",
644 		    owl_uart_early_console_setup);
645 
646 #define OWL_UART_CONSOLE (&owl_uart_console)
647 #else
648 #define OWL_UART_CONSOLE NULL
649 #endif
650 
651 static struct uart_driver owl_uart_driver = {
652 	.owner = THIS_MODULE,
653 	.driver_name = "owl-uart",
654 	.dev_name = OWL_UART_DEV_NAME,
655 	.nr = OWL_UART_PORT_NUM,
656 	.cons = OWL_UART_CONSOLE,
657 };
658 
659 static const struct owl_uart_info owl_s500_info = {
660 	.tx_fifosize = 16,
661 };
662 
663 static const struct owl_uart_info owl_s900_info = {
664 	.tx_fifosize = 32,
665 };
666 
667 static const struct of_device_id owl_uart_dt_matches[] = {
668 	{ .compatible = "actions,s500-uart", .data = &owl_s500_info },
669 	{ .compatible = "actions,s900-uart", .data = &owl_s900_info },
670 	{ }
671 };
672 MODULE_DEVICE_TABLE(of, owl_uart_dt_matches);
673 
674 static int owl_uart_probe(struct platform_device *pdev)
675 {
676 	const struct of_device_id *match;
677 	const struct owl_uart_info *info = NULL;
678 	struct resource *res_mem;
679 	struct owl_uart_port *owl_port;
680 	int ret, irq;
681 
682 	if (pdev->dev.of_node) {
683 		pdev->id = of_alias_get_id(pdev->dev.of_node, "serial");
684 		match = of_match_node(owl_uart_dt_matches, pdev->dev.of_node);
685 		if (match)
686 			info = match->data;
687 	}
688 
689 	if (pdev->id < 0 || pdev->id >= OWL_UART_PORT_NUM) {
690 		dev_err(&pdev->dev, "id %d out of range\n", pdev->id);
691 		return -EINVAL;
692 	}
693 
694 	res_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
695 	if (!res_mem) {
696 		dev_err(&pdev->dev, "could not get mem\n");
697 		return -ENODEV;
698 	}
699 
700 	irq = platform_get_irq(pdev, 0);
701 	if (irq < 0)
702 		return irq;
703 
704 	if (owl_uart_ports[pdev->id]) {
705 		dev_err(&pdev->dev, "port %d already allocated\n", pdev->id);
706 		return -EBUSY;
707 	}
708 
709 	owl_port = devm_kzalloc(&pdev->dev, sizeof(*owl_port), GFP_KERNEL);
710 	if (!owl_port)
711 		return -ENOMEM;
712 
713 	owl_port->clk = devm_clk_get(&pdev->dev, NULL);
714 	if (IS_ERR(owl_port->clk)) {
715 		dev_err(&pdev->dev, "could not get clk\n");
716 		return PTR_ERR(owl_port->clk);
717 	}
718 
719 	ret = clk_prepare_enable(owl_port->clk);
720 	if (ret) {
721 		dev_err(&pdev->dev, "could not enable clk\n");
722 		return ret;
723 	}
724 
725 	owl_port->port.dev = &pdev->dev;
726 	owl_port->port.line = pdev->id;
727 	owl_port->port.type = PORT_OWL;
728 	owl_port->port.iotype = UPIO_MEM;
729 	owl_port->port.mapbase = res_mem->start;
730 	owl_port->port.irq = irq;
731 	owl_port->port.uartclk = clk_get_rate(owl_port->clk);
732 	if (owl_port->port.uartclk == 0) {
733 		dev_err(&pdev->dev, "clock rate is zero\n");
734 		clk_disable_unprepare(owl_port->clk);
735 		return -EINVAL;
736 	}
737 	owl_port->port.flags = UPF_BOOT_AUTOCONF | UPF_IOREMAP | UPF_LOW_LATENCY;
738 	owl_port->port.x_char = 0;
739 	owl_port->port.fifosize = (info) ? info->tx_fifosize : 16;
740 	owl_port->port.ops = &owl_uart_ops;
741 
742 	owl_uart_ports[pdev->id] = owl_port;
743 	platform_set_drvdata(pdev, owl_port);
744 
745 	ret = uart_add_one_port(&owl_uart_driver, &owl_port->port);
746 	if (ret)
747 		owl_uart_ports[pdev->id] = NULL;
748 
749 	return ret;
750 }
751 
752 static int owl_uart_remove(struct platform_device *pdev)
753 {
754 	struct owl_uart_port *owl_port = platform_get_drvdata(pdev);
755 
756 	uart_remove_one_port(&owl_uart_driver, &owl_port->port);
757 	owl_uart_ports[pdev->id] = NULL;
758 	clk_disable_unprepare(owl_port->clk);
759 
760 	return 0;
761 }
762 
763 static struct platform_driver owl_uart_platform_driver = {
764 	.probe = owl_uart_probe,
765 	.remove = owl_uart_remove,
766 	.driver = {
767 		.name = "owl-uart",
768 		.of_match_table = owl_uart_dt_matches,
769 	},
770 };
771 
772 static int __init owl_uart_init(void)
773 {
774 	int ret;
775 
776 	ret = uart_register_driver(&owl_uart_driver);
777 	if (ret)
778 		return ret;
779 
780 	ret = platform_driver_register(&owl_uart_platform_driver);
781 	if (ret)
782 		uart_unregister_driver(&owl_uart_driver);
783 
784 	return ret;
785 }
786 
787 static void __exit owl_uart_exit(void)
788 {
789 	platform_driver_unregister(&owl_uart_platform_driver);
790 	uart_unregister_driver(&owl_uart_driver);
791 }
792 
793 module_init(owl_uart_init);
794 module_exit(owl_uart_exit);
795 
796 MODULE_LICENSE("GPL");
797