Front Haul Interface Library first seed code contribution

[o-du/phy.git] / fhi_lib / lib / ethernet / ethernet.h

diff --git a/fhi_lib/lib/ethernet/ethernet.h b/fhi_lib/lib/ethernet/ethernet.h
new file mode 100644 (file)
index 0000000..b22aed8
--- /dev/null
+++ b/fhi_lib/lib/ethernet/ethernet.h
@@ -0,0 +1,165 @@
+/******************************************************************************
+*
+*   Copyright (c) 2019 Intel.
+*
+*   Licensed under the Apache License, Version 2.0 (the "License");
+*   you may not use this file except in compliance with the License.
+*   You may obtain a copy of the License at
+*
+*       http://www.apache.org/licenses/LICENSE-2.0
+*
+*   Unless required by applicable law or agreed to in writing, software
+*   distributed under the License is distributed on an "AS IS" BASIS,
+*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*   See the License for the specific language governing permissions and
+*   limitations under the License.
+*
+*******************************************************************************/
+
+
+/**
+ * @brief This file has all definitions for the Ethernet Data Interface Layer
+ * @file ethernet.h
+ * @ingroup group_lte_source_auxlib
+ * @author Intel Corporation
+ **/
+
+#ifndef AUXLIB_ETHERNET_H
+#define AUXLIB_ETHERNET_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <rte_config.h>
+#include <rte_ether.h>
+#include <rte_mbuf.h>
+
+#define BURST_SIZE 64
+
+//#define VLAN_SUPPORT
+#define FLEXRAN_UP_VLAN_TAG 2
+#define ETHER_TYPE_ETHDI ETHER_TYPE_IPv4    /* hack needed for jumbo frames */
+#define ETHER_TYPE_ECPRI 0xAEFE
+#define ETHER_TYPE_SYNC 0xBEFE
+#define ETHER_TYPE_START_TX 0xCEFE
+
+#define NUM_MBUFS 262144
+#define MBUF_CACHE 256
+
+#define MBUF_POOL_ELM_SMALL 1500 /* regular ethernet MTU, most compatible */
+#define MBUF_POOL_ELEMENT MAX_RX_LEN
+
+#define MAX_RX_LEN 9600
+#define MAX_TX_LEN (MAX_RX_LEN - 14) /* headroom for rx driver */
+#define MAX_DATA_SIZE (MAX_TX_LEN - sizeof(struct ether_hdr) - \
+    sizeof(struct ethdi_hdr) - sizeof(struct burst_hdr))
+
+/* Looks like mbuf size is limited to 16 bits - see the buf_len field. */
+#define MBUF_POOL_ELM_BIG USHRT_MAX
+#define NUM_MBUFS_BIG 64
+
+#define DEFAULT_DUMP_LENGTH 96
+
+extern struct rte_mempool *_eth_mbuf_pool;
+extern struct rte_mempool *_eth_mbuf_pool_small;
+extern struct rte_mempool *_eth_mbuf_pool_big;
+
+/* Do NOT change the order of this enum and below
+ * - need to be in sync with the table of handlers in testue.c */
+enum pkt_type
+{
+    PKT_ZERO,
+    PKT_EMPTY,
+    PKT_DISCOVER_REQUEST,
+    PKT_PING,
+    PKT_PONG,
+    PKT_DISCOVER_REPLY,
+    PKT_LTE_DATA,
+    PKT_LTE_CONTROL,
+    PKT_BURST,
+    PKT_DATATEST,
+    PKT_ADD_ETHDEV,
+    PKT_SYNC_START,
+    PKT_LAST,
+};
+
+/* Do NOT change the order. */
+static char * const xran_pkt_descriptions[PKT_LAST + 1] = {
+    "ZERO",
+    "empty packet",
+    "discovery request packet",
+    "ping packet",
+    "pong packet",
+    "discovery reply packet",
+    "LTE data packet",
+    "LTE control packet",
+    "BURST packet",
+    "DATATEST packet",
+    "Add ethernet port command packet",
+    "SYNC-START packet",
+    "LAST packet",
+};
+
+struct burst_hdr {
+    int8_t pkt_idx;
+    int8_t total_pkts;
+    int8_t original_type;
+    int8_t data[];
+};
+
+struct ethdi_hdr {
+    uint8_t pkt_type;
+    uint8_t source_id;
+    uint8_t dest_id;
+    int8_t data[];    /* original raw data starts here! */
+};
+
+
+void xran_init_mbuf_pool(void);
+
+void xran_init_port(int port, struct ether_addr *p_lls_cu_addr);
+
+void xran_add_eth_hdr_vlan(struct ether_addr *dst, uint16_t ethertype, struct rte_mbuf *mb, uint16_t vlan_tci);
+int xran_send_mbuf(struct ether_addr *dst, struct rte_mbuf *mb);
+
+int xran_send_message_burst(int dst_id, int pkt_type, void *body, int len);
+
+void xran_memdump(void *addr, int len);
+
+/*
+ * Print a message after all critical processing done.
+ * Mt-safe. 4 variants - normal, warning, error and debug log.
+ */
+
+#define nlog(m, ...) 
+#define delayed_message     /* this is the old alias for this function */
+#define wlog(m, ...) 
+#define elog(m, ...) 
+#ifdef DEBUG
+# define dlog(m, ...) 
+#else
+# define dlog(m, ...)
+#endif
+
+#define PANIC_ON(x, m, ...) do { if (unlikely(x)) \
+    rte_panic("%s: " m "\n", #x, ##__VA_ARGS__); } while (0)
+
+/* Add mbuf to the TX ring. */
+static inline int xran_enqueue_mbuf(struct rte_mbuf *mb, struct rte_ring *r)
+{
+    if (rte_ring_enqueue(r, mb) == 0) {
+        return 1;   /* success */
+    }
+
+    rte_pktmbuf_free(mb);
+    wlog("failed to enqueue packet on port %d (ring full)", mb->port);
+
+    return 0;   /* fail */
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* AUXLIB_ETHERNET_H */