package hardcaml
Not available on OCaml 5.5Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=1cc136550365918c5e72db328acf7bbf109f680bdacb60edb80972dee042a58d
Description
Hardcaml is an embedded DSL for designing and simulating hardware in OCaml. Generic hardware designs are easily expressed using features such as higher order functions, lists, maps etc. A built in simulator allows designs to be simulated within Hardcaml. Designs are converted to either Verilog or VHDL to interact with standard back end tooling.
Added to opam-repository:
README
"Hardcaml"

Hardcaml is an OCaml library for designing and testing hardware designs.
- Express hardware designs in OCaml
- Make generic designs using higher order functions, lists, maps, functors...
- Simulate designs in OCaml
- Convert to (hierarchical) Verilog or VHDL
- Write new modules to transform or analyse circuits, or provide new backends
Install
$ opam install hardcaml ppx_deriving_hardcaml hardcaml_wavetermDocumentation
Tools and libraries
Hardcaml_waveterm- ASCII based digital waveforms. Usable in expect tests or from an interactive terminal application.Hardcaml_c- convert Hardcaml designs to C-based simulation models. Provides an API compatible with the standard Cyclesim module. Trades compilation time for runtime performance.Hardcaml_verilator- Convert Hardcaml designs to very high speed simulation model using the open source Verilator compiler.Hardcaml_step_testbench- Monadic testbench API. Control multiple tasks synchronized to a clock without converting to a statemachine coding style.Hardcaml_circuits- A library of useful/interesting Hardcaml designsHardcaml_fixed_point- Fixed point arithmetic with rounding and overflow controlHardcaml_xilinx- Various Xilinx primitives wrapped with Hardcaml interfaces and simulation modelsHardcaml_xilinx_components- Tool to read Xilinx unisim and xpm component definitions and generate Hardcaml interfacesHardcaml_of_verilog- Convert a verilog design to Hardcaml using YosysHardcaml_verify- SAT based formal verification tools for HardcamlHardcaml_xilinx_reports- Automated generation of synthesis reports from Vivado.
Projects using Hardcaml
Hardcaml ZPrize- Multi-scalar Multiplication and Number Theoretic Transform accelerators.Hardcaml Mips- A simple 5-stage MIPs CPU with associated blog detailing the development process.Hardcaml_arty- Infrastructure targeting the Arty A7 board.Hardcaml Reed-Solomon- Configurable Reed-Solomon encoder and decoder implementation.Hardcaml JPEG- JPEG decoder design.
Dependencies (11)
-
zarith
>= "1.11" -
ppxlib
>= "0.28.0" -
dune
>= "2.0.0" -
topological_sort
>= "v0.16" & < "v0.17" -
stdio
>= "v0.16" & < "v0.17" -
ppx_sexp_conv
>= "v0.16" & < "v0.17" -
ppx_jane
>= "v0.16" & < "v0.17" -
core_kernel
>= "v0.16" & < "v0.17" -
bin_prot
>= "v0.16" & < "v0.17" -
base
>= "v0.16" & < "v0.17" -
ocaml
>= "4.14.0"
Dev Dependencies
None
Optional Dependencies
None
Used by (15)
- hardcaml-lua
-
hardcaml_axi
< "v0.17.0" -
hardcaml_c
= "v0.16.0" -
hardcaml_circuits
= "v0.16.0" -
hardcaml_fixed_point
= "v0.16.0" -
hardcaml_handshake
< "v0.17.0" -
hardcaml_of_verilog
= "v0.16.0" -
hardcaml_step_testbench
= "v0.16.0" -
hardcaml_verify
= "v0.16.0" -
hardcaml_verilator
= "v0.16.0" -
hardcaml_waveterm
= "v0.16.0" -
hardcaml_xilinx
= "v0.16.0" -
hardcaml_xilinx_components
= "v0.16.0" -
hardcaml_xilinx_reports
< "v0.17.0" -
ppx_deriving_hardcaml
>= "v0.16.0"
Conflicts
None
Build status
Results of building hardcaml with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.
Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.
| Version | OCaml 4.11 | OCaml 4.14 | OCaml 5.2 | OCaml 5.4 | OCaml 5.5 |
|---|---|---|---|---|---|
| v0.17.1 | n/a | n/a | n/a | good | good |
| v0.17.0 | n/a | n/a | good | n/a | n/a |
| v0.16.0 (this version) | n/a | good | good | n/a | n/a |
| v0.15.0 | good | good | good | n/a | n/a |
- good Package successfully built
- partial One of the dependencies failed to build
- bad Package failed to build
- n/a Package is not available in this environment
- internal Internal failure