| Message ID | 1386006217.2680.13.camel@joe-AO722 (mailing list archive) |
|---|---|
| State | New, archived |
| Delegated to: | Bjorn Helgaas |
| Headers | show |
On Mon, Dec 02, 2013 at 09:43:37AM -0800, Joe Perches wrote: > Prefer use of the direct definition of struct pci_device_id Add 'const' ? > instead of indirection via macro DEFINE_PCI_DEVICE_TABLE. > > Update the PCI documentation to deprecate DEFINE_PCI_DEVICE_TABLE. > Update checkpatch adding --fix option. > > Signed-off-by: Joe Perches <joe@perches.com> > --- > Documentation/PCI/pci.txt | 6 ++++-- > include/linux/pci.h | 3 +-- > scripts/checkpatch.pl | 11 +++++++---- > 3 files changed, 12 insertions(+), 8 deletions(-) > > diff --git a/Documentation/PCI/pci.txt b/Documentation/PCI/pci.txt > index 6f45856..9518006 100644 > --- a/Documentation/PCI/pci.txt > +++ b/Documentation/PCI/pci.txt > @@ -123,8 +123,10 @@ initialization with a pointer to a structure describing the driver > > > The ID table is an array of struct pci_device_id entries ending with an > -all-zero entry; use of the macro DEFINE_PCI_DEVICE_TABLE is the preferred > -method of declaring the table. Each entry consists of: > +all-zero entry. Definitions with static const are generally preferred. > +Use of the deprecated macro DEFINE_PCI_DEVICE_TABLE should be avoided. > + > +Each entry consists of: > > vendor,device Vendor and device ID to match (or PCI_ANY_ID) > > diff --git a/include/linux/pci.h b/include/linux/pci.h > index 1084a15..88674b0 100644 > --- a/include/linux/pci.h > +++ b/include/linux/pci.h > @@ -634,8 +634,7 @@ struct pci_driver { > * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table > * @_table: device table name > * > - * This macro is used to create a struct pci_device_id array (a device table) > - * in a generic manner. > + * This macro is deprecated and should not be used in new code. > */ > #define DEFINE_PCI_DEVICE_TABLE(_table) \ > const struct pci_device_id _table[] > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > index 38be5d5..6f883f0 100755 > --- a/scripts/checkpatch.pl > +++ b/scripts/checkpatch.pl > @@ -2643,10 +2643,13 @@ sub process { > } > } > > -# check for declarations of struct pci_device_id > - if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { > - WARN("DEFINE_PCI_DEVICE_TABLE", > - "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); > +# check for uses of DEFINE_PCI_DEVICE_TABLE > + if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { > + if (WARN("DEFINE_PCI_DEVICE_TABLE", > + "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && Add 'const' ? Guenter -- To unsubscribe from this list: send the line "unsubscribe linux-pci" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
On Mon, 2013-12-02 at 10:01 -0800, Guenter Roeck wrote: > On Mon, Dec 02, 2013 at 09:43:37AM -0800, Joe Perches wrote: > > Prefer use of the direct definition of struct pci_device_id [] > > +all-zero entry. Definitions with static const are generally preferred. see here: > Add 'const' ? Also see $fix. Not all can be const as some codes actually modify the tables for various quirks. -- To unsubscribe from this list: send the line "unsubscribe linux-pci" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
On Tuesday, December 03, 2013 2:44 AM, Joe Perches > > Prefer use of the direct definition of struct pci_device_id > instead of indirection via macro DEFINE_PCI_DEVICE_TABLE. > > Update the PCI documentation to deprecate DEFINE_PCI_DEVICE_TABLE. > Update checkpatch adding --fix option. > > Signed-off-by: Joe Perches <joe@perches.com> Reviewed-by: Jingoo Han <jg1.han@samsung.com> Best regards, Jingoo Han > --- > Documentation/PCI/pci.txt | 6 ++++-- > include/linux/pci.h | 3 +-- > scripts/checkpatch.pl | 11 +++++++---- > 3 files changed, 12 insertions(+), 8 deletions(-) > > diff --git a/Documentation/PCI/pci.txt b/Documentation/PCI/pci.txt > index 6f45856..9518006 100644 > --- a/Documentation/PCI/pci.txt > +++ b/Documentation/PCI/pci.txt > @@ -123,8 +123,10 @@ initialization with a pointer to a structure describing the driver > > > The ID table is an array of struct pci_device_id entries ending with an > -all-zero entry; use of the macro DEFINE_PCI_DEVICE_TABLE is the preferred > -method of declaring the table. Each entry consists of: > +all-zero entry. Definitions with static const are generally preferred. > +Use of the deprecated macro DEFINE_PCI_DEVICE_TABLE should be avoided. > + > +Each entry consists of: > > vendor,device Vendor and device ID to match (or PCI_ANY_ID) > > diff --git a/include/linux/pci.h b/include/linux/pci.h > index 1084a15..88674b0 100644 > --- a/include/linux/pci.h > +++ b/include/linux/pci.h > @@ -634,8 +634,7 @@ struct pci_driver { > * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table > * @_table: device table name > * > - * This macro is used to create a struct pci_device_id array (a device table) > - * in a generic manner. > + * This macro is deprecated and should not be used in new code. > */ > #define DEFINE_PCI_DEVICE_TABLE(_table) \ > const struct pci_device_id _table[] > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > index 38be5d5..6f883f0 100755 > --- a/scripts/checkpatch.pl > +++ b/scripts/checkpatch.pl > @@ -2643,10 +2643,13 @@ sub process { > } > } > > -# check for declarations of struct pci_device_id > - if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { > - WARN("DEFINE_PCI_DEVICE_TABLE", > - "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); > +# check for uses of DEFINE_PCI_DEVICE_TABLE > + if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { > + if (WARN("DEFINE_PCI_DEVICE_TABLE", > + "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . > $herecurr) && > + $fix) { > + $fixed[$linenr - 1] =~ > s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id > $1\[\] = /; > + } > } > > # check for new typedefs, only function parameters and sparse annotations -- To unsubscribe from this list: send the line "unsubscribe linux-pci" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
On Mon, Dec 02, 2013 at 09:43:37AM -0800, Joe Perches wrote: > Prefer use of the direct definition of struct pci_device_id > instead of indirection via macro DEFINE_PCI_DEVICE_TABLE. > > Update the PCI documentation to deprecate DEFINE_PCI_DEVICE_TABLE. > Update checkpatch adding --fix option. > > Signed-off-by: Joe Perches <joe@perches.com> Applied with Jingoo's ack for v3.14, thanks! Bjorn > --- > Documentation/PCI/pci.txt | 6 ++++-- > include/linux/pci.h | 3 +-- > scripts/checkpatch.pl | 11 +++++++---- > 3 files changed, 12 insertions(+), 8 deletions(-) > > diff --git a/Documentation/PCI/pci.txt b/Documentation/PCI/pci.txt > index 6f45856..9518006 100644 > --- a/Documentation/PCI/pci.txt > +++ b/Documentation/PCI/pci.txt > @@ -123,8 +123,10 @@ initialization with a pointer to a structure describing the driver > > > The ID table is an array of struct pci_device_id entries ending with an > -all-zero entry; use of the macro DEFINE_PCI_DEVICE_TABLE is the preferred > -method of declaring the table. Each entry consists of: > +all-zero entry. Definitions with static const are generally preferred. > +Use of the deprecated macro DEFINE_PCI_DEVICE_TABLE should be avoided. > + > +Each entry consists of: > > vendor,device Vendor and device ID to match (or PCI_ANY_ID) > > diff --git a/include/linux/pci.h b/include/linux/pci.h > index 1084a15..88674b0 100644 > --- a/include/linux/pci.h > +++ b/include/linux/pci.h > @@ -634,8 +634,7 @@ struct pci_driver { > * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table > * @_table: device table name > * > - * This macro is used to create a struct pci_device_id array (a device table) > - * in a generic manner. > + * This macro is deprecated and should not be used in new code. > */ > #define DEFINE_PCI_DEVICE_TABLE(_table) \ > const struct pci_device_id _table[] > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > index 38be5d5..6f883f0 100755 > --- a/scripts/checkpatch.pl > +++ b/scripts/checkpatch.pl > @@ -2643,10 +2643,13 @@ sub process { > } > } > > -# check for declarations of struct pci_device_id > - if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { > - WARN("DEFINE_PCI_DEVICE_TABLE", > - "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); > +# check for uses of DEFINE_PCI_DEVICE_TABLE > + if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { > + if (WARN("DEFINE_PCI_DEVICE_TABLE", > + "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && > + $fix) { > + $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; > + } > } > > # check for new typedefs, only function parameters and sparse annotations > > -- To unsubscribe from this list: send the line "unsubscribe linux-pci" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
diff --git a/Documentation/PCI/pci.txt b/Documentation/PCI/pci.txt index 6f45856..9518006 100644 --- a/Documentation/PCI/pci.txt +++ b/Documentation/PCI/pci.txt @@ -123,8 +123,10 @@ initialization with a pointer to a structure describing the driver The ID table is an array of struct pci_device_id entries ending with an -all-zero entry; use of the macro DEFINE_PCI_DEVICE_TABLE is the preferred -method of declaring the table. Each entry consists of: +all-zero entry. Definitions with static const are generally preferred. +Use of the deprecated macro DEFINE_PCI_DEVICE_TABLE should be avoided. + +Each entry consists of: vendor,device Vendor and device ID to match (or PCI_ANY_ID) diff --git a/include/linux/pci.h b/include/linux/pci.h index 1084a15..88674b0 100644 --- a/include/linux/pci.h +++ b/include/linux/pci.h @@ -634,8 +634,7 @@ struct pci_driver { * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table * @_table: device table name * - * This macro is used to create a struct pci_device_id array (a device table) - * in a generic manner. + * This macro is deprecated and should not be used in new code. */ #define DEFINE_PCI_DEVICE_TABLE(_table) \ const struct pci_device_id _table[] diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 38be5d5..6f883f0 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -2643,10 +2643,13 @@ sub process { } } -# check for declarations of struct pci_device_id - if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { - WARN("DEFINE_PCI_DEVICE_TABLE", - "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); +# check for uses of DEFINE_PCI_DEVICE_TABLE + if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { + if (WARN("DEFINE_PCI_DEVICE_TABLE", + "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && + $fix) { + $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; + } } # check for new typedefs, only function parameters and sparse annotations
Prefer use of the direct definition of struct pci_device_id instead of indirection via macro DEFINE_PCI_DEVICE_TABLE. Update the PCI documentation to deprecate DEFINE_PCI_DEVICE_TABLE. Update checkpatch adding --fix option. Signed-off-by: Joe Perches <joe@perches.com> --- Documentation/PCI/pci.txt | 6 ++++-- include/linux/pci.h | 3 +-- scripts/checkpatch.pl | 11 +++++++---- 3 files changed, 12 insertions(+), 8 deletions(-) -- To unsubscribe from this list: send the line "unsubscribe linux-pci" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html