feat: Store export settings in the generated DUT class #53
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds functionality to store and retrieve export settings in the generated DUT class across multiple language templates. The changes enable upstream tools like toffee-test to query waveform format settings, coverage metrics configuration, and waveform dumping status.
Key changes:
- Added getter methods for waveform format and coverage metrics configuration
- Added method to check if waveform dumping is currently paused/closed
- Implemented compile-time constants for storing export configuration in the C++ base class
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| template/scala/dut.scala | Added WaveformClosed(), GetWaveFormat(), and GetCovMetrics() methods |
| template/python/dut.py | Added WaveformClosed(), GetWaveFormat(), and GetCovMetrics() methods with documentation |
| template/lua/dut.lua | Added WaveformClosed(), GetWaveFormat(), and GetCovMetrics() methods |
| template/lib/dut_base.hpp | Added static constants and method declarations for export settings |
| template/lib/dut_base.cpp | Implemented export settings methods and waveform state tracking |
| template/java/dut.java | Added WaveformClosed(), GetWaveFormat(), and GetCovMetrics() methods |
| template/golang/dut.go | Added WaveformClosed(), GetWaveFormat(), and GetCovMetrics() methods |
| template/cpp/dut.hpp | Added WaveformClosed(), GetWaveFormat(), and GetCovMetrics() methods |
| src/codegen/lib.cpp | Added gen_coverage_metrics function to generate coverage configuration |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
ad7289f to
62dd017
Compare
|
Add function comments for closed/paused/open/close/set/get to prevent misunderstood. |
62dd017 to
669238a
Compare
- Store waveform and coverage export settings in the DUT class. - **BREAKING CHANGE**: Renamed waveform control APIs to clarify pause/resume semantics: - `OpenWaveform` -> `ResumeWaveformDump` - `CloseWaveform` -> `PauseWaveformDump` - `WaveformClosed` -> `WaveformPaused` - Fix syntax error in `template/mem_direct/Makefile`.
b93dfad to
984e915
Compare
Makiras
approved these changes
Sep 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The selected options for waveform and coverage export are now written into the DUT class. A flag has also been added to the DUT to explicitly close waveform dumping.
This allows upstream tools, such as
toffee-test, to handle the output data accordingly.Type of change
How Has This Been Tested?
Call the following function with cpp, python, java, golang:
dut.GetWaveFormat()dut.GetCovMetrics()dut.WaveformClosed()Checklist: