f59ace322d7a5a1b2980f44c546084430f72bd6a
[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 #include "netapi.h"
55 /**
56  *  @ingroup cfg_structures
57  *  @brief NETCP Flow ID configuaration informaation
58  *  @details A flow defines a set of free queues (pktlib heap) for hardware to use to get
59  *          free packet descriptor(s) and buffer(s) to use when receiving a packet. CPPI flow ID for
60  *          default case, use NETCP_DEFAULT_FLOW
61  */
62 typedef struct NETCP_CFG_FLOW_Tag
63 {
64     int flowid;         /**< flow id*/
65     int dma_engine;     /**< dma engine (QMSS, NETCP)*/
66 } NETCP_CFG_FLOW_T;
69 /**
70  *  @ingroup cfg_structures
71  *  @brief NETAPI configuration information
72  *
73  *  @details The parameters in this structure are used to configure NETAPI.
74  */
75 typedef struct NETAPI_CFG_Tag
76 {
77  int def_mem_size;                  /**<  Bytes of CMA memory we have allocated */
78  int def_flow_pkt_rx_offset;        /**<  Offset in pkt buffer for hw to start RX */
79  int def_max_descriptors;           /**<  Number of descriptors in system  (must be power of 2), 2^14 max */
80  int def_tot_descriptors_for_us;    /**<  Number of descriptors to create in our region (must be power of 2)*/
81  int def_heap_n_descriptors;        /**<  Number of descriptor plus buffers in default heap*/
82  int def_heap_n_zdescriptors;       /**<  Number of zero len descriptors in defaut heap*/
83  int def_heap_buf_size;             /**<  Size of buffers in default heap, max amount of area for packet data */
84  int def_heap_tailroom_size;        /**<  Size of tailroom in reserve */
85  int def_heap_extra_size;           /**<  Size of extra space at end of buffer */ 
86 }  NETAPI_CFG_T;
88 /* @note:
89    each buffer will be allocated:  def_heap_buf_size+def_heap_extra_size bytes
90    each descriptor attached to these buffers will have rigBufferLen of:
91       def_heap_buf_size.
92    for default RX flow,  for rx packet, the bufptr  will be def_flow_pkt_rx_offset.
93    for detault RX flow,  threshold (ie max # of bytes in buffer) will be:
94        def_heap_buf_size - def_heap_tailroom_size-def_flow_pkt_rx_offset
97  RX Packet from NetCP
99 Headroom [Application]     Packet [HW]                Tailroom [Application]    Extra Space [Application]
100 <-----------------------><--------------------------><------------------------><----------------------->
102 Cppi_HostDesc->origBufferLen
103 <----------------------------------------------------------------------------->
104 Cppi_HostDesc->origBuffPtr
106 \/
107 |------------def_heap_buf_size-------------------------------------------------|--def_heap_extra_size--|
108 | def_flow_pkt_rx_offset| max Cppi_HostDesc->buffLen | def_heap_tailroom_size  |   Extra Size          |
109                         ^
110                         |
111                      Cppi_HostDesc->buffPtr
112 */
115 /**
116  * @ingroup cfg_constants
117  * @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.
118  */
119 typedef NETCP_CFG_FLOW_T* NETCP_CFG_FLOW_HANDLE_T;
121 /**
122  * @ingroup cfg_constants
123  * @def NETCP_DEFAULT_FLOW
124  * @brief This defines the default FLOW for NETCP to use.
125  * The default flow uses the default pktlib heap created by netapi_init; i.e.
126  * NETCP will allocate descriptors and buffers for received packets from this heap.
127  */
128 #define NETCP_DEFAULT_FLOW  (NETCP_CFG_FLOW_HANDLE_T) NULL
132 /**
133  * @def NETCP_DEFAULT_ROUTE
134  * This defines the NETCP default route.  This route has NETCP send received packets to the default NETCP 
135  * pktio channel using descriptors and buffers from the default flow. The default route is created by netapi_init
136  */
137 #define NETCP_DEFAULT_ROUTE (NETCP_CFG_ROUTE_HANDLE_T) NULL
140 /**
141  *  @ingroup cfg_structures
142  *  @brief NETCP application defined route information.
143  *  @details This structure is used to define a packet receive route.  A route consists of a 
144  *           flow where to get free descriptors and buffers to hold the packet, and a destination 
145  *           queue where to place the packet.
146  *
147  */
148 typedef struct NETCP_CFG_ROUTE_Tag
150    NETCP_CFG_FLOW_T* p_flow;   /**< NULL or NETCP_DEFAULT_FLOW for default flow, @ref NETCP_CFG_FLOW_T */
151    PKTIO_HANDLE_T*   p_dest_q;   /**<NULL for default destination queue */
152 } NETCP_CFG_ROUTE_T;
155 /**
156  * @ingroup cfg_constants
157  * @brief  Handle to a NETCP route.
158  * @details Application to use this handle to identify a NETCP route. A NETCP route defines the
159  *          pktio channel for packets received by NETCP
160  *    and the flow to use.
161  */
162 typedef NETCP_CFG_ROUTE_T* NETCP_CFG_ROUTE_HANDLE_T;
167 /**
168  * @ingroup cfg_constants
169  * @def NETCP_CFG_ACTION_DISCARD
170  *      This defines the NETCP action to discard packet.
171  */
172 #define NETCP_CFG_ACTION_DISCARD NWAL_MATCH_ACTION_DISCARD
173 /**
174  * @ingroup cfg_constants
175  * @def  NETCP_CFG_ACTION_CONTINUE
176  *      This defines the NETCP action to pass packet ono the next classifier
177  */
178 #define NETCP_CFG_ACTION_CONTINUE NWAL_MATCH_ACTION_CONTINUE_NEXT_ROUTE
179 /**
180  * @ingroup cfg_constants
181  * @def NETCP_CFG_ACTION_TO_SW
182  *      This defines the NETCP action to pass packet to User space application
183  */
184 #define NETCP_CFG_ACTION_TO_SW    NWAL_MATCH_ACTION_HOST
186 /**
187  * @ingroup cfg_constants
188  * @def NETCP_CFG_ALL_EXCEPTIONS
189  *      This defines NETCP configuration for all Exepction Packets.
190  */
191 #define NETCP_CFG_ALL_EXCEPTIONS 0xff
196 /**
197  * @ingroup cfg_constants
198  * @brief  Handle to NETCP VLAN configuration (FUTURE).
199  * @details Application to use this handle to identify a VLAN configuration.
200  */
201 typedef void * NETCP_CFG_VLAN_T;
203 /**
204  * @ingroup cfg_constants
205  * @brief  AppID for packets matching a  MAC interface rule
206  */
207 typedef uint32_t NETCP_CFG_MACIF_T;
209 /**
210  * @ingroup cfg_constants
211  * @brief AppID for packets matching an IP interface rule
212  */
213 typedef uint32_t NETCP_CFG_IP_T;
215 /**
216  * @ingroup cfg_constants
217  * @brief This define is used to identify the application id associated with a created SA (IPSEC security association) rule
218  */
219 typedef uint32_t NETCP_CFG_SA_T;
222 /**
223  * @ingroup cfg_constants
224  * @brief AppId for packets matching an NETCP IPSEC policy rule
225  */
226 typedef uint32_t NETCP_CFG_IPSEC_POLICY_T;
230 /**
231  * @ingroup cfg_constants
232  * @brief  AppID for packets being classified as  type exception.
233  */
234 typedef uint32_t NETCP_CFG_EXCEPTION_PKT_T;
236 /**
237  * @ingroup cfg_constants
238  *@brief This define is to be used in AddIp, AddClassifier, addSA, etc. to indicate that the rule can be bound to any MAC address.
239  */
240 #define NETCP_CFG_NO_INTERFACE 0xff
244 /**
245  * @note  APPIDs are present in RX packet meta data and tell "how far" the packet got
246  * through the classification rules of NETCP. 
247  * APPID is 32 bits:
248  * bits 31-24 = NETAPI_NETCP_MATCH_STAGE
249  * bits 23-8  = NETAPI_NETCP_MATCH_ID identifier 
250  * bits  7-0  = NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE logical mac interface
251 */
253 #define NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT 0 
254 #define NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK 0xFF
256 #define NETAPI_NETCP_MATCH_ID_SHIFT 8 
257 #define NETAPI_NETCP_MATCH_ID_MASK 0xFFFF
259 #define NETAPI_NETCP_MATCH_STAGE_SHIFT 24
260 #define NETAPI_NETCP_MATCH_STAGE_MASK 0xFF
263 /**
264  * @brief Helper function to get match stage associated with application ID.
265  */
266 #define netapi_cfgGetMatchStage(appid)  (((appid) >> NETAPI_NETCP_MATCH_STAGE_SHIFT) & NETAPI_NETCP_MATCH_STAGE_MASK)
268 /**
269  * @brief Helper function to get match id associated with application ID.
270  */
271 #define netapi_cfgGetMatchId(appid) (((appid) >> NETAPI_NETCP_MATCH_ID_SHIFT) & NETAPI_NETCP_MATCH_ID_MASK)
273 /**
274  * @brief Helper function to get logical match interface associated with application ID.
275  */
276 #define netapi_cfgGetMatchLogicalMacIface(appid) (((appid) >> NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT) & \
277                                                     NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK)
280 /**
281  * @ingroup cfg_constants
282  * @def NETAPI_NETCP_MATCH_GENERIC_MAC
283  *      This define is used for an APPID that indicates that a packet matched a MAC entry.
284  *      Logical MAC interface location:
285  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
286  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
287  *      Packet did not match any other rule.
288  */
289 #define NETAPI_NETCP_MATCH_GENERIC_MAC  0x10000000
291 /**
292  * @ingroup cfg_constants
293  * @def NETAPI_NETCP_MATCH_GENERIC_IP
294  *      This define is used for an APPID that indicates that a packet matched a MAC entry.
295  *      Logical MAC interface location:
296  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
297  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
298  *       IP rule number for this interface location:
299  *          Refer to NETAPI_NETCP_MATCH_ID_SHIFT and 
300  *          NETAPI_NETCP_MATCH_ID_MASK.
301  *      Packet also matched a generic IP rule attached to that interface.
302  *      Packet did not match any other rule.
303  */
304 #define NETAPI_NETCP_MATCH_GENERIC_IP   0x20000000
306 /**
307  * @ingroup cfg_constants
308  * @def NETAPI_NETCP_MATCH_CLASS
309  *      This define is used for an APPID that indicates that a packet matched a MAC entry.
310  *      Logical MAC interface location:
311  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
312  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
313  *      Classifer ID location:
314  *          Refer to NETAPI_NETCP_MATCH_ID_SHIFT and 
315  *          NETAPI_NETCP_MATCH_ID_MASK.
316  *      Packet also matched a generic IP rule attached to 
317  *      that interface OR a general IP rule added as part of the classifier or it matched a combination
318  *      of ISPEC SA rule and a policy check.  In addition, packet matched a L4 port rule that was added 
319  *      as part of a classifer. Packet did not match any other rule.
320  */
321 #define NETAPI_NETCP_MATCH_CLASS        0x80000000
323 /**
324  * @ingroup cfg_constants
325  * @def NETAPI_NETCP_MATCH_CLASS_L3
326  *      This define is used for an APPID that indicates that a  packet matched a MAC entry.
327  *      Logical MAC interface location:
328  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
329  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
330  *      Packet also  matched a general IP rule added as part 
331  *      of a classifier.  But it not match a L4 port or any other rule. 
332  *      We cannot determine what classifer partially matched so Bytes 3-2 are not applicable
333  */
334 #define NETAPI_NETCP_MATCH_CLASS_L3     0x40000000
336 /**
337  * @ingroup cfg_constants
338  * @def NETAPI_NETCP_MATCH_IPSEC
339  *      This define is used for an APPID that indicates that a packet matched a MAC entry.
340  *      Logical MAC interface location:
341  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
342  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
343  *      SA ID location:
344  *          Refer to NETAPI_NETCP_MATCH_ID_SHIFT and 
345  *          NETAPI_NETCP_MATCH_ID_MASK.
346  *      Packet also matched an IPSEC SA  rule (matched proto, destination ip and SPI).  
347  *      Packet did not match any other rule (so may have failed a policy check)
348  */
349 #define NETAPI_NETCP_MATCH_IPSEC        0x01000000  
352 /**
353  * @ingroup cfg_constants
354  * @def NETAPI_NETCP_MATCH_IPSEC_POLICY
355  *      This define is used for an APPID that indicates that a packet matched a MAC entry
356  *      Logical MAC interface location:
357  *          Refer to NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_SHIFT and 
358  *          NETAPI_NETCP_MATCH_LOGICAL_MAC_IFACE_MASK.
359  *      Packet also matched an IPSEC SA rule (matched proto, 
360  *      dest ip and SPI).  Packet also matched a POLICY RULE (this is a check of the inner IP).
361  *      IPSEC RX Policy ID location:
362  *          Refer to NETAPI_NETCP_MATCH_ID_SHIFT and 
363  *          NETAPI_NETCP_MATCH_ID_MASK.
364  *      Packet did not match any other rule 
365  */
366 #define NETAPI_NETCP_MATCH_IPSEC_POLICY 0x02000000  //lower byte==interface, Or' in SA id (16 bits)
368 /**
369  * @ingroup cfg_constants
370  * @def NETAPI_NETCP_CFG_MATCH_EXCEPTION
371  *      This define is used for an APPID that indicates that a packet is of type exception. 
372  *      Actual exception id is in byte 0 of APPID.
373  */
374 #define NETAPI_NETCP_CFG_MATCH_EXCEPTION     0x08000000
378 /**
379  *  @ingroup cfg_structures
380  *  @brief NETCP flow configuration information.
381  *  @details This structure is used to define key parameters for the receive flow to be created.
382  *           These include the flow index to use (or can be left un-specified), the dma_index
383  *           (specifying out of which CPPI DMA engine the flow should be allocated),
384  *           the receive offset (the byte offset into each buffer where received data should be placed),
385  *           and the drop policy for the DMA channel to use if there is no free buffer available (drop or block)
386  *
387  */
388 typedef struct NETCP_CFG_FLOW_CONFIG_Tag
390    int              flow_index;     /**< flow index to use or NETAPI_NETCP_FLOW_INDEX_ANY */
391 /**
392  * @def NETAPI_NETCP_FLOW_INDEX_ANY
393  * @ingroup cfg_constants
394  *      This define is used to let NETAPI pick the flow index to use(for flow_index field)
395  */
396 #define NETAPI_NETCP_FLOW_INDEX_ANY  CPPI_PARAM_NOT_SPECIFIED
398    int              dma_index;      /**< allocate flow out of which DMA */
399 /**
400  * @def NETAPI_DMA_INFRASTRUCTURE
401  * @ingroup cfg_constants
402  *      This define is used specify a flow in the QMSS CPPI DMA (for dma_index field)
403  */
404 #define NETAPI_DMA_INFRASTRUCTURE 0
405 /**
406  * @def NETAPI_DMA_NETCP
407  * @ingroup cfg_constants
408  *      This define us usee specify a flow in the NETCP CPPI DMA (for dma_index field)
409  */
410 #define NETAPI_DMA_NETCP 1
412    int              recv_offset;    /**< start of packet offset */
414    int              block;          /**< TRUE => DMA will wait for free descriptor if heap(s) are empty.
415                                          FALSE => DMA will discard */
416 /**
417  * @def NETAPI_FLOW_DROP
418  * @ingroup cfg_constants
419  *      This define is used to indicate that the flow should institute a Block policy.
420  *      This means that the DMA should wait for a free descriptor/buffer to come available if
421  *      the free poll is empty (for the block field)
422  */
423 #define NETAPI_FLOW_BLOCK 1
424 /**
425  * @def NETAPI_FLOW_DROP
426  * @ingroup cfg_constants
427  *      This define us used to indicate that the flow should institute a Drop policy.
428  *      This means that the DMA should NOT wait for a free descriptor/buffer to come available
429  *      if the free poll is empty. The transfer will be aborted and the data will dropped (for block field)
430  */
431 #define NETAPI_FLOW_DROP 0
433    PKTIO_HANDLE_T * p_dest_q;       /**<destination queue for this flow (may be overwrritten by source DMA) */
434 } NETCP_CFG_FLOW_CONFIG_T;
441 /**
442  *  @ingroup cfg_functions
443  *  @brief netapi_netcpCfgAddFlow   API to add a flow
444  * 
445  *  @details This api is used to add a flow
446  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
447  *  @param[in]  n    number of Pktlib_HeapHandle
448  *  @param[in]  handles[]   Handles to Pktlib_HeapHandle
449  *  @param[in]  sizes[]     must be <= heap corresponding heap size-recv_offset-any desired tail room
450  *  @param[in]  p_cfg   @ref NETCP_CFG_FLOW_CONFIG_T
451  *  @param[out] err     pointer to error return
452  *  @retval     NETCP flow handle, @ref NETCP_CFG_FLOW_HANDLE_T
453  *  @pre       @ref netapi_init
454  */
455 NETCP_CFG_FLOW_HANDLE_T netapi_netcpCfgAddFlow(NETAPI_T h,
456                                             int n, 
457                                             Pktlib_HeapHandle handles[],
458                                             int sizes[],
459                                             NETCP_CFG_FLOW_CONFIG_T * p_cfg,
460                                             int * err );
462 /**
463  *  @ingroup cfg_functions
464  *  @brief netapi_netcpCfgDelFlow   API to delete a flow
465  * 
466  *  @details This api is used to delete a flow.
467  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
468  *  @param[in]  p    handle to NETCP  flow
469  *  @param[out] err     pointer to error return
470  *  @retval     none
471  *  @pre       @ref netapi_init, netapi_netcpCfgAddFlow
472  */
473 void netapi_netcpCfgDelFlow(NETAPI_T h ,
474                                             NETCP_CFG_FLOW_HANDLE_T p ,
475                                             int * err);
477 /**
478  *  @ingroup cfg_functions
479  *  @brief  API attaches an IP address and qualifier to a MAC interface
480  * 
481  *  @details This api is used to add an IP address to a MAC interface along
482  *            with optional IP qualifier. A route, @ref NETCP_CFG_ROUTE_HANDLE_T,or NULL for default 
483  *            may be specified to indicate where to send packets matching the MAC interface MAC address, the
484  *            supplied IP address and any qualifier.  This API adds a rule to the NETCP level 1 lookup tables.
485  *            Packets arriving that match this rule are identified in meta data with Appid=  NETAPI_NETCP_MATCH_GENERIC_IP
486  *            Note: An IP address must be attached to enable NETCP receive Checksum offload feature
487  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
488  *  @param[in]  iface_no    interface number (0,1,..)
489  *  @param[in]  ipType  type of IP address (V4 for V6)
490  *  @param[in]  ip_addr      ip_address
491  *  @param[in]  ip_qualifiers   ip_qualifiers (all 0 for no qualifiers). This can be used to apply special handling for
492  *                  diffserv category for example.
493  *  @param[in]  route       handle of a created route or NULL to use internal default route, @ref NETCP_CFG_ROUTE_HANDLE_T
494  *  @param[in]  user_data     Optional: pointer to user provided data associated with IP
495  *  @param[out] err     pointer to error return
496  *  @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
497  *  @pre       @ref netapi_init
498  */
499 NETCP_CFG_IP_T  netapi_netcpCfgAddIp(NETAPI_T                   h,
500                                      int                        iface_no,
501                                      nwal_IpType                ipType,
502                                      nwalIpAddr_t*              ip_addr,
503                                      nwalIpOpt_t*               ip_qualifiers,
504                                      NETCP_CFG_ROUTE_HANDLE_T   route,
505                                      void*                      user_data,
506                                      int*                       err);
508 /**
509  *  @ingroup cfg_functions
510  *  @brief netapi_netcpCfgDelIp   API to delete IP interface
511  * 
512  *  @details This api is used to delete an IP interface
513  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
514  *  @param[in]  iface_no    interface number (0,1,..)
515  *  @param[in]  ipType  type of IP address (V4 for V6)
516  *  @param[in]  ip_addr      ip_address
517  *  @param[in]  ip_qualifiers   ip_qualifiers (all 0 for no qualifiers). This can be used to apply special handling for
518  *                  diffserv category for example.
519  *  @param[in]  ip_rule_id      @ref NETCP_CFG_IP_T
520  *  @param[out] err     pointer to error return
521  *  @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
522  *  @pre       @ref netapi_init , @ref netapi_netcpCfgAddIp
523  */
524 void netapi_netcpCfgDelIp(NETAPI_T          h, 
525                           int               iface_no,
526                           nwal_IpType       ipType,
527                           nwalIpAddr_t*     ip_addr,
528                           nwalIpOpt_t*      ip_qualifiers, 
529                           NETCP_CFG_IP_T    ip_rule_id,
530                           int*              err);
532 /**
533  *  @ingroup cfg_functions
534  *  @brief netapi_netcpCfgCreateMacInterface  API to insert a MAC interface rule in the NETCP hardware
535  *  lookup engines.
536  * 
537  *  @details This api is used to insert a MAC interface in the NETCP hardware lookup engines.
538  *      Once it is created, the MAC interface can be used to receive packets. The API
539  *      adds a rule to the NETCP 1st level lookup tables to route all packets with destination
540  *      MAC matching supplied argument and not matching any other lookup entry (see @ref netapi_netcpCfgAddIp) to
541  *      the supplied route, @ref NETCP_CFG_ROUTE_T, (or default route).
542  *      Packets arriving that match this rule are identified in meta data with Appid=  NETAPI_NETCP_MATCH_GENERIC_MAC
543  *      Note: The internal SOC switch (if operating in full swithc mode) may need to  be "taught" that this mac
544  *      address is present by transmitting a packet with destination mac = this interface mac address.
545  *  @param[in]  h   NETAPI instance handle, @ref NETAPI_T
546  *  @param[in]  p_mac   pointer to 6 byte MAC address for interface
547  *  @param[in]  iface_no    interface number (0,1,..) 
548  *  @param[in]  switch_port     (0 don't care, 1 switch port 1, 1 switch port 2) [only 0 supported currenly] 
549  *  @param[in]  route   handle of a created route or NULL to use internal default route, @ref NETCP_CFG_ROUTE_HANDLE_T
550  *  @param[in]  vlan    [future[ vlan configuration . Set to NULL, @ref NETCP_CFG_VLAN_T
551  *  @param[in]  state   [future] interface state (0=down, 1= up)
552  *  @param[out] err     pointer to error return
553  *  @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
554  *  @pre       @ref netapi_init 
555  */
556 NETCP_CFG_MACIF_T  netapi_netcpCfgCreateMacInterface(NETAPI_T                   h,
557                                                      uint8_t*                   p_mac, 
558                                                      int                        iface_no,
559                                                      int                        switch_port,
560                                                      NETCP_CFG_ROUTE_HANDLE_T   route,
561                                                      NETCP_CFG_VLAN_T           vlan,
562                                                      int                        state,
563                                                      int *                      err);
565 /**
566  *  @ingroup cfg_functions
567  *  @brief netapi_netcpCfgDelMac   API to delete MAC  interface
568  * 
569  *  @details This api is used to delete a MAC interface
570  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
571  *  @param[in]  iface_no    interface number (0,1,..)
572  *  @param[out] err     pointer to error return
573  *  @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
574  *  @pre       @ref netapi_init , @ref netapi_netcpCfgCreateMacInterface 
575  */
576 void netapi_netcpCfgDelMac(NETAPI_T     h,
577                            int          iface_no,
578                            int*         err);
581 /**
582  * @brief This defines handle to installed classifier returned by API.  Pkts matching this classifier will have meta data with this tag.
583  *  Also used to delete classifier
584  */
585 typedef uint32_t NETCP_CFG_CLASS_T;
588 /**
589  *  @ingroup cfg_structures
590  *  @brief NETAPI Class L4 Configuration
591  *
592  *  @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)
593  */
594 typedef struct NETCP_CFG_CLASS_L4_Tag
596     int                 iface;      /**< Indicates which MAC interface packet should be received on*/
597     NETCP_CFG_IP_T      ip;         /**< IP rule to match: see @ref NETCP_CFG_IP_T */
598     nwal_appProtoType_t proto;   /**< L4 proto (-1 for don't care)*/
599     nwalAppProto_t      appProto;   /**< L4 Ports or equivalent */
601 } NETCP_CFG_CLASS_L4_T;
604 /**
605  *  @ingroup cfg_structures
606  *  @brief NETAPI Classifier L4 plus IPSEC policy configuration
607  *
608  *  @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. 
609  */
610 //classifier L4 + policy  (L2, L3 (outer), tunnel, L3 (inner)  implied by policy
611 typedef struct NETCP_CFG_CLASS_L4_IPSEC_Tag
613     int                       iface;      /**< Indicates which MAC interface packet should be received from */
614     NETCP_CFG_IPSEC_POLICY_T  ip_policy; /**< IPSEC policy configuration. see @ref NETCP_CFG_IPSEC_POLICY_T */
615     nwal_appProtoType_t       proto;   /**< L4 proto (-1 for don't care)*/
616     nwalAppProto_t            appProto;   /**< L4 Ports or equivalent */
618 } NETCP_CFG_CLASS_L4_IPSEC_T;
622 /**
623  *  @ingroup cfg_structures
624  *  @brief NETAPI Classifier L4/L3 configuration
625  *
626  *  @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.
627  */
628 typedef struct NETCP_CFG_CLASS_L3_L4_Tag
630     int                         iface;          /**< Indicates which MAC interface packet is from */
631     nwal_IpType                 ipType;         /**< IP address type, IPV4 or IPV6 */
632     nwalIpAddr_t*               ip_addr;        /**< IP address to match */
633     nwalIpOpt_t*                ip_qualifiers;  /**< IP address qualifiers */
634     NETCP_CFG_ROUTE_HANDLE_T    p_fail_route;   /**< What to do if L3 matches but L4 fails AND L3 is a 
635                                                      new rule.(if exisitng rule, then existing fail
636                                                      route will be used). */
637     nwal_appProtoType_t         proto;          /**< L4 proto (-1 for don't care)*/
638     nwalAppProto_t              appProto;       /**< Ports or equivalent */
639 } NETCP_CFG_CLASS_L3_L4_T;
641 /**
642  *  @ingroup cfg_structures
643  *  @brief NETAPI Classifier configuration
644  *
645  *  @details This structure contains the NETAPI classifer configuration.  This is a union of the different classifier types above
646  */
647 typedef struct NETCP_CFG_CLASSIFIER_Tag
650 /**
651  * Classifer type which can be set to one of the following defines:
652  * <br>
653  *      @ref NETCP_CFG_CLASS_TYPE_L4 , @ref NETCP_CFG_CLASS_TYPE_L3_L4, _
654  */
655     int classType;
657 /**
658  * @def NETCP_CFG_CLASS_TYPE_L4
659  * @ingroup cfg_constants
660  *      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
661  */
662 #define NETCP_CFG_CLASS_TYPE_L4  0
664 /**
665  * @def NETCP_CFG_CLASS_TYPE_L3_L4
666  * @ingroup cfg_constants
667  *      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.
668  */
669 #define NETCP_CFG_CLASS_TYPE_L3_L4  1
671      union
672     {
673         NETCP_CFG_CLASS_L3_L4_T     c_l3_l4;    /**< @ref NETCP_CFG_CLASS_L3_L4_T */
674         NETCP_CFG_CLASS_L4_T        c_l4;       /**< @ref NETCP_CFG_CLASS_L4_T */
675         NETCP_CFG_CLASS_L4_IPSEC_T  c_l4_ipsec; /**< @ref NETCP_CFG_CLASS_L4_IPSEC_T */
676     } u;                                        /**< union for classifier type configuration structure */
677 } NETCP_CFG_CLASSIFIER_T;
681 /**
682  *  @ingroup cfg_functions
683  *  @brief netapi_netcpCfgAddClass   API to attach a classifier rule to NETCP.
684  *      This can be used to route a particular packet flow to a specific PKTIO channel
685  * 
686  *  @details This api can be used to route a particular packet flow to a particular PktIO channel, using a specific 
687  *  pktLib heap, and/or have NetCP attach a tag (classifier id) to the incoming packet.
688  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
689  *  @param[in]  p_class definition of the classifier
690  *  @param[in]  p_route handle to NETCP route.
691  *  @param[in]  action       what to do with packet: one of NETCP_CFG_ACTION_TO_SW, DISCARD or CONTINUE
692  *  @param[in]  user_data     Optional: pointer to user provided data associated with SA
693  *  @param[out] err     pointer to error return
694  *  @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
695  *  @pre       @ref netapi_init
696  */NETCP_CFG_CLASS_T netapi_netcpCfgAddClass(NETAPI_T                   h,
697                                              NETCP_CFG_CLASSIFIER_T*    p_class,
698                                              NETCP_CFG_ROUTE_HANDLE_T   p_route,
699                                              int                        action,
700                                              void*                      user_data,
701                                              int*                       err);
705 /**
706  *  @ingroup cfg_functions
707  *  @brief netapi_netcpCfgDelClass   API to delete a preconfigured classifier
708  * 
709  *  @details This API can be used to delete a preconfigured classifier
710  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
711  *  @param[in]  classId
712  *  @param[out] err     pointer to error return
713  *  @retval     none
714  *  @pre       @ref netapi_init, @ref netapi_netcpCfgAddClass
715  */
716 void netapi_netcpCfgDelClass(NETAPI_T           h,
717                              NETCP_CFG_CLASS_T  classId,
718                              int*               err);
721 /**
722  *  @ingroup netapi_cb_functions
723  *  @brief NETCP_CFG_STATS_CB   Callback function that is used to return statistics from NETCP
724  * 
725  *  @details The application provides a callback function that NETAPI  uses to report statistics.
726  *  The request for stats is generated from the @ref netapi_netcpCfgReqStats API.
727  *  Note: to receive this stats callback, the @ref netapi_netcpPoll function must be called
728  *  @param[in]  h   NETAPI instance handle, @ref NETAPI_T
729  *  @param[out]  pPaStats    the PA (NETCP packet accelerator subsystem) statistics block 
730  *  @retval     none 
731  *  @pre       @ref netapi_init , @ref netapi_netcpCfgReqStats, @ref netapi_netcpPoll
732  */
733 typedef void (*NETCP_CFG_STATS_CB)(NETAPI_T      h,
734                                    paSysStats_t* pPaStats);
736 /**
737  *  @ingroup cfg_functions
738  *  @brief netapi_netcpCfgReqStats   API to request statistics from NETCP
739  * 
740  *  @details This api is used to request a statistics from NETCP.  This will generate a stats request
741  *  command to NETCP. Sometime later, the statistics result will arrive and will be passed to 
742  *  the caller via the asynchronus callback @ref NETCP_CFG_STATS_CB that is registered in this call.
743  *  Note: to receive the stats callback, the @ref netapi_netcpPoll funcition must be called
744  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
745  *  @param[in]  cb   the callback function to invoke with the resulting statistics block, @ref NETCP_CFG_STATS_CB
746  *  @param[in]  doClear     clear the stats in NETCP after the report (0=no, 1=yes) 
747  *  @param[out] err     pointer to error return
748  *  @retval     none 
749  *  @pre       @ref netapi_init 
750  */
751 void netapi_netcpCfgReqStats(NETAPI_T               h,
752                              NETCP_CFG_STATS_CB     cb,
753                              int                    doClear,
754                              int*                   err);
757 /**
758  *  @ingroup cfg_functions
759  *  @brief netapi_netcpCfgExceptions    API to configure NETCP with global rules for exception packet handling
760  *
761  *  @details This api is used to configure NETCP with global rules of how to handle exception packets specified by exception_id.
762  *  @param[in]  h    NETAPI instance handle, @ref NETAPI_T
763  *  @param[in]  exception_id id of the exception packet, refer to pa.h,.pa_EROUTE_XXX for list of exception packet id's
764  *  @param[in]  p_route handle to NETCP route.
765  *  @param[in]  action, action for NETCP to take upon classifying packet as type exception, refer to nwal. nwal_matchAction_t
766  *  @retval returns app_id, @ref NETCP_CFG_EXCEPTION_PKT_T
767  *  @pre       @ref netapi_init 
768  */
769 NETCP_CFG_EXCEPTION_PKT_T netapi_netcpCfgExceptions(NETAPI_T                    h,
770                                                     int                         exception_id ,
771                                                     nwal_matchAction_t          action,
772                                                     NETCP_CFG_ROUTE_HANDLE_T    p_route);
775 #endif