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));
74 for(ueIdx=0; ueIdx<MAX_NUM_UE; ueIdx++)
76 if(dlSchedInfo->rarAlloc[ueIdx] != NULLP)
78 currDlSlot = &macCb.macCell[cellIdx]->dlSlot[dlSchedInfo->schSlotValue.rarTime.slot];
79 currDlSlot->dlInfo.rarAlloc[ueIdx] = dlSchedInfo->rarAlloc[ueIdx];
82 fillRarPdu(&currDlSlot->dlInfo.rarAlloc[ueIdx]->rarInfo);
85 if(dlSchedInfo->dlMsgAlloc[ueIdx] != NULLP)
87 currDlSlot = &macCb.macCell[cellIdx]->\
88 dlSlot[dlSchedInfo->schSlotValue.dlMsgTime.slot];
89 currDlSlot->dlInfo.dlMsgAlloc[ueIdx] = dlSchedInfo->dlMsgAlloc[ueIdx]; /* copy msg4 alloc pointer in MAC slot info */
90 currDlSlot->dlInfo.cellId = dlSchedInfo->cellId;
92 if(dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgPdcchCfg && dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgPdcchCfg->coresetCfg.coreSetType == CORESET_TYPE0)
94 MAC_ALLOC(macCb.macCell[cellIdx]->macRaCb[ueIdx].macMsg4Status, sizeof(bool));
97 /* Check if the downlink pdu is msg4 */
98 if((macCb.macCell[cellIdx]->macRaCb[ueIdx].macMsg4Status))
100 GET_UE_ID(dlSchedInfo->dlMsgAlloc[ueIdx]->crnti, ueId);
102 schedInfo = dlSchedInfo->dlMsgAlloc[ueIdx];
103 hqProcCb = &macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4HqInfo;
105 if(!dlSchedInfo->dlMsgAlloc[ueIdx]->transportBlock[0].ndi)
107 /* First transmission of MSG4 */
108 hqProcCb->procId = schedInfo->harqProcNum;
109 for(cwIdx = 0; cwIdx < schedInfo->dlMsgPdschCfg->numCodewords; cwIdx++)
111 memcpy(&hqProcCb->tbInfo[hqProcCb->numTb].txTime, &dlSchedInfo->schSlotValue.dlMsgTime, \
112 sizeof(SlotTimingInfo));
113 hqProcCb->tbInfo[hqProcCb->numTb].tbSize = schedInfo->dlMsgPdschCfg->codeword[cwIdx].tbSize;
119 /* MSG4 retransmission */
120 if(hqProcCb->procId == schedInfo->harqProcNum)
122 memcpy(&hqProcCb->tbInfo[0].txTime, &dlSchedInfo->schSlotValue.dlMsgTime, \
123 sizeof(SlotTimingInfo));
129 memcpy(&currDlSlot->dlInfo.schSlotValue, &dlSchedInfo->schSlotValue, sizeof(SchSlotValue));
131 if(!dlSchedInfo->dlMsgAlloc[ueIdx]->transportBlock[0].ndi)
133 /* If new data transmission is scheduled, send schedule results to RLC */
134 if(dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgPdschCfg)
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]);
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
150 for(cwIdx = 0; cwIdx < dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgPdschCfg->numCodewords; cwIdx++)
152 /* Fetch TB to be retransmitted */
153 txPduLen = dlSchedInfo->dlMsgAlloc[ueIdx]->dlMsgPdschCfg->codeword[cwIdx].tbSize;
154 retxTb = fetchTbfromDlHarqProc(currDlSlot->dlInfo.schSlotValue.dlMsgTime, \
155 &macCb.macCell[cellIdx]->ueCb[ueIdx], \
156 dlSchedInfo->dlMsgAlloc[ueIdx]->harqProcNum, txPduLen);
158 /* Store PDU in corresponding DL slot */
159 MAC_ALLOC(txPdu, txPduLen);
162 DU_LOG("\nERROR --> MAC : Memory allocation failed in MacProcDlAlloc");
165 memcpy(txPdu, retxTb, txPduLen);
167 currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgPduLen = txPduLen;
168 currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgPdu = txPdu;
175 if(dlSchedInfo->ulGrant != NULLP)
177 currDlSlot = &macCb.macCell[cellIdx]->dlSlot[dlSchedInfo->schSlotValue.ulDciTime.slot];
178 currDlSlot->dlInfo.ulGrant = dlSchedInfo->ulGrant;
185 * @brief process DL Paging allocation from scheduler
189 * Function : MacProcDlPageAlloc
191 * This function copied dl Pag info in the mac slot info
193 * @param[in] Pst *pst
194 * @param[in] DL Paging allocation from scheduler
199 uint8_t MacProcDlPageAlloc(Pst *pst, DlPageAlloc *dlPageAlloc)
201 uint16_t cellIdx = 0;
202 MacDlSlot *currDlSlot = NULLP;
204 #ifdef CALL_FLOW_DEBUG_LOG
205 DU_LOG("\nCall Flow: ENTSCH -> ENTMAC : EVENT_DL_PAGING_ALLOC\n");
207 if(dlPageAlloc != NULLP)
209 GET_CELL_IDX(dlPageAlloc->cellId, cellIdx);
211 currDlSlot = &macCb.macCell[cellIdx]->dlSlot[dlPageAlloc->dlPageTime.slot];
212 MAC_ALLOC(currDlSlot->pageAllocInfo, sizeof(DlPageAlloc));
213 if(currDlSlot->pageAllocInfo == NULLP)
215 DU_LOG("\nERROR --> MAC : MacProcDlPageAlloc : Memory Allocation is failed!");
218 memcpy(currDlSlot->pageAllocInfo, dlPageAlloc, sizeof(DlPageAlloc));
222 DU_LOG("\nERROR --> MAC : DL Paging Allocation is failed!");
229 * @brief Forming and filling the MUX Pdu
232 * Function : fillMsg4Pdu
234 * Forming and filling of Msg4Pdu
236 * @param[in] DlMsgAlloc *msg4Alloc
239 void fillMsg4Pdu(uint16_t cellId, DlMsgSchInfo *msg4SchInfo)
241 uint8_t ueId = 0, ueIdx = 0;
243 uint16_t msg4TxPduLen;
244 MacDlData msg4DlData;
246 DlHarqProcCb *hqProcCb;
248 GET_CELL_IDX(cellId, cellIdx);
250 memset(&msg4DlData, 0, sizeof(MacDlData));
251 memset(&macCeData, 0, sizeof(MacCeInfo));
253 GET_UE_ID(msg4SchInfo->crnti, ueId);
256 if(macCb.macCell[cellIdx] == NULLP)
258 DU_LOG("\nERROR --> MAC: Cell Id[%d] not found", cellId);
262 hqProcCb = &macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4HqInfo;
263 msg4TxPduLen = hqProcCb->tbInfo[0].tbSize - TX_PAYLOAD_HDR_LEN;
265 if(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu != NULLP)
267 MAC_ALLOC(msg4DlData.pduInfo[msg4DlData.numPdu].dlPdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
268 if(msg4DlData.pduInfo[msg4DlData.numPdu].dlPdu != NULLP)
270 fillMsg4DlData(&msg4DlData, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen, \
271 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu);
272 fillMacCe(&macCeData, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg3Pdu);
274 /* Forming Mux Pdu */
275 hqProcCb->tbInfo[0].tb = NULLP;
276 MAC_ALLOC(hqProcCb->tbInfo[0].tb, msg4TxPduLen);
277 if(hqProcCb->tbInfo[0].tb != NULLP)
279 memset(hqProcCb->tbInfo[0].tb, 0, msg4TxPduLen);
280 macMuxPdu(&msg4DlData, &macCeData, hqProcCb->tbInfo[0].tb, msg4TxPduLen);
284 DU_LOG("\nERROR --> MAC: Failed allocating memory for msg4TxPdu");
286 /* Free memory allocated */
287 MAC_FREE(msg4DlData.pduInfo[msg4DlData.numPdu-1].dlPdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
288 MAC_FREE(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu, macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
289 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu = NULLP;
290 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen = 0;
296 /* storing msg4 Pdu in macDlSlot */
297 if(hqProcCb->tbInfo[0].tb)
299 msg4SchInfo->dlMsgPduLen = msg4TxPduLen;
300 MAC_ALLOC(msg4SchInfo->dlMsgPdu, msg4SchInfo->dlMsgPduLen);
301 if(msg4SchInfo->dlMsgPdu != NULLP)
303 memcpy(msg4SchInfo->dlMsgPdu, hqProcCb->tbInfo[0].tb, \
304 msg4SchInfo->dlMsgPduLen);
309 DU_LOG("\nERROR --> MAC: Failed at fillMsg4Pdu()");
314 * @brief Builds and Send the Muxed Pdu to Lower MAC
318 * Function : buildAndSendMuxPdu
320 * Build and Sends the Muxed Pdu to Lower MAC.
322 * @param[in] SlotTimingInfo *slotInd
326 void buildAndSendMuxPdu(SlotTimingInfo currTimingInfo)
330 MacDlSlot *currDlSlot = NULLP;
331 SlotTimingInfo muxTimingInfo;
332 memset(&muxTimingInfo, 0, sizeof(SlotTimingInfo));
334 GET_CELL_IDX(currTimingInfo.cellId, cellIdx);
336 ADD_DELTA_TO_TIME(currTimingInfo, muxTimingInfo, PHY_DELTA_DL, macCb.macCell[cellIdx]->numOfSlots);
337 currDlSlot = &macCb.macCell[cellIdx]->dlSlot[muxTimingInfo.slot];
339 for(ueIdx=0; ueIdx<MAX_NUM_UE; ueIdx++)
341 if(currDlSlot->dlInfo.dlMsgAlloc[ueIdx])
343 if((macCb.macCell[cellIdx]->macRaCb[ueIdx].macMsg4Status)&& (currDlSlot->dlInfo.dlMsgAlloc[ueIdx]->dlMsgPdschCfg))
345 fillMsg4Pdu(currTimingInfo.cellId, currDlSlot->dlInfo.dlMsgAlloc[ueIdx]);
352 * @brief Transmission time interval indication from PHY.
356 * Function : sendSlotIndMacToSch
358 * This API is invoked by MAC to send slot ind to scheduler.
360 * @param[in] SlotTimingInfo *slotInd
365 int sendSlotIndMacToSch(SlotTimingInfo *slotInd)
367 /* fill Pst structure to send to lwr_mac to MAC */
370 FILL_PST_MAC_TO_SCH(pst, EVENT_SLOT_IND_TO_SCH);
371 return(SchMessageRouter(&pst, (void *)slotInd));
374 /*******************************************************************
376 * @brief Send cell up indication to DU APP
380 * Function : sendCellUpIndMacToDuApp
383 * Send cell up indication to DU APP
385 * @params[in] Cell Up indication info
386 * @return ROK - success
389 * ****************************************************************/
390 int sendCellUpIndMacToDuApp(uint16_t cellId)
394 OduCellId *oduCellId;
396 /* Allocate sharable memory */
397 MAC_ALLOC_SHRABL_BUF(oduCellId, sizeof(OduCellId));
400 DU_LOG("\nERROR --> MAC : Memory allocation failed for cell up indication");
403 oduCellId->cellId = cellId;
406 FILL_PST_MAC_TO_DUAPP(pst, EVENT_MAC_CELL_UP_IND);
408 ret = MacDuAppCellUpInd(&pst, oduCellId);
411 DU_LOG("\nERROR --> MAC: Failed to send cell up indication to DU APP");
412 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, oduCellId, sizeof(OduCellId));
416 } /* sendCellUpIndMacToDuApp */
418 /*******************************************************************
420 * @brief Send slot indication to DU APP
424 * Function : sendSlotIndToDuApp
427 * Send cell up indication to DU APP
429 * @params[in] Cell Up indication info
430 * @return ROK - success
433 * ****************************************************************/
434 uint8_t sendSlotIndToDuApp(SlotTimingInfo *slotInd)
438 SlotTimingInfo *slotIndInfo;
440 /* Allocate sharable memory */
441 MAC_ALLOC_SHRABL_BUF(slotIndInfo, sizeof(SlotTimingInfo));
444 DU_LOG("\nERROR --> MAC : Memory allocation failed for slot indication");
447 memcpy(slotIndInfo, slotInd,sizeof(SlotTimingInfo));
450 FILL_PST_MAC_TO_DUAPP(pst, EVENT_MAC_SLOT_IND);
452 ret = MacDuAppSlotInd(&pst, slotIndInfo);
455 DU_LOG("\nERROR --> MAC: Failed to send slot up indication to DU APP");
456 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, slotIndInfo, sizeof(SlotTimingInfo));
461 /*******************************************************************
463 * @brief Process slot indication at MAC
467 * Function : macProcSlotInd
469 * Functionality: Process slot indication at MAC
471 * @params[in] Slot indication info
472 * @return ROK - success
475 * ****************************************************************/
476 uint8_t macProcSlotInd(SlotTimingInfo slotInd)
478 uint16_t cellIdx = 0;
480 GET_CELL_IDX(slotInd.cellId, cellIdx);
482 if(macCb.macCell[cellIdx] == NULLP)
484 DU_LOG("ERROR --> MAC : macProcSlotInd(): CellId[%d] does not exist. Error occurred at SFN [%d] Slot [%d]",\
485 slotInd.cellId, slotInd.sfn, slotInd.slot);
488 /* Store current time info */
489 macCb.macCell[cellIdx]->currTime.cellId = slotInd.cellId;
490 macCb.macCell[cellIdx]->currTime.slot = slotInd.slot;
491 macCb.macCell[cellIdx]->currTime.sfn = slotInd.sfn;
493 /* Mux Pdu for Msg4 */
494 buildAndSendMuxPdu(slotInd);
496 /* Trigger for DL TTI REQ */
497 fillDlTtiReq(slotInd);
500 } /* macProcSlotInd */
503 * @brief Transmission time interval indication from PHY.
507 * Function : fapiMacSlotInd
509 * This API is invoked by PHY to indicate TTI indication to MAC for a cell.
511 * @param[in] Pst *pst
512 * @param[in] SuId suId
513 * @param[in] SlotTimingInfo *slotInd
518 uint8_t fapiMacSlotInd(Pst *pst, SlotTimingInfo *slotInd)
522 volatile uint32_t startTime=0;
524 #ifdef ODU_SLOT_IND_DEBUG_LOG
525 DU_LOG("\nDEBUG --> MAC : Slot Indication received. [%d : %d]", slotInd->sfn, slotInd->slot);
528 ODU_START_TASK(&startTime, PID_MAC_TTI_IND);
533 GET_CELL_IDX(slotInd->cellId, cellIdx);
534 macCb.macCell[cellIdx]->state = CELL_STATE_UP;
537 /* When testing L2 with Intel-L1, any changes specific to
538 * timer mode testing must be guarded under INTEL_TIMER_MODE*/
539 #ifndef INTEL_TIMER_MODE
540 /* send slot indication to scheduler */
541 ret = sendSlotIndMacToSch(slotInd);
544 DU_LOG("\nERROR --> MAC : Sending of slot ind msg from MAC to SCH failed");
545 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
549 ret = macProcSlotInd(*slotInd);
552 DU_LOG("\nERROR --> MAC : macProcSlotInd failed");
553 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
558 /*First Slot Ind is for CellUp. Any other Slot, will be notified to DUAPP as
562 /* send cell up indication to du app */
563 ret = sendCellUpIndMacToDuApp(slotInd->cellId);
568 /* send slot indication to du app */
569 ret = sendSlotIndToDuApp(slotInd);
574 DU_LOG("\nERROR --> MAC :Sending of slot ind msg from MAC to DU APP failed");
575 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
580 ODU_STOP_TASK(startTime, PID_MAC_TTI_IND);
581 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, slotInd, sizeof(SlotTimingInfo));
584 lwrMacCb.phySlotIndCntr++;
585 if(lwrMacCb.phySlotIndCntr > WLS_MEM_FREE_PRD)
587 lwrMacCb.phySlotIndCntr = 1;
589 freeWlsBlockList(lwrMacCb.phySlotIndCntr - 1);
593 } /* fapiMacSlotInd */
595 /**********************************************************************
597 **********************************************************************/