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

Implement Lookupable for Unit #4497

Merged
merged 1 commit into from
Nov 7, 2024
Merged

Implement Lookupable for Unit #4497

merged 1 commit into from
Nov 7, 2024

Conversation

jackkoenig
Copy link
Contributor

An oft-overlooked primitive type but an important one nonetheless!

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.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.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 Nov 7, 2024
@jackkoenig jackkoenig added this to the 6.x milestone Nov 7, 2024
Copy link
Contributor

@debs-sifive debs-sifive left a comment

Choose a reason for hiding this comment

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

Thanks!

@mwachs5
Copy link
Contributor

mwachs5 commented Nov 7, 2024

I approved, but isn't there an error message about what the types are allowed that we should add Unit to:

@public is only legal within a class or trait marked @instantiable, and only on vals of type Data, BaseModule, MemBase, IsInstantiable, IsLookupable, or Instance[_], or in an Iterable, Option, Either, or Tuple2

@jackkoenig
Copy link
Contributor Author

I approved, but isn't there an error message about what the types are allowed that we should add Unit to:

@public is only legal within a class or trait marked @instantiable, and only on vals of type Data, BaseModule, MemBase, IsInstantiable, IsLookupable, or Instance[_], or in an Iterable, Option, Either, or Tuple2

We ought to, but note there are a lot of other types that should also be listed (if we're to list them all), including Int, Float, Double, BigInt`...

We could link to the object Lookupable ScalaDoc for the complete list: https://www.chisel-lang.org/api/latest/chisel3/experimental/hierarchy/core/Lookupable$.html

But more fundamentally, I think we should make it easier to implement Lookupable for your own type, which needs some improvements on the Chisel API side and needs docs (probably on this page: https://www.chisel-lang.org/docs/cookbooks/hierarchy) in which case we should just link to that.

@jackkoenig jackkoenig enabled auto-merge (squash) November 7, 2024 20:01
@jackkoenig jackkoenig merged commit 48866a9 into main Nov 7, 2024
18 checks passed
@jackkoenig jackkoenig deleted the lookupable-unit branch November 7, 2024 20:06
@mergify mergify bot added the Backported This PR has been backported label Nov 7, 2024
mergify bot pushed a commit that referenced this pull request Nov 7, 2024
(cherry picked from commit 48866a9)

# Conflicts:
#	src/test/scala/chiselTests/experimental/hierarchy/InstanceSpec.scala
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.

3 participants