Skip to content

Commit a6a3ad1

Browse files
steven-bellockjyao1
authored andcommitted
Update documentation for the 3.3 release
Signed-off-by: Steven Bellock <[email protected]>
1 parent a284716 commit a6a3ad1

File tree

3 files changed

+34
-23
lines changed

3 files changed

+34
-23
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
SPDM 1.2: `GET_CSR`, `SET_CERTIFICATE`, `CHUNK_SEND`, and `CHUNK_GET`.
4040

41-
SPDM 1.3: No new commands are supported at this momemnt. No new SPDM 1.3 features are supported.
41+
SPDM 1.3: `GET_SUPPORTED_EVENT_TYPES`. Additional SPDM 1.3 messages will be implemented in future releases.
4242

4343
5) Cryptography Support
4444

@@ -67,7 +67,7 @@
6767

6868
Support to be included in [OpenBMC](https://github.com/openbmc). It is in planning, see [SPDM Integration](https://www.youtube.com/watch?v=PmgXkLJYI-E).
6969

70-
Support to be linked by other language. For example, [JAVA verifier](https://github.com/altera-opensource/verifier).
70+
Support to be linked by other languages. For example, [JAVA verifier](https://github.com/altera-opensource/verifier).
7171

7272
Support interoperability testing with other SPDM implementations. For example, [intel-server-prot-spdm](https://github.com/intel/intel-server-prot-spdm) and [spdm-rs](https://github.com/ccc-spdm-tools/spdm-rs).
7373

@@ -281,7 +281,7 @@ For other architectures, refer to [build](https://github.com/DMTF/libspdm/blob/m
281281

282282
### Other Tests
283283

284-
libspdm also supports other tests such as code coverage, fuzzing, symbolic execution, model checker.
284+
libspdm also supports other tests such as code coverage, fuzzing, symbolic execution, and model checker.
285285

286286
Refer to [test](https://github.com/DMTF/libspdm/blob/main/doc/test.md) for more details.
287287

doc/api/requester_api.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ If `true` then only the Responder direction secrets will updated. If `false` the
318318
direction and Requester direction secrets will be updated.
319319

320320
### Details
321-
TBD
321+
Before calling this function a secure session must first be established via `libspdm_start_session`.
322322

323323

324324
---
@@ -416,6 +416,36 @@ TBD
416416
<br/><br/>
417417

418418

419+
---
420+
### libspdm_get_event_types
421+
---
422+
423+
### Description
424+
Sends `GET_SUPPORTED_EVENT_TYPES` to retrieve the event types supported by the Responder.
425+
426+
### Parameters
427+
428+
**spdm_context**<br/>
429+
The SPDM context.
430+
431+
**session_id**<br/>
432+
The session through which the event types will be retrieved.
433+
434+
**event_group_count**<br/>
435+
The number of event groups in `supported_event_groups_list`.
436+
437+
**supported_event_groups_list_len**<br/>
438+
On input, indicates the size, in bytes, of the buffer in which the event groups list will be stored.
439+
On output, indicates the size, in bytes, of the event groups list.
440+
441+
**supported_event_groups_list**<br/>
442+
A pointer to a buffer to store the supported event groups list.
443+
444+
### Details
445+
Before calling this function a secure session must first be established via `libspdm_start_session`.
446+
<br/><br/>
447+
448+
419449
## Message Logging
420450
libspdm allows an Integrator to log request and response messages to an Integrator-provided buffer.
421451
It is currently only supported by a Requester. In the future it may be supported by a Responder, in

include/library/spdm_requester_lib.h

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -792,25 +792,6 @@ libspdm_return_t libspdm_get_event_types(void *spdm_context,
792792
uint8_t *event_group_count,
793793
uint32_t *supported_event_groups_list_len,
794794
void *supported_event_groups_list);
795-
796-
/** This function subscribes to the specified event types.
797-
*
798-
* This function can only be called after a secure session has been established with the device.
799-
*
800-
* @param spdm_context A pointer to the SPDM context.
801-
* @param session_id The session ID of the session.
802-
* @param subscribe_event_group_count The number of event groups in subscribe_list. If this value
803-
* is 0 then subscription to all events will be cleared and
804-
* subscribe_list_len must be 0 and subscribe_list must be
805-
* NULL.
806-
* @param subscribe_list_len The size, in bytes, of subscribe_list.
807-
* @param subscribe_list List of event types and event groups.
808-
**/
809-
libspdm_return_t libspdm_subscribe_event_types(void *spdm_context,
810-
uint32_t session_id,
811-
uint8_t subscribe_event_group_count,
812-
uint32_t subscribe_list_len,
813-
void *subscribe_list);
814795
#endif /* LIBSPDM_EVENT_RECIPIENT_SUPPORT */
815796

816797
#if LIBSPDM_ENABLE_MSG_LOG

0 commit comments

Comments
 (0)