Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
random thoughts on things to make 1 stage code more accessible
In the top level repository function of following directories emulator, project, riscv-fesvr, sbt, src, vsrc.. that can be overwhelming when coming to it fresh, from nothing.
Legacy stuff that's pulled over from Rocket, already in the 1 stage rv32_1stage/tile the tile is something that it's natural.. it's an artifact of Rocket that leaked into Sodor..
Coming to "new", it's like "what's this? why's it here? What's it's function?" Learning journey page about how decode is done: rv32_1stage/cpath
The code constructs used make this elegant, but need explanation of how it works MuxLookup in cpath the lookup table
The 1 stage is a good place to build a 2nd tier in the learning journey. The Journey has hands-on for muxes. Then the 1-stage uses muxes in "real" ways. For example: rv32_1stage/cpath.scala#L117
That's a more advanced use of muxes -- if we supplied a diagram showing the circuit this turns into, it may be a good learning opportunity.
Also, this line would be good to illustrate a real use of "::" in scala: rv32_1stage/cpath.scala#L112
Last thing is that pictures will help a lot, for newbies -- being able to see what the code turns into. We could provide a branch that is free from complexities in top.scala and tile.scala, and just has cpath and dpath, plus flat memory..? For example this code is a bit alien: rv32_1stage/top.scala#L30
And the implicit configuration is an advanced code feature: rv32_1stage/top.scala#L25
The imports could use some comments to explain, or point to wiki page: rv32_1stage/top.scala#L10
The def of "core" could use more explanation, or be simplified: rv32_1stage/core.scala#L32 as it is.. looking first time.. it's like "this doesn't do anything!"