diff mbox series

[v3,33/34] doc: add ICE description and update release note

Message ID 1544598004-27099-34-git-send-email-wenzhuo.lu@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Qi Zhang
Headers show
Series A new net PMD - ice | expand

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK

Commit Message

Wenzhuo Lu Dec. 12, 2018, 7 a.m. UTC
Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
---
 MAINTAINERS                            |   1 +
 doc/guides/nics/features/ice.ini       |  38 +++++++++++++
 doc/guides/nics/ice.rst                | 101 +++++++++++++++++++++++++++++++++
 doc/guides/rel_notes/release_19_02.rst |   4 ++
 4 files changed, 144 insertions(+)
 create mode 100644 doc/guides/nics/features/ice.ini
 create mode 100644 doc/guides/nics/ice.rst

Comments

Ferruh Yigit Dec. 13, 2018, 9:34 p.m. UTC | #1
On 12/12/2018 7:00 AM, Wenzhuo Lu wrote:
> Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
> ---
>  MAINTAINERS                            |   1 +
>  doc/guides/nics/features/ice.ini       |  38 +++++++++++++
>  doc/guides/nics/ice.rst                | 101 +++++++++++++++++++++++++++++++++

Need to update doc/guides/nics/index.rst too to include ice.rst

>  doc/guides/rel_notes/release_19_02.rst |   4 ++
>  4 files changed, 144 insertions(+)
>  create mode 100644 doc/guides/nics/features/ice.ini
>  create mode 100644 doc/guides/nics/ice.rst
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 37f3bf7..cd01565 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -598,6 +598,7 @@ M: Qiming Yang <qiming.yang@intel.com>
>  M: Wenzhuo Lu <wenzhuo.lu@intel.com>
>  T: git://dpdk.org/next/dpdk-next-net-intel
>  F: drivers/net/ice/
> +F: doc/guides/nics/features/ice*.ini

Should add .rst file too?

<...>

> @@ -0,0 +1,101 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2018 Intel Corporation.
> +
> +ICE Poll Mode Driver
> +======================
> +
> +The ice PMD (librte_pmd_ice) provides poll mode driver support for
> +10/25 Gbps Intel® Ethernet 810 Series Network Adapters based on
> +the Intel Ethernet Controller E810.

Please remember to add links to product web-page when it is available.
Wenzhuo Lu Dec. 14, 2018, 2:42 a.m. UTC | #2
Hi Ferruh,

> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Friday, December 14, 2018 5:34 AM
> To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v3 33/34] doc: add ICE description and
> update release note
> 
> On 12/12/2018 7:00 AM, Wenzhuo Lu wrote:
> > Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
> > ---
> >  MAINTAINERS                            |   1 +
> >  doc/guides/nics/features/ice.ini       |  38 +++++++++++++
> >  doc/guides/nics/ice.rst                | 101
> +++++++++++++++++++++++++++++++++
> 
> Need to update doc/guides/nics/index.rst too to include ice.rst
Will update it.
> 
> >  doc/guides/rel_notes/release_19_02.rst |   4 ++
> >  4 files changed, 144 insertions(+)
> >  create mode 100644 doc/guides/nics/features/ice.ini  create mode
> > 100644 doc/guides/nics/ice.rst
> >
> > diff --git a/MAINTAINERS b/MAINTAINERS index 37f3bf7..cd01565 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -598,6 +598,7 @@ M: Qiming Yang <qiming.yang@intel.com>
> >  M: Wenzhuo Lu <wenzhuo.lu@intel.com>
> >  T: git://dpdk.org/next/dpdk-next-net-intel
> >  F: drivers/net/ice/
> > +F: doc/guides/nics/features/ice*.ini
> 
> Should add .rst file too?
Will add it.
> 
> <...>
> 
> > @@ -0,0 +1,101 @@
> > +..  SPDX-License-Identifier: BSD-3-Clause
> > +    Copyright(c) 2018 Intel Corporation.
> > +
> > +ICE Poll Mode Driver
> > +======================
> > +
> > +The ice PMD (librte_pmd_ice) provides poll mode driver support for
> > +10/25 Gbps Intel® Ethernet 810 Series Network Adapters based on the
> > +Intel Ethernet Controller E810.
> 
> Please remember to add links to product web-page when it is available.
O, will add it later.
diff mbox series

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index 37f3bf7..cd01565 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -598,6 +598,7 @@  M: Qiming Yang <qiming.yang@intel.com>
 M: Wenzhuo Lu <wenzhuo.lu@intel.com>
 T: git://dpdk.org/next/dpdk-next-net-intel
 F: drivers/net/ice/
