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 read-write memory accessors for SyncReadMem (backport #3190) #3214

Merged
merged 1 commit into from
Apr 25, 2023

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Apr 25, 2023

This is an automatic backport of pull request #3190 done by Mergify.


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com


Original PR Body

Implements SyncReadMem.readWrite(address, writeData, enabled, isWrite) as a way to explicitly instantiate a readwrite port for a memory. This addresses the problem of unintentionally creating multiple read or write ports through multiple calls of SyncReadMem.read() and/or SyncReadMem.write(). Additionally, implements clocked and masked versions of readWrite for parity with the existing read and write functions.

Compare:

val myMem = SyncReadMem(100, UInt(32.W))
val readValue = myMem.read(someAddress)
when (timeToWrite)
  myMem.write(someAddress, valueToWrite)
when (timeToWrite) 
  myMem.write(someAddress, valueToWrite)

which instantiates a 1R2W memory, as opposed to

val myMem = SyncReadMem(100, UInt(32.W))
val rwPort = myMem.readWrite(someAddress, writeData, portEnabled, timeToWrite)

val readValue = rwPort
when (timeToWrite)
  writeData = valueToWrite
when (timeToWrite)
  writeData = differentValueToWrite

which instantiates a 1RW memory.

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 and merge

Release Notes

SyncReadMem.readWrite(address, writeData, enabled, isWrite) explicitly generates a read-write port that supports both read and write access to the memory.

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.

Adds new APIs to generate explicit read-write (rdwr) ports for a SyncReadMem, and all masked or clocked variants.
---------

Co-authored-by: Megan Wachs <megan@sifive.com>
(cherry picked from commit 1e6f2b4)
@mergify mergify bot added the Backport Automated backport, please consider for minor release label Apr 25, 2023
@mergify mergify bot merged commit 23367aa into 5.x Apr 25, 2023
@mergify mergify bot deleted the mergify/bp/5.x/pr-3190 branch April 25, 2023 23:36
@github-actions github-actions bot added the Feature New feature, will be included in release notes label May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport Automated backport, please consider for minor release Feature New feature, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant