Please bear with me - another rename checkin. This qualifies as trivial, no
[coreboot.git] / src / devices / device.c
index a2ded6d17c35e7a62f2a6c9f43e05cef70802b0e..635f876bbebb940ee2f011241240535078e5cf3d 100644 (file)
@@ -1,7 +1,21 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * It was originally based on the Linux kernel (arch/i386/kernel/pci-pc.c).
+ *
+ * Modifications are:
+ * Copyright (C) 2003 Eric Biederman <ebiederm@xmission.com>
+ * Copyright (C) 2003-2004 Linux Networx
+ * (Written by Eric Biederman <ebiederman@lnxi.com> for Linux Networx)
+ * Copyright (C) 2003 Ronald G. Minnich <rminnich@gmail.com>
+ * Copyright (C) 2004-2005 Li-Ta Lo <ollie@lanl.gov>
+ * Copyright (C) 2005-2006 Tyan
+ * (Written by Yinghai Lu <yhlu@tyan.com> for Tyan)
+ * Copyright (C) 2005-2006 Stefan Reinauer <stepan@openbios.org>
+ */
+
 /*
  *      (c) 1999--2000 Martin Mares <mj@suse.cz>
- *      (c) 2003 Eric Biederman <ebiederm@xmission.com>
- *     (c) 2003 Linux Networx
  */
 /* lots of mods by ron minnich (rminnich@lanl.gov), with 
  * the final architecture guidance from Tom Merritt (tjm@codegen.com)
@@ -56,10 +70,12 @@ device_t alloc_dev(struct bus *parent, struct device_path *path)
        int link;
 
        spin_lock(&dev_lock);   
+
        /* Find the last child of our parent */
        for(child = parent->children; child && child->sibling; ) {
                child = child->sibling;
        }
+
        dev = malloc(sizeof(*dev));
        if (dev == 0) {
                die("DEV: out of memory.\n");
@@ -67,13 +83,12 @@ device_t alloc_dev(struct bus *parent, struct device_path *path)
        memset(dev, 0, sizeof(*dev));
        memcpy(&dev->path, path, sizeof(*path));
 
-
        /* Initialize the back pointers in the link fields */
        for(link = 0; link < MAX_LINKS; link++) {
                dev->link[link].dev  = dev;
                dev->link[link].link = link;
        }
-       
+
        /* By default devices are enabled */
        dev->enabled = 1;
 
@@ -153,8 +168,7 @@ static void read_resources(struct bus *bus)
                        }
                        if (!(links & (1 << link))) {
                                links |= (1 << link);
-                               read_resources(&curdev->link[resource->index]);
-                               
+                               read_resources(&curdev->link[link]);
                        }
                }
        }
@@ -169,9 +183,10 @@ struct pick_largest_state {
        int seen_last;
 };
 
