feat: add documentation for new utility components and scripts

- Created documentation for , , , and  modules, detailing their functionality, parameters, and usage examples.
- Implemented a script  to ensure required headings and content are present in documentation files.
- Developed  to generate and update documentation pages from SystemVerilog declarations, ensuring consistency and completeness.
This commit is contained in:
maksyuki committed 2026-08-04 16:35:53 +08:00
1 parent cbbc335159
commit 3b6a925a51
157 files changed
+12973 -4

No files matched your search

+94
View File
@@ -0,0 +1,94 @@
# cdc_2phase
| Property | Value |
| --- | --- |
| Kind | `module` |
| RTL source | [`rtl/cdc/cdc_2phase.sv`](../../../rtl/cdc/cdc_2phase.sv) |
| Availability | Synthesizable RTL |
## Summary
Two-phase asynchronous request/acknowledge transfer.
## Functional Behavior
Two-phase asynchronous request/acknowledge transfer. It carries the declared control, event, or data contract through the stated synchronizer, handshake, or Gray-pointer mechanism. Endpoint reset discards in-flight data unless the page identifies an acknowledged warm-clear path.
## Suitable Applications
Use for reset release, asynchronous control/data transfer, asynchronous queues, event notification, and CDC recovery.
## Parameters
The declaration below is canonical; retain the RTL-enforced parameter range.
| Parameter | Declaration |
| --- | --- |
| `DATA_WIDTH` | `parameter int DATA_WIDTH = 32` |
| `SYNC_STAGES` | `parameter int SYNC_STAGES = 2` |
## Interface Definition
```systemverilog
module cdc_2phase #(
parameter int DATA_WIDTH = 32,
parameter int SYNC_STAGES = 2
) (
input logic src_clk_i,
input logic src_rst_n_i,
input logic [DATA_WIDTH-1:0] src_data_i,
input logic src_valid_i,
output logic src_ready_o,
input logic dst_clk_i,
input logic dst_rst_n_i,
output logic [DATA_WIDTH-1:0] dst_data_o,
output logic dst_valid_o,
input logic dst_ready_i
);
```
### Port Summary
| Signal | Direction | Declaration |
| --- | --- | --- |
| `src_clk_i` | `input` | `input logic src_clk_i` |
| `src_rst_n_i` | `input` | `input logic src_rst_n_i` |
| `src_data_i` | `input` | `input logic [DATA_WIDTH-1:0] src_data_i` |
| `src_valid_i` | `input` | `input logic src_valid_i` |
| `src_ready_o` | `output` | `output logic src_ready_o` |
| `dst_clk_i` | `input` | `input logic dst_clk_i` |
| `dst_rst_n_i` | `input` | `input logic dst_rst_n_i` |
| `dst_data_o` | `output` | `output logic [DATA_WIDTH-1:0] dst_data_o` |
| `dst_valid_o` | `output` | `output logic dst_valid_o` |
| `dst_ready_i` | `input` | `input logic dst_ready_i` |
## Integration and Use
Never use a simple synchronizer for arbitrary multi-bit data. Keep both endpoint clocks running after reset release and obey all ready/busy outputs.
```systemverilog
cdc_2phase #(
.DATA_WIDTH(DATA_WIDTH),
.SYNC_STAGES(SYNC_STAGES)
) u_cdc_2phase (
.src_clk_i(src_clk_i),
.src_rst_n_i(src_rst_n_i),
.src_data_i(src_data_i),
.src_valid_i(src_valid_i),
.src_ready_o(src_ready_o),
.dst_clk_i(dst_clk_i),
.dst_rst_n_i(dst_rst_n_i),
.dst_data_o(dst_data_o),
.dst_valid_o(dst_valid_o),
.dst_ready_i(dst_ready_i)
);
```
## Dependencies and Verification
The linked RTL source is the implementation authority and contains local assertions for unsupported
parameter combinations. See [`docs/design.md`](../../design.md) for repository-wide CDC, reset,
stream, and storage contracts, and [`docs/verification.md`](../../verification.md) for the
verification matrix.