-/******************************************************************************\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 definitions for Control Plane Messages APIs.\r
- *\r
- * @file xran_cp_api.h\r
- * @ingroup group_lte_source_xran\r
- * @author Intel Corporation\r
- *\r
- **/\r
-\r
-#ifndef _XRAN_CP_API_H_\r
-#define _XRAN_CP_API_H_\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-\r
-#include "xran_fh_o_du.h"\r
-#include "xran_pkt_cp.h"\r
-#include "xran_transport.h"\r
-\r
-#define XRAN_MAX_SECTIONDB_CTX 2\r
-\r
-#define XRAN_MAX_NUM_EXTENSIONS XRAN_MAX_PRBS /* Maximum number of extensions in a section [up to 1 ext section per RB]*/\r
-#define XRAN_MAX_NUM_UE 16 /* Maximum number of UEs/Lyaers */\r
-#define XRAN_MAX_NUM_ANT_BF 64 /* Maximum number of beamforming antenna,\r
- * could be defined as XRAN_MAX_ANTENNA_NR */\r
-/* Maximum total number of beamforming weights (5.4.7.1.2) */\r
-#define XRAN_MAX_BFW_N (XRAN_MAX_NUM_ANT_BF*XRAN_MAX_NUM_UE)\r
-#define XRAN_MAX_MODCOMP_ADDPARMS 6 /* max should be even number */\r
-\r
-#define XRAN_SECTIONEXT_ALIGN 4 /* alignment size in byte for section extension */\r
-\r
-\r
-/** Control Plane section types, defined in 5.4 Table 5.1 */\r
-enum xran_cp_sectiontype {\r
- XRAN_CP_SECTIONTYPE_0 = 0, /**< Unused RB or Symbols in DL or UL, not supported */\r
- XRAN_CP_SECTIONTYPE_1 = 1, /**< Most DL/UL Radio Channels */\r
- XRAN_CP_SECTIONTYPE_3 = 3, /**< PRACH and Mixed-numerology Channels */\r
- XRAN_CP_SECTIONTYPE_5 = 5, /**< UE scheduling information, not supported */\r
- XRAN_CP_SECTIONTYPE_6 = 6, /**< Channel Information, not supported */\r
- XRAN_CP_SECTIONTYPE_7 = 7, /**< LAA, not supported */\r
- XRAN_CP_SECTIONTYPE_MAX\r
- };\r
-\r
-/** Filter index, defined in 5.4.4.3 */\r
-enum xran_cp_filterindex {\r
- XRAN_FILTERINDEX_STANDARD = 0, /**< UL filter for standard channel */\r
- XRAN_FILTERINDEX_PRACH_012 = 1, /**< UL filter for PRACH preamble format 0, 1, 2 */\r
- XRAN_FILTERINDEX_PRACH_3 = 2, /**< UL filter for PRACH preamble format 3 */\r
- XRAN_FILTERINDEX_PRACH_ABC = 3, /**< UL filter for PRACH preamble format A1~3, B1~4, C0, C2 */\r
- XRAN_FILTERINDEX_NPRACH = 4, /**< UL filter for NPRACH */\r
- XRAN_FILTERINDEX_MAX\r
- };\r
-\r
-/** Maximum Slot Index, defined in 5.4.4.6 */\r
-#define XRAN_SLOTID_MAX 16\r
-\r
-/** FFT size in frame structure, defined in 5.4.4.13 Table 5.9 */\r
-enum xran_cp_fftsize {\r
- XRAN_FFTSIZE_128 = 7, /* 128 */\r
- XRAN_FFTSIZE_256 = 8, /* 256 */\r
- XRAN_FFTSIZE_512 = 9, /* 512 */\r
- XRAN_FFTSIZE_1024 = 10, /* 1024 */\r
- XRAN_FFTSIZE_2048 = 11, /* 2048 */\r
- XRAN_FFTSIZE_4096 = 12, /* 4096 */\r
- XRAN_FFTSIZE_1536 = 13, /* 1536 */\r
- XRAN_FFTSIZE_MAX\r
- };\r
-\r
-/** Sub-carrier spacing, defined in 5.4.4.13 Table 5.10 */\r
-enum xran_cp_subcarrierspacing { /*3GPP u, SCS, Nslot, Slot len */\r
- XRAN_SCS_15KHZ = 0, /* 0, 15kHz, 1, 1ms */\r
- XRAN_SCS_30KHZ = 1, /* 1, 30kHz, 2, 500us */\r
- XRAN_SCS_60KHZ = 2, /* 2, 60kHz, 4, 250us */\r
- XRAN_SCS_120KHZ = 3, /* 3, 120kHz, 8, 125us */\r
- XRAN_SCS_240KHZ = 4, /* 4, 240kHz, 16, 62.5us */\r
- XRAN_SCS_1P25KHZ = 12, /* NA, 1.25kHz, 1, 1ms */\r
- XRAN_SCS_3P75KHZ = 13, /* NA, 3.75kHz, 1, 1ms */\r
- XRAN_SCS_5KHZ = 14, /* NA, 5kHz, 1, 1ms */\r
- XRAN_SCS_7P5KHZ = 15, /* NA, 7.5kHz, 1, 1ms */\r
- XRAN_SCS_MAX\r
- };\r
-\r
-/** Resource block indicator, defined in 5.4.5.2 */\r
-enum xran_cp_rbindicator {\r
- XRAN_RBIND_EVERY = 0, /**< every RB used */\r
- XRAN_RBIND_EVERYOTHER = 1, /**< every other RB used */\r
- XRAN_RBIND_MAX\r
- };\r
-\r
-/** Symbol number increment command, defined in 5.4.5.3 */\r
-enum xran_cp_symbolnuminc {\r
- XRAN_SYMBOLNUMBER_NOTINC = 0, /**< do not increment the current symbol number */\r
- XRAN_SYMBOLNUMBER_INC = 1, /**< increment the current symbol number and use that */\r
- XRAN_SYMBOLNUMBER_INC_MAX\r
- };\r
-\r
-/** Macro to convert the number of PRBs as defined in 5.4.5.6 */\r
-#define XRAN_CONVERT_NUMPRBC(x) ((x) > 255 ? 0 : (x))\r
-\r
-#define XRAN_CONVERT_IQWIDTH(x) ((x) > 15 ? 0 : (x))\r
-\r
-/** Minimum number of symbols, defined in 5.4.5.7 */\r
-#define XRAN_SYMBOLNUMBER_MIN 1\r
-/** Maximum number of symbols, defined in 5.4.5.7 */\r
-#define XRAN_SYMBOLNUMBER_MAX 14\r
-\r
-/* LAA message type 5.4.5.14 Table 5.11, not supported */\r
-#define XRAN_LAAMSGTYPE_LBT_PDSCH_REQ 0\r
-#define XRAN_LAAMSGTYPE_LBT_DRS_REQ 1\r
-#define XRAN_LAAMSGTYPE_LBT_PDSCH_RSP 2\r
-#define XRAN_LAAMSGTYPE_LBT_DRS_RSP 3\r
-#define XRAN_LAAMSGTYPE_LBT_BUFFER_ERROR 4\r
-#define XRAN_LAAMSGTYPE_LBT_CWCONFIG_REQ 5\r
-#define XRAN_LAAMSGTYPE_LBT_CWCONFIG_RSP 6\r
-\r
-#define XRAN_LBTMODE_FULL 0\r
-#define XRAN_LBTMODE_PARTIAL25 1\r
-#define XRAN_LBTMODE_PARTIAL34 2\r
-#define XRAN_LBTMODE_FULLSTOP 3\r
-\r
-#define XRAN_EF_F_LAST 0\r
-#define XRAN_EF_F_ANOTHER_ONE 1\r
-\r
-\r
-\r
-/** Control Plane section extension commands, defined in 5.4.6 Table 5.13 */\r
-enum xran_cp_sectionextcmd {\r
- XRAN_CP_SECTIONEXTCMD_0 = 0, /**< Reserved, for future use */\r
- XRAN_CP_SECTIONEXTCMD_1 = 1, /**< Beamforming weights */\r
- XRAN_CP_SECTIONEXTCMD_2 = 2, /**< Beamforming attributes */\r
- XRAN_CP_SECTIONEXTCMD_3 = 3, /**< DL Precoding configuration parameters and indications, not supported */\r
- XRAN_CP_SECTIONEXTCMD_4 = 4, /**< Modulation compression parameter */\r
- XRAN_CP_SECTIONEXTCMD_5 = 5, /**< Modulation compression additional scaling parameters */\r
- XRAN_CP_SECTIONEXTCMD_MAX /* 6~127 reserved for future use */\r
- };\r
-\r
-/** Macro to convert bfwIqWidth defined in 5.4.7.1.1, Table 5-15 */\r
-#define XRAN_CONVERT_BFWIQWIDTH(x) ((x) > 15 ? 0 : (x))\r
-\r
-/** Beamforming Weights Compression Method 5.4.7.1.1, Table 5-16 */\r
-enum xran_cp_bfw_compression_method {\r
- XRAN_BFWCOMPMETHOD_NONE = 0, /**< Uncopressed I/Q value */\r
- XRAN_BFWCOMPMETHOD_BLKFLOAT = 1, /**< I/Q mantissa value */\r
- XRAN_BFWCOMPMETHOD_BLKSCALE = 2, /**< I/Q scaled value */\r
- XRAN_BFWCOMPMETHOD_ULAW = 3, /**< compressed I/Q value */\r
- XRAN_BFWCOMPMETHOD_BEAMSPACE = 4, /**< beamspace I/Q coefficient */\r
- XRAN_BFWCOMPMETHOD_MAX /* reserved for future methods */\r
- };\r
-\r
-/** Beamforming Attributes Bitwidth 5.4.7.2.1 */\r
-enum xran_cp_bfa_bitwidth {\r
- XRAN_BFABITWIDTH_NO = 0, /**< the filed is no applicable or the default value shall be used */\r
- XRAN_BFABITWIDTH_2BIT = 1, /**< the filed is 2-bit bitwidth */\r
- XRAN_BFABITWIDTH_3BIT = 2, /**< the filed is 3-bit bitwidth */\r
- XRAN_BFABITWIDTH_4BIT = 3, /**< the filed is 4-bit bitwidth */\r
- XRAN_BFABITWIDTH_5BIT = 4, /**< the filed is 5-bit bitwidth */\r
- XRAN_BFABITWIDTH_6BIT = 5, /**< the filed is 6-bit bitwidth */\r
- XRAN_BFABITWIDTH_7BIT = 6, /**< the filed is 7-bit bitwidth */\r
- XRAN_BFABITWIDTH_8BIT = 7, /**< the filed is 8-bit bitwidth */\r
- };\r
-\r
-/**\r
- * This structure contains the information to generate the section body of C-Plane message */\r
-struct xran_section_info {\r
- uint8_t type; /* type of this section */\r
- /* section type bit- */\r
- /* 0 1 3 5 6 7 length */\r
- uint8_t startSymId; /* X X X X X X 4bits */\r
- uint8_t numSymbol; /* X X X X 4bits */\r
- uint8_t symInc; /* X X X X X 1bit */\r
- uint16_t id; /* X X X X X 12bits */\r
- uint16_t reMask; /* X X X X 12bits */\r
- uint16_t startPrbc; /* X X X X X 10bits */\r
- uint16_t numPrbc; /* X X X X X 8bits */ /* will be converted to zero if >255 */\r
- uint8_t rb; /* X X X X X 1bit */\r
- uint8_t compMeth; /* X X X 4bits */\r
- uint8_t iqWidth; /* X X X 4bits */\r
- uint8_t ef; /* X X X X 1bit */\r
- int32_t freqOffset; /* X 24bits */\r
- uint16_t beamId; /* X X 15bits */\r
- uint16_t ueId; /* X X 15bits */\r
- uint16_t regFactor; /* X 16bits */\r
- uint16_t pad0;\r
- /** for U-plane */\r
- struct xran_section_desc sec_desc[XRAN_NUM_OF_SYMBOL_PER_SLOT];\r
-};\r
-\r
-\r
-struct xran_sectionext1_info {\r
- uint16_t rbNumber; /**< number RBs to ext1 chain */\r
- uint16_t bfwNumber; /**< number of bf weights in this section */\r
- uint8_t bfwiqWidth;\r
- uint8_t bfwCompMeth;\r
- int16_t *p_bfwIQ; /**< pointer to formed section extention */\r
- int16_t bfwIQ_sz; /**< size of buffer with section extention information */\r
- union {\r
- uint8_t exponent;\r
- uint8_t blockScaler;\r
- uint8_t compBitWidthShift;\r
- uint8_t activeBeamspaceCoeffMask[XRAN_MAX_BFW_N]; /* ceil(N/8)*8, should be multiple of 8 */\r
- } bfwCompParam;\r
- };\r
-\r
-struct xran_sectionext2_info {\r
- uint8_t bfAzPtWidth; /* beamforming zenith beamwidth parameter */\r
- uint8_t bfAzPt;\r
- uint8_t bfZePtWidth; /* beamforming azimuth beamwidth parameter */\r
- uint8_t bfZePt;\r
- uint8_t bfAz3ddWidth; /* beamforming zenith pointing parameter */\r
- uint8_t bfAz3dd;\r
- uint8_t bfZe3ddWidth; /* beamforming azimuth pointing parameter */\r
- uint8_t bfZe3dd;\r
-\r
- uint8_t bfAzSI;\r
- uint8_t bfZeSI;\r
- };\r
-\r
-struct xran_sectionext3_info { /* NOT SUPPORTED */\r
- uint8_t codebookIdx;\r
- uint8_t layerId;\r
- uint8_t numLayers;\r
- uint8_t txScheme;\r
- uint16_t crsReMask;\r
- uint8_t crsShift;\r
- uint8_t crsSymNum;\r
- uint16_t beamIdAP1;\r
- uint16_t beamIdAP2;\r
- uint16_t beamIdAP3;\r
- };\r
-\r
-struct xran_sectionext4_info {\r
- uint8_t csf;\r
- uint8_t pad0;\r
- uint16_t modCompScaler;\r
- };\r
-\r
-struct xran_sectionext5_info {\r
- uint8_t num_sets;\r
- struct {\r
- uint16_t csf;\r
- uint16_t mcScaleReMask;\r
- uint16_t mcScaleOffset;\r
- } mc[XRAN_MAX_MODCOMP_ADDPARMS];\r
- };\r
-\r
-struct xran_sectionext_info {\r
- uint16_t type;\r
- uint16_t len;\r
- void *data;\r
- };\r
-\r
-\r
-/**\r
- * This structure contains the information to generate the section header of C-Plane message */\r
-struct xran_cp_header_params {\r
- // common parameters\r
- uint8_t filterIdx;\r
- uint8_t frameId;\r
- uint8_t subframeId;\r
- uint8_t slotId;\r
- uint8_t startSymId;\r
- /* section type bit- */\r
- /* 0 1 3 5 6 7 length */\r
- uint8_t fftSize; /* X X 4bits */\r
- uint8_t scs; /* X X 4bits */\r
- uint8_t iqWidth; /* X X X 4bits */\r
- uint8_t compMeth; /* X X X 4bits */\r
- uint8_t numUEs; /* X 8bits */\r
- uint16_t timeOffset; /* X X 16bits */\r
- uint16_t cpLength; /* X X 16bits */\r
- };\r
-\r
-/**\r
- * This structure to hold the information to generate the sections of C-Plane message */\r
-struct xran_section_gen_info {\r
- struct xran_section_info info; /**< The information for section */\r
-\r
- uint32_t exDataSize; /**< The number of Extensions or type 6/7 data */\r
- /** the array to store section extension */\r
- struct {\r
- uint16_t type; /**< the type of section extension */\r
- uint16_t len; /**< length of extension data */\r
- void *data; /**< pointer to extension data */\r
- } exData[XRAN_MAX_NUM_EXTENSIONS];\r
- struct xran_sectionext1_info m_ext1[XRAN_MAX_NUM_EXTENSIONS];\r
- struct xran_sectionext2_info m_ext2[XRAN_MAX_NUM_EXTENSIONS];\r
- struct xran_sectionext3_info m_ext3[XRAN_MAX_NUM_EXTENSIONS];\r
- struct xran_sectionext4_info m_ext4[XRAN_MAX_NUM_EXTENSIONS];\r
- struct xran_sectionext5_info m_ext5[XRAN_MAX_NUM_EXTENSIONS];\r
-};\r
-\r
-\r
-/**\r
- * This structure to hold the information to generate a C-Plane message */\r
-struct xran_cp_gen_params {\r
- uint8_t dir; /**< UL or DL */\r
- uint8_t sectionType; /**< each section must have same type with this */\r
- uint16_t numSections; /**< the number of sections to generate */\r
-\r
- struct xran_cp_header_params hdr;\r
- /**< The information for C-Plane message header */\r
- struct xran_section_gen_info *sections;\r
- /**< Array of the section information */\r
- };\r
-\r
-/**\r
- * This structure to hold the information of RB allocation from PHY\r
- * to send data for allocated RBs only. */\r
-struct xran_cp_rbmap_list {\r
- uint16_t grp_id; /**< group id for this entry, reserved for future use */\r
-\r
- uint8_t sym_start; /**< Start symbol ID */\r
- uint8_t sym_num; /**< Number of symbols */\r
-\r
- uint16_t rb_start; /**< Start RB position */\r
- uint16_t rb_num; /**< Number of RBs */\r
-\r
- int16_t iq_buff_offset; /**< Offset within Sym for start of IQs */\r
- int16_t iq_buff_len; /**< length IQs */\r
-\r
- uint16_t beam_id; /**< Bean Index */\r
- uint8_t iqWidth; /**< I and Q width in bits */\r
- uint8_t comp_meth; /**< Compression method */\r
- uint8_t pad0;\r
- };\r
-\r
-\r
-uint16_t xran_get_cplength(int cpLength);\r
-int32_t xran_get_freqoffset(int freqOffset, int scs);\r
-\r
-int xran_prepare_ctrl_pkt(struct rte_mbuf *mbuf,\r
- struct xran_cp_gen_params *params,\r
- uint8_t CC_ID, uint8_t Ant_ID,\r
- uint8_t seq_id);\r
-\r
-int xran_parse_cp_pkt(struct rte_mbuf *mbuf,\r
- struct xran_cp_gen_params *result,\r
- struct xran_recv_packet_info *pkt_info);\r
-\r
-int xran_cp_init_sectiondb(void *pHandle);\r
-int xran_cp_free_sectiondb(void *pHandle);\r
-int xran_cp_add_section_info(void *pHandle,\r
- uint8_t dir, uint8_t cc_id, uint8_t ruport_id,\r
- uint8_t ctx_id, struct xran_section_info *info);\r
-int xran_cp_add_multisection_info(void *pHandle,\r
- uint8_t cc_id, uint8_t ruport_id, uint8_t ctx_id,\r
- struct xran_cp_gen_params *gen_info);\r
-struct xran_section_info *xran_cp_find_section_info(void *pHandle,\r
- uint8_t dir, uint8_t cc_id, uint8_t ruport_id,\r
- uint8_t ctx_id, uint16_t section_id);\r
-struct xran_section_info *xran_cp_iterate_section_info(void *pHandle,\r
- uint8_t dir, uint8_t cc_id, uint8_t ruport_id,\r
- uint8_t ctx_id, uint32_t *next);\r
-int xran_cp_getsize_section_info(void *pHandle, uint8_t dir, uint8_t cc_id, uint8_t ruport_id, uint8_t ctx_id);\r
-int xran_cp_reset_section_info(void *pHandle, uint8_t dir, uint8_t cc_id, uint8_t ruport_id, uint8_t ctx_id);\r
-int32_t xran_cp_populate_section_ext_1(int8_t *p_ext1_dst, /**< destination buffer */\r
- uint16_t ext1_dst_len, /**< dest buffer size */\r
- int16_t *p_bfw_iq_src, /**< source buffer of IQs */\r
- uint16_t rbNumber, /**< number RBs to ext1 chain */\r
- uint16_t bfwNumber, /**< number of bf weights in this set of sections */\r
- uint8_t bfwiqWidth, /**< bit size of IQs */\r
- uint8_t bfwCompMeth); /**< compression method */\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* _XRAN_CP_API_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 This file provides the definitions for Control Plane Messages APIs.
+ *
+ * @file xran_cp_api.h
+ * @ingroup group_lte_source_xran
+ * @author Intel Corporation
+ *
+ **/
+
+#ifndef _XRAN_CP_API_H_
+#define _XRAN_CP_API_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+#include "xran_fh_o_du.h"
+#include "xran_pkt_cp.h"
+#include "xran_transport.h"
+
+#define XRAN_MAX_SECTIONDB_CTX 2
+
+#define XRAN_MAX_NUM_EXTENSIONS XRAN_MAX_PRBS /* Maximum number of extensions in a section [up to 1 ext section per RB]*/
+#define XRAN_MAX_NUM_UE 16 /* Maximum number of UEs/Lyaers */
+#define XRAN_MAX_NUM_ANT_BF 64 /* Maximum number of beamforming antenna,
+ * could be defined as XRAN_MAX_ANTENNA_NR */
+/* Maximum total number of beamforming weights (5.4.7.1.2) */
+#define XRAN_MAX_BFW_N (XRAN_MAX_NUM_ANT_BF*XRAN_MAX_NUM_UE)
+#define XRAN_MAX_MODCOMP_ADDPARMS 6 /* max should be even number */
+
+#define XRAN_SECTIONEXT_ALIGN 4 /* alignment size in byte for section extension */
+
+
+/** Control Plane section types, defined in 5.4 Table 5.1 */
+enum xran_cp_sectiontype {
+ XRAN_CP_SECTIONTYPE_0 = 0, /**< Unused RB or Symbols in DL or UL, not supported */
+ XRAN_CP_SECTIONTYPE_1 = 1, /**< Most DL/UL Radio Channels */
+ XRAN_CP_SECTIONTYPE_3 = 3, /**< PRACH and Mixed-numerology Channels */
+ XRAN_CP_SECTIONTYPE_5 = 5, /**< UE scheduling information, not supported */
+ XRAN_CP_SECTIONTYPE_6 = 6, /**< Channel Information, not supported */
+ XRAN_CP_SECTIONTYPE_7 = 7, /**< LAA, not supported */
+ XRAN_CP_SECTIONTYPE_MAX
+ };
+
+/** Filter index, defined in 5.4.4.3 */
+enum xran_cp_filterindex {
+ XRAN_FILTERINDEX_STANDARD = 0, /**< UL filter for standard channel */
+ XRAN_FILTERINDEX_PRACH_012 = 1, /**< UL filter for PRACH preamble format 0, 1, 2 */
+ XRAN_FILTERINDEX_PRACH_3 = 2, /**< UL filter for PRACH preamble format 3 */
+ XRAN_FILTERINDEX_PRACH_ABC = 3, /**< UL filter for PRACH preamble format A1~3, B1~4, C0, C2 */
+ XRAN_FILTERINDEX_NPRACH = 4, /**< UL filter for NPRACH */
+ XRAN_FILTERINDEX_MAX
+ };
+
+/** Maximum Slot Index, defined in 5.4.4.6 */
+#define XRAN_SLOTID_MAX 16
+
+/** FFT size in frame structure, defined in 5.4.4.13 Table 5.9 */
+enum xran_cp_fftsize {
+ XRAN_FFTSIZE_128 = 7, /* 128 */
+ XRAN_FFTSIZE_256 = 8, /* 256 */
+ XRAN_FFTSIZE_512 = 9, /* 512 */
+ XRAN_FFTSIZE_1024 = 10, /* 1024 */
+ XRAN_FFTSIZE_2048 = 11, /* 2048 */
+ XRAN_FFTSIZE_4096 = 12, /* 4096 */
+ XRAN_FFTSIZE_1536 = 13, /* 1536 */
+ XRAN_FFTSIZE_MAX
+ };
+
+/** Sub-carrier spacing, defined in 5.4.4.13 Table 5.10 */
+enum xran_cp_subcarrierspacing { /*3GPP u, SCS, Nslot, Slot len */
+ XRAN_SCS_15KHZ = 0, /* 0, 15kHz, 1, 1ms */
+ XRAN_SCS_30KHZ = 1, /* 1, 30kHz, 2, 500us */
+ XRAN_SCS_60KHZ = 2, /* 2, 60kHz, 4, 250us */
+ XRAN_SCS_120KHZ = 3, /* 3, 120kHz, 8, 125us */
+ XRAN_SCS_240KHZ = 4, /* 4, 240kHz, 16, 62.5us */
+ XRAN_SCS_1P25KHZ = 12, /* NA, 1.25kHz, 1, 1ms */
+ XRAN_SCS_3P75KHZ = 13, /* NA, 3.75kHz, 1, 1ms */
+ XRAN_SCS_5KHZ = 14, /* NA, 5kHz, 1, 1ms */
+ XRAN_SCS_7P5KHZ = 15, /* NA, 7.5kHz, 1, 1ms */
+ XRAN_SCS_MAX
+ };
+
+/** Resource block indicator, defined in 5.4.5.2 */
+enum xran_cp_rbindicator {
+ XRAN_RBIND_EVERY = 0, /**< every RB used */
+ XRAN_RBIND_EVERYOTHER = 1, /**< every other RB used */
+ XRAN_RBIND_MAX
+ };
+
+/** Symbol number increment command, defined in 5.4.5.3 */
+enum xran_cp_symbolnuminc {
+ XRAN_SYMBOLNUMBER_NOTINC = 0, /**< do not increment the current symbol number */
+ XRAN_SYMBOLNUMBER_INC = 1, /**< increment the current symbol number and use that */
+ XRAN_SYMBOLNUMBER_INC_MAX
+ };
+
+/** Macro to convert the number of PRBs as defined in 5.4.5.6 */
+#define XRAN_CONVERT_NUMPRBC(x) ((x) > 255 ? 0 : (x))
+
+#define XRAN_CONVERT_IQWIDTH(x) ((x) > 15 ? 0 : (x))
+
+/** Minimum number of symbols, defined in 5.4.5.7 */
+#define XRAN_SYMBOLNUMBER_MIN 1
+/** Maximum number of symbols, defined in 5.4.5.7 */
+#define XRAN_SYMBOLNUMBER_MAX 14
+
+/* LAA message type 5.4.5.14 Table 5.11, not supported */
+#define XRAN_LAAMSGTYPE_LBT_PDSCH_REQ 0
+#define XRAN_LAAMSGTYPE_LBT_DRS_REQ 1
+#define XRAN_LAAMSGTYPE_LBT_PDSCH_RSP 2
+#define XRAN_LAAMSGTYPE_LBT_DRS_RSP 3
+#define XRAN_LAAMSGTYPE_LBT_BUFFER_ERROR 4
+#define XRAN_LAAMSGTYPE_LBT_CWCONFIG_REQ 5
+#define XRAN_LAAMSGTYPE_LBT_CWCONFIG_RSP 6
+
+#define XRAN_LBTMODE_FULL 0
+#define XRAN_LBTMODE_PARTIAL25 1
+#define XRAN_LBTMODE_PARTIAL34 2
+#define XRAN_LBTMODE_FULLSTOP 3
+
+#define XRAN_EF_F_LAST 0
+#define XRAN_EF_F_ANOTHER_ONE 1
+
+
+
+/** Control Plane section extension commands, defined in 5.4.6 Table 5.13 */
+enum xran_cp_sectionextcmd {
+ XRAN_CP_SECTIONEXTCMD_0 = 0, /**< Reserved, for future use */
+ XRAN_CP_SECTIONEXTCMD_1 = 1, /**< Beamforming weights */
+ XRAN_CP_SECTIONEXTCMD_2 = 2, /**< Beamforming attributes */
+ XRAN_CP_SECTIONEXTCMD_3 = 3, /**< DL Precoding configuration parameters and indications, not supported */
+ XRAN_CP_SECTIONEXTCMD_4 = 4, /**< Modulation compression parameter */
+ XRAN_CP_SECTIONEXTCMD_5 = 5, /**< Modulation compression additional scaling parameters */
+ XRAN_CP_SECTIONEXTCMD_MAX /* 6~127 reserved for future use */
+ };
+
+/** Macro to convert bfwIqWidth defined in 5.4.7.1.1, Table 5-15 */
+#define XRAN_CONVERT_BFWIQWIDTH(x) ((x) > 15 ? 0 : (x))
+
+/** Beamforming Weights Compression Method 5.4.7.1.1, Table 5-16 */
+enum xran_cp_bfw_compression_method {
+ XRAN_BFWCOMPMETHOD_NONE = 0, /**< Uncopressed I/Q value */
+ XRAN_BFWCOMPMETHOD_BLKFLOAT = 1, /**< I/Q mantissa value */
+ XRAN_BFWCOMPMETHOD_BLKSCALE = 2, /**< I/Q scaled value */
+ XRAN_BFWCOMPMETHOD_ULAW = 3, /**< compressed I/Q value */
+ XRAN_BFWCOMPMETHOD_BEAMSPACE = 4, /**< beamspace I/Q coefficient */
+ XRAN_BFWCOMPMETHOD_MAX /* reserved for future methods */
+ };
+
+/** Beamforming Attributes Bitwidth 5.4.7.2.1 */
+enum xran_cp_bfa_bitwidth {
+ XRAN_BFABITWIDTH_NO = 0, /**< the filed is no applicable or the default value shall be used */
+ XRAN_BFABITWIDTH_2BIT = 1, /**< the filed is 2-bit bitwidth */
+ XRAN_BFABITWIDTH_3BIT = 2, /**< the filed is 3-bit bitwidth */
+ XRAN_BFABITWIDTH_4BIT = 3, /**< the filed is 4-bit bitwidth */
+ XRAN_BFABITWIDTH_5BIT = 4, /**< the filed is 5-bit bitwidth */
+ XRAN_BFABITWIDTH_6BIT = 5, /**< the filed is 6-bit bitwidth */
+ XRAN_BFABITWIDTH_7BIT = 6, /**< the filed is 7-bit bitwidth */
+ XRAN_BFABITWIDTH_8BIT = 7, /**< the filed is 8-bit bitwidth */
+ };
+
+/**
+ * This structure contains the information to generate the section body of C-Plane message */
+struct xran_section_info {
+ uint8_t type; /* type of this section */
+ /* section type bit- */
+ /* 0 1 3 5 6 7 length */
+ uint8_t startSymId; /* X X X X X X 4bits */
+ uint8_t numSymbol; /* X X X X 4bits */
+ uint8_t symInc; /* X X X X X 1bit */
+ uint16_t id; /* X X X X X 12bits */
+ uint16_t reMask; /* X X X X 12bits */
+ uint16_t startPrbc; /* X X X X X 10bits */
+ uint16_t numPrbc; /* X X X X X 8bits */ /* will be converted to zero if >255 */
+ uint8_t rb; /* X X X X X 1bit */
+ uint8_t compMeth; /* X X X 4bits */
+ uint8_t iqWidth; /* X X X 4bits */
+ uint8_t ef; /* X X X X 1bit */
+ int32_t freqOffset; /* X 24bits */
+ uint16_t beamId; /* X X 15bits */
+ uint16_t ueId; /* X X 15bits */
+ uint16_t regFactor; /* X 16bits */
+ uint16_t pad0;
+ /** for U-plane */
+ struct xran_section_desc sec_desc[XRAN_NUM_OF_SYMBOL_PER_SLOT];
+};
+
+
+struct xran_sectionext1_info {
+ uint16_t rbNumber; /**< number RBs to ext1 chain */
+ uint16_t bfwNumber; /**< number of bf weights in this section */
+ uint8_t bfwiqWidth;
+ uint8_t bfwCompMeth;
+ int16_t *p_bfwIQ; /**< pointer to formed section extention */
+ int16_t bfwIQ_sz; /**< size of buffer with section extention information */
+ union {
+ uint8_t exponent;
+ uint8_t blockScaler;
+ uint8_t compBitWidthShift;
+ uint8_t activeBeamspaceCoeffMask[XRAN_MAX_BFW_N]; /* ceil(N/8)*8, should be multiple of 8 */
+ } bfwCompParam;
+ };
+
+struct xran_sectionext2_info {
+ uint8_t bfAzPtWidth; /* beamforming zenith beamwidth parameter */
+ uint8_t bfAzPt;
+ uint8_t bfZePtWidth; /* beamforming azimuth beamwidth parameter */
+ uint8_t bfZePt;
+ uint8_t bfAz3ddWidth; /* beamforming zenith pointing parameter */
+ uint8_t bfAz3dd;
+ uint8_t bfZe3ddWidth; /* beamforming azimuth pointing parameter */
+ uint8_t bfZe3dd;
+
+ uint8_t bfAzSI;
+ uint8_t bfZeSI;
+ };
+
+struct xran_sectionext3_info { /* NOT SUPPORTED */
+ uint8_t codebookIdx;
+ uint8_t layerId;
+ uint8_t numLayers;
+ uint8_t txScheme;
+ uint16_t crsReMask;
+ uint8_t crsShift;
+ uint8_t crsSymNum;
+ uint16_t beamIdAP1;
+ uint16_t beamIdAP2;
+ uint16_t beamIdAP3;
+ };
+
+struct xran_sectionext4_info {
+ uint8_t csf;
+ uint8_t pad0;
+ uint16_t modCompScaler;
+ };
+
+struct xran_sectionext5_info {
+ uint8_t num_sets;
+ struct {
+ uint16_t csf;
+ uint16_t mcScaleReMask;
+ uint16_t mcScaleOffset;
+ } mc[XRAN_MAX_MODCOMP_ADDPARMS];
+ };
+
+struct xran_sectionext_info {
+ uint16_t type;
+ uint16_t len;
+ void *data;
+ };
+
+
+/**
+ * This structure contains the information to generate the section header of C-Plane message */
+struct xran_cp_header_params {
+ // common parameters
+ uint8_t filterIdx;
+ uint8_t frameId;
+ uint8_t subframeId;
+ uint8_t slotId;
+ uint8_t startSymId;
+ /* section type bit- */
+ /* 0 1 3 5 6 7 length */
+ uint8_t fftSize; /* X X 4bits */
+ uint8_t scs; /* X X 4bits */
+ uint8_t iqWidth; /* X X X 4bits */
+ uint8_t compMeth; /* X X X 4bits */
+ uint8_t numUEs; /* X 8bits */
+ uint16_t timeOffset; /* X X 16bits */
+ uint16_t cpLength; /* X X 16bits */
+ };
+
+/**
+ * This structure to hold the information to generate the sections of C-Plane message */
+struct xran_section_gen_info {
+ struct xran_section_info info; /**< The information for section */
+
+ uint32_t exDataSize; /**< The number of Extensions or type 6/7 data */
+ /** the array to store section extension */
+ struct {
+ uint16_t type; /**< the type of section extension */
+ uint16_t len; /**< length of extension data */
+ void *data; /**< pointer to extension data */
+ } exData[XRAN_MAX_NUM_EXTENSIONS];
+ struct xran_sectionext1_info m_ext1[XRAN_MAX_NUM_EXTENSIONS];
+ struct xran_sectionext2_info m_ext2[XRAN_MAX_NUM_EXTENSIONS];
+ struct xran_sectionext3_info m_ext3[XRAN_MAX_NUM_EXTENSIONS];
+ struct xran_sectionext4_info m_ext4[XRAN_MAX_NUM_EXTENSIONS];
+ struct xran_sectionext5_info m_ext5[XRAN_MAX_NUM_EXTENSIONS];
+};
+
+
+/**
+ * This structure to hold the information to generate a C-Plane message */
+struct xran_cp_gen_params {
+ uint8_t dir; /**< UL or DL */
+ uint8_t sectionType; /**< each section must have same type with this */
+ uint16_t numSections; /**< the number of sections to generate */
+
+ struct xran_cp_header_params hdr;
+ /**< The information for C-Plane message header */
+ struct xran_section_gen_info *sections;
+ /**< Array of the section information */
+ };
+
+/**
+ * This structure to hold the information of RB allocation from PHY
+ * to send data for allocated RBs only. */
+struct xran_cp_rbmap_list {
+ uint16_t grp_id; /**< group id for this entry, reserved for future use */
+
+ uint8_t sym_start; /**< Start symbol ID */
+ uint8_t sym_num; /**< Number of symbols */
+
+ uint16_t rb_start; /**< Start RB position */
+ uint16_t rb_num; /**< Number of RBs */
+
+ int16_t iq_buff_offset; /**< Offset within Sym for start of IQs */
+ int16_t iq_buff_len; /**< length IQs */
+
+ uint16_t beam_id; /**< Bean Index */
+ uint8_t iqWidth; /**< I and Q width in bits */
+ uint8_t comp_meth; /**< Compression method */
+ uint8_t pad0;
+ };
+
+
+uint16_t xran_get_cplength(int cpLength);
+int32_t xran_get_freqoffset(int freqOffset, int scs);
+
+int xran_prepare_ctrl_pkt(struct rte_mbuf *mbuf,
+ struct xran_cp_gen_params *params,
+ uint8_t CC_ID, uint8_t Ant_ID,
+ uint8_t seq_id);
+
+int xran_parse_cp_pkt(struct rte_mbuf *mbuf,
+ struct xran_cp_gen_params *result,
+ struct xran_recv_packet_info *pkt_info);
+
+int xran_cp_init_sectiondb(void *pHandle);
+int xran_cp_free_sectiondb(void *pHandle);
+int xran_cp_add_section_info(void *pHandle,
+ uint8_t dir, uint8_t cc_id, uint8_t ruport_id,
+ uint8_t ctx_id, struct xran_section_info *info);
+int xran_cp_add_multisection_info(void *pHandle,
+ uint8_t cc_id, uint8_t ruport_id, uint8_t ctx_id,
+ struct xran_cp_gen_params *gen_info);
+struct xran_section_info *xran_cp_find_section_info(void *pHandle,
+ uint8_t dir, uint8_t cc_id, uint8_t ruport_id,
+ uint8_t ctx_id, uint16_t section_id);
+struct xran_section_info *xran_cp_iterate_section_info(void *pHandle,
+ uint8_t dir, uint8_t cc_id, uint8_t ruport_id,
+ uint8_t ctx_id, uint32_t *next);
+int xran_cp_getsize_section_info(void *pHandle, uint8_t dir, uint8_t cc_id, uint8_t ruport_id, uint8_t ctx_id);
+int xran_cp_reset_section_info(void *pHandle, uint8_t dir, uint8_t cc_id, uint8_t ruport_id, uint8_t ctx_id);
+int32_t xran_cp_populate_section_ext_1(int8_t *p_ext1_dst, /**< destination buffer */
+ uint16_t ext1_dst_len, /**< dest buffer size */
+ int16_t *p_bfw_iq_src, /**< source buffer of IQs */
+ uint16_t rbNumber, /**< number RBs to ext1 chain */
+ uint16_t bfwNumber, /**< number of bf weights in this set of sections */
+ uint8_t bfwiqWidth, /**< bit size of IQs */
+ uint8_t bfwCompMeth); /**< compression method */
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _XRAN_CP_API_H_ */
Code Review / o-du / phy.git / blobdiff