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

Make SRAMInterface parameters publicly available #3826

Merged
merged 2 commits into from
Feb 16, 2024

Conversation

debs-sifive
Copy link
Contributor

@debs-sifive debs-sifive commented Feb 16, 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

Desired Merge Strategy

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

Release Notes

memSize, dataType, numReadPorts, numWritePorts, numReadwritePorts, masked parameters are now visible for SRAMInterface.

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.

numReadwritePorts: Int,
masked: Boolean = false)
val memSize: BigInt,
val tpe: T,
Copy link
Contributor

Choose a reason for hiding this comment

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

This actually can't be public in this way because making an argument to a class a val makes it a public field of the class in a way that is indistinguishable with public vals in the body. Since this is of type Data, it will become a field of the Bundle.

Instead, you can keep tpe not a val but add a public def below that just returns it, something like def dataType: T = tpe

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm I'm actually thinking of putting this into a case class so the whole interface doesn't have to get passed around all the time (per what Megan said). So that should avoid the Data issue

Copy link
Contributor Author

@debs-sifive debs-sifive Feb 16, 2024

Choose a reason for hiding this comment

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

ok nvm, switching to your suggested getter because of what Andrew said

using case classes has the long-term issue of dead fields

@jackkoenig jackkoenig added Feature New feature, will be included in release notes and removed API Modification labels Feb 16, 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.

Note that "API Modification" means breaking something, just making stuff public is a new "Feature"

@debs-sifive debs-sifive merged commit 8f0196f into main Feb 16, 2024
16 checks passed
@debs-sifive debs-sifive deleted the debs-sifive/sram-publicvals branch February 16, 2024 21:20
@jackkoenig jackkoenig modified the milestones: 3.6.x, 5.x Feb 16, 2024
@mergify mergify bot added the Backported This PR has been backported label Feb 16, 2024
mergify bot pushed a commit that referenced this pull request Feb 16, 2024
mergify bot pushed a commit that referenced this pull request Feb 16, 2024
chiselbot pushed a commit that referenced this pull request Feb 16, 2024
(cherry picked from commit 8f0196f)

Co-authored-by: Deborah Soung <debs@sifive.com>
chiselbot pushed a commit that referenced this pull request Feb 16, 2024
(cherry picked from commit 8f0196f)

Co-authored-by: Deborah Soung <debs@sifive.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 Feature New feature, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants