Addressed comments in lower Mac
[o-du/l2.git] / src / 5gnrsch / sch.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 /* macros */
20 #define SCH_INST_START 1
21 #define SCH_MAX_CELLS 1
22 #define SCH_MAX_INST 1
23 #define SCH_NUM_SLOTS 10 /*forcing this to 10 */
24 #define SCH_MAX_SFN 1024
25 #define MAX_NUM_RB 106 /* value for numerology 0 15Khz */
26 #define SCH_MIB_TRANS 80 
27 #define SCH_NUM_SC_PRB 12 /* number of SCs in a PRB */
28 #define SCH_MAX_SSB_BEAM 4 /* since we are supporting only SCS=15KHz */
29 #define SCH_SCS_15KHZ 0 /* numerology 0 and 15Khz */
30 #define SCH_SYMBOL_PER_SLOT 14
31 #define SCH_SSB_SYMB_DURATION 4
32 #define SCH_SSB_PRB_DURATION 20
33 #define SCH_MEM_REGION     4
34 #define SCH_POOL           1
35 #define SCHED_DELTA 1
36 #define RAR_DELAY   1
37 #define SCH_MAX_UE  1
38 #define SI_RNTI 0xFFFF
39 #define P_RNTI  0xFFFE
40
41 #define CRC_FAILED 0
42 #define CRC_PASSED 1
43
44 /* allocate and zero out a static buffer */
45 #define SCH_ALLOC(_datPtr, _size)                                \
46 {                                                               \
47    S16 _ret;                                                    \
48    _ret = SGetSBuf(SCH_MEM_REGION, SCH_POOL,                  \
49                     (Data **)&_datPtr, _size);                  \
50    if(_ret == ROK)                                              \
51       cmMemset((U8*)_datPtr, 0, _size);                         \
52    else                                                         \
53       _datPtr = NULLP;                                          \
54 }
55
56 /* free a static buffer */
57 #define SCH_FREE(_datPtr, _size)                                 \
58    if(_datPtr)                                                  \
59       SPutSBuf(SCH_MEM_REGION, SCH_POOL,                      \
60          (Data *)_datPtr, _size);
61
62
63 #define SCH_FILL_RSP_PST(_rspPst, _inst)\
64 {                                  \
65    _rspPst.srcProcId = SFndProcId(); \
66    _rspPst.dstProcId = SFndProcId();\
67    _rspPst.srcEnt    = ENTRG;\
68    _rspPst.dstEnt    = ENTRG;\
69    _rspPst.srcInst   = 1;\
70    _rspPst.dstInst   = 0;\
71         _rspPst.selector  = MAC_SELECTOR_TC;\
72 }       
73 extern uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst);
74 /**
75   * @brief
76   * Structure holding LTE MAC's General Configuration information.
77   */
78 typedef struct schGenCb
79 {
80    uint8_t         tmrRes;           /*!< Timer resolution */
81    uint8_t         startCellId;      /*!< Starting Cell Id */
82 #ifdef LTE_ADV
83    bool            forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
84                                                of RLC control BO and SRB BO on
85                                                PCell. val 0 means don't force*/
86    bool            isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
87 #endif
88 }SchGenCb;
89
90 /**
91   * @brief
92   * scheduler allocationsfor DL per cell.
93   */
94 typedef struct schDlAlloc
95 {
96         uint16_t    totalPrb;  /*!< Number of RBs in the cell */
97         uint16_t    assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
98    bool        ssbPres;    /*!< Flag to determine if SSB is present in this slot */
99    uint8_t     ssbIdxSupported;  /*!< Max SSB index */
100         SsbInfo     ssbInfo[MAX_SSB_IDX]; /*!< SSB info */
101         bool        sib1Pres;
102         bool        rarPres;
103         RarInfo     rarInfo;
104 }SchDlAlloc;
105
106 typedef struct schRaCb
107 {
108    uint16_t tcrnti;
109 }SchRaCb;
110
111 /**
112   * @brief
113   * scheduler allocationsfor UL per cell.
114   */
115 typedef struct schUlAlloc
116 {
117         uint16_t    totalPrb;  /*!< Number of RBs in the cell */
118         uint16_t    assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
119         uint8_t     prachStartSymb; /*!< Start symbol for PRACH */
120 }SchUlAlloc;
121
122 /**
123   * @brief
124   * Cell Control block per cell.
125   */
126 typedef struct schCellCb
127 {
128    uint16_t      cellId;           /*!< Cell ID */
129    Inst          instIdx;          /*!< Index of the scheduler instance */
130    Inst          macInst;          /*!< Index of the MAC instance */
131         uint8_t       numSlots;         /*!< Number of slots in current frame */
132    SlotIndInfo   slotInfo;         /*!< SFN, Slot info being processed*/
133    SchDlAlloc    *dlAlloc[SCH_NUM_SLOTS]; /*!< SCH resource allocations in DL */
134    SchUlAlloc    *ulAlloc[SCH_NUM_SLOTS]; /*!< SCH resource allocations in UL */
135         SchCellCfg    cellCfg;                /*!< Cell ocnfiguration */
136         SchRaCb       raCb[SCH_MAX_UE];
137 }SchCellCb;
138
139 /**
140   * @brief
141   * Control block for sch
142   */
143 typedef struct schCb
144 {
145    TskInit       schInit;              /*!< Task Init info */
146    SchGenCb      genCfg;                 /*!< General Config info */
147    SchCellCb     *cells[SCH_MAX_CELLS];  /* Array to store cellCb ptr */  
148 }SchCb;
149
150 /* Declaration for scheduler control blocks */
151 SchCb schCb[SCH_MAX_INST];
152
153 /* function declarations */
154 uint8_t schBroadcastAlloc(SchCellCb *cell, DlBrdcstAlloc *dlBrdcstAlloc,uint16_t slot);
155 uint8_t schProcessSlotInd(SlotIndInfo *slotInd, Inst inst);
156 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
157
158
159
160 /**********************************************************************
161          End of file
162 **********************************************************************/