Skip to content

Commit

Permalink
Clean up documentation.
Browse files Browse the repository at this point in the history
doc/ChangeLog:

	* README.adoc (Future work): Reflect changes made to support
	Codasip simulator.
	(Repository structure): Diagrammatic representation of the file
	structure deleted.
  • Loading branch information
jeremybennett committed Jun 18, 2018
1 parent beb5b06 commit 795e518
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 47 deletions.
7 changes: 7 additions & 0 deletions doc/ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
2018-06-18 Jeremy Bennett <[email protected]>

* README.adoc (Future work): Reflect changes made to support
Codasip simulator.
(Repository structure): Diagrammatic representation of the file
structure deleted.

2018-06-12 Jeremy Bennett <[email protected]>

* .gitignore: Add custom.dict.
Expand Down
56 changes: 9 additions & 47 deletions doc/README.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= RISC-V Compliance Tests =
RISC-V Foundation Compliance Task Group
Issue 1.8 Draft
Issue 1.9 Draft
:toc:
:icons: font
:numbered:
Expand Down Expand Up @@ -47,9 +47,9 @@ This document is intended for design and verification engineers who wish to deve

This is a work in progress. A number of areas need resolving before the work is complete, and are recorded here so they do not get forgotten.

Move `compliance_test.h` to a target directory :: This may be necessary for the complete solution, possibly with the header being split. For the time being we wish to keep the current setup and learn all the areas of variance as the tests are applied to an ever wider set of platforms. This will then inform the best location and partitioning of all headers.
Consider whether `compliance_test.h` is needed :: It's not clear if this belongs in target directories, or if it is needed at all.

Generalize Makefile configuration :: At present each platform requires editing of the makefile, and many areas (for example choice of GCC or LLVM, native or cross-compile) are not even fully parameterized. Again we wish to explore a wider range of platforms before deciding what needs parameterization. We also know that with tools like _autotools_ and _cmake_ this is a well understood problem to solve.
Generalize Makefile configuration :: At present each platform requires editing of the makefile, and many areas are not even fully parameterized. Again we wish to explore a wider range of platforms before deciding what needs parameterization. For now `COMPILE_TARGET` allows a choice between GCC and LLVM. More generally, we know that with tools like _autotools_ and _cmake_ this is a well understood problem to solve.

Free up all registers for compliance testing :: At present some platforms have macros which use some registers in set up and verification, thus excluding them from compliance testing. We believe careful structuring of the macros will mean this problem can be avoided in the future, thus avoiding any registers being excluded from compliance testing.

Expand Down Expand Up @@ -121,6 +121,12 @@ Jeremy Bennett, Mary Bennett, Simon Davidmann, Radek Hajek, Lee Moore, Milan Nos
[cols="<1,<2,<3,<4",options="header,pagewidth",]
|================================================================================
| _Revision_ | _Date_ | _Author_ | _Modification_
| 1.9 Draft | 12 June 2018 |

Jeremy Bennett |

Update Future work section to take account of Codasip changes. Remove diagrammatic directory structure.

| 1.8 Draft | 12 June 2018 |

Jeremy Bennett |
Expand Down Expand Up @@ -450,50 +456,6 @@ The top level directory contains a `README.md` file giving an overview of the pr

`riscv-test-suite`:: This contains a subdirectory for each instruction set or instruction set extension. Within each subdirectory the source code and reference output for each test are in the `ISA` directory.

Diagrammatically this is:

----
*riscv-compliance*
*+-- doc*
*| |-- design.adoc* // This document
*|*
*+-- riscv-target*
*| +-- riscvOVPsim* // target that can run the test suites
*| | +-- device* // devices to be tested
*| | | +-- rv32i* // simulator config for the specific device
*| | | | |-- Makefile.include* // specific run command
*| | | +-- compliance_io.h* // macro implementation for this target
*| | *
*| |*
*| +-- spike* // target that can run the test suites
*| | +-- device* // devices to be tested
*| | | +-- rv32i* // simulator config for the specific device
*| | | | |-- Makefile.include* // specific run command
*| | | +-- compliance_io.h* // macro implementation for this target
*| | *
*|*
*+-- riscv-test-env* // TVM available at Foundation gitlab
*| |-- p*
*| +-- verify.sh* // main verify script
*| *
*+-- riscv-test-suite* // where the tests live
*| +-- rv32i*
*| |-- references* // reference results for ISA tests
*| |-- src* // assembler tests
*| |-- Makefile*
*| +--Makefrag* // list of tests
*| *
*| +-- rv32im* // placeholder for more tests
*| |-- references* // reference results for ISA tests
*| |-- src* // assembler tests
*| |-- Makefile*
*| +--Makefrag* // list of tests
*| *
*|*
*| +--LICENCE*
*+-- Makefile* // main makefile
----

[appendix]
== Creative Commons Attribution 4.0 International License

Expand Down

0 comments on commit 795e518

Please sign in to comment.