mirror of
https://github.com/buildwithparallel/mm-iot-sdk
synced 2026-08-10 21:27:58 -04:00
4f4eb7fc7a
This commit introduces version 2.9.7 of the Morse Micro MM-IoT-SDK for ARM microcontroller base platforms.
481 lines
32 KiB
HTML
481 lines
32 KiB
HTML
<!-- HTML header for doxygen 1.8.17-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
|
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Morse Micro IoT SDK: mmwlan_softap_args Struct Reference</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>
|
|
<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" />
|
|
<link href="style.css" rel="stylesheet" type="text/css"/>
|
|
<link rel="shortcut icon" href="favicon.svg" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Morse Micro IoT SDK
|
|
 <span id="projectnumber">2.9.7</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('structmmwlan__softap__args.html',''); initResizable(); });
|
|
/* @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="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">mmwlan_softap_args Struct Reference<div class="ingroups"><a class="el" href="group__MMWLAN.html">Morse Micro Wireless LAN (mmwlan) API</a> » <a class="el" href="group__MMWLAN__CTRL.html">WLAN Control API</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Arguments data structure for <a class="el" href="group__MMWLAN__CTRL.html#ga93f53a46eca2b0437b619975079aa77a">mmwlan_softap_enable()</a>. </p>
|
|
<p >This structure should be initialized using <a class="el" href="group__MMWLAN__CTRL.html#ga1df9edc518187bd43a341bfdc389efca">MMWLAN_SOFTAP_ARGS_INIT</a> for sensible default values, particularly for forward compatibility with new releases that may add new fields to the struct. For example:</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">enum</span> <a class="code hl_enumeration" href="group__MMWLAN.html#ga0039072000d47e5c3712686bf1e43086">mmwlan_status</a> status;</div>
|
|
<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structmmwlan__softap__args.html">mmwlan_softap_args</a> softap_args = <a class="code hl_define" href="group__MMWLAN__CTRL.html#ga1df9edc518187bd43a341bfdc389efca">MMWLAN_SOFTAP_ARGS_INIT</a>;</div>
|
|
<div class="line"><span class="comment">// HERE: initialize arguments</span></div>
|
|
<div class="line">status = <a class="code hl_function" href="group__MMWLAN__CTRL.html#ga93f53a46eca2b0437b619975079aa77a">mmwlan_softap_enable</a>(&softap_args);</div>
|
|
<div class="ttc" id="agroup__MMWLAN__CTRL_html_ga1df9edc518187bd43a341bfdc389efca"><div class="ttname"><a href="group__MMWLAN__CTRL.html#ga1df9edc518187bd43a341bfdc389efca">MMWLAN_SOFTAP_ARGS_INIT</a></div><div class="ttdeci">#define MMWLAN_SOFTAP_ARGS_INIT</div><div class="ttdoc">Initializer for mmwlan_softap_args.</div><div class="ttdef"><b>Definition:</b> <a href="mmwlan_8h_source.html#l01405">mmwlan.h:1405</a></div></div>
|
|
<div class="ttc" id="agroup__MMWLAN__CTRL_html_ga93f53a46eca2b0437b619975079aa77a"><div class="ttname"><a href="group__MMWLAN__CTRL.html#ga93f53a46eca2b0437b619975079aa77a">mmwlan_softap_enable</a></div><div class="ttdeci">enum mmwlan_status mmwlan_softap_enable(const struct mmwlan_softap_args *args)</div><div class="ttdoc">Enable Soft AP mode.</div></div>
|
|
<div class="ttc" id="agroup__MMWLAN_html_ga0039072000d47e5c3712686bf1e43086"><div class="ttname"><a href="group__MMWLAN.html#ga0039072000d47e5c3712686bf1e43086">mmwlan_status</a></div><div class="ttdeci">mmwlan_status</div><div class="ttdoc">Enumeration of status return codes.</div><div class="ttdef"><b>Definition:</b> <a href="mmwlan_8h_source.html#l00049">mmwlan.h:50</a></div></div>
|
|
<div class="ttc" id="astructmmwlan__softap__args_html"><div class="ttname"><a href="structmmwlan__softap__args.html">mmwlan_softap_args</a></div><div class="ttdoc">Arguments data structure for mmwlan_softap_enable().</div><div class="ttdef"><b>Definition:</b> <a href="mmwlan_8h_source.html#l01323">mmwlan.h:1324</a></div></div>
|
|
</div><!-- fragment --><dl class="section warning"><dt>Warning</dt><dd>BETA NOTICE: This is beta API that is under development; breaking changes may be introduced in future releases. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01323">1323</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:af373fa1f49bccb7aee8dba3382c2eafa"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#af373fa1f49bccb7aee8dba3382c2eafa">ssid</a> [<a class="el" href="group__MMWLAN.html#gab3eb6b84d66a2bac936052645f431015">MMWLAN_SSID_MAXLEN</a>]</td></tr>
|
|
<tr class="memdesc:af373fa1f49bccb7aee8dba3382c2eafa"><td class="mdescLeft"> </td><td class="mdescRight">SSID of the AP. <a href="structmmwlan__softap__args.html#af373fa1f49bccb7aee8dba3382c2eafa">More...</a><br /></td></tr>
|
|
<tr class="separator:af373fa1f49bccb7aee8dba3382c2eafa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9771bd79c1814b6b194703376b3bcc42"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a9771bd79c1814b6b194703376b3bcc42">ssid_len</a></td></tr>
|
|
<tr class="memdesc:a9771bd79c1814b6b194703376b3bcc42"><td class="mdescLeft"> </td><td class="mdescRight">Length of the SSID. <a href="structmmwlan__softap__args.html#a9771bd79c1814b6b194703376b3bcc42">More...</a><br /></td></tr>
|
|
<tr class="separator:a9771bd79c1814b6b194703376b3bcc42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0754fc595a0290b66a5a418f6edcf3b3"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a0754fc595a0290b66a5a418f6edcf3b3">bssid</a> [<a class="el" href="group__MMWLAN.html#gad1f02bb330d9d2f4c831a1cf9d44ff1a">MMWLAN_MAC_ADDR_LEN</a>]</td></tr>
|
|
<tr class="memdesc:a0754fc595a0290b66a5a418f6edcf3b3"><td class="mdescLeft"> </td><td class="mdescRight">Optional BSSID of the AP. <a href="structmmwlan__softap__args.html#a0754fc595a0290b66a5a418f6edcf3b3">More...</a><br /></td></tr>
|
|
<tr class="separator:a0754fc595a0290b66a5a418f6edcf3b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af37ae5ad0b555e989111ac9e23e93ff3"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__MMWLAN.html#gaa1811e3233be70cf35a4611111eddca0">mmwlan_security_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#af37ae5ad0b555e989111ac9e23e93ff3">security_type</a></td></tr>
|
|
<tr class="memdesc:af37ae5ad0b555e989111ac9e23e93ff3"><td class="mdescLeft"> </td><td class="mdescRight">Type of security to use. <a href="structmmwlan__softap__args.html#af37ae5ad0b555e989111ac9e23e93ff3">More...</a><br /></td></tr>
|
|
<tr class="separator:af37ae5ad0b555e989111ac9e23e93ff3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a006950c5a9641eb8de48281dd6e009d6"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a006950c5a9641eb8de48281dd6e009d6">passphrase</a> [<a class="el" href="group__MMWLAN.html#ga240c532e1ff898c69904c2dd2e346b11">MMWLAN_PASSPHRASE_MAXLEN</a>+1]</td></tr>
|
|
<tr class="memdesc:a006950c5a9641eb8de48281dd6e009d6"><td class="mdescLeft"> </td><td class="mdescRight">Passphrase (only used if <code>security_type</code> is <code>MMWLAN_SAE</code>, otherwise ignored. <a href="structmmwlan__softap__args.html#a006950c5a9641eb8de48281dd6e009d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a006950c5a9641eb8de48281dd6e009d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a224da1075f109b24db584dcf0ff20e83"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a224da1075f109b24db584dcf0ff20e83">passphrase_len</a></td></tr>
|
|
<tr class="memdesc:a224da1075f109b24db584dcf0ff20e83"><td class="mdescLeft"> </td><td class="mdescRight">Length of <code>passphrase</code>. <a href="structmmwlan__softap__args.html#a224da1075f109b24db584dcf0ff20e83">More...</a><br /></td></tr>
|
|
<tr class="separator:a224da1075f109b24db584dcf0ff20e83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9cc599366f01d3e13443b668c63d3a2c"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__MMWLAN.html#ga6f1e10b52468bc91ff773e96377bfa17">mmwlan_pmf_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a9cc599366f01d3e13443b668c63d3a2c">pmf_mode</a></td></tr>
|
|
<tr class="memdesc:a9cc599366f01d3e13443b668c63d3a2c"><td class="mdescLeft"> </td><td class="mdescRight">Protected Management Frame mode to use (802.11w) <a href="structmmwlan__softap__args.html#a9cc599366f01d3e13443b668c63d3a2c">More...</a><br /></td></tr>
|
|
<tr class="separator:a9cc599366f01d3e13443b668c63d3a2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17a673dd47d9e63d2ef47b0543d921dd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a17a673dd47d9e63d2ef47b0543d921dd">sae_owe_ec_groups</a> [<a class="el" href="group__MMWLAN.html#ga8e0c9525afa90a775d251a7dd785cb92">MMWLAN_MAX_EC_GROUPS</a>]</td></tr>
|
|
<tr class="memdesc:a17a673dd47d9e63d2ef47b0543d921dd"><td class="mdescLeft"> </td><td class="mdescRight">Preference list of enabled elliptic curve groups for SAE and OWE. <a href="structmmwlan__softap__args.html#a17a673dd47d9e63d2ef47b0543d921dd">More...</a><br /></td></tr>
|
|
<tr class="separator:a17a673dd47d9e63d2ef47b0543d921dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32caef7a6ce3f4849a1ae4cdd399e63f"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a32caef7a6ce3f4849a1ae4cdd399e63f">op_class</a></td></tr>
|
|
<tr class="memdesc:a32caef7a6ce3f4849a1ae4cdd399e63f"><td class="mdescLeft"> </td><td class="mdescRight">Operating Class to use (S1G or Global). <a href="structmmwlan__softap__args.html#a32caef7a6ce3f4849a1ae4cdd399e63f">More...</a><br /></td></tr>
|
|
<tr class="separator:a32caef7a6ce3f4849a1ae4cdd399e63f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7bf30c8c60c4eada02b1e3df54e96a46"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a7bf30c8c60c4eada02b1e3df54e96a46">s1g_chan_num</a></td></tr>
|
|
<tr class="memdesc:a7bf30c8c60c4eada02b1e3df54e96a46"><td class="mdescLeft"> </td><td class="mdescRight">S1G channel number of the channel to use. <a href="structmmwlan__softap__args.html#a7bf30c8c60c4eada02b1e3df54e96a46">More...</a><br /></td></tr>
|
|
<tr class="separator:a7bf30c8c60c4eada02b1e3df54e96a46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeee9c7f35aa907c68e18061ff7e3aed1"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#aeee9c7f35aa907c68e18061ff7e3aed1">beacon_interval_tus</a></td></tr>
|
|
<tr class="memdesc:aeee9c7f35aa907c68e18061ff7e3aed1"><td class="mdescLeft"> </td><td class="mdescRight">The Beacon period in units of TUs. <a href="structmmwlan__softap__args.html#aeee9c7f35aa907c68e18061ff7e3aed1">More...</a><br /></td></tr>
|
|
<tr class="separator:aeee9c7f35aa907c68e18061ff7e3aed1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae04d9251d5f87ef7ce351660b039a3a4"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#ae04d9251d5f87ef7ce351660b039a3a4">dtim_period</a></td></tr>
|
|
<tr class="memdesc:ae04d9251d5f87ef7ce351660b039a3a4"><td class="mdescLeft"> </td><td class="mdescRight">The Delivery Traffic Indication Map (DTIM) interval in beacons. <a href="structmmwlan__softap__args.html#ae04d9251d5f87ef7ce351660b039a3a4">More...</a><br /></td></tr>
|
|
<tr class="separator:ae04d9251d5f87ef7ce351660b039a3a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6580bfe0c7e7ef0aa1a3eb6f8ae1c05b"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a6580bfe0c7e7ef0aa1a3eb6f8ae1c05b">pri_bw_mhz</a></td></tr>
|
|
<tr class="memdesc:a6580bfe0c7e7ef0aa1a3eb6f8ae1c05b"><td class="mdescLeft"> </td><td class="mdescRight">Bandwidth to use for the primary channel. <a href="structmmwlan__softap__args.html#a6580bfe0c7e7ef0aa1a3eb6f8ae1c05b">More...</a><br /></td></tr>
|
|
<tr class="separator:a6580bfe0c7e7ef0aa1a3eb6f8ae1c05b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35782cf6499a51318451169697441513"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a35782cf6499a51318451169697441513">pri_1mhz_chan_idx</a></td></tr>
|
|
<tr class="memdesc:a35782cf6499a51318451169697441513"><td class="mdescLeft"> </td><td class="mdescRight">Index of the primary 1 Mhz channel within the operating channel. <a href="structmmwlan__softap__args.html#a35782cf6499a51318451169697441513">More...</a><br /></td></tr>
|
|
<tr class="separator:a35782cf6499a51318451169697441513"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fde38576b8ec07ec772c3404f2d9998"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MMWLAN__CTRL.html#ga7c506319e2f0a52c59f7938e733e8d31">mmwlan_softap_sta_status_cb_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#a3fde38576b8ec07ec772c3404f2d9998">sta_status_cb</a></td></tr>
|
|
<tr class="memdesc:a3fde38576b8ec07ec772c3404f2d9998"><td class="mdescLeft"> </td><td class="mdescRight">Optional callback to be invoked when the status of a connected STA changes. <a href="structmmwlan__softap__args.html#a3fde38576b8ec07ec772c3404f2d9998">More...</a><br /></td></tr>
|
|
<tr class="separator:a3fde38576b8ec07ec772c3404f2d9998"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa157c7f4071c22c11efd3ce56361731e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__softap__args.html#aa157c7f4071c22c11efd3ce56361731e">sta_status_cb_arg</a></td></tr>
|
|
<tr class="memdesc:aa157c7f4071c22c11efd3ce56361731e"><td class="mdescLeft"> </td><td class="mdescRight">Optional opaque argument to be passed to <code>sta_status_cb</code>. <a href="structmmwlan__softap__args.html#aa157c7f4071c22c11efd3ce56361731e">More...</a><br /></td></tr>
|
|
<tr class="separator:aa157c7f4071c22c11efd3ce56361731e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="aeee9c7f35aa907c68e18061ff7e3aed1" name="aeee9c7f35aa907c68e18061ff7e3aed1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeee9c7f35aa907c68e18061ff7e3aed1">◆ </a></span>beacon_interval_tus</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmwlan_softap_args::beacon_interval_tus</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The Beacon period in units of TUs. </p>
|
|
<p >A TU is equal to 1.024 ms.</p>
|
|
<p >If zero then the default value, <a class="el" href="group__MMWLAN.html#ga97067bcced560be898c59bda0e54daec">MMWLAN_DEFAULT_SOFTAP_BEACON_INTERVAL_TUS</a>, will be used. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01369">1369</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0754fc595a0290b66a5a418f6edcf3b3" name="a0754fc595a0290b66a5a418f6edcf3b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0754fc595a0290b66a5a418f6edcf3b3">◆ </a></span>bssid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t mmwlan_softap_args::bssid[<a class="el" href="group__MMWLAN.html#gad1f02bb330d9d2f4c831a1cf9d44ff1a">MMWLAN_MAC_ADDR_LEN</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Optional BSSID of the AP. </p>
|
|
<p >If zero then the devices MAC address will be used.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The MAC address selection behavior may change in future. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01334">1334</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae04d9251d5f87ef7ce351660b039a3a4" name="ae04d9251d5f87ef7ce351660b039a3a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae04d9251d5f87ef7ce351660b039a3a4">◆ </a></span>dtim_period</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmwlan_softap_args::dtim_period</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The Delivery Traffic Indication Map (DTIM) interval in beacons. </p>
|
|
<p >If zero then the default value, <a class="el" href="group__MMWLAN.html#gaba883cb183bdd2478a36420499755727">MMWLAN_DEFAULT_SOFTAP_DTIM_PERIOD</a>, will be used. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01375">1375</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a32caef7a6ce3f4849a1ae4cdd399e63f" name="a32caef7a6ce3f4849a1ae4cdd399e63f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32caef7a6ce3f4849a1ae4cdd399e63f">◆ </a></span>op_class</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmwlan_softap_args::op_class</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Operating Class to use (S1G or Global). </p>
|
|
<p >The combination of this field and <code>s1g_chan_num</code> will be used to look up the appropriate entry in the channel list, which must have been previously provided using <a class="el" href="group__MMWLAN__REGDB.html#ga73b6742a29b62bf0091a9b6c9cc770db">mmwlan_set_channel_list()</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01355">1355</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a006950c5a9641eb8de48281dd6e009d6" name="a006950c5a9641eb8de48281dd6e009d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a006950c5a9641eb8de48281dd6e009d6">◆ </a></span>passphrase</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char mmwlan_softap_args::passphrase[<a class="el" href="group__MMWLAN.html#ga240c532e1ff898c69904c2dd2e346b11">MMWLAN_PASSPHRASE_MAXLEN</a>+1]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Passphrase (only used if <code>security_type</code> is <code>MMWLAN_SAE</code>, otherwise ignored. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01338">1338</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a224da1075f109b24db584dcf0ff20e83" name="a224da1075f109b24db584dcf0ff20e83"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a224da1075f109b24db584dcf0ff20e83">◆ </a></span>passphrase_len</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmwlan_softap_args::passphrase_len</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Length of <code>passphrase</code>. </p>
|
|
<p >May be zero if <code>passphrase</code> is null-terminated. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01340">1340</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9cc599366f01d3e13443b668c63d3a2c" name="a9cc599366f01d3e13443b668c63d3a2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9cc599366f01d3e13443b668c63d3a2c">◆ </a></span>pmf_mode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MMWLAN.html#ga6f1e10b52468bc91ff773e96377bfa17">mmwlan_pmf_mode</a> mmwlan_softap_args::pmf_mode</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Protected Management Frame mode to use (802.11w) </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01342">1342</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a35782cf6499a51318451169697441513" name="a35782cf6499a51318451169697441513"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35782cf6499a51318451169697441513">◆ </a></span>pri_1mhz_chan_idx</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t mmwlan_softap_args::pri_1mhz_chan_idx</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Index of the primary 1 Mhz channel within the operating channel. </p>
|
|
<p >This must be less than the bandwidth of the operating channel. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01387">1387</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6580bfe0c7e7ef0aa1a3eb6f8ae1c05b" name="a6580bfe0c7e7ef0aa1a3eb6f8ae1c05b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6580bfe0c7e7ef0aa1a3eb6f8ae1c05b">◆ </a></span>pri_bw_mhz</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t mmwlan_softap_args::pri_bw_mhz</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bandwidth to use for the primary channel. </p>
|
|
<p >This may be set to 0 to automatically select the highest primary bandwidth supported by the operating channel.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This must not be greater than the bandwidth of the operating channel. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01382">1382</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7bf30c8c60c4eada02b1e3df54e96a46" name="a7bf30c8c60c4eada02b1e3df54e96a46"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7bf30c8c60c4eada02b1e3df54e96a46">◆ </a></span>s1g_chan_num</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmwlan_softap_args::s1g_chan_num</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>S1G channel number of the channel to use. </p>
|
|
<p >The combination of this field and <code>op_class</code> will be used to look up the appropriate entry in the channel list, which must have been previously provided using <a class="el" href="group__MMWLAN__REGDB.html#ga73b6742a29b62bf0091a9b6c9cc770db">mmwlan_set_channel_list()</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01363">1363</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a17a673dd47d9e63d2ef47b0543d921dd" name="a17a673dd47d9e63d2ef47b0543d921dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a17a673dd47d9e63d2ef47b0543d921dd">◆ </a></span>sae_owe_ec_groups</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int mmwlan_softap_args::sae_owe_ec_groups[<a class="el" href="group__MMWLAN.html#ga8e0c9525afa90a775d251a7dd785cb92">MMWLAN_MAX_EC_GROUPS</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Preference list of enabled elliptic curve groups for SAE and OWE. </p>
|
|
<p >By default (if this parameter is not set), the mandatory group 19 is preferred. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01347">1347</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af37ae5ad0b555e989111ac9e23e93ff3" name="af37ae5ad0b555e989111ac9e23e93ff3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af37ae5ad0b555e989111ac9e23e93ff3">◆ </a></span>security_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MMWLAN.html#gaa1811e3233be70cf35a4611111eddca0">mmwlan_security_type</a> mmwlan_softap_args::security_type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type of security to use. </p>
|
|
<p >If <code>MMWLAN_SAE</code> then a <code>passphrase</code> must be specified. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01336">1336</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af373fa1f49bccb7aee8dba3382c2eafa" name="af373fa1f49bccb7aee8dba3382c2eafa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af373fa1f49bccb7aee8dba3382c2eafa">◆ </a></span>ssid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t mmwlan_softap_args::ssid[<a class="el" href="group__MMWLAN.html#gab3eb6b84d66a2bac936052645f431015">MMWLAN_SSID_MAXLEN</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SSID of the AP. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01326">1326</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9771bd79c1814b6b194703376b3bcc42" name="a9771bd79c1814b6b194703376b3bcc42"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9771bd79c1814b6b194703376b3bcc42">◆ </a></span>ssid_len</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmwlan_softap_args::ssid_len</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Length of the SSID. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01328">1328</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3fde38576b8ec07ec772c3404f2d9998" name="a3fde38576b8ec07ec772c3404f2d9998"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3fde38576b8ec07ec772c3404f2d9998">◆ </a></span>sta_status_cb</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__MMWLAN__CTRL.html#ga7c506319e2f0a52c59f7938e733e8d31">mmwlan_softap_sta_status_cb_t</a> mmwlan_softap_args::sta_status_cb</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Optional callback to be invoked when the status of a connected STA changes. </p>
|
|
<p >May be set to <code>NULL</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01392">1392</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa157c7f4071c22c11efd3ce56361731e" name="aa157c7f4071c22c11efd3ce56361731e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa157c7f4071c22c11efd3ce56361731e">◆ </a></span>sta_status_cb_arg</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* mmwlan_softap_args::sta_status_cb_arg</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Optional opaque argument to be passed to <code>sta_status_cb</code>. </p>
|
|
<p >May optionally be <code>NULL</code>. The value of this parameter must remain valid during the lifetime of the Soft AP. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01397">1397</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmwlan_8h_source.html">mmwlan.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.17-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="structmmwlan__softap__args.html">mmwlan_softap_args</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|