[dpdk-dev] [PATCH v2] doc: add doc for i40e pmd driver introduction

[Thomas Monjalon]

2016-03-07 02:37, Wu, Jingjing:
> From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> > May I ask to update the table in overview.rst, please?
> So glad to see this table, I would like to update it. But I'm not sure which 
> symbol
> should I use to indicate support, not support, or haven't tested.  Take the
> row "ARMv7" for example, we haven't test on ARM platform.
> Could you share a draft patch to show us how to update it?

Please use an uppercase X to fill the table as in this patch:
http://dpdk.org/ml/archives/dev/2016-March/034699.html

If you are not sure if a row is supported (ARM case), please ignore the row.
Hint: i40e is disabled in ARM defconfigs.

[dpdk-dev] [PATCH v2] doc: add doc for i40e pmd driver introduction

[Wu, Jingjing]

> -Original Message-
> From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> Sent: Monday, March 07, 2016 4:35 PM
> To: Wu, Jingjing
> Cc: dev at dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v2] doc: add doc for i40e pmd driver
> introduction
> 
> 2016-03-07 02:37, Wu, Jingjing:
> > From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> > > May I ask to update the table in overview.rst, please?
> > So glad to see this table, I would like to update it. But I'm not sure
> > which symbol should I use to indicate support, not support, or haven't
> > tested.  Take the row "ARMv7" for example, we haven't test on ARM
> platform.
> > Could you share a draft patch to show us how to update it?
> 
> Please use an uppercase X to fill the table as in this patch:
>   http://dpdk.org/ml/archives/dev/2016-March/034699.html
> 
> If you are not sure if a row is supported (ARM case), please ignore the row.
> Hint: i40e is disabled in ARM defconfigs.

Thanks. I will work out it.

[dpdk-dev] [PATCH v2] doc: add doc for i40e pmd driver introduction

[Wu, Jingjing]

Hi, Thomas

> -Original Message-
> From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> Sent: Monday, March 07, 2016 6:39 AM
> To: Wu, Jingjing
> Cc: dev at dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v2] doc: add doc for i40e pmd driver
> introduction
> 
> 2016-02-23 09:23, Jingjing Wu:
> > A new doc "i40e.rst" is added to introduce i40e pmd driver.
> >
> > Signed-off-by: Jingjing Wu 
> > ---
> >  doc/guides/nics/i40e.rst  | 368
> ++
> >  doc/guides/nics/index.rst |   1 +
> >  2 files changed, 369 insertions(+)
> >  create mode 100644 doc/guides/nics/i40e.rst
> 
> May I ask to update the table in overview.rst, please?
So glad to see this table, I would like to update it. But I'm not sure which 
symbol
should I use to indicate support, not support, or haven't tested.  Take the
row "ARMv7" for example, we haven't test on ARM platform.
Could you share a draft patch to show us how to update it?

> 
> > --- a/doc/guides/nics/index.rst
> > +++ b/doc/guides/nics/index.rst
> > @@ -42,6 +42,7 @@ Network Interface Controller Drivers
> >  enic
> >  fm10k
> >  ixgbe
> > +i40e
> >  intel_vf
> >  mlx4
> >  mlx5
> 
> Please, let's keep an alphabetical order and insert i40e before ixgbe.
OK, I will do that.

Thanks
Jingjing

[dpdk-dev] [PATCH v2] doc: add doc for i40e pmd driver introduction

[Thomas Monjalon]

2016-02-23 09:23, Jingjing Wu:
> A new doc "i40e.rst" is added to introduce i40e pmd driver.
> 
> Signed-off-by: Jingjing Wu 
> ---
>  doc/guides/nics/i40e.rst  | 368 
> ++
>  doc/guides/nics/index.rst |   1 +
>  2 files changed, 369 insertions(+)
>  create mode 100644 doc/guides/nics/i40e.rst

May I ask to update the table in overview.rst, please?

> --- a/doc/guides/nics/index.rst
> +++ b/doc/guides/nics/index.rst
> @@ -42,6 +42,7 @@ Network Interface Controller Drivers
>  enic
>  fm10k
>  ixgbe
> +i40e
>  intel_vf
>  mlx4
>  mlx5

Please, let's keep an alphabetical order and insert i40e before ixgbe.

[dpdk-dev] [PATCH v2] doc: add doc for i40e pmd driver introduction

[Mcnamara, John]

