Evlers
/
rt-thread_wifi-host-driver
peilaus alkaen https://github-proxy.rt-thread.io/Evlers/rt-thread_wifi-host-driver.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    <title>Wi-Fi Host Driver (WHD): WHD Wi-Fi SoftAP API</title>
    <link href="tabs.css" rel="stylesheet" type="text/css"/>
    <script type="text/javascript" src="jquery.js"></script>
    <script type="text/javascript" src="dynsections.js"></script>
    <link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
    <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="doxygen.css" rel="stylesheet" type="text/css" />
  </head>
  <body>
    <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
      <div id="titlearea" style="font-family:verdana;">
        <table border='0' cellpadding='0' cellspacing='0' width="98%">
          <tr style="height:20px"><td>&nbsp;</td></tr>
          <tr style="border-collapse: collapse; padding: 0;">
            <td style="width:20px"></td>
            <td style="width:117px"><img src="ifx_logo.png" alt="Infineon Logo" /></td>
            <td style="vertical-align:middle; text-align:center; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
              Wi-Fi Host Driver (WHD) Public API Reference Guide
            </td>
          </tr>
          <tr><td>&nbsp;</td></tr>
        </table>
    </div>
    <!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__wifisoftap.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">WHD Wi-Fi SoftAP API<div class="ingroups"><a class="el" href="group__wifi.html">WHD Wi-Fi API</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>Wi-Fi APIs to perform SoftAP related functionalities. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga647aebc1d86708017fd11029e2e1a51c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga647aebc1d86708017fd11029e2e1a51c">whd_wifi_init_ap</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, <a class="el" href="structwhd__ssid__t.html">whd_ssid_t</a> *ssid, <a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a> auth_type, const uint8_t *security_key, uint8_t key_length, uint8_t channel)</td></tr>