+F: doc/guides/nics/features/ice*.ini
 
 Marvell mvpp2
 M: Tomasz Duszynski <tdu@semihalf.com>
diff --git a/doc/guides/nics/features/ice.ini b/doc/guides/nics/features/ice.ini
new file mode 100644
index 0000000..196b8d5
--- /dev/null
+++ b/doc/guides/nics/features/ice.ini
@@ -0,0 +1,38 @@ 
+;
+; Supported features of the 'ice' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Speed capabilities   = Y
+Link status          = Y
+Link status event    = Y
+Rx interrupt         = Y
+Queue start/stop     = Y
+MTU update           = Y
+Jumbo frame          = Y
+Scattered Rx         = Y
+TSO                  = Y
+Unicast MAC filter   = Y
+Multicast MAC filter = Y
+RSS hash             = Y
+RSS key update       = Y
+RSS reta update      = Y
+VLAN filter          = Y
+CRC offload          = Y
+VLAN offload         = Y
+QinQ offload         = Y
+L3 checksum offload  = Y
+L4 checksum offload  = Y
+Packet type parsing  = Y
+Rx descriptor status = Y
+Tx descriptor status = Y
+Basic stats          = Y
+Extended stats       = Y
+FW version           = Y
+Module EEPROM dump   = Y
+BSD nic_uio          = Y
+Linux UIO            = Y
+Linux VFIO           = Y
+x86-32               = Y
+x86-64               = Y
diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
new file mode 100644
index 0000000..95b409a
--- /dev/null
+++ b/doc/guides/nics/ice.rst
@@ -0,0 +1,101 @@ 
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2018 Intel Corporation.
+
+ICE Poll Mode Driver
+======================
+
+The ice PMD (librte_pmd_ice) provides poll mode driver support for
+10/25 Gbps Intel® Ethernet 810 Series Network Adapters based on
+the Intel Ethernet Controller E810.
+
+
+Prerequisites
+-------------
+
+- Identifying your adapter using `Intel Support
+  <http://www.intel.com/support>`_ and get the latest NVM/FW images.
+
+- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` 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 <linux_gsg>`.
+
+
+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_ICE_PMD`` (default ``y``)
+
+  Toggle compilation of the ``librte_pmd_ice`` driver.
+
+- ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``)
+
+  Toggle display of generic debugging messages.
+
+- ``CONFIG_RTE_LIBRTE_ICE_RX_ALLOW_BULK_ALLOC`` (default ``y``)
+
+  Toggle bulk allocation for RX.
+
+- ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``)
+
+  Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
+
+
+Driver compilation and testing
+------------------------------
+
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.
+
+
+Sample Application Notes
+------------------------
+
+Vlan filter
+~~~~~~~~~~~
+
+Vlan filter only works when Promiscuous mode is off.
+
+To start ``testpmd``, and add vlan 10 to port 0:
+
+.. code-block:: console
+
+    ./app/testpmd -l 0-15 -n 4 -- -i
+    ...
+
+    testpmd> rx_vlan add 10 0
+
+
+Limitations or Known issues
+---------------------------
+
+19.02 limitation
+~~~~~~~~~~~~~~~~
+
+Ice code released in 19.02 is for evaluation only.
+
+
+Secondary Process
+~~~~~~~~~~~~~~~~~
+Ice supports secondary process. But it does not support changing the setting
+and configuration in the secondary process.
+
+
+Promiscuous mode not supported
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+As promiscuous mode is not supported as this stage, a port can only receive the
+packets which destination MAC address is this port's own.
+
+
+TX anti-spoofing cannot be disabled
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+TX anti-spoofing is enabled by default. At this stage it's not supported to
+disable it. So any TX packet which source MAC address is not this port's own
+will be dropped by HW. It means io-fwd is not supported now. Recommand to use
+MAC-fwd for evaluation.
diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index a94fa86..c5a054b 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -54,6 +54,10 @@  New Features
      Also, make sure to start the actual text at the margin.
      =========================================================
 
+* **Added ICE net PMD**
+
+  Added the new ``ice`` net driver for Intel® Ethernet Network Adapters E810.
+  See the :doc:`../nics/ice` NIC guide for more details on this new driver.
 
 Removed Items
 -------------