Front Haul Interface Library update to third seed code contribution
[o-du/phy.git] / fhi_lib / lib / src / xran_transport.c
index 5251f71..325616b 100644 (file)
-/******************************************************************************\r
-*\r
-*   Copyright (c) 2019 Intel.\r
-*\r
-*   Licensed under the Apache License, Version 2.0 (the "License");\r
-*   you may not use this file except in compliance with the License.\r
-*   You may obtain a copy of the License at\r
-*\r
-*       http://www.apache.org/licenses/LICENSE-2.0\r
-*\r
-*   Unless required by applicable law or agreed to in writing, software\r
-*   distributed under the License is distributed on an "AS IS" BASIS,\r
-*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
-*   See the License for the specific language governing permissions and\r
-*   limitations under the License.\r
-*\r
-*******************************************************************************/\r
-\r
-/**\r
- * @brief This file provides the implementation for Transport lyaer (eCPRI) API.\r
- *\r
- * @file xran_transport.c\r
- * @ingroup group_lte_source_xran\r
- * @author Intel Corporation\r
- *\r
- **/\r
-\r
-#include <stdint.h>\r
-#include <endian.h>\r
-#include <rte_common.h>\r
-#include <rte_config.h>\r
-\r
-#include "xran_fh_o_du.h"\r
-#include "xran_common.h"\r
-#include "xran_transport.h"\r
-#include "xran_pkt_cp.h"\r
-#include "xran_cp_api.h"\r
-#include "xran_up_api.h"\r
-#include "xran_printf.h"\r
-\r
-\r
-/**\r
- * @brief return eCPRI header size without eCPRI common header\r
- *\r
- * @ingroup xran\r
- *\r
- * @return the size of eCPRI header without common header\r
- */\r
-int xran_get_ecpri_hdr_size(void)\r
-{\r
-    return(sizeof(struct xran_ecpri_hdr) - sizeof(struct xran_ecpri_cmn_hdr));\r
-}\r
-\r
-/**\r
- * @brief Compose ecpriRtcid/ecpriPcid\r
- *\r
- * @ingroup xran\r
- *\r
- * @param CU_Port_ID CU Port ID\r
- * @param BanbSector_ID Band Sector ID\r
- * @param CC_ID Component Carrier ID\r
- * @param Ant_ID RU Port ID (antenna ID)\r
- * @return uint16_t composed ecpriRtcid/ecpriPcid (network byte order)\r
- */\r
-uint16_t xran_compose_cid(uint8_t CU_Port_ID, uint8_t BandSector_ID, uint8_t CC_ID, uint8_t Ant_ID)\r
-{\r
-  uint16_t cid;\r
-  struct xran_eaxcid_config *conf;\r
-\r
-    conf = xran_get_conf_eAxC(NULL);\r
-\r
-    cid = ((CU_Port_ID      << conf->bit_cuPortId)      & conf->mask_cuPortId)\r
-        | ((BandSector_ID   << conf->bit_bandSectorId)  & conf->mask_bandSectorId)\r
-        | ((CC_ID           << conf->bit_ccId)          & conf->mask_ccId)\r
-        | ((Ant_ID          << conf->bit_ruPortId)      & conf->mask_ruPortId);\r
-\r
-    return (rte_cpu_to_be_16(cid));\r
-}\r
-\r
-/**\r
- * @brief Decompose ecpriRtcid/ecpriPcid\r
- *\r
- * @ingroup xran\r
- *\r
- * @param cid composed ecpriRtcid/ecpriPcid (network byte order)\r
- * @param result the pointer of the structure to store decomposed values\r
- * @return none\r
- */\r
-void xran_decompose_cid(uint16_t cid, struct xran_eaxc_info *result)\r
-{\r
-  struct xran_eaxcid_config *conf;\r
-\r
-    conf = xran_get_conf_eAxC(NULL);\r
-    cid = rte_be_to_cpu_16(cid);\r
-\r
-    result->cuPortId        = (cid&conf->mask_cuPortId)     >> conf->bit_cuPortId;\r
-    result->bandSectorId    = (cid&conf->mask_bandSectorId) >> conf->bit_bandSectorId;\r
-    result->ccId            = (cid&conf->mask_ccId)         >> conf->bit_ccId;\r
-    result->ruPortId        = (cid&conf->mask_ruPortId)     >> conf->bit_ruPortId;\r
-\r
-    return;\r
-}\r
-\r
-/**\r
- * @brief modify the payload size of eCPRI header in xRAN packet\r
- *\r
- * @ingroup xran\r
- *\r
- * @param mbuf Initialized rte_mbuf packet which has eCPRI header already\r
- * @param size payload size to be updated\r
- * @return none\r
- */\r
-inline void xran_update_ecpri_payload_size(struct rte_mbuf *mbuf, int size)\r
-{\r
-  struct xran_ecpri_hdr *ecpri_hdr;\r
-\r
-    ecpri_hdr = rte_pktmbuf_mtod(mbuf, struct xran_ecpri_hdr *);\r
-\r
-    ecpri_hdr->cmnhdr.ecpri_payl_size = rte_cpu_to_be_16(size);\r
-}\r
-\r
-\r
-/**\r
- * @brief Build ECPRI header and returns added length\r
- *\r
- * @ingroup xran\r
- *\r
- * @param mbuf\r
- *  The pointer of the packet buffer to be parsed\r
- * @param CC_ID\r
- *  Component Carrier ID for this C-Plane message\r
- * @param Ant_ID\r
- *  Antenna ID(RU Port ID) for this C-Plane message\r
- * @param seq_id\r
- *  Sequence ID for this C-Plane message\r
- * @param ecpri_hdr\r
- *  The pointer to ECPRI header\r
- * @return\r
- *  added payload size on success\r
- *  XRAN_STATUS_RESOURCE if failed to allocate the space to packet buffer\r
- */\r
-int xran_build_ecpri_hdr(struct rte_mbuf *mbuf,\r
-                        uint8_t CC_ID, uint8_t Ant_ID,\r
-                        uint8_t seq_id,\r
-                        struct xran_ecpri_hdr **ecpri_hdr)\r
-{\r
-  uint32_t payloadlen;\r
-  struct xran_ecpri_hdr *tmp;\r
-\r
-\r
-    tmp = (struct xran_ecpri_hdr *)rte_pktmbuf_append(mbuf, sizeof(struct xran_ecpri_hdr));\r
-    if(unlikely(tmp == NULL)) {\r
-        print_err("Fail to allocate the space for eCPRI hedaer!");\r
-        return (XRAN_STATUS_RESOURCE);\r
-        }\r
-\r
-    /* Fill common header */\r
-    tmp->cmnhdr.ecpri_ver           = XRAN_ECPRI_VER;\r
-    tmp->cmnhdr.ecpri_resv          = 0;     // should be zero\r
-    tmp->cmnhdr.ecpri_concat        = 0;\r
-    tmp->cmnhdr.ecpri_mesg_type     = ECPRI_RT_CONTROL_DATA;\r
-    tmp->ecpri_xtc_id               = xran_compose_cid(0, 0, CC_ID, Ant_ID);\r
-\r
-    /* TODO: Transport layer fragmentation is not supported */\r
-    tmp->ecpri_seq_id.seq_id        = seq_id;\r
-    tmp->ecpri_seq_id.sub_seq_id    = 0;\r
-    tmp->ecpri_seq_id.e_bit         = 1;\r
-\r
-    /* Starts with eCPRI header size */\r
-    payloadlen = xran_get_ecpri_hdr_size();\r
-\r
-    *ecpri_hdr = tmp;\r
-\r
-    return (payloadlen);\r
-}\r
-\r
-/**\r
- * @brief Parse ECPRI header\r
- *\r
- * @ingroup xran\r
- *\r
- * @param mbuf\r
- *  The pointer of the packet buffer to be parsed\r
- * @param ecpri_hdr\r
- *  The pointer to ECPRI header\r
- * @param pkt_info\r
- *  The pointer of sturcture to store the information from header\r
- * @return\r
- *  XRAN_STATUS_SUCCESS on success\r
- *  XRAN_STATUS_INVALID_PACKET if failed to parse the packet\r
- */\r
-int xran_parse_ecpri_hdr(struct rte_mbuf *mbuf,\r
-                    struct xran_ecpri_hdr **ecpri_hdr,\r
-                    struct xran_recv_packet_info *pkt_info)\r
-{\r
-  int ret;\r
-\r
-\r
-    *ecpri_hdr = rte_pktmbuf_mtod(mbuf, void *);\r
-    if(*ecpri_hdr == NULL) {\r
-        print_err("Invalid packet - eCPRI hedaer!");\r
-        return (XRAN_STATUS_INVALID_PACKET);\r
-        }\r
-\r
-    /* Process eCPRI header */\r
-    ret = XRAN_STATUS_SUCCESS;\r
-    if((*ecpri_hdr)->cmnhdr.ecpri_ver != XRAN_ECPRI_VER) {\r
-        print_err("Invalid eCPRI version - %d", (*ecpri_hdr)->cmnhdr.ecpri_ver);\r
-        ret = XRAN_STATUS_INVALID_PACKET;\r
-        }\r
-    if((*ecpri_hdr)->cmnhdr.ecpri_resv != 0) {\r
-        print_err("Invalid reserved field - %d", (*ecpri_hdr)->cmnhdr.ecpri_resv);\r
-        ret = XRAN_STATUS_INVALID_PACKET;\r
-        }\r
-\r
-    if(pkt_info != NULL) {\r
-        /* store the information from header */\r
-        pkt_info->ecpri_version = (*ecpri_hdr)->cmnhdr.ecpri_ver;\r
-        pkt_info->msg_type      = (enum ecpri_msg_type)(*ecpri_hdr)->cmnhdr.ecpri_mesg_type;\r
-        pkt_info->payload_len   = rte_be_to_cpu_16((*ecpri_hdr)->cmnhdr.ecpri_payl_size);\r
-\r
-        pkt_info->seq_id        = (*ecpri_hdr)->ecpri_seq_id.seq_id;\r
-        pkt_info->subseq_id     = (*ecpri_hdr)->ecpri_seq_id.sub_seq_id;\r
-        pkt_info->ebit          = (*ecpri_hdr)->ecpri_seq_id.e_bit;\r
-        xran_decompose_cid((*ecpri_hdr)->ecpri_xtc_id, &(pkt_info->eaxc));\r
-        }\r
-\r
-    return (ret);\r
-}\r
-\r
+/******************************************************************************
+*
+*   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 provides the implementation for Transport lyaer (eCPRI) API.
+ *
+ * @file xran_transport.c
+ * @ingroup group_lte_source_xran
+ * @author Intel Corporation
+ *
+ **/
+
+#include <stdint.h>
+#include <endian.h>
+#include <rte_common.h>
+#include <rte_config.h>
+
+#include "xran_fh_o_du.h"
+#include "xran_common.h"
+#include "xran_transport.h"
+#include "xran_pkt_cp.h"
+#include "xran_cp_api.h"
+#include "xran_up_api.h"
+#include "xran_printf.h"
+
+
+/**
+ * @brief return eCPRI header size without eCPRI common header
+ *
+ * @ingroup xran
+ *
+ * @return the size of eCPRI header without common header
+ */
+int xran_get_ecpri_hdr_size(void)
+{
+    return(sizeof(struct xran_ecpri_hdr) - sizeof(struct xran_ecpri_cmn_hdr));
+}
+
+/**
+ * @brief Compose ecpriRtcid/ecpriPcid
+ *
+ * @ingroup xran
+ *
+ * @param CU_Port_ID CU Port ID
+ * @param BanbSector_ID Band Sector ID
+ * @param CC_ID Component Carrier ID
+ * @param Ant_ID RU Port ID (antenna ID)
+ * @return uint16_t composed ecpriRtcid/ecpriPcid (network byte order)
+ */
+uint16_t xran_compose_cid(uint8_t CU_Port_ID, uint8_t BandSector_ID, uint8_t CC_ID, uint8_t Ant_ID)
+{
+  uint16_t cid;
+  struct xran_eaxcid_config *conf;
+
+    conf = xran_get_conf_eAxC(NULL);
+
+    cid = ((CU_Port_ID      << conf->bit_cuPortId)      & conf->mask_cuPortId)
+        | ((BandSector_ID   << conf->bit_bandSectorId)  & conf->mask_bandSectorId)
+        | ((CC_ID           << conf->bit_ccId)          & conf->mask_ccId)
+        | ((Ant_ID          << conf->bit_ruPortId)      & conf->mask_ruPortId);
+
+    return (rte_cpu_to_be_16(cid));
+}
+
+/**
+ * @brief Decompose ecpriRtcid/ecpriPcid
+ *
+ * @ingroup xran
+ *
+ * @param cid composed ecpriRtcid/ecpriPcid (network byte order)
+ * @param result the pointer of the structure to store decomposed values
+ * @return none
+ */
+void xran_decompose_cid(uint16_t cid, struct xran_eaxc_info *result)
+{
+  struct xran_eaxcid_config *conf;
+
+    conf = xran_get_conf_eAxC(NULL);
+    cid = rte_be_to_cpu_16(cid);
+
+    result->cuPortId        = (cid&conf->mask_cuPortId)     >> conf->bit_cuPortId;
+    result->bandSectorId    = (cid&conf->mask_bandSectorId) >> conf->bit_bandSectorId;
+    result->ccId            = (cid&conf->mask_ccId)         >> conf->bit_ccId;
+    result->ruPortId        = (cid&conf->mask_ruPortId)     >> conf->bit_ruPortId;
+
+    return;
+}
+
+/**
+ * @brief modify the payload size of eCPRI header in xRAN packet
+ *
+ * @ingroup xran
+ *
+ * @param mbuf Initialized rte_mbuf packet which has eCPRI header already
+ * @param size payload size to be updated
+ * @return none
+ */
+inline void xran_update_ecpri_payload_size(struct rte_mbuf *mbuf, int size)
+{
+  struct xran_ecpri_hdr *ecpri_hdr;
+
+    ecpri_hdr = rte_pktmbuf_mtod(mbuf, struct xran_ecpri_hdr *);
+
+    ecpri_hdr->cmnhdr.ecpri_payl_size = rte_cpu_to_be_16(size);
+}
+
+
+/**
+ * @brief Build ECPRI header and returns added length
+ *
+ * @ingroup xran
+ *
+ * @param mbuf
+ *  The pointer of the packet buffer to be parsed
+ * @param CC_ID
+ *  Component Carrier ID for this C-Plane message
+ * @param Ant_ID
+ *  Antenna ID(RU Port ID) for this C-Plane message
+ * @param seq_id
+ *  Sequence ID for this C-Plane message
+ * @param ecpri_hdr
+ *  The pointer to ECPRI header
+ * @return
+ *  added payload size on success
+ *  XRAN_STATUS_RESOURCE if failed to allocate the space to packet buffer
+ */
+int xran_build_ecpri_hdr(struct rte_mbuf *mbuf,
+                        uint8_t CC_ID, uint8_t Ant_ID,
+                        uint8_t seq_id,
+                        struct xran_ecpri_hdr **ecpri_hdr)
+{
+  uint32_t payloadlen;
+  struct xran_ecpri_hdr *tmp;
+
+
+    tmp = (struct xran_ecpri_hdr *)rte_pktmbuf_append(mbuf, sizeof(struct xran_ecpri_hdr));
+    if(unlikely(tmp == NULL)) {
+        print_err("Fail to allocate the space for eCPRI hedaer!");
+        return (XRAN_STATUS_RESOURCE);
+        }
+
+    /* Fill common header */
+    tmp->cmnhdr.ecpri_ver           = XRAN_ECPRI_VER;
+    tmp->cmnhdr.ecpri_resv          = 0;     // should be zero
+    tmp->cmnhdr.ecpri_concat        = 0;
+    tmp->cmnhdr.ecpri_mesg_type     = ECPRI_RT_CONTROL_DATA;
+    tmp->ecpri_xtc_id               = xran_compose_cid(0, 0, CC_ID, Ant_ID);
+
+    /* TODO: Transport layer fragmentation is not supported */
+    tmp->ecpri_seq_id.seq_id        = seq_id;
+    tmp->ecpri_seq_id.sub_seq_id    = 0;
+    tmp->ecpri_seq_id.e_bit         = 1;
+
+    /* Starts with eCPRI header size */
+    payloadlen = xran_get_ecpri_hdr_size();
+
+    *ecpri_hdr = tmp;
+
+    return (payloadlen);
+}
+
+/**
+ * @brief Parse ECPRI header
+ *
+ * @ingroup xran
+ *
+ * @param mbuf
+ *  The pointer of the packet buffer to be parsed
+ * @param ecpri_hdr
+ *  The pointer to ECPRI header
+ * @param pkt_info
+ *  The pointer of sturcture to store the information from header
+ * @return
+ *  XRAN_STATUS_SUCCESS on success
+ *  XRAN_STATUS_INVALID_PACKET if failed to parse the packet
+ */
+int xran_parse_ecpri_hdr(struct rte_mbuf *mbuf,
+                    struct xran_ecpri_hdr **ecpri_hdr,
+                    struct xran_recv_packet_info *pkt_info)
+{
+  int ret;
+
+
+    *ecpri_hdr = rte_pktmbuf_mtod(mbuf, void *);
+    if(*ecpri_hdr == NULL) {
+        print_err("Invalid packet - eCPRI hedaer!");
+        return (XRAN_STATUS_INVALID_PACKET);
+        }
+
+    /* Process eCPRI header */
+    ret = XRAN_STATUS_SUCCESS;
+    if((*ecpri_hdr)->cmnhdr.ecpri_ver != XRAN_ECPRI_VER) {
+        print_err("Invalid eCPRI version - %d", (*ecpri_hdr)->cmnhdr.ecpri_ver);
+        ret = XRAN_STATUS_INVALID_PACKET;
+        }
+    if((*ecpri_hdr)->cmnhdr.ecpri_resv != 0) {
+        print_err("Invalid reserved field - %d", (*ecpri_hdr)->cmnhdr.ecpri_resv);
+        ret = XRAN_STATUS_INVALID_PACKET;
+        }
+
+    if(pkt_info != NULL) {
+        /* store the information from header */
+        pkt_info->ecpri_version = (*ecpri_hdr)->cmnhdr.ecpri_ver;
+        pkt_info->msg_type      = (enum ecpri_msg_type)(*ecpri_hdr)->cmnhdr.ecpri_mesg_type;
+        pkt_info->payload_len   = rte_be_to_cpu_16((*ecpri_hdr)->cmnhdr.ecpri_payl_size);
+
+        pkt_info->seq_id        = (*ecpri_hdr)->ecpri_seq_id.seq_id;
+        pkt_info->subseq_id     = (*ecpri_hdr)->ecpri_seq_id.sub_seq_id;
+        pkt_info->ebit          = (*ecpri_hdr)->ecpri_seq_id.e_bit;
+        xran_decompose_cid((*ecpri_hdr)->ecpri_xtc_id, &(pkt_info->eaxc));
+        }
+
+    return (ret);
+}
+