JIRA ID:[ODUHIGH-301]:implement Mu 1 for SSB
[o-du/l2.git] / src / 5gnrsch / sch.h
index 8bb3fa3..900a7f2 100644 (file)
 #   See the License for the specific language governing permissions and        #
 #   limitations under the License.                                             #
 ################################################################################
-*******************************************************************************/
+ *******************************************************************************/
 
 /* macros */
 #define SCH_INST_START 1
-#define SCH_MAX_CELLS 1
 #define SCH_MAX_INST 1
-#define SCH_NUM_SLOTS 10 /*forcing this to 10 */
+#define SCH_MU0_NUM_SLOTS 10 
+#define SCH_MU1_NUM_SLOTS 20 
+#define SCH_MU2_NUM_SLOTS 30 
+#define SCH_MU3_NUM_SLOTS 40 
+#define SCH_MU4_NUM_SLOTS 50 
 #define SCH_MAX_SFN 1024
 #define MAX_NUM_RB 106 /* value for numerology 0 15Khz */
 #define SCH_MIB_TRANS 80 
 #define SCH_NUM_SC_PRB 12 /* number of SCs in a PRB */
-#define SCH_MAX_SSB_BEAM 4 /* since we are supporting only SCS=15KHz */
-#define SCH_SCS_15KHZ 0 /* numerology 0 and 15Khz */
+#define SCH_MAX_SSB_BEAM 8 /* since we are supporting only SCS=15KHz and 30KHz */
 #define SCH_SYMBOL_PER_SLOT 14
-#define SCH_SSB_SYMB_DURATION 4
-#define SCH_SSB_PRB_DURATION 20
-#define SCH_MEM_REGION     4
-#define SCH_POOL           1
+#define SCH_SSB_NUM_SYMB 4
+#define SCH_SSB_NUM_PRB 20
 #define SCHED_DELTA 1
-#define RAR_DELAY   1
-#define SCH_MAX_UE  1
+#define BO_DELTA 1
+#define RAR_DELAY   2
+#define MSG4_DELAY  1
+#define PUSCH_START_RB 15
+#define PUCCH_NUM_PRB_FORMAT_0_1_4 1  /* number of PRBs in freq domain, spec 38.213 - 9.2.1 */
 #define SI_RNTI 0xFFFF
 #define P_RNTI  0xFFFE
+#define DMRS_MAP_TYPE_A 1
+#define NUM_DMRS_SYMBOLS 12
+#define DMRS_ADDITIONAL_POS 2
+#define SCH_DEFAULT_K1 1
+
+#define CRC_FAILED 0
+#define CRC_PASSED 1
+
+#define MAC_HDR_SIZE  3   /* 3 bytes of MAC Header */
+#define UL_GRANT_SIZE 224
+
+typedef struct schCellCb SchCellCb;
+typedef struct schUeCb SchUeCb;
+
+typedef enum
+{
+   SCH_NUMEROLOGY_0,
+   SCH_NUMEROLOGY_1,
+   SCH_NUMEROLOGY_2,
+   SCH_NUMEROLOGY_3,
+   SCH_NUMEROLOGY_4
+}SchNumerology;
+
+typedef enum
+{
+   SCH_UE_STATE_INACTIVE,
+   SCH_UE_STATE_ACTIVE
+}SchUeState;
+
+typedef enum
+{
+   SCH_LC_STATE_INACTIVE,
+   SCH_LC_STATE_ACTIVE
+}SchLcState;
 
-/* allocate and zero out a static buffer */
-#define SCH_ALLOC(_datPtr, _size)                                \
-{                                                               \
-   S16 _ret;                                                    \
-   _ret = SGetSBuf(SCH_MEM_REGION, SCH_POOL,                  \
-                    (Data **)&_datPtr, _size);                  \
-   if(_ret == ROK)                                              \
-      cmMemset((U8*)_datPtr, 0, _size);                         \
-   else                                                         \
-      _datPtr = NULLP;                                          \
-}
-
-/* free a static buffer */
-#define SCH_FREE(_datPtr, _size)                                 \
-   if(_datPtr)                                                  \
-      SPutSBuf(SCH_MEM_REGION, SCH_POOL,                      \
-         (Data *)_datPtr, _size);
-
-
-#define SCH_FILL_RSP_PST(_rspPst, _inst)\
-{                                  \
-   _rspPst.srcProcId = SFndProcId(); \
-   _rspPst.dstProcId = SFndProcId();\
-   _rspPst.srcEnt    = ENTRG;\
-   _rspPst.dstEnt    = ENTRG;\
-   _rspPst.srcInst   = 1;\
-   _rspPst.dstInst   = 0;\
-       _rspPst.selector  = MAC_SELECTOR_TC;\
-}      
-extern uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst);
 /**
 * @brief
 * Structure holding LTE MAC's General Configuration information.
 */
