<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tpm2-tss: src/tss2-fapi/ifapi_io.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);
</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">tpm2-tss
 <span id="projectnumber">3.2.0</span>
</div>
<div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></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('ifapi__io_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">ifapi_io.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* SPDX-License-Identifier: BSD-2-Clause */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2018-2019, Fraunhofer SIT sponsored by Infineon Technologies AG</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef IFAPI_IO_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define IFAPI_IO_H</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <stdio.h></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <stdbool.h></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "tss2_common.h"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "tss2_fapi.h"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="struct_i_f_a_p_i___i_o.html"> 15</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  FILE *stream;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordtype">short</span> pollevents;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *char_buffer;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">char</span> *char_rbuffer;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordtype">size_t</span> buffer_length;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">size_t</span> buffer_idx;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> } <a class="code" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifdef TEST_FAPI_ASYNC</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define _IFAPI_IO_RETRIES 1</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#else </span><span class="comment">/* TEST_FAPI_ASYNC */</span><span class="preprocessor"></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define _IFAPI_IO_RETRIES 0</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif </span><span class="comment">/* TEST_FAPI_ASYNC */</span><span class="preprocessor"></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">static</span> <span class="keywordtype">int</span> _ifapi_io_retry __attribute__((unused)) = _IFAPI_IO_RETRIES;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define IFAPI_IO_STREAM context->io.stream</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define IFAPI_IO_BUFF context->io.char_buffer</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define IFAPI_IO_RBUFF context->io.char_rbuffer</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define IFAPI_IO_BUFFLEN context->io.buffer_length</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#define IFAPI_IO_BUFFIDX context->io.buffer_idx</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> TSS2_RC</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <a class="code" href="group__ifapi__io.html#gac846b38f5d38efeffca5c797b6079ba6">ifapi_io_read_async</a>(</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">struct</span> <a class="code" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *filename);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> TSS2_RC</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <a class="code" href="group__ifapi__io.html#ga7c1e9c87888b39024f388bacd3745b2f">ifapi_io_read_finish</a>(</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">struct</span> <a class="code" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io,</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  uint8_t **buffer,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">size_t</span> *length);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> TSS2_RC</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <a class="code" href="group__ifapi__io.html#ga4a7a36449b735a6e0d32515bd77444af">ifapi_io_write_async</a>(</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">struct</span> <a class="code" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *filename,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> uint8_t *buffer,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> TSS2_RC</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <a class="code" href="group__ifapi__io.html#ga11895786ad4495b81c8b0728dcae69bf">ifapi_io_write_finish</a>(</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">struct</span> <a class="code" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> TSS2_RC</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <a class="code" href="group__ifapi__io.html#ga7197784e25b06357ff6a77bdf79d2f8c">ifapi_io_check_file_writeable</a>(</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> TSS2_RC</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> ifapi_io_check_create_dir(</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *dirname, <span class="keywordtype">int</span> mode);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> TSS2_RC</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <a class="code" href="group__ifapi__io.html#gac71d7c2f3a426f303f61f2a02a62fdca">ifapi_io_remove_file</a>(</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file);</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> TSS2_RC</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> ifapi_io_remove_directories(</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *dirname,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *keystore_path,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *sub_dir);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> TSS2_RC</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <a class="code" href="group__ifapi__io.html#ga40c91a5a75565d079801c2fbc6a0537c">ifapi_io_dirfiles</a>(</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *dirname,</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">char</span> ***files,</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">size_t</span> *numfiles);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> TSS2_RC</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <a class="code" href="group__ifapi__io.html#ga042e89f444f50e79e93133fe2419fa9d">ifapi_io_dirfiles_all</a>(</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *searchPath,</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">char</span> ***pathlist,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">size_t</span> *numPaths);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keywordtype">bool</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <a class="code" href="group__ifapi__io.html#gaddcf6927532a647297142d304d994ab8">ifapi_io_path_exists</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> TSS2_RC</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <a class="code" href="group__ifapi__io.html#ga091222f9b5420e0ba779cf09309bea8a">ifapi_io_poll</a>(<a class="code" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> * io);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> TSS2_RC</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <a class="code" href="group__ifapi__io.html#ga81ca6a5c7dd8c97d6eefcd425faddb54">ifapi_io_poll_handles</a>(<a class="code" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, FAPI_POLL_HANDLE **handles, <span class="keywordtype">size_t</span> *num_handles);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif </span><span class="comment">/* IFAPI_IO_H */</span><span class="preprocessor"></span></div><div class="ttc" id="struct_i_f_a_p_i___i_o_html"><div class="ttname"><a href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a></div><div class="ttdef"><b>Definition:</b> ifapi_io.h:15</div></div>
<div class="ttc" id="group__ifapi__io_html_ga091222f9b5420e0ba779cf09309bea8a"><div class="ttname"><a href="group__ifapi__io.html#ga091222f9b5420e0ba779cf09309bea8a">ifapi_io_poll</a></div><div class="ttdeci">TSS2_RC ifapi_io_poll(IFAPI_IO *io)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:704</div></div>
<div class="ttc" id="group__ifapi__io_html_ga40c91a5a75565d079801c2fbc6a0537c"><div class="ttname"><a href="group__ifapi__io.html#ga40c91a5a75565d079801c2fbc6a0537c">ifapi_io_dirfiles</a></div><div class="ttdeci">TSS2_RC ifapi_io_dirfiles(const char *dirname, char ***files, size_t *numfiles)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:476</div></div>
<div class="ttc" id="group__ifapi__io_html_ga11895786ad4495b81c8b0728dcae69bf"><div class="ttname"><a href="group__ifapi__io.html#ga11895786ad4495b81c8b0728dcae69bf">ifapi_io_write_finish</a></div><div class="ttdeci">TSS2_RC ifapi_io_write_finish(struct IFAPI_IO *io)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:270</div></div>
<div class="ttc" id="group__ifapi__io_html_gaddcf6927532a647297142d304d994ab8"><div class="ttname"><a href="group__ifapi__io.html#gaddcf6927532a647297142d304d994ab8">ifapi_io_path_exists</a></div><div class="ttdeci">bool ifapi_io_path_exists(const char *path)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:682</div></div>
<div class="ttc" id="group__ifapi__io_html_ga7c1e9c87888b39024f388bacd3745b2f"><div class="ttname"><a href="group__ifapi__io.html#ga7c1e9c87888b39024f388bacd3745b2f">ifapi_io_read_finish</a></div><div class="ttdeci">TSS2_RC ifapi_io_read_finish(struct IFAPI_IO *io, uint8_t **buffer, size_t *length)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:143</div></div>
<div class="ttc" id="group__ifapi__io_html_ga81ca6a5c7dd8c97d6eefcd425faddb54"><div class="ttname"><a href="group__ifapi__io.html#ga81ca6a5c7dd8c97d6eefcd425faddb54">ifapi_io_poll_handles</a></div><div class="ttdeci">TSS2_RC ifapi_io_poll_handles(IFAPI_IO *io, FAPI_POLL_HANDLE **handles, size_t *num_handles)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:734</div></div>
<div class="ttc" id="group__ifapi__io_html_gac846b38f5d38efeffca5c797b6079ba6"><div class="ttname"><a href="group__ifapi__io.html#gac846b38f5d38efeffca5c797b6079ba6">ifapi_io_read_async</a></div><div class="ttdeci">TSS2_RC ifapi_io_read_async(struct IFAPI_IO *io, const char *filename)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:43</div></div>
<div class="ttc" id="group__ifapi__io_html_ga042e89f444f50e79e93133fe2419fa9d"><div class="ttname"><a href="group__ifapi__io.html#ga042e89f444f50e79e93133fe2419fa9d">ifapi_io_dirfiles_all</a></div><div class="ttdeci">TSS2_RC ifapi_io_dirfiles_all(const char *searchPath, char ***pathlist, size_t *numPaths)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:632</div></div>
<div class="ttc" id="group__ifapi__io_html_ga4a7a36449b735a6e0d32515bd77444af"><div class="ttname"><a href="group__ifapi__io.html#ga4a7a36449b735a6e0d32515bd77444af">ifapi_io_write_async</a></div><div class="ttdeci">TSS2_RC ifapi_io_write_async(struct IFAPI_IO *io, const char *filename, const uint8_t *buffer, size_t length)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:199</div></div>
<div class="ttc" id="group__ifapi__io_html_gac71d7c2f3a426f303f61f2a02a62fdca"><div class="ttname"><a href="group__ifapi__io.html#gac71d7c2f3a426f303f61f2a02a62fdca">ifapi_io_remove_file</a></div><div class="ttdeci">TSS2_RC ifapi_io_remove_file(const char *file)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:363</div></div>
<div class="ttc" id="group__ifapi__io_html_ga7197784e25b06357ff6a77bdf79d2f8c"><div class="ttname"><a href="group__ifapi__io.html#ga7197784e25b06357ff6a77bdf79d2f8c">ifapi_io_check_file_writeable</a></div><div class="ttdeci">TSS2_RC ifapi_io_check_file_writeable(const char *file)</div><div class="ttdef"><b>Definition:</b> ifapi_io.c:311</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_acac3fc32f1470bed36645d881a616c0.html">tss2-fapi</a></li><li class="navelem"><b>ifapi_io.h</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>