Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding version feature and compatibility info to main readme #247

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Adding version feature and compatibility info to main readme #247

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f46287
Adding version feature and compatibility info to main readme
nquarton Nov 7, 2024
1e2157c
Update GET_IDEV_CSR name in version table
nquarton Nov 19, 2024
f31a9e2
Version table minor formatting tweaks
nquarton Dec 4, 2024
bb83e47
Adding links to commands and updating 1.2 feature set with late addit…
nquarton Jan 22, 2025
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
50 changes: 50 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,56 @@ marks](https://github.com/chipsalliance/Caliptra/blob/main/CaliptraTrademarkPoli
* [Runtime 2.x - WIP](https://github.com/chipsalliance/caliptra-sw/blob/main-2.x/runtime/README.md)
* [MCU Firmware and SDK specification - WIP](https://chipsalliance.github.io/caliptra-mcu-sw/)

## Versioning

Caliptra is released in independently versioned components: RTL, ROM, FMC and Runtime FW. They are all represented by 3 values: major.minor.patch (such as 1.0.2). The first 2 values, major.minor, correspond to a set of features caliptra supports. The patch value is incremented as new releases are made with bug fixes.

Not all components necessarily need to be of the same major.minor version to be compatible. Details are below:

### Caliptra 1.0
Compatible Configurations:
| RTL | ROM | Runtime FMC/FW |
| --- | --- | --- |
| 1.0.x | 1.0.x | 1.0.x |

### Caliptra 1.1

Additional Features
- ECC HW performance enhancements*
- LMS HW acceleration*
- New Runtime commands
- LMS_SIGNATURE_VERIFY <link>
- ADD_SUBJECT_ALT_NAME <link>
- CERTIFY_KEY_EXTENDED <link>
- Expanded PL0 contexts to 16

\* Requires 1.1 RTL

Compatible Configurations:
| RTL | ROM | Runtime FMC/FW |
| --- | --- | --- |
| 1.1.x | 1.1.x | 1.1.x |
| 1.0.x | 1.0.x | 1.1.x |


### Caliptra 1.2

Additional Features
- Manifest-based Authorization
- SET_AUTH_MANIFEST
- AUTHORIZE_AND_STASH
- Deferred retrieval of IDEV CSR**
- GET_IDEV_CSR

\*\* Requires 1.2 ROM

Compatible Configurations:
| RTL | ROM | Runtime FMC/FW |
| --- | --- | --- |
| 1.1.x | 1.2.x | 1.2.x |
| 1.1.x | 1.1.x | 1.2.x |
| 1.0.x | 1.0.x | 1.2.x |

## Test Dashboards

* [Caliptra Software CI dashboard](https://chipsalliance.github.io/caliptra-sw/)
Expand Down