Commit 50b3d9f0 authored by Quentin Aristote's avatar Quentin Aristote
Browse files

explained options

parent 4cf9f6ef
......@@ -30,19 +30,24 @@ Use
```
Options are:
```
-n <number of steps> : specifies how many times the netlist will be run.
If not specified the netlist will be run indefinitely.
-print : the netlist won't be run but the topological ordering will still be
performed
and the resulting netlist will be outputed to <file name>_sch.net
-rom /path/to/directory : Location of the ROM files. By default, is set to './'.
The path of the directory must contain a / at its end.
There must be one <var>.rom file for each variable <var> that accesses the
ROM.
Each file should be a binary file, that is a text file where character n is
the ASCII character encoded by the byte ROM[n]ROM[n+1]...ROM[n+7].
-time <duration of a cycle> : Minimum time in millisecondes each cycle has to
take, set to 0 by default.
-p
--print : prints the result of scheduling in a file and stops.
-n <number of steps> : specifies the number of cycles to simulate.
If not specified, the netlist is simulated indefinitely.
-m
--memory /path/to/directory : location of the memory files. By default, set to './'.
The path of the directory must contain '/' at its end.
There must be one <var>.rom file for each variable <var> that accesses the ROM.
<var>.ram files are optional.
Each file should be a binary file, that is a text file where character n is the ASCII character encoded by the byte ROM[8*n]...ROM[8*n+7].
-f
--freq <frequence> : number of cycles per second.
-t
--time <t0> <t1> <t2> <t3> <t4> <t5> <t6> <t7> : sets the time at the beginning of the simulation.
-d
--debug : prints a handful of useful information.
-help
--help : display this list of options
```
Some netlist examples can be found in the ```test``` directory.
......
......@@ -454,25 +454,26 @@ let compile filename =
let main () =
Arg.parse
["-p", Arg.Set print_only, " " ^ "See --print." ;
"--print", Arg.Set print_only, " " ^ "Only print the result of scheduling" ;
"-n", Arg.Set_int number_steps, " " ^ "Number of steps to simulate." ;
"-m", Arg.Set_string memory_directory, " " ^ "See --rom." ;
"--memory", Arg.Set_string memory_directory,
"Location of the memory files. By default, set to './'.\n The pa"
^ "th of the directory must contain '/' at its end. \n There mus"
^ "t be one <var>.rom file for each variable <var> that accesses the ROM."
^ "\n <var>.ram files are optional.\n Each file shoul"
^ "d be a binary file, that is a text file where character n is the ASCII"
^ "character encoded by the byte ROM[8*n]...ROM[8*n+7]." ;
"-f", Arg.Set_int frequence, " " ^ "See --frequence." ;
"--freq", Arg.Set_int frequence, " " ^ "Number of cycles per second." ;
["-p", Arg.Set print_only, " " ;
"--print", Arg.Set print_only, ": prints the result of scheduling in a file and stops." ;
"-n", Arg.Set_int number_steps, "<number of steps> : specifies the number of cycles to simulate.\n If not specified, the netlist is simulated indefinitely." ;
"-m", Arg.Set_string memory_directory, " " ;
"--memory", Arg.Set_string memory_directory, "/path/to/directory : location of the memory files. By default, set to './'.\n The path of the directory must contain '/' at its end. \n There must be one <var>.rom file for each variable <var> that accesses the ROM.\n <var>.ram files are optional.\n Each file should be a binary file, that is a text file where character n is the ASCII character encoded by the byte ROM[8*n]...ROM[8*n+7]." ;
"-f", Arg.Set_int frequence, " " ;
"--freq", Arg.Set_int frequence, "<frequence> : number of cycles per second." ;
"-t", Arg.Tuple (List.init
8
(fun i ->
Arg.Int (fun n ->
default.(i) <- n))), "" ;
"--debug", Arg.Set debug, "Prints a handful of useful information."]
default.(i) <- n))), " " ;
"--time", Arg.Tuple (List.init
8
(fun i ->
Arg.Int (fun n ->
default.(i) <- n))),
"<t0> <t1> <t2> <t3> <t4> <t5> <t6> <t7> : sets the time at the beginning of the simulation." ;
"-d", Arg.Set debug, " " ;
"--debug", Arg.Set debug, ": prints a handful of useful information."]
compile
"" ;;
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment