package hardcaml

  1. Overview
  2. Docs
RTL Hardware Design in OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (9)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.1.tar.gz
md5=7435ee8610c2205c5f912b4bf09163b0
sha512=38d7cf428bd3491024212e52776ac582183d7b5f6a494589a3697d9a213fa18347d6eeea23327859c340b0cb3b967c08cd21a8a7f8d15cf2de20e5598cb8456d

doc/hardcaml/Hardcaml/Signal_graph/index.html

Module Hardcaml.Signal_graphSource

A Signal_graph.t is a created from a list of signals, and defined by tracing back to inputs (unassigned wires or constants). Functions are provided for traversing the graph.

When traversing using depth_first_seach we can specify upto which means the search will stop when it reaches any signal in the given list (which is also /not/ included as part of the search).

Sourcetype t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval create : ?upto:Signal.t Base.list -> Signal.t Base.list -> t

Create a Signal_graph.t from a list of signals (commonly, circuit outputs).

Traverse the graph and find all inputs. Badly formed inputs (no name, or multiple names) return an error.

Sourceval outputs : ?validate:Base.bool -> t -> Signal.t Base.list Base.Or_error.t

Return the outputs of the signal graph. If validate is true, then the outputs are checked for compatibility with circuit outputs.

Visit all signals in the graph, starting at the outputs, in a depth-first manner. Each signal is visited only once. f_before is called before recursing on each signal's fan-in. Similiarly, f_after is called after recursing on the fan-in.

If deps is provided it will be used to compute signal dependencies rather than the default definition. This is useful for terminating traversals based on some condition on signals, e.g., if it's a register or a memory.

Sourceval fold : t -> init:'a -> f:('a -> Signal.t -> 'a) -> 'a

Fold across all signals in the graph, starting at the outputs. Each signal is visited only once.

Sourceval filter : t -> f:(Signal.t -> Base.bool) -> Signal.t Base.list

Return a list of all signals in the graph for whom f signal returns true.

Sourceval iter : t -> f:(Signal.t -> Base.unit) -> Base.unit

Iterate over all signals in the graph.

Sourceval detect_combinational_loops : t -> Base.unit Base.Or_error.t

Retuns an error if the graph has a combinational loop, that is, a path from a signal back to itself that doesn't pass though a register, memory or instantiation.

Sourceval normalize_uids : t -> t

normalize_uids t creates a copy of t that is identical to t except the uids are numbered starting at 1.

Fan-out of each signal in the signal graph. The fan-out of a signal is the set of signals it drives.

Fan-in of each signal in the signal graph. The fan-in of a signal is the set of signals that drive it.

Sourceval topological_sort : deps:(module Signal.Type.Deps) -> t -> (Signal.t Base.list, Signal.t Base.list) Base.Result.t

topological_sort t sorts the signals in t so that all the signals in deps s occur before s.

Sourceval topological_sort_exn : deps:(module Signal.Type.Deps) -> t -> Signal.t Base.list

Signal dependencies used for simulation scheduling. Breaks loops through sequential elements like registers and memories.

Like Deps_for_simulation_scheduling, except loops are allowed through instantiations.

Sourceval last_layer_of_nodes : is_input:(Signal.t -> Base.bool) -> t -> Signal.Type.Uid.t Base.List.t

Final layer of combinational nodes which sit on the path between the outputs and any driving register or memory.