[PATCH] pci.txt: clarify vendor ID policy

From: Michael S. Tsirkin
Date: Mon Mar 30 2015 - 04:32:43 EST


Top of include/linux/pci_ids.h says:
Do not add new entries to this file unless the definitions
are shared between multiple drivers.
on the other hand, Documentation/PCI/pci.txt seems to imply that all
vendor IDs should be added in include/linux/pci_ids.h.

Clarify text pci.txt to avoid the apparent contradiction.

Signed-off-by: Michael S. Tsirkin <mst@xxxxxxxxxx>
---
Documentation/PCI/pci.txt | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/Documentation/PCI/pci.txt b/Documentation/PCI/pci.txt
index 53da450..47b0e28 100644
--- a/Documentation/PCI/pci.txt
+++ b/Documentation/PCI/pci.txt
@@ -564,12 +564,15 @@ to be handled by platform and generic code, not individual drivers.
8. Vendor and device identifications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-One is not required to add new device ids to include/linux/pci_ids.h.
-Please add PCI_VENDOR_ID_xxx for vendors and a hex constant for device ids.
+One is not required to add new device or vendor ids to include/linux/pci_ids.h.
+Please define PCI_VENDOR_ID_xxx for vendor ids and use a hex constant for
+device ids in your driver.

-PCI_VENDOR_ID_xxx constants are re-used. The device ids are arbitrary
-hex numbers (vendor controlled) and normally used only in a single
-location, the pci_device_id table.
+Only PCI_VENDOR_ID_xxx constant definitions that are re-used between multiple
+drivers should be added to include/linux/pci_ids.h.
+
+The device ids are arbitrary hex numbers (vendor controlled) and normally used
+only in a single location, the pci_device_id table.

Please DO submit new vendor/device ids to pciids.sourceforge.net project.

--
MST
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/