diff options
| author | Uwe Hermann <uwe@hermann-uwe.de> | 2010-10-17 19:01:48 +0000 |
|---|---|---|
| committer | Uwe Hermann <uwe@hermann-uwe.de> | 2010-10-17 19:01:48 +0000 |
| commit | c1ee42913534ea2ef1747cfc6bfd1ec687a0f9a3 (patch) | |
| tree | b93d2b8a11698cc83df0246be11b4e49b479fbeb /src/devices/hypertransport.c | |
| parent | b14fb6abd6cc04ea9f06e4dedd5f13c183e9450e (diff) | |
Various Doxygen comment fixes, typo fixes, etc.
- Fix incorrect argument names for @param entries.
- Add missing @param and @return entries, partly as TODOs.
- s/@returns/@return/, that's a typo.
- Small whitespace fixes while I'm at it.
- Drop useless @brief commands, they just clutter the comments and make them
harder to read. Doxygen has an option to always use the first sentence
of a Doxygen-comment as @brief automatically (should be on per default).
Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de>
Acked-by: Uwe Hermann <uwe@hermann-uwe.de>
git-svn-id: svn://svn.coreboot.org/coreboot/trunk@5955 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
Diffstat (limited to 'src/devices/hypertransport.c')
| -rw-r--r-- | src/devices/hypertransport.c | 22 |
1 files changed, 9 insertions, 13 deletions
diff --git a/src/devices/hypertransport.c b/src/devices/hypertransport.c index 674971cb94..89a41d64fc 100644 --- a/src/devices/hypertransport.c +++ b/src/devices/hypertransport.c @@ -23,10 +23,6 @@ * 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> @@ -35,8 +31,9 @@ #include <device/pci_ids.h> #include <device/hypertransport.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 @@ -261,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) @@ -598,17 +594,18 @@ unsigned int hypertransport_scan_chain(struct bus *bus, } /** - * @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. */ static unsigned int hypertransport_scan_chain_x(struct bus *bus, unsigned min_devfn, unsigned max_devfn, unsigned int max) @@ -623,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, |