docs: cover amaranth.vendor.

This commit is contained in:
Irides 2021-12-13 03:10:40 -06:00 committed by Catherine
parent 1ee2482c6b
commit 40b92965c9
13 changed files with 96 additions and 20 deletions

10
docs/platform/intel.rst Normal file
View file

@ -0,0 +1,10 @@
Intel
#####
.. py:module:: amaranth.vendor.intel
The :mod:`amaranth.vendor.intel` package provides a base platform to support Intel toolchains.
The Quartus and Mistral toolchains are supported.
.. autoclass:: IntelPlatform

View file

@ -0,0 +1,10 @@
Lattice ECP5
############
.. py:module:: amaranth.vendor.lattice_ecp5
The :mod:`amaranth.vendor.lattice_ecp5` package provides a base platform to support Lattice ECP5 devices.
The Trellis and Diamond toolchains are supported.
.. autoclass:: LatticeECP5Platform

View file

@ -0,0 +1,10 @@
Lattice iCE40
#############
.. py:module:: amaranth.vendor.lattice_ice40
The :mod:`amaranth.vendor.lattice_ice40` package provides a base platform to support Lattice iCE40 devices.
The IceStorm and iCECube2 toolchains are supported.
.. autoclass:: LatticeICE40Platform

View file

@ -0,0 +1,19 @@
Lattice MachXO2 and MachXO3L
############################
.. py:module:: amaranth.vendor.lattice_machxo_2_3l
The :mod:`amaranth.vendor.lattice_machxo_2_3l` package provides a base platform to support Lattice
MachXO2 and MachXO3L devices.
The Diamond toolchain is supported.
.. autoclass:: LatticeMachXO2Platform
.. autoclass:: LatticeMachXO3LPlatform
.. note:: Both of the above are aliases for the actual platform below, however only the aliased
definitions are actually exported from the module for use.
.. autoclass:: LatticeMachXO2Or3LPlatform

View file

@ -0,0 +1,10 @@
Quicklogic
##########
.. py:module:: amaranth.vendor.quicklogic
The :mod:`amaranth.vendor.quicklogic` package provides a base platform to support Quicklogic toolchains.
The Symbiflow toolchain is supported.
.. autoclass:: QuicklogicPlatform

10
docs/platform/xilinx.rst Normal file
View file

@ -0,0 +1,10 @@
Xilinx
######
.. py:module:: amaranth.vendor.xilinx
The :mod:`amaranth.vendor.xilinx` package provides a base platform to support Xilinx toolchains.
The ISE, Vivado, and Symbiflow toolchains are supported.
.. autoclass:: XilinxPlatform