Skip to content

Commit

Permalink
Document issue 1.8 Draft.
Browse files Browse the repository at this point in the history
doc/ChangeLog:

	* README.adoc (Introduction): Add Future work section and bump
	version.
	* custom.wordlist: Add words needed for Future work section.
  • Loading branch information
jeremybennett committed Jun 12, 2018
1 parent fc1bc91 commit 7af977a
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 2 deletions.
8 changes: 8 additions & 0 deletions doc/ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
2018-06-12 Jeremy Bennett <[email protected]>

Document issue 1.8 Draft.

* README.adoc (Introduction): Add Future work section and bump
version.
* custom.wordlist: Add words needed for Future work section.

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

* README.adoc: Remove special apostrophe from "licensor's".
Expand Down
20 changes: 18 additions & 2 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.7 Draft
Issue 1.8 Draft
:toc:
:icons: font
:numbered:
Expand Down Expand Up @@ -41,7 +41,17 @@ The result that compliance tests provide to the user is an assurance that the sp

=== Intended audience

This document is intended for design and verification engineers who wish to develop new compliance tests and also those who wish check if their implementation (simulation models, HDL models, etc.) of a RISC-V processor is compliant to the RISC-V specifications. [[_Toc463952678]][[_Toc463952679]]
This document is intended for design and verification engineers who wish to develop new compliance tests and also those who wish check if their implementation (simulation models, HDL models, etc.) of a RISC-V processor is compliant to the RISC-V specifications.

=== Future work

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.

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.

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.

=== Feedback and how to contribute

Expand Down Expand Up @@ -111,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.8 Draft | 12 June 2018 |

Jeremy Bennett |

Add Future work section.

| 1.7 Draft | 12 June 2018 |

Jeremy Bennett |
Expand Down
3 changes: 3 additions & 0 deletions doc/custom.wordlist
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ asciidoc
AsciiDoctor
asciidoctor
aspell
autotools
CGEN
cmake
Codasip
creativecommons
CY
Expand Down Expand Up @@ -40,6 +42,7 @@ merchantability
Nostersky
nz
pagewidth
parameterization
pdf
publicdomain
Radek
Expand Down

0 comments on commit 7af977a

Please sign in to comment.