Home Explore Help
Sign In
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
csu3_am335x
/
EVSE
/
GPL
/
tpm2-tss-3.2.0
/
doxygen-doc
/
html
/
group__ifapi__policy__callbacks.html

group__ifapi__policy__callbacks.html 34 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630 
  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: Policy callback functions.</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__policy__callbacks.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">Policy callback functions.<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:gac886bf2a0cd070979c90bc4423e3d343"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#gac886bf2a0cd070979c90bc4423e3d343">ifapi_branch_selection</a> (<a class="el" href="struct_t_p_m_l___p_o_l_i_c_y_b_r_a_n_c_h_e_s.html">TPML_POLICYBRANCHES</a> *branches, size_t *branch_idx, void *userdata)</td></tr>
    73. 

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

  74. <tr class="memitem:ga10715ee791f9a8a37c071cafa85dc7e1"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#ga10715ee791f9a8a37c071cafa85dc7e1">ifapi_exec_auth_nv_policy</a> (TPM2B_NV_PUBLIC *nv_public, TPMI_ALG_HASH hash_alg, void *userdata)</td></tr>
    75. 

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

  76. <tr class="memitem:gaf778195543972a79fc9ab0b6756e97ef"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#gaf778195543972a79fc9ab0b6756e97ef">ifapi_get_duplicate_name</a> (TPM2B_NAME *name, void *userdata)</td></tr>
    77. 

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

  78. <tr class="memitem:ga297e58a7ce5c56556862ec819e2dafd4"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#ga297e58a7ce5c56556862ec819e2dafd4">ifapi_get_key_public</a> (const char *path, TPMT_PUBLIC *public, void *ctx)</td></tr>
    79. 

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

  80. <tr class="memitem:gadb0fadb64aeee337839ba64cca0ffd78"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#gadb0fadb64aeee337839ba64cca0ffd78">ifapi_get_nv_public</a> (const char *path, TPM2B_NV_PUBLIC *nv_public, void *ctx)</td></tr>
    81. 

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

  82. <tr class="memitem:ga7b6fe64874f104dd78e2bf52daa552ab"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#ga7b6fe64874f104dd78e2bf52daa552ab">ifapi_get_object_name</a> (const char *path, TPM2B_NAME *name, void *ctx)</td></tr>
    83. 

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

  84. <tr class="memitem:gadd7eb66246e0cf577e7483d982327b8e"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#gadd7eb66246e0cf577e7483d982327b8e">ifapi_policy_action</a> (const char *action, void *userdata)</td></tr>
    85. 

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

  86. <tr class="memitem:ga0b46c66ee5f543af5eecca6373c2a6e4"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#ga0b46c66ee5f543af5eecca6373c2a6e4">ifapi_policyeval_cbauth</a> (TPM2B_NAME *name, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> *object_handle, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> *auth_handle, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> *authSession, void *userdata)</td></tr>
    87. 

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

  88. <tr class="memitem:gaf73e9ba8195cf4e4a0133d66f18009da"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__callbacks.html#gaf73e9ba8195cf4e4a0133d66f18009da">ifapi_read_pcr</a> (TPMS_PCR_SELECT *pcr_select, TPML_PCR_SELECTION *pcr_selection, <a class="el" href="struct_t_p_m_l___p_c_r_v_a_l_u_e_s.html">TPML_PCRVALUES</a> **pcr_values, void *ctx)</td></tr>
    89. 

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

  90. </table>
    91. 

  91. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    92. 

  92. <p>Provides internal callbacks functions for policy execution. </p>
    93. 

  93. <h2 class="groupheader">Function Documentation</h2>
    94. 

  94. <a id="gac886bf2a0cd070979c90bc4423e3d343"></a>
    95. 

  95. <h2 class="memtitle"><span class="permalink"><a href="#gac886bf2a0cd070979c90bc4423e3d343">&#9670;&nbsp;</a></span>ifapi_branch_selection()</h2>
    96. 

  96. 

  97. <div class="memitem">
    98. 

  98. <div class="memproto">
    99. 

  99.       <table class="memname">
    100. 

  100.         <tr>
    101. 

  101.           <td class="memname">TSS2_RC ifapi_branch_selection </td>
    102. 

  102.           <td>(</td>
    103. 

  103.           <td class="paramtype"><a class="el" href="struct_t_p_m_l___p_o_l_i_c_y_b_r_a_n_c_h_e_s.html">TPML_POLICYBRANCHES</a> *&#160;</td>
    104. 

  104.           <td class="paramname"><em>branches</em>, </td>
    105. 

  105.         </tr>
    106. 

  106.         <tr>
    107. 

  107.           <td class="paramkey"></td>
    108. 

  108.           <td></td>
    109. 

  109.           <td class="paramtype">size_t *&#160;</td>
    110. 

  110.           <td class="paramname"><em>branch_idx</em>, </td>
    111. 

  111.         </tr>
    112. 

  112.         <tr>
    113. 

  113.           <td class="paramkey"></td>
    114. 

  114.           <td></td>
    115. 

  115.           <td class="paramtype">void *&#160;</td>
    116. 

  116.           <td class="paramname"><em>userdata</em>&#160;</td>
    117. 

  117.         </tr>
    118. 

  118.         <tr>
    119. 

  119.           <td></td>
    120. 

  120.           <td>)</td>
    121. 

  121.           <td></td><td></td>
    122. 

  122.         </tr>
    123. 

  123.       </table>
    124. 

  124. </div><div class="memdoc">
    125. 

  125. <p>Callback for branch selection of policy or.</p>
    126. 

  126. <dl class="params"><dt>Parameters</dt><dd>
    127. 

  127.   <table class="params">
    128. 

  128.     <tr><td class="paramdir">[in]</td><td class="paramname">branches</td><td>The list of policy branches. </td></tr>
    129. 

  129.     <tr><td class="paramdir">[out]</td><td class="paramname">branch_idx</td><td>The index of the selcted branch. </td></tr>
    130. 

  130.     <tr><td class="paramdir">[in,out]</td><td class="paramname">userdata</td><td>The Fapi context which will be used for keystore access, and storing the policy execution state. the io state. </td></tr>
    131. 

  131.   </table>
    132. 

  132.   </dd>
    133. 

  133. </dl>
    134. 

  134. <dl class="retval"><dt>Return values</dt><dd>
    135. 

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

  136.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    137. 

  137.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context is NULL. </td></tr>
    138. 

  138.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if no branch selection callback is defined. This callback will be needed of or policies which have to be executed. </td></tr>
    139. 

  139.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the computed branch index delivered by the callback does not identify a branch. </td></tr>
    140. 

  140.   </table>
    141. 

  141.   </dd>
    142. 

  142. </dl>
    143. 

  143. 

  144. </div>
    145. 

  145. </div>
    146. 

  146. <a id="ga10715ee791f9a8a37c071cafa85dc7e1"></a>
    147. 

  147. <h2 class="memtitle"><span class="permalink"><a href="#ga10715ee791f9a8a37c071cafa85dc7e1">&#9670;&nbsp;</a></span>ifapi_exec_auth_nv_policy()</h2>
    148. 

  148. 

  149. <div class="memitem">
    150. 

  150. <div class="memproto">
    151. 

  151.       <table class="memname">
    152. 

  152.         <tr>
    153. 

  153.           <td class="memname">TSS2_RC ifapi_exec_auth_nv_policy </td>
    154. 

  154.           <td>(</td>
    155. 

  155.           <td class="paramtype">TPM2B_NV_PUBLIC *&#160;</td>
    156. 

  156.           <td class="paramname"><em>nv_public</em>, </td>
    157. 

  157.         </tr>
    158. 

  158.         <tr>
    159. 

  159.           <td class="paramkey"></td>
    160. 

  160.           <td></td>
    161. 

  161.           <td class="paramtype">TPMI_ALG_HASH&#160;</td>
    162. 

  162.           <td class="paramname"><em>hash_alg</em>, </td>
    163. 

  163.         </tr>
    164. 

  164.         <tr>
    165. 

  165.           <td class="paramkey"></td>
    166. 

  166.           <td></td>
    167. 

  167.           <td class="paramtype">void *&#160;</td>
    168. 

  168.           <td class="paramname"><em>userdata</em>&#160;</td>
    169. 

  169.         </tr>
    170. 

  170.         <tr>
    171. 

  171.           <td></td>
    172. 

  172.           <td>)</td>
    173. 

  173.           <td></td><td></td>
    174. 

  174.         </tr>
    175. 

  175.       </table>
    176. 

  176. </div><div class="memdoc">
    177. 

  177. <p>Callback for executing a policy identified by a digest stored in a nv object.</p>
    178. 

  178. <dl class="params"><dt>Parameters</dt><dd>
    179. 

  179.   <table class="params">
    180. 

  180.     <tr><td class="paramdir">[in]</td><td class="paramname">nv_public</td><td>the public data of the nv object which stores the digest of the authorized policy. </td></tr>
    181. 

  181.     <tr><td class="paramdir">[in]</td><td class="paramname">hash_alg</td><td>The hash algorithm used for policy computation. </td></tr>
    182. 

  182.     <tr><td class="paramdir">[in]</td><td class="paramname">userdata</td><td>The user context to retrieve the policy. </td></tr>
    183. 

  183.   </table>
    184. 

  184.   </dd>
    185. 

  185. </dl>
    186. 

  186. <dl class="retval"><dt>Return values</dt><dd>
    187. 

  187.   <table class="retval">
    188. 

  188.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    189. 

  189.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if it's not possible to allocate enough memory. </td></tr>
    190. 

  190.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>If no user data id passed or context stack is not initialized. </td></tr>
    191. 

  191.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>If an error occurs during access to the policy store. </td></tr>
    192. 

  192.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>If a policy for a certain path was not found. </td></tr>
    193. 

  193.     <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>If policy search for a certain policy digest was not successful. </td></tr>
    194. 

  194.     <tr><td class="paramname">TPM2_RC_BAD_AUTH</td><td>If the authentication for an object needed for policy execution fails. </td></tr>
    195. 

  195.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
    196. 

  196.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if an I/O operation is not finished yet and this function needs to be called again. </td></tr>
    197. 

  197.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    198. 

  198.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
    199. 

  199.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
    200. 

  200.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
    201. 

  201.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
    202. 

  202.     <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
    203. 

  203.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if the path is used in inappropriate context or contains illegal characters. </td></tr>
    204. 

  204.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    205. 

  205.   </table>
    206. 

  206.   </dd>
    207. 

  207. </dl>
    208. 

  208. 

  209. </div>
    210. 

  210. </div>
    211. 

  211. <a id="gaf778195543972a79fc9ab0b6756e97ef"></a>
    212. 

  212. <h2 class="memtitle"><span class="permalink"><a href="#gaf778195543972a79fc9ab0b6756e97ef">&#9670;&nbsp;</a></span>ifapi_get_duplicate_name()</h2>
    213. 

  213. 

  214. <div class="memitem">
    215. 

  215. <div class="memproto">
    216. 

  216.       <table class="memname">
    217. 

  217.         <tr>
    218. 

  218.           <td class="memname">TSS2_RC ifapi_get_duplicate_name </td>
    219. 

  219.           <td>(</td>
    220. 

  220.           <td class="paramtype">TPM2B_NAME *&#160;</td>
    221. 

  221.           <td class="paramname"><em>name</em>, </td>
    222. 

  222.         </tr>
    223. 

  223.         <tr>
    224. 

  224.           <td class="paramkey"></td>
    225. 

  225.           <td></td>
    226. 

  226.           <td class="paramtype">void *&#160;</td>
    227. 

  227.           <td class="paramname"><em>userdata</em>&#160;</td>
    228. 

  228.         </tr>
    229. 

  229.         <tr>
    230. 

  230.           <td></td>
    231. 

  231.           <td>)</td>
    232. 

  232.           <td></td><td></td>
    233. 

  233.         </tr>
    234. 

  234.       </table>
    235. 

  235. </div><div class="memdoc">
    236. 

  236. <p>Callback for getting the name of a key to be duplicated.</p>
    237. 

  237. <dl class="params"><dt>Parameters</dt><dd>
    238. 

  238.   <table class="params">
    239. 

  239.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>the name of the object to be duplicated. </td></tr>
    240. 

  240.     <tr><td class="paramdir">[in]</td><td class="paramname">userdata</td><td>The user context to retrieve the key. </td></tr>
    241. 

  241.   </table>
    242. 

  242.   </dd>
    243. 

  243. </dl>
    244. 

  244. <dl class="retval"><dt>Return values</dt><dd>
    245. 

  245.   <table class="retval">
    246. 

  246.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    247. 

  247.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if the context is not passed or the object to be duplicated is not set. </td></tr>
    248. 

  248.   </table>
    249. 

  249.   </dd>
    250. 

  250. </dl>
    251. 

  251. 

  252. </div>
    253. 

  253. </div>
    254. 

  254. <a id="ga297e58a7ce5c56556862ec819e2dafd4"></a>
    255. 

  255. <h2 class="memtitle"><span class="permalink"><a href="#ga297e58a7ce5c56556862ec819e2dafd4">&#9670;&nbsp;</a></span>ifapi_get_key_public()</h2>
    256. 

  256. 

  257. <div class="memitem">
    258. 

  258. <div class="memproto">
    259. 

  259.       <table class="memname">
    260. 

  260.         <tr>
    261. 

  261.           <td class="memname">TSS2_RC ifapi_get_key_public </td>
    262. 

  262.           <td>(</td>
    263. 

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

  264.           <td class="paramname"><em>path</em>, </td>
    265. 

  265.         </tr>
    266. 

  266.         <tr>
    267. 

  267.           <td class="paramkey"></td>
    268. 

  268.           <td></td>
    269. 

  269.           <td class="paramtype">TPMT_PUBLIC *&#160;</td>
    270. 

  270.           <td class="paramname"><em>public</em>, </td>
    271. 

  271.         </tr>
    272. 

  272.         <tr>
    273. 

  273.           <td class="paramkey"></td>
    274. 

  274.           <td></td>
    275. 

  275.           <td class="paramtype">void *&#160;</td>
    276. 

  276.           <td class="paramname"><em>ctx</em>&#160;</td>
    277. 

  277.         </tr>
    278. 

  278.         <tr>
    279. 

  279.           <td></td>
    280. 

  280.           <td>)</td>
    281. 

  281.           <td></td><td></td>
    282. 

  282.         </tr>
    283. 

  283.       </table>
    284. 

  284. </div><div class="memdoc">
    285. 

  285. <p>Get public data of a key from keystore.</p>
    286. 

  286. <dl class="params"><dt>Parameters</dt><dd>
    287. 

  287.   <table class="params">
    288. 

  288.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The relative path of the key. </td></tr>
    289. 

  289.     <tr><td class="paramdir">[out]</td><td class="paramname">public</td><td>The caller allocated public structure. </td></tr>
    290. 

  290.     <tr><td class="paramdir">[in,out]</td><td class="paramname">ctx</td><td>The context to access io and keystore module and to store the io state. </td></tr>
    291. 

  291.   </table>
    292. 

  292.   </dd>
    293. 

  293. </dl>
    294. 

  294. <dl class="retval"><dt>Return values</dt><dd>
    295. 

  295.   <table class="retval">
    296. 

  296.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    297. 

  297.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be loaded. </td></tr>
    298. 

  298.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    299. 

  299.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_TEMPLATE</td><td>If the loaded template is not appropriate for this operation. </td></tr>
    300. 

  300.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
    301. 

  301.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if an I/O operation is not finished yet and this function needs to be called again. </td></tr>
    302. 

  302.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    303. 

  303.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
    304. 

  304.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
    305. 

  305.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
    306. 

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

  307.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    308. 

  308.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if the path is used in inappropriate context or contains illegal characters. </td></tr>
    309. 

  309.   </table>
    310. 

  310.   </dd>
    311. 

  311. </dl>
    312. 

  312. 

  313. </div>
    314. 

  314. </div>
    315. 

  315. <a id="gadb0fadb64aeee337839ba64cca0ffd78"></a>
    316. 

  316. <h2 class="memtitle"><span class="permalink"><a href="#gadb0fadb64aeee337839ba64cca0ffd78">&#9670;&nbsp;</a></span>ifapi_get_nv_public()</h2>
    317. 

  317. 

  318. <div class="memitem">
    319. 

  319. <div class="memproto">
    320. 

  320.       <table class="memname">
    321. 

  321.         <tr>
    322. 

  322.           <td class="memname">TSS2_RC ifapi_get_nv_public </td>
    323. 

  323.           <td>(</td>
    324. 

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

  325.           <td class="paramname"><em>path</em>, </td>
    326. 

  326.         </tr>
    327. 

  327.         <tr>
    328. 

  328.           <td class="paramkey"></td>
    329. 

  329.           <td></td>
    330. 

  330.           <td class="paramtype">TPM2B_NV_PUBLIC *&#160;</td>
    331. 

  331.           <td class="paramname"><em>nv_public</em>, </td>
    332. 

  332.         </tr>
    333. 

  333.         <tr>
    334. 

  334.           <td class="paramkey"></td>
    335. 

  335.           <td></td>
    336. 

  336.           <td class="paramtype">void *&#160;</td>
    337. 

  337.           <td class="paramname"><em>ctx</em>&#160;</td>
    338. 

  338.         </tr>
    339. 

  339.         <tr>
    340. 

  340.           <td></td>
    341. 

  341.           <td>)</td>
    342. 

  342.           <td></td><td></td>
    343. 

  343.         </tr>
    344. 

  344.       </table>
    345. 

  345. </div><div class="memdoc">
    346. 

  346. <p>Get public data of a NV object from keystore.</p>
    347. 

  347. <dl class="params"><dt>Parameters</dt><dd>
    348. 

  348.   <table class="params">
    349. 

  349.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The relative path of the NV object. </td></tr>
    350. 

  350.     <tr><td class="paramdir">[out]</td><td class="paramname">nv_public</td><td>The caller allocated public structure. </td></tr>
    351. 

  351.     <tr><td class="paramdir">[in,out]</td><td class="paramname">ctx</td><td>The context to access io and keystore module and to store the io state. </td></tr>
    352. 

  352.   </table>
    353. 

  353.   </dd>
    354. 

  354. </dl>
    355. 

  355. <dl class="retval"><dt>Return values</dt><dd>
    356. 

  356.   <table class="retval">
    357. 

  357.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    358. 

  358.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be loaded. </td></tr>
    359. 

  359.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    360. 

  360.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_TEMPLATE</td><td>If the loaded template is not appropriate for this operation. </td></tr>
    361. 

  361.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
    362. 

  362.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if an I/O operation is not finished yet and this function needs to be called again. </td></tr>
    363. 

  363.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    364. 

  364.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
    365. 

  365.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
    366. 

  366.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
    367. 

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

  368.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    369. 

  369.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if the path is used in inappropriate context or contains illegal characters. </td></tr>
    370. 

  370.   </table>
    371. 

  371.   </dd>
    372. 

  372. </dl>
    373. 

  373. 

  374. </div>
    375. 

  375. </div>
    376. 

  376. <a id="ga7b6fe64874f104dd78e2bf52daa552ab"></a>
    377. 

  377. <h2 class="memtitle"><span class="permalink"><a href="#ga7b6fe64874f104dd78e2bf52daa552ab">&#9670;&nbsp;</a></span>ifapi_get_object_name()</h2>
    378. 

  378. 

  379. <div class="memitem">
    380. 

  380. <div class="memproto">
    381. 

  381.       <table class="memname">
    382. 

  382.         <tr>
    383. 

  383.           <td class="memname">TSS2_RC ifapi_get_object_name </td>
    384. 

  384.           <td>(</td>
    385. 

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

  386.           <td class="paramname"><em>path</em>, </td>
    387. 

  387.         </tr>
    388. 

  388.         <tr>
    389. 

  389.           <td class="paramkey"></td>
    390. 

  390.           <td></td>
    391. 

  391.           <td class="paramtype">TPM2B_NAME *&#160;</td>
    392. 

  392.           <td class="paramname"><em>name</em>, </td>
    393. 

  393.         </tr>
    394. 

  394.         <tr>
    395. 

  395.           <td class="paramkey"></td>
    396. 

  396.           <td></td>
    397. 

  397.           <td class="paramtype">void *&#160;</td>
    398. 

  398.           <td class="paramname"><em>ctx</em>&#160;</td>
    399. 

  399.         </tr>
    400. 

  400.         <tr>
    401. 

  401.           <td></td>
    402. 

  402.           <td>)</td>
    403. 

  403.           <td></td><td></td>
    404. 

  404.         </tr>
    405. 

  405.       </table>
    406. 

  406. </div><div class="memdoc">
    407. 

  407. <p>Get TPM name of an object from key keystore.</p>
    408. 

  408. <dl class="params"><dt>Parameters</dt><dd>
    409. 

  409.   <table class="params">
    410. 

  410.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The relative path of the object. </td></tr>
    411. 

  411.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>The caller allocate public structure. </td></tr>
    412. 

  412.     <tr><td class="paramdir">[in,out]</td><td class="paramname">ctx</td><td>The context to access io and keystore module and to store the io state. </td></tr>
    413. 

  413.   </table>
    414. 

  414.   </dd>
    415. 

  415. </dl>
    416. 

  416. <dl class="retval"><dt>Return values</dt><dd>
    417. 

  417.   <table class="retval">
    418. 

  418.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    419. 

  419.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be loaded. </td></tr>
    420. 

  420.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    421. 

  421.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_TEMPLATE</td><td>If the loaded template is not appropriate for this operation. </td></tr>
    422. 

  422.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
    423. 

  423.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if an I/O operation is not finished yet and this function needs to be called again. </td></tr>
    424. 

  424.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    425. 

  425.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
    426. 

  426.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
    427. 

  427.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
    428. 

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

  429.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    430. 

  430.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if the path is used in inappropriate context or contains illegal characters. </td></tr>
    431. 

  431.   </table>
    432. 

  432.   </dd>
    433. 

  433. </dl>
    434. 

  434. 

  435. </div>
    436. 

  436. </div>
    437. 

  437. <a id="gadd7eb66246e0cf577e7483d982327b8e"></a>
    438. 

  438. <h2 class="memtitle"><span class="permalink"><a href="#gadd7eb66246e0cf577e7483d982327b8e">&#9670;&nbsp;</a></span>ifapi_policy_action()</h2>
    439. 

  439. 

  440. <div class="memitem">
    441. 

  441. <div class="memproto">
    442. 

  442.       <table class="memname">
    443. 

  443.         <tr>
    444. 

  444.           <td class="memname">TSS2_RC ifapi_policy_action </td>
    445. 

  445.           <td>(</td>
    446. 

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

  447.           <td class="paramname"><em>action</em>, </td>
    448. 

  448.         </tr>
    449. 

  449.         <tr>
    450. 

  450.           <td class="paramkey"></td>
    451. 

  451.           <td></td>
    452. 

  452.           <td class="paramtype">void *&#160;</td>
    453. 

  453.           <td class="paramname"><em>userdata</em>&#160;</td>
    454. 

  454.         </tr>
    455. 

  455.         <tr>
    456. 

  456.           <td></td>
    457. 

  457.           <td>)</td>
    458. 

  458.           <td></td><td></td>
    459. 

  459.         </tr>
    460. 

  460.       </table>
    461. 

  461. </div><div class="memdoc">
    462. 

  462. <p>Callback for policy action.</p>
    463. 

  463. <dl class="params"><dt>Parameters</dt><dd>
    464. 

  464.   <table class="params">
    465. 

  465.     <tr><td class="paramdir">[in]</td><td class="paramname">action</td><td>The name of the policy action. </td></tr>
    466. 

  466.     <tr><td class="paramdir">[in,out]</td><td class="paramname">userdata</td><td>The Fapi context which will be used for keystore access, and storing the policy execution state. the io state. </td></tr>
    467. 

  467.   </table>
    468. 

  468.   </dd>
    469. 

  469. </dl>
    470. 

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

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

  472.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    473. 

  473.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>If the callback for branch selection is not defined. This callback will be needed of or policies have to be executed. </td></tr>
    474. 

  474.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>If no user data is passed. </td></tr>
    475. 

  475.   </table>
    476. 

  476.   </dd>
    477. 

  477. </dl>
    478. 

  478. 

  479. </div>
    480. 

  480. </div>
    481. 

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

  482. <h2 class="memtitle"><span class="permalink"><a href="#ga0b46c66ee5f543af5eecca6373c2a6e4">&#9670;&nbsp;</a></span>ifapi_policyeval_cbauth()</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_policyeval_cbauth </td>
    489. 

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

  490.           <td class="paramtype">TPM2B_NAME *&#160;</td>
    491. 

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

  492.         </tr>
    493. 

  493.         <tr>
    494. 

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

  495.           <td></td>
    496. 

  496.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> *&#160;</td>
    497. 

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

  498.         </tr>
    499. 

  499.         <tr>
    500. 

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

  501.           <td></td>
    502. 

  502.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> *&#160;</td>
    503. 

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

  504.         </tr>
    505. 

  505.         <tr>
    506. 

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

  507.           <td></td>
    508. 

  508.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> *&#160;</td>
    509. 

  509.           <td class="paramname"><em>authSession</em>, </td>
    510. 

  510.         </tr>
    511. 

  511.         <tr>
    512. 

  512.           <td class="paramkey"></td>
    513. 

  513.           <td></td>
    514. 

  514.           <td class="paramtype">void *&#160;</td>
    515. 

  515.           <td class="paramname"><em>userdata</em>&#160;</td>
    516. 

  516.         </tr>
    517. 

  517.         <tr>
    518. 

  518.           <td></td>
    519. 

  519.           <td>)</td>
    520. 

  520.           <td></td><td></td>
    521. 

  521.         </tr>
    522. 

  522.       </table>
    523. 

  523. </div><div class="memdoc">
    524. 

  524. <p>Callback for authorization of objects used by policy.</p>
    525. 

  525. <dl class="params"><dt>Parameters</dt><dd>
    526. 

  526.   <table class="params">
    527. 

  527.     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the object to be authorized. </td></tr>
    528. 

  528.     <tr><td class="paramdir">[in]</td><td class="paramname">object_handle</td><td>The ESYS handle of the used object. </td></tr>
    529. 

  529.     <tr><td class="paramdir">[in]</td><td class="paramname">auth_handle</td><td>will be used for object authorization. For keys it will we equal to the object handle. </td></tr>
    530. 

  530.     <tr><td class="paramdir">[out]</td><td class="paramname">authSession</td><td>The session used for object authorization. </td></tr>
    531. 

  531.     <tr><td class="paramdir">[in,out]</td><td class="paramname">userdata</td><td>The Fapi context which will be used for keystore access, and storing the policy execution state. the io state. </td></tr>
    532. 

  532.   </table>
    533. 

  533.   </dd>
    534. 

  534. </dl>
    535. 

  535. <dl class="retval"><dt>Return values</dt><dd>
    536. 

  536.   <table class="retval">
    537. 

  537.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    538. 

  538.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context or policy is NULL. </td></tr>
    539. 

  539.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
    540. 

  540.     <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>
    541. 

  541.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    542. 

  542.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>If a policy was not found. </td></tr>
    543. 

  543.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>If a key was not found. </td></tr>
    544. 

  544.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>If an IO error occurred during reading a policy or a key. </td></tr>
    545. 

  545.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>If an error in an used library occurred. </td></tr>
    546. 

  546.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
    547. 

  547.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
    548. 

  548.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
    549. 

  549.     <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>if policy search for a certain policy digest was not successful. </td></tr>
    550. 

  550.     <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
    551. 

  551.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if the path is used in inappropriate context or contains illegal characters. </td></tr>
    552. 

  552.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    553. 

  553.   </table>
    554. 

  554.   </dd>
    555. 

  555. </dl>
    556. 

  556. 

  557. </div>
    558. 

  558. </div>
    559. 

  559. <a id="gaf73e9ba8195cf4e4a0133d66f18009da"></a>
    560. 

  560. <h2 class="memtitle"><span class="permalink"><a href="#gaf73e9ba8195cf4e4a0133d66f18009da">&#9670;&nbsp;</a></span>ifapi_read_pcr()</h2>
    561. 

  561. 

  562. <div class="memitem">
    563. 

  563. <div class="memproto">
    564. 

  564.       <table class="memname">
    565. 

  565.         <tr>
    566. 

  566.           <td class="memname">TSS2_RC ifapi_read_pcr </td>
    567. 

  567.           <td>(</td>
    568. 

  568.           <td class="paramtype">TPMS_PCR_SELECT *&#160;</td>
    569. 

  569.           <td class="paramname"><em>pcr_select</em>, </td>
    570. 

  570.         </tr>
    571. 

  571.         <tr>
    572. 

  572.           <td class="paramkey"></td>
    573. 

  573.           <td></td>
    574. 

  574.           <td class="paramtype">TPML_PCR_SELECTION *&#160;</td>
    575. 

  575.           <td class="paramname"><em>pcr_selection</em>, </td>
    576. 

  576.         </tr>
    577. 

  577.         <tr>
    578. 

  578.           <td class="paramkey"></td>
    579. 

  579.           <td></td>
    580. 

  580.           <td class="paramtype"><a class="el" href="struct_t_p_m_l___p_c_r_v_a_l_u_e_s.html">TPML_PCRVALUES</a> **&#160;</td>
    581. 

  581.           <td class="paramname"><em>pcr_values</em>, </td>
    582. 

  582.         </tr>
    583. 

  583.         <tr>
    584. 

  584.           <td class="paramkey"></td>
    585. 

  585.           <td></td>
    586. 

  586.           <td class="paramtype">void *&#160;</td>
    587. 

  587.           <td class="paramname"><em>ctx</em>&#160;</td>
    588. 

  588.         </tr>
    589. 

  589.         <tr>
    590. 

  590.           <td></td>
    591. 

  591.           <td>)</td>
    592. 

  592.           <td></td><td></td>
    593. 

  593.         </tr>
    594. 

  594.       </table>
    595. 

  595. </div><div class="memdoc">
    596. 

  596. <p>Read values of PCR registers and clear selection.</p>
    597. 

  597. <dl class="params"><dt>Parameters</dt><dd>
    598. 

  598.   <table class="params">
    599. 

  599.     <tr><td class="paramdir">[in,out]</td><td class="paramname">pcr_select</td><td>The registers to be read (bank selection from profile). </td></tr>
    600. 

  600.     <tr><td class="paramdir">[in,out]</td><td class="paramname">pcr_selection</td><td>The registers to be read (with bank selection). </td></tr>
    601. 

  601.     <tr><td class="paramdir">[out]</td><td class="paramname">pcr_values</td><td>The callee-allocated public structure. </td></tr>
    602. 

  602.     <tr><td class="paramdir">[in,out]</td><td class="paramname">ctx</td><td>The context to access io and keystore module and to store the io state. </td></tr>
    603. 

  603.   </table>
    604. 

  604.   </dd>
    605. 

  605. </dl>
    606. 

  606. <dl class="retval"><dt>Return values</dt><dd>
    607. 

  607.   <table class="retval">
    608. 

  608.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    609. 

  609.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if the input parameters had inappropriate values. </td></tr>
    610. 

  610.     <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>
    611. 

  611.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
    612. 

  612.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    613. 

  613.   </table>
    614. 

  614.   </dd>
    615. 

  615. </dl>
    616. 

  616. 

  617. </div>
    618. 

  618. </div>
    619. 

  619. </div><!-- contents -->
    620. 

  620. </div><!-- doc-content -->
    621. 

  621. <!-- start footer part -->
    622. 

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

  623.   <ul>
    624. 

  624.     <li class="footer">Generated by
    625. 

  625.     <a href="http://www.doxygen.org/index.html">
    626. 

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

  627.   </ul>
    628. 

  628. </div>
    629. 

  629. </body>
    630. 

  630. </html>
    631.