Module Hardcaml_kernel.Rtl_attributeSource

RTL attribute specification. Only relevant to downstream tooling.

Sourcetype t

Specification of attributes which may be attached to various objects within a RTL design. Such attributes are used to provide implementation hints to down stream CAD tools and do not affect any functionality within Hardcaml.

include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
include sig ... end
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : t Bin_prot.Read.vtag_reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
include Ppx_compare_lib.Comparable.S__local with type t := t
include Ppx_compare_lib.Equal.S with type t := t
Sourceval equal : t -> t -> bool
include Ppx_compare_lib.Equal.S__local with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Comparator.S with type t := t
Sourcetype comparator_witness : value mod nonportable
Sourcemodule Value : sig ... end

Attribute value types.

Sourcemodule Applies_to : sig ... end
Sourceval create : ?applies_to:Applies_to.t list -> ?value:Value.t -> string -> t

Create a new attribute. applies_to, if specified, constrains what type of signal the attribute may be applied to.

Sourceval name : t -> string

Returns the attribute name

Sourceval value : t -> Value.t option

Returns the attribute value, if any.

Sourceval applies_to : t -> Applies_to.t list

Signal types that the attribute may be attached to.

Sourcemodule Vivado : sig ... end

A collection of common Xilinx Vivado attributes.