andpp/BMLite_RPi
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ee1de8e94d
BMLite_RPi/hcp/doxygen/html/fpc__com__transport_8c.html
Andrey Perminov ee1de8e94d Initial commit 
Change-Id: If8b9b540c22ba2c72ec05e9f0fac8dc4499ded0b
2020-04-16 15:17:23 -07:00

245 lines
14 KiB
HTML
Raw Blame History

<!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"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Host Communication Protocol: src/fpc_com_transport.c File 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>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Host Communication Protocol
&#160;<span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</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">
$(document).ready(function(){initNavTree('fpc__com__transport_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">fpc_com_transport.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Communication transport layer implementation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;<a class="el" href="fpc__com__link_8h_source.html">fpc_com_link.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="fpc__com__transport_8h_source.html">fpc_com_transport.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for fpc_com_transport.c:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="fpc__com__transport_8c__incl.svg" width="603" height="336"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
<p><a href="fpc__com__transport_8c_source.html">Go to the source code of this file.</a></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:af7766ded38ea5a21005d9c99dbd24a72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__transport_8c.html#af7766ded38ea5a21005d9c99dbd24a72">fpc_com_transport_transmit</a> (<a class="el" href="fpc__com__packets_8h.html#a056a2f08f90fe7e467988b2ddbc41f3c">fpc_com_packet_tsp_t</a> *packet, <a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *chain)</td></tr>
<tr class="memdesc:af7766ded38ea5a21005d9c99dbd24a72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit a transport layer packet. <a href="#af7766ded38ea5a21005d9c99dbd24a72">More...</a><br /></td></tr>
<tr class="separator:af7766ded38ea5a21005d9c99dbd24a72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc641d17a6f587ceb132b5500390f99a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__transport_8c.html#acc641d17a6f587ceb132b5500390f99a">fpc_com_transport_receive</a> (<a class="el" href="fpc__com__packets_8h.html#a056a2f08f90fe7e467988b2ddbc41f3c">fpc_com_packet_tsp_t</a> *packet, <a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *chain)</td></tr>
<tr class="memdesc:acc641d17a6f587ceb132b5500390f99a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive a transport layer packet. <a href="#acc641d17a6f587ceb132b5500390f99a">More...</a><br /></td></tr>
<tr class="separator:acc641d17a6f587ceb132b5500390f99a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5c3ffee064012e456917a1b37d30938"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__transport_8c.html#ab5c3ffee064012e456917a1b37d30938">fpc_com_transport_get_overhead</a> (uint16_t *offset)</td></tr>
<tr class="memdesc:ab5c3ffee064012e456917a1b37d30938"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the overhead of the layer. <a href="#ab5c3ffee064012e456917a1b37d30938">More...</a><br /></td></tr>
<tr class="separator:ab5c3ffee064012e456917a1b37d30938"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Communication transport layer implementation. </p>
<p>Definition in file <a class="el" href="fpc__com__transport_8c_source.html">fpc_com_transport.c</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ab5c3ffee064012e456917a1b37d30938"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t fpc_com_transport_get_overhead </td>
<td>(</td>
<td class="paramtype">uint16_t *&#160;</td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the overhead of the layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">offset</td><td>The offset to the packet data. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Overhead size in bytes. </dd></dl>
<p>Definition at line <a class="el" href="fpc__com__transport_8c_source.html#l00088">88</a> of file <a class="el" href="fpc__com__transport_8c_source.html">fpc_com_transport.c</a>.</p>
<p>References <a class="el" href="fpc__com__packets_8h_source.html#l00041">fpc_com_packet_transport::seq_len</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00043">fpc_com_packet_transport::seq_nr</a>, and <a class="el" href="fpc__com__packets_8h_source.html#l00039">fpc_com_packet_transport::size</a>.</p>
</div>
</div>
<a class="anchor" id="acc641d17a6f587ceb132b5500390f99a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a> fpc_com_transport_receive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="fpc__com__packets_8h.html#a056a2f08f90fe7e467988b2ddbc41f3c">fpc_com_packet_tsp_t</a> *&#160;</td>
<td class="paramname"><em>packet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *&#160;</td>
<td class="paramname"><em>chain</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive a transport layer packet. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">packet</td><td>The packet to populate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">chain</td><td>The chain to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a> </dd></dl>
<p>Definition at line <a class="el" href="fpc__com__transport_8c_source.html#l00060">60</a> of file <a class="el" href="fpc__com__transport_8c_source.html">fpc_com_transport.c</a>.</p>
<p>References <a class="el" href="fpc__com__packets_8h_source.html#l00045">fpc_com_packet_transport::data</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00067">fpc_com_packet_link::data</a>, <a class="el" href="fpc__com__link_8c_source.html#l00073">fpc_com_link_receive()</a>, <a class="el" href="fpc__com__result_8h_source.html#l00035">FPC_COM_RESULT_INVALID_ARGUMENT</a>, <a class="el" href="fpc__com__result_8h_source.html#l00033">FPC_COM_RESULT_OK</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00041">fpc_com_packet_transport::seq_len</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00043">fpc_com_packet_transport::seq_nr</a>, and <a class="el" href="fpc__com__packets_8h_source.html#l00039">fpc_com_packet_transport::size</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="fpc__com__transport_8c_acc641d17a6f587ceb132b5500390f99a_cgraph.svg" width="386" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="af7766ded38ea5a21005d9c99dbd24a72"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a> fpc_com_transport_transmit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="fpc__com__packets_8h.html#a056a2f08f90fe7e467988b2ddbc41f3c">fpc_com_packet_tsp_t</a> *&#160;</td>
<td class="paramname"><em>packet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *&#160;</td>
<td class="paramname"><em>chain</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmit a transport layer packet. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to transmit. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">chain</td><td>The chain to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a> </dd></dl>
<p>Definition at line <a class="el" href="fpc__com__transport_8c_source.html#l00028">28</a> of file <a class="el" href="fpc__com__transport_8c_source.html">fpc_com_transport.c</a>.</p>
<p>References <a class="el" href="fpc__com__packets_8h_source.html#l00063">fpc_com_packet_link::channel</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00105">fpc_com_chain::channel</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00067">fpc_com_packet_link::data</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00150">FPC_COM_CHAIN_TX</a>, <a class="el" href="fpc__com__link_8c_source.html#l00027">fpc_com_link_transmit()</a>, <a class="el" href="fpc__com__result_8h_source.html#l00035">FPC_COM_RESULT_INVALID_ARGUMENT</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00103">fpc_com_chain::link_overhead_get</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00121">fpc_com_chain::phy_mtu_buffer</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00041">fpc_com_packet_transport::seq_len</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00043">fpc_com_packet_transport::seq_nr</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00039">fpc_com_packet_transport::size</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00065">fpc_com_packet_link::size</a>, and <a class="el" href="fpc__com__chain_8h_source.html#l00095">fpc_com_chain::tsp_overhead_get</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="fpc__com__transport_8c_af7766ded38ea5a21005d9c99dbd24a72_cgraph.svg" width="628" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</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="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="fpc__com__transport_8c.html">fpc_com_transport.c</a></li>
<li class="footer">Generated on Tue Mar 24 2020 11:09:44 for Host Communication Protocol by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink