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 *******************************************************************************/
19 /* header include files -- defines (.h) */
20 #include "common_def.h"
23 #include "du_app_mac_inf.h"
24 #include "mac_sch_interface.h"
25 #include "rlc_mac_inf.h"
26 #include "mac_upr_inf_api.h"
29 #include "fapi_interface.h"
31 #include "lwr_mac_fsm.h"
32 #include "lwr_mac_upr_inf.h"
34 #include "mac_utils.h"
36 /* This file contains message handling functionality for MAC */
40 uint16_t buildMacPdu(RlcData *dlData);
42 void macStubBuildUlData(Buffer *mBuf);
45 /* Function pointer for sending crc ind from MAC to SCH */
46 MacSchCrcIndFunc macSchCrcIndOpts[]=
53 /* Function pointer for sending DL RLC BO Info from MAC to SCH */
54 MacSchDlRlcBoInfoFunc macSchDlRlcBoInfoOpts[]=
56 packMacSchDlRlcBoInfo,
61 /* Function pointer for sending short BSR from MAC to SCH */
62 MacSchBsrFunc macSchBsrOpts[]=
69 /* Function pointer for sending SR Uci ind from MAC to SCH */
70 MacSchSrUciIndFunc macSchSrUciIndOpts[]=
77 /*******************************************************************
79 * @brief Sends DL BO Info to SCH
83 * Function : sendDlRlcBoInfoToSch
86 * Sends DL BO Info to SCH
89 * @return ROK - success
92 ****************************************************************/
93 uint8_t sendDlRlcBoInfoToSch(DlRlcBoInfo *dlBoInfo)
97 FILL_PST_MAC_TO_SCH(pst, EVENT_DL_RLC_BO_INFO_TO_SCH);
98 return(*macSchDlRlcBoInfoOpts[pst.selector])(&pst, dlBoInfo);
101 /*******************************************************************
103 * @brief Sends CRC Indication to SCH
107 * Function : sendCrcIndMacToSch
110 * Sends CRC Indication to SCH
113 * @return ROK - success
116 ****************************************************************/
117 uint8_t sendCrcIndMacToSch(CrcIndInfo *crcInd)
121 FILL_PST_MAC_TO_SCH(pst, EVENT_CRC_IND_TO_SCH);
122 return(*macSchCrcIndOpts[pst.selector])(&pst, crcInd);
125 /*******************************************************************
127 * @brief Processes CRC Indication from PHY
131 * Function : fapiMacCrcInd
134 * Processes CRC Indication from PHY
136 * @params[in] Post Structure Pointer
137 * Crc Indication Pointer
138 * @return ROK - success
141 * ****************************************************************/
142 uint8_t fapiMacCrcInd(Pst *pst, CrcInd *crcInd)
145 CrcIndInfo crcIndInfo;
146 DU_LOG("\nMAC : Received CRC indication");
147 GET_CELL_IDX(crcInd->cellId, cellIdx);
148 /* Considering one pdu and one preamble */
149 crcIndInfo.cellId = macCb.macCell[cellIdx]->cellId;;
150 crcIndInfo.crnti = crcInd->crcInfo[0].rnti;
151 crcIndInfo.timingInfo.sfn = crcInd->timingInfo.sfn;
152 crcIndInfo.timingInfo.slot = crcInd->timingInfo.slot;
153 crcIndInfo.numCrcInd = crcInd->crcInfo[0].numCb;
154 crcIndInfo.crcInd[0] = crcInd->crcInfo[0].cbCrcStatus[0];
156 return(sendCrcIndMacToSch(&crcIndInfo));
159 /*******************************************************************
161 * @brief Process Rx Data Ind at MAC
165 * Function : fapiMacRxDataInd
168 * Process Rx Data Ind at MAC
170 * @params[in] Post structure
172 * @return ROK - success
175 * ****************************************************************/
176 uint8_t fapiMacRxDataInd(Pst *pst, RxDataInd *rxDataInd)
179 DU_LOG("\nMAC : Received Rx Data indication");
180 /* TODO : compare the handle received in RxDataInd with handle send in PUSCH
181 * PDU, which is stored in raCb */
183 for(pduIdx = 0; pduIdx < rxDataInd->numPdus; pduIdx++)
185 unpackRxData(rxDataInd->cellId, rxDataInd->timingInfo, &rxDataInd->pdus[pduIdx]);
190 /*******************************************************************
192 * @brief Processes DL data from RLC
196 * Function : MacProcRlcDlData
199 * Processes DL data from RLC
201 * @params[in] Post structure
203 * @return ROK - success
206 * ****************************************************************/
207 uint8_t MacProcRlcDlData(Pst* pstInfo, RlcData *dlData)
213 MacDlSlot *currDlSlot = NULLP;
215 DU_LOG("\nMAC: Received DL data for sfn=%d slot=%d", \
216 dlData->slotInfo.sfn, dlData->slotInfo.slot);
217 /* Copy the pdus to be muxed into mac Dl data */
218 macDlData.numPdu = dlData->numPdu;
219 for(pduIdx = 0; pduIdx < dlData->numPdu; pduIdx++)
221 macDlData.pduInfo[pduIdx].lcId = dlData->pduInfo[pduIdx].lcId;
222 macDlData.pduInfo[pduIdx].pduLen = dlData->pduInfo[pduIdx].pduLen;
223 macDlData.pduInfo[pduIdx].dlPdu = dlData->pduInfo[pduIdx].pduBuf;
226 /* Store DL data in the scheduled slot */
227 currDlSlot = &macCb.macCell[dlData->cellId -1]->dlSlot[dlData->slotInfo.slot];
230 if(currDlSlot->dlInfo.dlMsgAlloc)
232 tbSize = currDlSlot->dlInfo.dlMsgAlloc->dlMsgPdschCfg.codeword[0].tbSize;
233 MAC_ALLOC(txPdu, tbSize);
236 DU_LOG("\nMAC : Memory allocation failed in MacProcRlcDlData");
239 macMuxPdu(&macDlData, NULLP, txPdu, tbSize);
241 currDlSlot->dlInfo.dlMsgAlloc->dlMsgInfo.dlMsgPduLen = tbSize;
242 currDlSlot->dlInfo.dlMsgAlloc->dlMsgInfo.dlMsgPdu = txPdu;
247 for(pduIdx = 0; pduIdx < dlData->numPdu; pduIdx++)
249 MAC_FREE_SHRABL_BUF(pstInfo->region, pstInfo->pool, dlData->pduInfo[pduIdx].pduBuf,\
250 dlData->pduInfo[pduIdx].pduLen);
252 if(pstInfo->selector == ODU_SELECTOR_LWLC)
254 MAC_FREE_SHRABL_BUF(pstInfo->region, pstInfo->pool, dlData, sizeof(RlcData));
260 /*******************************************************************
262 * @brief Builds and Sends UL Data to RLC
266 * Function : macProcUlData
268 * Functionality: Builds and Sends UL Data to RLC
273 * LC Id on which payload was received
274 * Pointer to the payload
276 * @return ROK - success
279 * ****************************************************************/
280 uint8_t macProcUlData(uint16_t cellId, uint16_t rnti, SlotIndInfo slotInfo, \
281 uint8_t lcId, uint16_t pduLen, uint8_t *pdu)
286 /* Filling RLC Ul Data*/
287 MAC_ALLOC_SHRABL_BUF(ulData, sizeof(RlcData));
290 DU_LOG("\nMAC : Memory allocation failed while sending UL data to RLC");
293 memset(ulData, 0, sizeof(RlcData));
294 ulData->cellId = cellId;
296 memcpy(&ulData->slotInfo, &slotInfo, sizeof(SlotIndInfo));
297 ulData->slotInfo.cellId = cellId;
299 /* Filling pdu info */
300 if(lcId == SRB1_LCID || lcId == SRB2_LCID)
302 ulData->pduInfo[ulData->numPdu].commCh = true;
304 ulData->pduInfo[ulData->numPdu].lcId = lcId;
305 ulData->pduInfo[ulData->numPdu].pduBuf = pdu;
306 ulData->pduInfo[ulData->numPdu].pduLen = pduLen;
309 /* Filling Post and send to RLC */
310 memset(&pst, 0, sizeof(Pst));
311 FILL_PST_MAC_TO_RLC(pst, 0, EVENT_UL_DATA_TO_RLC);
312 MacSendUlDataToRlc(&pst, ulData);
318 /*******************************************************************
320 * @brief Processes BO status from RLC
324 * Function : MacProcRlcBOStatus
327 * Processes BO status from RLC
329 * @params[in] Post structure
331 * @return ROK - success
334 * ****************************************************************/
335 uint8_t MacProcRlcBoStatus(Pst* pst, RlcBoStatus* boStatus)
337 DlRlcBoInfo dlBoInfo;
339 dlBoInfo.cellId = boStatus->cellId;
340 GET_CRNTI(dlBoInfo.crnti, boStatus->ueIdx);
341 dlBoInfo.lcId = boStatus->lcId;
342 dlBoInfo.dataVolume = boStatus->bo;
344 sendDlRlcBoInfoToSch(&dlBoInfo);
346 if(pst->selector == ODU_SELECTOR_LWLC)
348 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, boStatus, sizeof(RlcBoStatus));
354 /*******************************************************************
356 * @brief Send LC schedule result report to RLC
360 * Function : sendSchRptToRlc
362 * Functionality: Send LC schedule result report to RLC
365 * @return ROK - success
368 * ****************************************************************/
369 uint8_t sendSchedRptToRlc(DlSchedInfo dlInfo, SlotIndInfo slotInfo)
373 RlcSchedResultRpt *schedRpt = NULLP;
375 MAC_ALLOC_SHRABL_BUF(schedRpt, sizeof(RlcSchedResultRpt));
378 DU_LOG("\nMAC: Memory allocation failure in sendSchResultRepToRlc");
382 DU_LOG("\nMAC: Send scheduled result report for sfn %d slot %d", slotInfo.sfn, slotInfo.slot);
383 schedRpt->cellId = dlInfo.cellId;
384 schedRpt->rnti = dlInfo.dlMsgAlloc->crnti;
385 schedRpt->numLc = dlInfo.dlMsgAlloc->numLc;
386 schedRpt->slotInfo.sfn = slotInfo.sfn;
387 schedRpt->slotInfo.slot = slotInfo.slot;
389 for(lcIdx = 0; lcIdx < schedRpt->numLc; lcIdx++)
391 schedRpt->lcSch[lcIdx].lcId = dlInfo.dlMsgAlloc->lcSchInfo[lcIdx].lcId;
392 schedRpt->lcSch[lcIdx].bufSize = dlInfo.dlMsgAlloc->lcSchInfo[lcIdx].schBytes;
393 schedRpt->lcSch[lcIdx].commCh = false;
397 FILL_PST_MAC_TO_RLC(pst, RLC_DL_INST, EVENT_SCHED_RESULT_TO_RLC);
398 if(MacSendSchedResultRptToRlc(&pst, schedRpt) != ROK)
400 DU_LOG("\nMAC: Failed to send Schedule result report to RLC");
401 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, schedRpt, sizeof(RlcSchedResultRpt));
408 /*******************************************************************
410 * @brief Handles cell start reuqest from DU APP
414 * Function : MacProcCellStartReq
417 * Handles cell start reuqest from DU APP
419 * @params[in] Post structure pointer
420 * Cell Start Request info pointer
421 * @return ROK - success
424 * ****************************************************************/
425 uint8_t MacProcCellStartReq(Pst *pst, MacCellStartInfo *cellStartInfo)
427 DU_LOG("\nMAC : Handling cell start request");
428 sendToLowerMac(START_REQUEST, 0, cellStartInfo);
430 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, cellStartInfo, \
431 sizeof(MacCellStartInfo));
436 /*******************************************************************
438 * @brief Handles cell stop request from DU APP
442 * Function : MacProcCellStartReq
445 * Handles cell stop request from DU APP
447 * @params[in] Post structure pointer
448 * Mac Cell stop information
449 * @return ROK - success
452 * ****************************************************************/
453 uint8_t MacProcCellStopReq(Pst *pst, MacCellStopInfo *cellStopInfo)
456 DU_LOG("\nMAC : Sending cell stop request to Lower Mac");
457 sendToLowerMac(FAPI_STOP_REQUEST, 0, cellStopInfo);
460 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, cellStopInfo, \
461 sizeof(MacCellStopInfo));
466 /*******************************************************************
468 * @brief Handles DL CCCH Ind from DU APP
472 * Function : MacProcDlCcchInd
475 * Handles DL CCCH Ind from DU APP
477 * @params[in] Post structure pointer
478 * DL CCCH Ind pointer
479 * @return ROK - success
482 * ****************************************************************/
483 uint8_t MacProcDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo)
488 DlRlcBoInfo dlBoInfo;
489 memset(&dlBoInfo, 0, sizeof(DlRlcBoInfo));
491 DU_LOG("\nMAC : Handling DL CCCH IND");
493 GET_CELL_IDX(dlCcchIndInfo->cellId, cellIdx);
495 dlBoInfo.cellId = dlCcchIndInfo->cellId;
496 dlBoInfo.crnti = dlCcchIndInfo->crnti;
498 if(dlCcchIndInfo->msgType == RRC_SETUP)
500 dlBoInfo.lcId = SRB0_LCID; // SRB ID 0 for msg4
501 dlBoInfo.dataVolume = dlCcchIndInfo->dlCcchMsgLen;
503 /* storing Msg4 Pdu in raCb */
504 GET_UE_IDX(dlBoInfo.crnti, ueIdx);
506 if(macCb.macCell[cellIdx]->macRaCb[ueIdx].crnti == dlCcchIndInfo->crnti)
508 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen = dlCcchIndInfo->dlCcchMsgLen;
509 MAC_ALLOC(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu, \
510 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
511 if(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu)
513 for(idx = 0; idx < dlCcchIndInfo->dlCcchMsgLen; idx++)
515 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu[idx] =\
516 dlCcchIndInfo->dlCcchMsg[idx];
521 sendDlRlcBoInfoToSch(&dlBoInfo);
523 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, dlCcchIndInfo->dlCcchMsg, \
524 dlCcchIndInfo->dlCcchMsgLen);
525 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, dlCcchIndInfo, sizeof(DlCcchIndInfo));
530 /*******************************************************************
532 * @brief Sends UL CCCH Ind to DU APP
536 * Function : macProcUlCcchInd
539 * MAC sends UL CCCH Ind to DU APP
541 * @params[in] Post structure pointer
543 * @return ROK - success
546 * ****************************************************************/
547 uint8_t macProcUlCcchInd(uint16_t cellId, uint16_t crnti, uint16_t rrcContSize, uint8_t *rrcContainer)
551 UlCcchIndInfo *ulCcchIndInfo = NULLP;
553 MAC_ALLOC_SHRABL_BUF(ulCcchIndInfo, sizeof(UlCcchIndInfo));
556 DU_LOG("\nMAC: Memory failed in macProcUlCcchInd");
560 ulCcchIndInfo->cellId = cellId;
561 ulCcchIndInfo->crnti = crnti;
562 ulCcchIndInfo->ulCcchMsgLen = rrcContSize;
563 ulCcchIndInfo->ulCcchMsg = rrcContainer;
566 FILL_PST_MAC_TO_DUAPP(pst, EVENT_MAC_UL_CCCH_IND);
568 if(MacDuAppUlCcchInd(&pst, ulCcchIndInfo) != ROK)
570 DU_LOG("\nMAC: Failed to send UL CCCH Ind to DU APP");
571 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, ulCcchIndInfo->ulCcchMsg, ulCcchIndInfo->ulCcchMsgLen);
572 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, ulCcchIndInfo, sizeof(UlCcchIndInfo));
578 /*******************************************************************
580 * @brief Processes received short BSR
584 * Function : macProcShortBsr
587 * MAC sends Short BSR to SCH
589 * @params[in] cell ID
595 * ****************************************************************/
596 uint8_t macProcShortBsr(uint16_t cellId, uint16_t crnti, uint8_t lcgId, uint32_t bufferSize)
599 UlBufferStatusRptInd bsrInd;
601 memset(&pst, 0, sizeof(Pst));
602 memset(&bsrInd, 0, sizeof(UlBufferStatusRptInd));
604 bsrInd.cellId = cellId;
605 bsrInd.crnti = crnti;
606 bsrInd.bsrType = SHORT_BSR;
607 bsrInd.numLcg = 1; /* short bsr reports one lcg at a time */
608 bsrInd.dataVolInfo[0].lcgId = lcgId;
609 bsrInd.dataVolInfo[0].dataVol = bufferSize;
611 FILL_PST_MAC_TO_SCH(pst, EVENT_SHORT_BSR);
612 return(*macSchBsrOpts[pst.selector])(&pst, &bsrInd);
615 /*******************************************************************
617 * @brief Builds and send SR UCI Indication to SCH
621 * Function : buildAndSendSrInd
624 * Builds and send SR UCI Indication to SCH
626 * @params[in] SrUciIndInfo Pointer
628 * @return ROK - success
631 * ****************************************************************/
632 uint8_t buildAndSendSrInd(UciInd *macUciInd, uint8_t crnti)
636 SrUciIndInfo srUciInd;
637 memset(&pst, 0, sizeof(Pst));
638 memset(&srUciInd, 0, sizeof(SrUciIndInfo));
640 GET_CELL_IDX(macUciInd->cellId, cellIdx);
641 srUciInd.cellId = macCb.macCell[cellIdx]->cellId;;
642 srUciInd.crnti = crnti;
643 srUciInd.slotInd.sfn = macUciInd->slotInd.sfn;
644 srUciInd.slotInd.slot = macUciInd->slotInd.slot;
645 srUciInd.numSrBits++;
646 memset(srUciInd.srPayload, 0, MAX_SR_BITS_IN_BYTES);
649 FILL_PST_MAC_TO_SCH(pst, EVENT_UCI_IND_TO_SCH);
651 return(*macSchSrUciIndOpts[pst.selector])(&pst, &srUciInd);
654 /*******************************************************************
656 * @brief Processes UCI Indication from PHY
660 * Function : fapiMacUciInd
663 * Processes UCI Indication from PHY
665 * @params[in] Post Structure Pointer
666 * UCI Indication Pointer
667 * @return ROK - success
670 * ****************************************************************/
671 uint8_t FapiMacUciInd(Pst *pst, UciInd *macUciInd)
680 nPdus = macUciInd->numUcis;
683 switch(macUciInd->pdus[pduIdx].pduType)
687 case UCI_IND_PUCCH_F0F1:
688 if(macUciInd->pdus[pduIdx].uci.uciPucchF0F1.srInfo.srIndPres)
690 DU_LOG("\nMAC : Received SR UCI indication");
691 crnti = macUciInd->pdus[pduIdx].uci.uciPucchF0F1.crnti;
692 ret = buildAndSendSrInd(macUciInd, crnti);
695 case UCI_IND_PUCCH_F2F3F4:
698 DU_LOG("\nMAC: Invalid Pdu Type %d at FapiMacUciInd", macUciInd->pdus[pduIdx].pduType);
708 DU_LOG("\nMAC: Received Uci Ind is NULL at FapiMacUciInd()");
715 /**********************************************************************
717 **********************************************************************/