Skip to content

Commit

Permalink
[rtl/system_integration] add README
Browse files Browse the repository at this point in the history
  • Loading branch information
stnolting committed May 8, 2024
1 parent a1c7709 commit 288b55d
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions rtl/system_integration/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Processor System Integration

### `neorv32_litex_core_complex.vhd`

Pre-configured top entity wrapper for integration within the [LiteX](https://github.com/enjoy-digital/litex) SoC builder framework.

> [!TIP]
> See the user guide's [`core/mem`](https://stnolting.github.io/neorv32/ug/#_litex_soc_builder_support) section for more information.
### `neorv32_vivado_ip.vhd`

Processor top entity with optional AXI4-Lite and AXI4-Stream interfaces. Dedicated for integration as custom IP block within AMD Vivado.
Run the provided packaging script in the Vivado TCL shell to generate a NEORV32 IP block:

```tcl
source neorv32_vivado_ip.tcl
```

> [!TIP]
> See the user guide's [UG: Packaging the Processor as Vivado IP Block](https://stnolting.github.io/neorv32/ug/#_packaging_the_processor_as_vivado_ip_block)
section for more information and step-by-step instructions for generating a NEORV32 IP module.

0 comments on commit 288b55d

Please sign in to comment.