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

Support literals and DontCare in DataView targets #3389

Merged
merged 2 commits into from
Jun 27, 2023

Conversation

jackkoenig
Copy link
Contributor

The best example of why this is useful is the test showing some possible uses with Valid:

object ValidExtensions {
  implicit def view[T <: Data] = DataView[T, Valid[T]](
    x => Valid(x.cloneType), // Valid will strip direction with `Output(...)` anyway
    _ -> _.bits,
    (_, v) => true.B -> v.valid
  )
}

This enables you to box any T as a Valid[T] where the valid bit is the literal true:

import ValidExtensions._
class MyModule extends Module {
  val in = IO(Input(UInt(8.W)))
  val out= IO(Output(Valid(UInt(8.W))))
  out := in.viewAs[Valid[UInt]]
}

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Feature (or new API)

Desired Merge Strategy

  • Squash

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.5.x or 3.6.x depending on impact, API modification or big change: 5.0.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@jackkoenig jackkoenig added the Feature New feature, will be included in release notes label Jun 27, 2023
@jackkoenig jackkoenig added this to the 3.6.x milestone Jun 27, 2023
@jackkoenig jackkoenig requested a review from seldridge June 27, 2023 22:56
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice feature improvement. The valid view is pretty slick.

Comment on lines +57 to +63
object ValidExtensions {
implicit def view[T <: Data] = DataView[T, Valid[T]](
x => Valid(x.cloneType), // Valid will strip direction with `Output(...)` anyway
_ -> _.bits,
(_, v) => true.B -> v.valid
)
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a public utility?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably, we need to figure out a general coding style for such methods. I think it should probably be a factory method on object Valid rather than making people call .viewAs[Valid[CorrectType]]. The problem is that the natural answer would be Valid.apply, but that is obviously taken by the factory for making types rather than values. It's sort of the "VecInit" pattern (but obviously that name is not the best), and if we can come up with a decent "standard", I think this would be a great example of it.

@jackkoenig jackkoenig merged commit 0f803cd into main Jun 27, 2023
@jackkoenig jackkoenig deleted the jackkoenig/dataview-enhancements branch June 27, 2023 23:21
@mergify mergify bot added the Backported This PR has been backported label Jun 27, 2023
mergify bot pushed a commit that referenced this pull request Jun 27, 2023
(cherry picked from commit 0f803cd)

# Conflicts:
#	src/test/scala/chiselTests/experimental/DataView.scala
mergify bot pushed a commit that referenced this pull request Jun 27, 2023
(cherry picked from commit 0f803cd)

# Conflicts:
#	src/test/scala/chiselTests/experimental/DataView.scala
mergify bot added a commit that referenced this pull request Jun 28, 2023
…3391)

* Support literals and DontCare in DataView targets (#3389)

(cherry picked from commit 0f803cd)

# Conflicts:
#	src/test/scala/chiselTests/experimental/DataView.scala

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <[email protected]>
mergify bot added a commit that referenced this pull request Jun 28, 2023
…3390)

* Support literals and DontCare in DataView targets (#3389)

(cherry picked from commit 0f803cd)

# Conflicts:
#	src/test/scala/chiselTests/experimental/DataView.scala

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Feature New feature, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants