ti/runtime/netapi/docs/doxygen/html/structnwal_sa_ip_sec_param__t.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>NETAPI: nwalSaIpSecParam_t Struct Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <table width=100%>
   8 <tr>
   9   <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border=0 src="../../tilogo.gif"></a></td>
  10   <td bgcolor="red"><img src="../../titagline.gif"></td>
  11 </tr>
  12 </table>
  13 <!-- Generated by Doxygen 1.5.1-p1 -->
  14 <div class="tabs">
  15   <ul>
  16     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  17     <li><a href="modules.html"><span>Modules</span></a></li>
  18     <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  19     <li><a href="files.html"><span>Files</span></a></li>
  20   </ul></div>
  21 <div class="tabs">
  22   <ul>
  23     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  24     <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  25   </ul></div>
  26 <h1>nwalSaIpSecParam_t Struct Reference</h1><!-- doxytag: class="nwalSaIpSecParam_t" --><code>#include &lt;nwal.h&gt;</code>
  27 <p>
  28 <table border="0" cellpadding="0" cellspacing="0">
  29 <tr><td></td></tr>
  30 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  31 <tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#e4e620b071de8b3c75c2a33571bb9afb">validParams</a></td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="nwal_8h.html#3b3afa5be7154c0eb050446efdc96a3b">nwal_saMode</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#d40b708502f67e32ea75bd67c3db8e18">saMode</a></td></tr>
  34
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="unionnwal_ip_addr__t.html">nwalIpAddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#cb8ddb6a68368aa1f1bb3e3a80724d15">src</a></td></tr>
  36
  37 <tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#876081cfc0181697dcbdc8bf857c1818">replayWindow</a></td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="nwal_8h.html#8066f3731e362c5f305b19ee4ff0609f">nwal_IPSecDir</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#9e6a6bce6ffa18dbc7f0ba32592fbfd2">dir</a></td></tr>
  40
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#a2be29bcc316b99ec35fe6c626692a07">esnLo</a></td></tr>
  42
  43 <tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#b50fd93d8dbe30590f6346a760f2f779">esnHi</a></td></tr>
  44
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="nwal_8h.html#2cd3763bfe428c69021adb1f0901878a">nwal_saAALG</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#4795cc35bde68533bbbc327f13b424d0">authMode</a></td></tr>
  46
  47 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="nwal_8h.html#991726d136c2c9da85529ea1ff488ebf">nwal_saEALG</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#42bde4bdf4b74fd0b807a997d74c468f">cipherMode</a></td></tr>
  48
  49 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="nwal_8h.html#c78950738f8a5d40e045de64e74e1e5f">nwalMacAddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#dea2bc1ca2cea138552aa523a05d62a2">remMacAddr</a></td></tr>
  50
  51 <tr><td class="memItemLeft" nowrap align="right" valign="top">uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#e68a2b6c1587d1be943a1ee03242f5bb">macSize</a></td></tr>
  52
  53 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="nwal_8h.html#0311c01d7766f5be08b62149091e6899">nwal_matchAction_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#c2d05603d1a5a9c2108f86ff6417f04c">matchAction</a></td></tr>
  54
  55 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="nwal_8h.html#4277d5458827c95a1bcb91eab9216836">nwal_nextRtFailAction_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#c9829e956991046ab824d74cf629b131">failAction</a></td></tr>
  56
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#af6a641f072909662d575ff9bba6da00">appRxPktFlowId</a></td></tr>
  58
  59 <tr><td class="memItemLeft" nowrap align="right" valign="top">Qmss_QueueHnd&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnwal_sa_ip_sec_param__t.html#df897668216ac1a3e2e618b019d4dbf2">appRxPktQueue</a></td></tr>
  60
  61 </table>
  62 <hr><h2>Field Documentation</h2>
  63 <a class="anchor" name="e4e620b071de8b3c75c2a33571bb9afb"></a><!-- doxytag: member="nwalSaIpSecParam_t::validParams" ref="e4e620b071de8b3c75c2a33571bb9afb" args="" -->
  64 <div class="memitem">
  65 <div class="memproto">
  66       <table class="memname">
  67         <tr>
  68           <td class="memname">uint32_t <a class="el" href="structnwal_sa_ip_sec_param__t.html#e4e620b071de8b3c75c2a33571bb9afb">nwalSaIpSecParam_t::validParams</a>          </td>
  69         </tr>
  70       </table>
  71 </div>
  72 <div class="memdoc">
  73
  74 <p>
  75 Valid Parameters for Optional config
  76 </div>
  77 </div><p>
  78 <a class="anchor" name="d40b708502f67e32ea75bd67c3db8e18"></a><!-- doxytag: member="nwalSaIpSecParam_t::saMode" ref="d40b708502f67e32ea75bd67c3db8e18" args="" -->
  79 <div class="memitem">
  80 <div class="memproto">
  81       <table class="memname">
  82         <tr>
  83           <td class="memname"><a class="el" href="nwal_8h.html#3b3afa5be7154c0eb050446efdc96a3b">nwal_saMode</a> <a class="el" href="structnwal_sa_ip_sec_param__t.html#d40b708502f67e32ea75bd67c3db8e18">nwalSaIpSecParam_t::saMode</a>          </td>
  84         </tr>
  85       </table>
  86 </div>
  87 <div class="memdoc">
  88
  89 <p>
  90 Tunnel/ Transport mode
  91 </div>
  92 </div><p>
  93 <a class="anchor" name="cb8ddb6a68368aa1f1bb3e3a80724d15"></a><!-- doxytag: member="nwalSaIpSecParam_t::src" ref="cb8ddb6a68368aa1f1bb3e3a80724d15" args="" -->
  94 <div class="memitem">
  95 <div class="memproto">
  96       <table class="memname">
  97         <tr>
  98           <td class="memname"><a class="el" href="unionnwal_ip_addr__t.html">nwalIpAddr_t</a> <a class="el" href="structnwal_sa_ip_sec_param__t.html#cb8ddb6a68368aa1f1bb3e3a80724d15">nwalSaIpSecParam_t::src</a>          </td>
  99         </tr>
 100       </table>
 101 </div>
 102 <div class="memdoc">
 103
 104 <p>
 105 Source IP Address: TBD
 106 </div>
 107 </div><p>
 108 <a class="anchor" name="876081cfc0181697dcbdc8bf857c1818"></a><!-- doxytag: member="nwalSaIpSecParam_t::replayWindow" ref="876081cfc0181697dcbdc8bf857c1818" args="" -->
 109 <div class="memitem">
 110 <div class="memproto">
 111       <table class="memname">
 112         <tr>
 113           <td class="memname">uint32_t <a class="el" href="structnwal_sa_ip_sec_param__t.html#876081cfc0181697dcbdc8bf857c1818">nwalSaIpSecParam_t::replayWindow</a>          </td>
 114         </tr>
 115       </table>
 116 </div>
 117 <div class="memdoc">
 118
 119 <p>
 120 Replay Window Size: TBD
 121 </div>
 122 </div><p>
 123 <a class="anchor" name="9e6a6bce6ffa18dbc7f0ba32592fbfd2"></a><!-- doxytag: member="nwalSaIpSecParam_t::dir" ref="9e6a6bce6ffa18dbc7f0ba32592fbfd2" args="" -->
 124 <div class="memitem">
 125 <div class="memproto">
 126       <table class="memname">
 127         <tr>
 128           <td class="memname"><a class="el" href="nwal_8h.html#8066f3731e362c5f305b19ee4ff0609f">nwal_IPSecDir</a> <a class="el" href="structnwal_sa_ip_sec_param__t.html#9e6a6bce6ffa18dbc7f0ba32592fbfd2">nwalSaIpSecParam_t::dir</a>          </td>
 129         </tr>
 130       </table>
 131 </div>
 132 <div class="memdoc">
 133
 134 <p>
 135
 136 </div>
 137 </div><p>
 138 <a class="anchor" name="a2be29bcc316b99ec35fe6c626692a07"></a><!-- doxytag: member="nwalSaIpSecParam_t::esnLo" ref="a2be29bcc316b99ec35fe6c626692a07" args="" -->
 139 <div class="memitem">
 140 <div class="memproto">
 141       <table class="memname">
 142         <tr>
 143           <td class="memname">uint32_t <a class="el" href="structnwal_sa_ip_sec_param__t.html#a2be29bcc316b99ec35fe6c626692a07">nwalSaIpSecParam_t::esnLo</a>          </td>
 144         </tr>
 145       </table>
 146 </div>
 147 <div class="memdoc">
 148
 149 <p>
 150 Direction for the channel. Inbound or Outbound Initial Value of Extended Sequence Number LSB
 151 </div>
 152 </div><p>
 153 <a class="anchor" name="b50fd93d8dbe30590f6346a760f2f779"></a><!-- doxytag: member="nwalSaIpSecParam_t::esnHi" ref="b50fd93d8dbe30590f6346a760f2f779" args="" -->
 154 <div class="memitem">
 155 <div class="memproto">
 156       <table class="memname">
 157         <tr>
 158           <td class="memname">uint32_t <a class="el" href="structnwal_sa_ip_sec_param__t.html#b50fd93d8dbe30590f6346a760f2f779">nwalSaIpSecParam_t::esnHi</a>          </td>
 159         </tr>
 160       </table>
 161 </div>
 162 <div class="memdoc">
 163
 164 <p>
 165 Initial Value of Extended Sequence Number MSB
 166 </div>
 167 </div><p>
 168 <a class="anchor" name="4795cc35bde68533bbbc327f13b424d0"></a><!-- doxytag: member="nwalSaIpSecParam_t::authMode" ref="4795cc35bde68533bbbc327f13b424d0" args="" -->
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname"><a class="el" href="nwal_8h.html#2cd3763bfe428c69021adb1f0901878a">nwal_saAALG</a> <a class="el" href="structnwal_sa_ip_sec_param__t.html#4795cc35bde68533bbbc327f13b424d0">nwalSaIpSecParam_t::authMode</a>          </td>
 174         </tr>
 175       </table>
 176 </div>
 177 <div class="memdoc">
 178
 179 <p>
 180 Authentication Algorithm
 181 </div>
 182 </div><p>
 183 <a class="anchor" name="42bde4bdf4b74fd0b807a997d74c468f"></a><!-- doxytag: member="nwalSaIpSecParam_t::cipherMode" ref="42bde4bdf4b74fd0b807a997d74c468f" args="" -->
 184 <div class="memitem">
 185 <div class="memproto">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname"><a class="el" href="nwal_8h.html#991726d136c2c9da85529ea1ff488ebf">nwal_saEALG</a> <a class="el" href="structnwal_sa_ip_sec_param__t.html#42bde4bdf4b74fd0b807a997d74c468f">nwalSaIpSecParam_t::cipherMode</a>          </td>
 189         </tr>
 190       </table>
 191 </div>
 192 <div class="memdoc">
 193
 194 <p>
 195 Encryption Algorithm
 196 </div>
 197 </div><p>
 198 <a class="anchor" name="dea2bc1ca2cea138552aa523a05d62a2"></a><!-- doxytag: member="nwalSaIpSecParam_t::remMacAddr" ref="dea2bc1ca2cea138552aa523a05d62a2" args="" -->
 199 <div class="memitem">
 200 <div class="memproto">
 201       <table class="memname">
 202         <tr>
 203           <td class="memname"><a class="el" href="nwal_8h.html#c78950738f8a5d40e045de64e74e1e5f">nwalMacAddr_t</a> <a class="el" href="structnwal_sa_ip_sec_param__t.html#dea2bc1ca2cea138552aa523a05d62a2">nwalSaIpSecParam_t::remMacAddr</a>          </td>
 204         </tr>
 205       </table>
 206 </div>
 207 <div class="memdoc">
 208
 209 <p>
 210 Remote MAC address
 211 </div>
 212 </div><p>
 213 <a class="anchor" name="e68a2b6c1587d1be943a1ee03242f5bb"></a><!-- doxytag: member="nwalSaIpSecParam_t::macSize" ref="e68a2b6c1587d1be943a1ee03242f5bb" args="" -->
 214 <div class="memitem">
 215 <div class="memproto">
 216       <table class="memname">
 217         <tr>
 218           <td class="memname">uint16_t <a class="el" href="structnwal_sa_ip_sec_param__t.html#e68a2b6c1587d1be943a1ee03242f5bb">nwalSaIpSecParam_t::macSize</a>          </td>
 219         </tr>
 220       </table>
 221 </div>
 222 <div class="memdoc">
 223
 224 <p>
 225 Specify the size of the authentication tag in bytes
 226 </div>
 227 </div><p>
 228 <a class="anchor" name="c2d05603d1a5a9c2108f86ff6417f04c"></a><!-- doxytag: member="nwalSaIpSecParam_t::matchAction" ref="c2d05603d1a5a9c2108f86ff6417f04c" args="" -->
 229 <div class="memitem">
 230 <div class="memproto">
 231       <table class="memname">
 232         <tr>
 233           <td class="memname"><a class="el" href="nwal_8h.html#0311c01d7766f5be08b62149091e6899">nwal_matchAction_t</a> <a class="el" href="structnwal_sa_ip_sec_param__t.html#c2d05603d1a5a9c2108f86ff6417f04c">nwalSaIpSecParam_t::matchAction</a>          </td>
 234         </tr>
 235       </table>
 236 </div>
 237 <div class="memdoc">
 238
 239 <p>
 240 Action upon matching classification rule at NetCP <a class="el" href="group__nwal__match_action__t.html">Action after classification is matched at NetCP.</a> Note setting the action to NWAL_MATCH_ACTION_HOST will require application to perform necessary authentication/decryption on IPSec Header Applicable only for <a class="el" href="nwal_8h.html#98a9668197a0ab59e4028a642ae69036">NWAL_IPSEC_DIR_INBOUND</a>
 241 </div>
 242 </div><p>
 243 <a class="anchor" name="c9829e956991046ab824d74cf629b131"></a><!-- doxytag: member="nwalSaIpSecParam_t::failAction" ref="c9829e956991046ab824d74cf629b131" args="" -->
 244 <div class="memitem">
 245 <div class="memproto">
 246       <table class="memname">
 247         <tr>
 248           <td class="memname"><a class="el" href="nwal_8h.html#4277d5458827c95a1bcb91eab9216836">nwal_nextRtFailAction_t</a> <a class="el" href="structnwal_sa_ip_sec_param__t.html#c9829e956991046ab824d74cf629b131">nwalSaIpSecParam_t::failAction</a>          </td>
 249         </tr>
 250       </table>
 251 </div>
 252 <div class="memdoc">
 253
 254 <p>
 255 Configuration for action when next route classification fails <a class="el" href="group__nwal_next_route_fail_action.html">Next Route fail action configuration at NetCP</a> Applicable only for <a class="el" href="nwal_8h.html#98a9668197a0ab59e4028a642ae69036">NWAL_IPSEC_DIR_INBOUND</a>
 256 </div>
 257 </div><p>
 258 <a class="anchor" name="af6a641f072909662d575ff9bba6da00"></a><!-- doxytag: member="nwalSaIpSecParam_t::appRxPktFlowId" ref="af6a641f072909662d575ff9bba6da00" args="" -->
 259 <div class="memitem">
 260 <div class="memproto">
 261       <table class="memname">
 262         <tr>
 263           <td class="memname">int16_t <a class="el" href="structnwal_sa_ip_sec_param__t.html#af6a641f072909662d575ff9bba6da00">nwalSaIpSecParam_t::appRxPktFlowId</a>          </td>
 264         </tr>
 265       </table>
 266 </div>
 267 <div class="memdoc">
 268
 269 <p>
 270
 271 </div>
 272 </div><p>
 273 <a class="anchor" name="df897668216ac1a3e2e618b019d4dbf2"></a><!-- doxytag: member="nwalSaIpSecParam_t::appRxPktQueue" ref="df897668216ac1a3e2e618b019d4dbf2" args="" -->
 274 <div class="memitem">
 275 <div class="memproto">
 276       <table class="memname">
 277         <tr>
 278           <td class="memname">Qmss_QueueHnd <a class="el" href="structnwal_sa_ip_sec_param__t.html#df897668216ac1a3e2e618b019d4dbf2">nwalSaIpSecParam_t::appRxPktQueue</a>          </td>
 279         </tr>
 280       </table>
 281 </div>
 282 <div class="memdoc">
 283
 284 <p>
 285 Optional: Application managed Flow ID for any packet to host from this classification entry. In case if NWAL managed flow needs to be used set to CPPI_PARAM_NOT_SPECIFIED
 286 </div>
 287 </div><p>
 288 <hr>The documentation for this struct was generated from the following file:<ul>
 289 <li><a class="el" href="nwal_8h.html">nwal.h</a></ul>
 290 <hr size="1"><small>
 291 Copyright  2012, Texas Instruments Incorporated</small>
 292 </body>
 293 </html>