sizeram removal/conversion.
[coreboot.git] / src / devices / device.c
index b54e7702947a3bd466f63226c5483176a7aa9949..96559c5833413ee315c2e2da633d35c0d7f0ef66 100644 (file)
 #include <arch/io.h>
 #include <device/device.h>
 #include <device/pci.h>
+#include <device/pci_ids.h>
 #include <stdlib.h>
 #include <string.h>
+#include <smp/spinlock.h>
 
-/* Linked list of ALL devices */
+/** Linked list of ALL devices */
 struct device *all_devices = &dev_root;
-/* pointer to the last device */
-static struct device **last_dev_p = &dev_root.next;
-
-#define DEVICE_MEM_HIGH  0xFEC00000UL /* Reserve 20M for the system */
+/** Pointer to the last device */
+extern struct device **last_dev_p;
+
+/** The upper limit of MEM resource of the devices.
+ * Reserve 20M for the system */
+#define DEVICE_MEM_HIGH 0xFEBFFFFFUL
+/** The lower limit of IO resource of the devices.
+ * Reserve 4k for ISA/Legacy devices */
 #define DEVICE_IO_START 0x1000
 
-/** Allocate a new device structure
+/**
+ * @brief Allocate a new device structure.
+ * 
+ * Allocte a new device structure and attached it to the device tree as a
+ * child of the parent bus.
+ *
+ * @param parent parent bus the newly created device attached to.
+ * @param path path to the device to be created.
+ *
+ * @return pointer to the newly created device structure.
+ *
+ * @see device_path
  */
