Document the machine code monitor debugger - #31
Open
chrisgleissner wants to merge 1 commit into
Open
Conversation
Add a Debugger section with screenshots taken from an Ultimate 64, and refresh the help screenshot for the new help layout.
chrisgleissner
marked this pull request as ready for review
August 30, 2026 16:57
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
1 participant
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.
What this adds
A
Debuggersection inhowto/machine_code_monitor.rst, covering the debug mode the machine code monitor gained in the firmware branchfeature/machine-code-monitor-debug: entering and leaving Debug, the CPU state footer, the five execution commands, the ten breakpoint slots and their popup, where the debugger can stop, the messages it can report, the Debug help screen, interrupt state on resume, and what the Ultimate 64 supports that the cartridge does not.The chapter's introduction now names the debugger, and the paragraph about the built-in help describes the three blocks it is laid out in.
Related PRs
Implementation: GideonZ/1541ultimate#705
Screenshots
Three new images under
media/monitor/, plus a refreshedhelp_view.png. All four were captured from a realUltimate 64 Elite running the branch firmware, taken off the device's own VIC video stream in UI Freeze mode, at the same 384x272 PAL geometry as the chapter's existing screenshots:
debug_paused.png- Assembly view stopped on aJSR, with the CPU state footer populated.debug_breakpoints.png- the breakpoint list with two slots set.debug_help.png- the Debug help screen.help_view.png- the ordinary help screen, re-taken because its layout changed with the same firmware.Accuracy
The text was written against
doc/machine_code_monitor.mdin the firmware branch, which is the reference thefirmware's own host and hardware tests are written against. Key bindings, message strings, breakpoint slot count, reserved address ranges, and the per-target support table all come from there rather than from the source.
Scope
Documentation only. No other chapter is touched.