Skip to content

Commit

Permalink
Add documentation on new enum
Browse files Browse the repository at this point in the history
Added explanation for field to documentation, specifying validity
window and conditions.

Signed-off-by: Will Marone <Will.Marone@amd.com>
  • Loading branch information
wmaroneAMD authored and jyao1 committed Oct 28, 2024
1 parent 7cc90cf commit 00a7155
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/api/common_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 00a7155

Please sign in to comment.