+static spinlock_t dev_lock = SPIN_LOCK_UNLOCKED;
 device_t alloc_dev(struct bus *parent, struct device_path *path)
 {
        device_t dev, child;
        int link;
+
+       spin_lock(&dev_lock);   
        /* Find the last child of our parent */
        for(child = parent->children; child && child->sibling; ) {
                child = child->sibling;
@@ -47,55 +67,49 @@ device_t alloc_dev(struct bus *parent, struct device_path *path)
        memset(dev, 0, sizeof(*dev));
        memcpy(&dev->path, path, sizeof(*path));
 
-       /* Append a new device to the global device chain.
-        * The chain is used to find devices once everything is set up.
-        */
-       *last_dev_p = dev;
-       last_dev_p = &dev->next;
 
        /* 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;
 
-       /* Add the new device to the children of the bus. */
+       /* Add the new device to the list of children of the bus. */
        dev->bus = parent;
        if (child) {
                child->sibling = dev;
        } else {
                parent->children = dev;
        }
-       /* If we don't have any other information about a device enable it */
-       dev->enable = 1;
+
+       /* Append a new device to the global device list.
+        * The list is used to find devices once everything is set up.
+        */
+       *last_dev_p = dev;
+       last_dev_p = &dev->next;
+
+       spin_unlock(&dev_lock);
        return dev;
 }
 
-/** round a number to an alignment. 
+/**
+ * @brief round a number up to an alignment. 
  * @param val the starting value
  * @param roundup Alignment as a power of two
  * @returns rounded up number
  */
-static unsigned long round(unsigned long val, unsigned long roundup)
-{
-       /* ROUNDUP MUST BE A POWER OF TWO. */
-       unsigned long inverse;
-       inverse = ~(roundup - 1);
-       val += (roundup - 1);
-       val &= inverse;
-       return val;
-}
-
-static unsigned long round_down(unsigned long val, unsigned long round_down)
+static resource_t round(resource_t val, unsigned long pow)
 {
-       /* ROUND_DOWN MUST BE A POWER OF TWO. */
-       unsigned long inverse;
-       inverse = ~(round_down - 1);
-       val &= inverse;
+       resource_t mask;
+       mask = (1ULL << pow) - 1ULL;
+       val += mask;
+       val &= ~mask;
        return val;
 }
 
-
 /** Read the resources on all devices of a given bus.
  * @param bus bus to read the resources on.
  */
@@ -103,11 +117,17 @@ static void read_resources(struct bus *bus)
 {
        struct device *curdev;
 
+       printk_spew("%s read_resources bus %d link: %d\n",
+               dev_path(bus->dev), bus->secondary, bus->link);
+
        /* Walk through all of the devices and find which resources they need. */
        for(curdev = bus->children; curdev; curdev = curdev->sibling) {
                unsigned links;
                int i;
-               if (curdev->resources > 0) {
+               if (curdev->have_resources) {
+                       continue;
+               }
+               if (!curdev->enabled) {
                        continue;
                }
                if (!curdev->ops || !curdev->ops->read_resources) {
@@ -115,24 +135,31 @@ static void read_resources(struct bus *bus)
                                dev_path(curdev));
                        continue;
                }
-               if (!curdev->enable) {
-                       continue;
-               }
                curdev->ops->read_resources(curdev);
+               curdev->have_resources = 1;
                /* Read in subtractive resources behind the current device */
                links = 0;
                for(i = 0; i < curdev->resources; i++) {
                        struct resource *resource;
+                       unsigned link;
                        resource = &curdev->resource[i];
-                       if ((resource->flags & IORESOURCE_SUBTRACTIVE) &&
-                               (!(links & (1 << resource->index))))
-                       {
-                               links |= (1 << resource->index);
+                       if (!(resource->flags & IORESOURCE_SUBTRACTIVE)) 
+                               continue;
+                       link = IOINDEX_SUBTRACTIVE_LINK(resource->index);
+                       if (link > MAX_LINKS) {
+                               printk_err("%s subtractive index on link: %d\n",
+                                       dev_path(curdev), link);
+                               continue;
+                       }
+                       if (!(links & (1 << link))) {
+                               links |= (1 << link);
                                read_resources(&curdev->link[resource->index]);
                                
                        }
                }
        }
+       printk_spew("%s read_resources bus %d link: %d done\n",
+               dev_path(bus->dev), bus->secondary, bus->link);
 }
 
 struct pick_largest_state {
@@ -142,8 +169,8 @@ struct pick_largest_state {
        int seen_last;
 };
 
-static void pick_largest_resource(
-       struct pick_largest_state *state, struct device *dev, struct resource *resource)
+static void pick_largest_resource(struct pick_largest_state *state, 
+       struct device *dev, struct resource *resource)
 {
        struct resource *last;
        last = state->last;
@@ -167,8 +194,7 @@ static void pick_largest_resource(
                        (state->result->size < resource->size))) {
                state->result_dev = dev;
                state->result = resource;
-       }
-                   
+       }    
 }
 
 static void find_largest_resource(struct pick_largest_state *state, 
@@ -177,6 +203,8 @@ static void find_largest_resource(struct pick_largest_state *state,
        struct device *curdev;
        for(curdev = bus->children; curdev; curdev = curdev->sibling) {
                int i;
+               /* Ignore disabled devices */
+               if (!curdev->have_resources) continue;
                for(i = 0; i < curdev->resources; i++) {
                        struct resource *resource = &curdev->resource[i];
                        /* If it isn't the right kind of resource ignore it */
@@ -249,7 +277,7 @@ void compute_allocate_resource(
 {
        struct device *dev;
        struct resource *resource;
-       unsigned long base;
+       resource_t base;
        unsigned long align, min_align;
        min_align = 0;
        base = bridge->base;
@@ -278,9 +306,11 @@ void compute_allocate_resource(
        /* Remember I haven't found anything yet. */
        resource = 0;
 
-       /* Walk through all the devices on the current bus and compute the addresses */
+       /* Walk through all the devices on the current bus and 
+        * compute the addresses.
+        */
        while((dev = largest_resource(bus, &resource, type_mask, type))) {
-               unsigned long size;
+               resource_t size;
                /* Do NOT I repeat do not ignore resources which have zero size.
                 * If they need to be ignored dev->read_resources should not even
                 * return them.   Some resources must be set even when they have
@@ -301,6 +331,14 @@ void compute_allocate_resource(
                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.
@@ -319,23 +357,23 @@ void compute_allocate_resource(
                                base = 0x3e0;
                        }
                }
-               if (((round(base, 1UL << align) + size) -1) <= resource->limit) {
+               if (((round(base, align) + size) -1) <= resource->limit) {
                        /* base must be aligned to size */
-                       base = round(base, 1UL << align);
+                       base = round(base, align);
                        resource->base = base;
                        resource->flags |= IORESOURCE_ASSIGNED;
                        resource->flags &= ~IORESOURCE_STORED;
                        base += size;
                        
                        printk_spew(
-                               "%s %02x *  [0x%08lx - 0x%08lx] %s\n",
+                               "%s %02x *  [0x%08Lx - 0x%08Lx] %s\n",
                                dev_path(dev),
                                resource->index, 
-                               resource->base, resource->base + resource->size -1,
+                               resource->base, 
+                               resource->base + resource->size - 1,
                                (resource->flags & IORESOURCE_IO)? "io":
                                (resource->flags & IORESOURCE_PREFETCH)? "prefmem": "mem");
                }
-
        }
        /* A pci bridge resource does not need to be a power
         * of two size, but it does have a minimum granularity.
@@ -343,10 +381,10 @@ void compute_allocate_resource(
         * know not to place something else at an address postitively
         * decoded by the bridge.
         */
-       bridge->size = round(base, 1UL << bridge->gran) - bridge->base;
+       bridge->size = round(base, bridge->gran) - bridge->base;
 
        printk_spew("%s compute_allocate_%s: base: %08lx size: %08lx align: %d gran: %d done\n", 
-               dev_path(dev),
+               dev_path(bus->dev),
                (bridge->flags & IORESOURCE_IO)? "io":
                (bridge->flags & IORESOURCE_PREFETCH)? "prefmem" : "mem",
                base, bridge->size, bridge->align, bridge->gran);
@@ -357,16 +395,20 @@ void compute_allocate_resource(
 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 bus *bus;
        bus = 0;
        vga = 0;
        for(dev = all_devices; dev; dev = dev->next) {
-               if (((dev->class >> 16) == 0x03) &&
-                       ((dev->class >> 8) != 0x380)) {
+               if (((dev->class >> 16) == PCI_BASE_CLASS_DISPLAY) &&
+                       ((dev->class >> 8) != PCI_CLASS_DISPLAY_OTHER)) 
+               {
                        if (!vga) {
-                               printk_debug("Allocating VGA resource\n");
+                               printk_debug("Allocating VGA resource %s\n",
+                                       dev_path(dev));
                                vga = dev;
                        }
                        if (vga == dev) {
@@ -391,98 +433,153 @@ static void allocate_vga_resource(void)
 
 /** 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. 
+ * on this bus.
+ * 
  * @param bus Pointer to the structure for this bus
  */ 
 void assign_resources(struct bus *bus)
 {
        struct device *curdev;
 
-       printk_debug("ASSIGN RESOURCES, bus %d\n", bus->secondary);
+       printk_spew("%s assign_resources, bus %d link: %d\n", 
+               dev_path(bus->dev), bus->secondary, bus->link);
 
-       for (curdev = bus->children; curdev; curdev = curdev->sibling) {
+       for(curdev = bus->children; curdev; curdev = curdev->sibling) {
+               if (!curdev->enabled || !curdev->resources) {
+                       continue;
+               }
                if (!curdev->ops || !curdev->ops->set_resources) {
                        printk_err("%s missing set_resources\n",
                                dev_path(curdev));
                        continue;
                }
-               if (!curdev->enable) {
-                       continue;
-               }
                curdev->ops->set_resources(curdev);
        }
-       printk_debug("ASSIGNED RESOURCES, bus %d\n", bus->secondary);
+       printk_spew("%s assign_resources, bus %d link: %d\n", 
+               dev_path(bus->dev), bus->secondary, bus->link);
 }
 
+/**
+ * @brief Enable the resources for a specific device
+ *
+ * @param dev the device whose resources are to be enabled
+ *
+ * Enable resources of the device by calling the device specific
+ * enable_resources() method.
+ *
+ * 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().
+ *
+ * Indirect mutual recursion:
+ */
 void enable_resources(struct device *dev)
 {
-       /* Enable the resources for a specific device.
-        * The parents resources should be enabled first to avoid
-        * having enabling ordering problems.
-        */
-       if (!dev->ops || !dev->ops->enable_resources) {
-               printk_err("%s missing enable_resources\n",
-                       dev_path(dev));
+       if (!dev->enabled) {
                return;
        }
-       if (!dev->enable) {
+       if (!dev->ops || !dev->ops->enable_resources) {
+               printk_err("%s missing enable_resources\n", dev_path(dev));
                return;
        }
        dev->ops->enable_resources(dev);
 }
 
-/** Enumerate the resources on the PCI by calling pci_init
+/**
+ * @brief Determine the existence of dynamic devices and construct dynamic
+ * 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 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
+ * it to the device tree. 
  */
 void dev_enumerate(void)
 {
        struct device *root;
        unsigned subordinate;
-       printk_info("Enumerating buses...");
+       printk_info("Enumerating buses...\n");
        root = &dev_root;
+       if (root->chip_ops && root->chip_ops->enable_dev) {
+               root->chip_ops->enable_dev(root);
+       }
+       if (!root->ops || !root->ops->scan_bus) {
+               printk_err("dev_root missing scan_bus operation");
+               return;
+       }
        subordinate = root->ops->scan_bus(root, 0);
        printk_info("done\n");
 }
 
-/** Starting at the root, compute what resources are needed and allocate them. 
- * I/O starts at PCI_IO_START. Since the assignment is hierarchical we
- * set the values into the dev_root struct. 
+
+/**
+ * @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.
+ *
+ * I/O resources start at DEVICE_IO_START and grow upward. MEM resources start
+ * at DEVICE_MEM_START and grow downward.
+ *
+ * Since the assignment is hierarchical we set the values into the dev_root
+ * struct. 
  */
 void dev_configure(void)
 {
-       struct device *root = &dev_root;
-       printk_info("Allocating resources...");
-       printk_debug("\n");
+       struct resource *io, *mem;
+       struct device *root;
 
+       printk_info("Allocating resources...\n");
 
+       root = &dev_root;
+       if (!root->ops || !root->ops->read_resources) {
+               printk_err("dev_root missing read_resources\n");
+               return;
+       }
+       if (!root->ops || !root->ops->set_resources) {
+               printk_err("dev_root missing set_resources\n");
+               return;
+       }
        root->ops->read_resources(root);
 
-       /* Make certain the io devices are allocated somewhere
-        * safe.
-        */
-       root->resource[0].base = DEVICE_IO_START;
-       root->resource[0].flags |= IORESOURCE_ASSIGNED;
-       root->resource[0].flags &= ~IORESOURCE_STORED;
+       /* Get the resources */
+       io  = &root->resource[0];
+       mem = &root->resource[1];
+       /* Make certain the io devices are allocated somewhere safe. */
+       io->base = DEVICE_IO_START;
+       io->flags |= IORESOURCE_ASSIGNED;
+       io->flags &= ~IORESOURCE_STORED;
        /* Now reallocate the pci resources memory with the
         * highest addresses I can manage.
         */
-       root->resource[1].base = 
-               round_down(DEVICE_MEM_HIGH - root->resource[1].size,
-                       1UL << root->resource[1].align);
-       root->resource[1].flags |= IORESOURCE_ASSIGNED;
-       root->resource[1].flags &= ~IORESOURCE_STORED;
+       mem->base = resource_max(&root->resource[1]);
+       mem->flags |= IORESOURCE_ASSIGNED;
+       mem->flags &= ~IORESOURCE_STORED;
 
-       /* Allocate the VGA I/O resource..
-        */
+       /* Allocate the VGA I/O resource.. */
        allocate_vga_resource(); 
 
-       // now just set things into registers ... we hope ...
+       /* Store the computed resource allocations into device registers ... */
        root->ops->set_resources(root);
 
+#if 0
+       mem->flags |= IORESOURCE_STORED;
+       report_resource_stored(root, mem, "");
+#endif
+
        printk_info("done.\n");
 }
 
-/** Starting at the root, walk the tree and enable all devices/bridges. 
- * What really happens is computed COMMAND bits get set in register 4
+/**
+ * @brief Enable devices on the device tree.
+ *
+ * Starting at the root, walk the tree and enable all devices/bridges by
+ * calling the device's enable_resources() method.
  */
 void dev_enable(void)
 {
@@ -490,22 +587,30 @@ void dev_enable(void)
 
        /* now enable everything. */
        enable_resources(&dev_root);
+
        printk_info("done.\n");
 }
 
-/** Starting at the root, walk the tree and call a driver to
- *  do device specific setup.
+/**
+ * @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.
  */
 void dev_initialize(void)
 {
        struct device *dev;
 
        printk_info("Initializing devices...\n");
-       for (dev = all_devices; dev; dev = dev->next) {
-               if (dev->enable && dev->ops && dev->ops->init) {
+       for(dev = all_devices; dev; dev = dev->next) {
+               if (dev->enabled && !dev->initialized && 
+                       dev->ops && dev->ops->init) 
+               {
                        printk_debug("%s init\n", dev_path(dev));
+                       dev->initialized = 1;
                        dev->ops->init(dev);
                }
        }
        printk_info("Devices initialized\n");
 }
+