Skip to content

Commit

Permalink
Add a note about migration.
Browse files Browse the repository at this point in the history
  • Loading branch information
mateusz-holenko committed Sep 15, 2021
1 parent d465e7f commit 38781fc
Showing 1 changed file with 6 additions and 72 deletions.
78 changes: 6 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,10 @@
# litex-renode
Tools for using [Renode](http://renode.io) from [Antmicro](http://antmicro.com) with [LiteX](http://github.com/enjoy-digital/litex) for simulation.
# Note

This repo hosts the parser of LiteX 'csr.json' file generating scripts for Renode allowing to simulate the given configuration of the LiteX SoC.
The scripts were migrated to the [LiteX](https://github.com/enjoy-digital/litex) repository.
Any further development will be held there.

### Renode
Please switch to [litex_json2renode](https://github.com/enjoy-digital/litex/blob/master/litex/tools/litex_json2renode.py) and
[litex_json2dts_zephyr](https://github.com/enjoy-digital/litex/blob/master/litex/tools/litex_json2dts_zephyr.py).

Renode was created by Antmicro as a virtual development tool for multinode embedded networks (both wired and wireless) and is intended to enable a scalable workflow for creating effective, tested and secure IoT systems.

With Renode, developing, testing, debugging and simulating unmodified software for IoT devices is fast, cost-effective and reliable.

For details, see [the official webpage](http://renode.io).

### LiteX

LiteX is a MiSoC-based SoC builder using Migen as Python DSL that can be used
to create SoCs and full FPGA designs.

LiteX provides specific building/debugging tools for high level of abstraction
and compatibily with the LiteX core ecosystem.

Think of Migen as a toolbox to create FPGA designs in Python and LiteX as a
toolbox to create/develop/debug FPGA SoCs in Python.

For details, see [the github repository](https://github.com/enjoy-digital/litex).

## Usage

First, build your LiteX platform with `--csr-json csr.json` switch, e.g.:

python3 litex/boards/targets/arty.py --cpu-type vexriscv --with-ethernet --csr-json csr.json

Now, use the generated configuration file as an input for `generate-renode-scripts.py`:

./generate-renode-scripts.py csr.json \
--resc litex.resc \
--repl litex.repl
--bios-binary soc_ethernetsoc_arty/software/bios/bios.bin

This will generate two files:

* `litex.repl` - platform definition file, containing information about all the peripherals and their configuration,
* `litex.resc` - Renode script file, allowing to easily run the simulation of the generated platform.

Finally, you can run the simulation by executing the command::

renode litex.resc

### Additional options

The script provides additional options:

#### `--firmware-binary`

Allows to set a path to the file that should be loaded into flash. Allows to use the `flashboot` command in LiteX bios.

#### `--configure-network`

Generates virtual network and connects it to the host's interface. Allows to use the `netboot` command in LiteX bios.

## Supported LiteX components

The script can generate the following elements of the LiteX SoC:

* `uart`,
* `timer0`,
* `ethmac`,
* `cas`,
* `cpu`,
* `spiflash`,
* `ctrl`.

## Examples

See [litex-buildenv](https://github.com/timvideos/litex-buildenv/blob/master/scripts/build-renode.sh) for an example of use.
For the documentation see: https://github.com/enjoy-digital/litex/wiki/Generate-Renode-simulation and https://github.com/enjoy-digital/litex/wiki/Run-Zephyr-On-Your-SoC.

0 comments on commit 38781fc

Please sign in to comment.