group___fapi___get_tcti.html 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  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: Fapi_GetTcti</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___fapi___get_tcti.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">Fapi_GetTcti<div class="ingroups"><a class="el" href="group__fapi.html">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:ga9a248ca883c12f37101705870cc7932e"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_tcti.html#ga9a248ca883c12f37101705870cc7932e">Fapi_GetTcti</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, TSS2_TCTI_CONTEXT **tcti)</td></tr>
  73. <tr class="separator:ga9a248ca883c12f37101705870cc7932e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. </table>
  75. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  76. <p>FAPI function to retrieve the TSS2_TCTI_CONTEXT currently used by the corresponding <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a>. </p>
  77. <h2 class="groupheader">Function Documentation</h2>
  78. <a id="ga9a248ca883c12f37101705870cc7932e"></a>
  79. <h2 class="memtitle"><span class="permalink"><a href="#ga9a248ca883c12f37101705870cc7932e">&#9670;&nbsp;</a></span>Fapi_GetTcti()</h2>
  80. <div class="memitem">
  81. <div class="memproto">
  82. <table class="memname">
  83. <tr>
  84. <td class="memname">Fapi_GetTcti </td>
  85. <td>(</td>
  86. <td class="paramtype"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *&#160;</td>
  87. <td class="paramname"><em>context</em>, </td>
  88. </tr>
  89. <tr>
  90. <td class="paramkey"></td>
  91. <td></td>
  92. <td class="paramtype">TSS2_TCTI_CONTEXT **&#160;</td>
  93. <td class="paramname"><em>tcti</em>&#160;</td>
  94. </tr>
  95. <tr>
  96. <td></td>
  97. <td>)</td>
  98. <td></td><td></td>
  99. </tr>
  100. </table>
  101. </div><div class="memdoc">
  102. <p>One-Call function for Fapi_GetTcti</p>
  103. <p>Fapi_GetTcti returns the TSS2_TCTI_CONTEXT currently used by the provided <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a>. The purpose is to enable advanced access to the TPM that is currently being talked to. It is especially useful in combination with <a class="el" href="group___fapi___get_tpm_blobs.html#ga2a93c04f04e6f84bd38dba811366ebf6">Fapi_GetTpmBlobs()</a>.</p>
  104. <p>Note: The application must ensure that this TSS2_TCTI_CONTEXT is not being used in parallel to the processing of a FAPI command.</p>
  105. <dl class="params"><dt>Parameters</dt><dd>
  106. <table class="params">
  107. <tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>The <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> </td></tr>
  108. <tr><td class="paramdir">[out]</td><td class="paramname">tcti</td><td>The TSS2_TCTI_CONTEXT used to talk to the current TPM.</td></tr>
  109. </table>
  110. </dd>
  111. </dl>
  112. <dl class="retval"><dt>Return values</dt><dd>
  113. <table class="retval">
  114. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
  115. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context, tcti is NULL. </td></tr>
  116. <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
  117. <tr><td class="paramname">TSS2_FAPI_RC_NO_TPM</td><td>if FAPI was started in non-TPM mode. </td></tr>
  118. </table>
  119. </dd>
  120. </dl>
  121. </div>
  122. </div>
  123. </div><!-- contents -->
  124. </div><!-- doc-content -->
  125. <!-- start footer part -->
  126. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  127. <ul>
  128. <li class="footer">Generated by
  129. <a href="http://www.doxygen.org/index.html">
  130. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  131. </ul>
  132. </div>
  133. </body>
  134. </html>