Language & toolchain

Warning

This manual is a work in progress and is seriously incomplete!

• Introduction
  • The Amaranth language
  • The Amaranth standard library
  • The Amaranth simulator
  • The Amaranth build system
• Installation
  • In-browser playground
  • System requirements
  • Installing prerequisites
  • Installing Amaranth
  • Installing board definitions
• Getting started
  • A counter
  • A blinking LED
• Tutorial
• Language guide
  • The prelude
  • Shapes
  • Values
  • Constants
  • Shape casting
  • Value casting
  • Constant casting
  • Signals
  • Operators
  • Arrays
  • Data structures
  • Modules
  • Control domains
  • Control flow
  • Combinational evaluation
  • Synchronous evaluation
  • Assertions
  • Debug printing
  • Clock domains
  • Elaboration
  • Memories
  • I/O values
  • Instances
  • I/O buffer instances
• Language reference
  • Backwards compatibility
  • Importing syntax
  • Source locations
  • Shapes
  • Values
• Standard library
  • Enumerations
  • Data structures
  • Interfaces and connections
  • Interface metadata
  • Data streams
  • Memory arrays
  • Input/output buffers
  • Clock domain crossing
  • Code conversion
  • First-in first-out queues
  • Cyclic redundancy checks
• Simulator
  • Simulating circuits
  • Replacing circuits with code
  • Reference
• Platform integration
  • Altera
  • Gowin
  • Lattice
  • Quicklogic
  • SiliconBlue
  • Xilinx
• Changelog
  • Documentation for past releases
  • Version 0.5.3
  • Version 0.5.2
  • Version 0.5.1
  • Version 0.5.0
  • Version 0.4.0
  • Version 0.3
  • Versions 0.1, 0.2
• Contributing
  • Filing problem reports
  • Fixing problems
  • Proposing new features
  • Working with the codebase
  • Documentation style guide
  • Contributing your changes
  • Weekly meetings