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;
142 char *scratch, *compat, *compat2;
144 int length, cplen, cplen2, seen = 0;
149 macio_dev = to_macio_device(dev);
153 of = &macio_dev->ofdev;
155 /* stuff we want to pass to /sbin/hotplug */
156 envp[i++] = scratch = buffer;
157 length = scnprintf (scratch, buffer_size, "OF_NAME=%s", of->node->name);
159 buffer_size -= length;
160 if ((buffer_size <= 0) || (i >= num_envp))
165 length = scnprintf (scratch, buffer_size, "OF_TYPE=%s", of->node->type);
167 buffer_size -= length;
168 if ((buffer_size <= 0) || (i >= num_envp))
172 /* Since the compatible field can contain pretty much anything
173 * it's not really legal to split it out with commas. We split it
174 * up using a number of environment variables instead. */
176 compat = (char *) get_property(of->node, "compatible", &cplen);
179 while (compat && cplen > 0) {
181 length = scnprintf (scratch, buffer_size,
182 "OF_COMPATIBLE_%d=%s", seen, compat);
184 buffer_size -= length;
185 if ((buffer_size <= 0) || (i >= num_envp))
188 length = strlen (compat) + 1;
195 length = scnprintf (scratch, buffer_size, "OF_COMPATIBLE_N=%d", seen);
197 buffer_size -= length;
198 if ((buffer_size <= 0) || (i >= num_envp))
203 length = scnprintf (scratch, buffer_size, "MODALIAS=of:N%sT%s",
204 of->node->name, of->node->type);
206 buffer_size -= length;
207 if ((buffer_size <= 0) || (i >= num_envp))
216 length = snprintf (scratch, buffer_size, "C%s", compat2);
217 buffer_size -= length;
218 if (buffer_size <= 0)
221 length = strlen (compat2) + 1;
231 extern struct device_attribute macio_dev_attrs[];
233 struct bus_type macio_bus_type = {
235 .match = macio_bus_match,
236 .uevent = macio_uevent,
237 .probe = macio_device_probe,
238 .remove = macio_device_remove,
239 .shutdown = macio_device_shutdown,
240 .suspend = macio_device_suspend,
241 .resume = macio_device_resume,
242 .dev_attrs = macio_dev_attrs,
245 static int __init macio_bus_driver_init(void)
247 return bus_register(&macio_bus_type);
250 postcore_initcall(macio_bus_driver_init);
254 * macio_release_dev - free a macio device structure when all users of it are
256 * @dev: device that's been disconnected
258 * Will be called only by the device core when all users of this macio device
259 * are done. This currently means never as we don't hot remove any macio
260 * device yet, though that will happen with mediabay based devices in a later
263 static void macio_release_dev(struct device *dev)
265 struct macio_dev *mdev;
267 mdev = to_macio_device(dev);
272 * macio_resource_quirks - tweak or skip some resources for a device
273 * @np: pointer to the device node
274 * @res: resulting resource
275 * @index: index of resource in node
277 * If this routine returns non-null, then the resource is completely
280 static int macio_resource_quirks(struct device_node *np, struct resource *res,
283 if (res->flags & IORESOURCE_MEM) {
284 /* Grand Central has too large resource 0 on some machines */
285 if (index == 0 && !strcmp(np->name, "gc"))
286 res->end = res->start + 0x1ffff;
288 /* Airport has bogus resource 2 */
289 if (index >= 2 && !strcmp(np->name, "radio"))
293 /* DBDMAs may have bogus sizes */
294 if ((res->start & 0x0001f000) == 0x00008000)
295 res->end = res->start + 0xff;
296 #endif /* CONFIG_PPC64 */
298 /* ESCC parent eats child resources. We could have added a
299 * level of hierarchy, but I don't really feel the need
302 if (!strcmp(np->name, "escc"))
305 /* ESCC has bogus resources >= 3 */
306 if (index >= 3 && !(strcmp(np->name, "ch-a") &&
307 strcmp(np->name, "ch-b")))
310 /* Media bay has too many resources, keep only first one */
311 if (index > 0 && !strcmp(np->name, "media-bay"))
314 /* Some older IDE resources have bogus sizes */
315 if (!(strcmp(np->name, "IDE") && strcmp(np->name, "ATA") &&
316 strcmp(np->type, "ide") && strcmp(np->type, "ata"))) {
317 if (index == 0 && (res->end - res->start) > 0xfff)
318 res->end = res->start + 0xfff;
319 if (index == 1 && (res->end - res->start) > 0xff)
320 res->end = res->start + 0xff;
327 static void macio_setup_interrupts(struct macio_dev *dev)
329 struct device_node *np = dev->ofdev.node;
332 /* For now, we use pre-parsed entries in the device-tree for
333 * interrupt routing and addresses, but we should change that
334 * to dynamically parsed entries and so get rid of most of the
335 * clutter in struct device_node
337 for (i = j = 0; i < np->n_intrs; i++) {
338 struct resource *res = &dev->interrupt[j];
340 if (j >= MACIO_DEV_COUNT_IRQS)
342 res->start = np->intrs[i].line;
343 res->flags = IORESOURCE_IO;
344 if (np->intrs[j].sense)
345 res->flags |= IORESOURCE_IRQ_LOWLEVEL;
347 res->flags |= IORESOURCE_IRQ_HIGHEDGE;
348 res->name = dev->ofdev.dev.bus_id;
349 if (macio_resource_quirks(np, res, i))
350 memset(res, 0, sizeof(struct resource));
354 dev->n_interrupts = j;
357 static void macio_setup_resources(struct macio_dev *dev,
358 struct resource *parent_res)
360 struct device_node *np = dev->ofdev.node;
364 for (index = 0; of_address_to_resource(np, index, &r) == 0; index++) {
365 struct resource *res = &dev->resource[index];
366 if (index >= MACIO_DEV_COUNT_RESOURCES)
369 res->name = dev->ofdev.dev.bus_id;
371 if (macio_resource_quirks(np, res, index)) {
372 memset(res, 0, sizeof(struct resource));
375 /* Currently, we consider failure as harmless, this may
376 * change in the future, once I've found all the device
377 * tree bugs in older machines & worked around them
379 if (insert_resource(parent_res, res)) {
380 printk(KERN_WARNING "Can't request resource "
381 "%d for MacIO device %s\n",
382 index, dev->ofdev.dev.bus_id);
385 dev->n_resources = index;
389 * macio_add_one_device - Add one device from OF node to the device tree
390 * @chip: pointer to the macio_chip holding the device
391 * @np: pointer to the device node in the OF tree
392 * @in_bay: set to 1 if device is part of a media-bay
394 * When media-bay is changed to hotswap drivers, this function will
395 * be exposed to the bay driver some way...
397 static struct macio_dev * macio_add_one_device(struct macio_chip *chip,
398 struct device *parent,
399 struct device_node *np,
400 struct macio_dev *in_bay,
401 struct resource *parent_res)
403 struct macio_dev *dev;
409 dev = kmalloc(sizeof(*dev), GFP_KERNEL);
412 memset(dev, 0, sizeof(*dev));
414 dev->bus = &chip->lbus;
415 dev->media_bay = in_bay;
416 dev->ofdev.node = np;
417 dev->ofdev.dma_mask = 0xffffffffUL;
418 dev->ofdev.dev.dma_mask = &dev->ofdev.dma_mask;
419 dev->ofdev.dev.parent = parent;
420 dev->ofdev.dev.bus = &macio_bus_type;
421 dev->ofdev.dev.release = macio_release_dev;
424 printk("preparing mdev @%p, ofdev @%p, dev @%p, kobj @%p\n",
425 dev, &dev->ofdev, &dev->ofdev.dev, &dev->ofdev.dev.kobj);
428 /* MacIO itself has a different reg, we use it's PCI base */
429 if (np == chip->of_node) {
430 sprintf(dev->ofdev.dev.bus_id, "%1d.%016llx:%.*s",
433 (unsigned long long)pci_resource_start(chip->lbus.pdev, 0),
435 0, /* NuBus may want to do something better here */
437 MAX_NODE_NAME_SIZE, np->name);
439 reg = (u32 *)get_property(np, "reg", NULL);
440 sprintf(dev->ofdev.dev.bus_id, "%1d.%08x:%.*s",
442 reg ? *reg : 0, MAX_NODE_NAME_SIZE, np->name);
445 /* Setup interrupts & resources */
446 macio_setup_interrupts(dev);
447 macio_setup_resources(dev, parent_res);
449 /* Register with core */
450 if (of_device_register(&dev->ofdev) != 0) {
451 printk(KERN_DEBUG"macio: device registration error for %s!\n",
452 dev->ofdev.dev.bus_id);
460 static int macio_skip_device(struct device_node *np)
462 if (strncmp(np->name, "battery", 7) == 0)
464 if (strncmp(np->name, "escc-legacy", 11) == 0)
470 * macio_pci_add_devices - Adds sub-devices of mac-io to the device tree
471 * @chip: pointer to the macio_chip holding the devices
473 * This function will do the job of extracting devices from the
474 * Open Firmware device tree, build macio_dev structures and add
475 * them to the Linux device tree.
477 * For now, childs of media-bay are added now as well. This will
480 static void macio_pci_add_devices(struct macio_chip *chip)
482 struct device_node *np, *pnode;
483 struct macio_dev *rdev, *mdev, *mbdev = NULL, *sdev = NULL;
484 struct device *parent = NULL;
485 struct resource *root_res = &iomem_resource;
487 /* Add a node for the macio bus itself */
489 if (chip->lbus.pdev) {
490 parent = &chip->lbus.pdev->dev;
491 root_res = &chip->lbus.pdev->resource[0];
494 pnode = of_node_get(chip->of_node);
498 /* Add macio itself to hierarchy */
499 rdev = macio_add_one_device(chip, parent, pnode, NULL, root_res);
502 root_res = &rdev->resource[0];
504 /* First scan 1st level */
505 for (np = NULL; (np = of_get_next_child(pnode, np)) != NULL;) {
506 if (macio_skip_device(np))
509 mdev = macio_add_one_device(chip, &rdev->ofdev.dev, np, NULL,
513 else if (strncmp(np->name, "media-bay", 9) == 0)
515 else if (strncmp(np->name, "escc", 4) == 0)
519 /* Add media bay devices if any */
521 for (np = NULL; (np = of_get_next_child(mbdev->ofdev.node, np))
523 if (macio_skip_device(np))
526 if (macio_add_one_device(chip, &mbdev->ofdev.dev, np,
527 mbdev, root_res) == NULL)
531 /* Add serial ports if any */
533 for (np = NULL; (np = of_get_next_child(sdev->ofdev.node, np))
535 if (macio_skip_device(np))
538 if (macio_add_one_device(chip, &sdev->ofdev.dev, np,
539 NULL, root_res) == NULL)
547 * macio_register_driver - Registers a new MacIO device driver
548 * @drv: pointer to the driver definition structure
550 int macio_register_driver(struct macio_driver *drv)
552 /* initialize common driver fields */
553 drv->driver.name = drv->name;
554 drv->driver.bus = &macio_bus_type;
556 /* register with core */
557 return driver_register(&drv->driver);
561 * macio_unregister_driver - Unregisters a new MacIO device driver
562 * @drv: pointer to the driver definition structure
564 void macio_unregister_driver(struct macio_driver *drv)
566 driver_unregister(&drv->driver);
570 * macio_request_resource - Request an MMIO resource
571 * @dev: pointer to the device holding the resource
572 * @resource_no: resource number to request
573 * @name: resource name
575 * Mark memory region number @resource_no associated with MacIO
576 * device @dev as being reserved by owner @name. Do not access
577 * any address inside the memory regions unless this call returns
580 * Returns 0 on success, or %EBUSY on error. A warning
581 * message is also printed on failure.
583 int macio_request_resource(struct macio_dev *dev, int resource_no,
586 if (macio_resource_len(dev, resource_no) == 0)
589 if (!request_mem_region(macio_resource_start(dev, resource_no),
590 macio_resource_len(dev, resource_no),
597 printk (KERN_WARNING "MacIO: Unable to reserve resource #%d:%lx@%lx"
600 macio_resource_len(dev, resource_no),
601 macio_resource_start(dev, resource_no),
602 dev->ofdev.dev.bus_id);
607 * macio_release_resource - Release an MMIO resource
608 * @dev: pointer to the device holding the resource
609 * @resource_no: resource number to release
611 void macio_release_resource(struct macio_dev *dev, int resource_no)
613 if (macio_resource_len(dev, resource_no) == 0)
615 release_mem_region(macio_resource_start(dev, resource_no),
616 macio_resource_len(dev, resource_no));
620 * macio_request_resources - Reserve all memory resources
621 * @dev: MacIO device whose resources are to be reserved
622 * @name: Name to be associated with resource.
624 * Mark all memory regions associated with MacIO device @dev as
625 * being reserved by owner @name. Do not access any address inside
626 * the memory regions unless this call returns successfully.
628 * Returns 0 on success, or %EBUSY on error. A warning
629 * message is also printed on failure.
631 int macio_request_resources(struct macio_dev *dev, const char *name)
635 for (i = 0; i < dev->n_resources; i++)
636 if (macio_request_resource(dev, i, name))
642 macio_release_resource(dev, i);
648 * macio_release_resources - Release reserved memory resources
649 * @dev: MacIO device whose resources were previously reserved
652 void macio_release_resources(struct macio_dev *dev)
656 for (i = 0; i < dev->n_resources; i++)
657 macio_release_resource(dev, i);
663 static int __devinit macio_pci_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
665 struct device_node* np;
666 struct macio_chip* chip;
668 if (ent->vendor != PCI_VENDOR_ID_APPLE)
671 /* Note regarding refcounting: We assume pci_device_to_OF_node() is
672 * ported to new OF APIs and returns a node with refcount incremented.
674 np = pci_device_to_OF_node(pdev);
678 /* The above assumption is wrong !!!
679 * fix that here for now until I fix the arch code
683 /* We also assume that pmac_feature will have done a get() on nodes
684 * stored in the macio chips array
686 chip = macio_find(np, macio_unknown);
691 /* XXX Need locking ??? */
692 if (chip->lbus.pdev == NULL) {
693 chip->lbus.pdev = pdev;
694 chip->lbus.chip = chip;
695 pci_set_drvdata(pdev, &chip->lbus);
696 pci_set_master(pdev);
699 printk(KERN_INFO "MacIO PCI driver attached to %s chipset\n",
703 * HACK ALERT: The WallStreet PowerBook and some OHare based machines
704 * have 2 macio ASICs. I must probe the "main" one first or IDE
705 * ordering will be incorrect. So I put on "hold" the second one since
706 * it seem to appear first on PCI
708 if (chip->type == macio_gatwick || chip->type == macio_ohareII)
709 if (macio_chips[0].lbus.pdev == NULL) {
710 macio_on_hold = chip;
714 macio_pci_add_devices(chip);
715 if (macio_on_hold && macio_chips[0].lbus.pdev != NULL) {
716 macio_pci_add_devices(macio_on_hold);
717 macio_on_hold = NULL;
723 static void __devexit macio_pci_remove(struct pci_dev* pdev)
725 panic("removing of macio-asic not supported !\n");
729 * MacIO is matched against any Apple ID, it's probe() function
730 * will then decide wether it applies or not
732 static const struct pci_device_id __devinitdata pci_ids [] = { {
733 .vendor = PCI_VENDOR_ID_APPLE,
734 .device = PCI_ANY_ID,
735 .subvendor = PCI_ANY_ID,
736 .subdevice = PCI_ANY_ID,
738 }, { /* end: all zeroes */ }
740 MODULE_DEVICE_TABLE (pci, pci_ids);
742 /* pci driver glue; this is a "new style" PCI driver module */
743 static struct pci_driver macio_pci_driver = {
744 .name = (char *) "macio",
747 .probe = macio_pci_probe,
748 .remove = macio_pci_remove,
751 #endif /* CONFIG_PCI */
753 static int __init macio_module_init (void)
758 rc = pci_register_driver(&macio_pci_driver);
761 #endif /* CONFIG_PCI */
765 module_init(macio_module_init);
767 EXPORT_SYMBOL(macio_register_driver);
768 EXPORT_SYMBOL(macio_unregister_driver);
769 EXPORT_SYMBOL(macio_dev_get);
770 EXPORT_SYMBOL(macio_dev_put);
771 EXPORT_SYMBOL(macio_request_resource);
772 EXPORT_SYMBOL(macio_release_resource);
773 EXPORT_SYMBOL(macio_request_resources);
774 EXPORT_SYMBOL(macio_release_resources);