ClockDomain

chisel3.domains.ClockDomain
object ClockDomain extends Domain

A Clock Domain

This represents a collection of signals that toggle together. This does not necessarily mean that signals associated with this domain share a clock or will toggle in a predictable way. I.e., this domain can be used to describe asynchronous signals or static signals (like strap pins).

Attributes

Source
ClockDomain.scala
Graph
Supertypes
class Domain
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

override def fields: Seq[(String, Type)]

A sequence of name--type pairs that define the schema for this domain.

A sequence of name--type pairs that define the schema for this domain.

The fields comprise the information that a user, after Verilog generation, should set in order to interact with, generate collateral files related to, or check the correctness of their choices for a domain.

Alternatively, the fields are the "parameters" for the domain. E.g., a clock domain could be parameterzied by an integer frequency. Chisel itself has no knowledge of this frequency, nor does it need a frequency to generate Verilog. However, in order to generate an implementation constraints file, the user must provide a frequency.

To change the fields from the default, override this method in your domain.

override def fields: Seq[(String, Field.Type)] = Seq(
 "foo" -> Field.Boolean
)

Attributes

Definition Classes
Source
ClockDomain.scala

Inherited methods

final def Type(): Type

Construct a type of this domain kind.

Construct a type of this domain kind.

For a given domain, this is used to create a Chisel type which can be used in a port. This is typically used to create domain type ports.

E.g., to create a chisel3.domains.ClockDomain port, use:

import chisel3.domains.ClockDomain

val A = IO(Input(ClockDomain.Type()))

Attributes

Inherited from:
Domain
Source
Domain.scala

Implicits

Inherited implicits

implicit val sourceInfo: SourceInfo

Attributes

Inherited from:
Domain
Source
Domain.scala