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 *******************************************************************************/
18 /* header include files (.h) */
19 #include "common_def.h"
22 #include "du_app_mac_inf.h"
23 #include "mac_sch_interface.h"
24 #include "lwr_mac_upr_inf.h"
25 #include "rlc_mac_inf.h"
27 #include "mac_upr_inf_api.h"
29 #include "lwr_mac_fsm.h"
30 #include "mac_utils.h"
31 #include "mac_harq_dl.h"
32 #include "lwr_mac_phy.h"
35 * @brief process DL allocation from scheduler
39 * Function : MacProcDlAlloc
41 * This function copied dl sch info in the mac slot info
44 * @param[in] DL allocation from scheduler
49 uint8_t MacProcDlAlloc(Pst *pst, DlSchedInfo *dlSchedInfo)
51 uint8_t schInfoIdx = 0, cwIdx = 0;
52 uint8_t ueId = 0, ueIdx = 0;
54 uint8_t *retxTb = NULLP, *txPdu = NULLP;
55 uint16_t txPduLen = 0;
56 MacDlSlot *currDlSlot = NULLP;
57 DlMsgSchInfo schedInfo;
58 DlHarqProcCb *hqProcCb = NULLP;
60 #ifdef CALL_FLOW_DEBUG_LOG
61 DU_LOG("\nCall Flow: ENTSCH -> ENTMAC : EVENT_DL_SCH_INFO\n");
63 if(dlSchedInfo != NULLP)
65 GET_CELL_IDX(dlSchedInfo->cellId, cellIdx);
66 if(dlSchedInfo->isBroadcastPres)
68 currDlSlot = &macCb.macCell[cellIdx]->\
69 dlSlot[dlSchedInfo->schSlotValue.broadcastTime.slot];
70 currDlSlot->dlInfo.isBroadcastPres = true;
71 memcpy(&currDlSlot->dlInfo.brdcstAlloc, &dlSchedInfo->brdcstAlloc, sizeof(DlBrdcstAlloc));
72 currDlSlot->dlInfo.brdcstAlloc.sib1Alloc.sib1PdcchCfg.dci.pdschCfg = \
73 &currDlSlot->dlInfo.brdcstAlloc.sib1Alloc.sib1PdschCfg;
76 for(ueIdx=0; ueIdx<MAX_NUM_UE; ueIdx++)
78 if(dlSchedInfo->rarAlloc[ueIdx] != NULLP)
80 currDlSlot = &macCb.macCell[cellIdx]->dlSlot[dlSchedInfo->schSlotValue.rarTime.slot];
81 currDlSlot->dlInfo.rarAlloc[ueIdx] = dlSchedInfo->rarAlloc[ueIdx];
84 fillRarPdu(&currDlSlot->dlInfo.rarAlloc[ueIdx]->rarInfo);
87 if(dlSchedInfo->dlMsgAlloc[ueIdx] != NULLP)
89 currDlSlot = &macCb.macCell[cellIdx]->\
90 dlSlot[dlSchedInfo->schSlotValue.dlMsgTime.slot];
91 currDlSlot->dlInfo.dlMsgAlloc[ueIdx] = dlSchedInfo->dlMsgAlloc[ueIdx]; /* copy msg4 alloc pointer in MAC slot info */
92 currDlSlot->dlInfo.cellId = dlSchedInfo->cellId;
94 /* Check if the downlink pdu is msg4 */
95 for(schInfoIdx=0; schInfoIdx < dlSchedInfo->dlMsgAlloc[ueIdx]->numSchedInfo; schInfoIdx++)
97 if(dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].dlMsgInfo.isMsg4Pdu)
99 GET_UE_ID(dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].dlMsgInfo.crnti, ueId);
101 schedInfo = dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx];
102 hqProcCb = &macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4HqInfo;
104 if(!dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].isRetx)
106 /* First transmission of MSG4 */
107 hqProcCb->procId = schedInfo.dlMsgInfo.harqProcNum;
108 for(cwIdx = 0; cwIdx < schedInfo.dlMsgPdschCfg.numCodewords; cwIdx++)
110 memcpy(&hqProcCb->tbInfo[hqProcCb->numTb].txTime, &dlSchedInfo->schSlotValue.dlMsgTime, \
111 sizeof(SlotTimingInfo));
112 hqProcCb->tbInfo[hqProcCb->numTb].tbSize = schedInfo.dlMsgPdschCfg.codeword[cwIdx].tbSize;
118 /* MSG4 retransmission */
119 if(hqProcCb->procId == schedInfo.dlMsgInfo.harqProcNum)
121 memcpy(&hqProcCb->tbInfo[0].txTime, &dlSchedInfo->schSlotValue.dlMsgTime, \
122 sizeof(SlotTimingInfo));
128 memcpy(&currDlSlot->dlInfo.schSlotValue, &dlSchedInfo->schSlotValue, sizeof(SchSlotValue));
130 if(!dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].isRetx)
132 /* If new data transmission is scheduled, send schedule results to RLC */
133 if((dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].pduPres == PDSCH_PDU) ||
134 (dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].pduPres == BOTH))
136 sendSchedRptToRlc(currDlSlot->dlInfo, dlSchedInfo->schSlotValue.dlMsgTime, ueIdx, schInfoIdx);
138 /* Add HARQ Proc to DL HARQ Proc Entity in UE */
139 addDlHqProcInUe(currDlSlot->dlInfo.schSlotValue.dlMsgTime, &macCb.macCell[cellIdx]->ueCb[ueIdx], \
140 dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx]);
145 /* For retransmission, fetch PDU to be retransmitted from DL HARQ entity and schedule on corresponding slot */
147 /* As of now this loop will run only once for one TB.
148 * TODO : update handling of fetched TB appropriately when support for two TB is added
151 cwIdx < dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].dlMsgPdschCfg.numCodewords;\
154 /* Fetch TB to be retransmitted */
155 txPduLen = dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].dlMsgPdschCfg.codeword[cwIdx].tbSize;
156 retxTb = fetchTbfromDlHarqProc(currDlSlot->dlInfo.schSlotValue.dlMsgTime, \
157 &macCb.macCell[cellIdx]->ueCb[ueIdx], \
158 dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].dlMsgInfo.harqProcNum, txPduLen);
160 /* Store PDU in corresponding DL slot */
161 MAC_ALLOC(txPdu, txPduLen);
164 DU_LOG("\nERROR --> MAC : Memory allocation failed in MacProcDlAlloc");
167 memcpy(txPdu, retxTb, txPduLen);
169 currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].dlMsgInfo.dlMsgPduLen = txPduLen;
170 currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].dlMsgInfo.dlMsgPdu = txPdu;
178 if(dlSchedInfo->ulGrant != NULLP)
180 currDlSlot = &macCb.macCell[cellIdx]->dlSlot[dlSchedInfo->schSlotValue.ulDciTime.slot];
181 currDlSlot->dlInfo.ulGrant = dlSchedInfo->ulGrant;
188 * @brief process DL Paging allocation from scheduler
192 * Function : MacProcDlPageAlloc
194 * This function copied dl Pag info in the mac slot info
196 * @param[in] Pst *pst
197 * @param[in] DL Paging allocation from scheduler
202 uint8_t MacProcDlPageAlloc(Pst *pst, DlPageAlloc *dlPageAlloc)
204 uint16_t cellIdx = 0;
205 MacDlSlot *currDlSlot = NULLP;
207 #ifdef CALL_FLOW_DEBUG_LOG
208 DU_LOG("\nCall Flow: ENTSCH -> ENTMAC : EVENT_DL_PAGING_ALLOC\n");
210 if(dlPageAlloc != NULLP)
212 GET_CELL_IDX(dlPageAlloc->cellId, cellIdx);
214 currDlSlot = &macCb.macCell[cellIdx]->dlSlot[dlPageAlloc->dlPageTime.slot];
215 MAC_ALLOC(currDlSlot->pageAllocInfo, sizeof(DlPageAlloc));
216 if(currDlSlot->pageAllocInfo == NULLP)
218 DU_LOG("\nERROR --> MAC : MacProcDlPageAlloc : Memory Allocation is failed!");
221 memcpy(currDlSlot->pageAllocInfo, dlPageAlloc, sizeof(DlPageAlloc));
222 currDlSlot->pageAllocInfo->pagePdcchCfg.dci.pdschCfg = \
223 &currDlSlot->pageAllocInfo->pagePdschCfg;
227 DU_LOG("\nERROR --> MAC : DL Paging Allocation is failed!");
234 * @brief Forming and filling the MUX Pdu
237 * Function : fillMsg4Pdu
239 * Forming and filling of Msg4Pdu
241 * @param[in] DlMsgAlloc *msg4Alloc
244 void fillMsg4Pdu(uint16_t cellId, DlMsgSchInfo *msg4SchInfo)
246 uint8_t ueId = 0, ueIdx = 0;
248 uint16_t msg4TxPduLen;
249 MacDlData msg4DlData;
251 DlHarqProcCb *hqProcCb;
253 GET_CELL_IDX(cellId, cellIdx);
255 memset(&msg4DlData, 0, sizeof(MacDlData));
256 memset(&macCeData, 0, sizeof(MacCeInfo));
258 GET_UE_ID(msg4SchInfo->dlMsgInfo.crnti, ueId);
261 if(macCb.macCell[cellIdx] == NULLP)
263 DU_LOG("\nERROR --> MAC: Cell Id[%d] not found", cellId);
267 hqProcCb = &macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4HqInfo;
268 msg4TxPduLen = hqProcCb->tbInfo[0].tbSize - TX_PAYLOAD_HDR_LEN;
270 if(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu != NULLP)
272 MAC_ALLOC(msg4DlData.pduInfo[msg4DlData.numPdu].dlPdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
273 if(msg4DlData.pduInfo[msg4DlData.numPdu].dlPdu != NULLP)
275 fillMsg4DlData(&msg4DlData, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen, \
276 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu);
277 fillMacCe(&macCeData, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg3Pdu);
279 /* Forming Mux Pdu */
280 hqProcCb->tbInfo[0].tb = NULLP;
281 MAC_ALLOC(hqProcCb->tbInfo[0].tb, msg4TxPduLen);
282 if(hqProcCb->tbInfo[0].tb != NULLP)
284 memset(hqProcCb->tbInfo[0].tb, 0, msg4TxPduLen);
285 macMuxPdu(&msg4DlData, &macCeData, hqProcCb->tbInfo[0].tb, msg4TxPduLen);
289 DU_LOG("\nERROR --> MAC: Failed allocating memory for msg4TxPdu");
291 /* Free memory allocated */
292 MAC_FREE(msg4DlData.pduInfo[msg4DlData.numPdu-1].dlPdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
293 MAC_FREE(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
294 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu = NULLP;
295 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen = 0;
301 /* storing msg4 Pdu in macDlSlot */
302 if(hqProcCb->tbInfo[0].tb)
304 msg4SchInfo->dlMsgInfo.dlMsgPduLen = msg4TxPduLen;
305 MAC_ALLOC(msg4SchInfo->dlMsgInfo.dlMsgPdu, msg4SchInfo->dlMsgInfo.dlMsgPduLen);
306 if(msg4SchInfo->dlMsgInfo.dlMsgPdu != NULLP)
308 memcpy(msg4SchInfo->dlMsgInfo.dlMsgPdu, hqProcCb->tbInfo[0].tb, \
309 msg4SchInfo->dlMsgInfo.dlMsgPduLen);
314 DU_LOG("\nERROR --> MAC: Failed at fillMsg4Pdu()");
319 * @brief Builds and Send the Muxed Pdu to Lower MAC
323 * Function : buildAndSendMuxPdu
325 * Build and Sends the Muxed Pdu to Lower MAC.
327 * @param[in] SlotTimingInfo *slotInd
331 void buildAndSendMuxPdu(SlotTimingInfo currTimingInfo)
336 MacDlSlot *currDlSlot = NULLP;
337 SlotTimingInfo muxTimingInfo;
338 memset(&muxTimingInfo, 0, sizeof(SlotTimingInfo));
340 GET_CELL_IDX(currTimingInfo.cellId, cellIdx);
342 ADD_DELTA_TO_TIME(currTimingInfo, muxTimingInfo, PHY_DELTA_DL, macCb.macCell[cellIdx]->numOfSlots);
343 currDlSlot = &macCb.macCell[cellIdx]->dlSlot[muxTimingInfo.slot];
345 for(ueIdx=0; ueIdx<MAX_NUM_UE; ueIdx++)
347 if(currDlSlot->dlInfo.dlMsgAlloc[ueIdx])
349 for(schInfoIdx=0; schInfoIdx<currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->numSchedInfo; schInfoIdx++)
351 if((currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].dlMsgInfo.isMsg4Pdu) &&
352 ((currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].pduPres == PDSCH_PDU) ||
353 (currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx].pduPres == BOTH)))
355 fillMsg4Pdu(currTimingInfo.cellId, &currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgSchedInfo[schInfoIdx]);
363 * @brief Transmission time interval indication from PHY.
367 * Function : sendSlotIndMacToSch
369 * This API is invoked by MAC to send slot ind to scheduler.
371 * @param[in] SlotTimingInfo *slotInd
376 int sendSlotIndMacToSch(SlotTimingInfo *slotInd)
378 /* fill Pst structure to send to lwr_mac to MAC */
381 FILL_PST_MAC_TO_SCH(pst, EVENT_SLOT_IND_TO_SCH);
382 return(SchMessageRouter(&pst, (void *)slotInd));
385 /*******************************************************************
387 * @brief Send cell up indication to DU APP
391 * Function : sendCellUpIndMacToDuApp
394 * Send cell up indication to DU APP
396 * @params[in] Cell Up indication info
397 * @return ROK - success
400 * ****************************************************************/
401 int sendCellUpIndMacToDuApp(uint16_t cellId)
405 OduCellId *oduCellId;
407 /* Allocate sharable memory */
408 MAC_ALLOC_SHRABL_BUF(oduCellId, sizeof(OduCellId));
411 DU_LOG("\nERROR --> MAC : Memory allocation failed for cell up indication");
414 oduCellId->cellId = cellId;
417 FILL_PST_MAC_TO_DUAPP(pst, EVENT_MAC_CELL_UP_IND);
419 ret = MacDuAppCellUpInd(&pst, oduCellId);
422 DU_LOG("\nERROR --> MAC: Failed to send cell up indication to DU APP");
423 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, oduCellId, sizeof(OduCellId));
427 } /* sendCellUpIndMacToDuApp */
429 /*******************************************************************
431 * @brief Send slot indication to DU APP
435 * Function : sendSlotIndToDuApp
438 * Send cell up indication to DU APP
440 * @params[in] Cell Up indication info
441 * @return ROK - success
444 * ****************************************************************/
445 uint8_t sendSlotIndToDuApp(SlotTimingInfo *slotInd)
449 SlotTimingInfo *slotIndInfo;
451 /* Allocate sharable memory */
452 MAC_ALLOC_SHRABL_BUF(slotIndInfo, sizeof(SlotTimingInfo));
455 DU_LOG("\nERROR --> MAC : Memory allocation failed for slot indication");
458 memcpy(slotIndInfo, slotInd,sizeof(SlotTimingInfo));
461 FILL_PST_MAC_TO_DUAPP(pst, EVENT_MAC_SLOT_IND);
463 ret = MacDuAppSlotInd(&pst, slotIndInfo);
466 DU_LOG("\nERROR --> MAC: Failed to send slot up indication to DU APP");
467 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, slotIndInfo, sizeof(SlotTimingInfo));
472 /*******************************************************************
474 * @brief Process slot indication at MAC
478 * Function : macProcSlotInd
480 * Functionality: Process slot indication at MAC
482 * @params[in] Slot indication info
483 * @return ROK - success
486 * ****************************************************************/
487 uint8_t macProcSlotInd(SlotTimingInfo slotInd)
489 uint16_t cellIdx = 0;
491 GET_CELL_IDX(slotInd.cellId, cellIdx);
493 if(macCb.macCell[cellIdx] == NULLP)
495 DU_LOG("ERROR --> MAC : macProcSlotInd(): CellId[%d] does not exist. Error occurred at SFN [%d] Slot [%d]",\
496 slotInd.cellId, slotInd.sfn, slotInd.slot);
499 /* Store current time info */
500 macCb.macCell[cellIdx]->currTime.cellId = slotInd.cellId;
501 macCb.macCell[cellIdx]->currTime.slot = slotInd.slot;
502 macCb.macCell[cellIdx]->currTime.sfn = slotInd.sfn;
504 /* Mux Pdu for Msg4 */
505 buildAndSendMuxPdu(slotInd);
507 /* Trigger for DL TTI REQ */
508 fillDlTtiReq(slotInd);
511 } /* macProcSlotInd */
514 * @brief Transmission time interval indication from PHY.
518 * Function : fapiMacSlotInd
520 * This API is invoked by PHY to indicate TTI indication to MAC for a cell.
522 * @param[in] Pst *pst
523 * @param[in] SuId suId
524 * @param[in] SlotTimingInfo *slotInd
529 uint8_t fapiMacSlotInd(Pst *pst, SlotTimingInfo *slotInd)
533 volatile uint32_t startTime=0;
535 #ifdef ODU_SLOT_IND_DEBUG_LOG
536 DU_LOG("\nDEBUG --> MAC : Slot Indication received. [%d : %d]", slotInd->sfn, slotInd->slot);
539 ODU_START_TASK(&startTime, PID_MAC_TTI_IND);
544 GET_CELL_IDX(slotInd->cellId, cellIdx);
545 macCb.macCell[cellIdx]->state = CELL_STATE_UP;
548 /* When testing L2 with Intel-L1, any changes specific to
549 * timer mode testing must be guarded under INTEL_TIMER_MODE*/
550 #ifndef INTEL_TIMER_MODE
551 /* send slot indication to scheduler */
552 ret = sendSlotIndMacToSch(slotInd);
555 DU_LOG("\nERROR --> MAC : Sending of slot ind msg from MAC to SCH failed");
556 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
560 ret = macProcSlotInd(*slotInd);
563 DU_LOG("\nERROR --> MAC : macProcSlotInd failed");
564 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
569 /*First Slot Ind is for CellUp. Any other Slot, will be notified to DUAPP as
573 /* send cell up indication to du app */
574 ret = sendCellUpIndMacToDuApp(slotInd->cellId);
579 /* send slot indication to du app */
580 ret = sendSlotIndToDuApp(slotInd);
585 DU_LOG("\nERROR --> MAC :Sending of slot ind msg from MAC to DU APP failed");
586 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
591 ODU_STOP_TASK(startTime, PID_MAC_TTI_IND);
592 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
595 lwrMacCb.phySlotIndCntr++;
596 if(lwrMacCb.phySlotIndCntr > WLS_MEM_FREE_PRD)
598 lwrMacCb.phySlotIndCntr = 1;
600 freeWlsBlockList(lwrMacCb.phySlotIndCntr - 1);
604 } /* fapiMacSlotInd */
606 /**********************************************************************
608 **********************************************************************/