EGTP receiver thread creation
[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         202
64 #define EVENT_MAC_CELL_STOP          203
65 #define EVENT_MAC_CELL_UP_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 enum
484 {
485    MCS_TABLE_QAM64,
486    MCS_TABLE_QAM256,
487    MCS_TABLE_QAM64_LOW_SE
488 }McsTable;
489
490 typedef struct failureCause
491 {
492    CauseGrp   type;
493    union
494    {
495       RadioNwLyrCause   radioNwCause;
496       TransLyrCause     transportCause;
497       ProtCause         protcolCause;
498       MiscFailCause     miscCause;
499    }u;
500 }FailureCause;
501
502 typedef struct carrierCfg
503 {
504    bool  pres;
505    uint32_t   bw;             /* DL/UL bandwidth */
506    uint32_t   freq;           /* Absolute frequency of DL/UL point A in KHz */
507    uint16_t   k0[NUM_NUMEROLOGY];          /* K0 for DL/UL */
508    uint16_t   gridSize[NUM_NUMEROLOGY];    /* DL/UL Grid size for each numerologies */
509    uint16_t   numAnt;         /* Number of Tx/Rx antennas */
510 }CarrierCfg;
511
512 typedef struct ssbCfg
513 {
514    uint32_t    ssbPbchPwr;       /* SSB block power */
515    BchPduOpt   bchPayloadFlag;   /* Options for generation of payload */
516    uint8_t     scsCmn;           /* subcarrier spacing for common */
517    uint16_t    ssbOffsetPointA;  /* SSB subcarrier offset from point A */
518    BetaPss     betaPss;
519    SSBPeriod   ssbPeriod;        /* SSB Periodicity in msec */
520    uint8_t     ssbScOffset;       /* Subcarrier Offset */
521    uint8_t     mibPdu[3];           /* MIB payload */
522    uint32_t    ssbMask[SSB_MASK_SIZE];      /* Bitmap for actually transmitted SSB. */
523    uint8_t     beamId[NUM_SSB];
524    bool        multCarrBand;     /* Multiple carriers in a band */
525    bool        multCellCarr;     /* Multiple cells in single carrier */
526 }SsbCfg;
527
528 typedef struct fdmInfo
529 {
530    uint16_t   rootSeqIdx;        /* Root sequence index */
531    uint8_t    numRootSeq;        /* Number of root sequences required for FD */
532    uint16_t   k1;                /* Frequency Offset for each FD */
533    uint8_t    zeroCorrZoneCfg;   /* Zero correlation zone cofig */
534    uint8_t    numUnusedRootSeq;  /* Number of unused root sequence */
535    uint8_t    *unsuedRootSeq;     /* Unused root sequence per FD */
536 }PrachFdmInfo;
537
538 typedef struct prachCfg
539 {
540    bool          pres;
541    uint8_t       prachCfgIdx;         /* PRACH Cfg Index */
542    PrachSeqLen   prachSeqLen;         /* RACH Sequence length: Long/short */
543    uint8_t       prachSubcSpacing;    /* Subcarrier spacing of RACH */
544    RstSetCfg     prachRstSetCfg;      /* PRACH restricted set config */
545    uint16_t      msg1FreqStart;       /* Msg1-FrequencyStart */
546    uint8_t       msg1Fdm;             /* PRACH FDM (1,2,4,8) */
547    uint8_t       rootSeqLen;          /* Root sequence length */
548    PrachFdmInfo  fdm[8];              /* FDM info */
549    uint8_t       ssbPerRach;          /* SSB per RACH occassion */
550    bool          prachMultCarrBand;   /* Multiple carriers in Band */
551    uint8_t       prachRestrictedSet; /* Support for PRACH restricted set */
552    uint8_t       raContResTmr;        /* RA Contention Resoultion Timer */
553    uint8_t       rsrpThreshSsb;       /* RSRP Threshold SSB */
554    uint8_t       raRspWindow;         /* RA Response Window */
555 }PrachCfg;
556
557 typedef struct tddCfg
558 {
559    bool               pres;
560    DlUlTxPeriodicity  tddPeriod;      /* DL UL Transmission periodicity */
561    SlotConfig         slotCfg[MAXIMUM_TDD_PERIODICITY][MAX_SYMB_PER_SLOT]; 
562 }TDDCfg;
563
564 typedef struct sib1CellCfg
565 {
566    uint8_t  *sib1Pdu;
567    uint16_t sib1PduLen;
568    uint16_t sib1NewTxPeriod;
569    uint16_t sib1RepetitionPeriod;
570    uint8_t coresetZeroIndex;     /* derived from 4 LSB of pdcchSib1 present in MIB */
571    uint8_t searchSpaceZeroIndex; /* derived from 4 MSB of pdcchSib1 present in MIB */
572    uint16_t sib1Mcs;
573 } Sib1CellCfg; 
574
575 typedef struct bwpParams
576 {
577    uint16_t firstPrb;
578    uint16_t numPrb;
579    uint8_t  scs;
580    uint8_t  cyclicPrefix;
581 }BwpParams;
582
583 typedef struct candidatesInfo
584 {
585    uint8_t aggLevel1;
586    uint8_t aggLevel2;
587    uint8_t aggLevel4;
588    uint8_t aggLevel8;
589    uint8_t aggLevel16;
590 }CandidatesInfo;
591
592 typedef struct searchSpaceCfg
593 {
594    uint8_t searchSpaceId;
595    uint8_t coresetId;
596    uint16_t monitoringSlot;
597    uint16_t duration;
598    uint16_t monitoringSymbol;
599    CandidatesInfo candidate;
600 }SearchSpaceCfg;
601
602 typedef struct pdcchConfigCommon
603 {
604    /* only one search space is configured during SIB1 */
605    SearchSpaceCfg commonSearchSpace;
606    uint8_t raSearchSpaceId;
607 }PdcchConfigCommon;
608
609 typedef struct pdschConfigCommon
610 {
611    uint8_t k0;
612    uint8_t mappingType;
613    uint8_t startSymbol;
614    uint8_t lengthSymbol;
615 }PdschConfigCommon;
616
617 typedef struct pucchConfigCommon
618 {
619    uint8_t pucchResourceCommon;
620    uint8_t pucchGroupHopping;
621 }PucchConfigCommon;
622
623 typedef struct puschConfigCommon
624 {
625    /* PUSCH-TimeDomainResourceAllocation info */
626    uint8_t k2;
627    uint8_t mappingType;
628    uint8_t startSymbol;
629    uint8_t lengthSymbol;
630 }PuschConfigCommon;
631
632 typedef struct bwpDlConfig
633 {
634    BwpParams      bwp;
635    PdcchConfigCommon pdcchCommon;
636    PdschConfigCommon pdschCommon;
637 }BwpDlConfig;
638
639 typedef struct bwpUlConfig
640 {
641    BwpParams      bwp;
642    // rach config common sent in PrachCfg
643    PucchConfigCommon pucchCommon;
644    PuschConfigCommon puschCommon;
645 }BwpUlConfig;
646
647 typedef struct macCellCfg
648 {
649    uint16_t       cellId;           /* Cell Id */
650    uint8_t        carrierId;        /* Carrired Index */
651    uint16_t       phyCellId;        /* Physical cell id */
652    uint8_t        numerology;       /* Supported numerology */
653    DuplexMode     dupType;          /* Duplex type: TDD/FDD */
654    CarrierCfg     dlCarrCfg;        /* DL Carrier configuration */
655    CarrierCfg     ulCarrCfg;        /* UL Carrier configuration */
656    bool           freqShft;         /* Indicates presence of 7.5kHz frequency shift */
657    SsbCfg         ssbCfg;           /* SSB configuration */          
658    PrachCfg       prachCfg;         /* PRACH Configuration */
659    TDDCfg         tddCfg;           /* TDD periodicity and slot configuration */
660    RSSIMeasUnit   rssiUnit;         /* RSSI measurement unit */
661    Sib1CellCfg    sib1Cfg;          /* SIB1 config */
662    BwpDlConfig    initialDlBwp;     /* Initial DL BWP */
663    BwpUlConfig    initialUlBwp;     /* Initial UL BWP */
664    uint8_t        dmrsTypeAPos;     /* DMRS Type A position */
665 }MacCellCfg;
666
667 typedef struct macCellCfgCfm
668 {
669    uint16_t       cellId;
670    uint8_t        rsp; 
671 }MacCellCfgCfm;
672
673 typedef struct ulCcchInd
674 {
675    uint16_t cellId;
676    uint16_t crnti;
677    uint16_t ulCcchMsgLen;
678    uint8_t  *ulCcchMsg;
679 }UlCcchIndInfo;
680
681 typedef struct dlCcchInd
682 {
683    uint16_t      cellId;
684    uint16_t      crnti;
685    DlCcchMsgType msgType;
686    uint16_t      dlCcchMsgLen;
687    uint8_t       *dlCcchMsg;
688 }DlCcchIndInfo;
689
690 typedef struct bsrTmrCfg
691 {
692    uint16_t     periodicTimer;
693    uint16_t     retxTimer;
694    uint16_t     srDelayTimer;
695 }BsrTmrCfg;
696
697
698 /* Info of Scheduling Request to Add/Modify */
699 typedef struct schedReqInfo
700 {
701    uint8_t         schedReqId;
702    SrProhibitTimer srProhibitTmr;
703    SrTransMax      srTransMax;
704 }SchedReqInfo;
705
706 /* Scheduling Request Configuration */
707 typedef struct schedReqCfg
708 {
709    uint8_t       addModListCount;
710    SchedReqInfo  addModList[MAX_NUM_SR_CFG_PER_CELL_GRP];   /* List of Scheduling req to be added/modified */
711    uint8_t       relListCount;
712    uint8_t       relList[MAX_NUM_SR_CFG_PER_CELL_GRP];      /* list of scheduling request Id to be deleted */
713 }SchedReqCfg;
714
715 typedef struct tagInfo
716 {
717    uint8_t tagId;
718    TimeAlignmentTimer timeAlignTimer;
719 }TagInfo;
720
721 typedef struct tagCfg
722 {
723    uint8_t      addModListCount;
724    TagInfo      addModList[MAC_NUM_TAGS];  /* List of Tag to Add/Modify */
725    uint8_t      relListCount;
726    uint8_t      relList[MAC_NUM_TAGS];     /* list of Tag Id to release */
727 }TagCfg;
728
729 typedef struct phrCfg
730 {
731    PhrPeriodicTimer periodicTimer;
732    PhrProhibitTimer prohibitTimer; 
733    PhrTxPwrFactorChange txPowerFactor;
734    bool     multiplePHR;       
735    bool     dummy;
736    bool     phrType2OtherCell;
737    PhrModeOtherCG phrOtherCG;
738 }PhrCfg;
739
740 typedef struct macCellGrpCfg
741 {
742    SchedReqCfg schReqCfg;
743    TagCfg      tagCfg;
744    BsrTmrCfg   bsrTmrCfg;
745    bool        phrCfgSetupPres;   /* true/false: phrCfgSetup/phrCfgRelease */
746    PhrCfg      phrCfg;
747 }MacCellGrpCfg;
748
749 typedef struct phyCellGrpCfg
750 {
751    PdschHarqAckCodebook  pdschHarqAckCodebook;
752    uint8_t    pNrFr1;
753 }PhyCellGrpCfg;
754
755 /* Control resource set info */
756 typedef struct controlRsrcSet
757 {
758    uint8_t     cRSetId;                /* Control resource set id */
759    uint8_t     freqDomainRsrc[FREQ_DOM_RSRC_SIZE];  /* Frequency domain resource */
760    uint8_t     duration;
761    REGMappingType cceRegMappingType;
762    PrecoderGranul precoderGranularity;
763    uint16_t    dmrsScramblingId;
764 }ControlRsrcSet;
765
766 /* Search Space info */
767 typedef struct searchSpace
768 {
769    uint8_t     searchSpaceId;
770    uint8_t     cRSetId;
771    MSlotPeriodAndOffset  mSlotPeriodicityAndOffset;
772    uint8_t     mSymbolsWithinSlot[MONITORING_SYMB_WITHIN_SLOT_SIZE];
773    AggrLevel   numCandidatesAggLevel1;      /* Number of candidates for aggregation level 1 */
774    AggrLevel   numCandidatesAggLevel2;      /* Number of candidates for aggregation level 2 */
775    AggrLevel   numCandidatesAggLevel4;      /* Number of candidates for aggregation level 4 */
776    AggrLevel   numCandidatesAggLevel8;      /* Number of candidates for aggregation level 8 */
777    AggrLevel   numCandidatesAggLevel16;     /* Number of candidates for aggregation level 16 */
778    SearchSpaceType searchSpaceType;
779    uint8_t     ueSpecificDciFormat;
780 }SearchSpace;
781
782 /* PDCCH cofniguration */
783 typedef struct pdcchConfig
784 {
785    uint8_t           numCRsetToAddMod;
786    ControlRsrcSet    cRSetToAddModList[MAX_NUM_CRSET];           /* List of control resource set to add/modify */
787    uint8_t           numCRsetToRel;
788    uint8_t           cRSetToRelList[MAX_NUM_CRSET];              /* List of control resource set to release */
789    uint8_t           numSearchSpcToAddMod;
790    SearchSpace       searchSpcToAddModList[MAX_NUM_SEARCH_SPC];  /* List of search space to add/modify */
791    uint8_t           numSearchSpcToRel;
792    uint8_t           searchSpcToRelList[MAX_NUM_SEARCH_SPC];     /* List of search space to release */
793 }PdcchConfig;
794
795 /* PDSCH time domain resource allocation */
796 typedef struct pdschTimeDomRsrcAlloc
797 {
798    CommonMappingType mappingType;
799    uint8_t           startSymbol;
800    uint8_t           symbolLength;
801    uint8_t           startSymbolAndLength;
802 }PdschTimeDomRsrcAlloc;
803
804
805 typedef struct pdschBundling
806 {
807    struct staticBundling
808    {
809      BundlingSizeSet2 size;
810    }StaticBundling;
811    struct dynamicBundling
812    {
813      BundlingSizeSet1 sizeSet1;
814      BundlingSizeSet2 sizeSet2;
815    }DynamicBundling;
816 }PdschBundling;
817
818 /* DMRS downlink configuration */
819 typedef struct dmrsDlCfg
820 {
821    AddPosType  addPos;       /* DMRS additional position */
822 }DmrsDlCfg;
823
824 /* PDSCH Configuration */
825 typedef struct pdschConfig
826 {
827    DmrsDlCfg               dmrsDlCfgForPdschMapTypeA;
828    ResAllocType            resourceAllocType;
829    uint8_t                 numTimeDomRsrcAlloc;
830    PdschTimeDomRsrcAlloc   timeDomRsrcAllociList[MAX_NUM_DL_ALLOC]; /* PDSCH time domain DL resource allocation list */
831    RBGSize                 rbgSize;
832    CodeWordsSchedDci       numCodeWordsSchByDci;                    /* Number of code words scheduled by DCI */
833    BundlingType            bundlingType;
834    PdschBundling           bundlingInfo;
835 }PdschConfig;
836
837 /* Initial Downlink BWP */
838 typedef struct initialDlBwp
839 {
840    bool          pdcchPresent;
841    PdcchConfig   pdcchCfg;
842    bool          pdschPresent;
843    PdschConfig   pdschCfg;
844 }InitialDlBwp;
845
846 /* BWP Downlink common */
847 typedef struct bwpDlCommon
848 {
849 }BwpDlCommon;
850
851 /* Downlink BWP information */
852 typedef struct dlBwpInfo
853 {
854    uint8_t          bwpId;
855 }DlBwpInfo;
856
857 /* PDCCH Serving Cell configuration */
858 typedef struct pdschServCellCfg
859 {
860    uint8_t              *maxMimoLayers;           
861    NumHarqProcForPdsch  numHarqProcForPdsch;
862    MaxCodeBlkGrpPerTB   *maxCodeBlkGrpPerTb;
863    bool                 *codeBlkGrpFlushInd;
864    PdschXOverhead       *xOverhead;
865 }PdschServCellCfg;
866
867 /* PUCCH Configuration */
868 typedef struct pucchCfg
869 {
870    /* TODO : Not used currently */ 
871 }PucchCfg;
872
873 /* Transform precoding disabled */
874 typedef struct transPrecodDisabled
875 {
876    uint16_t   scramblingId0;
877 }TransPrecodDisabled;
878
879 /* DMRS Uplink configuration */
880 typedef struct dmrsUlCfg
881 {
882    AddPosType            addPos;               /* DMRS additional position */
883    TransPrecodDisabled   transPrecodDisabled;  /* Transform precoding disabled */
884 }DmrsUlCfg;
885
886 /* PUSCH Time Domain Resource Allocation */
887 typedef struct puschTimeDomRsrcAlloc
888 {
889    uint8_t   k2;
890    CommonMappingType   mappingType;
891    uint8_t           startSymbol;
892    uint8_t           symbolLength;
893    uint8_t   startSymbolAndLength;
894 }PuschTimeDomRsrcAlloc;
895
896 /* PUSCH Configuration */
897 typedef struct puschCfg
898 {
899    uint8_t                 dataScramblingId;
900    DmrsUlCfg               dmrsUlCfgForPuschMapTypeA;
901    ResAllocType            resourceAllocType;
902    uint8_t                 numTimeDomRsrcAlloc;
903    PuschTimeDomRsrcAlloc   timeDomRsrcAllocList[MAX_NUM_UL_ALLOC]; /* PUSCH time domain UL resource allocation list */
904    TransformPrecoder       transformPrecoder;
905 }PuschCfg;
906
907 /* Initial Uplink BWP */
908 typedef struct initialUlBwp
909 {
910    bool       pucchPresent;
911    PucchCfg   pucchCfg; 
912    bool       puschPresent;
913    PuschCfg   puschCfg;
914 }InitialUlBwp;
915
916 /* Uplink BWP information */
917 typedef struct ulBwpInfo
918 {
919    uint8_t        bwpId;
920 }UlBwpInfo;
921
922 /* Serving cell configuration */
923 typedef struct servCellCfgInfo
924 {
925    InitialDlBwp       initDlBwp;
926    uint8_t            numDlBwpToAdd;
927    DlBwpInfo          DlBwpToAddList[MAX_NUM_BWP];
928    uint8_t            firstActvDlBwpId;
929    uint8_t            defaultDlBwpId;
930    uint8_t            *bwpInactivityTmr;
931    PdschServCellCfg   pdschServCellCfg;
932    InitialUlBwp       initUlBwp;
933    uint8_t            numUlBwpToAdd;
934    UlBwpInfo          UlBwpToAddList[MAX_NUM_BWP];
935    uint8_t            firstActvUlBwpId;
936 }ServCellCfgInfo;
937
938 /* Special cell configuration */
939 typedef struct spCellCfg
940 {
941    uint8_t           servCellIdx;
942    ServCellCfgInfo   servCellCfg;
943 }SpCellCfg;
944
945 typedef struct ambrCfg
946 {
947    uint32_t ulBr;   /* UL Bit rate */
948    uint32_t dlBr;   /* DL Bit rate */
949 }AmbrCfg;
950
951 /* Single Network Slice Selection assistance Info */
952 typedef struct snssai
953 {
954    uint8_t sst;                /* Slice Type */
955    uint8_t sd[SD_SIZE];        /* Slice Differentiator */
956 }Snssai;
957
958 typedef struct nonDynFiveQi
959 {
960    uint16_t   fiveQi;
961    uint8_t    priorLevel;
962    uint16_t   avgWindow;
963    uint16_t   maxDataBurstVol;
964 }NonDynFiveQi;
965
966 typedef struct dynFiveQi
967 {
968    uint8_t    priorLevel;
969    uint16_t   packetDelayBudget;
970    uint8_t    packetErrRateScalar;
971    uint8_t    packetErrRateExp;
972    uint16_t   fiveQi;
973    uint8_t    delayCritical;
974    uint16_t   avgWindow;
975    uint16_t   maxDataBurstVol;
976 }DynFiveQi;
977
978 typedef struct ngRanAllocAndRetPri
979 {
980    uint8_t priorityLevel;
981    uint8_t preEmptionCap;
982    uint8_t preEmptionVul;
983 }NgRanAllocAndRetPri;
984
985 typedef struct grbQosInfo
986 {
987    uint32_t maxFlowBitRateDl;
988    uint32_t maxFlowBitRateUl;
989    uint32_t guarFlowBitRateDl;
990    uint32_t guarFlowBitRateUl;
991 }GrbQosInfo;
992
993 typedef struct drbQos
994 {
995    QosType  fiveQiType;   /* Dynamic or non-dynamic */ 
996    union
997    {
998       NonDynFiveQi   nonDyn5Qi;
999       DynFiveQi      dyn5Qi;
1000    }u;
1001    NgRanAllocAndRetPri ngRanRetPri;
1002    GrbQosInfo grbQosInfo;
1003    uint16_t             pduSessionId;
1004    uint32_t             ulPduSessAggMaxBitRate;
1005 }DrbQosInfo;
1006
1007 typedef struct ulLcCfg
1008 {
1009    uint8_t priority;
1010    uint8_t lcGroup;
1011    uint8_t schReqId;
1012    PBitRate pbr;        // prioritisedBitRate
1013    BucketSizeDur bsd;        // bucketSizeDuration
1014 }UlLcCfg;
1015
1016 typedef struct duLcCfg
1017 {
1018    LcPriority lcp;      // logical Channel Prioritization
1019 }DlLcCfg;
1020
1021 typedef struct lcCfg
1022 {
1023    ConfigType configType;
1024    uint8_t lcId;
1025    DrbQosInfo *drbQos; 
1026    Snssai  *snssai;
1027    bool ulLcCfgPres;
1028    UlLcCfg ulLcCfg;
1029    DlLcCfg dlLcCfg;
1030 }LcCfg;
1031
1032 typedef struct modulationInfo
1033 {
1034    uint8_t     modOrder;    /* Modulation order */
1035    uint8_t     mcsIndex;    /* MCS Index */
1036    McsTable    mcsTable;    /* MCS table */
1037 }ModulationInfo;
1038
1039 typedef struct macUeCfg
1040 {
1041    uint16_t cellId;
1042    uint8_t  ueIdx;
1043    uint16_t crnti;
1044    MacCellGrpCfg macCellGrpCfg;
1045    PhyCellGrpCfg phyCellGrpCfg;
1046    SpCellCfg spCellCfg;
1047    AmbrCfg   *ambrCfg;
1048    ModulationInfo dlModInfo;    /* DL modulation info */
1049    ModulationInfo ulModInfo;    /* UL modulation info */
1050    uint8_t numLcs;
1051    LcCfg lcCfgList[MAX_NUM_LC];
1052    UeCfgState macUeCfgState;    /* InActive / Completed */
1053 }MacUeCfg;
1054
1055 typedef struct nrcgi
1056 {
1057    Plmn      plmn;
1058    uint16_t  cellId;
1059 }Nrcgi;
1060
1061 typedef struct srbFailInfo
1062 {
1063    uint8_t       srbId;
1064    FailureCause  cause;
1065 }SRBFailInfo;
1066
1067 typedef struct drbFailInfo
1068 {
1069    uint8_t       drbId;
1070    FailureCause  cause;
1071 }DRBFailInfo;
1072
1073 typedef struct sCellFailInfo
1074 {
1075    Nrcgi         nrcgi;
1076    FailureCause  cause;
1077 }SCellFailInfo;
1078
1079 typedef struct ueCfgRsp
1080 {
1081    uint16_t       cellId;
1082    uint16_t       ueIdx;
1083    MacRsp         result;
1084    uint8_t        numSRBFailed;   /* valid values : 0 to MAX_NUM_SRB */ 
1085    SRBFailInfo    *failedSRBlisti;
1086    uint8_t        numDRBFailed;   /* valid values : 0 to MAX_NUM_DRB */
1087    DRBFailInfo    *failedDRBlist;
1088    uint8_t        numSCellFailed; /* valid values : 0 to MAX_NUM_SCELL */
1089    SCellFailInfo  *failedSCellList;
1090 }MacUeCfgRsp;
1091
1092 /* Functions for slot Ind from MAC to DU APP*/
1093 typedef uint8_t (*DuMacCellUpInd) ARGS((
1094          Pst       *pst,
1095          OduCellId *cellId ));
1096
1097 /* Functions for stop Ind from MAC to DU APP*/
1098 typedef uint8_t (*DuMacStopInd) ARGS((
1099          Pst        *pst,
1100          OduCellId  *cellId ));
1101
1102 /* Functions for mac cell start req */
1103 typedef uint8_t (*DuMacCellStart) ARGS((
1104          Pst        *pst, 
1105          OduCellId  *cellId));
1106
1107 /* Functions for mac cell stop request */
1108 typedef uint8_t (*DuMacCellStop) ARGS((
1109          Pst        *pst,
1110          OduCellId  *cellId ));
1111
1112 /* Function pointers for packing macCellCfg Request and Confirm */
1113 typedef uint8_t (*packMacCellCfgReq) ARGS((
1114          Pst           *pst,
1115          MacCellCfg    *macCellCfg ));
1116
1117 typedef uint8_t (*packMacCellCfgConfirm) ARGS((
1118          Pst              *pst,
1119          MacCellCfgCfm    *macCellCfgCfm ));
1120
1121 typedef uint8_t (*DuMacCellCfgReq) ARGS((
1122          Pst        *pst,        
1123          MacCellCfg *macCellCfg));
1124
1125 typedef uint8_t (*DuMacCellCfgCfm) ARGS((
1126          Pst        *pst,        
1127          MacCellCfgCfm *macCellCfgCfm ));
1128
1129 /* Functions for UL CCCH Ind from MAC to DU APP*/
1130 typedef uint8_t (*DuMacUlCcchInd) ARGS((
1131          Pst           *pst,
1132          UlCcchIndInfo *ulCcchIndInfo ));
1133
1134 /* Functions for DL CCCH Ind from DU APP to MAC*/
1135 typedef uint8_t (*DuMacDlCcchInd) ARGS((
1136          Pst           *pst,
1137          DlCcchIndInfo *dlCcchIndInfo ));
1138
1139 /* UE create Request from DU APP to MAC*/
1140 typedef uint8_t (*DuMacUeCreateReq) ARGS((
1141          Pst           *pst,
1142          MacUeCfg      *ueCfg ));
1143
1144 /* UE create Response from MAC to DU APP */
1145 typedef uint8_t (*MacDuUeCfgRspFunc) ARGS((
1146          Pst           *pst, 
1147          MacUeCfgRsp   *cfgRsp));
1148
1149 /* UE Reconfig Request from DU APP to MAC*/
1150 typedef uint8_t (*DuMacUeReconfigReq) ARGS((
1151          Pst           *pst,
1152          MacUeCfg      *ueCfg ));
1153
1154 uint8_t packMacCellUpInd(Pst *pst, OduCellId *cellId);
1155 uint8_t unpackMacCellUpInd(DuMacCellUpInd func, Pst *pst, Buffer *mBuf);
1156 uint8_t duHandleCellUpInd(Pst *pst, OduCellId *cellId);
1157 uint8_t packMacCellStart(Pst *pst, OduCellId *cellId);
1158 uint8_t unpackMacCellStart(DuMacCellStart func, Pst *pst, Buffer *mBuf);
1159 uint8_t MacProcCellStart(Pst *pst, OduCellId *cellId);
1160 uint8_t packMacCellStop(Pst *pst, OduCellId *cellId);
1161 uint8_t unpackMacCellStop(DuMacCellStop func, Pst *pst, Buffer *mBuf);
1162 uint8_t MacProcCellStop(Pst *pst, OduCellId *cellId);
1163 uint8_t packMacCellCfg(Pst *pst, MacCellCfg *macCellCfg);
1164 uint8_t unpackDuMacCellCfg(DuMacCellCfgReq func,  Pst *pst,  Buffer *mBuf);
1165 uint8_t MacProcCellCfgReq(Pst *pst, MacCellCfg *macCellCfg);
1166 uint8_t packMacCellCfgCfm(Pst *pst, MacCellCfgCfm *macCellCfgCfm);
1167 uint8_t unpackMacCellCfgCfm(DuMacCellCfgCfm func, Pst *pst, Buffer *mBuf);
1168 uint8_t duHandleMacCellCfgCfm(Pst *pst, MacCellCfgCfm *macCellCfgCfm);
1169 uint8_t packMacStopInd(Pst *pst, OduCellId *cellId);
1170 uint8_t unpackMacStopInd(DuMacStopInd func, Pst *pst, Buffer *mBuf);
1171 uint8_t duHandleStopInd(Pst *pst, OduCellId *cellId);
1172 uint8_t packMacUlCcchInd(Pst *pst, UlCcchIndInfo *ulCcchIndInfo);
1173 uint8_t unpackMacUlCcchInd(DuMacUlCcchInd func, Pst *pst, Buffer *mBuf);
1174 uint8_t duHandleUlCcchInd(Pst *pst, UlCcchIndInfo *ulCcchIndInfo);
1175 uint8_t packMacDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo);
1176 uint8_t unpackMacDlCcchInd(DuMacDlCcchInd func, Pst *pst, Buffer *mBuf);
1177 uint8_t MacProcDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo);
1178 uint8_t packDuMacUeCreateReq(Pst *pst, MacUeCfg *ueCfg);
1179 uint8_t unpackMacUeCreateReq(DuMacUeCreateReq func, Pst *pst, Buffer *mBuf);
1180 uint8_t MacProcUeCreateReq(Pst *pst, MacUeCfg *ueCfg);
1181 uint8_t sendStopIndMacToDuApp(uint16_t cellId);
1182 uint8_t packDuMacUeCfgRsp(Pst *pst, MacUeCfgRsp *cfgRsp);
1183 uint8_t unpackDuMacUeCfgRsp(MacDuUeCfgRspFunc func, Pst *pst, Buffer *mBuf);
1184 uint8_t DuProcMacUeCfgRsp(Pst *pst, MacUeCfgRsp *cfgRsp);
1185 uint8_t packDuMacUeReconfigReq(Pst *pst, MacUeCfg *ueCfg);
1186 uint8_t unpackMacUeReconfigReq(DuMacUeReconfigReq func, Pst *pst, Buffer *mBuf);
1187 uint8_t MacProcUeReconfigReq(Pst *pst, MacUeCfg *ueCfg);
1188
1189 #endif
1190
1191 /**********************************************************************
1192   End of file
1193  **********************************************************************/