Add a dynamic ISA reference (sliderules)
raccog opened this issue · comments
This issue will be used to track my progress on adding a dynamic ISA reference to Ripes. Feel free to let me know if you have any ideas on how this feature could be improved. Any ideas on how to improve the UI of this feature are very welcome.
The purpose of this feature is to provide an easy way for users to reference details from an ISA while within Ripes. This will be mainly implemented in two Excel-like tables containing all the ISA's instructions and pseudo-instructions. One table will be used for encoding these instructions and the other will be for decoding. Both of these tables will be filterable to make it easier for users to search for instructions.
Along with the reference table, other places where instructions show up in the Ripes UI should also somehow link to the instruction's reference. This could be implemented in a tooltip that shows the reference details when hovering over an instruction.
There are a few things to consider while implementing this feature:
- As the Ripes project plans to support more instruction sets in the future, this feature should be flexible enough to support many ISAs, not just RISC-V
- What instruction details should be displayed in the tables?
- How should each detail be displayed? (text, colored text, graph, interactivity, etc.)
- Besides the reference table, where else should these ISA details show up? (tooltips, menus, etc.)