-static void pick_largest_resource(struct pick_largest_state *state, 
+static void pick_largest_resource(void *gp,
        struct device *dev, struct resource *resource)
 {
+       struct pick_largest_state *state = gp;
        struct resource *last;
        last = state->last;
        /* Be certain to pick the successor to last */
@@ -179,6 +194,7 @@ static void pick_largest_resource(struct pick_largest_state *state,
                state->seen_last = 1;
                return;
        }
+       if (resource->flags & IORESOURCE_FIXED ) return; //skip it 
        if (last && (
                    (last->align < resource->align) ||
                    ((last->align == resource->align) &&
@@ -191,37 +207,13 @@ static void pick_largest_resource(struct pick_largest_state *state,
        if (!state->result || 
                (state->result->align < resource->align) ||
                ((state->result->align == resource->align) &&
-                       (state->result->size < resource->size))) {
+                       (state->result->size < resource->size)))
+       {
                state->result_dev = dev;
                state->result = resource;
        }    
 }
 
-static void find_largest_resource(struct pick_largest_state *state, 
-       struct bus *bus, unsigned long type_mask, unsigned long type)
-{
-       struct device *curdev;
-       for(curdev = bus->children; curdev; curdev = curdev->sibling) {
-               int i;
-               for(i = 0; i < curdev->resources; i++) {
-                       struct resource *resource = &curdev->resource[i];
-                       /* If it isn't the right kind of resource ignore it */
-                       if ((resource->flags & type_mask) != type) {
-                               continue;
-                       }
-                       /* If it is a subtractive resource recurse */
-                       if (resource->flags & IORESOURCE_SUBTRACTIVE) {
-                               struct bus *subbus;
-                               subbus = &curdev->link[resource->index];
-                               find_largest_resource(state, subbus, type_mask, type);
-                               continue;
-                       }
-                       /* See if this is the largest resource */
-                       pick_largest_resource(state, curdev, resource);
-               }
-       }
-}
-
 static struct device *largest_resource(struct bus *bus, struct resource **result_res,
        unsigned long type_mask, unsigned long type)
 {
@@ -232,7 +224,7 @@ static struct device *largest_resource(struct bus *bus, struct resource **result
        state.result = 0;
        state.seen_last = 0;
 
-       find_largest_resource(&state, bus, type_mask, type);
+       search_bus_resources(bus, type_mask, type, pick_largest_resource, &state);
 
        *result_res = state.result;
        return state.result_dev;
@@ -280,13 +272,12 @@ void compute_allocate_resource(
        min_align = 0;
        base = bridge->base;
 
-       printk_spew("%s compute_allocate_%s: base: %08lx size: %08lx align: %d gran: %d\n", 
+       printk_spew("%s compute_allocate_%s: base: %08Lx size: %08Lx align: %d gran: %d\n", 
                dev_path(bus->dev),
                (bridge->flags & IORESOURCE_IO)? "io":
                (bridge->flags & IORESOURCE_PREFETCH)? "prefmem" : "mem",
                base, bridge->size, bridge->align, bridge->gran);
 
-
        /* We want different minimum alignments for different kinds of
         * resources.  These minimums are not device type specific
         * but resource type specific.
@@ -314,30 +305,30 @@ void compute_allocate_resource(
                 * return them.   Some resources must be set even when they have
                 * no size.  PCI bridge resources are a good example of this.
                 */
-
                /* Propogate the resource alignment to the bridge register  */
                if (resource->align > bridge->align) {
                        bridge->align = resource->align;
                }
 
-               /* Propogate the resource limit to the bridge register */
-               if (bridge->limit > resource->limit) {
-                       bridge->limit = resource->limit;
-               }
-               /* Artificially deny limits between DEVICE_MEM_HIGH and 0xffffffff */
-               if ((bridge->limit > DEVICE_MEM_HIGH) && (bridge->limit <= 0xffffffff)) {
-                       bridge->limit = DEVICE_MEM_HIGH;
-               }
-
                /* Make certain we are dealing with a good minimum size */
                size = resource->size;
                align = resource->align;
                if (align < min_align) {
                        align = min_align;
                }
+
                if (resource->flags & IORESOURCE_FIXED) {
                        continue;
                }
+
+               /* Propogate the resource limit to the bridge register */
+               if (bridge->limit > resource->limit) {
+                       bridge->limit = resource->limit;
+               }
+               /* Artificially deny limits between DEVICE_MEM_HIGH and 0xffffffff */
+               if ((bridge->limit > DEVICE_MEM_HIGH) && (bridge->limit <= 0xffffffff)) {
+                       bridge->limit = DEVICE_MEM_HIGH;
+               }
                if (resource->flags & IORESOURCE_IO) {
                        /* Don't allow potential aliases over the
                         * legacy pci expansion card addresses.
@@ -382,7 +373,7 @@ void compute_allocate_resource(
         */
        bridge->size = round(base, bridge->gran) - bridge->base;
 
-       printk_spew("%s compute_allocate_%s: base: %08lx size: %08lx align: %d gran: %d done\n", 
+       printk_spew("%s compute_allocate_%s: base: %08Lx size: %08Lx align: %d gran: %d done\n", 
                dev_path(bus->dev),
                (bridge->flags & IORESOURCE_IO)? "io":
                (bridge->flags & IORESOURCE_PREFETCH)? "prefmem" : "mem",
@@ -391,51 +382,94 @@ void compute_allocate_resource(
 
 }
 
+#if CONFIG_CONSOLE_VGA == 1
+device_t vga_pri = 0;
 static void allocate_vga_resource(void)
 {
 #warning "FIXME modify allocate_vga_resource so it is less pci centric!"
 #warning "This function knows to much about PCI stuff, it should be just a ietrator/visitor."
 
        /* FIXME handle the VGA pallette snooping */
-       struct device *dev, *vga;
+       struct device *dev, *vga, *vga_onboard, *vga_first, *vga_last;
        struct bus *bus;
        bus = 0;
        vga = 0;
+       vga_onboard = 0;
+       vga_first = 0;
+       vga_last = 0;
        for(dev = all_devices; dev; dev = dev->next) {
+               if (!dev->enabled) continue;
                if (((dev->class >> 16) == PCI_BASE_CLASS_DISPLAY) &&
                        ((dev->class >> 8) != PCI_CLASS_DISPLAY_OTHER)) 
                {
-                       if (!vga) {
-                               printk_debug("Allocating VGA resource %s\n",
-                                       dev_path(dev));
-                               vga = dev;
-                       }
-                       if (vga == dev) {
-                               /* All legacy VGA cards have MEM & I/O space registers */
-                               dev->command |= PCI_COMMAND_MEMORY | PCI_COMMAND_IO;
-                       } else {
-                               /* It isn't safe to enable other VGA cards */
-                               dev->command &= ~(PCI_COMMAND_MEMORY | PCI_COMMAND_IO);
-                       }
+                        if (!vga_first) {
+                                if (dev->on_mainboard) {
+                                        vga_onboard = dev;
+                                } else {
+                                        vga_first = dev;
+                                }
+                        } else {
+                                if (dev->on_mainboard) {
+                                        vga_onboard = dev;
+                                } else {
+                                        vga_last = dev;
+                                }
+                        }
+
+                       /* It isn't safe to enable other VGA cards */
+                       dev->command &= ~(PCI_COMMAND_MEMORY | PCI_COMMAND_IO);
                }
        }
+       
+        vga = vga_last;
+
+        if(!vga) {
+                vga = vga_first;
+        }
+
+#if CONFIG_CONSOLE_VGA_ONBOARD_AT_FIRST == 1
+        if (vga_onboard) // will use on board vga as pri
+#else
+        if (!vga) // will use last add on adapter as pri
+#endif
+        {
+                vga = vga_onboard;
+        }
+
+       
        if (vga) {
+               /* vga is first add on card or the only onboard vga */
+               printk_debug("Allocating VGA resource %s\n", dev_path(vga));
+               /* All legacy VGA cards have MEM & I/O space registers */
+               vga->command |= (PCI_COMMAND_MEMORY | PCI_COMMAND_IO);
+               vga_pri = vga;
                bus = vga->bus;
        }
        /* Now walk up the bridges setting the VGA enable */
        while(bus) {
+               printk_debug("Setting PCI_BRIDGE_CTL_VGA for bridge %s\n",
+                            dev_path(bus->dev));
                bus->bridge_ctrl |= PCI_BRIDGE_CTL_VGA;
                bus = (bus == bus->dev->bus)? 0 : bus->dev->bus;
        } 
 }
 
+#endif
 
-/** Assign the computed resources to the bridges and devices on the bus.
- * Recurse to any bridges found on this bus first. Then do the devices
- * on this bus.
- * 
+
+/**
+ * @brief  Assign the computed resources to the devices on the bus.
+ *
  * @param bus Pointer to the structure for this bus
- */ 
+ *
+ * Use the device specific set_resources method to store the computed
+ * resources to hardware. For bridge devices, the set_resources() method
+ * has to recurse into every down stream buses.
+ *
+ * Mutual recursion:
+ *     assign_resources() -> device_operation::set_resources()
+ *     device_operation::set_resources() -> assign_resources()
+ */
 void assign_resources(struct bus *bus)
 {
        struct device *curdev;
@@ -468,10 +502,13 @@ void assign_resources(struct bus *bus)
  *
  * The parent's resources should be enabled first to avoid having enabling
  * order problem. This is done by calling the parent's enable_resources()
- * method and let that method to call it's children's enable_resoruces() via
- * enable_childrens_resources().
+ * method and let that method to call it's children's enable_resoruces()
+ * method via the (global) enable_childrens_resources().
  *
  * Indirect mutual recursion:
+ *     enable_resources() -> device_operations::enable_resource()
+ *     device_operations::enable_resource() -> enable_children_resources()
+ *     enable_children_resources() -> enable_resources()
  */
 void enable_resources(struct device *dev)
 {
@@ -485,17 +522,89 @@ void enable_resources(struct device *dev)
        dev->ops->enable_resources(dev);
 }
 
+/** 
+ * @brief Reset all of the devices a bus
+ *
+ * Reset all of the devices on a bus and clear the bus's reset_needed flag.
+ *
+ * @param bus pointer to the bus structure
+ *
+ * @return 1 if the bus was successfully reset, 0 otherwise.
+ *
+ */
+int reset_bus(struct bus *bus)
+{
+       if (bus && bus->dev && bus->dev->ops && bus->dev->ops->reset_bus)
+       {
+               bus->dev->ops->reset_bus(bus);
+               bus->reset_needed = 0;
+               return 1;
+       }
+       return 0;
+}
+
+/** 
+ * @brief Scan for devices on a bus.
+ *
+ * If there are bridges on the bus, recursively scan the buses behind the bridges.
+ * If the setting up and tuning of the bus causes a reset to be required, 
+ * reset the bus and scan it again.
+ *
+ * @param bus pointer to the bus device
+ * @param max current bus number
+ *
+ * @return The maximum bus number found, after scanning all subordinate busses
+ */
+unsigned int scan_bus(device_t bus, unsigned int max)
+{
+       unsigned int new_max;
+       int do_scan_bus;
+       if (    !bus ||
+               !bus->enabled ||
+               !bus->ops ||
+               !bus->ops->scan_bus)
+       {
+               return max;
+       }
+       do_scan_bus = 1;
+       while(do_scan_bus) {
+               int link;
+               new_max = bus->ops->scan_bus(bus, max);
+               do_scan_bus = 0;
+               for(link = 0; link < bus->links; link++) {
+                       if (bus->link[link].reset_needed) {
+                               if (reset_bus(&bus->link[link])) {
+                                       do_scan_bus = 1;
+                               } else {
+                                       bus->bus->reset_needed = 1;
+                               }
+                       }
+               }
+       }
+       return new_max;
+}
+
+
 /**
- * @brief Determine the existence of dynamic devices and construct dynamic
+ * @brief Determine the existence of devices and extend the device tree.
+ *
+ * Most of the devices in the system are listed in the mainboard Config.lb
+ * file. The device structures for these devices are generated at compile
+ * time by the config tool and are organized into the device tree. This
+ * function determines if the devices created at compile time actually exist
+ * in the physical system.
+ *
+ * For devices in the physical system but not listed in the Config.lb file,
+ * the device structures have to be created at run time and attached to the
  * device tree.
  *
- * Start from the root device 'dev_root', scan the buses in the system
- * recursively, build the dynamic device tree according to the result
- * of the probe.
+ * This function starts from the root device 'dev_root', scan the buses in
+ * the system recursively, modify the device tree according to the result of
+ * the probe.
  *
  * This function has no idea how to scan and probe buses and devices at all.
  * It depends on the bus/device specific scan_bus() method to do it. The
- * scan_bus() function also has to create the device structure and attach
+ * scan_bus() method also has to create the device structure and attach
  * it to the device tree. 
  */
 void dev_enumerate(void)
@@ -511,16 +620,17 @@ void dev_enumerate(void)
                printk_err("dev_root missing scan_bus operation");
                return;
        }
-       subordinate = root->ops->scan_bus(root, 0);
+       subordinate = scan_bus(root, 0);
        printk_info("done\n");
 }
 
-
 /**
  * @brief Configure devices on the devices tree.
  * 
- * Starting at the root of the dynamic device tree, travel recursively,
- * and compute resources needed by each device and allocate them.
+ * Starting at the root of the device tree, travel it recursively in two
+ * passes. In the first pass, we compute and allocate resources (ranges)
+ * requried by each device. In the second pass, the resources ranges are
+ * relocated to their final position and stored to the hardware.
  *
  * I/O resources start at DEVICE_IO_START and grow upward. MEM resources start
  * at DEVICE_MEM_START and grow downward.
@@ -544,7 +654,10 @@ void dev_configure(void)
                printk_err("dev_root missing set_resources\n");
                return;
        }
+
+       printk_info("Reading resources...\n");
        root->ops->read_resources(root);
+       printk_info("Done reading resources.\n");
 
        /* Get the resources */
        io  = &root->resource[0];
@@ -560,18 +673,21 @@ void dev_configure(void)
        mem->flags |= IORESOURCE_ASSIGNED;
        mem->flags &= ~IORESOURCE_STORED;
 
+#if CONFIG_CONSOLE_VGA == 1
        /* Allocate the VGA I/O resource.. */
        allocate_vga_resource(); 
+#endif
 
        /* Store the computed resource allocations into device registers ... */
+       printk_info("Setting resources...\n");
        root->ops->set_resources(root);
-
+       printk_info("Done setting resources.\n");
 #if 0
        mem->flags |= IORESOURCE_STORED;
        report_resource_stored(root, mem, "");
 #endif
 
-       printk_info("done.\n");
+       printk_info("Done allocating resources.\n");
 }
 
 /**
@@ -582,7 +698,7 @@ void dev_configure(void)
  */
 void dev_enable(void)
 {
-       printk_info("Enabling resourcess...\n");
+       printk_info("Enabling resources...\n");
 
        /* now enable everything. */
        enable_resources(&dev_root);
@@ -594,7 +710,8 @@ void dev_enable(void)
  * @brief Initialize all devices in the global device list.
  *
  * Starting at the first device on the global device link list,
- * walk the list and call a driver to do device specific setup.
+ * walk the list and call the device's init() method to do deivce
+ * specific setup.
  */
 void dev_initialize(void)
 {
@@ -605,6 +722,10 @@ void dev_initialize(void)
                if (dev->enabled && !dev->initialized && 
                        dev->ops && dev->ops->init) 
                {
+                       if (dev->path.type == DEVICE_PATH_I2C) {
+                               printk_debug("smbus: %s[%d]->",
+                                       dev_path(dev->bus->dev), dev->bus->link);
+                       }
                        printk_debug("%s init\n", dev_path(dev));
                        dev->initialized = 1;
                        dev->ops->init(dev);