Skip to content

Fix FIRRTL spec emission and bump to spec 1.2.0#3094

Merged
jackkoenig merged 2 commits intomainfrom
firrtl-spec-bump
Mar 16, 2023
Merged

Fix FIRRTL spec emission and bump to spec 1.2.0#3094
jackkoenig merged 2 commits intomainfrom
firrtl-spec-bump

Conversation

@jackkoenig
Copy link
Contributor

Now emitting FIRRTL version 1.2.0.

This fixes .fir serialization to include the FIRRTL spec version. It was previously working just for chisel3.stage.ChiselStage.emitChirrtl (which no longer exists but does on 3.6.x and 3.5.x branches), but it didn't work for anything using the CircuitSerializationAnnotation (which uses the Emitter).

The backport does not include the spec version bump (since the spec version is specified in SFC on older branches), just the fix.

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 state the API impact?
  • Did you specify the code generation impact?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • bug fix

API Impact

Now emitting FIRRTL 1.2.0 and in more cases. This will be rejected by versions of SFC older than v1.5.5 and firtool older than 1.12.0.

Backend Code Generation Impact

This bumps the version in the emitted .fir and ensures we always emit a version in the .fir.

Desired Merge Strategy

  • Squash

Release Notes

Fix emission of FIRRTL spec in emitted .fir. Now emitting FIRRTL version 1.2.0.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • 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 this to the 3.5.x milestone Mar 16, 2023
@jackkoenig jackkoenig requested a review from seldridge March 16, 2023 01:22
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

Not sure what is going on with the failure.

@jackkoenig jackkoenig enabled auto-merge (squash) March 16, 2023 16:15
@jackkoenig jackkoenig merged commit 1ef1fc4 into main Mar 16, 2023
@jackkoenig jackkoenig deleted the firrtl-spec-bump branch March 16, 2023 17:02
@mergify mergify bot added the Backported This PR has been backported label Mar 16, 2023
mergify bot pushed a commit that referenced this pull request Mar 16, 2023
* Emit FIRRTL spec version in Emitter
* Bump FIRRTL spec version to 1.2.0

(cherry picked from commit 1ef1fc4)

# Conflicts:
#	firrtl/src/main/scala/firrtl/ir/Serializer.scala
#	firrtl/src/test/scala/firrtlTests/ExtModuleTests.scala
mergify bot pushed a commit that referenced this pull request Mar 16, 2023
* Emit FIRRTL spec version in Emitter
* Bump FIRRTL spec version to 1.2.0

(cherry picked from commit 1ef1fc4)

# Conflicts:
#	firrtl/src/main/scala/firrtl/ir/Serializer.scala
#	firrtl/src/test/scala/firrtlTests/ExtModuleTests.scala
#	src/test/scala/circtTests/stage/ChiselStageSpec.scala
mergify bot added a commit that referenced this pull request Mar 16, 2023
* Fix FIRRTL spec emission and bump to spec 1.2.0 (#3094)

* Emit FIRRTL spec version in Emitter
* Bump FIRRTL spec version to 1.2.0

(cherry picked from commit 1ef1fc4)

# Conflicts:
#	firrtl/src/main/scala/firrtl/ir/Serializer.scala
#	firrtl/src/test/scala/firrtlTests/ExtModuleTests.scala
#	src/test/scala/circtTests/stage/ChiselStageSpec.scala

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
mergify bot added a commit that referenced this pull request Mar 16, 2023
* Fix FIRRTL spec emission and bump to spec 1.2.0 (#3094)

* Emit FIRRTL spec version in Emitter
* Bump FIRRTL spec version to 1.2.0

(cherry picked from commit 1ef1fc4)

# Conflicts:
#	firrtl/src/main/scala/firrtl/ir/Serializer.scala
#	firrtl/src/test/scala/firrtlTests/ExtModuleTests.scala

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
@jackkoenig jackkoenig added the Feature New feature, will be included in release notes label Apr 7, 2023
@sequencer sequencer mentioned this pull request Jun 20, 2023
14 tasks
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