[v5] ethdev: add HIGIG2 key field to flow API
diff mbox series

Message ID 20191018041300.22290-1-kirankumark@marvell.com
State Superseded, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • [v5] ethdev: add HIGIG2 key field to flow API
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-compilation success Compile Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

Kiran Kumar Kokkilagadda Oct. 18, 2019, 4:13 a.m. UTC
From: Kiran Kumar K <kirankumark@marvell.com>

Add new rte_flow_item_higig2_hdr in order to match higig2 header.
It is a layer 2.5 protocol and used in Broadcom switches.
Header format is based on the following document.
http://read.pudn.com/downloads558/doc/comm/2301468/HiGig_protocol.pdf

Signed-off-by: Kiran Kumar K <kirankumark@marvell.com>
---
V5 changes:
* Changed broadcom to Broadcom
* Changed RTE_HIGIG2_H to RTE_HIGIG_H
* Fixed meson build

V4 Changes:
* Removed packed attribute

V3 Changes:
* Fixed Copyright header
* Fixed version info in the subject

V2 Changes:
* Added support in testpmd to parse the higig2 item
* Moved the higig2 header to new file
* Added indentation in doc

 app/test-pmd/cmdline_flow.c        |  33 +++++++
 doc/guides/prog_guide/rte_flow.rst |   8 ++
 lib/librte_ethdev/rte_flow.c       |   1 +
 lib/librte_ethdev/rte_flow.h       |   7 ++
 lib/librte_net/Makefile            |   2 +-
 lib/librte_net/meson.build         |   3 +-
 lib/librte_net/rte_higig.h         | 138 +++++++++++++++++++++++++++++
 7 files changed, 190 insertions(+), 2 deletions(-)
 create mode 100644 lib/librte_net/rte_higig.h

--
2.17.1

Comments

Andrew Rybchenko Oct. 18, 2019, 7:36 a.m. UTC | #1
On 10/18/19 7:13 AM, kirankumark@marvell.com wrote:
> From: Kiran Kumar K <kirankumark@marvell.com>
>
> Add new rte_flow_item_higig2_hdr in order to match higig2 header.
> It is a layer 2.5 protocol and used in Broadcom switches.
> Header format is based on the following document.
> http://read.pudn.com/downloads558/doc/comm/2301468/HiGig_protocol.pdf
>
> Signed-off-by: Kiran Kumar K <kirankumark@marvell.com>

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Yigit, Ferruh Oct. 18, 2019, 5:36 p.m. UTC | #2
On 10/18/2019 5:13 AM, kirankumark@marvell.com wrote:
> From: Kiran Kumar K <kirankumark@marvell.com>
> 
> Add new rte_flow_item_higig2_hdr in order to match higig2 header.
> It is a layer 2.5 protocol and used in Broadcom switches.
> Header format is based on the following document.
> http://read.pudn.com/downloads558/doc/comm/2301468/HiGig_protocol.pdf

+1 to have protocol documentation, but what is 'pudn.com'? Is it kind of
download site? Isn't there any official web site for the protocol?

> 
> Signed-off-by: Kiran Kumar K <kirankumark@marvell.com>
> ---
> V5 changes:
> * Changed broadcom to Broadcom
> * Changed RTE_HIGIG2_H to RTE_HIGIG_H
> * Fixed meson build
> 
> V4 Changes:
> * Removed packed attribute
> 
> V3 Changes:
> * Fixed Copyright header
> * Fixed version info in the subject
> 
> V2 Changes:
> * Added support in testpmd to parse the higig2 item
> * Moved the higig2 header to new file
> * Added indentation in doc
> 
>  app/test-pmd/cmdline_flow.c        |  33 +++++++
>  doc/guides/prog_guide/rte_flow.rst |   8 ++
>  lib/librte_ethdev/rte_flow.c       |   1 +
>  lib/librte_ethdev/rte_flow.h       |   7 ++
>  lib/librte_net/Makefile            |   2 +-
>  lib/librte_net/meson.build         |   3 +-
>  lib/librte_net/rte_higig.h         | 138 +++++++++++++++++++++++++++++

'lib/librte_net/' maintainer is Olivier, so by default new file maintainer will
be Olivier, it is good to get his ack to confirm this before merging patch.

Also can you please update "doc/api/doxy-api-index.md" to add new 'rte_higig.h'
file so that it can be part of our API documentation.

btw, 'rte_gre.h' & 'rte_mpls.h' are seems missing in API documentation, another
patch to add them would be nice if possible.
Kiran Kumar Kokkilagadda Oct. 19, 2019, 4:51 a.m. UTC | #3
> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@intel.com>
> Sent: Friday, October 18, 2019 11:06 PM
> To: Kiran Kumar Kokkilagadda <kirankumark@marvell.com>; Adrien Mazarguil
> <adrien.mazarguil@6wind.com>; Wenzhuo Lu <wenzhuo.lu@intel.com>;
> Jingjing Wu <jingjing.wu@intel.com>; Bernard Iremonger
> <bernard.iremonger@intel.com>; John McNamara
> <john.mcnamara@intel.com>; Marko Kovacevic <marko.kovacevic@intel.com>;
> Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <arybchenko@solarflare.com>; Olivier Matz <olivier.matz@6wind.com>
> Cc: dev@dpdk.org; ajit.khaparde@broadcom.com
> Subject: [EXT] Re: [dpdk-dev] [PATCH v5] ethdev: add HIGIG2 key field to flow
> API
> 
> External Email
> 
> ----------------------------------------------------------------------
> On 10/18/2019 5:13 AM, kirankumark@marvell.com wrote:
> 
> > From: Kiran Kumar K <kirankumark@marvell.com>
> 
> >
> 
> > Add new rte_flow_item_higig2_hdr in order to match higig2 header.
> 
> > It is a layer 2.5 protocol and used in Broadcom switches.
> 
> > Header format is based on the following document.
> 
> > https://urldefense.proofpoint.com/v2/url?u=http-
> 3A__read.pudn.com_downloads558_doc_comm_2301468_HiGig-
> 5Fprotocol.pdf&d=DwIDaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=owEKckYY4FTmil
> 1Z6oBURwkTThyuRbLAY9LdfiaT6HA&m=QfogB8qcVeClwPxCAkPab3S-
> eGGVwAH1QH3LGdaNa4U&s=8ADdrFBPBhaij7nUt6QRpmlHoVBc2sPtE8egdS58d
> w8&e=
> 
> 
> 
> +1 to have protocol documentation, but what is 'pudn.com'? Is it kind of
> 
> download site? Isn't there any official web site for the protocol?
> 
> 
There is no official doc available for this protocol. This is the only place we find the public doc.
> 
> >
> 
> > Signed-off-by: Kiran Kumar K <kirankumark@marvell.com>
> 
> > ---
> 
> > V5 changes:
> 
> > * Changed broadcom to Broadcom
> 
> > * Changed RTE_HIGIG2_H to RTE_HIGIG_H
> 
> > * Fixed meson build
> 
> >
> 
> > V4 Changes:
> 
> > * Removed packed attribute
> 
> >
> 
> > V3 Changes:
> 
> > * Fixed Copyright header
> 
> > * Fixed version info in the subject
> 
> >
> 
> > V2 Changes:
> 
> > * Added support in testpmd to parse the higig2 item
> 
> > * Moved the higig2 header to new file
> 
> > * Added indentation in doc
> 
> >
> 
> >  app/test-pmd/cmdline_flow.c        |  33 +++++++
> 
> >  doc/guides/prog_guide/rte_flow.rst |   8 ++
> 
> >  lib/librte_ethdev/rte_flow.c       |   1 +
> 
> >  lib/librte_ethdev/rte_flow.h       |   7 ++
> 
> >  lib/librte_net/Makefile            |   2 +-
> 
> >  lib/librte_net/meson.build         |   3 +-
> 
> >  lib/librte_net/rte_higig.h         | 138 +++++++++++++++++++++++++++++
> 
> 
> 
> 'lib/librte_net/' maintainer is Olivier, so by default new file maintainer will
> 
> be Olivier, it is good to get his ack to confirm this before merging patch.
> 
> 
> 
> Also can you please update "doc/api/doxy-api-index.md" to add new
> 'rte_higig.h'
> 
> file so that it can be part of our API documentation.
> 
Will update and send v6.
> 
> 
> btw, 'rte_gre.h' & 'rte_mpls.h' are seems missing in API documentation, another
> 
> patch to add them would be nice if possible.

