Git-Mirrors/tillitis-key
1
0
Fork 0
mirror of https://github.com/tillitis/tillitis-key1.git synced 2024-12-24 15:09:27 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clarify toolchain use

Browse Source 
Signed-off-by: Daniel Lublin <daniel@lublin.se>
This commit is contained in:
Daniel Lublin 2023-01-09 10:38:20 +01:00
parent 34c1a20015
commit 08bde89b3d
No known key found for this signature in database
GPG Key ID: 75BD0FEB8D3E7830
1 changed files with 33 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
doc/toolchain_setup.md
View File

@ -6,24 +6,43 @@ project. Tested on Ubuntu 22.10.
## General development environment ## General development environment
The following is intended to be a complete list of the packages that The following is intended to be a complete list of the packages that
are *required* to build the gateware icestorm toolchain, the firmware, are required for doing all of the following:
the apps, and as well our QEMU machine.
sudo apt install build-essential clang lld llvm bison flex libreadline-dev \ - building and developing [TKey host programs and
gawk tcl-dev libffi-dev git mercurial graphviz \ apps](https://github.com/tillitis/tillitis-key1-apps)
xdot pkg-config python3 libftdi-dev \ - building our [QEMU machine](https://github.com/tillitis/qemu/tree/tk1)
python3-dev libeigen3-dev \ (useful for apps dev)
libboost-dev libboost-filesystem-dev \ - building and developing firmware and FPGA gateware (which also
libboost-thread-dev libboost-program-options-dev \ requires building the toolchain below)
libboost-iostreams-dev cmake libhidapi-dev \
ninja-build libglib2.0-dev libpixman-1-dev \
golang
## Gateware: icestorm toolchain ```
sudo apt install build-essential clang lld llvm bison flex libreadline-dev \
gawk tcl-dev libffi-dev git mercurial graphviz \
xdot pkg-config python3 libftdi-dev \
python3-dev libeigen3-dev \
libboost-dev libboost-filesystem-dev \
libboost-thread-dev libboost-program-options-dev \
libboost-iostreams-dev cmake libhidapi-dev \
ninja-build libglib2.0-dev libpixman-1-dev \
golang
```
## Gateware: Yosys/Icestorm toolchain
If the LED of your TKey is flashing white when you plug it, then the
firmware is running and it's already usable! If you want to develop
TKey apps, then only the above general development environment is
needed.
Compiling and installing Yosys and friends is only needed if your TKey
is not already running the required firmware and FPGA gateware, or if
you want to do development on these components.
These steps are used to build and install the These steps are used to build and install the
[icestorm](http://bygone.clairexen.net/icestorm/) toolchain (in [icestorm](http://bygone.clairexen.net/icestorm/) toolchain. The
`/usr/local`). Note that nextpnr is replacing Arachne-PNR. binaries are installed in `/usr/local`. Note that if you have or
install other versions of these tools locally, they could conflict
(case in point: `yosys` installed on MacOS using brew).
git clone https://github.com/YosysHQ/icestorm git clone https://github.com/YosysHQ/icestorm
cd icestorm cd icestorm