From 3f462873402da1bbf2147f9ad01ff3e3683ae473 Mon Sep 17 00:00:00 2001
From: Nick Quarton <139178705+nquarton@users.noreply.github.com>
Date: Thu, 7 Nov 2024 09:57:19 -0800
Subject: [PATCH 1/4] Adding version feature and compatibility info to main
readme
---
README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 48 insertions(+)
diff --git a/README.md b/README.md
index 7167313..810638c 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,54 @@ 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
+| 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
+ - ADD_SUBJECT_ALT_NAME
+ - CERTIFY_KEY_EXTENDED
+ - Expanded PL0 contexts to 16
+
+\* Requires 1.1+ RTL
+
+| 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_IDEVID_CSR
+
+\*\* Requires 1.2+ ROM
+
+| 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/)
From 1e2157cb3f853ce753ab5b755aec42403cab6adf Mon Sep 17 00:00:00 2001
From: Nick Quarton <139178705+nquarton@users.noreply.github.com>
Date: Tue, 19 Nov 2024 14:51:53 -0800
Subject: [PATCH 2/4] Update GET_IDEV_CSR name in version table
Co-authored-by: Carl Lundin <108372512+clundin25@users.noreply.github.com>
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 810638c..ece2af5 100644
--- a/README.md
+++ b/README.md
@@ -81,7 +81,7 @@ Additional Features
- SET_AUTH_MANIFEST
- AUTHORIZE_AND_STASH
- Deferred retrieval of IDEV CSR**
- - GET_IDEVID_CSR
+ - GET_IDEV_CSR
\*\* Requires 1.2+ ROM
From f31a9e238958cc1fe3c437fd6bd2a71e5bf02076 Mon Sep 17 00:00:00 2001
From: Nick Quarton <139178705+nquarton@users.noreply.github.com>
Date: Wed, 4 Dec 2024 08:24:10 -0800
Subject: [PATCH 3/4] Version table minor formatting tweaks
---
README.md | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index ece2af5..8155e63 100644
--- a/README.md
+++ b/README.md
@@ -49,8 +49,8 @@ Caliptra is released in independently versioned components: RTL, ROM, FMC and Ru
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 |
@@ -66,8 +66,9 @@ Additional Features
- CERTIFY_KEY_EXTENDED
- Expanded PL0 contexts to 16
-\* Requires 1.1+ RTL
+\* Requires 1.1 RTL
+Compatible Configurations:
| RTL | ROM | Runtime FMC/FW |
| --- | --- | --- |
| 1.1.x | 1.1.x | 1.1.x |
@@ -83,8 +84,9 @@ Additional Features
- Deferred retrieval of IDEV CSR**
- GET_IDEV_CSR
-\*\* Requires 1.2+ ROM
+\*\* Requires 1.2 ROM
+Compatible Configurations:
| RTL | ROM | Runtime FMC/FW |
| --- | --- | --- |
| 1.1.x | 1.2.x | 1.2.x |
From bb83e472d7c250fc9ababb18ab3282dfeb0f6bfc Mon Sep 17 00:00:00 2001
From: Nick Quarton <139178705+nquarton@users.noreply.github.com>
Date: Wed, 22 Jan 2025 10:59:46 -0800
Subject: [PATCH 4/4] Adding links to commands and updating 1.2 feature set
with late additions
---
README.md | 26 +++++++++++++++-----------
1 file changed, 15 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 8155e63..986705f 100644
--- a/README.md
+++ b/README.md
@@ -52,7 +52,7 @@ Not all components necessarily need to be of the same major.minor version to be
### Caliptra 1.0
Compatible Configurations:
| RTL | ROM | Runtime FMC/FW |
-| --- | --- | --- |
+| --- | --- | --- |
| 1.0.x | 1.0.x | 1.0.x |
### Caliptra 1.1
@@ -61,9 +61,9 @@ Additional Features
- ECC HW performance enhancements*
- LMS HW acceleration*
- New Runtime commands
- - LMS_SIGNATURE_VERIFY
- - ADD_SUBJECT_ALT_NAME
- - CERTIFY_KEY_EXTENDED
+ - [LMS_SIGNATURE_VERIFY](https://github.com/chipsalliance/caliptra-sw/blob/caliptra-1.1/runtime/README.md#lms_signature_verify)
+ - [ADD_SUBJECT_ALT_NAME](https://github.com/chipsalliance/caliptra-sw/blob/caliptra-1.1/runtime/README.md#add_subject_alt_name)
+ - [CERTIFY_KEY_EXTENDED](https://github.com/chipsalliance/caliptra-sw/blob/caliptra-1.1/runtime/README.md#certify_key_extended)
- Expanded PL0 contexts to 16
\* Requires 1.1 RTL
@@ -72,17 +72,21 @@ 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 |
+| 1.0.x | 1.0.x | 1.1.x |
### Caliptra 1.2
Additional Features
- - Manifest-based Authorization
- - SET_AUTH_MANIFEST
- - AUTHORIZE_AND_STASH
+ - [Manifest-based Authorization](https://github.com/chipsalliance/caliptra-sw/blob/main/auth-manifest/README.md)
+ - [SET_AUTH_MANIFEST](https://github.com/chipsalliance/caliptra-sw/blob/main/runtime/README.md#set_auth_manifest)
+ - [AUTHORIZE_AND_STASH](https://github.com/chipsalliance/caliptra-sw/blob/main/runtime/README.md#authorize_and_stash)
- Deferred retrieval of IDEV CSR**
- - GET_IDEV_CSR
+ - [GET_IDEVID_CSR](https://github.com/chipsalliance/caliptra-sw/blob/main/runtime/README.md#get_idevid_csr)
+ - Self-signed FMC Alias CSR
+ - [GET_FMC_ALIAS_CSR](https://github.com/chipsalliance/caliptra-sw/blob/main/runtime/README.md#get_fmc_alias_csr)
+ - DPE export of CDI
+ - SIGN_WITH_EXPORTED - WIP
\*\* Requires 1.2 ROM
@@ -90,8 +94,8 @@ 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 |
+| 1.1.x | 1.1.x | 1.2.x |
+| 1.0.x | 1.0.x | 1.2.x |
## Test Dashboards