From 761cac271b0d0937e304d7950ccdb76a1ebe6230 Mon Sep 17 00:00:00 2001 From: TheAIBot Date: Sun, 22 Nov 2020 01:07:03 +0100 Subject: [PATCH] Clarification to DIRRTL coverage description --- FIRRTLCoverage/README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/FIRRTLCoverage/README.md b/FIRRTLCoverage/README.md index c35205d..5d0435a 100644 --- a/FIRRTLCoverage/README.md +++ b/FIRRTLCoverage/README.md @@ -1,11 +1,21 @@ # Test coverage at FIRRTL level -This project wil make ti possible to get accurate test coverage data from chisel code by introducing a way to measure the coverage of FIRRTL code. +This project wil make it possible to get accurate test coverage data from chisel code by introducing a way to measure the coverage of FIRRTL code. Coverage is understood as the hardware paths that reaches a register or similar state preserving elements. A mux or similar can block paths. Chisel will have to annotate chisel code in a way that makes it possible to trace specific FIRRTL operations back to the scala source that made them. FIRRTL needs to support loading these new annotations and preserve them through its various optimizations and transformations that it does. Treade will need to support these new annotations and record the annotations as the attached hardware is used. -## TODO +## Sources +This project requires changes to FIRRTL, Treadle and Chisel3. As those are all major projects, the source will not be available in this folder. Instead One can Check out my forks to view the changes i've made. + +https://github.com/TheAIBot/chisel3 + +https://github.com/TheAIBot/treadle -* Tag FIRRTL code with chisel source code location -* Implement a way to measure FIRRTL coverage +https://github.com/TheAIBot/firrtl + +## TODO +* Tag FIRRTL code with chisel source code location annotations +* FIRRTL annotation support +* Treadle annotation support +* Implement a way to understand the outputted coverage report ## Text material