PCI: Document reason for using pci_is_root_bus()
authorBjorn Helgaas <bhelgaas@google.com>
Tue, 24 Sep 2013 21:14:57 +0000 (15:14 -0600)
committerBjorn Helgaas <bhelgaas@google.com>
Wed, 25 Sep 2013 21:43:58 +0000 (15:43 -0600)
Some code assumes "bus->self == NULL" means the bus is a root bus.  This
adds a comment explaining why this is incorrect ("virtual" buses added for
SR-IOV have "bus->self == NULL" but are not root buses).

No functional change.

Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
include/linux/pci.h

index 197e2d21f2cb732ebbb7870dbbe45898a7285c50..d3a888ae4b2e3ad030bdb5f89354eea2f2567d0b 100644 (file)
@@ -470,6 +470,10 @@ struct pci_bus {
 /*
  * Returns true if the pci bus is root (behind host-pci bridge),
  * false otherwise
+ *
+ * Some code assumes that "bus->self == NULL" means that bus is a root bus.
+ * This is incorrect because "virtual" buses added for SR-IOV (via
+ * virtfn_add_bus()) have "bus->self == NULL" but are not root buses.
  */
 static inline bool pci_is_root_bus(struct pci_bus *pbus)
 {