100 lines
18 KiB
HTML
100 lines
18 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_hcp.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__hcp_8h_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">fpc_hcp.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="fpc__hcp_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_HCP_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define FPC_HCP_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 <stdbool.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="fpc__hcp__common_8h.html">fpc_hcp_common.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="fpc__com__chain_8h.html">fpc_com_chain.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <a class="code" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a> <a class="code" href="fpc__hcp_8h.html#ac8ec0a9f397508976922d1833a9a7626">fpc_hcp_transmit</a>(<a class="code" href="structfpc__hcp__packet.html">fpc_hcp_packet_t</a> *packet, <a class="code" href="structfpc__com__chain.html">fpc_com_chain_t</a> *chain);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a> <a class="code" href="fpc__hcp_8h.html#aa964fefb0fc68032f44850ee060b8e9b">fpc_hcp_receive</a>(<a class="code" href="structfpc__hcp__packet.html">fpc_hcp_packet_t</a> *packet, <a class="code" href="structfpc__com__chain.html">fpc_com_chain_t</a> *chain);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">bool</span> <a class="code" href="fpc__hcp_8h.html#a9b6886d13174fd6e88bd673ba09cca7d">fpc_hcp_arg_add</a>(<a class="code" href="structfpc__hcp__packet.html">fpc_hcp_packet_t</a> *packet, <a class="code" href="fpc__hcp__common_8h.html#a7470deee2c0eae8f5ac7feb71649df0b">fpc_hcp_arg_t</a> arg, uint16_t size, <span class="keywordtype">bool</span> free_data,</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> *data);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">bool</span> <a class="code" href="fpc__hcp_8h.html#ae1b7ce8b198acf7c8f6802300e2591ea">fpc_hcp_arg_check</a>(<a class="code" href="structfpc__hcp__packet.html">fpc_hcp_packet_t</a> *packet, <a class="code" href="fpc__hcp__common_8h.html#a7470deee2c0eae8f5ac7feb71649df0b">fpc_hcp_arg_t</a> arg);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <a class="code" href="structfpc__hcp__arg__data.html">fpc_hcp_arg_data_t</a> *<a class="code" href="fpc__hcp_8h.html#a3860f01dade55ac5f55e85342b8f6d0d">fpc_hcp_arg_get</a>(<a class="code" href="structfpc__hcp__packet.html">fpc_hcp_packet_t</a> *packet, <a class="code" href="fpc__hcp__common_8h.html#a7470deee2c0eae8f5ac7feb71649df0b">fpc_hcp_arg_t</a> arg);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">bool</span> <a class="code" href="fpc__hcp_8h.html#addefbe1e416979abcf59f7bf652e2a77">fpc_hcp_arg_copy_data</a>(<a class="code" href="structfpc__hcp__packet.html">fpc_hcp_packet_t</a> *packet, <a class="code" href="fpc__hcp__common_8h.html#a7470deee2c0eae8f5ac7feb71649df0b">fpc_hcp_arg_t</a> arg, uint16_t data_size,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  uint8_t *data);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keywordtype">void</span> <a class="code" href="fpc__hcp_8h.html#a78f14eb8269c8f17ea46f01beab88608">fpc_hcp_free</a>(<a class="code" href="structfpc__com__chain.html">fpc_com_chain_t</a> *chain, <a class="code" href="structfpc__hcp__packet.html">fpc_hcp_packet_t</a> *packet);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> uint16_t <a class="code" href="fpc__hcp_8h.html#a144fab9621ae9cd7abb8e3660b20265f">fpc_hcp_get_size</a>(<a class="code" href="structfpc__hcp__packet.html">fpc_hcp_packet_t</a> *packet, uint16_t *num_args);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> }</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor">#endif </span><span class="comment">/* FPC_HCP_H */</span><span class="preprocessor"></span></div><div class="ttc" id="fpc__hcp_8h_html_ae1b7ce8b198acf7c8f6802300e2591ea"><div class="ttname"><a href="fpc__hcp_8h.html#ae1b7ce8b198acf7c8f6802300e2591ea">fpc_hcp_arg_check</a></div><div class="ttdeci">bool fpc_hcp_arg_check(fpc_hcp_packet_t *packet, fpc_hcp_arg_t arg)</div><div class="ttdoc">Check if command contains selected argument key. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp_8c_source.html#l00169">fpc_hcp.c:169</a></div></div>
|
|
<div class="ttc" id="structfpc__com__chain_html"><div class="ttname"><a href="structfpc__com__chain.html">fpc_com_chain</a></div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__chain_8h_source.html#l00050">fpc_com_chain.h:50</a></div></div>
|
|
<div class="ttc" id="structfpc__hcp__packet_html"><div class="ttname"><a href="structfpc__hcp__packet.html">fpc_hcp_packet</a></div><div class="ttdoc">Application Command Packet. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp__common_8h_source.html#l00210">fpc_hcp_common.h:210</a></div></div>
|
|
<div class="ttc" id="fpc__hcp_8h_html_a3860f01dade55ac5f55e85342b8f6d0d"><div class="ttname"><a href="fpc__hcp_8h.html#a3860f01dade55ac5f55e85342b8f6d0d">fpc_hcp_arg_get</a></div><div class="ttdeci">fpc_hcp_arg_data_t * fpc_hcp_arg_get(fpc_hcp_packet_t *packet, fpc_hcp_arg_t arg)</div><div class="ttdoc">Get Argument with specified key. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp_8c_source.html#l00173">fpc_hcp.c:173</a></div></div>
|
|
<div class="ttc" id="fpc__com__chain_8h_html"><div class="ttname"><a href="fpc__com__chain_8h.html">fpc_com_chain.h</a></div><div class="ttdoc">Communication chain type definitions. </div></div>
|
|
<div class="ttc" id="structfpc__hcp__arg__data_html"><div class="ttname"><a href="structfpc__hcp__arg__data.html">fpc_hcp_arg_data</a></div><div class="ttdoc">Command Argument. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp__common_8h_source.html#l00196">fpc_hcp_common.h:196</a></div></div>
|
|
<div class="ttc" id="fpc__hcp_8h_html_a9b6886d13174fd6e88bd673ba09cca7d"><div class="ttname"><a href="fpc__hcp_8h.html#a9b6886d13174fd6e88bd673ba09cca7d">fpc_hcp_arg_add</a></div><div class="ttdeci">bool fpc_hcp_arg_add(fpc_hcp_packet_t *packet, fpc_hcp_arg_t arg, uint16_t size, bool free_data, void *data)</div><div class="ttdoc">Add argument to packet. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp_8c_source.html#l00145">fpc_hcp.c:145</a></div></div>
|
|
<div class="ttc" id="fpc__hcp_8h_html_aa964fefb0fc68032f44850ee060b8e9b"><div class="ttname"><a href="fpc__hcp_8h.html#aa964fefb0fc68032f44850ee060b8e9b">fpc_hcp_receive</a></div><div class="ttdeci">fpc_com_result_t fpc_hcp_receive(fpc_hcp_packet_t *packet, fpc_com_chain_t *chain)</div><div class="ttdoc">Receives an application packet through the supplied transmit chain. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp_8c_source.html#l00117">fpc_hcp.c:117</a></div></div>
|
|
<div class="ttc" id="fpc__hcp__common_8h_html_a7470deee2c0eae8f5ac7feb71649df0b"><div class="ttname"><a href="fpc__hcp__common_8h.html#a7470deee2c0eae8f5ac7feb71649df0b">fpc_hcp_arg_t</a></div><div class="ttdeci">uint16_t fpc_hcp_arg_t</div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp__common_8h_source.html#l00191">fpc_hcp_common.h:191</a></div></div>
|
|
<div class="ttc" id="fpc__hcp_8h_html_a144fab9621ae9cd7abb8e3660b20265f"><div class="ttname"><a href="fpc__hcp_8h.html#a144fab9621ae9cd7abb8e3660b20265f">fpc_hcp_get_size</a></div><div class="ttdeci">uint16_t fpc_hcp_get_size(fpc_hcp_packet_t *packet, uint16_t *num_args)</div><div class="ttdoc">Calculate serialized packet size. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp_8c_source.html#l00064">fpc_hcp.c:64</a></div></div>
|
|
<div class="ttc" id="fpc__hcp_8h_html_addefbe1e416979abcf59f7bf652e2a77"><div class="ttname"><a href="fpc__hcp_8h.html#addefbe1e416979abcf59f7bf652e2a77">fpc_hcp_arg_copy_data</a></div><div class="ttdeci">bool fpc_hcp_arg_copy_data(fpc_hcp_packet_t *packet, fpc_hcp_arg_t arg, uint16_t data_size, uint8_t *data)</div><div class="ttdoc">Copy data from an argument with specified key. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp_8c_source.html#l00183">fpc_hcp.c:183</a></div></div>
|
|
<div class="ttc" id="fpc__hcp_8h_html_ac8ec0a9f397508976922d1833a9a7626"><div class="ttname"><a href="fpc__hcp_8h.html#ac8ec0a9f397508976922d1833a9a7626">fpc_hcp_transmit</a></div><div class="ttdeci">fpc_com_result_t fpc_hcp_transmit(fpc_hcp_packet_t *packet, fpc_com_chain_t *chain)</div><div class="ttdoc">Transmits an application packet through the supplied transmit chain. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp_8c_source.html#l00089">fpc_hcp.c:89</a></div></div>
|
|
<div class="ttc" id="fpc__com__result_8h_html_a49b1f9a24f677d396227ea645494070a"><div class="ttname"><a href="fpc__com__result_8h.html#a49b1f9a24f677d396227ea645494070a">fpc_com_result_t</a></div><div class="ttdeci">uint8_t fpc_com_result_t</div><div class="ttdef"><b>Definition:</b> <a href="fpc__com__result_8h_source.html#l00041">fpc_com_result.h:41</a></div></div>
|
|
<div class="ttc" id="fpc__hcp__common_8h_html"><div class="ttname"><a href="fpc__hcp__common_8h.html">fpc_hcp_common.h</a></div><div class="ttdoc">Host Communication Protocol common type definitions. </div></div>
|
|
<div class="ttc" id="fpc__hcp_8h_html_a78f14eb8269c8f17ea46f01beab88608"><div class="ttname"><a href="fpc__hcp_8h.html#a78f14eb8269c8f17ea46f01beab88608">fpc_hcp_free</a></div><div class="ttdeci">void fpc_hcp_free(fpc_com_chain_t *chain, fpc_hcp_packet_t *packet)</div><div class="ttdoc">Frees the resources held by the packet i.e. the dynamic data held in the arguments. </div><div class="ttdef"><b>Definition:</b> <a href="fpc__hcp_8c_source.html#l00198">fpc_hcp.c:198</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__hcp_8h.html">fpc_hcp.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>
|