Implement RFC 18: Reorganize vendor platforms

This commit is contained in:
Catherine 2023-08-31 23:25:38 +00:00
parent 88cbf30128
commit 796068a192
23 changed files with 4447 additions and 4334 deletions

View file

@ -1,9 +1,9 @@
Gowin
#####
.. py:module:: amaranth.vendor.gowin
.. currentmodule:: amaranth.vendor
The :mod:`amaranth.vendor.gowin` module provides a base platform to support Gowin toolchains.
The :class:`GowinPlatform` class provides a base platform to support Gowin toolchains.
The Apicula and Gowin toolchains are supported.

View file

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

View file

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

View file

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

View file

@ -1,19 +1,12 @@
Lattice MachXO2 and MachXO3L
############################
.. py:module:: amaranth.vendor.lattice_machxo_2_3l
.. currentmodule:: amaranth.vendor
The :mod:`amaranth.vendor.lattice_machxo_2_3l` module provides a base platform to support Lattice
MachXO2 and MachXO3L devices.
The :class:`LatticeMachXO2Platform` and :class:`LatticeMachXO3LPlatform` classes provide base platforms to support Lattice MachXO2 and MachXO3L devices.
The Diamond toolchain is supported.
.. autoclass:: amaranth.vendor._lattice_machxo_2_3l.LatticeMachXO2Or3LPlatform
.. 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

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

View file

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