4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Copyright (c) 1999 The Puffin Group
10 * Copyright (c) 2001 Matthew Wilcox for Hewlett Packard
11 * Copyright (c) 2001 Helge Deller <deller@gmx.de>
12 * Copyright (c) 2001,2002 Ryan Bradetich
13 * Copyright (c) 2004-2005 Thibaut VARENE <varenet@parisc-linux.org>
15 * The file handles registering devices and drivers, then matching them.
16 * It's the closest we get to a dating agency.
18 * If you're thinking about modifying this file, here are some gotchas to
20 * - 715/Mirage device paths have a dummy device between Lasi and its children
21 * - The EISA adapter may show up as a sibling or child of Wax
22 * - Dino has an optionally functional serial port. If firmware enables it,
23 * it shows up as a child of Dino. If firmware disables it, the buswalk
24 * finds it and it shows up as a child of Cujo
25 * - Dino has both parisc and pci devices as children
26 * - parisc devices are discovered in a random order, including children
27 * before parents in some cases.
30 #include <linux/slab.h>
31 #include <linux/types.h>
32 #include <linux/kernel.h>
33 #include <linux/pci.h>
34 #include <linux/spinlock.h>
35 #include <linux/string.h>
36 #include <asm/hardware.h>
39 #include <asm/parisc-device.h>
41 /* See comments in include/asm-parisc/pci.h */
42 struct hppa_dma_ops *hppa_dma_ops;
43 EXPORT_SYMBOL(hppa_dma_ops);
45 static struct device root = {
49 static inline int check_dev(struct device *dev)
51 if (dev->bus == &parisc_bus_type) {
52 struct parisc_device *pdev;
53 pdev = to_parisc_device(dev);
54 return pdev->id.hw_type != HPHW_FAULTY;
59 static struct device *
60 parse_tree_node(struct device *parent, int index, struct hardware_path *modpath);
62 struct recurse_struct {
64 int (*fn)(struct device *, void *);
67 static int descend_children(struct device * dev, void * data)
69 struct recurse_struct * recurse_data = (struct recurse_struct *)data;
71 if (recurse_data->fn(dev, recurse_data->obj))
74 return device_for_each_child(dev, recurse_data, descend_children);
78 * for_each_padev - Iterate over all devices in the tree
79 * @fn: Function to call for each device.
80 * @data: Data to pass to the called function.
82 * This performs a depth-first traversal of the tree, calling the
83 * function passed for each node. It calls the function for parents
87 static int for_each_padev(int (*fn)(struct device *, void *), void * data)
89 struct recurse_struct recurse_data = {
93 return device_for_each_child(&root, &recurse_data, descend_children);
97 * match_device - Report whether this driver can handle this device
98 * @driver: the PA-RISC driver to try
99 * @dev: the PA-RISC device to try
101 static int match_device(struct parisc_driver *driver, struct parisc_device *dev)
103 const struct parisc_device_id *ids;
105 for (ids = driver->id_table; ids->sversion; ids++) {
106 if ((ids->sversion != SVERSION_ANY_ID) &&
107 (ids->sversion != dev->id.sversion))
110 if ((ids->hw_type != HWTYPE_ANY_ID) &&
111 (ids->hw_type != dev->id.hw_type))
114 if ((ids->hversion != HVERSION_ANY_ID) &&
115 (ids->hversion != dev->id.hversion))
123 static int parisc_driver_probe(struct device *dev)
126 struct parisc_device *pa_dev = to_parisc_device(dev);
127 struct parisc_driver *pa_drv = to_parisc_driver(dev->driver);
129 rc = pa_drv->probe(pa_dev);
132 pa_dev->driver = pa_drv;
137 static int parisc_driver_remove(struct device *dev)
139 struct parisc_device *pa_dev = to_parisc_device(dev);
140 struct parisc_driver *pa_drv = to_parisc_driver(dev->driver);
142 pa_drv->remove(pa_dev);
149 * register_parisc_driver - Register this driver if it can handle a device
150 * @driver: the PA-RISC driver to try
152 int register_parisc_driver(struct parisc_driver *driver)
154 /* FIXME: we need this because apparently the sti
155 * driver can be registered twice */
156 if(driver->drv.name) {
158 "BUG: skipping previously registered driver %s\n",
163 if (!driver->probe) {
165 "BUG: driver %s has no probe routine\n",
170 driver->drv.bus = &parisc_bus_type;
172 /* We install our own probe and remove routines */
173 WARN_ON(driver->drv.probe != NULL);
174 WARN_ON(driver->drv.remove != NULL);
176 driver->drv.probe = parisc_driver_probe;
177 driver->drv.remove = parisc_driver_remove;
178 driver->drv.name = driver->name;
180 return driver_register(&driver->drv);
182 EXPORT_SYMBOL(register_parisc_driver);
186 struct parisc_driver * driver;
190 static int match_and_count(struct device * dev, void * data)
192 struct match_count * m = data;
193 struct parisc_device * pdev = to_parisc_device(dev);
195 if (check_dev(dev)) {
196 if (match_device(m->driver, pdev))
203 * count_parisc_driver - count # of devices this driver would match
204 * @driver: the PA-RISC driver to try
206 * Use by IOMMU support to "guess" the right size IOPdir.
207 * Formula is something like memsize/(num_iommu * entry_size).
209 int count_parisc_driver(struct parisc_driver *driver)
211 struct match_count m = {
216 for_each_padev(match_and_count, &m);
224 * unregister_parisc_driver - Unregister this driver from the list of drivers
225 * @driver: the PA-RISC driver to unregister
227 int unregister_parisc_driver(struct parisc_driver *driver)
229 driver_unregister(&driver->drv);
232 EXPORT_SYMBOL(unregister_parisc_driver);
236 struct parisc_device * dev;
239 static int find_device(struct device * dev, void * data)
241 struct parisc_device * pdev = to_parisc_device(dev);
242 struct find_data * d = (struct find_data*)data;
244 if (check_dev(dev)) {
245 if (pdev->hpa.start == d->hpa) {
253 static struct parisc_device *find_device_by_addr(unsigned long hpa)
255 struct find_data d = {
260 ret = for_each_padev(find_device, &d);
261 return ret ? d.dev : NULL;
265 * find_pa_parent_type - Find a parent of a specific type
266 * @dev: The device to start searching from
267 * @type: The device type to search for.
269 * Walks up the device tree looking for a device of the specified type.
270 * If it finds it, it returns it. If not, it returns NULL.
272 const struct parisc_device *
273 find_pa_parent_type(const struct parisc_device *padev, int type)
275 const struct device *dev = &padev->dev;
276 while (dev != &root) {
277 struct parisc_device *candidate = to_parisc_device(dev);
278 if (candidate->id.hw_type == type)
287 static inline int is_pci_dev(struct device *dev)
289 return dev->bus == &pci_bus_type;
292 static inline int is_pci_dev(struct device *dev)
299 * get_node_path fills in @path with the firmware path to the device.
300 * Note that if @node is a parisc device, we don't fill in the 'mod' field.
301 * This is because both callers pass the parent and fill in the mod
302 * themselves. If @node is a PCI device, we do fill it in, even though this
305 static void get_node_path(struct device *dev, struct hardware_path *path)
308 memset(&path->bc, -1, 6);
310 if (is_pci_dev(dev)) {
311 unsigned int devfn = to_pci_dev(dev)->devfn;
312 path->mod = PCI_FUNC(devfn);
313 path->bc[i--] = PCI_SLOT(devfn);
317 while (dev != &root) {
318 if (is_pci_dev(dev)) {
319 unsigned int devfn = to_pci_dev(dev)->devfn;
320 path->bc[i--] = PCI_SLOT(devfn) | (PCI_FUNC(devfn)<< 5);
321 } else if (dev->bus == &parisc_bus_type) {
322 path->bc[i--] = to_parisc_device(dev)->hw_path;
328 static char *print_hwpath(struct hardware_path *path, char *output)
331 for (i = 0; i < 6; i++) {
332 if (path->bc[i] == -1)
334 output += sprintf(output, "%u/", (unsigned char) path->bc[i]);
336 output += sprintf(output, "%u", (unsigned char) path->mod);
341 * print_pa_hwpath - Returns hardware path for PA devices
342 * dev: The device to return the path for
343 * output: Pointer to a previously-allocated array to place the path in.
345 * This function fills in the output array with a human-readable path
346 * to a PA device. This string is compatible with that used by PDC, and
347 * may be printed on the outside of the box.
349 char *print_pa_hwpath(struct parisc_device *dev, char *output)
351 struct hardware_path path;
353 get_node_path(dev->dev.parent, &path);
354 path.mod = dev->hw_path;
355 return print_hwpath(&path, output);
357 EXPORT_SYMBOL(print_pa_hwpath);
359 #if defined(CONFIG_PCI) || defined(CONFIG_ISA)
361 * get_pci_node_path - Determines the hardware path for a PCI device
362 * @pdev: The device to return the path for
363 * @path: Pointer to a previously-allocated array to place the path in.
365 * This function fills in the hardware_path structure with the route to
366 * the specified PCI device. This structure is suitable for passing to
369 void get_pci_node_path(struct pci_dev *pdev, struct hardware_path *path)
371 get_node_path(&pdev->dev, path);
373 EXPORT_SYMBOL(get_pci_node_path);
376 * print_pci_hwpath - Returns hardware path for PCI devices
377 * dev: The device to return the path for
378 * output: Pointer to a previously-allocated array to place the path in.
380 * This function fills in the output array with a human-readable path
381 * to a PCI device. This string is compatible with that used by PDC, and
382 * may be printed on the outside of the box.
384 char *print_pci_hwpath(struct pci_dev *dev, char *output)
386 struct hardware_path path;
388 get_pci_node_path(dev, &path);
389 return print_hwpath(&path, output);
391 EXPORT_SYMBOL(print_pci_hwpath);
393 #endif /* defined(CONFIG_PCI) || defined(CONFIG_ISA) */
395 static void setup_bus_id(struct parisc_device *padev)
397 struct hardware_path path;
398 char *output = padev->dev.bus_id;
401 get_node_path(padev->dev.parent, &path);
403 for (i = 0; i < 6; i++) {
404 if (path.bc[i] == -1)
406 output += sprintf(output, "%u:", (unsigned char) path.bc[i]);
408 sprintf(output, "%u", (unsigned char) padev->hw_path);
411 struct parisc_device * create_tree_node(char id, struct device *parent)
413 struct parisc_device *dev = kmalloc(sizeof(*dev), GFP_KERNEL);
417 memset(dev, 0, sizeof(*dev));
419 dev->id.hw_type = HPHW_FAULTY;
421 dev->dev.parent = parent;
424 dev->dev.bus = &parisc_bus_type;
425 dev->dma_mask = 0xffffffffUL; /* PARISC devices are 32-bit */
427 /* make the generic dma mask a pointer to the parisc one */
428 dev->dev.dma_mask = &dev->dma_mask;
429 dev->dev.coherent_dma_mask = dev->dma_mask;
430 device_register(&dev->dev);
435 struct match_id_data {
437 struct parisc_device * dev;
440 static int match_by_id(struct device * dev, void * data)
442 struct parisc_device * pdev = to_parisc_device(dev);
443 struct match_id_data * d = data;
445 if (pdev->hw_path == d->id) {
453 * alloc_tree_node - returns a device entry in the iotree
454 * @parent: the parent node in the tree
455 * @id: the element of the module path for this entry
457 * Checks all the children of @parent for a matching @id. If none
458 * found, it allocates a new device and returns it.
460 static struct parisc_device * alloc_tree_node(struct device *parent, char id)
462 struct match_id_data d = {
465 if (device_for_each_child(parent, &d, match_by_id))
468 return create_tree_node(id, parent);
471 static struct parisc_device *create_parisc_device(struct hardware_path *modpath)
474 struct device *parent = &root;
475 for (i = 0; i < 6; i++) {
476 if (modpath->bc[i] == -1)
478 parent = &alloc_tree_node(parent, modpath->bc[i])->dev;
480 return alloc_tree_node(parent, modpath->mod);
483 struct parisc_device *
484 alloc_pa_dev(unsigned long hpa, struct hardware_path *mod_path)
487 unsigned long bytecnt;
489 struct parisc_device *dev;
492 /* Check to make sure this device has not already been added - Ryan */
493 if (find_device_by_addr(hpa) != NULL)
496 status = pdc_iodc_read(&bytecnt, hpa, 0, &iodc_data, 32);
497 if (status != PDC_OK)
500 dev = create_parisc_device(mod_path);
501 if (dev->id.hw_type != HPHW_FAULTY) {
502 printk("Two devices have hardware path %s. Please file a bug with HP.\n"
503 "In the meantime, you could try rearranging your cards.\n", parisc_pathname(dev));
507 dev->id.hw_type = iodc_data[3] & 0x1f;
508 dev->id.hversion = (iodc_data[0] << 4) | ((iodc_data[1] & 0xf0) >> 4);
509 dev->id.hversion_rev = iodc_data[1] & 0x0f;
510 dev->id.sversion = ((iodc_data[4] & 0x0f) << 16) |
511 (iodc_data[5] << 8) | iodc_data[6];
512 dev->hpa.name = parisc_pathname(dev);
513 dev->hpa.start = hpa;
514 if (hpa == 0xf4000000 || hpa == 0xf6000000 ||
515 hpa == 0xf8000000 || hpa == 0xfa000000) {
516 dev->hpa.end = hpa + 0x01ffffff;
518 dev->hpa.end = hpa + 0xfff;
520 dev->hpa.flags = IORESOURCE_MEM;
521 name = parisc_hardware_description(&dev->id);
523 strlcpy(dev->name, name, sizeof(dev->name));
526 /* Silently fail things like mouse ports which are subsumed within
527 * the keyboard controller
529 if ((hpa & 0xfff) == 0 && insert_resource(&iomem_resource, &dev->hpa))
530 printk("Unable to claim HPA %lx for device %s\n",
536 static int parisc_generic_match(struct device *dev, struct device_driver *drv)
538 return match_device(to_parisc_driver(drv), to_parisc_device(dev));
541 #define pa_dev_attr(name, field, format_string) \
542 static ssize_t name##_show(struct device *dev, struct device_attribute *attr, char *buf) \
544 struct parisc_device *padev = to_parisc_device(dev); \
545 return sprintf(buf, format_string, padev->field); \
548 #define pa_dev_attr_id(field, format) pa_dev_attr(field, id.field, format)
550 pa_dev_attr(irq, irq, "%u\n");
551 pa_dev_attr_id(hw_type, "0x%02x\n");
552 pa_dev_attr(rev, id.hversion_rev, "0x%x\n");
553 pa_dev_attr_id(hversion, "0x%03x\n");
554 pa_dev_attr_id(sversion, "0x%05x\n");
556 static struct device_attribute parisc_device_attrs[] = {
565 struct bus_type parisc_bus_type = {
567 .match = parisc_generic_match,
568 .dev_attrs = parisc_device_attrs,
572 * register_parisc_device - Locate a driver to manage this device.
573 * @dev: The parisc device.
575 * Search the driver list for a driver that is willing to manage
578 int register_parisc_device(struct parisc_device *dev)
590 * match_pci_device - Matches a pci device against a given hardware path
592 * @dev: the generic device (known to be contained by a pci_dev).
593 * @index: the current BC index
594 * @modpath: the hardware path.
595 * @return: true if the device matches the hardware path.
597 static int match_pci_device(struct device *dev, int index,
598 struct hardware_path *modpath)
600 struct pci_dev *pdev = to_pci_dev(dev);
604 /* we are at the end of the path, and on the actual device */
605 unsigned int devfn = pdev->devfn;
606 return ((modpath->bc[5] == PCI_SLOT(devfn)) &&
607 (modpath->mod == PCI_FUNC(devfn)));
610 id = PCI_SLOT(pdev->devfn) | (PCI_FUNC(pdev->devfn) << 5);
611 return (modpath->bc[index] == id);
615 * match_parisc_device - Matches a parisc device against a given hardware
617 * @dev: the generic device (known to be contained by a parisc_device).
618 * @index: the current BC index
619 * @modpath: the hardware path.
620 * @return: true if the device matches the hardware path.
622 static int match_parisc_device(struct device *dev, int index,
623 struct hardware_path *modpath)
625 struct parisc_device *curr = to_parisc_device(dev);
626 char id = (index == 6) ? modpath->mod : modpath->bc[index];
628 return (curr->hw_path == id);
631 struct parse_tree_data {
633 struct hardware_path * modpath;
637 static int check_parent(struct device * dev, void * data)
639 struct parse_tree_data * d = data;
641 if (check_dev(dev)) {
642 if (dev->bus == &parisc_bus_type) {
643 if (match_parisc_device(dev, d->index, d->modpath))
645 } else if (is_pci_dev(dev)) {
646 if (match_pci_device(dev, d->index, d->modpath))
648 } else if (dev->bus == NULL) {
649 /* we are on a bus bridge */
650 struct device *new = parse_tree_node(dev, d->index, d->modpath);
655 return d->dev != NULL;
659 * parse_tree_node - returns a device entry in the iotree
660 * @parent: the parent node in the tree
661 * @index: the current BC index
662 * @modpath: the hardware_path struct to match a device against
663 * @return: The corresponding device if found, NULL otherwise.
665 * Checks all the children of @parent for a matching @id. If none
666 * found, it returns NULL.
668 static struct device *
669 parse_tree_node(struct device *parent, int index, struct hardware_path *modpath)
671 struct parse_tree_data d = {
676 struct recurse_struct recurse_data = {
681 device_for_each_child(parent, &recurse_data, descend_children);
686 * hwpath_to_device - Finds the generic device corresponding to a given hardware path.
687 * @modpath: the hardware path.
688 * @return: The target device, NULL if not found.
690 struct device *hwpath_to_device(struct hardware_path *modpath)
693 struct device *parent = &root;
694 for (i = 0; i < 6; i++) {
695 if (modpath->bc[i] == -1)
697 parent = parse_tree_node(parent, i, modpath);
701 if (is_pci_dev(parent)) /* pci devices already parse MOD */
704 return parse_tree_node(parent, 6, modpath);
706 EXPORT_SYMBOL(hwpath_to_device);
709 * device_to_hwpath - Populates the hwpath corresponding to the given device.
710 * @param dev the target device
711 * @param path pointer to a previously allocated hwpath struct to be filled in
713 void device_to_hwpath(struct device *dev, struct hardware_path *path)
715 struct parisc_device *padev;
716 if (dev->bus == &parisc_bus_type) {
717 padev = to_parisc_device(dev);
718 get_node_path(dev->parent, path);
719 path->mod = padev->hw_path;
720 } else if (is_pci_dev(dev)) {
721 get_node_path(dev, path);
724 EXPORT_SYMBOL(device_to_hwpath);
726 #define BC_PORT_MASK 0x8
727 #define BC_LOWER_PORT 0x8
729 #define BUS_CONVERTER(dev) \
730 ((dev->id.hw_type == HPHW_IOA) || (dev->id.hw_type == HPHW_BCPORT))
732 #define IS_LOWER_PORT(dev) \
733 ((gsc_readl(dev->hpa.start + offsetof(struct bc_module, io_status)) \
734 & BC_PORT_MASK) == BC_LOWER_PORT)
736 #define MAX_NATIVE_DEVICES 64
737 #define NATIVE_DEVICE_OFFSET 0x1000
739 #define FLEX_MASK F_EXTEND(0xfffc0000)
740 #define IO_IO_LOW offsetof(struct bc_module, io_io_low)
741 #define IO_IO_HIGH offsetof(struct bc_module, io_io_high)
742 #define READ_IO_IO_LOW(dev) (unsigned long)(signed int)gsc_readl(dev->hpa.start + IO_IO_LOW)
743 #define READ_IO_IO_HIGH(dev) (unsigned long)(signed int)gsc_readl(dev->hpa.start + IO_IO_HIGH)
745 static void walk_native_bus(unsigned long io_io_low, unsigned long io_io_high,
746 struct device *parent);
748 void walk_lower_bus(struct parisc_device *dev)
750 unsigned long io_io_low, io_io_high;
752 if (!BUS_CONVERTER(dev) || IS_LOWER_PORT(dev))
755 if (dev->id.hw_type == HPHW_IOA) {
756 io_io_low = (unsigned long)(signed int)(READ_IO_IO_LOW(dev) << 16);
757 io_io_high = io_io_low + MAX_NATIVE_DEVICES * NATIVE_DEVICE_OFFSET;
759 io_io_low = (READ_IO_IO_LOW(dev) + ~FLEX_MASK) & FLEX_MASK;
760 io_io_high = (READ_IO_IO_HIGH(dev)+ ~FLEX_MASK) & FLEX_MASK;
763 walk_native_bus(io_io_low, io_io_high, &dev->dev);
767 * walk_native_bus -- Probe a bus for devices
768 * @io_io_low: Base address of this bus.
769 * @io_io_high: Last address of this bus.
770 * @parent: The parent bus device.
772 * A native bus (eg Runway or GSC) may have up to 64 devices on it,
773 * spaced at intervals of 0x1000 bytes. PDC may not inform us of these
774 * devices, so we have to probe for them. Unfortunately, we may find
775 * devices which are not physically connected (such as extra serial &
776 * keyboard ports). This problem is not yet solved.
778 static void walk_native_bus(unsigned long io_io_low, unsigned long io_io_high,
779 struct device *parent)
781 int i, devices_found = 0;
782 unsigned long hpa = io_io_low;
783 struct hardware_path path;
785 get_node_path(parent, &path);
787 for(i = 0; i < MAX_NATIVE_DEVICES; i++, hpa += NATIVE_DEVICE_OFFSET) {
788 struct parisc_device *dev;
790 /* Was the device already added by Firmware? */
791 dev = find_device_by_addr(hpa);
794 dev = alloc_pa_dev(hpa, &path);
798 register_parisc_device(dev);
803 } while(!devices_found && hpa < io_io_high);
806 #define CENTRAL_BUS_ADDR F_EXTEND(0xfff80000)
809 * walk_central_bus - Find devices attached to the central bus
811 * PDC doesn't tell us about all devices in the system. This routine
812 * finds devices connected to the central bus.
814 void walk_central_bus(void)
816 walk_native_bus(CENTRAL_BUS_ADDR,
817 CENTRAL_BUS_ADDR + (MAX_NATIVE_DEVICES * NATIVE_DEVICE_OFFSET),
821 static void print_parisc_device(struct parisc_device *dev)
826 print_pa_hwpath(dev, hw_path);
827 printk(KERN_INFO "%d. %s at 0x%lx [%s] { %d, 0x%x, 0x%.3x, 0x%.5x }",
828 ++count, dev->name, dev->hpa.start, hw_path, dev->id.hw_type,
829 dev->id.hversion_rev, dev->id.hversion, dev->id.sversion);
831 if (dev->num_addrs) {
833 printk(", additional addresses: ");
834 for (k = 0; k < dev->num_addrs; k++)
835 printk("0x%lx ", dev->addr[k]);
841 * init_parisc_bus - Some preparation to be done before inventory
843 void init_parisc_bus(void)
845 bus_register(&parisc_bus_type);
846 device_register(&root);
851 static int print_one_device(struct device * dev, void * data)
853 struct parisc_device * pdev = to_parisc_device(dev);
856 print_parisc_device(pdev);
861 * print_parisc_devices - Print out a list of devices found in this system
863 void print_parisc_devices(void)
865 for_each_padev(print_one_device, NULL);