package hardcaml

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Hardcaml.RtlSource

include module type of struct include Rtl end
Sourcemodule Language : sig ... end
Sourcemodule Output_mode : sig ... end

RTL generation options.

Sourcemodule Blackbox : sig ... end

Control blackbox generation. None implies blackboxes are not used. Top means the circuit will be turned into a blackbox. Instantiations means that the top level circuit will be written as normal, but submodules will be written as blackboxes.

Sourcemodule Signals_name_map : sig ... end

Map signal names to mangled RTL names. This used in Hardcaml_verilator.

Sourceval output : ?output_mode:Output_mode.t -> ?database:Circuit_database.t -> ?blackbox:Blackbox.t -> Language.t -> Circuit.t -> Base.unit

Write circuit to Verilog or Vhdl. Instantiations are (recursively) looked up in database and if a circuit exists it is also written. The output_mode specifies how the circuit should be written - either to a single file (or buffer, or channel) or to a directory with one file for each for the top level circuit and any instantiated circuits contained in the database.

Sourceval print : ?database:Circuit_database.t -> ?blackbox:Blackbox.t -> Language.t -> Circuit.t -> Base.unit

print is output ~output_mode:(To_channel stdout)

Sourcemodule Digest : sig ... end
Sourcemodule Expert : sig ... end
Sourcemodule Ast : sig ... end
Sourcemodule Deprecated : sig ... end
Sourcemodule Name : sig ... end
Sourcemodule Verilog : sig ... end
Sourcemodule Vhdl : sig ... end
OCaml

Innovation. Community. Security.