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 /* Only quirks for memory resources for now */
284 if ((res
->flags
& IORESOURCE_MEM
) == 0)
287 /* Grand Central has too large resource 0 on some machines */
288 if (index
== 0 && !strcmp(np
->name
, "gc"))
289 res
->end
= res
->start
+ 0x1ffff;
291 /* Airport has bogus resource 2 */
292 if (index
>= 2 && !strcmp(np
->name
, "radio"))
296 /* DBDMAs may have bogus sizes */
297 if ((res
->start
& 0x0001f000) == 0x00008000)
298 res
->end
= res
->start
+ 0xff;
299 #endif /* CONFIG_PPC64 */
301 /* ESCC parent eats child resources. We could have added a
302 * level of hierarchy, but I don't really feel the need
305 if (!strcmp(np
->name
, "escc"))
308 /* ESCC has bogus resources >= 3 */
309 if (index
>= 3 && !(strcmp(np
->name
, "ch-a") &&
310 strcmp(np
->name
, "ch-b")))
313 /* Media bay has too many resources, keep only first one */
314 if (index
> 0 && !strcmp(np
->name
, "media-bay"))
317 /* Some older IDE resources have bogus sizes */
318 if (!(strcmp(np
->name
, "IDE") && strcmp(np
->name
, "ATA") &&
319 strcmp(np
->type
, "ide") && strcmp(np
->type
, "ata"))) {
320 if (index
== 0 && (res
->end
- res
->start
) > 0xfff)
321 res
->end
= res
->start
+ 0xfff;
322 if (index
== 1 && (res
->end
- res
->start
) > 0xff)
323 res
->end
= res
->start
+ 0xff;
328 static void macio_create_fixup_irq(struct macio_dev
*dev
, int index
,
333 irq
= irq_create_mapping(NULL
, line
);
335 dev
->interrupt
[index
].start
= irq
;
336 dev
->interrupt
[index
].flags
= IORESOURCE_IRQ
;
337 dev
->interrupt
[index
].name
= dev
->ofdev
.dev
.bus_id
;
339 if (dev
->n_interrupts
<= index
)
340 dev
->n_interrupts
= index
+ 1;
343 static void macio_add_missing_resources(struct macio_dev
*dev
)
345 struct device_node
*np
= dev
->ofdev
.node
;
346 unsigned int irq_base
;
348 /* Gatwick has some missing interrupts on child nodes */
349 if (dev
->bus
->chip
->type
!= macio_gatwick
)
352 /* irq_base is always 64 on gatwick. I have no cleaner way to get
353 * that value from here at this point
358 if (strcmp(np
->name
, "ch-a") == 0) {
359 macio_create_fixup_irq(dev
, 0, 15 + irq_base
);
360 macio_create_fixup_irq(dev
, 1, 4 + irq_base
);
361 macio_create_fixup_irq(dev
, 2, 5 + irq_base
);
362 printk(KERN_INFO
"macio: fixed SCC irqs on gatwick\n");
366 if (strcmp(np
->name
, "media-bay") == 0) {
367 macio_create_fixup_irq(dev
, 0, 29 + irq_base
);
368 printk(KERN_INFO
"macio: fixed media-bay irq on gatwick\n");
371 /* Fix left media bay childs */
372 if (dev
->media_bay
!= NULL
&& strcmp(np
->name
, "floppy") == 0) {
373 macio_create_fixup_irq(dev
, 0, 19 + irq_base
);
374 macio_create_fixup_irq(dev
, 1, 1 + irq_base
);
375 printk(KERN_INFO
"macio: fixed left floppy irqs\n");
377 if (dev
->media_bay
!= NULL
&& strcasecmp(np
->name
, "ata4") == 0) {
378 macio_create_fixup_irq(dev
, 0, 14 + irq_base
);
379 macio_create_fixup_irq(dev
, 0, 3 + irq_base
);
380 printk(KERN_INFO
"macio: fixed left ide irqs\n");
384 static void macio_setup_interrupts(struct macio_dev
*dev
)
386 struct device_node
*np
= dev
->ofdev
.node
;
391 struct resource
*res
= &dev
->interrupt
[j
];
393 if (j
>= MACIO_DEV_COUNT_IRQS
)
395 irq
= irq_of_parse_and_map(np
, i
++);
399 res
->flags
= IORESOURCE_IRQ
;
400 res
->name
= dev
->ofdev
.dev
.bus_id
;
401 if (macio_resource_quirks(np
, res
, i
- 1)) {
402 memset(res
, 0, sizeof(struct resource
));
407 dev
->n_interrupts
= j
;
410 static void macio_setup_resources(struct macio_dev
*dev
,
411 struct resource
*parent_res
)
413 struct device_node
*np
= dev
->ofdev
.node
;
417 for (index
= 0; of_address_to_resource(np
, index
, &r
) == 0; index
++) {
418 struct resource
*res
= &dev
->resource
[index
];
419 if (index
>= MACIO_DEV_COUNT_RESOURCES
)
422 res
->name
= dev
->ofdev
.dev
.bus_id
;
424 if (macio_resource_quirks(np
, res
, index
)) {
425 memset(res
, 0, sizeof(struct resource
));
428 /* Currently, we consider failure as harmless, this may
429 * change in the future, once I've found all the device
430 * tree bugs in older machines & worked around them
432 if (insert_resource(parent_res
, res
)) {
433 printk(KERN_WARNING
"Can't request resource "
434 "%d for MacIO device %s\n",
435 index
, dev
->ofdev
.dev
.bus_id
);
438 dev
->n_resources
= index
;
442 * macio_add_one_device - Add one device from OF node to the device tree
443 * @chip: pointer to the macio_chip holding the device
444 * @np: pointer to the device node in the OF tree
445 * @in_bay: set to 1 if device is part of a media-bay
447 * When media-bay is changed to hotswap drivers, this function will
448 * be exposed to the bay driver some way...
450 static struct macio_dev
* macio_add_one_device(struct macio_chip
*chip
,
451 struct device
*parent
,
452 struct device_node
*np
,
453 struct macio_dev
*in_bay
,
454 struct resource
*parent_res
)
456 struct macio_dev
*dev
;
462 dev
= kmalloc(sizeof(*dev
), GFP_KERNEL
);
465 memset(dev
, 0, sizeof(*dev
));
467 dev
->bus
= &chip
->lbus
;
468 dev
->media_bay
= in_bay
;
469 dev
->ofdev
.node
= np
;
470 dev
->ofdev
.dma_mask
= 0xffffffffUL
;
471 dev
->ofdev
.dev
.dma_mask
= &dev
->ofdev
.dma_mask
;
472 dev
->ofdev
.dev
.parent
= parent
;
473 dev
->ofdev
.dev
.bus
= &macio_bus_type
;
474 dev
->ofdev
.dev
.release
= macio_release_dev
;
477 printk("preparing mdev @%p, ofdev @%p, dev @%p, kobj @%p\n",
478 dev
, &dev
->ofdev
, &dev
->ofdev
.dev
, &dev
->ofdev
.dev
.kobj
);
481 /* MacIO itself has a different reg, we use it's PCI base */
482 if (np
== chip
->of_node
) {
483 sprintf(dev
->ofdev
.dev
.bus_id
, "%1d.%08x:%.*s",
486 (unsigned int)pci_resource_start(chip
->lbus
.pdev
, 0),
488 0, /* NuBus may want to do something better here */
490 MAX_NODE_NAME_SIZE
, np
->name
);
492 reg
= (u32
*)get_property(np
, "reg", NULL
);
493 sprintf(dev
->ofdev
.dev
.bus_id
, "%1d.%08x:%.*s",
495 reg
? *reg
: 0, MAX_NODE_NAME_SIZE
, np
->name
);
498 /* Setup interrupts & resources */
499 macio_setup_interrupts(dev
);
500 macio_setup_resources(dev
, parent_res
);
501 macio_add_missing_resources(dev
);
503 /* Register with core */
504 if (of_device_register(&dev
->ofdev
) != 0) {
505 printk(KERN_DEBUG
"macio: device registration error for %s!\n",
506 dev
->ofdev
.dev
.bus_id
);
514 static int macio_skip_device(struct device_node
*np
)
516 if (strncmp(np
->name
, "battery", 7) == 0)
518 if (strncmp(np
->name
, "escc-legacy", 11) == 0)
524 * macio_pci_add_devices - Adds sub-devices of mac-io to the device tree
525 * @chip: pointer to the macio_chip holding the devices
527 * This function will do the job of extracting devices from the
528 * Open Firmware device tree, build macio_dev structures and add
529 * them to the Linux device tree.
531 * For now, childs of media-bay are added now as well. This will
534 static void macio_pci_add_devices(struct macio_chip
*chip
)
536 struct device_node
*np
, *pnode
;
537 struct macio_dev
*rdev
, *mdev
, *mbdev
= NULL
, *sdev
= NULL
;
538 struct device
*parent
= NULL
;
539 struct resource
*root_res
= &iomem_resource
;
541 /* Add a node for the macio bus itself */
543 if (chip
->lbus
.pdev
) {
544 parent
= &chip
->lbus
.pdev
->dev
;
545 root_res
= &chip
->lbus
.pdev
->resource
[0];
548 pnode
= of_node_get(chip
->of_node
);
552 /* Add macio itself to hierarchy */
553 rdev
= macio_add_one_device(chip
, parent
, pnode
, NULL
, root_res
);
556 root_res
= &rdev
->resource
[0];
558 /* First scan 1st level */
559 for (np
= NULL
; (np
= of_get_next_child(pnode
, np
)) != NULL
;) {
560 if (macio_skip_device(np
))
563 mdev
= macio_add_one_device(chip
, &rdev
->ofdev
.dev
, np
, NULL
,
567 else if (strncmp(np
->name
, "media-bay", 9) == 0)
569 else if (strncmp(np
->name
, "escc", 4) == 0)
573 /* Add media bay devices if any */
575 for (np
= NULL
; (np
= of_get_next_child(mbdev
->ofdev
.node
, np
))
577 if (macio_skip_device(np
))
580 if (macio_add_one_device(chip
, &mbdev
->ofdev
.dev
, np
,
581 mbdev
, root_res
) == NULL
)
585 /* Add serial ports if any */
587 for (np
= NULL
; (np
= of_get_next_child(sdev
->ofdev
.node
, np
))
589 if (macio_skip_device(np
))
592 if (macio_add_one_device(chip
, &sdev
->ofdev
.dev
, np
,
593 NULL
, root_res
) == NULL
)
601 * macio_register_driver - Registers a new MacIO device driver
602 * @drv: pointer to the driver definition structure
604 int macio_register_driver(struct macio_driver
*drv
)
606 /* initialize common driver fields */
607 drv
->driver
.name
= drv
->name
;
608 drv
->driver
.bus
= &macio_bus_type
;
610 /* register with core */
611 return driver_register(&drv
->driver
);
615 * macio_unregister_driver - Unregisters a new MacIO device driver
616 * @drv: pointer to the driver definition structure
618 void macio_unregister_driver(struct macio_driver
*drv
)
620 driver_unregister(&drv
->driver
);
624 * macio_request_resource - Request an MMIO resource
625 * @dev: pointer to the device holding the resource
626 * @resource_no: resource number to request
627 * @name: resource name
629 * Mark memory region number @resource_no associated with MacIO
630 * device @dev as being reserved by owner @name. Do not access
631 * any address inside the memory regions unless this call returns
634 * Returns 0 on success, or %EBUSY on error. A warning
635 * message is also printed on failure.
637 int macio_request_resource(struct macio_dev
*dev
, int resource_no
,
640 if (macio_resource_len(dev
, resource_no
) == 0)
643 if (!request_mem_region(macio_resource_start(dev
, resource_no
),
644 macio_resource_len(dev
, resource_no
),
651 printk (KERN_WARNING
"MacIO: Unable to reserve resource #%d:%lx@%lx"
654 macio_resource_len(dev
, resource_no
),
655 macio_resource_start(dev
, resource_no
),
656 dev
->ofdev
.dev
.bus_id
);
661 * macio_release_resource - Release an MMIO resource
662 * @dev: pointer to the device holding the resource
663 * @resource_no: resource number to release
665 void macio_release_resource(struct macio_dev
*dev
, int resource_no
)
667 if (macio_resource_len(dev
, resource_no
) == 0)
669 release_mem_region(macio_resource_start(dev
, resource_no
),
670 macio_resource_len(dev
, resource_no
));
674 * macio_request_resources - Reserve all memory resources
675 * @dev: MacIO device whose resources are to be reserved
676 * @name: Name to be associated with resource.
678 * Mark all memory regions associated with MacIO device @dev as
679 * being reserved by owner @name. Do not access any address inside
680 * the memory regions unless this call returns successfully.
682 * Returns 0 on success, or %EBUSY on error. A warning
683 * message is also printed on failure.
685 int macio_request_resources(struct macio_dev
*dev
, const char *name
)
689 for (i
= 0; i
< dev
->n_resources
; i
++)
690 if (macio_request_resource(dev
, i
, name
))
696 macio_release_resource(dev
, i
);
702 * macio_release_resources - Release reserved memory resources
703 * @dev: MacIO device whose resources were previously reserved
706 void macio_release_resources(struct macio_dev
*dev
)
710 for (i
= 0; i
< dev
->n_resources
; i
++)
711 macio_release_resource(dev
, i
);
717 static int __devinit
macio_pci_probe(struct pci_dev
*pdev
, const struct pci_device_id
*ent
)
719 struct device_node
* np
;
720 struct macio_chip
* chip
;
722 if (ent
->vendor
!= PCI_VENDOR_ID_APPLE
)
725 /* Note regarding refcounting: We assume pci_device_to_OF_node() is
726 * ported to new OF APIs and returns a node with refcount incremented.
728 np
= pci_device_to_OF_node(pdev
);
732 /* The above assumption is wrong !!!
733 * fix that here for now until I fix the arch code
737 /* We also assume that pmac_feature will have done a get() on nodes
738 * stored in the macio chips array
740 chip
= macio_find(np
, macio_unknown
);
745 /* XXX Need locking ??? */
746 if (chip
->lbus
.pdev
== NULL
) {
747 chip
->lbus
.pdev
= pdev
;
748 chip
->lbus
.chip
= chip
;
749 pci_set_drvdata(pdev
, &chip
->lbus
);
750 pci_set_master(pdev
);
753 printk(KERN_INFO
"MacIO PCI driver attached to %s chipset\n",
757 * HACK ALERT: The WallStreet PowerBook and some OHare based machines
758 * have 2 macio ASICs. I must probe the "main" one first or IDE
759 * ordering will be incorrect. So I put on "hold" the second one since
760 * it seem to appear first on PCI
762 if (chip
->type
== macio_gatwick
|| chip
->type
== macio_ohareII
)
763 if (macio_chips
[0].lbus
.pdev
== NULL
) {
764 macio_on_hold
= chip
;
768 macio_pci_add_devices(chip
);
769 if (macio_on_hold
&& macio_chips
[0].lbus
.pdev
!= NULL
) {
770 macio_pci_add_devices(macio_on_hold
);
771 macio_on_hold
= NULL
;
777 static void __devexit
macio_pci_remove(struct pci_dev
* pdev
)
779 panic("removing of macio-asic not supported !\n");
783 * MacIO is matched against any Apple ID, it's probe() function
784 * will then decide wether it applies or not
786 static const struct pci_device_id __devinitdata pci_ids
[] = { {
787 .vendor
= PCI_VENDOR_ID_APPLE
,
788 .device
= PCI_ANY_ID
,
789 .subvendor
= PCI_ANY_ID
,
790 .subdevice
= PCI_ANY_ID
,
792 }, { /* end: all zeroes */ }
794 MODULE_DEVICE_TABLE (pci
, pci_ids
);
796 /* pci driver glue; this is a "new style" PCI driver module */
797 static struct pci_driver macio_pci_driver
= {
798 .name
= (char *) "macio",
801 .probe
= macio_pci_probe
,
802 .remove
= macio_pci_remove
,
805 #endif /* CONFIG_PCI */
807 static int __init
macio_module_init (void)
812 rc
= pci_register_driver(&macio_pci_driver
);
815 #endif /* CONFIG_PCI */
819 module_init(macio_module_init
);
821 EXPORT_SYMBOL(macio_register_driver
);
822 EXPORT_SYMBOL(macio_unregister_driver
);
823 EXPORT_SYMBOL(macio_dev_get
);
824 EXPORT_SYMBOL(macio_dev_put
);
825 EXPORT_SYMBOL(macio_request_resource
);
826 EXPORT_SYMBOL(macio_release_resource
);
827 EXPORT_SYMBOL(macio_request_resources
);
828 EXPORT_SYMBOL(macio_release_resources
);