[2/2] doc: multiple representors in one device

Message ID 20240111064432.193119-3-hkalra@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series multiple representors in one device |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/github-robot: build success github build: passed
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS

Commit Message

Harman Kalra Jan. 11, 2024, 6:44 a.m. UTC
  Updating the documentation with the pattern format for enabling
multiple representors in one device

Signed-off-by: Harman Kalra <hkalra@marvell.com>
---
 doc/guides/prog_guide/poll_mode_drv.rst         | 4 +++-
 doc/guides/prog_guide/switch_representation.rst | 1 +
 2 files changed, 4 insertions(+), 1 deletion(-)
  

Comments

Andrew Rybchenko Jan. 12, 2024, 7:26 a.m. UTC | #1
On 1/11/24 09:44, Harman Kalra wrote:
> Updating the documentation with the pattern format for enabling
> multiple representors in one device
> 
> Signed-off-by: Harman Kalra <hkalra@marvell.com>

IMHO it should be squashed into previous patch.
  
Harman Kalra Jan. 15, 2024, 4:01 p.m. UTC | #2
> -----Original Message-----
> From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Sent: Friday, January 12, 2024 12:56 PM
> To: Harman Kalra <hkalra@marvell.com>; Thomas Monjalon
> <thomas@monjalon.net>; Ferruh Yigit <ferruh.yigit@amd.com>
> Cc: dev@dpdk.org
> Subject: [EXT] Re: [PATCH 2/2] doc: multiple representors in one device
> 
> External Email
> 
> ----------------------------------------------------------------------
> On 1/11/24 09:44, Harman Kalra wrote:
> > Updating the documentation with the pattern format for enabling
> > multiple representors in one device
> >
> > Signed-off-by: Harman Kalra <hkalra@marvell.com>
> 
> IMHO it should be squashed into previous patch.

Done, kindly review V2
  

Patch

diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst
index c145a9066c..76285e71e2 100644
--- a/doc/guides/prog_guide/poll_mode_drv.rst
+++ b/doc/guides/prog_guide/poll_mode_drv.rst
@@ -376,7 +376,7 @@  parameters to those ports.
 
 * ``representor`` for a device which supports the creation of representor ports
   this argument allows user to specify which switch ports to enable port
-  representors for. Multiple representors in one device argument is invalid::
+  representors for::
 
    -a DBDF,representor=vf0
    -a DBDF,representor=vf[0,4,6,9]
@@ -389,6 +389,8 @@  parameters to those ports.
    -a DBDF,representor=pf1vf0
    -a DBDF,representor=pf[0-1]sf[0-127]
    -a DBDF,representor=pf1
+   -a DBDF,representor=pf[0-1],representor=pf2vf[0-2],representor=pf3[3,5-8]
+   (Enabling creation of multiple representors in one device argument)
 
 Note: PMDs are not required to support the standard device arguments and users
 should consult the relevant PMD documentation to see support devargs.
diff --git a/doc/guides/prog_guide/switch_representation.rst b/doc/guides/prog_guide/switch_representation.rst
index 6fd7b98bdc..fde8c790ba 100644
--- a/doc/guides/prog_guide/switch_representation.rst
+++ b/doc/guides/prog_guide/switch_representation.rst
@@ -77,6 +77,7 @@  thought as a software "patch panel" front-end for applications.
    -a pci:dbdf,representor=sf1
    -a pci:dbdf,representor=sf[0-1023]
    -a pci:dbdf,representor=sf[0,2-1023]
+   -a pci:dbdf,representor=pf[0-1],representor=pf2vf[0-2],representor=pf3[3,5]
 
 - As virtual devices, they may be more limited than their physical
   counterparts, for instance by exposing only a subset of device