[Epic-ID: ODUHIGH-406][Task-ID: ODUHIGH-422]F1AP Paging Message Handling at DUAPP
[o-du/l2.git] / src / du_app / du_utils.c
1 /*******************************************************************************
2 ################################################################################
3 #   Copyright (c) [2020] [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 /* Utility definitions to be used in du app */
19 #include "common_def.h"
20 #include "lrg.h"
21 #include "lrg.x"
22 #include "lkw.x"
23 #include "du_app_mac_inf.h"
24 #include "du_utils.h"
25 #include "du_app_rlc_inf.h"
26 #include "du_cfg.h"
27 #include "du_mgr.h"
28
29 /* Spec Ref-38.214-Table 5.1.2.1-1 */
30 uint8_t slivCfgIdxTable[MAX_SLIV_CONFIG_IDX][3] = {
31 /*S    L     SLIV*/
32 { 0,   1,    0  },/* index0  */
33 { 0,   2,    14 },/* index1  */
34 { 0,   3,    28 },/* index2  */
35 { 0,   4,    42 },/* index3  */
36 { 0,   5,    56 },/* index4  */
37 { 0,   6,    70 },/* index5  */
38 { 0,   7,    84 },/* index6  */
39 { 0,   8,    98 },/* index7  */
40 { 0,   9,    97 },/* index8  */
41 { 0,   10,   83 },/* index9  */
42 { 0,   11,   69 },/* index10 */
43 { 0,   12,   55 },/* index11 */
44 { 0,   13,   41 },/* index12 */
45 { 0,   14,   27 },/* index13 */
46 { 1,   1,    1  },/* index14 */
47 { 1,   2,    15 },/* index15 */
48 { 1,   3,    29 },/* index16 */
49 { 1,   4,    43 },/* index17 */
50 { 1,   5,    57 },/* index18 */
51 { 1,   6,    71 },/* index19 */
52 { 1,   7,    85 },/* index20 */
53 { 1,   8,    99 },/* index21 */
54 { 1,   9,    96 },/* index22 */
55 { 1,   10,   82 },/* index23 */
56 { 1,   11,   68 },/* index24 */
57 { 1,   12,   54 },/* index25 */
58 { 1,   13,   40 },/* index26 */
59 { 2,   1,    2  },/* index27 */
60 { 2,   2,    16 },/* index28 */
61 { 2,   3,    30 },/* index29 */
62 { 2,   4,    44 },/* index30 */
63 { 2,   5,    58 },/* index31 */
64 { 2,   6,    72 },/* index32 */
65 { 2,   7,    86 },/* index33 */
66 { 2,   8,    100},/* index34 */
67 { 2,   9,    95 },/* index35 */
68 { 2,   10,   81 },/* index36 */
69 { 2,   11,   67 },/* index37 */
70 { 2,   12,   53 },/* index38 */
71 { 3,   1,    3  },/* index39 */
72 { 3,   2,    17 },/* index40 */
73 { 3,   3,    31 },/* index41 */
74 { 3,   4,    45 },/* index42 */
75 { 3,   5,    59 },/* index43 */
76 { 3,   6,    73 },/* index44 */
77 { 3,   7,    87 },/* index45 */
78 { 3,   8,    101},/* index46 */
79 { 3,   9,    94 },/* index47 */
80 { 3,   10,   80 },/* index48 */
81 { 3,   11,   66 },/* index49 */
82 { 4,   1,    4  },/* index50 */
83 { 4,   2,    18 },/* index51 */
84 { 4,   3,    32 },/* index52 */
85 { 4,   4,    46 },/* index53 */
86 { 4,   5,    60 },/* index54 */
87 { 4,   6,    74 },/* index55 */
88 { 4,   7,    88 },/* index56 */
89 { 4,   8,    102},/* index57 */
90 { 4,   9,    93 },/* index58 */
91 { 4,   10,   79 },/* index59 */
92 { 5,   1,    5  },/* index60 */
93 { 5,   2,    19 },/* index61 */
94 { 5,   3,    33 },/* index62 */
95 { 5,   4,    47 },/* index63 */
96 { 5,   5,    61 },/* index64 */
97 { 5,   6,    75 },/* index65 */
98 { 5,   7,    89 },/* index66 */
99 { 5,   8,    103},/* index67 */
100 { 5,   9,    92 },/* index68 */
101 { 6,   1,    6  },/* index69 */
102 { 6,   2,    20 },/* index70 */
103 { 6,   3,    34 },/* index71 */
104 { 6,   4,    48 },/* index72 */
105 { 6,   5,    62 },/* index73 */
106 { 6,   6,    76 },/* index74 */
107 { 6,   7,    90 },/* index75 */
108 { 6,   8,    104},/* index76 */
109 { 7,   1,    7  },/* index77 */
110 { 7,   2,    21 },/* index78 */
111 { 7,   3,    35 },/* index79 */
112 { 7,   4,    49 },/* index80 */
113 { 7,   5,    63 },/* index81 */
114 { 7,   6,    77 },/* index82 */
115 { 7,   7,    91 },/* index83 */
116 { 8,   1,    8  },/* index84 */
117 { 8,   2,    22 },/* index85 */
118 { 8,   3,    36 },/* index86 */
119 { 8,   4,    50 },/* index87 */
120 { 8,   5,    64 },/* index88 */
121 { 8,   6,    78 },/* index89 */
122 { 9,   1,    9  },/* index90 */
123 { 9,   2,    23 },/* index91 */
124 { 9,   3,    37 },/* index92 */
125 { 9,   4,    51 },/* index93 */
126 { 9,   5,    65 },/* index94 */
127 { 10,  1,    10 },/* index95 */
128 { 10,  2,    24 },/* index96 */
129 { 10,  3,    38 },/* index97 */
130 { 10,  4,    52 },/* index98 */
131 { 11,  1,    11 },/* index99 */
132 { 11,  2,    25 },/* index100*/
133 { 11,  3,    39 },/* index101*/
134 { 12,  1,    12 },/* index102*/
135 { 12,  2,    26 },/* index103*/
136 { 13,  1,    13 } /* index104*/
137 };
138
139 /*******************************************************************
140  *
141  * @brief Function to fill the start Symbol and Symbol Len from the 
142  * sliv Config Idx Table
143  *
144  * @details
145  *
146  *    Function : fillStartSymbolAndLen
147  *
148  *    Functionality: Function to fill the start Symbol and Symbol Len 
149  *                   from the sliv Config Idx Table
150  *
151  * @params[in] startSymbolIdx pointer,
152  *             symbolLen pointer,
153  *             sliv
154  * @return void
155  *
156  * ****************************************************************/
157 void fillStartSymbolAndLen(uint8_t numRsrcAlloc, PdschConfig *pdschCfg, PuschCfg *puschCfg)
158 {
159    uint8_t slivIdx, timeDomIdx;
160
161    for(timeDomIdx = 0; timeDomIdx < numRsrcAlloc; timeDomIdx++)
162    {
163       for(slivIdx = 0; slivIdx < MAX_SLIV_CONFIG_IDX; slivIdx++)
164       {
165          if(pdschCfg)/* PDSCH Config */
166          {
167             if(pdschCfg->timeDomRsrcAllociList[timeDomIdx].startSymbolAndLength ==\
168                slivCfgIdxTable[slivIdx][2])
169             {
170                pdschCfg->timeDomRsrcAllociList[timeDomIdx].startSymbol  = slivCfgIdxTable[slivIdx][0];
171                pdschCfg->timeDomRsrcAllociList[timeDomIdx].symbolLength = slivCfgIdxTable[slivIdx][1];
172                break;
173             }
174          }
175          if(puschCfg)/* PUSCH Config */
176          {
177             if(puschCfg->timeDomRsrcAllocList[timeDomIdx].startSymbolAndLength ==\
178                slivCfgIdxTable[slivIdx][2])
179             {
180                puschCfg->timeDomRsrcAllocList[timeDomIdx].startSymbol  = slivCfgIdxTable[slivIdx][0];
181                puschCfg->timeDomRsrcAllocList[timeDomIdx].symbolLength = slivCfgIdxTable[slivIdx][1];
182                break;
183             }
184
185          }
186       }
187    }
188 }
189
190 /*******************************************************************
191  * @brief Function to add a node to a linked list
192  *
193  * @details
194  *
195  *     Function: duAddNodeToLList
196  *
197  *     This function adds a new node to the linked list
198  *
199  *  @param[in]  Pointer to the list
200  *              Pointer to node to be added
201  *              Pointer to current node
202  *  @return     ROK
203  *              RFAILED
204 *******************************************************************/
205 uint8_t duAddNodeToLList(CmLListCp *llist, void *blockToAdd, CmLList *currNode)
206 {
207    CmLList  *newNode = NULLP;
208
209    DU_ALLOC(newNode, sizeof(CmLList));
210    if(newNode)
211    {
212       newNode->node = (PTR)blockToAdd;
213       
214       if(currNode == NULLP)
215          cmLListAdd2Tail(llist, newNode);
216       else
217       {
218          llist->crnt = currNode;
219          cmLListInsAfterCrnt(llist, newNode);
220       }
221       return ROK;
222    } 
223    return RFAILED;
224 }
225
226 /*******************************************************************
227  * @brief Function to delete a node from linked list
228  *
229  * @details
230  *
231  *     Function: duDelNodeFromLList
232  *
233  *     This function deletes a node from the linked list
234  *
235  *  @param[in]  Pointer to the list
236  *              Pointer to node to be deleted
237  *  @return     Pointer to the deleted node
238 *******************************************************************/
239
240 uint8_t duDelNodeFromLList(CmLListCp *llist, CmLList *node)
241 {
242    node = cmLListDelFrm(llist, node);
243    DU_FREE(node, sizeof(CmLList));
244
245    return ROK;
246 }
247
248 /*Below function for printing will be used in future so disabling it for now*/
249 #if 0 
250 /****************************************************************************
251  *
252  * @brief Print the LC in list for debugging purpose 
253  *
254  * @details
255  *
256  *    Function : printLcLL
257  *
258  *    Functionality:
259  *            For debugging purpose, for printing the LC in the order and
260  *            parameters
261  *
262  * @params[in] LcList pointer 
263  *       
264  * @return void 
265  *        
266  *************************************************************************/
267 void printPageInfoLL(CmLListCp *pageInfoLL)
268 {
269    CmLList *node = NULLP;
270    DuPagUeList *pageInfoNode = NULLP;
271
272    if(pageInfoLL == NULLP)
273    {
274       DU_LOG("\nINFO   -->  DU APP: PageInfo List doesnt exist");
275       return;
276    }
277    node = pageInfoLL->first;
278    while(node)
279    {
280       pageInfoNode = (DuPagUeList *)node->node;
281       if(pageInfoNode)
282       {
283          DU_LOG("\nINFO   -->  DU APP i_s:%d",pageInfoNode->i_s);
284          printPageUeRecordLL(&(pageInfoNode->pagUeList));
285       }
286
287       node = node->next;
288    }
289 }
290
291 /****************************************************************************
292  *
293  * @brief Print the Ue Record against Paging Frame for debugging purpose 
294  *
295  * @details
296  *
297  *    Function : printLcLL
298  *
299  *    Functionality:
300  *            For debugging purpose, for printing the UE Record in the order and
301  *            parameters
302  *
303  * @params[in] ueList pointer 
304  *       
305  * @return void 
306  *        
307  *************************************************************************/
308 void printPageUeRecordLL(CmLListCp *ueList)
309 {
310    CmLList *node = NULLP;
311    DuPagUeRecord *ueRecord = NULLP;
312
313    if(ueList == NULLP)
314    {
315       DU_LOG("\nINFO   -->  DU APP: PageUe List doesnt exist");
316       return;
317    }
318    node = ueList->first;
319    while(node)
320    {
321       ueRecord = (DuPagUeRecord *)node->node;
322       if(ueRecord)
323       {
324          DU_LOG("\nINFO   -->  DU APP ueId:%d, sTmsi:%lu, prio:%d",ueRecord->pagUeId, ueRecord->sTmsi, ueRecord->pagPriority);
325       }
326
327       node = node->next;
328    }
329
330 }
331
332 /*******************************************************************
333  * @brief Print the Page Info List and UE Records
334  *
335  * @details
336  *
337  *    Function : printPageList
338  *
339  *    Functionality: Print the Page Info List and UE Records
340  *
341  * @params[in] CmHashListCp *pagingInfoMap
342  *
343  * @return void
344  *
345  * ****************************************************************/
346 void printPageList(CmHashListCp *pagingInfoMap)
347 {
348    uint8_t ret = ROK;
349    DuPagInfoList *pagInfoLLFromPF = NULLP, *prevPageInfoLL = NULLP;
350
351    do
352    {
353       ret = cmHashListGetNext(pagingInfoMap, (PTR)prevPageInfoLL, (PTR *)&pagInfoLLFromPF);
354       if(ret == ROK)
355       {
356          DU_LOG("\nDEBUG  --> DUAPP Page List for PF:%d",pagInfoLLFromPF->pf);
357          printPageInfoLL(&(pagInfoLLFromPF->pagInfoList));
358          prevPageInfoLL = pagInfoLLFromPF;
359       }
360    }while(ret == ROK);
361    
362 }
363 #endif
364 /**********************************************************************
365 End of file
366 **********************************************************************/
367