SoftwareDesign
/
csu3_am335x


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tpm2-tss: The ESAPI function for the TPM2_ReadPublic command.</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">tpm2-tss
   &#160;<span id="projectnumber">3.2.0</span>
   </div>
   <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group___esys___read_public.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">The ESAPI function for the TPM2_ReadPublic command.<div class="ingroups"><a class="el" href="group__esys.html">Enhanced System API</a> &raquo; <a class="el" href="group__esys__tpm.html">Esys TPM Commands</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga10fe3b8377e33a61b09c9771ccc0cdef"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___read_public.html#ga10fe3b8377e33a61b09c9771ccc0cdef">Esys_ReadPublic_Async</a> (<a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *esysContext, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> objectHandle, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle1, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle2, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle3)</td></tr>
<tr class="separator:ga10fe3b8377e33a61b09c9771ccc0cdef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a4c6ed2fc2cef7c1e4d8fae35dba71d"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___read_public.html#ga1a4c6ed2fc2cef7c1e4d8fae35dba71d">Esys_ReadPublic</a> (<a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *esysContext, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> objectHandle, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle1, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle2, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle3, TPM2B_PUBLIC **outPublic, TPM2B_NAME **name, TPM2B_NAME **qualifiedName)</td></tr>
<tr class="separator:ga1a4c6ed2fc2cef7c1e4d8fae35dba71d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7ddce48838c78294f2851154a17f4404"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___read_public.html#ga7ddce48838c78294f2851154a17f4404">Esys_ReadPublic_Finish</a> (<a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *esysContext, TPM2B_PUBLIC **outPublic, TPM2B_NAME **name, TPM2B_NAME **qualifiedName)</td></tr>
<tr class="separator:ga7ddce48838c78294f2851154a17f4404"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>ESAPI function to invoke the TPM2_ReadPublic command either as a one-call or in an asynchronous manner. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga1a4c6ed2fc2cef7c1e4d8fae35dba71d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1a4c6ed2fc2cef7c1e4d8fae35dba71d">&#9670;&nbsp;</a></span>Esys_ReadPublic()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TSS2_RC Esys_ReadPublic </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *&#160;</td>
          <td class="paramname"><em>esysContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
          <td class="paramname"><em>objectHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
          <td class="paramname"><em>shandle1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
          <td class="paramname"><em>shandle2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
          <td class="paramname"><em>shandle3</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TPM2B_PUBLIC **&#160;</td>
          <td class="paramname"><em>outPublic</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TPM2B_NAME **&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TPM2B_NAME **&#160;</td>
          <td class="paramname"><em>qualifiedName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>One-Call function for TPM2_ReadPublic</p>
<p>This function invokes the TPM2_ReadPublic command in a one-call variant. This means the function will block until the TPM response is available. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">esysContext</td><td>The <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a>. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">objectHandle</td><td>TPM handle of an object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">shandle1</td><td>First session handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">shandle2</td><td>Second session handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">shandle3</td><td>Third session handle. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">outPublic</td><td>Structure containing the public area of an object. (callee-allocated) </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Name of the object. (callee-allocated) </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">qualifiedName</td><td>The Qualified Name of the object. (callee-allocated) </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_REFERENCE</td><td>if the esysContext or required input pointers or required output handle references are NULL. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_CONTEXT</td><td>if esysContext corruption is detected. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MEMORY</td><td>if the ESAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_INSUFFICIENT_RESPONSE</td><td>if the TPM's response does not at least contain the tag, response length, and response code. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MALFORMED_RESPONSE</td><td>if the TPM's response is corrupted. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_RSP_AUTH_FAILED</td><td>if the response HMAC from the TPM did not verify. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS</td><td>if more than one session has the 'decrypt' attribute bit set. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS</td><td>if more than one session has the 'encrypt' attribute bit set. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_TR</td><td>if any of the ESYS_TR objects are unknown to the <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_NO_DECRYPT_PARAM</td><td>if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter. </td></tr>
    <tr><td class="paramname">TSS2_RCs</td><td>produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga10fe3b8377e33a61b09c9771ccc0cdef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga10fe3b8377e33a61b09c9771ccc0cdef">&#9670;&nbsp;</a></span>Esys_ReadPublic_Async()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TSS2_RC Esys_ReadPublic_Async </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *&#160;</td>
          <td class="paramname"><em>esysContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
          <td class="paramname"><em>objectHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
          <td class="paramname"><em>shandle1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
          <td class="paramname"><em>shandle2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
          <td class="paramname"><em>shandle3</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Asynchronous function for TPM2_ReadPublic</p>
<p>This function invokes the TPM2_ReadPublic command in a asynchronous variant. This means the function will return as soon as the command has been sent downwards the stack to the TPM. All input parameters are const. In order to retrieve the TPM's response call Esys_ReadPublic_Finish.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">esysContext</td><td>The <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a>. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">objectHandle</td><td>TPM handle of an object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">shandle1</td><td>First session handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">shandle2</td><td>Second session handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">shandle3</td><td>Third session handle. </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">ESYS_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_REFERENCE</td><td>if the esysContext or required input pointers or required output handle references are NULL. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_CONTEXT</td><td>if esysContext corruption is detected. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MEMORY</td><td>if the ESAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    <tr><td class="paramname">TSS2_RCs</td><td>produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS</td><td>if more than one session has the 'decrypt' attribute bit set. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS</td><td>if more than one session has the 'encrypt' attribute bit set. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_TR</td><td>if any of the ESYS_TR objects are unknown to the <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_NO_DECRYPT_PARAM</td><td>if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga7ddce48838c78294f2851154a17f4404"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7ddce48838c78294f2851154a17f4404">&#9670;&nbsp;</a></span>Esys_ReadPublic_Finish()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TSS2_RC Esys_ReadPublic_Finish </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *&#160;</td>
          <td class="paramname"><em>esysContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TPM2B_PUBLIC **&#160;</td>
          <td class="paramname"><em>outPublic</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TPM2B_NAME **&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TPM2B_NAME **&#160;</td>
          <td class="paramname"><em>qualifiedName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Asynchronous finish function for TPM2_ReadPublic</p>
<p>This function returns the results of a TPM2_ReadPublic command invoked via Esys_ReadPublic_Finish. All non-simple output parameters are allocated by the function's implementation. NULL can be passed for every output parameter if the value is not required.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">esysContext</td><td>The <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a>. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">outPublic</td><td>Structure containing the public area of an object. (callee-allocated) </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Name of the object. (callee-allocated) </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">qualifiedName</td><td>The Qualified Name of the object. (callee-allocated) </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success </td></tr>
    <tr><td class="paramname">ESYS_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_REFERENCE</td><td>if the esysContext or required input pointers or required output handle references are NULL. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_CONTEXT</td><td>if esysContext corruption is detected. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MEMORY</td><td>if the ESAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_TRY_AGAIN</td><td>if the timeout counter expires before the TPM response is received. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_INSUFFICIENT_RESPONSE</td><td>if the TPM's response does not at least contain the tag, response length, and response code. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_RSP_AUTH_FAILED</td><td>if the response HMAC from the TPM did not verify. </td></tr>
    <tr><td class="paramname">TSS2_ESYS_RC_MALFORMED_RESPONSE</td><td>if the TPM's response is corrupted. </td></tr>
    <tr><td class="paramname">TSS2_RCs</td><td>produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>