[Epic-ID: ODUHIGH-406][Task-ID: ODUHIGH-422]F1AP Paging Message Handling at DUAPP
[o-du/l2.git] / src / du_app / du_utils.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 /* Utility definitions to be used in du app */
20
21 /* Memory related configs */
22 #define DU_APP_MEM_REGION    0
23 #define RLC_UL_MEM_REGION    1
24 #define RLC_DL_MEM_REGION    4
25 #define MAC_MEM_REGION       4
26
27 #define DU_POOL  1
28 #define RLC_POOL  1
29 #define MAC_POOL 1
30 #define MAX_SLIV_CONFIG_IDX 105
31
32 /* Events */
33 #define EVTCFG 0
34 #define EVTSCTPSTRT  1
35 #define EVENT_CU_DATA  2
36 #define EVENT_SCTP_NTFY  3
37 #define EVTSRVOPENREQ  4
38 #define EVTSRVOPENCFM  5
39 #define EVTTNLMGMTREQ  6
40 #define EVTTNLMGMTCFM  7
41 #define EVTSLOTIND    8
42 #define EVTSTARTPOLL  9
43 #define EVENT_RIC_DATA  10
44
45 /* allocate and zero out a static buffer */
46
47 #ifdef ODU_MEMORY_DEBUG_LOG
48 #define DU_MEM_LOG(_macro, _file, _line, _func, _size, _datPtr)\
49 {\
50    printf("\n%s=== %s +%d, %s, %d, %p\n",           \
51          _macro, _file, _line, _func, _size, _datPtr); \
52 }
53 #else
54 #define DU_MEM_LOG(_macro, _file, _line, _func, _size, _dataPtr) {}
55 #endif
56
57 #define DU_ALLOC(_datPtr, _size)                                \
58 {                                                               \
59    int _ret;                                                    \
60    _ret = SGetSBuf(DU_APP_MEM_REGION, DU_POOL,                  \
61                     (Data **)&_datPtr, _size);                  \
62    if(_ret == ROK)     \
63    {\
64       DU_MEM_LOG("DU_ALLOC", __FILE__, __LINE__, __FUNCTION__, _size, _datPtr);\
65       memset(_datPtr, 0, _size);                         \
66    }\
67    else                                                         \
68       _datPtr = NULLP;                                          \
69 }
70
71 /* free a static buffer */
72 #define DU_FREE(_datPtr, _size)                                 \
73 {                                                               \
74    if(_datPtr != NULLP)                                                  \
75    {                                                            \
76       DU_MEM_LOG("DU_FREE", __FILE__, __LINE__, __FUNCTION__, _size, _datPtr);\
77       SPutSBuf(DU_APP_MEM_REGION, DU_POOL,                      \
78          (Data *)_datPtr, _size);                               \
79       _datPtr = NULLP;                                          \
80    }                                                            \
81 }
82 /* Allocate shared memory to be used for LWLC
83  * during inter-layer communication */
84 #define DU_ALLOC_SHRABL_BUF(_buf, _size)                     \
85 {                                                            \
86    if(SGetStaticBuffer(DU_APP_MEM_REGION, DU_POOL,           \
87       (Data **)&_buf, (Size) _size, 0) == ROK)               \
88    {                                                         \
89       DU_MEM_LOG("DU_ALLOC_SHRABL_BUF", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
90       memset((_buf), 0, _size);                      \
91    }                                                         \
92    else                                                      \
93    {                                                         \
94       (_buf) = NULLP;                                        \
95    }                                                         \
96 }
97
98 /* Free shared memory, received through LWLC */
99 #define DU_FREE_SHRABL_BUF(_region, _pool,_buf, _size)          \
100 {                                                               \
101    if (_buf != NULLP)                                           \
102    {                                                            \
103       DU_MEM_LOG("DU_FREE_SHRABL_BUF", __FILE__, __LINE__, __FUNCTION__, _size, _buf);\
104       (Void) SPutStaticBuffer(_region, _pool,                   \
105            (Data *) _buf, (Size) _size, 0);                     \
106        _buf = NULLP;                                            \
107    }                                                            \
108 }
109
110 /* Fill Pst structure for sending msg from DU APP to MAC */
111 #define FILL_PST_DUAPP_TO_MAC(_pst, _event)                 \
112 {                                                           \
113    _pst.selector  = ODU_SELECTOR_LWLC;                      \
114    _pst.srcEnt    = ENTDUAPP;                               \
115    _pst.dstEnt    = ENTMAC;                                  \
116    _pst.dstInst   = 0;                                      \
117    _pst.srcInst   = 0;                                      \
118    _pst.dstProcId = DU_PROC;                                \
119    _pst.srcProcId = DU_PROC;                                \
120    _pst.region = DU_APP_MEM_REGION;                         \
121    _pst.pool = DU_POOL;                                     \
122    _pst.event = _event;                                     \
123    _pst.route = 0;                                          \
124    _pst.prior = 0;                                          \
125    _pst.intfVer = 0;                                        \
126 }
127
128 /* Fill Pst structure for sending msg from DU_APP to RLC */
129 #define FILL_PST_DUAPP_TO_RLC(_pst, _dstInst, _event)       \
130 {                                                           \
131    _pst.selector  = ODU_SELECTOR_LWLC;                      \
132    _pst.srcEnt    = ENTDUAPP;                               \
133    _pst.dstEnt    = ENTRLC;                                  \
134    _pst.dstInst   = _dstInst;                               \
135    _pst.srcInst   = DU_INST;                                \
136    _pst.dstProcId = DU_PROC;                                \
137    _pst.srcProcId = DU_PROC;                                \
138    _pst.region = DU_APP_MEM_REGION;                         \
139    _pst.pool = DU_POOL;                                     \
140    _pst.event = _event;                                     \
141    _pst.route = 0;                                          \
142    _pst.prior = 0;                                          \
143    _pst.intfVer = 0;                                        \
144 }
145
146
147 void fillStartSymbolAndLen(uint8_t numRsrcAlloc, PdschConfig *pdschCfg, PuschCfg *puschCfg);
148 uint8_t duAddNodeToLList(CmLListCp *llist, void *blockToAdd, CmLList *currNode);
149 uint8_t duDelNodeFromLList(CmLListCp *llist, CmLList *node);
150
151 #if 0
152 void printPageInfoLL(CmLListCp *pageInfoLL);
153 void printPageUeRecordLL(CmLListCp *pageUeLL);
154 void printPageList(CmHashListCp *pagingInfoMap);
155 #endif
156
157 /**********************************************************************
158          End of file
159 **********************************************************************/