Merge pull request #203 from chipsalliance/dev-integrate

Merge dev-integrate -> main

README.md

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and<BR>
 limitations under the License.*_<BR>
 
 # **Caliptra Hands-On Guide** #
-_*Last Update: 2023/08/24*_
+_*Last Update: 2023/09/06*_
 
 
 ## **Tools Used** ##
@@ -44,9 +44,10 @@ Synthesis:
 
 GCC:
  - RISCV Toolchain for generating memory initialization files
-   - `riscv64-unknown-elf-gcc-8.2.0-2019.02.0-x86_64-linux-centos6`
- - G++ Used to compile Verilator objects
-   - `g++ (GCC) 8.2.0`
+   - `Version 2023.04.29`
+   - `riscv64-unknown-elf-gcc (g) 12.2.0`
+ - G++ Used to compile Verilator objects and test firmware
+   - `g++ (GCC) 11.2.0`
 
 Other:
  - Playbook (Microsoft Internal workflow management tool)
@@ -78,11 +79,11 @@ Required for Firmware (i.e. Test suites) makefile:<BR>
 Caliptra
 |-- LICENSE
 |-- README.md
-|-- Release_notes.txt
+|-- Release_Notes.md
 |-- docs
 |   |-- Caliptra_Integration_Specification.pdf
-|   |-- Caliptra_Hardware_Spec.pdf
-|   |-- Caliptra_TestPlan_L1.pdf
+|   |-- Caliptra_Hardware_Specification.pdf
+|   `-- Caliptra_TestPlan.xlsx
 |-- src
 |   |-- aes
 |   |-- ahb_lite_bus
@@ -108,11 +109,11 @@ Caliptra
 |   |-- sha512_masked
 |   |-- soc_ifc
 |   |-- spi_host
-|   |-- uart
+|   `-- uart
 `-- tools
-    |-- config
     |-- README
-    `-- scripts
+    |-- scripts
+    `-- templates
 ```
 The root of the repository is structured as shown above, to a depth of 2 layers.<BR>
 Each sub-component is accompanied by a file list summary (located in src/<component>/config/<name>.vf) that comprises all the filenames required to compile the component, and an optional testbench filelist for unit-level simulation. <BR>
