diff options
Diffstat (limited to 'chiselFrontend')
4 files changed, 27 insertions, 36 deletions
diff --git a/chiselFrontend/src/main/scala/chisel3/core/Annotation.scala b/chiselFrontend/src/main/scala/chisel3/core/Annotation.scala index b2c9ea78..b7e82f63 100644 --- a/chiselFrontend/src/main/scala/chisel3/core/Annotation.scala +++ b/chiselFrontend/src/main/scala/chisel3/core/Annotation.scala @@ -5,7 +5,6 @@ package chisel3.core import scala.language.existentials import chisel3.internal.{Builder, InstanceId} -import chisel3.core.ImplicitModule import firrtl.Transform import firrtl.annotations.{Annotation, CircuitName, ComponentName, ModuleName} import firrtl.transforms.{DontTouchAnnotation, NoDedupAnnotation} @@ -30,9 +29,10 @@ object ChiselAnnotation { } } -/** Mixin for [[ChiselAnnotation]] that instantiates an associated FIRRTL Transform when this - * Annotation is present during a run of [[chisel3.Driver.execute]]. Automatic Transform - * instantiation is *not* supported when the Circuit and Annotations are serialized before invoking +/** Mixin for [[ChiselAnnotation]] that instantiates an associated FIRRTL Transform when this Annotation is present + * during a run of + * [[Driver$.execute(args:Array[String],dut:()=>chisel3\.experimental\.RawModule)* Driver.execute]]. + * Automatic Transform instantiation is *not* supported when the Circuit and Annotations are serialized before invoking * FIRRTL. */ // TODO There should be a FIRRTL API for this instead @@ -99,7 +99,7 @@ object dontTouch { // scalastyle:ignore object.name * val b = Input(UInt(32.W)) * val out = Output(UInt(32.W)) * }) - * override def desiredName = s"adder_$myNname" + * override def desiredName = "adder_" + myNname * io.out := io.a + io.b * }) * doNotDedup(m) diff --git a/chiselFrontend/src/main/scala/chisel3/core/Bits.scala b/chiselFrontend/src/main/scala/chisel3/core/Bits.scala index 424db5cb..b18b27e5 100644 --- a/chiselFrontend/src/main/scala/chisel3/core/Bits.scala +++ b/chiselFrontend/src/main/scala/chisel3/core/Bits.scala @@ -1285,7 +1285,7 @@ sealed class Bool() extends UInt(1.W) with Reset { * * @param that a hardware $coll * @return the lgocial or of this $coll and `that` - * @note this is equivalent to [[Bool.|]] + * @note this is equivalent to [[Bool!.|(that:chisel3\.core\.Bool)* Bool.|)]] * @group Logical */ def || (that: Bool): Bool = macro SourceInfoTransform.thatArg @@ -1297,7 +1297,7 @@ sealed class Bool() extends UInt(1.W) with Reset { * * @param that a hardware $coll * @return the lgocial and of this $coll and `that` - * @note this is equivalent to [[Bool.&]] + * @note this is equivalent to [[Bool!.&(that:chisel3\.core\.Bool)* Bool.&]] * @group Logical */ def && (that: Bool): Bool = macro SourceInfoTransform.thatArg diff --git a/chiselFrontend/src/main/scala/chisel3/core/Data.scala b/chiselFrontend/src/main/scala/chisel3/core/Data.scala index 7ff58b54..3ce79786 100644 --- a/chiselFrontend/src/main/scala/chisel3/core/Data.scala +++ b/chiselFrontend/src/main/scala/chisel3/core/Data.scala @@ -498,7 +498,7 @@ abstract class Data extends HasId with NamedComponent with SourceInfoDoc { // sc case Some(BundleLitBinding(litMap)) => None // this API does not support Bundle literals case _ => None } - + def isLit(): Boolean = litArg.isDefined /** @@ -567,9 +567,8 @@ abstract class Data extends HasId with NamedComponent with SourceInfoDoc { // sc } trait WireFactory { - /** @usecase def apply[T <: Data](t: T): T - * Construct a [[Wire]] from a type template - * @param t The template from which to construct this wire + /** Construct a [[Wire]] from a type template + * @param t The template from which to construct this wire */ def apply[T <: Data](t: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = { if (compileOptions.declaredTypeMustBeUnbound) { @@ -681,29 +680,25 @@ object WireDefault { x } - /** @usecase def apply[T <: Data](t: T, init: DontCare.type): T - * Construct a [[Wire]] with a type template and a [[DontCare]] default - * @param t The type template used to construct this [[Wire]] - * @param init The default connection to this [[Wire]], can only be [[DontCare]] - * @note This is really just a specialized form of `apply[T <: Data](t: T, init: T): T` with [[DontCare]] - * as `init` + /** Construct a [[Wire]] with a type template and a [[chisel3.DontCare]] default + * @param t The type template used to construct this [[Wire]] + * @param init The default connection to this [[Wire]], can only be [[DontCare]] + * @note This is really just a specialized form of `apply[T <: Data](t: T, init: T): T` with [[DontCare]] as `init` */ def apply[T <: Data](t: T, init: DontCare.type)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = { // scalastyle:ignore line.size.limit applyImpl(t, init) } - /** @usecase def apply[T <: Data](t: T, init: T): T - * Construct a [[Wire]] with a type template and a default connection - * @param t The type template used to construct this [[Wire]] - * @param init The hardware value that will serve as the default value + /** Construct a [[Wire]] with a type template and a default connection + * @param t The type template used to construct this [[Wire]] + * @param init The hardware value that will serve as the default value */ def apply[T <: Data](t: T, init: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = { applyImpl(t, init) } - /** @usecase def apply[T <: Data](init: T): T - * Construct a [[Wire]] with a default connection - * @param init The hardware value that will serve as a type template and default value + /** Construct a [[Wire]] with a default connection + * @param init The hardware value that will serve as a type template and default value */ def apply[T <: Data](init: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = { val model = (init match { @@ -745,4 +740,3 @@ private[chisel3] object DontCare extends Element { // DontCare's only match themselves. private[core] def typeEquivalent(that: chisel3.core.Data): Boolean = that == DontCare } - diff --git a/chiselFrontend/src/main/scala/chisel3/core/Reg.scala b/chiselFrontend/src/main/scala/chisel3/core/Reg.scala index 27156f8b..747fad73 100644 --- a/chiselFrontend/src/main/scala/chisel3/core/Reg.scala +++ b/chiselFrontend/src/main/scala/chisel3/core/Reg.scala @@ -30,10 +30,9 @@ import chisel3.internal.sourceinfo.{SourceInfo} * */ object Reg { - /** @usecase def apply[T <: Data](t: T): T - * Construct a [[Reg]] from a type template with no initialization value (reset is ignored). - * Value will not change unless the [[Reg]] is given a connection. - * @param t The template from which to construct this wire + /** Construct a [[Reg]] from a type template with no initialization value (reset is ignored). + * Value will not change unless the [[Reg]] is given a connection. + * @param t The template from which to construct this wire */ def apply[T <: Data](t: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = { if (compileOptions.declaredTypeMustBeUnbound) { @@ -143,10 +142,9 @@ object RegNext { * }}} */ object RegInit { - /** @usecase def apply[T <: Data](t: T, init: T): T - * Construct a [[Reg]] from a type template initialized to the specified value on reset - * @param t The type template used to construct this [[Reg]] - * @param init The value the [[Reg]] is initialized to on reset + /** Construct a [[Reg]] from a type template initialized to the specified value on reset + * @param t The type template used to construct this [[Reg]] + * @param init The value the [[Reg]] is initialized to on reset */ def apply[T <: Data](t: T, init: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = { if (compileOptions.declaredTypeMustBeUnbound) { @@ -162,9 +160,8 @@ object RegInit { reg } - /** @usecase def apply[T <: Data](init: T): T - * Construct a [[Reg]] initialized on reset to the specified value. - * @param init Initial value that serves as a type template and reset value + /** Construct a [[Reg]] initialized on reset to the specified value. + * @param init Initial value that serves as a type template and reset value */ def apply[T <: Data](init: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = { val model = (init match { |