Patch
diff mbox series

diff --git a/app/test-pmd/cmdline_flow.c b/app/test-pmd/cmdline_flow.c
index b26b8bfe2..8d6c354fa 100644
--- a/app/test-pmd/cmdline_flow.c
+++ b/app/test-pmd/cmdline_flow.c
@@ -203,6 +203,9 @@  enum index {
 	ITEM_PPPOED,
 	ITEM_PPPOE_SEID,
 	ITEM_PPPOE_PROTO_ID,
+	ITEM_HIGIG2,
+	ITEM_HIGIG2_CLASSIFICATION,
+	ITEM_HIGIG2_VID,

 	/* Validate/create actions. */
 	ACTIONS,
@@ -675,6 +678,7 @@  static const enum index next_item[] = {
 	ITEM_PPPOES,
 	ITEM_PPPOED,
 	ITEM_PPPOE_PROTO_ID,
+	ITEM_HIGIG2,
 	END_SET,
 	ZERO,
 };
@@ -939,6 +943,13 @@  static const enum index item_pppoe_proto_id[] = {
 	ZERO,
 };

+static const enum index item_higig2[] = {
+	ITEM_HIGIG2_CLASSIFICATION,
+	ITEM_HIGIG2_VID,
+	ITEM_NEXT,
+	ZERO,
+};
+
 static const enum index next_action[] = {
 	ACTION_END,
 	ACTION_VOID,
@@ -2419,6 +2430,28 @@  static const struct token token_list[] = {
 		.next = NEXT(item_pppoe_proto_id),
 		.call = parse_vc,
 	},
+	[ITEM_HIGIG2] = {
+		.name = "higig2",
+		.help = "matches higig2 header",
+		.priv = PRIV_ITEM(HIGIG2,
+				sizeof(struct rte_flow_item_higig2_hdr)),
+		.next = NEXT(item_higig2),
+		.call = parse_vc,
+	},
+	[ITEM_HIGIG2_CLASSIFICATION] = {
+		.name = "classification",
+		.help = "matches classification of higig2 header",
+		.next = NEXT(item_higig2, NEXT_ENTRY(UNSIGNED), item_param),
+		.args = ARGS(ARGS_ENTRY_HTON(struct rte_flow_item_higig2_hdr,
+					ppt1.classification)),
+	},
+	[ITEM_HIGIG2_VID] = {
+		.name = "vid",
+		.help = "matches vid of higig2 header",
+		.next = NEXT(item_higig2, NEXT_ENTRY(UNSIGNED), item_param),
+		.args = ARGS(ARGS_ENTRY_HTON(struct rte_flow_item_higig2_hdr,
+					ppt1.vid)),
+	},
 	/* Validate/create actions. */
 	[ACTIONS] = {
 		.name = "actions",
diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 1c837ff13..6e6d44df2 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -1289,6 +1289,14 @@  Matches a IP Authentication Header (RFC 4302).
 - ``seq_num``: counter value increased by 1 on each packet sent.
 - Default ``mask`` matches spi.

+Item: ``HIGIG2``
+^^^^^^^^^^^^^^^^^
+
+Matches a HIGIG2 header field. It is layer 2.5 protocol and used in
+Broadcom switches.
+
+- Default ``mask`` matches classification and vlan.
+

 Actions
 ~~~~~~~
diff --git a/lib/librte_ethdev/rte_flow.c b/lib/librte_ethdev/rte_flow.c
index 81a85b995..ca0f68016 100644
--- a/lib/librte_ethdev/rte_flow.c
+++ b/lib/librte_ethdev/rte_flow.c
@@ -83,6 +83,7 @@  static const struct rte_flow_desc_data rte_flow_desc_item[] = {
 	MK_FLOW_ITEM(NSH, sizeof(struct rte_flow_item_nsh)),
 	MK_FLOW_ITEM(IGMP, sizeof(struct rte_flow_item_igmp)),
 	MK_FLOW_ITEM(AH, sizeof(struct rte_flow_item_ah)),
+	MK_FLOW_ITEM(HIGIG2, sizeof(struct rte_flow_item_higig2_hdr)),
 };

 /** Generate flow_action[] entry. */
diff --git a/lib/librte_ethdev/rte_flow.h b/lib/librte_ethdev/rte_flow.h
index bcfc06cdc..79f160df0 100644
--- a/lib/librte_ethdev/rte_flow.h
+++ b/lib/librte_ethdev/rte_flow.h
@@ -27,6 +27,7 @@ 
 #include <rte_udp.h>
 #include <rte_byteorder.h>
 #include <rte_esp.h>
+#include <rte_higig.h>

 #ifdef __cplusplus
 extern "C" {
@@ -491,6 +492,12 @@  enum rte_flow_item_type {
 	 *
 	 */
 	RTE_FLOW_ITEM_TYPE_AH,
+
+	/**
+	 * Matches a HIGIG header.
+	 * see struct rte_flow_item_higig2_hdr.
+	 */
+	RTE_FLOW_ITEM_TYPE_HIGIG2,
 };

 /**
diff --git a/lib/librte_net/Makefile b/lib/librte_net/Makefile
index 1244c9fd5..62735a5f9 100644
--- a/lib/librte_net/Makefile
+++ b/lib/librte_net/Makefile
@@ -21,6 +21,6 @@  SRCS-$(CONFIG_RTE_LIBRTE_NET) += rte_arp.c
 SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include := rte_ip.h rte_tcp.h rte_udp.h rte_esp.h
 SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_sctp.h rte_icmp.h rte_arp.h
 SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_ether.h rte_gre.h rte_net.h
-SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_net_crc.h rte_mpls.h
+SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_net_crc.h rte_mpls.h rte_higig.h

 include $(RTE_SDK)/mk/rte.lib.mk
diff --git a/lib/librte_net/meson.build b/lib/librte_net/meson.build
index 868a93fd6..c52c34592 100644
--- a/lib/librte_net/meson.build
+++ b/lib/librte_net/meson.build
@@ -14,7 +14,8 @@  headers = files('rte_ip.h',
 	'rte_gre.h',
 	'rte_net.h',
 	'rte_net_crc.h',
-	'rte_mpls.h')
+	'rte_mpls.h',
+	'rte_higig.h')

 sources = files('rte_arp.c', 'rte_ether.c', 'rte_net.c', 'rte_net_crc.c')
 deps += ['mbuf']
diff --git a/lib/librte_net/rte_higig.h b/lib/librte_net/rte_higig.h
new file mode 100644
index 000000000..7c0dec449
--- /dev/null
+++ b/lib/librte_net/rte_higig.h
@@ -0,0 +1,138 @@ 
+
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2019 Marvell International Ltd.
+ */
+
+#ifndef _RTE_HIGIG_H_
+#define _RTE_HIGIG_H_
+
+#include <stdint.h>
+#include <rte_byteorder.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * RTE_FLOW_ITEM_TYPE_HIGIG2
+ * Matches higig2 header.
+ */
+struct rte_higig2_frc {
+#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
+	uint32_t ksop:8;
+	uint32_t tc:4;
+	uint32_t mcst:1;
+	uint32_t resv:3;
+	uint32_t dst_modid:8;
+	uint32_t dst_pid:8;
+	uint32_t src_modid:8;
+	uint32_t src_pid:8;
+	uint32_t lbid:8;
+	uint32_t ppd_type:3;
+	uint32_t resv1:3;
+	uint32_t dp:2;
+#elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+	uint32_t ksop:8;
+	uint32_t resv:3;
+	uint32_t mcst:1;
+	uint32_t tc:4;
+	uint32_t dst_modid:8;
+	uint32_t dst_pid:8;
+	uint32_t src_modid:8;
+	uint32_t src_pid:8;
+	uint32_t lbid:8;
+	uint32_t dp:2;
+	uint32_t resv1:3;
+	uint32_t ppd_type:3;
+#endif
+};
+
+struct rte_higig2_ppt_type0 {
+#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
+	uint32_t mirror:1;
+	uint32_t mirror_done:1;
+	uint32_t mirror_only:1;
+	uint32_t ingress_tagged:1;
+	uint32_t dst_tgid:3;
+	uint32_t dst_t:1;
+	uint32_t vc_label2:4;
+	uint32_t label_present:1;
+	uint32_t l3:1;
+	uint32_t res:2;
+	uint32_t vc_label1:8;
+	uint32_t vc_label0:8;
+	uint32_t vid_high:8;
+	uint32_t vid_low:8;
+	uint32_t opcode:3;
+	uint32_t res1:2;
+	uint32_t src_t:1;
+	uint32_t pfm:2;
+	uint32_t res2:5;
+	uint32_t hdr_ext_len:3;
+#elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+	uint32_t dst_t:1;
+	uint32_t dst_tgid:3;
+	uint32_t ingress_tagged:1;
+	uint32_t mirror_only:1;
+	uint32_t mirror_done:1;
+	uint32_t mirror:1;
+	uint32_t res:2;
+	uint32_t l3:1;
+	uint32_t label_present:1;
+	uint32_t vc_label2:4;
+	uint32_t vc_label1:8;
+	uint32_t vc_label0:8;
+	uint32_t vid_high:8;
+	uint32_t vid_low:8;
+	uint32_t pfm:2;
+	uint32_t src_t:1;
+	uint32_t res1:2;
+	uint32_t opcode:3;
+	uint32_t hdr_ext_len:3;
+	uint32_t res2:5;
+#endif
+};
+
+struct rte_higig2_ppt_type1 {
+	uint16_t classification;
+	uint16_t resv;
+	uint16_t vid;
+#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
+	uint16_t opcode:3;
+	uint16_t resv1:2;
+	uint16_t src_t:1;
+	uint16_t pfm:2;
+	uint16_t resv2:5;
+	uint16_t hdr_ext_len:3;
+#elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+	uint16_t pfm:2;
+	uint16_t src_t:1;
+	uint16_t resv1:2;
+	uint16_t opcode:3;
+	uint16_t hdr_ext_len:3;
+	uint16_t resv2:5;
+#endif
+};
+
+RTE_STD_C11
+struct rte_flow_item_higig2_hdr {
+	struct rte_higig2_frc fcr;
+	union {
+		struct rte_higig2_ppt_type0 ppt0;
+		struct rte_higig2_ppt_type1 ppt1;
+	};
+};
+
+/** Default mask for RTE_FLOW_ITEM_TYPE_HIGIG2. */
+#ifndef __cplusplus
+static const struct rte_flow_item_higig2_hdr rte_flow_item_higig2_hdr_mask = {
+	.ppt1.classification = 0xffff,
+	.ppt1.vid = 0xfff,
+};
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* RTE_HIGIG_H_ */