CHANGELOG.md

CHANGELOG

This project adheres to Semantic Versioning.

Please note the header WIP-DEV is to always remain indicating the changes done on the dev branch. Only when a release to the main branch is done, the contents of the WIP-DEV are put under a versioned header while the WIP-DEV is left empty

[WIP-DEV]

• Ensure correct riscof return code when --no-browser is used. Fixes #87.
• Updating CONTRIBUTING.rst to capture the new git strategy adopted to follow a monthly release
• Fix typo in installation.rst
• Remove unused pip import in setup.py

[1.25.3] - 2023-01-24

• use "make -k" in riscof_model.py template to ensure all test cases run, even after a failure. Fixes #73.

[1.25.2] - 2022-10-08

• updating paths for docker image and plugins to point to new location

[1.25.1] - 2022-09-09

• Modified the code to fix the issue #62, which changed the condition to allow flen=64 for D extension tests.

[1.25.0] - 2022-09-07

• migrated to using riscv-config version 3.2.0+
• modified functions to use the new warl_class from riscv-config-3.2.0+
• modified prod_isa to use riscv-config isa_validator

[1.24.3] - 2022-08-29

• fix typeo in doc for command related to cloning arch-suites
• bump riscv-config version to be 2.17.0

[1.24.2] - 2022-07-27

• Fix riscv_config dependency version to 2.10.1

[1.24.1] - 2022-07-19

• Account for the same test to be included with both XLEN variants in the isa generation.
• Add markdown report for coverage statistics.

[1.24.0] - 2022-05-14

• rename the "master" branch of riscv-arch-test to "main"

[1.23.4] - 2022-02-24

• fixed doc dependency on mistune for successful RTD build

[1.23.3] - 2022-01-27

• Added missing subextensions for B and K specs in ISA generation function.

[1.23.2] - 2021-11-23

• Fixed report generation for failing tests. Removed HTML table and added manual diff of lines in the report.
• Added no_clean flag to CLI.

[1.23.1] - 2021-10-20

• Improved diff reporting in case of Failed tests.
• Added support for f and d exts in model plugin.
• Added checking to ensure that tests with wrong filtering based on ISA are not selected.
• Fixed spelling for opening and arch test command in docs.

[1.23.0] - 2021-10-14

• Added support for new RVTEST_ISA macro
• Fixed decode error in Command util.

[1.22.1] - 2021-09-13

• Added return code of 1 on error

[1.22.0] - 2021-09-10

• Fixed signature alignment to begin and end at 16-byte boundaries for all header templates.

[1.21.2] - 2021-09-03

• Ported CLI to use click package
• Improved documentation for using plugins.
• Added separate paths for dut and ref artifacts.

[1.21.1] - 2021-07-24

• Added support for intermediate run start points #1
• --dbfile is added to generate the test-list and then run tests on the target and reference
• --testfile is added to directly run tests on the target and reference (assumes the testlist has been correctly generated)
• --no-ref-run is added so that tests do not run on reference and quit before signature comparison
• --no-dut-run is added so that tests do not run on DUT and quit before signature comparison
• Added a timestamp comment on the generated database.yaml and testlist.yaml files
• Change FXLEN macro to FLEN #8

[1.21.0] - 2021-07-21

• Changed CI script from gitlab to github actions
• Removing hosted cgf files
• Removing hosted riscv-test-suite
• Removing hosted database.yaml
• Updated report to capture the version of the riscv-arch-test suite used during run
• Added new cli - 'arch-test' to automatically clone, update and maintain the riscv-arch-test repo
• Using annotated tags for CI releases
• suite and env are now required cli args
• updated docs
  • added new sections on commands and inputs.
  • Revised the installation and riscv-arch-test sections.
  • Fixed testlist and dbgen usage and formats
  • Cleaned up examples.
  • Removed testformat spec.
  • Removed section on adding new tests.
  • Adding new doc on available PLUGINS for RISCOF.
  • Fixed links for new repo transition

[1.20.3] - 2021-06-30

• Updated docs with guide on running riscv-arch-tests with RISCOF

[1.20.2] - 2021-06-30

• Fixed ISA check typo for 64-bit K extension tests and database.yaml
• Fixed the issue pointed out in #53. Now riscof will through an error if test_list.yaml is empty and will not proceed furthur.

[1.20.1] - 2021-06-24

