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 test for FlatIO port ordering #4113

Merged
merged 3 commits into from
May 30, 2024
Merged

add test for FlatIO port ordering #4113

merged 3 commits into from
May 30, 2024

Conversation

mwachs5
Copy link
Contributor

@mwachs5 mwachs5 commented May 30, 2024

This is just a unit test. I thought going into writing the test that FlatIO maybe was not working as we intended, but i think it is just general misunderstanding of how Record and Bundle treat their elements.

This might be more of a test of CIRCT's lowering ABI, but firtool internally considers the port order part of the contract (not just the name of the signals), so check that we are doing what is sane here.

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

  • Internal or build-related (includes code refactoring/cleanup)

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference).

Release Notes

Added a unit test for FlatIO Ordering being maintained

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.

@mwachs5 mwachs5 added the Internal Internal change, does not affect users, will be included in release notes label May 30, 2024
@mwachs5 mwachs5 added this to the 6.x milestone May 30, 2024
@mwachs5 mwachs5 requested review from mikeurbach and jackkoenig May 30, 2024 06:48
Comment on lines +95 to +102
matchesAndOmits(
ChiselStage.emitSystemVerilog(new MyModule)
)("io_foo,")("io_bar,")

matchesAndOmits(
ChiselStage.emitSystemVerilog(new MyFlatIOModule)
)("foo,")("bar,")
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Clever, I need to just finish and merge #3410 as that would be a good way to test this.

I wonder if we should also check Vec and also check recursive order...

@jackkoenig jackkoenig modified the milestones: 6.x, 5.x May 30, 2024
@jackkoenig jackkoenig merged commit c3c9979 into main May 30, 2024
15 checks passed
@jackkoenig jackkoenig deleted the flatio-order branch May 30, 2024 15:52
@mergify mergify bot added the Backported This PR has been backported label May 30, 2024
mergify bot pushed a commit that referenced this pull request May 30, 2024
(cherry picked from commit c3c9979)

# Conflicts:
#	src/test/scala/chiselTests/experimental/FlatIOSpec.scala
mergify bot pushed a commit that referenced this pull request May 30, 2024
chiselbot pushed a commit that referenced this pull request May 30, 2024
* Add test for FlatIO port ordering (#4113)

(cherry picked from commit c3c9979)

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

* Added MatchesOrOmits

* Resolve backport conflicts

---------

Co-authored-by: Megan Wachs <[email protected]>
Co-authored-by: Adam Izraelevitz <[email protected]>
Co-authored-by: Jack Koenig <[email protected]>
chiselbot pushed a commit that referenced this pull request May 30, 2024
(cherry picked from commit c3c9979)

Co-authored-by: Megan Wachs <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
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 Internal Internal change, does not affect users, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants