xran_cp_api.h

Go to the documentation of this file.

/******************************************************************************
*
*   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.
*
*******************************************************************************/

#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 */


enum xran_cp_sectiontype {
    XRAN_CP_SECTIONTYPE_0   = 0,    
    XRAN_CP_SECTIONTYPE_1   = 1,    
    XRAN_CP_SECTIONTYPE_3   = 3,    
    XRAN_CP_SECTIONTYPE_5   = 5,    
    XRAN_CP_SECTIONTYPE_6   = 6,    
    XRAN_CP_SECTIONTYPE_7   = 7,    
    XRAN_CP_SECTIONTYPE_MAX
    };

enum xran_cp_filterindex {
    XRAN_FILTERINDEX_STANDARD   = 0,    
    XRAN_FILTERINDEX_PRACH_012  = 1,    
    XRAN_FILTERINDEX_PRACH_3    = 2,    
    XRAN_FILTERINDEX_PRACH_ABC  = 3,    
    XRAN_FILTERINDEX_NPRACH     = 4,    
    XRAN_FILTERINDEX_MAX
    };

#define XRAN_SLOTID_MAX                     16

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
    };

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
    };

enum xran_cp_rbindicator {
    XRAN_RBIND_EVERY        = 0,    
    XRAN_RBIND_EVERYOTHER   = 1,    
    XRAN_RBIND_MAX
    };

enum xran_cp_symbolnuminc {
    XRAN_SYMBOLNUMBER_NOTINC    = 0,      
    XRAN_SYMBOLNUMBER_INC       = 1,      
    XRAN_SYMBOLNUMBER_INC_MAX
    };

#define XRAN_CONVERT_NUMPRBC(x)             ((x) > 255 ? 0 : (x))

#define XRAN_CONVERT_IQWIDTH(x)             ((x) > 15 ? 0 : (x))

#define XRAN_SYMBOLNUMBER_MIN               1

#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



enum xran_cp_sectionextcmd {
    XRAN_CP_SECTIONEXTCMD_0 = 0,    
    XRAN_CP_SECTIONEXTCMD_1 = 1,    
    XRAN_CP_SECTIONEXTCMD_2 = 2,    
    XRAN_CP_SECTIONEXTCMD_3 = 3,    
    XRAN_CP_SECTIONEXTCMD_4 = 4,    
    XRAN_CP_SECTIONEXTCMD_5 = 5,    
    XRAN_CP_SECTIONEXTCMD_MAX       /* 6~127 reserved for future use */
    };

#define XRAN_CONVERT_BFWIQWIDTH(x)          ((x) > 15 ? 0 : (x))

enum xran_cp_bfw_compression_method {
    XRAN_BFWCOMPMETHOD_NONE         = 0,    
    XRAN_BFWCOMPMETHOD_BLKFLOAT     = 1,    
    XRAN_BFWCOMPMETHOD_BLKSCALE     = 2,    
    XRAN_BFWCOMPMETHOD_ULAW         = 3,    
    XRAN_BFWCOMPMETHOD_BEAMSPACE    = 4,    
    XRAN_BFWCOMPMETHOD_MAX                  /* reserved for future methods */
    };

enum xran_cp_bfa_bitwidth {
    XRAN_BFABITWIDTH_NO             = 0,    
    XRAN_BFABITWIDTH_2BIT           = 1,    
    XRAN_BFABITWIDTH_3BIT           = 2,    
    XRAN_BFABITWIDTH_4BIT           = 3,    
    XRAN_BFABITWIDTH_5BIT           = 4,    
    XRAN_BFABITWIDTH_6BIT           = 5,    
    XRAN_BFABITWIDTH_7BIT           = 6,    
    XRAN_BFABITWIDTH_8BIT           = 7,    
    };

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;
    struct xran_section_desc sec_desc[XRAN_NUM_OF_SYMBOL_PER_SLOT];
};


struct xran_sectionext1_info {
    uint16_t    rbNumber;                   
    uint16_t    bfwNumber;                  
    uint8_t     bfwiqWidth;
    uint8_t     bfwCompMeth;
    int16_t     *p_bfwIQ;                   
    int16_t     bfwIQ_sz;                   
    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;
    };


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 */
    };

struct xran_section_gen_info {
    struct xran_section_info info;  
    uint32_t    exDataSize;         
    struct {
        uint16_t    type;           
        uint16_t    len;            
        void        *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];
};


struct xran_cp_gen_params {
    uint8_t     dir;            
    uint8_t     sectionType;    
    uint16_t    numSections;    
    struct xran_cp_header_params hdr;
    struct xran_section_gen_info *sections;
    };

struct xran_cp_rbmap_list {
    uint16_t    grp_id;     
    uint8_t     sym_start;  
    uint8_t     sym_num;    
    uint16_t    rb_start;   
    uint16_t    rb_num;     
    int16_t     iq_buff_offset; 
    int16_t     iq_buff_len;    
    uint16_t    beam_id;    
    uint8_t     iqWidth;    
    uint8_t     comp_meth;  
    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,    
                                       uint16_t  ext1_dst_len, 
                                       int16_t  *p_bfw_iq_src, 
                                       uint16_t  rbNumber,     
                                       uint16_t  bfwNumber,    
                                       uint8_t   bfwiqWidth,   
                                       uint8_t   bfwCompMeth); 
#ifdef __cplusplus
}
#endif

#endif /* _XRAN_CP_API_H_ */