Front Haul Interface Library update to third seed code contribution
[o-du/phy.git] / fhi_lib / app / src / config.h
index d9cae09..6113134 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\r
- * @file\r
- * @ingroup\r
- * @author Intel Corporation\r
- **/\r
-\r
-#ifndef _SAMPLEAPP__CONFIG_H_\r
-#define _SAMPLEAPP__CONFIG_H_\r
-\r
-#include <stdint.h>\r
-#include <rte_ether.h>\r
-#include "xran_fh_o_du.h"\r
-\r
-/** Run time configuration of application */\r
-typedef struct _RuntimeConfig\r
-{\r
-    uint8_t appMode;      /**< Application mode: lls-CU or RU  */\r
-    uint8_t xranCat;     /**< xran mode: Categoty A | Category B */\r
-    uint8_t numCC;        /**< Number of CC per ports supported by RU */\r
-    uint8_t numAxc;       /**< Number of Antenna Carriers per CC */\r
-    uint8_t numUlAxc;     /**< Number of Antenna Carriers per CC for UL (Cat B) */\r
-    uint32_t antElmTRx;   /**< Number of antenna elements for TX and RX */\r
-    uint32_t muMimoUEs;   /**< Number of UEs (with 1 RX ant)/beams */\r
-\r
-    uint32_t DlLayersPerUe; /**< Number of DL layer per UE */\r
-    uint32_t UlLayersPerUe; /**< Number of UL layer per UE */\r
-\r
-    uint32_t ttiPeriod;   /**< TTI period */\r
-    uint32_t testVect;    /**< Test Signal to send */\r
-    struct ether_addr o_du_addr; /**<  lls-CU Ethernet Mac Address */\r
-    struct ether_addr o_ru_addr; /**<  RU Ethernet Mac Address */\r
-    struct ether_addr tmp_addr; /**<  Temp Ethernet Mac Address */\r
-\r
-    uint32_t instance_id; /**<  Instance ID of application */\r
-    uint32_t io_core; /**<  Core used for IO */\r
-    uint64_t system_core; /* <system core ID> */\r
-    uint64_t pkt_proc_core;\r
-    uint64_t pkt_aux_core;\r
-    uint64_t timing_core;\r
-    \r
-    uint32_t mtu; /**< maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single\r
-                       xRAN network layer transaction. supported 1500 bytes and 9600 bytes (Jumbo Frame) */\r
-    int numSlots;  /**< number of slots in IQ vector */\r
-    char ant_file[XRAN_MAX_SECTOR_NR*XRAN_MAX_ANTENNA_NR][512]; /**<  file to use for test vector */\r
-    char prach_file[XRAN_MAX_SECTOR_NR*XRAN_MAX_ANTENNA_NR][512]; /**<  file to use for test vector */\r
-\r
-    char dl_bfw_file [XRAN_MAX_SECTOR_NR*XRAN_MAX_ANTENNA_NR][512]; /**< file with beamforming weights for DL streams */\r
-    char ul_bfw_file [XRAN_MAX_SECTOR_NR*XRAN_MAX_ANTENNA_NR][512]; /**< file with beamforming weights for UL streams */\r
-\r
-    char ul_srs_file [XRAN_MAX_SECTOR_NR*XRAN_MAX_ANT_ARRAY_ELM_NR][512]; /**< file with SRS content for UL antenna elements */\r
-\r
-    /* prach config */\r
-    uint8_t enablePrach; /**<  enable PRACH */\r
-    uint8_t prachOffset; /**< Sets the PRACH position in frequency / subcarrier position, n_PRBoffset^RA and is expressed as a physical resource block number.\r
-                              Set by SIB2, prach-FreqOffset in E-UTRA. */\r
-\r
-    uint8_t prachConfigIndex; /**< TS36.211 - Table 5.7.1-2 : PRACH Configuration Index */\r
-    uint8_t iqswap; /**< do swap of IQ before send to ETH */\r
-    uint8_t nebyteorderswap; /**< do swap of byte order from host byte order to network byte order. ETH */\r
-    uint8_t compression;     /**< enable use case with compression */\r
-\r
-    uint16_t totalBfWeights; /**< The total number of beamforming weights on RU */\r
-\r
-    uint8_t enableSrs; /**< enable SRS (valid for Cat B only) */\r
-    uint16_t srsSymMask; /**< SRS symbol mask [014] within S/U slot [0-13] def is  13 */\r
-\r
-    uint16_t maxFrameId; /**< max value of frame id */\r
-\r
-    uint16_t Tadv_cp_dl;\r
-    uint16_t T2a_min_cp_dl;\r
-    uint16_t T2a_max_cp_dl;\r
-    uint16_t T2a_min_cp_ul;\r
-    uint16_t T2a_max_cp_ul;\r
-    uint16_t T2a_min_up;\r
-    uint16_t T2a_max_up;\r
-    uint16_t Ta3_min;\r
-    uint16_t Ta3_max;\r
-    uint16_t T1a_min_cp_dl;\r
-    uint16_t T1a_max_cp_dl;\r
-    uint16_t T1a_min_cp_ul;\r
-    uint16_t T1a_max_cp_ul;\r
-    uint16_t T1a_min_up;\r
-    uint16_t T1a_max_up;\r
-    uint16_t Ta4_min;\r
-    uint16_t Ta4_max;\r
-\r
-    uint8_t enableCP;    /**<  enable C-plane */\r
-    uint8_t cp_vlan_tag; /**<  C-plane vlan tag */\r
-    uint8_t up_vlan_tag; /**<  U-plane vlan tag */\r
-\r
-    int32_t debugStop;\r
-    int32_t debugStopCount;\r
-    int32_t bbdevMode;\r
-    int32_t DynamicSectionEna;\r
-    int32_t GPS_Alpha;\r
-    int32_t GPS_Beta;\r
-\r
-    uint8_t  mu_number;       /**< Mu numner as per 3GPP */\r
-    uint32_t nDLAbsFrePointA; /**< Abs Freq Point A of the Carrier Center Frequency for in KHz Value: 450000->52600000 */\r
-    uint32_t nULAbsFrePointA; /**< Abs Freq Point A of the Carrier Center Frequency for in KHz Value: 450000->52600000 */\r
-    uint32_t nDLBandwidth;    /**< Carrier bandwidth for in MHz. Value: 5->400 */\r
-    uint32_t nULBandwidth;    /**< Carrier bandwidth for in MHz. Value: 5->400 */\r
-    uint32_t nDLFftSize;      /**< DL FFT size */\r
-    uint32_t nULFftSize;      /**< UL FFT size */\r
-\r
-\r
-    uint8_t nFrameDuplexType;\r
-    uint8_t nTddPeriod;\r
-    struct xran_slot_config sSlotConfig[XRAN_MAX_TDD_PERIODICITY];\r
-    struct xran_prb_map PrbMapDl;\r
-    struct xran_prb_map PrbMapUl;\r
-} RuntimeConfig;\r
-\r
-/**\r
- * Parse application configuration file.\r
- *\r
- * @param filename The name of the configuration file to be parsed.\r
- * @param config The configuration structure to be filled with parsed data. */\r
-int parseConfigFile(char *filename, RuntimeConfig *config);\r
-\r
-#endif /* _SAMPLEAPP__CONFIG_H_ */\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
+ * @file
+ * @ingroup
+ * @author Intel Corporation
+ **/
+
+#ifndef _SAMPLEAPP__CONFIG_H_
+#define _SAMPLEAPP__CONFIG_H_
+
+#include <stdint.h>
+#include <rte_ether.h>
+#include "xran_fh_o_du.h"
+
+/** Run time configuration of application */
+typedef struct _RuntimeConfig
+{
+    uint8_t appMode;      /**< Application mode: lls-CU or RU  */
+    uint8_t xranCat;     /**< xran mode: Categoty A | Category B */
+    uint8_t numCC;        /**< Number of CC per ports supported by RU */
+    uint8_t numAxc;       /**< Number of Antenna Carriers per CC */
+    uint8_t numUlAxc;     /**< Number of Antenna Carriers per CC for UL (Cat B) */
+    uint32_t antElmTRx;   /**< Number of antenna elements for TX and RX */
+    uint32_t muMimoUEs;   /**< Number of UEs (with 1 RX ant)/beams */
+
+    uint32_t DlLayersPerUe; /**< Number of DL layer per UE */
+    uint32_t UlLayersPerUe; /**< Number of UL layer per UE */
+
+    uint32_t ttiPeriod;   /**< TTI period */
+    uint32_t testVect;    /**< Test Signal to send */
+    struct ether_addr o_du_addr; /**<  lls-CU Ethernet Mac Address */
+    struct ether_addr o_ru_addr; /**<  RU Ethernet Mac Address */
+    struct ether_addr tmp_addr; /**<  Temp Ethernet Mac Address */
+
+    uint32_t instance_id; /**<  Instance ID of application */
+    uint32_t io_core; /**<  Core used for IO */
+    uint64_t system_core; /* <system core ID> */
+    uint64_t pkt_proc_core;
+    uint64_t pkt_aux_core;
+    uint64_t timing_core;
+    
+    uint32_t mtu; /**< maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single
+                       xRAN network layer transaction. supported 1500 bytes and 9600 bytes (Jumbo Frame) */
+    int numSlots;  /**< number of slots in IQ vector */
+    char ant_file[XRAN_MAX_SECTOR_NR*XRAN_MAX_ANTENNA_NR][512]; /**<  file to use for test vector */
+    char prach_file[XRAN_MAX_SECTOR_NR*XRAN_MAX_ANTENNA_NR][512]; /**<  file to use for test vector */
+
+    char dl_bfw_file [XRAN_MAX_SECTOR_NR*XRAN_MAX_ANTENNA_NR][512]; /**< file with beamforming weights for DL streams */
+    char ul_bfw_file [XRAN_MAX_SECTOR_NR*XRAN_MAX_ANTENNA_NR][512]; /**< file with beamforming weights for UL streams */
+
+    char ul_srs_file [XRAN_MAX_SECTOR_NR*XRAN_MAX_ANT_ARRAY_ELM_NR][512]; /**< file with SRS content for UL antenna elements */
+
+    /* prach config */
+    uint8_t enablePrach; /**<  enable PRACH */
+    uint8_t prachOffset; /**< Sets the PRACH position in frequency / subcarrier position, n_PRBoffset^RA and is expressed as a physical resource block number.
+                              Set by SIB2, prach-FreqOffset in E-UTRA. */
+
+    uint8_t prachConfigIndex; /**< TS36.211 - Table 5.7.1-2 : PRACH Configuration Index */
+    uint8_t iqswap; /**< do swap of IQ before send to ETH */
+    uint8_t nebyteorderswap; /**< do swap of byte order from host byte order to network byte order. ETH */
+    uint8_t compression;     /**< enable use case with compression */
+
+    uint16_t totalBfWeights; /**< The total number of beamforming weights on RU */
+
+    uint8_t enableSrs; /**< enable SRS (valid for Cat B only) */
+    uint16_t srsSymMask; /**< SRS symbol mask [014] within S/U slot [0-13] def is  13 */
+
+    uint16_t maxFrameId; /**< max value of frame id */
+
+    uint16_t Tadv_cp_dl;
+    uint16_t T2a_min_cp_dl;
+    uint16_t T2a_max_cp_dl;
+    uint16_t T2a_min_cp_ul;
+    uint16_t T2a_max_cp_ul;
+    uint16_t T2a_min_up;
+    uint16_t T2a_max_up;
+    uint16_t Ta3_min;
+    uint16_t Ta3_max;
+    uint16_t T1a_min_cp_dl;
+    uint16_t T1a_max_cp_dl;
+    uint16_t T1a_min_cp_ul;
+    uint16_t T1a_max_cp_ul;
+    uint16_t T1a_min_up;
+    uint16_t T1a_max_up;
+    uint16_t Ta4_min;
+    uint16_t Ta4_max;
+
+    uint8_t enableCP;    /**<  enable C-plane */
+    uint8_t cp_vlan_tag; /**<  C-plane vlan tag */
+    uint8_t up_vlan_tag; /**<  U-plane vlan tag */
+
+    int32_t debugStop;
+    int32_t debugStopCount;
+    int32_t bbdevMode;
+    int32_t DynamicSectionEna;
+    int32_t GPS_Alpha;
+    int32_t GPS_Beta;
+
+    uint8_t  mu_number;       /**< Mu numner as per 3GPP */
+    uint32_t nDLAbsFrePointA; /**< Abs Freq Point A of the Carrier Center Frequency for in KHz Value: 450000->52600000 */
+    uint32_t nULAbsFrePointA; /**< Abs Freq Point A of the Carrier Center Frequency for in KHz Value: 450000->52600000 */
+    uint32_t nDLBandwidth;    /**< Carrier bandwidth for in MHz. Value: 5->400 */
+    uint32_t nULBandwidth;    /**< Carrier bandwidth for in MHz. Value: 5->400 */
+    uint32_t nDLFftSize;      /**< DL FFT size */
+    uint32_t nULFftSize;      /**< UL FFT size */
+
+
+    uint8_t nFrameDuplexType;
+    uint8_t nTddPeriod;
+    struct xran_slot_config sSlotConfig[XRAN_MAX_TDD_PERIODICITY];
+    struct xran_prb_map PrbMapDl;
+    struct xran_prb_map PrbMapUl;
+} RuntimeConfig;
+
+/**
+ * Parse application configuration file.
+ *
+ * @param filename The name of the configuration file to be parsed.
+ * @param config The configuration structure to be filled with parsed data. */
+int parseConfigFile(char *filename, RuntimeConfig *config);
+
+#endif /* _SAMPLEAPP__CONFIG_H_ */