Skip to content
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand All @@ -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
Expand Down