[PATCH v3] PCI: Add PCI_DEVICE_DATA() macro to fully describe device ID entry

[PATCH v3] PCI: Add PCI_DEVICE_DATA() macro to fully describe device ID entry

[Andy Shevchenko]

There are a lot of examples in the kernel where PCI_VDEVICE() is used and still
looks not so convenient due to additional driver_data field attached.

Introduce PCI_DEVICE_DATA() macro to fully describe device ID entry in shortest
possible form. For example,

  before:

    { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_MRFLD),
      (kernel_ulong_t) &dwc3_pci_mrfld_properties, },

  after:

    { PCI_DEVICE_DATA(INTEL, INTEL_MRFLD, &dwc3_pci_mrfld_properties) },

Drivers can be converted later on in independent way.

While here, remove the unused macro with the same name
from Ralink wireless driver.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---

- fix commit message (Randy)

 drivers/net/wireless/ralink/rt2x00/rt2x00pci.h |  6 ------
 include/linux/pci.h                            | 15 +++++++++++++++
 2 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/drivers/net/wireless/ralink/rt2x00/rt2x00pci.h b/drivers/net/wireless/ralink/rt2x00/rt2x00pci.h
index bc0ca5f58f38..283e2e607bba 100644
--- a/drivers/net/wireless/ralink/rt2x00/rt2x00pci.h
+++ b/drivers/net/wireless/ralink/rt2x00/rt2x00pci.h
@@ -27,12 +27,6 @@
 #include <linux/io.h>
 #include <linux/pci.h>
 
-/*
- * This variable should be used with the
- * pci_driver structure initialization.
- */
-#define PCI_DEVICE_DATA(__ops)	.driver_data = (kernel_ulong_t)(__ops)
-
 /*
  * PCI driver handlers.
  */
diff --git a/include/linux/pci.h b/include/linux/pci.h
index d0961aefdbae..754da6f9adb3 100644
--- a/include/linux/pci.h
+++ b/include/linux/pci.h
@@ -825,6 +825,21 @@ struct pci_driver {
 	.vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
 	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
 
+/**
+ * PCI_DEVICE_DATA - macro used to describe a specific PCI device in very short form
+ * @vend: the vendor name (without PCI_VENDOR_ID_ prefix)
+ * @dev: the device name (without PCI_DEVICE_ID_ prefix)
+ * @data: the driver data to be filled
+ *
+ * This macro is used to create a struct pci_device_id that matches a
+ * specific PCI device.  The subvendor, and subdevice fields will be set
+ * to PCI_ANY_ID.
+ */
+#define PCI_DEVICE_DATA(vend, dev, data) \
+	.vendor = PCI_VENDOR_ID_##vend, .device = PCI_DEVICE_ID_##dev, \
+	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0, \
+	.driver_data = (kernel_ulong_t)(data)
+
 enum {
 	PCI_REASSIGN_ALL_RSRC	= 0x00000001,	/* Ignore firmware setup */
 	PCI_REASSIGN_ALL_BUS	= 0x00000002,	/* Reassign all bus numbers */
-- 
2.18.0

Re: [PATCH v3] PCI: Add PCI_DEVICE_DATA() macro to fully describe device ID entry

[Bjorn Helgaas]

On Fri, Jul 27, 2018 at 11:49:44PM +0300, Andy Shevchenko wrote:
> There are a lot of examples in the kernel where PCI_VDEVICE() is used and still
> looks not so convenient due to additional driver_data field attached.
> 
> Introduce PCI_DEVICE_DATA() macro to fully describe device ID entry in shortest
> possible form. For example,
> 
>   before:
> 
>     { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_MRFLD),
>       (kernel_ulong_t) &dwc3_pci_mrfld_properties, },
> 
>   after:
> 
>     { PCI_DEVICE_DATA(INTEL, INTEL_MRFLD, &dwc3_pci_mrfld_properties) },

Most device IDs include the vendor ID; did you consider pasting the
vendor ID string into the device ID, so you would end up with this?

    { PCI_DEVICE_DATA(INTEL, MRFLD, &dwc3_pci_mrfld_properties) },

I don't absolutely love either PCI_VDEVICE or PCI_DEVICE_DATA because
grep doesn't work as well to find uses of the symbol, but the existing
2300 uses of PCI_VDEVICE are telling me pretty loudly to just get over
it :)

Bjorn

Re: [PATCH v3] PCI: Add PCI_DEVICE_DATA() macro to fully describe device ID entry

[Andy Shevchenko]

On Fri, 2018-07-27 at 16:10 -0500, Bjorn Helgaas wrote:
> On Fri, Jul 27, 2018 at 11:49:44PM +0300, Andy Shevchenko wrote:
> > There are a lot of examples in the kernel where PCI_VDEVICE() is
> > used and still
> > looks not so convenient due to additional driver_data field
> > attached.
> > 
> > Introduce PCI_DEVICE_DATA() macro to fully describe device ID entry
> > in shortest
> > possible form. For example,
> > 
> >   before:
> > 
> >     { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_MRFLD),
> >       (kernel_ulong_t) &dwc3_pci_mrfld_properties, },
> > 
> >   after:
> > 
> >     { PCI_DEVICE_DATA(INTEL, INTEL_MRFLD,
> > &dwc3_pci_mrfld_properties) },
> 
> Most device IDs include the vendor ID; did you consider pasting the
> vendor ID string into the device ID, so you would end up with this?
> 
>     { PCI_DEVICE_DATA(INTEL, MRFLD, &dwc3_pci_mrfld_properties) },

While it makes it slightly shorter, it breaks consistency among such
macros. I don't see any of them is using something like
PCI_DEVICE_ID_##vend##dev.

Though I see few users outside of PCI subsystem that reinvent above
line.

Do you think variant with ##vend##dev is better? I will update it for v4
if needed.

> I don't absolutely love either PCI_VDEVICE or PCI_DEVICE_DATA because
> grep doesn't work as well to find uses of the symbol, but the existing
> 2300 uses of PCI_VDEVICE are telling me pretty loudly to just get over
> it :)


-- 
Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Intel Finland Oy

Re: [PATCH v3] PCI: Add PCI_DEVICE_DATA() macro to fully describe device ID entry

[Andy Shevchenko]

On Sun, 2018-07-29 at 15:49 +0300, Andy Shevchenko wrote:
> On Fri, 2018-07-27 at 16:10 -0500, Bjorn Helgaas wrote:

> Do you think variant with ##vend##dev is better? I will update it for
> v4
> if needed.

Okay, I have sent v4 with your comment addressed.

-- 
Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Intel Finland Oy