Resolve NETAPI library coverity warnings.
[keystone-rtos/netapi.git] / ti / runtime / netapi / src / netapi_loc.h
1 /*****************************************
2  * file: netapi_loc.h
3  * purpose:  internal netapi stuff
4  ****************************************/
6 #ifndef __NETAPI_LOC__H
7 #define __NETAPI_LOC__H
9 #ifdef __cplusplus
10 extern "C" {
11 #endif
15 #include "ti/drv/nwal/nwal_util.h"
16 #include "ti/drv/nwal/nwal.h"
17 #include "ti/runtime/hplib/hplib.h"
18 #include "ti/runtime/netapi/pktio.h"
19 #include "ti/runtime/netapi/netcp_cfg.h"
20 #include "ti/runtime/netapi/netapi_tune.h"
23 extern hplib_virtualAddrInfo_T netapi_VM_VirtAddr[HPLIB_MAX_MEM_POOLS];
24 extern unsigned char *netapi_VM_SaContextVaddr;
26 #define NETAPI_TRUE 1
27 #define NETAPI_FALSE 0
29 /***********************************************
30  *  GLOBAL AREA
31  *   short term:  this is global to process
32  *         (multi-process not supported)
33  *   long term:  this structure gets put in shared memory 
34  ***********************************************/
36 /* list of global pktio channels that have been created
37    (NETCP_TX, RX are intrinsic so won't be here) */
38 typedef struct PKTIO_ENTRY_tag
39 {
40    char name[PKTIO_MAX_NAME+1];
41    Qmss_Queue qn;         // -1 => slot is free
42 } PKTIO_ENTRY_T;
44 /* to hold an IP on an interface */
45 typedef struct NETCP_INTERFACE_IP_Tag
46 {
47         int in_use;
48         void * nwal_handle;
49         nwal_IpType  ip_type;
50         nwalIpAddr_t  ip_addr;
51         nwalIpOpt_t ip_qualifiers;
52         void * user_data;
53 } NETCP_INTERFACE_IP_T;
55 /* to hold a classifier */
56 typedef struct NETCP_INTERFACE_CLASSIFIER_Tag
57 {
58     int  in_use;
59     int  class_type;   //see netcp_cfg.h
60     void * nwal_L2_handle;
61     void * nwal_L3_handle;
62     void * nwal_L4_handle;
63     void * user_data;
64 } NETCP_INTERFACE_CLASSIFIER_T;
66 /* to hold an ipsec rx policy */
67 typedef struct NETCP_IPSEC_POLICY_Tag
68 {
69     int in_use;
70     int tunnel; //associated tunnel
71     void * nwal_handle;  //handle associated with this RX Policy
72     void * user_data; // user data associtaed with this RX Policy
73 } NETCP_IPSEC_POLICY_T;
75 /* to hold a tunnel */
76 typedef struct NETCP_IPSEC_SA_Tag
77 {
78     int in_use;
79     int inbound;  //true if inbound
80        
81     int  sa_mode;  //mode we are going to use 
82 #define NETCP_IPSEC_SA_MODE_INFLOW 0
83 #define NETCP_IPSEC_SA_MODE_SIDEBAND 1
84  
85     void * sa_handle_inflow;   //for inflow mode
86     void * sa_handle_sideband; //for sideband mode
87     int iface;     //associated interface
88     nwalTxDmPSCmdInfo_t     dmPSCmdInfo;
89     uint32_t    swInfo0;
90     uint32_t    swInfo1;
91     void*   user_data;
92 } NETCP_IPSEC_SA_T;
94 /* to hold a netcp 'interface' */
95 typedef struct NETCP_INTERFACE_Tag
96 {
97    int in_use;  /* 1 for valid */
98    int state;  /* 0=down, 1=up,  future.. */
99    void * nwal_handle;  //handle associated with this interface
100    unsigned char mac[6];  // mac address
101    unsigned int vlan;   //future
102 } NETCP_INTERFACE_T;
104 /*to keep track of netcp config transactions */
105 typedef struct {
106     nwal_Bool_t             inUse;
107     uint16_t                transType;
108 #define NETAPI_NWAL_HANDLE_TRANS_NONE             0
109 #define NETAPI_NWAL_HANDLE_TRANS_MAC              1
110 #define NETAPI_NWAL_HANDLE_TRANS_IP               2
111 #define NETAPI_NWAL_HANDLE_TRANS_PORT             3
112 #define NETAPI_NWAL_HANDLE_TRANS_SA               4
113 #define NETAPI_NWAL_HANDLE_TRANS_SA_POLICY        5
114 #define NETAPI_NWAL_HANDLE_STAT_REQUEST           6
116     uint16_t                state;
117 #define NETAPI_NWAL_HANDLE_STATE_IDLE             0
118 #define NETAPI_NWAL_HANDLE_STATE_OPEN_PENDING     1
119 #define NETAPI_NWAL_HANDLE_STATE_OPEN             2
120 #define NETAPI_NWAL_HANDLE_STATE_CLOSE_PENDING    3
121 #define NETAPI_NWAL_HANDLE_STATE_ERR                        4
122     nwal_Handle             handle;
123     uint64_t                transId;
124     NETAPI_T                netapi_handle; //the thread making the transaction
125 }  NetapiNwalTransInfo_t;
127 /* to hold user defined flows */
128 typedef struct NETCP_REGISTERED_FLOWS_Tag
130     int                 in_use;  //1=> in use
131     void*               handle; //cppi handle to resource (internal)
132     NETCP_CFG_FLOW_T    flow;
133 } NETCP_REGISTERED_FLOWS_T;
135 /******************************
136  *    nwal global context : for SOC
137  *  (shared over all process instances)
138  *******************************/
139 typedef struct
141     int                             state;
142 #define NETAPI_NW_CXT_GLOB_INACTIVE               0x0
143 #define NETAPI__CXT_GLOB_ACTIVE                   0x1
144 #define NETAPI_NW_CXT_GLOB_RES_ALLOC_COMPLETE     0x3
146     nwal_Handle                     nwalInstHandle;  //created instance 
147     //internal heaps used just by netcp (sa<->pa). SW doesn't touch these
148     Pktlib_HeapHandle               sa2pa_heap;
149     Pktlib_HeapHandle               pa2sa_heap;
150     //stats
151     paSysStats_t                    paStats;
152     NETCP_INTERFACE_T               interfaces[TUNE_NETAPI_MAX_NUM_MAC];        //interfaces
153     NETCP_INTERFACE_CLASSIFIER_T    classi[TUNE_NETAPI_MAX_CLASSIFIERS]; //classifiers
154     NETCP_REGISTERED_FLOWS_T        flows[TUNE_NETAPI_MAX_FLOWS]; //flows
155     NETCP_IPSEC_SA_T                tunnel[TUNE_NETAPI_MAX_SA];           //tunnels
156     NETCP_IPSEC_POLICY_T            policy[TUNE_NETAPI_MAX_POLICY];  //policies
157     NETCP_INTERFACE_IP_T            ips[TUNE_NETAPI_MAX_NUM_IP];           //ips
158 } NETAPI_NWAL_GLOBAL_CONTEXT_T;
159 /************************************/
160 /* global instance for this process */
161 /************************************/
162 typedef struct
164     int                             state; /* see above*/
165     int                             numCmdPass;
166     int                             numCmdFail;
167     int                             numBogusTransIds;
168     NetapiNwalTransInfo_t           transInfos[TUNE_NETAPI_MAX_NUM_TRANS]; 
169 } NETAPI_NWAL_GLOBAL_PROC_CONTEXT_T;
171 /* NWAL Local context (per core/thread)  */
172 typedef struct
174 #define NETAPI_NW_CXT_LOC_INACTIVE     0x0
175 #define NETAPI_NW_CXT_LOC_ACTIVE       0x2
176     int                     state;
178     int                     numPendingCfg;
179     NETCP_CFG_STATS_CB      stats_cb;
181 /* stats */
182     int                     numL2PktsRecvd;
183     int                     numL3PktsRecvd;
184     int                     numL4PktsRecvd;
185     int                     numL4PktsSent;
186     int                     TxErrDrop;
188     /* local config */
189     nwalLocCfg_t           nwalLocCfg;
190 } NETAPI_NWAL_LOCAL_CONTEXT_T;
192 /* the global: for SOC, accross all processes */
193 typedef struct NETAPI_GLOBAL_tag
195 #define NETAPI_MAX_PKTIO (TUNE_NETAPI_MAX_PKTIO) 
196     PKTIO_ENTRY_T                   pktios[NETAPI_MAX_PKTIO];
197     /* configuration */
198     NETAPI_CFG_T                    cfg;
199     /* nwal context */
200     NETAPI_NWAL_GLOBAL_CONTEXT_T    nwal_context;
201     //NETAPI_T                        p_master;  // save p'masters handle 
202 } NETAPI_GLOBAL_T;
204 /* the process global: one per process */
205 typedef struct NETAPI_PROC_GLOBAL_tag
207     /* nwal context */
208     NETAPI_NWAL_GLOBAL_PROC_CONTEXT_T    nwal_context;
210     //NETAPI_T                        p_master;  // save p'masters handle 
211 } NETAPI_PROC_GLOBAL_T;
212 /************************************
213  * this is a per thread structure.
214  * It contains stuff local to thread
215  *  and pointer to global stuff
216  *  that is shared over all threads,
217  **************************************/
218 typedef struct NETAPI_HANDLE_Tag
220     int                         master; //master type
222     void*                       global;  /* pointer to the soc global area */
223     void*                       proc_global;  /* pointer to the proc global area */
225     /* heap  handles */
226     Pktlib_HeapHandle           netcp_heap;    /* internal default */
227     Pktlib_HeapHandle           netcp_control_rx_heap; /* for control messages */
228     Pktlib_HeapHandle           netcp_control_tx_heap; /* for control messages */
229     Pktlib_HeapHandle           createdHeaps[TUNE_NETAPI_MAX_HEAPS];  /* created by app and registered */
231     /* pktios defined */
232     int                         n_pktios; /* #of pktios that are active for this instance */
233     void*                       pktios[NETAPI_MAX_PKTIO]; /* the list of pktios */
235     /* scheduler stuff.  unallocated if NETAPI_INCLUDE_SCHED not set */
236     void*                       p_sched;
238     /* nwal local context */
239     NETAPI_NWAL_LOCAL_CONTEXT_T nwal_local;
241     /* thread cookie */
242     void*                      cookie;  /*set by calling thread */
243     HPLIB_SPINLOCK_IF_T        spinLock;
244     //uint32_t                   fNssGen2;
245 } NETAPI_HANDLE_T;
247 typedef struct NETAPI_SHM_Tag
249     NETAPI_GLOBAL_T     netapi_global;
250     hplib_spinLock_T    netapi_pktio_lock;
251     hplib_spinLock_T    netapi_netcp_cfg_lock;
252     hplib_spinLock_T    netapi_util_lock;
253     hplib_spinLock_T    netapi_netcp_cfg_l3_classi_lock;
254 } NETAPI_SHM_T;
256 //internal initialization routines */
257 int netapip_initQm(int max_descriptors, void* rmClientServiceHandle);
259 int netapip_initCppi(void* rmClientServiceHandle);
261 int netapip_startQm(void* rmClientServiceHandle);
262 int netapip_initNwal(int region2use,
263                      Pktlib_HeapIfTable * p_table,
264                      NETAPI_NWAL_GLOBAL_CONTEXT_T * p_nwal_context,
265                      NETAPI_CFG_T *p_cfg);
266 int netapip_startNwal(Pktlib_HeapHandle             pkt_heap,
267                       Pktlib_HeapHandle             cmd_heapRx,
268                       Pktlib_HeapHandle             cmd_heapTx,
269                       NETAPI_NWAL_LOCAL_CONTEXT_T*  p,
270                       NETAPI_CFG_T*                 p_cfg,
271                       NETAPI_NWAL_GLOBAL_CONTEXT_T* p_nwal_glob_context );
273 int netapip_initTimer(void);
274 int netapip_qmSetupMemRegion(unsigned int          numDesc,
275                              unsigned int          descSize,
276                              unsigned int*         pDescMemBase,
277                              int                   memRegion);
279 #define NETAPI_GLOBAL_REGION TUNE_NETAPI_QM_GLOBAL_REGION 
280 #define NETAPI_LOCAL_REGION ((NETAPI_GLOBAL_REGION)+1) 
283 //nwal callbacks
284 void netapip_pktioNWALRxPktCallback(uint32_t          appCookie,
285                                     uint16_t          numPkts,
286                                     nwalRxPktInfo_t*  pPktInfo,
287                                     uint64_t          timestamp,
288                                     nwal_Bool_t*      pFreePkt);
290 void netapip_netcpCfgNWALCmdCallBack (nwal_AppId        appHandle,
291                                       uint16_t          trans_id,
292                                       nwal_RetValue     ret);
294 void netapip_netcpCfgNWALCmdPaStatsReply (nwal_AppId        appHandle,
295                                           nwal_TransID_t    trans_id,
296                                           paSysStats_t      *stats);
298 void netapip_pktioNWALSBPktCallback     (uint32_t                   appCookie,
299                                          uint16_t                   numPkts,
300                                          nwalDmRxPayloadInfo_t*     pDmRxPktInfo,
301                                         nwal_Bool_t*                pFreePkt);
304 //***********************************
305 //internal utilities
306 //*************************************
308 //return the list of pktios for this instance
309 static inline void ** netapi_get_pktio_list(NETAPI_T p)
311 NETAPI_HANDLE_T *pp = (NETAPI_HANDLE_T *) p;
312 return &pp->pktios[0];
315 //get scheduler block handle
316 static inline void * netapi_get_scheduler(NETAPI_T p)
318     NETAPI_HANDLE_T *pp = (NETAPI_HANDLE_T *) p;
319     return pp->p_sched;
322 /* return pointer to global area */
323 NETAPI_GLOBAL_T * netapi_get_global(void);
324 NETAPI_PROC_GLOBAL_T * netapi_get_proc_global(void);
326 //add a pktio name (and queue) to global list
327 static inline int  netapip_addGlobalPktio(NETAPI_T p, char *name, Qmss_Queue * qn)
329 NETAPI_HANDLE_T *pp = (NETAPI_HANDLE_T *) p;
330 PKTIO_ENTRY_T *pe;
331 int i;
332 //find a free slot
333 pe = &((NETAPI_GLOBAL_T *)(pp->global))->pktios[0];
335     for(i=0;i<NETAPI_MAX_PKTIO; i++)
336  {
337    if (pe->qn.qNum ==  -1)
338    {
339      pe->qn.qNum=qn->qNum;
340      pe->qn.qMgr=qn->qMgr;
341      strncpy(pe->name, name, PKTIO_MAX_NAME);
342      return 1;
343    }
344    pe+=1;
345  }
346  return 0;  //no room
349 //delete a pktio name (and queue) to global list
350 static inline int  netapi_del_global_pktio(NETAPI_T p, char *name)
352 NETAPI_HANDLE_T *pp = (NETAPI_HANDLE_T *) p;
353 PKTIO_ENTRY_T *pe;
354 int i;
355 //find slot
356 pe = &((NETAPI_GLOBAL_T *)(pp->global))->pktios[0];
358 for(i=0;i<NETAPI_MAX_PKTIO; i++)
359  {
360    if (pe->qn.qNum == -1) continue;
361    if (!strncmp(name, pe->name, PKTIO_MAX_NAME))
362    {
363      pe->qn.qNum=-1;
364      pe->name[0]='\0';
365      return 1;
366    }
367    pe+=1;
368  }
369  return 0;  //no room
373 /* get list of global pktios that have been created */
374 static inline  Qmss_Queue*  netapip_findGlobalPktio(NETAPI_T p, char *name)
376 NETAPI_HANDLE_T *pp = (NETAPI_HANDLE_T *) p;
377 PKTIO_ENTRY_T *pe;
378 int i;
379 //find slot
380 pe = &((NETAPI_GLOBAL_T *)(pp->global))->pktios[0];
382 for(i=0;i<NETAPI_MAX_PKTIO; i++)
383  {
384    if (pe->qn.qNum  == -1) continue;
385    if (!strncmp(name, pe->name, PKTIO_MAX_NAME))
386    {
387      return &pe->qn;
388    }
389    pe +=1;
390  }
391  return NULL;  //not found
394 /* return the nwal global instance handle */
395 static inline nwal_Handle netapip_returnNwalInstanceHandle(NETAPI_T p)
398 NETAPI_HANDLE_T *pp = (NETAPI_HANDLE_T *) p;
399 return ((NETAPI_GLOBAL_T *)(pp->global))->nwal_context.nwalInstHandle;
404 //utility to clear out a queue
405 void netapip_zapQ(int queueNum);
406 void netapip_netcpCfgBuildRoute(NETCP_CFG_ROUTE_T * p_route,
407                                 int16_t * p_flow,
408                                 Qmss_QueueHnd * p_q,
409                                 nwalRouteType_t *p_type);
411 //database utilities
412 void netapip_netcpCfgDeleteSa(NETAPI_NWAL_GLOBAL_CONTEXT_T *p,int sa_slot);
414 void netapip_netcpCfgInsertSa(NETAPI_NWAL_GLOBAL_CONTEXT_T *p,
415                           int sa_slot,  //we 'reserved it already'
416                           int dir,
417                           int mode,
418                           void * temp1,
419                           void * temp2,
420                           void * handle_inflow,
421                           void * handle_sideband,
422                           nwalTxDmPSCmdInfo_t *dmPSCmdInfo,
423                           uint32_t swInfo0,
424                           uint32_t swInfo1,
425                           void* user_data);
426 void *netapip_netcpCfgGetSaHandles( NETAPI_NWAL_GLOBAL_CONTEXT_T *p,
427                           int sa_slot, void ** p_sideband);
428 void* netapip_netcpCfgGetMacHandle(NETAPI_NWAL_GLOBAL_CONTEXT_T *p,int iface_no);
429 NetapiNwalTransInfo_t *  netapip_getFreeTransInfo(NETAPI_HANDLE_T *p_handle,
430                                                   NETAPI_PROC_GLOBAL_T *p_global,
431                                                   nwal_TransID_t *pTransId);
432 void netapip_freeTransInfo(NetapiNwalTransInfo_t* pTransInfo);
433 void *netapip_netcpCfgGetPolicy( NETAPI_NWAL_GLOBAL_CONTEXT_T *p,
434                           int policy_slot);
435 nwalTxDmPSCmdInfo_t* netapip_netcpCfgGetSaSBInfo(NETAPI_NWAL_GLOBAL_CONTEXT_T *p,
436                                       NETCP_CFG_SA_T    sa_app_id);
437 int netapip_netcpCfgGetSaInflowInfo(NETAPI_NWAL_GLOBAL_CONTEXT_T *p,
438                                       NETCP_CFG_SA_T    sa_app_id,
439                                       uint32_t *swInfo0,
440                                       uint32_t *swInfo1);
442 int netapip_systemInit(NETAPI_HANDLE_T  *handle,
443                        Bool             global_master_process);
446 void netapip_cleanupAtStart(void);
451 #ifdef __cplusplus
453 #endif
455 #endif