Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Súbory Issues 0 Pull requesty 0 Wiki
Branch: master
Branche Tagy
csu3_am335x
/
EVSE
/
GPL
/
tpm2-tss-3.2.0
/
doxygen-doc
/
html
/
group__ifapi__io.html

group__ifapi__io.html 27 KB
Permanentný odkaz História Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.13"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>tpm2-tss: Basic IO module</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="resize.js"></script>
    14. 

  14. <script type="text/javascript" src="navtreedata.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18. </script>
    19. 

  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    20. 

  20. </head>
    21. 

  21. <body>
    22. 

  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    23. 

  23. <div id="titlearea">
    24. 

  24. <table cellspacing="0" cellpadding="0">
    25. 

  25.  <tbody>
    26. 

  26.  <tr style="height: 56px;">
    27. 

  27.   <td id="projectalign" style="padding-left: 0.5em;">
    28. 

  28.    <div id="projectname">tpm2-tss
    29. 

  29.    &#160;<span id="projectnumber">3.2.0</span>
    30. 

  30.    </div>
    31. 

  31.    <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
    32. 

  32.   </td>
    33. 

  33.  </tr>
    34. 

  34.  </tbody>
    35. 

  35. </table>
    36. 

  36. </div>
    37. 

  37. <!-- end header part -->
    38. 

  38. <!-- Generated by Doxygen 1.8.13 -->
    39. 

  39. <script type="text/javascript" src="menudata.js"></script>
    40. 

  40. <script type="text/javascript" src="menu.js"></script>
    41. 

  41. <script type="text/javascript">
    42. 

  42. $(function() {
    43. 

  43.   initMenu('',false,false,'search.php','Search');
    44. 

  44. });
    45. 

  45. </script>
    46. 

  46. <div id="main-nav"></div>
    47. 

  47. </div><!-- top -->
    48. 

  48. <div id="side-nav" class="ui-resizable side-nav-resizable">
    49. 

  49.   <div id="nav-tree">
    50. 

  50.     <div id="nav-tree-contents">
    51. 

  51.       <div id="nav-sync" class="sync"></div>
    52. 

  52.     </div>
    53. 

  53.   </div>
    54. 

  54.   <div id="splitbar" style="-moz-user-select:none;" 
    55. 

  55.        class="ui-resizable-handle">
    56. 

  56.   </div>
    57. 

  57. </div>
    58. 

  58. <script type="text/javascript">
    59. 

  59. $(document).ready(function(){initNavTree('group__ifapi__io.html','');});
    60. 

  60. </script>
    61. 

  61. <div id="doc-content">
    62. 

  62. <div class="header">
    63. 

  63.   <div class="summary">
    64. 

  64. <a href="#func-members">Functions</a>  </div>
    65. 

  65.   <div class="headertitle">
    66. 

  66. <div class="title">Basic IO module<div class="ingroups"><a class="el" href="group__fapi.html">Feature API</a> &raquo; <a class="el" href="group__ifapi.html">Internals of Feature API</a></div></div>  </div>
    67. 

  67. </div><!--header-->
    68. 

  68. <div class="contents">
    69. 

  69. <table class="memberdecls">
    70. 

  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    71. 

  71. Functions</h2></td></tr>
    72. 

  72. <tr class="memitem:ga7197784e25b06357ff6a77bdf79d2f8c"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#ga7197784e25b06357ff6a77bdf79d2f8c">ifapi_io_check_file_writeable</a> (const char *file)</td></tr>
    73. 

  73. <tr class="separator:ga7197784e25b06357ff6a77bdf79d2f8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:ga40c91a5a75565d079801c2fbc6a0537c"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#ga40c91a5a75565d079801c2fbc6a0537c">ifapi_io_dirfiles</a> (const char *dirname, char ***files, size_t *numfiles)</td></tr>
    75. 

  75. <tr class="separator:ga40c91a5a75565d079801c2fbc6a0537c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:ga042e89f444f50e79e93133fe2419fa9d"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#ga042e89f444f50e79e93133fe2419fa9d">ifapi_io_dirfiles_all</a> (const char *searchPath, char ***pathlist, size_t *numPaths)</td></tr>
    77. 

  77. <tr class="separator:ga042e89f444f50e79e93133fe2419fa9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. <tr class="memitem:gaddcf6927532a647297142d304d994ab8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#gaddcf6927532a647297142d304d994ab8">ifapi_io_path_exists</a> (const char *path)</td></tr>
    79. 

  79. <tr class="separator:gaddcf6927532a647297142d304d994ab8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:ga091222f9b5420e0ba779cf09309bea8a"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#ga091222f9b5420e0ba779cf09309bea8a">ifapi_io_poll</a> (<a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io)</td></tr>
    81. 

  81. <tr class="separator:ga091222f9b5420e0ba779cf09309bea8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. <tr class="memitem:ga81ca6a5c7dd8c97d6eefcd425faddb54"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#ga81ca6a5c7dd8c97d6eefcd425faddb54">ifapi_io_poll_handles</a> (<a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, FAPI_POLL_HANDLE **handles, size_t *num_handles)</td></tr>
    83. 

  83. <tr class="separator:ga81ca6a5c7dd8c97d6eefcd425faddb54"><td class="memSeparator" colspan="2">&#160;</td></tr>
    84. 

  84. <tr class="memitem:gac846b38f5d38efeffca5c797b6079ba6"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#gac846b38f5d38efeffca5c797b6079ba6">ifapi_io_read_async</a> (struct <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const char *filename)</td></tr>
    85. 

  85. <tr class="separator:gac846b38f5d38efeffca5c797b6079ba6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    86. 

  86. <tr class="memitem:ga7c1e9c87888b39024f388bacd3745b2f"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#ga7c1e9c87888b39024f388bacd3745b2f">ifapi_io_read_finish</a> (struct <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, uint8_t **buffer, size_t *length)</td></tr>
    87. 

  87. <tr class="separator:ga7c1e9c87888b39024f388bacd3745b2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    88. 

  88. <tr class="memitem:gac71d7c2f3a426f303f61f2a02a62fdca"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#gac71d7c2f3a426f303f61f2a02a62fdca">ifapi_io_remove_file</a> (const char *file)</td></tr>
    89. 

  89. <tr class="separator:gac71d7c2f3a426f303f61f2a02a62fdca"><td class="memSeparator" colspan="2">&#160;</td></tr>
    90. 

  90. <tr class="memitem:ga4a7a36449b735a6e0d32515bd77444af"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#ga4a7a36449b735a6e0d32515bd77444af">ifapi_io_write_async</a> (struct <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const char *filename, const uint8_t *buffer, size_t length)</td></tr>
    91. 

  91. <tr class="separator:ga4a7a36449b735a6e0d32515bd77444af"><td class="memSeparator" colspan="2">&#160;</td></tr>
    92. 

  92. <tr class="memitem:ga11895786ad4495b81c8b0728dcae69bf"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__io.html#ga11895786ad4495b81c8b0728dcae69bf">ifapi_io_write_finish</a> (struct <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io)</td></tr>
    93. 

  93. <tr class="separator:ga11895786ad4495b81c8b0728dcae69bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
    94. 

  94. </table>
    95. 

  95. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    96. 

  96. <p>Provides internal basic IO functions for policy and key store module. </p>
    97. 

  97. <h2 class="groupheader">Function Documentation</h2>
    98. 

  98. <a id="ga7197784e25b06357ff6a77bdf79d2f8c"></a>
    99. 

  99. <h2 class="memtitle"><span class="permalink"><a href="#ga7197784e25b06357ff6a77bdf79d2f8c">&#9670;&nbsp;</a></span>ifapi_io_check_file_writeable()</h2>
    100. 

  100. 

  101. <div class="memitem">
    102. 

  102. <div class="memproto">
    103. 

  103.       <table class="memname">
    104. 

  104.         <tr>
    105. 

  105.           <td class="memname">TSS2_RC ifapi_io_check_file_writeable </td>
    106. 

  106.           <td>(</td>
    107. 

  107.           <td class="paramtype">const char *&#160;</td>
    108. 

  108.           <td class="paramname"><em>file</em></td><td>)</td>
    109. 

  109.           <td></td>
    110. 

  110.         </tr>
    111. 

  111.       </table>
    112. 

  112. </div><div class="memdoc">
    113. 

  113. <p>Check whether a file is writeable.</p>
    114. 

  114. <dl class="params"><dt>Parameters</dt><dd>
    115. 

  115.   <table class="params">
    116. 

  116.     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>The name of the fileto be checked. </td></tr>
    117. 

  117.   </table>
    118. 

  118.   </dd>
    119. 

  119. </dl>
    120. 

  120. <dl class="retval"><dt>Return values</dt><dd>
    121. 

  121.   <table class="retval">
    122. 

  122.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the directories existed or were successfully created </td></tr>
    123. 

  123.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error occurred </td></tr>
    124. 

  124.   </table>
    125. 

  125.   </dd>
    126. 

  126. </dl>
    127. 

  127. 

  128. </div>
    129. 

  129. </div>
    130. 

  130. <a id="ga40c91a5a75565d079801c2fbc6a0537c"></a>
    131. 

  131. <h2 class="memtitle"><span class="permalink"><a href="#ga40c91a5a75565d079801c2fbc6a0537c">&#9670;&nbsp;</a></span>ifapi_io_dirfiles()</h2>
    132. 

  132. 

  133. <div class="memitem">
    134. 

  134. <div class="memproto">
    135. 

  135.       <table class="memname">
    136. 

  136.         <tr>
    137. 

  137.           <td class="memname">TSS2_RC ifapi_io_dirfiles </td>
    138. 

  138.           <td>(</td>
    139. 

  139.           <td class="paramtype">const char *&#160;</td>
    140. 

  140.           <td class="paramname"><em>dirname</em>, </td>
    141. 

  141.         </tr>
    142. 

  142.         <tr>
    143. 

  143.           <td class="paramkey"></td>
    144. 

  144.           <td></td>
    145. 

  145.           <td class="paramtype">char ***&#160;</td>
    146. 

  146.           <td class="paramname"><em>files</em>, </td>
    147. 

  147.         </tr>
    148. 

  148.         <tr>
    149. 

  149.           <td class="paramkey"></td>
    150. 

  150.           <td></td>
    151. 

  151.           <td class="paramtype">size_t *&#160;</td>
    152. 

  152.           <td class="paramname"><em>numfiles</em>&#160;</td>
    153. 

  153.         </tr>
    154. 

  154.         <tr>
    155. 

  155.           <td></td>
    156. 

  156.           <td>)</td>
    157. 

  157.           <td></td><td></td>
    158. 

  158.         </tr>
    159. 

  159.       </table>
    160. 

  160. </div><div class="memdoc">
    161. 

  161. <p>Enumerate the list of files in a directory.</p>
    162. 

  162. <p>Enumerage the regular files (no directories, symlinks etc) from a given directory.</p>
    163. 

  163. <dl class="params"><dt>Parameters</dt><dd>
    164. 

  164.   <table class="params">
    165. 

  165.     <tr><td class="paramdir">[in]</td><td class="paramname">dirname</td><td>The directory to list files from. </td></tr>
    166. 

  166.     <tr><td class="paramdir">[out]</td><td class="paramname">files</td><td>The list of file names. </td></tr>
    167. 

  167.     <tr><td class="paramdir">[out]</td><td class="paramname">numfiles</td><td>The size of files. </td></tr>
    168. 

  168.   </table>
    169. 

  169.   </dd>
    170. 

  170. </dl>
    171. 

  171. <dl class="retval"><dt>Return values</dt><dd>
    172. 

  172.   <table class="retval">
    173. 

  173.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the directories were successfully removed </td></tr>
    174. 

  174.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error occurred </td></tr>
    175. 

  175.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated to hold the read data. </td></tr>
    176. 

  176.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    177. 

  177.   </table>
    178. 

  178.   </dd>
    179. 

  179. </dl>
    180. 

  180. 

  181. </div>
    182. 

  182. </div>
    183. 

  183. <a id="ga042e89f444f50e79e93133fe2419fa9d"></a>
    184. 

  184. <h2 class="memtitle"><span class="permalink"><a href="#ga042e89f444f50e79e93133fe2419fa9d">&#9670;&nbsp;</a></span>ifapi_io_dirfiles_all()</h2>
    185. 

  185. 

  186. <div class="memitem">
    187. 

  187. <div class="memproto">
    188. 

  188.       <table class="memname">
    189. 

  189.         <tr>
    190. 

  190.           <td class="memname">TSS2_RC ifapi_io_dirfiles_all </td>
    191. 

  191.           <td>(</td>
    192. 

  192.           <td class="paramtype">const char *&#160;</td>
    193. 

  193.           <td class="paramname"><em>searchPath</em>, </td>
    194. 

  194.         </tr>
    195. 

  195.         <tr>
    196. 

  196.           <td class="paramkey"></td>
    197. 

  197.           <td></td>
    198. 

  198.           <td class="paramtype">char ***&#160;</td>
    199. 

  199.           <td class="paramname"><em>pathlist</em>, </td>
    200. 

  200.         </tr>
    201. 

  201.         <tr>
    202. 

  202.           <td class="paramkey"></td>
    203. 

  203.           <td></td>
    204. 

  204.           <td class="paramtype">size_t *&#160;</td>
    205. 

  205.           <td class="paramname"><em>numPaths</em>&#160;</td>
    206. 

  206.         </tr>
    207. 

  207.         <tr>
    208. 

  208.           <td></td>
    209. 

  209.           <td>)</td>
    210. 

  210.           <td></td><td></td>
    211. 

  211.         </tr>
    212. 

  212.       </table>
    213. 

  213. </div><div class="memdoc">
    214. 

  214. <p>Recursive enumerate the list of files in a directory.</p>
    215. 

  215. <p>Enumerage the regular files (no directories, symlinks etc) from a given directory.</p>
    216. 

  216. <dl class="params"><dt>Parameters</dt><dd>
    217. 

  217.   <table class="params">
    218. 

  218.     <tr><td class="paramdir">[in]</td><td class="paramname">searchPath</td><td>The directory to list files from. </td></tr>
    219. 

  219.     <tr><td class="paramdir">[out]</td><td class="paramname">pathlist</td><td>The list of file names. </td></tr>
    220. 

  220.     <tr><td class="paramdir">[out]</td><td class="paramname">numPaths</td><td>The size of files. </td></tr>
    221. 

  221.   </table>
    222. 

  222.   </dd>
    223. 

  223. </dl>
    224. 

  224. <dl class="retval"><dt>Return values</dt><dd>
    225. 

  225.   <table class="retval">
    226. 

  226.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the directories were successfully removed </td></tr>
    227. 

  227.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error occurred </td></tr>
    228. 

  228.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated to hold the read data. </td></tr>
    229. 

  229.   </table>
    230. 

  230.   </dd>
    231. 

  231. </dl>
    232. 

  232. 

  233. </div>
    234. 

  234. </div>
    235. 

  235. <a id="gaddcf6927532a647297142d304d994ab8"></a>
    236. 

  236. <h2 class="memtitle"><span class="permalink"><a href="#gaddcf6927532a647297142d304d994ab8">&#9670;&nbsp;</a></span>ifapi_io_path_exists()</h2>
    237. 

  237. 

  238. <div class="memitem">
    239. 

  239. <div class="memproto">
    240. 

  240.       <table class="memname">
    241. 

  241.         <tr>
    242. 

  242.           <td class="memname">bool ifapi_io_path_exists </td>
    243. 

  243.           <td>(</td>
    244. 

  244.           <td class="paramtype">const char *&#160;</td>
    245. 

  245.           <td class="paramname"><em>path</em></td><td>)</td>
    246. 

  246.           <td></td>
    247. 

  247.         </tr>
    248. 

  248.       </table>
    249. 

  249. </div><div class="memdoc">
    250. 

  250. <p>Determine whether a path exists.</p>
    251. 

  251. <dl class="params"><dt>Parameters</dt><dd>
    252. 

  252.   <table class="params">
    253. 

  253.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The absolute path of the file. </td></tr>
    254. 

  254.   </table>
    255. 

  255.   </dd>
    256. 

  256. </dl>
    257. 

  257. <dl class="retval"><dt>Return values</dt><dd>
    258. 

  258.   <table class="retval">
    259. 

  259.     <tr><td class="paramname">true</td><td>The file exists. </td></tr>
    260. 

  260.     <tr><td class="paramname">false</td><td>The file does not exist. </td></tr>
    261. 

  261.   </table>
    262. 

  262.   </dd>
    263. 

  263. </dl>
    264. 

  264. 

  265. </div>
    266. 

  266. </div>
    267. 

  267. <a id="ga091222f9b5420e0ba779cf09309bea8a"></a>
    268. 

  268. <h2 class="memtitle"><span class="permalink"><a href="#ga091222f9b5420e0ba779cf09309bea8a">&#9670;&nbsp;</a></span>ifapi_io_poll()</h2>
    269. 

  269. 

  270. <div class="memitem">
    271. 

  271. <div class="memproto">
    272. 

  272.       <table class="memname">
    273. 

  273.         <tr>
    274. 

  274.           <td class="memname">TSS2_RC ifapi_io_poll </td>
    275. 

  275.           <td>(</td>
    276. 

  276.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    277. 

  277.           <td class="paramname"><em>io</em></td><td>)</td>
    278. 

  278.           <td></td>
    279. 

  279.         </tr>
    280. 

  280.       </table>
    281. 

  281. </div><div class="memdoc">
    282. 

  282. <p>Wait for file I/O to be ready.</p>
    283. 

  283. <p>If FAPI state automata are in a file I/O state it will be waited for an event on a file descriptor.</p>
    284. 

  284. <dl class="params"><dt>Parameters</dt><dd>
    285. 

  285.   <table class="params">
    286. 

  286.     <tr><td class="paramdir">[in]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    287. 

  287.   </table>
    288. 

  288.   </dd>
    289. 

  289. </dl>
    290. 

  290. <dl class="retval"><dt>Return values</dt><dd>
    291. 

  291.   <table class="retval">
    292. 

  292.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>After the end of the wait. </td></tr>
    293. 

  293.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the poll function returns an error. </td></tr>
    294. 

  294.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    295. 

  295.   </table>
    296. 

  296.   </dd>
    297. 

  297. </dl>
    298. 

  298. 

  299. </div>
    300. 

  300. </div>
    301. 

  301. <a id="ga81ca6a5c7dd8c97d6eefcd425faddb54"></a>
    302. 

  302. <h2 class="memtitle"><span class="permalink"><a href="#ga81ca6a5c7dd8c97d6eefcd425faddb54">&#9670;&nbsp;</a></span>ifapi_io_poll_handles()</h2>
    303. 

  303. 

  304. <div class="memitem">
    305. 

  305. <div class="memproto">
    306. 

  306.       <table class="memname">
    307. 

  307.         <tr>
    308. 

  308.           <td class="memname">TSS2_RC ifapi_io_poll_handles </td>
    309. 

  309.           <td>(</td>
    310. 

  310.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    311. 

  311.           <td class="paramname"><em>io</em>, </td>
    312. 

  312.         </tr>
    313. 

  313.         <tr>
    314. 

  314.           <td class="paramkey"></td>
    315. 

  315.           <td></td>
    316. 

  316.           <td class="paramtype">FAPI_POLL_HANDLE **&#160;</td>
    317. 

  317.           <td class="paramname"><em>handles</em>, </td>
    318. 

  318.         </tr>
    319. 

  319.         <tr>
    320. 

  320.           <td class="paramkey"></td>
    321. 

  321.           <td></td>
    322. 

  322.           <td class="paramtype">size_t *&#160;</td>
    323. 

  323.           <td class="paramname"><em>num_handles</em>&#160;</td>
    324. 

  324.         </tr>
    325. 

  325.         <tr>
    326. 

  326.           <td></td>
    327. 

  327.           <td>)</td>
    328. 

  328.           <td></td><td></td>
    329. 

  329.         </tr>
    330. 

  330.       </table>
    331. 

  331. </div><div class="memdoc">
    332. 

  332. <p>Get a list of poll handles.</p>
    333. 

  333. <dl class="params"><dt>Parameters</dt><dd>
    334. 

  334.   <table class="params">
    335. 

  335.     <tr><td class="paramdir">[in]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    336. 

  336.     <tr><td class="paramdir">[out]</td><td class="paramname">handles</td><td>The array with the poll handles. </td></tr>
    337. 

  337.     <tr><td class="paramdir">[out]</td><td class="paramname">num_handles</td><td>The number of poll handles. </td></tr>
    338. 

  338.   </table>
    339. 

  339.   </dd>
    340. 

  340. </dl>
    341. 

  341. <dl class="retval"><dt>Return values</dt><dd>
    342. 

  342.   <table class="retval">
    343. 

  343.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    344. 

  344.     <tr><td class="paramname">TSS2_FAPI_RC_NO_HANDLE</td><td>In no poll events are stored in IO context. </td></tr>
    345. 

  345.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>If the output data cannot be allocated. </td></tr>
    346. 

  346.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    347. 

  347.   </table>
    348. 

  348.   </dd>
    349. 

  349. </dl>
    350. 

  350. 

  351. </div>
    352. 

  352. </div>
    353. 

  353. <a id="gac846b38f5d38efeffca5c797b6079ba6"></a>
    354. 

  354. <h2 class="memtitle"><span class="permalink"><a href="#gac846b38f5d38efeffca5c797b6079ba6">&#9670;&nbsp;</a></span>ifapi_io_read_async()</h2>
    355. 

  355. 

  356. <div class="memitem">
    357. 

  357. <div class="memproto">
    358. 

  358.       <table class="memname">
    359. 

  359.         <tr>
    360. 

  360.           <td class="memname">TSS2_RC ifapi_io_read_async </td>
    361. 

  361.           <td>(</td>
    362. 

  362.           <td class="paramtype">struct <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    363. 

  363.           <td class="paramname"><em>io</em>, </td>
    364. 

  364.         </tr>
    365. 

  365.         <tr>
    366. 

  366.           <td class="paramkey"></td>
    367. 

  367.           <td></td>
    368. 

  368.           <td class="paramtype">const char *&#160;</td>
    369. 

  369.           <td class="paramname"><em>filename</em>&#160;</td>
    370. 

  370.         </tr>
    371. 

  371.         <tr>
    372. 

  372.           <td></td>
    373. 

  373.           <td>)</td>
    374. 

  374.           <td></td><td></td>
    375. 

  375.         </tr>
    376. 

  376.       </table>
    377. 

  377. </div><div class="memdoc">
    378. 

  378. <p>Start reading a file's complete content into memory in an asynchronous way.</p>
    379. 

  379. <dl class="params"><dt>Parameters</dt><dd>
    380. 

  380.   <table class="params">
    381. 

  381.     <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    382. 

  382.     <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>The name of the file to be read into memory. </td></tr>
    383. 

  383.   </table>
    384. 

  384.   </dd>
    385. 

  385. </dl>
    386. 

  386. <dl class="retval"><dt>Return values</dt><dd>
    387. 

  387.   <table class="retval">
    388. 

  388.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    389. 

  389.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error was encountered; such as the file was not found. </td></tr>
    390. 

  390.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated to hold the read data. </td></tr>
    391. 

  391.   </table>
    392. 

  392.   </dd>
    393. 

  393. </dl>
    394. 

  394. 

  395. </div>
    396. 

  396. </div>
    397. 

  397. <a id="ga7c1e9c87888b39024f388bacd3745b2f"></a>
    398. 

  398. <h2 class="memtitle"><span class="permalink"><a href="#ga7c1e9c87888b39024f388bacd3745b2f">&#9670;&nbsp;</a></span>ifapi_io_read_finish()</h2>
    399. 

  399. 

  400. <div class="memitem">
    401. 

  401. <div class="memproto">
    402. 

  402.       <table class="memname">
    403. 

  403.         <tr>
    404. 

  404.           <td class="memname">TSS2_RC ifapi_io_read_finish </td>
    405. 

  405.           <td>(</td>
    406. 

  406.           <td class="paramtype">struct <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    407. 

  407.           <td class="paramname"><em>io</em>, </td>
    408. 

  408.         </tr>
    409. 

  409.         <tr>
    410. 

  410.           <td class="paramkey"></td>
    411. 

  411.           <td></td>
    412. 

  412.           <td class="paramtype">uint8_t **&#160;</td>
    413. 

  413.           <td class="paramname"><em>buffer</em>, </td>
    414. 

  414.         </tr>
    415. 

  415.         <tr>
    416. 

  416.           <td class="paramkey"></td>
    417. 

  417.           <td></td>
    418. 

  418.           <td class="paramtype">size_t *&#160;</td>
    419. 

  419.           <td class="paramname"><em>length</em>&#160;</td>
    420. 

  420.         </tr>
    421. 

  421.         <tr>
    422. 

  422.           <td></td>
    423. 

  423.           <td>)</td>
    424. 

  424.           <td></td><td></td>
    425. 

  425.         </tr>
    426. 

  426.       </table>
    427. 

  427. </div><div class="memdoc">
    428. 

  428. <p>Finish reading a file's complete content into memory in an asynchronous way.</p>
    429. 

  429. <p>This function needs to be called repeatedly until it does not return TSS2_FAPI_RC_TRY_AGAIN.</p>
    430. 

  430. <dl class="params"><dt>Parameters</dt><dd>
    431. 

  431.   <table class="params">
    432. 

  432.     <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    433. 

  433.     <tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>The data that was read from file. (callee-allocated; use free()) </td></tr>
    434. 

  434.     <tr><td class="paramdir">[out]</td><td class="paramname">length</td><td>The length of the data that was read from file. </td></tr>
    435. 

  435.   </table>
    436. 

  436.   </dd>
    437. 

  437. </dl>
    438. 

  438. <dl class="retval"><dt>Return values</dt><dd>
    439. 

  439.   <table class="retval">
    440. 

  440.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    441. 

  441.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error was encountered; such as the file was not found. </td></tr>
    442. 

  442.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the asynchronous operation is not yet complete. Call this function again later. </td></tr>
    443. 

  443.   </table>
    444. 

  444.   </dd>
    445. 

  445. </dl>
    446. 

  446. 

  447. </div>
    448. 

  448. </div>
    449. 

  449. <a id="gac71d7c2f3a426f303f61f2a02a62fdca"></a>
    450. 

  450. <h2 class="memtitle"><span class="permalink"><a href="#gac71d7c2f3a426f303f61f2a02a62fdca">&#9670;&nbsp;</a></span>ifapi_io_remove_file()</h2>
    451. 

  451. 

  452. <div class="memitem">
    453. 

  453. <div class="memproto">
    454. 

  454.       <table class="memname">
    455. 

  455.         <tr>
    456. 

  456.           <td class="memname">TSS2_RC ifapi_io_remove_file </td>
    457. 

  457.           <td>(</td>
    458. 

  458.           <td class="paramtype">const char *&#160;</td>
    459. 

  459.           <td class="paramname"><em>file</em></td><td>)</td>
    460. 

  460.           <td></td>
    461. 

  461.         </tr>
    462. 

  462.       </table>
    463. 

  463. </div><div class="memdoc">
    464. 

  464. <p>Remove a file.</p>
    465. 

  465. <dl class="params"><dt>Parameters</dt><dd>
    466. 

  466.   <table class="params">
    467. 

  467.     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>The absolute path of the file to be removed. </td></tr>
    468. 

  468.   </table>
    469. 

  469.   </dd>
    470. 

  470. </dl>
    471. 

  471. <dl class="retval"><dt>Return values</dt><dd>
    472. 

  472.   <table class="retval">
    473. 

  473.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>If the file was successfully removed </td></tr>
    474. 

  474.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>If the file could not be removed. </td></tr>
    475. 

  475.   </table>
    476. 

  476.   </dd>
    477. 

  477. </dl>
    478. 

  478. 

  479. </div>
    480. 

  480. </div>
    481. 

  481. <a id="ga4a7a36449b735a6e0d32515bd77444af"></a>
    482. 

  482. <h2 class="memtitle"><span class="permalink"><a href="#ga4a7a36449b735a6e0d32515bd77444af">&#9670;&nbsp;</a></span>ifapi_io_write_async()</h2>
    483. 

  483. 

  484. <div class="memitem">
    485. 

  485. <div class="memproto">
    486. 

  486.       <table class="memname">
    487. 

  487.         <tr>
    488. 

  488.           <td class="memname">TSS2_RC ifapi_io_write_async </td>
    489. 

  489.           <td>(</td>
    490. 

  490.           <td class="paramtype">struct <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    491. 

  491.           <td class="paramname"><em>io</em>, </td>
    492. 

  492.         </tr>
    493. 

  493.         <tr>
    494. 

  494.           <td class="paramkey"></td>
    495. 

  495.           <td></td>
    496. 

  496.           <td class="paramtype">const char *&#160;</td>
    497. 

  497.           <td class="paramname"><em>filename</em>, </td>
    498. 

  498.         </tr>
    499. 

  499.         <tr>
    500. 

  500.           <td class="paramkey"></td>
    501. 

  501.           <td></td>
    502. 

  502.           <td class="paramtype">const uint8_t *&#160;</td>
    503. 

  503.           <td class="paramname"><em>buffer</em>, </td>
    504. 

  504.         </tr>
    505. 

  505.         <tr>
    506. 

  506.           <td class="paramkey"></td>
    507. 

  507.           <td></td>
    508. 

  508.           <td class="paramtype">size_t&#160;</td>
    509. 

  509.           <td class="paramname"><em>length</em>&#160;</td>
    510. 

  510.         </tr>
    511. 

  511.         <tr>
    512. 

  512.           <td></td>
    513. 

  513.           <td>)</td>
    514. 

  514.           <td></td><td></td>
    515. 

  515.         </tr>
    516. 

  516.       </table>
    517. 

  517. </div><div class="memdoc">
    518. 

  518. <p>Start writing a buffer into a file in an asynchronous way.</p>
    519. 

  519. <dl class="params"><dt>Parameters</dt><dd>
    520. 

  520.   <table class="params">
    521. 

  521.     <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    522. 

  522.     <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>The name of the file to be read into memory. </td></tr>
    523. 

  523.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The buffer to be written. </td></tr>
    524. 

  524.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The number of bytes to be written. </td></tr>
    525. 

  525.   </table>
    526. 

  526.   </dd>
    527. 

  527. </dl>
    528. 

  528. <dl class="retval"><dt>Return values</dt><dd>
    529. 

  529.   <table class="retval">
    530. 

  530.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    531. 

  531.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error was encountered; such as the file was not found. </td></tr>
    532. 

  532.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated to hold the read data. </td></tr>
    533. 

  533.   </table>
    534. 

  534.   </dd>
    535. 

  535. </dl>
    536. 

  536. 

  537. </div>
    538. 

  538. </div>
    539. 

  539. <a id="ga11895786ad4495b81c8b0728dcae69bf"></a>
    540. 

  540. <h2 class="memtitle"><span class="permalink"><a href="#ga11895786ad4495b81c8b0728dcae69bf">&#9670;&nbsp;</a></span>ifapi_io_write_finish()</h2>
    541. 

  541. 

  542. <div class="memitem">
    543. 

  543. <div class="memproto">
    544. 

  544.       <table class="memname">
    545. 

  545.         <tr>
    546. 

  546.           <td class="memname">TSS2_RC ifapi_io_write_finish </td>
    547. 

  547.           <td>(</td>
    548. 

  548.           <td class="paramtype">struct <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    549. 

  549.           <td class="paramname"><em>io</em></td><td>)</td>
    550. 

  550.           <td></td>
    551. 

  551.         </tr>
    552. 

  552.       </table>
    553. 

  553. </div><div class="memdoc">
    554. 

  554. <p>Finish writing a buffer into a file in an asynchronous way.</p>
    555. 

  555. <p>This function needs to be called repeatedly until it does not return TSS2_FAPI_RC_TRY_AGAIN.</p>
    556. 

  556. <dl class="params"><dt>Parameters</dt><dd>
    557. 

  557.   <table class="params">
    558. 

  558.     <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    559. 

  559.   </table>
    560. 

  560.   </dd>
    561. 

  561. </dl>
    562. 

  562. <dl class="retval"><dt>Return values</dt><dd>
    563. 

  563.   <table class="retval">
    564. 

  564.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    565. 

  565.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error was encountered; such as the file was not found. </td></tr>
    566. 

  566.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the asynchronous operation is not yet complete. Call this function again later. </td></tr>
    567. 

  567.   </table>
    568. 

  568.   </dd>
    569. 

  569. </dl>
    570. 

  570. 

  571. </div>
    572. 

  572. </div>
    573. 

  573. </div><!-- contents -->
    574. 

  574. </div><!-- doc-content -->
    575. 

  575. <!-- start footer part -->
    576. 

  576. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    577. 

  577.   <ul>
    578. 

  578.     <li class="footer">Generated by
    579. 

  579.     <a href="http://www.doxygen.org/index.html">
    580. 

  580.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
    581. 

  581.   </ul>
    582. 

  582. </div>
    583. 

  583. </body>
    584. 

  584. </html>
    585.