+ * @brief
+ * Structure holding LTE MAC's General Configuration information.
+ */
 typedef struct schGenCb
 {
    uint8_t         tmrRes;           /*!< Timer resolution */
    uint8_t         startCellId;      /*!< Starting Cell Id */
 #ifdef LTE_ADV
    bool            forceCntrlSrbBoOnPCel; /*!< value 1 means force scheduling
-                                               of RLC control BO and SRB BO on
-                                               PCell. val 0 means don't force*/
+                                           of RLC control BO and SRB BO on
+                                           PCell. val 0 means don't force*/
    bool            isSCellActDeactAlgoEnable; /*!< TRUE will enable activation/deactivation algo at Schd */
 #endif
 }SchGenCb;
 
 /**
 * @brief
 * scheduler allocationsfor DL per cell.
 */
-typedef struct schDlAlloc
+ * @brief
+ * scheduler allocationsfor DL per cell.
+ */
+typedef struct schDlSlotInfo
 {
-       uint16_t    totalPrb;  /*!< Number of RBs in the cell */
-       uint16_t    assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
-   bool        ssbPres;    /*!< Flag to determine if SSB is present in this slot */
-   uint8_t     ssbIdxSupported;  /*!< Max SSB index */
-       SsbInfo     ssbInfo[MAX_SSB_IDX]; /*!< SSB info */
-       bool        sib1Pres;
-       bool        rarPres;
-       RarInfo     rarInfo;
-}SchDlAlloc;
+   uint16_t  totalPrb;                          /*!< Number of RBs in the cell */
+   uint16_t  assignedPrb[SCH_SYMBOL_PER_SLOT];  /*!< Num RBs and corresponding symbols allocated */
+   bool      ssbPres;                           /*!< Flag to determine if SSB is present in this slot */
+   uint8_t   ssbIdxSupported;                   /*!< Max SSB index */
+   SsbInfo   ssbInfo[MAX_SSB_IDX];              /*!< SSB info */
+   bool      sib1Pres;                          /*!< Flag to determine if SIB1 is present in this slot */
+   RarInfo   *rarInfo;                          /*!< RAR info */
+   DlMsgInfo *dlMsgInfo;                       /*!< DL dedicated Msg info */
+}SchDlSlotInfo;
 
 typedef struct schRaCb
 {
@@ -106,42 +113,114 @@ typedef struct schRaCb
 }SchRaCb;
 
 /**
-  * @brief
-  * scheduler allocationsfor UL per cell.
-  */
-typedef struct schUlAlloc
+ * @brief
+ * scheduler allocationsfor UL per cell.
+ */
+typedef struct schUlSlotInfo
+{
+   uint16_t     totalPrb;  /*!< Number of RBs in the cell */
+   uint16_t     assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
+   uint8_t      puschCurrentPrb; /* Current PRB for PUSCH allocation */
+   bool         puschPres; /*!< PUSCH presence field */
+   SchPuschInfo *schPuschInfo; /*!< PUSCH info */
+   bool         pucchPres; /*!< PUCCH presence field */
+   SchPucchInfo schPucchInfo; /*!< PUCCH info */
+}SchUlSlotInfo;
+
+/**
+@brief
+* BSR info per slot per UE.
+*/
+typedef struct bsrInfo
+{
+   uint8_t    priority;  /* CG priority */
+   uint32_t   dataVol;   /* Data volume requested in bytes */
+}BsrInfo;
+
+typedef struct schLcCtxt
+{
+   uint8_t lcId;     // logical Channel ID
+   uint8_t lcp;      // logical Channel Prioritization
+   SchLcState lcState;
+   uint16_t bo;
+}SchDlLcCtxt;
+
+typedef struct schDlCb
+{
+   uint8_t       numDlLc;
+   SchDlLcCtxt   dlLcCtxt[MAX_NUM_LC];
+}SchDlCb;
+
+typedef struct schUlLcCtxt
+{
+   SchLcState  lcState;
+   uint8_t lcId;       
+   uint8_t priority;
+   uint8_t lcGroup;
+   uint8_t schReqId;
+   uint8_t pbr;        // prioritisedBitRate
+   uint8_t bsd;        // bucketSizeDuration
+}SchUlLcCtxt;
+
+typedef struct schUlCb
+{
+   uint8_t     numUlLc;
+   SchUlLcCtxt ulLcCtxt[MAX_NUM_LC];
+}SchUlCb;
+
+/**
+ * @brief
+ * UE control block
+ */
+typedef struct schUeCb
 {
-       uint16_t    totalPrb;  /*!< Number of RBs in the cell */
-       uint16_t    assignedPrb[SCH_SYMBOL_PER_SLOT]; /*!< Num RBs and corresponding symbols allocated */
-       uint8_t     prachStartSymb; /*!< Start symbol for PRACH */
-}SchUlAlloc;
+   uint16_t   ueIdx;
+   uint16_t   crnti;
+   SchUeCfg   ueCfg;
+   SchUeState state;
+   SchCellCb  *cellCb;
+   bool       srRcvd;
+   BsrInfo    bsrInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS];
+   SchUlCb    ulInfo;
+   SchDlCb    dlInfo;
+}SchUeCb;
 
 /**
 * @brief
 * Cell Control block per cell.
 */
