Patchwork [2/3] PCI: Use spec name for the comment of PCIe capability field

login
register
mail settings
Submitter Wei Yang
Date Sept. 6, 2013, 1:45 a.m.
Message ID <1378431958-7874-2-git-send-email-weiyang@linux.vnet.ibm.com>
Download mbox | patch
Permalink /patch/273019/
State Not Applicable
Headers show

Comments

Wei Yang - Sept. 6, 2013, 1:45 a.m.
According to the PCIe specification, bit 7:4 of PCI Express Capabilities
Register in a PCI Express Capability Structure is used to identify the
Device/Port type. If this field equals to 0x7, this PCIe device is a PCI
Express to PCI/PCI-X Bridge. While the comment of this value in the code
does not comply with the specification.

This patch changes the comment to "PCIE to PCI/PCI-X Bridge" instead of
"PCI/PCI-X Bridge", which comply with the specification.

Signed-off-by: Wei Yang <weiyang@linux.vnet.ibm.com>
---
 include/uapi/linux/pci_regs.h |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
Bjorn Helgaas - Sept. 6, 2013, 11:12 p.m.
On Fri, Sep 06, 2013 at 09:45:57AM +0800, Wei Yang wrote:
> According to the PCIe specification, bit 7:4 of PCI Express Capabilities
> Register in a PCI Express Capability Structure is used to identify the
> Device/Port type. If this field equals to 0x7, this PCIe device is a PCI
> Express to PCI/PCI-X Bridge. While the comment of this value in the code
> does not comply with the specification.
> 
> This patch changes the comment to "PCIE to PCI/PCI-X Bridge" instead of
> "PCI/PCI-X Bridge", which comply with the specification.
> 
> Signed-off-by: Wei Yang <weiyang@linux.vnet.ibm.com>
> ---
>  include/uapi/linux/pci_regs.h |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
> 
> diff --git a/include/uapi/linux/pci_regs.h b/include/uapi/linux/pci_regs.h
> index c3cc01d..b82b2ff 100644
> --- a/include/uapi/linux/pci_regs.h
> +++ b/include/uapi/linux/pci_regs.h
> @@ -421,7 +421,7 @@
>  #define  PCI_EXP_TYPE_ROOT_PORT 0x4	/* Root Port */
>  #define  PCI_EXP_TYPE_UPSTREAM	0x5	/* Upstream Port */
>  #define  PCI_EXP_TYPE_DOWNSTREAM 0x6	/* Downstream Port */
> -#define  PCI_EXP_TYPE_PCI_BRIDGE 0x7	/* PCI/PCI-X Bridge */
> +#define  PCI_EXP_TYPE_PCI_BRIDGE 0x7	/* PCIE to PCI/PCI-X Bridge */
>  #define  PCI_EXP_TYPE_PCIE_BRIDGE 0x8	/* PCI/PCI-X to PCIE Bridge */
>  #define  PCI_EXP_TYPE_RC_END	0x9	/* Root Complex Integrated Endpoint */
>  #define  PCI_EXP_TYPE_RC_EC	0xa	/* Root Complex Event Collector */
> -- 
> 1.7.1
> 

A similar change is already in Linus' tree:

http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/include/uapi/linux/pci_regs.h?id=fbf501c347b2eea8451a615bd823b6b91a1a8eed

I guess several of us found that comment confusing :)
--
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
Wei Yang - Sept. 9, 2013, 2:10 a.m.
On Fri, Sep 06, 2013 at 05:12:43PM -0600, Bjorn Helgaas wrote:
>On Fri, Sep 06, 2013 at 09:45:57AM +0800, Wei Yang wrote:
>> According to the PCIe specification, bit 7:4 of PCI Express Capabilities
>> Register in a PCI Express Capability Structure is used to identify the
>> Device/Port type. If this field equals to 0x7, this PCIe device is a PCI
>> Express to PCI/PCI-X Bridge. While the comment of this value in the code
>> does not comply with the specification.
>> 
>> This patch changes the comment to "PCIE to PCI/PCI-X Bridge" instead of
>> "PCI/PCI-X Bridge", which comply with the specification.
>> 
>> Signed-off-by: Wei Yang <weiyang@linux.vnet.ibm.com>
>> ---
>>  include/uapi/linux/pci_regs.h |    2 +-
>>  1 files changed, 1 insertions(+), 1 deletions(-)
>> 
>> diff --git a/include/uapi/linux/pci_regs.h b/include/uapi/linux/pci_regs.h
>> index c3cc01d..b82b2ff 100644
>> --- a/include/uapi/linux/pci_regs.h
>> +++ b/include/uapi/linux/pci_regs.h
>> @@ -421,7 +421,7 @@
>>  #define  PCI_EXP_TYPE_ROOT_PORT 0x4	/* Root Port */
>>  #define  PCI_EXP_TYPE_UPSTREAM	0x5	/* Upstream Port */
>>  #define  PCI_EXP_TYPE_DOWNSTREAM 0x6	/* Downstream Port */
>> -#define  PCI_EXP_TYPE_PCI_BRIDGE 0x7	/* PCI/PCI-X Bridge */
>> +#define  PCI_EXP_TYPE_PCI_BRIDGE 0x7	/* PCIE to PCI/PCI-X Bridge */
>>  #define  PCI_EXP_TYPE_PCIE_BRIDGE 0x8	/* PCI/PCI-X to PCIE Bridge */
>>  #define  PCI_EXP_TYPE_RC_END	0x9	/* Root Complex Integrated Endpoint */
>>  #define  PCI_EXP_TYPE_RC_EC	0xa	/* Root Complex Event Collector */
>> -- 
>> 1.7.1
>> 
>
>A similar change is already in Linus' tree:
>
>http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/include/uapi/linux/pci_regs.h?id=fbf501c347b2eea8451a615bd823b6b91a1a8eed
>
>I guess several of us found that comment confusing :)

Thanks, I didn't notice this :-)

Patch

diff --git a/include/uapi/linux/pci_regs.h b/include/uapi/linux/pci_regs.h
index c3cc01d..b82b2ff 100644
--- a/include/uapi/linux/pci_regs.h
+++ b/include/uapi/linux/pci_regs.h
@@ -421,7 +421,7 @@ 
 #define  PCI_EXP_TYPE_ROOT_PORT 0x4	/* Root Port */
 #define  PCI_EXP_TYPE_UPSTREAM	0x5	/* Upstream Port */
 #define  PCI_EXP_TYPE_DOWNSTREAM 0x6	/* Downstream Port */
-#define  PCI_EXP_TYPE_PCI_BRIDGE 0x7	/* PCI/PCI-X Bridge */
+#define  PCI_EXP_TYPE_PCI_BRIDGE 0x7	/* PCIE to PCI/PCI-X Bridge */
 #define  PCI_EXP_TYPE_PCIE_BRIDGE 0x8	/* PCI/PCI-X to PCIE Bridge */
 #define  PCI_EXP_TYPE_RC_END	0x9	/* Root Complex Integrated Endpoint */
 #define  PCI_EXP_TYPE_RC_EC	0xa	/* Root Complex Event Collector */