Patchwork [dpdk-dev,v2,19/20] doc: add ICE description and update release note

login
register
mail settings
Submitter Wenzhuo Lu
Date Dec. 3, 2018, 7:07 a.m.
Message ID <1543820821-108122-20-git-send-email-wenzhuo.lu@intel.com>
Download mbox | patch
Permalink /patch/670221/
State New
Headers show

Comments

Wenzhuo Lu - Dec. 3, 2018, 7:07 a.m.
Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
---
 MAINTAINERS                            |  1 +
 doc/guides/nics/features/ice.ini       | 39 +++++++++++++++
 doc/guides/nics/ice.rst                | 87 ++++++++++++++++++++++++++++++++++
 doc/guides/rel_notes/release_19_02.rst |  4 ++
 4 files changed, 131 insertions(+)
 create mode 100644 doc/guides/nics/features/ice.ini
 create mode 100644 doc/guides/nics/ice.rst
Varghese, Vipin - Dec. 3, 2018, 8:15 a.m.
Hi,

Thanks for adding details for secondary multi process in limitations section, even though the API were expected. 

> -----Original Message-----

> From: dev <dev-bounces@dpdk.org> On Behalf Of Wenzhuo Lu

> Sent: Monday, December 3, 2018 12:37 PM

> To: dev@dpdk.org

> Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>

> Subject: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and update

> release note

> 

> Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>

> ---


Do not we have to add change details like

V2:
 - updated the limitation sections
 - removed section etc?

Snipped

