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.
417 lines
23 KiB
HTML
417 lines
23 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: Serial Line Internet Protocol (SLIP) implementation.</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('group__SLIP.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="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Serial Line Internet Protocol (SLIP) implementation.<div class="ingroups"><a class="el" href="group__MMUTILS.html">Morse Micro Utilities</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p >SLIP was originally designed as an encapsulation for IP over serial ports, but can be used for framing of any packet-based data for transmission over a serial port. </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structslip__rx__state.html">slip_rx_state</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure used to contain the current state for the SLIP receiver. <a href="structslip__rx__state.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga9e17e8236b045af9f97c7f5121a31117"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SLIP.html#ga9e17e8236b045af9f97c7f5121a31117">SLIP_RX_BUFFER_SIZE</a>   (2000)</td></tr>
|
|
<tr class="memdesc:ga9e17e8236b045af9f97c7f5121a31117"><td class="mdescLeft"> </td><td class="mdescRight">Recommended RX buffer size. <a href="group__SLIP.html#ga9e17e8236b045af9f97c7f5121a31117">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9e17e8236b045af9f97c7f5121a31117"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga58b6b036a6d81cf1f7ad252406b9bb93"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SLIP.html#ga58b6b036a6d81cf1f7ad252406b9bb93">SLIP_RX_STATE_INIT</a>(_buffer, _buffer_length)   { _buffer, _buffer_length, 0, false, false }</td></tr>
|
|
<tr class="memdesc:ga58b6b036a6d81cf1f7ad252406b9bb93"><td class="mdescLeft"> </td><td class="mdescRight">Static initializer for <a class="el" href="structslip__rx__state.html">slip_rx_state</a>. <a href="group__SLIP.html#ga58b6b036a6d81cf1f7ad252406b9bb93">More...</a><br /></td></tr>
|
|
<tr class="separator:ga58b6b036a6d81cf1f7ad252406b9bb93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gacccb685b1cd94bb7b3d14f832d65469f"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SLIP.html#gacccb685b1cd94bb7b3d14f832d65469f">slip_transport_tx_fn</a>) (uint8_t c, void *arg)</td></tr>
|
|
<tr class="memdesc:gacccb685b1cd94bb7b3d14f832d65469f"><td class="mdescLeft"> </td><td class="mdescRight">Function to send a character on the SLIP transport. <a href="group__SLIP.html#gacccb685b1cd94bb7b3d14f832d65469f">More...</a><br /></td></tr>
|
|
<tr class="separator:gacccb685b1cd94bb7b3d14f832d65469f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga8b3d9f67bf20876006c9bd36b72e2009"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SLIP.html#ga8b3d9f67bf20876006c9bd36b72e2009">slip_rx_status</a> { <a class="el" href="group__SLIP.html#gga8b3d9f67bf20876006c9bd36b72e2009ab03bd156d377590fa9870a46a6311ea6">SLIP_RX_COMPLETE</a>
|
|
, <a class="el" href="group__SLIP.html#gga8b3d9f67bf20876006c9bd36b72e2009ae2e805579251042a03b0a7b1f96d327a">SLIP_RX_IN_PROGRESS</a>
|
|
, <a class="el" href="group__SLIP.html#gga8b3d9f67bf20876006c9bd36b72e2009adaf041c337283099a9075408b39d561b">SLIP_RX_BUFFER_LIMIT</a>
|
|
, <a class="el" href="group__SLIP.html#gga8b3d9f67bf20876006c9bd36b72e2009a1b09dc405ed77b7b5d4253e9942612f0">SLIP_RX_ERROR</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga8b3d9f67bf20876006c9bd36b72e2009"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of SLIP status codes. <a href="group__SLIP.html#ga8b3d9f67bf20876006c9bd36b72e2009">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8b3d9f67bf20876006c9bd36b72e2009"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga3f425609c4de6eedd74a314b718028f6"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SLIP.html#ga3f425609c4de6eedd74a314b718028f6">slip_rx_state_reinit</a> (struct <a class="el" href="structslip__rx__state.html">slip_rx_state</a> *state, uint8_t *buffer, size_t buffer_length)</td></tr>
|
|
<tr class="memdesc:ga3f425609c4de6eedd74a314b718028f6"><td class="mdescLeft"> </td><td class="mdescRight">Dynamic (re)initializer for <a class="el" href="structslip__rx__state.html">slip_rx_state</a>. <a href="group__SLIP.html#ga3f425609c4de6eedd74a314b718028f6">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3f425609c4de6eedd74a314b718028f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0b6ccde54d6cabd5d25d9319114bac08"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__SLIP.html#ga8b3d9f67bf20876006c9bd36b72e2009">slip_rx_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SLIP.html#ga0b6ccde54d6cabd5d25d9319114bac08">slip_rx</a> (struct <a class="el" href="structslip__rx__state.html">slip_rx_state</a> *state, uint8_t c)</td></tr>
|
|
<tr class="memdesc:ga0b6ccde54d6cabd5d25d9319114bac08"><td class="mdescLeft"> </td><td class="mdescRight">Handle reception of a character in a SLIP stream. <a href="group__SLIP.html#ga0b6ccde54d6cabd5d25d9319114bac08">More...</a><br /></td></tr>
|
|
<tr class="separator:ga0b6ccde54d6cabd5d25d9319114bac08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6745989126f61ab425a9c4a081faf393"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SLIP.html#ga6745989126f61ab425a9c4a081faf393">slip_tx</a> (<a class="el" href="group__SLIP.html#gacccb685b1cd94bb7b3d14f832d65469f">slip_transport_tx_fn</a> transport_tx_fn, void *transport_tx_arg, const uint8_t *packet, size_t packet_len)</td></tr>
|
|
<tr class="memdesc:ga6745989126f61ab425a9c4a081faf393"><td class="mdescLeft"> </td><td class="mdescRight">Transmit a packet with SLIP framing. <a href="group__SLIP.html#ga6745989126f61ab425a9c4a081faf393">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6745989126f61ab425a9c4a081faf393"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ga9e17e8236b045af9f97c7f5121a31117" name="ga9e17e8236b045af9f97c7f5121a31117"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9e17e8236b045af9f97c7f5121a31117">◆ </a></span>SLIP_RX_BUFFER_SIZE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SLIP_RX_BUFFER_SIZE   (2000)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Recommended RX buffer size. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00025">25</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga58b6b036a6d81cf1f7ad252406b9bb93" name="ga58b6b036a6d81cf1f7ad252406b9bb93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga58b6b036a6d81cf1f7ad252406b9bb93">◆ </a></span>SLIP_RX_STATE_INIT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SLIP_RX_STATE_INIT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">_buffer, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">_buffer_length </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   { _buffer, _buffer_length, 0, false, false }</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Static initializer for <a class="el" href="structslip__rx__state.html">slip_rx_state</a>. </p>
|
|
<p >See <a class="el" href="structslip__rx__state.html">slip_rx_state</a> for an example of usage.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">_buffer</td><td>Pointer to a buffer to be used by SLIP (should be a <code>uint8_t</code> array). </td></tr>
|
|
<tr><td class="paramname">_buffer_length</td><td>The size of <code>_buffer</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00059">59</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="gacccb685b1cd94bb7b3d14f832d65469f" name="gacccb685b1cd94bb7b3d14f832d65469f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacccb685b1cd94bb7b3d14f832d65469f">◆ </a></span>slip_transport_tx_fn</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef int(* slip_transport_tx_fn) (uint8_t c, void *arg)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to send a character on the SLIP transport. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">c</td><td>The character to transmit </td></tr>
|
|
<tr><td class="paramname">arg</td><td>Opaque argument, as passed to <code><a class="el" href="group__SLIP.html#ga6745989126f61ab425a9c4a081faf393" title="Transmit a packet with SLIP framing.">slip_tx()</a></code>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a negative error code. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00110">110</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ga8b3d9f67bf20876006c9bd36b72e2009" name="ga8b3d9f67bf20876006c9bd36b72e2009"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8b3d9f67bf20876006c9bd36b72e2009">◆ </a></span>slip_rx_status</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__SLIP.html#ga8b3d9f67bf20876006c9bd36b72e2009">slip_rx_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration of SLIP status codes. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga8b3d9f67bf20876006c9bd36b72e2009ab03bd156d377590fa9870a46a6311ea6" name="gga8b3d9f67bf20876006c9bd36b72e2009ab03bd156d377590fa9870a46a6311ea6"></a>SLIP_RX_COMPLETE </td><td class="fielddoc"><p >A complete packet with length > 0 has been received. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga8b3d9f67bf20876006c9bd36b72e2009ae2e805579251042a03b0a7b1f96d327a" name="gga8b3d9f67bf20876006c9bd36b72e2009ae2e805579251042a03b0a7b1f96d327a"></a>SLIP_RX_IN_PROGRESS </td><td class="fielddoc"><p >Receive is still in progress. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga8b3d9f67bf20876006c9bd36b72e2009adaf041c337283099a9075408b39d561b" name="gga8b3d9f67bf20876006c9bd36b72e2009adaf041c337283099a9075408b39d561b"></a>SLIP_RX_BUFFER_LIMIT </td><td class="fielddoc"><p >Receive buffer limit has been reached. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga8b3d9f67bf20876006c9bd36b72e2009a1b09dc405ed77b7b5d4253e9942612f0" name="gga8b3d9f67bf20876006c9bd36b72e2009a1b09dc405ed77b7b5d4253e9942612f0"></a>SLIP_RX_ERROR </td><td class="fielddoc"><p >An erroneous packet has been received. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00081">81</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga0b6ccde54d6cabd5d25d9319114bac08" name="ga0b6ccde54d6cabd5d25d9319114bac08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0b6ccde54d6cabd5d25d9319114bac08">◆ </a></span>slip_rx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__SLIP.html#ga8b3d9f67bf20876006c9bd36b72e2009">slip_rx_status</a> slip_rx </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct <a class="el" href="structslip__rx__state.html">slip_rx_state</a> * </td>
|
|
<td class="paramname"><em>state</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>c</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Handle reception of a character in a SLIP stream. </p>
|
|
<p >When reception of a packet is successful, this will return <code>SLIP_RX_COMPLETE</code> and the packet can be found in <code>state->buffer</code> with length <code>state->length</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>Current slip state. Will be updated by this function. </td></tr>
|
|
<tr><td class="paramname">c</td><td>The received character.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>an appropriate value of <a class="el" href="group__SLIP.html#ga8b3d9f67bf20876006c9bd36b72e2009">slip_rx_status</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3f425609c4de6eedd74a314b718028f6" name="ga3f425609c4de6eedd74a314b718028f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3f425609c4de6eedd74a314b718028f6">◆ </a></span>slip_rx_state_reinit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void slip_rx_state_reinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct <a class="el" href="structslip__rx__state.html">slip_rx_state</a> * </td>
|
|
<td class="paramname"><em>state</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>buffer_length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Dynamic (re)initializer for <a class="el" href="structslip__rx__state.html">slip_rx_state</a>. </p>
|
|
<p >This can be used as an alternative to <a class="el" href="group__SLIP.html#ga58b6b036a6d81cf1f7ad252406b9bb93">SLIP_RX_STATE_INIT</a> when static initialization is not possible.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>The slip state structure to init. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>Pointer to the buffer to be used by SLIP. </td></tr>
|
|
<tr><td class="paramname">buffer_length</td><td>Length of <code>buffer</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="slip_8h_source.html#l00070">70</a> of file <a class="el" href="slip_8h_source.html">slip.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6745989126f61ab425a9c4a081faf393" name="ga6745989126f61ab425a9c4a081faf393"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6745989126f61ab425a9c4a081faf393">◆ </a></span>slip_tx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int slip_tx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__SLIP.html#gacccb685b1cd94bb7b3d14f832d65469f">slip_transport_tx_fn</a> </td>
|
|
<td class="paramname"><em>transport_tx_fn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>transport_tx_arg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>packet</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>packet_len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Transmit a packet with SLIP framing. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">transport_tx_fn</td><td>Function to invoke to send characters on the transport. </td></tr>
|
|
<tr><td class="paramname">transport_tx_arg</td><td>Argument to pass to <code>transport_tx_fn</code>. </td></tr>
|
|
<tr><td class="paramname">packet</td><td>The packet to transmit. </td></tr>
|
|
<tr><td class="paramname">packet_len</td><td>The length of the packet.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise an error code as returned by <code>transport_tx_fn</code>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|