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;
147 DU_LOG("\nMAC : Received CRC indication");
149 GET_CELL_IDX(crcInd->cellId, cellIdx);
150 /* Considering one pdu and one preamble */
151 crcIndInfo.cellId = macCb.macCell[cellIdx]->cellId;;
152 crcIndInfo.crnti = crcInd->crcInfo[0].rnti;
153 crcIndInfo.timingInfo.sfn = crcInd->timingInfo.sfn;
154 crcIndInfo.timingInfo.slot = crcInd->timingInfo.slot;
155 crcIndInfo.numCrcInd = crcInd->crcInfo[0].numCb;
156 crcIndInfo.crcInd[0] = crcInd->crcInfo[0].cbCrcStatus[0];
158 return(sendCrcIndMacToSch(&crcIndInfo));
161 /*******************************************************************
163 * @brief Process Rx Data Ind at MAC
167 * Function : fapiMacRxDataInd
170 * Process Rx Data Ind at MAC
172 * @params[in] Post structure
174 * @return ROK - success
177 * ****************************************************************/
178 uint8_t fapiMacRxDataInd(Pst *pst, RxDataInd *rxDataInd)
182 DU_LOG("\nMAC : Received Rx Data indication");
184 /* TODO : compare the handle received in RxDataInd with handle send in PUSCH
185 * PDU, which is stored in raCb */
187 for(pduIdx = 0; pduIdx < rxDataInd->numPdus; pduIdx++)
189 unpackRxData(rxDataInd->cellId, rxDataInd->timingInfo, &rxDataInd->pdus[pduIdx]);
194 /*******************************************************************
196 * @brief Processes DL data from RLC
200 * Function : MacProcRlcDlData
203 * Processes DL data from RLC
205 * @params[in] Post structure
207 * @return ROK - success
210 * ****************************************************************/
211 uint8_t MacProcRlcDlData(Pst* pstInfo, RlcData *dlData)
217 MacDlSlot *currDlSlot = NULLP;
219 DU_LOG("\nMAC: Received DL data for sfn=%d slot=%d", \
220 dlData->slotInfo.sfn, dlData->slotInfo.slot);
222 /* Copy the pdus to be muxed into mac Dl data */
223 macDlData.numPdu = dlData->numPdu;
224 for(pduIdx = 0; pduIdx < dlData->numPdu; pduIdx++)
226 macDlData.pduInfo[pduIdx].lcId = dlData->pduInfo[pduIdx].lcId;
227 macDlData.pduInfo[pduIdx].pduLen = dlData->pduInfo[pduIdx].pduLen;
228 macDlData.pduInfo[pduIdx].dlPdu = dlData->pduInfo[pduIdx].pduBuf;
231 /* Store DL data in the scheduled slot */
232 currDlSlot = &macCb.macCell[dlData->cellId -1]->dlSlot[dlData->slotInfo.slot];
235 if(currDlSlot->dlInfo.dlMsgAlloc)
237 tbSize = currDlSlot->dlInfo.dlMsgAlloc->dlMsgPdschCfg.codeword[0].tbSize;
238 MAC_ALLOC(txPdu, tbSize);
241 DU_LOG("\nMAC : Memory allocation failed in MacProcRlcDlData");
244 macMuxPdu(&macDlData, NULLP, txPdu, tbSize);
246 currDlSlot->dlInfo.dlMsgAlloc->dlMsgInfo.dlMsgPduLen = tbSize;
247 currDlSlot->dlInfo.dlMsgAlloc->dlMsgInfo.dlMsgPdu = txPdu;
252 for(pduIdx = 0; pduIdx < dlData->numPdu; pduIdx++)
254 MAC_FREE_SHRABL_BUF(pstInfo->region, pstInfo->pool, dlData->pduInfo[pduIdx].pduBuf,\
255 dlData->pduInfo[pduIdx].pduLen);
257 if(pstInfo->selector == ODU_SELECTOR_LWLC)
259 MAC_FREE_SHRABL_BUF(pstInfo->region, pstInfo->pool, dlData, sizeof(RlcData));
265 /*******************************************************************
267 * @brief Builds and Sends UL Data to RLC
271 * Function : macProcUlData
273 * Functionality: Builds and Sends UL Data to RLC
278 * LC Id on which payload was received
279 * Pointer to the payload
281 * @return ROK - success
284 * ****************************************************************/
285 uint8_t macProcUlData(uint16_t cellId, uint16_t rnti, SlotIndInfo slotInfo, \
286 uint8_t lcId, uint16_t pduLen, uint8_t *pdu)
291 /* Filling RLC Ul Data*/
292 MAC_ALLOC_SHRABL_BUF(ulData, sizeof(RlcData));
295 DU_LOG("\nMAC : Memory allocation failed while sending UL data to RLC");
298 memset(ulData, 0, sizeof(RlcData));
299 ulData->cellId = cellId;
301 memcpy(&ulData->slotInfo, &slotInfo, sizeof(SlotIndInfo));
302 ulData->slotInfo.cellId = cellId;
304 /* Filling pdu info */
305 if(lcId == SRB1_LCID || lcId == SRB2_LCID)
307 ulData->pduInfo[ulData->numPdu].commCh = true;
309 ulData->pduInfo[ulData->numPdu].lcId = lcId;
310 ulData->pduInfo[ulData->numPdu].pduBuf = pdu;
311 ulData->pduInfo[ulData->numPdu].pduLen = pduLen;
314 /* Filling Post and send to RLC */
315 memset(&pst, 0, sizeof(Pst));
316 FILL_PST_MAC_TO_RLC(pst, 0, EVENT_UL_DATA_TO_RLC);
317 MacSendUlDataToRlc(&pst, ulData);
323 /*******************************************************************
325 * @brief Processes BO status from RLC
329 * Function : MacProcRlcBOStatus
332 * Processes BO status from RLC
334 * @params[in] Post structure
336 * @return ROK - success
339 * ****************************************************************/
340 uint8_t MacProcRlcBoStatus(Pst* pst, RlcBoStatus* boStatus)
342 DlRlcBoInfo dlBoInfo;
344 dlBoInfo.cellId = boStatus->cellId;
345 GET_CRNTI(dlBoInfo.crnti, boStatus->ueIdx);
346 dlBoInfo.lcId = boStatus->lcId;
347 dlBoInfo.dataVolume = boStatus->bo;
349 sendDlRlcBoInfoToSch(&dlBoInfo);
351 if(pst->selector == ODU_SELECTOR_LWLC)
353 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, boStatus, sizeof(RlcBoStatus));
359 /*******************************************************************
361 * @brief Send LC schedule result report to RLC
365 * Function : sendSchRptToRlc
367 * Functionality: Send LC schedule result report to RLC
370 * @return ROK - success
373 * ****************************************************************/
374 uint8_t sendSchedRptToRlc(DlSchedInfo dlInfo, SlotIndInfo slotInfo)
378 RlcSchedResultRpt *schedRpt = NULLP;
380 MAC_ALLOC_SHRABL_BUF(schedRpt, sizeof(RlcSchedResultRpt));
383 DU_LOG("\nMAC: Memory allocation failure in sendSchResultRepToRlc");
386 DU_LOG("\nMAC: Send scheduled result report for sfn %d slot %d", slotInfo.sfn, slotInfo.slot);
388 schedRpt->cellId = dlInfo.cellId;
389 schedRpt->rnti = dlInfo.dlMsgAlloc->crnti;
390 schedRpt->numLc = dlInfo.dlMsgAlloc->numLc;
391 schedRpt->slotInfo.sfn = slotInfo.sfn;
392 schedRpt->slotInfo.slot = slotInfo.slot;
394 for(lcIdx = 0; lcIdx < schedRpt->numLc; lcIdx++)
396 schedRpt->lcSch[lcIdx].lcId = dlInfo.dlMsgAlloc->lcSchInfo[lcIdx].lcId;
397 schedRpt->lcSch[lcIdx].bufSize = dlInfo.dlMsgAlloc->lcSchInfo[lcIdx].schBytes;
398 schedRpt->lcSch[lcIdx].commCh = false;
402 FILL_PST_MAC_TO_RLC(pst, RLC_DL_INST, EVENT_SCHED_RESULT_TO_RLC);
403 if(MacSendSchedResultRptToRlc(&pst, schedRpt) != ROK)
405 DU_LOG("\nMAC: Failed to send Schedule result report to RLC");
406 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, schedRpt, sizeof(RlcSchedResultRpt));
413 /*******************************************************************
415 * @brief Handles cell start reuqest from DU APP
419 * Function : MacProcCellStartReq
422 * Handles cell start reuqest from DU APP
424 * @params[in] Post structure pointer
425 * Cell Start Request info pointer
426 * @return ROK - success
429 * ****************************************************************/
430 uint8_t MacProcCellStartReq(Pst *pst, MacCellStartInfo *cellStartInfo)
432 DU_LOG("\nMAC : Handling cell start request");
433 sendToLowerMac(START_REQUEST, 0, cellStartInfo);
435 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, cellStartInfo, \
436 sizeof(MacCellStartInfo));
441 /*******************************************************************
443 * @brief Handles cell stop request from DU APP
447 * Function : MacProcCellStartReq
450 * Handles cell stop request from DU APP
452 * @params[in] Post structure pointer
453 * Mac Cell stop information
454 * @return ROK - success
457 * ****************************************************************/
458 uint8_t MacProcCellStopReq(Pst *pst, MacCellStopInfo *cellStopInfo)
461 DU_LOG("\nMAC : Sending cell stop request to Lower Mac");
462 sendToLowerMac(FAPI_STOP_REQUEST, 0, cellStopInfo);
465 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, cellStopInfo, \
466 sizeof(MacCellStopInfo));
471 /*******************************************************************
473 * @brief Handles DL CCCH Ind from DU APP
477 * Function : MacProcDlCcchInd
480 * Handles DL CCCH Ind from DU APP
482 * @params[in] Post structure pointer
483 * DL CCCH Ind pointer
484 * @return ROK - success
487 * ****************************************************************/
488 uint8_t MacProcDlCcchInd(Pst *pst, DlCcchIndInfo *dlCcchIndInfo)
493 DlRlcBoInfo dlBoInfo;
494 memset(&dlBoInfo, 0, sizeof(DlRlcBoInfo));
496 DU_LOG("\nMAC : Handling DL CCCH IND");
498 GET_CELL_IDX(dlCcchIndInfo->cellId, cellIdx);
500 dlBoInfo.cellId = dlCcchIndInfo->cellId;
501 dlBoInfo.crnti = dlCcchIndInfo->crnti;
503 if(dlCcchIndInfo->msgType == RRC_SETUP)
505 dlBoInfo.lcId = SRB0_LCID; // SRB ID 0 for msg4
506 dlBoInfo.dataVolume = dlCcchIndInfo->dlCcchMsgLen;
508 /* storing Msg4 Pdu in raCb */
509 GET_UE_IDX(dlBoInfo.crnti, ueIdx);
511 if(macCb.macCell[cellIdx]->macRaCb[ueIdx].crnti == dlCcchIndInfo->crnti)
513 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen = dlCcchIndInfo->dlCcchMsgLen;
514 MAC_ALLOC(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu, \
515 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4PduLen);
516 if(macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu)
518 for(idx = 0; idx < dlCcchIndInfo->dlCcchMsgLen; idx++)
520 macCb.macCell[cellIdx]->macRaCb[ueIdx].msg4Pdu[idx] =\
521 dlCcchIndInfo->dlCcchMsg[idx];
526 sendDlRlcBoInfoToSch(&dlBoInfo);
528 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, dlCcchIndInfo->dlCcchMsg, \
529 dlCcchIndInfo->dlCcchMsgLen);
530 MAC_FREE_SHRABL_BUF(pst->region, pst->pool, dlCcchIndInfo, sizeof(DlCcchIndInfo));
535 /*******************************************************************
537 * @brief Sends UL CCCH Ind to DU APP
541 * Function : macProcUlCcchInd
544 * MAC sends UL CCCH Ind to DU APP
546 * @params[in] Post structure pointer
548 * @return ROK - success
551 * ****************************************************************/
552 uint8_t macProcUlCcchInd(uint16_t cellId, uint16_t crnti, uint16_t rrcContSize, uint8_t *rrcContainer)
556 UlCcchIndInfo *ulCcchIndInfo = NULLP;
558 MAC_ALLOC_SHRABL_BUF(ulCcchIndInfo, sizeof(UlCcchIndInfo));
561 DU_LOG("\nMAC: Memory failed in macProcUlCcchInd");
565 ulCcchIndInfo->cellId = cellId;
566 ulCcchIndInfo->crnti = crnti;
567 ulCcchIndInfo->ulCcchMsgLen = rrcContSize;
568 ulCcchIndInfo->ulCcchMsg = rrcContainer;
571 FILL_PST_MAC_TO_DUAPP(pst, EVENT_MAC_UL_CCCH_IND);
573 if(MacDuAppUlCcchInd(&pst, ulCcchIndInfo) != ROK)
575 DU_LOG("\nMAC: Failed to send UL CCCH Ind to DU APP");
576 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, ulCcchIndInfo->ulCcchMsg, ulCcchIndInfo->ulCcchMsgLen);
577 MAC_FREE_SHRABL_BUF(MAC_MEM_REGION, MAC_POOL, ulCcchIndInfo, sizeof(UlCcchIndInfo));
583 /*******************************************************************
585 * @brief Processes received short BSR
589 * Function : macProcShortBsr
592 * MAC sends Short BSR to SCH
594 * @params[in] cell ID
600 * ****************************************************************/
601 uint8_t macProcShortBsr(uint16_t cellId, uint16_t crnti, uint8_t lcgId, uint32_t bufferSize)
604 UlBufferStatusRptInd bsrInd;
606 memset(&pst, 0, sizeof(Pst));
607 memset(&bsrInd, 0, sizeof(UlBufferStatusRptInd));
609 bsrInd.cellId = cellId;
610 bsrInd.crnti = crnti;
611 bsrInd.bsrType = SHORT_BSR;
612 bsrInd.numLcg = 1; /* short bsr reports one lcg at a time */
613 bsrInd.dataVolInfo[0].lcgId = lcgId;
614 bsrInd.dataVolInfo[0].dataVol = bufferSize;
616 FILL_PST_MAC_TO_SCH(pst, EVENT_SHORT_BSR);
617 return(*macSchBsrOpts[pst.selector])(&pst, &bsrInd);
620 /*******************************************************************
622 * @brief Builds and send SR UCI Indication to SCH
626 * Function : buildAndSendSrInd
629 * Builds and send SR UCI Indication to SCH
631 * @params[in] SrUciIndInfo Pointer
633 * @return ROK - success
636 * ****************************************************************/
637 uint8_t buildAndSendSrInd(UciInd *macUciInd, uint8_t crnti)
641 SrUciIndInfo srUciInd;
642 memset(&pst, 0, sizeof(Pst));
643 memset(&srUciInd, 0, sizeof(SrUciIndInfo));
645 GET_CELL_IDX(macUciInd->cellId, cellIdx);
646 srUciInd.cellId = macCb.macCell[cellIdx]->cellId;;
647 srUciInd.crnti = crnti;
648 srUciInd.slotInd.sfn = macUciInd->slotInd.sfn;
649 srUciInd.slotInd.slot = macUciInd->slotInd.slot;
650 srUciInd.numSrBits++;
651 memset(srUciInd.srPayload, 0, MAX_SR_BITS_IN_BYTES);
654 FILL_PST_MAC_TO_SCH(pst, EVENT_UCI_IND_TO_SCH);
656 return(*macSchSrUciIndOpts[pst.selector])(&pst, &srUciInd);
659 /*******************************************************************
661 * @brief Processes UCI Indication from PHY
665 * Function : fapiMacUciInd
668 * Processes UCI Indication from PHY
670 * @params[in] Post Structure Pointer
671 * UCI Indication Pointer
672 * @return ROK - success
675 * ****************************************************************/
676 uint8_t FapiMacUciInd(Pst *pst, UciInd *macUciInd)
685 nPdus = macUciInd->numUcis;
688 switch(macUciInd->pdus[pduIdx].pduType)
692 case UCI_IND_PUCCH_F0F1:
693 if(macUciInd->pdus[pduIdx].uci.uciPucchF0F1.srInfo.srIndPres)
695 DU_LOG("\nMAC : Received SR UCI indication");
696 crnti = macUciInd->pdus[pduIdx].uci.uciPucchF0F1.crnti;
697 ret = buildAndSendSrInd(macUciInd, crnti);
700 case UCI_IND_PUCCH_F2F3F4:
703 DU_LOG("\nMAC: Invalid Pdu Type %d at FapiMacUciInd", macUciInd->pdus[pduIdx].pduType);
713 DU_LOG("\nMAC: Received Uci Ind is NULL at FapiMacUciInd()");
720 /**********************************************************************
722 **********************************************************************/