Clash - A functional hardware description language
Clash is a functional hardware description language that borrows both
its syntax and semantics from the functional programming language
Haskell. The Clash compiler transforms these high-level descriptions to
low-level synthesizable VHDL, Verilog, or SystemVerilog.
Features of Clash:
-
Strongly typed, but with a very high degree of type inference, enabling both
safe and fast prototyping using concise descriptions. -
Interactive REPL: load your designs in an interpreter and easily test all
your component without needing to setup a test bench. -
Higher-order functions, with type inference, result in designs that are
fully parametric by default. -
Synchronous sequential circuit design based on streams of values, called
Signals, lead to natural descriptions of feedback loops. -
Support for multiple clock domains, with type safe clock domain crossing.
Community
Mailing list: for updates and questions join the mailing list clash-language+subscribe@googlegroups.com or read the forum
Slack: Invite yourself at fpchat-invite.herokuapp.com. To join #clash, click on "Channels" and search for "clash".
IRC: freenode#clash-lang
Installing Clash
Installing via Snap
Clash is released as a binary package on snapcraft. Snap is supported on all
major Linux distributions. Visit Clash’s snapcraft page,
scroll down, and choose your distribution for installation instructions. To
install the latest stable version, use:
snap install clash
To install the latest development version of Clash, run:
snap install clash --edge
This version is updated every 24 hours.
Installing via Source (Linux / MacOS)
Install the latest nix and run:
curl -s -L https://github.com/clash-lang/clash-compiler/archive/1.0.tar.gz, tar xz
nix-shell clash-compiler-1.0/shell.nix
See the releases page
for all available versions of the compiler.
Installing via Source (Windows)
- Install GHC Platform. Make sure to install Stack along with it.
- Download the source code of Clash 1.0
- Unpack the archive
- Use cd to navigate to the unpacked directory
- Run
stack build clash-ghc. This will take a while.
See the releases page
for all available versions of the compiler.
Installing via Source (HEAD)
Clone Clash from github using git and enter the cloned directory:
git clone https://github.com/clash-lang/clash-compiler.git
cd clash-compiler
Use one of the build tools below to get Clash up and running.
Cabal
Install Cabal >= 2.4 and GHC >= 8.4. Even though GHC 8.6 is supported, we currently recommend running 8.4 as the former contains some known bugs concerning documentation generation. If you're using Ubuntu, add HVR's PPA and install them using APT:
sudo add-apt-repository -u ppa:hvr/ghc
sudo apt install ghc-8.4.4 cabal-install-2.4
Add /opt/ghc/bin to your PATH. Finally, run Clash using cabal:
cabal new-run --write-ghc-environment-files=always -- clash
Stack
You can use Stack to build and run Clash too:
stack run -- clash
Nix
Or use Nix to get a shell with the clash and clashi binaries on your PATH:
nix-shell