Re: [coreboot] [PATCH] v3: improve PCI device doxygen comments and printks

[ron minnich]

On Wed, Aug 13, 2008 at 7:10 PM, Carl-Daniel Hailfinger
 wrote:
> Improve/fix PCI device doxygen comments and printks. As a bonus, the
> boot messages are more understandable now.
>
> Signed-off-by: Carl-Daniel Hailfinger
> Index: corebootv3-pci_device_better_prints_comments/device/pci_device.c
>
> --- corebootv3-pci_device_better_prints_comments/device/pci_device.c    (Revision 759)
> +++ corebootv3-pci_device_better_prints_comments/device/pci_device.c    (Arbeitskopie)
> @@ -929,12 +929,15 @@
>  /**
> 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.
> @param dev Pointer to the device structure if it already exists or NULL

"if it already exists" is not qutie it.

"If it is already in the device tree, i.e. was specified in the dts.
It may not exist however. "
> @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.
>     or NULL if no device is found and dev==NULL was passed in
>     or the device structure with enabled=0 if no device is found.
>
> */
>  struct device *pci_probe_dev(struct device *dev, struct bus *bus,
>                             unsigned int devfn)
> @@ -990,8 +993,8 @@
>                if ((id == 0xffffffff) || (id == 0x00000000) ||
>                    (id == 0x0000ffff) || (id == 0xffff0000)) {
>                        if (dev->enabled) {
>                           printk(BIOS_INFO,
>                                  "Disabling static device: %s\n",
>                           printk(BIOS_INFO, "PCI: Static device not "
>                                  "found, setting enabled=0: %s\n",
>                                 dev_path(dev));
>                          dev->enabled = 0;
>                  }