@@ -133,6 +134,7 @@ The "Integration" sub-component contains the top-level fileset for Caliptra. `sr
 `run_verilator_l0_regression.py`: Wrapper to run the L0 smoke test regression suite using the Makefile flow in Verilator<BR>
 `integration_vector_gen.py`: Generates test vectors for crypto core tests<BR>
 `veer_build_command.sh`: Shell script used to generate the VeeR-EL2 repository present in `src/riscv_core/veer_el2`<BR>
+`openocd`: Open-Source FW debug utility used for JTAG testing in automated workflows
 
 ## **Simulation Flow** ##
 

Release_Notes.md

@@ -14,13 +14,113 @@ See the License for the specific language governing permissions and<BR>
 limitations under the License.*_<BR>
 
 # **Release Notes** #
-_*Last Update: 2023/08/24*_
+_*Last Update: 2023/09/13*_
 
-## Rev 0p8 ##
+## Rev 1p0 ##
 
-### DISCALIMER: This is NOT A BUG-FREE MODEL YET. This is a 0p8 release model. Please see testplan document in docs folder to know the status of validation. ###
-#### This model is released mainly for interface, floorplan planning purposes for consumers. ####
-#### Rev 0p8 release date: 03-31-2023 ####
+### Rev 1p0 release date: (pending ROM release for official declaration) ###
+- Caliptra IP Specification: see docs/ folder
+- Caliptra Integration Specification: see docs/ folder
+- Caliptra testplan: see docs/ folder
+- Data Vault
+- RISC-V Timers
+  - mtime + mtimecmp implementation
+  - Watchdog timer configuration by SOC; escalate interrupts to error
+- Reliability, Availability, Serviceability Features
+  - Connectivity for cptra_error_fatal/cptra_error_non_fatal interrupts
+  - Mailbox protocol violation detection and Error state
+  - SRAM ECC error detection and reporting for ICCM, DCCM, Mailbox
+  - Key clearing and system reset on fatal errors
+- SOC Interface
+  - QSPI inout changed to input+output+enable
+  - FUSE PAUSER config registers and enforcement
+- Reset Domain Crossing (RDC) fixes
+  - Reset-triggered clock gating on cross-domain registers
+  - Reset timing changes for noncore reset assertion
+  - Migrate most internal logic to the noncore reset domain
+  - Migrate APB interface to noncore reset domain
+- FIPS compliance updates
+  - SHA Accelerator LOCK default to Caliptra-owned
+  - LMS Fuse
+  - SOC Stepping ID field in HW Revision
+  - Extended pcr_nonce from 32-bit to 256-bit
+  - TRNG Data Clear
+- RISC-V Core
+  - Increase ROM size to 48KiB
+  - Added 2:1 AHB lite mux on LSU and SB buses to allow debug access to
+    peripherals
+- Timing Optimizations
+  - Remove PSEL loopback path in APB slave
+  - Remove unnecessary Mailbox SRAM ECC writeback path
+- Validation enhancements
+  - SOC_IFC/Mailbox randomized regressions via UVM testbench
+  - SOC Interface Register validation via directed + random tests
+  - Coverage reporting and analysis for all interfaces, registers, FSM
+  - Automated GitHub action using OpenOCD for interactive JTAG debugging
+  - SHA Formal Verification
+
+### Bug Fixes ###
+[CLK GATING] Fatal error should wake up clks<br>
+[CLK GATING] JTAG accesses need to wake up clocks<br>
+[DOE] add zeroize to clear all internal regs<br>
+[DOE] DOE IV reg needs hwclr input<br>
+[DOE] doe_fsm incr_dest_sel logic can be removed since FE now only takes up 12 dwords<br>
+[DOE] doe_fsm write_offset increments to 0xC<br>
+[DOE] Simplify kv_write dest_valid hardcoded value in doe_fsm<br>
+[ECC] ECC input register bound check<br>
+[ECC] ECC output register bound check<br>
+[ECC] ECC Public key validation check<br>
+[ECC] mismatch of final reduction in Mont. mult in the case of prime<= p_internal<br>
+[ECC] mismatch of modular addition result in the case of p<= a+b < 2^384<br>
+[ECC] remove FW read access to kv/privkey reg<br>
+[ECC} error trigger when pcr_sign ctrl input is set in keygen/verifying mode<br>
+[KV] Debug Mode and Scan Mode switch doesn't flush locked registers<br>
+[KV] Debug mode should flush KV even if core is asleep<br>
+[KV] Dest_valid and last_dword should check lock_use to clear along with lock_wr<br>
+[KV] KV may still contain secrets during scan mode<br>
+[KV] kv_reg.rdl still has 6 bits for dest_valid while we have 5 valid clients<br>
+[KV] KV->SHA ->FW read path and KV->HMAC->FW read path should NOT exist in the design<br>
+[KV] last dword of secret values stays in KV/crypto interface<br>
+[KV] Suppress writes to an entry altogether when it's being cleared<br>
+[MBOX] ECC error decode may detect error on mbox_sram when a write is in progress<br>
+[MBOX] First resp read data is zero after handling a command with DLEN > MBOX SIZE<br>
+[MBOX] HWCLR triggered by force-unlock has lower precedence than SW writes<br>
+[MBOX] Mailbox data length limiting reads is calculated incorrectly<br>
+[MBOX] Mailbox does not flag protocol error for attempted writes to DLEN<br>
+[MBOX] mailbox returns non-zero data in an overread case<br>
+[MBOX] New RAS feature to detect protocol violation incorrectly decodes certain reg accesses as errors<br>
+[MBOX] SOC can read mbox_dataout with stale data<br>
+[MBOX] Writes beyond the mailbox size overwrite the last data dword in mailbox memory<br>
+[MBOX] Writes to (a) unaligned addresses (b) size < AHB_DATA_WIDTH may corrupt memory<br>
+[MBOX] error_cmd_fail_sts.hwset is continuously set when mailbox protocol error occurs<br>
+[PCR] Extend PCR Nonce from 32-bit to 256-bit to protect replay attack<br>
+[PCR] PCR dword mismatch<br>
+[PCR] Update the reset of the 'lock' PCR control to the core reset domain (so that a FW update reset or warm reset can also unlock the PCR)<br>
+[PCR] zeroize doesn't take effect if is set with pcr at the same cycle<br>
+[SHA ACCEL] SoC requester can use mailbox mode<br>
+[SOC_IFC] Arbiter lets direct request dv through at the same time as soc ifc mailbox request causing deadlock<br>
+[SOC_IFC] Breakpoint is unreachable<br>
+[SOC_IFC] Fuse Registers can never be written using non-default values programmed in FUSE_VALID_PAUSER<br>
+[SOC_IFC] Generic Input Wires toggle (any bit) should trigger notification interrupt to uC<br>
+[SOC_IFC] INTERNAL_HW_ERROR_FATAL_MASK and INTERNAL_HW_ERROR_NON_FATAL_MASK allow writes to (and non-zero reads from) reserved fields.<br>
+[SOC_IFC] Mailbox ECC errors detected during SHA Accel direct accesses are not detected/corrected<br>
+[SOC_IFC] mbox_execute can be cleared by SOC at any point after acquiring lock<br>
+[SOC_IFC] uC can't write to CPTRA_FW_ERROR regs (Github issue #64)<br>
+[SOC_IFC] WDT may not correctly detect when uC services the timer expiration interrupt<br>
+[WDT] CPTRA_WDT_STATUS reg should be FW writeable so it can clear the flags<br>
+[WDT] First stage interrupt output should be "error_intr" instead of "notif_intr"<br>
+[WDT] WDT registers need to be on ungated clk<br>
+[AHB] AHB 2:1 Mux hangs with back to back transactions after a stall<br>
+[RST] scan_mode should not corrupt resets<br>
+[TOP] EL2 Mem interface is not instantiated with a modport at all levels
+
+## Previous Releases ##
+
+### Rev 0p8 ###
+
+#### DISCALIMER: This is NOT A BUG-FREE MODEL YET. This is a 0p8 release model. Please see testplan document in docs folder to know the status of validation. ####
+##### This model is released mainly for interface, floorplan planning purposes for consumers. #####
+##### Rev 0p8 release date: 03-31-2023 #####
 
 - Caliptra IP Specification: see docs/ folder
 - Caliptra Integration Specification: see docs/ folder
@@ -59,13 +159,6 @@ _*Last Update: 2023/08/24*_
     - UVMF for multiple DUT blocks and SOC interface
     - DV complete for first cut of the boot & reset flows, Fuses, SOC registers, Crypto blocks, Key vault, PCR Vault, PCR extend, PCR signing, Mailbox
 
-## Pending for RTL 1p0: ##
-- Timers, integrated-TRNG integration w/ Caliptra, Error domain logic
-- Lots of bug fixes :-)
-- Data Vault, TRNG REQ protocol, SHA384 acceleration, More mailbox val, PCR val, cross product flows
-
-## Previous Releases ##
-
 ### Rev Pre0p8: ###
 #### DISCLAIMER: This is NOT A BUG-FREE MODEL. This is a pre-0p8 development model that will be sync’d every week. ####
 #### This model is released mainly for interface, floorplan planning purposes for consumers. ####