ethdev: add eCPRI key fields to flow API
authorBing Zhao <bingz@mellanox.com>
Sun, 12 Jul 2020 13:35:02 +0000 (21:35 +0800)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 13 Jul 2020 00:11:30 +0000 (02:11 +0200)
Add a new item "rte_flow_item_ecpri" in order to match eCRPI header.

eCPRI is a packet based protocol used in the fronthaul interface of
5G networks. Header format definition could be found in the
specification via the link below:
https://www.gigalight.com/downloads/standards/ecpri-specification.pdf

eCPRI message can be over Ethernet layer (.1Q supported also) or over
UDP layer. Message header formats are the same in these two variants.

Signed-off-by: Bing Zhao <bingz@mellanox.com>
Acked-by: Ori Kam <orika@mellanox.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
doc/guides/prog_guide/rte_flow.rst
doc/guides/rel_notes/release_20_08.rst
lib/librte_ethdev/rte_flow.c
lib/librte_ethdev/rte_flow.h
lib/librte_net/Makefile
lib/librte_net/meson.build
lib/librte_net/rte_ecpri.h [new file with mode: 0644]
lib/librte_net/rte_ether.h

index d5dd18c..3e5cd1e 100644 (file)
@@ -1362,6 +1362,14 @@ Matches a PFCP Header.
 - ``seid``: session endpoint identifier.
 - Default ``mask`` matches s_field and seid.
 
+Item: ``ECPRI``
+^^^^^^^^^^^^^^^
+
+Matches a eCPRI header.
+
+- ``hdr``: eCPRI header definition (``rte_ecpri.h``).
+- Default ``mask`` matches nothing, for all eCPRI messages.
+
 Actions
 ~~~~~~~
 
index 3e07ee6..f19b748 100644 (file)
@@ -81,6 +81,10 @@ New Features
   Added the RegEx library which provides an API for offload of regular
   expressions search operations to hardware or software accelerator devices.
 
+* **Added eCPRI protocol support in rte_flow.**
+
+  The ``ECPRI`` item has been added to support eCPRI packet offloading for
+  5G network.
 
 * **Introduced send packet scheduling on the timestamps.**
 
index 1685be5..f8fdd68 100644 (file)
@@ -95,6 +95,7 @@ static const struct rte_flow_desc_data rte_flow_desc_item[] = {
        MK_FLOW_ITEM(HIGIG2, sizeof(struct rte_flow_item_higig2_hdr)),
        MK_FLOW_ITEM(L2TPV3OIP, sizeof(struct rte_flow_item_l2tpv3oip)),
        MK_FLOW_ITEM(PFCP, sizeof(struct rte_flow_item_pfcp)),
+       MK_FLOW_ITEM(ECPRI, sizeof(struct rte_flow_item_ecpri)),
 };
 
 /** Generate flow_action[] entry. */
index b0e4199..da8bfa5 100644 (file)
@@ -28,6 +28,7 @@
 #include <rte_byteorder.h>
 #include <rte_esp.h>
 #include <rte_higig.h>
+#include <rte_ecpri.h>
 #include <rte_mbuf.h>
 #include <rte_mbuf_dyn.h>
 
