232 lines
12 KiB
HTML
232 lines
12 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_packets.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__packets_8h.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<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> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fpc_com_packets.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Communication packet type definitions.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <stdint.h></code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for fpc_com_packets.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="fpc__com__packets_8h__incl.svg" width="168" 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><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__packets_8h__dep__incl.svg" width="456" 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>
|
|
<p><a href="fpc__com__packets_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="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="structfpc__com__packet__transport.html">fpc_com_packet_transport</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__com__packet__link.html">fpc_com_packet_link</a></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 name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a4f4c239eb61e8e793498793c1be608f7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__packets_8h.html#a4f4c239eb61e8e793498793c1be608f7">FPC_COM_ACK</a>   0x7f01ff7f</td></tr>
|
|
<tr class="separator:a4f4c239eb61e8e793498793c1be608f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:a056a2f08f90fe7e467988b2ddbc41f3c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structfpc__com__packet__transport.html">fpc_com_packet_transport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__packets_8h.html#a056a2f08f90fe7e467988b2ddbc41f3c">fpc_com_packet_tsp_t</a></td></tr>
|
|
<tr class="separator:a056a2f08f90fe7e467988b2ddbc41f3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a243c6cf0a9ab056a1fce6430bb88c2d8"><td class="memItemLeft" align="right" valign="top">typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__packets_8h.html#a243c6cf0a9ab056a1fce6430bb88c2d8">fpc_com_channel_t</a></td></tr>
|
|
<tr class="separator:a243c6cf0a9ab056a1fce6430bb88c2d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6fc3a46c87f1ad2a452eb822f2a0942"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structfpc__com__packet__link.html">fpc_com_packet_link</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__packets_8h.html#af6fc3a46c87f1ad2a452eb822f2a0942">fpc_com_packet_link_t</a></td></tr>
|
|
<tr class="separator:af6fc3a46c87f1ad2a452eb822f2a0942"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ad77ec293a161472c5ca6283ae1c944c8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8">fpc_com_channel</a> { <br />
|
|
  <a class="el" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8a82d8a35822a610caddc5c841e3a74a2a">FPC_COM_CHANNEL_NONE</a> = 0x00,
|
|
<br />
|
|
  <a class="el" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8aff1cc469181cd2df91ed52a2092748ed">FPC_COM_CHANNEL_CLEAR</a> = 0x01,
|
|
<br />
|
|
  <a class="el" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8ae9bbbecb694256ca41a9b57f101fb973">FPC_COM_CHANNEL_TLS</a> = 0x02,
|
|
<br />
|
|
  <a class="el" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8af73ea123cd946a1ef0109660569cd856">FPC_COM_CHANNEL_END</a> = 0xFF
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ad77ec293a161472c5ca6283ae1c944c8"><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 packet type definitions. </p>
|
|
|
|
<p>Definition in file <a class="el" href="fpc__com__packets_8h_source.html">fpc_com_packets.h</a>.</p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="a4f4c239eb61e8e793498793c1be608f7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FPC_COM_ACK   0x7f01ff7f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Communication acknowledge definition </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__packets_8h_source.html#l00032">32</a> of file <a class="el" href="fpc__com__packets_8h_source.html">fpc_com_packets.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="a243c6cf0a9ab056a1fce6430bb88c2d8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef uint16_t <a class="el" href="fpc__com__packets_8h.html#a243c6cf0a9ab056a1fce6430bb88c2d8">fpc_com_channel_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Communication channel type </p>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__packets_8h_source.html#l00058">58</a> of file <a class="el" href="fpc__com__packets_8h_source.html">fpc_com_packets.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af6fc3a46c87f1ad2a452eb822f2a0942"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structfpc__com__packet__link.html">fpc_com_packet_link</a> <a class="el" href="fpc__com__packets_8h.html#af6fc3a46c87f1ad2a452eb822f2a0942">fpc_com_packet_link_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Link layer packet </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a056a2f08f90fe7e467988b2ddbc41f3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structfpc__com__packet__transport.html">fpc_com_packet_transport</a> <a class="el" href="fpc__com__packets_8h.html#a056a2f08f90fe7e467988b2ddbc41f3c">fpc_com_packet_tsp_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Transport layer packet. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ad77ec293a161472c5ca6283ae1c944c8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8">fpc_com_channel</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Transport packet channels. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ad77ec293a161472c5ca6283ae1c944c8a82d8a35822a610caddc5c841e3a74a2a"></a>FPC_COM_CHANNEL_NONE </td><td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ad77ec293a161472c5ca6283ae1c944c8aff1cc469181cd2df91ed52a2092748ed"></a>FPC_COM_CHANNEL_CLEAR </td><td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ad77ec293a161472c5ca6283ae1c944c8ae9bbbecb694256ca41a9b57f101fb973"></a>FPC_COM_CHANNEL_TLS </td><td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ad77ec293a161472c5ca6283ae1c944c8af73ea123cd946a1ef0109660569cd856"></a>FPC_COM_CHANNEL_END </td><td class="fielddoc">
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p>Definition at line <a class="el" href="fpc__com__packets_8h_source.html#l00051">51</a> of file <a class="el" href="fpc__com__packets_8h_source.html">fpc_com_packets.h</a>.</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__packets_8h.html">fpc_com_packets.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>
|