riscv/rocket-chip
1
0
Fork 0
Code Releases Activity

Arguments clarification, add examples

Browse Source 
This clarifies and provides consistent for the command line arguments
usage text.

This adds a set of examples for running the rocket-chip emulator.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>
This commit is contained in:
Schuyler Eldridge 2017-11-18 19:20:44 -05:00 committed by Megan Wachs
parent 1aa87f6578
commit 7ae6bf7611
1 changed files with 28 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
csrc/emulator.cc
View File

@ -47,29 +47,40 @@ Run a BINARY on the Rocket Chip emulator.\n\
Mandatory arguments to long options are mandatory for short options too.\n\ Mandatory arguments to long options are mandatory for short options too.\n\
\n\ \n\
EMULATOR OPTIONS\n\ EMULATOR OPTIONS\n\
-c, --cycle-count Print the cycle count before exiting\n\ -c, --cycle-count Print the cycle count before exiting\n\
+cycle-count\n\ +cycle-count\n\
-h, --help Display this help and exit\n\ -h, --help Display this help and exit\n\
-m, --max-cycles=[CYCLES] Kill the emulation after CYCLES\n\ -m, --max-cycles=CYCLES Kill the emulation after CYCLES\n\
+max-cycles=[CYCLES]\n\ +max-cycles=CYCLES\n\
-s, --seed=[SEED] Use random number seed SEED\n\ -s, --seed=SEED Use random number seed SEED\n\
-V, --verbose Enable all Chisel printfs\n\ -V, --verbose Enable all Chisel printfs (cycle-by-cycle info)\n\
+verbose\n\ +verbose\n\
", stdout); ", stdout);
#if VM_TRACE #if VM_TRACE == 0
fputs("\ fputs("\
-v, --vcd=[FILE], write vcd trace to FILE (or '-' for stdout)\n\
-x, --dump-start=[CYCLE] start VCD tracing at CYCLE\n\
+dump-start\n\
\n\ \n\
EMULATOR OPTIONS (unsupported in non-debug build -- try `make debug`)\n\ EMULATOR OPTIONS (only supported in debug build -- try `make debug`)\n",
", stdout); stdout);
#endif #endif
fputs("\ fputs("\
VCD options (e.g., -v, +dump-start) require a debug-enabled emulator.\n\ -v, --vcd=FILE, Write vcd trace to FILE (or '-' for stdout)\n\
Try `make debug`.\n\ -x, --dump-start=CYCLE Start VCD tracing at CYCLE\n\
+dump-start\n\
", stdout); ", stdout);
fputs(HTIF_USAGE_OPTIONS, stdout); fputs("\n" HTIF_USAGE_OPTIONS, stdout);
printf("\n"
"EXAMPLES\n"
" - run a bare metal test:\n"
" %s rv64ui-p-add\n"
" - run a bare metal test showing cycle-by-cycle information:\n"
" %s +verbose rv64ui-p-add 2>&1 | spike-dasm\n"
#if VM_TRACE
" - run a bare metal test to generate a VCD waveform:\n"
" %s -v rv64ui-p-add.vcd rv64ui-p-add\n"
#endif
" - run a hello-world test using the proxy kernel:\n"
" %s pk hello\n",
program_name, program_name, program_name, program_name);
} }
int main(int argc, char** argv) int main(int argc, char** argv)
@ -139,7 +150,7 @@ int main(int argc, char** argv)
optarg = optarg+12; optarg = optarg+12;
} }
#if VM_TRACE #if VM_TRACE
else if (arg.substr(0, 12) == "+dump-start=") else if (arg.substr(0, 12) == "+dump-start=") {
c = 'x'; c = 'x';
optarg = optarg+12; optarg = optarg+12;
} }
@ -148,7 +159,7 @@ int main(int argc, char** argv)
c = 'c'; c = 'c';
// If we don't find a legacy '+' argument, it still could be // If we don't find a legacy '+' argument, it still could be
// an HTIF (HOST) argument and not an error. If this is the // an HTIF (HOST) argument and not an error. If this is the
// case, then we're doing processing EMULATOR arguments. // case, then we're done processing EMULATOR arguments.
else { else {
static struct option htif_long_options [] = { HTIF_LONG_OPTIONS }; static struct option htif_long_options [] = { HTIF_LONG_OPTIONS };
struct option * htif_option = &htif_long_options[0]; struct option * htif_option = &htif_long_options[0];