[PATCH 1/2] doc: update programmers guide for fm10k pmd driver

[PATCH 1/2] doc: update programmers guide for fm10k pmd driver

[Chen Jing D(Mark)]

From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

DPDK introduced pmd driver for PCIE host-interface of Intel Ethernet
Switch FM10000 Series, update programming guide to describe the new
driver and usage.

Signed-off-by: Chen Jing D(Mark) <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 .../prog_guide/i40e_ixgbe_igb_virt_func_drv.rst    |   37 ++++++++++++++++++-
 doc/guides/prog_guide/source_org.rst               |    1 +
 2 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst b/doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst
index 41e316e..8ea518d 100755
--- a/doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst
+++ b/doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst
@@ -53,9 +53,10 @@ Refer to Figure 10.
 
 Therefore, a NIC is logically distributed among multiple virtual machines (as shown in Figure 10),
 while still having global data in common to share with the Physical Function and other Virtual Functions.
-The DPDK i40evf, igbvf or ixgbevf as a Poll Mode Driver (PMD) serves for the Intel® 82576 Gigabit Ethernet Controller,
+The DPDK fm10kvf, i40evf, igbvf or ixgbevf as a Poll Mode Driver (PMD) serves for the Intel® 82576 Gigabit Ethernet Controller,
 Intel® Ethernet Controller I350 family, Intel® 82599 10 Gigabit Ethernet Controller NIC,
-or Intel® Fortville 10/40 Gigabit Ethernet Controller NIC's virtual PCI function.
+Intel® Fortville 10/40 Gigabit Ethernet Controller NIC's virtual PCI function,or PCIE host-interface of the Intel Ethernet Switch
+FM10000 Series.
 Meanwhile the DPDK Poll Mode Driver (PMD) also supports "Physical Function" of such NIC's on the host.
 
 The DPDK PF/VF Poll Mode Driver (PMD) supports the Layer 2 switch on Intel® 82576 Gigabit Ethernet Controller,
@@ -93,6 +94,38 @@ and the Physical Function operates on the global resources on behalf of the Virt
 For this out-of-band communication, an SR-IOV enabled NIC provides a memory buffer for each Virtual Function,
 which is called a "Mailbox".
 
