Various Doxygen comment fixes, typo fixes, etc.
[coreboot.git] / src / devices / hypertransport.c
index 5fb35ce88f707b9fb02d776738fb26d26c90c83c..89a41d64fc58c85e2f13b78c5846f0e092df6d47 100644 (file)
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-/*
-       2005.11 yhlu add let the real sb to use small uintid
-*/
-
 #include <bitops.h>
 #include <console/console.h>
 #include <device/device.h>
 #include <device/pci.h>
 #include <device/pci_ids.h>
 #include <device/hypertransport.h>
-#include <part/hard_reset.h>
-#include <part/fallback_boot.h>
 
-/* The hypertransport link is already optimized in pre-ram code
- * so don't do it again
+/*
+ * The hypertransport link is already optimized in pre-RAM code so don't do
+ * it again.
  */
 #define OPT_HT_LINK 0
-        
+
 #if OPT_HT_LINK == 1
 #include <cpu/amd/model_fxx_rev.h>
 #endif
@@ -54,9 +49,9 @@ static device_t ht_scan_get_devs(device_t *old_devices)
        /* Extract the chain of devices to (first through last)
         * for the next hypertransport device.
         */
-       while(last && last->sibling && 
+       while(last && last->sibling &&
                (last->sibling->path.type == DEVICE_PATH_PCI) &&
-               (last->sibling->path.pci.devfn > last->path.pci.devfn)) 
+               (last->sibling->path.pci.devfn > last->path.pci.devfn))
        {
                last = last->sibling;
        }
@@ -103,11 +98,11 @@ static unsigned ht_read_freq_cap(device_t dev, unsigned pos)
        }
        /* AMD K8 Unsupported 1Ghz? */
        if ((dev->vendor == PCI_VENDOR_ID_AMD) && (dev->device == 0x1100)) {
-#if CONFIG_K8_HT_FREQ_1G_SUPPORT == 1 
-       #if CONFIG_K8_REV_F_SUPPORT == 0 
+#if CONFIG_K8_HT_FREQ_1G_SUPPORT == 1
+       #if CONFIG_K8_REV_F_SUPPORT == 0
                if (is_cpu_pre_e0()) { // only e0 later suupport 1GHz HT
                        freq_cap &= ~(1 << HT_FREQ_1000Mhz);
-               } 
+               }
        #endif
 #else
                freq_cap &= ~(1 << HT_FREQ_1000Mhz);
@@ -131,7 +126,7 @@ static int ht_setup_link(struct ht_link *prev, device_t dev, unsigned pos)
        static const uint8_t pow2_to_link_width[] = { 0x7, 4, 5, 0, 1, 3 };
        unsigned present_width_cap,    upstream_width_cap;
        unsigned present_freq_cap,     upstream_freq_cap;
-       unsigned ln_present_width_in,  ln_upstream_width_in; 
+       unsigned ln_present_width_in,  ln_upstream_width_in;
        unsigned ln_present_width_out, ln_upstream_width_out;
        unsigned freq, old_freq;
        unsigned present_width, upstream_width, old_width;
@@ -142,7 +137,7 @@ static int ht_setup_link(struct ht_link *prev, device_t dev, unsigned pos)
 
        /* Set the hypertransport link width and frequency */
        reset_needed = 0;
-       /* See which side of the device our previous write to 
+       /* See which side of the device our previous write to
         * set the unitid came from.
         */
        cur->dev = dev;
@@ -166,7 +161,7 @@ static int ht_setup_link(struct ht_link *prev, device_t dev, unsigned pos)
        upstream_freq_cap  = ht_read_freq_cap(prev->dev, prev->pos + prev->freq_cap_off);
        present_width_cap  = pci_read_config8(cur->dev, cur->pos + cur->config_off);
        upstream_width_cap = pci_read_config8(prev->dev, prev->pos + prev->config_off);
-       
+
        /* Calculate the highest useable frequency */
        freq = log2(present_freq_cap & upstream_freq_cap);
 
@@ -194,11 +189,11 @@ static int ht_setup_link(struct ht_link *prev, device_t dev, unsigned pos)
                unsigned new_freq;
                pci_write_config8(cur->dev, cur->pos + cur->freq_off, freq);
                reset_needed = 1;
-               printk_spew("HyperT FreqP old %x new %x\n",old_freq,freq);
+               printk(BIOS_SPEW, "HyperT FreqP old %x new %x\n",old_freq,freq);
                new_freq = pci_read_config8(cur->dev, cur->pos + cur->freq_off);
                new_freq &= 0x0f;
                if (new_freq != freq) {
-                       printk_err("%s Hypertransport frequency would not set wanted: %x got: %x\n",
+                       printk(BIOS_ERR, "%s Hypertransport frequency would not set wanted: %x got: %x\n",
                                dev_path(dev), freq, new_freq);
                }
        }
