Pull bugzilla-5737 into release branch
[linux-2.6] / arch / powerpc / kernel / legacy_serial.c
1 #include <linux/config.h>
2 #include <linux/kernel.h>
3 #include <linux/serial.h>
4 #include <linux/serial_8250.h>
5 #include <linux/serial_core.h>
6 #include <linux/console.h>
7 #include <linux/pci.h>
8 #include <asm/io.h>
9 #include <asm/mmu.h>
10 #include <asm/prom.h>
11 #include <asm/serial.h>
12 #include <asm/udbg.h>
13 #include <asm/pci-bridge.h>
14 #include <asm/ppc-pci.h>
15
16 #undef DEBUG
17
18 #ifdef DEBUG
19 #define DBG(fmt...) do { printk(fmt); } while(0)
20 #else
21 #define DBG(fmt...) do { } while(0)
22 #endif
23
24 #define MAX_LEGACY_SERIAL_PORTS 8
25
26 static struct plat_serial8250_port
27 legacy_serial_ports[MAX_LEGACY_SERIAL_PORTS+1];
28 static struct legacy_serial_info {
29         struct device_node              *np;
30         unsigned int                    speed;
31         unsigned int                    clock;
32         phys_addr_t                     taddr;
33 } legacy_serial_infos[MAX_LEGACY_SERIAL_PORTS];
34 static unsigned int legacy_serial_count;
35 static int legacy_serial_console = -1;
36
37 static int __init add_legacy_port(struct device_node *np, int want_index,
38                                   int iotype, phys_addr_t base,
39                                   phys_addr_t taddr, unsigned long irq,
40                                   upf_t flags)
41 {
42         u32 *clk, *spd, clock = BASE_BAUD * 16;
43         int index;
44
45         /* get clock freq. if present */
46         clk = (u32 *)get_property(np, "clock-frequency", NULL);
47         if (clk && *clk)
48                 clock = *clk;
49
50         /* get default speed if present */
51         spd = (u32 *)get_property(np, "current-speed", NULL);
52
53         /* If we have a location index, then try to use it */
54         if (want_index >= 0 && want_index < MAX_LEGACY_SERIAL_PORTS)
55                 index = want_index;
56         else
57                 index = legacy_serial_count;
58
59         /* if our index is still out of range, that mean that
60          * array is full, we could scan for a free slot but that
61          * make little sense to bother, just skip the port
62          */
63         if (index >= MAX_LEGACY_SERIAL_PORTS)
64                 return -1;
65         if (index >= legacy_serial_count)
66                 legacy_serial_count = index + 1;
67
68         /* Check if there is a port who already claimed our slot */
69         if (legacy_serial_infos[index].np != 0) {
70                 /* if we still have some room, move it, else override */
71                 if (legacy_serial_count < MAX_LEGACY_SERIAL_PORTS) {
72                         printk(KERN_INFO "Moved legacy port %d -> %d\n",
73                                index, legacy_serial_count);
74                         legacy_serial_ports[legacy_serial_count] =
75                                 legacy_serial_ports[index];
76                         legacy_serial_infos[legacy_serial_count] =
77                                 legacy_serial_infos[index];
78                         legacy_serial_count++;
79                 } else {
80                         printk(KERN_INFO "Replacing legacy port %d\n", index);
81                 }
82         }
83
84         /* Now fill the entry */
85         memset(&legacy_serial_ports[index], 0,
86                sizeof(struct plat_serial8250_port));
87         if (iotype == UPIO_PORT)
88                 legacy_serial_ports[index].iobase = base;
89         else
90                 legacy_serial_ports[index].mapbase = base;
91         legacy_serial_ports[index].iotype = iotype;
92         legacy_serial_ports[index].uartclk = clock;
93         legacy_serial_ports[index].irq = irq;
94         legacy_serial_ports[index].flags = flags;
95         legacy_serial_infos[index].taddr = taddr;
96         legacy_serial_infos[index].np = of_node_get(np);
97         legacy_serial_infos[index].clock = clock;
98         legacy_serial_infos[index].speed = spd ? *spd : 0;
99
100         printk(KERN_INFO "Found legacy serial port %d for %s\n",
101                index, np->full_name);
102         printk(KERN_INFO "  %s=%llx, taddr=%llx, irq=%lx, clk=%d, speed=%d\n",
103                (iotype == UPIO_PORT) ? "port" : "mem",
104                (unsigned long long)base, (unsigned long long)taddr, irq,
105                legacy_serial_ports[index].uartclk,
106                legacy_serial_infos[index].speed);
107
108         return index;
109 }
110
111 static int __init add_legacy_soc_port(struct device_node *np,
112                                       struct device_node *soc_dev)
113 {
114         phys_addr_t addr;
115         u32 *addrp;
116         upf_t flags = UPF_BOOT_AUTOCONF | UPF_SKIP_TEST | UPF_SHARE_IRQ;
117
118         /* We only support ports that have a clock frequency properly
119          * encoded in the device-tree.
120          */
121         if (get_property(np, "clock-frequency", NULL) == NULL)
122                 return -1;
123
124         /* Get the address */
125         addrp = of_get_address(soc_dev, 0, NULL, NULL);
126         if (addrp == NULL)
127                 return -1;
128
129         addr = of_translate_address(soc_dev, addrp);
130
131         /* Add port, irq will be dealt with later. We passed a translated
132          * IO port value. It will be fixed up later along with the irq
133          */
134         return add_legacy_port(np, -1, UPIO_MEM, addr, addr, NO_IRQ, flags);
135 }
136
137 static int __init add_legacy_isa_port(struct device_node *np,
138                                       struct device_node *isa_brg)
139 {
140         u32 *reg;
141         char *typep;
142         int index = -1;
143         phys_addr_t taddr;
144
145         /* Get the ISA port number */
146         reg = (u32 *)get_property(np, "reg", NULL);
147         if (reg == NULL)
148                 return -1;
149
150         /* Verify it's an IO port, we don't support anything else */
151         if (!(reg[0] & 0x00000001))
152                 return -1;
153
154         /* Now look for an "ibm,aix-loc" property that gives us ordering
155          * if any...
156          */
157         typep = (char *)get_property(np, "ibm,aix-loc", NULL);
158
159         /* If we have a location index, then use it */
160         if (typep && *typep == 'S')
161                 index = simple_strtol(typep+1, NULL, 0) - 1;
162
163         /* Translate ISA address */
164         taddr = of_translate_address(np, reg);
165
166         /* Add port, irq will be dealt with later */
167         return add_legacy_port(np, index, UPIO_PORT, reg[1], taddr, NO_IRQ, UPF_BOOT_AUTOCONF);
168
169 }
170
171 #ifdef CONFIG_PCI
172 static int __init add_legacy_pci_port(struct device_node *np,
173                                       struct device_node *pci_dev)
174 {
175         phys_addr_t addr, base;
176         u32 *addrp;
177         unsigned int flags;
178         int iotype, index = -1, lindex = 0;
179
180         /* We only support ports that have a clock frequency properly
181          * encoded in the device-tree (that is have an fcode). Anything
182          * else can't be used that early and will be normally probed by
183          * the generic 8250_pci driver later on. The reason is that 8250
184          * compatible UARTs on PCI need all sort of quirks (port offsets
185          * etc...) that this code doesn't know about
186          */
187         if (get_property(np, "clock-frequency", NULL) == NULL)
188                 return -1;
189
190         /* Get the PCI address. Assume BAR 0 */
191         addrp = of_get_pci_address(pci_dev, 0, NULL, &flags);
192         if (addrp == NULL)
193                 return -1;
194
195         /* We only support BAR 0 for now */
196         iotype = (flags & IORESOURCE_MEM) ? UPIO_MEM : UPIO_PORT;
197         addr = of_translate_address(pci_dev, addrp);
198
199         /* Set the IO base to the same as the translated address for MMIO,
200          * or to the domain local IO base for PIO (it will be fixed up later)
201          */
202         if (iotype == UPIO_MEM)
203                 base = addr;
204         else
205                 base = addrp[2];
206
207         /* Try to guess an index... If we have subdevices of the pci dev,
208          * we get to their "reg" property
209          */
210         if (np != pci_dev) {
211                 u32 *reg = (u32 *)get_property(np, "reg", NULL);
212                 if (reg && (*reg < 4))
213                         index = lindex = *reg;
214         }
215
216         /* Local index means it's the Nth port in the PCI chip. Unfortunately
217          * the offset to add here is device specific. We know about those
218          * EXAR ports and we default to the most common case. If your UART
219          * doesn't work for these settings, you'll have to add your own special
220          * cases here
221          */
222         if (device_is_compatible(pci_dev, "pci13a8,152") ||
223             device_is_compatible(pci_dev, "pci13a8,154") ||
224             device_is_compatible(pci_dev, "pci13a8,158")) {
225                 addr += 0x200 * lindex;
226                 base += 0x200 * lindex;
227         } else {
228                 addr += 8 * lindex;
229                 base += 8 * lindex;
230         }
231
232         /* Add port, irq will be dealt with later. We passed a translated
233          * IO port value. It will be fixed up later along with the irq
234          */
235         return add_legacy_port(np, index, iotype, base, addr, NO_IRQ, UPF_BOOT_AUTOCONF);
236 }
237 #endif
238
239 static void __init setup_legacy_serial_console(int console)
240 {
241         struct legacy_serial_info *info =
242                 &legacy_serial_infos[console];
243         void __iomem *addr;
244
245         if (info->taddr == 0)
246                 return;
247         addr = ioremap(info->taddr, 0x1000);
248         if (addr == NULL)
249                 return;
250         if (info->speed == 0)
251                 info->speed = udbg_probe_uart_speed(addr, info->clock);
252         DBG("default console speed = %d\n", info->speed);
253         udbg_init_uart(addr, info->speed, info->clock);
254 }
255
256 /*
257  * This is called very early, as part of setup_system() or eventually
258  * setup_arch(), basically before anything else in this file. This function
259  * will try to build a list of all the available 8250-compatible serial ports
260  * in the machine using the Open Firmware device-tree. It currently only deals
261  * with ISA and PCI busses but could be extended. It allows a very early boot
262  * console to be initialized, that list is also used later to provide 8250 with
263  * the machine non-PCI ports and to properly pick the default console port
264  */
265 void __init find_legacy_serial_ports(void)
266 {
267         struct device_node *np, *stdout = NULL;
268         char *path;
269         int index;
270
271         DBG(" -> find_legacy_serial_port()\n");
272
273         /* Now find out if one of these is out firmware console */
274         path = (char *)get_property(of_chosen, "linux,stdout-path", NULL);
275         if (path != NULL) {
276                 stdout = of_find_node_by_path(path);
277                 if (stdout)
278                         DBG("stdout is %s\n", stdout->full_name);
279         } else {
280                 DBG(" no linux,stdout-path !\n");
281         }
282
283         /* First fill our array with SOC ports */
284         for (np = NULL; (np = of_find_compatible_node(np, "serial", "ns16550")) != NULL;) {
285                 struct device_node *soc = of_get_parent(np);
286                 if (soc && !strcmp(soc->type, "soc")) {
287                         index = add_legacy_soc_port(np, np);
288                         if (index >= 0 && np == stdout)
289                                 legacy_serial_console = index;
290                 }
291                 of_node_put(soc);
292         }
293
294         /* First fill our array with ISA ports */
295         for (np = NULL; (np = of_find_node_by_type(np, "serial"));) {
296                 struct device_node *isa = of_get_parent(np);
297                 if (isa && !strcmp(isa->name, "isa")) {
298                         index = add_legacy_isa_port(np, isa);
299                         if (index >= 0 && np == stdout)
300                                 legacy_serial_console = index;
301                 }
302                 of_node_put(isa);
303         }
304
305 #ifdef CONFIG_PCI
306         /* Next, try to locate PCI ports */
307         for (np = NULL; (np = of_find_all_nodes(np));) {
308                 struct device_node *pci, *parent = of_get_parent(np);
309                 if (parent && !strcmp(parent->name, "isa")) {
310                         of_node_put(parent);
311                         continue;
312                 }
313                 if (strcmp(np->name, "serial") && strcmp(np->type, "serial")) {
314                         of_node_put(parent);
315                         continue;
316                 }
317                 /* Check for known pciclass, and also check wether we have
318                  * a device with child nodes for ports or not
319                  */
320                 if (device_is_compatible(np, "pciclass,0700") ||
321                     device_is_compatible(np, "pciclass,070002"))
322                         pci = np;
323                 else if (device_is_compatible(parent, "pciclass,0700") ||
324                          device_is_compatible(parent, "pciclass,070002"))
325                         pci = parent;
326                 else {
327                         of_node_put(parent);
328                         continue;
329                 }
330                 index = add_legacy_pci_port(np, pci);
331                 if (index >= 0 && np == stdout)
332                         legacy_serial_console = index;
333                 of_node_put(parent);
334         }
335 #endif
336
337         DBG("legacy_serial_console = %d\n", legacy_serial_console);
338         if (legacy_serial_console >= 0)
339                 setup_legacy_serial_console(legacy_serial_console);
340         DBG(" <- find_legacy_serial_port()\n");
341 }
342
343 static struct platform_device serial_device = {
344         .name   = "serial8250",
345         .id     = PLAT8250_DEV_PLATFORM,
346         .dev    = {
347                 .platform_data = legacy_serial_ports,
348         },
349 };
350
351 static void __init fixup_port_irq(int index,
352                                   struct device_node *np,
353                                   struct plat_serial8250_port *port)
354 {
355         DBG("fixup_port_irq(%d)\n", index);
356
357         /* Check for interrupts in that node */
358         if (np->n_intrs > 0) {
359                 port->irq = np->intrs[0].line;
360                 DBG(" port %d (%s), irq=%d\n",
361                     index, np->full_name, port->irq);
362                 return;
363         }
364
365         /* Check for interrupts in the parent */
366         np = of_get_parent(np);
367         if (np == NULL)
368                 return;
369
370         if (np->n_intrs > 0) {
371                 port->irq = np->intrs[0].line;
372                 DBG(" port %d (%s), irq=%d\n",
373                     index, np->full_name, port->irq);
374         }
375         of_node_put(np);
376 }
377
378 static void __init fixup_port_pio(int index,
379                                   struct device_node *np,
380                                   struct plat_serial8250_port *port)
381 {
382 #ifdef CONFIG_PCI
383         struct pci_controller *hose;
384
385         DBG("fixup_port_pio(%d)\n", index);
386
387         hose = pci_find_hose_for_OF_device(np);
388         if (hose) {
389                 unsigned long offset = (unsigned long)hose->io_base_virt -
390 #ifdef CONFIG_PPC64
391                         pci_io_base;
392 #else
393                         isa_io_base;
394 #endif
395                 DBG("port %d, IO %lx -> %lx\n",
396                     index, port->iobase, port->iobase + offset);
397                 port->iobase += offset;
398         }
399 #endif
400 }
401
402 static void __init fixup_port_mmio(int index,
403                                    struct device_node *np,
404                                    struct plat_serial8250_port *port)
405 {
406         DBG("fixup_port_mmio(%d)\n", index);
407
408         port->membase = ioremap(port->mapbase, 0x100);
409 }
410
411 /*
412  * This is called as an arch initcall, hopefully before the PCI bus is
413  * probed and/or the 8250 driver loaded since we need to register our
414  * platform devices before 8250 PCI ones are detected as some of them
415  * must properly "override" the platform ones.
416  *
417  * This function fixes up the interrupt value for platform ports as it
418  * couldn't be done earlier before interrupt maps have been parsed. It
419  * also "corrects" the IO address for PIO ports for the same reason,
420  * since earlier, the PHBs virtual IO space wasn't assigned yet. It then
421  * registers all those platform ports for use by the 8250 driver when it
422  * finally loads.
423  */
424 static int __init serial_dev_init(void)
425 {
426         int i;
427
428         if (legacy_serial_count == 0)
429                 return -ENODEV;
430
431         /*
432          * Before we register the platfrom serial devices, we need
433          * to fixup their interrutps and their IO ports.
434          */
435         DBG("Fixing serial ports interrupts and IO ports ...\n");
436
437         for (i = 0; i < legacy_serial_count; i++) {
438                 struct plat_serial8250_port *port = &legacy_serial_ports[i];
439                 struct device_node *np = legacy_serial_infos[i].np;
440
441                 if (port->irq == NO_IRQ)
442                         fixup_port_irq(i, np, port);
443                 if (port->iotype == UPIO_PORT)
444                         fixup_port_pio(i, np, port);
445                 if (port->iotype == UPIO_MEM)
446                         fixup_port_mmio(i, np, port);
447         }
448
449         DBG("Registering platform serial ports\n");
450
451         return platform_device_register(&serial_device);
452 }
453 arch_initcall(serial_dev_init);
454
455
456 /*
457  * This is called very early, as part of console_init() (typically just after
458  * time_init()). This function is respondible for trying to find a good
459  * default console on serial ports. It tries to match the open firmware
460  * default output with one of the available serial console drivers, either
461  * one of the platform serial ports that have been probed earlier by
462  * find_legacy_serial_ports() or some more platform specific ones.
463  */
464 static int __init check_legacy_serial_console(void)
465 {
466         struct device_node *prom_stdout = NULL;
467         int speed = 0, offset = 0;
468         char *name;
469         u32 *spd;
470
471         DBG(" -> check_legacy_serial_console()\n");
472
473         /* The user has requested a console so this is already set up. */
474         if (strstr(saved_command_line, "console=")) {
475                 DBG(" console was specified !\n");
476                 return -EBUSY;
477         }
478
479         if (!of_chosen) {
480                 DBG(" of_chosen is NULL !\n");
481                 return -ENODEV;
482         }
483
484         if (legacy_serial_console < 0) {
485                 DBG(" legacy_serial_console not found !\n");
486                 return -ENODEV;
487         }
488         /* We are getting a weird phandle from OF ... */
489         /* ... So use the full path instead */
490         name = (char *)get_property(of_chosen, "linux,stdout-path", NULL);
491         if (name == NULL) {
492                 DBG(" no linux,stdout-path !\n");
493                 return -ENODEV;
494         }
495         prom_stdout = of_find_node_by_path(name);
496         if (!prom_stdout) {
497                 DBG(" can't find stdout package %s !\n", name);
498                 return -ENODEV;
499         }
500         DBG("stdout is %s\n", prom_stdout->full_name);
501
502         name = (char *)get_property(prom_stdout, "name", NULL);
503         if (!name) {
504                 DBG(" stdout package has no name !\n");
505                 goto not_found;
506         }
507         spd = (u32 *)get_property(prom_stdout, "current-speed", NULL);
508         if (spd)
509                 speed = *spd;
510
511         if (0)
512                 ;
513 #ifdef CONFIG_SERIAL_8250_CONSOLE
514         else if (strcmp(name, "serial") == 0) {
515                 int i;
516                 /* Look for it in probed array */
517                 for (i = 0; i < legacy_serial_count; i++) {
518                         if (prom_stdout != legacy_serial_infos[i].np)
519                                 continue;
520                         offset = i;
521                         speed = legacy_serial_infos[i].speed;
522                         break;
523                 }
524                 if (i >= legacy_serial_count)
525                         goto not_found;
526         }
527 #endif /* CONFIG_SERIAL_8250_CONSOLE */
528 #ifdef CONFIG_SERIAL_PMACZILOG_CONSOLE
529         else if (strcmp(name, "ch-a") == 0)
530                 offset = 0;
531         else if (strcmp(name, "ch-b") == 0)
532                 offset = 1;
533 #endif /* CONFIG_SERIAL_PMACZILOG_CONSOLE */
534         else
535                 goto not_found;
536         of_node_put(prom_stdout);
537
538         DBG("Found serial console at ttyS%d\n", offset);
539
540         if (speed) {
541                 static char __initdata opt[16];
542                 sprintf(opt, "%d", speed);
543                 return add_preferred_console("ttyS", offset, opt);
544         } else
545                 return add_preferred_console("ttyS", offset, NULL);
546
547  not_found:
548         DBG("No preferred console found !\n");
549         of_node_put(prom_stdout);
550         return -ENODEV;
551 }
552 console_initcall(check_legacy_serial_console);
553