E2AP review changes part1
[o-du/l2.git] / src / mt / mt_ss.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**
20
21      Name:     MTSS -- implementation specific definitions
22
23      Type:     C include file
24
25      Desc:     Various macro definitions demanded by systems services.
26                The contents of these are for the MTSS implementation.
27
28      File:     mt_ss.h
29
30 *********************************************************************21*/
31
32
33 #ifndef __MTSSH__
34 #define __MTSSH__
35
36
37 /* --- interface to SS --- */
38
39 /* general */
40 #define SS_PROC_ID                      PID_STK(1)
41
42 /* task related */
43 /* mt028.201: addition: multiple procs support related changes */
44 #ifdef SS_MULTIPLE_PROCS
45 #define SS_MAX_PROCS                    100 /* max entries for proc list */
46 #endif /* SS_MULTIPLE_PROCS */
47
48 #define SS_MAX_ENT                      255
49 #define SS_MAX_INST                     8
50
51 /* mt028.201: modification: multiple procs support related changes */
52 #ifndef SS_MULTIPLE_PROCS
53 #define SS_MAX_TTSKS                    100
54
55 #ifndef SS_MULTICORE_SUPPORT
56 #define SS_MAX_STSKS                    7
57 #else
58 /* mt001.301 : Additions */
59 #ifdef  SPLIT_RLC_DL_TASK
60 #ifdef L2_L3_SPLIT
61 #define SS_MAX_STSKS                    4 
62 #else
63 #define SS_MAX_STSKS                    5 
64 #endif
65 #else 
66 #define SS_MAX_STSKS                    5 
67 #endif 
68 #endif /* SS_MULTICORE_SUPPORT */
69
70 #else /* SS_MULTIPLE_PROCS */
71 #define SS_MAX_TTSKS                    1000 
72 #define SS_MAX_STSKS                    7
73 #endif /* SS_MULTIPLE_PROCS */
74
75 #ifdef SS_DRVR_SUPPORT
76 #define SS_MAX_DRVRTSKS                 70
77 #endif
78
79 #ifdef SS_RTR_SUPPORT
80    /* mt0012.21 : Addition */
81 #define SS_MAX_RTRTSKS                  255
82 #endif
83
84
85 /* timer related */
86 #define SS_MAX_TMRS                     45
87
88 /* memory related */
89 /* mt022.201 - Modification for shared memory relay and memcal regions */
90 #ifdef SS_MULTICORE_SUPPORT
91 #define SS_MAX_REGS SS_MAX_STSKS
92 #else
93 #define SS_MAX_REGS 5
94 #endif
95
96 #ifdef CMM_MAX_BKT_ENT
97 #define SS_MAX_POOLS_PER_REG            CMM_MAX_BKT_ENT
98 #else
99 #define SS_MAX_POOLS_PER_REG            5
100 #endif
101 /* mt001.301 : Additions */
102 #ifdef SS_WATCHDOG
103 #define ENTDW                           0xcd
104 #define ENTHB                           0xce
105 #define INST0                           0x00
106 #define SS_TMR_HRTBT                    0x00
107 #define EVTSSHRTBTREQ                   0x00
108 #define EVTSSHRTBTRSP                   0x01
109 #define SS_LOOSE_COUPLING               0x00
110 #endif /* SS_WATCHDOG */
111
112 /* locks */
113 #define SS_STSKTBL_LOCK                 SS_LOCK_MUTEX
114 #define SS_STSKENTRY_LOCK               SS_LOCK_MUTEX
115 #define SS_TMRTBL_LOCK                  SS_LOCK_MUTEX
116 #define SS_DMNDQ_LOCK                   SS_LOCK_MUTEX
117 #define SS_DRVRENTRY_LOCK               SS_LOCK_MUTEX
118 #define SS_RTRENTRY_LOCK                SS_LOCK_MUTEX
119
120 #ifdef TENB_T2K3K_SPECIFIC_CHANGES
121 #define MIPS_FILE "/sys/devices/virtual/mmonitor/mmonitor/mips_stat"
122 #define GET_CPU_MAX(x, y) ((x) >= (y) ? (x) : (y))
123 #define MIPS_STRING_LEN    24
124 #endif
125
126
127 /* types needed by common SSI code */
128 #define SsSemaId                        sem_t
129 #define SLockId                         pthread_mutex_t
130
131
132 /* calls needed by common SSI code */
133 #ifndef TENB_RTLIN_CHANGES
134 #define SInitLock(l, t)                 pthread_mutex_init(l, NULL)
135 #endif
136 /*extern U32 gt[128]; */
137 /*#define SLock(l)                        (((gt[0x000000FF &((U32)pthread_self())]=MacGetTick())&&pthread_mutex_lock(l)&&MLogTask(30340, RESOURCE_LINL2, gt[0x000000FF &((U32)pthread_self())], MacGetTick()))?0:0)*/
138 #define SLock(l)                        pthread_mutex_lock(l)
139 #define SUnlock(l)                      pthread_mutex_unlock(l)
140 #define SDestroyLock(l)                 pthread_mutex_destroy(l)
141
142 #define ssInitSema(s, c)                sem_init(s, 0, c)
143 #define ssWaitSema(s)                   sem_wait(s)
144 #define ssPostSema(s)                   sem_post(s)
145 #define ssDestroySema(s)                sem_destroy(s)
146
147 #define SS_CHECK_CUR_STSK(t)            (pthread_equal(pthread_self(), \
148                                           (t)->dep.tId))
149  /* mt013.21: Addition */
150 #define SInitSemaphore(s, c)            sem_init(s, 0, c)
151 #define SWaitSemaphore(s)               sem_wait(s)
152 #define SPostSemaphore(s)               sem_post(s)
153 #define SDestroySemaphore(s)            sem_destroy(s)
154
155 #define ssdPstTsk(p, m, t)
156
157 /* added SExit() for exiting process : mt017.21 */
158 /* mt001.301 : Additions */
159 #ifndef SS_LOGGER_SUPPORT
160 #define SExit()                         exit(0)
161 #else
162 #define SExit()  \
163 { \
164 SCleanUp(); \
165 exit(0); \
166 }
167 #endif /* SS_LOGGER_SUPPORT  */
168
169   /* mt007.21 addition */
170 /* calls needed by Message Functions */
171 #define SMemCpy(d,s,c)  memcpy(d,s,c)
172 #define SMemSet(s,c,n)  memset(s,c,n)
173 /* --- internal to MTSS-Solaris --- */
174
175
176 /*mt041.201 Value of MT_TICK_CNT changed*/
177 /*mt004.301- defining the MT_TICK_CNT in Micro seconds (usecs) */
178 /* mt010.301  Removed #ifdef SS_FAP portion and enabled oroginal code */
179 #define MT_TICK_CNT             (((U32)0x0F4240)/SS_TICKS_SEC)
180
181 #define MT_MAX_TICK_CNT_VAL     35
182 #define MT_MIN_TICK_CNT_VAL     1
183
184
185 /* interrupt service flags */
186 #define MT_IS_SET               0
187 #define MT_IS_UNSET             1
188 #define MT_IS_RESET             2
189
190 /******************************************************************
191  mt018.201 - Memory Configuration.
192
193 Memory block sizes and counts for memory manager configuration
194 There is no restriction in the size of each block for the bucket.
195 However, it is recommended that the bucket size should be word aligned.
196 The CMM (Common Memory Manager) also create a look up table which map
197 the size to the bucket index.
198 The number of entry in the lookup table  (CMM_MAX_MAP_ENT, defined in
199 cm_mem.h) = ((maximum bucket size)/(bucket quantum size)) + 1.
200 The CMM_MAX_MAP_ENT should be changed depending on the bucket sizes
201 that are configured below.
202 *******************************************************************/
203
204 /* Bucket 0 configuration */
205 /* mt032.201 changed  MT_BKT_0_DSIZE from 120 to 128 for 64k compilation */
206 #define MT_BKT_0_DSIZE          256
207 /*mt004.301-changed for FAP*/
208 #ifndef SS_FAP
209 #ifdef XEON_SPECIFIC_CHANGES
210 #define MT_BKT_0_NUMBLKS        5248 /* 10500 Modified from 3500 to 10500 */
211 #else
212 #define MT_BKT_0_NUMBLKS        10000 /* 10500 Modified from 3500 to 10500 */
213 #endif
214 #else
215 #define MT_BKT_0_NUMBLKS        10000
216 #endif
217
218 /* Bucket 1 configuration */
219 /*mt004.301-changed for FAP*/
220 #ifndef SS_FAP
221 #ifdef XEON_SPECIFIC_CHANGES
222 #define MT_BKT_1_DSIZE          1024  /* Modified from 256 to 4096 */
223 #else
224 #define MT_BKT_1_DSIZE          1280  /* Modified from 256 to 4096 */
225 #endif
226 #define MT_BKT_1_NUMBLKS        10496 /* 1000*/
227 #else
228 /*mt010.301*/
229 #define MT_BKT_1_DSIZE          256
230 #define MT_BKT_1_NUMBLKS        2000
231 #endif
232
233 /* Bucket 2 configuration */
234 /*mt010.301*/
235 #ifdef SS_FAP
236 #define MT_BKT_2_DSIZE      1376      /* Fill in this value as required */
237 #define MT_BKT_2_NUMBLKS    4000        /* Fill in this value as required */
238 #else
239 #ifdef XEON_SPECIFIC_CHANGES
240 #define MT_BKT_2_DSIZE   1768 /* 1664 2048 */
241 #define MT_BKT_2_NUMBLKS 5248 /* 10496 */
242 #else
243 #define MT_BKT_2_DSIZE   2048 /* 1664 2048 */
244 #define MT_BKT_2_NUMBLKS 2000 /* 10496 */
245 #endif
246 #endif
247
248
249 /* Bucket 3 configuration */
250 /*mt010.301*/
251 #ifdef SS_FAP
252 #define MT_BKT_3_DSIZE     2592      /* Fill in this value as required */
253 #define MT_BKT_3_NUMBLKS   1500     /* Fill in this value as required */
254 #else
255 #ifdef XEON_SPECIFIC_CHANGES
256 #define MT_BKT_3_DSIZE     4224      /* Fill in this value as required */
257 #define MT_BKT_3_NUMBLKS   5248 /*10496 */       /* Fill in this value as required */
258 #else
259 #define MT_BKT_3_DSIZE     8196      /* Fill in this value as required */
260 #define MT_BKT_3_NUMBLKS   1000 /*10496 */       /* Fill in this value as required */
261 #endif
262 #endif
263
264 /* For Non-Sharable regions/static regions */
265 #ifdef XEON_SPECIFIC_CHANGES
266 #define MT_BKT_0_STATIC_NUMBLKS   500000     /* Fill in this value as required */
267 #define MT_BKT_1_STATIC_NUMBLKS   500000     /* Fill in this value as required */
268 #define MT_BKT_2_STATIC_NUMBLKS   200000     /* Fill in this value as required */
269 #define MT_BKT_3_STATIC_NUMBLKS   40960     /* Fill in this value as required */
270 #define MT_BKT_4_STATIC_NUMBLKS   4096     /* Fill in this value as required */
271 #else
272 #define MT_BKT_0_STATIC_NUMBLKS   75000     /* Fill in this value as required */
273 #define MT_BKT_1_STATIC_NUMBLKS   15000     /* Fill in this value as required */
274 #define MT_BKT_2_STATIC_NUMBLKS   500     /* Fill in this value as required */
275 #define MT_BKT_3_STATIC_NUMBLKS   1600     /* Fill in this value as required */
276 #endif
277 /*mt010.301*/
278 #ifdef RGL_SPECIFIC_CHANGES
279 #define MT_MAX_BKTS             5
280 #else
281 #define MT_MAX_BKTS             4
282 #endif
283
284 /* mt029.201 corrected typos */
285 /* memory pool data size definitions for pool-to-size mapping table */
286 #define MT_POOL_3_DSIZE        (MT_BKT_3_DSIZE-(sizeof(SsMblk)+sizeof(SsDblk)))
287 #define MT_POOL_2_DSIZE        (MT_BKT_2_DSIZE-(sizeof(SsMblk)+sizeof(SsDblk)))
288 #define MT_POOL_1_DSIZE        (MT_BKT_1_DSIZE-(sizeof(SsMblk)+sizeof(SsDblk)))
289 #define MT_POOL_0_DSIZE        (MT_BKT_0_DSIZE-(sizeof(SsMblk)+sizeof(SsDblk)))
290
291
292
293 /* mt026.201 - Modification to increase default heap size */
294 /* memory size used for heap by the memory manager (2MB) */
295 /* mt001.301 : Additions */
296 /*mt004.301- changed heap size for FAP */
297 #ifdef SS_FAP
298 #define MT_HEAP_SIZE            5242880U
299 #else
300 #ifdef XEON_SPECIFIC_CHANGES
301 #define MT_HEAP_SIZE            6194304U
302 #else
303 #define MT_HEAP_SIZE            1004800U /*PAL FIX: 4MB to 6MB flexran */
304 #endif
305 #endif
306
307 #ifndef USE_MEMCAL
308 #define STATIC_MEM_CFG
309 #endif
310
311 /* mt022.201 - definition of MT_BKTQNSIZE */
312 /*mt010.301*/
313 #define MT_BKTQNSIZE 128
314
315
316 /* mt021.201 - Addition for setting stack size for threads */
317 /* Configuration for stack size (in bytes) of spawned threads
318  * Size of zero gives default of 1 MB or 2 MB for 32 bit or 64 bit
319  * compilers, respectively */
320 #define MT_TASK_STACK           NULLD   /* stack size for task handler */
321 #define MT_ISTASK_STACK         NULLD   /* stack size for IS task handler */
322 #define MT_TMRTASK_STACK        NULLD   /* stack size for timer handler */
323 #define MT_CONSOLE_STACK        NULLD   /* stack size for console handler */
324
325 /* mt001.301 : Additions Logger support */
326 #ifdef SS_LOGGER_SUPPORT
327 #ifndef SS_MAX_LOGBUF_SIZE
328 #define SS_MAX_LOGBUF_SIZE 8192
329 #endif
330 #ifndef SS_MAX_PATH
331 #define SS_MAX_PATH 1024
332 #endif
333 #endif /* SS_LOGGER_SUPPORT */
334 /* mt005.301: Cavium changes: */
335 #ifdef SS_SEUM_CAVIUM
336 /* Cavium related hashdefines */
337 #define SS_CVMX_GRP_MASK   (1 << osCp.procId)
338
339 #define SS_CVMX_NUM_PKT_BUFFERS   0
340 #define SS_CVMX_NUM_WQE_BUFFERS   100
341 #define SS_CVMX_NUM_PKO_BUFFERS   0
342 #define SS_CVMX_NUM_TIM_BUFFERS   1000
343 #define SS_CVMX_NUM_DFA_BUFFERS   0
344
345 /* fpa pool 0 configuration */
346 #define SS_CVMX_POOL_0_NUMBLKS        3000
347
348 /* fpa pool 1 configuration */
349 #define SS_CVMX_POOL_1_NUMBLKS        100
350
351 /* fpa pool 2 configuration */
352 #define SS_CVMX_POOL_2_NUMBLKS        10        /* Fill in this value as required */
353
354 /* fpa pool 3 configuration */
355 #define SS_CVMX_POOL_3_NUMBLKS        2500      /* Fill in this value as required */
356
357 #define SS_CVMX_TICK_TIME   1000  /* the value is in micorsec */
358 #define SS_CVMX_MAX_TICKS   1000
359 #define SS_CVMX_TICKS       500
360
361 #define SS_CVMX_TMR_TAG     1000
362 #define SS_CVMX_MBUF_TAG    1001
363 #endif /* SS_SEUM_CAVIUM */
364
365 /* mt011.301: Pool definition for both 64 bit and 32 bit Cavium */
366 #ifndef SS_CVMX_WQE_POOL
367 #ifdef BIT_64
368 #define SS_CVMX_WQE_POOL CVMX_FPA_WQE_POOL
369 #else
370 #define SS_CVMX_WQE_POOL SS_CVMX_POOL_0
371 #endif
372 #endif
373
374
375 #endif  /*  __MTSSH__  */
376
377
378 \f
379 /********************************************************************30**
380
381          End of file
382 **********************************************************************/