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