Domain

chisel3.domain.Domain

abstract class Domain()(implicit val sourceInfo: SourceInfo)

A Domain represents a kind information, and the schema of that information, that can be associated with certain hardware in a Chisel design.

A domain is intended to represent a specific kind of hardware-related concern that is not captured with the digital, synchronous logic that core Chisel represents. Examples of domains are clock, reset, and power domains. And while some domains are provided as part of Chisel, domain kinds are intentionall user-extensible.

To create a new user-defined domain kind, define an object that extends the Domain class. Add fields to define the domain's schema by overridding the fields method:

import chisel3.domain.{Domain, Field}

object FooDomain extends Domain {
 override def fields: Seq[(String, Field.Type)] = Seq(
   "bar" -> Field.Boolean,
   "baz" -> Field.Integer,
   "qux" -> Field.String
 )
}

Attributes

See also: chisel3.domains.ClockDomain
Source: Domain.scala
Graph
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object ClockDomain
Self type: Singleton

Members list

Value members

Concrete methods

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

Source: Domain.scala

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

Source: Domain.scala

Implicits

Attributes

Source: Domain.scala

In this article

Generated with