a668fd40d5476ab19ef1d747e8361413b934015b
[keystone-rtos/netapi.git] / ti / runtime / netapi / netcp_cfg.h
1 /******************************************************************************
2  * FILE PURPOSE:  netapi NETCP configuration API header file
3  ******************************************************************************
4  * FILE NAME:   netcp_cfg.h
5  *
6  * DESCRIPTION:netapi NETCP configuration API header  file for user space transport library
7  *
8  * REVISION HISTORY:
9  *
10  *  Copyright (c) Texas Instruments Incorporated 2013
11  *
12  *  Redistribution and use in source and binary forms, with or without
13  *  modification, are permitted provided that the following conditions
14  *  are met:
15  *
16  *    Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  *
19  *    Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the
22  *    distribution.
23  *
24  *    Neither the name of Texas Instruments Incorporated nor the names of
25  *    its contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  *
40  */
41 /* ============================================================= */
43 /**
44  *   @file netcp_cfg.h
45  *   @brief Netapi NETCP configuration API header file for user space transport library
46  */
50 #ifndef __NETCP_CFG__H
51 #define __NETCP_CFG__H
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
57 //#include "netapi.h"
59 /**
60  *  @ingroup cfg_structures
61  *  @brief NETCP Flow ID configuaration informaation
62  *  @details A flow defines a set of free queues (pktlib heap) for hardware to use to get
63  *          free packet descriptor(s) and buffer(s) to use when receiving a packet. CPPI flow ID for
64  *          default case, use NETCP_DEFAULT_FLOW
65  */
66 typedef struct NETCP_CFG_FLOW_Tag
67 {
68     int flowid;         /**< flow id*/
69     int dma_engine;     /**< dma engine (QMSS, NETCP)*/
70 } NETCP_CFG_FLOW_T;
73 /**
74  *  @ingroup cfg_structures
75  *  @brief NETAPI configuration information
76  *
77  *  @details The parameters in this structure are used to configure NETAPI.
78  */
79 typedef struct NETAPI_CFG_Tag
80 {
81  int def_mem_size;                  /**<  Bytes of CMA memory we have allocated */
82  int def_flow_pkt_rx_offset;        /**<  Offset in pkt buffer for hw to start RX */
83  int def_max_descriptors;           /**<  Number of descriptors in system  (must be power of 2), 2^14 max */
84  int def_tot_descriptors_for_us;    /**<  Number of descriptors to create in our region (must be power of 2)*/
85  int def_heap_n_descriptors;        /**<  Number of descriptor plus buffers in default heap*/
86  int def_heap_n_zdescriptors;       /**<  Number of zero len descriptors in defaut heap*/
87  int def_heap_buf_size;             /**<  Size of buffers in default heap, max amount of area for packet data */
88  int def_heap_tailroom_size;        /**<  Size of tailroom in reserve */
89  int def_heap_extra_size;           /**<  Size of extra space at end of buffer */ 
90  int def_multi_process;             /**<  Flag to indicate if NETAPI init is for multi-process environment */
91  void *rmHandle;                    /**<  Optional: Resource Manager (RM) server handle to use RM for re                                                    souce allocations*/
92  int memoryRegion;                  /**<  Optional: Specify the descriptor memory region to be used,
93                                           must be a valid memory  region index
94                                           (0 to Maximum number of memory regions supported
95                                           Not used when using Resouce Manager(RM)as QMSS via RM will
96                                           return available Memory Region Id.
97                                           */
98  int start_index;                   /**<  Optional: Used to leave holes by configuring dummy regions which
99                                           can be later configured with actual values. May either be
100                                           specified by the user (for example, to select "internal" or
101                                           "external" linking RAM, or set to QMSS_START_INDEX_NOT_SPECIFIED,
102                                           QMSS_PARAM_NOT_SPECIFIED to have LLD/RM select a compatible startIndex
103                                           from anywhere with free indicies, or QMSS_START_INDEX_INTERNAL.
104                                           for internal linking RAM, QMSS_START_INDEX_EXTERNAL for external linking RAM. 
105                                           Not used when using Resouce Manager(RM)as QMSS via RM will
106                                           return available Memory Region Id and determine avialable start index.
107                                           */
108 }  NETAPI_CFG_T;
110 /* @note:
111    each buffer will be allocated:  def_heap_buf_size+def_heap_extra_size bytes
112    each descriptor attached to these buffers will have rigBufferLen of:
113       def_heap_buf_size.
114    for default RX flow,  for rx packet, the bufptr  will be def_flow_pkt_rx_offset.
115    for detault RX flow,  threshold (ie max # of bytes in buffer) will be:
116        def_heap_buf_size - def_heap_tailroom_size-def_flow_pkt_rx_offset
119  RX Packet from NetCP
121 Headroom [Application]     Packet [HW]                Tailroom [Application]    Extra Space [Application]
122 <-----------------------><--------------------------><------------------------><----------------------->
124 Cppi_HostDesc->origBufferLen
125 <----------------------------------------------------------------------------->
126 Cppi_HostDesc->origBuffPtr
128 \/
129 |------------def_heap_buf_size-------------------------------------------------|--def_heap_extra_size--|
130 | def_flow_pkt_rx_offset| max Cppi_HostDesc->buffLen | def_heap_tailroom_size  |   Extra Size          |
131                         ^
132                         |
133                      Cppi_HostDesc->buffPtr
134 */
137 /**
138  * @ingroup cfg_constants
139  * @brief  This defines the handle to a NETCP configured Flow. A Flow is a set of pktlib heaps that h/w can use to obtain free packets.
140  */
141 typedef NETCP_CFG_FLOW_T* NETCP_CFG_FLOW_HANDLE_T;
143 /**
144  * @ingroup cfg_constants
145  * @def NETCP_DEFAULT_FLOW
146  * @brief This defines the default FLOW for NETCP to use.
147  * The default flow uses the default pktlib heap created by netapi_init; i.e.
148  * NETCP will allocate descriptors and buffers for received packets from this heap.
149  */
150 #define NETCP_DEFAULT_FLOW  (NETCP_CFG_FLOW_HANDLE_T) NULL
154 /**
155  * @ingroup cfg_constants
156  * @def NETCP_DEFAULT_ROUTE
157  * @brief This defines the NETCP default route.  This route has NETCP send received packets to the default NETCP 
158  * pktio channel using descriptors and buffers from the default flow. The default route is created by netapi_init
159  */
160 #define NETCP_DEFAULT_ROUTE (NETCP_CFG_ROUTE_HANDLE_T) NULL
163 /**
164  *  @ingroup cfg_constants
165  *  @{
166  *
167  *  @name   Valid Parameter configuration for NETCP_CFG_ROUTE_T
168  *  @brief  Valid Parameter configuration
169  *
170  *  @details Valid Parameter to configure optional parameters.
171  */
172 /* @{ */
173 /**
174  *  @def  NETCP_CFG_VALID_PARAM_ROUTE_TYPE
175  *        Valid Route Type configuration
176  *
177  */
179 #define NETCP_CFG_VALID_PARAM_ROUTE_TYPE        0x01
180 /*  @}  */
181 /** @} */
185 /**
186  *  @ingroup cfg_structures
187  *  @brief NETCP application defined route information.
188  *  @details This structure is used to define a packet receive route.  A route consists of a 
189  *           flow where to get free descriptors and buffers to hold the packet, and a destination 
190  *           queue where to place the packet. Priority routing based on VLAN priority bits,
191  *           DSCP/TOS, and received input port is supported. In the case
192  *           of priority based routing, the PASS will forward the matchd packeed to the desired
193  *           queue which is equal to the base queue plus an offset. This offset is sepcififed
194  *           by the VLAN prioirty or DSCP/TOS value, or received input port.
195  *
196  */
197 typedef struct NETCP_CFG_ROUTE_Tag
199     uint32_t            valid_params;       /**< Specifies which route config params
200                                                  are valid */
201     NETCP_CFG_FLOW_T    *p_flow;            /**< NULL or NETCP_DEFAULT_FLOW for default
202                                               *flow,@ref NETCP_CFG_FLOW_T
203                                               */
204     PKTIO_HANDLE_T      *p_dest_q;          /**< NULL for default destination queue */
206     nwalRouteType_t     routeType;          /**< Optional: Routing priority,
207                                               *  @see nwal.h for nwalRouteType_t
208                                               */
209    uint16_t             egress_swith_port;   /* learned swithc port #, from ale_table */
210 } NETCP_CFG_ROUTE_T;
213 /**
214  * @ingroup cfg_constants
215  * @brief  Handle to a NETCP route.
216  * @details Application to use this handle to identify a NETCP route. A NETCP route defines the
217  *          pktio channel for packets received by NETCP
218  *    and the flow to use.
219  */
220 typedef NETCP_CFG_ROUTE_T* NETCP_CFG_ROUTE_HANDLE_T;
225 /**
226  * @ingroup cfg_constants
227  * @def NETCP_CFG_ACTION_DISCARD
228  *      This defines the NETCP action to discard packet.
229  */
230 #define NETCP_CFG_ACTION_DISCARD NWAL_MATCH_ACTION_DISCARD
231 /**
232  * @ingroup cfg_constants
233  * @def  NETCP_CFG_ACTION_CONTINUE
234  *      This defines the NETCP action to pass packet ono the next classifier
235  */
236 #define NETCP_CFG_ACTION_CONTINUE NWAL_MATCH_ACTION_CONTINUE_NEXT_ROUTE
237 /**
238  * @ingroup cfg_constants
239  * @def NETCP_CFG_ACTION_TO_SW
240  *      This defines the NETCP action to pass packet to User space application
241  */
242 #define NETCP_CFG_ACTION_TO_SW    NWAL_MATCH_ACTION_HOST
244 /**
245  * @ingroup cfg_constants
246  * @def NETCP_CFG_ALL_EXCEPTIONS
247  *      This defines NETCP configuration for all Exepction Packets.
248  */
249 #define NETCP_CFG_ALL_EXCEPTIONS 0xff
251 /**
252  * @ingroup cfg_constants
253  * @brief General APP_ID Type definition.
254  */
255 typedef uint32_t NETCP_CFG_APP_ID_T;
258 /**
259  * @ingroup cfg_constants
260  * @brief  Handle to NETCP VLAN configuration (FUTURE).
261  * @details Application to use this handle to identify a VLAN configuration.
262  */
263 typedef void * NETCP_CFG_VLAN_T;
265 /**
266  * @ingroup cfg_constants
267  * @brief  NETCP PA LLD handle associated with an SA
268  * @details Application to use this handle to identify a PA PLLD handle associated with an SA.
269  */
270 typedef void * NETCP_CFG_PA_HANDLE_T;
272 /**
273  * @ingroup cfg_constants
274  * @brief  NETCP SA LLD handle associated with an SA
275  * @details Application to use this handle to identify a SA LLD handle associated with an SA.
276  */
277 typedef void * NETCP_CFG_SA_HANDLE_T;
279 /**
280  * @ingroup cfg_constants
281  * @brief  AppID for packets matching a  MAC interface rule
282  */
283 typedef uint32_t NETCP_CFG_MACIF_T;
285 /**
286  * @ingroup cfg_constants
287  * @brief AppID for packets matching an IP interface rule
288  */
289 typedef uint32_t NETCP_CFG_IP_T;
291 /**
292  * @ingroup cfg_constants
293  * @brief This define is used to identify the application id associated with a created SA (IPSEC security association) rule
294  */
295 typedef uint32_t NETCP_CFG_SA_T;
298 /**
299  * @ingroup cfg_constants
300  * @brief AppId for packets matching an NETCP IPSEC policy rule
301  */
302 typedef uint32_t NETCP_CFG_IPSEC_POLICY_T;
306 /**
307  * @ingroup cfg_constants
308  * @brief  AppID for packets being classified as  type exception.
309  */
310 typedef uint32_t NETCP_CFG_EXCEPTION_PKT_T;
312 /**
313  * @ingroup cfg_constants
314  *@brief This define is to be used in AddIp, AddClassifier, addSA, etc. to indicate that the rule can be bound to any MAC address.
315  */
316 #define NETCP_CFG_NO_INTERFACE 0xff
320 /**
321  * @note  APPIDs are present in RX packet meta data and tell "how far" the packet got
322  * through the classification rules of NETCP. 
323  * APPID is 32 bits:
324  * bits 31-24 = NETAPI_NETCP_MATCH_STAGE
325  * bits 23-8  = NETAPI_NETCP_MATCH_ID identifier 
326  * bits  7-0  = NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE logical mac interface
327 */
329 #define NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT 0 
330 #define NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK 0xFF
332 #define NETAPI_NETCP_MATCH_ID_SHIFT 8 
333 #define NETAPI_NETCP_MATCH_ID_MASK 0xFFFF
335 #define NETAPI_NETCP_MATCH_STAGE_SHIFT 24
336 #define NETAPI_NETCP_MATCH_STAGE_MASK 0xFF
339 /**
340  * @brief Helper function to get match stage associated with application ID.
341  */
342 #define netapi_cfgGetMatchStage(appid)  (((appid) >> NETAPI_NETCP_MATCH_STAGE_SHIFT) & NETAPI_NETCP_MATCH_STAGE_MASK)
344 /**
345  * @brief Helper function to get match id associated with application ID.
346  */
347 #define netapi_cfgGetMatchId(appid) (((appid) >> NETAPI_NETCP_MATCH_ID_SHIFT) & NETAPI_NETCP_MATCH_ID_MASK)
349 /**
350  * @brief Helper function to get logical match interface associated with application ID.
351  */
352 #define netapi_cfgGetMatchLogicalMacIface(appid) (((appid) >> NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT) & \
353                                                     NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK)
356 /**
357  * @ingroup cfg_constants
358  * @def NETAPI_NETCP_MATCH_GENERIC_MAC
359  *      This define is used for an APPID that indicates that a packet matched a MAC entry.
360  *      Logical MAC interface location:
361  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
362  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
363  *      Packet did not match any other rule.
364  */
365 #define NETAPI_NETCP_MATCH_GENERIC_MAC  0x10000000
367 /**
368  * @ingroup cfg_constants
369  * @def NETAPI_NETCP_MATCH_GENERIC_IP
370  *      This define is used for an APPID that indicates that a packet matched a MAC entry.
371  *      Logical MAC interface location:
372  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
373  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
374  *       IP rule number for this interface location:
375  *          Refer to NETAPI_NETCP_MATCH_ID_SHIFT and 
376  *          NETAPI_NETCP_MATCH_ID_MASK.
377  *      Packet also matched a generic IP rule attached to that interface.
378  *      Packet did not match any other rule.
379  */
380 #define NETAPI_NETCP_MATCH_GENERIC_IP   0x20000000
382 /**
383  * @ingroup cfg_constants
384  * @def NETAPI_NETCP_MATCH_CLASS
385  *      This define is used for an APPID that indicates that a packet matched a MAC entry.
386  *      Logical MAC interface location:
387  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
388  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
389  *      Classifer ID location:
390  *          Refer to NETAPI_NETCP_MATCH_ID_SHIFT and 
391  *          NETAPI_NETCP_MATCH_ID_MASK.
392  *      Packet also matched a generic IP rule attached to 
393  *      that interface OR a general IP rule added as part of the classifier or it matched a combination
394  *      of ISPEC SA rule and a policy check.  In addition, packet matched a L4 port rule that was added 
395  *      as part of a classifer. Packet did not match any other rule.
396  */
397 #define NETAPI_NETCP_MATCH_CLASS        0x80000000
399 /**
400  * @ingroup cfg_constants
401  * @def NETAPI_NETCP_MATCH_CLASS_L3
402  *      This define is used for an APPID that indicates that a  packet matched a MAC entry.
403  *      Logical MAC interface location:
404  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
405  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
406  *      Packet also  matched a general IP rule added as part 
407  *      of a classifier.  But it not match a L4 port or any other rule. 
408  *      We cannot determine what classifer partially matched so Bytes 3-2 are not applicable
409  */
410 #define NETAPI_NETCP_MATCH_CLASS_L3     0x40000000
412 /**
413  * @ingroup cfg_constants
414  * @def NETAPI_NETCP_MATCH_IPSEC
415  *      This define is used for an APPID that indicates that a packet matched a MAC entry.
416  *      Logical MAC interface location:
417  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
418  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
419  *      SA ID location:
420  *          Refer to NETAPI_NETCP_MATCH_ID_SHIFT and 
421  *          NETAPI_NETCP_MATCH_ID_MASK.
422  *      Packet also matched an IPSEC SA  rule (matched proto, destination ip and SPI).  
423  *      Packet did not match any other rule (so may have failed a policy check)
424  */
425 #define NETAPI_NETCP_MATCH_IPSEC        0x01000000  
428 /**
429  * @ingroup cfg_constants
430  * @def NETAPI_NETCP_MATCH_IPSEC_POLICY
431  *      This define is used for an APPID that indicates that a packet matched a MAC entry
432  *      Logical MAC interface location:
433  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
434  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
435  *      Packet also matched an IPSEC SA rule (matched proto, 
436  *      dest ip and SPI).  Packet also matched a POLICY RULE (this is a check of the inner IP).
437  *      IPSEC RX Policy ID location:
438  *          Refer to NETAPI_NETCP_MATCH_ID_SHIFT and 
439  *          NETAPI_NETCP_MATCH_ID_MASK.
440  *      Packet did not match any other rule 
441  */
442 #define NETAPI_NETCP_MATCH_IPSEC_POLICY 0x02000000  //lower byte==interface, Or' in SA id (16 bits)
444 /**
445  * @ingroup cfg_constants
446  * @def NETAPI_NETCP_CFG_MATCH_EXCEPTION
447  *      This define is used for an APPID that indicates that a packet is of type exception. 
448  *      Actual exception id is in byte 0 of APPID.
449  */
450 #define NETAPI_NETCP_CFG_MATCH_EXCEPTION     0x08000000
454 /**
455  *  @ingroup cfg_structures
456  *  @brief NETCP flow configuration information.
457  *  @details This structure is used to define key parameters for the receive flow to be created.
458  *           These include the flow index to use (or can be left un-specified), the dma_index
459  *           (specifying out of which CPPI DMA engine the flow should be allocated),
460  *           the receive offset (the byte offset into each buffer where received data should be placed),
461  *           and the drop policy for the DMA channel to use if there is no free buffer available (drop or block)
462  *
463  */
464 typedef struct NETCP_CFG_FLOW_CONFIG_Tag
466    int              flow_index;     /**< flow index to use or NETAPI_NETCP_FLOW_INDEX_ANY */
467 /**
468  * @def NETAPI_NETCP_FLOW_INDEX_ANY
469  * @ingroup cfg_constants
470  *      This define is used to let NETAPI pick the flow index to use(for flow_index field)
471  */
472 #define NETAPI_NETCP_FLOW_INDEX_ANY  CPPI_PARAM_NOT_SPECIFIED
474    int              dma_index;      /**< allocate flow out of which DMA */
475 /**
476  * @def NETAPI_DMA_INFRASTRUCTURE
477  * @ingroup cfg_constants
478  *      This define is used specify a flow in the QMSS CPPI DMA (for dma_index field)
479  */
480 #define NETAPI_DMA_INFRASTRUCTURE 0
481 /**
482  * @def NETAPI_DMA_NETCP
483  * @ingroup cfg_constants
484  *      This define us usee specify a flow in the NETCP CPPI DMA (for dma_index field)
485  */
486 #define NETAPI_DMA_NETCP 1
488    int              recv_offset;    /**< start of packet offset */
490    int              block;          /**< TRUE => DMA will wait for free descriptor if heap(s) are empty.
491                                          FALSE => DMA will discard */
492 /**
493  * @def NETAPI_FLOW_DROP
494  * @ingroup cfg_constants
495  *      This define is used to indicate that the flow should institute a Block policy.
496  *      This means that the DMA should wait for a free descriptor/buffer to come available if
497  *      the free poll is empty (for the block field)
498  */
499 #define NETAPI_FLOW_BLOCK 1
500 /**
501  * @def NETAPI_FLOW_DROP
502  * @ingroup cfg_constants
503  *      This define us used to indicate that the flow should institute a Drop policy.
504  *      This means that the DMA should NOT wait for a free descriptor/buffer to come available
505  *      if the free poll is empty. The transfer will be aborted and the data will dropped (for block field)
506  */
507 #define NETAPI_FLOW_DROP 0
509    PKTIO_HANDLE_T * p_dest_q;       /**<destination queue for this flow (may be overwrritten by source DMA) */
510 } NETCP_CFG_FLOW_CONFIG_T;
512  /**
513  *  @ingroup cfg_structures
514  * @brief
515  *  The structure contains the NETAPI Physical Memory Address Device configuration for
516  *  QMSS and PASS Perihperals.
517  *
518  * @details
519  *  The structure contains the NETAPI Physical Memory Address Device configuration for
520  *  QMSS and PASS Perihperals.
521  */
522 typedef struct NETCP_CFG_GLOB_DEVICE_PARAMS_Tag
524     int         fNssGen2;           /**< 1: NSS Gen2 device */
525     uint32_t    cslNetCpCfgRegs;    /**< Base address of NETCP configuration Registers */
526     uint32_t    cslQmssCfgBase;     /**< Base address of QMSS configuration Registers */
527     uint32_t    cslQmssDataBase;    /**< Base address of QMSS Data Registers */
528     uint32_t    cslNetCpCfgSaCfgRegs;/**< Base address of SA configuration Registers */
530 } NETCP_CFG_GLOB_DEVICE_PARAMS_T;
535 /**
536  *  @ingroup cfg_functions
537  *  @brief netapi_netcpCfgAddFlow   API to add a flow
538  * 
539  *  @details This api is used to add a flow
540  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
541  *  @param[in]  n    number of Pktlib_HeapHandle
542  *  @param[in]  handles[]   Handles to Pktlib_HeapHandle
543  *  @param[in]  sizes[]     must be <= heap corresponding heap size-recv_offset-any desired tail room
544  *  @param[in]  p_cfg   @ref NETCP_CFG_FLOW_CONFIG_T
545  *  @param[out] err     pointer to error return
546  *  @retval     NETCP flow handle, @ref NETCP_CFG_FLOW_HANDLE_T
547  *  @pre       @ref netapi_init
548  */
549 NETCP_CFG_FLOW_HANDLE_T netapi_netcpCfgAddFlow(NETAPI_T h,
550                                             int n, 
551                                             Pktlib_HeapHandle handles[],
552                                             int sizes[],
553                                             NETCP_CFG_FLOW_CONFIG_T * p_cfg,
554                                             int * err );
556 /**
557  *  @ingroup cfg_functions
558  *  @brief netapi_netcpCfgDelFlow   API to delete a flow
559  * 
560  *  @details This api is used to delete a flow.
561  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
562  *  @param[in]  p    handle to NETCP  flow
563  *  @param[out] err     pointer to error return
564  *  @retval     none
565  *  @pre       @ref netapi_init, netapi_netcpCfgAddFlow
566  */
567 void netapi_netcpCfgDelFlow(NETAPI_T h ,
568                                             NETCP_CFG_FLOW_HANDLE_T p ,
569                                             int * err);
571 /**
572  *  @ingroup cfg_functions
573  *  @brief  API attaches an IP address and qualifier to a MAC interface
574  * 
575  *  @details This api is used to add an IP address to a MAC interface along
576  *            with optional IP qualifier. A route, @ref NETCP_CFG_ROUTE_HANDLE_T,or NULL for default 
577  *            may be specified to indicate where to send packets matching the MAC interface MAC address, the
578  *            supplied IP address and any qualifier.  This API adds a rule to the NETCP level 1 lookup tables.
579  *            Packets arriving that match this rule are identified in meta data with Appid=  NETAPI_NETCP_MATCH_GENERIC_IP
580  *            Note: An IP address must be attached to enable NETCP receive Checksum offload feature
581  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
582  *  @param[in]  iface_no    interface number (0,1,..)
583  *  @param[in]  ipType  type of IP address (V4 for V6)
584  *  @param[in]  ip_addr destination or local
585  *  @param[in]  ip_rem_addr source or remote
586  *  @param[in]  ip_qualifiers   ip_qualifiers (all 0 for no qualifiers). This can be used to apply special handling for
587  *                              diffserv category for example.
588  *  @param[in]  route       handle of a created route or NULL to use internal default route, @ref NETCP_CFG_ROUTE_HANDLE_T
589  *  @param[in]  user_data     Optional: pointer to user provided data associated with IP
590  *  @param[in]  ip_addr remote
591  *  @param[out] err     pointer to error return
592  
593  *  @retval     returned AppID for attached rule. This is returned in RX meta data for packets matching this rule and no other, @ref NETCP_CFG_IP_T
594  *  @pre       @ref netapi_init
595  */
596 NETCP_CFG_IP_T  netapi_netcpCfgAddIp(NETAPI_T                   h,
597                                      int                        iface_no,
598                                      nwal_IpType                ipType,
599                                      nwalIpAddr_t*              ip_addr,
600                                      nwalIpAddr_t*              ip_rem_addr,
601                                      nwalIpOpt_t*               ip_qualifiers,
602                                      NETCP_CFG_ROUTE_HANDLE_T   route,
603                                      void*                      user_data,
604                                      int*                       err);
606 /**
607  *  @ingroup cfg_functions
608  *  @brief netapi_netcpCfgDelIp   API to delete IP interface
609  * 
610  *  @details This api is used to delete an IP interface
611  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
612  *  @param[in]  iface_no    interface number (0,1,..)
613  *  @param[in]  ipType  type of IP address (V4 for V6)
614  *  @param[in]  ip_addr      ip_address
615  *  @param[in]  ip_qualifiers   ip_qualifiers (all 0 for no qualifiers). This can be used to apply special handling for
616  *                  diffserv category for example.
617  *  @param[in]  ip_rule_id      @ref NETCP_CFG_IP_T
618  *  @param[out] err     pointer to error return
619  *  @retval     returned AppID for attached rule. This is returned in RX meta data for packets matching this rule and no other, @ref NETCP_CFG_IP_T
620  *  @pre       @ref netapi_init , @ref netapi_netcpCfgAddIp
621  */
622 void netapi_netcpCfgDelIp(NETAPI_T          h, 
623                           int               iface_no,
624                           nwal_IpType       ipType,
625                           nwalIpAddr_t*     ip_addr,
626                           nwalIpOpt_t*      ip_qualifiers, 
627                           NETCP_CFG_IP_T    ip_rule_id,
628                           int*              err);
630 /**
631  *  @ingroup cfg_functions
632  *  @brief netapi_netcpCfgCreateMacInterface  API to insert a MAC interface rule in the NETCP hardware
633  *  lookup engines.
634  * 
635  *  @details This api is used to insert a MAC interface in the NETCP hardware lookup engines.
636  *      Once it is created, the MAC interface can be used to receive packets. The API
637  *      adds a rule to the NETCP 1st level lookup tables to route all packets with destination
638  *      MAC matching supplied argument and not matching any other lookup entry (see @ref netapi_netcpCfgAddIp) to
639  *      the supplied route, @ref NETCP_CFG_ROUTE_T, (or default route).
640  *      Packets arriving that match this rule are identified in meta data with Appid=  NETAPI_NETCP_MATCH_GENERIC_MAC
641  *      Note: The internal SOC switch (if operating in full swithc mode) may need to  be "taught" that this mac
642  *      address is present by transmitting a packet with destination mac = this interface mac address.
643  *  @param[in]  h   NETAPI instance handle, @ref NETAPI_T
644  *  @param[in]  p_mac   pointer to 6 byte MAC address for local interface
645  *  @param[in]  p_mac_remote   pointer to 6 byte MAC address for remote interface
646  *  @param[in]  iface_no    interface number (0,1,..) 
647  *  @param[in]  switch_port     (0 don't care, 1 switch port 1, 1 switch port 2) [only 0 supported currenly] 
648  *  @param[in]  route   handle of a created route or NULL to use internal default route, @ref NETCP_CFG_ROUTE_HANDLE_T
649  *  @param[in]  vlan    [future[ vlan configuration . Set to NULL, @ref NETCP_CFG_VLAN_T
650  *  @param[in]  etherType  Ethertype field.
652  *  @param[in]  state   [future] interface state (0=down, 1= up)
653  *  @param[out] err     pointer to error return
654  *  @retval     returns AppID for interface (this is returned in meta data for received packets matching this rule an no others, @ref NETCP_CFG_MACIF_T
655  *  @pre       @ref netapi_init 
656  */
657 NETCP_CFG_MACIF_T  netapi_netcpCfgCreateMacInterface(NETAPI_T                   h,
658                                                      uint8_t*                   p_mac,
659                                                      uint8_t*                   p_mac_remote,
660                                                      int                        iface_no,
661                                                      int                        switch_port,
662                                                      NETCP_CFG_ROUTE_HANDLE_T   route,
663                                                      NETCP_CFG_VLAN_T           vlan,
664                                                      uint16_t                   etherType,
665                                                      int                        state,
666                                                      int *                      err);
668 /**
669  *  @ingroup cfg_functions
670  *  @brief netapi_netcpCfgDelMac   API to delete MAC  interface
671  * 
672  *  @details This api is used to delete a MAC interface
673  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
674  *  @param[in]  iface_no    interface number (0,1,..)
675  *  @param[out] err     pointer to error return
676  *  @retval     returned AppID for attached rule. This is returned in RX meta data for packets matching this rule and no other, @ref NETCP_CFG_IP_T
677  *  @pre       @ref netapi_init , @ref netapi_netcpCfgCreateMacInterface 
678  */
679 void netapi_netcpCfgDelMac(NETAPI_T     h,
680                            int          iface_no,
681                            int*         err);
684 /**
685  * @brief This defines handle to installed classifier returned by API.  Pkts matching this classifier will have meta data with this tag.
686  *  Also used to delete classifier
687  */
688 typedef uint32_t NETCP_CFG_CLASS_T;
691 /**
692  *  @ingroup cfg_structures
693  *  @brief NETAPI Class L4 Configuration
694  *
695  *  @details This structure contains Classifier L4 Configuration. In this type of classifier, the  L2 and L3 header match criteria are implied by the iface and ip entries.  L4 packet match criteria are defined by the proto and appProto fields ( L4 protocol id and ports)
696  */
697 typedef struct NETCP_CFG_CLASS_L4_Tag
699     int                 iface;      /**< Indicates which MAC interface packet should be received on*/
700     NETCP_CFG_IP_T      ip;         /**< IP rule to match: see @ref NETCP_CFG_IP_T */
701     nwal_appProtoType_t proto;      /**< L4 proto (-1 for don't care)*/
702     nwalAppProto_t      appProto;   /**< L4 Ports or equivalent */
704 } NETCP_CFG_CLASS_L4_T;
707 /**
708  *  @ingroup cfg_structures
709  *  @brief NETAPI Classifier L4 plus IPSEC policy configuration
710  *
711  *  @details This structure contains Classifier L4 plus IPSEC policy configuration. In this type of classifier, the  L2,L3 header match criteria are implied by the iface and ip_policy fields. The L4 match criteria are implied by the proto and appProto fields. 
712  */
713 //classifier L4 + policy  (L2, L3 (outer), tunnel, L3 (inner)  implied by policy
714 typedef struct NETCP_CFG_CLASS_L4_IPSEC_Tag
716     int                       iface;      /**< Indicates which MAC interface packet should be received from */
717     NETCP_CFG_IPSEC_POLICY_T  ip_policy;  /**< IPSEC policy configuration. see @ref NETCP_CFG_IPSEC_POLICY_T */
718     nwal_appProtoType_t       proto;      /**< L4 proto (-1 for don't care)*/
719     nwalAppProto_t            appProto;   /**< L4 Ports or equivalent */
721 } NETCP_CFG_CLASS_L4_IPSEC_T;
725 /**
726  *  @ingroup cfg_structures
727  *  @brief NETAPI Classifier L4/L3 configuration
728  *
729  *  @details This structure contains Class L4 + L3 Classifier configuration. In this type of classifier the L2 header match criteria is implied by the iface field.  The L3 header match criteria is implied by the ipType, ip_addr and ip_qulaifier fields.  L4 match criteris is implied by the proto and appProto fields.  A failed route can be optionally included to tell NETCP what to do if the L3 portion of the classifier matches but not the L4 portion.
730  */
731 typedef struct NETCP_CFG_CLASS_L3_L4_Tag
733     int                         iface;          /**< Indicates which MAC interface packet is from */
734     nwal_IpType                 ipType;         /**< IP address type, IPV4 or IPV6 */
735     nwalIpAddr_t*               ip_addr;        /**< IP address to match */
736     nwalIpOpt_t*                ip_qualifiers;  /**< IP address qualifiers */
737     NETCP_CFG_ROUTE_HANDLE_T    p_fail_route;   /**< What to do if L3 matches but L4 fails AND L3 is a 
738                                                      new rule.(if exisitng rule, then existing fail
739                                                      route will be used). */
740     nwal_appProtoType_t         proto;          /**< L4 proto (-1 for don't care)*/
741     nwalAppProto_t              appProto;       /**< Ports or equivalent */
742 } NETCP_CFG_CLASS_L3_L4_T;
744 /**
745  *  @ingroup cfg_structures
746  *  @brief NETAPI Classifier configuration
747  *
748  *  @details This structure contains the NETAPI classifer configuration.  This is a union of the different classifier types above
749  */
750 typedef struct NETCP_CFG_CLASSIFIER_Tag
753 /**
754  * Classifer type which can be set to one of the following defines:
755  * <br>
756  *      @ref NETCP_CFG_CLASS_TYPE_L4 , @ref NETCP_CFG_CLASS_TYPE_L3_L4, _
757  */
758     int classType;
760 /**
761  * @def NETCP_CFG_CLASS_TYPE_L4
762  * @ingroup cfg_constants
763  *      This defines classifier type to be Class L4. Class L4 classifiers specifiy the L4 protocol information of the packets to matched;  the L2,L3 portions of the classifier are implied by supplied handles from the mac interface create and IP Add APIs
764  */
765 #define NETCP_CFG_CLASS_TYPE_L4  0
767 /**
768  * @def NETCP_CFG_CLASS_TYPE_L3_L4
769  * @ingroup cfg_constants
770  *      This defines classifier type to be Class L4/L3 .  Class L3_L4 classifiers specify both the IP address (L3) and the L4 protocol information of the packets to be matched.
771  */
772 #define NETCP_CFG_CLASS_TYPE_L3_L4  1
774      union
775     {
776         NETCP_CFG_CLASS_L3_L4_T     c_l3_l4;    /**< @ref NETCP_CFG_CLASS_L3_L4_T */
777         NETCP_CFG_CLASS_L4_T        c_l4;       /**< @ref NETCP_CFG_CLASS_L4_T */
778         NETCP_CFG_CLASS_L4_IPSEC_T  c_l4_ipsec; /**< @ref NETCP_CFG_CLASS_L4_IPSEC_T */
779     } u;                                        /**< union for classifier type configuration structure */
780 } NETCP_CFG_CLASSIFIER_T;
784 /**
785  *  @ingroup cfg_functions
786  *  @brief netapi_netcpCfgAddClass   API to attach a classifier rule to NETCP.
787  *      This can be used to route a particular packet flow to a specific PKTIO channel
788  * 
789  *  @details This api can be used to route a particular packet flow to a particular PktIO channel, using a specific 
790  *  pktLib heap, and/or have NetCP attach a tag (classifier id) to the incoming packet.
791  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
792  *  @param[in]  p_class definition of the classifier
793  *  @param[in]  p_route handle to NETCP route.
794  *  @param[in]  action       what to do with packet: one of NETCP_CFG_ACTION_TO_SW, DISCARD or CONTINUE
795  *  @param[in]  user_data     Optional: pointer to user provided data associated with SA
796  *  @param[out] err     pointer to error return
797  *  @retval     returned AppID for attached rule. This is returned in RX meta data for packets matching this rule and no other, @ref NETCP_CFG_IP_T
798  *  @pre       @ref netapi_init
799  */NETCP_CFG_CLASS_T netapi_netcpCfgAddClass(NETAPI_T                   h,
800                                              NETCP_CFG_CLASSIFIER_T*    p_class,
801                                              NETCP_CFG_ROUTE_HANDLE_T   p_route,
802                                              int                        action,
803                                              void*                      user_data,
804                                              int*                       err);
808 /**
809  *  @ingroup cfg_functions
810  *  @brief netapi_netcpCfgDelClass   API to delete a preconfigured classifier
811  * 
812  *  @details This API can be used to delete a preconfigured classifier
813  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
814  *  @param[in]  classId
815  *  @param[out] err     pointer to error return
816  *  @retval     none
817  *  @pre       @ref netapi_init, @ref netapi_netcpCfgAddClass
818  */
819 void netapi_netcpCfgDelClass(NETAPI_T           h,
820                              NETCP_CFG_CLASS_T  classId,
821                              int*               err);
824 /**
825  *  @ingroup netapi_cb_functions
826  *  @brief NETCP_CFG_STATS_CB   Callback function that is used to return statistics from NETCP
827  * 
828  *  @details The application provides a callback function that NETAPI  uses to report statistics.
829  *  The request for stats is generated from the @ref netapi_netcpCfgReqStats API.
830  *  Note: to receive this stats callback, the @ref netapi_netcpPoll function must be called
831  *  @param[in]  h   NETAPI instance handle, @ref NETAPI_T
832  *  @param[out]  pPaStats    the PA (NETCP packet accelerator subsystem) statistics block 
833  *  @retval     none 
834  *  @pre       @ref netapi_init , @ref netapi_netcpCfgReqStats, @ref netapi_netcpPoll
835  */
836 typedef void (*NETCP_CFG_STATS_CB)(NETAPI_T      h,
837                                    paSysStats_t* pPaStats);
839 /**
840  *  @ingroup cfg_functions
841  *  @brief netapi_netcpCfgReqStats   API to request statistics from NETCP
842  * 
843  *  @details This api is used to request a statistics from NETCP.  This will generate a stats request
844  *  command to NETCP. Sometime later, the statistics result will arrive and will be passed to 
845  *  the caller via the asynchronus callback @ref NETCP_CFG_STATS_CB that is registered in this call.
846  *  Note: to receive the stats callback, the @ref netapi_netcpPoll funcition must be called
847  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
848  *  @param[in]  cb   the callback function to invoke with the resulting statistics block, @ref NETCP_CFG_STATS_CB
849  *  @param[in]  doClear     clear the stats in NETCP after the report (0=no, 1=yes) 
850  *  @param[out] err     pointer to error return
851  *  @retval     none 
852  *  @pre       @ref netapi_init 
853  */
854 void netapi_netcpCfgReqStats(NETAPI_T               h,
855                              NETCP_CFG_STATS_CB     cb,
856                              int                    doClear,
857                              int*                   err);
860 /**
861  *  @ingroup cfg_functions
862  *  @brief netapi_netcpCfgExceptions    API to configure NETCP with global rules for exception packet handling
863  *
864  *  @details This api is used to configure NETCP with global rules of how to handle exception packets specified by exception_id.
865  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
866  *  @param[in]  exception_id id of the exception packet, refer to pa.h,.pa_EROUTE_XXX for list of exception packet id's
867  *  @param[in]  p_route handle to NETCP route.
868  *  @param[in]  action, action for NETCP to take upon classifying packet as type exception, refer to nwal. nwal_matchAction_t
869  *  @retval returns app_id, @ref NETCP_CFG_EXCEPTION_PKT_T
870  *  @pre       @ref netapi_init 
871  */
872 NETCP_CFG_EXCEPTION_PKT_T netapi_netcpCfgExceptions(NETAPI_T                    h,
873                                                     int                         exception_id ,
874                                                     nwal_matchAction_t          action,
875                                                     NETCP_CFG_ROUTE_HANDLE_T    p_route);
878 #ifdef __cplusplus
880 #endif
881 #endif