Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

SRAM API: Add a parameter to initialize the memory #3364

Merged
merged 8 commits into from
Jun 22, 2023
Merged

Conversation

jared-barocsi
Copy link
Contributor

@jared-barocsi jared-barocsi commented Jun 15, 2023

This PR adds a new String parameter to SRAM.apply which loads the contents of a binary file from the filesystem into the memory (invokes loadMemoryFromFileInline on the inner SyncReadMem.)

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

Release Notes

SRAM.apply and SRAM.masked now take a contents parameter, by default a None, which is a string path to a binary file on the filesystem which the SRAM should be initialized with.

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.

@jackkoenig jackkoenig added Feature New feature, will be included in release notes and removed API Modification labels Jun 21, 2023
@jackkoenig jackkoenig added this to the 3.6.x milestone Jun 21, 2023
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.

Some comments about the API, also this needs a test, it can just check that the annotation is properly created.

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.

A few tweaks then LGTM

@jackkoenig jackkoenig enabled auto-merge (squash) June 22, 2023 20:41
@jackkoenig jackkoenig merged commit 2e95804 into main Jun 22, 2023
@jackkoenig jackkoenig deleted the sram-meminit branch June 22, 2023 22:23
@mergify mergify bot added the Backported This PR has been backported label Jun 22, 2023
mergify bot pushed a commit that referenced this pull request Jun 22, 2023
mergify bot pushed a commit that referenced this pull request Jun 22, 2023
mergify bot added a commit that referenced this pull request Jun 22, 2023
(cherry picked from commit 2e95804)

Co-authored-by: Jared Barocsi <82000041+jared-barocsi@users.noreply.github.com>
mergify bot added a commit that referenced this pull request Jun 22, 2023
(cherry picked from commit 2e95804)

Co-authored-by: Jared Barocsi <82000041+jared-barocsi@users.noreply.github.com>
# for free to join this conversation on GitHub. Already have an account? # 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