Skip to content

Commit a4d62f6

Browse files
committed
docs: add info on core config generation
Signed-off-by: Karol Gugala <[email protected]>
1 parent 0b72449 commit a4d62f6

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

doc/source/phy.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,29 @@ The core implements 4 CSRs for controlling timings of the I3C bus:
6666
In the target configuration, the first three should be set to `0`, the `T_SU_DAT_REG` should be set according to the following equation:
6767

6868
```
69-
reg_val = $ceil(3 / system_clock_period) - 1
69+
reg_val = $floor(3 / system_clock_period) - 1
7070
T_SU_DAT_REG = reg_val > 0 ? reg_val : 0
7171
```
7272

7373
For system clock frequencies below 320MHz, the core should be configured with the `DisableInputFF` parameter set to `True` (see [example configuration](https://github.com/chipsalliance/i3c-core/blob/main/i3c_core_configs.yaml#L49))
7474
This parameter removes one flipflop on the input lines, shortening the response latency.
7575

76+
The core provides 2 configurations with the `DisableInputFF` parameter set to `True`.
77+
In order to generate a configuration with the parameter set, run the following command from the top level of the I3C repository:
78+
79+
```
80+
make generate CFG_NAME=ahb CFG_FILE=i3c_core_configs.yaml
81+
```
82+
83+
or
84+
85+
```
86+
make generate CFG_NAME=axi CFG_FILE=i3c_core_configs.yaml
87+
```
88+
89+
Depending on the chosen bus interface.
90+
More Information about the configuration tool can be found in the relevant [README](https://github.com/chipsalliance/i3c-core/blob/main/tools/i3c_config/README.md)
91+
7692
Example configurations:
7793

7894
* 160MHz system clock (minimal operting clock) - `DisableInputFF=True`, `T_SU_DAT_REG=0`

tools/i3c_config/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ axi:
1313
RespFifoDepth: 64
1414
IbiFifoDepth: 64
1515
IbiFifoExtSize: False
16-
DatDepth: 32
17-
DctDepth: 32
16+
DatDepth: 128
17+
DctDepth: 128
1818
FrontendBusInterface: "AXI"
19-
FrontendBusAddrWidth: 32
20-
FrontendBusDataWidth: 64
19+
FrontendBusAddrWidth: 12
20+
FrontendBusDataWidth: 32
21+
FrontendBusUserWidth: 32
22+
FrontendBusIdWidth: 8
23+
DisableInputFF: True
2124
```
2225
2326
## Usage

0 commit comments

Comments
 (0)