begriffs open source - cmsis/blob - v6.0.0/Driver/group__wifi__bypass__gr.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: WiFi Bypass Mode</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Driver
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Driver");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__wifi__bypass__gr.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#func-members">Functions</a>  </div>
 129   <div class="headertitle"><div class="title">WiFi Bypass Mode<div class="ingroups"><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>Transfer Ethernet frames by WiFi module.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 137 Functions</h2></td></tr>
 138 <tr class="memitem:ga678fa1aa06ca6aaa67c7eb7a7660730e"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html#ga678fa1aa06ca6aaa67c7eb7a7660730e">ARM_WIFI_BypassControl</a> (uint32_t interface, uint32_t mode)</td></tr>
 139 <tr class="memdesc:ga678fa1aa06ca6aaa67c7eb7a7660730e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable or disable bypass (pass-through) mode. Transmit and receive Ethernet frames (IP layer bypassed and WiFi/Ethernet translation).  <br /></td></tr>
 140 <tr class="separator:ga678fa1aa06ca6aaa67c7eb7a7660730e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:gac1da4619feaf62d0cc90cfe44642d16b"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html#gac1da4619feaf62d0cc90cfe44642d16b">ARM_WIFI_EthSendFrame</a> (uint32_t interface, const uint8_t *frame, uint32_t len)</td></tr>
 142 <tr class="memdesc:gac1da4619feaf62d0cc90cfe44642d16b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Ethernet frame (in bypass mode only).  <br /></td></tr>
 143 <tr class="separator:gac1da4619feaf62d0cc90cfe44642d16b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga1dbeb5528095af31a60560e0c48321d4"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a> (uint32_t interface, uint8_t *frame, uint32_t len)</td></tr>
 145 <tr class="memdesc:ga1dbeb5528095af31a60560e0c48321d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data of received Ethernet frame (in bypass mode only).  <br /></td></tr>
 146 <tr class="separator:ga1dbeb5528095af31a60560e0c48321d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gab67442ff061d0c4311a7046bce8d0cd1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html#gab67442ff061d0c4311a7046bce8d0cd1">ARM_WIFI_EthGetRxFrameSize</a> (uint32_t interface)</td></tr>
 148 <tr class="memdesc:gab67442ff061d0c4311a7046bce8d0cd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get size of received Ethernet frame (in bypass mode only).  <br /></td></tr>
 149 <tr class="separator:gab67442ff061d0c4311a7046bce8d0cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table>
 151 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 152 <p>Transfer Ethernet frames by WiFi module. </p>
 153 <p>The <a class="el" href="group__wifi__bypass__gr.html">WiFi Bypass Mode</a> functions are an optional interface and enable the transmission of Ethernet frames with WiFi modules. The use of this interface requires that the TCP/IP stack is running on the microcontroller (usually a third-party or open-source networking component). The internal TCP/IP stack of the WiFi module is therefore not used, and this usually means that the <a class="el" href="group__wifi__socket__gr.html">WiFi Socket</a> functions can not be used. </p>
 154 <h2 class="groupheader">Function Documentation</h2>
 155 <a id="ga678fa1aa06ca6aaa67c7eb7a7660730e" name="ga678fa1aa06ca6aaa67c7eb7a7660730e"></a>
 156 <h2 class="memtitle"><span class="permalink"><a href="#ga678fa1aa06ca6aaa67c7eb7a7660730e">&#9670;&#160;</a></span>ARM_WIFI_BypassControl()</h2>
 157
 158 <div class="memitem">
 159 <div class="memproto">
 160       <table class="memname">
 161         <tr>
 162           <td class="memname">int32_t ARM_WIFI_BypassControl </td>
 163           <td>(</td>
 164           <td class="paramtype">uint32_t&#160;</td>
 165           <td class="paramname"><em>interface</em>, </td>
 166         </tr>
 167         <tr>
 168           <td class="paramkey"></td>
 169           <td></td>
 170           <td class="paramtype">uint32_t&#160;</td>
 171           <td class="paramname"><em>mode</em>&#160;</td>
 172         </tr>
 173         <tr>
 174           <td></td>
 175           <td>)</td>
 176           <td></td><td></td>
 177         </tr>
 178       </table>
 179 </div><div class="memdoc">
 180
 181 <p>Enable or disable bypass (pass-through) mode. Transmit and receive Ethernet frames (IP layer bypassed and WiFi/Ethernet translation). </p>
 182 <dl class="params"><dt>Parameters</dt><dd>
 183   <table class="params">
 184     <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
 185     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td><ul>
 186 <li>value = 1: all packets bypass internal IP stack</li>
 187 <li>value = 0: all packets processed by internal IP stack </li>
 188 </ul>
 189 </td></tr>
 190   </table>
 191   </dd>
 192 </dl>
 193 <dl class="section return"><dt>Returns</dt><dd>execution status<ul>
 194 <li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
 195 <li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
 196 <li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
 197 <li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface or mode)</li>
 198 </ul>
 199 </dd></dl>
 200 <p>The function <b>ARM_WIFI_BypassControl</b> enables or disables the WiFi bypass mode.</p>
 201 <p>The WiFi Bypass mode can only be enabled, if there is a bypass mode supported in the WiFi driver. You can check this by checking the driver's capabilities.</p>
 202 <dl class="section note"><dt>Note</dt><dd>Bypass mode is enabled by default if the module does not support the Socket interface.</dd></dl>
 203 <p>The argument <em>mode</em> specifies the desired state of the WiFi Bypass mode, which is enabled or disabled.</p>
 204 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> Driver_WiFi0;</div>
 205 <div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> *wifi;</div>
 206 <div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> own_mac_address;</div>
 207 <div class="line"> </div>
 208 <div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> wifi_notify (uint32_t event, ,<span class="keywordtype">void</span> *arg) {</div>
 209 <div class="line">  <span class="keywordflow">switch</span> (event)  {</div>
 210 <div class="line">     :</div>
 211 <div class="line">  }  </div>
 212 <div class="line">}</div>
 213 <div class="line"> </div>
 214 <div class="line"><span class="keywordtype">void</span> initialize_wifi_bypass (<span class="keywordtype">void</span>) {</div>
 215 <div class="line">  <a class="code hl_struct" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a> capabilities;</div>
 216 <div class="line"> </div>
 217 <div class="line">  wifi = &amp;Driver_WiFi0;</div>
 218 <div class="line">  capabilities = wifi-&gt;<a class="code hl_variable" href="group__wifi__interface__gr.html#a10f74a292db2275b28b6b0eb6b22bea8">GetCapabilities</a> ();</div>
 219 <div class="line">  <span class="keywordflow">if</span> (capabilities.<a class="code hl_variable" href="group__wifi__control__gr.html#adbcc47408fb8c50d262a3be535108186">bypass_mode</a> == 0) {</div>
 220 <div class="line">    <span class="comment">// error handling </span></div>
 221 <div class="line">  } </div>
 222 <div class="line"> </div>
 223 <div class="line">  <span class="comment">// Initialize and Power-on WiFi Interface</span></div>
 224 <div class="line">  wifi-&gt;<a class="code hl_variable" href="group__wifi__interface__gr.html#afe313d2860cfecd7b235dfa4a75ad0f9">Initialize</a> ((capabilities.eth_rx_frame_event) ? wifi_notify : NULL);</div>
 225 <div class="line">  wifi-&gt;<a class="code hl_variable" href="group__wifi__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> (<a class="code hl_enumvalue" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
 226 <div class="line"> </div>
 227 <div class="line">  <span class="comment">// populate own_mac_address with the address to use for station</span></div>
 228 <div class="line">  wifi-&gt;<a class="code hl_variable" href="group__wifi__interface__gr.html#aee3ad2b5a66b88a9d66352b6429c69a3">SetOption</a>(0U, <a class="code hl_define" href="group__WiFi__option.html#gafefb0fe1e5cdfb71f7f8cc7606840865">ARM_WIFI_MAC</a>, &amp;own_mac_address, 6U);</div>
 229 <div class="line"> </div>
 230 <div class="line">  wifi-&gt;<a class="code hl_variable" href="group__wifi__interface__gr.html#a30d6724850d3de7986c40d274a944679">BypassControl</a> (0U, 1U); <span class="comment">// Enable bypass mode for station</span></div>
 231 <div class="line">}</div>
 232 <div class="ttc" id="aDriver__Common_8h_html_ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e"><div class="ttname"><a href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a></div><div class="ttdeci">@ ARM_POWER_FULL</div><div class="ttdoc">Power on: full operation at maximum performance.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:66</div></div>
 233 <div class="ttc" id="agroup__WiFi__option_html_gafefb0fe1e5cdfb71f7f8cc7606840865"><div class="ttname"><a href="group__WiFi__option.html#gafefb0fe1e5cdfb71f7f8cc7606840865">ARM_WIFI_MAC</a></div><div class="ttdeci">#define ARM_WIFI_MAC</div><div class="ttdoc">Station/AP Set/Get MAC; data = &amp;mac, len = 6, uint8_t[6].</div></div>
 234 <div class="ttc" id="agroup__eth__interface__gr_html_structARM__ETH__MAC__ADDR"><div class="ttname"><a href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a></div><div class="ttdoc">Ethernet MAC Address.</div><div class="ttdef"><b>Definition:</b> Driver_ETH.h:83</div></div>
 235 <div class="ttc" id="agroup__wifi__control__gr_html_adbcc47408fb8c50d262a3be535108186"><div class="ttname"><a href="group__wifi__control__gr.html#adbcc47408fb8c50d262a3be535108186">ARM_WIFI_CAPABILITIES::bypass_mode</a></div><div class="ttdeci">uint32_t bypass_mode</div><div class="ttdoc">Bypass or pass-through mode (Ethernet interface)</div><div class="ttdef"><b>Definition:</b> Driver_WiFi.h:615</div></div>
 236 <div class="ttc" id="agroup__wifi__control__gr_html_structARM__WIFI__CAPABILITIES"><div class="ttname"><a href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a></div><div class="ttdoc">WiFi Driver Capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_WiFi.h:606</div></div>
 237 <div class="ttc" id="agroup__wifi__interface__gr_html_a10f74a292db2275b28b6b0eb6b22bea8"><div class="ttname"><a href="group__wifi__interface__gr.html#a10f74a292db2275b28b6b0eb6b22bea8">ARM_DRIVER_WIFI::GetCapabilities</a></div><div class="ttdeci">ARM_WIFI_CAPABILITIES(* GetCapabilities)(void)</div><div class="ttdef"><b>Definition:</b> Driver_WiFi.h:627</div></div>
 238 <div class="ttc" id="agroup__wifi__interface__gr_html_a24ebae5c6011631f76027f9a16eaf5ce"><div class="ttname"><a href="group__wifi__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">ARM_DRIVER_WIFI::PowerControl</a></div><div class="ttdeci">int32_t(* PowerControl)(ARM_POWER_STATE state)</div><div class="ttdef"><b>Definition:</b> Driver_WiFi.h:630</div></div>
 239 <div class="ttc" id="agroup__wifi__interface__gr_html_a30d6724850d3de7986c40d274a944679"><div class="ttname"><a href="group__wifi__interface__gr.html#a30d6724850d3de7986c40d274a944679">ARM_DRIVER_WIFI::BypassControl</a></div><div class="ttdeci">int32_t(* BypassControl)(uint32_t interface, uint32_t mode)</div><div class="ttdef"><b>Definition:</b> Driver_WiFi.h:639</div></div>
 240 <div class="ttc" id="agroup__wifi__interface__gr_html_aee3ad2b5a66b88a9d66352b6429c69a3"><div class="ttname"><a href="group__wifi__interface__gr.html#aee3ad2b5a66b88a9d66352b6429c69a3">ARM_DRIVER_WIFI::SetOption</a></div><div class="ttdeci">int32_t(* SetOption)(uint32_t interface, uint32_t option, const void *data, uint32_t len)</div><div class="ttdef"><b>Definition:</b> Driver_WiFi.h:632</div></div>
 241 <div class="ttc" id="agroup__wifi__interface__gr_html_afe313d2860cfecd7b235dfa4a75ad0f9"><div class="ttname"><a href="group__wifi__interface__gr.html#afe313d2860cfecd7b235dfa4a75ad0f9">ARM_DRIVER_WIFI::Initialize</a></div><div class="ttdeci">int32_t(* Initialize)(ARM_WIFI_SignalEvent_t cb_event)</div><div class="ttdef"><b>Definition:</b> Driver_WiFi.h:628</div></div>
 242 <div class="ttc" id="agroup__wifi__interface__gr_html_structARM__DRIVER__WIFI"><div class="ttname"><a href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a></div><div class="ttdoc">Access structure of the WiFi Driver.</div><div class="ttdef"><b>Definition:</b> Driver_WiFi.h:625</div></div>
 243 </div><!-- fragment -->
 244 </div>
 245 </div>
 246 <a id="gac1da4619feaf62d0cc90cfe44642d16b" name="gac1da4619feaf62d0cc90cfe44642d16b"></a>
 247 <h2 class="memtitle"><span class="permalink"><a href="#gac1da4619feaf62d0cc90cfe44642d16b">&#9670;&#160;</a></span>ARM_WIFI_EthSendFrame()</h2>
 248
 249 <div class="memitem">
 250 <div class="memproto">
 251       <table class="memname">
 252         <tr>
 253           <td class="memname">int32_t ARM_WIFI_EthSendFrame </td>
 254           <td>(</td>
 255           <td class="paramtype">uint32_t&#160;</td>
 256           <td class="paramname"><em>interface</em>, </td>
 257         </tr>
 258         <tr>
 259           <td class="paramkey"></td>
 260           <td></td>
 261           <td class="paramtype">const uint8_t *&#160;</td>
 262           <td class="paramname"><em>frame</em>, </td>
 263         </tr>
 264         <tr>
 265           <td class="paramkey"></td>
 266           <td></td>
 267           <td class="paramtype">uint32_t&#160;</td>
 268           <td class="paramname"><em>len</em>&#160;</td>
 269         </tr>
 270         <tr>
 271           <td></td>
 272           <td>)</td>
 273           <td></td><td></td>
 274         </tr>
 275       </table>
 276 </div><div class="memdoc">
 277
 278 <p>Send Ethernet frame (in bypass mode only). </p>
 279 <dl class="params"><dt>Parameters</dt><dd>
 280   <table class="params">
 281     <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
 282     <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>Pointer to frame buffer with data to send </td></tr>
 283     <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Frame buffer length in bytes </td></tr>
 284   </table>
 285   </dd>
 286 </dl>
 287 <dl class="section return"><dt>Returns</dt><dd>execution status<ul>
 288 <li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
 289 <li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
 290 <li><a class="el" href="group__execution__status.html#ga13c1123319c7b9a4735d63447f35116b">ARM_DRIVER_ERROR_BUSY</a> : Driver is busy</li>
 291 <li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
 292 <li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface or NULL frame pointer)</li>
 293 </ul>
 294 </dd></dl>
 295 <p>The function <b>ARM_WIFI_EthSendFrame</b> writes an <b>Ethernet frame</b> to the WiFi transmit buffer.</p>
 296 <p>The WiFi bypass mode must be enabled by using the function <a class="el" href="group__wifi__bypass__gr.html#ga678fa1aa06ca6aaa67c7eb7a7660730e">ARM_WIFI_BypassControl</a> before a call to this function.</p>
 297 <p>The frame data addressed by <em>frame</em> starts with MAC destination and ends with the last Payload data byte. The frame data is copied into the transmit buffer of the WiFi interface.</p>
 298 <p>The maximum value for <em>len</em> is implied by the size restrictions of the Ethernet frame but is not verified. Using an invalid value for <em>len</em> may generate unpredicted results.</p>
 299 <p><b>Example:</b> </p><div class="fragment"><div class="line">status = wifi-&gt;EthSendFrame (0U, &amp;frame_data[0], frame_length);</div>
 300 <div class="line"><span class="keywordflow">if</span> (status != <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>)  {</div>
 301 <div class="line">  <span class="comment">// error handling</span></div>
 302 <div class="line">}</div>
 303 <div class="ttc" id="agroup__execution__status_html_ga85752c5de59e8adeb001e35ff5be6be7"><div class="ttname"><a href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a></div><div class="ttdeci">#define ARM_DRIVER_OK</div><div class="ttdoc">Operation succeeded.</div></div>
 304 </div><!-- fragment -->
 305 </div>
 306 </div>
 307 <a id="ga1dbeb5528095af31a60560e0c48321d4" name="ga1dbeb5528095af31a60560e0c48321d4"></a>
 308 <h2 class="memtitle"><span class="permalink"><a href="#ga1dbeb5528095af31a60560e0c48321d4">&#9670;&#160;</a></span>ARM_WIFI_EthReadFrame()</h2>
 309
 310 <div class="memitem">
 311 <div class="memproto">
 312       <table class="memname">
 313         <tr>
 314           <td class="memname">int32_t ARM_WIFI_EthReadFrame </td>
 315           <td>(</td>
 316           <td class="paramtype">uint32_t&#160;</td>
 317           <td class="paramname"><em>interface</em>, </td>
 318         </tr>
 319         <tr>
 320           <td class="paramkey"></td>
 321           <td></td>
 322           <td class="paramtype">uint8_t *&#160;</td>
 323           <td class="paramname"><em>frame</em>, </td>
 324         </tr>
 325         <tr>
 326           <td class="paramkey"></td>
 327           <td></td>
 328           <td class="paramtype">uint32_t&#160;</td>
 329           <td class="paramname"><em>len</em>&#160;</td>
 330         </tr>
 331         <tr>
 332           <td></td>
 333           <td>)</td>
 334           <td></td><td></td>
 335         </tr>
 336       </table>
 337 </div><div class="memdoc">
 338
 339 <p>Read data of received Ethernet frame (in bypass mode only). </p>
 340 <dl class="params"><dt>Parameters</dt><dd>
 341   <table class="params">
 342     <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
 343     <tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>Pointer to frame buffer for data to read into </td></tr>
 344     <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Frame buffer length in bytes </td></tr>
 345   </table>
 346   </dd>
 347 </dl>
 348 <dl class="section return"><dt>Returns</dt><dd>number of data bytes read or error code<ul>
 349 <li>value &gt;= 0 : Number of data bytes read</li>
 350 <li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
 351 <li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
 352 <li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface or NULL frame pointer)</li>
 353 </ul>
 354 </dd></dl>
 355 <p>The function <b>ARM_WIFI_EthReadFrame</b> reads an <b>Ethernet frame</b> from the WiFi interface in the bypass mode.</p>
 356 <p>The <em>len</em> of the Ethernet frame can be checked using the function <a class="el" href="group__wifi__bypass__gr.html#gab67442ff061d0c4311a7046bce8d0cd1">ARM_WIFI_EthGetRxFrameSize</a>.</p>
 357 <p>The frame data addressed by <em>frame</em> starts with MAC destination and ends with the last Payload data byte. The frame data is read from the receive buffer of the WiFi interface and the number of bytes written into the memory addressed by <em>frame</em> is returned. A negative return value indicates an error whereby the status code is defined with driver common return codes.</p>
 358 <p>The function <a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a> may be called with <em>buf</em> = <span class="XML-Token">NULL</span> and <em>len</em> = <span class="XML-Token">0</span> to discard or release a frame. This is useful when an incorrect frame has been received or no memory is available to hold the Ethernet frame.</p>
 359 <p><b>Example:</b> </p><div class="fragment"><div class="line">size = wifi-&gt;EthGetRxFrameSize ();</div>
 360 <div class="line"><span class="keywordflow">if</span> ((size &lt; 14) || (size &gt; 1514)) {    <span class="comment">// frame excludes CRC</span></div>
 361 <div class="line">  wifi-&gt;EthReadFrame (NULL, 0);        <span class="comment">// Frame error, release it</span></div>
 362 <div class="line">}</div>
 363 <div class="line">len = wifi-&gt;ReadFrame (0U, &amp;frame_data[0], size);</div>
 364 <div class="line"><span class="keywordflow">if</span> (len &lt; 0)  {</div>
 365 <div class="line">  <span class="comment">// error handling</span></div>
 366 <div class="line">}</div>
 367 </div><!-- fragment -->
 368 </div>
 369 </div>
 370 <a id="gab67442ff061d0c4311a7046bce8d0cd1" name="gab67442ff061d0c4311a7046bce8d0cd1"></a>
 371 <h2 class="memtitle"><span class="permalink"><a href="#gab67442ff061d0c4311a7046bce8d0cd1">&#9670;&#160;</a></span>ARM_WIFI_EthGetRxFrameSize()</h2>
 372
 373 <div class="memitem">
 374 <div class="memproto">
 375       <table class="memname">
 376         <tr>
 377           <td class="memname">uint32_t ARM_WIFI_EthGetRxFrameSize </td>
 378           <td>(</td>
 379           <td class="paramtype">uint32_t&#160;</td>
 380           <td class="paramname"><em>interface</em></td><td>)</td>
 381           <td></td>
 382         </tr>
 383       </table>
 384 </div><div class="memdoc">
 385
 386 <p>Get size of received Ethernet frame (in bypass mode only). </p>
 387 <dl class="params"><dt>Parameters</dt><dd>
 388   <table class="params">
 389     <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
 390   </table>
 391   </dd>
 392 </dl>
 393 <dl class="section return"><dt>Returns</dt><dd>number of bytes in received frame</dd></dl>
 394 <p>The function <b>ARM_WIFI_EthGetRxFrameSize</b> returns the size of a received <b>Ethernet frame</b> in the bypass mode. This function can be called before <a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a> and retrieves the value <em>len</em>.</p>
 395 <p>The frame size includes MAC destination and ends with the last Payload data byte. Value <span class="XML-Token">0</span> indicates that no Ethernet frame is available in the receive buffer. Values smaller than minimum size of Ethernet frame or larger than maximum size of Ethernet frame indicate an invalid frame which needs to be discarded by calling <a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a>.</p>
 396 <p><b>Example:</b> </p><ul>
 397 <li>see <a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a> </li>
 398 </ul>
 399
 400 </div>
 401 </div>
 402 </div><!-- contents -->
 403 </div><!-- doc-content -->
 404 <!-- start footer part -->
 405 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 406   <ul>
 407     <li class="footer">
 408       <script type="text/javascript">
 409         <!--
 410         writeFooter.call(this);
 411         //-->
 412       </script>
 413     </li>
 414   </ul>
 415 </div>
 416 </body>
 417 </html>