• Added env argument to the cli.
• printing versions of isac and confing in log for better debugging
• fixed issues pointed out in #51
• fixed regex conditions for cebreak tests and also updated database
• Updated tests based on latest coverpoints.

[1.20.0] - 2021-05-30

• work directory is now controlled by user args. Defaults to riscof_work for backward compatibility.
• when filtering we check the config string in the cgf. The config node can have multiple entries. If within an entry multiple conditions are detected, then they are andded to create included_entry. Across all the list of entries in the config list the included_entries are ORed.

[1.19.0] - 2021-04-24

• Added new rv64i and rv32i tests from arch-test repo
• Added K_unratified tests from arch-test repo
• Addded all relevant coverage files
• Updated coverage support to pick local coverage files
• Updated setup phase to dump out sail_cSim reference model
• Updated the config.ini and model setup files
• Updated docs

[1.18.4] - 2021-01-27

• Fixed missing coverage.html during pip installation.

[1.18.3] - 2021-01-21

• Added support for paths relative to config.ini location
• Plugins get the location of config.ini directory with the key config_dir

[1.18.2] - 2021-01-14

• Fixed missing files in PYPI package
• Added physical_addr_sz field in model_isa.yaml

[1.18.1] - 2021-01-11

• updated ci to use latest twine
• using api-tokens for twine uploads

[1.18.0] - 2021-01-11

• updated cli to accept multiple cgf files similar to isac
• doc updates with fixes to broken links
• manifest fixed to include requirements file

[1.17.2] - 2020-11-10

• doc updates
• added contributing.rst file
• changed version maintenance procedure. Using bumpversion now.

[1.17.1] - 2020-10-26

• doc fix
• fix passing of cgf from command line to internal variable

[1.17.0] - 2020-10-26

• Adding coverage support using riscv-isac=0.3.0
• Adding default CGF file in the suite folder
• Re structured tests to be compatible with test-format spec and for coverage analysis
• Updated docs and test-format spec

[1.16.2] - 2020-08-05

• Removed coverage support and cgf file(will be reintroduced when riscv-isac is released).
• Freeze riscv-config to v2.2.2

[1.16.1] - 2020-07-20

• Adding docs for rvtest_case condition string syntax.

[1.16.0] - 2020-06-18

• Adding coverage generation support through spike --log-commits
• CGF file for rv32i for now.
• Also added pipecleaning tests under wip

[1.15.2] - 2020-05-18

• changed python vrsion to be 3.6 or above. This makes installation of python easy
• update docs with more details on installation and fixed other typos as well.

[1.15.1] - 2020-04-07

Added

• doc updates for test-format structure

Changed

• RVMODEL_BOOT is no longer subsumed within the RVTEST_COMPLIANCE_BEGIN macro

[1.15.0] - 2020-03-29

Added

• Supports riscv-config version > 2.0
• Added Test-format spec to the docs
• adding ci for checks on each pull-request.

Fixed

• Fixed hyperlink to test-format-spec in new-test sections

[1.14.1] - 2020-03-25

Changed

• Changed the command line args to use subparsers and added relevant documentation.

[1.14.0] - 2020-03-21

Fixed

• Migrated C-extension tests to those available on github. This required adding and fixing special macros
• C.SWSP test has been fixed to not access regions outside the signature region
• Moved ECALL, EBREAK and MIS-ALIGNED tests to a separate folder. Also their respective TEST_CASE conditions have been updated
• Moved Atomic tests to wip folder.
• renamed I-IO.S to I-IO-01.S

[1.13.4] - 2020-03-18

Fixed

• load_yaml function in utils forced to return dict type.

[1.13.3] - 2020-03-18

Fixed

• moved requirements.txt inside riscof

[1.13.2] - 2020-03-17

Fixed

• Removed duplicate env folder.
• Fixed exclusion of env folder in pip package.
• Reduced python package dependencies

[1.13.1] - 2020-02-26

Fixed

• shipping the model folder as well

[1.13.0] - 2020-02-26

Fixed

• PyPi is now shipped with compressed and atomic tests
• docs have been updated with developer related information
• Shifted to the new test-suite available on github

Added

• Update docs for : install, macros and usage example
• Setup command has been updated to create sample plugin folder with all collaterals required for running RISCOF.
• Added version argument support
• Version is also printed at the begining of each run

[1.12.0] - 2020-02-10

Fixed

