Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ command = "mdbook-mermaid"

[output.html]
additional-js = ["src/third_party/mermaid.min.js", "src/third_party/mermaid-init.js"]
additional-css = ["theme/custom.css"]
default-theme = "light"

[output.html.fold]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* [SPDM](./specification/middleware/spdm.md)
* [PLDM](./specification/middleware/pldm.md)
* [Services](./specification/services/README.md)
* [Firmware Update](./specification/services/fwupdate.md)
* [Device Abstraction](./specification/device_abstraction/README.md)
* [Terminology](./specification/terminology.md)

Expand All @@ -26,4 +27,3 @@
* [Design](./design/README.md)
* [Digest Driver for Hubris](./design/driver-hubris-hash.md)
* [Rust Traits to IDL Guide](./design/rust-trait-to-idl-conversion.md)

6 changes: 3 additions & 3 deletions docs/src/specification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ TBD

## High Level Architecture

TBD

### Block Diagram

TBD
The following block diagram illustrates the high-level architecture of OpenPRoT.

<img src="openprot_diagram.svg" alt="figure2" width="700"/>
1 change: 1 addition & 0 deletions docs/src/specification/openprot_diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 5 additions & 10 deletions docs/src/specification/services/fwupdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,9 @@ DownstreamDeviceIDRecordCount | 1 | 0

#### Component Image Information

Field | Size | Definition
:---------------------------- | :--- | :---------
ComponentClassification | 2 | 0x000A: Downstream EEPROM, Downstream SoC Firmware, and OpenPRoT RT Image (Firmware), 0x0001: Downstream SoC Manifest (Other)
:--------------------------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------
ComponentIdentifier | 2 | Unique value selected by the FD vendor to distinguish between component images. 0x0001: OpenPRoT RT Image, 0x0002: Downstream SoC Manifest, 0x0003: 0x0003: Downstream EEPROM 0x1000\-0xFFFF \- Reserved for other vendor-defined SoC images
ComponentComparisonStamp | 4 | Value used as a comparison in determining if a firmware component is down-level or up-level. When ComponentOptions bit 1 is set, this field should use a comparison stamp format (e.g., MajorMinorRevisionPatch). If not set, use 0xFFFFFFFF.
ComponentOptions | 2 | Refer to ComponentOptions definition in [DMTF Firmware Update Specification v.1.3.0](https://www.dmtf.org/sites/default/files/standards/documents/DSP0267_1.3.0.pdf)
Expand All @@ -106,16 +107,10 @@ ComponentOpaqueData | Variable | Optional data transferred to the

| Component Image | Name | Description |
| :-------------- | :------------------------ | :----------------------------- |
| 0x0 | OpenPRoT RT Image | OpenPRoT manifest and firmware |
: : : images (e.g. BL0, RT :
: : : firmware). :
| 0x1 | Downstream SoC Manifest | SoC manifest covering firmware |
: : : images. Used to stage :
: : : verification of the firmware :
: : : payload. :
| 0x0 | OpenPRoT RT Image | OpenPRoT manifest and firmware images (e.g. BL0, RT firmware). |
| 0x1 | Downstream SoC Manifest | SoC manifest covering firmware images. Used to stage verification of the firmware payload. |
| 0x2 | Downstream SoC Firmware | SoC firmware payload. |
| 0x3 | Downstream EEPROM | Bulk update of downstream |
: : : EEPROM :
| 0x3 | Downstream EEPROM | Bulk update of downstream EEPROM |
| \>= 0x1000 | Vendor defined components | |

## PLDM Firmware Update Process
Expand Down
7 changes: 7 additions & 0 deletions docs/theme/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:root {
--content-max-width: 900px;
}

table {
width: 100%;
}
Loading