package hardcaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Comb with type comb = Signal.t
type comb = Signal.t
type t = comb t
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
val widths : t -> Base.Int.t t

Actual bit widths of each field.

val const : Base.Int.t -> t

Each field is set to the constant integer value provided.

val consts : Base.Int.t t -> t

consts c sets each field to the integer value in c using the declared field bit width.

val pack : ?rev:Base.Bool.t -> t -> comb

Pack interface into a vector.

val unpack : ?rev:Base.Bool.t -> comb -> t

Unpack interface from a vector.

val mux : comb -> t Base.List.t -> t

Multiplex a list of interfaces.

val mux2 : comb -> t -> t -> t
val concat : t Base.List.t -> t

Concatenate a list of interfaces.

val wires : ?named:Base.Bool.t -> ?from:t -> Base.Unit.t -> t

Create a wire for each field. If named is true then wires are given the RTL field name. If from is provided the wire is attached to each given field in from.

val assign : t -> t -> Base.Unit.t
val (<==) : t -> t -> Base.Unit.t
val inputs : Base.Unit.t -> t

inputs t is wires () ~named:true.

val outputs : t -> t

outputs t is wires () ~from:t ~named:true.