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
/
man
/
Esys_HierarchyControl.3

Esys_HierarchyControl.3 2.1 KB
Permalink History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 
  1. .TH "Esys_HierarchyControl" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
    2. 

  2. .ad l
    3. 

  3. .nh
    4. 

  4. .SH NAME
    5. 

  5. Esys_HierarchyControl
    6. 

  6. .SH SYNOPSIS
    7. 

  7. .br
    8. 

  8. .PP
    9. 

  9. .SS "Functions"
    10. 

  10. 

  11. .in +1c
    12. 

  12. .ti -1c
    13. 

  13. .RI "TSS2_RC \fBEsys_HierarchyControl_Finish\fP (\fBESYS_CONTEXT\fP *esysContext)"
    14. 

  14. .br
    15. 

  15. .in -1c
    16. 

  16. .SH "Detailed Description"
    17. 

  17. .PP 
    18. 

  18. ESAPI function to invoke the TPM2_HierarchyControl command either as a one-call or in an asynchronous manner\&. 
    19. 

  19. .SH "Function Documentation"
    20. 

  20. .PP 
    21. 

  21. .SS "TSS2_RC Esys_HierarchyControl_Finish (\fBESYS_CONTEXT\fP * esysContext)"
    22. 

  22. Asynchronous finish function for TPM2_HierarchyControl
    23. 

  23. .PP
    24. 

  24. This function returns the results of a TPM2_HierarchyControl command invoked via Esys_HierarchyControl_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\&.
    25. 

  25. .PP
    26. 

  26. \fBParameters:\fP
    27. 

  27. .RS 4
    28. 

  28. \fIesysContext\fP The \fBESYS_CONTEXT\fP\&. 
    29. 

  29. .RE
    30. 

  30. .PP
    31. 

  31. \fBReturn values:\fP
    32. 

  32. .RS 4
    33. 

  33. \fITSS2_RC_SUCCESS\fP on success 
    34. 

  34. .br
    35. 

  35. \fIESYS_RC_SUCCESS\fP if the function call was a success\&. 
    36. 

  36. .br
    37. 

  37. \fITSS2_ESYS_RC_BAD_REFERENCE\fP if the esysContext or required input pointers or required output handle references are NULL\&. 
    38. 

  38. .br
    39. 

  39. \fITSS2_ESYS_RC_BAD_CONTEXT\fP if esysContext corruption is detected\&. 
    40. 

  40. .br
    41. 

  41. \fITSS2_ESYS_RC_MEMORY\fP if the ESAPI cannot allocate enough memory for internal operations or return parameters\&. 
    42. 

  42. .br
    43. 

  43. \fITSS2_ESYS_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
    44. 

  44. .br
    45. 

  45. \fITSS2_ESYS_RC_TRY_AGAIN\fP if the timeout counter expires before the TPM response is received\&. 
    46. 

  46. .br
    47. 

  47. \fITSS2_ESYS_RC_INSUFFICIENT_RESPONSE\fP if the TPM's response does not at least contain the tag, response length, and response code\&. 
    48. 

  48. .br
    49. 

  49. \fITSS2_ESYS_RC_RSP_AUTH_FAILED\fP if the response HMAC from the TPM did not verify\&. 
    50. 

  50. .br
    51. 

  51. \fITSS2_ESYS_RC_MALFORMED_RESPONSE\fP if the TPM's response is corrupted\&. 
    52. 

  52. .br
    53. 

  53. \fITSS2_RCs\fP produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally\&. 
    54. 

  54. .RE
    55. 

  55. .PP
    56. 

  56. 

  57. .SH "Author"
    58. 

  58. .PP 
    59. 

  59. Generated automatically by Doxygen for tpm2-tss from the source code\&.
    60.