Esys_PolicyNvWritten(3)

🌸 NAME 🌸

Esys_PolicyNvWritten(3) — okay bestie, this is the Library Functions Manual entry from tpm2-tss for Esys_PolicyNvWritten, and it is literally the ESAPI function for the TPM2_PolicyNvWritten command. That's the whole name vibe, no cap 💖.

✨ SYNOPSIS ✨

🧚 Functions 🧚

Here are the three function besties, exactly as they appear:

TSS2_RC Esys_PolicyNvWritten_Async (ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO writtenSet)
TSS2_RC Esys_PolicyNvWritten (ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO writtenSet)
TSS2_RC Esys_PolicyNvWritten_Finish (ESYS_CONTEXT *esysContext)

💫 Detailed Description 💫

It's the ESAPI function to invoke the TPM2_PolicyNvWritten command either as a one-call or in an asynchronous manner. Two paths, same command, pick your adventure ✨.

🌟 Function Documentation 🌟

💅 TSS2_RC Esys_PolicyNvWritten

One-Call function for TPM2_PolicyNvWritten.

Signature, verbatim:

TSS2_RC Esys_PolicyNvWritten (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO writtenSet)

This function invokes the TPM2_PolicyNvWritten command in a one-call variant. That means the function will block until the TPM response is available — yes bestie, it waits for the TPM to reply before it comes back. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation 🫶.

🌸 Parameters 🌸

• esysContext — the ESYS_CONTEXT.
• policySession — handle for the policy session being extended.
• shandle1 — first session handle.
• shandle2 — second session handle.
• shandle3 — third session handle.
• writtenSet — YES if NV Index is required to have been written.

⭐ 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_PolicyNvWritten_Async

Asynchronous function for TPM2_PolicyNvWritten.

Signature, verbatim:

TSS2_RC Esys_PolicyNvWritten_Async (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO writtenSet)

This function invokes the TPM2_PolicyNvWritten command in an 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_PolicyNvWritten_Finish 🦋.

🌸 Parameters 🌸

• esysContext — the ESYS_CONTEXT.
• policySession — handle for the policy session being extended.
• shandle1 — first session handle.
• shandle2 — second session handle.
• shandle3 — third session handle.
• writtenSet — YES if NV Index is required to have been written.

⭐ 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_PolicyNvWritten_Finish

Asynchronous finish function for TPM2_PolicyNvWritten.

Signature, verbatim:

TSS2_RC Esys_PolicyNvWritten_Finish (ESYS_CONTEXT * esysContext)

This function returns the results of a TPM2_PolicyNvWritten command invoked via Esys_PolicyNvWritten_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 💜.

🌸 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. Doxygen ate and left no crumbs, honestly ✨.

---

Okay bestie, that's the whole page — source is tpm2-tss, Version 4.1.5, page Esys_PolicyNvWritten(3). Mwah 💋✨