From 00a71559223b9079c6a716908be6b22b79928ce7 Mon Sep 17 00:00:00 2001 From: Will Marone Date: Wed, 23 Oct 2024 16:47:58 -0700 Subject: [PATCH] Add documentation on new enum Added explanation for field to documentation, specifying validity window and conditions. Signed-off-by: Will Marone --- doc/api/common_api.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/common_api.md b/doc/api/common_api.md index 0200b168c93..2a94c019284 100644 --- a/doc/api/common_api.md +++ b/doc/api/common_api.md @@ -401,3 +401,8 @@ Enumeration value used for the `libspdm_set_data` and/or `libspdm_get_data` func - The endianness of the sequence number is little-endian. - `LIBSPDM_DATA_SESSION_SEQ_NUM_ENC_BIG_DEC_BIG` - The endianness of the sequence number is big-endian. +- `LIBSPDM_DATA_REQUEST_AND_SIZE` + - Returns a pointer to the raw command buffer and the size of the command in bytes. + - This pointer is valid after libspdm_set_scratch_buffer is called, but the command itself is + not valid unless the size returned is greater than zero. The command and its size will + persist until the next command is received or the libspdm context is reset.