Docs: Fix sample code for debug box #400
Merged
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
Fixes: * ARMmbed#392: "A quick change in debugging documentation"
Contributor
Author
|
@Patater added clarification regarding reboot from a debug box handler. |
Patater
reviewed
Jan 19, 2017
| /* Remember that debug_deprivilege_and_return() has been called once. | ||
| * We'll reboot after the debug handler is run, so this will go back to | ||
| * zero after the reboot. */ | ||
| /* Remember that debug_deprivilege_and_return() has been called once. */ |
Contributor
There was a problem hiding this comment.
Perhaps note that the debug box can only be entered once, to avoid the debug box calling itself recursively. This is probably important enough to go into the documentation (not just comments) as well, as this limits what you can do after the debug box runs before you have to reboot. For instance, you can't catch a fault and then restart that box and catch a subsequent fault; you get one debug box entry per boot. This means you pretty much have to reboot.
Contributor
Author
There was a problem hiding this comment.
Updated with improved docs before the code snippet (the comment has not been changed).
A handler registered to the debug box does not cause the system to reboot any more. By default, the system is halted, instead. A user can still request that the system reboots from within a debug box handler, by calling the `NVIC_SystemReset()` API. This API can only be called by the debug box when uVisor is enabled.
AlessandroA
force-pushed
the
docs_update_debugging
branch
from
a6f13de to
052f6a3
Compare
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.
Fixes:
@niklas-arm @Patater
Thanks @asensaoui @janjongboom for also reporting this.