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.
236 lines
14 KiB
HTML
236 lines
14 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: slip_rx_state 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('structslip__rx__state.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">slip_rx_state Struct Reference<div class="ingroups"><a class="el" href="group__MMUTILS.html">Morse Micro Utilities</a> » <a class="el" href="group__SLIP.html">Serial Line Internet Protocol (SLIP) implementation.</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 >Structure used to contain the current state for the SLIP receiver. </p>
|
|
<p >For forward compatibility, instances of this structure should be initialized using <a class="el" href="group__SLIP.html#ga58b6b036a6d81cf1f7ad252406b9bb93">SLIP_RX_STATE_INIT</a>. For dynamic initialization use <a class="el" href="group__SLIP.html#ga3f425609c4de6eedd74a314b718028f6">slip_rx_state_reinit()</a>.</p>
|
|
<p >For example:</p>
|
|
<div class="fragment"><div class="line"><span class="comment">// Buffer for SLIP processing on receive path.</span></div>
|
|
<div class="line">uint8_t <a class="code hl_variable" href="rf-test_8c.html#ab5eda394424d5302fdc376b519cb9629">slip_rx_buffer</a>[<a class="code hl_define" href="group__SLIP.html#ga9e17e8236b045af9f97c7f5121a31117">SLIP_RX_BUFFER_SIZE</a>];</div>
|
|
<div class="line"><span class="comment">// State data for SLIP processing on receive path.</span></div>
|
|
<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structslip__rx__state.html">slip_rx_state</a> <a class="code hl_function" href="group__SLIP.html#ga0b6ccde54d6cabd5d25d9319114bac08">slip_rx</a> = <a class="code hl_define" href="group__SLIP.html#ga58b6b036a6d81cf1f7ad252406b9bb93">SLIP_RX_STATE_INIT</a>(<a class="code hl_variable" href="rf-test_8c.html#ab5eda394424d5302fdc376b519cb9629">slip_rx_buffer</a>, <span class="keyword">sizeof</span>(<a class="code hl_variable" href="rf-test_8c.html#ab5eda394424d5302fdc376b519cb9629">slip_rx_buffer</a>));</div>
|
|
<div class="ttc" id="agroup__SLIP_html_ga0b6ccde54d6cabd5d25d9319114bac08"><div class="ttname"><a href="group__SLIP.html#ga0b6ccde54d6cabd5d25d9319114bac08">slip_rx</a></div><div class="ttdeci">enum slip_rx_status slip_rx(struct slip_rx_state *state, uint8_t c)</div><div class="ttdoc">Handle reception of a character in a SLIP stream.</div></div>
|
|
<div class="ttc" id="agroup__SLIP_html_ga58b6b036a6d81cf1f7ad252406b9bb93"><div class="ttname"><a href="group__SLIP.html#ga58b6b036a6d81cf1f7ad252406b9bb93">SLIP_RX_STATE_INIT</a></div><div class="ttdeci">#define SLIP_RX_STATE_INIT(_buffer, _buffer_length)</div><div class="ttdoc">Static initializer for slip_rx_state.</div><div class="ttdef"><b>Definition:</b> <a href="slip_8h_source.html#l00059">slip.h:59</a></div></div>
|
|
<div class="ttc" id="agroup__SLIP_html_ga9e17e8236b045af9f97c7f5121a31117"><div class="ttname"><a href="group__SLIP.html#ga9e17e8236b045af9f97c7f5121a31117">SLIP_RX_BUFFER_SIZE</a></div><div class="ttdeci">#define SLIP_RX_BUFFER_SIZE</div><div class="ttdoc">Recommended RX buffer size.</div><div class="ttdef"><b>Definition:</b> <a href="slip_8h_source.html#l00025">slip.h:25</a></div></div>
|
|
<div class="ttc" id="arf-test_8c_html_ab5eda394424d5302fdc376b519cb9629"><div class="ttname"><a href="rf-test_8c.html#ab5eda394424d5302fdc376b519cb9629">slip_rx_buffer</a></div><div class="ttdeci">static uint8_t slip_rx_buffer[SLIP_RX_BUFFER_SIZE]</div><div class="ttdoc">Buffer for SLIP processing on receive path.</div><div class="ttdef"><b>Definition:</b> <a href="rf-test_8c_source.html#l00206">rf-test.c:206</a></div></div>
|
|
<div class="ttc" id="astructslip__rx__state_html"><div class="ttname"><a href="structslip__rx__state.html">slip_rx_state</a></div><div class="ttdoc">Structure used to contain the current state for the SLIP receiver.</div><div class="ttdef"><b>Definition:</b> <a href="slip_8h_source.html#l00042">slip.h:43</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00042">42</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="slip_8h_source.html">slip.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:a71e234f23a3e1138d3607de8cb809b14"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structslip__rx__state.html#a71e234f23a3e1138d3607de8cb809b14">buffer</a></td></tr>
|
|
<tr class="memdesc:a71e234f23a3e1138d3607de8cb809b14"><td class="mdescLeft"> </td><td class="mdescRight">Reference to buffer where processed bytes are received. <a href="structslip__rx__state.html#a71e234f23a3e1138d3607de8cb809b14">More...</a><br /></td></tr>
|
|
<tr class="separator:a71e234f23a3e1138d3607de8cb809b14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad17a0dd870f9a7150c047628413b6e27"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structslip__rx__state.html#ad17a0dd870f9a7150c047628413b6e27">buffer_length</a></td></tr>
|
|
<tr class="memdesc:ad17a0dd870f9a7150c047628413b6e27"><td class="mdescLeft"> </td><td class="mdescRight">Length of the buffer. <a href="structslip__rx__state.html#ad17a0dd870f9a7150c047628413b6e27">More...</a><br /></td></tr>
|
|
<tr class="separator:ad17a0dd870f9a7150c047628413b6e27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfc7fe628e6f74370414e179b39b7b19"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structslip__rx__state.html#acfc7fe628e6f74370414e179b39b7b19">length</a></td></tr>
|
|
<tr class="memdesc:acfc7fe628e6f74370414e179b39b7b19"><td class="mdescLeft"> </td><td class="mdescRight">Length of the currently received frame, excluding escape bytes. <a href="structslip__rx__state.html#acfc7fe628e6f74370414e179b39b7b19">More...</a><br /></td></tr>
|
|
<tr class="separator:acfc7fe628e6f74370414e179b39b7b19"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bc697eea8043b5b6d2d43f08a4c11a2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structslip__rx__state.html#a6bc697eea8043b5b6d2d43f08a4c11a2">escape</a></td></tr>
|
|
<tr class="memdesc:a6bc697eea8043b5b6d2d43f08a4c11a2"><td class="mdescLeft"> </td><td class="mdescRight">Escape state. <a href="structslip__rx__state.html#a6bc697eea8043b5b6d2d43f08a4c11a2">More...</a><br /></td></tr>
|
|
<tr class="separator:a6bc697eea8043b5b6d2d43f08a4c11a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7437f725987b31f9851a401a71750e22"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structslip__rx__state.html#a7437f725987b31f9851a401a71750e22">frame_started</a></td></tr>
|
|
<tr class="memdesc:a7437f725987b31f9851a401a71750e22"><td class="mdescLeft"> </td><td class="mdescRight">Escape state. <a href="structslip__rx__state.html#a7437f725987b31f9851a401a71750e22">More...</a><br /></td></tr>
|
|
<tr class="separator:a7437f725987b31f9851a401a71750e22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a71e234f23a3e1138d3607de8cb809b14" name="a71e234f23a3e1138d3607de8cb809b14"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71e234f23a3e1138d3607de8cb809b14">◆ </a></span>buffer</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* slip_rx_state::buffer</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reference to buffer where processed bytes are received. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00044">44</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad17a0dd870f9a7150c047628413b6e27" name="ad17a0dd870f9a7150c047628413b6e27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad17a0dd870f9a7150c047628413b6e27">◆ </a></span>buffer_length</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t slip_rx_state::buffer_length</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Length of the buffer. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00045">45</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6bc697eea8043b5b6d2d43f08a4c11a2" name="a6bc697eea8043b5b6d2d43f08a4c11a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6bc697eea8043b5b6d2d43f08a4c11a2">◆ </a></span>escape</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool slip_rx_state::escape</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Escape state. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00047">47</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7437f725987b31f9851a401a71750e22" name="a7437f725987b31f9851a401a71750e22"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7437f725987b31f9851a401a71750e22">◆ </a></span>frame_started</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool slip_rx_state::frame_started</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Escape state. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00048">48</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acfc7fe628e6f74370414e179b39b7b19" name="acfc7fe628e6f74370414e179b39b7b19"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acfc7fe628e6f74370414e179b39b7b19">◆ </a></span>length</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t slip_rx_state::length</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Length of the currently received frame, excluding escape bytes. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00046">46</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="slip_8h_source.html">slip.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="structslip__rx__state.html">slip_rx_state</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|