@@ -527,6 +528,15 @@ enum rte_flow_item_type {
         */
        RTE_FLOW_ITEM_TYPE_PFCP,
 
+       /**
+        * Matches eCPRI Header.
+        *
+        * Configure flow for eCPRI over ETH or UDP packets.
+        *
+        * See struct rte_flow_item_ecpri.
+        */
+       RTE_FLOW_ITEM_TYPE_ECPRI,
+
 };
 
 /**
@@ -1546,6 +1556,29 @@ static const struct rte_flow_item_pfcp rte_flow_item_pfcp_mask = {
 };
 #endif
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ *
+ * RTE_FLOW_ITEM_TYPE_ECPRI
+ *
+ * Match eCPRI Header
+ */
+struct rte_flow_item_ecpri {
+       struct rte_ecpri_combined_msg_hdr hdr;
+};
+
+/** Default mask for RTE_FLOW_ITEM_TYPE_ECPRI. */
+#ifndef __cplusplus
+static const struct rte_flow_item_ecpri rte_flow_item_ecpri_mask = {
+       .hdr = {
+               .common = {
+                       .u32 = 0x0,
+               },
+       },
+};
+#endif
+
 /**
  * Matching pattern item definition.
  *
index aa1d6fe..9830e77 100644 (file)
@@ -20,5 +20,6 @@ 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 rte_higig.h
 SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_gtp.h rte_vxlan.h
+SYMLINK-$(CONFIG_RTE_LIBRTE_NET)-include += rte_ecpri.h
 
 include $(RTE_SDK)/mk/rte.lib.mk
index f799349..24ed825 100644 (file)
@@ -15,7 +15,8 @@ headers = files('rte_ip.h',
        'rte_net.h',
        'rte_net_crc.h',
        'rte_mpls.h',
-       'rte_higig.h')
+       'rte_higig.h',
+       'rte_ecpri.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_ecpri.h b/lib/librte_net/rte_ecpri.h
new file mode 100644 (file)
index 0000000..d1c4838
--- /dev/null
@@ -0,0 +1,183 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2020 Mellanox Technologies, Ltd
+ */
+
+#ifndef _RTE_ECPRI_H_
+#define _RTE_ECPRI_H_
+
+#include <stdint.h>
+#include <rte_byteorder.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * eCPRI Protocol Revision 1.0, 1.1, 1.2, 2.0: 0001b
+ * Other values are reserved for future
+ */
+#define RTE_ECPRI_REV_UP_TO_20         1
+
+/*
+ * eCPRI message types in specifications
+ * IWF* types will only be supported from rev.2
+ * 12-63: Reserved for future revision
+ * 64-255: Vendor Specific
+ */
+#define RTE_ECPRI_MSG_TYPE_IQ_DATA     0
+#define RTE_ECPRI_MSG_TYPE_BIT_SEQ     1
+#define RTE_ECPRI_MSG_TYPE_RTC_CTRL    2
+#define RTE_ECPRI_MSG_TYPE_GEN_DATA    3
+#define RTE_ECPRI_MSG_TYPE_RM_ACC      4
+#define RTE_ECPRI_MSG_TYPE_DLY_MSR     5
+#define RTE_ECPRI_MSG_TYPE_RMT_RST     6
+#define RTE_ECPRI_MSG_TYPE_EVT_IND     7
+#define RTE_ECPRI_MSG_TYPE_IWF_UP      8
+#define RTE_ECPRI_MSG_TYPE_IWF_OPT     9
+#define RTE_ECPRI_MSG_TYPE_IWF_MAP     10
+#define RTE_ECPRI_MSG_TYPE_IWF_DCTRL   11
+
+/*
+ * Event Type of Message Type #7: Event Indication
+ * 0x00: Fault(s) Indication
+ * 0x01: Fault(s) Indication Acknowledge
+ * 0x02: Notification(s) Indication
+ * 0x03: Synchronization Request
+ * 0x04: Synchronization Acknowledge
+ * 0x05: Synchronization End Indication
+ * 0x06...0xFF: Reserved
+ */
+#define RTE_ECPRI_EVT_IND_FAULT_IND    0x00
+#define RTE_ECPRI_EVT_IND_FAULT_ACK    0x01
+#define RTE_ECPRI_EVT_IND_NTFY_IND     0x02
+#define RTE_ECPRI_EVT_IND_SYNC_REQ     0x03
+#define RTE_ECPRI_EVT_IND_SYNC_ACK     0x04
+#define RTE_ECPRI_EVT_IND_SYNC_END     0x05
+
+/**
+ * eCPRI Common Header
+ */
+RTE_STD_C11
+struct rte_ecpri_common_hdr {
+       union {
+               rte_be32_t u32;                 /**< 4B common header in BE */
+               struct {
+#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
+                       uint32_t size:16;       /**< Payload Size */
+                       uint32_t type:8;        /**< Message Type */
+                       uint32_t c:1;           /**< Concatenation Indicator */
+                       uint32_t res:3;         /**< Reserved */
+                       uint32_t revision:4;    /**< Protocol Revision */
+#elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+                       uint32_t revision:4;    /**< Protocol Revision */
+                       uint32_t res:3;         /**< Reserved */
+                       uint32_t c:1;           /**< Concatenation Indicator */
+                       uint32_t type:8;        /**< Message Type */
+                       uint32_t size:16;       /**< Payload Size */
+#endif
+               };
+       };
+};
+
+/**
+ * eCPRI Message Header of Type #0: IQ Data
+ */
+struct rte_ecpri_msg_iq_data {
+       rte_be16_t pc_id;               /**< Physical channel ID */
+       rte_be16_t seq_id;              /**< Sequence ID */
+};
+
+/**
+ * eCPRI Message Header of Type #1: Bit Sequence
+ */
+struct rte_ecpri_msg_bit_seq {
+       rte_be16_t pc_id;               /**< Physical channel ID */
+       rte_be16_t seq_id;              /**< Sequence ID */
+};
+
+/**
+ * eCPRI Message Header of Type #2: Real-Time Control Data
+ */
+struct rte_ecpri_msg_rtc_ctrl {
+       rte_be16_t rtc_id;              /**< Real-Time Control Data ID */
+       rte_be16_t seq_id;              /**< Sequence ID */
+};
+
+/**
+ * eCPRI Message Header of Type #3: Generic Data Transfer
+ */
+struct rte_ecpri_msg_gen_data {
+       rte_be32_t pc_id;               /**< Physical channel ID */
+       rte_be32_t seq_id;              /**< Sequence ID */
+};
+
+/**
+ * eCPRI Message Header of Type #4: Remote Memory Access
+ */
+RTE_STD_C11
+struct rte_ecpri_msg_rm_access {
+#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
+       uint32_t ele_id:16;             /**< Element ID */
+       uint32_t rr:4;                  /**< Req/Resp */
+       uint32_t rw:4;                  /**< Read/Write */
+       uint32_t rma_id:8;              /**< Remote Memory Access ID */
+#elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+       uint32_t rma_id:8;              /**< Remote Memory Access ID */
+       uint32_t rw:4;                  /**< Read/Write */
+       uint32_t rr:4;                  /**< Req/Resp */
+       uint32_t ele_id:16;             /**< Element ID */
+#endif
+       uint8_t addr[6];                /**< 48-bits address */
+       rte_be16_t length;              /**< number of bytes */
+};
+
+/**
+ * eCPRI Message Header of Type #5: One-Way Delay Measurement
+ */
+struct rte_ecpri_msg_delay_measure {
+       uint8_t msr_id;                 /**< Measurement ID */
+       uint8_t act_type;               /**< Action Type */
+};
+
+/**
+ * eCPRI Message Header of Type #6: Remote Reset
+ */
+struct rte_ecpri_msg_remote_reset {
+       rte_be16_t rst_id;              /**< Reset ID */
+       uint8_t rst_op;                 /**< Reset Code Op */
+};
+
+/**
+ * eCPRI Message Header of Type #7: Event Indication
+ */
+struct rte_ecpri_msg_event_ind {
+       uint8_t evt_id;                 /**< Event ID */
+       uint8_t evt_type;               /**< Event Type */
+       uint8_t seq;                    /**< Sequence Number */
+       uint8_t number;                 /**< Number of Faults/Notif */
+};
+
+/**
+ * eCPRI Combined Message Header Format: Common Header + Message Types
+ */
+RTE_STD_C11
+struct rte_ecpri_combined_msg_hdr {
+       struct rte_ecpri_common_hdr common;
+       union {
+               struct rte_ecpri_msg_iq_data type0;
+               struct rte_ecpri_msg_bit_seq type1;
+               struct rte_ecpri_msg_rtc_ctrl type2;
+               struct rte_ecpri_msg_bit_seq type3;
+               struct rte_ecpri_msg_rm_access type4;
+               struct rte_ecpri_msg_delay_measure type5;
+               struct rte_ecpri_msg_remote_reset type6;
+               struct rte_ecpri_msg_event_ind type7;
+               rte_be32_t dummy[3];
+       };
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _RTE_ECPRI_H_ */
index e942556..a358e88 100644 (file)
@@ -307,6 +307,7 @@ struct rte_vlan_hdr {
 #define RTE_ETHER_TYPE_LLDP 0x88CC /**< LLDP Protocol. */
 #define RTE_ETHER_TYPE_MPLS 0x8847 /**< MPLS ethertype. */
 #define RTE_ETHER_TYPE_MPLSM 0x8848 /**< MPLS multicast ethertype. */
+#define RTE_ETHER_TYPE_ECPRI 0xAEFE /**< eCPRI ethertype (.1Q supported). */
 
 /**
  * Extract VLAN tag information into mbuf