r801 - coreboot-v3/device

Author: hailfinger
Date: 2008-08-22 13:10:04 +0200 (Fri, 22 Aug 2008)
New Revision: 801

Modified:
   coreboot-v3/device/pci_device.c
Log:
Improve/fix PCI device doxygen comments.

Thanks to Ron for explaining this.

Signed-off-by: Carl-Daniel Hailfinger 
Acked-by: Ronald G. Minnich

Modified: coreboot-v3/device/pci_device.c
===================================================================
--- coreboot-v3/device/pci_device.c	2008-08-22 10:57:34 UTC (rev 800)
+++ coreboot-v3/device/pci_device.c	2008-08-22 11:10:04 UTC (rev 801)
@@ -950,12 +950,19 @@
 /** 
  * Scan a PCI bus.
  *
- * Determine the existence of a given PCI device.
+ * Determine the existence of a given PCI device. Allocate a new struct device
+ * if dev==NULL was passed in and the device exists in hardware.
  *
+ * @param dev Pointer to the device structure if it already is in the device
+ *         tree, i.e. was specified in the dts. It may not exist on hardware,
+ *         however. Looking for hardware not yet in the device tree has this
+ *         parameter as NULL.
  * @param bus Pointer to the bus structure.
  * @param devfn A device/function number.
- * @return The device structure for the device (if found)
- *         or the NULL if no device is found.
+ * @return The device structure for the device if it exists in hardware
+ *         or the passed in device structure with enabled=0 if the device
+ *         does not exist in hardware and only in the tree
+ *         or NULL if no device is found and dev==NULL was passed in.
  */
 struct device *pci_probe_dev(struct device *dev, struct bus *bus,
    		     unsigned int devfn)