Fapi_NvIncrement(3)

💖 Fapi_NvIncrement(3) — Library Functions Manual 💖

okay so bestie, welcome to Fapi_NvIncrement(3) from the Library Functions Manual — she's cute, she's niche, and she increments NV counters by exactly 1. no cap. ✨

---

🌸 NAME 🌸

Fapi_NvIncrement — Fapi_NvIncrement

yes, the name is the name twice. she said “I am the brand,” and honestly? iconic. 👑

---

✨ SYNOPSIS ✨

🦋 Functions 🦋

TSS2_RC Fapi_NvIncrement (FAPI_CONTEXT *context, char const *path)
TSS2_RC Fapi_NvIncrement_Async (FAPI_CONTEXT *context, char const *path)
TSS2_RC Fapi_NvIncrement_Finish (FAPI_CONTEXT *context)

---

🌈 Detailed Description 🌈

The FAPI functions here are for invoking NvIncrement either as a one-call or in an asynchronous manner. two modes, one little increment, whole lotta FAPI energy. 💫

---

💅 Function Documentation 💅

⭐ TSS2_RC Fapi_NvIncrement (FAPI_CONTEXT * context, char const * nvPath)

TSS2_RC Fapi_NvIncrement (FAPI_CONTEXT * context, char const * nvPath)

This is the One-Call function for Fapi_NvIncrement. she increments an NV index that is a counter by 1. just +1, bestie, that's the whole assignment. 🎀

🎀 Parameters 🎀

• context — The FAPI_CONTEXT.
• nvPath — The path to the NV index that is incremented.

💖 Return values 💖

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or nvPath is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_PATH — if nvPath is not found.
• TSS2_FAPI_RC_NV_WRONG_TYPE — if the NV index type is not TPM2_NT_COUNTER.
• TSS2_FAPI_RC_NV_NOT_WRITEABLE — if the NV index is not writeable.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if the policy is unknown.
• 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_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• 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_GENERAL_FAILURE — if an internal error occurred.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

🦋 TSS2_RC Fapi_NvIncrement_Async (FAPI_CONTEXT * context, char const * nvPath)

TSS2_RC Fapi_NvIncrement_Async (FAPI_CONTEXT * context, char const * nvPath)

This is the Asynchronous function for Fapi_NvIncrement. same increment-by-1 agenda, just async-flavored. it increments an NV index that is a counter by 1. 🦋

Call Fapi_NvIncrement_Finish to finish the execution of this command. don't leave her hanging, bestie. 💅

🌸 Parameters 🌸

• context — The FAPI_CONTEXT.
• nvPath — The path to the NV index that is incremented.

✨ Return values ✨

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or nvPath is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_PATH — if nvPath is not found.
• TSS2_FAPI_RC_NV_WRONG_TYPE — if the NV index type is not TPM2_NT_COUNTER.
• TSS2_FAPI_RC_NV_NOT_WRITEABLE — if the NV index is not writeable.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if the policy is unknown.
• 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_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

👑 TSS2_RC Fapi_NvIncrement_Finish (FAPI_CONTEXT * context)

TSS2_RC Fapi_NvIncrement_Finish (FAPI_CONTEXT * context)

This is the Asynchronous finish function for Fapi_NvIncrement. she's the sequel. this function should be called after a previous Fapi_NvIncrement_Async. periodt. 👑

🫶 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_PATH — if a path is used in inappropriate context or contains illegal characters.
• 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_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

🧚 Author 🧚

Generated automatically by Doxygen for tpm2-tss from the source code. auto-generated and still serving looks, we love to see it. 💖

---

that's the whole page, bestie. this iconic little document is from tpm2-tss, Version 4.1.5, and it's the Fapi_NvIncrement(3) manual page — Library Functions Manual energy, no cap. 💅✨