group__ifapi__eventlog.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>tpm2-tss: Event log utilities.</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20. </head>
  21. <body>
  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23. <div id="titlearea">
  24. <table cellspacing="0" cellpadding="0">
  25. <tbody>
  26. <tr style="height: 56px;">
  27. <td id="projectalign" style="padding-left: 0.5em;">
  28. <div id="projectname">tpm2-tss
  29. &#160;<span id="projectnumber">3.2.0</span>
  30. </div>
  31. <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
  32. </td>
  33. </tr>
  34. </tbody>
  35. </table>
  36. </div>
  37. <!-- end header part -->
  38. <!-- Generated by Doxygen 1.8.13 -->
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. $(function() {
  43. initMenu('',false,false,'search.php','Search');
  44. });
  45. </script>
  46. <div id="main-nav"></div>
  47. </div><!-- top -->
  48. <div id="side-nav" class="ui-resizable side-nav-resizable">
  49. <div id="nav-tree">
  50. <div id="nav-tree-contents">
  51. <div id="nav-sync" class="sync"></div>
  52. </div>
  53. </div>
  54. <div id="splitbar" style="-moz-user-select:none;"
  55. class="ui-resizable-handle">
  56. </div>
  57. </div>
  58. <script type="text/javascript">
  59. $(document).ready(function(){initNavTree('group__ifapi__eventlog.html','');});
  60. </script>
  61. <div id="doc-content">
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">Event log utilities.<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. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:ga5e89f103600a23fe7cd4b6dd4dc99ddd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga5e89f103600a23fe7cd4b6dd4dc99ddd">ifapi_cleanup_event</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t.html">IFAPI_EVENT</a> *event)</td></tr>
  73. <tr class="separator:ga5e89f103600a23fe7cd4b6dd4dc99ddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ga6ac8c0daf0f029cd3696a86d68c73219"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga6ac8c0daf0f029cd3696a86d68c73219">ifapi_eventlog_append_check</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io)</td></tr>
  75. <tr class="separator:ga6ac8c0daf0f029cd3696a86d68c73219"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga417170e7828a2ce3c141b87dbec6ca1d"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga417170e7828a2ce3c141b87dbec6ca1d">ifapi_eventlog_append_finish</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const <a class="el" href="struct_i_f_a_p_i___e_v_e_n_t.html">IFAPI_EVENT</a> *pcr_event)</td></tr>
  77. <tr class="separator:ga417170e7828a2ce3c141b87dbec6ca1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga9677fd20dc24c0bc3ddb4492aaac529d"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga9677fd20dc24c0bc3ddb4492aaac529d">ifapi_eventlog_get_async</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const TPM2_HANDLE *pcrList, size_t pcrListSize)</td></tr>
  79. <tr class="separator:ga9677fd20dc24c0bc3ddb4492aaac529d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga14c309bed3daccc393ac644c28e32efa"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga14c309bed3daccc393ac644c28e32efa">ifapi_eventlog_get_finish</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, char **log)</td></tr>
  81. <tr class="separator:ga14c309bed3daccc393ac644c28e32efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:gab2ade1bd7663318c8ff39f3bed986ff3"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#gab2ade1bd7663318c8ff39f3bed986ff3">ifapi_eventlog_initialize</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, const char *log_dir)</td></tr>
  83. <tr class="separator:gab2ade1bd7663318c8ff39f3bed986ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table>
  85. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  86. <p>Provides internal fapi functions for the handling of event logs </p>
  87. <h2 class="groupheader">Function Documentation</h2>
  88. <a id="ga5e89f103600a23fe7cd4b6dd4dc99ddd"></a>
  89. <h2 class="memtitle"><span class="permalink"><a href="#ga5e89f103600a23fe7cd4b6dd4dc99ddd">&#9670;&nbsp;</a></span>ifapi_cleanup_event()</h2>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">void ifapi_cleanup_event </td>
  95. <td>(</td>
  96. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t.html">IFAPI_EVENT</a> *&#160;</td>
  97. <td class="paramname"><em>event</em></td><td>)</td>
  98. <td></td>
  99. </tr>
  100. </table>
  101. </div><div class="memdoc">
  102. <p>Free allocated memory for an ifapi event.</p>
  103. <dl class="params"><dt>Parameters</dt><dd>
  104. <table class="params">
  105. <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>The structure to be cleaned up. </td></tr>
  106. </table>
  107. </dd>
  108. </dl>
  109. </div>
  110. </div>
  111. <a id="ga6ac8c0daf0f029cd3696a86d68c73219"></a>
  112. <h2 class="memtitle"><span class="permalink"><a href="#ga6ac8c0daf0f029cd3696a86d68c73219">&#9670;&nbsp;</a></span>ifapi_eventlog_append_check()</h2>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">TSS2_RC ifapi_eventlog_append_check </td>
  118. <td>(</td>
  119. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *&#160;</td>
  120. <td class="paramname"><em>eventlog</em>, </td>
  121. </tr>
  122. <tr>
  123. <td class="paramkey"></td>
  124. <td></td>
  125. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
  126. <td class="paramname"><em>io</em>&#160;</td>
  127. </tr>
  128. <tr>
  129. <td></td>
  130. <td>)</td>
  131. <td></td><td></td>
  132. </tr>
  133. </table>
  134. </div><div class="memdoc">
  135. <p>Check event log format before appending an event to the existing event log.</p>
  136. <p>Call after ifapi_eventlog_get_async.</p>
  137. <dl class="params"><dt>Parameters</dt><dd>
  138. <table class="params">
  139. <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
  140. <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The context area for the asynchronous io module. </td></tr>
  141. </table>
  142. </dd>
  143. </dl>
  144. <dl class="retval"><dt>Return values</dt><dd>
  145. <table class="retval">
  146. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
  147. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
  148. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
  149. <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the I/O operation is not finished yet and this function needs to be called again. </td></tr>
  150. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
  151. <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
  152. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  153. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
  154. </table>
  155. </dd>
  156. </dl>
  157. </div>
  158. </div>
  159. <a id="ga417170e7828a2ce3c141b87dbec6ca1d"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#ga417170e7828a2ce3c141b87dbec6ca1d">&#9670;&nbsp;</a></span>ifapi_eventlog_append_finish()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">TSS2_RC ifapi_eventlog_append_finish </td>
  166. <td>(</td>
  167. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *&#160;</td>
  168. <td class="paramname"><em>eventlog</em>, </td>
  169. </tr>
  170. <tr>
  171. <td class="paramkey"></td>
  172. <td></td>
  173. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
  174. <td class="paramname"><em>io</em>, </td>
  175. </tr>
  176. <tr>
  177. <td class="paramkey"></td>
  178. <td></td>
  179. <td class="paramtype">const <a class="el" href="struct_i_f_a_p_i___e_v_e_n_t.html">IFAPI_EVENT</a> *&#160;</td>
  180. <td class="paramname"><em>pcr_event</em>&#160;</td>
  181. </tr>
  182. <tr>
  183. <td></td>
  184. <td>)</td>
  185. <td></td><td></td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>Append an event to the existing event log.</p>
  190. <p>Call after ifapi_eventlog_get_async.</p>
  191. <dl class="params"><dt>Parameters</dt><dd>
  192. <table class="params">
  193. <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
  194. <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The context area for the asynchronous io module. </td></tr>
  195. <tr><td class="paramdir">[in]</td><td class="paramname">pcr_event</td><td>The event to be appended to the eventlog. </td></tr>
  196. </table>
  197. </dd>
  198. </dl>
  199. <dl class="retval"><dt>Return values</dt><dd>
  200. <table class="retval">
  201. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
  202. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
  203. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
  204. <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the I/O operation is not finished yet and this function needs to be called again. </td></tr>
  205. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
  206. <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
  207. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  208. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
  209. </table>
  210. </dd>
  211. </dl>
  212. </div>
  213. </div>
  214. <a id="ga9677fd20dc24c0bc3ddb4492aaac529d"></a>
  215. <h2 class="memtitle"><span class="permalink"><a href="#ga9677fd20dc24c0bc3ddb4492aaac529d">&#9670;&nbsp;</a></span>ifapi_eventlog_get_async()</h2>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <table class="memname">
  219. <tr>
  220. <td class="memname">TSS2_RC ifapi_eventlog_get_async </td>
  221. <td>(</td>
  222. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *&#160;</td>
  223. <td class="paramname"><em>eventlog</em>, </td>
  224. </tr>
  225. <tr>
  226. <td class="paramkey"></td>
  227. <td></td>
  228. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
  229. <td class="paramname"><em>io</em>, </td>
  230. </tr>
  231. <tr>
  232. <td class="paramkey"></td>
  233. <td></td>
  234. <td class="paramtype">const TPM2_HANDLE *&#160;</td>
  235. <td class="paramname"><em>pcrList</em>, </td>
  236. </tr>
  237. <tr>
  238. <td class="paramkey"></td>
  239. <td></td>
  240. <td class="paramtype">size_t&#160;</td>
  241. <td class="paramname"><em>pcrListSize</em>&#160;</td>
  242. </tr>
  243. <tr>
  244. <td></td>
  245. <td>)</td>
  246. <td></td><td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Retrieve the eventlog for a given list of pcrs using asynchronous io.</p>
  251. <p>Call ifapi_eventlog_get_finish to retrieve the results.</p>
  252. <dl class="params"><dt>Parameters</dt><dd>
  253. <table class="params">
  254. <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
  255. <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The context area for the asynchronous io module. </td></tr>
  256. <tr><td class="paramdir">[in]</td><td class="paramname">pcrList</td><td>The list of PCR indices to retrieve the log for. </td></tr>
  257. <tr><td class="paramdir">[in]</td><td class="paramname">pcrListSize</td><td>The size of pcrList. </td></tr>
  258. </table>
  259. </dd>
  260. </dl>
  261. <dl class="retval"><dt>Return values</dt><dd>
  262. <table class="retval">
  263. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
  264. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
  265. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
  266. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
  267. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
  268. </table>
  269. </dd>
  270. </dl>
  271. </div>
  272. </div>
  273. <a id="ga14c309bed3daccc393ac644c28e32efa"></a>
  274. <h2 class="memtitle"><span class="permalink"><a href="#ga14c309bed3daccc393ac644c28e32efa">&#9670;&nbsp;</a></span>ifapi_eventlog_get_finish()</h2>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">TSS2_RC ifapi_eventlog_get_finish </td>
  280. <td>(</td>
  281. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *&#160;</td>
  282. <td class="paramname"><em>eventlog</em>, </td>
  283. </tr>
  284. <tr>
  285. <td class="paramkey"></td>
  286. <td></td>
  287. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
  288. <td class="paramname"><em>io</em>, </td>
  289. </tr>
  290. <tr>
  291. <td class="paramkey"></td>
  292. <td></td>
  293. <td class="paramtype">char **&#160;</td>
  294. <td class="paramname"><em>log</em>&#160;</td>
  295. </tr>
  296. <tr>
  297. <td></td>
  298. <td>)</td>
  299. <td></td><td></td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>Retrieve the eventlog for a given list of pcrs using asynchronous io.</p>
  304. <p>Call after ifapi_eventlog_get_async.</p>
  305. <dl class="params"><dt>Parameters</dt><dd>
  306. <table class="params">
  307. <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
  308. <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The context area for the asynchronous io module. </td></tr>
  309. <tr><td class="paramdir">[out]</td><td class="paramname">log</td><td>The event log for the requested PCRs in JSON format </td></tr>
  310. </table>
  311. </dd>
  312. </dl>
  313. <dl class="retval"><dt>Return values</dt><dd>
  314. <table class="retval">
  315. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
  316. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
  317. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
  318. <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the I/O operation is not finished yet and this function needs to be called again. </td></tr>
  319. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
  320. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  321. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
  322. </table>
  323. </dd>
  324. </dl>
  325. </div>
  326. </div>
  327. <a id="gab2ade1bd7663318c8ff39f3bed986ff3"></a>
  328. <h2 class="memtitle"><span class="permalink"><a href="#gab2ade1bd7663318c8ff39f3bed986ff3">&#9670;&nbsp;</a></span>ifapi_eventlog_initialize()</h2>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">TSS2_RC ifapi_eventlog_initialize </td>
  334. <td>(</td>
  335. <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *&#160;</td>
  336. <td class="paramname"><em>eventlog</em>, </td>
  337. </tr>
  338. <tr>
  339. <td class="paramkey"></td>
  340. <td></td>
  341. <td class="paramtype">const char *&#160;</td>
  342. <td class="paramname"><em>log_dir</em>&#160;</td>
  343. </tr>
  344. <tr>
  345. <td></td>
  346. <td>)</td>
  347. <td></td><td></td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <p>Initialize the eventlog module of FAPI.</p>
  352. <dl class="params"><dt>Parameters</dt><dd>
  353. <table class="params">
  354. <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
  355. <tr><td class="paramdir">[in]</td><td class="paramname">log_dir</td><td>The directory where to put the eventlog data. </td></tr>
  356. </table>
  357. </dd>
  358. </dl>
  359. <dl class="retval"><dt>Return values</dt><dd>
  360. <table class="retval">
  361. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
  362. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
  363. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
  364. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
  365. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
  366. </table>
  367. </dd>
  368. </dl>
  369. </div>
  370. </div>
  371. </div><!-- contents -->
  372. </div><!-- doc-content -->
  373. <!-- start footer part -->
  374. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  375. <ul>
  376. <li class="footer">Generated by
  377. <a href="http://www.doxygen.org/index.html">
  378. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  379. </ul>
  380. </div>
  381. </body>
  382. </html>