• RISCOF now checks if the sign dumps are not empty before comparing them.
• Print help when no arguments specified in command line.

Added

• A Makefile generation utility to avoid plugins re-writing it always.
• Automated adding paths to PYTHONPATH.
• Support for custom suites.

[1.11.1] - 2019-11-28

Added

• Update docs for : install, macros and usage example.

[1.11.0] - 2019-10-23

Added

• Added support to generate test list only through command line.
• Added support to generate test generate validated YAML files only through command line.

Fixed

• Fixed path to riscv-config yaml-specs in html report.
• Fixed error in documentation.

[1.10.0] - 2019-08-12

Added

• Ported A extension tests to latest spec.

Fixed

• Fixed logging issue with riscv-config v1.0.2.
• Fixed undefined macro in M extension tests.

[1.9.0] - 2019-08-07

Added

• Ported C extension tests to latest spec.

[1.8.2] - 2019-08-02

Fixed

• minor doc updates to replace rifle with riscv-config

[1.8.1] - 2019-08-02

Changed

• Changed dependency from rifle to riscv-config.

[1.8.0] - 2019-08-02

Changed

• Parallel Execution on models.
• Signature files are mandated to be self.name[:-1]+".signature"

[1.7.4] - 2019-07-23

Changed

• Patch to support rifle version 1.1.0

[1.7.3] - 2019-07-19

Changed

• bumping rifle to 1.0.3

[1.7.2] - 2019-07-19

Fixed

• ci-cd for pdf hosting on gitlab itself

[1.7.1] - 2019-07-19

Fixed

• Removed stray text in flow diagram.
• docs for pdf generation.

[1.7.1] - 2019-07-19

Fixed

• Removed stray text in flow diagram.
• docs for pdf generation.

[1.7.0] - 2019-07-19

Changed

• Uses rifle instead of rips subpackage.

Removed

• rips module is no longer a subpackage.
• Examples folder removed from the repository.

[1.6.3] - 2019-07-17

Fixed

• Fixed setup.py for pypi compatibility.

[1.6.2] - 2019-07-17

Added

• MANIFEST.in file added.

Changed

• setup.py modified to add suite properly.
• Package requirements updated appropriately.
• gitlab-cicd to use version-extract.py for generating tags.

Fixed

• Errors in quickstart documentation.

[1.6.1] - 2019-07-15

Added

• Links to yaml specifications in the report.
• Background to the flow picture.
• WIP indication in docs for user features.

[1.6.0] - 2019-07-12

Added

• --setup option to generate setup files in pwd.
• Added support for separate environment files for model and standard macros.
• New model specific macros.

Changed

• Configuration for riscof is taken through config.ini file in the pwd.
• Suite directory structure to follow the standard.
• Moved C and A extension tests to wip folder.
• Modified macros into new RVTEST_ and RVMODEL_ prefixed macros.
• Macro list for compile now passed as a list instead of -D prefixed string.

Removed

• Clean up of macro definitions to ensure bare minimum and necessary code for testing.

[1.5.2] - 2019-07-10

Fixed

• Errors in macro documentation.

Changed

• Changed macro name prefixes to RVTEST and RVMODEL based on their definitions and functions.

[1.5.1] - 2019-07-09

Added

• Html Report Generation.
• Supervisor csrs to schema.
• Documentation update for Supervisor csrs.

Changed

• Use difflib instead of filecmp for signature comparision.

Fixed

• Bug fix for mstatus(it is to be treated as a required field).

[1.5.0] - 2019-07-02

Added

• External plugin support.

Changed

• pluginTemplate is now implemented as an ABC.
• Documentation update.

Removed

• No plugins included in the default package.

[1.4.1] - 2019-06-28

Added

• requirements.txt file in docs for sphinx build

Fixed

• setup.py modified for pypi installation
• README.rst

Removed

• README.md as this is replaced with README.rst.

[1.4.0] - 2019-06-27

Added

• Setup script for PyPI integration.
• A single entry point integrating framework and rips.
• Support for system wide install of the package.
• "Command" class to ensure future extensibility and cross-platform compatibility.
• Support for "RVTEST_SIG*" macros.

Changed

• Directory structure to encapsulate all modules into one shippable package.
• Ensured python coding practices are followed.
• Modified I and M test suites to confirm to the latest test specifications.

Removed

• Relative and wildcard imports and stray obsolete portions of code and files.