Fapi_NvExtend(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Fapi_NvExtend(3) — the NV-extend glow-up, FAPI edition

okay bestie, buckle up 🎀 this is the manual page for Fapi_NvExtend, living in section 3 of the library functions manual, and it's basically the "extend a thing onto an NV index" starter pack. two ways to run it: the one-call way, or the async way. both slay. let's go ✨

🌸 NAME

Fapi_NvExtend — literally just Fapi_NvExtend, no cap. that's the whole name. iconic minimalism 💅

🦋 SYNOPSIS

✨ Functions

TSS2_RC Fapi_NvExtend (FAPI_CONTEXT *context, char const *path, uint8_t
    const *data, size_t size, char const *logData)
TSS2_RC Fapi_NvExtend_Async (FAPI_CONTEXT *context, char const *path,
    uint8_t const *data, size_t size, char const *logData)
TSS2_RC Fapi_NvExtend_Finish (FAPI_CONTEXT *context)

🌈 Detailed Description

so these are FAPI functions that let you invoke NvExtend — either as a one-call situation, or asynchronously, if that's your vibe. both paths exist, pick your fighter 🫶

👑 Function Documentation

💖 TSS2_RC Fapi_NvExtend (FAPI_CONTEXT * context, char const * nvPath, uint8_t const * data, size_t dataSize, char const * logData)

One-Call function for Fapi_NvExtend — the "do it all in one go, no follow-up needed" option 💫

It performs an extend operation on an NV index that has the type extend. that's the whole assignment, and it ate 🔥

🍓 Parameters

  • context — the FAPI context
  • nvPath — the path to the NV index that is being extended
  • data — the data to extend on the NV index
  • dataSize — the size of the data to extend. Must be smaller than 1024
  • logData — a JSON representation of the data that is written to the event log. May be NULL

💀 Return values

  • TSS2_RC_SUCCESS — if the function call was a success 💖
  • TSS2_FAPI_RC_BAD_REFERENCE — if context, nvPath, or data 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 is not an extendable index
  • 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_BAD_VALUE — if an invalid value was passed into the function
  • 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_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_NvExtend_Async (FAPI_CONTEXT * context, char const * nvPath, uint8_t const * data, size_t dataSize, char const * logData)

Asynchronous function for Fapi_NvExtend — for when you like a little suspense in your life 😭

It performs an extend operation on an NV index with the type extend. same energy, different scheduling.

👀 heads up bestie: call Fapi_NvExtend_Finish to finish the execution of this command. don't leave it hanging, that's rude.

🍓 Parameters

  • context — the FAPI context
  • nvPath — the path to the NV index that is extended
  • data — the data to extend on the NV index
  • dataSize — the size of the data to extend. Must be smaller than 1024
  • logData — a JSON representation of the data that is written to the event log. May be NULL

💀 Return values

  • TSS2_RC_SUCCESS — if the function call was a success 💖
  • TSS2_FAPI_RC_BAD_REFERENCE — if context, nvPath, or data is NULL
  • TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected
  • TSS2_FAPI_RC_BAD_VALUE — if dataSize is larger than 1024
  • TSS2_FAPI_RC_BAD_PATH — if nvPath is not found
  • TSS2_FAPI_RC_NV_WRONG_TYPE — if the NV is not an extendable index
  • 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_NOT_PROVISIONED — FAPI was not provisioned

🎀 TSS2_RC Fapi_NvExtend_Finish (FAPI_CONTEXT * context)

Asynchronous finish function for Fapi_NvExtend — the part two, the finale, the closing number 💫

This function should be called after a previous Fapi_NvExtend.

🍓 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. (yes, a robot wrote it. and honestly? it understood the assignment 🤖💅)

🫶 okay that's the whole page, go extend something gorgeous and remember: dataSize smaller than 1024, logData may be NULL, and always finish your async calls. mwah 💋

tpm2-tss · Version 4.1.5 · Fapi_NvExtend(3) — that's the whole footer vibe, catch you in the next man page bestie, slay 🌈✨🦋

📦 where this page comes from