103 lines
20 KiB
HTML
103 lines
20 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 Source File</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_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">fpc_com_packets.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="fpc__com__packets_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2020 Fingerprint Cards AB</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * https://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef FPC_COM_PACKETS_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define FPC_COM_PACKETS_H</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="fpc__com__packets_8h.html#a4f4c239eb61e8e793498793c1be608f7"> 32</a></span> <span class="preprocessor">#define FPC_COM_ACK 0x7f01ff7f</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structfpc__com__packet__transport.html"> 37</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structfpc__com__packet__transport.html">fpc_com_packet_transport</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structfpc__com__packet__transport.html#a9c0d37a137ba70a8d0ecd17802e3810a"> 39</a></span>  uint16_t <a class="code" href="structfpc__com__packet__transport.html#a9c0d37a137ba70a8d0ecd17802e3810a">size</a>;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structfpc__com__packet__transport.html#af72d4eb7fdaf84b87dd369b348eafc6d"> 41</a></span>  uint16_t <a class="code" href="structfpc__com__packet__transport.html#af72d4eb7fdaf84b87dd369b348eafc6d">seq_len</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structfpc__com__packet__transport.html#a41944ffde2478be8fca892e84bd633c0"> 43</a></span>  uint16_t <a class="code" href="structfpc__com__packet__transport.html#a41944ffde2478be8fca892e84bd633c0">seq_nr</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structfpc__com__packet__transport.html#a701682a127995ad73fd3d945faa0e6d0"> 45</a></span>  uint8_t *<a class="code" href="structfpc__com__packet__transport.html#a701682a127995ad73fd3d945faa0e6d0">data</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> } <a class="code" href="fpc__com__packets_8h.html#a056a2f08f90fe7e467988b2ddbc41f3c">fpc_com_packet_tsp_t</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8"> 51</a></span> <span class="keyword">enum</span> <a class="code" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8">fpc_com_channel</a> {</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8a82d8a35822a610caddc5c841e3a74a2a"> 52</a></span>  <a class="code" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8a82d8a35822a610caddc5c841e3a74a2a">FPC_COM_CHANNEL_NONE</a> = 0x00,</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8aff1cc469181cd2df91ed52a2092748ed"> 53</a></span>  <a class="code" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8aff1cc469181cd2df91ed52a2092748ed">FPC_COM_CHANNEL_CLEAR</a> = 0x01,</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8ae9bbbecb694256ca41a9b57f101fb973"> 54</a></span>  <a class="code" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8ae9bbbecb694256ca41a9b57f101fb973">FPC_COM_CHANNEL_TLS</a> = 0x02,</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8af73ea123cd946a1ef0109660569cd856"> 55</a></span>  <a class="code" href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8af73ea123cd946a1ef0109660569cd856">FPC_COM_CHANNEL_END</a> = 0xFF,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="fpc__com__packets_8h.html#a243c6cf0a9ab056a1fce6430bb88c2d8"> 58</a></span> <span class="keyword">typedef</span> uint16_t <a class="code" href="fpc__com__packets_8h.html#a243c6cf0a9ab056a1fce6430bb88c2d8">fpc_com_channel_t</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structfpc__com__packet__link.html"> 61</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structfpc__com__packet__link.html">fpc_com_packet_link</a> {</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structfpc__com__packet__link.html#aa90708dd6d842b318723cb70d6939c2a"> 63</a></span>  fpc_com_channel_t <a class="code" href="structfpc__com__packet__link.html#aa90708dd6d842b318723cb70d6939c2a">channel</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structfpc__com__packet__link.html#a7305e6e32039579c1258ccb42513049b"> 65</a></span>  uint16_t <a class="code" href="structfpc__com__packet__link.html#a7305e6e32039579c1258ccb42513049b">size</a>;</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structfpc__com__packet__link.html#ac5412a399ecd825e331b560c1ec078fd"> 67</a></span>  uint8_t *<a class="code" href="structfpc__com__packet__link.html#ac5412a399ecd825e331b560c1ec078fd">data</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structfpc__com__packet__link.html#a2b36a249ee8d192688f2a5f3cce8cde4"> 69</a></span>  uint32_t <a class="code" href="structfpc__com__packet__link.html#a2b36a249ee8d192688f2a5f3cce8cde4">crc</a>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> } <a class="code" href="fpc__com__packets_8h.html#af6fc3a46c87f1ad2a452eb822f2a0942">fpc_com_packet_link_t</a>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif </span><span class="comment">/* FPC_COM_PACKETS_H */</span><span class="preprocessor"></span></div><div class="ttc" id="fpc__com__packets_8h_html_ad77ec293a161472c5ca6283ae1c944c8aff1cc469181cd2df91ed52a2092748ed"><div class="ttname"><a href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8aff1cc469181cd2df91ed52a2092748ed">FPC_COM_CHANNEL_CLEAR</a></div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00053">fpc_com_packets.h:53</a></div></div>
|
|
<div class="ttc" id="fpc__com__packets_8h_html_af6fc3a46c87f1ad2a452eb822f2a0942"><div class="ttname"><a href="fpc__com__packets_8h.html#af6fc3a46c87f1ad2a452eb822f2a0942">fpc_com_packet_link_t</a></div><div class="ttdeci">struct fpc_com_packet_link fpc_com_packet_link_t</div></div>
|
|
<div class="ttc" id="fpc__com__packets_8h_html_ad77ec293a161472c5ca6283ae1c944c8"><div class="ttname"><a href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8">fpc_com_channel</a></div><div class="ttdeci">fpc_com_channel</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00051">fpc_com_packets.h:51</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__transport_html_a701682a127995ad73fd3d945faa0e6d0"><div class="ttname"><a href="structfpc__com__packet__transport.html#a701682a127995ad73fd3d945faa0e6d0">fpc_com_packet_transport::data</a></div><div class="ttdeci">uint8_t * data</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00045">fpc_com_packets.h:45</a></div></div>
|
|
<div class="ttc" id="fpc__com__packets_8h_html_ad77ec293a161472c5ca6283ae1c944c8a82d8a35822a610caddc5c841e3a74a2a"><div class="ttname"><a href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8a82d8a35822a610caddc5c841e3a74a2a">FPC_COM_CHANNEL_NONE</a></div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00052">fpc_com_packets.h:52</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__link_html_a7305e6e32039579c1258ccb42513049b"><div class="ttname"><a href="structfpc__com__packet__link.html#a7305e6e32039579c1258ccb42513049b">fpc_com_packet_link::size</a></div><div class="ttdeci">uint16_t size</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00065">fpc_com_packets.h:65</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__transport_html"><div class="ttname"><a href="structfpc__com__packet__transport.html">fpc_com_packet_transport</a></div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00037">fpc_com_packets.h:37</a></div></div>
|
|
<div class="ttc" id="fpc__com__packets_8h_html_ad77ec293a161472c5ca6283ae1c944c8ae9bbbecb694256ca41a9b57f101fb973"><div class="ttname"><a href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8ae9bbbecb694256ca41a9b57f101fb973">FPC_COM_CHANNEL_TLS</a></div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00054">fpc_com_packets.h:54</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__link_html_ac5412a399ecd825e331b560c1ec078fd"><div class="ttname"><a href="structfpc__com__packet__link.html#ac5412a399ecd825e331b560c1ec078fd">fpc_com_packet_link::data</a></div><div class="ttdeci">uint8_t * data</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00067">fpc_com_packets.h:67</a></div></div>
|
|
<div class="ttc" id="fpc__com__packets_8h_html_a056a2f08f90fe7e467988b2ddbc41f3c"><div class="ttname"><a href="fpc__com__packets_8h.html#a056a2f08f90fe7e467988b2ddbc41f3c">fpc_com_packet_tsp_t</a></div><div class="ttdeci">struct fpc_com_packet_transport fpc_com_packet_tsp_t</div></div>
|
|
<div class="ttc" id="fpc__com__packets_8h_html_ad77ec293a161472c5ca6283ae1c944c8af73ea123cd946a1ef0109660569cd856"><div class="ttname"><a href="fpc__com__packets_8h.html#ad77ec293a161472c5ca6283ae1c944c8af73ea123cd946a1ef0109660569cd856">FPC_COM_CHANNEL_END</a></div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00055">fpc_com_packets.h:55</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__link_html_aa90708dd6d842b318723cb70d6939c2a"><div class="ttname"><a href="structfpc__com__packet__link.html#aa90708dd6d842b318723cb70d6939c2a">fpc_com_packet_link::channel</a></div><div class="ttdeci">fpc_com_channel_t channel</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00063">fpc_com_packets.h:63</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__transport_html_af72d4eb7fdaf84b87dd369b348eafc6d"><div class="ttname"><a href="structfpc__com__packet__transport.html#af72d4eb7fdaf84b87dd369b348eafc6d">fpc_com_packet_transport::seq_len</a></div><div class="ttdeci">uint16_t seq_len</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00041">fpc_com_packets.h:41</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__link_html_a2b36a249ee8d192688f2a5f3cce8cde4"><div class="ttname"><a href="structfpc__com__packet__link.html#a2b36a249ee8d192688f2a5f3cce8cde4">fpc_com_packet_link::crc</a></div><div class="ttdeci">uint32_t crc</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00069">fpc_com_packets.h:69</a></div></div>
|
|
<div class="ttc" id="fpc__com__packets_8h_html_a243c6cf0a9ab056a1fce6430bb88c2d8"><div class="ttname"><a href="fpc__com__packets_8h.html#a243c6cf0a9ab056a1fce6430bb88c2d8">fpc_com_channel_t</a></div><div class="ttdeci">uint16_t fpc_com_channel_t</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00058">fpc_com_packets.h:58</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__transport_html_a41944ffde2478be8fca892e84bd633c0"><div class="ttname"><a href="structfpc__com__packet__transport.html#a41944ffde2478be8fca892e84bd633c0">fpc_com_packet_transport::seq_nr</a></div><div class="ttdeci">uint16_t seq_nr</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00043">fpc_com_packets.h:43</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__transport_html_a9c0d37a137ba70a8d0ecd17802e3810a"><div class="ttname"><a href="structfpc__com__packet__transport.html#a9c0d37a137ba70a8d0ecd17802e3810a">fpc_com_packet_transport::size</a></div><div class="ttdeci">uint16_t size</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00039">fpc_com_packets.h:39</a></div></div>
|
|
<div class="ttc" id="structfpc__com__packet__link_html"><div class="ttname"><a href="structfpc__com__packet__link.html">fpc_com_packet_link</a></div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__packets_8h_source.html#l00061">fpc_com_packets.h:61</a></div></div>
|
|
</div><!-- fragment --></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>
|