Cell down alarm notification [Issue-Id: ODUHIGH-430]
[o-du/l2.git] / src / 5gnrmac / mac.h
1 /*******************************************************************************
2 ################################################################################
3 #   Copyright (c) [2017-2019] [Radisys]                                        #
4 #                                                                              #
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                                    #
8 #                                                                              #
9 #       http://www.apache.org/licenses/LICENSE-2.0                             #
10 #                                                                              #
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 #ifndef _MAC_H_
19 #define _MAC_H_
20
21 /* MAX values */
22 #define MAX_MAC_CE 6
23 #define MAX_CRI_SIZE 6
24 #define MAX_MAC_DL_PDU 16
25 #define MAX_NUM_HARQ_PROC  16
26 #define MAX_ZERO_CORR_CFG_IDX 16 /* max zero correlation config index */
27 #define MAC_TQ_SIZE    10        /* Timing Queue Size */
28 #define MAX_NUM_TIMER  1         /* MAX number of MAC timers */
29
30 #define DEFAULT_CELLS 1
31 #define SI_RNTI 0xFFFF
32 #define P_RNTI 0xFFFE
33
34 #define MAC_LCID_CCCH              0
35 #define MAC_LCID_MIN               1
36 #define MAC_LCID_MAX               32
37 #define MAC_LCID_RESERVED_MIN      33
38 #define MAC_LCID_RESERVED_MAX      51
39 #define MAC_LCID_CCCH_48BIT        52
40 #define MAC_LCID_BIT_RATE_QUERY    53
41 #define MAC_LCID_MULT_PHR_FOUR_OCT 54
42 #define MAC_LCID_CFG_GRANT_CFM     55
43 #define MAC_LCID_MULT_PHR_ONE_OCT  56
44 #define MAC_LCID_SINGLE_PHR        57
45 #define MAC_LCID_CRNTI             58
46 #define MAC_LCID_SHORT_TRUNC_BSR   59
47 #define MAC_LCID_LONG_TRUNC_BSR    60
48 #define MAC_LCID_SHORT_BSR         61
49 #define MAC_LCID_LONG_BSR          62
50 #define MAC_LCID_CRI               62
51 #define MAC_LCID_PADDING           63
52
53 /* Definitions for size of RAR PDU contents (in bits).
54  * Refer spec 38.321, sections 6.1.4, 6.2.2 and 6.2.3*/
55 #define E_BIT_SIZE 1
56 #define T_BIT_SIZE 1
57 #define R_BIT_SIZE 1
58 #define RAPID_SIZE 6
59 #define LC_ID_SIZE 6
60 #define TIMING_ADVANCE_SIZE 12
61 #define T_CRNTI_SIZE 16
62 /*  UL Grant is of size = 27 bits. Refer to Spec 38.213, Table 8.2-1 for
63  *  contents of UL grant in RAR */
64 #define FREQ_HOP_FLAG_SIZE 1
65 #define FREQ_RSRC_ALLOC_SIZE 14
66 #define TIME_RSRC_ALLOC_SIZE 4
67 #define MCS_SIZE 4
68 #define TPC_COMMAND_SIZE 3
69 #define CSI_REQUEST_SIZE 1
70
71 typedef struct macCellCb MacCellCb;
72
73 typedef enum
74 {
75    CELL_STATE_UP,
76    CELL_TO_BE_STOPPED,
77    CELL_STOP_IN_PROGRESS,
78 }CellState;        
79
80 typedef enum
81 {
82    UE_STATE_INACTIVE,
83    UE_STATE_ACTIVE,
84    UE_HANDIN_IN_PROGRESS
85 }UeState;
86
87 typedef enum
88 {
89    MAC_LC_STATE_INACTIVE,
90    MAC_LC_STATE_ACTIVE
91 }MacLcState;
92
93 typedef struct macDlSlot
94 {
95    DlSchedInfo dlInfo;
96 }MacDlSlot;
97
98 typedef struct macUlSlot
99 {
100    UlSchedInfo  ulInfo;
101 }MacUlSlot;
102
103 typedef struct macCbInfo
104 {
105    uint16_t    cellId;
106    uint16_t    crnti;
107    uint8_t     msg3Pdu[6];  /* used as CRI value during muxing */
108    uint8_t     *msg4Pdu;    /* storing DL-CCCH Ind Pdu */
109    uint16_t    msg4PduLen;  /* storing DL-CCCH Ind Pdu Len */
110    uint8_t     *msg4TxPdu;  /* muxed Pdu used for re-transmission */
111    uint16_t    msg4TbSize;  /* size required for msg4TxPdu */
112 }MacRaCbInfo;
113
114 typedef struct macCe
115 {
116    uint16_t macCeLcid;
117    uint8_t  macCeValue[6];
118 }MacCe;
119
120 typedef struct macCeInfo
121 {
122    uint16_t numCes;
123    MacCe macCe[MAX_MAC_CE];
124 }MacCeInfo;
125
126 typedef struct macDlInfo
127 {
128    uint16_t  lcId;
129    uint16_t  pduLen;
130    uint8_t  *dlPdu;
131 }MacDlInfo;
132
133 typedef struct macDlData
134 {
135    uint8_t  ueId;
136    uint16_t numPdu;
137    MacDlInfo  pduInfo[MAX_MAC_DL_PDU];
138 }MacDlData;
139
140 /* HARQ Process Info */
141 typedef struct dlHarqProcCb
142 {
143    uint8_t   procId;    /* HARQ Process Id */
144 }DlHarqProcCb;
145
146 /* DL HARQ entity */
147 typedef struct dlHarqEnt
148 {
149    uint8_t        maxReTx;            /* MAX HARQ retransmission */
150    uint8_t        numHarqProcs;       /* Number of HARQ procs */
151    DlHarqProcCb   harqProcCb[MAX_NUM_HARQ_PROC];
152 }DlHarqEnt;
153
154 /* Uplink deidcated logical channel info */
155 typedef struct ulLcCb
156 {
157    uint8_t    lcId;         /* Logical Channel Id */
158    uint8_t    lcGrpId;      /* Logical Channel group */
159    MacLcState lcActive;     /* Is LC active ? */
160    /*Commenting as S-NSSAI and PDU session will be used in future scope*/
161    /*For eg: When we have to send these for AMBR cases*/
162    #if 0
163    uint16_t   pduSessionId; /*Pdu Session Id*/
164    Snssai     *snssai;      /*S-NSSAI assoc with LCID*/
165    #endif
166 }UlLcCb;
167
168 /* Downlink dedicated logical channel info */
169 typedef struct dlLcCb
170 {
171    uint8_t    lcId;        /* Logical channel Id */ 
172    MacLcState lcState;     /* Is LC active ? */
173    /*Commenting as S-NSSAI and PDU session will be used in future scope*/
174    /*For eg: When we have to send these info via FAPI to phy layer*/
175    #if 0
176    uint16_t   pduSessionId;/*Pdu Session Id*/
177    Snssai     *snssai;    /*S-NSSAI assoc with LCID*/
178    #endif
179 }DlLcCb;
180
181 /* BSR Information */
182 typedef struct macBsrTmrCfg
183 {
184    uint16_t   periodicTimer;
185    uint16_t   retxTimer;
186    uint16_t   srDelayTimer;
187 }MacBsrTmrCfg;
188
189 /* UE specific UL info */
190 typedef struct ueUlCb
191 {
192    uint8_t    maxReTx;     /* MAX HARQ retransmission */
193    uint8_t    numUlLc;     /* Number of uplink logical channels */       
194    UlLcCb     lcCb[MAX_NUM_LC];    /* Uplink dedicated logocal channels */
195 }UeUlCb;
196
197 /* UE specific DL Info */
198 typedef struct ueDlCb
199 {
200    DlHarqEnt  dlHarqEnt;      /* DL HARQ entity */
201    uint8_t    numDlLc;        /* Number of downlink logical channels */
202    DlLcCb     lcCb[MAX_NUM_LC];  /* Downlink dedicated logical channels */
203 }UeDlCb;
204
205 /* UE Cb */
206 typedef struct macUeCb
207 {
208    uint16_t     ueId;     /* UE Id from DU APP */
209    uint16_t     crnti;    /* UE CRNTI */
210    MacCellCb    *cellCb;  /* Pointer to cellCb to whihc this UE belongs */
211    UeState      state;    /* Is UE active ? */
212    MacRaCbInfo  *raCb;    /* RA info */
213    MacBsrTmrCfg bsrTmrCfg;  /* BSR Timer Info */
214    UeUlCb       ulInfo;   /* UE specific UL info */
215    UeDlCb       dlInfo;   /* UE specific DL info */
216    DataTransmissionAction transmissionAction;
217 }MacUeCb;
218
219 struct macCellCb
220 {
221    uint16_t    cellId;
222    CellState   state;
223    uint8_t     crntiMap;
224    MacRaCbInfo macRaCb[MAX_NUM_UE];
225    MacDlSlot   dlSlot[MAX_SLOTS];
226    MacUlSlot   ulSlot[MAX_SLOTS];
227    uint16_t    numActvUe;
228    MacUeCfg    *ueCfgTmpData[MAX_NUM_UE];
229    MacUeCb     ueCb[MAX_NUM_UE];
230    MacCellCfg  macCellCfg;
231    SlotTimingInfo currTime;
232 };
233
234 typedef struct macCb
235 {
236    Inst        macInst;
237    ProcId      procId;
238    uint8_t     tmrRes;                    /*!< Timer resolution */
239    CmTqCp      tmrTqCp;                   /*!< Timer Task Queue Cntrl Point */
240    CmTqType    tmrTq[MAC_TQ_SIZE];        /*!< Timer Task Queue */
241    CmTimer     tmrBlk[MAX_NUM_TIMER];     /*!< Timer Block */
242    MacCellCb   *macCell[MAX_NUM_CELL];
243 }MacCb;
244
245 /* global variable */
246 MacCb macCb;
247
248 /* Function declarations */
249 short int macActvTmr(Ent ent,Inst inst);
250 void fillRarPdu(RarInfo *rarInfo);
251 void createMacRaCb(RachIndInfo *rachIndInfo);
252 void fillMsg4DlData(MacDlData *dlData, uint16_t msg4PduLen, uint8_t *msg4Pdu);
253 void fillMacCe(MacCeInfo  *macCeData, uint8_t *msg3Pdu);
254 void macMuxPdu(MacDlData *dlData, MacCeInfo *macCeData, uint8_t *msg4TxPdu, uint16_t tbSize);
255 uint8_t unpackRxData(uint16_t cellId, SlotTimingInfo slotInfo, RxDataIndPdu *rxDataIndPdu);
256 void fillMg4Pdu(DlMsgAlloc *msg4Alloc);
257 void buildAndSendMuxPdu(SlotTimingInfo currTimingInfo);
258 uint8_t macProcUlCcchInd(uint16_t cellId, uint16_t crnti, uint16_t rrcContSize, uint8_t *rrcContainer);
259 uint8_t macProcShortBsr(uint16_t cellId, uint16_t crnti, uint8_t lcgId, uint32_t bufferSize);
260 uint8_t macProcUlData(uint16_t cellId, uint16_t rnti, SlotTimingInfo slotInfo, \
261    uint8_t lcId, uint16_t pduLen, uint8_t *pdu);
262 uint8_t sendSchedRptToRlc(DlSchedInfo dlInfo, SlotTimingInfo slotInfo, uint8_t ueIdx, uint8_t schInfoIdx);
263 uint8_t macProcLongBsr(uint16_t cellId, uint16_t crnti,uint8_t numLcg,\
264                          DataVolInfo dataVolInfo[MAX_NUM_LOGICAL_CHANNEL_GROUPS]);
265 void freeMacSliceCfgReq(MacSliceCfgReq *cfgReq,Pst *pst);
266 #endif
267 /**********************************************************************
268   End of file
269  **********************************************************************/