package hardcaml_c

You can search for identifiers within the package.

in-package search v0.2.0

hardcaml_c
- Hardcaml_c
  - Cyclesim
    
    With_interface
    
    I
    
    All
    
    Comb
    
    Make_comb
    
    Comb
    
    Signed
    
    Sop
    
    Typed_math
    
    Unsigned
    
    Uop
    
    Names_and_widths
    
    Of_always
    
    Of_bits
    
    Of_signal
    
    Unsafe_assoc_by_port_name
    
    O
    
    All
    
    Comb
    
    Make_comb
    
    Comb
    
    Signed
    
    Sop
    
    Typed_math
    
    Unsigned
    
    Uop
    
    Names_and_widths
    
    Of_always
    
    Of_bits
    
    Of_signal
    
    Unsafe_assoc_by_port_name
  - Instance

Legend:
Library
Module
Module type
Parameter
Class
Class type

Helper functions to ease usage of the Always API when working with interfaces.

val value : Hardcaml.Always.Variable.t t -> Hardcaml.Signal.t t

val assign : 
  Hardcaml.Always.Variable.t t ->
  Hardcaml.Signal.t t ->
  Hardcaml.Always.t

Assign a interface containing variables in an always block.

val reg : 
  ?enable:Hardcaml.Signal.t ->
  Hardcaml.Reg_spec.t ->
  Hardcaml.Always.Variable.t t

Creates a interface container with register variables.

val wire : (Base.int -> Hardcaml.Signal.t) -> Hardcaml.Always.Variable.t t

Creates a interface container with wire variables, e.g. Foo.Of_always.wire Signal.zero, which would yield wires defaulting to zero.

val apply_names : 
  ?prefix:Base.string ->
  ?suffix:Base.string ->
  ?naming_op:(Hardcaml.Signal.t -> Base.string -> Hardcaml.Signal.t) ->
  Hardcaml.Always.Variable.t t ->
  Base.unit

Apply names to field of the interface. Add prefix and suffix if specified.