PeekPokeTester doesn't work with StrongEnum

Type of issue: bug report

Impact: API addition (no impact on existing code)

Development Phase: request

Chisel version: 3.2-SNAPSHOT

Error messages:

poke:

[error] StateMachineTest.scala:42:00: overloaded method value poke with alternatives:
[error]   (signal: chisel3.core.Aggregate,value: IndexedSeq[BigInt])Unit <and>
[error]   (signal: chisel3.Bundle,map: Map[String,BigInt])Unit <and>
[error]   (signal: chisel3.Bits,value: Long)Unit <and>
[error]   (signal: chisel3.Bits,value: Int)Unit <and>
[error]   (signal: chisel3.Bits,value: BigInt)Unit <and>
[error]   (path: String,value: Long)Unit <and>
[error]   (path: String,value: Int)Unit <and>
[error]   (path: String,value: BigInt)Unit
[error]  cannot be applied to (MyStrongEnum.Type, MyStrongEnum.Type)
[error]   poke(dut.io.state, MyStrongEnum.Idle)

expect:

[error] StateMachineTest.scala:42:00: overloaded method value expect with alternatives:
[error]   (signal: chisel3.Bundle,expected: Map[String,BigInt])Boolean <and>
[error]   (signal: chisel3.core.Aggregate,expected: IndexedSeq[BigInt])Boolean <and>
[error]   (signal: chisel3.Bits,expected: BigInt,msg: => String)Boolean <and>
[error]   (good: Boolean,msg: => String)Boolean
[error]  cannot be applied to (MyStrongEnum.Type, MyStrongEnum.Type)
[error]   expect(dut.io.state, MyStrongEnum.Idle)

Internally, the StrongEnum Value items are assigned UInts, but there’s no way of accessing these from the outside world.

[hngenc]

@nhynes If you need enum testing support right away, then you can pull this branch: https://github.com/hngenc/chisel-testers/tree/add_enum_support. I haven’t tested it extensively, but it seems to work for examples like poke(dut.io.state, MyStrongEnum.Idle). If the reviewers are fine with my changes, then I should be able to upstream this soon.

[hngenc]

A conversion from EnumType to UInt would be great, but I can’t figure out how to do it outside of a Module. Maybe somebody who’s more familiar with the Chisel codebase will know, if its even possible.

@edwardcwang I considered that as well. As I understand it, we’d have to mix in the trait in chisel3, but it wouldn’t have any meaning except in chisel-testers which is a different project. That feels like a coding sin to me, but it would be a simple solution.