diff --git a/README.md b/README.md index ec138a8e..21ff108e 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ sets out the charter governing the Caliptra project. ## 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. Lastly, mutable firmware (FMC/FW) have security version numbers (SVNs) that are incremented as required by when addressing security-critical issues. These are specified with the label (svn/svn) for (FMC/FW) versions respectively. +Caliptra is released in independently versioned components: Core RTL, Subsystem RTL, ROM, FMC, 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. Lastly, mutable firmware (FMC/FW) have security version numbers (SVNs) that are incremented as required by when addressing security-critical issues. These are specified with the label (svn/svn) for (FMC/FW) versions respectively. Not all components necessarily need to be of the same major.minor version to be compatible. Details are below: @@ -118,13 +118,14 @@ Additional Features - IDevID CSR HMAC Signing - Crypto Offload Mailbox Services -\*\*\* Only RTL release versions 2.0.2+ should be used due to ROM compatibility requirements. +\*\*\* Integrators must use Caliptra Core RTL release versions 2.0.4+ for security hardening. Compatible Configurations: -| RTL | ROM | Runtime FMC/FW | -| --- | --- | --- | -| 2.0.2+ | 2.0.x | 2.0.x (0/0) | +| Configuration | RTL | ROM | Runtime FMC/FW | +| --- | --- | --- | --- | +| Core | 2.0.4+ | 2.0.x | 2.0.x (0/0) | +| Subsystem | 2.0.2+ | 2.0.x | 2.0.x (0/0) | ### Caliptra 2.1 @@ -135,11 +136,14 @@ Additional Features - Support for AES DMA mode - Caliptra Core mailbox size reduced to 16 KiB in subsystem mode +\*\*\* Integrators must use Caliptra Core RTL release versions 2.1.2+ for security hardening. + Compatible Configurations: -| RTL | ROM | Runtime FMC/FW | -| --- | --- | --- | -| 2.1.x | 2.1.x | 2.1.x (0/0) | +| Configuration | RTL | ROM | Runtime FMC/FW | +| --- | --- | --- | --- | +| Core | 2.1.2+ | 2.1.x | 2.1.x (0/0) | +| Subsystem | 2.1.2+ | 2.1.x | 2.1.x (0/0) | ## Test Dashboards diff --git a/doc/trademark/CaliptraChecklistAndEvaluationMethodology.md b/doc/trademark/CaliptraChecklistAndEvaluationMethodology.md index 11faca9a..04dff175 100644 --- a/doc/trademark/CaliptraChecklistAndEvaluationMethodology.md +++ b/doc/trademark/CaliptraChecklistAndEvaluationMethodology.md @@ -242,6 +242,9 @@ The following is a consolidated list of all requirements to ensure comprehensive * **Checklist Item:** * **Requirement:** The Caliptra RTL MUST be from an official release or TAC approved modification. Changes to the RTL other than those documented in the Integrator RTL Modification Requirements MUST be published to GitHub to obtain approval for the modification. Refer to docs/CaliptraIntegrationSpecification.md (section "Integrator RTL Modification Requirements") from the official release that was consumed for integration, as listed in [Releases](https://github.com/chipsalliance/caliptra-rtl/releases). * **Evaluation Methodology:** Manufacturers MUST show all changes made to RTL files. Manufacturers MUST show that changes to files in the Integrator RTL modification list are limited to the scope described in those requirements, and MUST show TAC approval for other changes. The [audit tools](https://github.com/chipsalliance/caliptra-rtl/tree/main/tools) can be used to identify changes. +* **Checklist Item:** + * **Requirement:** Integrators MUST consume a Caliptra RTL release that is compliant with the versioning compatibility matrix published at [Caliptra Versioning](https://chipsalliance.github.io/caliptra-web/versioning). + * **Evaluation Methodology:** Manufacturers MUST identify the Caliptra RTL release consumed by the product to demonstrate that it meets the minimum acceptable Major and Minor versions defined in the versioning table. Manufacturers MUST provide evidence that the selected ROM version is compatible according to the published versioning compatibility matrix. * **Checklist Item:** * **Requirement:** Netlists, layout, and other development collateral derived from the RTL MUST maintain the same behavior as the released RTL when Caliptra is in the [Production Non-Debug state](https://github.com/chipsalliance/Caliptra/blob/main/doc/Caliptra.md#caliptra-security-states). * **Evaluation Methodology:** Manufacturers MUST provide evidence that collateral derived from the released RTL has not had its behavior modified.