Skip to content

Commit

Permalink
Fix some typo in doc
Browse files Browse the repository at this point in the history
Signed-off-by: Wenxing Hou <[email protected]>
  • Loading branch information
Wenxing-hou authored and jyao1 committed Oct 30, 2024
1 parent 2e8b643 commit 30014a8
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions doc/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

#### Compiler for ARM/AARCH64 (Choose one)

a) [ARM Developerment Studio 2022](https://developer.arm.com/downloads/-/arm-development-studio-downloads) for ARM/AARCH64.
a) [ARM Development Studio 2022](https://developer.arm.com/downloads/-/arm-development-studio-downloads) for ARM/AARCH64.
- Install [MSYS2](https://www.msys2.org/).
- Install ARM DS2022. Change the default installation path C:\ArmStudio.
- Launch MSYS2 -> MSYS2 MINGW64.
Expand All @@ -27,7 +27,7 @@ a) [ARM Developerment Studio 2022](https://developer.arm.com/downloads/-/arm-dev
#### Compiler for ARM/AARCH64 (Choose one)
a) [ARM Developerment Studio 2022](https://developer.arm.com/downloads/-/arm-development-studio-downloads) for ARM/AARCH64.
a) [ARM Development Studio 2022](https://developer.arm.com/downloads/-/arm-development-studio-downloads) for ARM/AARCH64.
- Follow the [Arm Development Studio Getting Started Guide](https://developer.arm.com/documentation/101469/2022-1/Installing-and-configuring-Arm-Development-Studio/Installing-on-Linux) to install Linux version.
- Setup build environment
```
Expand Down
4 changes: 2 additions & 2 deletions doc/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@
- `LIBSPDM_SCRATCH_BUFFER_SIZE` - The Integrator may calculate the `scratch_buffer_size` according to the `max_spdm_msg_size` value input to `libspdm_register_transport_layer_func()`, according to `libspdm_get_scratch_buffer_capacity()` API implementation in [libspdm_com_context_data.c](https://github.com/DMTF/libspdm/blob/main/library/spdm_common_lib/libspdm_com_context_data.c). NOTE: The size requirement depends on `LIBSPDM_ENABLE_CAPABILITY_CHUNK_CAP` and `LIBSPDM_RESPOND_IF_READY_SUPPORT`.
- `LIBSPDM_MAX_SPDM_MSG_SIZE` - The Integrator needs to input `max_spdm_msg_size` to `libspdm_register_transport_layer_func()`.
- `LIBSPDM_DATA_TRANSFER_SIZE` - It is no longer needed.
- `LIBSPDM_TRANSPORT_ADDITIONAL_SIZE` - The Integrator needs to inpuit `transport_header_size` and `transport_tail_size` to `libspdm_register_transport_layer_func()`. For example, `LIBSPDM_MCTP_TRANSPORT_HEADER_SIZE` and `LIBSPDM_MCTP_TRANSPORT_TAIL_SIZE`, or `LIBSPDM_PCI_DOE_TRANSPORT_HEADER_SIZE` and `LIBSPDM_PCI_DOE_TRANSPORT_TAIL_SIZE`.
- `LIBSPDM_TRANSPORT_ADDITIONAL_SIZE` - The Integrator needs to input `transport_header_size` and `transport_tail_size` to `libspdm_register_transport_layer_func()`. For example, `LIBSPDM_MCTP_TRANSPORT_HEADER_SIZE` and `LIBSPDM_MCTP_TRANSPORT_TAIL_SIZE`, or `LIBSPDM_PCI_DOE_TRANSPORT_HEADER_SIZE` and `LIBSPDM_PCI_DOE_TRANSPORT_TAIL_SIZE`.
- `LIBSPDM_SENDER_RECEIVE_BUFFER_SIZE` - The Integrator needs to input `sender_buffer_size` and `receiver_buffer_size` to `libspdm_register_device_buffer_func()`.
- `LIBSPDM_MAX_MESSAGE_BUFFER_SIZE`, `LIBSPDM_MAX_MESSAGE_SMALL_BUFFER_SIZE`, `LIBSPDM_MAX_MESSAGE_MEDIUM_BUFFER_SIZE` - They are no longer needed. The managed buffer is defined individually, such as cert chain buffer, VCA transcript buffer, L1/L2 transcript buffer, M1/M2 transcript buffer, TH transcript buffer, etc.
- `LIBSPDM_MAX_REQUEST_RETRY_TIMES` - The Integrator needs to input `LIBSPDM_DATA_REQUEST_RETRY_TIMES`.
- `LIBSPDM_MAX_SESSION_STATE_CALLBACK_NUM` - The Integrator can only register one `libspdm_session_state_callback_func`.
- `LIBSPDM_MAX_CONNECTION_STATE_CALLBACK_NUM` - The Integrator can only regsiter one `libspdm_connection_state_callback_func`.
- `LIBSPDM_MAX_CONNECTION_STATE_CALLBACK_NUM` - The Integrator can only register one `libspdm_connection_state_callback_func`.
- `LIBSPDM_MAX_KEY_UPDATE_CALLBACK_NUM` - The Integrator can only register one `libspdm_key_update_callback_func`.
- `LIBSPDM_MAX_CSR_SIZE` - The real max CSR size is determined by the max SPDM message size.
- define fine granularity control of crypto algo.
Expand Down
2 changes: 1 addition & 1 deletion doc/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ Refer to spdm_server_init() in [spdm_responder.c](https://github.com/DMTF/spdm-e

0.5, implement required SPDM device IO functions - `libspdm_device_send_message_func` and `libspdm_device_receive_message_func` according to [spdm_common_lib](https://github.com/DMTF/libspdm/blob/main/include/library/spdm_common_lib.h).

0.6, if the device does not have access to a real-time clock and if the device uses OpenSSL or Mbed TLS then undefine `OPENSSL_CHECK_TIME` or `MBEDTLS_HAVE_TIME_DATE`.
0.6, if the device does not have access to a real-time clock and if the device uses OpenSSL or MbedTLS then undefine `OPENSSL_CHECK_TIME` or `MBEDTLS_HAVE_TIME_DATE`.

0. Implement a proper spdm_device_secret_lib.

Expand Down

0 comments on commit 30014a8

Please sign in to comment.