> -Original Message-
> From: Wu, Jingjing
> Sent: Tuesday, February 23, 2016 1:23 AM
> To: dev at dpdk.org
> Cc: Wu, Jingjing ; Zhang, Helin
> ; Lu, Wenzhuo ; Mcnamara,
> John 
> Subject: [PATCH v2] doc: add doc for i40e pmd driver introduction
> 
> A new doc "i40e.rst" is added to introduce i40e pmd driver.
> 
> Signed-off-by: Jingjing Wu 

Acked-by: John McNamara 

[dpdk-dev] [PATCH v2] doc: add doc for i40e pmd driver introduction

[Jingjing Wu]

A new doc "i40e.rst" is added to introduce i40e pmd driver.

Signed-off-by: Jingjing Wu 
---
 doc/guides/nics/i40e.rst  | 368 ++
 doc/guides/nics/index.rst |   1 +
 2 files changed, 369 insertions(+)
 create mode 100644 doc/guides/nics/i40e.rst

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
new file mode 100644
index 000..4019b41
--- /dev/null
+++ b/doc/guides/nics/i40e.rst
@@ -0,0 +1,368 @@
+..  BSD LICENSE
+Copyright(c) 2016 Intel Corporation. All rights reserved.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+* Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in
+the documentation and/or other materials provided with the
+distribution.
+* Neither the name of Intel Corporation nor the names of its
+contributors may be used to endorse or promote products derived
+from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+I40E Poll Mode Driver
+==
+
+The I40E PMD (librte_pmd_i40e) provides poll mode driver support
+for the Intel X710/XL710/X722 10/40 Gbps family of adapters.
+
+
+Features
+
+
+Features of the I40E PMD are:
+
+- Multiple queues for TX and RX
+- Receiver Side Scaling (RSS)
+- MAC/VLAN filtering
+- Packet type information
+- Flow director
+- Cloud filter
+- Checksum offload
+- VLAN/QinQ stripping and inserting
+- TSO offload
+- Promiscuous mode
+- Multicast mode
+- Port hardware statistics
+- Jumbo frames
+- Link state information
+- Link flow control
+- Mirror on port, VLAN and VSI
+- Interrupt mode for RX
+- Scattered and gather for TX and RX
+- Vector Poll mode driver
+- DCB
+- VMDQ
+- SR-IOV VF
+- Hot plug
+- IEEE1588/802.1AS timestamping
+
+
+Prerequisites
+-
+
+- Identifying your adapter using `Intel Support
+  `_ and get the latest NVM/FW images.
+
+- Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup 
the basic DPDK environment.
+
+- To get better performance on Intel platforms, please follow the "How to get 
best performance with NICs on Intel platforms"
+  section of the :ref:`Getting Started Guide for Linux `.
+
+
+Pre-Installation Configuration
+--
+
+Config File Options
+~~~
+
+The following options can be modified in the ``config`` file.
+Please note that enabling debugging options may affect system performance.
+
+- ``CONFIG_RTE_LIBRTE_I40E_PMD`` (default ``y``)
+
+  Toggle compilation of the ``librte_pmd_i40e`` driver.
+
+- ``CONFIG_RTE_LIBRTE_I40E_DEBUG_*`` (default ``n``)
+
+  Toggle display of generic debugging messages.
+
+- ``CONFIG_RTE_LIBRTE_I40E_RX_ALLOW_BULK_ALLOC`` (default ``y``)
+
+  Toggle bulk allocation for RX.
+
+- ``CONFIG_RTE_LIBRTE_I40E_INC_VECTOR`` (default ``n``)
+
+  Toggle the use of Vector PMD instead of normal RX/TX path.
+  To enable vPMD for RX, bulk allocation for Rx must be allowed.
+
+- ``CONFIG_RTE_LIBRTE_I40E_RX_OLFLAGS_ENABLE`` (default ``y``)
+
+  Toggle to enable RX ``olflags``.
+  This is only meaningful when Vector PMD is used.
+
+- ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` (default ``n``)
+
+  Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 
byte.
+
+- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``)
+
+  Number of queues reserved for PF.
+
+- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VF`` (default ``4``)
+
+  Number of queues reserved for each SR-IOV VF.
+
+- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``)
+
+  Number of queues reserved for each VMDQ Pool.
+
+- ``CONFIG_RTE_LIBRTE_I40E_ITR_INTERVAL`` (default ``-1``)
+
+  Interrupt Throttling interval.
+
+
+Driver Compilation
+~~
+
+To compile the I40E PMD see :ref:`Getting Started Guide for Linux ` 
or
+:ref:`Getting Started Guide for FreeBSD `