apio

🌱 Open source ecosystem for open FPGA boards

Showing:

Popularity

Downloads/wk

0

GitHub Stars

407

Maintenance

Last Commit

19d ago

Contributors

38

Package

Dependencies

11

License

Categories

Readme

PyPI Version Build Status License

       

Open source ecosystem for open FPGA boards

Apio (pronounced [ˈa.pjo]) is a multiplatform toolbox, with static pre-built packages, project configuration tools and easy command interface to verify, synthesize, simulate and upload your verilog designs.

Apio is used by Icestudio.

Table of contents

Documentation

Find all the information on this WIKI PAGE

Installation

  1. Install Python and pip

  2. Install the latest apio: pip install -U apio

Apio packages

PackageInstallationDescription
driversapio install driversDrivers tools (only for Windows)
examplesapio install examplesVerilog basic examples, pinouts, etc
gtkwaveapio install gtkwaveSimulation viewer. GTKWave project (only for Windows)
yosysapio install yosysFPGA synthesis. Yosys project
ice40apio install ice40iCE40 place & route and configuration tools. Icestorm project
ecp5apio install ecp5ECP5 tools including Project Trellis and nextpnr
iverilogapio install iverilogVerilog simulation and synthesis tool. Icarus Verilog project
sconsapio install sconsA software construction tool. Scons project
systemapio install systemTools for listing the USB devices and retrieving information from the FTDI chips
verilatorapio install verilatorVerilog HDL simulator. Verilator project
icesprogapio install icesprogProgrammer for the iCESugar
dfu-utilsapio install dfuDevice Firmware Upgrade Utilities
fujprogapio install fujprogProgrammer for ULX2/3S boards

Supported platforms

linux_x86_64, linux_i686, linux_armv7l, linux_aarch64, windows_x86, windows_amd64, darwin.

Supported boards

HX1K

Board nameInterface
IceZUM AlhambraFTDI
Nandland Go boardFTDI
iCEstick Evaluation KitFTDI
iCEblink40-HX1KDigilent Adept

HX8K

Board nameInterface
Alchitry-Cu
Alhambra IIFTDI
BlackIceSerial
BlackIce IISerial
Blackice-mxSerial
CAT BoardGPIO RPi
icoBOARD 1.0GPIO RPi
Kéfir I iCE40-HX4KFTDI
iCE40-HX8K Breakout BoardFTDI
Alchitry CuFTDI
iceFUNSerial

LP8K

Board nameInterface
TinyFPGA B2Serial
TinyFPGA BXSerial

UP5K

Board nameInterface
arice1
FomuDFU
FPGA 101 Workshop Badge BoardFTDI
iCEBreakerFTDI
iCEBreaker bitsyDFU
iCE40 UltraPlus Breakout BoardFTDI
UPDuino v1.0FTDI
UPDuino v2.0FTDI
UPDuino v2.1FTDI
UPDuino v3.0FTDI
iCESugar v1.5FTDI
OK-iCE40ProFTDI

ECP5

Board nameInterface
OrangeCrab r0.2FTDI
TinyFPGA-EX-rev1Serial
TinyFPGA-EX-rev2Serial
ULX3S-12FUjprog
ULX3S-25FUjprog
ULX3S-45FUjprog
ULX3S-85FUjprog
Versa
ColorLight-5A-75B-V61FT2232H
ColorLight-5A-75B-V7FT2232H
ColorLight-5A-75B-V8FT2232H
ColorLight-5A-75E-V6FT2232H
ColorLight-5A-75E-V71FT2232H, FT232H or USB-Blaster
ColorLight-i5-v7.0FT2232H, FT232H or USB-Blaster
iCESugar-ProFT2232H, FT232H or USB-Blaster
FleaFPGA-OhmFT2232H, FT232H or USB-Blaster

LP1K

Board nameInterface
iCESugar-nanoFTDI

NOTE: all supported Icestorm FPGAs can be used with --fpga or --size, --type and --pack options.

Documentation

The complete documentation of the project can be found in Read the Docs: http://apiodoc.readthedocs.io. There is also a list of frequently asked questions (FAQ) that you can check here.

Development

git clone https://github.com/FPGAwars/apio.git
cd apio

Testing

pip install tox
tox
tox -e offline
tox -e coverage

Documentation

cd docs
make html
firefox _build/html/index.html

Debian packaging

Also you can find the debian scripts to package the full application and all the packages here: https://github.com/set-soft/apio-debian.

Thanks Salvador E. Tropea!

Videos

Apio in RPI2: iCEstick, Icezum and icoBOARD

Apio: an easy multi-platform toolbox for open FPGAs

Authors

Contributors

Credits

  • APIO was inspired by PlatformIO.

  • FPGAwars community has developed this project in a voluntary and altruistic way since 11/2016.

  • BQ sponsored this project from 02/2016 to 11/2016. Thanks.

License

Licensed under GPL 2.0 and Creative Commons Attribution-ShareAlike 4.0 International License.


https://github.com/FPGAwars/Apio-wiki/raw/main/wiki/Logos/Apio-github.png

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100