@@ -208,10 +203,10 @@ static int ht_setup_link(struct ht_link *prev, device_t dev, unsigned pos)
                pci_write_config8(cur->dev, cur->pos + cur->config_off + 1,
                        present_width);
                reset_needed = 1;
-               printk_spew("HyperT widthP old %x new %x\n",old_width, present_width);
+               printk(BIOS_SPEW, "HyperT widthP old %x new %x\n",old_width, present_width);
                new_width = pci_read_config8(cur->dev, cur->pos + cur->config_off + 1);
                if (new_width != present_width) {
-                       printk_err("%s Hypertransport width would not set wanted: %x got: %x\n",
+                       printk(BIOS_ERR, "%s Hypertransport width would not set wanted: %x got: %x\n",
                                dev_path(dev), present_width, new_width);
                }
        }
@@ -223,11 +218,11 @@ static int ht_setup_link(struct ht_link *prev, device_t dev, unsigned pos)
                unsigned new_freq;
                pci_write_config8(prev->dev, prev->pos + prev->freq_off, freq);
                reset_needed = 1;
-               printk_spew("HyperT freqU old %x new %x\n", old_freq, freq);
+               printk(BIOS_SPEW, "HyperT freqU old %x new %x\n", old_freq, freq);
                new_freq = pci_read_config8(prev->dev, prev->pos + prev->freq_off);
                new_freq &= 0x0f;
                if (new_freq != freq) {
-                       printk_err("%s Hypertransport frequency would not set wanted: %x got: %x\n",
+                       printk(BIOS_ERR, "%s Hypertransport frequency would not set wanted: %x got: %x\n",
                                dev_path(prev->dev), freq, new_freq);
                }
        }
@@ -236,15 +231,15 @@ static int ht_setup_link(struct ht_link *prev, device_t dev, unsigned pos)
                unsigned new_width;
                pci_write_config8(prev->dev, prev->pos + prev->config_off + 1, upstream_width);
                reset_needed = 1;
-               printk_spew("HyperT widthU old %x new %x\n", old_width, upstream_width);
+               printk(BIOS_SPEW, "HyperT widthU old %x new %x\n", old_width, upstream_width);
                new_width = pci_read_config8(prev->dev, prev->pos + prev->config_off + 1);
                if (new_width != upstream_width) {
-                       printk_err("%s Hypertransport width would not set wanted: %x got: %x\n",
+                       printk(BIOS_ERR, "%s Hypertransport width would not set wanted: %x got: %x\n",
                                dev_path(prev->dev), upstream_width, new_width);
                }
        }
 #endif
-       
+
        /* Remember the current link as the previous link,
         * But look at the other offsets.
         */
@@ -263,7 +258,6 @@ static int ht_setup_link(struct ht_link *prev, device_t dev, unsigned pos)
        }
 
        return reset_needed;
-               
 }
 
 static unsigned ht_lookup_slave_capability(struct device *dev)
@@ -275,7 +269,7 @@ static unsigned ht_lookup_slave_capability(struct device *dev)
                if (pos) {
                        unsigned flags;
                        flags = pci_read_config16(dev, pos + PCI_CAP_FLAGS);
-                       printk_spew("flags: 0x%04x\n", flags);
+                       printk(BIOS_SPEW, "flags: 0x%04x\n", flags);
                        if ((flags >> 13) == 0) {
                                /* Entry is a Slave secondary, success... */
                                break;
@@ -319,7 +313,7 @@ static void ht_collapse_early_enumeration(struct bus *bus, unsigned offset_uniti
                        pci_write_config16(prev.dev, prev.pos + prev.ctrl_off, ctrl);
                        ctrl = pci_read_config16(prev.dev, prev.pos + prev.ctrl_off);
                        if (ctrl & ((1 << 4) | (1 << 8))) {
-                               printk_alert("Detected error on Hypertransport Link\n");
+                               printk(BIOS_ALERT, "Detected error on Hypertransport Link\n");
                                return;
                        }
                }
@@ -357,7 +351,7 @@ static void ht_collapse_early_enumeration(struct bus *bus, unsigned offset_uniti
                dummy.path.type        = DEVICE_PATH_PCI;
                dummy.path.pci.devfn = devfn;
                id = pci_read_config32(&dummy, PCI_VENDOR_ID);
-               if (    (id == 0xffffffff) || (id == 0x00000000) || 
+               if (    (id == 0xffffffff) || (id == 0x00000000) ||
                        (id == 0x0000ffff) || (id == 0xffff0000)) {
                        continue;
                }
@@ -373,12 +367,12 @@ static void ht_collapse_early_enumeration(struct bus *bus, unsigned offset_uniti
                flags = pci_read_config16(&dummy, pos + PCI_CAP_FLAGS);
                flags &= ~0x1f;
                pci_write_config16(&dummy, pos + PCI_CAP_FLAGS, flags);
-               printk_spew("Collapsing %s [%04x/%04x]\n", 
+               printk(BIOS_SPEW, "Collapsing %s [%04x/%04x]\n",
                        dev_path(&dummy), dummy.vendor, dummy.device);
        }
 }
 
-unsigned int hypertransport_scan_chain(struct bus *bus, 
+unsigned int hypertransport_scan_chain(struct bus *bus,
        unsigned min_devfn, unsigned max_devfn, unsigned int max, unsigned *ht_unitid_base, unsigned offset_unitid)
 {
        //even CONFIG_HT_CHAIN_UNITID_BASE == 0, we still can go through this function, because of end_of_chain check, also We need it to optimize link
@@ -392,9 +386,9 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
 
 #if CONFIG_HT_CHAIN_END_UNITID_BASE != 0x20
         //let't record the device of last ht device, So we can set the Unitid to CONFIG_HT_CHAIN_END_UNITID_BASE
-        unsigned real_last_unitid
-        uint8_t real_last_pos;
-       device_t real_last_dev;
+        unsigned real_last_unitid=0;
+        uint8_t real_last_pos=0;
+       device_t real_last_dev=NULL;
        unsigned end_used = 0;
 #endif
 
@@ -412,7 +406,7 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
        prev.config_off   = PCI_HT_CAP_HOST_WIDTH;
        prev.freq_off     = PCI_HT_CAP_HOST_FREQ;
        prev.freq_cap_off = PCI_HT_CAP_HOST_FREQ_CAP;
-       
+
        /* If present assign unitid to a hypertransport chain */
        last_unitid = min_unitid -1;
        max_unitid = next_unitid = min_unitid;
@@ -443,12 +437,12 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
                                pci_write_config16(prev.dev, prev.pos + prev.ctrl_off, ctrl);
                                ctrl = pci_read_config16(prev.dev, prev.pos + prev.ctrl_off);
                                if (ctrl & ((1 << 4) | (1 << 8))) {
-                                       printk_alert("Detected error on Hypertransport Link\n");
+                                       printk(BIOS_ALERT, "Detected error on Hypertransport Link\n");
                                        goto end_of_chain;
                                }
                        }
                } while((ctrl & (1 << 5)) == 0);
-               
+
 
                /* Get and setup the device_structure */
                dev = ht_scan_get_devs(&old_devices);
@@ -464,15 +458,15 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
                /* Find the hypertransport link capability */
                pos = ht_lookup_slave_capability(dev);
                if (pos == 0) {
-                       printk_err("%s Hypertransport link capability not found", 
+                       printk(BIOS_ERR, "%s Hypertransport link capability not found",
                                dev_path(dev));
                        break;
                }
-               
+
                /* Update the Unitid of the current device */
                flags = pci_read_config16(dev, pos + PCI_CAP_FLAGS);
-        
-               /* If the devices has a unitid set and is at devfn 0 we are done. 
+
+               /* If the devices has a unitid set and is at devfn 0 we are done.
                 * This can happen with shadow hypertransport devices,
                 * or if we have reached the bottom of a
                 * hypertransport device chain.
@@ -494,7 +488,7 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
                                }
                        }
 
-               } 
+               }
 #endif
 
                 flags |= next_unitid & 0x1f;
@@ -504,12 +498,12 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
                static_count = 1;
                for(func = dev; func; func = func->sibling) {
                        func->path.pci.devfn += (next_unitid << 3);
-                       static_count = (func->path.pci.devfn >> 3) 
+                       static_count = (func->path.pci.devfn >> 3)
                                - (dev->path.pci.devfn >> 3) + 1;
                        last_func = func;
                }
                /* Compute the number of unitids consumed */
-               printk_spew("%s count: %04x static_count: %04x\n", 
+               printk(BIOS_SPEW, "%s count: %04x static_count: %04x\n",
                        dev_path(dev), count, static_count);
                if (count < static_count) {
                        count = static_count;
@@ -534,27 +528,25 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
                /* Setup the hypetransport link */
                bus->reset_needed |= ht_setup_link(&prev, dev, pos);
 
-               printk_debug("%s [%04x/%04x] %s next_unitid: %04x\n",
+               printk(BIOS_DEBUG, "%s [%04x/%04x] %s next_unitid: %04x\n",
                        dev_path(dev),
-                       dev->vendor, dev->device, 
+                       dev->vendor, dev->device,
                        (dev->enabled? "enabled": "disabled"), next_unitid);
 
        } while (last_unitid != next_unitid);
  end_of_chain:
 #if OPT_HT_LINK == 1
        if(bus->reset_needed) {
-               printk_info("HyperT reset needed\n");
+               printk(BIOS_INFO, "HyperT reset needed\n");
        }
        else {
-               printk_debug("HyperT reset not needed\n");
+               printk(BIOS_DEBUG, "HyperT reset not needed\n");
        }
 #endif
 
 #if CONFIG_HT_CHAIN_END_UNITID_BASE != 0x20
         if(offset_unitid && (ht_dev_num>1) && (real_last_unitid != CONFIG_HT_CHAIN_END_UNITID_BASE)  && !end_used) {
                 uint16_t flags;
-                int i;
-               device_t last_func = 0;
                 flags = pci_read_config16(real_last_dev, real_last_pos + PCI_CAP_FLAGS);
                 flags &= ~0x1f;
                 flags |= CONFIG_HT_CHAIN_END_UNITID_BASE & 0x1f;
@@ -566,8 +558,8 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
                 }
 
                ht_unitid_base[ht_dev_num-1] = CONFIG_HT_CHAIN_END_UNITID_BASE; // update last one
-               
-               printk_debug(" unitid: %04x --> %04x\n",
+
+               printk(BIOS_DEBUG, " unitid: %04x --> %04x\n",
                                real_last_unitid, CONFIG_HT_CHAIN_END_UNITID_BASE);
 
         }
@@ -577,44 +569,45 @@ unsigned int hypertransport_scan_chain(struct bus *bus,
        if (next_unitid > 0x20) {
                next_unitid = 0x20;
        }
-       if( (bus->secondary == 0) && (next_unitid > 0x18)) { 
+       if( (bus->secondary == 0) && (next_unitid > 0x18)) {
                next_unitid = 0x18; /* avoid K8 on bus 0 */
        }
 
-       /* Die if any leftover Static devices are are found.  
+       /* Die if any leftover Static devices are are found.
         * There's probably a problem in the Config.lb.
         */
        if(old_devices) {
                device_t left;
                for(left = old_devices; left; left = left->sibling) {
-                       printk_debug("%s\n", dev_path(left));
+                       printk(BIOS_DEBUG, "%s\n", dev_path(left));
                }
-               printk_err("HT: Left over static devices.  Check your Config.lb\n");
+               printk(BIOS_ERR, "HT: Left over static devices.  Check your Config.lb\n");
                if(last_func  && !last_func->sibling) // put back the left over static device, and let pci_scan_bus disable it
-                       last_func->sibling = old_devices; 
+                       last_func->sibling = old_devices;
        }
 
        /* Now that nothing is overlapping it is safe to scan the
-        * children. 
+        * children.
         */
-       max = pci_scan_bus(bus, 0x00, ((next_unitid-1) << 3)|7, max); 
-       return max; 
+       max = pci_scan_bus(bus, 0x00, ((next_unitid-1) << 3)|7, max);
+       return max;
 }
 
 /**
- * @brief Scan a PCI bridge and the buses behind the bridge.
+ * Scan a PCI bridge and the buses behind the bridge.
  *
  * Determine the existence of buses behind the bridge. Set up the bridge
  * according to the result of the scan.
  *
  * This function is the default scan_bus() method for PCI bridge devices.
  *
- * @param dev pointer to the bridge device
- * @param max the highest bus number assgined up to now
- *
- * @return The maximum bus number found, after scanning all subordinate busses
+ * @param bus TODO
+ * @param min_devfn TODO
+ * @param max_devfn TODO
+ * @param max The highest bus number assgined up to now.
+ * @return The maximum bus number found, after scanning all subordinate busses.
  */
-unsigned int hypertransport_scan_chain_x(struct bus *bus,
+static unsigned int hypertransport_scan_chain_x(struct bus *bus,
         unsigned min_devfn, unsigned max_devfn, unsigned int max)
 {
        unsigned ht_unitid_base[4];
@@ -627,7 +620,6 @@ unsigned int ht_scan_bridge(struct device *dev, unsigned int max)
        return do_pci_scan_bridge(dev, max, hypertransport_scan_chain_x);
 }
 
-
 /** Default device operations for hypertransport bridges */
 static struct pci_operations ht_bus_ops_pci = {
        .set_subsystem = 0,