13eb03bc5bb0334f0b8f8afced6725fd81c199f1
[o-du/l2.git] / src / 5gnrmac / rg.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
19 /**********************************************************************
20  
21     Name:   MAC layer
22  
23     Type:   H include file
24  
25     Desc:   Defines required by LTE-MAC
26  
27     File:   rg.h
28  
29 **********************************************************************/
30  
31 /** @file rg.h
32 @brief This file contains definitons for Mac.
33 */
34 \f
35  
36 #ifndef __RGH__
37 #define __RGH__
38
39
40
41 #ifdef L2_OPTMZ
42 #include "gen.x"           /* general layer */
43 #include "ssi.x"           /* system service interface */
44 #include "ss_strm.h"
45 #include "ss_strm.x"
46 #include "ss_queue.h"
47 #include "ss_queue.x"
48 #include "ss_task.x"
49 #include "ss_msg.x" 
50
51 #define RG_MAC_HDR_SIZE 250
52 #define RG_MAC_CE_SIZE  250
53 uint32_t MacPtrAddress;
54 uint32_t macHeader[2];
55
56 #define RG_ADD_DBuf(_dBuf,_size,_mBuf)\
57 { \
58   SsMsgInfo *mInfo = NULLP; \
59   mInfo = (SsMsgInfo *)_mBuf->b_rptr; \
60   ssGetDBufOfSize(mInfo->region,_size, &_dBuf); \
61   SUpdMsg(_mBuf, _dBuf,0);\
62   _dBuf->b_wptr = _dBuf->b_rptr =  (_dBuf->b_datap->db_base + 5);\
63   MacPtrAddress = (uint32_t)_dBuf->b_wptr;\
64 }
65 #endif
66
67
68
69 #define RGLAYERNAME     "MAC"
70 #define RG_MAX_TB_PER_UE 2
71 #define RG_MAX_BCCH_DLSCH 2
72 #define RG_INVALID_RNTI   0x0000
73
74 #define RG_MAX_NUM_DED_LC 10       /* maximum dedicated logical channels in a UE */
75 #define RG_MAX_NUM_CMN_LC 5       /* maximum number of common logical 
76                                      channels in a cell */
77 #define RG_MAX_LCG_PER_UE 4
78 #define RG_CON_RES_ID_SZ  6
79 #define RG_MAX_RA_RNTI   60
80
81 /* Added support for SPS*/
82 #ifdef LTEMAC_SPS
83 #define RG_ADDL_SPS_OCC_FOR_EXP_REL 2
84
85 #define RG_SPS_SID_PACKET_SIZE 10
86 #define RG_SPS_LCG_ID  1
87
88 #endif
89
90 /* Well known RNTIS */
91 #define RG_SI_RNTI        0xffff
92 #define RG_P_RNTI         0xfffe
93
94 #define RG_MAX_UPPERSAP               3
95 #define RG_MAX_LOWERSAP               1 
96 #define RG_TQ_SIZE                    10   /* Timing Queue Size */
97 #define RG_MAX_TIMER     RG_MAX_LOWERSAP   /* MAX number of MAC timers */
98 #define RG_NMB_CELL_HASHBIN           10   /* Number of Hash Bins for cell hash
99                                               table */
100 #define RG_NMB_UE_HASHBIN             10   /* Number of Hash Bins for UE hash
101                                               table */        
102 #define RG_BNDREQ_TMR    1    /* Bind Request timer event value */
103 #define RG_MAX_BNDRETRY  2    /* Max number of Bind Retries for TFU SAP */
104
105
106 #define RG_UE_TQ_SIZE    10   /* Timing Queue Size */
107
108 #define RG_INVALID_SCHD_TYPE 255
109 #define RG_MAX_UE_PER_CELL 0xFFFF /*!< Maximum number of UEs per cell */
110 #ifdef EIGHT_UE_PER_TTI_CHANGES
111 #define RG_MAX_UE_BIN_PER_CELL 1024 /*!< Maximum number of UE bins per cell */
112 #else
113 #define RG_MAX_UE_BIN_PER_CELL 128 /*!< Maximum number of UE bins per cell */
114 #endif
115 #define RG_MIN_DL_BW       6    /*!< Minimum Downlink bandwidth in RBs */
116 #define RG_MAX_DL_BW       110  /*!< Maximum Downlink bandwidth in RBs */
117 #define RG_MIN_UL_BW       6    /*!< Minimum Uplink bandwidth in RBs */
118 #define RG_MAX_UL_BW       110  /*!< Maximum Uplink bandwidth in RBs */
119 #define RG_MIN_CFI_VAL     1    /*!< Minimum value for CFI */
120 #define RG_MAX_CFI_VAL     3    /*!< Maximum value for CFI */
121 #define RG_QM_BPSK         2    /*!< Qm value for BPSK */
122 #define RG_QM_QPSK         4    /*!< Qm value for QPSK */
123 #define RG_QM_64QAM        6    /*!< Qm value for 64QAM */
124 #define RG_MIN_SRS_SFCFG_IDX 0  /*!< Minimum value for SRS subframe 
125                                      configurtion index */
126 #define RG_MAX_SRS_SFCFG_IDX 15  /*!< Maximum value for SRS subframe 
127                                      configurtion index */
128 #define RG_MAX_SRS_TX_OFFSET 8    /*!< Maximum number of SRS transmission 
129                                     offsets per cell */
130 #define RG_MIN_MAC_RNTI      10   /*!< Minimum value of RNTI to be managed by 
131                                     MAC */
132
133 /* HARQ related MACROs */
134 #define RG_NUM_DL_HQ_PROC 8
135 #define RG_NUM_UL_HQ_PROC 8
136 #define RG_MIN_HQ_TX 1
137
138 /* Group power related MACROs */
139 #define RG_MAX_GRP_PWR_FMT3_IDX  15   /*!< Maximum index value for group power format 3 */
140 #define RG_MAX_GRP_PWR_FMT3A_IDX 31   /*!< Maximum index value for group power format 3A */
141
142 /* MACROs to indicate cell specific config for cell to be active */
143 #define RG_BCCH_BCH_CFG_DONE      (1<<0)
144 #define RG_BCCH_DLSCH_CFG1_DONE    (1<<1)
145 #define RG_BCCH_DLSCH_CFG2_DONE    (1<<2)
146 #define RG_PCCH_CFG_DONE          (1<<3)
147 #define RG_UL_CCCH_CFG_DONE       (1<<4)
148 #define RG_DL_CCCH_CFG_DONE       (1<<5)
149 #define RG_SCHD_CFG_DONE          (1<<6)
150 #define RG_CELL_ACTIVE (RG_BCCH_BCH_CFG_DONE | RG_BCCH_DLSCH_CFG1_DONE |  RG_BCCH_DLSCH_CFG2_DONE | RG_PCCH_CFG_DONE | RG_UL_CCCH_CFG_DONE | RG_DL_CCCH_CFG_DONE)
151 /* Logical channel realated MACROs */
152 #define RG_INVALID_LCG_ID  255
153 #define RG_INVALID_LC_ID   255
154 #define RG_BCCH_BCH_IDX   0
155 #define RG_BCCH_DLSCH_IDX 1
156 #define RG_PCCH_IDX 2
157
158 /* constants for MIN & MAX qci*/
159 #define RG_QCI_MIN 1
160 #define RG_QCI_MAX 9
161
162 /* PUCCH related macros */
163 #define RG_PUCCH_MAXVAL_CS    7   /*!< Maximum value for cyclic shift of PUCCH */
164 #define RG_PUCCH_MINVAL_DS    1   /*!< Mininmum value for delta shift of PUCCH */
165 #define RG_PUCCH_MAXVAL_DS    3   /*!< Maximum value for delta shift of PUCCH */
166
167 /* DUX related macros */
168 #define RG_LCID_MASK 0x3F
169
170 #define RG_LCID_LEN 0x6
171 #define RG_CCCH_LCID 0x00
172 #define RG_DEDLC_MIN_LCID 0x01
173 #define RG_DEDLC_MAX_LCID 0x0A
174 #define RG_RES_MIN_LCID 0x0B
175 #define RG_RES_MAX_LCID 0x18
176 #define RG_EXT_PHR_LCID 0x19
177 #define RG_PHR_LCID 0x1A
178 #define RG_CRNTI_LCID 0X1B
179 #define RG_TRUNC_BSR_LCID 0X1C
180 #define RG_SHORT_BSR_LCID 0X1D
181 #define RG_LONG_BSR_LCID  0X1E
182 #define RG_PAD_LCID 0x3F
183 #define RG_MAX_EXTN_PAD_SUBHDRS 0x02
184 #define RG_REF_PCMAX  0xFF
185
186 #define RG_CCCH_SDU_PRSNT     (1<<0)
187 #define RG_CRNTI_CE_PRSNT     (1<<1)
188 #define RG_PHR_CE_PRSNT       (1<<2)
189 #define RG_TRUNC_BSR_CE_PRSNT (1<<3)
190 #define RG_SHORT_BSR_CE_PRSNT (1<<4)
191 #define RG_LONG_BSR_CE_PRSNT  (1<<5)
192 /* L2_COUNTERS */
193 #define RG_ACTIVE_LC_PRSNT  (1<<6)
194
195 #ifdef LTEMAC_SPS
196 #define RG_UL_SPS_ACT_PRSNT (1<<7)
197 #endif
198 #define RG_EXT_PHR_CE_PRSNT (1<<8)
199
200 /* LOGICAL CHANNEL */
201 #define RG_MAX_LC_PER_UE      10
202 /* Maximum number of common logical channel control blocks */
203 #define RG_MAX_CMN_LC_CB      3
204 #define RG_MAX_BCCH           2
205
206 #ifdef LTE_ADV
207 #define RG_MAX_SCELL_PER_UE   7  /*!< MAX SCell can be Added per Cell */
208 #endif /* LTE_ADV */
209
210 #define RG_OPTM_NUM_DED_LC    3
211
212 /* Random access related MACROs */
213 #define RG_MAX_RA_PREAMBLE_FMT 3 /*!< Maximun value of Random access preamble 
214                                       format */
215 #define RG_MAX_RA_WINSIZE    10  /*!< Maximum size of Random access response 
216                                       window in subframes */
217 #define RG_MIN_RA_WINSIZE    2   /*!< Minimum size of Random access response 
218                                       window in subframes */
219 #define RG_MIN_NUM_RA_PREAMBLE 4 /*!< Minimum number of Random access 
220                                       preambles */
221 #define RG_MAX_NUM_RA_PREAMBLE 64 /*!< Maximim number of Random access 
222                                       preambles */
223 #define RG_NUM_RA_RB     6
224
225 #define RG_MAX_RA_RSP_ALLOC    4 /*!< Maximum number of Random access
226                                       allocations */
227 #define RG_CRG_CFG 1          /* CRG configuration element */
228 #define RG_RGR_CFG 2          /* RGR configuration element */
229
230 #define RG_NUM_ITBS         27
231 #define RG_MAX_NUM_RB       110
232
233 #define RG_MAX_NUM_PAD_HDRS 2
234
235 /* Changes for MIMO feature addition */
236 /* Removed dependency on MIMO compile-time flag */
237 #define RG_MAX_LYR_PERCW    2
238
239 #ifdef LTE_TDD
240 #define RG_MAX_DL_HARQ_NUM   15
241 #else
242 #define RG_MAX_DL_HARQ_NUM   8 
243 #endif
244
245 /* Free shared memory, received through LWLC */
246 #define MAC_FREE_MEM(_region, _pool, _datPtr, _size)         \
247        MAC_FREE(_datPtr, _size);      \
248
249 #define RG_LCG_ISCFGD(lcg) ((lcg)->lcgId != RG_INVALID_LCG_ID)
250 /* Corrected the check for dlCcchId */
251 #define RG_DLCCCH_ISCFGD(cell) ((cell)->dlCcchId != RG_INVALID_LC_ID)
252 #define RG_ULCCCH_ISCFGD(cell) ((cell)->ulCcchId != RG_INVALID_LC_ID)
253 /* After merging from 2.1 to 2.2 */
254 #define RG_CALC_SF_DIFF(_time1, _time2)\
255    (_time1.sfn*RG_NUM_SUB_FRAMES_5G+_time1.slot) < (_time2.sfn*RG_NUM_SUB_FRAMES_5G+_time2.slot)?\
256      ((_time1.sfn+RG_MAX_SFN)*RG_NUM_SUB_FRAMES_5G+_time1.slot) -\
257        (_time2.sfn*RG_NUM_SUB_FRAMES_5G+_time2.slot) : \
258      (_time1.sfn*RG_NUM_SUB_FRAMES_5G+_time1.slot) - (_time2.sfn*RG_NUM_SUB_FRAMES_5G+_time2.slot)
259 /*LTE_L2_MEAS_PHASE2*/
260 #define RG_CALC_SFN_SF_DIFF(_time1,_sfnCycle, _time2)\
261 (((_time1.sfn+RG_MAX_SFN * _sfnCycle)*RG_NUM_SUB_FRAMES_5G) + _time1.slot -\
262 (_time2.sfn*RG_NUM_SUB_FRAMES_5G + _time2.slot))
263
264 #define RG_EXT_LCID(_lcId, _byte) {\
265       (_lcId) = (_byte) & RG_LCID_MASK; \
266 }
267 #define RG_EXT_FORMT_BIT(_fmtBit, _byte) {\
268       (_fmtBit) = ((_byte) >> RG_LCID_LEN) & 0x01; \
269 }
270
271 #define RG_EXT_EXTN_BIT(_extnBit, _byte) {\
272       (_extnBit) = ((_byte) >> RG_LCID_LEN) & 0x01; \
273 }
274
275 #ifndef MS_MBUF_CORRUPTION
276 #define MS_BUF_ADD_ALLOC_CALLER()
277 #endif
278
279 #define RG_PACK_PAD(_padBuf,_size,_sduBuf) { \
280   Buffer *sduEnd = NULLP; \
281   SsMsgInfo *mInfo = NULLP; \
282   mInfo = (SsMsgInfo *)_sduBuf->b_rptr; \
283   ssGetDBufOfSize(mInfo->region,_size, &_padBuf); \
284   if (_padBuf == NULLP) \
285   { \
286     DU_LOG("\nERROR  -->  MAC : RGERR_MUX_BLD_CEHDR_FAIL");\
287     return RFAILED;\
288   } \
289   if (mInfo->endptr == NULLP) { \
290     sduEnd = _sduBuf; \
291     }\
292   else \
293   {  \
294     sduEnd = mInfo->endptr; \
295   } \
296   sduEnd->b_cont = _padBuf; \
297   padBuf->b_wptr += _size; \
298   mInfo = (SsMsgInfo *)_sduBuf->b_rptr; \
299   mInfo->endptr = _padBuf; \
300   mInfo->len += _size; \
301 }
302
303 #define RG_PACK_SDU(_sdusBuf, _sduBuf, _ret) {\
304    _ret = SCatMsg(_sdusBuf, _sduBuf, M1M2);\
305 }
306
307 #define RG_PACK_LAST_SDU_SHDR(_subHdr, _lcId, _mBuf, _ret) {\
308    _ret = ROK;\
309    _subHdr.shLen = 1;\
310    _subHdr.shData[0] = (0x1F & _lcId);\
311    MS_BUF_ADD_ALLOC_CALLER(); \
312    _ret = SAddPstMsgMult(&_subHdr.shData[0], _subHdr.shLen, _mBuf);\
313 }
314
315 #define RGADDTOCRNTTIME(crntTime, toFill, incr)          \
316    if ((crntTime.slot + incr) > (RG_NUM_SUB_FRAMES_5G - 1))   \
317       toFill.sfn = (crntTime.sfn + 1);      \
318    else                                                  \
319       toFill.sfn = crntTime.sfn;                              \
320    toFill.slot = (crntTime.slot + incr) % RG_NUM_SUB_FRAMES_5G; \
321    if (toFill.sfn >= RG_MAX_SFN) \
322    { \
323       toFill.sfn%=RG_MAX_SFN; \
324    } \
325
326 #define RGSUBFRMCRNTTIME(crntTime, toFill, dcr)    \
327 {                                                  \
328    if (crntTime.sfn == 0)                          \
329 {                                                  \
330    if ((crntTime.slot - (dcr)) < 0)              \
331    {                                               \
332       toFill.sfn = RG_MAX_SFN - 1;                 \
333    }                                               \
334    else                                            \
335    {                                               \
336    toFill.sfn = crntTime.sfn;                      \
337    }                                               \
338 }                                                  \
339 else                                               \
340 {                                                  \
341    if ((crntTime.slot - (dcr)) < 0)              \
342    {                                               \
343    toFill.sfn = crntTime.sfn - 1;                  \
344    }                                               \
345    else                                            \
346    toFill.sfn = crntTime.sfn;                      \
347 }                                                  \
348 toFill.slot = (RG_NUM_SUB_FRAMES_5G + crntTime.slot - (dcr)) % (RG_NUM_SUB_FRAMES_5G);                                   \
349 }
350
351 #define RGCPYTIMEINFO(src, dst)  \
352    dst.sfn    = src.sfn;     \
353    dst.slot   = src.slot;
354 #define RG_TIMEINFO_SAME(x, y) ((x.sfn == y.sfn) && (x.slot == y.slot))
355
356
357 #define rgPBuf(_inst)  rgCb[_inst].rgInit.prntBuf
358
359 /* Debug Prints for MAC */
360 #ifdef DEBUGP
361 #define RGDBGERRNEW(_inst,_args)          \
362                   DBGP(&rgCb[_inst].rgInit, RGLAYERNAME, DBGMASK_ERR, _args)
363 #define RGDBGINFONEW(_inst,_args)         \
364                   DBGP(&rgCb[_inst].rgInit, RGLAYERNAME, DBGMASK_INFO, _args)
365 #else
366 #define RGDBGERRNEW(_inst,_args) 
367 #define RGDBGINFONEW(_inst,_args)
368 #endif /* #ifdef DEBUGP */
369 #define RGDBGPRM(_inst,_args) 
370 #define RGDBGERR(_inst,_args) 
371 #define RGDBGINFO(_inst,_args)
372
373 #ifdef ERRCLS_KW
374 #define RG_NULL_CHECK(_inst, _ptr )     \
375    if((_ptr) == NULLP)  \
376    {                                               \
377       DU_LOG("\nERROR  -->  MAC : Null Pointer detected");\
378       SExit();\
379    }
380 #define RG_ARRAY_BOUND_CHECK(_inst, _array, _idxVal)     \
381    if((_idxVal) >= (sizeof(_array)/sizeof(_array[0]))) \
382    {                                               \
383       DU_LOG("\nERROR  -->  MAC : Array Bound Check Failed");\
384       SExit();\
385    }
386 #else
387 #define RG_NULL_CHECK(_inst, _ptr )     
388 #define RG_ARRAY_BOUND_CHECK(_inst, _array, _idxVal)     
389 #endif
390
391 /* Macro to free the message buffer and initialize it to zero */
392 /***********************************************************
393  *
394  *     Name : RG_FREE_MSG
395  *
396  *     Desc : Macro to free the message buffer and initialize it to zero
397  *            
398  *     Input  : mBuf - message buffer pointer to be retunrned
399  *
400  *     Output : None.
401  *
402  *     Notes: None
403  *
404  **********************************************************/
405 #define RG_FREE_MSG(_buf)\
406 {\
407    if (NULLP != (_buf)) \
408    { \
409       SPutMsg((_buf)); \
410       _buf = NULLP; \
411    } \
412 }
413
414 #define RG_FREE_MEM(_mem)\
415 {\
416    if (NULLP != (_mem)) \
417    { \
418       cmFreeMem((_mem)); \
419       _mem = NULLP; \
420    } \
421 }
422
423 #ifdef L2_OPTMZ
424 #define RG_FREE_TB(_tb)\
425 {\
426    uint32_t lchIdx, pduIdx;\
427    SResetMBuf(_tb->macHdr);\
428    SResetMBuf(_tb->macCes);\
429    _tb->tbPres = FALSE;\
430    _tb->tbSize = 0;\
431    _tb->padSize = 0;\
432    for(lchIdx = 0; lchIdx < _tb->numLch; lchIdx++) \
433    {\
434       for(pduIdx = 0; pduIdx < _tb->lchInfo[lchIdx].numPdu; pduIdx++)\
435       {\
436           if(_tb->lchInfo[lchIdx].mBuf[pduIdx] != NULL)\
437           {\
438             SPutMsg(_tb->lchInfo[lchIdx].mBuf[pduIdx]);\
439             _tb->lchInfo[lchIdx].freeBuff = FALSE;\
440           }\
441           _tb->lchInfo[lchIdx].mBuf[pduIdx] = NULL;\
442       }\
443       _tb->lchInfo[lchIdx].numPdu = 0;\
444    }\
445    _tb->numLch = 0;\
446 }
447
448 #define RG_FREE_SAVED_TB(_tb)\
449 {\
450    uint32_t lchIdx, pduIdx;\
451    RG_FREE_MSG(_tb->macHdr);\
452    RG_FREE_MSG(_tb->macCes);\
453    _tb->tbPres = FALSE;\
454    _tb->tbSize = 0;\
455    _tb->padSize = 0;\
456    for(lchIdx = 0; lchIdx < 10; lchIdx++) \
457    {\
458       for(pduIdx = 0; pduIdx < 4; pduIdx++)\
459       {\
460           if(_tb->lchInfo[lchIdx].freeBuff == TRUE)\
461           {\
462             SPutMsg(_tb->lchInfo[lchIdx].mBuf[pduIdx]);\
463             _tb->lchInfo[lchIdx].freeBuff = FALSE;\
464           }\
465           _tb->lchInfo[lchIdx].mBuf[pduIdx] = NULL;\
466       }\
467       _tb->lchInfo[lchIdx].numPdu = 0;\
468    }\
469    _tb->numLch = 0;\
470 }
471
472 #endif
473
474 /***********************************************************
475  *
476  *     Name : RG_DROP_RGUDDATREQ_MBUF
477  *
478  *     Desc : Macro to free the message buffers and initialize them to zero
479  *            
480  *     Input  : _datreq - Dedicated Data Request pointer which has mBufs
481  *              to be freed
482  *     
483  *     Output : None.
484  *
485  *     Notes: None
486  *
487  **********************************************************/
488 #define RG_DROP_RGUDDATREQ_MBUF(_datReq)\
489 {\
490    uint32_t idx5,idx6,idx7;\
491    for (idx5=0; idx5 < _datReq.nmbOfTbs; idx5++)\
492    {\
493       for (idx6=0; idx6 < _datReq.datReqTb[idx5].nmbLch; idx6++)\
494       {\
495          for (idx7=0; \
496                idx7 < _datReq.datReqTb[idx5].lchData[idx6].pdu.numPdu; \
497                idx7++)\
498          {\
499             RG_FREE_MSG(_datReq.datReqTb[idx5].\
500                   lchData[idx6].pdu.mBuf[idx7]);\
501          }\
502       }\
503    }\
504 }
505
506 /***********************************************************
507  *
508  *     Name : RG_DROP_RGUCDATREQ_MBUF
509  *
510  *     Desc : Macro to free the message buffers and initialize them to zero
511  *            
512  *     Input  : _datreq - Common Data Request pointer which has mBufs
513  *              to be freed
514  *     
515  *     Output : None.
516  *
517  *     Notes: None
518  *
519  **********************************************************/
520 #define RG_DROP_RGUCDATREQ_MBUF(_datReq)\
521 {\
522    if (_datReq != NULLP)\
523    {\
524       RG_FREE_MSG(_datReq->pdu);\
525    }\
526 }
527
528 /* RRM_SP1_START */
529 #define RG_UPD_GBR_PRB(_cellCb, _qci, _prbUsed) {\
530    if(_qci <= RG_MAX_QCI_REPORTS)\
531    {\
532       _cellCb->qcisUlPrbCnt[_qci-1] += _prbUsed;\
533    }\
534 }
535 /* RRM_SP1_END */
536
537 /* Macros for memory region and pool determination */
538 #define RG_GET_MEM_REGION(rgCb)  (rgCb.rgInit.region)
539 #define RG_GET_MEM_POOL(rgCb)    (rgCb.rgInit.pool)
540
541
542 /* MUX related macros */
543 #define RG_RAR_SHDR_LEN                1
544 #define RG_RAR_ELEM_LEN                6
545 #define RG_MAX_SDU_SUB_HDR_LEN         3
546 #define RG_MAX_PAD_ARR_SZ              4096 /* Changing from 400 to 4096 */
547 #define RG_PAD_BYTE                    0x00
548
549 #define RG_HDR_TYPE_CRES                1
550 #define RG_HDR_TYPE_TA                  2
551 #ifdef LTE_ADV
552 #define RG_HDR_TYPE_SCELL_ACT           3
553 #endif
554
555 #define RG_SDU_SHDR_LEN 1
556 #define RG_FIXDSZ_CE_SHDR_LEN 1
557 #define RG_PAD_SHDR_LEN 1
558 #define RG_CRES_LEN    6
559 #define RG_TA_LEN      1
560 #ifdef LTE_ADV
561 #define RG_SCELL_ACT_CE_LEN 1
562 #define RG_SCELL_CE_ELM_LEN (RG_FIXDSZ_CE_SHDR_LEN+RG_SCELL_ACT_CE_LEN)
563 #endif
564 #define RG_CRES_ELM_LEN (RG_FIXDSZ_CE_SHDR_LEN+RG_CRES_LEN)
565 #define RG_TA_ELM_LEN   (RG_FIXDSZ_CE_SHDR_LEN+RG_TA_LEN)
566
567
568 /* Values of below macros not yet defined in 5G-NR hence using LTE values till
569  * They are defined
570  */
571 #define RG_CRES_LCID_IDX               0x1C
572 #define RG_TA_LCID_IDX                 0x1D
573 #ifdef LTE_ADV
574 #define RG_SCELL_LCID_IDX              0x1B
575 #endif
576 #define RG_PAD_LCID_IDX               0x3F
577
578 /* Structure member offset computation macro    */
579 #define OffsetOf(type, field)                                                 \
580          (PTR) (&(((type *) NULLP)->field))
581
582 #define RG_MAX_SUBFRAMES_IN_SFN        9
583 #define RG_MAX_SFN                     1024
584 #ifdef RGAC_5GTF
585 #define RG_NUM_SUB_FRAMES              50
586 #else
587 #define RG_NUM_SUB_FRAMES              10
588 #endif
589 #define RG_NUM_SUB_FRAMES_5G           50
590 /* RRM_SP1_START */
591 #define RG_MAX_QCI_REPORTS         4
592 /* RRM_SP1_END */
593
594 #ifdef LTE_L2_MEAS
595 #define RG_NUM_UL_SUB_FRAMES              16
596 #define RG_MAX_QCI_VALUE                  10
597
598 #ifdef EIGHT_UE_PER_TTI_CHANGES 
599 /* Tuned according to TDD Cfg Mode2 and 2UE/TTI.
600  *  * Need to tune if NumUE/TTI is increased */
601 #define RG_MAX_DFRD_FREE_BUFS             64 /* 64 - 8UE/TTI */
602 #define RG_MAX_FREE_BUFS_PERTTI           16 /* 16 - 8UE/TTI */
603 #endif
604
605 #define RG_CALC_SF_DIFF(_time1, _time2)\
606       (_time1.sfn*RG_NUM_SUB_FRAMES_5G+_time1.slot) < (_time2.sfn*RG_NUM_SUB_FRAMES_5G+_time2.slot)?\
607      ((_time1.sfn+RG_MAX_SFN)*RG_NUM_SUB_FRAMES_5G+_time1.slot) -\
608        (_time2.sfn*RG_NUM_SUB_FRAMES_5G+_time2.slot) : \
609      (_time1.sfn*RG_NUM_SUB_FRAMES_5G+_time1.slot) - (_time2.sfn*RG_NUM_SUB_FRAMES_5G+_time2.slot)
610
611 #define RG_TTI_CYCLE_INVLD                0xFFFFFFFF     
612 #define RG_CALC_TTI_CNT(_cellCb, _ttiCnt)\
613      _ttiCnt = (RG_NUM_SUB_FRAMES_5G * (_cellCb->crntTime.sfn + (_cellCb->ttiCycle * 1024)) )+\
614                _cellCb->crntTime.slot;
615 #endif /* LTE_L2_MEAS */
616
617 /* Tuned according to TDD Cfg Mode2 and 2UE/TTI.
618  * Need to tune if NumUE/TTI is increased */
619 #define RG_MAX_DFRD_FREE_BUFS             32 /* 16- 2 UE per TTI 32 - 4UE/TTI */
620 #define RG_MAX_FREE_BUFS_PERTTI           8 /* 4 - 2 Ue per TTI, 8 - 4UE/TTI */
621
622
623 /* Define for the block size for memory allocation */
624 /* RG_BLKSZ changed from 2048 to 1500*/
625 #define RG_BLKSZ                       1500
626
627 /* Defines for RGU Statistics types */
628 #define RG_RGU_SDU_DROP 1
629 #define RG_RGU_SDU_RCVD 2
630
631 /* MACROS for General Statistics */
632 #define RG_CFG_ADD      1
633 #define RG_CFG_DEL      2
634
635 #define RG_HQ_FDB_IND_CB_TYPE_HQ_ENT      1
636 #define RG_HQ_FDB_IND_CB_TYPE_RA_CB       2
637
638 /* MACRO for validating the mac instance id */
639 #define RG_IS_INST_VALID(_inst)\
640 {\
641    if(_inst >= RG_MAX_INST)\
642    {\
643       return RFAILED;\
644    }\
645 }
646
647 /* 
648  * Removed unused hash-define which defines the
649  * index for releasing the subframe.
650  */
651
652 /* Value used to set nDmrs in uplink grant if nDmrs is not applicable */
653 #define RG_INVALID_NDMRS  10
654
655 /* Note: Any changes to these enums should reflect to */
656 /** @details Enums for special argument
657  *
658 */
659 typedef enum
660 {
661    RG_DIAG_NA
662 } RgDiagSplArg;
663  
664 #ifdef SS_DIAG 
665 #define RG_DIAG_LVL0(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)                        \
666 {                                                                                                \
667    if(rgCb[_inst].rgInit.logMask & SS_DIAG_LVL0)                                                         \
668    {                                                                                             \
669       ssDiagFix(_tknId, _splArgEnum, ENTMAC, rgCb[_inst].rgInit.inst, SS_DIAG_LVL0, SS_DIAG_MSG_TYPE_FIXED, _splArg, _arg1, _arg2, _arg3, _arg4, _string);\
670    }                                                                                             \
671 }
672
673 /** @details Macro definition for LTE-MAC error logs
674  *  
675 */
676 #define RG_DIAG_LVL1(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)            \
677 {                                                                 \
678    if(rgCb[_inst].rgInit.logMask & SS_DIAG_LVL1)                             \
679    {                                                              \
680       ssDiagFix(_tknId, _splArgEnum, ENTMAC, rgCb[_inst].rgInit.inst, SS_DIAG_LVL1, SS_DIAG_MSG_TYPE_FIXED, _splArg, _arg1, _arg2, _arg3, _arg4, _string);\
681    }                                                              \
682 }
683
684 /** @details Macro definition for LTE-MAC critical logs
685  *  
686 */
687 #define RG_DIAG_LVL2(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)       \
688 {                                                              \
689    if(rgCb[_inst].rgInit.logMask & SS_DIAG_LVL2)                            \
690    {                                                              \
691       ssDiagFix(_tknId, _splArgEnum, ENTMAC, rgCb[_inst].rgInit.inst, SS_DIAG_LVL2, SS_DIAG_MSG_TYPE_FIXED, _splArg, _arg1, _arg2, _arg3, _arg4, _string);\
692    }                                                              \
693 }
694
695 /** @details Macro definition for LTE-MAC logs 
696  *  
697 */
698 #define RG_DIAG_LVL3(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)        \
699 {                                                              \
700    if(rgCb[_inst].rgInit.logMask & SS_DIAG_LVL3)                            \
701    {                                                              \
702       ssDiagFix(_tknId, _splArgEnum, ENTMAC, rgCb[_inst].rgInit.inst, SS_DIAG_LVL3, SS_DIAG_MSG_TYPE_FIXED, _splArg, _arg1, _arg2, _arg3, _arg4, _string);\
703    }                                                              \
704 }
705
706 /** @details Macro definition for LTE-MAC logs
707  *  
708 */
709 #define RG_DIAG_LVL4(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)        \
710 {                                                              \
711    if(rgCb[_inst].rgInit.logMask & SS_DIAG_LVL4)                            \
712    {                                                              \
713       ssDiagFix(_tknId, _splArgEnum, ENTMAC, rgCb[_inst].rgInit.inst, SS_DIAG_LVL4, SS_DIAG_MSG_TYPE_FIXED, _splArg, _arg1, _arg2, _arg3, _arg4, _string);\
714    }                                                              \
715 }
716   
717 #else
718
719 #define RG_DIAG_LVL0(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)                        \
720 {                                                                                                \
721 }
722
723 /** @details Macro definition for LTE-MAC error logs
724  *  
725 */
726 #define RG_DIAG_LVL1(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)            \
727 {                                                                 \
728 }
729
730 /** @details Macro definition for LTE-MAC critical logs
731  *  
732 */
733 #define RG_DIAG_LVL2(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)       \
734 {                                                              \
735 }
736
737 /** @details Macro definition for LTE-MAC logs 
738  *  
739 */
740 #define RG_DIAG_LVL3(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)        \
741 {                                                              \
742 }
743
744 /** @details Macro definition for LTE-MAC logs
745  *  
746 */
747 #define RG_DIAG_LVL4(_inst,_tknId, _splArgEnum, _splArg, _string, _arg1, _arg2, _arg3, _arg4)        \
748 {                                                              \
749 }
750 #endif
751 #endif /* __RGH__ */
752 \f
753 /**********************************************************************
754          End of file
755 **********************************************************************/