1 |
2 |
mballance |
# RISC-V Compliance Task Group
|
2 |
|
|
|
3 |
|
|
This is a repository for the work of the RISC-V Foundation Compliance Task Group. The repository owners are:
|
4 |
|
|
- Jeremy Bennett (Embecosm)
|
5 |
|
|
- Lee Moore (Imperas)
|
6 |
|
|
|
7 |
|
|
Details of the RISC-V Foundation, the work of its task groups, and how to become a member can be found at [riscv.org](https://riscv.org/).
|
8 |
|
|
|
9 |
|
|
## Contribution process
|
10 |
|
|
|
11 |
|
|
You are encouraged to contribute to this repository by submitting pull requests and by commenting on pull requests submitted by other people.
|
12 |
|
|
|
13 |
|
|
- Where a pull request is non-controversial one of the repository owners will immediately merge it. The respository uses rebase merges to maintain a linear history.
|
14 |
|
|
|
15 |
|
|
- Other pull requests will be publicised to the task group for comment and decision at a subsequent meeting of the group. Everyone is encouraged to comment on a pull request. Such pull requests will be merged by when a concensus/decision has been reached by the task group.
|
16 |
|
|
|
17 |
|
|
## Licensing
|
18 |
|
|
|
19 |
|
|
In general:
|
20 |
|
|
- code is licensed under the BSD 3-clause license (SPDX license identifier `BSD-3-Clause`); while
|
21 |
|
|
- documentation is licensed under the Creative Commons Attribution 4.0 International license (SPDX license identifier `CC-BY-4.0`).
|
22 |
|
|
|
23 |
|
|
The files [`COPYING.BSD`](./COPYING.BSD) and [`COPYING.CC`](./COPYING.CC) in the top level directory contain the complete text of these licenses.
|
24 |
|
|
|
25 |
|
|
## Engineering practice
|
26 |
|
|
|
27 |
|
|
- Documentation uses the structured text format _AsciiDoc_. See [`doc/README.adoc`](doc/README.adoc) for more details.
|
28 |
|
|
|
29 |
|
|
- Some directories use `ChangeLog` files to track changes in the code and documentation. Please honor these, keeping them up to date and including the ChangeLog entry in the _git_ commit message.
|
30 |
|
|
|
31 |
|
|
- Please include a comment with the SPDX license identifier in all source files, for example:
|
32 |
|
|
```
|
33 |
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
34 |
|
|
```
|
35 |
|
|
|
36 |
|
|
## Running the compliance tests
|
37 |
|
|
|
38 |
|
|
The only setup required is to define where the toolchain is found, and where the target / device is found.
|
39 |
|
|
|
40 |
|
|
For the toolchain, the binaries must be in the search path and the compiler prefix is defined on the make line. The default value for this is
|
41 |
|
|
|
42 |
|
|
RISCV_PREFIX ?= riscv64-unknown-elf-
|
43 |
|
|
|
44 |
|
|
The path to the RUN_TARGET is defined within the riscv-target Makefile.include.
|
45 |
|
|
|
46 |
|
|
To run the rv32i test suite on riscvOVPsim
|
47 |
|
|
|
48 |
|
|
make RISCV_TARGET=riscvOVPsim RISCV_DEVICE=rv32i
|
49 |
|
|
|
50 |
|
|
### Accessing riscvOVPsim
|
51 |
|
|
|
52 |
|
|
As we create the RISCV.org compliance test suite, the Imperas developed _riscvOVPsim_ compliance simulator is included as part of this GitHub repository. For more information please contact info@ovpworld.org or info@imperas.com.
|
53 |
|
|
|
54 |
|
|
For more information on riscvOVPsim look here: [riscv-ovpsim/README.md](riscv-ovpsim/README.md) and here: [riscv-ovpsim/doc/riscvOVPsim_User_Guide.pdf](riscv-ovpsim/doc/riscvOVPsim_User_Guide.pdf).
|