[keystone-rtos/netapi.git] / ti / runtime / netapi / docs / doxygen / html / group__nwal__api__functions.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\r
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">\r
3 <title>NETAPI: NWAL API's</title>\r
4 <link href="doxygen.css" rel="stylesheet" type="text/css">\r
5 <link href="tabs.css" rel="stylesheet" type="text/css">\r
6 </head><body>\r
7 <table width=100%>\r
8 <tr>\r
9 <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border=0 src="../../tilogo.gif"></a></td>\r
10 <td bgcolor="red"><img src="../../titagline.gif"></td>\r
11 </tr>\r
12 </table>\r
13 <!-- Generated by Doxygen 1.5.1-p1 -->\r
14 <div class="tabs">\r
15 <ul>\r
16 <li><a href="index.html"><span>Main Page</span></a></li>\r
17 <li><a href="modules.html"><span>Modules</span></a></li>\r
18 <li><a href="annotated.html"><span>Data Structures</span></a></li>\r
19 <li><a href="files.html"><span>Files</span></a></li>\r
20 </ul></div>\r
21 <h1>NWAL API's<br>\r
22 <small>\r
23 [<a class="el" href="group__nwal__module.html">NWAL Module API</a>]</small>\r
24 </h1><table border="0" cellpadding="0" cellspacing="0">\r
25 <tr><td></td></tr>\r
26 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>\r
27 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g67e3eb4e446cec804e87b0f4fec8bc25">nwal_getBufferReq</a> (<a class="el" href="structnwal_size_info__t.html">nwalSizeInfo_t</a> *sizeCfg, int sizes[nwal_N_BUFS], int aligns[nwal_N_BUFS])</td></tr>\r
28 \r
29 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to retrieve memory buffer requirement by NWAL module. <a href="#g67e3eb4e446cec804e87b0f4fec8bc25"></a><br></td></tr>\r
30 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g1822ee8a1ab76a26470ae3b16d5e0ae8">nwal_create</a> (const <a class="el" href="structnwal_glob_cfg__t.html">nwalGlobCfg_t</a> *pCfg, <a class="el" href="structnwal_size_info__t.html">nwalSizeInfo_t</a> *pSizeInfo, int sizes[nwal_N_BUFS], void *bases[nwal_N_BUFS], <a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> *pNwalInst)</td></tr>\r
31 \r
32 <tr><td class="mdescLeft"> </td><td class="mdescRight">API instantiates the driver and allocated global resources and is pre-requisite. <a href="#g1822ee8a1ab76a26470ae3b16d5e0ae8"></a><br></td></tr>\r
33 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g8902b9568e8ce7989da63d6a97c2e3a7">nwal_delete</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst)</td></tr>\r
34 \r
35 <tr><td class="mdescLeft"> </td><td class="mdescRight">API frees the NetCP resources allocated byNWAL. <a href="#g8902b9568e8ce7989da63d6a97c2e3a7"></a><br></td></tr>\r
36 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g9491a97d2695d4df29ae94ccaf7d0538">nwal_getGlobCxtInfo</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="structnwal_glob_cxt_info__t.html">nwalGlobCxtInfo_t</a> *pInfo)</td></tr>\r
37 \r
38 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to retrieve global resources created by NWAL at the end of <a class="el" href="group__nwal__api__functions.html#g1822ee8a1ab76a26470ae3b16d5e0ae8">nwal_create()</a> API. <a href="#g9491a97d2695d4df29ae94ccaf7d0538"></a><br></td></tr>\r
39 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, const <a class="el" href="structnwal_loc_cfg__t.html">nwalLocCfg_t</a> *pCfg)</td></tr>\r
40 \r
41 <tr><td class="mdescLeft"> </td><td class="mdescRight">API would need to be called for all cores as a pre-requisite. API allows local per core related resource configuration to NWAL. <a href="#g90852da1af033180d619e147594a869e"></a><br></td></tr>\r
42 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#ga368a5b778510840d7648844616e4b45">nwal_getLocCxtInfo</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="structnwal_loc_cxt_info__t.html">nwalLocCxtInfo_t</a> *pInfo)</td></tr>\r
43 \r
44 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to retrieve local per process resources created by NWAL at the end of <a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start()</a> API. <a href="#ga368a5b778510840d7648844616e4b45"></a><br></td></tr>\r
45 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g4ac963c021e794ec1bfce2f7003772d6">nwal_getMacIface</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="structnwal_mac_param__t.html">nwalMacParam_t</a> *pParam, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pIfHandle)</td></tr>\r
46 \r
47 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_getMacIface: API will check for already configuration for MAC entry <a href="#g4ac963c021e794ec1bfce2f7003772d6"></a><br></td></tr>\r
48 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g0b49a46ae19bd0020a0726e40c41750c">nwal_setMacIface</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="structnwal_mac_param__t.html">nwalMacParam_t</a> *pParam, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pIfHandle)</td></tr>\r
49 \r
50 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_setMacIface: Configures MAC LUT entry at NetCP. <a href="#g0b49a46ae19bd0020a0726e40c41750c"></a><br></td></tr>\r
51 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g75cf2e792790d8ece465de728f87d404">nwal_delMacIface</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> ifHandle)</td></tr>\r
52 \r
53 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_delMacIface: Delete MAC LUT entry at NetCP. <a href="#g75cf2e792790d8ece465de728f87d404"></a><br></td></tr>\r
54 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#gd6993a765961a1b21f7354a7617ffad7">nwal_getIPAddr</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="structnwal_ip_param__t.html">nwalIpParam_t</a> *pParam, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> pPrevHandle, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pIpHandle)</td></tr>\r
55 \r
56 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_getIPAddr: API will check if there is already IP Address configured by application. If found returns the handle <a href="#gd6993a765961a1b21f7354a7617ffad7"></a><br></td></tr>\r
57 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g088d54ec748e8a8ceab0d8314424bbe0">nwal_setIPAddr</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> ifHandle, <a class="el" href="structnwal_ip_param__t.html">nwalIpParam_t</a> *pParam, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pIpHandle)</td></tr>\r
58 \r
59 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_setIPAddr: Add IP Address configuration to NETCP. <a href="#g088d54ec748e8a8ceab0d8314424bbe0"></a><br></td></tr>\r
60 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g5f8b24f04b58bd9bb10d041ab309af9c">nwal_delIPAddr</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> ipHandle)</td></tr>\r
61 \r
62 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_deleteIPAddr: Delete IP Address configuration at NETCP. <a href="#g5f8b24f04b58bd9bb10d041ab309af9c"></a><br></td></tr>\r
63 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g206ce6e6f7ffe6145836023f046ffb60">nwal_getSecAssoc</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="structnwal_sa_ip_sec_id__t.html">nwalSaIpSecId_t</a> *pSaId, <a class="el" href="nwal_8h.html#8066f3731e362c5f305b19ee4ff0609f">nwal_IPSecDir</a> dir, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pNwalSecAssocHandle)</td></tr>\r
64 \r
65 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get an IPSec Security Association Channel. <a href="#g206ce6e6f7ffe6145836023f046ffb60"></a><br></td></tr>\r
66 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#gca33b2cd9bd7ccf47f024685a7749727">nwal_setSecAssoc</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="structnwal_sa_ip_sec_id__t.html">nwalSaIpSecId_t</a> *pSaId, <a class="el" href="structnwal_create_s_a_params__t.html">nwalCreateSAParams_t</a> *pCreateParam, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pNwalSecAssocHandle)</td></tr>\r
67 \r
68 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to create outer IPSec Security Association Channel For inbound direction API will trigger allocating resources at NetCP. Application can either block by passing transaction ID as NWAL_TRANSID_SPIN_WAIT or wait for call back being called with the results For outbound, API will return nwal_TRANS_COMPLETE and no further callback will be called.Application can free transaction ID after returning from API. <a href="#gca33b2cd9bd7ccf47f024685a7749727"></a><br></td></tr>\r
69 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#gcddcfd2aee1399d68d3ad5af65f655d2">nwal_delSecAssoc</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> nwalSecAssocHandle)</td></tr>\r
70 \r
71 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to delete an existing Policy Handle For inbound direction API will trigger allocating resources at NetCP. Application can either block by passing transaction ID as NWAL_TRANSID_SPIN_WAIT or wait for call back being called with the results For outbound, API will return nwal_TRANS_COMPLETE and no further callback will be called.Application can free transaction ID after returning from API. <a href="#gcddcfd2aee1399d68d3ad5af65f655d2"></a><br></td></tr>\r
72 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#ge9b0a2500f33214fd0758158edf34a22">nwal_getSecPolicy</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="structnwal_sec_pol_params__t.html">nwalSecPolParams_t</a> *pPolParam, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pNwalSecPolHandle)</td></tr>\r
73 \r
74 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to retrieve handle for existing security policy for a connection. <a href="#ge9b0a2500f33214fd0758158edf34a22"></a><br></td></tr>\r
75 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#gfe8015e99d27a8198ebc0dc14bb0c60b">nwal_setSecPolicy</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="structnwal_sec_pol_params__t.html">nwalSecPolParams_t</a> *pPolParam, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pNwalSecPolHandle)</td></tr>\r
76 \r
77 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to create policy for a connection. <a href="#gfe8015e99d27a8198ebc0dc14bb0c60b"></a><br></td></tr>\r
78 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#gbfbfb134f82617f4172490d7e3691f36">nwal_delSecPolicy</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> nwalSecPolHandle)</td></tr>\r
79 \r
80 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to delete an existing Policy Handle. <a href="#gbfbfb134f82617f4172490d7e3691f36"></a><br></td></tr>\r
81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#gfa8c0d4f3cc343d34c617ca633f7206e">nwal_addConn</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="nwal_8h.html#2c12e1b9dc5645d72d060dc6b2952c05">nwal_appProtoType_t</a> proto, <a class="el" href="structnwal_loc_conn_cfg__t.html">nwalLocConnCfg_t</a> *pLocConnCfg, <a class="el" href="structnwal_rem_conn_cfg__t.html">nwalRemConnCfg_t</a> *pRemConnCfg, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> *pNwalConHandle)</td></tr>\r
82 \r
83 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to create connection establishment. <a href="#gfa8c0d4f3cc343d34c617ca633f7206e"></a><br></td></tr>\r
84 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g555ca6d2c15b3ff5546fa2370034d07b">nwal_delConn</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> nwalConHandle)</td></tr>\r
85 \r
86 <tr><td class="mdescLeft"> </td><td class="mdescRight">API to delete an existing connection. <a href="#g555ca6d2c15b3ff5546fa2370034d07b"></a><br></td></tr>\r
87 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#geee71f679658ef7182385f8fee78b5d2">nwal_cfgConn</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> nwalConHandle, <a class="el" href="structnwal_rem_conn_cfg__t.html">nwalRemConnCfg_t</a> *pRemConnCfg)</td></tr>\r
88 \r
89 <tr><td class="mdescLeft"> </td><td class="mdescRight">API for run time configuration connection establishment. <a href="#geee71f679658ef7182385f8fee78b5d2"></a><br></td></tr>\r
90 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g3a6de9ce78144e80feb5ad45db73ae81">nwal_refreshConn</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> nwalHandle)</td></tr>\r
91 \r
92 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_refreshConn: Refreshes a connection for the core. <a href="#g3a6de9ce78144e80feb5ad45db73ae81"></a><br></td></tr>\r
93 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g14fd102b2d3b8d942cb86b8b8d2dbf72">nwal_getPAStats</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, paSysStats_t *pPaStats, <a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> doClear)</td></tr>\r
94 \r
95 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_getPAStats: Get Statistics from PA <a href="#g14fd102b2d3b8d942cb86b8b8d2dbf72"></a><br></td></tr>\r
96 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g113edc64f9b709805625a49a0a5c25ba">nwal_sendRaw</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, uint16_t bufLen, uint8_t *pBuf)</td></tr>\r
97 \r
98 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_sendRaw: Transmit raw packet to the PA <a href="#g113edc64f9b709805625a49a0a5c25ba"></a><br></td></tr>\r
99 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g9becdd27693d5b7d564274c6a9798b5a">nwal_send</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> nwalHandle, <a class="el" href="structnwal_tx_pkt_info__t.html">nwalTxPktInfo_t</a> *pPktInfo)</td></tr>\r
100 \r
101 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_send: Transmit packet out for a connection <a href="#g9becdd27693d5b7d564274c6a9798b5a"></a><br></td></tr>\r
102 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g32fdcdfe7e992b416502eab84de846fb">nwal_pollCtl</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack</a> *pCmdCallBack, <a class="el" href="group___external_callbacks.html#g7a490e5146f40d17de861888dcc3ed12">nwal_CmdPaStatsReply</a> *pPaStatsCallBack)</td></tr>\r
103 \r
104 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_pollCtl: API for polling Control message response from NetCP: PA Subsystem. <a href="#g32fdcdfe7e992b416502eab84de846fb"></a><br></td></tr>\r
105 <tr><td class="memItemLeft" nowrap align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nwal__api__functions.html#g220abef4dc0cd6e26f55117c8f9cf72d">nwal_pollPkt</a> (<a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> nwalInst, <a class="el" href="nwal_8h.html#2ce41d72fbf1aa7109d89a4a93884660">nwal_pollPktQCtl</a> pktQCtl, uint32_t appCookie, uint16_t maxPkts, Qmss_QueueHnd appRxPktQueue, <a class="el" href="group___external_callbacks.html#g202f54ea7a87c9c1059266d19ef988d5">nwal_rxPktCallBack</a> *pRxPktCallBack)</td></tr>\r
106 \r
107 <tr><td class="mdescLeft"> </td><td class="mdescRight">nwal_pollPkt: API for polling packets from network. <a href="#g220abef4dc0cd6e26f55117c8f9cf72d"></a><br></td></tr>\r
108 </table>\r
109 <hr><h2>Function Documentation</h2>\r
110 <a class="anchor" name="gfa8c0d4f3cc343d34c617ca633f7206e"></a><!-- doxytag: member="nwal.h::nwal_addConn" ref="gfa8c0d4f3cc343d34c617ca633f7206e" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_AppId appId, nwal_appProtoType_t proto, nwalLocConnCfg_t *pLocConnCfg, nwalRemConnCfg_t *pRemConnCfg, nwal_Handle *pNwalConHandle)" -->\r
111 <div class="memitem">\r
112 <div class="memproto">\r
113 <table class="memname">\r
114 <tr>\r
115 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_addConn </td>\r
116 <td>(</td>\r
117 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
118 <td class="paramname"> <em>nwalInst</em>, </td>\r
119 </tr>\r
120 <tr>\r
121 <td class="paramkey"></td>\r
122 <td></td>\r
123 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
124 <td class="paramname"> <em>transId</em>, </td>\r
125 </tr>\r
126 <tr>\r
127 <td class="paramkey"></td>\r
128 <td></td>\r
129 <td class="paramtype"><a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> </td>\r
130 <td class="paramname"> <em>appId</em>, </td>\r
131 </tr>\r
132 <tr>\r
133 <td class="paramkey"></td>\r
134 <td></td>\r
135 <td class="paramtype"><a class="el" href="nwal_8h.html#2c12e1b9dc5645d72d060dc6b2952c05">nwal_appProtoType_t</a> </td>\r
136 <td class="paramname"> <em>proto</em>, </td>\r
137 </tr>\r
138 <tr>\r
139 <td class="paramkey"></td>\r
140 <td></td>\r
141 <td class="paramtype"><a class="el" href="structnwal_loc_conn_cfg__t.html">nwalLocConnCfg_t</a> * </td>\r
142 <td class="paramname"> <em>pLocConnCfg</em>, </td>\r
143 </tr>\r
144 <tr>\r
145 <td class="paramkey"></td>\r
146 <td></td>\r
147 <td class="paramtype"><a class="el" href="structnwal_rem_conn_cfg__t.html">nwalRemConnCfg_t</a> * </td>\r
148 <td class="paramname"> <em>pRemConnCfg</em>, </td>\r
149 </tr>\r
150 <tr>\r
151 <td class="paramkey"></td>\r
152 <td></td>\r
153 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
154 <td class="paramname"> <em>pNwalConHandle</em></td><td> </td>\r
155 </tr>\r
156 <tr>\r
157 <td></td>\r
158 <td>)</td>\r
159 <td></td><td></td><td width="100%"></td>\r
160 </tr>\r
161 </table>\r
162 </div>\r
163 <div class="memdoc">\r
164 \r
165 <p>\r
166 API to create connection establishment. \r
167 <p>\r
168 This function results in configuration of L4 LUT entry for the RX side. For TX side the function will collect all details to enable header creation. Supports RX only or RX/TX channel<p>\r
169 <dl compact><dt><b>Parameters:</b></dt><dd>\r
170 <table border="0" cellspacing="2" cellpadding="0">\r
171 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
172 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
173 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>appId</em> </td><td>Application ID to be registered. The handle will be used for all interfaces from NWAL to application: 1) Asynchronous confirmation of configuration response 2) Any packets received from NetCP related to this handle </td></tr>\r
174 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>proto</em> </td><td>Layer 4 protocol type </td></tr>\r
175 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pLocConnCfg</em> </td><td>Local Connection configuration for the channel. </td></tr>\r
176 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pRemConnCfg</em> </td><td>[Optional]Remote Connection configuration for the channel. If provided as NULL connection will be configured as RX only </td></tr>\r
177 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pNwalConHandle</em> </td><td>Connection handle being returned to application</td></tr>\r
178 </table>\r
179 </dl>\r
180 <dl compact><dt><b>Return values:</b></dt><dd>\r
181 <table border="0" cellspacing="2" cellpadding="0">\r
182 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
183 </table>\r
184 </dl>\r
185 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#gfe8015e99d27a8198ebc0dc14bb0c60b">nwal_setSecPolicy</a> for IPSec or <a class="el" href="group__nwal__api__functions.html#g088d54ec748e8a8ceab0d8314424bbe0">nwal_setIPAddr</a> for non IPSec </dd></dl>\r
186 \r
187 </div>\r
188 </div><p>\r
189 <a class="anchor" name="geee71f679658ef7182385f8fee78b5d2"></a><!-- doxytag: member="nwal.h::nwal_cfgConn" ref="geee71f679658ef7182385f8fee78b5d2" args="(nwal_Inst nwalInst, nwal_Handle nwalConHandle, nwalRemConnCfg_t *pRemConnCfg)" -->\r
190 <div class="memitem">\r
191 <div class="memproto">\r
192 <table class="memname">\r
193 <tr>\r
194 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_cfgConn </td>\r
195 <td>(</td>\r
196 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
197 <td class="paramname"> <em>nwalInst</em>, </td>\r
198 </tr>\r
199 <tr>\r
200 <td class="paramkey"></td>\r
201 <td></td>\r
202 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
203 <td class="paramname"> <em>nwalConHandle</em>, </td>\r
204 </tr>\r
205 <tr>\r
206 <td class="paramkey"></td>\r
207 <td></td>\r
208 <td class="paramtype"><a class="el" href="structnwal_rem_conn_cfg__t.html">nwalRemConnCfg_t</a> * </td>\r
209 <td class="paramname"> <em>pRemConnCfg</em></td><td> </td>\r
210 </tr>\r
211 <tr>\r
212 <td></td>\r
213 <td>)</td>\r
214 <td></td><td></td><td width="100%"></td>\r
215 </tr>\r
216 </table>\r
217 </div>\r
218 <div class="memdoc">\r
219 \r
220 <p>\r
221 API for run time configuration connection establishment. \r
222 <p>\r
223 This function results in configuration of header details for TX side<p>\r
224 <dl compact><dt><b>Parameters:</b></dt><dd>\r
225 <table border="0" cellspacing="2" cellpadding="0">\r
226 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
227 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalConHandle</em> </td><td>Connection handle to be reconfigured </td></tr>\r
228 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pRemConnCfg</em> </td><td>Remote Connection configuration for the channel. </td></tr>\r
229 </table>\r
230 </dl>\r
231 <dl compact><dt><b>Return values:</b></dt><dd>\r
232 <table border="0" cellspacing="2" cellpadding="0">\r
233 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
234 </table>\r
235 </dl>\r
236 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#gfa8c0d4f3cc343d34c617ca633f7206e">nwal_addConn</a> </dd></dl>\r
237 \r
238 </div>\r
239 </div><p>\r
240 <a class="anchor" name="g1822ee8a1ab76a26470ae3b16d5e0ae8"></a><!-- doxytag: member="nwal.h::nwal_create" ref="g1822ee8a1ab76a26470ae3b16d5e0ae8" args="(const nwalGlobCfg_t *pCfg, nwalSizeInfo_t *pSizeInfo, int sizes[nwal_N_BUFS], void *bases[nwal_N_BUFS], nwal_Inst *pNwalInst)" -->\r
241 <div class="memitem">\r
242 <div class="memproto">\r
243 <table class="memname">\r
244 <tr>\r
245 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_create </td>\r
246 <td>(</td>\r
247 <td class="paramtype">const <a class="el" href="structnwal_glob_cfg__t.html">nwalGlobCfg_t</a> * </td>\r
248 <td class="paramname"> <em>pCfg</em>, </td>\r
249 </tr>\r
250 <tr>\r
251 <td class="paramkey"></td>\r
252 <td></td>\r
253 <td class="paramtype"><a class="el" href="structnwal_size_info__t.html">nwalSizeInfo_t</a> * </td>\r
254 <td class="paramname"> <em>pSizeInfo</em>, </td>\r
255 </tr>\r
256 <tr>\r
257 <td class="paramkey"></td>\r
258 <td></td>\r
259 <td class="paramtype">int </td>\r
260 <td class="paramname"> <em>sizes</em>[nwal_N_BUFS], </td>\r
261 </tr>\r
262 <tr>\r
263 <td class="paramkey"></td>\r
264 <td></td>\r
265 <td class="paramtype">void * </td>\r
266 <td class="paramname"> <em>bases</em>[nwal_N_BUFS], </td>\r
267 </tr>\r
268 <tr>\r
269 <td class="paramkey"></td>\r
270 <td></td>\r
271 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> * </td>\r
272 <td class="paramname"> <em>pNwalInst</em></td><td> </td>\r
273 </tr>\r
274 <tr>\r
275 <td></td>\r
276 <td>)</td>\r
277 <td></td><td></td><td width="100%"></td>\r
278 </tr>\r
279 </table>\r
280 </div>\r
281 <div class="memdoc">\r
282 \r
283 <p>\r
284 API instantiates the driver and allocated global resources and is pre-requisite. \r
285 <p>\r
286 Allocates global resources valid per system level common across all DSP cores<p>\r
287 All NetCP related initialization will be done inside the module. Module also supports a possible use case of NetCP initialization being done by application. In that case application would need to provide paHandle in the API. All QM and PktDMA initialization is required to be done outside module. Following are the resource initialization prerequisite to NWAL module initialization:<ul>\r
288 <li>QMSS Initialization for the link RAM and descriptors</li><li>CPPI Initialization of descriptors</li><li>Buffer pool being made available through queues containing descriptors and linked buffers <dl compact><dt><b>Parameters:</b></dt><dd>\r
289 <table border="0" cellspacing="2" cellpadding="0">\r
290 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pCfg</em> </td><td>Input conguration </td></tr>\r
291 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pSizeInfo</em> </td><td>Configuration information for Memory sizing. </td></tr>\r
292 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>sizes</em> </td><td>Memory Size for the buffers allocated. Expected to be same as output returned by NWAL during <a class="el" href="group__nwal__api__functions.html#g67e3eb4e446cec804e87b0f4fec8bc25">nwal_getBufferReq()</a> API </td></tr>\r
293 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>bases</em> </td><td>Array of the memory buffer base addresses </td></tr>\r
294 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pNwalInst</em> </td><td>NWAL Global Instance handle. </td></tr>\r
295 </table>\r
296 </dl>\r
297 <dl compact><dt><b>Return values:</b></dt><dd>\r
298 <table border="0" cellspacing="2" cellpadding="0">\r
299 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
300 </table>\r
301 </dl>\r
302 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g67e3eb4e446cec804e87b0f4fec8bc25">nwal_getBufferReq</a> </dd></dl>\r
303 </li></ul>\r
304 \r
305 </div>\r
306 </div><p>\r
307 <a class="anchor" name="g555ca6d2c15b3ff5546fa2370034d07b"></a><!-- doxytag: member="nwal.h::nwal_delConn" ref="g555ca6d2c15b3ff5546fa2370034d07b" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_Handle nwalConHandle)" -->\r
308 <div class="memitem">\r
309 <div class="memproto">\r
310 <table class="memname">\r
311 <tr>\r
312 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_delConn </td>\r
313 <td>(</td>\r
314 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
315 <td class="paramname"> <em>nwalInst</em>, </td>\r
316 </tr>\r
317 <tr>\r
318 <td class="paramkey"></td>\r
319 <td></td>\r
320 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
321 <td class="paramname"> <em>transId</em>, </td>\r
322 </tr>\r
323 <tr>\r
324 <td class="paramkey"></td>\r
325 <td></td>\r
326 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
327 <td class="paramname"> <em>nwalConHandle</em></td><td> </td>\r
328 </tr>\r
329 <tr>\r
330 <td></td>\r
331 <td>)</td>\r
332 <td></td><td></td><td width="100%"></td>\r
333 </tr>\r
334 </table>\r
335 </div>\r
336 <div class="memdoc">\r
337 \r
338 <p>\r
339 API to delete an existing connection. \r
340 <p>\r
341 This function results in deletion of existing connection<p>\r
342 <dl compact><dt><b>Parameters:</b></dt><dd>\r
343 <table border="0" cellspacing="2" cellpadding="0">\r
344 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
345 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
346 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalConHandle</em> </td><td>Connection handle being returned to application</td></tr>\r
347 </table>\r
348 </dl>\r
349 <dl compact><dt><b>Return values:</b></dt><dd>\r
350 <table border="0" cellspacing="2" cellpadding="0">\r
351 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
352 </table>\r
353 </dl>\r
354 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#gfa8c0d4f3cc343d34c617ca633f7206e">nwal_addConn</a> </dd></dl>\r
355 \r
356 </div>\r
357 </div><p>\r
358 <a class="anchor" name="g8902b9568e8ce7989da63d6a97c2e3a7"></a><!-- doxytag: member="nwal.h::nwal_delete" ref="g8902b9568e8ce7989da63d6a97c2e3a7" args="(nwal_Inst nwalInst)" -->\r
359 <div class="memitem">\r
360 <div class="memproto">\r
361 <table class="memname">\r
362 <tr>\r
363 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_delete </td>\r
364 <td>(</td>\r
365 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
366 <td class="paramname"> <em>nwalInst</em> </td>\r
367 <td> ) </td>\r
368 <td width="100%"></td>\r
369 </tr>\r
370 </table>\r
371 </div>\r
372 <div class="memdoc">\r
373 \r
374 <p>\r
375 API frees the NetCP resources allocated byNWAL. \r
376 <p>\r
377 Frees global resources allocated at NetCP. To be called only one per system <dl compact><dt><b>Parameters:</b></dt><dd>\r
378 <table border="0" cellspacing="2" cellpadding="0">\r
379 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
380 </table>\r
381 </dl>\r
382 <dl compact><dt><b>Return values:</b></dt><dd>\r
383 <table border="0" cellspacing="2" cellpadding="0">\r
384 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
385 </table>\r
386 </dl>\r
387 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g1822ee8a1ab76a26470ae3b16d5e0ae8">nwal_create</a> </dd></dl>\r
388 \r
389 </div>\r
390 </div><p>\r
391 <a class="anchor" name="g5f8b24f04b58bd9bb10d041ab309af9c"></a><!-- doxytag: member="nwal.h::nwal_delIPAddr" ref="g5f8b24f04b58bd9bb10d041ab309af9c" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_Handle ipHandle)" -->\r
392 <div class="memitem">\r
393 <div class="memproto">\r
394 <table class="memname">\r
395 <tr>\r
396 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_delIPAddr </td>\r
397 <td>(</td>\r
398 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
399 <td class="paramname"> <em>nwalInst</em>, </td>\r
400 </tr>\r
401 <tr>\r
402 <td class="paramkey"></td>\r
403 <td></td>\r
404 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
405 <td class="paramname"> <em>transId</em>, </td>\r
406 </tr>\r
407 <tr>\r
408 <td class="paramkey"></td>\r
409 <td></td>\r
410 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
411 <td class="paramname"> <em>ipHandle</em></td><td> </td>\r
412 </tr>\r
413 <tr>\r
414 <td></td>\r
415 <td>)</td>\r
416 <td></td><td></td><td width="100%"></td>\r
417 </tr>\r
418 </table>\r
419 </div>\r
420 <div class="memdoc">\r
421 \r
422 <p>\r
423 nwal_deleteIPAddr: Delete IP Address configuration at NETCP. \r
424 <p>\r
425 API removes NetCP IP Addres classification rule for local IP Address<p>\r
426 <dl compact><dt><b>Parameters:</b></dt><dd>\r
427 <table border="0" cellspacing="2" cellpadding="0">\r
428 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
429 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
430 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ipHandle</em> </td><td>Handle returned to application from :nwal_setIPAddr.</td></tr>\r
431 </table>\r
432 </dl>\r
433 <dl compact><dt><b>Return values:</b></dt><dd>\r
434 <table border="0" cellspacing="2" cellpadding="0">\r
435 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
436 </table>\r
437 </dl>\r
438 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g088d54ec748e8a8ceab0d8314424bbe0">nwal_setIPAddr</a> </dd></dl>\r
439 \r
440 </div>\r
441 </div><p>\r
442 <a class="anchor" name="g75cf2e792790d8ece465de728f87d404"></a><!-- doxytag: member="nwal.h::nwal_delMacIface" ref="g75cf2e792790d8ece465de728f87d404" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_Handle ifHandle)" -->\r
443 <div class="memitem">\r
444 <div class="memproto">\r
445 <table class="memname">\r
446 <tr>\r
447 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_delMacIface </td>\r
448 <td>(</td>\r
449 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
450 <td class="paramname"> <em>nwalInst</em>, </td>\r
451 </tr>\r
452 <tr>\r
453 <td class="paramkey"></td>\r
454 <td></td>\r
455 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
456 <td class="paramname"> <em>transId</em>, </td>\r
457 </tr>\r
458 <tr>\r
459 <td class="paramkey"></td>\r
460 <td></td>\r
461 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
462 <td class="paramname"> <em>ifHandle</em></td><td> </td>\r
463 </tr>\r
464 <tr>\r
465 <td></td>\r
466 <td>)</td>\r
467 <td></td><td></td><td width="100%"></td>\r
468 </tr>\r
469 </table>\r
470 </div>\r
471 <div class="memdoc">\r
472 \r
473 <p>\r
474 nwal_delMacIface: Delete MAC LUT entry at NetCP. \r
475 <p>\r
476 The API deletes NetCP configuration received through : nwal_setMacIface<p>\r
477 <dl compact><dt><b>Parameters:</b></dt><dd>\r
478 <table border="0" cellspacing="2" cellpadding="0">\r
479 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
480 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
481 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ifHandle</em> </td><td>Handle returned to application from :nwal_setMacIface.</td></tr>\r
482 </table>\r
483 </dl>\r
484 <dl compact><dt><b>Return values:</b></dt><dd>\r
485 <table border="0" cellspacing="2" cellpadding="0">\r
486 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
487 </table>\r
488 </dl>\r
489 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g0b49a46ae19bd0020a0726e40c41750c">nwal_setMacIface</a> </dd></dl>\r
490 \r
491 </div>\r
492 </div><p>\r
493 <a class="anchor" name="gcddcfd2aee1399d68d3ad5af65f655d2"></a><!-- doxytag: member="nwal.h::nwal_delSecAssoc" ref="gcddcfd2aee1399d68d3ad5af65f655d2" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_Handle nwalSecAssocHandle)" -->\r
494 <div class="memitem">\r
495 <div class="memproto">\r
496 <table class="memname">\r
497 <tr>\r
498 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_delSecAssoc </td>\r
499 <td>(</td>\r
500 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
501 <td class="paramname"> <em>nwalInst</em>, </td>\r
502 </tr>\r
503 <tr>\r
504 <td class="paramkey"></td>\r
505 <td></td>\r
506 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
507 <td class="paramname"> <em>transId</em>, </td>\r
508 </tr>\r
509 <tr>\r
510 <td class="paramkey"></td>\r
511 <td></td>\r
512 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
513 <td class="paramname"> <em>nwalSecAssocHandle</em></td><td> </td>\r
514 </tr>\r
515 <tr>\r
516 <td></td>\r
517 <td>)</td>\r
518 <td></td><td></td><td width="100%"></td>\r
519 </tr>\r
520 </table>\r
521 </div>\r
522 <div class="memdoc">\r
523 \r
524 <p>\r
525 API to delete an existing Policy Handle For inbound direction API will trigger allocating resources at NetCP. Application can either block by passing transaction ID as NWAL_TRANSID_SPIN_WAIT or wait for call back being called with the results For outbound, API will return nwal_TRANS_COMPLETE and no further callback will be called.Application can free transaction ID after returning from API. \r
526 <p>\r
527 This function results in freeing up SA related resource for Security profile related resources<p>\r
528 <dl compact><dt><b>Parameters:</b></dt><dd>\r
529 <table border="0" cellspacing="2" cellpadding="0">\r
530 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
531 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>Transaction Id maintained by application. Applicable only in the case of inbound direction. The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
532 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalSecAssocHandle</em> </td><td>Connection handle returned from <a class="el" href="group__nwal__api__functions.html#gca33b2cd9bd7ccf47f024685a7749727">nwal_setSecAssoc</a></td></tr>\r
533 </table>\r
534 </dl>\r
535 <dl compact><dt><b>Return values:</b></dt><dd>\r
536 <table border="0" cellspacing="2" cellpadding="0">\r
537 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK or <a class="el" href="group__nwal___ret_value.html#gd84bd26de04054c46f419f09b69ad342">nwal_TRANS_COMPLETE</a> on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
538 </table>\r
539 </dl>\r
540 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#gca33b2cd9bd7ccf47f024685a7749727">nwal_setSecAssoc</a> </dd></dl>\r
541 \r
542 </div>\r
543 </div><p>\r
544 <a class="anchor" name="gbfbfb134f82617f4172490d7e3691f36"></a><!-- doxytag: member="nwal.h::nwal_delSecPolicy" ref="gbfbfb134f82617f4172490d7e3691f36" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_Handle nwalSecPolHandle)" -->\r
545 <div class="memitem">\r
546 <div class="memproto">\r
547 <table class="memname">\r
548 <tr>\r
549 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_delSecPolicy </td>\r
550 <td>(</td>\r
551 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
552 <td class="paramname"> <em>nwalInst</em>, </td>\r
553 </tr>\r
554 <tr>\r
555 <td class="paramkey"></td>\r
556 <td></td>\r
557 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
558 <td class="paramname"> <em>transId</em>, </td>\r
559 </tr>\r
560 <tr>\r
561 <td class="paramkey"></td>\r
562 <td></td>\r
563 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
564 <td class="paramname"> <em>nwalSecPolHandle</em></td><td> </td>\r
565 </tr>\r
566 <tr>\r
567 <td></td>\r
568 <td>)</td>\r
569 <td></td><td></td><td width="100%"></td>\r
570 </tr>\r
571 </table>\r
572 </div>\r
573 <div class="memdoc">\r
574 \r
575 <p>\r
576 API to delete an existing Policy Handle. \r
577 <p>\r
578 This function results in initiation of freeing up resource for Security profile related resources. For inbound direction API will trigger allocating resources at NetCP. Application can either block by passing transaction ID as NWAL_TRANSID_SPIN_WAIT or wait for call back being called with the results For outbound, API will return nwal_TRANS_COMPLETE and no further callback will be called.Application can free transaction ID after returning from API.<p>\r
579 <dl compact><dt><b>Parameters:</b></dt><dd>\r
580 <table border="0" cellspacing="2" cellpadding="0">\r
581 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
582 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>Transaction Id maintained by application. Applicable only in the case of inbound Sec Policy. The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to zero in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
583 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalSecPolHandle</em> </td><td>Connection handle returned from nwal_setSecPolicy.</td></tr>\r
584 </table>\r
585 </dl>\r
586 <dl compact><dt><b>Return values:</b></dt><dd>\r
587 <table border="0" cellspacing="2" cellpadding="0">\r
588 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK or <a class="el" href="group__nwal___ret_value.html#gd84bd26de04054c46f419f09b69ad342">nwal_TRANS_COMPLETE</a> on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
589 </table>\r
590 </dl>\r
591 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#gfe8015e99d27a8198ebc0dc14bb0c60b">nwal_setSecPolicy</a> </dd></dl>\r
592 \r
593 </div>\r
594 </div><p>\r
595 <a class="anchor" name="g67e3eb4e446cec804e87b0f4fec8bc25"></a><!-- doxytag: member="nwal.h::nwal_getBufferReq" ref="g67e3eb4e446cec804e87b0f4fec8bc25" args="(nwalSizeInfo_t *sizeCfg, int sizes[nwal_N_BUFS], int aligns[nwal_N_BUFS])" -->\r
596 <div class="memitem">\r
597 <div class="memproto">\r
598 <table class="memname">\r
599 <tr>\r
600 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_getBufferReq </td>\r
601 <td>(</td>\r
602 <td class="paramtype"><a class="el" href="structnwal_size_info__t.html">nwalSizeInfo_t</a> * </td>\r
603 <td class="paramname"> <em>sizeCfg</em>, </td>\r
604 </tr>\r
605 <tr>\r
606 <td class="paramkey"></td>\r
607 <td></td>\r
608 <td class="paramtype">int </td>\r
609 <td class="paramname"> <em>sizes</em>[nwal_N_BUFS], </td>\r
610 </tr>\r
611 <tr>\r
612 <td class="paramkey"></td>\r
613 <td></td>\r
614 <td class="paramtype">int </td>\r
615 <td class="paramname"> <em>aligns</em>[nwal_N_BUFS]</td><td> </td>\r
616 </tr>\r
617 <tr>\r
618 <td></td>\r
619 <td>)</td>\r
620 <td></td><td></td><td width="100%"></td>\r
621 </tr>\r
622 </table>\r
623 </div>\r
624 <div class="memdoc">\r
625 \r
626 <p>\r
627 API to retrieve memory buffer requirement by NWAL module. \r
628 <p>\r
629 Input to the API is configuration for NWAL through <a class="el" href="structnwal_size_info__t.html">nwalSizeInfo_t</a>. API returns buffer size and alignment size requirement for the module<p>\r
630 <a class="el" href="structnwal_size_info__t.html">nwalSizeInfo_t</a> Configuration information for Memory sizing. sizes Buffer sizes aligns Alignment size <dl compact><dt><b>Return values:</b></dt><dd>\r
631 <table border="0" cellspacing="2" cellpadding="0">\r
632 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
633 </table>\r
634 </dl>\r
635 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd>None </dd></dl>\r
636 \r
637 </div>\r
638 </div><p>\r
639 <a class="anchor" name="g9491a97d2695d4df29ae94ccaf7d0538"></a><!-- doxytag: member="nwal.h::nwal_getGlobCxtInfo" ref="g9491a97d2695d4df29ae94ccaf7d0538" args="(nwal_Inst nwalInst, nwalGlobCxtInfo_t *pInfo)" -->\r
640 <div class="memitem">\r
641 <div class="memproto">\r
642 <table class="memname">\r
643 <tr>\r
644 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_getGlobCxtInfo </td>\r
645 <td>(</td>\r
646 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
647 <td class="paramname"> <em>nwalInst</em>, </td>\r
648 </tr>\r
649 <tr>\r
650 <td class="paramkey"></td>\r
651 <td></td>\r
652 <td class="paramtype"><a class="el" href="structnwal_glob_cxt_info__t.html">nwalGlobCxtInfo_t</a> * </td>\r
653 <td class="paramname"> <em>pInfo</em></td><td> </td>\r
654 </tr>\r
655 <tr>\r
656 <td></td>\r
657 <td>)</td>\r
658 <td></td><td></td><td width="100%"></td>\r
659 </tr>\r
660 </table>\r
661 </div>\r
662 <div class="memdoc">\r
663 \r
664 <p>\r
665 API to retrieve global resources created by NWAL at the end of <a class="el" href="group__nwal__api__functions.html#g1822ee8a1ab76a26470ae3b16d5e0ae8">nwal_create()</a> API. \r
666 <p>\r
667 API to retrieve global resources created by NWAL through <a class="el" href="group__nwal__api__functions.html#g1822ee8a1ab76a26470ae3b16d5e0ae8">nwal_create()</a> API <dl compact><dt><b>Parameters:</b></dt><dd>\r
668 <table border="0" cellspacing="2" cellpadding="0">\r
669 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
670 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pInfo</em> </td><td>NWAL global context information </td></tr>\r
671 </table>\r
672 </dl>\r
673 <dl compact><dt><b>Return values:</b></dt><dd>\r
674 <table border="0" cellspacing="2" cellpadding="0">\r
675 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
676 </table>\r
677 </dl>\r
678 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g1822ee8a1ab76a26470ae3b16d5e0ae8">nwal_create</a> </dd></dl>\r
679 \r
680 </div>\r
681 </div><p>\r
682 <a class="anchor" name="gd6993a765961a1b21f7354a7617ffad7"></a><!-- doxytag: member="nwal.h::nwal_getIPAddr" ref="gd6993a765961a1b21f7354a7617ffad7" args="(nwal_Inst nwalInst, nwalIpParam_t *pParam, nwal_Handle pPrevHandle, nwal_Handle *pIpHandle)" -->\r
683 <div class="memitem">\r
684 <div class="memproto">\r
685 <table class="memname">\r
686 <tr>\r
687 <td class="memname"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> nwal_getIPAddr </td>\r
688 <td>(</td>\r
689 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
690 <td class="paramname"> <em>nwalInst</em>, </td>\r
691 </tr>\r
692 <tr>\r
693 <td class="paramkey"></td>\r
694 <td></td>\r
695 <td class="paramtype"><a class="el" href="structnwal_ip_param__t.html">nwalIpParam_t</a> * </td>\r
696 <td class="paramname"> <em>pParam</em>, </td>\r
697 </tr>\r
698 <tr>\r
699 <td class="paramkey"></td>\r
700 <td></td>\r
701 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
702 <td class="paramname"> <em>pPrevHandle</em>, </td>\r
703 </tr>\r
704 <tr>\r
705 <td class="paramkey"></td>\r
706 <td></td>\r
707 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
708 <td class="paramname"> <em>pIpHandle</em></td><td> </td>\r
709 </tr>\r
710 <tr>\r
711 <td></td>\r
712 <td>)</td>\r
713 <td></td><td></td><td width="100%"></td>\r
714 </tr>\r
715 </table>\r
716 </div>\r
717 <div class="memdoc">\r
718 \r
719 <p>\r
720 nwal_getIPAddr: API will check if there is already IP Address configured by application. If found returns the handle \r
721 <p>\r
722 The API lookups IP related configuration at NWAL.<p>\r
723 <dl compact><dt><b>Parameters:</b></dt><dd>\r
724 <table border="0" cellspacing="2" cellpadding="0">\r
725 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
726 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pParam</em> </td><td>IP Configuration parameters </td></tr>\r
727 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pPrevHandle</em> </td><td>Dependent MAC/IP handle </td></tr>\r
728 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pIpHandle</em> </td><td>Output handle from NWAL if found. :nwal_Handle</td></tr>\r
729 </table>\r
730 </dl>\r
731 <dl compact><dt><b>Return values:</b></dt><dd>\r
732 <table border="0" cellspacing="2" cellpadding="0">\r
733 <tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>:nwal_TRUE if found /nwal_FALSE if not configured </td></tr>\r
734 </table>\r
735 </dl>\r
736 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g0b49a46ae19bd0020a0726e40c41750c">nwal_setMacIface</a> </dd></dl>\r
737 \r
738 </div>\r
739 </div><p>\r
740 <a class="anchor" name="ga368a5b778510840d7648844616e4b45"></a><!-- doxytag: member="nwal.h::nwal_getLocCxtInfo" ref="ga368a5b778510840d7648844616e4b45" args="(nwal_Inst nwalInst, nwalLocCxtInfo_t *pInfo)" -->\r
741 <div class="memitem">\r
742 <div class="memproto">\r
743 <table class="memname">\r
744 <tr>\r
745 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_getLocCxtInfo </td>\r
746 <td>(</td>\r
747 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
748 <td class="paramname"> <em>nwalInst</em>, </td>\r
749 </tr>\r
750 <tr>\r
751 <td class="paramkey"></td>\r
752 <td></td>\r
753 <td class="paramtype"><a class="el" href="structnwal_loc_cxt_info__t.html">nwalLocCxtInfo_t</a> * </td>\r
754 <td class="paramname"> <em>pInfo</em></td><td> </td>\r
755 </tr>\r
756 <tr>\r
757 <td></td>\r
758 <td>)</td>\r
759 <td></td><td></td><td width="100%"></td>\r
760 </tr>\r
761 </table>\r
762 </div>\r
763 <div class="memdoc">\r
764 \r
765 <p>\r
766 API to retrieve local per process resources created by NWAL at the end of <a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start()</a> API. \r
767 <p>\r
768 API to retrieve local per process resources created by NWAL at the end of <a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start()</a> API <dl compact><dt><b>Parameters:</b></dt><dd>\r
769 <table border="0" cellspacing="2" cellpadding="0">\r
770 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
771 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pInfo</em> </td><td>NWAL Local context information </td></tr>\r
772 </table>\r
773 </dl>\r
774 <dl compact><dt><b>Return values:</b></dt><dd>\r
775 <table border="0" cellspacing="2" cellpadding="0">\r
776 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
777 </table>\r
778 </dl>\r
779 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g1822ee8a1ab76a26470ae3b16d5e0ae8">nwal_create</a> </dd></dl>\r
780 \r
781 </div>\r
782 </div><p>\r
783 <a class="anchor" name="g4ac963c021e794ec1bfce2f7003772d6"></a><!-- doxytag: member="nwal.h::nwal_getMacIface" ref="g4ac963c021e794ec1bfce2f7003772d6" args="(nwal_Inst nwalInst, nwalMacParam_t *pParam, nwal_Handle *pIfHandle)" -->\r
784 <div class="memitem">\r
785 <div class="memproto">\r
786 <table class="memname">\r
787 <tr>\r
788 <td class="memname"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> nwal_getMacIface </td>\r
789 <td>(</td>\r
790 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
791 <td class="paramname"> <em>nwalInst</em>, </td>\r
792 </tr>\r
793 <tr>\r
794 <td class="paramkey"></td>\r
795 <td></td>\r
796 <td class="paramtype"><a class="el" href="structnwal_mac_param__t.html">nwalMacParam_t</a> * </td>\r
797 <td class="paramname"> <em>pParam</em>, </td>\r
798 </tr>\r
799 <tr>\r
800 <td class="paramkey"></td>\r
801 <td></td>\r
802 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
803 <td class="paramname"> <em>pIfHandle</em></td><td> </td>\r
804 </tr>\r
805 <tr>\r
806 <td></td>\r
807 <td>)</td>\r
808 <td></td><td></td><td width="100%"></td>\r
809 </tr>\r
810 </table>\r
811 </div>\r
812 <div class="memdoc">\r
813 \r
814 <p>\r
815 nwal_getMacIface: API will check for already configuration for MAC entry \r
816 <p>\r
817 The API lookups L2/MAC related configuration at NWAL.<p>\r
818 <dl compact><dt><b>Parameters:</b></dt><dd>\r
819 <table border="0" cellspacing="2" cellpadding="0">\r
820 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
821 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pParam</em> </td><td><a class="el" href="group__nwal_mac_param__t.html">MAC configuration Parameter for nwal_setMacIface</a> </td></tr>\r
822 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pIfHandle</em> </td><td>Output handle from NWAL if found. :nwal_Handle</td></tr>\r
823 </table>\r
824 </dl>\r
825 <dl compact><dt><b>Return values:</b></dt><dd>\r
826 <table border="0" cellspacing="2" cellpadding="0">\r
827 <tr><td valign="top"></td><td valign="top"><em>nwal_TRUE</em> </td><td>if found / nwal_FALSE if not configured </td></tr>\r
828 </table>\r
829 </dl>\r
830 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </dd></dl>\r
831 \r
832 </div>\r
833 </div><p>\r
834 <a class="anchor" name="g14fd102b2d3b8d942cb86b8b8d2dbf72"></a><!-- doxytag: member="nwal.h::nwal_getPAStats" ref="g14fd102b2d3b8d942cb86b8b8d2dbf72" args="(nwal_Inst nwalInst, nwal_TransID_t transId, paSysStats_t *pPaStats, nwal_Bool_t doClear)" -->\r
835 <div class="memitem">\r
836 <div class="memproto">\r
837 <table class="memname">\r
838 <tr>\r
839 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_getPAStats </td>\r
840 <td>(</td>\r
841 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
842 <td class="paramname"> <em>nwalInst</em>, </td>\r
843 </tr>\r
844 <tr>\r
845 <td class="paramkey"></td>\r
846 <td></td>\r
847 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
848 <td class="paramname"> <em>transId</em>, </td>\r
849 </tr>\r
850 <tr>\r
851 <td class="paramkey"></td>\r
852 <td></td>\r
853 <td class="paramtype">paSysStats_t * </td>\r
854 <td class="paramname"> <em>pPaStats</em>, </td>\r
855 </tr>\r
856 <tr>\r
857 <td class="paramkey"></td>\r
858 <td></td>\r
859 <td class="paramtype"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> </td>\r
860 <td class="paramname"> <em>doClear</em></td><td> </td>\r
861 </tr>\r
862 <tr>\r
863 <td></td>\r
864 <td>)</td>\r
865 <td></td><td></td><td width="100%"></td>\r
866 </tr>\r
867 </table>\r
868 </div>\r
869 <div class="memdoc">\r
870 \r
871 <p>\r
872 nwal_getPAStats: Get Statistics from PA \r
873 <p>\r
874 The API is to querry the stats from PA.If multiple request is initiated callback will be only called with latest transId<p>\r
875 <dl compact><dt><b>Parameters:</b></dt><dd>\r
876 <table border="0" cellspacing="2" cellpadding="0">\r
877 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
878 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
879 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pPaStats</em> </td><td>Valid only if pStatsCallback is NULL and stats requested as blocking call </td></tr>\r
880 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>doClear</em> </td><td>True to clear the stats. Alternatively False</td></tr>\r
881 </table>\r
882 </dl>\r
883 <dl compact><dt><b>Return values:</b></dt><dd>\r
884 <table border="0" cellspacing="2" cellpadding="0">\r
885 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
886 </table>\r
887 </dl>\r
888 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </dd></dl>\r
889 \r
890 </div>\r
891 </div><p>\r
892 <a class="anchor" name="g206ce6e6f7ffe6145836023f046ffb60"></a><!-- doxytag: member="nwal.h::nwal_getSecAssoc" ref="g206ce6e6f7ffe6145836023f046ffb60" args="(nwal_Inst nwalInst, nwalSaIpSecId_t *pSaId, nwal_IPSecDir dir, nwal_Handle *pNwalSecAssocHandle)" -->\r
893 <div class="memitem">\r
894 <div class="memproto">\r
895 <table class="memname">\r
896 <tr>\r
897 <td class="memname"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> nwal_getSecAssoc </td>\r
898 <td>(</td>\r
899 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
900 <td class="paramname"> <em>nwalInst</em>, </td>\r
901 </tr>\r
902 <tr>\r
903 <td class="paramkey"></td>\r
904 <td></td>\r
905 <td class="paramtype"><a class="el" href="structnwal_sa_ip_sec_id__t.html">nwalSaIpSecId_t</a> * </td>\r
906 <td class="paramname"> <em>pSaId</em>, </td>\r
907 </tr>\r
908 <tr>\r
909 <td class="paramkey"></td>\r
910 <td></td>\r
911 <td class="paramtype"><a class="el" href="nwal_8h.html#8066f3731e362c5f305b19ee4ff0609f">nwal_IPSecDir</a> </td>\r
912 <td class="paramname"> <em>dir</em>, </td>\r
913 </tr>\r
914 <tr>\r
915 <td class="paramkey"></td>\r
916 <td></td>\r
917 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
918 <td class="paramname"> <em>pNwalSecAssocHandle</em></td><td> </td>\r
919 </tr>\r
920 <tr>\r
921 <td></td>\r
922 <td>)</td>\r
923 <td></td><td></td><td width="100%"></td>\r
924 </tr>\r
925 </table>\r
926 </div>\r
927 <div class="memdoc">\r
928 \r
929 <p>\r
930 Get an IPSec Security Association Channel. \r
931 <p>\r
932 This function looks up for an existing outer IPSec Security Association Channel. <dl compact><dt><b>Parameters:</b></dt><dd>\r
933 <table border="0" cellspacing="2" cellpadding="0">\r
934 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
935 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pSaId</em> </td><td>SA ID uniquely identifying Tunnel </td></tr>\r
936 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dir</em> </td><td>Direction <a class="el" href="nwal_8h.html#98a9668197a0ab59e4028a642ae69036">NWAL_IPSEC_DIR_INBOUND</a> or <a class="el" href="nwal_8h.html#70448dea2e8e092b3014b1a27152476f">NWAL_IPSEC_DIR_OUTBOUND</a> </td></tr>\r
937 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pNwalSecAssocHandle</em> </td><td>Returns nwal_TRUE with NWAL Handle for SA channel if found, nwal_FALSE if not found with NULL as handle </td></tr>\r
938 </table>\r
939 </dl>\r
940 <dl compact><dt><b>Return values:</b></dt><dd>\r
941 <table border="0" cellspacing="2" cellpadding="0">\r
942 <tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>:nwal_TRUE if found /nwal_FALSE if not configured </td></tr>\r
943 </table>\r
944 </dl>\r
945 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g0b49a46ae19bd0020a0726e40c41750c">nwal_setMacIface</a> </dd></dl>\r
946 \r
947 </div>\r
948 </div><p>\r
949 <a class="anchor" name="ge9b0a2500f33214fd0758158edf34a22"></a><!-- doxytag: member="nwal.h::nwal_getSecPolicy" ref="ge9b0a2500f33214fd0758158edf34a22" args="(nwal_Inst nwalInst, nwalSecPolParams_t *pPolParam, nwal_Handle *pNwalSecPolHandle)" -->\r
950 <div class="memitem">\r
951 <div class="memproto">\r
952 <table class="memname">\r
953 <tr>\r
954 <td class="memname"><a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> nwal_getSecPolicy </td>\r
955 <td>(</td>\r
956 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
957 <td class="paramname"> <em>nwalInst</em>, </td>\r
958 </tr>\r
959 <tr>\r
960 <td class="paramkey"></td>\r
961 <td></td>\r
962 <td class="paramtype"><a class="el" href="structnwal_sec_pol_params__t.html">nwalSecPolParams_t</a> * </td>\r
963 <td class="paramname"> <em>pPolParam</em>, </td>\r
964 </tr>\r
965 <tr>\r
966 <td class="paramkey"></td>\r
967 <td></td>\r
968 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
969 <td class="paramname"> <em>pNwalSecPolHandle</em></td><td> </td>\r
970 </tr>\r
971 <tr>\r
972 <td></td>\r
973 <td>)</td>\r
974 <td></td><td></td><td width="100%"></td>\r
975 </tr>\r
976 </table>\r
977 </div>\r
978 <div class="memdoc">\r
979 \r
980 <p>\r
981 API to retrieve handle for existing security policy for a connection. \r
982 <p>\r
983 API to retrieve handle for existing security policy for a connection. <dl compact><dt><b>Parameters:</b></dt><dd>\r
984 <table border="0" cellspacing="2" cellpadding="0">\r
985 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
986 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pPolParam</em> </td><td>Configuration information for Security profile for IPSec Channel. </td></tr>\r
987 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pNwalSecPolHandle</em> </td><td>Returns nwal_TRUE with NWAL Handle for SA channel if found, nwal_FALSE if not found with NULL as handle </td></tr>\r
988 </table>\r
989 </dl>\r
990 <dl compact><dt><b>Return values:</b></dt><dd>\r
991 <table border="0" cellspacing="2" cellpadding="0">\r
992 <tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>:nwal_TRUE if found /nwal_FALSE if not configured </td></tr>\r
993 </table>\r
994 </dl>\r
995 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#gca33b2cd9bd7ccf47f024685a7749727">nwal_setSecAssoc</a> </dd></dl>\r
996 \r
997 </div>\r
998 </div><p>\r
999 <a class="anchor" name="g32fdcdfe7e992b416502eab84de846fb"></a><!-- doxytag: member="nwal.h::nwal_pollCtl" ref="g32fdcdfe7e992b416502eab84de846fb" args="(nwal_Inst nwalInst, nwal_CmdCallBack *pCmdCallBack, nwal_CmdPaStatsReply *pPaStatsCallBack)" -->\r
1000 <div class="memitem">\r
1001 <div class="memproto">\r
1002 <table class="memname">\r
1003 <tr>\r
1004 <td class="memname">void nwal_pollCtl </td>\r
1005 <td>(</td>\r
1006 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1007 <td class="paramname"> <em>nwalInst</em>, </td>\r
1008 </tr>\r
1009 <tr>\r
1010 <td class="paramkey"></td>\r
1011 <td></td>\r
1012 <td class="paramtype"><a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack</a> * </td>\r
1013 <td class="paramname"> <em>pCmdCallBack</em>, </td>\r
1014 </tr>\r
1015 <tr>\r
1016 <td class="paramkey"></td>\r
1017 <td></td>\r
1018 <td class="paramtype"><a class="el" href="group___external_callbacks.html#g7a490e5146f40d17de861888dcc3ed12">nwal_CmdPaStatsReply</a> * </td>\r
1019 <td class="paramname"> <em>pPaStatsCallBack</em></td><td> </td>\r
1020 </tr>\r
1021 <tr>\r
1022 <td></td>\r
1023 <td>)</td>\r
1024 <td></td><td></td><td width="100%"></td>\r
1025 </tr>\r
1026 </table>\r
1027 </div>\r
1028 <div class="memdoc">\r
1029 \r
1030 <p>\r
1031 nwal_pollCtl: API for polling Control message response from NetCP: PA Subsystem. \r
1032 <p>\r
1033 The API will poll for control message response from NetCP PA Subsystem <dl compact><dt><b>Parameters:</b></dt><dd>\r
1034 <table border="0" cellspacing="2" cellpadding="0">\r
1035 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1036 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pCmdCallBack</em> </td><td>Optional:Callback for configuration response processing at application. If passed as NULL,NWAL will use default callback passed during <a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </td></tr>\r
1037 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pPaStatsCallBack</em> </td><td>Optional:Callback for PA Stats response processing at application. If passed as NULL, NWAL will use default callback passed during <a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </td></tr>\r
1038 </table>\r
1039 </dl>\r
1040 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </dd></dl>\r
1041 \r
1042 </div>\r
1043 </div><p>\r
1044 <a class="anchor" name="g220abef4dc0cd6e26f55117c8f9cf72d"></a><!-- doxytag: member="nwal.h::nwal_pollPkt" ref="g220abef4dc0cd6e26f55117c8f9cf72d" args="(nwal_Inst nwalInst, nwal_pollPktQCtl pktQCtl, uint32_t appCookie, uint16_t maxPkts, Qmss_QueueHnd appRxPktQueue, nwal_rxPktCallBack *pRxPktCallBack)" -->\r
1045 <div class="memitem">\r
1046 <div class="memproto">\r
1047 <table class="memname">\r
1048 <tr>\r
1049 <td class="memname">uint16_t nwal_pollPkt </td>\r
1050 <td>(</td>\r
1051 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1052 <td class="paramname"> <em>nwalInst</em>, </td>\r
1053 </tr>\r
1054 <tr>\r
1055 <td class="paramkey"></td>\r
1056 <td></td>\r
1057 <td class="paramtype"><a class="el" href="nwal_8h.html#2ce41d72fbf1aa7109d89a4a93884660">nwal_pollPktQCtl</a> </td>\r
1058 <td class="paramname"> <em>pktQCtl</em>, </td>\r
1059 </tr>\r
1060 <tr>\r
1061 <td class="paramkey"></td>\r
1062 <td></td>\r
1063 <td class="paramtype">uint32_t </td>\r
1064 <td class="paramname"> <em>appCookie</em>, </td>\r
1065 </tr>\r
1066 <tr>\r
1067 <td class="paramkey"></td>\r
1068 <td></td>\r
1069 <td class="paramtype">uint16_t </td>\r
1070 <td class="paramname"> <em>maxPkts</em>, </td>\r
1071 </tr>\r
1072 <tr>\r
1073 <td class="paramkey"></td>\r
1074 <td></td>\r
1075 <td class="paramtype">Qmss_QueueHnd </td>\r
1076 <td class="paramname"> <em>appRxPktQueue</em>, </td>\r
1077 </tr>\r
1078 <tr>\r
1079 <td class="paramkey"></td>\r
1080 <td></td>\r
1081 <td class="paramtype"><a class="el" href="group___external_callbacks.html#g202f54ea7a87c9c1059266d19ef988d5">nwal_rxPktCallBack</a> * </td>\r
1082 <td class="paramname"> <em>pRxPktCallBack</em></td><td> </td>\r
1083 </tr>\r
1084 <tr>\r
1085 <td></td>\r
1086 <td>)</td>\r
1087 <td></td><td></td><td width="100%"></td>\r
1088 </tr>\r
1089 </table>\r
1090 </div>\r
1091 <div class="memdoc">\r
1092 \r
1093 <p>\r
1094 nwal_pollPkt: API for polling packets from network. \r
1095 <p>\r
1096 The API will poll for packets from Network. In case if application provides an application managed packet Queue, module will poll packet from that Queue.<p>\r
1097 <dl compact><dt><b>Parameters:</b></dt><dd>\r
1098 <table border="0" cellspacing="2" cellpadding="0">\r
1099 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1100 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pktQCtl</em> </td><td>Bitmap for polling packets from queue for poll <a class="el" href="group__nwal__poll_pkt_q_ctl.html">Poll Control Bit map</a> </td></tr>\r
1101 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>appCookie</em> </td><td>Optional Application context information if required for a poll. Set to NULL if not used </td></tr>\r
1102 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>maxPkts</em> </td><td>Poll and accumulate upto this count per Queue. Maximum value can be NWAL_MAX_RX_PKT_THRESHOLD </td></tr>\r
1103 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>appRxPktQueue</em> </td><td>Optional. Application managed Queue Handle. Required only if API is called for <a class="el" href="nwal_8h.html#26da5f7b22ea10ae0d8d2f20d7775ffc">nwal_POLL_APP_MANAGED_PKT_Q</a>. Set to QMSS_PARAM_NOT_SPECIFIED if not used </td></tr>\r
1104 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pRxPktCallBack</em> </td><td>Optional:Callback for packet processing at application. Set to NULL for NWAL to use default </td></tr>\r
1105 </table>\r
1106 </dl>\r
1107 <dl compact><dt><b>Return values:</b></dt><dd>\r
1108 <table border="0" cellspacing="2" cellpadding="0">\r
1109 <tr><td valign="top"></td><td valign="top"><em>Number</em> </td><td>of packets returned through callback callback configured during <a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </td></tr>\r
1110 </table>\r
1111 </dl>\r
1112 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </dd></dl>\r
1113 \r
1114 </div>\r
1115 </div><p>\r
1116 <a class="anchor" name="g3a6de9ce78144e80feb5ad45db73ae81"></a><!-- doxytag: member="nwal.h::nwal_refreshConn" ref="g3a6de9ce78144e80feb5ad45db73ae81" args="(nwal_Inst nwalInst, nwal_Handle nwalHandle)" -->\r
1117 <div class="memitem">\r
1118 <div class="memproto">\r
1119 <table class="memname">\r
1120 <tr>\r
1121 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_refreshConn </td>\r
1122 <td>(</td>\r
1123 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1124 <td class="paramname"> <em>nwalInst</em>, </td>\r
1125 </tr>\r
1126 <tr>\r
1127 <td class="paramkey"></td>\r
1128 <td></td>\r
1129 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
1130 <td class="paramname"> <em>nwalHandle</em></td><td> </td>\r
1131 </tr>\r
1132 <tr>\r
1133 <td></td>\r
1134 <td>)</td>\r
1135 <td></td><td></td><td width="100%"></td>\r
1136 </tr>\r
1137 </table>\r
1138 </div>\r
1139 <div class="memdoc">\r
1140 \r
1141 <p>\r
1142 nwal_refreshConn: Refreshes a connection for the core. \r
1143 <p>\r
1144 API to be used to refresh an NWAL handle created external to the core <dl compact><dt><b>Parameters:</b></dt><dd>\r
1145 <table border="0" cellspacing="2" cellpadding="0">\r
1146 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1147 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalHandle</em> </td><td>Handle created external to the core. The handle could be the one returned from following APIs <a class="el" href="group__nwal__api__functions.html#g0b49a46ae19bd0020a0726e40c41750c">nwal_setMacIface</a>, <a class="el" href="group__nwal__api__functions.html#g088d54ec748e8a8ceab0d8314424bbe0">nwal_setIPAddr</a> , <a class="el" href="group__nwal__api__functions.html#gca33b2cd9bd7ccf47f024685a7749727">nwal_setSecAssoc</a>, <a class="el" href="group__nwal__api__functions.html#gfe8015e99d27a8198ebc0dc14bb0c60b">nwal_setSecPolicy</a> </td></tr>\r
1148 </table>\r
1149 </dl>\r
1150 <dl compact><dt><b>Return values:</b></dt><dd>\r
1151 <table border="0" cellspacing="2" cellpadding="0">\r
1152 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
1153 </table>\r
1154 </dl>\r
1155 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#gfa8c0d4f3cc343d34c617ca633f7206e">nwal_addConn</a> </dd></dl>\r
1156 \r
1157 </div>\r
1158 </div><p>\r
1159 <a class="anchor" name="g9becdd27693d5b7d564274c6a9798b5a"></a><!-- doxytag: member="nwal.h::nwal_send" ref="g9becdd27693d5b7d564274c6a9798b5a" args="(nwal_Inst nwalInst, nwal_Handle nwalHandle, nwalTxPktInfo_t *pPktInfo)" -->\r
1160 <div class="memitem">\r
1161 <div class="memproto">\r
1162 <table class="memname">\r
1163 <tr>\r
1164 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_send </td>\r
1165 <td>(</td>\r
1166 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1167 <td class="paramname"> <em>nwalInst</em>, </td>\r
1168 </tr>\r
1169 <tr>\r
1170 <td class="paramkey"></td>\r
1171 <td></td>\r
1172 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
1173 <td class="paramname"> <em>nwalHandle</em>, </td>\r
1174 </tr>\r
1175 <tr>\r
1176 <td class="paramkey"></td>\r
1177 <td></td>\r
1178 <td class="paramtype"><a class="el" href="structnwal_tx_pkt_info__t.html">nwalTxPktInfo_t</a> * </td>\r
1179 <td class="paramname"> <em>pPktInfo</em></td><td> </td>\r
1180 </tr>\r
1181 <tr>\r
1182 <td></td>\r
1183 <td>)</td>\r
1184 <td></td><td></td><td width="100%"></td>\r
1185 </tr>\r
1186 </table>\r
1187 </div>\r
1188 <div class="memdoc">\r
1189 \r
1190 <p>\r
1191 nwal_send: Transmit packet out for a connection \r
1192 <p>\r
1193 The API will result in transmission of packets out. Freeing of descriptors is not handled with in NWAL at the end of transmission. It is assumed that application has configured hardware to return to free queue once packet is transmitted out. The API also prepends L2/L3/L4 header if application passed NULL for pHdrDesc parameter.<p>\r
1194 <dl compact><dt><b>Parameters:</b></dt><dd>\r
1195 <table border="0" cellspacing="2" cellpadding="0">\r
1196 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1197 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalHandle</em> </td><td>Can be either<ul>\r
1198 <li>connHandle returned from <a class="el" href="group__nwal__api__functions.html#gfa8c0d4f3cc343d34c617ca633f7206e">nwal_addConn</a> or</li><li>nwalSecPolHandle returned from <a class="el" href="group__nwal__api__functions.html#gfe8015e99d27a8198ebc0dc14bb0c60b">nwal_setSecPolicy</a> for sending packets with IPSec header</li><li>nwal_HANDLE_INVALID if packets already contains protocol headers. </li></ul>\r
1199 </td></tr>\r
1200 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pPktInfo</em> </td><td>Transmit packet information <a class="el" href="group__nwal_tx_pkt_info__t.html">NWAL Packet meta data information for outgoing packet</a></td></tr>\r
1201 </table>\r
1202 </dl>\r
1203 <dl compact><dt><b>Return values:</b></dt><dd>\r
1204 <table border="0" cellspacing="2" cellpadding="0">\r
1205 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
1206 </table>\r
1207 </dl>\r
1208 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </dd></dl>\r
1209 \r
1210 </div>\r
1211 </div><p>\r
1212 <a class="anchor" name="g113edc64f9b709805625a49a0a5c25ba"></a><!-- doxytag: member="nwal.h::nwal_sendRaw" ref="g113edc64f9b709805625a49a0a5c25ba" args="(nwal_Inst nwalInst, uint16_t bufLen, uint8_t *pBuf)" -->\r
1213 <div class="memitem">\r
1214 <div class="memproto">\r
1215 <table class="memname">\r
1216 <tr>\r
1217 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_sendRaw </td>\r
1218 <td>(</td>\r
1219 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1220 <td class="paramname"> <em>nwalInst</em>, </td>\r
1221 </tr>\r
1222 <tr>\r
1223 <td class="paramkey"></td>\r
1224 <td></td>\r
1225 <td class="paramtype">uint16_t </td>\r
1226 <td class="paramname"> <em>bufLen</em>, </td>\r
1227 </tr>\r
1228 <tr>\r
1229 <td class="paramkey"></td>\r
1230 <td></td>\r
1231 <td class="paramtype">uint8_t * </td>\r
1232 <td class="paramname"> <em>pBuf</em></td><td> </td>\r
1233 </tr>\r
1234 <tr>\r
1235 <td></td>\r
1236 <td>)</td>\r
1237 <td></td><td></td><td width="100%"></td>\r
1238 </tr>\r
1239 </table>\r
1240 </div>\r
1241 <div class="memdoc">\r
1242 \r
1243 <p>\r
1244 nwal_sendRaw: Transmit raw packet to the PA \r
1245 <p>\r
1246 The API transmits the raw packet to the PA.<p>\r
1247 <dl compact><dt><b>Parameters:</b></dt><dd>\r
1248 <table border="0" cellspacing="2" cellpadding="0">\r
1249 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1250 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>bufLen</em> </td><td>Length of buffer being transmitted. </td></tr>\r
1251 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pBuf</em> </td><td>Byte array with the payload</td></tr>\r
1252 </table>\r
1253 </dl>\r
1254 <dl compact><dt><b>Return values:</b></dt><dd>\r
1255 <table border="0" cellspacing="2" cellpadding="0">\r
1256 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
1257 </table>\r
1258 </dl>\r
1259 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </dd></dl>\r
1260 \r
1261 </div>\r
1262 </div><p>\r
1263 <a class="anchor" name="g088d54ec748e8a8ceab0d8314424bbe0"></a><!-- doxytag: member="nwal.h::nwal_setIPAddr" ref="g088d54ec748e8a8ceab0d8314424bbe0" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_AppId appId, nwal_Handle ifHandle, nwalIpParam_t *pParam, nwal_Handle *pIpHandle)" -->\r
1264 <div class="memitem">\r
1265 <div class="memproto">\r
1266 <table class="memname">\r
1267 <tr>\r
1268 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_setIPAddr </td>\r
1269 <td>(</td>\r
1270 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1271 <td class="paramname"> <em>nwalInst</em>, </td>\r
1272 </tr>\r
1273 <tr>\r
1274 <td class="paramkey"></td>\r
1275 <td></td>\r
1276 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
1277 <td class="paramname"> <em>transId</em>, </td>\r
1278 </tr>\r
1279 <tr>\r
1280 <td class="paramkey"></td>\r
1281 <td></td>\r
1282 <td class="paramtype"><a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> </td>\r
1283 <td class="paramname"> <em>appId</em>, </td>\r
1284 </tr>\r
1285 <tr>\r
1286 <td class="paramkey"></td>\r
1287 <td></td>\r
1288 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> </td>\r
1289 <td class="paramname"> <em>ifHandle</em>, </td>\r
1290 </tr>\r
1291 <tr>\r
1292 <td class="paramkey"></td>\r
1293 <td></td>\r
1294 <td class="paramtype"><a class="el" href="structnwal_ip_param__t.html">nwalIpParam_t</a> * </td>\r
1295 <td class="paramname"> <em>pParam</em>, </td>\r
1296 </tr>\r
1297 <tr>\r
1298 <td class="paramkey"></td>\r
1299 <td></td>\r
1300 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
1301 <td class="paramname"> <em>pIpHandle</em></td><td> </td>\r
1302 </tr>\r
1303 <tr>\r
1304 <td></td>\r
1305 <td>)</td>\r
1306 <td></td><td></td><td width="100%"></td>\r
1307 </tr>\r
1308 </table>\r
1309 </div>\r
1310 <div class="memdoc">\r
1311 \r
1312 <p>\r
1313 nwal_setIPAddr: Add IP Address configuration to NETCP. \r
1314 <p>\r
1315 API configures NetCP to add classification rule for local IP Address<p>\r
1316 <dl compact><dt><b>Parameters:</b></dt><dd>\r
1317 <table border="0" cellspacing="2" cellpadding="0">\r
1318 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1319 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
1320 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>appId</em> </td><td>Application ID to be registered. The handle will be used for all interfaces from NWAL to application: 1) Asynchronous confirmation of configuration response 2) Any packets received from NetCP related to this handle </td></tr>\r
1321 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ifHandle</em> </td><td>Handle returned to application from :nwal_setMacIface. </td></tr>\r
1322 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pParam</em> </td><td>Configuration parameters for IP classification </td></tr>\r
1323 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pIpHandle</em> </td><td>Handle for IP related resource</td></tr>\r
1324 </table>\r
1325 </dl>\r
1326 <dl compact><dt><b>Return values:</b></dt><dd>\r
1327 <table border="0" cellspacing="2" cellpadding="0">\r
1328 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
1329 </table>\r
1330 </dl>\r
1331 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g0b49a46ae19bd0020a0726e40c41750c">nwal_setMacIface</a> </dd></dl>\r
1332 \r
1333 </div>\r
1334 </div><p>\r
1335 <a class="anchor" name="g0b49a46ae19bd0020a0726e40c41750c"></a><!-- doxytag: member="nwal.h::nwal_setMacIface" ref="g0b49a46ae19bd0020a0726e40c41750c" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_AppId appId, nwalMacParam_t *pParam, nwal_Handle *pIfHandle)" -->\r
1336 <div class="memitem">\r
1337 <div class="memproto">\r
1338 <table class="memname">\r
1339 <tr>\r
1340 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_setMacIface </td>\r
1341 <td>(</td>\r
1342 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1343 <td class="paramname"> <em>nwalInst</em>, </td>\r
1344 </tr>\r
1345 <tr>\r
1346 <td class="paramkey"></td>\r
1347 <td></td>\r
1348 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
1349 <td class="paramname"> <em>transId</em>, </td>\r
1350 </tr>\r
1351 <tr>\r
1352 <td class="paramkey"></td>\r
1353 <td></td>\r
1354 <td class="paramtype"><a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> </td>\r
1355 <td class="paramname"> <em>appId</em>, </td>\r
1356 </tr>\r
1357 <tr>\r
1358 <td class="paramkey"></td>\r
1359 <td></td>\r
1360 <td class="paramtype"><a class="el" href="structnwal_mac_param__t.html">nwalMacParam_t</a> * </td>\r
1361 <td class="paramname"> <em>pParam</em>, </td>\r
1362 </tr>\r
1363 <tr>\r
1364 <td class="paramkey"></td>\r
1365 <td></td>\r
1366 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
1367 <td class="paramname"> <em>pIfHandle</em></td><td> </td>\r
1368 </tr>\r
1369 <tr>\r
1370 <td></td>\r
1371 <td>)</td>\r
1372 <td></td><td></td><td width="100%"></td>\r
1373 </tr>\r
1374 </table>\r
1375 </div>\r
1376 <div class="memdoc">\r
1377 \r
1378 <p>\r
1379 nwal_setMacIface: Configures MAC LUT entry at NetCP. \r
1380 <p>\r
1381 The API configures L2/MAC related configuration to NetCP.<p>\r
1382 <dl compact><dt><b>Parameters:</b></dt><dd>\r
1383 <table border="0" cellspacing="2" cellpadding="0">\r
1384 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1385 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
1386 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>appId</em> </td><td>Application ID to be registered. The handle will be used for all interfaces from NWAL to application: 1) Asynchronous confirmation of configuration response 2) Any packets received from NetCP related to this handle </td></tr>\r
1387 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pParam</em> </td><td>Configuration parameters. :<a class="el" href="structnwal_mac_param__t.html">nwalMacParam_t</a> </td></tr>\r
1388 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pIfHandle</em> </td><td>Output handle from NWAL. To be used for any next route classification based on this interface handle. :nwal_Handle</td></tr>\r
1389 </table>\r
1390 </dl>\r
1391 <dl compact><dt><b>Return values:</b></dt><dd>\r
1392 <table border="0" cellspacing="2" cellpadding="0">\r
1393 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
1394 </table>\r
1395 </dl>\r
1396 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g90852da1af033180d619e147594a869e">nwal_start</a> </dd></dl>\r
1397 \r
1398 </div>\r
1399 </div><p>\r
1400 <a class="anchor" name="gca33b2cd9bd7ccf47f024685a7749727"></a><!-- doxytag: member="nwal.h::nwal_setSecAssoc" ref="gca33b2cd9bd7ccf47f024685a7749727" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_AppId appId, nwalSaIpSecId_t *pSaId, nwalCreateSAParams_t *pCreateParam, nwal_Handle *pNwalSecAssocHandle)" -->\r
1401 <div class="memitem">\r
1402 <div class="memproto">\r
1403 <table class="memname">\r
1404 <tr>\r
1405 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_setSecAssoc </td>\r
1406 <td>(</td>\r
1407 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1408 <td class="paramname"> <em>nwalInst</em>, </td>\r
1409 </tr>\r
1410 <tr>\r
1411 <td class="paramkey"></td>\r
1412 <td></td>\r
1413 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
1414 <td class="paramname"> <em>transId</em>, </td>\r
1415 </tr>\r
1416 <tr>\r
1417 <td class="paramkey"></td>\r
1418 <td></td>\r
1419 <td class="paramtype"><a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> </td>\r
1420 <td class="paramname"> <em>appId</em>, </td>\r
1421 </tr>\r
1422 <tr>\r
1423 <td class="paramkey"></td>\r
1424 <td></td>\r
1425 <td class="paramtype"><a class="el" href="structnwal_sa_ip_sec_id__t.html">nwalSaIpSecId_t</a> * </td>\r
1426 <td class="paramname"> <em>pSaId</em>, </td>\r
1427 </tr>\r
1428 <tr>\r
1429 <td class="paramkey"></td>\r
1430 <td></td>\r
1431 <td class="paramtype"><a class="el" href="structnwal_create_s_a_params__t.html">nwalCreateSAParams_t</a> * </td>\r
1432 <td class="paramname"> <em>pCreateParam</em>, </td>\r
1433 </tr>\r
1434 <tr>\r
1435 <td class="paramkey"></td>\r
1436 <td></td>\r
1437 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
1438 <td class="paramname"> <em>pNwalSecAssocHandle</em></td><td> </td>\r
1439 </tr>\r
1440 <tr>\r
1441 <td></td>\r
1442 <td>)</td>\r
1443 <td></td><td></td><td width="100%"></td>\r
1444 </tr>\r
1445 </table>\r
1446 </div>\r
1447 <div class="memdoc">\r
1448 \r
1449 <p>\r
1450 API to create outer IPSec Security Association Channel For inbound direction API will trigger allocating resources at NetCP. Application can either block by passing transaction ID as NWAL_TRANSID_SPIN_WAIT or wait for call back being called with the results For outbound, API will return nwal_TRANS_COMPLETE and no further callback will be called.Application can free transaction ID after returning from API. \r
1451 <p>\r
1452 This function create outer IPSec Security Association Channel. <dl compact><dt><b>Parameters:</b></dt><dd>\r
1453 <table border="0" cellspacing="2" cellpadding="0">\r
1454 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1455 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>Transaction Id maintained by application. Applicable only in the case of inbound direction. The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
1456 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>appId</em> </td><td>Application ID to be registered. The handle will be used for all interfaces from NWAL to application: 1) Asynchronous confirmation of configuration response 2) Any packets received from NetCP related to this handle </td></tr>\r
1457 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pSaId</em> </td><td>SA ID uniquely identifying Tunnel </td></tr>\r
1458 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pCreateParam</em> </td><td>Configuration parameters. </td></tr>\r
1459 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pNwalSecAssocHandle</em> </td><td>NWAL Handle for SA channel</td></tr>\r
1460 </table>\r
1461 </dl>\r
1462 <dl compact><dt><b>Return values:</b></dt><dd>\r
1463 <table border="0" cellspacing="2" cellpadding="0">\r
1464 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK or <a class="el" href="group__nwal___ret_value.html#gd84bd26de04054c46f419f09b69ad342">nwal_TRANS_COMPLETE</a> on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
1465 </table>\r
1466 </dl>\r
1467 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g0b49a46ae19bd0020a0726e40c41750c">nwal_setMacIface</a> </dd></dl>\r
1468 \r
1469 </div>\r
1470 </div><p>\r
1471 <a class="anchor" name="gfe8015e99d27a8198ebc0dc14bb0c60b"></a><!-- doxytag: member="nwal.h::nwal_setSecPolicy" ref="gfe8015e99d27a8198ebc0dc14bb0c60b" args="(nwal_Inst nwalInst, nwal_TransID_t transId, nwal_AppId appId, nwalSecPolParams_t *pPolParam, nwal_Handle *pNwalSecPolHandle)" -->\r
1472 <div class="memitem">\r
1473 <div class="memproto">\r
1474 <table class="memname">\r
1475 <tr>\r
1476 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_setSecPolicy </td>\r
1477 <td>(</td>\r
1478 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1479 <td class="paramname"> <em>nwalInst</em>, </td>\r
1480 </tr>\r
1481 <tr>\r
1482 <td class="paramkey"></td>\r
1483 <td></td>\r
1484 <td class="paramtype"><a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> </td>\r
1485 <td class="paramname"> <em>transId</em>, </td>\r
1486 </tr>\r
1487 <tr>\r
1488 <td class="paramkey"></td>\r
1489 <td></td>\r
1490 <td class="paramtype"><a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> </td>\r
1491 <td class="paramname"> <em>appId</em>, </td>\r
1492 </tr>\r
1493 <tr>\r
1494 <td class="paramkey"></td>\r
1495 <td></td>\r
1496 <td class="paramtype"><a class="el" href="structnwal_sec_pol_params__t.html">nwalSecPolParams_t</a> * </td>\r
1497 <td class="paramname"> <em>pPolParam</em>, </td>\r
1498 </tr>\r
1499 <tr>\r
1500 <td class="paramkey"></td>\r
1501 <td></td>\r
1502 <td class="paramtype"><a class="el" href="nwal_8h.html#4798eb44a470ec16617a4e547985a4d6">nwal_Handle</a> * </td>\r
1503 <td class="paramname"> <em>pNwalSecPolHandle</em></td><td> </td>\r
1504 </tr>\r
1505 <tr>\r
1506 <td></td>\r
1507 <td>)</td>\r
1508 <td></td><td></td><td width="100%"></td>\r
1509 </tr>\r
1510 </table>\r
1511 </div>\r
1512 <div class="memdoc">\r
1513 \r
1514 <p>\r
1515 API to create policy for a connection. \r
1516 <p>\r
1517 This function results in configuration of Inner IP LUT entry for the RX side. For inbound direction API will trigger allocating resources at NetCP. Application can either block by passing transaction ID as NWAL_TRANSID_SPIN_WAIT or wait for call back being called with the results For outbound, API will return nwal_TRANS_COMPLETE and no further callback will be called.Application can free transaction ID after returning from API. <dl compact><dt><b>Parameters:</b></dt><dd>\r
1518 <table border="0" cellspacing="2" cellpadding="0">\r
1519 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1520 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>transId</em> </td><td>Transaction Id maintained by application. Applicable only in the case of inbound Sec Policy. The ID will be returned back by NWAL in <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack()</a> upon completion of the transaction.Set this to NWAL_TRANSID_SPIN_WAIT in case of blocking API call It is recommended not to initiate a blocking API call when a callback event driven API is in progress. </td></tr>\r
1521 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>appId</em> </td><td>Application ID to be registered. The handle will be used for all interfaces from NWAL to application: 1) Asynchronous confirmation of configuration response 2) Any packets received from NetCP related to this handle </td></tr>\r
1522 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pPolParam</em> </td><td>Configuration information for Security profile for IPSec Channel. </td></tr>\r
1523 <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>pNwalSecPolHandle</em> </td><td>NWAL Handle identifying the policy configuration</td></tr>\r
1524 </table>\r
1525 </dl>\r
1526 <dl compact><dt><b>Return values:</b></dt><dd>\r
1527 <table border="0" cellspacing="2" cellpadding="0">\r
1528 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK or <a class="el" href="group__nwal___ret_value.html#gd84bd26de04054c46f419f09b69ad342">nwal_TRANS_COMPLETE</a> on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
1529 </table>\r
1530 </dl>\r
1531 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#gca33b2cd9bd7ccf47f024685a7749727">nwal_setSecAssoc</a> </dd></dl>\r
1532 \r
1533 </div>\r
1534 </div><p>\r
1535 <a class="anchor" name="g90852da1af033180d619e147594a869e"></a><!-- doxytag: member="nwal.h::nwal_start" ref="g90852da1af033180d619e147594a869e" args="(nwal_Inst nwalInst, const nwalLocCfg_t *pCfg)" -->\r
1536 <div class="memitem">\r
1537 <div class="memproto">\r
1538 <table class="memname">\r
1539 <tr>\r
1540 <td class="memname"><a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> nwal_start </td>\r
1541 <td>(</td>\r
1542 <td class="paramtype"><a class="el" href="nwal_8h.html#dfc10335d7a5619a310a3745899c036c">nwal_Inst</a> </td>\r
1543 <td class="paramname"> <em>nwalInst</em>, </td>\r
1544 </tr>\r
1545 <tr>\r
1546 <td class="paramkey"></td>\r
1547 <td></td>\r
1548 <td class="paramtype">const <a class="el" href="structnwal_loc_cfg__t.html">nwalLocCfg_t</a> * </td>\r
1549 <td class="paramname"> <em>pCfg</em></td><td> </td>\r
1550 </tr>\r
1551 <tr>\r
1552 <td></td>\r
1553 <td>)</td>\r
1554 <td></td><td></td><td width="100%"></td>\r
1555 </tr>\r
1556 </table>\r
1557 </div>\r
1558 <div class="memdoc">\r
1559 \r
1560 <p>\r
1561 API would need to be called for all cores as a pre-requisite. API allows local per core related resource configuration to NWAL. \r
1562 <p>\r
1563 Following resource initialization is handled in API:<ul>\r
1564 <li>Control and packet flows for each core <dl compact><dt><b>Parameters:</b></dt><dd>\r
1565 <table border="0" cellspacing="2" cellpadding="0">\r
1566 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nwalInst</em> </td><td>NWAL Instance identifier </td></tr>\r
1567 <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pCfg</em> </td><td><a class="el" href="structnwal_loc_cfg__t.html">nwalLocCfg_t</a> </td></tr>\r
1568 </table>\r
1569 </dl>\r
1570 <dl compact><dt><b>Return values:</b></dt><dd>\r
1571 <table border="0" cellspacing="2" cellpadding="0">\r
1572 <tr><td valign="top"></td><td valign="top"><em>@ref</em> </td><td>nwal_OK on success. Error codes <a class="el" href="group__nwal___ret_value.html">NWAL API Return Codes</a> </td></tr>\r
1573 </table>\r
1574 </dl>\r
1575 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd><a class="el" href="group__nwal__api__functions.html#g1822ee8a1ab76a26470ae3b16d5e0ae8">nwal_create</a> </dd></dl>\r
1576 </li></ul>\r
1577 \r
1578 </div>\r
1579 </div><p>\r
1580 <hr size="1"><small>\r
1581 Copyright 2012, Texas Instruments Incorporated</small>\r
1582 </body>\r
1583 </html>\r