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

Add modulePorts and fullModulePorts in DataMirror for Instance #4076

Merged
merged 7 commits into from
May 22, 2024

Conversation

debs-sifive
Copy link
Contributor

@debs-sifive debs-sifive commented May 21, 2024

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: The PR will be squashed and merged (choose this if you have no preference).

Release Notes

Added modulePorts and fullModulePorts methods in DataMirror that returns all ports on an Instance of a module.

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.

@debs-sifive debs-sifive added the Feature New feature, will be included in release notes label May 21, 2024
@debs-sifive debs-sifive requested review from azidar and jackkoenig May 21, 2024 16:23
@debs-sifive debs-sifive changed the title Add fullModulePorts in DataMirror for Instance Add modulePorts and fullModulePorts in DataMirror for Instance May 21, 2024
Copy link
Contributor

@jackkoenig jackkoenig left a comment

Choose a reason for hiding this comment

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

Looks good but please see comments on tests.

Also this is failing to generate ScalaDoc due to ambiguous links. Theoretically it's possible to disambiguate them but I find ScalaDoc to be super flakey on that so just replace the [[ and ]] around [[DataMirror.modulePorts]] with backticks and call it a day. You can reproduce the failure with sbt "unipublish / unidoc"

src/test/scala/chiselTests/reflect/DataMirrorSpec.scala Outdated Show resolved Hide resolved
src/test/scala/chiselTests/reflect/DataMirrorSpec.scala Outdated Show resolved Hide resolved
src/test/scala/chiselTests/reflect/DataMirrorSpec.scala Outdated Show resolved Hide resolved
@jackkoenig jackkoenig added this to the 6.x milestone May 22, 2024
@jackkoenig jackkoenig merged commit 62bbad5 into main May 22, 2024
15 checks passed
@jackkoenig jackkoenig deleted the inst-ports branch May 22, 2024 03:56
@mergify mergify bot added the Backported This PR has been backported label May 22, 2024
mergify bot pushed a commit that referenced this pull request May 22, 2024
(cherry picked from commit 62bbad5)

# Conflicts:
#	core/src/main/scala/chisel3/reflect/DataMirror.scala
#	src/test/scala/chiselTests/reflect/DataMirrorSpec.scala
chiselbot pushed a commit that referenced this pull request May 22, 2024
…ort #4076) (#4077)

* Add modulePorts and fullModulePorts in DataMirror for Instance (#4076)

(cherry picked from commit 62bbad5)

# Conflicts:
#	core/src/main/scala/chisel3/reflect/DataMirror.scala
#	src/test/scala/chiselTests/reflect/DataMirrorSpec.scala

* Resolve backport conflicts

---------

Co-authored-by: Deborah Soung <[email protected]>
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