243 lines
15 KiB
HTML
243 lines
15 KiB
HTML
<!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: inc/fpc_com_link.h 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
|
|
 <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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="annotated.html"><span>Data 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 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__link_8h.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_link.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Communication link interface.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <stdbool.h></code><br />
|
|
<code>#include <stdint.h></code><br />
|
|
<code>#include "<a class="el" href="fpc__com__result_8h_source.html">fpc_com_result.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for fpc_com_link.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="fpc__com__link_8h__incl.svg" width="551" height="262"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
</div>
|
|
</div><div class="textblock"><div class="dynheader">
|
|
This graph shows which files directly or indirectly include this file:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="fpc__com__link_8h__dep__incl.svg" width="331" height="112"><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__link_8h_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:a43a8a308255ea41e7b7cdefd63a90d14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__link_8h.html#a43a8a308255ea41e7b7cdefd63a90d14">fpc_com_link_transmit</a> (<a class="el" href="fpc__com__packets_8h.html#af6fc3a46c87f1ad2a452eb822f2a0942">fpc_com_packet_link_t</a> *packet, <a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *chain)</td></tr>
|
|
<tr class="memdesc:a43a8a308255ea41e7b7cdefd63a90d14"><td class="mdescLeft"> </td><td class="mdescRight">Sends a packet over the physical link in blocking mode. <a href="#a43a8a308255ea41e7b7cdefd63a90d14">More...</a><br /></td></tr>
|
|
<tr class="separator:a43a8a308255ea41e7b7cdefd63a90d14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae64b80cd91fbfe44abc06dc52eacf739"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__link_8h.html#ae64b80cd91fbfe44abc06dc52eacf739">fpc_com_link_receive</a> (<a class="el" href="fpc__com__packets_8h.html#af6fc3a46c87f1ad2a452eb822f2a0942">fpc_com_packet_link_t</a> *packet, <a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *chain)</td></tr>
|
|
<tr class="memdesc:ae64b80cd91fbfe44abc06dc52eacf739"><td class="mdescLeft"> </td><td class="mdescRight">Receives a packet from the physical link. <a href="#ae64b80cd91fbfe44abc06dc52eacf739">More...</a><br /></td></tr>
|
|
<tr class="separator:ae64b80cd91fbfe44abc06dc52eacf739"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e60e21a5ac4ad4881e4929de2f3c2f4"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__link_8h.html#a3e60e21a5ac4ad4881e4929de2f3c2f4">fpc_com_link_get_overhead</a> (uint16_t *offset)</td></tr>
|
|
<tr class="memdesc:a3e60e21a5ac4ad4881e4929de2f3c2f4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the overhead of the layer. <a href="#a3e60e21a5ac4ad4881e4929de2f3c2f4">More...</a><br /></td></tr>
|
|
<tr class="separator:a3e60e21a5ac4ad4881e4929de2f3c2f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Communication link interface. </p>
|
|
|
|
<p>Definition in file <a class="el" href="fpc__com__link_8h_source.html">fpc_com_link.h</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="a3e60e21a5ac4ad4881e4929de2f3c2f4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t fpc_com_link_get_overhead </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t * </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__link_8c_source.html#l00126">126</a> of file <a class="el" href="fpc__com__link_8c_source.html">fpc_com_link.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__packets_8h_source.html#l00069">fpc_com_packet_link::crc</a>, and <a class="el" href="fpc__com__packets_8h_source.html#l00065">fpc_com_packet_link::size</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae64b80cd91fbfe44abc06dc52eacf739"></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_link_receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="fpc__com__packets_8h.html#af6fc3a46c87f1ad2a452eb822f2a0942">fpc_com_packet_link_t</a> * </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> * </td>
|
|
<td class="paramname"><em>chain</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receives a packet from the physical link. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">packet</td><td>Packet to populate. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">chain</td><td>The communication 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__link_8c_source.html#l00073">73</a> of file <a class="el" href="fpc__com__link_8c_source.html">fpc_com_link.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__packets_8h_source.html#l00069">fpc_com_packet_link::crc</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00066">fpc_com_chain::crc_calc</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00067">fpc_com_packet_link::data</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00032">FPC_COM_ACK</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00151">FPC_COM_CHAIN_RX</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#l00037">FPC_COM_RESULT_IO_ERROR</a>, <a class="el" href="fpc__com__result_8h_source.html#l00033">FPC_COM_RESULT_OK</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__chain_8h_source.html#l00119">fpc_com_chain::phy_mtu_size</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00116">fpc_com_chain::phy_rx</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00125">fpc_com_chain::phy_timeout_rx</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00123">fpc_com_chain::phy_timeout_tx</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00113">fpc_com_chain::phy_tx</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00137">fpc_com_chain::session</a>, and <a class="el" href="fpc__com__packets_8h_source.html#l00065">fpc_com_packet_link::size</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a43a8a308255ea41e7b7cdefd63a90d14"></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_link_transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="fpc__com__packets_8h.html#af6fc3a46c87f1ad2a452eb822f2a0942">fpc_com_packet_link_t</a> * </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> * </td>
|
|
<td class="paramname"><em>chain</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sends a packet over the physical link in blocking mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>Packet to transmit. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">chain</td><td>The communication 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__link_8c_source.html#l00027">27</a> of file <a class="el" href="fpc__com__link_8c_source.html">fpc_com_link.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__packets_8h_source.html#l00069">fpc_com_packet_link::crc</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00066">fpc_com_chain::crc_calc</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00067">fpc_com_packet_link::data</a>, <a class="el" href="fpc__com__packets_8h_source.html#l00032">FPC_COM_ACK</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#l00126">fpc_com_link_get_overhead()</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#l00037">FPC_COM_RESULT_IO_ERROR</a>, <a class="el" href="fpc__com__result_8h_source.html#l00033">FPC_COM_RESULT_OK</a>, <a class="el" href="fpc__com__result_8h_source.html#l00038">FPC_COM_RESULT_TIMEOUT</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__chain_8h_source.html#l00116">fpc_com_chain::phy_rx</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00125">fpc_com_chain::phy_timeout_rx</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00123">fpc_com_chain::phy_timeout_tx</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00113">fpc_com_chain::phy_tx</a>, <a class="el" href="fpc__com__chain_8h_source.html#l00137">fpc_com_chain::session</a>, and <a class="el" href="fpc__com__packets_8h_source.html#l00065">fpc_com_packet_link::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__link_8h_a43a8a308255ea41e7b7cdefd63a90d14_cgraph.svg" width="396" 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_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="fpc__com__link_8h.html">fpc_com_link.h</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>
|