2 * Bus & driver management routines for devices within
3 * a MacIO ASIC. Interface to new driver model mostly
4 * stolen from the PCI version.
6 * Copyright (C) 2005 Ben. Herrenschmidt (benh@kernel.crashing.org)
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version
11 * 2 of the License, or (at your option) any later version.
15 * - Don't probe below media bay by default, but instead provide
16 * some hooks for media bay to dynamically add/remove it's own
20 #include <linux/string.h>
21 #include <linux/kernel.h>
22 #include <linux/pci.h>
23 #include <linux/pci_ids.h>
24 #include <linux/init.h>
25 #include <linux/module.h>
26 #include <linux/slab.h>
28 #include <asm/machdep.h>
29 #include <asm/macio.h>
30 #include <asm/pmac_feature.h>
32 #include <asm/pci-bridge.h>
36 #define MAX_NODE_NAME_SIZE (BUS_ID_SIZE - 12)
38 static struct macio_chip *macio_on_hold;
40 static int macio_bus_match(struct device *dev, struct device_driver *drv)
42 struct macio_dev * macio_dev = to_macio_device(dev);
43 struct macio_driver * macio_drv = to_macio_driver(drv);
44 const struct of_device_id * matches = macio_drv->match_table;
49 return of_match_device(matches, &macio_dev->ofdev) != NULL;
52 struct macio_dev *macio_dev_get(struct macio_dev *dev)
58 tmp = get_device(&dev->ofdev.dev);
60 return to_macio_device(tmp);
65 void macio_dev_put(struct macio_dev *dev)
68 put_device(&dev->ofdev.dev);
72 static int macio_device_probe(struct device *dev)
75 struct macio_driver *drv;
76 struct macio_dev *macio_dev;
77 const struct of_device_id *match;
79 drv = to_macio_driver(dev->driver);
80 macio_dev = to_macio_device(dev);
85 macio_dev_get(macio_dev);
87 match = of_match_device(drv->match_table, &macio_dev->ofdev);
89 error = drv->probe(macio_dev, match);
91 macio_dev_put(macio_dev);
96 static int macio_device_remove(struct device *dev)
98 struct macio_dev * macio_dev = to_macio_device(dev);
99 struct macio_driver * drv = to_macio_driver(dev->driver);
101 if (dev->driver && drv->remove)
102 drv->remove(macio_dev);
103 macio_dev_put(macio_dev);
108 static void macio_device_shutdown(struct device *dev)
110 struct macio_dev * macio_dev = to_macio_device(dev);
111 struct macio_driver * drv = to_macio_driver(dev->driver);
113 if (dev->driver && drv->shutdown)
114 drv->shutdown(macio_dev);
117 static int macio_device_suspend(struct device *dev, pm_message_t state)
119 struct macio_dev * macio_dev = to_macio_device(dev);
120 struct macio_driver * drv = to_macio_driver(dev->driver);
122 if (dev->driver && drv->suspend)
123 return drv->suspend(macio_dev, state);
127 static int macio_device_resume(struct device * dev)
129 struct macio_dev * macio_dev = to_macio_device(dev);
130 struct macio_driver * drv = to_macio_driver(dev->driver);
132 if (dev->driver && drv->resume)
133 return drv->resume(macio_dev);
137 static int macio_uevent(struct device *dev, char **envp, int num_envp,
138 char *buffer, int buffer_size)
140 struct macio_dev * macio_dev;
141 struct of_device * of;
143 const char *compat, *compat2;
146 int length, cplen, cplen2, seen = 0;
151 macio_dev = to_macio_device(dev);
155 of = &macio_dev->ofdev;
157 /* stuff we want to pass to /sbin/hotplug */
158 envp[i++] = scratch = buffer;
159 length = scnprintf (scratch, buffer_size, "OF_NAME=%s", of->node->name);
161 buffer_size -= length;
162 if ((buffer_size <= 0) || (i >= num_envp))
167 length = scnprintf (scratch, buffer_size, "OF_TYPE=%s", of->node->type);
169 buffer_size -= length;
170 if ((buffer_size <= 0) || (i >= num_envp))
174 /* Since the compatible field can contain pretty much anything
175 * it's not really legal to split it out with commas. We split it
176 * up using a number of environment variables instead. */
178 compat = get_property(of->node, "compatible", &cplen);
181 while (compat && cplen > 0) {
183 length = scnprintf (scratch, buffer_size,
184 "OF_COMPATIBLE_%d=%s", seen, compat);
186 buffer_size -= length;
187 if ((buffer_size <= 0) || (i >= num_envp))
190 length = strlen (compat) + 1;
197 length = scnprintf (scratch, buffer_size, "OF_COMPATIBLE_N=%d", seen);
199 buffer_size -= length;
200 if ((buffer_size <= 0) || (i >= num_envp))
205 length = scnprintf (scratch, buffer_size, "MODALIAS=of:N%sT%s",
206 of->node->name, of->node->type);
208 buffer_size -= length;
209 if ((buffer_size <= 0) || (i >= num_envp))
218 length = snprintf (scratch, buffer_size, "C%s", compat2);
219 buffer_size -= length;
220 if (buffer_size <= 0)
223 length = strlen (compat2) + 1;
233 extern struct device_attribute macio_dev_attrs[];
235 struct bus_type macio_bus_type = {
237 .match = macio_bus_match,
238 .uevent = macio_uevent,
239 .probe = macio_device_probe,
240 .remove = macio_device_remove,
241 .shutdown = macio_device_shutdown,
242 .suspend = macio_device_suspend,
243 .resume = macio_device_resume,
244 .dev_attrs = macio_dev_attrs,
247 static int __init macio_bus_driver_init(void)
249 return bus_register(&macio_bus_type);
252 postcore_initcall(macio_bus_driver_init);
256 * macio_release_dev - free a macio device structure when all users of it are
258 * @dev: device that's been disconnected
260 * Will be called only by the device core when all users of this macio device
261 * are done. This currently means never as we don't hot remove any macio
262 * device yet, though that will happen with mediabay based devices in a later
265 static void macio_release_dev(struct device *dev)
267 struct macio_dev *mdev;
269 mdev = to_macio_device(dev);
274 * macio_resource_quirks - tweak or skip some resources for a device
275 * @np: pointer to the device node
276 * @res: resulting resource
277 * @index: index of resource in node
279 * If this routine returns non-null, then the resource is completely
282 static int macio_resource_quirks(struct device_node *np, struct resource *res,
285 /* Only quirks for memory resources for now */
286 if ((res->flags & IORESOURCE_MEM) == 0)
289 /* Grand Central has too large resource 0 on some machines */
290 if (index == 0 && !strcmp(np->name, "gc"))
291 res->end = res->start + 0x1ffff;
293 /* Airport has bogus resource 2 */
294 if (index >= 2 && !strcmp(np->name, "radio"))
298 /* DBDMAs may have bogus sizes */
299 if ((res->start & 0x0001f000) == 0x00008000)
300 res->end = res->start + 0xff;
301 #endif /* CONFIG_PPC64 */
303 /* ESCC parent eats child resources. We could have added a
304 * level of hierarchy, but I don't really feel the need
307 if (!strcmp(np->name, "escc"))
310 /* ESCC has bogus resources >= 3 */
311 if (index >= 3 && !(strcmp(np->name, "ch-a") &&
312 strcmp(np->name, "ch-b")))
315 /* Media bay has too many resources, keep only first one */
316 if (index > 0 && !strcmp(np->name, "media-bay"))
319 /* Some older IDE resources have bogus sizes */
320 if (!(strcmp(np->name, "IDE") && strcmp(np->name, "ATA") &&
321 strcmp(np->type, "ide") && strcmp(np->type, "ata"))) {
322 if (index == 0 && (res->end - res->start) > 0xfff)
323 res->end = res->start + 0xfff;
324 if (index == 1 && (res->end - res->start) > 0xff)
325 res->end = res->start + 0xff;
330 static void macio_create_fixup_irq(struct macio_dev *dev, int index,
335 irq = irq_create_mapping(NULL, line);
337 dev->interrupt[index].start = irq;
338 dev->interrupt[index].flags = IORESOURCE_IRQ;
339 dev->interrupt[index].name = dev->ofdev.dev.bus_id;
341 if (dev->n_interrupts <= index)
342 dev->n_interrupts = index + 1;
345 static void macio_add_missing_resources(struct macio_dev *dev)
347 struct device_node *np = dev->ofdev.node;
348 unsigned int irq_base;
350 /* Gatwick has some missing interrupts on child nodes */
351 if (dev->bus->chip->type != macio_gatwick)
354 /* irq_base is always 64 on gatwick. I have no cleaner way to get
355 * that value from here at this point
360 if (strcmp(np->name, "ch-a") == 0) {
361 macio_create_fixup_irq(dev, 0, 15 + irq_base);
362 macio_create_fixup_irq(dev, 1, 4 + irq_base);
363 macio_create_fixup_irq(dev, 2, 5 + irq_base);
364 printk(KERN_INFO "macio: fixed SCC irqs on gatwick\n");
368 if (strcmp(np->name, "media-bay") == 0) {
369 macio_create_fixup_irq(dev, 0, 29 + irq_base);
370 printk(KERN_INFO "macio: fixed media-bay irq on gatwick\n");
373 /* Fix left media bay childs */
374 if (dev->media_bay != NULL && strcmp(np->name, "floppy") == 0) {
375 macio_create_fixup_irq(dev, 0, 19 + irq_base);
376 macio_create_fixup_irq(dev, 1, 1 + irq_base);
377 printk(KERN_INFO "macio: fixed left floppy irqs\n");
379 if (dev->media_bay != NULL && strcasecmp(np->name, "ata4") == 0) {
380 macio_create_fixup_irq(dev, 0, 14 + irq_base);
381 macio_create_fixup_irq(dev, 0, 3 + irq_base);
382 printk(KERN_INFO "macio: fixed left ide irqs\n");
386 static void macio_setup_interrupts(struct macio_dev *dev)
388 struct device_node *np = dev->ofdev.node;
393 struct resource *res = &dev->interrupt[j];
395 if (j >= MACIO_DEV_COUNT_IRQS)
397 irq = irq_of_parse_and_map(np, i++);
401 res->flags = IORESOURCE_IRQ;
402 res->name = dev->ofdev.dev.bus_id;
403 if (macio_resource_quirks(np, res, i - 1)) {
404 memset(res, 0, sizeof(struct resource));
409 dev->n_interrupts = j;
412 static void macio_setup_resources(struct macio_dev *dev,
413 struct resource *parent_res)
415 struct device_node *np = dev->ofdev.node;
419 for (index = 0; of_address_to_resource(np, index, &r) == 0; index++) {
420 struct resource *res = &dev->resource[index];
421 if (index >= MACIO_DEV_COUNT_RESOURCES)
424 res->name = dev->ofdev.dev.bus_id;
426 if (macio_resource_quirks(np, res, index)) {
427 memset(res, 0, sizeof(struct resource));
430 /* Currently, we consider failure as harmless, this may
431 * change in the future, once I've found all the device
432 * tree bugs in older machines & worked around them
434 if (insert_resource(parent_res, res)) {
435 printk(KERN_WARNING "Can't request resource "
436 "%d for MacIO device %s\n",
437 index, dev->ofdev.dev.bus_id);
440 dev->n_resources = index;
444 * macio_add_one_device - Add one device from OF node to the device tree
445 * @chip: pointer to the macio_chip holding the device
446 * @np: pointer to the device node in the OF tree
447 * @in_bay: set to 1 if device is part of a media-bay
449 * When media-bay is changed to hotswap drivers, this function will
450 * be exposed to the bay driver some way...
452 static struct macio_dev * macio_add_one_device(struct macio_chip *chip,
453 struct device *parent,
454 struct device_node *np,
455 struct macio_dev *in_bay,
456 struct resource *parent_res)
458 struct macio_dev *dev;
464 dev = kmalloc(sizeof(*dev), GFP_KERNEL);
467 memset(dev, 0, sizeof(*dev));
469 dev->bus = &chip->lbus;
470 dev->media_bay = in_bay;
471 dev->ofdev.node = np;
472 dev->ofdev.dma_mask = 0xffffffffUL;
473 dev->ofdev.dev.dma_mask = &dev->ofdev.dma_mask;
474 dev->ofdev.dev.parent = parent;
475 dev->ofdev.dev.bus = &macio_bus_type;
476 dev->ofdev.dev.release = macio_release_dev;
479 printk("preparing mdev @%p, ofdev @%p, dev @%p, kobj @%p\n",
480 dev, &dev->ofdev, &dev->ofdev.dev, &dev->ofdev.dev.kobj);
483 /* MacIO itself has a different reg, we use it's PCI base */
484 if (np == chip->of_node) {
485 sprintf(dev->ofdev.dev.bus_id, "%1d.%08x:%.*s",
488 (unsigned int)pci_resource_start(chip->lbus.pdev, 0),
490 0, /* NuBus may want to do something better here */
492 MAX_NODE_NAME_SIZE, np->name);
494 reg = get_property(np, "reg", NULL);
495 sprintf(dev->ofdev.dev.bus_id, "%1d.%08x:%.*s",
497 reg ? *reg : 0, MAX_NODE_NAME_SIZE, np->name);
500 /* Setup interrupts & resources */
501 macio_setup_interrupts(dev);
502 macio_setup_resources(dev, parent_res);
503 macio_add_missing_resources(dev);
505 /* Register with core */
506 if (of_device_register(&dev->ofdev) != 0) {
507 printk(KERN_DEBUG"macio: device registration error for %s!\n",
508 dev->ofdev.dev.bus_id);
516 static int macio_skip_device(struct device_node *np)
518 if (strncmp(np->name, "battery", 7) == 0)
520 if (strncmp(np->name, "escc-legacy", 11) == 0)
526 * macio_pci_add_devices - Adds sub-devices of mac-io to the device tree
527 * @chip: pointer to the macio_chip holding the devices
529 * This function will do the job of extracting devices from the
530 * Open Firmware device tree, build macio_dev structures and add
531 * them to the Linux device tree.
533 * For now, childs of media-bay are added now as well. This will
536 static void macio_pci_add_devices(struct macio_chip *chip)
538 struct device_node *np, *pnode;
539 struct macio_dev *rdev, *mdev, *mbdev = NULL, *sdev = NULL;
540 struct device *parent = NULL;
541 struct resource *root_res = &iomem_resource;
543 /* Add a node for the macio bus itself */
545 if (chip->lbus.pdev) {
546 parent = &chip->lbus.pdev->dev;
547 root_res = &chip->lbus.pdev->resource[0];
550 pnode = of_node_get(chip->of_node);
554 /* Add macio itself to hierarchy */
555 rdev = macio_add_one_device(chip, parent, pnode, NULL, root_res);
558 root_res = &rdev->resource[0];
560 /* First scan 1st level */
561 for (np = NULL; (np = of_get_next_child(pnode, np)) != NULL;) {
562 if (macio_skip_device(np))
565 mdev = macio_add_one_device(chip, &rdev->ofdev.dev, np, NULL,
569 else if (strncmp(np->name, "media-bay", 9) == 0)
571 else if (strncmp(np->name, "escc", 4) == 0)
575 /* Add media bay devices if any */
577 for (np = NULL; (np = of_get_next_child(mbdev->ofdev.node, np))
579 if (macio_skip_device(np))
582 if (macio_add_one_device(chip, &mbdev->ofdev.dev, np,
583 mbdev, root_res) == NULL)
587 /* Add serial ports if any */
589 for (np = NULL; (np = of_get_next_child(sdev->ofdev.node, np))
591 if (macio_skip_device(np))
594 if (macio_add_one_device(chip, &sdev->ofdev.dev, np,
595 NULL, root_res) == NULL)
603 * macio_register_driver - Registers a new MacIO device driver
604 * @drv: pointer to the driver definition structure
606 int macio_register_driver(struct macio_driver *drv)
608 /* initialize common driver fields */
609 drv->driver.name = drv->name;
610 drv->driver.bus = &macio_bus_type;
612 /* register with core */
613 return driver_register(&drv->driver);
617 * macio_unregister_driver - Unregisters a new MacIO device driver
618 * @drv: pointer to the driver definition structure
620 void macio_unregister_driver(struct macio_driver *drv)
622 driver_unregister(&drv->driver);
626 * macio_request_resource - Request an MMIO resource
627 * @dev: pointer to the device holding the resource
628 * @resource_no: resource number to request
629 * @name: resource name
631 * Mark memory region number @resource_no associated with MacIO
632 * device @dev as being reserved by owner @name. Do not access
633 * any address inside the memory regions unless this call returns
636 * Returns 0 on success, or %EBUSY on error. A warning
637 * message is also printed on failure.
639 int macio_request_resource(struct macio_dev *dev, int resource_no,
642 if (macio_resource_len(dev, resource_no) == 0)
645 if (!request_mem_region(macio_resource_start(dev, resource_no),
646 macio_resource_len(dev, resource_no),
653 printk (KERN_WARNING "MacIO: Unable to reserve resource #%d:%lx@%lx"
656 macio_resource_len(dev, resource_no),
657 macio_resource_start(dev, resource_no),
658 dev->ofdev.dev.bus_id);
663 * macio_release_resource - Release an MMIO resource
664 * @dev: pointer to the device holding the resource
665 * @resource_no: resource number to release
667 void macio_release_resource(struct macio_dev *dev, int resource_no)
669 if (macio_resource_len(dev, resource_no) == 0)
671 release_mem_region(macio_resource_start(dev, resource_no),
672 macio_resource_len(dev, resource_no));
676 * macio_request_resources - Reserve all memory resources
677 * @dev: MacIO device whose resources are to be reserved
678 * @name: Name to be associated with resource.
680 * Mark all memory regions associated with MacIO device @dev as
681 * being reserved by owner @name. Do not access any address inside
682 * the memory regions unless this call returns successfully.
684 * Returns 0 on success, or %EBUSY on error. A warning
685 * message is also printed on failure.
687 int macio_request_resources(struct macio_dev *dev, const char *name)
691 for (i = 0; i < dev->n_resources; i++)
692 if (macio_request_resource(dev, i, name))
698 macio_release_resource(dev, i);
704 * macio_release_resources - Release reserved memory resources
705 * @dev: MacIO device whose resources were previously reserved
708 void macio_release_resources(struct macio_dev *dev)
712 for (i = 0; i < dev->n_resources; i++)
713 macio_release_resource(dev, i);
719 static int __devinit macio_pci_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
721 struct device_node* np;
722 struct macio_chip* chip;
724 if (ent->vendor != PCI_VENDOR_ID_APPLE)
727 /* Note regarding refcounting: We assume pci_device_to_OF_node() is
728 * ported to new OF APIs and returns a node with refcount incremented.
730 np = pci_device_to_OF_node(pdev);
734 /* The above assumption is wrong !!!
735 * fix that here for now until I fix the arch code
739 /* We also assume that pmac_feature will have done a get() on nodes
740 * stored in the macio chips array
742 chip = macio_find(np, macio_unknown);
747 /* XXX Need locking ??? */
748 if (chip->lbus.pdev == NULL) {
749 chip->lbus.pdev = pdev;
750 chip->lbus.chip = chip;
751 pci_set_drvdata(pdev, &chip->lbus);
752 pci_set_master(pdev);
755 printk(KERN_INFO "MacIO PCI driver attached to %s chipset\n",
759 * HACK ALERT: The WallStreet PowerBook and some OHare based machines
760 * have 2 macio ASICs. I must probe the "main" one first or IDE
761 * ordering will be incorrect. So I put on "hold" the second one since
762 * it seem to appear first on PCI
764 if (chip->type == macio_gatwick || chip->type == macio_ohareII)
765 if (macio_chips[0].lbus.pdev == NULL) {
766 macio_on_hold = chip;
770 macio_pci_add_devices(chip);
771 if (macio_on_hold && macio_chips[0].lbus.pdev != NULL) {
772 macio_pci_add_devices(macio_on_hold);
773 macio_on_hold = NULL;
779 static void __devexit macio_pci_remove(struct pci_dev* pdev)
781 panic("removing of macio-asic not supported !\n");
785 * MacIO is matched against any Apple ID, it's probe() function
786 * will then decide wether it applies or not
788 static const struct pci_device_id __devinitdata pci_ids [] = { {
789 .vendor = PCI_VENDOR_ID_APPLE,
790 .device = PCI_ANY_ID,
791 .subvendor = PCI_ANY_ID,
792 .subdevice = PCI_ANY_ID,
794 }, { /* end: all zeroes */ }
796 MODULE_DEVICE_TABLE (pci, pci_ids);
798 /* pci driver glue; this is a "new style" PCI driver module */
799 static struct pci_driver macio_pci_driver = {
800 .name = (char *) "macio",
803 .probe = macio_pci_probe,
804 .remove = macio_pci_remove,
807 #endif /* CONFIG_PCI */
809 static int __init macio_module_init (void)
814 rc = pci_register_driver(&macio_pci_driver);
817 #endif /* CONFIG_PCI */
821 module_init(macio_module_init);
823 EXPORT_SYMBOL(macio_register_driver);
824 EXPORT_SYMBOL(macio_unregister_driver);
825 EXPORT_SYMBOL(macio_dev_get);
826 EXPORT_SYMBOL(macio_dev_put);
827 EXPORT_SYMBOL(macio_request_resource);
828 EXPORT_SYMBOL(macio_release_resource);
829 EXPORT_SYMBOL(macio_request_resources);
830 EXPORT_SYMBOL(macio_release_resources);