+ * @brief
+ * Cell Control block per cell.
+ */
 typedef struct schCellCb
 {
-   uint16_t      cellId;           /*!< Cell ID */
-   Inst          instIdx;          /*!< Index of the scheduler instance */
-   Inst          macInst;          /*!< Index of the MAC instance */
-       uint8_t       numSlots;         /*!< Number of slots in current frame */
-   SlotIndInfo   slotInfo;         /*!< SFN, Slot info being processed*/
-   SchDlAlloc    *dlAlloc[SCH_NUM_SLOTS]; /*!< SCH resource allocations in DL */
-   SchUlAlloc    *ulAlloc[SCH_NUM_SLOTS]; /*!< SCH resource allocations in UL */
-       SchCellCfg    cellCfg;                /*!< Cell ocnfiguration */
-       SchRaCb       raCb[SCH_MAX_UE];
+   uint16_t      cellId;                            /*!< Cell ID */
+   Inst          instIdx;                           /*!< Index of the scheduler instance */
+   Inst          macInst;                           /*!< Index of the MAC instance */
+   uint8_t       numSlots;                          /*!< Number of slots in current frame */
+   SlotIndInfo   slotInfo;                          /*!< SFN, Slot info being processed*/
+   SchDlSlotInfo **schDlSlotInfo;                   /*!< SCH resource allocations in DL */
+   SchUlSlotInfo **schUlSlotInfo;                   /*!< SCH resource allocations in UL */
+   SchCellCfg    cellCfg;                           /*!< Cell ocnfiguration */
+   uint8_t       ssbStartSymbArr[SCH_MAX_SSB_BEAM]; /*!<start symbol per SSB beam */
+   SchRaCb       raCb[MAX_NUM_UE];                  /*!< Rach Cb */
+   uint16_t      numActvUe;                         /*!<Number of active UEs */
+   uint32_t      actvUeBitMap;                      /*!<Bit map to find active UEs */
+   uint32_t      boIndBitMap;                       /*!<Bit map to indicate UEs that have recevied BO */
+   SchUeCb       ueCb[MAX_NUM_UE];                  /*!<Pointer to UE contexts of this cell */
+#ifdef NR_TDD
+   uint8_t       numSlotsInPeriodicity;             /*!< number of slots in configured periodicity and SCS */
+   uint32_t      slotFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S slots. 00-D, 01-U, 10-S */
+   uint32_t      symbFrmtBitMap;                    /*!< 2 bits must be read together to determine D/U/S symbols. 00-D, 01-U, 10-S */
+#endif
 }SchCellCb;
 
 /**
 * @brief
 * Control block for sch
 */
+ * @brief
+ * Control block for sch
+ */
 typedef struct schCb
 {
    TskInit       schInit;              /*!< Task Init info */
    SchGenCb      genCfg;                 /*!< General Config info */
-   SchCellCb     *cells[SCH_MAX_CELLS];  /* Array to store cellCb ptr */  
+   SchCellCb     *cells[MAX_NUM_CELL];  /* Array to store cellCb ptr */  
 }SchCb;
 
 /* Declaration for scheduler control blocks */
@@ -151,9 +230,17 @@ SchCb schCb[SCH_MAX_INST];
 uint8_t schBroadcastAlloc(SchCellCb *cell, DlBrdcstAlloc *dlBrdcstAlloc,uint16_t slot);
 uint8_t schProcessSlotInd(SlotIndInfo *slotInd, Inst inst);
 uint8_t schUlResAlloc(SchCellCb *cell, Inst schInst);
-
-
+uint8_t schDlRsrcAllocMsg4(DlMsgAlloc *msg4Alloc, SchCellCb *cell, uint16_t slot);
+uint16_t schCalcTbSize(uint16_t payLoadSize);
+uint16_t schCalcNumPrb(uint16_t tbSize, uint16_t mcs, uint8_t numSymbols);
+uint16_t schAllocPucchResource(SchCellCb *cell, uint16_t crnti, uint16_t slot);
+uint8_t schProcessRachInd(RachIndInfo *rachInd, Inst schInst);
+uint8_t schFillUlDci(SchUeCb *ueCb, SchPuschInfo puschInfo, DciInfo *dciInfo);
+uint8_t schFillPuschAlloc(SchUeCb *ueCb, uint16_t pdcchSlot, uint32_t dataVol, SchPuschInfo *puschInfo);
+uint8_t schDlRsrcAllocDlMsg(DlMsgAlloc *dlMsgAlloc, SchCellCb *cell, uint16_t crnti,
+   uint16_t accumalatedSize, uint16_t slot);
+uint16_t schAccumalateLcBoSize(SchCellCb *cell, uint16_t ueIdx);
 
 /**********************************************************************
-         End of file
-**********************************************************************/
+  End of file
+ **********************************************************************/