Skip to content

Commit

Permalink
Updated the steps and include streaming boot in the sequence
Browse files Browse the repository at this point in the history
  • Loading branch information
mlvisaya committed Jan 29, 2025
1 parent b659d19 commit b7791d9
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 26 deletions.
14 changes: 3 additions & 11 deletions docs/src/firmware_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,14 @@ The MCU SDK provides an API that allows for updating the firmware of Caliptra FM

## Architecture

The PLDM stack forwards all Firmware Update Messages (PLDM T5) to the Firmware Update API. The API handles these messages and generates responses back to the PLDM stack.
The MCU PLDM stack handles the PLDM firmware messages from an external Firmware Update Agent. This includes parsing the messages and handling firmware state transitions. The stack will generate upstream notifications to the Firmware Update API to handle application specific actions such as writing firmware chunks to a staging or permanent storage location, verifying components, etc. The API notifies the application of the start and completion of the firmware update process.

The API will notify the application if a firmware update is available. The application will indicate to the API when to start the firmware update.

The Firmware Update API works with other APIs to complete the firmware update.

<p align="left">
<img src="images/firmware_update_software_stack.svg" alt="flash_config" width="30%">
</p>
![flash_config](images/firmware_update_software_stack.svg)

## PLDM Firmware Download Sequence

<!--
https://www.plantuml.com/plantuml/svg/XLLTJ-Cw47tFhnZnTA-kq7td0M7wKIgrqDk4YxIgL0tD1AnrRA_jbkNVhuqRaustj5AfuXcVcNFEJBYn3etRjw9mt0c2AJVj6ng2HrsZ8_WNIcS8MovVu5Of1oNzs9FSKL5eVv7lk4Rfu6Ar62_X5YrT05e8JtayWNjCt7qFcUdez-nX5smr3zdXTr2NQHqZMXT5uVzUNlkagr31kEFrmfzSNdUOWnZk73-46gcJ8lJQp_zlJ-PzJ0U-etbDql66ax55bt1v7IvSGPwH8St8TGyhDDYI-nDGdf8ZhOCDraKI2I6IJweTa0jy5aS1l3XvQ51y0BoHQx9QIUjL4Kffs7jk0b28ZTofraT8ketaib6WqLggiqPN_dZqcVfNkhRbzTzPzK5sgawoXj30iOr66Q23TmKIN5OuCZXJEcbsDltuGU66E_9njXmzWZ9GFenWtk9B9tb0dasgRLcnsVn-jcNZyNfIbXkvH2wUrS_GVukoBYXyXQN1kWNiaw2B1pR-6Z5yuoTJEl7DjEuPtVVOGgtUf51OKtrgQhhZCJhC3Ea7X-htOoTrJc8iKVB6b-lfSRjl6ZBW50YrG_7XnvejewOZ55mxWp1TZlvPLxrh8xQOhwersqwVFkJyb77KoUW18bfrok0dmns1KnjPEdm9rZ536CK_xscE0milCh2wDcHjH53kbOm5gLnOFlL6oTlmazOZjxaoA6rG9ZWjA7zN_4-6D--G1k5BbKi_TUonkjiksVryEYchZVn29pxW5su-hEVV9bjsFmuhKTwb-v78u4MTcefTycpmklOJkI4xfhNeloJoiQACR-P8FnZicGgqhr0wPGA_imCIUEZtg0OqHhNGZKc6bNRsf1214AUeL9GWSamAf578zeyT_zDb6dNdGOX8f6-v1qmfaLc-9BbtIULqD_CkHNhldXkFj6_5Bm00
https://www.plantuml.com/plantuml/svg/ZLLDJyCu4BtdLumuxMfLxMal710X_I1IFxfDMAHLfMfe9iN2iREEMvP_lpPktE1iA4W1wdb-C_FUJ7FVQ5JwMF58Cyq9fanLxwW8dke2DS7la6b5M35nW0SfDMJqpv74dgAeDXVPdjKeDDoSuV61XBu1R60z7o--Gko9OSFz6umW_yEYVBgloB28U9rQjFqRHRZNKi5DAfXcQFvraRgEeiZy7jqPqArDexHdtuepKKRgn4pj1ZEwQwDNqIOZEza3NsraU-ao_7aazJ4c2qyB4fgLZ5GJjO3HdRrm2tr4Zsb6klsmHeKLwVyZwaFwJ1lhLADTCvx12UILFI7Z-C9DqqjfQzgZPb8uWOoSLu61agkteDIWZAtOK5DBqHWDkPGr78qI793phTZBoaH8wArWefHGOzDGqMjhROwJ2_GNV-tNC7K8zQb9562pdsiefG8w6GF1SmLPMnckvhNQXjX0CVE3N8UBzdcsI9v0AiXM2QGL7joSEixP9DzbUJnBbxDTF1vl9bcs5GlZoOlyrvPTeIWYiWzlADXPopr8Eb_5uokCvhdkSzXrr-ckrLsN6oZak-0I2og6vgOz7gF6dYlTOEX2DmQ10mCUUA4MA5XfadUqUZYM9IdG4hZS8__qQXCldDu9SbPhXJ1T9Bzjyiwr99wdwtmJxwRFdr9V94vQYGs1Oyk7p7zMJ9D9lHMPneErDLQ4pfZhVlTvO6uaXxWe53MDOv3wbLG3GcgxZFATlFTzwplx4vgMAnIDrSdE0IUZQMZBNwHO-G5-JW9hld4WCzCQF-MFkqMyJAUJBD-ARpHaGU_svcgJ_ZtPnSknNQNiyNB_fpFkYX_iBQvhxhz4WjO6bZxeDlIg6xJ6JJashyPkgKntFncTHDOVJWiebQoW7Q0-r_2csnCdWElGzt-PWt0nu_Chipq9bFBndaHNsibCId_PHOED6XpQy9NckmXCTlJ1k-hUS1uh_Xy0
-->

<img src="images/firmware_update_sequence.svg" width="50%">
Expand Down Expand Up @@ -52,8 +46,6 @@ Note: Actions below are performed by MCU RT Firmware.
- Add flag and AUTHORIZE_AND_STASH command to indicate whether image to be validated is in staging or load address
- Add Activate command with input argument of image_id



(Open Questions):

1. Updating 1 image needs moving images in flash.
Expand Down
Loading

0 comments on commit b7791d9

Please sign in to comment.