usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update documentation and changelog to reflect existing changes.

Browse source
This commit is contained in:
Catherine 2023-01-31 12:48:46 +00:00
parent aaec7e0d27
commit 309f647c0e
7 changed files with 37 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

4
amaranth/vendor/intel.py
View file

@ -18,7 +18,7 @@ class IntelPlatform(TemplatedPlatform):
* ``quartus_sta``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_Quartus``, if present.
``AMARANTH_ENV_QUARTUS``, if present.
Available overrides:
* ``add_settings``: inserts commands at the end of the QSF file.
@ -42,7 +42,7 @@ class IntelPlatform(TemplatedPlatform):
* ``nextpnr-mistral``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_Mistral``, if present.
``AMARANTH_ENV_MISTRAL``, if present.
* ``verbose``: enables logging of informational messages to standard error.
* ``read_verilog_opts``: adds options for ``read_verilog`` Yosys command.

4
amaranth/vendor/lattice_ecp5.py
View file

@ -17,7 +17,7 @@ class LatticeECP5Platform(TemplatedPlatform):
* ``ecppack``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_Trellis``, if present.
``AMARANTH_ENV_TRELLIS``, if present.
Available overrides:
* ``verbose``: enables logging of informational messages to standard error.
@ -45,7 +45,7 @@ class LatticeECP5Platform(TemplatedPlatform):
* ``ddtcmd``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_Diamond``, if present. On Linux, diamond_env as provided by Diamond
``AMARANTH_ENV_DIAMOND``, if present. On Linux, diamond_env as provided by Diamond
itself is a good candidate. On Windows, the following script (named ``diamond_env.bat``,
for instance) is known to work::

6
amaranth/vendor/lattice_ice40.py
View file

@ -18,7 +18,7 @@ class LatticeICE40Platform(TemplatedPlatform):
* ``icepack``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_IceStorm``, if present.
``AMARANTH_ENV_ICESTORM``, if present.
Available overrides:
* ``verbose``: enables logging of informational messages to standard error.
@ -47,7 +47,7 @@ class LatticeICE40Platform(TemplatedPlatform):
* ``tclsh``
The environment is populated by setting the necessary environment variables based on
``AMARANTH_ENV_iCECube2``, which must point to the root of the iCECube2 installation, and
``AMARANTH_ENV_ICECUBE2``, which must point to the root of the iCECube2 installation, and
is required.
Available overrides:
@ -306,7 +306,7 @@ class LatticeICE40Platform(TemplatedPlatform):
if self.toolchain == "IceStorm":
return f"AMARANTH_ENV_{self.toolchain}"
if self.toolchain in ("LSE-iCECube2", "Synplify-iCECube2"):
return f"AMARANTH_ENV_iCECube2"
return f"AMARANTH_ENV_ICECUBE2"
assert False
@property

2
amaranth/vendor/lattice_machxo_2_3l.py
View file

@ -16,7 +16,7 @@ class LatticeMachXO2Or3LPlatform(TemplatedPlatform):
* ``ddtcmd``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_Diamond``, if present. On Linux, diamond_env as provided by Diamond
``AMARANTH_ENV_DIAMOND``, if present. On Linux, diamond_env as provided by Diamond
itself is a good candidate. On Windows, the following script (named ``diamond_env.bat``,
for instance) is known to work::

2
amaranth/vendor/quicklogic.py
View file

@ -21,7 +21,7 @@ class QuicklogicPlatform(TemplatedPlatform):
* ``symbiflow_write_bitstream``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_QLSymbiflow``, if present.
``AMARANTH_ENV_QLSYMBIFLOW``, if present.
Available overrides:
* ``add_constraints``: inserts commands in XDC file.

6
amaranth/vendor/xilinx.py
View file

@ -17,7 +17,7 @@ class XilinxPlatform(TemplatedPlatform):
* ``vivado``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_Vivado``, if present.
``AMARANTH_ENV_VIVADO``, if present.
Available overrides:
* ``script_after_read``: inserts commands after ``read_xdc`` in Tcl script.
@ -99,7 +99,7 @@ class XilinxPlatform(TemplatedPlatform):
* ``symbiflow_write_bitstream``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_Symbiflow``, if present.
``AMARANTH_ENV_SYMBIFLOW``, if present.
Available overrides:
* ``add_constraints``: inserts commands in XDC file.
@ -113,7 +113,7 @@ class XilinxPlatform(TemplatedPlatform):
* ``xc7frames2bit``
The environment is populated by running the script specified in the environment variable
``AMARANTH_ENV_Xray``, if present.
``AMARANTH_ENV_XRAY``, if present.
"""
toolchain = None # selected when creating platform