begriffs open source - cmsis-driver-validation/blob - docs/html/group__wifi__ctrl.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>WiFi Control</title>
   7 <title>CMSIS-Driver Validation: WiFi Control</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <link href="drv.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="printComponentTabs.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <link href="stylsheetf" rel="stylesheet" type="text/css" />
  26 </head>
  27 <body>
  28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  29 <div id="titlearea">
  30 <table cellspacing="0" cellpadding="0">
  31  <tbody>
  32  <tr style="height: 46px;">
  33   <td id="projectlogo"><img alt="Logo" src="keilarm.png"/></td>
  34   <td style="padding-left: 0.5em;">
  35    <div id="projectname">CMSIS-Driver Validation
  36    &#160;<span id="projectnumber">Version 1.3.0</span>
  37    </div>
  38    <div id="projectbrief">Driver Validation</div>
  39   </td>
  40  </tr>
  41  </tbody>
  42 </table>
  43 </div>
  44 <!-- end header part -->
  45 <div id="DRVnav" class="tabs1">
  46     <ul class="tablist">
  47       <script type="text/javascript">
  48                 <!--
  49                 writeComponentTabs.call(this);
  50                 //-->
  51       </script>
  52           </ul>
  53 </div>
  54 <!-- Generated by Doxygen 1.8.6 -->
  55 <script type="text/javascript">
  56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  57 </script>
  58   <div id="navrow1" class="tabs">
  59     <ul class="tablist">
  60       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  61       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  62       <li><a href="modules.html"><span>Reference</span></a></li>
  63       <li>
  64         <div id="MSearchBox" class="MSearchBoxInactive">
  65         <span class="left">
  66           <img id="MSearchSelect" src="search/mag_sel.png"
  67                onmouseover="return searchBox.OnSearchSelectShow()"
  68                onmouseout="return searchBox.OnSearchSelectHide()"
  69                alt=""/>
  70           <input type="text" id="MSearchField" value="Search" accesskey="S"
  71                onfocus="searchBox.OnSearchFieldFocus(true)"
  72                onblur="searchBox.OnSearchFieldFocus(false)"
  73                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  74           </span><span class="right">
  75             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  76           </span>
  77         </div>
  78       </li>
  79     </ul>
  80   </div>
  81 </div><!-- top -->
  82 <div id="side-nav" class="ui-resizable side-nav-resizable">
  83   <div id="nav-tree">
  84     <div id="nav-tree-contents">
  85       <div id="nav-sync" class="sync"></div>
  86     </div>
  87   </div>
  88   <div id="splitbar" style="-moz-user-select:none;"
  89        class="ui-resizable-handle">
  90   </div>
  91 </div>
  92 <script type="text/javascript">
  93 $(document).ready(function(){initNavTree('group__wifi__ctrl.html','');});
  94 </script>
  95 <div id="doc-content">
  96 <!-- window showing the filter options -->
  97 <div id="MSearchSelectWindow"
  98      onmouseover="return searchBox.OnSearchSelectShow()"
  99      onmouseout="return searchBox.OnSearchSelectHide()"
 100      onkeydown="return searchBox.OnSearchSelectKey(event)">
 101 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 102
 103 <!-- iframe showing the search results (closed by default) -->
 104 <div id="MSearchResultsWindow">
 105 <iframe src="javascript:void(0)" frameborder="0"
 106         name="MSearchResults" id="MSearchResults">
 107 </iframe>
 108 </div>
 109
 110 <div class="header">
 111   <div class="summary">
 112 <a href="#func-members">Functions</a>  </div>
 113   <div class="headertitle">
 114 <div class="title">WiFi Control<div class="ingroups"><a class="el" href="group__wifi__funcs.html">WiFi Validation</a></div></div>  </div>
 115 </div><!--header-->
 116 <div class="contents">
 117 <table class="memberdecls">
 118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 119 Functions</h2></td></tr>
 120 <tr class="memitem:gabf36e93010fb844fac85ed8dbcbb3a7d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__ctrl.html#gabf36e93010fb844fac85ed8dbcbb3a7d">WIFI_GetVersion</a> (void)</td></tr>
 121 <tr class="memdesc:gabf36e93010fb844fac85ed8dbcbb3a7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: WIFI_GetVersion.  <a href="#gabf36e93010fb844fac85ed8dbcbb3a7d">More...</a><br/></td></tr>
 122 <tr class="separator:gabf36e93010fb844fac85ed8dbcbb3a7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 <tr class="memitem:ga5471ab21541fea5b044ff6d494612e98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__ctrl.html#ga5471ab21541fea5b044ff6d494612e98">WIFI_GetCapabilities</a> (void)</td></tr>
 124 <tr class="memdesc:ga5471ab21541fea5b044ff6d494612e98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: WIFI_GetCapabilities.  <a href="#ga5471ab21541fea5b044ff6d494612e98">More...</a><br/></td></tr>
 125 <tr class="separator:ga5471ab21541fea5b044ff6d494612e98"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <tr class="memitem:gab582bc281e499b96e649c54d79f215a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__ctrl.html#gab582bc281e499b96e649c54d79f215a3">WIFI_Initialize_Uninitialize</a> (void)</td></tr>
 127 <tr class="memdesc:gab582bc281e499b96e649c54d79f215a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: WIFI_Initialize/Uninitialize.  <a href="#gab582bc281e499b96e649c54d79f215a3">More...</a><br/></td></tr>
 128 <tr class="separator:gab582bc281e499b96e649c54d79f215a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 <tr class="memitem:gaeb5d009d842e3e9392cef317c8132237"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__ctrl.html#gaeb5d009d842e3e9392cef317c8132237">WIFI_PowerControl</a> (void)</td></tr>
 130 <tr class="memdesc:gaeb5d009d842e3e9392cef317c8132237"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: WIFI_PowerControl.  <a href="#gaeb5d009d842e3e9392cef317c8132237">More...</a><br/></td></tr>
 131 <tr class="separator:gaeb5d009d842e3e9392cef317c8132237"><td class="memSeparator" colspan="2">&#160;</td></tr>
 132 <tr class="memitem:ga31db4cf74dda4771170c23f2e503a5a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__ctrl.html#ga31db4cf74dda4771170c23f2e503a5a5">WIFI_GetModuleInfo</a> (void)</td></tr>
 133 <tr class="memdesc:ga31db4cf74dda4771170c23f2e503a5a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: WIFI_GetModuleInfo.  <a href="#ga31db4cf74dda4771170c23f2e503a5a5">More...</a><br/></td></tr>
 134 <tr class="separator:ga31db4cf74dda4771170c23f2e503a5a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 </table>
 136 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 137 <p>These tests verify API and operation of the WiFi control functions. </p>
 138 <h2 class="groupheader">Function Documentation</h2>
 139 <a class="anchor" id="ga5471ab21541fea5b044ff6d494612e98"></a>
 140 <div class="memitem">
 141 <div class="memproto">
 142       <table class="memname">
 143         <tr>
 144           <td class="memname">void WIFI_GetCapabilities </td>
 145           <td>(</td>
 146           <td class="paramtype">void&#160;</td>
 147           <td class="paramname"></td><td>)</td>
 148           <td></td>
 149         </tr>
 150       </table>
 151 </div><div class="memdoc">
 152 <p>The test case <b>WIFI_GetCapabilities</b> verifies the WiFi Driver <b>GetCapabilities</b> function. </p>
 153 <div class="fragment"><div class="line">ARM_WIFI_CAPABILITIES (*GetCapabilities) (void);</div>
 154 </div><!-- fragment -->
 155 </div>
 156 </div>
 157 <a class="anchor" id="ga31db4cf74dda4771170c23f2e503a5a5"></a>
 158 <div class="memitem">
 159 <div class="memproto">
 160       <table class="memname">
 161         <tr>
 162           <td class="memname">void WIFI_GetModuleInfo </td>
 163           <td>(</td>
 164           <td class="paramtype">void&#160;</td>
 165           <td class="paramname"></td><td>)</td>
 166           <td></td>
 167         </tr>
 168       </table>
 169 </div><div class="memdoc">
 170 <p>The test case <b>WIFI_GetModuleInfo</b> verifies the WiFi Driver <b>GetModuleInfo</b> function. </p>
 171 <div class="fragment"><div class="line">int32_t (*GetModuleInfo) (<span class="keywordtype">char</span> *module_info, uint32_t max_len);</div>
 172 </div><!-- fragment -->
 173 </div>
 174 </div>
 175 <a class="anchor" id="gabf36e93010fb844fac85ed8dbcbb3a7d"></a>
 176 <div class="memitem">
 177 <div class="memproto">
 178       <table class="memname">
 179         <tr>
 180           <td class="memname">void WIFI_GetVersion </td>
 181           <td>(</td>
 182           <td class="paramtype">void&#160;</td>
 183           <td class="paramname"></td><td>)</td>
 184           <td></td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188 <p>The test case <b>WIFI_GetVersion</b> verifies the WiFi Driver <b>GetVersion</b> function. </p>
 189 <div class="fragment"><div class="line">ARM_DRIVER_VERSION (*GetVersion) (void);</div>
 190 </div><!-- fragment -->
 191 </div>
 192 </div>
 193 <a class="anchor" id="gab582bc281e499b96e649c54d79f215a3"></a>
 194 <div class="memitem">
 195 <div class="memproto">
 196       <table class="memname">
 197         <tr>
 198           <td class="memname">void WIFI_Initialize_Uninitialize </td>
 199           <td>(</td>
 200           <td class="paramtype">void&#160;</td>
 201           <td class="paramname"></td><td>)</td>
 202           <td></td>
 203         </tr>
 204       </table>
 205 </div><div class="memdoc">
 206 <p>The test case <b>WIFI_Initialize_Uninitialize</b> verifies the WiFi Driver <b>Initialize</b> and <b>Uninitialize</b> functions. </p>
 207 <div class="fragment"><div class="line">int32_t (*Initialize) (ARM_WIFI_SignalEvent_t cb_event);</div>
 208 </div><!-- fragment --><p> and </p>
 209 <div class="fragment"><div class="line">int32_t (*Uninitialize) (void);</div>
 210 </div><!-- fragment --><p> Testing sequence:</p>
 211 <ul>
 212 <li>Initialize without callback</li>
 213 <li>Uninitialize</li>
 214 <li>Initialize with callback (if driver supports it)</li>
 215 <li>Power on</li>
 216 <li>Uninitialize</li>
 217 <li>Initialize without callback</li>
 218 <li>Power on</li>
 219 <li>Power off</li>
 220 <li>Uninitialize </li>
 221 </ul>
 222
 223 </div>
 224 </div>
 225 <a class="anchor" id="gaeb5d009d842e3e9392cef317c8132237"></a>
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname">void WIFI_PowerControl </td>
 231           <td>(</td>
 232           <td class="paramtype">void&#160;</td>
 233           <td class="paramname"></td><td>)</td>
 234           <td></td>
 235         </tr>
 236       </table>
 237 </div><div class="memdoc">
 238 <p>The test case <b>WIFI_PowerControl</b> verifies the WiFi Driver <b>PowerControl</b> function. </p>
 239 <div class="fragment"><div class="line">int32_t (*PowerControl) (ARM_POWER_STATE state);</div>
 240 </div><!-- fragment --><p> Testing sequence:</p>
 241 <ul>
 242 <li>Power off</li>
 243 <li>Initialize with callback (if driver supports it)</li>
 244 <li>Power off</li>
 245 <li>Power on</li>
 246 <li>Scan</li>
 247 <li>Power low</li>
 248 <li>Power off</li>
 249 <li>Uninitialize </li>
 250 </ul>
 251
 252 </div>
 253 </div>
 254 </div><!-- contents -->
 255 </div><!-- doc-content -->
 256 <!-- start footer part -->
 257 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 258   <ul>
 259     <li class="footer">Generated on Fri Oct 4 2019 14:13:04 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 260         <!--
 261     <a href="http://www.doxygen.org/index.html">
 262     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 263         -->
 264         </li>
 265   </ul>
 266 </div>
 267 </body>
 268 </html>