2 * (c) 1999--2000 Martin Mares <mj@suse.cz>
3 * (c) 2003 Eric Biederman <ebiederm@xmission.com>
4 * (c) 2003 Linux Networx
6 /* lots of mods by ron minnich (rminnich@lanl.gov), with
7 * the final architecture guidance from Tom Merritt (tjm@codegen.com)
8 * In particular, we changed from the one-pass original version to
9 * Tom's recommended multiple-pass version. I wasn't sure about doing
10 * it with multiple passes, until I actually started doing it and saw
11 * the wisdom of Tom's recommendations ...
13 * Lots of cleanups by Eric Biederman to handle bridges, and to
14 * handle resource allocation for non-pci devices.
17 #include <console/console.h>
20 #include <device/device.h>
21 #include <device/pci.h>
22 #include <device/pci_ids.h>
25 #include <smp/spinlock.h>
27 /** Linked list of ALL devices */
28 struct device *all_devices = &dev_root;
29 /** Pointer to the last device */
30 extern struct device **last_dev_p;
32 /** The upper limit of MEM resource of the devices.
33 * Reserve 20M for the system */
34 #define DEVICE_MEM_HIGH 0xFEBFFFFFUL
35 /** The lower limit of IO resource of the devices.
36 * Reserve 4k for ISA/Legacy devices */
37 #define DEVICE_IO_START 0x1000
40 * @brief Allocate a new device structure.
42 * Allocte a new device structure and attached it to the device tree as a
43 * child of the parent bus.
45 * @param parent parent bus the newly created device attached to.
46 * @param path path to the device to be created.
48 * @return pointer to the newly created device structure.
52 static spinlock_t dev_lock = SPIN_LOCK_UNLOCKED;
53 device_t alloc_dev(struct bus *parent, struct device_path *path)
60 /* Find the last child of our parent */
61 for (child = parent->children; child && child->sibling; ) {
62 child = child->sibling;
65 dev = malloc(sizeof(*dev));
67 die("DEV: out of memory.\n");
69 memset(dev, 0, sizeof(*dev));
70 memcpy(&dev->path, path, sizeof(*path));
72 /* Initialize the back pointers in the link fields */
73 for (link = 0; link < MAX_LINKS; link++) {
74 dev->link[link].dev = dev;
75 dev->link[link].link = link;
78 /* By default devices are enabled */
81 /* Add the new device to the list of children of the bus. */
86 parent->children = dev;
89 /* Append a new device to the global device list.
90 * The list is used to find devices once everything is set up.
93 last_dev_p = &dev->next;
95 spin_unlock(&dev_lock);
100 * @brief round a number up to an alignment.
101 * @param val the starting value
102 * @param roundup Alignment as a power of two
103 * @returns rounded up number
105 static resource_t round(resource_t val, unsigned long pow)
108 mask = (1ULL << pow) - 1ULL;
114 /** Read the resources on all devices of a given bus.
115 * @param bus bus to read the resources on.
117 static void read_resources(struct bus *bus)
119 struct device *curdev;
121 printk_spew("%s read_resources bus %d link: %d\n",
122 dev_path(bus->dev), bus->secondary, bus->link);
124 /* Walk through all of the devices and find which resources they need. */
125 for (curdev = bus->children; curdev; curdev = curdev->sibling) {
128 if (curdev->have_resources) {
131 if (!curdev->enabled) {
134 if (!curdev->ops || !curdev->ops->read_resources) {
135 printk_err("%s missing read_resources\n",
139 curdev->ops->read_resources(curdev);
140 curdev->have_resources = 1;
141 /* Read in subtractive resources behind the current device */
143 for (i = 0; i < curdev->resources; i++) {
144 struct resource *resource;
146 resource = &curdev->resource[i];
147 if (!(resource->flags & IORESOURCE_SUBTRACTIVE))
149 link = IOINDEX_SUBTRACTIVE_LINK(resource->index);
150 if (link > MAX_LINKS) {
151 printk_err("%s subtractive index on link: %d\n",
152 dev_path(curdev), link);
155 if (!(links & (1 << link))) {
156 links |= (1 << link);
157 read_resources(&curdev->link[resource->index]);
162 printk_spew("%s read_resources bus %d link: %d done\n",
163 dev_path(bus->dev), bus->secondary, bus->link);
166 struct pick_largest_state {
167 struct resource *last;
168 struct device *result_dev;
169 struct resource *result;
173 static void pick_largest_resource(void *gp,
174 struct device *dev, struct resource *resource)
176 struct pick_largest_state *state = gp;
177 struct resource *last;
179 /* Be certain to pick the successor to last */
180 if (resource == last) {
181 state->seen_last = 1;
185 (last->align < resource->align) ||
186 ((last->align == resource->align) &&
187 (last->size < resource->size)) ||
188 ((last->align == resource->align) &&
189 (last->size == resource->size) &&
190 (!state->seen_last)))) {
193 if (!state->result ||
194 (state->result->align < resource->align) ||
195 ((state->result->align == resource->align) &&
196 (state->result->size < resource->size))) {
197 state->result_dev = dev;
198 state->result = resource;
202 static struct device *largest_resource(struct bus *bus, struct resource **result_res,
203 unsigned long type_mask, unsigned long type)
205 struct pick_largest_state state;
207 state.last = *result_res;
208 state.result_dev = 0;
212 search_bus_resources(bus, type_mask, type, pick_largest_resource, &state);
214 *result_res = state.result;
215 return state.result_dev;
218 /* Compute allocate resources is the guts of the resource allocator.
221 * - Allocate resources locations for every device.
222 * - Don't overlap, and follow the rules of bridges.
223 * - Don't overlap with resources in fixed locations.
224 * - Be efficient so we don't have ugly strategies.
227 * - Devices that have fixed addresses are the minority so don't
228 * worry about them too much. Instead only use part of the address
229 * space for devices with programmable addresses. This easily handles
230 * everything except bridges.
232 * - PCI devices are required to have thier sizes and their alignments
233 * equal. In this case an optimal solution to the packing problem
234 * exists. Allocate all devices from highest alignment to least
235 * alignment or vice versa. Use this.
237 * - So we can handle more than PCI run two allocation passes on
238 * bridges. The first to see how large the resources are behind
239 * the bridge, and what their alignment requirements are. The
240 * second to assign a safe address to the devices behind the
241 * bridge. This allows me to treat a bridge as just a device with
242 * a couple of resources, and not need to special case it in the
243 * allocator. Also this allows handling of other types of bridges.
247 void compute_allocate_resource(
249 struct resource *bridge,
250 unsigned long type_mask,
254 struct resource *resource;
256 unsigned long align, min_align;
260 printk_spew("%s compute_allocate_%s: base: %08Lx size: %08Lx align: %d gran: %d\n",
262 (bridge->flags & IORESOURCE_IO)? "io":
263 (bridge->flags & IORESOURCE_PREFETCH)? "prefmem" : "mem",
264 base, bridge->size, bridge->align, bridge->gran);
266 /* We want different minimum alignments for different kinds of
267 * resources. These minimums are not device type specific
268 * but resource type specific.
270 if (bridge->flags & IORESOURCE_IO) {
271 min_align = log2(DEVICE_IO_ALIGN);
273 if (bridge->flags & IORESOURCE_MEM) {
274 min_align = log2(DEVICE_MEM_ALIGN);
277 /* Make certain I have read in all of the resources */
280 /* Remember I haven't found anything yet. */
283 /* Walk through all the devices on the current bus and
284 * compute the addresses.
286 while ((dev = largest_resource(bus, &resource, type_mask, type))) {
288 /* Do NOT I repeat do not ignore resources which have zero size.
289 * If they need to be ignored dev->read_resources should not even
290 * return them. Some resources must be set even when they have
291 * no size. PCI bridge resources are a good example of this.
293 /* Propogate the resource alignment to the bridge register */
294 if (resource->align > bridge->align) {
295 bridge->align = resource->align;
298 /* Make certain we are dealing with a good minimum size */
299 size = resource->size;
300 align = resource->align;
301 if (align < min_align) {
304 if (resource->flags & IORESOURCE_FIXED) {
307 /* Propogate the resource limit to the bridge register */
308 if (bridge->limit > resource->limit) {
309 bridge->limit = resource->limit;
311 /* Artificially deny limits between DEVICE_MEM_HIGH and 0xffffffff */
312 if ((bridge->limit > DEVICE_MEM_HIGH) && (bridge->limit <= 0xffffffff)) {
313 bridge->limit = DEVICE_MEM_HIGH;
315 if (resource->flags & IORESOURCE_IO) {
316 /* Don't allow potential aliases over the
317 * legacy pci expansion card addresses.
318 * The legacy pci decodes only 10 bits,
319 * uses 100h - 3ffh. Therefor, only 0 - ff
320 * can be used out of each 400h block of io
323 if ((base & 0x300) != 0) {
324 base = (base & ~0x3ff) + 0x400;
326 /* Don't allow allocations in the VGA IO range.
327 * PCI has special cases for that.
329 else if ((base >= 0x3b0) && (base <= 0x3df)) {
333 if (((round(base, align) + size) -1) <= resource->limit) {
334 /* base must be aligned to size */
335 base = round(base, align);
336 resource->base = base;
337 resource->flags |= IORESOURCE_ASSIGNED;
338 resource->flags &= ~IORESOURCE_STORED;
341 printk_spew("%s %02x * [0x%08Lx - 0x%08Lx] %s\n",
345 resource->base + resource->size - 1,
346 (resource->flags & IORESOURCE_IO)? "io":
347 (resource->flags & IORESOURCE_PREFETCH)? "prefmem": "mem");
350 /* A pci bridge resource does not need to be a power
351 * of two size, but it does have a minimum granularity.
352 * Round the size up to that minimum granularity so we
353 * know not to place something else at an address postitively
354 * decoded by the bridge.
356 bridge->size = round(base, bridge->gran) - bridge->base;
358 printk_spew("%s compute_allocate_%s: base: %08Lx size: %08Lx align: %d gran: %d done\n",
360 (bridge->flags & IORESOURCE_IO)? "io":
361 (bridge->flags & IORESOURCE_PREFETCH)? "prefmem" : "mem",
362 base, bridge->size, bridge->align, bridge->gran);
366 #if CONFIG_CONSOLE_VGA == 1
367 device_t vga_pri = 0;
368 static void allocate_vga_resource(void)
370 #warning "FIXME modify allocate_vga_resource so it is less pci centric!"
371 #warning "This function knows to much about PCI stuff, it should be just a ietrator/visitor."
373 /* FIXME handle the VGA pallette snooping */
374 struct device *dev, *vga, *vga_onboard;
379 for (dev = all_devices; dev; dev = dev->next) {
380 if ( !dev->enabled ) continue;
381 if (((dev->class >> 16) == PCI_BASE_CLASS_DISPLAY) &&
382 ((dev->class >> 8) != PCI_CLASS_DISPLAY_OTHER)) {
384 if (dev->on_mainboard) {
391 /* It isn't safe to enable other VGA cards */
392 dev->command &= ~(PCI_COMMAND_MEMORY | PCI_COMMAND_IO);
400 if (vga) { // vga is first add on card or the only onboard vga
401 printk_debug("Allocating VGA resource %s\n", dev_path(vga));
402 vga->command |= (PCI_COMMAND_MEMORY | PCI_COMMAND_IO);
406 /* Now walk up the bridges setting the VGA enable */
408 printk_debug("Setting PCI_BRIDGE_CTL_VGA for bridge %s\n",
410 bus->bridge_ctrl |= PCI_BRIDGE_CTL_VGA;
411 bus = (bus == bus->dev->bus)? 0 : bus->dev->bus;
419 * @brief Assign the computed resources to the devices on the bus.
421 * @param bus Pointer to the structure for this bus
423 * Use the device specific set_resources method to store the computed
424 * resources to hardware. For bridge devices, the set_resources() method
425 * has to recurse into every down stream buses.
428 * assign_resources() -> device_operation::set_resources()
429 * device_operation::set_resources() -> assign_resources()
431 void assign_resources(struct bus *bus)
433 struct device *curdev;
435 printk_spew("%s assign_resources, bus %d link: %d\n",
436 dev_path(bus->dev), bus->secondary, bus->link);
438 for (curdev = bus->children; curdev; curdev = curdev->sibling) {
439 if (!curdev->enabled || !curdev->resources) {
442 if (!curdev->ops || !curdev->ops->set_resources) {
443 printk_err("%s missing set_resources\n",
447 curdev->ops->set_resources(curdev);
449 printk_spew("%s assign_resources, bus %d link: %d\n",
450 dev_path(bus->dev), bus->secondary, bus->link);
454 * @brief Enable the resources for a specific device
456 * @param dev the device whose resources are to be enabled
458 * Enable resources of the device by calling the device specific
459 * enable_resources() method.
461 * The parent's resources should be enabled first to avoid having enabling
462 * order problem. This is done by calling the parent's enable_resources()
463 * method and let that method to call it's children's enable_resoruces()
464 * method via the (global) enable_childrens_resources().
466 * Indirect mutual recursion:
467 * enable_resources() -> device_operations::enable_resource()
468 * device_operations::enable_resource() -> enable_children_resources()
469 * enable_children_resources() -> enable_resources()
471 void enable_resources(struct device *dev)
476 if (!dev->ops || !dev->ops->enable_resources) {
477 printk_err("%s missing enable_resources\n", dev_path(dev));
480 dev->ops->enable_resources(dev);
484 * @brief Determine the existence of devices and extend the device tree.
486 * Most of the devices in the system are listed in the mainboard Config.lb
487 * file. The device structures for these devices are generated at compile
488 * time by the config tool and are organized into the device tree. This
489 * function determines if the devices created at compile time actually exist
490 * in the physical system.
492 * For devices in the physical system but not listed in the Config.lb file,
493 * the device structures have to be created at run time and attached to the
496 * This function starts from the root device 'dev_root', scan the buses in
497 * the system recursively, modify the device tree according to the result of
500 * This function has no idea how to scan and probe buses and devices at all.
501 * It depends on the bus/device specific scan_bus() method to do it. The
502 * scan_bus() method also has to create the device structure and attach
503 * it to the device tree.
505 void dev_enumerate(void)
508 unsigned subordinate;
509 printk_info("Enumerating buses...\n");
511 if (root->chip_ops && root->chip_ops->enable_dev) {
512 root->chip_ops->enable_dev(root);
514 if (!root->ops || !root->ops->scan_bus) {
515 printk_err("dev_root missing scan_bus operation");
518 subordinate = root->ops->scan_bus(root, 0);
519 printk_info("done\n");
523 * @brief Configure devices on the devices tree.
525 * Starting at the root of the device tree, travel it recursively in two
526 * passes. In the first pass, we compute and allocate resources (ranges)
527 * requried by each device. In the second pass, the resources ranges are
528 * relocated to their final position and stored to the hardware.
530 * I/O resources start at DEVICE_IO_START and grow upward. MEM resources start
531 * at DEVICE_MEM_START and grow downward.
533 * Since the assignment is hierarchical we set the values into the dev_root
536 void dev_configure(void)
538 struct resource *io, *mem;
541 printk_info("Allocating resources...\n");
544 if (!root->ops || !root->ops->read_resources) {
545 printk_err("dev_root missing read_resources\n");
548 if (!root->ops || !root->ops->set_resources) {
549 printk_err("dev_root missing set_resources\n");
553 printk_info("Reading resources...\n");
554 root->ops->read_resources(root);
555 printk_info("Done reading resources.\n");
557 /* Get the resources */
558 io = &root->resource[0];
559 mem = &root->resource[1];
560 /* Make certain the io devices are allocated somewhere safe. */
561 io->base = DEVICE_IO_START;
562 io->flags |= IORESOURCE_ASSIGNED;
563 io->flags &= ~IORESOURCE_STORED;
564 /* Now reallocate the pci resources memory with the
565 * highest addresses I can manage.
567 mem->base = resource_max(&root->resource[1]);
568 mem->flags |= IORESOURCE_ASSIGNED;
569 mem->flags &= ~IORESOURCE_STORED;
571 #if CONFIG_CONSOLE_VGA == 1
572 /* Allocate the VGA I/O resource.. */
573 allocate_vga_resource();
576 /* Store the computed resource allocations into device registers ... */
577 printk_info("Setting resources...\n");
578 root->ops->set_resources(root);
579 printk_info("Done setting resources.\n");
581 mem->flags |= IORESOURCE_STORED;
582 report_resource_stored(root, mem, "");
585 printk_info("Done allocating resources.\n");
589 * @brief Enable devices on the device tree.
591 * Starting at the root, walk the tree and enable all devices/bridges by
592 * calling the device's enable_resources() method.
594 void dev_enable(void)
596 printk_info("Enabling resourcess...\n");
598 /* now enable everything. */
599 enable_resources(&dev_root);
601 printk_info("done.\n");
605 * @brief Initialize all devices in the global device list.
607 * Starting at the first device on the global device link list,
608 * walk the list and call the device's init() method to do deivce
611 void dev_initialize(void)
615 printk_info("Initializing devices...\n");
616 #if CONFIG_CONSOLE_VGA == 1
617 for (dev = all_devices; dev; dev = dev->next) {
618 if (dev->enabled && !dev->initialized &&
619 dev->ops && dev->ops->init)
621 if( !dev->on_mainboard ) continue; // process addon card in second run
622 else if( dev->rom_address!=0 ) continue; // onboard and it is assigned via MB Config.lb, process it later
623 printk_debug("%s init\n", dev_path(dev));
624 dev->initialized = 1;
629 for (dev = all_devices; dev; dev = dev->next) {
630 if (dev->enabled && !dev->initialized &&
631 dev->ops && dev->ops->init)
633 printk_debug("%s init\n", dev_path(dev));
634 dev->initialized = 1;
638 printk_info("Devices initialized\n");