Document simulation API for watching uninitialized input signals#291
Draft
Document simulation API for watching uninitialized input signals#291
Conversation
Co-authored-by: Readon <3614708+Readon@users.noreply.github.com>
Co-authored-by: Readon <3614708+Readon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Document watch on uninitialized input signals
Document simulation API for watching uninitialized input signals
Feb 28, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
SpinalHDL 1555 introduced an API to detect undriven DUT input signals during simulation, but it was undocumented. Adds a new section to
Simulation/signal.rstcovering all four new functions.Changes
source/SpinalHDL/Simulation/signal.rst— New "Watching uninitialized input signals" section with an API reference table and usage example:addInputsAssignmentWatch(dut)— mark all module inputs as watchedaddWatchedSignals(signals)— mark an explicitSeq[BaseType]as watchedcheckInputsAssignmentAfterReset(cd, stopOnFail)— after each clock sampling, emit warnings (or callsimFailure) for any watched input that has never been drivencheckWatchedSignalAssigned()— returns names of currently undriven watched signals.gitignore— Addedbuild/to exclude Sphinx HTML output from the repo.Example
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.