]>
Commit | Line | Data |
---|---|---|
8d38a5b2 AB |
1 | /* |
2 | * Serial Port driver for Open Firmware platform devices | |
3 | * | |
4 | * Copyright (C) 2006 Arnd Bergmann <arnd@arndb.de>, IBM Corp. | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or | |
7 | * modify it under the terms of the GNU General Public License | |
8 | * as published by the Free Software Foundation; either version | |
9 | * 2 of the License, or (at your option) any later version. | |
10 | * | |
11 | */ | |
8ad3b135 | 12 | #include <linux/console.h> |
8d38a5b2 | 13 | #include <linux/module.h> |
5a0e3ad6 | 14 | #include <linux/slab.h> |
bf03f65b | 15 | #include <linux/delay.h> |
8d38a5b2 | 16 | #include <linux/serial_core.h> |
bf03f65b | 17 | #include <linux/serial_reg.h> |
f1ca09b2 | 18 | #include <linux/of_address.h> |
73930a85 | 19 | #include <linux/of_irq.h> |
c401b044 | 20 | #include <linux/of_platform.h> |
5886188d | 21 | #include <linux/nwpserial.h> |
0bbeb3c3 | 22 | #include <linux/clk.h> |
8d38a5b2 | 23 | |
ed4492fa MS |
24 | #ifdef CONFIG_SERIAL_8250_MODULE |
25 | #define CONFIG_SERIAL_8250 CONFIG_SERIAL_8250_MODULE | |
26 | #endif | |
27 | ||
b0b8c84c HK |
28 | #include "8250/8250.h" |
29 | ||
e34b9c94 | 30 | struct of_serial_info { |
0bbeb3c3 | 31 | struct clk *clk; |
e34b9c94 IK |
32 | int type; |
33 | int line; | |
34 | }; | |
35 | ||
bf03f65b DW |
36 | #ifdef CONFIG_ARCH_TEGRA |
37 | void tegra_serial_handle_break(struct uart_port *p) | |
38 | { | |
39 | unsigned int status, tmout = 10000; | |
40 | ||
41 | do { | |
42 | status = p->serial_in(p, UART_LSR); | |
43 | if (status & (UART_LSR_FIFOE | UART_LSR_BRK_ERROR_BITS)) | |
44 | status = p->serial_in(p, UART_RX); | |
45 | else | |
46 | break; | |
47 | if (--tmout == 0) | |
48 | break; | |
49 | udelay(1); | |
50 | } while (1); | |
51 | } | |
f26402e8 SW |
52 | #else |
53 | static inline void tegra_serial_handle_break(struct uart_port *port) | |
54 | { | |
55 | } | |
bf03f65b DW |
56 | #endif |
57 | ||
8d38a5b2 AB |
58 | /* |
59 | * Fill a struct uart_port for a given device node | |
60 | */ | |
9671f099 | 61 | static int of_platform_serial_setup(struct platform_device *ofdev, |
0bbeb3c3 MK |
62 | int type, struct uart_port *port, |
63 | struct of_serial_info *info) | |
8d38a5b2 AB |
64 | { |
65 | struct resource resource; | |
61c7a080 | 66 | struct device_node *np = ofdev->dev.of_node; |
b84e7731 GL |
67 | u32 clk, spd, prop; |
68 | int ret; | |
8d38a5b2 AB |
69 | |
70 | memset(port, 0, sizeof *port); | |
b84e7731 | 71 | if (of_property_read_u32(np, "clock-frequency", &clk)) { |
0bbeb3c3 MK |
72 | |
73 | /* Get clk rate through clk driver if present */ | |
3a63d224 | 74 | info->clk = devm_clk_get(&ofdev->dev, NULL); |
76cc4386 | 75 | if (IS_ERR(info->clk)) { |
0bbeb3c3 MK |
76 | dev_warn(&ofdev->dev, |
77 | "clk or clock-frequency not defined\n"); | |
76cc4386 | 78 | return PTR_ERR(info->clk); |
0bbeb3c3 MK |
79 | } |
80 | ||
6f0c3091 MY |
81 | ret = clk_prepare_enable(info->clk); |
82 | if (ret < 0) | |
83 | return ret; | |
84 | ||
0bbeb3c3 | 85 | clk = clk_get_rate(info->clk); |
8d38a5b2 | 86 | } |
b84e7731 GL |
87 | /* If current-speed was set, then try not to change it. */ |
88 | if (of_property_read_u32(np, "current-speed", &spd) == 0) | |
89 | port->custom_divisor = clk / (16 * spd); | |
8d38a5b2 AB |
90 | |
91 | ret = of_address_to_resource(np, 0, &resource); | |
92 | if (ret) { | |
93 | dev_warn(&ofdev->dev, "invalid address\n"); | |
0bbeb3c3 | 94 | goto out; |
8d38a5b2 AB |
95 | } |
96 | ||
97 | spin_lock_init(&port->lock); | |
98 | port->mapbase = resource.start; | |
07876912 | 99 | port->mapsize = resource_size(&resource); |
b912b5e2 JL |
100 | |
101 | /* Check for shifted address mapping */ | |
b84e7731 GL |
102 | if (of_property_read_u32(np, "reg-offset", &prop) == 0) |
103 | port->mapbase += prop; | |
b912b5e2 JL |
104 | |
105 | /* Check for registers offset within the devices address range */ | |
b84e7731 GL |
106 | if (of_property_read_u32(np, "reg-shift", &prop) == 0) |
107 | port->regshift = prop; | |
b912b5e2 | 108 | |
9f1ca068 HK |
109 | /* Check for fifo size */ |
110 | if (of_property_read_u32(np, "fifo-size", &prop) == 0) | |
111 | port->fifosize = prop; | |
112 | ||
3239fd31 LS |
113 | /* Check for a fixed line number */ |
114 | ret = of_alias_get_id(np, "serial"); | |
115 | if (ret >= 0) | |
116 | port->line = ret; | |
117 | ||
8d38a5b2 AB |
118 | port->irq = irq_of_parse_and_map(np, 0); |
119 | port->iotype = UPIO_MEM; | |
b84e7731 GL |
120 | if (of_property_read_u32(np, "reg-io-width", &prop) == 0) { |
121 | switch (prop) { | |
7423734e JI |
122 | case 1: |
123 | port->iotype = UPIO_MEM; | |
124 | break; | |
bd94c407 MY |
125 | case 2: |
126 | port->iotype = UPIO_MEM16; | |
127 | break; | |
7423734e | 128 | case 4: |
ebc5e200 KC |
129 | port->iotype = of_device_is_big_endian(np) ? |
130 | UPIO_MEM32BE : UPIO_MEM32; | |
7423734e JI |
131 | break; |
132 | default: | |
b84e7731 GL |
133 | dev_warn(&ofdev->dev, "unsupported reg-io-width (%d)\n", |
134 | prop); | |
0bbeb3c3 MK |
135 | ret = -EINVAL; |
136 | goto out; | |
7423734e JI |
137 | } |
138 | } | |
139 | ||
8d38a5b2 | 140 | port->type = type; |
b84e7731 | 141 | port->uartclk = clk; |
abb4a239 | 142 | port->flags = UPF_SHARE_IRQ | UPF_BOOT_AUTOCONF | UPF_IOREMAP |
eedacbf0 | 143 | | UPF_FIXED_PORT | UPF_FIXED_TYPE; |
fde8be29 GJ |
144 | |
145 | if (of_find_property(np, "no-loopback-test", NULL)) | |
146 | port->flags |= UPF_SKIP_TEST; | |
147 | ||
8d38a5b2 | 148 | port->dev = &ofdev->dev; |
8d38a5b2 | 149 | |
9b8777e3 JC |
150 | switch (type) { |
151 | case PORT_TEGRA: | |
bf03f65b | 152 | port->handle_break = tegra_serial_handle_break; |
9b8777e3 JC |
153 | break; |
154 | ||
155 | case PORT_RT2880: | |
156 | port->iotype = UPIO_AU; | |
157 | break; | |
158 | } | |
bf03f65b | 159 | |
d43b54d2 SW |
160 | if (IS_ENABLED(CONFIG_SERIAL_8250_FSL) && |
161 | (of_device_is_compatible(np, "fsl,ns16550") || | |
162 | of_device_is_compatible(np, "fsl,16550-FIFO64"))) | |
163 | port->handle_irq = fsl8250_handle_irq; | |
164 | ||
8d38a5b2 | 165 | return 0; |
0bbeb3c3 MK |
166 | out: |
167 | if (info->clk) | |
168 | clk_disable_unprepare(info->clk); | |
169 | return ret; | |
8d38a5b2 AB |
170 | } |
171 | ||
172 | /* | |
173 | * Try to register a serial port | |
174 | */ | |
ed0bb232 | 175 | static const struct of_device_id of_platform_serial_table[]; |
9671f099 | 176 | static int of_platform_serial_probe(struct platform_device *ofdev) |
8d38a5b2 | 177 | { |
b1608d69 | 178 | const struct of_device_id *match; |
e34b9c94 | 179 | struct of_serial_info *info; |
8d38a5b2 AB |
180 | struct uart_port port; |
181 | int port_type; | |
182 | int ret; | |
183 | ||
b1608d69 GL |
184 | match = of_match_device(of_platform_serial_table, &ofdev->dev); |
185 | if (!match) | |
793218df GL |
186 | return -EINVAL; |
187 | ||
61c7a080 | 188 | if (of_find_property(ofdev->dev.of_node, "used-by-rtas", NULL)) |
8d38a5b2 AB |
189 | return -EBUSY; |
190 | ||
7e12e675 | 191 | info = kzalloc(sizeof(*info), GFP_KERNEL); |
e34b9c94 IK |
192 | if (info == NULL) |
193 | return -ENOMEM; | |
194 | ||
b1608d69 | 195 | port_type = (unsigned long)match->data; |
0bbeb3c3 | 196 | ret = of_platform_serial_setup(ofdev, port_type, &port, info); |
8d38a5b2 AB |
197 | if (ret) |
198 | goto out; | |
199 | ||
200 | switch (port_type) { | |
5886188d | 201 | #ifdef CONFIG_SERIAL_8250 |
8d38a5b2 | 202 | case PORT_8250 ... PORT_MAX_8250: |
ce7240e4 | 203 | { |
ce7240e4 AC |
204 | struct uart_8250_port port8250; |
205 | memset(&port8250, 0, sizeof(port8250)); | |
206 | port8250.port = port; | |
b0b8c84c HK |
207 | |
208 | if (port.fifosize) | |
209 | port8250.capabilities = UART_CAP_FIFO; | |
210 | ||
211 | if (of_property_read_bool(ofdev->dev.of_node, | |
212 | "auto-flow-control")) | |
213 | port8250.capabilities |= UART_CAP_AFE; | |
214 | ||
ce7240e4 | 215 | ret = serial8250_register_8250_port(&port8250); |
8d38a5b2 | 216 | break; |
ce7240e4 | 217 | } |
5886188d BK |
218 | #endif |
219 | #ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL | |
220 | case PORT_NWPSERIAL: | |
221 | ret = nwpserial_register_port(&port); | |
222 | break; | |
223 | #endif | |
8d38a5b2 AB |
224 | default: |
225 | /* need to add code for these */ | |
1558f9b4 IK |
226 | case PORT_UNKNOWN: |
227 | dev_info(&ofdev->dev, "Unknown serial port found, ignored\n"); | |
8d38a5b2 AB |
228 | ret = -ENODEV; |
229 | break; | |
230 | } | |
231 | if (ret < 0) | |
232 | goto out; | |
233 | ||
e34b9c94 IK |
234 | info->type = port_type; |
235 | info->line = ret; | |
696faedd | 236 | platform_set_drvdata(ofdev, info); |
8d38a5b2 AB |
237 | return 0; |
238 | out: | |
e34b9c94 | 239 | kfree(info); |
8d38a5b2 AB |
240 | irq_dispose_mapping(port.irq); |
241 | return ret; | |
242 | } | |
243 | ||
244 | /* | |
245 | * Release a line | |
246 | */ | |
2dc11581 | 247 | static int of_platform_serial_remove(struct platform_device *ofdev) |
8d38a5b2 | 248 | { |
696faedd | 249 | struct of_serial_info *info = platform_get_drvdata(ofdev); |
e34b9c94 | 250 | switch (info->type) { |
5886188d | 251 | #ifdef CONFIG_SERIAL_8250 |
e34b9c94 IK |
252 | case PORT_8250 ... PORT_MAX_8250: |
253 | serial8250_unregister_port(info->line); | |
254 | break; | |
5886188d BK |
255 | #endif |
256 | #ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL | |
257 | case PORT_NWPSERIAL: | |
258 | nwpserial_unregister_port(info->line); | |
259 | break; | |
260 | #endif | |
e34b9c94 IK |
261 | default: |
262 | /* need to add code for these */ | |
263 | break; | |
264 | } | |
0bbeb3c3 MK |
265 | |
266 | if (info->clk) | |
267 | clk_disable_unprepare(info->clk); | |
e34b9c94 | 268 | kfree(info); |
8d38a5b2 AB |
269 | return 0; |
270 | } | |
271 | ||
8ad3b135 JL |
272 | #ifdef CONFIG_PM_SLEEP |
273 | #ifdef CONFIG_SERIAL_8250 | |
274 | static void of_serial_suspend_8250(struct of_serial_info *info) | |
275 | { | |
276 | struct uart_8250_port *port8250 = serial8250_get_port(info->line); | |
277 | struct uart_port *port = &port8250->port; | |
278 | ||
279 | serial8250_suspend_port(info->line); | |
280 | if (info->clk && (!uart_console(port) || console_suspend_enabled)) | |
281 | clk_disable_unprepare(info->clk); | |
282 | } | |
283 | ||
284 | static void of_serial_resume_8250(struct of_serial_info *info) | |
285 | { | |
286 | struct uart_8250_port *port8250 = serial8250_get_port(info->line); | |
287 | struct uart_port *port = &port8250->port; | |
288 | ||
289 | if (info->clk && (!uart_console(port) || console_suspend_enabled)) | |
290 | clk_prepare_enable(info->clk); | |
291 | ||
292 | serial8250_resume_port(info->line); | |
293 | } | |
294 | #else | |
295 | static inline void of_serial_suspend_8250(struct of_serial_info *info) | |
296 | { | |
297 | } | |
298 | ||
299 | static inline void of_serial_resume_8250(struct of_serial_info *info) | |
300 | { | |
301 | } | |
302 | #endif | |
303 | ||
304 | static int of_serial_suspend(struct device *dev) | |
305 | { | |
306 | struct of_serial_info *info = dev_get_drvdata(dev); | |
307 | ||
308 | switch (info->type) { | |
309 | case PORT_8250 ... PORT_MAX_8250: | |
310 | of_serial_suspend_8250(info); | |
311 | break; | |
312 | default: | |
313 | break; | |
314 | } | |
315 | ||
316 | return 0; | |
317 | } | |
318 | ||
319 | static int of_serial_resume(struct device *dev) | |
320 | { | |
321 | struct of_serial_info *info = dev_get_drvdata(dev); | |
322 | ||
323 | switch (info->type) { | |
324 | case PORT_8250 ... PORT_MAX_8250: | |
325 | of_serial_resume_8250(info); | |
326 | break; | |
327 | default: | |
328 | break; | |
329 | } | |
330 | ||
331 | return 0; | |
332 | } | |
333 | #endif | |
334 | static SIMPLE_DEV_PM_OPS(of_serial_pm_ops, of_serial_suspend, of_serial_resume); | |
335 | ||
8d38a5b2 AB |
336 | /* |
337 | * A few common types, add more as needed. | |
338 | */ | |
ed0bb232 | 339 | static const struct of_device_id of_platform_serial_table[] = { |
8c6e9112 GL |
340 | { .compatible = "ns8250", .data = (void *)PORT_8250, }, |
341 | { .compatible = "ns16450", .data = (void *)PORT_16450, }, | |
342 | { .compatible = "ns16550a", .data = (void *)PORT_16550A, }, | |
343 | { .compatible = "ns16550", .data = (void *)PORT_16550, }, | |
344 | { .compatible = "ns16750", .data = (void *)PORT_16750, }, | |
345 | { .compatible = "ns16850", .data = (void *)PORT_16850, }, | |
2e39e5be | 346 | { .compatible = "nvidia,tegra20-uart", .data = (void *)PORT_TEGRA, }, |
e4305f0c | 347 | { .compatible = "nxp,lpc3220-uart", .data = (void *)PORT_LPC3220, }, |
9b8777e3 | 348 | { .compatible = "ralink,rt2880-uart", .data = (void *)PORT_RT2880, }, |
e06c93ca LFT |
349 | { .compatible = "altr,16550-FIFO32", |
350 | .data = (void *)PORT_ALTR_16550_F32, }, | |
351 | { .compatible = "altr,16550-FIFO64", | |
352 | .data = (void *)PORT_ALTR_16550_F64, }, | |
353 | { .compatible = "altr,16550-FIFO128", | |
354 | .data = (void *)PORT_ALTR_16550_F128, }, | |
6ad991b6 RH |
355 | { .compatible = "mrvl,mmp-uart", |
356 | .data = (void *)PORT_XSCALE, }, | |
357 | { .compatible = "mrvl,pxa-uart", | |
358 | .data = (void *)PORT_XSCALE, }, | |
5886188d | 359 | #ifdef CONFIG_SERIAL_OF_PLATFORM_NWPSERIAL |
8c6e9112 GL |
360 | { .compatible = "ibm,qpace-nwp-serial", |
361 | .data = (void *)PORT_NWPSERIAL, }, | |
5886188d | 362 | #endif |
8d38a5b2 AB |
363 | { /* end of list */ }, |
364 | }; | |
8d58db1e | 365 | MODULE_DEVICE_TABLE(of, of_platform_serial_table); |
8d38a5b2 | 366 | |
793218df | 367 | static struct platform_driver of_platform_serial_driver = { |
4018294b GL |
368 | .driver = { |
369 | .name = "of_serial", | |
4018294b GL |
370 | .of_match_table = of_platform_serial_table, |
371 | }, | |
8d38a5b2 AB |
372 | .probe = of_platform_serial_probe, |
373 | .remove = of_platform_serial_remove, | |
8d38a5b2 AB |
374 | }; |
375 | ||
940ab889 | 376 | module_platform_driver(of_platform_serial_driver); |
8d38a5b2 AB |
377 | |
378 | MODULE_AUTHOR("Arnd Bergmann <arnd@arndb.de>"); | |
379 | MODULE_LICENSE("GPL"); | |
380 | MODULE_DESCRIPTION("Serial Port driver for Open Firmware platform devices"); |