Page Comparison

This page provides technical details about running the Architecture Compatible Test (ACT) suite to achieve the "RISC-V Compatible™" trademark and logo.  Completion of the test suite is the core work in the process of gaining permission to use the “RISC-V Compatible” Trademark. See the RISC-V Branding Guidelines & Materials webpage for more details and requirements on the other steps.

...

RISC-V-Compatible Testing requires the following components:

1. Python for the test driver system.
2. A RISC-V GNU Toolchain (cross) for the test drive system.
3. The RISC-V Compatibility Framework (RISCOF)
   
4. The RISC-V Config Tool (RISCV-CONFIG)
5. The Architecture Test Suite (ACT)
6. The SAIL golden model
   The RISC-V SAIL model is hosted in GitHub at https://github.com/riscv/sail-riscv
7. The vendor’s device under test (RTL or actual form)

...

The ordered list of steps to complete the test process are as follows:

1. If needed, install Python 3.X and the Virtualenv for Python on the system which will drive the test process.  This is not the RISC-V Device Under Test (DUT).
   More details are found the "Install Python" section of the RISCOF Documentation.
2. If needed, install a RISC-V cross toolchain to compile binaries (testcases) on the system driving the test of the DUT.
   Sample directions for a 32-bit device are found in the "Install RISCV-GNU Toolchain" section of the RISCOF Documentation.
3. Build an ISA YAML file for the Device Under Test ( DUT). This YAML file should include the extensions for which RISC-V Compatibility will be claimed, but may also reflect the device's full capabilities assuming they are a superset.
   Example YAML files are provide in the examples directory of the RISC-V Config (riscv-config) GitHub repo.  They have names of XXX_isa.yaml. 
   The YAML syntax for ISA files is documented in the "ISA YAML Spec" section of the RISCV-CONFIG documentation.
   
4. Build Platform YAML file for the DUT.
   Example YAML files are provide in the examples directory of the RISC-V Config (riscv-config) GitHub repo.  They have names of XXX_platform.yaml. 
   The YAML syntax for ISA files is documented in the "Platform YAML Spec" section of the RISCV-CONFIG documentation.
   
5. Install the RISCV-CONFIG tool and use it to validate the ISA and Platform YAML files built in Steps #1 and #2.  For each Hart defined in your YAML, inspect the output for a message stating "No errors for Hart: ...".  Correct all errors before proceeding.  See the RISCV-CONFIG documentation for more details.

6. Install the RISCOF Framework, ACT suite, and SAIL.  Configure RISCOF for a  Device Under Test (DUT), using the previously created YAML files, and for SAIL. Detailed steps for this process can be found in the "Running RISCV-ARCH-TESTS" section of the RISCOF Documentation.

7. Generate a Test List and review the entries to ensure that the appropriate set of tests are covered. Specifically, look for test of ISA extensions which are not expected.
   More information on generate the Test List and interpret the results can be found in the "Test List Form" section of the RISCOF Documentation.

8. Run the appropriate ACT suite from RISCOF for either the 32-bit or 64-bit test suite.
   Detailed steps for this process can be found in the "Running Tests with RISCOF" section of the RISCOF Documentation.
   Test suite entry points are defined in the riscv-test-suite directory (the sub-folder names) of the RISC-V Architecture Test (riscv-arch-test) GitHub repo.  More information exists in the riscv-test-suite/README.md file.

9. Review the test results in the "Results" section of the report.html file created by RISCOF to ensure that the DUT test results indicate "Passed".  For tests marked "Failed", investigate the problem, correct if possible or address using actions defined in the "Test-Case Waivers" section of the Architecture Compatibility Test Policy.
   Specific test source can be found in the particular riscv-test-suite directory of the RISC-V Architecture Test (riscv-arch-test) GitHub repo used to invoke RISCOF (--suite) in the previous step.
10. Repeat Steps #5 and #6 as needed.
11. When ready, submit the test results and supporting information per the directions in the “Where to Report Test Results” section of the Architecture Test Policy.
    

...

A RISC-V Technical Session titled "Using Template Repo  to setup/run RISC-V Arch Test Suite under RHEL/Ubuntu" was recorded in April 2023.  It provides information about a member-provided repo (link) that supplements setup of the ACT environment with some extra scripts and files.  Details, including the presentation and recording links are available here.

...