Improved Debug Module documentation #3036
Merged
Conversation
This file contains 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
|
Ask for review @sequencer |
sequencer
requested changes
Sep 18, 2022
| * @param nAbstractDataWords Number of 32-bit words for Abstract Commands | ||
| * @param nProgamBufferWords Number of 32-bit words for Program Buffer | ||
| * @param hasBusMaster Whether or not a bus master should be included | ||
| * @param clockGate todo |
There was a problem hiding this comment.
clockGate is used in Periphery.scala, where the debug module is instantiated.
| @@ -563,6 +608,7 @@ class TLDebugModuleOuter(device: Device)(implicit p: Parameters) extends LazyMod | |||
| // hartsel/hasel/hamask must also be used by the DebugModule state machine, | |||
| // so it is passed to Inner. | |||
|
|
|||
| // sends debug interruption to Core when dmcs.haltreq is set, | |||
There was a problem hiding this comment.
Maybe merge with the comment block above?
There was a problem hiding this comment.
In fact, the comment block above has nothing to do with Interrupt mechanism. So I'd rather keep this line and move the block above to where it belongs.
sequencer
approved these changes
Oct 2, 2022
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.
Related issue:
Documentation
Type of change: bug report | feature request | other enhancement
other enhancement
Impact: no functional change | API addition (no impact on existing code) | API modification
no functional change
Development Phase: proposal | implementation
implementation
Release Notes
Add more micro-architecture details in documentation for debug module.
Fix format and typo issues in documentation.