1 /*******************************************************************************
2 ################################################################################
3 # Copyright (c) [2017-2019] [Radisys] #
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 #
9 # http://www.apache.org/licenses/LICENSE-2.0 #
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 *******************************************************************************/
23 #define MAX_CRI_SIZE 6
24 #define MAX_MAC_DL_PDU 16
25 #define MAX_NUM_HARQ_PROC 16
26 #define MAX_ZERO_CORR_CFG_IDX 16 /* max zero correlation config index */
27 #define MAC_TQ_SIZE 10 /* Timing Queue Size */
28 #define MAX_NUM_TIMER 1 /* MAX number of MAC timers */
29 #define MAX_PENDING_STATS_RSP 5 /* Maximum number of statistics request for which response is pending */
31 #define DEFAULT_CELLS 1
32 #define SI_RNTI 0xFFFF
35 #define MAC_LCID_CCCH 0
36 #define MAC_LCID_MIN 1
37 #define MAC_LCID_MAX 32
38 #define MAC_LCID_RESERVED_MIN 33
39 #define MAC_LCID_RESERVED_MAX 51
40 #define MAC_LCID_CCCH_48BIT 52
41 #define MAC_LCID_BIT_RATE_QUERY 53
42 #define MAC_LCID_MULT_PHR_FOUR_OCT 54
43 #define MAC_LCID_CFG_GRANT_CFM 55
44 #define MAC_LCID_MULT_PHR_ONE_OCT 56
45 #define MAC_LCID_SINGLE_PHR 57
46 #define MAC_LCID_CRNTI 58
47 #define MAC_LCID_SHORT_TRUNC_BSR 59
48 #define MAC_LCID_LONG_TRUNC_BSR 60
49 #define MAC_LCID_SHORT_BSR 61
50 #define MAC_LCID_LONG_BSR 62
51 #define MAC_LCID_CRI 62
52 #define MAC_LCID_PADDING 63
54 /* Definitions for size of RAR PDU contents (in bits).
55 * Refer spec 38.321, sections 6.1.4, 6.2.2 and 6.2.3*/
61 #define TIMING_ADVANCE_SIZE 12
62 #define T_CRNTI_SIZE 16
64 /* UL Grant is of size = 27 bits. Refer to Spec 38.213, Table 8.2-1 for
65 * contents of UL grant in RAR */
66 #define FREQ_HOP_FLAG_SIZE 1
67 #define FREQ_RSRC_ALLOC_SIZE 14
68 #define TIME_RSRC_ALLOC_SIZE 4
70 #define TPC_COMMAND_SIZE 3
71 #define CSI_REQUEST_SIZE 1
73 typedef struct macCellCb MacCellCb;
79 CELL_STOP_IN_PROGRESS,
91 MAC_LC_STATE_INACTIVE,
95 typedef struct dlTbInfo
97 SlotTimingInfo txTime;
102 /* DL HARQ Process Info */
103 typedef struct dlHarqProcCb
105 uint8_t procId; /* HARQ Process Id */
106 uint8_t numTb; /* Number of TB */
107 DlTbInfo tbInfo[MAX_NUM_TB_PER_UE]; /* TB information */
110 typedef struct macDlSlot
113 DlPageAlloc *pageAllocInfo;
116 typedef struct macUlSlot
118 UlSchedInfo ulSchInfo;
121 typedef struct macCbInfo
125 uint8_t msg3Pdu[6]; /* used as CRI value during muxing */
126 uint8_t *msg4Pdu; /* storing DL-CCCH Ind Pdu */
127 uint16_t msg4PduLen; /* storing DL-CCCH Ind Pdu Len */
128 DlHarqProcCb msg4HqInfo; /* HARQ process info for msg 4 */
135 uint8_t macCeValue[6];
138 typedef struct macCeInfo
141 MacCe macCe[MAX_MAC_CE];
144 typedef struct macDlInfo
151 typedef struct macDlData
155 MacDlInfo pduInfo[MAX_MAC_DL_PDU];
159 typedef struct dlHarqEnt
161 uint8_t maxReTx; /* MAX HARQ retransmission */
162 uint8_t numHarqProcs; /* Number of HARQ procs */
163 DlHarqProcCb harqProcCb[MAX_NUM_HARQ_PROC];
166 /* Uplink deidcated logical channel info */
167 typedef struct ulLcCb
169 uint8_t lcId; /* Logical Channel Id */
170 uint8_t lcGrpId; /* Logical Channel group */
171 MacLcState lcActive; /* Is LC active ? */
172 /*Commenting as S-NSSAI and PDU session will be used in future scope*/
173 /*For eg: When we have to send these for AMBR cases*/
175 uint16_t pduSessionId; /*Pdu Session Id*/
176 Snssai *snssai; /*S-NSSAI assoc with LCID*/
180 /* Downlink dedicated logical channel info */
181 typedef struct dlLcCb
183 uint8_t lcId; /* Logical channel Id */
184 MacLcState lcState; /* Is LC active ? */
185 /*Commenting as S-NSSAI and PDU session will be used in future scope*/
186 /*For eg: When we have to send these info via FAPI to phy layer*/
188 uint16_t pduSessionId;/*Pdu Session Id*/
189 Snssai *snssai; /*S-NSSAI assoc with LCID*/
193 /* BSR Information */
194 typedef struct macBsrTmrCfg
196 uint16_t periodicTimer;
198 uint16_t srDelayTimer;
201 /* UE specific UL info */
202 typedef struct ueUlCb
204 uint8_t maxReTx; /* MAX HARQ retransmission */
205 uint8_t numUlLc; /* Number of uplink logical channels */
206 UlLcCb lcCb[MAX_NUM_LC]; /* Uplink dedicated logocal channels */
209 /* UE specific DL Info */
210 typedef struct ueDlCb
212 DlHarqEnt dlHarqEnt; /* DL HARQ entity */
213 uint8_t numDlLc; /* Number of downlink logical channels */
214 DlLcCb lcCb[MAX_NUM_LC]; /* Downlink dedicated logical channels */
218 typedef struct macUeCb
220 uint16_t ueId; /* UE Id from DU APP */
221 uint16_t crnti; /* UE CRNTI */
222 MacCellCb *cellCb; /* Pointer to cellCb to whihc this UE belongs */
223 UeState state; /* Is UE active ? */
224 MacCfraResource cfraResource; /* CF-RA resource */
225 MacRaCbInfo *raCb; /* RA info */
226 MacBsrTmrCfg bsrTmrCfg; /* BSR Timer Info */
227 UeUlCb ulInfo; /* UE specific UL info */
228 UeDlCb dlInfo; /* UE specific DL info */
229 DataTransmissionAction transmissionAction;
238 MacRaCbInfo macRaCb[MAX_NUM_UE];
239 MacDlSlot dlSlot[MAX_SLOTS];
240 MacUlSlot ulSlot[MAX_SLOTS];
242 MacUeCreateReq *ueCfgTmpData[MAX_NUM_UE];
243 MacUeRecfg *ueRecfgTmpData[MAX_NUM_UE];
244 MacUeCb ueCb[MAX_NUM_UE];
245 MacCellCfg macCellCfg;
247 SlotTimingInfo currTime;
250 typedef struct macStatistics
252 uint8_t numPendingStatsRsp;
253 MacStatsRsp pendingStatsRsp[MAX_PENDING_STATS_RSP];
255 /* This structure can be developed in future to add details of
256 * the statistics to be calculated at MAC */
263 uint8_t tmrRes; /*!< Timer resolution */
264 CmTqCp tmrTqCp; /*!< Timer Task Queue Cntrl Point */
265 CmTqType tmrTq[MAC_TQ_SIZE]; /*!< Timer Task Queue */
266 CmTimer tmrBlk[MAX_NUM_TIMER]; /*!< Timer Block */
267 MacCellCb *macCell[MAX_NUM_CELL];
268 MacStatistics statistics;
271 /* global variable */
274 /* Function declarations */
275 uint8_t macActvInit ARGS((Ent entity, Inst inst, Region region, Reason reason));
276 uint8_t macActvTsk(Pst *pst, Buffer *mBuf);
277 short int macActvTmr(Ent ent,Inst inst);
279 void fillRarPdu(RarInfo *rarInfo);
280 void fillMsg4DlData(MacDlData *dlData, uint16_t msg4PduLen, uint8_t *msg4Pdu);
281 void fillMacCe(MacCeInfo *macCeData, uint8_t *msg3Pdu);
282 void macMuxPdu(MacDlData *dlData, MacCeInfo *macCeData, uint8_t *msg4TxPdu, uint16_t tbSize);
283 uint8_t unpackRxData(uint16_t cellId, SlotTimingInfo slotInfo, RxDataIndPdu *rxDataIndPdu);
284 void fillMg4Pdu(DlMsgSchInfo *msg4Alloc);
285 void buildAndSendMuxPdu(SlotTimingInfo currTimingInfo);
286 uint8_t macProcUlCcchInd(uint16_t cellId, uint16_t crnti, uint16_t rrcContSize, uint8_t *rrcContainer);
287 uint8_t macProcShortBsr(uint16_t cellId, uint16_t crnti, uint8_t lcgId, uint32_t bufferSize);
288 uint8_t macProcUlData(uint16_t cellId, uint16_t rnti, SlotTimingInfo slotInfo, uint8_t lcId, uint16_t pduLen, uint8_t *pdu);
289 uint8_t sendSchedRptToRlc(DlSchedInfo dlInfo, SlotTimingInfo slotInfo, uint8_t ueIdx, uint8_t schInfoIdx);
290 uint8_t macProcLongBsr(uint16_t cellId, uint16_t crnti,uint8_t numLcg, DataVolInfo dataVolInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS]);
291 void freeMacSliceCfgReq(MacSliceCfgReq *cfgReq,Pst *pst);
292 void deleteMacRaCb(uint16_t cellIdx, MacUeCb *ueCb);
294 uint8_t MacProcSchSliceCfgRsp(Pst *pst, SchSliceCfgRsp *schSliceCfgRsp);
295 uint8_t MacProcSchSliceRecfgRsp(Pst *pst, SchSliceRecfgRsp *sliceRecfgrsp);
296 uint8_t MacProcSchCellCfgCfm(Pst *pst, SchCellCfgCfm *schCellCfgCfm);
297 uint8_t MacProcDlAlloc(Pst *pst, DlSchedInfo *dlSchedInfo);
298 uint8_t MacProcUlSchInfo(Pst *pst, UlSchedInfo *ulSchedInfo);
299 uint8_t MacProcSchRachRsrcRsp(Pst *pst, SchRachRsrcRsp *schRachRsrcRsp);
300 uint8_t MacProcDlPageAlloc(Pst *pst, DlPageAlloc *dlPageAlloc);
301 uint8_t MacProcSchCellDeleteRsp(Pst *pst, SchCellDeleteRsp *schCellDeleteRsp);
303 uint8_t MacProcSchStatsRsp(Pst *pst, SchStatsRsp *schStatsRsp);
304 uint8_t MacProcSchStatsInd(Pst *pst, SchStatsInd *schStatsInd);
305 uint8_t MacProcSchStatsDeleteRsp(Pst *pst, SchStatsDeleteRsp *schStatsDeleteRsp);
306 uint8_t MacProcSchStatsModificationRsp(Pst *pst, SchStatsModificationRsp *schStatsModificationRsp);
309 /**********************************************************************
311 **********************************************************************/