f4pga/README.md

FOSS Flow For FPGA (F4PGA) project

This is the top-level repository for the F4PGA project, which is a Workgroup under the CHIPS Alliance. The elements of the project include (but are not limited to):

• The F4PGA open source FPGA toolchains for programming FPGAs (formerly known as SymbiFlow). This includes:

  • F4PGA documentation: f4pga.readthedocs.io (knowledge base)
  • F4PGA Architecture Definitions: f4pga.readthedocs.io/projects/arch-defs
  • F4PGA examples: f4pga-examples.readthedocs.io
  • F4PGA Yosys plugins

• The FPGA interchange format (an interchange format defined by CHIPS Alliance to enable interoperability between different FPGA tools) adopted by the F4PGA toolchain:

  • FPGA Interchange schema
  • FPGA Interchange Python utilities
  • FPGA Interchange Test suite

• The FPGA tool performance framework framework for benchmarking designs against various FPGA tools, and vice versa, over time.

• FPGA Database visualisation tools for visual exploration of FPGA bitstream and databases:

  • F4PGA bitstream viewer
  • F4PGA database visualizer

• Other utilities (FPGA assembly format, documentation and other):

  • F4PGA Assembly (FASM)
  • Xilinx bitstream generation library
  • Verilog-to-routing XML utilities
  • SDF format utilities
  • F4PGA tools data manager
  • F4PGA Sphinx Theme
  • F4PGA Sphinx HDL diagrams
  • F4PGA Sphinx Verilog domain

F4PGA Workgroup

The F4PGA Workgroup consists of members from different backgrounds, including FPGA vendors (Xilinx and QuickLogic), industrial users (Google, Antmicro) and academia (University of Toronto), who collaborate to build a more open source and software-driven FPGA ecosystem (IP, tools and workflows) to drive the adoption of FPGAs in existing and new use cases, and eliminate barriers of entry.