Skip to content

Commit

Permalink
[skip ci] Fix formating
Browse files Browse the repository at this point in the history
Hot fix to handle recent changes to Markdown rendering by GitHub.  Skipping the CI regression as this markdown file does not affect simulation.
  • Loading branch information
MikeOpenHWGroup authored Jul 21, 2022
1 parent 5a0becb commit 9a26828
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions mk/TOOLCHAIN.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ The following describes how this works in core-v-verif.
In core-v-verif each test-program has its own directory and the test-program defintion, _test.yaml_ is required to exist in that directory.
This test-program defintion contains variables used by the software toolchain and SystemVerilog simulator.
For an example see:
$(CORE_V_VERIF)/$(CORE_V_CORE)/tests/programs/custom/hello-world/test.yaml
`$(CORE_V_VERIF)/$(CORE_V_CORE)/tests/programs/custom/hello-world/test.yaml`


The test-program defintion can overload the defintion of the CV_SW_TOOLCHAIN and CV_SW_PREXFIX, if required.
For example:
```
Expand All @@ -113,8 +115,8 @@ Similarily, each pseudo-random (corev-dv) test-program is required to have two Y
2. _test.yaml_ is the test-program defintion for the toolchain and SystemVerilog simulator. This test.yaml serves the same function as for manually written test-programs.

For examples see:
$(CORE_V_VERIF)/$(CORE_V_CORE)/tests/programs/corev-dv/corev_rand_arithmetic_base_test/corev-dv.yaml
$(CORE_V_VERIF)/$(CORE_V_CORE)/tests/programs/corev-dv/corev_rand_arithmetic_base_test/test.yaml
`$(CORE_V_VERIF)/$(CORE_V_CORE)/tests/programs/corev-dv/corev_rand_arithmetic_base_test/corev-dv.yaml` and
`$(CORE_V_VERIF)/$(CORE_V_CORE)/tests/programs/corev-dv/corev_rand_arithmetic_base_test/test.yaml`.

The script [YAML2MAKE](../bin/yaml2make) will parse test.yaml and create a set of Makefile variables that are used by the Makefile to:
* Compile the test-program.
Expand All @@ -129,13 +131,13 @@ generates the pseudo-random test-program. These variables all have a "GEN\_"
prefix. NOTE: defining toolchain parameters in corev-dv is not required
as the Makefile does not use variables prefixed with "GEN\_" to access or control the toolchain.

Lastly, if the "CFG" variable is set, [CFGYAML2MAKE](../bin/cfgyaml2make) parses a specific YAML file in $(CORE_V_VERIF)/$(CORE_V_CORE)/tests/cfg.
Lastly, if the "CFG" variable is set, [CFGYAML2MAKE](../bin/cfgyaml2make) parses a specific YAML file in `$(CORE_V_VERIF)/$(CORE_V_CORE)/tests/cfg`.
The variables generated by this script all have a "CFG\_" prefix.
The "CFG" variable must be set to the filename (no extension) of a yaml file in the cfg directory.
Note that "CFG" can be a shell environment variable or passed to "make" on the comand line:
make test TEST=my_test_program CFG=my_cfg

Note: if "CFG" is not defined, then $(CORE_V_VERIF)/$(CORE_V_CORE)/tests/cfg/default.yaml is used.
Note: if "CFG" is not defined, then `$(CORE_V_VERIF)/$(CORE_V_CORE)/tests/cfg/default.yaml` is used.

The common Makefile, ([Common.mk](./Common.mk)), will launch the yaml2make and cfgyaml2make scripts to generate the TEST\*, GEN\* and CFG\* variables.
These are then used to set the appropriate parameters for generating the test-program, compiling the test-program, compiling and simulating the SystemVerilog testbench.
Expand Down

0 comments on commit 9a26828

Please sign in to comment.