<tr class="memdesc:ga647aebc1d86708017fd11029e2e1a51c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialises an infrastructure WiFi network (SoftAP)  <a href="#ga647aebc1d86708017fd11029e2e1a51c">More...</a><br /></td></tr>
<tr class="separator:ga647aebc1d86708017fd11029e2e1a51c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c9aa99add3f6a6d13e9092bd6e1246b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga3c9aa99add3f6a6d13e9092bd6e1246b">whd_wifi_start_ap</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp)</td></tr>
<tr class="memdesc:ga3c9aa99add3f6a6d13e9092bd6e1246b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the infrastructure WiFi network (SoftAP) using the parameter set by <a class="el" href="group__wifisoftap.html#ga647aebc1d86708017fd11029e2e1a51c" title="Initialises an infrastructure WiFi network (SoftAP)">whd_wifi_init_ap()</a> and optionaly by <a class="el" href="group__wifiutilities.html#gaaf7be7d8099507426f52ecff8f716543" title="Manage the addition and removal of custom IEs.">whd_wifi_manage_custom_ie()</a>  <a href="#ga3c9aa99add3f6a6d13e9092bd6e1246b">More...</a><br /></td></tr>
<tr class="separator:ga3c9aa99add3f6a6d13e9092bd6e1246b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c6c28512678dc57dabb641c41e30d41"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga2c6c28512678dc57dabb641c41e30d41">whd_wifi_stop_ap</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp)</td></tr>
<tr class="memdesc:ga2c6c28512678dc57dabb641c41e30d41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops an existing infrastructure WiFi network.  <a href="#ga2c6c28512678dc57dabb641c41e30d41">More...</a><br /></td></tr>
<tr class="separator:ga2c6c28512678dc57dabb641c41e30d41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga32982684d093a173a6e578856b581d29"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga32982684d093a173a6e578856b581d29">whd_wifi_ap_get_max_assoc</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint32_t *max_assoc)</td></tr>
<tr class="memdesc:ga32982684d093a173a6e578856b581d29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum number of associations supported by AP interfaces.  <a href="#ga32982684d093a173a6e578856b581d29">More...</a><br /></td></tr>
<tr class="separator:ga32982684d093a173a6e578856b581d29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e974ab0fcc24698d01a5abc3e2c1dbb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga9e974ab0fcc24698d01a5abc3e2c1dbb">whd_wifi_get_associated_client_list</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, void *client_list_buffer, uint16_t buffer_length)</td></tr>
<tr class="memdesc:ga9e974ab0fcc24698d01a5abc3e2c1dbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current number of active connections.  <a href="#ga9e974ab0fcc24698d01a5abc3e2c1dbb">More...</a><br /></td></tr>
<tr class="separator:ga9e974ab0fcc24698d01a5abc3e2c1dbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad9ad2649c18db8773351a5938e7930e4"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#gad9ad2649c18db8773351a5938e7930e4">whd_wifi_deauth_sta</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, <a class="el" href="structwhd__mac__t.html">whd_mac_t</a> *mac, <a class="el" href="whd__types_8h.html#ac81b31559ee1db82f01e8acfb8eea55d">whd_dot11_reason_code_t</a> reason)</td></tr>
<tr class="memdesc:gad9ad2649c18db8773351a5938e7930e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deauthenticates a STA which may or may not be associated to SoftAP.  <a href="#gad9ad2649c18db8773351a5938e7930e4">More...</a><br /></td></tr>
<tr class="separator:gad9ad2649c18db8773351a5938e7930e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95c40af4be45d119b737c0113d9a038e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga95c40af4be45d119b737c0113d9a038e">whd_wifi_get_ap_info</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, whd_bss_info_t *ap_info, <a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a> *security)</td></tr>
<tr class="memdesc:ga95c40af4be45d119b737c0113d9a038e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves AP information.  <a href="#ga95c40af4be45d119b737c0113d9a038e">More...</a><br /></td></tr>
<tr class="separator:ga95c40af4be45d119b737c0113d9a038e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf2758fcc1028704d801b16d77b96a345"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#gaf2758fcc1028704d801b16d77b96a345">whd_wifi_ap_set_beacon_interval</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint16_t interval)</td></tr>
<tr class="memdesc:gaf2758fcc1028704d801b16d77b96a345"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the beacon interval.  <a href="#gaf2758fcc1028704d801b16d77b96a345">More...</a><br /></td></tr>
<tr class="separator:gaf2758fcc1028704d801b16d77b96a345"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57c57ad4d5acf499e90ff8db020fa2d9"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga57c57ad4d5acf499e90ff8db020fa2d9">whd_wifi_ap_set_dtim_interval</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint16_t interval)</td></tr>
<tr class="memdesc:ga57c57ad4d5acf499e90ff8db020fa2d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the DTIM interval.  <a href="#ga57c57ad4d5acf499e90ff8db020fa2d9">More...</a><br /></td></tr>
<tr class="separator:ga57c57ad4d5acf499e90ff8db020fa2d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga647aebc1d86708017fd11029e2e1a51c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga647aebc1d86708017fd11029e2e1a51c">&#9670;&nbsp;</a></span>whd_wifi_init_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_init_ap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structwhd__ssid__t.html">whd_ssid_t</a> *&#160;</td>
          <td class="paramname"><em>ssid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a>&#160;</td>
          <td class="paramname"><em>auth_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>security_key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>key_length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>channel</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialises an infrastructure WiFi network (SoftAP) </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ssid</td><td>A null terminated string containing the SSID name of the network to join </td></tr>
    <tr><td class="paramname">auth_type</td><td>Authentication type </td></tr>
    <tr><td class="paramname">security_key</td><td>A byte array containing the cleartext security key for the network </td></tr>
    <tr><td class="paramname">key_length</td><td>The length of the security_key in bytes. </td></tr>
    <tr><td class="paramname">channel</td><td>802.11 channel number</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if successfully initialises an AP Error code if an error occurred </dd></dl>

</div>
</div>
<a id="ga3c9aa99add3f6a6d13e9092bd6e1246b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c9aa99add3f6a6d13e9092bd6e1246b">&#9670;&nbsp;</a></span>whd_wifi_start_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_start_ap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start the infrastructure WiFi network (SoftAP) using the parameter set by <a class="el" href="group__wifisoftap.html#ga647aebc1d86708017fd11029e2e1a51c" title="Initialises an infrastructure WiFi network (SoftAP)">whd_wifi_init_ap()</a> and optionaly by <a class="el" href="group__wifiutilities.html#gaaf7be7d8099507426f52ecff8f716543" title="Manage the addition and removal of custom IEs.">whd_wifi_manage_custom_ie()</a> </p>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if successfully creates an AP Error code if an error occurred </dd></dl>

