Clock

Instance Constructors

new Clock(width: Width = Width(1))

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def :=(that: ⇒ Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

Connect this data to that data mono-directionally and element-wise.
Connect this data to that data mono-directionally and element-wise.
This uses the MonoConnect algorithm.
that
the data to connect to

Definition Classes
Data
final def <>(that: ⇒ Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

Connect this data to that data bi-directionally and element-wise.
Connect this data to that data bi-directionally and element-wise.
This uses the BiConnect algorithm.
that
the data to connect to

Definition Classes
Data
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final macro def asBool(): Bool

Returns the contents of the clock wire as a Bool.
final def asInstanceOf[T0]: T0

Definition Classes
Any
macro def asTypeOf[T <: Data](that: T): T

Does a reinterpret cast of the bits in this node into the format that provides.
Does a reinterpret cast of the bits in this node into the format that provides. Returns a new Wire of that type. Does not modify existing nodes.
x.asTypeOf(that) performs the inverse operation of x := that.toBits.

Definition Classes
Data
Note
that should have known widths
,
bit widths are NOT checked, may pad or drop bits from input
final macro def asUInt(): UInt

Reinterpret cast to UInt.
Reinterpret cast to UInt.

Definition Classes
Data
Note
Aggregates are recursively packed with the first element appearing in the least-significant bits of the result.
,
value not guaranteed to be preserved: for example, a SInt of width 3 and value -1 (0b111) would become an UInt with value 7
def autoSeed(name: String): Clock.this.type

Takes the last seed suggested.
Takes the last seed suggested. Multiple calls to this function will take the last given seed, unless this HasId is a module port (see overridden method in Data.scala).
If the final computed name conflicts with the final name of another signal, the final name may get uniquified by appending a digit at the end of the name.
Is a lower priority than suggestName, in that regardless of whether autoSeed was called, suggestName will always take precedence if it was called.
returns
this object

Definition Classes
Data → HasId
def binding: Option[Binding]

Attributes
protected[chisel3]
Definition Classes
Data
def bindingToString: String

Attributes
protected
Definition Classes
Data
def binding_=(target: Binding): Unit

Attributes
protected
Definition Classes
Data
def circuitName: String

Attributes
protected
Definition Classes
HasId
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def cloneType: Clock.this.type

Internal API; Chisel users should look at chisel3.chiselTypeOf(...).
Internal API; Chisel users should look at chisel3.chiselTypeOf(...).
cloneType must be defined for any Chisel object extending Data. It is responsible for constructing a basic copy of the object being cloned.
returns
a copy of the object.

Definition Classes
Clock → Data
def computeName(defaultPrefix: Option[String], defaultSeed: Option[String]): Option[String]

Computes the name of this HasId, if one exists
Computes the name of this HasId, if one exists
defaultPrefix
Optionally provide a default prefix for computing the name
defaultSeed
Optionally provide default seed for computing the name
returns
the name, if it can be computed

Definition Classes
HasId
def connect(that: Data)(implicit sourceInfo: SourceInfo, connectCompileOptions: CompileOptions): Unit

Definition Classes
Clock → Data
def do_asBool(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

Definition Classes
Data
def do_asUInt(implicit sourceInfo: SourceInfo, connectCompileOptions: CompileOptions): UInt

Definition Classes
Clock → Data
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: Any): Boolean

Definition Classes
HasId → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getWidth: Int

Returns the width, in bits, if currently known.
Returns the width, in bits, if currently known.

Definition Classes
Data
def hasSeed: Boolean

returns
Whether either autoName or suggestName has been called

Definition Classes
HasId
def hashCode(): Int

Definition Classes
HasId → AnyRef → Any
def instanceName: String

Definition Classes
HasId → InstanceId
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isLit(): Boolean

Definition Classes
Data
final def isWidthKnown: Boolean

Returns whether the width is currently known.
Returns whether the width is currently known.

Definition Classes
Data
def litOption(): Option[BigInt]

If this is a literal that is representable as bits, returns the value as a BigInt.
If this is a literal that is representable as bits, returns the value as a BigInt. If not a literal, or not representable as bits (for example, is or contains Analog), returns None.

Definition Classes
Clock → Element → Data
def litValue(): BigInt

Returns the literal value if this is a literal that is representable as bits, otherwise crashes.
Returns the literal value if this is a literal that is representable as bits, otherwise crashes.

Definition Classes
Data
def name: String

Definition Classes
Element
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parentModName: String

Definition Classes
HasId → InstanceId
def parentPathName: String

Definition Classes
HasId → InstanceId
def pathName: String

Definition Classes
HasId → InstanceId
def suggestName(seed: ⇒ String): Clock.this.type

Takes the first seed suggested.
Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.
Is a higher priority than autoSeed, in that regardless of whether autoSeed was called, suggestName will always take precedence.
seed
The seed for the name of this component
returns
this object

Definition Classes
HasId
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def toAbsoluteTarget: ReferenceTarget

Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph
Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

Definition Classes
NamedComponent → InstanceId
final def toNamed: ComponentName

Returns a FIRRTL ComponentName that references this object
Returns a FIRRTL ComponentName that references this object

Definition Classes
NamedComponent → InstanceId
Note
Should not be called until circuit elaboration is complete
def toPrintable: Printable

Not really supported
Not really supported

Definition Classes
Clock → Data
def toString(): String

Definition Classes
Clock → AnyRef → Any
final def toTarget: ReferenceTarget

Returns a FIRRTL ReferenceTarget that references this object
Returns a FIRRTL ReferenceTarget that references this object

Definition Classes
NamedComponent → InstanceId
Note
Should not be called until circuit elaboration is complete
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def widthKnown: Boolean

Definition Classes
Element
final def widthOption: Option[Int]

Returns Some(width) if the width is known, else None.
Returns Some(width) if the width is known, else None.

Definition Classes
Data

Deprecated Value Members

def litArg(): Option[LitArg]

Definition Classes
Data
Annotations
@deprecated
Deprecated
(Since version 3.2) litArg is deprecated, use litOption or litTo*Option

Related Docs: object Clock | package chisel3

sealed class Clock extends Element

Instance Constructors

new Clock(width: Width = Width(1))

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def :=(that: ⇒ Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

final def <>(that: ⇒ Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

final def ==(arg0: Any): Boolean

final macro def asBool(): Bool

final def asInstanceOf[T0]: T0

macro def asTypeOf[T <: Data](that: T): T

final macro def asUInt(): UInt

def autoSeed(name: String): Clock.this.type

def binding: Option[Binding]

def bindingToString: String

def binding_=(target: Binding): Unit

def circuitName: String

def clone(): AnyRef

def cloneType: Clock.this.type

def computeName(defaultPrefix: Option[String], defaultSeed: Option[String]): Option[String]

def connect(that: Data)(implicit sourceInfo: SourceInfo, connectCompileOptions: CompileOptions): Unit

def do_asBool(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

def do_asUInt(implicit sourceInfo: SourceInfo, connectCompileOptions: CompileOptions): UInt

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def getWidth: Int

def hasSeed: Boolean

def hashCode(): Int

def instanceName: String

final def isInstanceOf[T0]: Boolean

def isLit(): Boolean

final def isWidthKnown: Boolean

def litOption(): Option[BigInt]

def litValue(): BigInt

def name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parentModName: String

def parentPathName: String

def pathName: String

def suggestName(seed: ⇒ String): Clock.this.type

final def synchronized[T0](arg0: ⇒ T0): T0

final def toAbsoluteTarget: ReferenceTarget

final def toNamed: ComponentName

def toPrintable: Printable

def toString(): String

final def toTarget: ReferenceTarget

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def widthKnown: Boolean

final def widthOption: Option[Int]

Deprecated Value Members

def litArg(): Option[LitArg]

Inherited from Element

Inherited from Data

Inherited from SourceInfoDoc

Inherited from NamedComponent

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Connect

SourceInfoTransformMacro

Ungrouped