ucb-bar / riscv-mini

Simple RISC-V 3-stage Pipeline in Chisel
Other
511 stars 102 forks source link

Proposal to Update Project to Latest Chisel #23

Closed chick closed 2 years ago

chick commented 4 years ago

I'd like to propose the following.

  1. Make the current master branch become the release branch
    • Make release be the default branch in this repo
    • It will, for now, continue to point to its desired version of chisel3
    • This would allow us to work on master, buffering existing users
  2. After the above change master branch
    1. Point to current 3.2-SNAPSHOT
    2. Fix all code to be compliant and as warning free as possible with Chisel 3.2
    3. put all code in main and tests into a mini package
      • This will bring it in line with standard Scala conventions
  3. Change master to depend on chisel-testers2 instead of chisel3
    • This would allow us to develop some testers2 style unit tests
      • This would help test out testers2 capabilities
      • Provide alternative examples of unit testing facilities under chisel
chick commented 4 years ago

@donggyukim Can you let me know what you think of this proposal. I am prepared to do the described work and testing. I am also interested in making sure Treadle can handle riscv-mini and this seems like a good path.

donggyukim commented 4 years ago

@chick I love this proposal. Can't wait to see tests running on Treadle! There used to be chisel-testers1.0-based tests, and I hope it'll be helpful for porting: https://github.com/ucb-bar/riscv-mini/tree/6b889ec7ba5d72876f764532220725d49c49b912/src/test/scala

chick commented 4 years ago

@donggyukim Thanks As a first step I have created a release branch. The only change from master was removing the "-SNAPSHOT" from the version string in build.sbt. If this is ok with you I think the next steps should be

  1. Make release be the default branch
  2. Make a release tag for release
  3. Add protection rules to the release and master branches to require PRs
    • I think this is optional but protects against accidental changes.

Does this sound ok? If so, I am happy to do them.

donggyukim commented 4 years ago

Yeah, it sounds good to me.