[19/19] doc: add ICE description and update release note

Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
---
 MAINTAINERS                      |  1 +
 doc/guides/nics/features/ice.ini | 39 ++++++++++++++++++++
 doc/guides/nics/ice.rst          | 78 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 118 insertions(+)
 create mode 100644 doc/guides/nics/features/ice.ini
 create mode 100644 doc/guides/nics/ice.rst

Hi Wenzhuo

<snipped>

> 
> Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
> ---
>  MAINTAINERS                      |  1 +
>  doc/guides/nics/features/ice.ini | 39 ++++++++++++++++++++
>  doc/guides/nics/ice.rst          | 78
> ++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 118 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 00a5e03..2e1a537 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..2be52ca
> --- /dev/null
> +++ b/doc/guides/nics/features/ice.ini
> @@ -0,0 +1,39 @@
> +;
> +; 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
> +Multiprocess aware   = Y
> +BSD nic_uio          = Y
> +Linux UIO            = Y
> +Linux VFIO           = Y
> +x86-32               = Y
> +x86-64               = Y

Is all the features also supported for secondary multiprocess?

> diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst new file mode
> 100644 index 0000000..12a12d2
> --- /dev/null
> +++ b/doc/guides/nics/ice.rst
> @@ -0,0 +1,78 @@
> +..  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
> +---------------------------
> +

If there are features not supported in secondary, can you mention the same here?

> +N/A
> --
> 1.9.3

Hi, Vipin
Not all feature enabled for secondary process. We add secondary process check in each ops like below,
	
if (rte_eal_process_type() == RTE_PROC_SECONDARY)
		return -E_RTE_SECONDARY;

Qiming

-----Original Message-----
From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Varghese, Vipin
Sent: Friday, November 23, 2018 3:45 PM
To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org
Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>
Subject: Re: [dpdk-dev] [PATCH 19/19] doc: add ICE description and update release note

Hi Wenzhuo

<snipped>

> 
> Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
> ---
>  MAINTAINERS                      |  1 +
>  doc/guides/nics/features/ice.ini | 39 ++++++++++++++++++++
>  doc/guides/nics/ice.rst          | 78
> ++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 118 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 00a5e03..2e1a537 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..2be52ca
> --- /dev/null
> +++ b/doc/guides/nics/features/ice.ini
> @@ -0,0 +1,39 @@
> +;
> +; 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
> +Multiprocess aware   = Y
> +BSD nic_uio          = Y
> +Linux UIO            = Y
> +Linux VFIO           = Y
> +x86-32               = Y
> +x86-64               = Y

Is all the features also supported for secondary multiprocess?

> diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst new 
> file mode
> 100644 index 0000000..12a12d2
> --- /dev/null
> +++ b/doc/guides/nics/ice.rst
> @@ -0,0 +1,78 @@
> +..  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
> +---------------------------
> +

If there are features not supported in secondary, can you mention the same here?

> +N/A
> --
> 1.9.3

Hi Qiming,

Thanks for the update, please feel free to update the limitation in release notes which all are not supported too.

Note: do we plan to add test cases (unit) for the same?

> -----Original Message-----
> From: Yang, Qiming
> Sent: Monday, November 26, 2018 9:13 AM
> To: Varghese, Vipin <vipin.varghese@intel.com>; Lu, Wenzhuo
> <wenzhuo.lu@intel.com>; dev@dpdk.org
> Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>
> Subject: RE: [dpdk-dev] [PATCH 19/19] doc: add ICE description and update
> release note
> 
> Hi, Vipin
> Not all feature enabled for secondary process. We add secondary process check
> in each ops like below,
> 
> if (rte_eal_process_type() == RTE_PROC_SECONDARY)
> 		return -E_RTE_SECONDARY;
> 
> Qiming
> 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Varghese, Vipin
> Sent: Friday, November 23, 2018 3:45 PM
> To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org
> Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>
> Subject: Re: [dpdk-dev] [PATCH 19/19] doc: add ICE description and update
> release note
> 
> Hi Wenzhuo
> 
> <snipped>
> 
> >
> > Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
> > ---
> >  MAINTAINERS                      |  1 +
> >  doc/guides/nics/features/ice.ini | 39 ++++++++++++++++++++
> >  doc/guides/nics/ice.rst          | 78
> > ++++++++++++++++++++++++++++++++++++++++
> >  3 files changed, 118 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 00a5e03..2e1a537 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..2be52ca
> > --- /dev/null
> > +++ b/doc/guides/nics/features/ice.ini
> > @@ -0,0 +1,39 @@
> > +;
> > +; 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
> > +Multiprocess aware   = Y
> > +BSD nic_uio          = Y
> > +Linux UIO            = Y
> > +Linux VFIO           = Y
> > +x86-32               = Y
> > +x86-64               = Y
> 
> Is all the features also supported for secondary multiprocess?
> 
> > diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst new
> > file mode
> > 100644 index 0000000..12a12d2
> > --- /dev/null
> > +++ b/doc/guides/nics/ice.rst
> > @@ -0,0 +1,78 @@
> > +..  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
> > +---------------------------
> > +
> 
> If there are features not supported in secondary, can you mention the same
> here?
> 
> > +N/A
> > --
> > 1.9.3