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 support for Integer properties and conversion to FIRRTL. #3470

Merged

Conversation

mikeurbach
Copy link
Contributor

@mikeurbach mikeurbach commented Aug 8, 2023

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

The Integer property type is defined in FIRRTL spec version 3.1.0: https://github.com/chipsalliance/firrtl-spec/releases/tag/v3.1.0.

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, 3.6.x, or 5.x depending on impact, API modification or big change: 6.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.

@mikeurbach
Copy link
Contributor Author

mikeurbach commented Aug 8, 2023

This is an alternative to #3469.

There is more boilerplate for every new property type: instead of one line in the Converter and Property files, there are a few new lines in the IR, Converter, and Property files. But the upshot seems better: when you define your new property typeclass instance, you have to say how it converts to IR. Which means you have to add a new case object, which means you have to update the match statement in the converter. I sort of prefer this PR to #3469 , but curious what others think.

@mikeurbach mikeurbach force-pushed the mikeurbach/properties-int-alternate branch from 05aec56 to 29519f7 Compare August 8, 2023 17:27
@mikeurbach mikeurbach marked this pull request as ready for review August 8, 2023 17:28
@mikeurbach mikeurbach force-pushed the mikeurbach/properties-int-alternate branch 3 times, most recently from 6442aea to 5de26ef Compare August 9, 2023 20:54
@mikeurbach mikeurbach added the Feature New feature, will be included in release notes label Aug 9, 2023
@mikeurbach mikeurbach force-pushed the mikeurbach/properties-int-alternate branch from 5de26ef to 1a67a5d Compare August 10, 2023 20:54
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

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

LGTM

core/src/main/scala/chisel3/properties/Property.scala Outdated Show resolved Hide resolved
core/src/main/scala/chisel3/properties/Property.scala Outdated Show resolved Hide resolved
@mikeurbach mikeurbach force-pushed the mikeurbach/properties-int-alternate branch from 446a55d to cede5aa Compare August 10, 2023 21:53
@mikeurbach mikeurbach added this to the 6.0 milestone Aug 10, 2023
@mikeurbach mikeurbach merged commit 71209b4 into chipsalliance:main Aug 10, 2023
@mikeurbach mikeurbach deleted the mikeurbach/properties-int-alternate branch August 10, 2023 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants