Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package domains
    Definition Classes
    chisel3
  • object ClockDomain extends Domain

    A Clock 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).

    Definition Classes
    domains
  • Relationship

object Relationship

Types of clock relationships

Source
ClockDomain.scala
Linear Supertypes
AnyRef, Any
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Relationship
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait Type extends AnyRef

    A clock relationship

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def assertRational(A: domain.Type, B: domain.Type): Unit

    Generate an assertion that two domains have a rational or synchronous relationship.

    Generate an assertion that two domains have a rational or synchronous relationship.

    This is a building block of writing safe clock domain synchronizers.

    A

    the first domain

    B

    the second domain

  6. def assertSynchronous(A: domain.Type, B: domain.Type): Unit

    Generate an assertion that two domains have a synchronous relationship.

    Generate an assertion that two domains have a synchronous relationship.

    This is a building block of writing safe clock domain synchronizers.

    A

    the first domain

    B

    the second domain

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. object Rational extends Type

    A rational relationship

    A rational relationship

    This indicates that two clocks have a deterministic phase relationship and a non-integer rational frequency ratio, e.g., 2:3. Both clocks must be derived from a common source clock, e.g., with a phase-locked-loop (PLL).

  23. object Synchronous extends Type

    A synchronous relationship

    A synchronous relationship

    This indicates that two clocks have a deterministic phase relationship and an integer frequency ratio, e.g., 1:1, 2:1, or 1:4. Both clocks must be derived from the same source via integer multiplication or division, e.g., using a clock divider.

Inherited from AnyRef

Inherited from Any

Ungrouped