Skip to content

Commit 28eb34e

Browse files
committed
add changes to help file
1 parent 17087b9 commit 28eb34e

File tree

1 file changed

+32
-18
lines changed

1 file changed

+32
-18
lines changed

ODIN_II/verify_odin.sh

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -91,29 +91,15 @@ printf "Called program with $INPUT
9191
FLAGS:
9292
-g|--generate_bench $(_prt_cur_arg ${_GENERATE_BENCH}) Generate input and output vector for test
9393
-o|--generate_output $(_prt_cur_arg ${_GENERATE_OUTPUT}) Generate output vector for test given its input vector
94-
-b|--build_config $(_prt_cur_arg ${_GENERATE_CONFIG}) Generate a config file for a given directory
94+
-b|--build_config $(_prt_cur_arg ${_GENERATE_CONFIG}) Generate a config file for a given directory
9595
-c|--clean $(_prt_cur_arg off ) Clean temporary directory
9696
-f|--force_simulate $(_prt_cur_arg ${_FORCE_SIM}) Force the simulation to be executed regardless of the config
97-
"
98-
}
9997
100-
function config_help() {
101-
printf "
102-
*.conf is a list of key=value set
103-
'#' are used for comments
104-
105-
the following key are available:
98+
CONFIG FILE HELP:
99+
"
106100

107-
circuit_dir
108-
circuit_list_add
109-
arch_dir
110-
arch_list_add
111-
script_params
112-
synthesis_params
113-
simulation_params
114-
regression_params
101+
config_help
115102

116-
"
117103
}
118104

119105
###############################################
@@ -337,6 +323,34 @@ _simulation_params=""
337323
_circuit_list=""
338324
_arch_list=""
339325

326+
function config_help() {
327+
printf "
328+
*.conf is a list of key=value set
329+
'#' are used for comments
330+
331+
the following key=value, ... are available:
332+
333+
circuit_dir = < path/to/circuit/dir >
334+
circuit_list_add = < circuit file path relative to [circuit_dir] >
335+
arch_dir = < path/to/arch/dir >
336+
arch_list_add = < architecture file path relative to [arch_dir] >
337+
script_synthesis_params = [see exec_wrapper.sh options]
338+
script_simulation_params= [see exec_wrapper.sh options]
339+
synthesis_params = [see Odin options]
340+
simulation_params = [see Odin options]
341+
regression_params =
342+
{
343+
--concat_circuit_list # concatenate the circuit list and pass it straight through to odin
344+
--generate_bench # generate input and output vectors from scratch
345+
--generate_output # generate output vectors only if input vectors already exist
346+
--disable_simulation # disable the simulation for this task
347+
--disable_parallel_jobs # disable running circuit/task pairs in parralel
348+
--include_default_arch # run odin also without architecture file
349+
}
350+
351+
"
352+
}
353+
340354
init_args_for_test() {
341355
_regression_params=""
342356
_script_synthesis_params=""

0 commit comments

Comments
 (0)