From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from rcdn-iport-9.cisco.com (rcdn-iport-9.cisco.com [173.37.86.80]) by dpdk.org (Postfix) with ESMTP id 059662C6D for ; Thu, 18 May 2017 00:38:16 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=4445; q=dns/txt; s=iport; t=1495060696; x=1496270296; h=from:to:cc:subject:date:message-id:in-reply-to: references; bh=3/kzOrUiSA1gcXU3cSN9rBP81YQZXkVNuaN4FG+yJTI=; b=Ai28nXUNQI3GSv7Xt75onVMYSTWknnummN7mM5M689CsCrFrm1vuxeQs WdjyL/GWeDMWAccCKDdNLx94HGUIrnQDMeilCtSxyw+SOgnW42fRw4j7g O1/ISbXIEJhaiA2eRjdlNF6a7bJC1zFPx3rCtJHimZUwLxVqDVvHMqA4S k=; X-IronPort-AV: E=Sophos;i="5.38,356,1491264000"; d="scan'208";a="244559911" Received: from rcdn-core-11.cisco.com ([173.37.93.147]) by rcdn-iport-9.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 17 May 2017 22:38:15 +0000 Received: from cisco.com (savbu-usnic-a.cisco.com [10.193.184.48]) by rcdn-core-11.cisco.com (8.14.5/8.14.5) with ESMTP id v4HMcFnW031299; Wed, 17 May 2017 22:38:15 GMT Received: by cisco.com (Postfix, from userid 392789) id CD0D420F2003; Wed, 17 May 2017 15:38:14 -0700 (PDT) From: John Daley To: ferruh.yigit@intel.com Cc: dev@dpdk.org, John Daley Date: Wed, 17 May 2017 15:38:11 -0700 Message-Id: <20170517223811.6150-9-johndale@cisco.com> X-Mailer: git-send-email 2.12.0 In-Reply-To: <20170517223811.6150-1-johndale@cisco.com> References: <1480ef9e-a5fd-6fd9-a990-df3bed147bfc@intel.com> <20170517223811.6150-1-johndale@cisco.com> Subject: [dpdk-dev] [PATCH v4 8/8] net/enic: flow API documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 17 May 2017 22:38:17 -0000 Update enic NIC guide, release notes and add flow API to the supported features list. Signed-off-by: John Daley Reviewed-by: Nelson Escobar --- 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 ` 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 ` 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