Implement DecoupledIO.map utility #2646
Conversation
|
|
||
| implicit class DecoupledExtensions[A <: Data](x: DecoupledIO[A]) { | ||
| def map[B <: Data](f: A => B): DecoupledIO[B] = { | ||
| val res = f(x.bits) |
There was a problem hiding this comment.
What if this were called "bits" and wire was called "res"? Just looking at the names of the resulting signals
There was a problem hiding this comment.
Alternatively, it could just be wire.bits := f(x.bits), or I think I like map better as a name because it indicates that this came from calling .map.
Also, this might be a good opportunity to utilize #2580 by using _ as the leading character for names in this block (wire in particular isn't a super useful name in the Verilog, but map could be...).
There was a problem hiding this comment.
Use of the leading underscore seems good to me. Maybe _map or _mapped. Alternatively, don't create a val res here and just inline it. That'll create an unnamed node and that should get inlined? That would then motivate changing val wire to val _map.
Can you generate some examples of what the output looks like in Verilog for this?
jackkoenig
left a comment
jackkoenig
left a comment
There was a problem hiding this comment.
Minor suggestions for improvements to the tests, but otherwise, this looks great!
Co-authored-by: Jack Koenig <[email protected]>
jackkoenig
added
the
Please Merge
(cherry picked from commit b20df1d)
(cherry picked from commit b20df1d) Co-authored-by: Jared Barocsi <[email protected]>
6 participants
Addresses #1072: Implements a new utility for
Decoupledwhich applies a function to its data.Contributor Checklist
docs/src?Type of Improvement
API Impact
Decoupled.mapto apply a function to aDecoupledIOand return the new resultingDecoupledIOBackend Code Generation Impact
Desired Merge Strategy
Release Notes
Implement
DecoupledIO.mapto apply a function toDecoupledIO.bitsReviewer Checklist (only modified by reviewer)
3.4.x, [small] API extension:3.5.x, API modification or big change:3.6.0)?Enable auto-merge (squash), clean up the commit message, and label withPlease Merge.Create a merge commit.