+
+The PCIE host-interface of Intel Ethernet Switch FM10000 Series VF infrastructure
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In a virtualized environment, the programmer can enable a maximum of *64 Virtual Functions (VF)*
+globally per PCIE host-interface of the Intel Ethernet Switch FM10000 Series device.
+Each VF can have a maximum of 16 queue pairs.
+The Physical Function in host could be only configured by the Linux* fm10k driver
+(in the case of the Linux Kernel-based Virtual Machine [KVM]), DPDK PMD PF driver doesn't support it yet.
+
+For example,
+
+*   Using Linux* fm10k driver:
+
+    .. code-block:: console
+
+        rmmod fm10k (To remove the fm10k module)
+        insmod fm0k.ko max_vfs=2,2 (To enable two Virtual Functions per port)
+
+Virtual Function enumeration is performed in the following sequence by the Linux* pci driver for a dual-port NIC.
+When you enable the four Virtual Functions with the above command, the four enabled functions have a Function#
+represented by (Bus#, Device#, Function#) in sequence starting from 0 to 3.
+However:
+
+*   Virtual Functions 0 and 2 belong to Physical Function 0
+
+*   Virtual Functions 1 and 3 belong to Physical Function 1
+
+.. note::
+
+    The above is an important consideration to take into account when targeting specific packets to a selected port.
+
 Intel® Fortville 10/40 Gigabit Ethernet Controller VF Infrastructure
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index c66ad16..061f107 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -81,6 +81,7 @@ The lib directory contains::
     +-- librte_net          # various IP-related headers
     +-- librte_pmd_bond     # bonding poll mode driver
     +-- librte_pmd_e1000    # 1GbE poll mode drivers (igb and em)
+    +-- librte_pmd_fm10k    # Host interface PMD driver for FM10000 Series
     +-- librte_pmd_ixgbe    # 10GbE poll mode driver
     +-- librte_pmd_i40e     # 40GbE poll mode driver
     +-- librte_pmd_mlx4     # Mellanox ConnectX-3 poll mode driver
-- 
1.7.7.6

[PATCH 2/2] doc: update release note for fm10k pmd driver

[Chen Jing D(Mark)]

From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Add feature list for fm10k driver.

Signed-off-by: Chen Jing D(Mark) <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 doc/guides/rel_notes/new_features.rst |   20 ++++++++++++++++++++
 1 files changed, 20 insertions(+), 0 deletions(-)

diff --git a/doc/guides/rel_notes/new_features.rst b/doc/guides/rel_notes/new_features.rst
index 2993b1e..c08d5a8 100644
--- a/doc/guides/rel_notes/new_features.rst
+++ b/doc/guides/rel_notes/new_features.rst
@@ -58,4 +58,24 @@ New Features
 
 *   Packet Distributor Sample Application
 
+*   Poll Mode Driver - PCIE host-interface of Intel Ethernet Switch FM10000 Series (librte_pmd_fm10k)
+
+    *   Basic Rx/Tx functions for PF/VF
+
+    *   Interrupt handling support for PF/VF
+
+    *   Per queue start/stop functions for PF/VF
+
+    *   Support Mailbox handling between PF/VF and PF/Switch Manager
+
+    *   Receive Side Scaling (RSS) for PF/VF
+
+    *   Scatter receive function for PF/VF
+
+    *   Reta update/query for PF/VF
+
+    *   VLAN filter set for PF
+
+    *   Link status query for PF/VF.
+
 For further features supported in this release, see Chapter 3 Supported Features.
-- 
1.7.7.6

Re: [PATCH 2/2] doc: update release note for fm10k pmd driver

[Qiu, Michael]

On 3/6/2015 2:40 PM, Chen Jing D(Mark) wrote:
> From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
>
> Add feature list for fm10k driver.
>
> Signed-off-by: Chen Jing D(Mark) <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
> ---
>  doc/guides/rel_notes/new_features.rst |   20 ++++++++++++++++++++
>  1 files changed, 20 insertions(+), 0 deletions(-)
>
> diff --git a/doc/guides/rel_notes/new_features.rst b/doc/guides/rel_notes/new_features.rst
> index 2993b1e..c08d5a8 100644
> --- a/doc/guides/rel_notes/new_features.rst
> +++ b/doc/guides/rel_notes/new_features.rst
> @@ -58,4 +58,24 @@ New Features
>  
>  *   Packet Distributor Sample Application
>  
> +*   Poll Mode Driver - PCIE host-interface of Intel Ethernet Switch FM10000 Series (librte_pmd_fm10k)
> +
> +    *   Basic Rx/Tx functions for PF/VF
> +
> +    *   Interrupt handling support for PF/VF
> +
> +    *   Per queue start/stop functions for PF/VF
> +
> +    *   Support Mailbox handling between PF/VF and PF/Switch Manager
> +
> +    *   Receive Side Scaling (RSS) for PF/VF
> +
> +    *   Scatter receive function for PF/VF
> +
> +    *   Reta update/query for PF/VF
> +
> +    *   VLAN filter set for PF
> +
> +    *   Link status query for PF/VF.

Why only last has '.'? I think should be keep the same style.

Thanks,
Michael
> +
>  For further features supported in this release, see Chapter 3 Supported Features.

Re: [PATCH 2/2] doc: update release note for fm10k pmd driver

[Chen, Jing D]

Hi Michael,

> -----Original Message-----
> From: Qiu, Michael
> Sent: Friday, March 06, 2015 4:07 PM
> To: Chen, Jing D; dev-VfR2kkLFssw@public.gmane.org
> Subject: Re: [dpdk-dev] [PATCH 2/2] doc: update release note for fm10k
> pmd driver
> 
> On 3/6/2015 2:40 PM, Chen Jing D(Mark) wrote:
> > From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
> >
> > Add feature list for fm10k driver.
> >
> > Signed-off-by: Chen Jing D(Mark) <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
> > ---
> >  doc/guides/rel_notes/new_features.rst |   20 ++++++++++++++++++++
> >  1 files changed, 20 insertions(+), 0 deletions(-)
> >
> > diff --git a/doc/guides/rel_notes/new_features.rst
> b/doc/guides/rel_notes/new_features.rst
> > index 2993b1e..c08d5a8 100644
> > --- a/doc/guides/rel_notes/new_features.rst
> > +++ b/doc/guides/rel_notes/new_features.rst
> > @@ -58,4 +58,24 @@ New Features
> >
> >  *   Packet Distributor Sample Application
> >
> > +*   Poll Mode Driver - PCIE host-interface of Intel Ethernet Switch
> FM10000 Series (librte_pmd_fm10k)
> > +
> > +    *   Basic Rx/Tx functions for PF/VF
> > +
> > +    *   Interrupt handling support for PF/VF
> > +
> > +    *   Per queue start/stop functions for PF/VF
> > +
> > +    *   Support Mailbox handling between PF/VF and PF/Switch Manager
> > +
> > +    *   Receive Side Scaling (RSS) for PF/VF
> > +
> > +    *   Scatter receive function for PF/VF
> > +
> > +    *   Reta update/query for PF/VF
> > +
> > +    *   VLAN filter set for PF
> > +
> > +    *   Link status query for PF/VF.
> 
> Why only last has '.'? I think should be keep the same style.

Thanks for your comments. 

> 
> Thanks,
> Michael
> > +
> >  For further features supported in this release, see Chapter 3 Supported
> Features.

[PATCH v2 0/2] doc: update doc for fm10k driver

[Chen Jing D(Mark)]

From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Update programming guide and release notes for fm10k driver.

Changes in v2:
- Remove a punctuation.
 

Chen Jing D(Mark) (2):
  doc: update programmers guide for fm10k pmd driver
  doc: update release note for fm10k pmd driver

 .../prog_guide/i40e_ixgbe_igb_virt_func_drv.rst    |   37 ++++++++++++++++++-
 doc/guides/prog_guide/source_org.rst               |    1 +
 doc/guides/rel_notes/new_features.rst              |   20 +++++++++++
 3 files changed, 56 insertions(+), 2 deletions(-)

-- 
1.7.7.6

[PATCH v2 1/2] doc: update programmers guide for fm10k pmd driver

[Chen Jing D(Mark)]

From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

DPDK introduced pmd driver for PCIE host-interface of Intel Ethernet
Switch FM10000 Series, update programming guide to describe the new
driver and usage.

Signed-off-by: Chen Jing D(Mark) <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 .../prog_guide/i40e_ixgbe_igb_virt_func_drv.rst    |   37 ++++++++++++++++++-
 doc/guides/prog_guide/source_org.rst               |    1 +
 2 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst b/doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst
index 41e316e..8ea518d 100755
--- a/doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst
+++ b/doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst
@@ -53,9 +53,10 @@ Refer to Figure 10.
 
 Therefore, a NIC is logically distributed among multiple virtual machines (as shown in Figure 10),
 while still having global data in common to share with the Physical Function and other Virtual Functions.
-The DPDK i40evf, igbvf or ixgbevf as a Poll Mode Driver (PMD) serves for the Intel® 82576 Gigabit Ethernet Controller,
+The DPDK fm10kvf, i40evf, igbvf or ixgbevf as a Poll Mode Driver (PMD) serves for the Intel® 82576 Gigabit Ethernet Controller,
 Intel® Ethernet Controller I350 family, Intel® 82599 10 Gigabit Ethernet Controller NIC,
-or Intel® Fortville 10/40 Gigabit Ethernet Controller NIC's virtual PCI function.
+Intel® Fortville 10/40 Gigabit Ethernet Controller NIC's virtual PCI function,or PCIE host-interface of the Intel Ethernet Switch
+FM10000 Series.
 Meanwhile the DPDK Poll Mode Driver (PMD) also supports "Physical Function" of such NIC's on the host.
 
 The DPDK PF/VF Poll Mode Driver (PMD) supports the Layer 2 switch on Intel® 82576 Gigabit Ethernet Controller,
@@ -93,6 +94,38 @@ and the Physical Function operates on the global resources on behalf of the Virt
 For this out-of-band communication, an SR-IOV enabled NIC provides a memory buffer for each Virtual Function,
 which is called a "Mailbox".
 
+
+The PCIE host-interface of Intel Ethernet Switch FM10000 Series VF infrastructure
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In a virtualized environment, the programmer can enable a maximum of *64 Virtual Functions (VF)*
+globally per PCIE host-interface of the Intel Ethernet Switch FM10000 Series device.
+Each VF can have a maximum of 16 queue pairs.
+The Physical Function in host could be only configured by the Linux* fm10k driver
+(in the case of the Linux Kernel-based Virtual Machine [KVM]), DPDK PMD PF driver doesn't support it yet.
+
+For example,
+
+*   Using Linux* fm10k driver:
+
+    .. code-block:: console
+
+        rmmod fm10k (To remove the fm10k module)
+        insmod fm0k.ko max_vfs=2,2 (To enable two Virtual Functions per port)
+
+Virtual Function enumeration is performed in the following sequence by the Linux* pci driver for a dual-port NIC.
+When you enable the four Virtual Functions with the above command, the four enabled functions have a Function#
+represented by (Bus#, Device#, Function#) in sequence starting from 0 to 3.
+However:
+
+*   Virtual Functions 0 and 2 belong to Physical Function 0
+
+*   Virtual Functions 1 and 3 belong to Physical Function 1
+
+.. note::
+
+    The above is an important consideration to take into account when targeting specific packets to a selected port.
+
 Intel® Fortville 10/40 Gigabit Ethernet Controller VF Infrastructure
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index c66ad16..061f107 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -81,6 +81,7 @@ The lib directory contains::
     +-- librte_net          # various IP-related headers
     +-- librte_pmd_bond     # bonding poll mode driver
     +-- librte_pmd_e1000    # 1GbE poll mode drivers (igb and em)
+    +-- librte_pmd_fm10k    # Host interface PMD driver for FM10000 Series
     +-- librte_pmd_ixgbe    # 10GbE poll mode driver
     +-- librte_pmd_i40e     # 40GbE poll mode driver
     +-- librte_pmd_mlx4     # Mellanox ConnectX-3 poll mode driver
-- 
1.7.7.6

[PATCH v2 2/2] doc: update release note for fm10k pmd driver

[Chen Jing D(Mark)]

From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Add feature list for fm10k driver.

Signed-off-by: Chen Jing D(Mark) <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 doc/guides/rel_notes/new_features.rst |   20 ++++++++++++++++++++
 1 files changed, 20 insertions(+), 0 deletions(-)

diff --git a/doc/guides/rel_notes/new_features.rst b/doc/guides/rel_notes/new_features.rst
index 2993b1e..a27e360 100644
--- a/doc/guides/rel_notes/new_features.rst
+++ b/doc/guides/rel_notes/new_features.rst
@@ -58,4 +58,24 @@ New Features
 
 *   Packet Distributor Sample Application
 
+*   Poll Mode Driver - PCIE host-interface of Intel Ethernet Switch FM10000 Series (librte_pmd_fm10k)
+
+    *   Basic Rx/Tx functions for PF/VF
+
+    *   Interrupt handling support for PF/VF
+
+    *   Per queue start/stop functions for PF/VF
+
+    *   Support Mailbox handling between PF/VF and PF/Switch Manager
+
+    *   Receive Side Scaling (RSS) for PF/VF
+
+    *   Scatter receive function for PF/VF
+
+    *   Reta update/query for PF/VF
+
+    *   VLAN filter set for PF
+
+    *   Link status query for PF/VF
+
 For further features supported in this release, see Chapter 3 Supported Features.
-- 
1.7.7.6

Re: [PATCH v2 2/2] doc: update release note for fm10k pmd driver

[Butler, Siobhan A]

Acked-by Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

On Mar 13, 2015 9:14 AM, "Chen, Jing D" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> wrote:
From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Add feature list for fm10k driver.

Signed-off-by: Chen Jing D(Mark) <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 doc/guides/rel_notes/new_features.rst |   20 ++++++++++++++++++++
 1 files changed, 20 insertions(+), 0 deletions(-)

diff --git a/doc/guides/rel_notes/new_features.rst b/doc/guides/rel_notes/new_features.rst
index 2993b1e..a27e360 100644
--- a/doc/guides/rel_notes/new_features.rst
+++ b/doc/guides/rel_notes/new_features.rst
@@ -58,4 +58,24 @@ New Features

 *   Packet Distributor Sample Application

+*   Poll Mode Driver - PCIE host-interface of Intel Ethernet Switch FM10000 Series (librte_pmd_fm10k)
+
+    *   Basic Rx/Tx functions for PF/VF
+
+    *   Interrupt handling support for PF/VF
+
+    *   Per queue start/stop functions for PF/VF
+
+    *   Support Mailbox handling between PF/VF and PF/Switch Manager
+
+    *   Receive Side Scaling (RSS) for PF/VF
+
+    *   Scatter receive function for PF/VF
+
+    *   Reta update/query for PF/VF
+
+    *   VLAN filter set for PF
+
+    *   Link status query for PF/VF
+
 For further features supported in this release, see Chapter 3 Supported Features.
--
1.7.7.6

Re: [PATCH v2 0/2] doc: update doc for fm10k driver

[Butler, Siobhan A]

Acked-by Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

On Mar 13, 2015 9:14 AM, "Chen, Jing D" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> wrote:
From: "Chen Jing D(Mark)" <jing.d.chen-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Update programming guide and release notes for fm10k driver.

Changes in v2:
- Remove a punctuation.


Chen Jing D(Mark) (2):
  doc: update programmers guide for fm10k pmd driver
  doc: update release note for fm10k pmd driver

 .../prog_guide/i40e_ixgbe_igb_virt_func_drv.rst    |   37 ++++++++++++++++++-
 doc/guides/prog_guide/source_org.rst               |    1 +
 doc/guides/rel_notes/new_features.rst              |   20 +++++++++++
 3 files changed, 56 insertions(+), 2 deletions(-)

--
1.7.7.6

Re: [PATCH v2 0/2] doc: update doc for fm10k driver

[Thomas Monjalon]

> Update programming guide and release notes for fm10k driver.
> 
> Changes in v2:
> - Remove a punctuation.
> 
> 
> Chen Jing D(Mark) (2):
>   doc: update programmers guide for fm10k pmd driver
>   doc: update release note for fm10k pmd driver
> 
> Acked-by Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Applied, thanks