Skip to content

Commit

Permalink
Docs: Update info about adding new modules
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Katarzynski <[email protected]>
  • Loading branch information
pkatarzynski committed Nov 29, 2024
1 parent 1cf2114 commit 3063eb1
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions docs/source/hammering.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,17 +249,9 @@ such as on ZCU104. On other boards it would be necessary to desolder the DRAM ch

### Adding new modules

The [LiteDRAM](https://github.com/enjoy-digital/litedram) controller provides out-of-the-box support for various DRAM modules.
The supported modules are listed in [litedram/modules.py](https://github.com/antmicro/litedram/blob/rowhammer-tester/litedram/modules.py).
If a module is not listed there, you can add a new definition.

To make development more convenient, modules can be added in the rowhammer-tester repository directly in file [rowhammer_tester/targets/modules.py](https://github.com/antmicro/rowhammer-tester/blob/main/rowhammer_tester/targets/modules.py).
These definitions will be used before definitions in LiteDRAM.

```{note}
After ensuring that the module works correctly, a Pull Request to LiteDRAM should be created to add support for the module.
```

To add a new module definition, use the existing ones as a reference.
A new module class should derive from `SDRAMModule` (or the helper classes, e.g. `DDR4Module`).
Timing/geometry values for a module have to be obtained from the relevant DRAM module's datasheet.
Expand Down

0 comments on commit 3063eb1

Please sign in to comment.