forked from im-tomu/fomu-toolchain
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request im-tomu#20 from umarcor/fpga-toolchain
migrate from xobs/toolchain-* to open-tool-forge/fpga-toolchain
- Loading branch information
Showing
2 changed files
with
31 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,32 @@ | ||
# Fomu Toolchain | ||
|
||
Fomu is an FPGA in your USB port. This repository contains prebuilt versions of all the tools you will need to develop for Fomu. | ||
[Fomu](https://github.com/im-tomu/fomu-hardware) ([fomu.im](https://fomu.im)) is an FPGA in your USB port. This repository gathers all the tools you will need to develop for Fomu, and provides them as prebuilt packages for GNU/Linux, Windows or macOS. | ||
|
||
## Usage | ||
|
||
Download the [latest release](https://github.com/im-tomu/fomu-toolchain/releases/latest) for your platform and extract it somewhere on your disk. Then set your PATH: | ||
|
||
* MacOS: `export PATH=[path-to-bin]:$PATH` | ||
* Linux: `export PATH=[path-to-bin]:$PATH` | ||
* Windows Powershell: `$ENV:PATH = "[path-to-bin];" + $ENV:PATH` | ||
* Windows cmd.exe: `PATH=[path-to-bin];%PATH%` | ||
* Shell (GNU/Linux, Cygwin/MSYS2/MINGW, MacOS...): `export PATH=[path-to-bin]:$PATH` | ||
* Powershell (Windows): `$ENV:PATH = "[path-to-bin];" + $ENV:PATH` | ||
* cmd.exe (Windows): `PATH=[path-to-bin];%PATH%` | ||
|
||
To confirm installation, run a command such as `nextpnr-ice40` or `yosys`. | ||
|
||
## What's included | ||
|
||
This contains _almost_ everything you'll need to develop on Fomu: | ||
Prebuilt packages contain _almost_ everything you'll need for developing software and/or hardware on Fomu: | ||
|
||
* **yosys** -- synthesis | ||
* **nextpnr-ice40** -- place-and-route | ||
* **dfu-util** -- upload bitstream to the FPGA | ||
* **python3** -- required for `nextpnr-ice40` and to build litex projects | ||
* **riscv-gcc** -- compile code for RISC-V CPUs, such as the Fomu softcore | ||
* **wishbone-tool** -- access the debug bus on Fomu | ||
* [open-tool-forge/fpga-toolchain](https://github.com/open-tool-forge/fpga-toolchain): | ||
* **yosys** -- synthesis | ||
* **ghdl-yosys-plugin** -- VHDL frontend for *Yosys* | ||
* **nextpnr** -- place-and-route | ||
* **dfu-util** -- upload bitstream to the FPGA | ||
* Find the list of all tools at [open-tool-forge/fpga-toolchain: Introduction](https://github.com/open-tool-forge/fpga-toolchain#introduction). | ||
* Extras, specific for Fomu: | ||
* **riscv-gcc** -- compile code for RISC-V CPUs, such as the Fomu softcore | ||
* **wishbone-tool** -- access the debug bus on Fomu | ||
* The Windows version includes `make` and `teraterm`. | ||
|
||
Additionally, the macOS and Windows versions include `make`. | ||
NOTE: *fpga-toolchain* includes an internal *lib/python3.8* interpreter to be used by *nextpnr*. However, users should install a Python interpreter on their system for using *LiteX* or other Python based hardware description/design tools. | ||
|
||
It is strongly recommended that you install `git` to manage repositories and check out code, though it is not strictly necessary. | ||
It is strongly recommended that you install `git` for managing repositories and checking out code, though it is not strictly necessary. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters