From: John Daley <johndale@cisco.com>
To: ferruh.yigit@intel.com
Cc: dev@dpdk.org, John Daley <johndale@cisco.com>
Subject: [dpdk-dev] [PATCH v4 8/8] net/enic: flow API documentation
Date: Wed, 17 May 2017 15:38:11 -0700 [thread overview]
Message-ID: <20170517223811.6150-9-johndale@cisco.com> (raw)
In-Reply-To: <20170517223811.6150-1-johndale@cisco.com>
Update enic NIC guide, release notes and add flow API to the
supported features list.
Signed-off-by: John Daley <johndale@cisco.com>
Reviewed-by: Nelson Escobar <neescoba@cisco.com>
---
doc/guides/nics/enic.rst | 52 ++++++++++++++++++++++++++++++++++
doc/guides/nics/features/enic.ini | 1 +
doc/guides/rel_notes/release_17_08.rst | 6 ++++
3 files changed, 59 insertions(+)
diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst
index 89a301585..cb5ae1250 100644
--- a/doc/guides/nics/enic.rst
+++ b/doc/guides/nics/enic.rst
@@ -213,6 +213,45 @@ or ``vfio`` in non-IOMMU mode.
Please see :ref:`Limitations <enic_limitations>` for limitations in
the use of SR-IOV.
+.. _enic-genic-flow-api:
+
+Generic Flow API support
+------------------------
+
+Generic Flow API is supported. The baseline support is:
+
+- **1200 series VICs**
+
+ 5-tuple exact Flow support for 1200 series adapters. This allows:
+
+ - Attributes: ingress
+ - Items: ipv4, ipv6, udp, tcp (must exactly match src/dst IP
+ addresses and ports and all must be specified).
+ - Actions: queue and void
+ - Selectors: 'is'
+
+- **1300 series VICS with Advanced filters disabled**
+
+ With advanced filters disabled, an IPv4 or IPv6 item must be specified
+ in the pattern.
+
+ - Attributes: ingress
+ - Items: eth, ipv4, ipv6, udp, tcp, vxlan, inner eth, ipv4, ipv6, udp, tcp
+ - Actions: queue and void
+ - Selectors: 'is', 'spec' and 'mask'. 'last' is not supported
+ - In total, up to 64 bytes of mask is allowed across all haeders
+
+- **1300 series VICS with Advanced filters enabled**
+
+ - Attributes: ingress
+ - Items: eth, ipv4, ipv6, udp, tcp, vxlan, inner eth, ipv4, ipv6, udp, tcp
+ - Actions: queue, mark, flag and void
+ - Selectors: 'is', 'spec' and 'mask'. 'last' is not supported
+ - In total, up to 64 bytes of mask is allowed across all haeders
+
+More features may be added in future firmware and new versions of the VIC.
+Please refer to the release notes.
+
.. _enic_limitations:
Limitations
@@ -260,9 +299,21 @@ Limitations
- The number of SR-IOV devices is limited to 256. Components on target system
might limit this number to fewer than 256.
+- **Flow API**
+
+ - The number of filters that can be specified with the Generic Flow API is
+ dependent on how many header fields are being masked. Use 'flow create' in
+ a loop to determine how many filters your VIC will support (not more than
+ 1000 for 1300 series VICs). Filter are checked for matching in the order they
+ were added. Since there currently is no grouping or priority support,
+ 'catch-all' filters should be added last.
+
How to build the suite
----------------------
+The build instructions for the DPDK suite should be followed. By default
+the ENIC PMD library will be built into the DPDK library.
+
Refer to the document :ref:`compiling and testing a PMD for a NIC
<pmd_build_and_test>` for details.
@@ -313,6 +364,7 @@ Supported features
- Scattered Rx
- MTU update
- SR-IOV on UCS managed servers connected to Fabric Interconnects.
+- Flow API
Known bugs and unsupported features in this release
---------------------------------------------------
diff --git a/doc/guides/nics/features/enic.ini b/doc/guides/nics/features/enic.ini
index 94e7f3cba..0de3ef53c 100644
--- a/doc/guides/nics/features/enic.ini
+++ b/doc/guides/nics/features/enic.ini
@@ -20,6 +20,7 @@ VLAN filter = Y
CRC offload = Y
VLAN offload = Y
Flow director = Y
+Flow API = Y
L3 checksum offload = Y
L4 checksum offload = Y
Packet type parsing = Y
diff --git a/doc/guides/rel_notes/release_17_08.rst b/doc/guides/rel_notes/release_17_08.rst
index 74aae10f7..e3a920438 100644
--- a/doc/guides/rel_notes/release_17_08.rst
+++ b/doc/guides/rel_notes/release_17_08.rst
@@ -41,6 +41,12 @@ New Features
Also, make sure to start the actual text at the margin.
=========================================================
+* **Added Generic Flow API support to enic.**
+
+ Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
+ and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
+ MARK, FLAG and VOID actions for ingress traffic.
+
Resolved Issues
---------------
--
2.12.0
next prev parent reply other threads:[~2017-05-17 22:38 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-30 21:28 [dpdk-dev] [PATCH 1/6] net/enic: bring NIC interface functions up to date John Daley
2017-03-30 21:28 ` [dpdk-dev] [PATCH 2/6] net/enic: flow API skeleton John Daley
2017-03-30 21:28 ` [dpdk-dev] [PATCH 3/6] net/enic: flow API for NICs with advanced filters enabled John Daley
2017-03-30 21:28 ` [dpdk-dev] [PATCH 4/6] net/enic: flow API for NICs with advanced filters disabled John Daley
2017-03-30 21:28 ` [dpdk-dev] [PATCH 5/6] net/enic: flow API support for Legacy NICs John Daley
2017-03-30 21:28 ` [dpdk-dev] [PATCH 6/6] net/enic: flow API debug John Daley
2017-03-31 2:06 ` [dpdk-dev] [PATCH v2 0/7] *** flow API support for enic *** John Daley
2017-03-31 2:06 ` [dpdk-dev] [PATCH v2 1/7] net/enic: bring NIC interface functions up to date John Daley
2017-03-31 2:06 ` [dpdk-dev] [PATCH v2 2/7] net/enic: flow API skeleton John Daley
2017-03-31 2:06 ` [dpdk-dev] [PATCH v2 3/7] net/enic: flow API for NICs with advanced filters enabled John Daley
2017-03-31 2:06 ` [dpdk-dev] [PATCH v2 4/7] net/enic: flow API for NICs with advanced filters disabled John Daley
2017-03-31 2:06 ` [dpdk-dev] [PATCH v2 5/7] net/enic: flow API for Legacy NICs John Daley
2017-03-31 2:06 ` [dpdk-dev] [PATCH v2 6/7] net/enic: flow API debug John Daley
2017-03-31 2:06 ` [dpdk-dev] [PATCH v2 7/7] net/enic: flow API documentation John Daley
2017-04-02 15:18 ` Mcnamara, John
2017-05-12 12:11 ` Ferruh Yigit
2017-05-17 3:03 ` [dpdk-dev] [PATCH v3 0/6] enic flow api support John Daley
2017-05-17 3:03 ` [dpdk-dev] [PATCH v3 1/6] net/enic: flow API skeleton John Daley
2017-05-17 11:12 ` Ferruh Yigit
2017-05-17 3:03 ` [dpdk-dev] [PATCH v3 2/6] net/enic: flow API for NICs with advanced filters enabled John Daley
2017-05-17 11:12 ` Ferruh Yigit
2017-05-17 3:03 ` [dpdk-dev] [PATCH v3 3/6] net/enic: flow API for NICs with advanced filters disabled John Daley
2017-05-17 11:13 ` Ferruh Yigit
2017-05-17 3:03 ` [dpdk-dev] [PATCH v3 4/6] net/enic: flow API for Legacy NICs John Daley
2017-05-17 3:03 ` [dpdk-dev] [PATCH v3 5/6] net/enic: flow API debug John Daley
2017-05-17 3:03 ` [dpdk-dev] [PATCH v3 6/6] net/enic: flow API documentation John Daley
2017-05-17 11:13 ` Ferruh Yigit
2017-05-17 22:38 ` [dpdk-dev] [PATCH v4 0/8] enic flow api support John Daley
2017-05-17 22:38 ` [dpdk-dev] [PATCH v4 1/8] net/enic: bring NIC interface functions up to date John Daley
2017-05-22 9:49 ` Ferruh Yigit
2017-06-08 10:44 ` Jerin Jacob
2017-05-17 22:38 ` [dpdk-dev] [PATCH v4 2/8] net/enic: flow API skeleton John Daley
2017-05-17 22:38 ` [dpdk-dev] [PATCH v4 3/8] net/enic: flow API for NICs with advanced filters enabled John Daley
2017-05-17 22:38 ` [dpdk-dev] [PATCH v4 4/8] net/enic: flow API mark and flag support John Daley
2017-05-17 22:38 ` [dpdk-dev] [PATCH v4 5/8] net/enic: flow API for NICs with advanced filters disabled John Daley
2017-05-17 22:38 ` [dpdk-dev] [PATCH v4 6/8] net/enic: flow API for Legacy NICs John Daley
2017-05-17 22:38 ` [dpdk-dev] [PATCH v4 7/8] net/enic: flow API debug John Daley
2017-05-17 22:38 ` John Daley [this message]
2017-05-22 10:05 ` [dpdk-dev] [PATCH v4 0/8] enic flow api support Ferruh Yigit
2017-05-17 11:12 ` [dpdk-dev] [PATCH v3 0/6] " Ferruh Yigit
2017-03-31 10:12 ` [dpdk-dev] [PATCH 1/6] net/enic: bring NIC interface functions up to date Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170517223811.6150-9-johndale@cisco.com \
--to=johndale@cisco.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).