Merge pull request #267 from chipsalliance/stephm-addimages

add images and image references
chipsalliance · Nov 1, 2023 · 4631e4f · 4631e4f
2 parents e8e5a41 + 8798526
commit 4631e4f
Show file tree

Hide file tree

Showing 12 changed files with 21 additions and 1 deletion.
diff --git a/docs/Caliptra_rtl.md b/docs/Caliptra_rtl.md
@@ -38,6 +38,8 @@ The following figure shows the Caliptra Core.
 
 *Figure 1: Caliptra block diagram*
 
+![](./images/Caliptra_HW_diagram.png)
+
 ## Boot Media Dependent (passive) vs Boot Media Integrated (active) profile
 
 In the BMD profile, QSPI and I3C IO peripherals are disabled using integration-time defines passed to the hardware, which are also exposed to ROM. Peripheral IOs can be tied off appropriately for the BMD profile at SoC integration time. For more information on the BMD vs. BMI profile differences, see the boot flows in [Caliptra profiles](https://chipsalliance.github.io/Caliptra/doc/Caliptra.html#caliptra-profiles). Only the BMD profile is supported for the first generation release of Caliptra.
@@ -48,6 +50,8 @@ The following figure shows the SoC interface definition.
 
 *Figure 2: SoC Interface Block Diagram*
 
+![](./images/Caliptra_soc_interface_block.png)
+
 ## Integration parameters
 
 The following table describes integration parameters.
@@ -197,6 +201,8 @@ The following figure shows the reset rules and timing.
 
 *Figure 3: Reset rules and timing diagram*
 
+![](./images/Caliptra_reset_timing.png)
+
 Deassertion of cptra\_pwrgood indicates a power cycle that results in returning Caliptra to its default state. All resettable flops are reset.
 
 De-assertion of cptra\_rst\_b indicates a warm reset cycle that resets all but the “sticky” registers (fuses, error logging, etc.).
@@ -268,6 +274,8 @@ The Boot FSM detects that the SoC is bringing Caliptra out of reset. Part of thi
 
 *Figure 4: Mailbox Boot FSM state diagram*
 
+![](./images/Caliptra_mbox_boot_FSM.png)
+
 The boot FSM first waits for the SoC to assert cptra\_pwrgood and de-assert cptra\_rst\_b. In the BOOT\_FUSE state, Caliptra signals to the SoC that it is ready for fuses. After the SoC is done writing fuses, it sets the fuse done register and the FSM advances to BOOT\_DONE.
 
 BOOT\_DONE enables Caliptra reset deassertion through a two flip-flop synchronizer.
@@ -313,6 +321,8 @@ Once LOCK is granted, the mailbox is locked until that device has concluded its
 
 *Figure 5: Sender protocol flow chart*
 
+![](./images/Caliptra_mbox-sender.png)
+
 ## Receiver Protocol
 
 Upon receiving indication that mailbox has been populated, the appropriate device can read the mailbox. This is indicated by a dedicated wire that is asserted when Caliptra populates the mailbox for SoC consumption.
@@ -334,6 +344,8 @@ The following figure shows the receiver protocol flow.
 
 *Figure 6: Receiver protocol flowchart*
 
+![](./images/Caliptra_mbox_receiver.png)
+
 ## Mailbox arbitration
 
 From a mailbox protocol perspective, as long as CPTRA\_VALID\_PAUSER registers carry valid requestors, mailbox lock can be obtained by any of those valid requestors but only one of them at any given time. While the mailbox flow is happening, all other requestors will not get a grant.
@@ -499,6 +511,8 @@ The following figure shows the SRAM interface timing.
 
 *Figure 7: SRAM interface timing*
 
+![](./images/Caliptra_SRAM_interface_timing.png)
+
 ## SRAM parameterization
 
 Parameterization for ICCM/DCCM memories is derived from the configuration of the VeeR RISC-V core that has been selected for Caliptra integration. Parameters defined in the VeeR core determine signal dimensions at the Caliptra top-level interface and drive requirements for SRAM layout. For details about interface parameterization, see the [Interface](#interface) section. The following configuration options from the RISC-V Core dictate this behavior:
@@ -526,6 +540,8 @@ Note that the example assumes that data and ECC codes are in non-deterministic b
 
 *Figure 8: Example machine check reliability implementation*
 
+![](./images/Caliptra_machine_reliability.png)
+
 ### Error detection and logging
 
 1. Caliptra IP shall interface to ECC protected memories.
@@ -643,7 +659,11 @@ In an unconstrained environment, several CDC violations are anticipated. CDC ana
 
 The following code snippet and schematic diagram illustrate JTAG originating CDC violations.
 
-*Figure 9: Schematic diagram showing JTAG-originating CDC violations*
+*Figure 9: Schematic diagram and code snippet showing JTAG-originating CDC violations*
+
+![](./images/Caliptra_CDC_JTAG_code_snippet.png)
+
+![](./images/Caliptra_schematic_jtag.png)
 
 ## CDC analysis conclusions
 * Missing synchronizers appear to be the result of “inferred” and/or only 2-FF instantiated synchronizers.

diff --git a/docs/images/Caliptra_CDC_JTAG_code_snippet.png b/docs/images/Caliptra_CDC_JTAG_code_snippet.png
diff --git a/docs/images/Caliptra_HW_diagram.png b/docs/images/Caliptra_HW_diagram.png
diff --git a/docs/images/Caliptra_SRAM_interface_timing.png b/docs/images/Caliptra_SRAM_interface_timing.png
diff --git a/docs/images/Caliptra_machine_reliability.png b/docs/images/Caliptra_machine_reliability.png
diff --git a/docs/images/Caliptra_mbox-sender.png b/docs/images/Caliptra_mbox-sender.png
diff --git a/docs/images/Caliptra_mbox_boot_FSM.png b/docs/images/Caliptra_mbox_boot_FSM.png
diff --git a/docs/images/Caliptra_mbox_receiver.png b/docs/images/Caliptra_mbox_receiver.png
diff --git a/docs/images/Caliptra_reset_timing.png b/docs/images/Caliptra_reset_timing.png
diff --git a/docs/images/Caliptra_schematic_jtag.png b/docs/images/Caliptra_schematic_jtag.png
diff --git a/docs/images/Caliptra_soc_interface_block.png b/docs/images/Caliptra_soc_interface_block.png
diff --git a/docs/images/OCP_logo.png b/docs/images/OCP_logo.png