Add doc for Renode usage notes. Create a document to keep track of and pool Renode examples and usage notes. To be included, Renode script setup, adding extensions in C#, and Robot workflow. (Also added small typo-fix in RunningOpenTitanVectorSimulation.md) Change-Id: Id6f462bd76f35e43667748b28113c1f4e5bcc67e
diff --git a/RenodeUsageNotes.md b/RenodeUsageNotes.md new file mode 100644 index 0000000..de99340 --- /dev/null +++ b/RenodeUsageNotes.md
@@ -0,0 +1,60 @@ +# Running Renode + +Tips for running Renode + +## Automatically Start Renode Script + +To streamline firing-up renode, use the `-e` flag to execute onload: + +``` +renode "i @sim/config/shodan_hellovector.resc; start" +``` + +This will start the renode script (resc) automatically. + +Make sure to follow with `"i @path/to/file.resc; start` where the path starts +after `$ROOTDIR` (don't include the `$ROOTDIR` in the path). + +## Using Headless Mode + +To utilize without the pop-up renode consoles, utilize two flags: + +1. `--disable-xwt` -- to prevent the windows from opening +2. `--port 1234` -- or port of choice for prompt access + +This can be combined with the `-e` flag: +``` +renode --disable-xwt --port 1234 -e "i @sim/config/shodan_hellovector.resc; start" +``` + +In a separate terminal window (or tmux pane), start a telnet at that port for +prompt access: +``` +telnet 127.0.0.1 1234 +``` + +Using this should create the following prompt: +``` +$ telnet 127.0.0.1 1234 +Trying 127.0.0.1... +Connected to 127.0.0.1. +Escape character is '^]'. +Renode, version 1.10.1.31213 (773406ba-202011051557) + +(monitor) i @sim/config/shodan_hellovector.resc +(machine-0) start +Starting emulation... +(machine-0) +``` + +## Quitting Headless Renode Session + +To quit the session, just type `quit` into the telnet prompt: + +``` +(machine-0) quit +Renode is quitting +Connection closed by foreign host. +``` + +This will quickly exit both telnet and the renode process on this port.
diff --git a/RunningOpenTitanVectorSimulation.md b/RunningOpenTitanVectorSimulation.md index 80df3f8..62cbf60 100644 --- a/RunningOpenTitanVectorSimulation.md +++ b/RunningOpenTitanVectorSimulation.md
@@ -238,7 +238,7 @@ #### Step 5: Add an entry to the RVV Opcode Struct in the `riscv-opc.c` file: Take care in spelling in the assembly instruction name (in this example `vrgatherei16.vv`) -as well as spelling in the mask and match names (in this example `MATCH_VRGATHEREI16VV` and `MASKMASK_VRGATHEREI16VV`): +as well as spelling in the mask and match names (in this example `MATCH_VRGATHEREI16VV` and `MASK_VRGATHEREI16VV`): ``` {"vrgatherei16.vv",0, INSN_CLASS_V, "Vd,Vt,VsVm", MATCH_VRGATHEREI16VV, MASK_VRGATHEREI16VV, match_vd_neq_vs1_neq_vs2_neq_vm, 0},