Hierarchy (p.hardcaml.v0.15.0.doc.hardcaml.Hardcaml.Hierarchy)

Source

val hierarchical : 
  (module Interface.S_Of_signal with type Of_signal.t = 'i) ->
  (module Interface.S_Of_signal with type Of_signal.t = 'o) ->
  ?config:Circuit.Config.t ->
  ?instance:Base.string ->
  ?attributes:Rtl_attribute.t Base.list ->
  scope:Scope.t ->
  name:Base.string ->
  (Scope.t -> 'i -> 'o) ->
  'i ->
  'o

Sourcemodule With_interface (I : Interface.S) (O : Interface.S) : sig ... end

Sourcemodule In_scope (I : Interface.S) (O : Interface.S) : sig ... end

Support for hierarchically structured Hardcaml designs. We extend the standard Interface.Create_fn pattern so that the create function also takes a Scope.t argument. This allows scoping of signal names and automatic recording of the design in a Circuit_database.t.