Fapi_Initialize(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

✨ NAME ✨

Fapi_Initialize — bestie, this is the glow-up moment where your FAPI context gets born 💅 (this page is from the tpm2-tss manual, section 3, and yes we're doing this)

🌸 SYNOPSIS 🌸

functions, aka the whole cast 🎀

TSS2_RC Fapi_Initialize (FAPI_CONTEXT **context, char const *uri)
TSS2_RC Fapi_Initialize_Async (FAPI_CONTEXT **context, char const *uri)
TSS2_RC Fapi_Initialize_Finish (FAPI_CONTEXT **context)

🦋 Detailed Description 🦋

okay so these are the FAPI functions that let you invoke Initialize — either as a one-call situation (efficient queen ✨) or in an asynchronous manner (main character who needs a minute, valid 💅).

💖 Function Documentation 💖

⭐ TSS2_RC Fapi_Initialize (FAPI_CONTEXT ** context, char const * uri)

One-Call function for Fapi_Initialize. literally the whole thing in one go, no cap.

It initializes a FAPI_CONTEXT that holds all the state and metadata information during an interaction with the TPM. like, that context is carrying everything 🫶

🎀 Parameters

  • context — The FAPI_CONTEXT
  • uri — Unused in this version of the FAPI. Must be NULL. (yes bestie, NULL. it's giving "we left it there for future us" 🙈)

💫 Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_FAPI_RC_BAD_REFERENCE if context is NULL.
  • TSS2_FAPI_RC_BAD_VALUE if uri is not NULL.
  • TSS2_FAPI_RC_IO_ERROR if the data cannot be saved.
  • TSS2_FAPI_RC_MEMORY if the FAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_FAPI_RC_TRY_AGAIN if an I/O operation is not finished yet and this function needs to be called again.
  • TSS2_FAPI_RC_BAD_SEQUENCE if the context has an asynchronous operation already pending.
  • TSS2_FAPI_RC_GENERAL_FAILURE if an internal error occurred.
  • TSS2_FAPI_RC_BAD_PATH if a path is used in inappropriate context or contains illegal characters.
  • TSS2_ESYS_RC_* possible error codes of ESAPI.

⭐ TSS2_RC Fapi_Initialize_Async (FAPI_CONTEXT ** context, char const * uri)

Asynchronous function for Fapi_Initialize. the "we're doing this but like, on our own timeline" version 💅

It initializes a FAPI_CONTEXT that holds all the state and metadata information during an interaction with the TPM.

call Fapi_Initialize to finish the execution of this command — don't leave it hanging bestie 😭

🎀 Parameters

  • context — The FAPI_CONTEXT
  • uri — Unused in this version of the FAPI. Must be NULL.

💫 Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_FAPI_RC_BAD_REFERENCE if context is NULL.
  • TSS2_FAPI_RC_BAD_VALUE if uri is not NULL.
  • TSS2_FAPI_RC_IO_ERROR if the data cannot be saved.
  • TSS2_FAPI_RC_MEMORY if the FAPI cannot allocate enough memory for internal operations or return parameters.

⭐ TSS2_RC Fapi_Initialize_Finish (FAPI_CONTEXT ** context)

Asynchronous finish function for Fapi_Initialize. the closing act, the final bow 👑

This function should be called after a previous Fapi_Initialize_Async.

🎀 Parameters

  • context — The FAPI_CONTEXT

💫 Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_FAPI_RC_BAD_REFERENCE if context is NULL.
  • TSS2_FAPI_RC_BAD_CONTEXT if context corruption is detected.
  • TSS2_FAPI_RC_BAD_SEQUENCE if the context has an asynchronous operation already pending.
  • TSS2_FAPI_RC_IO_ERROR if the data cannot be saved.
  • TSS2_FAPI_RC_MEMORY if the FAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_FAPI_RC_TRY_AGAIN if the asynchronous operation is not yet complete. Call this function again later.
  • TSS2_FAPI_RC_BAD_VALUE if an invalid value was passed into the function.
  • TSS2_FAPI_RC_GENERAL_FAILURE if an internal error occurred.
  • TSS2_FAPI_RC_BAD_PATH if a path is used in inappropriate context or contains illegal characters.
  • TSS2_ESYS_RC_* possible error codes of ESAPI.

🌈 Author 🌈

Generated automatically by Doxygen for tpm2-tss from the source code. (the robot did the typing, we just did the vibes ✨)

okay that's the whole page bestie, you ate that 🫶 this was tpm2-tss Version 4.1.5, page Fapi_Initialize(3) — mwah, go initialize something iconic 💜

📦 where this page comes from