changed dev->enable to dev->enabled. Sorry, I am the only one who can't speak
[coreboot.git] / src / devices / device.c
index ffc72533892d3fb01d2ebc9a3aa00a85b048eb9d..60e79c5a580dc54d7ffbfc5bb96fc455642e2bfe 100644 (file)
@@ -1,6 +1,7 @@
 /*
  *      (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)
 
 #include <console/console.h>
 #include <bitops.h>
-#include <device.h>
 #include <arch/io.h>
-#include <pci.h>
+#include <device/device.h>
+#include <device/pci.h>
+#include <stdlib.h>
+#include <string.h>
+
+/** 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;
+
+/** The upper limit of MEM resource of the devices.
+ * Reserve 20M for the system */
+#define DEVICE_MEM_HIGH 0xFEC00000UL
+/** The lower limit of IO resource of the devices.
+ * Reserve 4k for ISA/Legacy devices */
+#define DEVICE_IO_START 0x1000
 
 /**
- * This is the root of the device tree. A PCI tree always has 
- * one bus, bus 0. Bus 0 contains devices and bridges. 
+ * @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
  */
-struct device dev_root;
-/* Linked list of ALL devices */
-struct device *all_devices = 0;
-/* pointer to the last device */
-static struct device **last_dev_p = &all_devices;
-
-#define DEVICE_MEM_HIGH  0xFEC00000UL /* Reserve 20M for the system */
-#define DEVICE_IO_START 0x1000
-
+device_t alloc_dev(struct bus *parent, struct device_path *path)
+{
+       device_t dev, child;
+       int link;
 
-unsigned long device_memory_base;
+       /* 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");
+       }
+       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.
- */
-void append_device(struct device *dev)
-{
+       /* 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;
-}
 
+       /* 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;
+       }
+
+       /* Add the new device to the 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->enabled = 1;
 
-/** round a number to an alignment. 
+       return dev;
+}
+
+/**
+ * @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
@@ -74,61 +119,123 @@ static unsigned long round_down(unsigned long val, unsigned long round_down)
 /** Read the resources on all devices of a given bus.
  * @param bus bus to read the resources on.
  */
-static void read_resources(struct device *bus)
+static void read_resources(struct bus *bus)
 {
        struct device *curdev;
 
-       
        /* Walk through all of the devices and find which resources they need. */
-       for(curdev = bus->children; curdev; curdev = curdev->sibling) {
+       for (curdev = bus->children; curdev; curdev = curdev->sibling) {
+               unsigned links;
+               int i;
                if (curdev->resources > 0) {
                        continue;
                }
+               if (!curdev->ops || !curdev->ops->read_resources) {
+                       printk_err("%s missing read_resources\n",
+                                  dev_path(curdev));
+                       continue;
+               }
+               if (!curdev->enabled) {
+                       continue;
+               }
+
                curdev->ops->read_resources(curdev);
+
+               /* Read in subtractive resources behind the current device */
+               links = 0;
+               for (i = 0; i < curdev->resources; i++) {
+                       struct resource *resource;
+                       resource = &curdev->resource[i];
+                       if ((resource->flags & IORESOURCE_SUBTRACTIVE) &&
+                           (!(links & (1 << resource->index))))
+                       {
+                               links |= (1 << resource->index);
+                               read_resources(&curdev->link[resource->index]);
+                               
+                       }
+               }
+       }
+}
+
+struct pick_largest_state {
+       struct resource *last;
+       struct device   *result_dev;
+       struct resource *result;
+       int seen_last;
+};
+
+static void pick_largest_resource(struct pick_largest_state *state,
+                                 struct device *dev, struct resource *resource)
+{
+       struct resource *last;
+       last = state->last;
+       /* Be certain to pick the successor to last */
+       if (resource == last) {
+               state->seen_last = 1;
+               return;
        }
+       if (last &&
+           ((last->align < resource->align) ||
+            ((last->align == resource->align) &&
+             (last->size < resource->size)) ||
+            ((last->align == resource->align) &&
+             (last->size == resource->size) &&
+             (!state->seen_last)))) {
+               return;
+       }
+       if (!state->result ||
+           (state->result->align < resource->align) ||
+           ((state->result->align == resource->align) &&
+            (state->result->size < resource->size))) {
+               state->result_dev = dev;
+               state->result = resource;
+       }    
 }
 
-static struct device *largest_resource(struct device *bus, struct resource **result_res,
-       unsigned long type_mask, unsigned long type)
+static void find_largest_resource(struct pick_largest_state *state, 
+                                 struct bus *bus, unsigned long type_mask,
+                                 unsigned long type)
 {
        struct device *curdev;
-       struct device *result_dev = 0;
-       struct resource *last = *result_res;
-       struct resource *result = 0;
-       int seen_last = 0;
-       for(curdev = bus->children; curdev; curdev = curdev->sibling) {
+
+       for (curdev = bus->children; curdev; curdev = curdev->sibling) {
                int i;
-               for(i = 0; i < curdev->resources; 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;
                        }
-                       /* Be certain to pick the successor to last */
-                       if (resource == last) {
-                               seen_last = 1;
+                       /* 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;
                        }
-                       if (last && (
-                               (last->align < resource->align) ||
-                               ((last->align == resource->align) &&
-                                       (last->size < resource->size)) ||
-                               ((last->align == resource->align) &&
-                                       (last->size == resource->size) &&
-                                       (!seen_last)))) {
-                               continue;
-                       }
-                       if (!result || 
-                               (result->align < resource->align) ||
-                               ((result->align == resource->align) &&
-                                       (result->size < resource->size))) {
-                               result_dev = curdev;
-                               result = resource;
-                       }
+                       /* See if this is the largest resource */
+                       pick_largest_resource(state, curdev, resource);
                }
        }
-       *result_res = result;
-       return result_dev;
+}
+
+static struct device *largest_resource(struct bus *bus,
+                                      struct resource **result_res,
+                                      unsigned long type_mask,
+                                      unsigned long type)
+{
+       struct pick_largest_state state;
+
+       state.last = *result_res;
+       state.result_dev = 0;
+       state.result = 0;
+       state.seen_last = 0;
+
+       find_largest_resource(&state, bus, type_mask, type);
+
+       *result_res = state.result;
+       return state.result_dev;
 }
 
 /* Compute allocate resources is the guts of the resource allocator.
@@ -161,7 +268,7 @@ static struct device *largest_resource(struct device *bus, struct resource **res
  */
 
 void compute_allocate_resource(
-       struct device *bus,
+       struct bus *bus,
        struct resource *bridge,
        unsigned long type_mask,
        unsigned long type)
@@ -173,6 +280,13 @@ 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", 
+                   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.
@@ -184,21 +298,15 @@ void compute_allocate_resource(
                min_align = log2(DEVICE_MEM_ALIGN);
        }
 
-       printk_spew("DEV: %02x:%02x.%01x compute_allocate_%s: base: %08lx size: %08lx align: %d gran: %d\n", 
-               bus->bus->secondary,
-               PCI_SLOT(bus->devfn), PCI_FUNC(bus->devfn),
-               (bridge->flags & IORESOURCE_IO)? "io":
-               (bridge->flags & IORESOURCE_PREFETCH)? "prefmem" : "mem",
-               base, bridge->size, bridge->align, bridge->gran);
-
        /* Make certain I have read in all of the resources */
        read_resources(bus);
 
        /* Remember I haven't found anything yet. */
        resource = 0;
 
-       /* Walk through all the devices on the current bus and compute the addresses */
-       while((dev = largest_resource(bus, &resource, type_mask, type))) {
+       /* 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;
                /* Do NOT I repeat do not ignore resources which have zero size.
                 * If they need to be ignored dev->read_resources should not even
@@ -217,11 +325,18 @@ void compute_allocate_resource(
                if (align < min_align) {
                        align = min_align;
                }
+               if (resource->flags & IORESOURCE_FIXED) {
+                       continue;
+               }
                if (resource->flags & IORESOURCE_IO) {
                        /* Don't allow potential aliases over the
                         * legacy pci expansion card addresses.
+                        * The legacy pci decodes only 10 bits,
+                        * uses 100h - 3ffh. Therefor, only 0 - ff
+                        * can be used out of each 400h block of io
+                        * space.
                         */
-                       if ((base > 0x3ff) && ((base & 0x300) != 0)) {
+                       if ((base & 0x300) != 0) {
                                base = (base & ~0x3ff) + 0x400;
                        }
                        /* Don't allow allocations in the VGA IO range.
@@ -235,19 +350,17 @@ void compute_allocate_resource(
                        /* base must be aligned to size */
                        base = round(base, 1UL << align);
                        resource->base = base;
-                       resource->flags |= IORESOURCE_SET;
+                       resource->flags |= IORESOURCE_ASSIGNED;
+                       resource->flags &= ~IORESOURCE_STORED;
                        base += size;
                        
-                       printk_spew(
-                               "DEV: %02x:%02x.%01x %02x *  [0x%08lx - 0x%08lx] %s\n",
-                               dev->bus->secondary, 
-                               PCI_SLOT(dev->devfn), PCI_FUNC(dev->devfn), 
-                               resource->index, 
-                               resource->base, resource->base + resource->size -1,
-                               (resource->flags & IORESOURCE_IO)? "io":
-                               (resource->flags & IORESOURCE_PREFETCH)? "prefmem": "mem");
+                       printk_spew("%s %02x *  [0x%08lx - 0x%08lx] %s\n",
+                                   dev_path(dev),
+                                   resource->index, 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.
@@ -257,26 +370,28 @@ void compute_allocate_resource(
         */
        bridge->size = round(base, 1UL << bridge->gran) - bridge->base;
 
-       printk_spew("DEV: %02x:%02x.%01x compute_allocate_%s: base: %08lx size: %08lx align: %d gran: %d done\n", 
-               bus->bus->secondary,
-               PCI_SLOT(bus->devfn), PCI_FUNC(bus->devfn),
-               (bridge->flags & IORESOURCE_IO)? "io":
-               (bridge->flags & IORESOURCE_PREFETCH)? "prefmem" : "mem",
-               base, bridge->size, bridge->align, bridge->gran);
+       printk_spew("%s compute_allocate_%s: base: %08lx size: %08lx align: %d gran: %d done\n", 
+                   dev_path(dev),
+                   (bridge->flags & IORESOURCE_IO)? "io":
+                   (bridge->flags & IORESOURCE_PREFETCH)? "prefmem" : "mem",
+                   base, bridge->size, bridge->align, bridge->gran);
 
 
 }
 
 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, *bus;
-       bus = vga = 0;
+       struct device *dev, *vga;
+       struct bus *bus;
+       bus = 0;
+       vga = 0;
        for(dev = all_devices; dev; dev = dev->next) {
-               uint32_t class_revision;
-               pci_read_config_dword(dev, PCI_CLASS_REVISION, &class_revision);
-               if (((class_revision >> 24) == 0x03) && 
-                   ((class_revision >> 16) != 0x380)) {
+               if (((dev->class >> 16) == 0x03) &&
+                       ((dev->class >> 8) != 0x380)) {
                        if (!vga) {
                                printk_debug("Allocating VGA resource\n");
                                vga = dev;
@@ -295,129 +410,166 @@ static void allocate_vga_resource(void)
        }
        /* Now walk up the bridges setting the VGA enable */
        while(bus) {
-               uint16_t ctrl;
-               pci_read_config_word(bus, PCI_BRIDGE_CONTROL, &ctrl);
-               ctrl |= PCI_BRIDGE_CTL_VGA;
-               pci_write_config_word(bus, PCI_BRIDGE_CONTROL, ctrl);
-               bus = (bus == bus->bus)? 0 : bus->bus;
+               bus->bridge_ctrl |= PCI_BRIDGE_CTL_VGA;
+               bus = (bus == bus->dev->bus)? 0 : bus->dev->bus;
        } 
 }
 
 
 /** 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 device *bus)
+void assign_resources(struct bus *bus)
 {
        struct device *curdev;
 
        printk_debug("ASSIGN RESOURCES, bus %d\n", bus->secondary);
 
        for (curdev = bus->children; curdev; curdev = curdev->sibling) {
+               if (!curdev->ops || !curdev->ops->set_resources) {
+                       printk_err("%s missing set_resources\n",
+                                  dev_path(curdev));
+                       continue;
+               }
+               if (!curdev->enabled) {
+                       continue;
+               }
                curdev->ops->set_resources(curdev);
        }
        printk_debug("ASSIGNED RESOURCES, bus %d\n", bus->secondary);
 }
 
-static void enable_resources(struct device *bus)
+/**
+ * @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 the method to call it's children's enable_resoruces() via
+ * enable_childrens_resources().
+ */
+void enable_resources(struct device *dev)
 {
-       struct device *curdev;
-
-       /* Walk through the chain of all pci devices and enable them.
-        * This is effectively a breadth first traversal so we should
-        * not have enalbing ordering problems.
-        */
-       for (curdev = all_devices; curdev; curdev = curdev->next) {
-               uint16_t command;
-               pci_read_config_word(curdev, PCI_COMMAND, &command);
-               command |= curdev->command;
-               printk_debug("DEV: %02x:%02x.%01x cmd <- %02x\n",
-                       curdev->bus->secondary,
-                       PCI_SLOT(curdev->devfn), PCI_FUNC(curdev->devfn),
-                       command);
-               pci_write_config_word(curdev, PCI_COMMAND, command);
+       if (!dev->ops || !dev->ops->enable_resources) {
+               printk_err("%s missing enable_resources\n", dev_path(dev));
+               return;
+       }
+       if (!dev->enabled) {
+               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 form 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 have to create the device structure and attach
+ * it to the device tree. 
  */
 void dev_enumerate(void)
 {
        struct device *root;
-       printk_info("Enumerating buses...");
+       unsigned subordinate;
+
+       printk_info("Enumerating buses...\n");
+
        root = &dev_root;
-       if (!root->ops) {
-               root->ops = &default_pci_ops_root;
-       }
-       root->subordinate = root->ops->scan_bus(root, 0);
+       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,
+ * 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");
 
-
        root->ops->read_resources(root);
 
-       /* Make certain the io devices are allocated somewhere
-        * safe.
-        */
+       /* Make certain the io devices are allocated somewhere safe. */
        root->resource[0].base = DEVICE_IO_START;
-       root->resource[0].flags |= IORESOURCE_SET;
-       /* Now reallocate the pci resources memory with the
-        * highest addresses I can manage.
-        */
+       root->resource[0].flags |= IORESOURCE_ASSIGNED;
+       root->resource[0].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);
-       device_memory_base = root->resource[1].base;
-       root->resource[1].flags |= IORESOURCE_SET;
-       // now just set things into registers ... we hope ...
-       root->ops->set_resources(root);
+                          1UL << root->resource[1].align);
+       root->resource[1].flags |= IORESOURCE_ASSIGNED;
+       root->resource[1].flags &= ~IORESOURCE_STORED;
+
+       /* Allocate the VGA I/O resource.. */
+       allocate_vga_resource(); 
 
-       allocate_vga_resource();
+       /* now just set things into registers ... we hope ... */
+       root->ops->set_resources(root);
 
        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)
 {
-       printk_info("Enabling resourcess...");
+       printk_info("Enabling resourcess...\n");
 
        /* 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->ops->init) {
-                       printk_debug("PCI: %02x:%02x.%01x init\n",
-                               dev->bus->secondary,
-                               PCI_SLOT(dev->devfn), PCI_FUNC(dev->devfn));
+               if (dev->enabled && dev->ops && dev->ops->init) {
+                       printk_debug("%s init\n", dev_path(dev));
                        dev->ops->init(dev);
                }
        }
+
        printk_info("Devices initialized\n");
 }
-
-