> +[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


Do we support Traffic Manager and Inline Crypto? If not, can we add this also to limitations?

> +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 cross compile for ARM and PPC disabled since it uses Intel specific ISA? Should this be added to limitations?


Snipped

> +

> +Config File Options

> +~~~~~~~~~~~~~~~~~~~

> +

> +The following options can be modified in the ``config`` file.

> +Please note that enabling debugging options may affect system performance.


Do we see real performance variance? If yes, can we highlight this in info section?

snipped
Wenzhuo Lu - Dec. 5, 2018, 6:54 a.m.
Hi Vipin,


> -----Original Message-----

> From: Varghese, Vipin

> Sent: Monday, December 3, 2018 4:15 PM

> To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org

> Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>

> Subject: RE: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and

> update release note

> 

> Hi,

> 

> Thanks for adding details for secondary multi process in limitations section,

> even though the API were expected.

> 

> > -----Original Message-----

> > From: dev <dev-bounces@dpdk.org> On Behalf Of Wenzhuo Lu

> > Sent: Monday, December 3, 2018 12:37 PM

> > To: dev@dpdk.org

> > Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>

> > Subject: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and

> > update release note

> >

> > Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>

> > ---

> 

> Do not we have to add change details like

> 

> V2:

>  - updated the limitation sections

>  - removed section etc?

Good suggestion, thanks. I can add that in the next version.

> 

> Snipped

> 

> > +[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

> 

> Do we support Traffic Manager and Inline Crypto? If not, can we add this

> also to limitations?

The style is only listed supported features here. I don't think we'll list everything not supported as limitation.
The same below.

> 

> > +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 cross compile for ARM and PPC disabled since it uses Intel specific ISA?

> Should this be added to limitations?

> 

> 

> Snipped

> 

> > +

> > +Config File Options

> > +~~~~~~~~~~~~~~~~~~~

> > +

> > +The following options can be modified in the ``config`` file.

> > +Please note that enabling debugging options may affect system

> performance.

> 

> Do we see real performance variance? If yes, can we highlight this in info

> section?

IMH, we could get different numbers because of different scenarios. It's only a reminder to not enable debug.

> 

> snipped
Varghese, Vipin - Dec. 6, 2018, 4:34 a.m.
Thanks Wenzhuo

snipped
> >

> > Do we support Traffic Manager and Inline Crypto? If not, can we add

> > this also to limitations?

> The style is only listed supported features here. I don't think we'll list everything

> not supported as limitation.

Thanks for the correction in format, hence the suggested action item is update limitation section to state what is not supported. 

> The same below.

> 

> >

> > > +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 cross compile for ARM and PPC disabled since it uses Intel specific ISA?

> > Should this be added to limitations?

Is powerpc and arm cross build with non avx and sse ISA supported? If no, will default '.config' has 'ICE_PMD=n'?

> >

> >

> > Snipped

> >

> > > +

> > > +Config File Options

> > > +~~~~~~~~~~~~~~~~~~~

> > > +

> > > +The following options can be modified in the ``config`` file.

> > > +Please note that enabling debugging options may affect system

> > performance.

> >

> > Do we see real performance variance? If yes, can we highlight this in

> > info section?

> IMH, we could get different numbers because of different scenarios. It's only a

> reminder to not enable debug.

Thanks, but then wording should 'Note: enabling debug option for ICE will have difference in performance. Hence recommendation is not to enable unless for debugging the ICE PMD.'
> 

> >

> > snipped
Wenzhuo Lu - Dec. 6, 2018, 6:05 a.m.
Hi Vipin,


> -----Original Message-----

> From: Varghese, Vipin

> Sent: Thursday, December 6, 2018 12:34 PM

> To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org

> Subject: RE: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and

> update release note

> 

> Thanks Wenzhuo

> 

> snipped

> > >

> > > Do we support Traffic Manager and Inline Crypto? If not, can we add

> > > this also to limitations?

> > The style is only listed supported features here. I don't think we'll

> > list everything not supported as limitation.

> Thanks for the correction in format, hence the suggested action item is

> update limitation section to state what is not supported.

> 

> > The same below.

> >

> > >

> > > > +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 cross compile for ARM and PPC disabled since it uses Intel specific ISA?

> > > Should this be added to limitations?

> Is powerpc and arm cross build with non avx and sse ISA supported? If no,

> will default '.config' has 'ICE_PMD=n'?

Yes, it should be. Currently at least all the Intel NICs set 'y' here. If any problem, we should handle it as bug.

> 

> > >

> > >

> > > Snipped

> > >

> > > > +

> > > > +Config File Options

> > > > +~~~~~~~~~~~~~~~~~~~

> > > > +

> > > > +The following options can be modified in the ``config`` file.

> > > > +Please note that enabling debugging options may affect system

> > > performance.

> > >

> > > Do we see real performance variance? If yes, can we highlight this

> > > in info section?

> > IMH, we could get different numbers because of different scenarios.

> > It's only a reminder to not enable debug.

> Thanks, but then wording should 'Note: enabling debug option for ICE will

> have difference in performance. Hence recommendation is not to enable

> unless for debugging the ICE PMD.'

> >

> > >

> > > snipped
Varghese, Vipin - Dec. 6, 2018, 6:08 a.m.
> -----Original Message-----

> From: Lu, Wenzhuo

> Sent: Thursday, December 6, 2018 11:36 AM

> To: Varghese, Vipin <vipin.varghese@intel.com>; dev@dpdk.org

> Subject: RE: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and update

> release note

> 

> Hi Vipin,

> 

> 

> > -----Original Message-----

> > From: Varghese, Vipin

> > Sent: Thursday, December 6, 2018 12:34 PM

> > To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org

> > Subject: RE: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and

> > update release note

> >

> > Thanks Wenzhuo

> >

> > snipped

> > > >

> > > > Do we support Traffic Manager and Inline Crypto? If not, can we

> > > > add this also to limitations?

> > > The style is only listed supported features here. I don't think

> > > we'll list everything not supported as limitation.

> > Thanks for the correction in format, hence the suggested action item

> > is update limitation section to state what is not supported.

> >

> > > The same below.

> > >

> > > >

> > > > > +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 cross compile for ARM and PPC disabled since it uses Intel specific ISA?

> > > > Should this be added to limitations?

> > Is powerpc and arm cross build with non avx and sse ISA supported? If

> > no, will default '.config' has 'ICE_PMD=n'?

> Yes, it should be. Currently at least all the Intel NICs set 'y' here. If any problem,

> we should handle it as bug.

So my understanding from 'yes' is ICE_DSI PMD is having minimum scalar functions which is cross build successful for ARM and powerpc. Hence you are leaving it as '=y' like other NIC. 

If above is true, why is arm and PowerPC not added to your documentation?

> 

> >

> > > >

> > > >

> > > > Snipped

> > > >

> > > > > +

> > > > > +Config File Options

> > > > > +~~~~~~~~~~~~~~~~~~~

> > > > > +

> > > > > +The following options can be modified in the ``config`` file.

> > > > > +Please note that enabling debugging options may affect system

> > > > performance.

> > > >

> > > > Do we see real performance variance? If yes, can we highlight this

> > > > in info section?

> > > IMH, we could get different numbers because of different scenarios.

> > > It's only a reminder to not enable debug.

> > Thanks, but then wording should 'Note: enabling debug option for ICE

> > will have difference in performance. Hence recommendation is not to

> > enable unless for debugging the ICE PMD.'

> > >

> > > >

> > > > snipped
Wenzhuo Lu - Dec. 6, 2018, 6:23 a.m.
Hi Vipin,


> -----Original Message-----

> From: Varghese, Vipin

> Sent: Thursday, December 6, 2018 2:09 PM

> To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org

> Subject: RE: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and

> update release note

> 

> 

> 

> > -----Original Message-----

> > From: Lu, Wenzhuo

> > Sent: Thursday, December 6, 2018 11:36 AM

> > To: Varghese, Vipin <vipin.varghese@intel.com>; dev@dpdk.org

> > Subject: RE: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and

> > update release note

> >

> > Hi Vipin,

> >

> >

> > > -----Original Message-----

> > > From: Varghese, Vipin

> > > Sent: Thursday, December 6, 2018 12:34 PM

> > > To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org

> > > Subject: RE: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description

> > > and update release note

> > >

> > > Thanks Wenzhuo

> > >

> > > snipped

> > > > >

> > > > > Do we support Traffic Manager and Inline Crypto? If not, can we

> > > > > add this also to limitations?

> > > > The style is only listed supported features here. I don't think

> > > > we'll list everything not supported as limitation.

> > > Thanks for the correction in format, hence the suggested action item

> > > is update limitation section to state what is not supported.

> > >

> > > > The same below.

> > > >

> > > > >

> > > > > > +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 cross compile for ARM and PPC disabled since it uses Intel specific

> ISA?

> > > > > Should this be added to limitations?

> > > Is powerpc and arm cross build with non avx and sse ISA supported?

> > > If no, will default '.config' has 'ICE_PMD=n'?

> > Yes, it should be. Currently at least all the Intel NICs set 'y' here.

> > If any problem, we should handle it as bug.

> So my understanding from 'yes' is ICE_DSI PMD is having minimum scalar

> functions which is cross build successful for ARM and powerpc. Hence you

> are leaving it as '=y' like other NIC.

> 

> If above is true, why is arm and PowerPC not added to your documentation?

It's a good question. If you check the history, you'll find the arm and powerpc support is updated by the arm and powerpc maintainers. It means ideally we believe it supports these platforms, but we don't have any of these platform to confirm that.

> 

> >

> > >

> > > > >

> > > > >

> > > > > Snipped

> > > > >

> > > > > > +

> > > > > > +Config File Options

> > > > > > +~~~~~~~~~~~~~~~~~~~

> > > > > > +

> > > > > > +The following options can be modified in the ``config`` file.

> > > > > > +Please note that enabling debugging options may affect system

> > > > > performance.

> > > > >

> > > > > Do we see real performance variance? If yes, can we highlight

> > > > > this in info section?

> > > > IMH, we could get different numbers because of different scenarios.

> > > > It's only a reminder to not enable debug.

> > > Thanks, but then wording should 'Note: enabling debug option for ICE

> > > will have difference in performance. Hence recommendation is not to

> > > enable unless for debugging the ICE PMD.'

> > > >

> > > > >

> > > > > snipped
Varghese, Vipin - Dec. 6, 2018, 6:25 a.m.
snipped
> > > > Thanks Wenzhuo

> > > >

> > > > snipped

> > > > > >

> > > > > > Do we support Traffic Manager and Inline Crypto? If not, can

> > > > > > we add this also to limitations?

> > > > > The style is only listed supported features here. I don't think

> > > > > we'll list everything not supported as limitation.

> > > > Thanks for the correction in format, hence the suggested action

> > > > item is update limitation section to state what is not supported.

> > > >

> > > > > The same below.

> > > > >

> > > > > >

> > > > > > > +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 cross compile for ARM and PPC disabled since it uses Intel

> > > > > > specific

> > ISA?

> > > > > > Should this be added to limitations?

> > > > Is powerpc and arm cross build with non avx and sse ISA supported?

> > > > If no, will default '.config' has 'ICE_PMD=n'?

> > > Yes, it should be. Currently at least all the Intel NICs set 'y' here.

> > > If any problem, we should handle it as bug.

> > So my understanding from 'yes' is ICE_DSI PMD is having minimum scalar

> > functions which is cross build successful for ARM and powerpc. Hence

> > you are leaving it as '=y' like other NIC.

> >

> > If above is true, why is arm and PowerPC not added to your documentation?

> It's a good question. If you check the history, you'll find the arm and powerpc

> support is updated by the arm and powerpc maintainers. It means ideally we

> believe it supports these platforms, but we don't have any of these platform to

> confirm that.

Perfect, please add the right team members in 'to' so they can update the same.

> 

> >

> > >

> > > >

> > > > > >

> > > > > >

> > > > > > Snipped

> > > > > >

> > > > > > > +

> > > > > > > +Config File Options

> > > > > > > +~~~~~~~~~~~~~~~~~~~

> > > > > > > +

> > > > > > > +The following options can be modified in the ``config`` file.

> > > > > > > +Please note that enabling debugging options may affect

> > > > > > > +system

> > > > > > performance.

> > > > > >

> > > > > > Do we see real performance variance? If yes, can we highlight

> > > > > > this in info section?

> > > > > IMH, we could get different numbers because of different scenarios.

> > > > > It's only a reminder to not enable debug.

> > > > Thanks, but then wording should 'Note: enabling debug option for

> > > > ICE will have difference in performance. Hence recommendation is

> > > > not to enable unless for debugging the ICE PMD.'

> > > > >

> > > > > >

> > > > > > snipped
Wenzhuo Lu - Dec. 6, 2018, 6:35 a.m.
Hi Vipin,


> -----Original Message-----

> From: Varghese, Vipin

> Sent: Thursday, December 6, 2018 2:26 PM

> To: Lu, Wenzhuo <wenzhuo.lu@intel.com>; dev@dpdk.org

> Subject: RE: [dpdk-dev] [PATCH v2 19/20] doc: add ICE description and

> update release note

> 

> snipped

> > > > > Thanks Wenzhuo

> > > > >

> > > > > snipped

> > > > > > >

> > > > > > > Do we support Traffic Manager and Inline Crypto? If not, can

> > > > > > > we add this also to limitations?

> > > > > > The style is only listed supported features here. I don't

> > > > > > think we'll list everything not supported as limitation.

> > > > > Thanks for the correction in format, hence the suggested action

> > > > > item is update limitation section to state what is not supported.

> > > > >

> > > > > > The same below.

> > > > > >

> > > > > > >

> > > > > > > > +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 cross compile for ARM and PPC disabled since it uses

> > > > > > > Intel specific

> > > ISA?

> > > > > > > Should this be added to limitations?

> > > > > Is powerpc and arm cross build with non avx and sse ISA supported?

> > > > > If no, will default '.config' has 'ICE_PMD=n'?

> > > > Yes, it should be. Currently at least all the Intel NICs set 'y' here.

> > > > If any problem, we should handle it as bug.

> > > So my understanding from 'yes' is ICE_DSI PMD is having minimum

> > > scalar functions which is cross build successful for ARM and

> > > powerpc. Hence you are leaving it as '=y' like other NIC.

> > >

> > > If above is true, why is arm and PowerPC not added to your

> documentation?

> > It's a good question. If you check the history, you'll find the arm

> > and powerpc support is updated by the arm and powerpc maintainers. It

> > means ideally we believe it supports these platforms, but we don't

> > have any of these platform to confirm that.

> Perfect, please add the right team members in 'to' so they can update the

> same.

Good suggestion. I'll cc them when sending the new version. But we cannot expect there's a quick update because ice is a new device.

> 

> >

> > >

> > > >

> > > > >

> > > > > > >

> > > > > > >

> > > > > > > Snipped

> > > > > > >

> > > > > > > > +

> > > > > > > > +Config File Options

> > > > > > > > +~~~~~~~~~~~~~~~~~~~

> > > > > > > > +

> > > > > > > > +The following options can be modified in the ``config`` file.

> > > > > > > > +Please note that enabling debugging options may affect

> > > > > > > > +system

> > > > > > > performance.

> > > > > > >

> > > > > > > Do we see real performance variance? If yes, can we

> > > > > > > highlight this in info section?

> > > > > > IMH, we could get different numbers because of different scenarios.

> > > > > > It's only a reminder to not enable debug.

> > > > > Thanks, but then wording should 'Note: enabling debug option for

> > > > > ICE will have difference in performance. Hence recommendation is

> > > > > not to enable unless for debugging the ICE PMD.'

> > > > > >

> > > > > > >

> > > > > > > snipped

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