1 # Installation instructions for Symbiflow with Xilinx Artix7 100T Board
3 * <https://symbiflow.github.io/>
4 * <https://github.com/SymbiFlow>
8 * <https://bugs.libre-soc.org/show_bug.cgi?id=654>
10 ## Setting up new debootstrap and chroot into it
12 Run the following if you wish to isolate the symbiflow build
13 from other software (reproducible builds) or use the schroot
14 auto-preparation script here:
15 <https://git.libre-soc.org/?p=dev-env-setup.git;a=blob;f=mk-deb-chroot;hb=HEAD>
17 export MY_CHROOT=/stable-chroot
19 debootstrap buster $MY_CHROOT http://deb.debian.org/debian/
20 mount -t proc proc $MY_CHROOT/proc
21 mount -t sysfs sysfs $MY_CHROOT/sys
22 mount -t devpts devpts $MY_CHROOT/dev/pts/
23 chroot $MY_CHROOT /bin/bash
25 ## Add Buster Backports Repo and Update
27 ""buster backports is needed for cmake""
29 cat << EOF > /etc/apt/sources.list.d/buster_backports.list
30 deb http://deb.debian.org/debian buster-backports main
33 ""oooo annoying, pin preferences for buster-backports""
35 cat << EOF > /etc/apt/preferences.d/99buster-backports
37 Pin: release a=buster-backports
41 ""upgrade to buster-backports""
47 ## Download neccessary softwares
49 apt-get install -y libcurl3-gnutls/buster git/buster wget
51 git clone https://github.com/steveicarus/iverilog.git
52 git clone https://github.com/YosysHQ/yosys.git
53 git clone https://github.com/YosysHQ/abc.git
54 git clone https://github.com/oneapi-src/oneTBB.git
55 git clone https://github.com/verilog-to-routing/vtr-verilog-to-routing.git
56 git clone https://github.com/cliffordwolf/icestorm.git
57 git clone https://github.com/SymbiFlow/prjxray.git
58 git clone https://github.com/SymbiFlow/prjxray-db.git
59 git clone https://github.com/SymbiFlow/yosys-symbiflow-plugins.git
60 git clone https://github.com/SymbiFlow/symbiflow-examples.git
61 git clone https://github.com/SymbiFlow/symbiflow-arch-defs.git
62 git clone https://github.com/QuickLogic-Corp/quicklogic-fasm.git
63 git clone https://github.com/QuickLogic-Corp/quicklogic-fasm-utils.git
64 git clone https://github.com/SymbiFlow/python-fpga-interchange.git
65 git clone https://github.com/capnproto/capnproto.git
66 git clone https://github.com/capnproto/pycapnp.git
68 wget http://xmlsoft.org/sources/libxml2-2.9.12.tar.gz
69 wget http://xmlsoft.org/sources/libxslt-1.1.34.tar.gz
71 ## Steps to compile Icarus Verilog
73 ### Necessary software to install
75 apt-get install -y build-essential autoconf make g++ bison flex gperf \
78 ### Build Icarus Verilog
83 ./configure --prefix=/usr/local/symbiflow/iverilog
87 export PATH=/usr/local/symbiflow/iverilog/bin:$PATH
90 ## Steps to compile Yosys
92 ### Necessary software to install
94 apt-get install -y cmake
95 apt-get install -y python3 clang libreadline-dev gawk tcl-dev \
96 libffi-dev pkg-config libboost-system-dev libboost-python-dev \
97 libboost-filesystem-dev zlib1g-dev
102 git checkout 4f5f73d18b137930fb3048c0b385c82fa078db38
104 git checkout f44110c62561b21fa673f44d8e115c3ee70d2900
106 make -j $(nproc) PREFIX=/usr/local/symbiflow/yosys
107 make PREFIX=/usr/local/symbiflow/yosys install
108 install -d -m 0755 /usr/local/symbiflow/share
109 ln -s ../yosys/share/yosys /usr/local/symbiflow/share
110 export PATH=/usr/local/symbiflow/yosys/bin:$PATH
113 ## Steps to compile oneTBB
115 * Note: TBB is needed for multi-threading VTR-Verilog-to-routing
116 * If not need multi-threading do not build TBB and VTR with TBB
118 ### Necessary software to install
120 apt-get install -y libhwloc-dev
126 make -j$(nproc) tbb tbbmalloc tbbproxy tbbbind
127 install -d -m 0755 /usr/local/symbiflow/oneTBB/lib
128 cp -dpr include /usr/local/symbiflow/oneTBB
129 install -Dm755 build/linux_*/*.so* -t /usr/local/symbiflow/oneTBB/lib
130 cmake -DINSTALL_DIR=/usr/local/symbiflow/oneTBB/lib/cmake/TBB \
131 -DTBB_VERSION_FILE=/usr/local/symbiflow/oneTBB/include/tbb/tbb_stddef.h \
132 -DSYSTEM_NAME=Linux -P cmake/tbb_config_installer.cmake
133 echo "/usr/local/symbiflow/oneTBB/lib" > /etc/ld.so.conf.d/symbiflow.conf
137 ## Steps to compile vtr-verilog-to-routing
139 ### Necessary software to install
141 apt-get install -y libeigen3-dev
143 # Only if want GUI place and route
144 #apt-get install libcairo2-dev libfontconfig1-dev libx11-dev libxft-dev \
149 cd vtr-verilog-to-routing
150 git checkout 77a3df829fdf509a76b9d7b941376f3835c2576a
151 mkdir build; cd build
152 cmake -DCMAKE_INSTALL_PREFIX=/usr/local/symbiflow/vtr ..
155 install -d -m 0755 /usr/local/symbiflow/share/vtr
156 install -m 0644 ../libs/libvtrcapnproto/gen/rr_graph_uxsdcxx.capnp \
157 /usr/local/symbiflow/share/vtr
158 export PATH=/usr/local/symbiflow/vtr/bin:$PATH
163 cd vtr-verilog-to-routing
164 git checkout 77a3df829fdf509a76b9d7b941376f3835c2576a
165 mkdir build-tbb; cd build-tbb
166 cmake -DCMAKE_INSTALL_PREFIX=/usr/local/symbiflow/vtr-tbb \
167 -DTBB_INCLUDE_DIR=/usr/local/symbiflow/oneTBB/include \
168 -DTBB_LIBRARY=/usr/local/symbiflow/oneTBB/lib -DBUILD_TYPE=Release ..
169 LIBRARY_PATH=/usr/local/symbiflow/oneTBB/lib make -j $(nproc)
170 LIBRARY_PATH=/usr/local/symbiflow/oneTBB/lib make install
171 install -d -m 0755 /usr/local/symbiflow/share/vtr
172 install -m 0644 ../libs/libvtrcapnproto/gen/rr_graph_uxsdcxx.capnp \
173 /usr/local/symbiflow/share/vtr
174 # Choose either one of path for vtr-binaries
175 # This one or above one
176 #export PATH=/usr/local/symbiflow/vtr-tbb/bin:$PATH
179 ## Steps to compile libxml2
181 * Newer version is needed which fixes a integer overflow error and is not
184 ### Necessary software to install
186 apt-get install -y python3-dev
190 tar -xf libxml2-2.9.12.tar.gz
192 ./configure --prefix=/usr/local/symbiflow/libxml2 --with-history \
193 --with-python=/usr/bin/python3
196 echo "/usr/local/symbiflow/libxml2/lib" >> /etc/ld.so.conf.d/symbiflow.conf
198 export PATH=/usr/local/symbiflow/libxml2/bin:$PATH
201 ## Steps to compile libxslt
203 * Needed by python3 lxml
207 tar -xf libxslt-1.1.34.tar.gz
209 sed -i s/3000/5000/ libxslt/transform.c doc/xsltproc.{1,xml}
210 sed -i -r '/max(Parser)?Depth/d' ./tests/fuzz/fuzz.c
211 ./configure --prefix=/usr/local/symbiflow/libxslt --disable-static \
213 PKG_CONFIG_PATH=/usr/local/symbiflow/libxml2/lib/pkgconfig
216 echo "/usr/local/symbiflow/libxslt/lib" >> /etc/ld.so.conf.d/symbiflow.conf
218 export PATH=/usr/local/symbiflow/libxslt/bin:$PATH
221 ## Steps to compile prjxray
223 ### Necessary software to install
228 git checkout f7f06896ad26bb7c94680dc323d4b871eded1f4e
229 git submodule update --init --recursive
230 mkdir build; cd build
231 cmake -DCMAKE_INSTALL_PREFIX=/usr/local/symbiflow ..
234 export PATH=/usr/local/symbiflow/bin:$PATH
237 ## Steps to compile yosys-symbiflow-plugins
239 ### Necessary software to install
241 ### Build yosys-symbiflow-plugins
243 cd yosys-symbiflow-plugins
244 git checkout b170f1d3575568d87901422f846b700169e299be
245 sed -i -e 's@-include third_party/make-env/conda.mk@#-include third_party/make-env/conda.mk@' Makefile
250 ## Steps to compile prjxray-db
252 ### Install prjxray-db
255 git archive --format=tar --prefix=prjxray-db/ \
256 cd41f08a8a4d2a60053750a0fe10623b1e2e35da | \
257 tar -C /usr/local/symbiflow -xf -
259 cat > /usr/local/symbiflow/bin/prjxray-config << EOF
261 echo /usr/local/symbiflow/prjxray-db
264 chmod +x /usr/local/symbiflow/bin/prjxray-config
267 ## Steps to compile Icestorm
269 ### Necessary software to install
271 apt-get install -y libftdi-dev
276 git checkout 83b8ef947f77723f602b706eac16281e37de278c
277 make -j $(nproc) PREFIX=/usr/local/symbiflow/icestorm
278 make PREFIX=/usr/local/symbiflow/icestorm install
279 export PATH=/usr/local/symbiflow/icestorm/bin:$PATH
282 ## Steps to compile capnproto
284 ### Necessary software to install
286 apt-get install -y automake autoconf libtool
294 ./configure --prefix=/usr/local/symbiflow/capnproto
297 echo "/usr/local/symbiflow/capnproto/lib" >> /etc/ld.so.conf.d/symbiflow.conf
299 export PATH=/usr/local/symbiflow/capnproto/bin:$PATH
302 ## Steps to compile pycapnp
304 ### Necessary software to install
306 apt-get install -y python3-pip cython3
311 git checkout v1.0.0b1
315 ## Git checkout python-fpga-interchange
317 cd python-fpga-interchange
318 git checkout 1959b40e998db987c604c0a75664ccb209df13f7
321 ## Git checkout quicklogic-fasm-utils
323 cd quicklogic-fasm-utils
324 git checkout 3d6a375ddb6b55aaa5a59d99e44a207d4c18709f
327 ## Git checkout quicklogic-fasm
330 git checkout ee546ff09b2ee25894db3f419366afaf3c4bfe32
333 ## Steps to compile symbiflow-arch-defs
335 ## Necessary software to install
337 apt-get install -y nodejs npm python-pytest openocd flake8 python3-numpy \
338 python3-intervaltree python3-simplejson python3-intelhex \
339 python3-importlib-metadata python3-jsonschema python3-packaging \
340 python3-pyparsing python3-pyrsistent python3-tqdm python3-zipp \
341 python3-typing-extensions python3-ply
343 pip3 install textx fasm pyjson5 pyyaml tinyfpgab tinyprog pyjson lxml \
344 progressbar2 hilbertcurve==1.0.5 python-constraint parameterized \
345 yapf==0.26.0 python-sat
349 cd symbiflow-arch-defs
350 git checkout c2c0f00960baf538eb31e4c42bf5d09dca87bad7
352 git submodule update --init --recursive
353 pip3 install ../python-fpga-interchange
354 pip3 install -e third_party/prjxray
355 pip3 install -e third_party/xc-fasm
356 pip3 install ../quicklogic-fasm-utils
357 pip3 install ../quicklogic-fasm
358 pip3 install -e third_party/qlf-fasm
359 pip3 install -e quicklogic/common/utils/quicklogic-timings-importer
360 pip3 install -e third_party/vtr-xml-utils
361 pip3 install -e third_party/python-symbiflow-v2x
362 pip3 install -e third_party/python-sdf-timing
363 pip3 install -e third_party/symbiflow-xc-fasm2bels
365 mkdir -p env/conda/envs
366 ln -s /usr/local/symbiflow env/conda/envs/symbiflow_arch_def_base
368 sed -i -e 's@add_subdirectory(litex)@#add_subdirectory(litex)@g' \
369 -e 's@add_subdirectory(ibex)@#add_subdirectory(ibex)@g' \
370 xc/xc7/tests/soc/CMakeLists.txt
372 ### Build symbiflow-arch-defs-xc7-artix7-100t
374 export VPR_NUM_WORKERS=$(nproc)
376 mkdir build; cd build
377 cmake -DUSE_CONDA=FALSE -DPRJXRAY_DB_DIR=/usr/local/symbiflow/prjxray-db \
378 -DINSTALL_FAMILIES=xc7 -DINSTALL_ARCHS=artix7_100t \
379 -DINSTALL_DEVICES=xc7a100t -DCMAKE_INSTALL_PREFIX=/usr/local/symbiflow ..
380 cd xc/xc7/archs/artix7_100t
383 make PINMAP_INSTALL_arty100t-full_xc7a100t_test_arty100t-full_pinmap.csv
384 install -d -m 0755 /usr/local/symbiflow/share/symbiflow/arch/xc7a100t_test/xc7a100tcsg324-1
385 install -m 0644 arty100t-full_pinmap.csv /usr/local/symbiflow/share/symbiflow/arch/xc7a100t_test/xc7a100tcsg324-1/pinmap.csv
387 # Now you can skip to symbiflow-examples.git for external test
389 # To do builtin counter test; it should build top.bit as final bitstream
391 make counter_arty100t_bit
393 # see file counter_arty100t/artix7_100t-xc7a100t-virt-xc7a100t-test/top.bit
394 # it is the bitstream file and if built then success
398 ### Build symbiflow-arch-defs-xc7-artix7 (xc7a50t)
400 "If you do not want this target skip"
402 export VPR_NUM_WORKERS=$(nproc)
404 mkdir build_artix7; cd build_artix7
405 cmake -DUSE_CONDA=FALSE -DPRJXRAY_DB_DIR=/usr/local/symbiflow/prjxray-db \
406 -DINSTALL_FAMILIES=xc7 -DINSTALL_ARCHS=artix7_100t \
407 -DINSTALL_DEVICES=xc7a50t \
408 -DCMAKE_INSTALL_PREFIX=/usr/local/symbiflow ..
409 cd xc/xc7/archs/artix7
412 make PINMAP_INSTALL_arty-full_xc7a50t_test_arty-full_pinmap.csv
413 install -d -m 0755 /usr/local/symbiflow/share/symbiflow/arch/xc7a50t_test/xc7a50tfgg484-1
414 install -m 0644 arty-full_pinmap.csv /usr/local/symbiflow/share/symbiflow/arch/xc7a50t_test/xc7a50tfgg484-1/pinmap.csv
415 install -d -m 0755 /usr/local/symbiflow/share/symbiflow/arch/xc7a50t_test/xc7a35tcsg324-1
416 ln -s ../xc7a50tfgg484-1/pinmap.csv /usr/local/symbiflow/share/symbiflow/arch/xc7a50t_test/xc7a35tcsg324-1
418 # Now you can skip to symbiflow-examples.git for external test
420 # To do builtin counter test; it should build top.bit as final bitstream
422 make counter_arty100t_bit
424 # see file counter_arty/artix7-xc7a50t-arty-swbut-roi-virt-xc7a50t-arty-swbut-test/top.bit
425 # it is the bitstream file and if built then success
429 ## Steps to compile symbiflow-examples
431 ### Build counter test for arty_100
433 cd symbiflow-examples
434 git checkout 07a6353627e0b6083728d1022ce30f9093d4c2de
437 TARGET="arty_100" make -C counter_test
439 # Should produce top.bit bitstream
440 # see file counter_test/build/arty_100/top.bit
442 ### Build counter test for arty_35
444 TARGET="arty_35" make -C counter_test
446 # Should produce top.bit bitstream
447 # see file counter_test/build/arty_/top.bit
449 ### Build picosoc demo for arty_100
451 TARGET="arty_100" make -C picosoc_demo
453 # Should produce top.bit bitstream
454 # see file picosoc_demo/build/arty_100/top.bit
456 ### Build picosoc demo for arty_35
458 TARGET="arty_35" make -C picosoc_demo
460 # Should produce top.bit bitstream
461 # see file picosoc_demo/build/arty_35/top.bit
463 ### Build Linux Litex Demo for arty_100
465 TARGET="arty_100" make -C linux_litex_demo
467 # Should produce top.bit bitstream
468 # see file linux_litex_demo/build/arty_100/top.bit
470 ### Build Linux Litex Demo for arty_35
472 TARGET="arty_35" make -C linux_litex_demo
474 # Should produce top.bit bitstream
475 # see file linux_litex_demo/build/arty_35/top.bit
479 ## Steps to compile symbiflow-examples Litex
486 git clone https://github.com/m-labs/migen
487 git clone https://github.com/litex-hub/pythondata-software-compiler_rt
488 git clone https://github.com/enjoy-digital/litex
489 git clone https://github.com/enjoy-digital/litedram
490 git clone https://github.com/enjoy-digital/liteeth
491 git clone https://github.com/enjoy-digital/liteiclink
492 git clone https://github.com/enjoy-digital/litesdcard
493 git clone https://github.com/litex-hub/litespi
494 git clone https://github.com/litex-hub/litex-boards
495 git clone https://github.com/litex-hub/pythondata-cpu-picorv32
496 git clone https://github.com/litex-hub/pythondata-cpu-vexriscv
497 git clone https://github.com/litex-hub/pythondata-software-picolibc.git
503 migen=6e3f8e565704b4293174aedfb15b3470d233f528
504 pythondata-software-compiler_rt=fcb03245613ccf3079cc833a701f13d0beaae09d
505 litex=db20cb172dc982c5879aa8080ec7aa18de181cc5
506 litedram=1d5192f572c2eb97bc85eb56667e25dc88d725f1
507 liteeth=8ecc3ca6d9476dd1a8b32b2b6bf3584cd6dcfc02
508 liteiclink=3d8ecdbcf9f0260292221ff63b0ad3f5e409a955
509 litesdcard=4edf05e627a8b5f03e632215accec8ab588737e3
510 litespi=4cb907881bb75999e4c6bb68e211dd5cfc301de9
511 litex-boards=9e18d9bc34bafb18839512a55dc66ba62e0d4824
512 pythondata-cpu-picorv32=2e8be513726fb6ffd960f7e18d24e3a86d895107
513 pythondata-cpu-vexriscv=c4eca1837ebca20b637a0a61e3a93d9446488459
514 pythondata-software-picolibc=e27c8a7ef8a8e75b6474823aae338efb1a2ca1a9
516 for pkg in migen pythondata-software-compiler_rt litex litedram \
517 liteeth liteiclink litesdcard litespi litex-boards \
518 pythondata-cpu-picorv32 pythondata-cpu-vexriscv \
519 pythondata-software-picolibc; do
521 eval git checkout $`echo $pkg`
526 #### Build Litex Demo
531 ./litex_boards/targets/digilent_arty.py --toolchain=symbiflow \
532 --cpu-type=picorv32 --sys-clk-freq 80e6 --variant a7-100 \
533 --output-dir build/picorv32/arty_100 --build --no-compile-software
534 # see file build/picorv32/arty_100/gateware/digilent_arty.bit
535 # this is the built bitstream
539 ./litex_boards/targets/digilent_arty.py --toolchain=symbiflow \
540 --cpu-type=vexriscv --sys-clk-freq 80e6 --variant a7-100 \
541 --output-dir build/vexriscv/arty_100 --build --no-compile-software
542 # see file build/vexriscv/arty_100/gateware/digilent_arty.bit
543 # this is the built bitstream
547 ./litex_boards/targets/digilent_arty.py --toolchain=symbiflow \
548 --cpu-type=picorv32 --sys-clk-freq 80e6 --variant a7-35 \
549 --output-dir build/picorv32/arty_35 --build --no-compile-software
550 # see file build/picorv32/arty_35/gateware/digilent_arty.bit
551 # this is the built bitstream
555 ./litex_boards/targets/digilent_arty.py --toolchain=symbiflow \
556 --cpu-type=vexriscv --sys-clk-freq 80e6 --variant a7-35 \
557 --output-dir build/vexriscv/arty_35 --build --no-compile-software
558 # see file build/vexriscv/arty_35/gateware/digilent_arty.bit
559 # this is the built bitstream