</div>
</div>
<a id="ga2c6c28512678dc57dabb641c41e30d41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c6c28512678dc57dabb641c41e30d41">&#9670;&nbsp;</a></span>whd_wifi_stop_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_stop_ap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stops an existing infrastructure WiFi network. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the AP is successfully stopped or if the AP has not yet been brought up Error code if an error occurred </dd></dl>

</div>
</div>
<a id="ga32982684d093a173a6e578856b581d29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga32982684d093a173a6e578856b581d29">&#9670;&nbsp;</a></span>whd_wifi_ap_get_max_assoc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_ap_get_max_assoc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>max_assoc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the maximum number of associations supported by AP interfaces. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">max_assoc</td><td>The maximum number of associations supported by Soft AP interfaces.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the maximum number of associated clients was successfully read WHD_ERROR if the maximum number of associated clients was not successfully read </dd></dl>

</div>
</div>
<a id="ga9e974ab0fcc24698d01a5abc3e2c1dbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9e974ab0fcc24698d01a5abc3e2c1dbb">&#9670;&nbsp;</a></span>whd_wifi_get_associated_client_list()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_get_associated_client_list </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>client_list_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>buffer_length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the current number of active connections. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">client_list_buffer</td><td>Buffer to store list of associated clients </td></tr>
    <tr><td class="paramname">buffer_length</td><td>Length of client list buffer</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the active connections was successfully read WHD_ERROR if the active connections was not successfully read </dd></dl>

</div>
</div>
<a id="gad9ad2649c18db8773351a5938e7930e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad9ad2649c18db8773351a5938e7930e4">&#9670;&nbsp;</a></span>whd_wifi_deauth_sta()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_deauth_sta </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structwhd__mac__t.html">whd_mac_t</a> *&#160;</td>
          <td class="paramname"><em>mac</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#ac81b31559ee1db82f01e8acfb8eea55d">whd_dot11_reason_code_t</a>&#160;</td>
          <td class="paramname"><em>reason</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deauthenticates a STA which may or may not be associated to SoftAP. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">mac</td><td>Pointer to a variable containing the MAC address to which the deauthentication will be sent NULL mac address will deauthenticate all the associated STAs</td></tr>
    <tr><td class="paramname">reason</td><td>Deauthentication reason code</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS On successful deauthentication of the other STA WHD_ERROR If an error occurred </dd></dl>

</div>
</div>
<a id="ga95c40af4be45d119b737c0113d9a038e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95c40af4be45d119b737c0113d9a038e">&#9670;&nbsp;</a></span>whd_wifi_get_ap_info()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_get_ap_info </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">whd_bss_info_t *&#160;</td>
          <td class="paramname"><em>ap_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a> *&#160;</td>
          <td class="paramname"><em>security</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves AP information. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ap_info</td><td>Returns a whd_bss_info_t structure containing AP details </td></tr>
    <tr><td class="paramname">security</td><td>Authentication type</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the AP info was successfully retrieved Error code if the AP info was not successfully retrieved </dd></dl>

</div>
</div>
<a id="gaf2758fcc1028704d801b16d77b96a345"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf2758fcc1028704d801b16d77b96a345">&#9670;&nbsp;</a></span>whd_wifi_ap_set_beacon_interval()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_ap_set_beacon_interval </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>interval</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the beacon interval. </p>
<p>Note that the value needs to be set before ap_start in order to beacon interval to take effect.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">interval</td><td>Beacon interval in time units (Default: 100 time units = 102.4 ms)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="ga57c57ad4d5acf499e90ff8db020fa2d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57c57ad4d5acf499e90ff8db020fa2d9">&#9670;&nbsp;</a></span>whd_wifi_ap_set_dtim_interval()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_ap_set_dtim_interval </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>interval</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the DTIM interval. </p>
<p>Note that the value needs to be set before ap_start in order to DTIM interval to take effect.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">interval</td><td>DTIM interval, in unit of beacon interval</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
    <!-- start footer part -->
    <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
      <ul>
        <li class="footer">Copyright Infineon Technologies.</li>
      </ul>
    </div>
  </body>
</html>