working amaranth fork for Pleiades
Find a file
Marcelina Kościelnicka 8c4a15ab92 hdl.mem: lower Memory directly to $mem_v2 RTLIL cell.
The design decision of using split memory ports in the internal
representation (copied from Yosys) was misguided and caused no end
of misery. Remove any uses of `$memrd`/`$memwr` and lower memories
directly to a combined memory cell, currently the RTLIL one.
2023-09-03 03:27:51 +00:00
.github CI: group all required workflows into one for the status check. 2023-08-08 13:13:14 +00:00
amaranth hdl.mem: lower Memory directly to $mem_v2 RTLIL cell. 2023-09-03 03:27:51 +00:00
docs hdl.mem: lower Memory directly to $mem_v2 RTLIL cell. 2023-09-03 03:27:51 +00:00
examples examples/uart: acknowledging RX data should deassert RX ready. 2021-12-16 13:31:32 +00:00
tests hdl.mem: lower Memory directly to $mem_v2 RTLIL cell. 2023-09-03 03:27:51 +00:00
.codecov.yml CI: disable codecov project status. 2020-10-25 00:13:39 +00:00
.coveragerc Rename nMigen to Amaranth HDL. 2021-12-10 10:34:13 +00:00
.git_archival.txt Configure git-archive to export information for setuptools_scm. 2023-02-02 23:43:33 +00:00
.gitattributes Configure git-archive to export information for setuptools_scm. 2023-02-02 23:43:33 +00:00
.gitignore Add PDM-related files to gitignore. 2023-07-21 03:57:06 +00:00
CONTRIBUTING.txt Rename nMigen to Amaranth HDL. 2021-12-10 10:34:13 +00:00
LICENSE.txt Update authorship notice. 2023-01-31 21:51:43 +00:00
pyproject.toml pyproject: add PDM scripts for reporting code coverage. 2023-08-22 16:22:09 +00:00
README.md README: add Matrix channel. 2023-07-19 22:21:51 +00:00
setup.py Add a workaround for python-poetry/poetry#7702. 2023-03-22 10:37:06 +00:00

Amaranth HDL (previously nMigen)

The Amaranth project provides an open-source toolchain for developing hardware based on synchronous digital logic using the Python programming language, as well as evaluation board definitions, a System on Chip toolkit, and more. It aims to be easy to learn and use, reduce or eliminate common coding mistakes, and simplify the design of complex hardware with reusable components.

The Amaranth toolchain consists of the Amaranth hardware definition language, the standard library, the simulator, and the build system, covering all steps of a typical FPGA development workflow. At the same time, it does not restrict the designers choice of tools: existing industry-standard (System)Verilog or VHDL code can be integrated into an Amaranth-based design flow, or, conversely, Amaranth code can be integrated into an existing Verilog-based design flow.

The development of Amaranth has been supported by LambdaConcept, ChipEleven, and Chipflow.

Introduction

See the Introduction section of the documentation.

Installation

See the Installation section of the documentation.

Supported devices

Amaranth can be used to target any FPGA or ASIC process that accepts behavioral Verilog-2001 as input. It also offers extended support for many FPGA families, providing toolchain integration, abstractions for device-specific primitives, and more. Specifically:

  • Lattice iCE40 (toolchains: Yosys+nextpnr, LSE-iCECube2, Synplify-iCECube2);
  • Lattice MachXO2 (toolchains: Diamond);
  • Lattice MachXO3L (toolchains: Diamond);
  • Lattice ECP5 (toolchains: Yosys+nextpnr, Diamond);
  • Xilinx Spartan 3A (toolchains: ISE);
  • Xilinx Spartan 6 (toolchains: ISE);
  • Xilinx 7-series (toolchains: Vivado);
  • Xilinx UltraScale (toolchains: Vivado);
  • Intel (toolchains: Quartus);
  • Quicklogic EOS S3 (toolchains: Yosys+VPR).

FOSS toolchains are listed in bold.

Community

Amaranth has a dedicated IRC channel, #amaranth-lang at libera.chat, which is bridged1 to Matrix at #amaranth-lang:matrix.org. Feel free to join to ask questions about using Amaranth or discuss ongoing development of Amaranth and its related projects.

License

Amaranth is released under the very permissive two-clause BSD license. Under the terms of this license, you are authorized to use Amaranth for closed-source proprietary designs.


  1. The same messages appear on IRC and on Matrix, and one can participate in the discussion equally using either communication system. ↩︎