c785ec24115674b2a4c47e6c5616d45368c68b60
[o-du/l2.git] / 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 /* Macro for Ue Context */
46 #define MAX_NUM_SR_CFG_PER_CELL_GRP 8   /* Max number of scheduling request config per cell group */
47 #define MAC_NUM_TAGS 4                  /* Max number of timing advance groups */
48 #define MAX_NUM_BWP  4                  /* Max number of BWP per serving cell */
49 #define MAX_NUM_CRSET  3                /* Max number of control resource set in add/modify/release list */
50 #define MAX_NUM_SEARCH_SPC  10          /* Max number of search space in add/modify/release list */
51 #define MONITORING_SYMB_WITHIN_SLOT_SIZE 2  /* i.e. 2 bytes because size of monitoring symbols within slot is 14 bits */
52 #define MAX_NUM_DL_ALLOC 16             /* Max number of pdsch time domain downlink allocation */
53 #define MAX_NUM_UL_ALLOC 16             /* Max number of pusch time domain uplink allocation */
54 #define SD_SIZE   3                     /* Max size of Slice Differentiator in S-NSSAI */
55
56 #define MAX_NUM_SRB    8
57 #define MAX_NUM_DRB    64
58 #define MAX_NUM_SCELL  32
59
60 /* Event IDs */
61 #define EVENT_MAC_CELL_CONFIG_REQ    200
62 #define EVENT_MAC_CELL_CONFIG_CFM    201
63 #define EVENT_MAC_CELL_START_REQ     202
64 #define EVENT_MAC_CELL_STOP_REQ      203
65 #define EVENT_MAC_SLOT_IND           204
66 #define EVENT_MAC_STOP_IND           205
67 #define EVENT_MAC_UL_CCCH_IND        206
68 #define EVENT_MAC_DL_CCCH_IND        207
69 #define EVENT_MAC_UE_CREATE_REQ      208
70 #define EVENT_MAC_UE_CREATE_RSP      209
71 #define EVENT_MAC_UE_RECONFIG_REQ    210
72 #define EVENT_MAC_UE_RECONFIG_RSP    211
73
74 #define BSR_PERIODIC_TIMER_SF_10 10
75 #define BSR_RETX_TIMER_SF_320 320
76 #define BSR_SR_DELAY_TMR_2560 2560
77
78 typedef enum
79 {
80    MAC_DU_APP_RSP_NOK,
81    MAC_DU_APP_RSP_OK
82 }MacRsp;
83
84 typedef enum
85 {
86    DUP_MODE_FDD,
87    DUP_MODE_TDD
88 }DuplexMode;
89
90 typedef enum
91 {
92    MAC_GEN_FULL_PBCH_PAYLD,   /* MAC generated the full PBCH Payload */
93    PHY_GEN_TIMING_PBCH_BIT,   /* PHY generates the timing PBCH bits */
94    PHY_GEN_FULL_PBCH_PAYLD    /* PHY generates full PBCH payload */
95 }BchPduOpt;
96
97 typedef enum
98 {
99    LONG_SEQUENCE,
100    SHORT_SEQUENCE
101 }PrachSeqLen;
102
103 typedef enum
104 {
105    UNRESTRICTED,
106    RESTRICTED_SET_TYPE_A,
107    RESTRICTED_SET_TYPE_B
108 }RstSetCfg;
109
110 typedef enum
111 {
112    DONT_REPORT_RSSI,
113    RSSI_UNIT_DBM,
114    RSSI_UNIT_DBFS
115 }RSSIMeasUnit;
116
117 typedef enum
118 {
119    DL_SLOT,
120    UL_SLOT,
121    GUARD_SLOT
122 }SlotConfig;
123
124 typedef enum
125 {
126    TX_PRDCTY_MS_0P5,
127    TX_PRDCTY_MS_0P625,
128    TX_PRDCTY_MS_1,
129    TX_PRDCTY_MS_1P25,
130    TX_PRDCTY_MS_2,
131    TX_PRDCTY_MS_2P5,
132    TX_PRDCTY_MS_5,
133    TX_PRDCTY_MS_10
134 }DlUlTxPeriodicity;
135
136 typedef enum
137 {
138    BETA_PSS_0DB,
139    BETA_PSS_1DB
140 }BetaPss;
141
142 typedef enum 
143 {
144    SSB_PRDCTY_MS_5,
145    SSB_PRDCTY_MS_10,
146    SSB_PRDCTY_MS_20,
147    SSB_PRDCTY_MS_40,
148    SSB_PRDCTY_MS_80,
149    SSB_PRDCTY_MS_160
150 }SSBPeriod;
151
152 typedef enum
153 {
154    RRC_REJECT,
155    RRC_SETUP
156 }DlCcchMsgType;
157
158 /* Enums for Ue Create Request */
159
160 /* SR PROHIBIT TIMER */
161 typedef enum
162 {
163    SR_PROHIBIT_MS_1,
164    SR_PROHIBIT_MS_2,
165    SR_PROHIBIT_MS_4,
166    SR_PROHIBIT_MS_8,
167    SR_PROHIBIT_MS_16,
168    SR_PROHIBIT_MS_32,
169    SR_PROHIBIT_MS_64,
170    SR_PROHIBIT_MS_128
171 }SrProhibitTimer;
172
173 typedef enum
174 {
175    SR_TRANS_MAX_N_4,
176    SR_TRANS_MAX_N_8,
177    SR_TRANS_MAX_N_16,
178    SR_TRANS_MAX_N_32,
179    SR_TRANS_MAX_N_64,
180    SR_TRANS_MAX_spare3,
181    SR_TRANS_MAX_spare2,
182    SR_TRANS_MAX_spare1
183 }SrTransMax;
184
185 typedef enum
186 {
187    TIME_ALIGNMENT_TIMER_MS_500,
188    TIME_ALIGNMENT_TIMER_MS_750,
189    TIME_ALIGNMENT_TIMER_MS_1280,
190    TIME_ALIGNMENT_TIMER_MS_1920,
191    TIME_ALIGNMENT_TIMER_MS_2560,
192    TIME_ALIGNMENT_TIMER_MS_5120,
193    TIME_ALIGNMENT_TIMER_MS_10240,
194    TIME_ALIGNMENT_TIMER_INFINITY
195 }TimeAlignmentTimer;
196
197 typedef enum
198 {
199    PHR_PERIODIC_TIMER_SF_10,
200    PHR_PERIODIC_TIMER_SF_20,
201    PHR_PERIODIC_TIMER_SF_50,
202    PHR_PERIODIC_TIMER_SF_100,
203    PHR_PERIODIC_TIMER_SF_200,
204    PHR_PERIODIC_TIMER_SF_500,
205    PHR_PERIODIC_TIMER_SF_1000,
206    PHR_PERIODIC_TIMER_INFINITY
207 }PhrPeriodicTimer;
208
209 typedef enum
210 {
211    PHR_PROHIBIT_TIMER_SF_0,
212    PHR_PROHIBIT_TIMER_SF_10,
213    PHR_PROHIBIT_TIMER_SF_20,
214    PHR_PROHIBIT_TIMER_SF_50,
215    PHR_PROHIBIT_TIMER_SF_100,
216    PHR_PROHIBIT_TIMER_SF_200,
217    PHR_PROHIBIT_TIMER_SF_500,
218    PHR_PROHIBIT_TIMER_SF_1000
219 }PhrProhibitTimer;
220
221 typedef enum
222 {
223    PHR_TX_PWR_FACTOR_CHANGE_DB_1,
224    PHR_TX_PWR_FACTOR_CHANGE_DB_3,
225    PHR_TX_PWR_FACTOR_CHANGE_DB_6,
226    PHR_TX_PWR_FACTOR_CHANGE_INFINITY
227 }PhrTxPwrFactorChange;
228
229 typedef enum
230 {
231    PHR_MODE_OTHER_CG_REAL,
232    PHR_MODE_OTHER_CG_VIRTUAL
233 }PhrModeOtherCG;
234
235 typedef enum
236 {
237    PDSCH_HARQ_ACK_CODEBOOK_SEMISTATIC,
238    PDSCH_HARQ_ACK_CODEBOOK_DYNAMIC
239 }PdschHarqAckCodebook;
240
241 typedef enum
242 {
243    NUM_HARQ_PROC_FOR_PDSCH_N_2,
244    NUM_HARQ_PROC_FOR_PDSCH_N_4,
245    NUM_HARQ_PROC_FOR_PDSCH_N_6,
246    NUM_HARQ_PROC_FOR_PDSCH_N_10,
247    NUM_HARQ_PROC_FOR_PDSCH_N_16
248 }NumHarqProcForPdsch;
249
250 typedef enum
251 {
252    MAX_CODE_BLOCK_GROUP_PER_TB_N_2,
253    MAX_CODE_BLOCK_GROUP_PER_TB_N_4,
254    MAX_CODE_BLOCK_GROUP_PER_TB_N_6,
255    MAX_CODE_BLOCK_GROUP_PER_TB_N_8
256 }MaxCodeBlkGrpPerTB;
257
258 typedef enum
259 {
260    PDSCH_X_OVERHEAD_6,
261    PDSCH_X_OVERHEAD_12,
262    PDSCH_X_OVERHEAD_18
263 }PdschXOverhead;
264
265 typedef enum
266 {
267    TRANSFORM_PRECODER_ENABLED,
268    TRANSFORM_PRECODER_DISABLED
269 }TransformPrecoder;
270
271 typedef enum 
272 {
273    CCE_REG_MAPPINGTYPE_PR_INTERLEAVED = 1,
274    CCE_REG_MAPPINGTYPE_PR_NONINTERLEAVED
275 }REGMappingType;
276
277 typedef enum
278 {
279    SLOTPERIODICITYANDOFFSET_PR_SL1 = 1,
280    SLOTPERIODICITYANDOFFSET_PR_SL2,
281    SLOTPERIODICITYANDOFFSET_PR_SL4,
282    SLOTPERIODICITYANDOFFSET_PR_SL5,
283    SLOTPERIODICITYANDOFFSET_PR_SL8,
284    SLOTPERIODICITYANDOFFSET_PR_SL10,
285    SLOTPERIODICITYANDOFFSET_PR_SL16,
286    SLOTPERIODICITYANDOFFSET_PR_SL20,
287    SLOTPERIODICITYANDOFFSET_PR_SL40,
288    SLOTPERIODICITYANDOFFSET_PR_SL80,
289    SLOTPERIODICITYANDOFFSET_PR_SL160,
290    SLOTPERIODICITYANDOFFSET_PR_SL320,
291    SLOTPERIODICITYANDOFFSET_PR_SL640,
292    SLOTPERIODICITYANDOFFSET_PR_SL1280,
293    SLOTPERIODICITYANDOFFSET_PR_SL2560
294 }MSlotPeriodAndOffset;
295
296 typedef enum
297 {
298    SAMEASREG_BUNDLE,
299    ALL_CONTIGUOUS_RBS
300 }PrecoderGranul;
301
302 typedef enum
303 {
304    SEARCHSPACETYPE_PR_COMMON = 1,
305    SEARCHSPACETYPE_PR_UE_SPECIFIC
306 }SearchSpaceType;
307
308 typedef enum
309 {
310    QOS_NON_DYNAMIC = 1,
311    QOS_DYNAMIC
312 }QosType;
313
314 typedef enum
315 {
316    AGGREGATIONLEVEL_N0  = 0,  
317    AGGREGATIONLEVEL_N1  = 1,
318    AGGREGATIONLEVEL_N2  = 2,
319    AGGREGATIONLEVEL_N3  = 3,
320    AGGREGATIONLEVEL_N4  = 4,
321    AGGREGATIONLEVEL_N5  = 5,
322    AGGREGATIONLEVEL_N6  = 6,
323    AGGREGATIONLEVEL_N8  = 7
324 }AggrLevel;
325
326 typedef enum
327 {
328    ADDITIONALPOSITION_POS0,
329    ADDITIONALPOSITION_POS1,
330    ADDITIONALPOSITION_POS3
331 }AddPosType;
332
333 typedef enum
334 {
335    MAPPING_TYPEA,
336    MAPPING_TYPEB
337 }CommonMappingType;
338
339 typedef enum
340 {
341    RESOURCEALLOCATION_TYPE0,
342    RESOURCEALLOCATION_TYPE1,
343    RESOURCEALLOCATION_DYNAMICSWITCH
344 }ResAllocType;
345
346 typedef enum
347 {
348    RBG_SIZE_CONFIG1,
349    RBG_SIZE_CONFIG2
350 }RBGSize;
351
352 typedef enum
353 {
354    CODEWORDS_SCHED_BY_DCI_N1,
355    CODEWORDS_SCHED_BY_DCI_N2
356 }CodeWordsSchedDci;
357
358 typedef enum
359 {
360    TYPE_STATIC_BUNDLING = 1,
361    TYPE_DYNAMIC_BUNDLING
362 }BundlingType;
363
364 typedef enum
365 {
366    SET2_SIZE_N4,
367    SET2_SIZE_WIDEBAND
368 }BundlingSizeSet2;
369
370 typedef enum
371 {
372    SET1_SIZE_N4,
373    SET1_SIZE_WIDEBAND,
374    SET1_SIZE_N2_WIDEBAND,
375    SET1_SIZE_N4_WIDEBAND
376 }BundlingSizeSet1;
377
378 typedef enum
379 {
380    LC_PRIORITY_1 = 1,
381    LC_PRIORITY_2,
382    LC_PRIORITY_3
383 }LcPriority;
384
385 typedef enum
386 {
387   PBR_KBPS_0,
388   PBR_KBPS_8,
389   PBR_KBPS_16,
390   PBR_KBPS_32,
391   PBR_KBPS_64,
392   PBR_KBPS_128,
393   PBR_KBPS_256,
394   PBR_KBPS_512,
395   PBR_KBPS_1024,
396   PBR_KBPS_2048,
397   PBR_KBPS_4096,
398   PBR_KBPS_8192,
399   PBR_KBPS_16384,
400   PBR_KBPS_32768,
401   PBR_KBPS_65536,
402   PBR_KBPS_INFINITY
403 }PBitRate;
404
405 typedef enum
406 {
407    BSD_MS_5,
408    BSD_MS_10,
409    BSD_MS_20,
410    BSD_MS_50,
411    BSD_MS_100,
412    BSD_MS_150,
413    BSD_MS_300,
414    BSD_MS_500,
415    BSD_MS_1000,
416    BSD_SPARE_7,
417    BSD_SPARE_6,
418    BSD_SPARE_5,
419    BSD_SPARE_4,
420    BSD_SPARE_3,
421    BSD_SPARE_2,
422    BSD_SPARE_1
423
424 }BucketSizeDur;
425
426 typedef enum
427 {
428    RADIO_NW_LAYER_FAIL,
429    TRANSPORT_LAYER_FAIL,
430    PROTOCOL_FAIL,
431    MISCELLANEOUS
432 }CauseGrp;
433
434 typedef enum
435 {
436    UNSPECIFIED_RADIO_NW_CAUSE,
437    RL_FAIL_RLC,
438    UNKNOWN_GNB_CU_UE_F1AP_ID,
439    ALREADY_ALLOCATED_GNB_CU_UE_F1AP_ID,
440    UNKNOWN_GNB_DU_UE_F1AP_ID,
441    ALREADY_ALLOCATED_GNB_DU_UE_F1AP_ID,
442    UNKNOWN_UE_F1AP_ID_PAIR,
443    INCONSISTENT_UE_F1AP_ID_PAIR,
444    INTERACTION_WITH_OTHER_PROCEDURE,
445    UNSUPPORTED_QCI,
446    ACTION_REQUIRED_FOR_RADIO_REASONS,
447    RADIO_RESOURCES_UNAVAILABLE,
448    CANCELLED_PROCEDURE,
449    RELEASE_NORMAL,
450    CELL_UNAVAILABLE,
451    OTHER_RL_FAILURE,
452    UE_REJECTION,
453    RESOURCES_UNAVAILABLE_FOR_SLICE
454 }RadioNwLyrCause;
455
456 typedef enum
457 {
458    UNSPECIFIED_TRANSPORT_LAYER_CAUSE,
459    TRANSPORT_RESOURCE_UNAVAILABLE
460 }TransLyrCause;
461
462 typedef enum
463 {
464    TRANSFER_SYNTAX_ERROR,
465    ABSTRACT_SYNTAX_ERROR_REJECT,
466    ABSTRACT_SYNTAX_ERROR_IGNORE_AND_REJECT,
467    INCOMPATIBLE_MESSAGE_FOR_RECEIVER_STATE,
468    SEMANTIC_ERR,
469    ABSTRAXCT_SYNTAX_ERROR_FALSELY_CONSTRUCTED_MSG,
470    UNSPECIFIED_PROTOCOL_CAUSE
471 }ProtCause;
472
473 typedef enum
474 {
475    CONTROL_PROCESSING_OVERLOAD,
476    NOT_ENOUGH_USER,
477    PLANE_PROCESSING_RESOURCES,
478    HARDWARE_FAIL,
479    INTERVENTION_BY_O_AND_M,
480    UNSPECIFIED_MISC_CAUSE
481 }MiscFailCause;
482
483 typedef struct failureCause
484 {
485    CauseGrp   type;
486    union
487    {
488       RadioNwLyrCause   radioNwCause;
489       TransLyrCause     transportCause;
490       ProtCause         protcolCause;
491       MiscFailCause     miscCause;
492    }u;
493 }FailureCause;
494
495 typedef struct carrierCfg
496 {
497    bool  pres;
498    uint32_t   bw;             /* DL/UL bandwidth */
499    uint32_t   freq;           /* Absolute frequency of DL/UL point A in KHz */
500    uint16_t   k0[NUM_NUMEROLOGY];          /* K0 for DL/UL */
501    uint16_t   gridSize[NUM_NUMEROLOGY];    /* DL/UL Grid size for each numerologies */
502    uint16_t   numAnt;         /* Number of Tx/Rx antennas */
503 }CarrierCfg;
504
505 typedef struct ssbCfg
506 {
507    uint32_t    ssbPbchPwr;       /* SSB block power */
508    BchPduOpt   bchPayloadFlag;   /* Options for generation of payload */
509    uint8_t     scsCmn;           /* subcarrier spacing for common */
510    uint16_t    ssbOffsetPointA;  /* SSB subcarrier offset from point A */
511    BetaPss     betaPss;
512    SSBPeriod   ssbPeriod;        /* SSB Periodicity in msec */
513    uint8_t     ssbScOffset;       /* Subcarrier Offset */
514    uint8_t     mibPdu[3];           /* MIB payload */
515    uint32_t    ssbMask[SSB_MASK_SIZE];      /* Bitmap for actually transmitted SSB. */
516    uint8_t     beamId[NUM_SSB];
517    bool        multCarrBand;     /* Multiple carriers in a band */
518    bool        multCellCarr;     /* Multiple cells in single carrier */
519 }SsbCfg;
520
521 typedef struct fdmInfo
522 {
523    uint16_t   rootSeqIdx;        /* Root sequence index */
524    uint8_t    numRootSeq;        /* Number of root sequences required for FD */
525    uint16_t   k1;                /* Frequency Offset for each FD */
526    uint8_t    zeroCorrZoneCfg;   /* Zero correlation zone cofig */
527    uint8_t    numUnusedRootSeq;  /* Number of unused root sequence */
528    uint8_t    *unsuedRootSeq;     /* Unused root sequence per FD */
529 }PrachFdmInfo;
530
531 typedef struct prachCfg
532 {
533    bool          pres;
534    uint8_t       prachCfgIdx;         /* PRACH Cfg Index */
535    PrachSeqLen   prachSeqLen;         /* RACH Sequence length: Long/short */
536    uint8_t       prachSubcSpacing;    /* Subcarrier spacing of RACH */
537    RstSetCfg     prachRstSetCfg;      /* PRACH restricted set config */
538    uint16_t      msg1FreqStart;       /* Msg1-FrequencyStart */
539    uint8_t       msg1Fdm;             /* PRACH FDM (1,2,4,8) */
540    uint8_t       rootSeqLen;          /* Root sequence length */
541    PrachFdmInfo  fdm[8];              /* FDM info */
542    uint8_t       ssbPerRach;          /* SSB per RACH occassion */
543    bool          prachMultCarrBand;   /* Multiple carriers in Band */
544    uint8_t       prachRestrictedSet; /* Support for PRACH restricted set */
545    uint8_t       raContResTmr;        /* RA Contention Resoultion Timer */
546    uint8_t       rsrpThreshSsb;       /* RSRP Threshold SSB */
547    uint8_t       raRspWindow;         /* RA Response Window */
548 }PrachCfg;
549
550 typedef struct tddCfg
551 {
552    bool               pres;
553    DlUlTxPeriodicity  tddPeriod;      /* DL UL Transmission periodicity */
554    SlotConfig         slotCfg[MAXIMUM_TDD_PERIODICITY][MAX_SYMB_PER_SLOT]; 
555 }TDDCfg;
556
557 typedef struct sib1CellCfg
558 {
559    uint8_t  *sib1Pdu;
560    uint16_t sib1PduLen;
561    uint16_t sib1NewTxPeriod;
562    uint16_t sib1RepetitionPeriod;
563    uint8_t coresetZeroIndex;     /* derived from 4 LSB of pdcchSib1 present in MIB */
564    uint8_t searchSpaceZeroIndex; /* derived from 4 MSB of pdcchSib1 present in MIB */
565    uint16_t sib1Mcs;
566 } Sib1CellCfg; 
567
568 typedef struct bwpParams
569 {
570    uint16_t firstPrb;
571    uint16_t numPrb;
572    uint8_t  scs;
573    uint8_t  cyclicPrefix;
574 }BwpParams;
575
576 typedef struct candidatesInfo
577 {
578    uint8_t aggLevel1;
579    uint8_t aggLevel2;
580    uint8_t aggLevel4;
581    uint8_t aggLevel8;
582    uint8_t aggLevel16;
583 }CandidatesInfo;
584
585 typedef struct searchSpaceCfg
586 {
587    uint8_t searchSpaceId;
588    uint8_t coresetId;
589    uint16_t monitoringSlot;
590    uint16_t duration;
591    uint16_t monitoringSymbol;
592    CandidatesInfo candidate;
593 }SearchSpaceCfg;
594
595 typedef struct pdcchConfigCommon
596 {
597    /* only one search space is configured during SIB1 */
598    SearchSpaceCfg commonSearchSpace;
599    uint8_t raSearchSpaceId;
600 }PdcchConfigCommon;
601
602 typedef struct pdschConfigCommon
603 {
604    uint8_t k0;
605    uint8_t mappingType;
606    uint8_t startSymbol;
607    uint8_t lengthSymbol;
608 }PdschConfigCommon;
609
610 typedef struct pucchConfigCommon
611 {
612    uint8_t pucchResourceCommon;
613    uint8_t pucchGroupHopping;
614 }PucchConfigCommon;
615
616 typedef struct puschConfigCommon
617 {
618    /* PUSCH-TimeDomainResourceAllocation info */
619    uint8_t k2;
620    uint8_t mappingType;
621    uint8_t startSymbol;
622    uint8_t lengthSymbol;
623 }PuschConfigCommon;
624
625 typedef struct bwpDlConfig
626 {
627    BwpParams      bwp;
628    PdcchConfigCommon pdcchCommon;
629    PdschConfigCommon pdschCommon;
630 }BwpDlConfig;
631
632 typedef struct bwpUlConfig
633 {
634    BwpParams      bwp;
635    // rach config common sent in PrachCfg
636    PucchConfigCommon pucchCommon;
637    PuschConfigCommon puschCommon;
638 }BwpUlConfig;
639
640 typedef struct macCellCfg
641 {
642    uint16_t            cellId;           /* Cell Id */
643    uint8_t             carrierId;        /* Carrired Index */
644    uint16_t            phyCellId;        /* Physical cell id */
645    DuplexMode     dupType;          /* Duplex type: TDD/FDD */
646    CarrierCfg     dlCarrCfg;        /* DL Carrier configuration */
647    CarrierCfg     ulCarrCfg;        /* UL Carrier configuration */
648    bool           freqShft;         /* Indicates presence of 7.5kHz frequency shift */
649    SsbCfg         ssbCfg;           /* SSB configuration */          
650    PrachCfg       prachCfg;         /* PRACH Configuration */
651    TDDCfg         tddCfg;           /* TDD periodicity and slot configuration */
652    RSSIMeasUnit   rssiUnit;         /* RSSI measurement unit */
653    Sib1CellCfg    sib1Cfg;          /* SIB1 config */
654    BwpDlConfig    initialDlBwp;     /* Initial DL BWP */
655    BwpUlConfig    initialUlBwp;     /* Initial UL BWP */
656    uint8_t        dmrsTypeAPos;     /* DMRS Type A position */
657 }MacCellCfg;
658
659 typedef struct macCellCfgCfm
660 {
661    uint16_t            cellId;
662    uint8_t        rsp; 
663 }MacCellCfgCfm;
664
665 typedef struct macCellStartInfo
666 {
667    uint16_t cellId;
668 }MacCellStartInfo;
669
670 typedef struct macCellStopInfo
671 {
672    uint16_t cellId;
673 }MacCellStopInfo;
674
675 typedef struct ulCcchInd
676 {
677    uint16_t cellId;
678    uint16_t crnti;
679    uint16_t ulCcchMsgLen;
680    uint8_t  *ulCcchMsg;
681 }UlCcchIndInfo;
682
683 typedef struct dlCcchInd
684 {
685    uint16_t      cellId;
686    uint16_t      crnti;
687    DlCcchMsgType msgType;
688    uint16_t      dlCcchMsgLen;
689    uint8_t       *dlCcchMsg;
690 }DlCcchIndInfo;
691
692 typedef struct bsrTmrCfg
693 {
694    uint16_t     periodicTimer;
695    uint16_t     retxTimer;
696    uint16_t     srDelayTimer;
697 }BsrTmrCfg;
698
699
700 /* Info of Scheduling Request to Add/Modify */
701 typedef struct schedReqInfo
702 {
703    uint8_t         schedReqId;
704    SrProhibitTimer srProhibitTmr;
705    SrTransMax      srTransMax;
706 }SchedReqInfo;
707
708 /* Scheduling Request Configuration */
709 typedef struct schedReqCfg
710 {
711    uint8_t       addModListCount;
712    SchedReqInfo  addModList[MAX_NUM_SR_CFG_PER_CELL_GRP];   /* List of Scheduling req to be added/modified */
713    uint8_t       relListCount;
714    uint8_t       relList[MAX_NUM_SR_CFG_PER_CELL_GRP];      /* list of scheduling request Id to be deleted */
715 }SchedReqCfg;
716
717 typedef struct tagInfo
718 {
719    uint8_t tagId;
720    TimeAlignmentTimer timeAlignTimer;
721 }TagInfo;
722
723 typedef struct tagCfg
724 {
725    uint8_t      addModListCount;
726    TagInfo      addModList[MAC_NUM_TAGS];  /* List of Tag to Add/Modify */
727    uint8_t      relListCount;
728    uint8_t      relList[MAC_NUM_TAGS];     /* list of Tag Id to release */
729 }TagCfg;
730
731 typedef struct phrCfg
732 {
733    PhrPeriodicTimer periodicTimer;
734    PhrProhibitTimer prohibitTimer; 
735    PhrTxPwrFactorChange txPowerFactor;
736    bool     multiplePHR;       
737    bool     dummy;
738    bool     phrType2OtherCell;
739    PhrModeOtherCG phrOtherCG;
740 }PhrCfg;
741
742 typedef struct macCellGrpCfg
743 {
744    SchedReqCfg schReqCfg;
745    TagCfg      tagCfg;
746    BsrTmrCfg   bsrTmrCfg;
747    bool        phrCfgSetupPres;   /* true/false: phrCfgSetup/phrCfgRelease */
748    PhrCfg      phrCfg;
749 }MacCellGrpCfg;
750
751 typedef struct phyCellGrpCfg
752 {
753    PdschHarqAckCodebook  pdschHarqAckCodebook;
754    uint8_t    pNrFr1;
755 }PhyCellGrpCfg;
756
757 /* Control resource set info */
758 typedef struct controlRsrcSet
759 {
760    uint8_t     cRSetId;                /* Control resource set id */
761    uint8_t     freqDomainRsrc[FREQ_DOM_RSRC_SIZE];  /* Frequency domain resource */
762    uint8_t     duration;
763    REGMappingType cceRegMappingType;
764    PrecoderGranul precoderGranularity;
765    uint16_t    dmrsScramblingId;
766 }ControlRsrcSet;
767
768 /* Search Space info */
769 typedef struct searchSpace
770 {
771    uint8_t     searchSpaceId;
772    uint8_t     cRSetId;
773    MSlotPeriodAndOffset  mSlotPeriodicityAndOffset;
774    uint8_t     mSymbolsWithinSlot[MONITORING_SYMB_WITHIN_SLOT_SIZE];
775    AggrLevel   numCandidatesAggLevel1;      /* Number of candidates for aggregation level 1 */
776    AggrLevel   numCandidatesAggLevel2;      /* Number of candidates for aggregation level 2 */
777    AggrLevel   numCandidatesAggLevel4;      /* Number of candidates for aggregation level 4 */
778    AggrLevel   numCandidatesAggLevel8;      /* Number of candidates for aggregation level 8 */
779    AggrLevel   numCandidatesAggLevel16;     /* Number of candidates for aggregation level 16 */
780    SearchSpaceType searchSpaceType;
781    uint8_t     ueSpecificDciFormat;
782 }SearchSpace;
783
784 /* PDCCH cofniguration */
785 typedef struct pdcchConfig
786 {
787    uint8_t           numCRsetToAddMod;
788    ControlRsrcSet    cRSetToAddModList[MAX_NUM_CRSET];           /* List of control resource set to add/modify */
789    uint8_t           numCRsetToRel;
790    uint8_t           cRSetToRelList[MAX_NUM_CRSET];              /* List of control resource set to release */
791    uint8_t           numSearchSpcToAddMod;
792    SearchSpace       searchSpcToAddModList[MAX_NUM_SEARCH_SPC];  /* List of search space to add/modify */
793    uint8_t           numSearchSpcToRel;
794    uint8_t           searchSpcToRelList[MAX_NUM_SEARCH_SPC];     /* List of search space to release */
795 }PdcchConfig;
796
797 /* PDSCH time domain resource allocation */
798 typedef struct pdschTimeDomRsrcAlloc
799 {
800    CommonMappingType mappingType;
801    uint8_t           startSymbol;
802    uint8_t           symbolLength;
803    uint8_t           startSymbolAndLength;
804 }PdschTimeDomRsrcAlloc;
805
806
807 typedef struct pdschBundling
808 {
809    struct staticBundling
810    {
811      BundlingSizeSet2 size;
812    }StaticBundling;
813    struct dynamicBundling
814    {
815      BundlingSizeSet1 sizeSet1;
816      BundlingSizeSet2 sizeSet2;
817    }DynamicBundling;
818 }PdschBundling;
819
820 /* DMRS downlink configuration */
821 typedef struct dmrsDlCfg
822 {
823    AddPosType  addPos;       /* DMRS additional position */
824 }DmrsDlCfg;
825
826 /* PDSCH Configuration */
827 typedef struct pdschConfig
828 {
829    DmrsDlCfg               dmrsDlCfgForPdschMapTypeA;
830    ResAllocType            resourceAllocType;
831    uint8_t                 numTimeDomRsrcAlloc;
832    PdschTimeDomRsrcAlloc   timeDomRsrcAllociList[MAX_NUM_DL_ALLOC]; /* PDSCH time domain DL resource allocation list */
833    RBGSize                 rbgSize;
834    CodeWordsSchedDci       numCodeWordsSchByDci;                    /* Number of code words scheduled by DCI */
835    BundlingType            bundlingType;
836    PdschBundling           bundlingInfo;
837 }PdschConfig;
838
839 /* Initial Downlink BWP */
840 typedef struct initialDlBwp
841 {
842    bool          pdcchPresent;
843    PdcchConfig   pdcchCfg;
844    bool          pdschPresent;
845    PdschConfig   pdschCfg;
846 }InitialDlBwp;
847
848 /* BWP Downlink common */
849 typedef struct bwpDlCommon
850 {
851 }BwpDlCommon;
852
853 /* Downlink BWP information */
854 typedef struct dlBwpInfo
855 {
856    uint8_t          bwpId;
857 }DlBwpInfo;
858
859 /* PDCCH Serving Cell configuration */
860 typedef struct pdschServCellCfg
861 {
862    uint8_t              *maxMimoLayers;           
863    NumHarqProcForPdsch  numHarqProcForPdsch;
864    MaxCodeBlkGrpPerTB   *maxCodeBlkGrpPerTb;
865    bool                 *codeBlkGrpFlushInd;
866    PdschXOverhead       *xOverhead;
867 }PdschServCellCfg;
868
869 /* PUCCH Configuration */
870 typedef struct pucchCfg
871 {
872    /* TODO : Not used currently */ 
873 }PucchCfg;
874
875 /* Transform precoding disabled */
876 typedef struct transPrecodDisabled
877 {
878    uint16_t   scramblingId0;
879 }TransPrecodDisabled;
880
881 /* DMRS Uplink configuration */
882 typedef struct dmrsUlCfg
883 {
884    AddPosType            addPos;               /* DMRS additional position */
885    TransPrecodDisabled   transPrecodDisabled;  /* Transform precoding disabled */
886 }DmrsUlCfg;
887
888 /* PUSCH Time Domain Resource Allocation */
889 typedef struct puschTimeDomRsrcAlloc
890 {
891    uint8_t   k2;
892    CommonMappingType   mappingType;
893    uint8_t           startSymbol;
894    uint8_t           symbolLength;
895    uint8_t   startSymbolAndLength;
896 }PuschTimeDomRsrcAlloc;
897
898 /* PUSCH Configuration */
899 typedef struct puschCfg
900 {
901    uint8_t                 dataScramblingId;
902    DmrsUlCfg               dmrsUlCfgForPuschMapTypeA;
903    ResAllocType            resourceAllocType;
904    uint8_t                 numTimeDomRsrcAlloc;
905    PuschTimeDomRsrcAlloc   timeDomRsrcAllocList[MAX_NUM_UL_ALLOC]; /* PUSCH time domain UL resource allocation list */
906    TransformPrecoder       transformPrecoder;
907 }PuschCfg;
908
909 /* Initial Uplink BWP */
910 typedef struct initialUlBwp
911 {
912    bool       pucchPresent;
913    PucchCfg   pucchCfg; 
914    bool       puschPresent;
915    PuschCfg   puschCfg;
916 }InitialUlBwp;
917
918 /* Uplink BWP information */
919 typedef struct ulBwpInfo
920 {
921    uint8_t        bwpId;
922 }UlBwpInfo;
923
924 /* Serving cell configuration */
925 typedef struct servCellCfgInfo
926 {
927    InitialDlBwp       initDlBwp;
928    uint8_t            numDlBwpToAdd;
929    DlBwpInfo          DlBwpToAddList[MAX_NUM_BWP];
930    uint8_t            firstActvDlBwpId;
931    uint8_t            defaultDlBwpId;
932    uint8_t            *bwpInactivityTmr;
933    PdschServCellCfg   pdschServCellCfg;
934    InitialUlBwp       initUlBwp;
935    uint8_t            numUlBwpToAdd;
936    UlBwpInfo          UlBwpToAddList[MAX_NUM_BWP];
937    uint8_t            firstActvUlBwpId;
938 }ServCellCfgInfo;
939
940 /* Special cell configuration */
941 typedef struct spCellCfg
942 {
943    uint8_t           servCellIdx;
944    ServCellCfgInfo   servCellCfg;
945 }SpCellCfg;
946
947 typedef struct ambrCfg
948 {
949    uint32_t ulBr;   /* UL Bit rate */
950    uint32_t dlBr;   /* DL Bit rate */
951 }AmbrCfg;
952
953 /* Single Network Slice Selection assistance Info */
954 typedef struct snssai
955 {
956    uint8_t sst;                /* Slice Type */
957    uint8_t sd[SD_SIZE];        /* Slice Differentiator */
958 }Snssai;
959
960 typedef struct nonDynFiveQi
961 {
962    uint16_t   fiveQi;
963    uint8_t    priorLevel;
964    uint16_t   avgWindow;
965    uint16_t   maxDataBurstVol;
966 }NonDynFiveQi;
967
968 typedef struct dynFiveQi
969 {
970    uint8_t    priorLevel;
971    uint16_t   packetDelayBudget;
972    uint8_t    packetErrRateScalar;
973    uint8_t    packetErrRateExp;
974    uint16_t   fiveQi;
975    uint8_t    delayCritical;
976    uint16_t   avgWindow;
977    uint16_t   maxDataBurstVol;
978 }DynFiveQi;
979
980 typedef struct ngRanAllocAndRetPri
981 {
982    uint8_t priorityLevel;
983    uint8_t preEmptionCap;
984    uint8_t preEmptionVul;
985 }NgRanAllocAndRetPri;
986
987 typedef struct grbQosInfo
988 {
989    uint32_t maxFlowBitRateDl;
990    uint32_t maxFlowBitRateUl;
991    uint32_t guarFlowBitRateDl;
992    uint32_t guarFlowBitRateUl;
993 }GrbQosInfo;
994
995 typedef struct drbQos
996 {
997    QosType  fiveQiType;   /* Dynamic or non-dynamic */ 
998    union
999    {
1000       NonDynFiveQi   nonDyn5Qi;
1001       DynFiveQi      dyn5Qi;
1002    }u;
1003    NgRanAllocAndRetPri ngRanRetPri;
1004    GrbQosInfo grbQosInfo;
1005    uint16_t             pduSessionId;
1006    uint32_t             ulPduSessAggMaxBitRate;
1007 }DrbQosInfo;
1008
1009 typedef struct ulLcCfg
1010 {
1011    uint8_t priority;
1012    uint8_t lcGroup;
1013    uint8_t schReqId;
1014    PBitRate pbr;        // prioritisedBitRate
1015    BucketSizeDur bsd;        // bucketSizeDuration
1016 }UlLcCfg;
1017
1018 typedef struct duLcCfg
1019 {
1020    LcPriority lcp;      // logical Channel Prioritization
1021 }DlLcCfg;
1022
1023 typedef struct lcCfg
1024 {
1025    ConfigType configType;
1026    uint8_t lcId;
1027    DrbQosInfo *drbQos; 
1028    Snssai  *snssai;
1029    bool ulLcCfgPres;
1030    UlLcCfg ulLcCfg;
1031    DlLcCfg dlLcCfg;
1032 }LcCfg;
1033
1034 typedef struct macUeCfg
1035 {
1036    uint16_t cellId;
1037    uint8_t  ueIdx;
1038    uint16_t crnti;
1039    MacCellGrpCfg macCellGrpCfg;
1040    PhyCellGrpCfg phyCellGrpCfg;
1041    SpCellCfg spCellCfg;
1042    AmbrCfg   *ambrCfg;
1043    uint8_t numLcs;
1044    LcCfg lcCfgList[MAX_NUM_LC];
1045    UeCfgState macUeCfgState; /* InActive / Completed */
1046 }MacUeCfg;
1047
1048 typedef struct nrcgi
1049 {
1050    Plmn      plmn;
1051    uint16_t  cellId;
1052 }Nrcgi;
1053
1054 typedef struct srbFailInfo
1055 {
1056    uint8_t       srbId;
1057    FailureCause  cause;
1058 }SRBFailInfo;
1059
1060 typedef struct drbFailInfo
1061 {
1062    uint8_t       drbId;
1063    FailureCause  cause;
1064 }DRBFailInfo;
1065
1066 typedef struct sCellFailInfo
1067 {
1068    Nrcgi         nrcgi;
1069    FailureCause  cause;
1070 }SCellFailInfo;
1071
1072 typedef struct ueCfgRsp
1073 {
1074    uint16_t       cellId;
1075    uint16_t       ueIdx;
1076    MacRsp         result;
1077    uint8_t        numSRBFailed;   /* valid values : 0 to MAX_NUM_SRB */ 
1078    SRBFailInfo    *failedSRBlisti;
1079    uint8_t        numDRBFailed;   /* valid values : 0 to MAX_NUM_DRB */
1080    DRBFailInfo    *failedDRBlist;
1081    uint8_t        numSCellFailed; /* valid values : 0 to MAX_NUM_SCELL */
1082    SCellFailInfo  *failedSCellList;
1083 }MacUeCfgRsp;
1084
1085 /* Functions for slot Ind from MAC to DU APP*/
1086 typedef uint8_t (*DuMacSlotInd) ARGS((
1087          Pst       *pst,
1088          SlotIndInfo  *slotInfo ));
1089
1090 /* Functions for stop Ind from MAC to DU APP*/
1091 typedef uint8_t (*DuMacStopInd) ARGS((
1092          Pst       *pst,
1093          MacCellStopInfo  *cellId ));
1094
1095 /* Functions for mac cell start req */
1096 typedef uint8_t (*DuMacCellStartReq) ARGS((
1097          Pst               *pst, 
1098          MacCellStartInfo  *cellStartInfo ));
1099
1100 /* Functions for mac cell stop request */
1101 typedef uint8_t (*DuMacCellStopReq) ARGS((
1102          Pst               *pst,
1103          MacCellStopInfo  *cellStopInfo ));
1104
1105 /* Function pointers for packing macCellCfg Request and Confirm */
1106 typedef uint8_t (*packMacCellCfgReq) ARGS((
1107          Pst           *pst,
1108          MacCellCfg    *macCellCfg ));
1109
1110 typedef uint8_t (*packMacCellCfgConfirm) ARGS((
1111          Pst              *pst,
1112          MacCellCfgCfm    *macCellCfgCfm ));
1113
1114 typedef uint8_t (*DuMacCellCfgReq) ARGS((
1115          Pst        *pst,        
1116          MacCellCfg *macCellCfg));
1117
1118 typedef uint8_t (*DuMacCellCfgCfm) ARGS((
1119          Pst        *pst,        
1120          MacCellCfgCfm *macCellCfgCfm ));
1121
1122 /* Functions for UL CCCH Ind from MAC to DU APP*/
1123 typedef uint8_t (*DuMacUlCcchInd) ARGS((
1124          Pst           *pst,
1125          UlCcchIndInfo *ulCcchIndInfo ));
1126
1127 /* Functions for DL CCCH Ind from DU APP to MAC*/
1128 typedef uint8_t (*DuMacDlCcchInd) ARGS((
1129          Pst           *pst,
1130          DlCcchIndInfo *dlCcchIndInfo ));
1131
1132 /* UE create Request from DU APP to MAC*/
1133 typedef uint8_t (*DuMacUeCreateReq) ARGS((
1134          Pst           *pst,
1135          MacUeCfg      *ueCfg ));
1136
1137 /* UE create Response from MAC to DU APP */
1138 typedef uint8_t (*MacDuUeCfgRspFunc) ARGS((
1139          Pst           *pst, 
1140          MacUeCfgRsp   *cfgRsp));
1141
1142 /* UE Reconfig Request from DU APP to MAC*/
1143 typedef uint8_t (*DuMacUeReconfigReq) ARGS((
1144          Pst           *pst,
1145          MacUeCfg      *ueCfg ));
1146
1147 uint8_t packMacSlotInd(Pst *pst, SlotIndInfo *slotInfo );
1148 uint8_t unpackMacSlotInd(DuMacSlotInd func, Pst *pst, Buffer *mBuf);
1149 uint8_t duHandleSlotInd(Pst *pst, SlotIndInfo *slotInfo);
1150 uint8_t packMacCellStartReq(Pst *pst, MacCellStartInfo *cellStartInfo);
1151 uint8_t unpackMacCellStartReq(DuMacCellStartReq func, Pst *pst, Buffer *mBuf);
1152 uint8_t MacProcCellStartReq(Pst *pst, MacCellStartInfo  *cellStartInfo);
1153 uint8_t packMacCellStopReq(Pst *pst, MacCellStopInfo  *cellStopInfo);
1154 uint8_t unpackMacCellStopReq(DuMacCellStopReq func, Pst *pst, Buffer *mBuf);
1155 uint8_t MacProcCellStopReq(Pst *pst, MacCellStopInfo  *cellStopInfo);
1156 uint8_t packMacCellCfg(Pst *pst, MacCellCfg *macCellCfg);
1157 uint8_t unpackDuMacCellCfg(DuMacCellCfgReq func,  Pst *pst,  Buffer *mBuf);
1158 uint8_t MacProcCellCfgReq(Pst *pst, MacCellCfg *macCellCfg);
1159 uint8_t packMacCellCfgCfm(Pst *pst, MacCellCfgCfm *macCellCfgCfm);
1160 uint8_t unpackMacCellCfgCfm(DuMacCellCfgCfm func, Pst *pst, Buffer *mBuf);
1161 uint8_t duHandleMacCellCfgCfm(Pst *pst, MacCellCfgCfm *macCellCfgCfm);
1162 uint8_t packMacStopInd(Pst *pst, MacCellStopInfo *cellId);
1163 uint8_t unpackMacStopInd(DuMacStopInd func, Pst *pst, Buffer *mBuf);
1164 uint8_t duHandleStopInd(Pst *pst, MacCellStopInfo *cellId);
1165 uint8_t packMacUlCcchInd(Pst *pst, UlCcchIndInfo *ulCcchIndInfo);
1166 uint8_t unpackMacUlCcchInd(DuMacUlCcchInd func, Pst *pst, Buffer *mBuf);
1167 uint8_t duHandleUlCcchInd(Pst *pst, UlCcchIndInfo *ulCcchIndInfo);
1168 uint8_t packMacDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo);
1169 uint8_t unpackMacDlCcchInd(DuMacDlCcchInd func, Pst *pst, Buffer *mBuf);
1170 uint8_t MacProcDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo);
1171 uint8_t packDuMacUeCreateReq(Pst *pst, MacUeCfg *ueCfg);
1172 uint8_t unpackMacUeCreateReq(DuMacUeCreateReq func, Pst *pst, Buffer *mBuf);
1173 uint8_t MacProcUeCreateReq(Pst *pst, MacUeCfg *ueCfg);
1174 uint8_t sendStopIndMacToDuApp(uint16_t cellId);
1175 uint8_t packDuMacUeCfgRsp(Pst *pst, MacUeCfgRsp *cfgRsp);
1176 uint8_t unpackDuMacUeCfgRsp(MacDuUeCfgRspFunc func, Pst *pst, Buffer *mBuf);
1177 uint8_t DuProcMacUeCfgRsp(Pst *pst, MacUeCfgRsp *cfgRsp);
1178 uint8_t packDuMacUeReconfigReq(Pst *pst, MacUeCfg *ueCfg);
1179 uint8_t unpackMacUeReconfigReq(DuMacUeReconfigReq func, Pst *pst, Buffer *mBuf);
1180 uint8_t MacProcUeReconfigReq(Pst *pst, MacUeCfg *ueCfg);
1181
1182 #endif
1183
1184 /**********************************************************************
1185   End of file
1186  **********************************************************************/