525 lines
32 KiB
HTML
525 lines
32 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: fpc_com_chain 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>
|
|
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
|
|
<li><a href="functions.html"><span>Data Fields</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('structfpc__com__chain.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fpc_com_chain Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for fpc_com_chain:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="structfpc__com__chain__coll__graph.svg" width="167" height="306"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a4a5f51c68263c56df53e3026d0959c4c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a4a5f51c68263c56df53e3026d0959c4c">initialized</a></td></tr>
|
|
<tr class="separator:a4a5f51c68263c56df53e3026d0959c4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac697aca7a789065170e24d18647df0e7"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#ac697aca7a789065170e24d18647df0e7">crc_calc</a> )(uint32_t start, const void *data, uint32_t size)</td></tr>
|
|
<tr class="separator:ac697aca7a789065170e24d18647df0e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30701342d30047f48d0ec4f3f47f6ca3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fpc__com__chain_8h.html#a0983b70df0d560f35537acc24ecc0d0d">fpc_com_chain_private_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a30701342d30047f48d0ec4f3f47f6ca3">private_vars</a></td></tr>
|
|
<tr class="separator:a30701342d30047f48d0ec4f3f47f6ca3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92eac8623fea4a4134d073233d25a63f"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a92eac8623fea4a4134d073233d25a63f">session</a></td></tr>
|
|
<tr class="memdesc:a92eac8623fea4a4134d073233d25a63f"><td class="mdescLeft"> </td><td class="mdescRight">User session pointer. User private stuff, to be able to pass necessary info from the layer that calls hcp down to the user's TX and RX functions (phy_tx/rx), to enable multi threaded applications at the host side. <a href="#a92eac8623fea4a4134d073233d25a63f">More...</a><br /></td></tr>
|
|
<tr class="separator:a92eac8623fea4a4134d073233d25a63f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b907ebf3aeb09944baae1fd72a7abf9"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a6b907ebf3aeb09944baae1fd72a7abf9">context</a></td></tr>
|
|
<tr class="memdesc:a6b907ebf3aeb09944baae1fd72a7abf9"><td class="mdescLeft"> </td><td class="mdescRight">User context pointer. User private stuff, to be able to pass nessecary context to argument_allocator and argument_free. <a href="#a6b907ebf3aeb09944baae1fd72a7abf9">More...</a><br /></td></tr>
|
|
<tr class="separator:a6b907ebf3aeb09944baae1fd72a7abf9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">HCP Layer</div></td></tr>
|
|
<tr class="memitem:a6e99f2fce0216d384bfba272cfba56b9"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a6e99f2fce0216d384bfba272cfba56b9">argument_allocator</a> )(<a class="el" href="fpc__hcp__common_8h.html#ac3276a2f739c2a97e665a95212e75108">fpc_hcp_cmd_t</a> cmd, <a class="el" href="fpc__hcp__common_8h.html#a7470deee2c0eae8f5ac7feb71649df0b">fpc_hcp_arg_t</a> arg, uint16_t size, bool *free_data, void *<a class="el" href="structfpc__com__chain.html#a6b907ebf3aeb09944baae1fd72a7abf9">context</a>)</td></tr>
|
|
<tr class="separator:a6e99f2fce0216d384bfba272cfba56b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af2a276eb2ccc79b6165584d97e798874"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#af2a276eb2ccc79b6165584d97e798874">argument_free</a> )(<a class="el" href="fpc__hcp__common_8h.html#ac3276a2f739c2a97e665a95212e75108">fpc_hcp_cmd_t</a> cmd, <a class="el" href="fpc__hcp__common_8h.html#a4243dac41cd32d44aac72af8e1583b86">fpc_hcp_arg_data_t</a> *arg_data, void *<a class="el" href="structfpc__com__chain.html#a6b907ebf3aeb09944baae1fd72a7abf9">context</a>)</td></tr>
|
|
<tr class="separator:af2a276eb2ccc79b6165584d97e798874"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Application Layer</div></td></tr>
|
|
<tr class="memitem:a3498d443baffb40cb1201380423a753d"><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="structfpc__com__chain.html#a3498d443baffb40cb1201380423a753d">app_tx</a> )(<a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *chain)</td></tr>
|
|
<tr class="separator:a3498d443baffb40cb1201380423a753d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc6a3bbad06589291a9441417cbb48c5"><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="structfpc__com__chain.html#adc6a3bbad06589291a9441417cbb48c5">app_rx</a> )(<a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *chain)</td></tr>
|
|
<tr class="separator:adc6a3bbad06589291a9441417cbb48c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0059f42e6687eb0f82e5ee1de6b7236b"><td class="memItemLeft" align="right" valign="top">uint16_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a0059f42e6687eb0f82e5ee1de6b7236b">app_overhead_get</a> )(uint16_t *offset)</td></tr>
|
|
<tr class="separator:a0059f42e6687eb0f82e5ee1de6b7236b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa60e372908d633b665e2ee4e3f220eac"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#aa60e372908d633b665e2ee4e3f220eac">app_packet_size</a> [2]</td></tr>
|
|
<tr class="separator:aa60e372908d633b665e2ee4e3f220eac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacb377d52218056953552b9528654e75"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#aacb377d52218056953552b9528654e75">app_mtu_size</a> [2]</td></tr>
|
|
<tr class="separator:aacb377d52218056953552b9528654e75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e8d84ccc4f808b0b95a4968f8445793"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a7e8d84ccc4f808b0b95a4968f8445793">app_mtu_buffer</a> [2]</td></tr>
|
|
<tr class="separator:a7e8d84ccc4f808b0b95a4968f8445793"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Transport Layer</div></td></tr>
|
|
<tr class="memitem:aa9ee59b2a8c25a2cec027c078bb5db57"><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="structfpc__com__chain.html#aa9ee59b2a8c25a2cec027c078bb5db57">tsp_tx</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="separator:aa9ee59b2a8c25a2cec027c078bb5db57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72f15dbe8cd7750f8f33346783404fb9"><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="structfpc__com__chain.html#a72f15dbe8cd7750f8f33346783404fb9">tsp_rx</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="separator:a72f15dbe8cd7750f8f33346783404fb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a319d3aa6f72ba5b04f6ac73bd09e860e"><td class="memItemLeft" align="right" valign="top">uint16_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a319d3aa6f72ba5b04f6ac73bd09e860e">tsp_overhead_get</a> )(uint16_t *offset)</td></tr>
|
|
<tr class="separator:a319d3aa6f72ba5b04f6ac73bd09e860e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Link Layer</div></td></tr>
|
|
<tr class="memitem:a055b5749b6e11042f39604bc7c7a33fe"><td class="memItemLeft" align="right" valign="top">uint16_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a055b5749b6e11042f39604bc7c7a33fe">link_overhead_get</a> )(uint16_t *offset)</td></tr>
|
|
<tr class="separator:a055b5749b6e11042f39604bc7c7a33fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa42c6bf7052b0047c8b91635a13674d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fpc__com__packets_8h.html#a243c6cf0a9ab056a1fce6430bb88c2d8">fpc_com_channel_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#aa42c6bf7052b0047c8b91635a13674d8">channel</a></td></tr>
|
|
<tr class="separator:aa42c6bf7052b0047c8b91635a13674d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Physical Layer</div></td></tr>
|
|
<tr class="memitem:a67cdb9c412d3478b46f9091d094c4faf"><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="structfpc__com__chain.html#a67cdb9c412d3478b46f9091d094c4faf">phy_tx</a> )(uint16_t size, const uint8_t *buffer, uint32_t timeout, void *<a class="el" href="structfpc__com__chain.html#a92eac8623fea4a4134d073233d25a63f">session</a>)</td></tr>
|
|
<tr class="separator:a67cdb9c412d3478b46f9091d094c4faf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0e4aa33099bfc0c9910c7b6bb30f915"><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="structfpc__com__chain.html#ae0e4aa33099bfc0c9910c7b6bb30f915">phy_rx</a> )(uint16_t size, uint8_t *buffer, uint32_t timeout, void *<a class="el" href="structfpc__com__chain.html#a92eac8623fea4a4134d073233d25a63f">session</a>)</td></tr>
|
|
<tr class="separator:ae0e4aa33099bfc0c9910c7b6bb30f915"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad135c2c04d54045141c2c3ffff09636d"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#ad135c2c04d54045141c2c3ffff09636d">phy_mtu_size</a> [2]</td></tr>
|
|
<tr class="separator:ad135c2c04d54045141c2c3ffff09636d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63a02907c00e5443c7c3d4c0bd158d36"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a63a02907c00e5443c7c3d4c0bd158d36">phy_mtu_buffer</a> [2]</td></tr>
|
|
<tr class="separator:a63a02907c00e5443c7c3d4c0bd158d36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12a7599fb0f8ca779f6f5ac1df47bed2"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a12a7599fb0f8ca779f6f5ac1df47bed2">phy_timeout_tx</a></td></tr>
|
|
<tr class="separator:a12a7599fb0f8ca779f6f5ac1df47bed2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e3f88e744ac92baecf22b8be8b8bdb2"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__chain.html#a2e3f88e744ac92baecf22b8be8b8bdb2">phy_timeout_rx</a></td></tr>
|
|
<tr class="separator:a2e3f88e744ac92baecf22b8be8b8bdb2"><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 chain struct </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00050">50</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a class="anchor" id="a7e8d84ccc4f808b0b95a4968f8445793"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* fpc_com_chain::app_mtu_buffer[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Application MTU buffers </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00083">83</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aacb377d52218056953552b9528654e75"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t fpc_com_chain::app_mtu_size[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Application MTU sizes </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00081">81</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0059f42e6687eb0f82e5ee1de6b7236b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t(* fpc_com_chain::app_overhead_get) (uint16_t *offset)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Application layer overhead get interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00077">77</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa60e372908d633b665e2ee4e3f220eac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t fpc_com_chain::app_packet_size[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Application packet sizes </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00079">79</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adc6a3bbad06589291a9441417cbb48c5"></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_chain::app_rx) (<a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *chain)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Application layer receive interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00075">75</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3498d443baffb40cb1201380423a753d"></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_chain::app_tx) (<a class="el" href="fpc__com__chain_8h.html#a1530dd4e8729e5f546a96abc5ac0a6de">fpc_com_chain_t</a> *chain)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Application layer transmit interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00073">73</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6e99f2fce0216d384bfba272cfba56b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void*(* fpc_com_chain::argument_allocator) (<a class="el" href="fpc__hcp__common_8h.html#ac3276a2f739c2a97e665a95212e75108">fpc_hcp_cmd_t</a> cmd, <a class="el" href="fpc__hcp__common_8h.html#a7470deee2c0eae8f5ac7feb71649df0b">fpc_hcp_arg_t</a> arg, uint16_t size, bool *free_data, void *<a class="el" href="structfpc__com__chain.html#a6b907ebf3aeb09944baae1fd72a7abf9">context</a>)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Argument allocator interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00059">59</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af2a276eb2ccc79b6165584d97e798874"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void(* fpc_com_chain::argument_free) (<a class="el" href="fpc__hcp__common_8h.html#ac3276a2f739c2a97e665a95212e75108">fpc_hcp_cmd_t</a> cmd, <a class="el" href="fpc__hcp__common_8h.html#a4243dac41cd32d44aac72af8e1583b86">fpc_hcp_arg_data_t</a> *arg_data, void *<a class="el" href="structfpc__com__chain.html#a6b907ebf3aeb09944baae1fd72a7abf9">context</a>)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Argument free interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00062">62</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa42c6bf7052b0047c8b91635a13674d8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="fpc__com__packets_8h.html#a243c6cf0a9ab056a1fce6430bb88c2d8">fpc_com_channel_t</a> fpc_com_chain::channel</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Communication channel </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00105">105</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6b907ebf3aeb09944baae1fd72a7abf9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* fpc_com_chain::context</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>User context pointer. User private stuff, to be able to pass nessecary context to argument_allocator and argument_free. </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00143">143</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac697aca7a789065170e24d18647df0e7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t(* fpc_com_chain::crc_calc) (uint32_t start, const void *data, uint32_t size)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>CRC calculation interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00066">66</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4a5f51c68263c56df53e3026d0959c4c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fpc_com_chain::initialized</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialization status </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00052">52</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a055b5749b6e11042f39604bc7c7a33fe"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t(* fpc_com_chain::link_overhead_get) (uint16_t *offset)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Link layer overhead get interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00103">103</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a63a02907c00e5443c7c3d4c0bd158d36"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* fpc_com_chain::phy_mtu_buffer[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Physical MTU buffers </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00121">121</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad135c2c04d54045141c2c3ffff09636d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t fpc_com_chain::phy_mtu_size[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Physical MTU sizes </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00119">119</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae0e4aa33099bfc0c9910c7b6bb30f915"></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_chain::phy_rx) (uint16_t size, uint8_t *buffer, uint32_t timeout, void *<a class="el" href="structfpc__com__chain.html#a92eac8623fea4a4134d073233d25a63f">session</a>)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Physical layer receive interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00116">116</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2e3f88e744ac92baecf22b8be8b8bdb2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t fpc_com_chain::phy_timeout_rx</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Physical receive timeout </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00125">125</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a12a7599fb0f8ca779f6f5ac1df47bed2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t fpc_com_chain::phy_timeout_tx</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Physical transmit timeout </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00123">123</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a67cdb9c412d3478b46f9091d094c4faf"></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_chain::phy_tx) (uint16_t size, const uint8_t *buffer, uint32_t timeout, void *<a class="el" href="structfpc__com__chain.html#a92eac8623fea4a4134d073233d25a63f">session</a>)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Physical layer transmit interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00113">113</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a30701342d30047f48d0ec4f3f47f6ca3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="fpc__com__chain_8h.html#a0983b70df0d560f35537acc24ecc0d0d">fpc_com_chain_private_t</a> fpc_com_chain::private_vars</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Communication change private variables </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00129">129</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a92eac8623fea4a4134d073233d25a63f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* fpc_com_chain::session</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>User session pointer. User private stuff, to be able to pass necessary info from the layer that calls hcp down to the user's TX and RX functions (phy_tx/rx), to enable multi threaded applications at the host side. </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00137">137</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a319d3aa6f72ba5b04f6ac73bd09e860e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t(* fpc_com_chain::tsp_overhead_get) (uint16_t *offset)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Transport layer overhead get interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00095">95</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a72f15dbe8cd7750f8f33346783404fb9"></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_chain::tsp_rx) (<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>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Transport layer receive interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00093">93</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa9ee59b2a8c25a2cec027c078bb5db57"></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_chain::tsp_tx) (<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>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Transport layer transmit interface function </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__chain_8h_source.html#l00091">91</a> of file <a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>inc/<a class="el" href="fpc__com__chain_8h_source.html">fpc_com_chain.h</a></li>
|
|
</ul>
|
|
</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="structfpc__com__chain.html">fpc_com_chain</a></li>
|
|
<li class="footer">Generated on Tue Mar 24 2020 11:09:45 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>
|