object Select
Use to select Chisel components in a module, after that module has been constructed Useful for adding additional Chisel annotations or for use within an Aspect
- Source
- Select.scala
- Alphabetic
- By Inheritance
- Select
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
trait
Predicate extends Serializeable
Used to indicates a when's predicate (or its otherwise predicate)
-
case class
PredicatedConnect(preds: Seq[Predicate], loc: Data, exp: Data, isBulk: Boolean) extends Serializeable with Product with Serializable
Used to represent a connection or bulk connection
Used to represent a connection or bulk connection
Additionally contains the sequence of when predicates seen when the connection is declared
-
case class
Printf(preds: Seq[Predicate], pable: Printable, clock: Clock) extends Serializeable with Product with Serializable
Used to represent a chisel3.printf
- trait Serializeable extends AnyRef
-
case class
Stop(preds: Seq[Predicate], ret: Int, clock: Clock) extends Serializeable with Product with Serializable
Used to represent a chisel3.stop
-
case class
When(bool: Bool) extends Predicate with Product with Serializable
Used to represent chisel3.when predicate
Used to represent chisel3.when predicate
- bool
the when predicate
-
case class
WhenNot(bool: Bool) extends Predicate with Product with Serializable
Used to represent the
otherwise
predicate of a chisel3.whenUsed to represent the
otherwise
predicate of a chisel3.when- bool
the when predicate corresponding to this otherwise predicate
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
attachedTo(module: BaseModule)(signal: Data): Set[Data]
Selects all components who are attached to a given signal, within a module
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
collectDeep[T](module: BaseModule)(collector: PartialFunction[BaseModule, T]): Iterable[T]
Collects all components selected by collector within module and all children modules it instantiates directly or indirectly Accepts a collector partial function, rather than a collector function (see getDeep)
Collects all components selected by collector within module and all children modules it instantiates directly or indirectly Accepts a collector partial function, rather than a collector function (see getDeep)
- T
Type of the component that will be collected
- module
Module to collect components, as well as all children module it directly and indirectly instantiates
- collector
Collector partial function to pick, given a module, which components to collect
-
def
connectionsTo(module: BaseModule)(signal: Data): Seq[PredicatedConnect]
Selects all connections to a signal or its parent signal(s) (if the signal is an element of an aggregate signal) The when predicates surrounding each connection are included in the returned values
Selects all connections to a signal or its parent signal(s) (if the signal is an element of an aggregate signal) The when predicates surrounding each connection are included in the returned values
E.g. if signal = io.foo.bar, connectionsTo will return all connections to io, io.foo, and io.bar
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getDeep[T](module: BaseModule)(collector: (BaseModule) ⇒ Seq[T]): Seq[T]
Collects all components selected by collector within module and all children modules it instantiates directly or indirectly Accepts a collector function, rather than a collector partial function (see collectDeep)
Collects all components selected by collector within module and all children modules it instantiates directly or indirectly Accepts a collector function, rather than a collector partial function (see collectDeep)
- T
Type of the component that will be collected
- module
Module to collect components, as well as all children module it directly and indirectly instantiates
- collector
Collector function to pick, given a module, which components to collect
-
def
getIntermediateAndLeafs(d: Data): Seq[Data]
Return all expanded components, including intermediate aggregate nodes
Return all expanded components, including intermediate aggregate nodes
- d
Component to find leafs if aggregate typed. Intermediate fields/indicies ARE included
-
def
getLeafs(d: Data): Seq[Data]
Return just leaf components of expanded node
Return just leaf components of expanded node
- d
Component to find leafs if aggregate typed. Intermediate fields/indicies are not included
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
instances(module: BaseModule): Seq[BaseModule]
Selects all instances directly instantiated within given module
-
def
invalids(module: BaseModule): Seq[Data]
Selects all components who have been set to be invalid, even if they are later connected to
-
def
ios(module: BaseModule): Seq[Data]
Selects all ios directly contained within given module
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
memPorts(dir: MemPortDirection)(module: BaseModule): Seq[(Data, MemBase[_])]
Selects all memory ports of a given direction, including their memory
Selects all memory ports of a given direction, including their memory
- dir
The direction of memory ports to select
-
def
memPorts(module: BaseModule): Seq[(Data, MemPortDirection, MemBase[_])]
Selects all memory ports, including their direction and memory
-
def
mems(module: BaseModule): Seq[Mem[_]]
Selects all Mems directly contained within given module
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
ops(opKind: String)(module: BaseModule): Seq[Data]
Selects a kind of arithmetic or logical operator directly instantiated within given module The kind of operators are contained in chisel3.internal.firrtl.PrimOp
Selects a kind of arithmetic or logical operator directly instantiated within given module The kind of operators are contained in chisel3.internal.firrtl.PrimOp
- opKind
the kind of operator, e.g. "mux", "add", or "bits"
-
def
ops(module: BaseModule): Seq[(String, Data)]
Selects all arithmetic or logical operators directly instantiated within given module
-
def
printfs(module: BaseModule): Seq[Printf]
Selects all printf statements, and includes the predicates surrounding the printf statement
-
def
registers(module: BaseModule): Seq[Data]
Selects all registers directly instantiated within given module
-
def
stops(module: BaseModule): Seq[Stop]
Selects all stop statements, and includes the predicates surrounding the stop statement
-
def
syncReadMems(module: BaseModule): Seq[SyncReadMem[_]]
Selects all SyncReadMems directly contained within given module
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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( ... ) @native()
-
def
wires(module: BaseModule): Seq[Data]
Selects all wires in a module
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
,FixedPoint
,Clock
, andReg
, the abstract typesBits
,Aggregate
, andData
, and the aggregate typesBundle
andVec
.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.