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 a dynamic ISA reference (sliderules) #297

Open
raccog opened this issue Sep 18, 2023 · 1 comment
Open

Add a dynamic ISA reference (sliderules) #297

raccog opened this issue Sep 18, 2023 · 1 comment

Comments

@raccog
Copy link
Contributor

raccog commented Sep 18, 2023

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.)
This was referenced Sep 18, 2023
@raccog raccog changed the title Add an instruction details window Add a dynamic ISA reference (sliderules) Sep 21, 2023
@magiwanders
Copy link

magiwanders commented Jan 1, 2024

  • Current level of detail seems appropriate for the Encoders, except "Explanation" Column, I think there is no reason why we should have it there since explanations could be long. Explanations could be just popups over "Description" column cells
  • Showing the immediate encoding row below some instructions could be optional, a good option should be showing it when clicking the "imm" cell next to it, and a global checkbox for showing/hiding all
  • Ctrl+click on any assembly name could bring you to the sliderules tab, hovering just brings up fields+immedate encoding. This happens in the Editor Tab in the assembled code, in the Processor tab on the instruction over the processor scheme and in the bottom right instruction memory panel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants