<p align="center">
  <a title="Website" href="https://f4pga.org"><img src="https://img.shields.io/website?longCache=true&style=flat-square&label=f4pga.org&up_color=10cfc9&url=https%3A%2F%2Ff4pga.org%2Findex.html&labelColor=fff"></a><!--
  -->
  <a title="Documentation" href="https://f4pga.readthedocs.io"><img src="https://img.shields.io/website?longCache=true&style=flat-square&label=Documentation&up_color=1226aa&up_message=%E2%9E%9A&url=https%3A%2F%2Ff4pga.readthedocs.io%2Fen%2Flatest%2Findex.html&labelColor=fff"></a><!--
  -->
  <a title="Community" href="https://f4pga.readthedocs.io/en/latest/community.html#communication"><img src="https://img.shields.io/badge/Chat-IRC%20%7C%20Slack-white?longCache=true&style=flat-square&logo=Slack&logoColor=fff"></a><!--
  -->
</p>

# F4PGA Architecture Definitions

<p align="center">
  <a title="License Status" href="https://github.com/SymbiFlow/f4pga-arch-defs/blob/main/COPYING"><img alt="License Status" src="https://img.shields.io/github/license/SymbiFlow/f4pga-arch-defs?longCache=true&style=flat-square&label=License"></a><!--
  -->
  <a title="Documentation Status" href="https://f4pga.readthedocs.io/projects/arch-defs/"><img alt="Documentation Status" src="https://img.shields.io/readthedocs/symbiflow-arch-defs/latest?longCache=true&style=flat-square&logo=ReadTheDocs&logoColor=fff&label=Architecture%20Definitions%20Documentation"></a><!--
  -->
  <a title="'Automerge' workflow status" href="https://github.com/SymbiFlow/f4pga-arch-defs/actions/workflows/Automerge.yml"><img alt="'Automerge' workflow status" src="https://img.shields.io/github/workflow/status/SymbiFlow/f4pga-arch-defs/Automerge/main?longCache=true&style=flat-square&label=Tests&logo=Github%20Actions&logoColor=fff"></a><!--
  -->
</p>

**This repository is focused on the development of architecture support in F4PGA. Start with the [![Examples (for Users)](https://img.shields.io/website?longCache=true&style=flat-square&label=F4PGA%20Examples%20for%20Users&up_color=white&up_message=%E2%9E%9A&url=https%3A%2F%2Ff4pga-examples.readthedocs.io%2Fen%2Flatest%2Findex.html&labelColor=231f20)](https://f4pga-examples.readthedocs.io) if you are looking to use the
tools.**

This repo contains documentation of various FPGA architectures, it is currently concentrating on:

* Lattice
  * [iCE40](lattice/ice40)
  * [ECP5](lattice/ecp5)
* AMD/Xilinx
  * [Series 7](xilinx/xc7) (Artix, Kintex and Zynq)
* [QuickLogic](quicklogic)

It includes:

* Black box part definitions
* Verilog To Routing architecture definitions
* Documentation for humans
* Verilog simulations

The aim is to gather useful documentation (both human and machine readable) about the primitives and routing
infrastructure for these architectures.
We hope this enables growth in the open source FPGA tools space.