2 * This file is part of the coreboot project.
4 * Copyright (C) 2003-2004 Linux Networx
5 * (Written by Eric Biederman <ebiederman@lnxi.com> for Linux Networx)
6 * Copyright (C) 2003 Greg Watson <jarrah@users.sourceforge.net>
7 * Copyright (C) 2004 Li-Ta Lo <ollie@lanl.gov>
8 * Copyright (C) 2005-2006 Tyan
9 * (Written by Yinghai Lu <yhlu@tyan.com> for Tyan)
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; version 2 of the License.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <console/console.h>
26 #include <device/device.h>
27 #include <device/path.h>
28 #include <device/pci.h>
29 #include <device/resource.h>
33 * @brief See if a device structure exists for path
35 * @param bus The bus to find the device on
36 * @param path The relative path from the bus to the appropriate device
37 * @return pointer to a device structure for the device on bus at path
38 * or 0/NULL if no device is found
40 device_t find_dev_path(struct bus *parent, struct device_path *path)
43 for(child = parent->children; child; child = child->sibling) {
44 if (path_eq(path, &child->path)) {
52 * @brief See if a device structure already exists and if not allocate it
54 * @param bus The bus to find the device on
55 * @param path The relative path from the bus to the appropriate device
56 * @return pointer to a device structure for the device on bus at path
58 device_t alloc_find_dev(struct bus *parent, struct device_path *path)
61 child = find_dev_path(parent, path);
63 child = alloc_dev(parent, path);
69 * @brief Given a PCI bus and a devfn number, find the device structure
71 * @param bus The bus number
72 * @param devfn a device/function number
73 * @return pointer to the device structure
75 struct device *dev_find_slot(unsigned int bus, unsigned int devfn)
77 struct device *dev, *result;
80 for (dev = all_devices; dev; dev = dev->next) {
81 if ((dev->path.type == DEVICE_PATH_PCI) &&
82 (dev->bus->secondary == bus) &&
83 (dev->path.pci.devfn == devfn)) {
92 * @brief Given a smbus bus and a device number, find the device structure
94 * @param bus The bus number
95 * @param addr a device number
96 * @return pointer to the device structure
98 struct device *dev_find_slot_on_smbus(unsigned int bus, unsigned int addr)
100 struct device *dev, *result;
103 for (dev = all_devices; dev; dev = dev->next) {
104 if ((dev->path.type == DEVICE_PATH_I2C) &&
105 (dev->bus->secondary == bus) &&
106 (dev->path.i2c.device == addr)) {
114 /** Find a device of a given vendor and type
115 * @param vendor Vendor ID (e.g. 0x8086 for Intel)
116 * @param device Device ID
117 * @param from Pointer to the device structure, used as a starting point
118 * in the linked list of all_devices, which can be 0 to start at the
119 * head of the list (i.e. all_devices)
120 * @return Pointer to the device struct
122 struct device *dev_find_device(unsigned int vendor, unsigned int device, struct device *from)
128 while (from && (from->vendor != vendor || from->device != device)) {
134 /** Find a device of a given class
135 * @param class Class of the device
136 * @param from Pointer to the device structure, used as a starting point
137 * in the linked list of all_devices, which can be 0 to start at the
138 * head of the list (i.e. all_devices)
139 * @return Pointer to the device struct
141 struct device *dev_find_class(unsigned int class, struct device *from)
147 while (from && (from->class & 0xffffff00) != class)
152 /* Warning: This function uses a static buffer. Don't call it more than once
153 * from the same print statement! */
155 const char *dev_path(device_t dev)
157 static char buffer[DEVICE_PATH_MAX];
160 memcpy(buffer, "<null>", 7);
163 switch(dev->path.type) {
164 case DEVICE_PATH_ROOT:
165 memcpy(buffer, "Root Device", 12);
167 case DEVICE_PATH_PCI:
168 #if CONFIG_PCI_BUS_SEGN_BITS
169 sprintf(buffer, "PCI: %04x:%02x:%02x.%01x",
170 dev->bus->secondary>>8, dev->bus->secondary & 0xff,
171 PCI_SLOT(dev->path.pci.devfn), PCI_FUNC(dev->path.pci.devfn));
173 sprintf(buffer, "PCI: %02x:%02x.%01x",
175 PCI_SLOT(dev->path.pci.devfn), PCI_FUNC(dev->path.pci.devfn));
178 case DEVICE_PATH_PNP:
179 sprintf(buffer, "PNP: %04x.%01x",
180 dev->path.pnp.port, dev->path.pnp.device);
182 case DEVICE_PATH_I2C:
183 sprintf(buffer, "I2C: %02x:%02x",
185 dev->path.i2c.device);
187 case DEVICE_PATH_APIC:
188 sprintf(buffer, "APIC: %02x",
189 dev->path.apic.apic_id);
191 case DEVICE_PATH_PCI_DOMAIN:
192 sprintf(buffer, "PCI_DOMAIN: %04x",
193 dev->path.pci_domain.domain);
195 case DEVICE_PATH_APIC_CLUSTER:
196 sprintf(buffer, "APIC_CLUSTER: %01x",
197 dev->path.apic_cluster.cluster);
199 case DEVICE_PATH_CPU:
200 sprintf(buffer, "CPU: %02x", dev->path.cpu.id);
202 case DEVICE_PATH_CPU_BUS:
203 sprintf(buffer, "CPU_BUS: %02x", dev->path.cpu_bus.id);
206 printk_err("Unknown device path type: %d\n", dev->path.type);
213 const char *bus_path(struct bus *bus)
215 static char buffer[BUS_PATH_MAX];
216 sprintf(buffer, "%s,%d", dev_path(bus->dev), bus->link);
220 int path_eq(struct device_path *path1, struct device_path *path2)
223 if (path1->type == path2->type) {
224 switch(path1->type) {
225 case DEVICE_PATH_NONE:
227 case DEVICE_PATH_ROOT:
230 case DEVICE_PATH_PCI:
231 equal = (path1->pci.devfn == path2->pci.devfn);
233 case DEVICE_PATH_PNP:
234 equal = (path1->pnp.port == path2->pnp.port) &&
235 (path1->pnp.device == path2->pnp.device);
237 case DEVICE_PATH_I2C:
238 equal = (path1->i2c.device == path2->i2c.device);
240 case DEVICE_PATH_APIC:
241 equal = (path1->apic.apic_id == path2->apic.apic_id);
243 case DEVICE_PATH_PCI_DOMAIN:
244 equal = (path1->pci_domain.domain == path2->pci_domain.domain);
246 case DEVICE_PATH_APIC_CLUSTER:
247 equal = (path1->apic_cluster.cluster == path2->apic_cluster.cluster);
249 case DEVICE_PATH_CPU:
250 equal = (path1->cpu.id == path2->cpu.id);
252 case DEVICE_PATH_CPU_BUS:
253 equal = (path1->cpu_bus.id == path2->cpu_bus.id);
256 printk_err("Uknown device type: %d\n", path1->type);
264 * See if we have unused but allocated resource structures.
265 * If so remove the allocation.
266 * @param dev The device to find the resource on
268 void compact_resources(device_t dev)
270 struct resource *resource;
272 /* Move all of the free resources to the end */
273 for(i = 0; i < dev->resources;) {
274 resource = &dev->resource[i];
275 if (!resource->flags) {
276 memmove(resource, resource + 1, (dev->resources - i) *
279 memset(&dev->resource[dev->resources], 0, sizeof(*resource));
288 * See if a resource structure already exists for a given index
289 * @param dev The device to find the resource on
290 * @param index The index of the resource on the device.
291 * @return the resource if it already exists
293 struct resource *probe_resource(device_t dev, unsigned index)
295 struct resource *resource;
297 /* See if there is a resource with the appropriate index */
299 for(i = 0; i < dev->resources; i++) {
300 if (dev->resource[i].index == index) {
301 resource = &dev->resource[i];
309 * See if a resource structure already exists for a given index and if
310 * not allocate one. Then initialize the initialize the resource
312 * @param dev The device to find the resource on
313 * @param index The index of the resource on the device.
315 struct resource *new_resource(device_t dev, unsigned index)
317 struct resource *resource;
319 /* First move all of the free resources to the end */
320 compact_resources(dev);
322 /* See if there is a resource with the appropriate index */
323 resource = probe_resource(dev, index);
325 if (dev->resources == MAX_RESOURCES) {
326 die("MAX_RESOURCES exceeded.");
328 resource = &dev->resource[dev->resources];
329 memset(resource, 0, sizeof(*resource));
332 /* Initialize the resource values */
333 if (!(resource->flags & IORESOURCE_FIXED)) {
339 resource->index = index;
347 * Return an existing resource structure for a given index.
348 * @param dev The device to find the resource on
349 * @param index The index of the resource on the device.
351 struct resource *find_resource(device_t dev, unsigned index)
353 struct resource *resource;
355 /* See if there is a resource with the appropriate index */
356 resource = probe_resource(dev, index);
358 printk_emerg("%s missing resource: %02x\n",
359 dev_path(dev), index);
367 * @brief round a number up to the next multiple of gran
368 * @param val the starting value
369 * @param gran granularity we are aligning the number to.
370 * @returns aligned value
372 static resource_t align_up(resource_t val, unsigned long gran)
375 mask = (1ULL << gran) - 1ULL;
382 * @brief round a number up to the previous multiple of gran
383 * @param val the starting value
384 * @param gran granularity we are aligning the number to.
385 * @returns aligned value
387 static resource_t align_down(resource_t val, unsigned long gran)
390 mask = (1ULL << gran) - 1ULL;
396 * @brief Compute the maximum address that is part of a resource
397 * @param resource the resource whose limit is desired
400 resource_t resource_end(struct resource *resource)
402 resource_t base, end;
403 /* get the base address */
404 base = resource->base;
406 /* For a non bridge resource granularity and alignment are the same.
407 * For a bridge resource align is the largest needed alignment below
408 * the bridge. While the granularity is simply how many low bits of the
409 * address cannot be set.
412 /* Get the end (rounded up) */
413 end = base + align_up(resource->size, resource->gran) - 1;
419 * @brief Compute the maximum legal value for resource->base
420 * @param resource the resource whose maximum is desired
421 * @returns the maximum
423 resource_t resource_max(struct resource *resource)
427 max = align_down(resource->limit - resource->size + 1, resource->align);
433 * @brief return the resource type of a resource
434 * @param resource the resource type to decode.
436 const char *resource_type(struct resource *resource)
438 static char buffer[RESOURCE_TYPE_MAX];
439 sprintf(buffer, "%s%s%s%s",
440 ((resource->flags & IORESOURCE_READONLY)? "ro": ""),
441 ((resource->flags & IORESOURCE_PREFETCH)? "pref":""),
442 ((resource->flags == 0)? "unused":
443 (resource->flags & IORESOURCE_IO)? "io":
444 (resource->flags & IORESOURCE_DRQ)? "drq":
445 (resource->flags & IORESOURCE_IRQ)? "irq":
446 (resource->flags & IORESOURCE_MEM)? "mem":"??????"),
447 ((resource->flags & IORESOURCE_PCI64)?"64":""));
452 * @brief print the resource that was just stored.
453 * @param dev the device the stored resorce lives on
454 * @param resource the resource that was just stored.
456 void report_resource_stored(device_t dev, struct resource *resource, const char *comment)
458 if (resource->flags & IORESOURCE_STORED) {
460 unsigned long long base, end;
461 base = resource->base;
462 end = resource_end(resource);
464 if (resource->flags & IORESOURCE_PCI_BRIDGE) {
465 #if CONFIG_PCI_BUS_SEGN_BITS
466 sprintf(buf, "bus %04x:%02x ", dev->bus->secondary>>8, dev->link[0].secondary & 0xff);
468 sprintf(buf, "bus %02x ", dev->link[0].secondary);
472 "%s %02lx <- [0x%010Lx - 0x%010Lx] size 0x%08Lx gran 0x%02x %s%s%s\n",
476 resource->size, resource->gran,
478 resource_type(resource),
483 void search_bus_resources(struct bus *bus,
484 unsigned long type_mask, unsigned long type,
485 resource_search_t search, void *gp)
487 struct device *curdev;
488 for(curdev = bus->children; curdev; curdev = curdev->sibling) {
490 /* Ignore disabled devices */
491 if (!curdev->enabled) continue;
492 for(i = 0; i < curdev->resources; i++) {
493 struct resource *resource = &curdev->resource[i];
494 /* If it isn't the right kind of resource ignore it */
495 if ((resource->flags & type_mask) != type) {
498 /* If it is a subtractive resource recurse */
499 if (resource->flags & IORESOURCE_SUBTRACTIVE) {
501 subbus = &curdev->link[IOINDEX_SUBTRACTIVE_LINK(resource->index)];
502 search_bus_resources(subbus, type_mask, type, search, gp);
505 search(gp, curdev, resource);
510 void search_global_resources(
511 unsigned long type_mask, unsigned long type,
512 resource_search_t search, void *gp)
514 struct device *curdev;
515 for(curdev = all_devices; curdev; curdev = curdev->next) {
517 /* Ignore disabled devices */
518 if (!curdev->enabled) continue;
519 for(i = 0; i < curdev->resources; i++) {
520 struct resource *resource = &curdev->resource[i];
521 /* If it isn't the right kind of resource ignore it */
522 if ((resource->flags & type_mask) != type) {
525 /* If it is a subtractive resource ignore it */
526 if (resource->flags & IORESOURCE_SUBTRACTIVE) {
529 search(gp, curdev, resource);
534 void dev_set_enabled(device_t dev, int enable)
536 if (dev->enabled == enable) {
539 dev->enabled = enable;
540 if (dev->ops && dev->ops->enable) {
541 dev->ops->enable(dev);
543 else if (dev->chip_ops && dev->chip_ops->enable_dev) {
544 dev->chip_ops->enable_dev(dev);
548 void disable_children(struct bus *bus)
551 for(child = bus->children; child; child = child->sibling) {
553 for(link = 0; link < child->links; link++) {
554 disable_children(&child->link[link]);
556 dev_set_enabled(child, 0);
560 static void resource_tree(struct device *root, int debug_level, int depth)
563 struct device *child;
564 char indent[30]; /* If your tree has more levels, it's wrong. */
566 for (i = 0; i < depth + 1 && i < 29; i++)
570 do_printk(BIOS_DEBUG, "%s%s links %x child on link 0", indent,
571 dev_path(root), root->links);
572 do_printk(BIOS_DEBUG, " %s\n", root->link[0].children ?
573 dev_path(root->link[0].children) : "NULL");
574 for (i = 0; i < root->resources; i++) {
575 do_printk(BIOS_DEBUG,
576 "%s%s resource base %llx size %llx align %d gran %d limit %llx flags %lx index %lx\n",
577 indent, dev_path(root), root->resource[i].base,
578 root->resource[i].size, root->resource[i].align,
579 root->resource[i].gran, root->resource[i].limit,
580 root->resource[i].flags, root->resource[i].index);
583 for (link = 0; link < root->links; link++) {
584 for (child = root->link[link].children; child;
585 child = child->sibling)
586 resource_tree(child, debug_level, depth + 1);
590 void print_resource_tree(struct device * root, int debug_level,
593 /* Bail if root is null. */
595 do_printk(debug_level, "%s passed NULL for root!\n", __func__);
599 /* Bail if not printing to screen. */
600 if (!do_printk(debug_level, "Show resources in subtree (%s)...%s\n",
601 dev_path(root), msg))
603 resource_tree(root, debug_level, 0);
606 void show_devs_tree(struct device *dev, int debug_level, int depth, int linknum)
608 char depth_str[20] = "";
610 struct device *sibling;
611 for (i = 0; i < depth; i++)
614 do_printk(debug_level, "%s%s: enabled %d, %d resources\n",
615 depth_str, dev_path(dev), dev->enabled, dev->resources);
616 for (i = 0; i < dev->links; i++) {
617 for (sibling = dev->link[i].children; sibling;
618 sibling = sibling->sibling)
619 show_devs_tree(sibling, debug_level, depth + 1, i);
623 void show_all_devs_tree(int debug_level, const char *msg)
625 /* Bail if not printing to screen. */
626 if (!do_printk(debug_level, "Show all devs in tree form...%s\n", msg))
628 show_devs_tree(all_devices, debug_level, 0, -1);
631 void show_devs_subtree(struct device *root, int debug_level, const char *msg)
633 /* Bail if not printing to screen. */
634 if (!do_printk(debug_level, "Show all devs in subtree %s...%s\n",
635 dev_path(root), msg))
637 do_printk(debug_level, "%s\n", msg);
638 show_devs_tree(root, debug_level, 0, -1);
641 void show_all_devs(int debug_level, const char *msg)
645 /* Bail if not printing to screen. */
646 if (!do_printk(debug_level, "Show all devs...%s\n", msg))
648 for (dev = all_devices; dev; dev = dev->next) {
649 do_printk(debug_level,
650 "%s: enabled %d, %d resources\n",
651 dev_path(dev), dev->enabled,
656 void show_one_resource(int debug_level, struct device *dev,
657 struct resource *resource, const char *comment)
660 unsigned long long base, end;
661 base = resource->base;
662 end = resource_end(resource);
665 if (resource->flags & IORESOURCE_BRIDGE) {
666 #if CONFIG_PCI_BUS_SEGN_BITS
667 sprintf(buf, "bus %04x:%02x ", dev->bus->secondary >> 8,
668 dev->link[0].secondary & 0xff);
670 sprintf(buf, "bus %02x ", dev->link[0].secondary);
674 do_printk(debug_level, "%s %02lx <- [0x%010llx - 0x%010llx] "
675 "size 0x%08Lx gran 0x%02x %s%s%s\n",
676 dev_path(dev), resource->index, base, end,
677 resource->size, resource->gran, buf,
678 resource_type(resource), comment);
682 void show_all_devs_resources(int debug_level, const char* msg)
686 if(!do_printk(debug_level, "Show all devs with resources...%s\n", msg))
689 for (dev = all_devices; dev; dev = dev->next) {
691 do_printk(debug_level,
692 "%s: enabled %d, %d resources\n",
693 dev_path(dev), dev->enabled,
695 for (i = 0; i < dev->resources; i++)
696 show_one_resource(debug_level, dev, &dev->resource[i], "");