Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Reg() to properly handle clocks as rvalues (backport #3775) #3779

Merged
merged 4 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/src/main/scala/chisel3/Reg.scala
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ object Reg {
val t = source // evaluate once (passed by name)
requireIsChiselType(t, "reg type")
val reg = if (!t.mustClone(prevId)) t else t.cloneTypeFull
val clock = Node(Builder.forcedClock)
val clock = Builder.forcedClock.ref

reg.bind(RegBinding(Builder.forcedUserModule, Builder.currentWhen))
pushCommand(DefReg(sourceInfo, reg, clock))
Expand Down
36 changes: 0 additions & 36 deletions src/test/scala/chiselTests/Clock.scala

This file was deleted.

85 changes: 85 additions & 0 deletions src/test/scala/chiselTests/ClockSpec.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
// SPDX-License-Identifier: Apache-2.0

package chiselTests

import chisel3._
import chisel3.testers.BasicTester
import circt.stage.ChiselStage

class ClockAsUIntTester extends BasicTester {
assert(true.B.asClock.asUInt === 1.U)
assert(true.B.asClock.asBool === true.B)
stop()
}

class WithClockAndNoReset extends RawModule {
val clock1 = IO(Input(Clock()))
val clock2 = IO(Input(Clock()))
val in = IO(Input(Bool()))
val out = IO(Output(Bool()))
val a = withClock(clock2) {
RegNext(in)
}

out := a
}

class ClockSpec extends ChiselPropSpec {
property("Bool.asClock.asUInt should pass a signal through unaltered") {
assertTesterPasses { new ClockAsUIntTester }
}

property("Should be able to use withClock in a module with no reset") {
val circuit = ChiselStage.emitCHIRRTL(new WithClockAndNoReset)
circuit.contains("reg a : UInt<1>, clock2") should be(true)
}

property("Chisel should give a decent error message if you use an unbound Clock") {
val e = the[ChiselException] thrownBy (
ChiselStage.emitCHIRRTL(
new RawModule {
withClock(Clock()) {
val r = Reg(UInt(8.W))
}
},
args = Array("--throw-on-first-error")
)
)
e.getMessage should include(
"'Clock' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?"
)
}

property("Chisel should give a decent error message if you use a Clock from another scope") {
val e = the[ChiselException] thrownBy (
ChiselStage.emitCHIRRTL(
new RawModule {
override def desiredName = "Parent"
val child = Module(new RawModule {
override def desiredName = "Child"
val clock = Wire(Clock())
})
withClock(child.clock) {
val r = Reg(UInt(8.W))
}
},
args = Array("--throw-on-first-error")
)
)
e.getMessage should include(
"operand 'Child.clock: Wire[Clock]' is not visible from the current module"
)
}

property("Chisel should support Clocks from views") {
import chisel3.experimental.dataview._
val chirrtl = ChiselStage.emitCHIRRTL(new RawModule {
val clock = IO(Clock())
val view = clock.viewAs[Clock]
withClock(view) {
val r = Reg(UInt(8.W))
}
})
chirrtl should include("reg r : UInt<8>, clock")
}
}
Loading