Esys_NV_UndefineSpace(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 NAME — Esys_NV_UndefineSpace 💖

Okay bestie, welcome to the Library Functions Manual page for Esys_NV_UndefineSpace — the ESAPI function for the TPM2_NV_UndefineSpace command. We're evicting an NV Index from NV space and honestly? Main character energy. ✨

🎀 SYNOPSIS 🎀

💅 Functions

TSS2_RC Esys_NV_UndefineSpace_Async (ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_NV_UndefineSpace (ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_NV_UndefineSpace_Finish (ESYS_CONTEXT *esysContext)

🦋 Detailed Description 🦋

So like, this is the ESAPI function that invokes the TPM2_NV_UndefineSpace command — and you can run it either as a one-call or in an asynchronous manner. Pick your vibe, both are valid, no cap. 🌸

👑 Function Documentation 👑

🌈 TSS2_RC Esys_NV_UndefineSpace (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

One-Call function for TPM2_NV_UndefineSpace 💫

This one invokes the TPM2_NV_UndefineSpace command in a one-call variant. Meaning: the function will block until the TPM response is available. It is not ghosting you — it stays right there till it's done, periodt. 😭

All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation.

🧚 Parameters

  • esysContext — The ESYS_CONTEXT.
  • authHandle — TPM2_RH_OWNER or TPM2_RH_PLATFORM+{PP}.
  • nvIndex — The NV Index to remove from NV space.
  • shandle1 — Session handle for authorization of authHandle
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.

🔥 Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers or required output handle references are NULL.
  • TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
  • TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous operation already pending.
  • TSS2_ESYS_RC_INSUFFICIENT_RESPONSE if the TPM's response does not at least contain the tag, response length, and response code.
  • TSS2_ESYS_RC_MALFORMED_RESPONSE if the TPM's response is corrupted.
  • TSS2_ESYS_RC_RSP_AUTH_FAILED if the response HMAC from the TPM did not verify.
  • TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the 'decrypt' attribute bit set.
  • TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the 'encrypt' attribute bit set.
  • TSS2_ESYS_RC_BAD_TR if any of the ESYS_TR objects are unknown to the ESYS_CONTEXT or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE.
  • TSS2_ESYS_RC_NO_DECRYPT_PARAM if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter.
  • TSS2_ESYS_RC_NO_ENCRYPT_PARAM if one of the sessions has the 'encrypt' attribute set and the command does not support encryption of the first response parameter.
  • TSS2_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🌈 TSS2_RC Esys_NV_UndefineSpace_Async (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

Asynchronous function for TPM2_NV_UndefineSpace 🦋

This one invokes the TPM2_NV_UndefineSpace command in an asynchronous variant. Meaning: it returns as soon as the command has been sent downwards the stack to the TPM — it says "okay sent it, byeee" and dips. 🙈 All input parameters are const.

In order to retrieve the TPM's response, call Esys_NV_UndefineSpace_Finish. Like, you have to come back for it, bestie, the response isn't gonna read itself. 💀

🧚 Parameters

  • esysContext — The ESYS_CONTEXT.
  • authHandle — TPM2_RH_OWNER or TPM2_RH_PLATFORM+{PP}.
  • nvIndex — The NV Index to remove from NV space.
  • shandle1 — Session handle for authorization of authHandle
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.

🔥 Return values

  • ESYS_RC_SUCCESS if the function call was a success.
  • TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers or required output handle references are NULL.
  • TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
  • TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.
  • TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the 'decrypt' attribute bit set.
  • TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the 'encrypt' attribute bit set.
  • TSS2_ESYS_RC_BAD_TR if any of the ESYS_TR objects are unknown to the ESYS_CONTEXT or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE.
  • TSS2_ESYS_RC_NO_DECRYPT_PARAM if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter.
  • TSS2_ESYS_RC_NO_ENCRYPT_PARAM if one of the sessions has the 'encrypt' attribute set and the command does not support encryption of the first response parameter.

🌈 TSS2_RC Esys_NV_UndefineSpace_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_NV_UndefineSpace 🎀

This is the one that comes back with the receipts. It returns the results of a TPM2_NV_UndefineSpace command invoked via Esys_NV_UndefineSpace_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 — lowkey convenient, ngl.

🧚 Parameters

  • esysContext — The ESYS_CONTEXT.

🔥 Return values

  • TSS2_RC_SUCCESS on success
  • ESYS_RC_SUCCESS if the function call was a success.
  • TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers or required output handle references are NULL.
  • TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
  • TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous operation already pending.
  • TSS2_ESYS_RC_TRY_AGAIN if the timeout counter expires before the TPM response is received.
  • TSS2_ESYS_RC_INSUFFICIENT_RESPONSE if the TPM's response does not at least contain the tag, response length, and response code.
  • TSS2_ESYS_RC_RSP_AUTH_FAILED if the response HMAC from the TPM did not verify.
  • TSS2_ESYS_RC_MALFORMED_RESPONSE if the TPM's response is corrupted.
  • TSS2_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🌟 Author 🌟

Generated automatically by Doxygen for tpm2-tss from the source code. Not me writing it by hand — the machines did that, slay. 🤖💅

Okay that's the whole page, bestie — every flag, every return value, every last crumb. Go forth and undefine that NV space. 🫶

tpm2-tss · Version 4.1.5 · Esys_NV_UndefineSpace(3) — mwah, that's the sign-off, love u, bye! 💖🎀🦋🌸

📦 where this page comes from