src/cm/du_app_mac_inf.h

   1 /*******************************************************************************
   2 ################################################################################
   3 #   Copyright (c) [2017-2019] [Radisys]                                        #
   4 #                                                                              #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");            #
   6 #   you may not use this file except in compliance with the License.           #
   7 #   You may obtain a copy of the License at                                    #
   8 #                                                                              #
   9 #       http://www.apache.org/licenses/LICENSE-2.0                             #
  10 #                                                                              #
  11 #   Unless required by applicable law or agreed to in writing, software        #
  12 #   distributed under the License is distributed on an "AS IS" BASIS,          #
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
  14 #   See the License for the specific language governing permissions and        #
  15 #   limitations under the License.                                             #
  16 ################################################################################
  17 *******************************************************************************/
  18
  19 /* Defines APIs exchanged between du_app and cl module of MAC */
  20 #ifndef __MACINT_H__
  21 #define __MACINT_H__
  22
  23 #define NUM_NUMEROLOGY 5  /* Number of numerology */
  24 #define MAXIMUM_TDD_PERIODICITY 5
  25 #define MAX_SYMB_PER_SLOT 14
  26
  27 #define NUM_SSB         1       /* max value is 64 */
  28 #define SSB_MASK_SIZE   1       /* SSB mask size is 32bit for sub6 */
  29 #define SIB1_NEW_TX_PERIOD      160
  30 #define SIB1_REPETITION_PERIOD   20
  31 #define CORESET_0_INDEX      0
  32 #define CORESET_1_INDEX      1
  33 #define CORESET_2_INDEX      2
  34 #define CORESET_3_INDEX      3
  35 #define CORESET_4_INDEX      4
  36 #define SEARCHSPACE_0_INDEX   0
  37 #define SEARCHSPACE_1_INDEX   1
  38 #define SEARCHSPACE_2_INDEX   2
  39 #define SEARCHSPACE_3_INDEX   3
  40 #define SEARCHSPACE_4_INDEX   4
  41 #define SS_MONITORING_SLOT_SL1   0 /* all slots */
  42 #define SS_MONITORING_SYMBOL     0x2000; /* symbol-0, set 14th bit */
  43 #define SIB1_MCS  4
  44
  45 /* Macros for coupling */
  46 #define DU_MAC_LC  0
  47 #define DU_MAC_TC  1
  48 #define DU_MAC_LWLC  2
  49
  50 /* Event IDs */
  51 #define EVENT_MAC_CELL_CONFIG_REQ    200
  52 #define EVENT_MAC_CELL_CONFIG_CFM    201
  53 #define EVENT_MAC_CELL_START_REQ     202
  54 #define EVENT_MAC_CELL_STOP_REQ      203
  55 #define EVENT_MAC_SLOT_IND           204
  56 #define EVENT_MAC_STOP_IND           205
  57 #define EVENT_MAC_UL_CCCH_IND        206
  58 #define EVENT_MAC_DL_CCCH_IND        207
  59
  60 typedef enum
  61 {
  62    DUP_MODE_FDD,
  63    DUP_MODE_TDD
  64 }DuplexMode;
  65
  66 typedef enum
  67 {
  68    MAC_GEN_FULL_PBCH_PAYLD,   /* MAC generated the full PBCH Payload */
  69    PHY_GEN_TIMING_PBCH_BIT,   /* PHY generates the timing PBCH bits */
  70    PHY_GEN_FULL_PBCH_PAYLD    /* PHY generates full PBCH payload */
  71 }BchPduOpt;
  72
  73 typedef enum
  74 {
  75    LONG_SEQUENCE,
  76    SHORT_SEQUENCE
  77 }PrachSeqLen;
  78
  79 typedef enum
  80 {
  81    UNRESTRICTED,
  82    RESTRICTED_SET_TYPE_A,
  83    RESTRICTED_SET_TYPE_B
  84 }RstSetCfg;
  85
  86 typedef enum
  87 {
  88    DONT_REPORT_RSSI,
  89    RSSI_UNIT_DBM,
  90    RSSI_UNIT_DBFS
  91 }RSSIMeasUnit;
  92
  93 typedef enum
  94 {
  95    DL_SLOT,
  96    UL_SLOT,
  97    GUARD_SLOT
  98 }SlotConfig;
  99
 100 typedef enum
 101 {
 102    TX_PRDCTY_MS_0P5,
 103    TX_PRDCTY_MS_0P625,
 104    TX_PRDCTY_MS_1,
 105    TX_PRDCTY_MS_1P25,
 106    TX_PRDCTY_MS_2,
 107    TX_PRDCTY_MS_2P5,
 108    TX_PRDCTY_MS_5,
 109    TX_PRDCTY_MS_10
 110 }DlUlTxPeriodicity;
 111
 112 typedef enum
 113 {
 114    BETA_PSS_0DB,
 115    BETA_PSS_1DB
 116 }BetaPss;
 117
 118 typedef enum
 119 {
 120    SSB_PRDCTY_MS_5,
 121    SSB_PRDCTY_MS_10,
 122    SSB_PRDCTY_MS_20,
 123    SSB_PRDCTY_MS_40,
 124    SSB_PRDCTY_MS_80,
 125    SSB_PRDCTY_MS_160
 126 }SSBPeriod;
 127
 128 typedef enum
 129 {
 130    RRC_REJECT,
 131    RRC_SETUP
 132 }DlCcchMsgType;
 133
 134 typedef struct carrierCfg
 135 {
 136    Bool  pres;
 137    U16   bw;             /* DL/UL bandwidth */
 138    U32   freq;           /* Absolute frequency of DL/UL point A in KHz */
 139    U16   k0[NUM_NUMEROLOGY];          /* K0 for DL/UL */
 140    U16   gridSize[NUM_NUMEROLOGY];    /* DL/UL Grid size for each numerologies */
 141    U16   numAnt;         /* Number of Tx/Rx antennas */
 142 }CarrierCfg;
 143
 144 typedef struct ssbCfg
 145 {
 146    uint32_t    ssbPbchPwr;       /* SSB block power */
 147    BchPduOpt   bchPayloadFlag;   /* Options for generation of payload */
 148    uint8_t     scsCmn;           /* subcarrier spacing for common */
 149    uint16_t    ssbOffsetPointA;  /* SSB subcarrier offset from point A */
 150    BetaPss     betaPss;
 151    SSBPeriod   ssbPeriod;        /* SSB Periodicity in msec */
 152    uint8_t     ssbScOffset;       /* Subcarrier Offset */
 153    uint8_t     mibPdu[3];           /* MIB payload */
 154    uint32_t    ssbMask[SSB_MASK_SIZE];      /* Bitmap for actually transmitted SSB. */
 155    uint8_t     beamId[NUM_SSB];
 156    Bool        multCarrBand;     /* Multiple carriers in a band */
 157    Bool        multCellCarr;     /* Multiple cells in single carrier */
 158 }SsbCfg;
 159
 160 typedef struct fdmInfo
 161 {
 162    U16   rootSeqIdx;        /* Root sequence index */
 163    U8    numRootSeq;        /* Number of root sequences required for FD */
 164    U16   k1;                /* Frequency Offset for each FD */
 165    U8    zeroCorrZoneCfg;   /* Zero correlation zone cofig */
 166    U8    numUnusedRootSeq;  /* Number of unused root sequence */
 167    U8    *unsuedRootSeq;     /* Unused root sequence per FD */
 168 }PrachFdmInfo;
 169
 170 typedef struct prachCfg
 171 {
 172    Bool          pres;
 173         uint8_t       prachCfgIdx;         /* PRACH Cfg Index */
 174    PrachSeqLen   prachSeqLen;         /* RACH Sequence length: Long/short */
 175    uint8_t       prachSubcSpacing;    /* Subcarrier spacing of RACH */
 176    RstSetCfg     prachRstSetCfg;      /* PRACH restricted set config */
 177         uint16_t      msg1FreqStart;       /* Msg1-FrequencyStart */
 178    uint8_t       msg1Fdm;             /* PRACH FDM (1,2,4,8) */
 179         uint8_t       rootSeqLen;          /* Root sequence length */
 180    PrachFdmInfo  fdm[8];              /* FDM info */
 181    uint8_t       ssbPerRach;          /* SSB per RACH occassion */
 182    Bool          prachMultCarrBand;   /* Multiple carriers in Band */
 183    uint8_t       prachRestrictedSet; /* Support for PRACH restricted set */
 184         uint8_t       raContResTmr;        /* RA Contention Resoultion Timer */
 185         uint8_t       rsrpThreshSsb;       /* RSRP Threshold SSB */
 186    uint8_t       raRspWindow;         /* RA Response Window */
 187 }PrachCfg;
 188
 189 typedef struct tddCfg
 190 {
 191    Bool               pres;
 192    DlUlTxPeriodicity  tddPeriod;      /* DL UL Transmission periodicity */
 193    SlotConfig         slotCfg[MAXIMUM_TDD_PERIODICITY][MAX_SYMB_PER_SLOT];
 194 }TDDCfg;
 195
 196 typedef struct sib1CellCfg
 197 {
 198    uint8_t  *sib1Pdu;
 199    uint16_t sib1PduLen;
 200    uint16_t sib1NewTxPeriod;
 201    uint16_t sib1RepetitionPeriod;
 202    uint8_t coresetZeroIndex;     /* derived from 4 LSB of pdcchSib1 present in MIB */
 203    uint8_t searchSpaceZeroIndex; /* derived from 4 MSB of pdcchSib1 present in MIB */
 204    uint16_t sib1Mcs;
 205 } Sib1CellCfg;
 206
 207 typedef struct bwpParams
 208 {
 209    uint16_t firstPrb;
 210    uint16_t numPrb;
 211         uint8_t  scs;
 212         uint8_t  cyclicPrefix;
 213 }BwpParams;
 214
 215 typedef struct candidatesInfo
 216 {
 217    uint8_t aggLevel1;
 218    uint8_t aggLevel2;
 219    uint8_t aggLevel4;
 220    uint8_t aggLevel8;
 221    uint8_t aggLevel16;
 222 }CandidatesInfo;
 223
 224 typedef struct searchSpaceCfg
 225 {
 226    uint8_t searchSpaceId;
 227         uint8_t coresetId;
 228         uint16_t monitoringSlot;
 229         uint16_t duration;
 230         uint16_t monitoringSymbol;
 231         CandidatesInfo candidate;
 232 }SearchSpaceCfg;
 233
 234 typedef struct pdcchConfigCommon
 235 {
 236    /* only one search space is configured during SIB1 */
 237    SearchSpaceCfg commonSearchSpace;
 238    uint8_t raSearchSpaceId;
 239 }PdcchConfigCommon;
 240
 241 typedef struct pdschConfigCommon
 242 {
 243    uint8_t k0;
 244         uint8_t mappingType;
 245         uint8_t startSymbol;
 246         uint8_t lengthSymbol;
 247 }PdschConfigCommon;
 248
 249 typedef struct puschConfigCommon
 250 {
 251    /* PUSCH-TimeDomainResourceAllocation info */
 252    uint8_t k2;
 253         uint8_t mappingType;
 254         uint8_t startSymbol;
 255         uint8_t lengthSymbol;
 256 }PuschConfigCommon;
 257
 258 typedef struct bwpDlConfig
 259 {
 260    BwpParams      bwp;
 261         PdcchConfigCommon pdcchCommon;
 262         PdschConfigCommon pdschCommon;
 263 }BwpDlConfig;
 264
 265 typedef struct bwpUlConfig
 266 {
 267    BwpParams      bwp;
 268         // rach config common sent in PrachCfg
 269         // pucch info not required
 270         PuschConfigCommon puschCommon;
 271 }BwpUlConfig;
 272
 273 typedef struct macCellCfg
 274 {
 275         U16            transId;          /* Trans Id */
 276         U16            cellId;           /* Cell Id */
 277         U8             numTlv;           /* Number of configuration TLVs */
 278         U8             carrierId;        /* Carrired Index */
 279         U16            phyCellId;        /* Physical cell id */
 280         DuplexMode     dupType;          /* Duplex type: TDD/FDD */
 281         CarrierCfg     dlCarrCfg;        /* DL Carrier configuration */
 282         CarrierCfg     ulCarrCfg;        /* UL Carrier configuration */
 283         Bool           freqShft;         /* Indicates presence of 7.5kHz frequency shift */
 284    SsbCfg         ssbCfg;           /* SSB configuration */
 285    PrachCfg       prachCfg;         /* PRACH Configuration */
 286    TDDCfg         tddCfg;           /* TDD periodicity and slot configuration */
 287    RSSIMeasUnit   rssiUnit;         /* RSSI measurement unit */
 288    Sib1CellCfg    sib1Cfg;          /* SIB1 config */
 289         BwpDlConfig    initialDlBwp;     /* Initial DL BWP */
 290         BwpUlConfig    initialUlBwp;     /* Initial UL BWP */
 291         uint8_t        dmrsTypeAPos;     /* DMRS Type A position */
 292 }MacCellCfg;
 293
 294 typedef struct macCellCfgCfm
 295 {
 296         uint8_t        rsp;
 297    U16            transId;
 298 }MacCellCfgCfm;
 299
 300 typedef struct slotInfo
 301 {
 302    uint16_t cellId;
 303    uint16_t sfn;
 304    uint16_t slot;
 305 }SlotInfo;
 306
 307 typedef struct macCellStartInfo
 308 {
 309    uint16_t cellId;
 310 }MacCellStartInfo;
 311
 312 typedef struct macCellStopInfo
 313 {
 314    uint16_t cellId;
 315 }MacCellStopInfo;
 316
 317 typedef struct ulCcchInd
 318 {
 319    uint16_t cellId;
 320    uint16_t crnti;
 321    uint8_t  *ulCcchMsg;
 322 }UlCcchIndInfo;
 323
 324 typedef struct dlCcchInd
 325 {
 326    uint16_t      cellId;
 327    uint16_t      crnti;
 328    DlCcchMsgType msgType;
 329    uint8_t       *dlCcchMsg;
 330 }DlCcchIndInfo;
 331
 332
 333 /* Functions for slot Ind from MAC to DU APP*/
 334 typedef uint16_t (*DuMacSlotInd) ARGS((
 335    Pst       *pst,
 336    SlotInfo  *slotInfo ));
 337
 338 /* Functions for stop Ind from MAC to DU APP*/
 339 typedef uint16_t (*DuMacStopInd) ARGS((
 340    Pst       *pst,
 341    MacCellStopInfo  *cellId ));
 342
 343 /* Functions for mac cell start req */
 344 typedef uint16_t (*DuMacCellStartReq) ARGS((
 345    Pst               *pst,
 346    MacCellStartInfo  *cellStartInfo ));
 347
 348 /* Functions for mac cell stop request */
 349 typedef uint16_t (*DuMacCellStopReq) ARGS((
 350    Pst               *pst,
 351    MacCellStopInfo  *cellStopInfo ));
 352
 353 /* Function pointers for packing macCellCfg Request and Confirm */
 354 typedef int (*packMacCellCfgReq) ARGS((
 355    Pst           *pst,
 356    MacCellCfg    *macCellCfg ));
 357
 358 typedef int (*packMacCellCfgConfirm) ARGS((
 359    Pst              *pst,
 360    MacCellCfgCfm    *macCellCfgCfm ));
 361
 362 typedef int (*DuMacCellCfgReq) ARGS((
 363    Pst        *pst,
 364    MacCellCfg *macCellCfg));
 365
 366 typedef int (*DuMacCellCfgCfm) ARGS((
 367    Pst        *pst,
 368    MacCellCfgCfm *macCellCfgCfm ));
 369
 370 /* Functions for UL CCCH Ind from MAC to DU APP*/
 371 typedef uint16_t (*DuMacUlCcchInd) ARGS((
 372    Pst           *pst,
 373    UlCcchIndInfo *ulCcchIndInfo ));
 374
 375 /* Functions for DL CCCH Ind from DU APP to MAC*/
 376 typedef uint16_t (*DuMacDlCcchInd) ARGS((
 377    Pst           *pst,
 378    DlCcchIndInfo *dlCcchIndInfo ));
 379
 380 extern uint16_t packMacSlotInd(Pst *pst, SlotInfo *slotInfo );
 381 extern uint16_t unpackMacSlotInd(DuMacSlotInd func, Pst *pst, Buffer *mBuf);
 382 extern uint16_t duHandleSlotInd(Pst *pst, SlotInfo *slotInfo);
 383 extern uint16_t packMacCellStartReq(Pst *pst, MacCellStartInfo *cellStartInfo);
 384 extern uint16_t unpackMacCellStartReq(DuMacCellStartReq func, Pst *pst, Buffer *mBuf);
 385 extern uint16_t MacHdlCellStartReq(Pst *pst, MacCellStartInfo  *cellStartInfo);
 386 extern uint16_t packMacCellStopReq(Pst *pst, MacCellStopInfo  *cellStopInfo);
 387 extern uint16_t unpackMacCellStopReq(DuMacCellStopReq func, Pst *pst, Buffer *mBuf);
 388 extern uint16_t MacHdlCellStopReq(Pst *pst, MacCellStopInfo  *cellStopInfo);
 389 extern int  packMacCellCfg(Pst *pst, MacCellCfg *macCellCfg);
 390 extern int MacHdlCellCfgReq(Pst *pst, MacCellCfg *macCellCfg);
 391 extern void cmUnpackLwLcMacCellCfg(DuMacCellCfgReq func, Pst *pst, Buffer *mBuf);
 392 extern int unpackMacCellCfgCfm(DuMacCellCfgCfm func, Pst *pst, Buffer *mBuf);
 393 extern int duHandleMacCellCfgCfm(Pst *pst, MacCellCfgCfm *macCellCfgCfm);
 394 extern uint16_t packMacStopInd(Pst *pst, MacCellStopInfo *cellId);
 395 extern uint16_t unpackMacStopInd(DuMacStopInd func, Pst *pst, Buffer *mBuf);
 396 extern uint16_t duHandleStopInd(Pst *pst, MacCellStopInfo *cellId);
 397 extern uint16_t packMacUlCcchInd(Pst *pst, UlCcchIndInfo *ulCcchIndInfo);
 398 extern uint16_t unpackMacUlCcchInd(DuMacUlCcchInd func, Pst *pst, Buffer *mBuf);
 399 extern uint16_t duHandleUlCcchInd(Pst *pst, UlCcchIndInfo *ulCcchIndInfo);
 400 extern uint16_t packMacDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo);
 401 extern uint16_t unpackMacDlCcchInd(DuMacDlCcchInd func, Pst *pst, Buffer *mBuf);
 402 extern uint16_t MacHdlDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo);
 403 uint8_t sendStopIndMacToDuApp();
 404 #endif
 405
 406 /**********************************************************************
 407          End of file
 408 **********************************************************************/