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.
151 lines
9.1 KiB
HTML
151 lines
9.1 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_tx_metadata 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__tx__metadata.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_tx_metadata 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__DATA.html">WLAN Datapath 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 >Metadata for TX packets. </p>
|
|
<p >This structure should be initialized using <a class="el" href="group__MMWLAN__DATA.html#gaea2485f837f11664455b410d83c1c9bc">MMWLAN_TX_METADATA_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__tx__metadata.html">mmwlan_tx_metadata</a> metadata = <a class="code hl_define" href="group__MMWLAN__DATA.html#gaea2485f837f11664455b410d83c1c9bc">MMWLAN_TX_METADATA_INIT</a>;</div>
|
|
<div class="line"><span class="comment">// HERE: initialize metadata</span></div>
|
|
<div class="line">status = <a class="code hl_function" href="group__MMWLAN__DATA.html#gac99f2ca7b19d56ce14a9d3a806395c10">mmwlan_tx_pkt</a>(pkt, &metadata);</div>
|
|
<div class="ttc" id="agroup__MMWLAN__DATA_html_gac99f2ca7b19d56ce14a9d3a806395c10"><div class="ttname"><a href="group__MMWLAN__DATA.html#gac99f2ca7b19d56ce14a9d3a806395c10">mmwlan_tx_pkt</a></div><div class="ttdeci">enum mmwlan_status mmwlan_tx_pkt(struct mmpkt *pkt, const struct mmwlan_tx_metadata *metadata)</div><div class="ttdoc">Transmit the given packet.</div></div>
|
|
<div class="ttc" id="agroup__MMWLAN__DATA_html_gaea2485f837f11664455b410d83c1c9bc"><div class="ttname"><a href="group__MMWLAN__DATA.html#gaea2485f837f11664455b410d83c1c9bc">MMWLAN_TX_METADATA_INIT</a></div><div class="ttdeci">#define MMWLAN_TX_METADATA_INIT</div><div class="ttdoc">Initializer for mmwlan_tx_metadata.</div><div class="ttdef"><b>Definition:</b> <a href="mmwlan_8h_source.html#l02417">mmwlan.h:2417</a></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__tx__metadata_html"><div class="ttname"><a href="structmmwlan__tx__metadata.html">mmwlan_tx_metadata</a></div><div class="ttdoc">Metadata for TX packets.</div><div class="ttdef"><b>Definition:</b> <a href="mmwlan_8h_source.html#l02405">mmwlan.h:2406</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l02405">2405</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:ad48abf0465bccb7088e0bbf5aad17059"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__tx__metadata.html#ad48abf0465bccb7088e0bbf5aad17059">tid</a></td></tr>
|
|
<tr class="memdesc:ad48abf0465bccb7088e0bbf5aad17059"><td class="mdescLeft"> </td><td class="mdescRight">Traffic ID (TID) to use. <a href="structmmwlan__tx__metadata.html#ad48abf0465bccb7088e0bbf5aad17059">More...</a><br /></td></tr>
|
|
<tr class="separator:ad48abf0465bccb7088e0bbf5aad17059"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="ad48abf0465bccb7088e0bbf5aad17059" name="ad48abf0465bccb7088e0bbf5aad17059"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad48abf0465bccb7088e0bbf5aad17059">◆ </a></span>tid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t mmwlan_tx_metadata::tid</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Traffic ID (TID) to use. </p>
|
|
<p >Must be less than or equal to <a class="el" href="group__MMWLAN__DATA.html#gad9f43607aa66574ab80c278096a41576">MMWLAN_MAX_QOS_TID</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MMWLAN__DATA.html#ga883e1f4d9dcbbd02586187f52bbd3af6" title="Default QoS Traffic ID (TID) to use for transmit (mmwlan_tx()).">MMWLAN_TX_DEFAULT_QOS_TID</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l02411">2411</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__tx__metadata.html">mmwlan_tx_metadata</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|