mirror of
https://github.com/retroSoC/common.git
synced 2026-11-04 14:22:39 +00:00
maksyuki
3b6a925a51
- 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.
73 lines
1.9 KiB
Markdown
73 lines
1.9 KiB
Markdown
# dffrh
|
|
|
|
| Property | Value |
|
|
| --- | --- |
|
|
| Kind | `module` |
|
|
| RTL source | [`rtl/utils/register.sv`](../../../rtl/utils/register.sv) |
|
|
| Availability | Synthesizable RTL |
|
|
|
|
## Summary
|
|
|
|
D flip-flop with all-one reset value.
|
|
|
|
## Functional Behavior
|
|
|
|
D flip-flop with all-one reset value. Its exact parameters and ports are reproduced below from the implementation declaration.
|
|
|
|
## Suitable Applications
|
|
|
|
Use as a small reusable datapath, state, coding, delay, or verification primitive.
|
|
|
|
## Parameters
|
|
|
|
The declaration below is canonical; retain the RTL-enforced parameter range.
|
|
|
|
| Parameter | Declaration |
|
|
| --- | --- |
|
|
| `DATA_WIDTH` | `parameter int DATA_WIDTH = 1` |
|
|
|
|
## Interface Definition
|
|
|
|
```systemverilog
|
|
module dffrh #(
|
|
parameter int DATA_WIDTH = 1
|
|
) (
|
|
input logic clk_i,
|
|
input logic rst_n_i,
|
|
input logic [DATA_WIDTH-1:0] dat_i,
|
|
output logic [DATA_WIDTH-1:0] dat_o
|
|
);
|
|
```
|
|
|
|
|
|
### Port Summary
|
|
|
|
| Signal | Direction | Declaration |
|
|
| --- | --- | --- |
|
|
| `clk_i` | `input` | `input logic clk_i` |
|
|
| `rst_n_i` | `input` | `input logic rst_n_i` |
|
|
| `dat_i` | `input` | `input logic [DATA_WIDTH-1:0] dat_i` |
|
|
| `dat_o` | `output` | `output logic [DATA_WIDTH-1:0] dat_o` |
|
|
|
|
## Integration and Use
|
|
|
|
Keep parameter values within RTL assertions and add required clocking, reset, or CDC protection at the caller boundary.
|
|
|
|
```systemverilog
|
|
dffrh #(
|
|
.DATA_WIDTH(DATA_WIDTH)
|
|
) u_dffrh (
|
|
.clk_i(clk_i),
|
|
.rst_n_i(rst_n_i),
|
|
.dat_i(dat_i),
|
|
.dat_o(dat_o)
|
|
);
|
|
```
|
|
|
|
## 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.
|