From 4b30b2324c1bdee3945a48c9f0f641ec2ae08b80 Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Tue, 15 Dec 2020 17:06:06 +0100 Subject: [PATCH] xc7: Remove information covered in the sphinx documentation from README Signed-off-by: Robert Winkler --- xc7/README.rst | 110 ++----------------------------------------------- 1 file changed, 3 insertions(+), 107 deletions(-) diff --git a/xc7/README.rst b/xc7/README.rst index 3002558..72f9c5a 100644 --- a/xc7/README.rst +++ b/xc7/README.rst @@ -1,116 +1,12 @@ SymbiFlow Toolchain Examples for Xilinx 7 Series ================================================ -#. ``counter`` - simple 4-bit counter driving LEDs. The design targets the `Basys3 board `__ and the `Arty boards `__. - +#. ``counter`` - simple 4-bit counter driving LEDs. The design targets the `Basys3 board `__, the `Arty boards `__, and the `Zybo Z7 board `__ #. ``picosoc`` - `picorv32 `__ based SoC. The design targets the `Basys3 board `__. - #. ``linux_litex`` - `LiteX `__ based system with Linux capable `VexRiscv core `__. The design includes `DDR `__ and `Ethernet `__ controllers. The design targets the `Arty boards `__. The Linux images for the ``linux_litex`` example can be built following the `linux on litex vexriscv `__ instructions. The ``linux_litex`` example is already provided with working Linux images. - -Clone this repository ---------------------- -If you have not already done so, clone this repository and `cd` into it: - -.. code:: bash - - sudo apt install git - git clone https://github.com/SymbiFlow/symbiflow-examples.git && cd symbiflow-examples - - - -Setting up the toolchain ------------------------- - -Choose the installation directory (see the `README <../README.rst>`_ one level up for details): - - -.. code:: bash - - export INSTALL_DIR=~/opt/symbiflow # or somewhere else you choose - -.. toolchain_include_begin_label - -.. code:: bash - :name: xc7-setup-toolchain - - bash conda_installer.sh -b -p $INSTALL_DIR/xc7/conda - source "$INSTALL_DIR/xc7/conda/etc/profile.d/conda.sh" - conda env create -f xc7/environment.yml - conda activate xc7 - mkdir -p $INSTALL_DIR/xc7/install - wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/continuous/install/112/20201208-080919/symbiflow-arch-defs-install-7c1267b7.tar.xz | tar -xJC $INSTALL_DIR/xc7/install - wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/continuous/install/112/20201208-080919/symbiflow-arch-defs-xc7a50t_test-7c1267b7.tar.xz | tar -xJC $INSTALL_DIR/xc7/install - wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/continuous/install/112/20201208-080919/symbiflow-arch-defs-xc7a100t_test-7c1267b7.tar.xz | tar -xJC $INSTALL_DIR/xc7/install - wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/continuous/install/112/20201208-080919/symbiflow-arch-defs-xc7z010_test-7c1267b7.tar.xz | tar -xJC $INSTALL_DIR/xc7/install - conda deactivate - -.. toolchain_include_end_label - -Building the examples ---------------------- - -.. build_examples_include_begin_label - -Before building any example, set the installation directory to match what you set it to earlier, - -.. code:: bash - - export INSTALL_DIR=~/opt/symbiflow - -and prepare the environment: - -.. code:: bash - :name: xc7-prepare-env - - # adding symbiflow toolchain binaries to PATH - export PATH="$INSTALL_DIR/xc7/install/bin:$PATH" - source "$INSTALL_DIR/xc7/conda/etc/profile.d/conda.sh" - conda activate xc7 - -To build the counter example, run any or all of the following commands: - -.. code:: bash - :name: xc7-counter - - pushd xc7/counter_test && TARGET="arty_35" make && popd - pushd xc7/counter_test && TARGET="arty_100" make && popd - pushd xc7/counter_test && TARGET="basys3" make && popd - pushd xc7/counter_test && TARGET="zybo" make && popd - -To build the picosoc example, run the following commands: - -.. code:: bash - :name: xc7-picosoc - - pushd xc7/picosoc_demo && make && popd - -To build the litex example, run the following commands: - -.. code:: bash - :name: xc7-litex - - mkdir xc7/litex_demo - pushd xc7/litex_demo - wget https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py - chmod +x litex_setup.py - ./litex_setup.py init - ./litex_setup.py install - wget https://static.dev.sifive.com/dev-tools/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz - tar -xf riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz - export PATH=$PATH:$PWD/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14/bin/ - pushd litex/litex/boards/targets && ./arty.py --toolchain symbiflow --cpu-type vexriscv --sys-clk-freq 80e6 --no-ident-version --build && popd - popd - -To build the linux-litex-demo example, run the following commands: - -.. code:: bash - :name: xc7-linux - - pushd xc7/linux_litex_demo && make && popd - pushd xc7/linux_litex_demo && TARGET="arty_100" make && popd - -.. build_examples_include_end_label +The detailed description about building the examples is available in the +`project documentation `__.