2 * Copyright (C) 2015 Masahiro Yamada <yamada.masahiro@socionext.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 #include <linux/clk.h>
17 #include <linux/module.h>
19 #include <linux/platform_device.h>
23 /* Most (but not all) of UniPhier UART devices have 64-depth FIFO. */
24 #define UNIPHIER_UART_DEFAULT_FIFO_SIZE 64
26 #define UNIPHIER_UART_CHAR_FCR 3 /* Character / FIFO Control Register */
27 #define UNIPHIER_UART_LCR_MCR 4 /* Line/Modem Control Register */
28 #define UNIPHIER_UART_LCR_SHIFT 8
29 #define UNIPHIER_UART_DLR 9 /* Divisor Latch Register */
31 struct uniphier8250_priv {
34 spinlock_t atomic_write_lock;
38 * The register map is slightly different from that of 8250.
39 * IO callbacks must be overridden for correct access to FCR, LCR, and MCR.
41 static unsigned int uniphier_serial_in(struct uart_port *p, int offset)
43 unsigned int valshift = 0;
47 valshift = UNIPHIER_UART_LCR_SHIFT;
50 offset = UNIPHIER_UART_LCR_MCR;
56 offset <<= p->regshift;
59 * The return value must be masked with 0xff because LCR and MCR reside
60 * in the same register that must be accessed by 32-bit write/read.
61 * 8 or 16 bit access to this hardware result in unexpected behavior.
63 return (readl(p->membase + offset) >> valshift) & 0xff;
66 static void uniphier_serial_out(struct uart_port *p, int offset, int value)
68 unsigned int valshift = 0;
73 offset = UNIPHIER_UART_CHAR_FCR;
76 valshift = UNIPHIER_UART_LCR_SHIFT;
77 /* Divisor latch access bit does not exist. */
78 value &= ~(UART_LCR_DLAB << valshift);
81 offset = UNIPHIER_UART_LCR_MCR;
88 offset <<= p->regshift;
91 writel(value, p->membase + offset);
94 * Special case: two registers share the same address that
95 * must be 32-bit accessed. As this is not longer atomic safe,
96 * take a lock just in case.
98 struct uniphier8250_priv *priv = p->private_data;
102 spin_lock_irqsave(&priv->atomic_write_lock, flags);
103 tmp = readl(p->membase + offset);
104 tmp &= ~(0xff << valshift);
105 tmp |= value << valshift;
106 writel(tmp, p->membase + offset);
107 spin_unlock_irqrestore(&priv->atomic_write_lock, flags);
112 * This hardware does not have the divisor latch access bit.
113 * The divisor latch register exists at different address.
114 * Override dl_read/write callbacks.
116 static int uniphier_serial_dl_read(struct uart_8250_port *up)
118 int offset = UNIPHIER_UART_DLR << up->port.regshift;
120 return readl(up->port.membase + offset);
123 static void uniphier_serial_dl_write(struct uart_8250_port *up, int value)
125 int offset = UNIPHIER_UART_DLR << up->port.regshift;
127 writel(value, up->port.membase + offset);
130 static int uniphier_of_serial_setup(struct device *dev, struct uart_port *port,
131 struct uniphier8250_priv *priv)
135 struct device_node *np = dev->of_node;
137 ret = of_alias_get_id(np, "serial");
139 dev_err(dev, "failed to get alias id\n");
142 port->line = priv->line = ret;
144 /* Get clk rate through clk driver */
145 priv->clk = devm_clk_get(dev, NULL);
146 if (IS_ERR(priv->clk)) {
147 dev_err(dev, "failed to get clock\n");
148 return PTR_ERR(priv->clk);
151 ret = clk_prepare_enable(priv->clk);
155 port->uartclk = clk_get_rate(priv->clk);
157 /* Check for fifo size */
158 if (of_property_read_u32(np, "fifo-size", &prop) == 0)
159 port->fifosize = prop;
161 port->fifosize = UNIPHIER_UART_DEFAULT_FIFO_SIZE;
166 static int uniphier_uart_probe(struct platform_device *pdev)
168 struct device *dev = &pdev->dev;
169 struct uart_8250_port up;
170 struct uniphier8250_priv *priv;
171 struct resource *regs;
172 void __iomem *membase;
176 regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
178 dev_err(dev, "failed to get memory resource");
182 membase = devm_ioremap(dev, regs->start, resource_size(regs));
186 irq = platform_get_irq(pdev, 0);
188 dev_err(dev, "failed to get IRQ number");
192 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
196 memset(&up, 0, sizeof(up));
198 ret = uniphier_of_serial_setup(dev, &up.port, priv);
202 spin_lock_init(&priv->atomic_write_lock);
205 up.port.private_data = priv;
206 up.port.mapbase = regs->start;
207 up.port.mapsize = resource_size(regs);
208 up.port.membase = membase;
211 up.port.type = PORT_16550A;
212 up.port.iotype = UPIO_MEM32;
213 up.port.regshift = 2;
214 up.port.flags = UPF_FIXED_PORT | UPF_FIXED_TYPE;
215 up.capabilities = UART_CAP_FIFO;
217 up.port.serial_in = uniphier_serial_in;
218 up.port.serial_out = uniphier_serial_out;
219 up.dl_read = uniphier_serial_dl_read;
220 up.dl_write = uniphier_serial_dl_write;
222 ret = serial8250_register_8250_port(&up);
224 dev_err(dev, "failed to register 8250 port\n");
225 clk_disable_unprepare(priv->clk);
229 platform_set_drvdata(pdev, priv);
234 static int uniphier_uart_remove(struct platform_device *pdev)
236 struct uniphier8250_priv *priv = platform_get_drvdata(pdev);
238 serial8250_unregister_port(priv->line);
239 clk_disable_unprepare(priv->clk);
244 static const struct of_device_id uniphier_uart_match[] = {
245 { .compatible = "socionext,uniphier-uart" },
248 MODULE_DEVICE_TABLE(of, uniphier_uart_match);
250 static struct platform_driver uniphier_uart_platform_driver = {
251 .probe = uniphier_uart_probe,
252 .remove = uniphier_uart_remove,
254 .name = "uniphier-uart",
255 .of_match_table = uniphier_uart_match,
258 module_platform_driver(uniphier_uart_platform_driver);
260 MODULE_AUTHOR("Masahiro Yamada <yamada.masahiro@socionext.com>");
261 MODULE_DESCRIPTION("UniPhier UART driver");
262 MODULE_LICENSE("GPL");