Skip to content

Commit

Permalink
[rtl] cleanup README
Browse files Browse the repository at this point in the history
  • Loading branch information
stnolting committed Jun 23, 2024
1 parent 46aff57 commit c0b8020
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions rtl/core/mem/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Processor Memory Source Files
## Processor Memory Source Files

This folder provides the architecture-only VHDL sources for the processor-internal memories
(instruction memory "IMEM", data memory "DMEM"). Different implementations are available - but
only **one** version of each (IMEM and DMEM) has to be added as actual source files.
(instruction memory "IMEM", data memory "DMEM"). Different implementations are available, but
only **one** version of each (IMEM and DMEM) should be added as actual source files.

For the first implementation the `*.default.vhd` files should be selected. The HDL style for describing
memories used by these files has proven **platform-independence** across several FPGA architectures and toolchains.
For an initial setup the `*.default.vhd` files should be selected. The HDL style for describing
memories used by these files has proven quite good platform-independence across several FPGA
architectures and toolchains.

If synthesis fails to infer actual block RAM resources from these default files, try the legacy `*.legacy.vhd` files, which
provide a different HDL style. These files are intended for legacy support of older Intel/Altera Quartus versions (13.0 and older). However,
these files do **not** use platform-specific macros or primitives - so they might also work for other FPGAs and toolchains.
If synthesis fails to infer block RAM resources from these default files, try the legacy
`*.legacy.vhd` files, which provide a different HDL style. These files are also intended for
legacy support of older Intel/Altera Quartus versions (13.0 and older). However, these files
still do not use platform-specific macros or primitives - so they might also work for other
FPGAs and toolchains.

:warning: Make sure to add the selected files from this folder also to the `neorv32` design library.
> [!IMPORTANT]
> Make sure to add the selected files from this folder also to the `neorv32` design library.

0 comments on commit c0b8020

Please sign in to comment.