diff mbox series

[v8,5/5] misc: pci_endpoint_test: Document a policy about adding pci_device_id

Message ID 20240520074300.125969-6-yoshihiro.shimoda.uh@renesas.com
State New
Headers show
Series PCI: rcar-gen4: Add R-Car V4H support | expand

Commit Message

Yoshihiro Shimoda May 20, 2024, 7:43 a.m. UTC 
To avoid becoming struct pci_device_id pci_endpoint_test_tbl longer
and longer, document a policy. For example, if PCIe endpoint controller
can configure vendor id and/or product id, you can reuse one of
existing entries to test.

Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Reviewed-by: Frank Li <Frank.Li@nxp.com>
---
 drivers/misc/pci_endpoint_test.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Bjorn Helgaas June 5, 2024, 5:28 p.m. UTC | #1 
On Mon, May 20, 2024 at 04:43:00PM +0900, Yoshihiro Shimoda wrote:
> To avoid becoming struct pci_device_id pci_endpoint_test_tbl longer
> and longer, document a policy. For example, if PCIe endpoint controller
> can configure vendor id and/or product id, you can reuse one of
> existing entries to test.

Possible text:

  Add a comment suggesting that if the endpoint controller Vendor and
  Device ID are programmable, an existing entry might be usable for
  testing without having to add an entry to pci_endpoint_test_tbl[].

> Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
> Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> Reviewed-by: Frank Li <Frank.Li@nxp.com>
> ---
>  drivers/misc/pci_endpoint_test.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/misc/pci_endpoint_test.c b/drivers/misc/pci_endpoint_test.c
> index c38a6083f0a7..727db13b6450 100644
> --- a/drivers/misc/pci_endpoint_test.c
> +++ b/drivers/misc/pci_endpoint_test.c
> @@ -980,6 +980,7 @@ static const struct pci_endpoint_test_data j721e_data = {
>  	.irq_type = IRQ_TYPE_MSI,
>  };
>  
> +/* Do not add a new entry if the controller can use existing VID:PID combinations */

  /*
   * If the controller's Vendor/Device ID are programmable, you may be
   * able to use one of the existing entries for testing instead of
   * adding a new one.
   */

>  static const struct pci_device_id pci_endpoint_test_tbl[] = {
>  	{ PCI_DEVICE(PCI_VENDOR_ID_TI, PCI_DEVICE_ID_TI_DRA74x),
>  	  .driver_data = (kernel_ulong_t)&default_data,
> -- 
> 2.25.1
>
Yoshihiro Shimoda June 11, 2024, 9:06 a.m. UTC | #2 
Hi Bjorn,

> From: Bjorn Helgaas, Sent: Thursday, June 6, 2024 2:28 AM
> 
> On Mon, May 20, 2024 at 04:43:00PM +0900, Yoshihiro Shimoda wrote:
> > To avoid becoming struct pci_device_id pci_endpoint_test_tbl longer
> > and longer, document a policy. For example, if PCIe endpoint controller
> > can configure vendor id and/or product id, you can reuse one of
> > existing entries to test.
> 
> Possible text:
> 
>   Add a comment suggesting that if the endpoint controller Vendor and
>   Device ID are programmable, an existing entry might be usable for
>   testing without having to add an entry to pci_endpoint_test_tbl[].

Thank you for the suggestion. I'll fix the description.

> > Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
> > Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> > Reviewed-by: Frank Li <Frank.Li@nxp.com>
> > ---
> >  drivers/misc/pci_endpoint_test.c | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/drivers/misc/pci_endpoint_test.c b/drivers/misc/pci_endpoint_test.c
> > index c38a6083f0a7..727db13b6450 100644
> > --- a/drivers/misc/pci_endpoint_test.c
> > +++ b/drivers/misc/pci_endpoint_test.c
> > @@ -980,6 +980,7 @@ static const struct pci_endpoint_test_data j721e_data = {
> >  	.irq_type = IRQ_TYPE_MSI,
> >  };
> >
> > +/* Do not add a new entry if the controller can use existing VID:PID combinations */
> 
>   /*
>    * If the controller's Vendor/Device ID are programmable, you may be
>    * able to use one of the existing entries for testing instead of
>    * adding a new one.
>    */

I'll write this on v9.

Best regards,
Yoshihiro Shimoda

> >  static const struct pci_device_id pci_endpoint_test_tbl[] = {
> >  	{ PCI_DEVICE(PCI_VENDOR_ID_TI, PCI_DEVICE_ID_TI_DRA74x),
> >  	  .driver_data = (kernel_ulong_t)&default_data,
> > --
> > 2.25.1
> >
diff mbox series

Patch

diff --git a/drivers/misc/pci_endpoint_test.c b/drivers/misc/pci_endpoint_test.c
index c38a6083f0a7..727db13b6450 100644
--- a/drivers/misc/pci_endpoint_test.c
+++ b/drivers/misc/pci_endpoint_test.c
@@ -980,6 +980,7 @@  static const struct pci_endpoint_test_data j721e_data = {
 	.irq_type = IRQ_TYPE_MSI,
 };
 
+/* Do not add a new entry if the controller can use existing VID:PID combinations */
 static const struct pci_device_id pci_endpoint_test_tbl[] = {
 	{ PCI_DEVICE(PCI_VENDOR_ID_TI, PCI_DEVICE_ID_TI_DRA74x),
 	  .driver_data = (kernel_ulong_t)&default_data,