<p><strong>Insert Cartridge...</strong> does the same as the toolbar button; see the “Insert Cartridge” toolbar button description for details.</p>
<p><strong>Use CD Unit</strong> does the same as the toolbar button; see the “Use CD Unit” toolbar button description for details.</p>
<p><strong>Configure</strong> launches the Configure dialogue. A full description is given in the “Configure Dialog” section below.</p>
-<p><strong>Status</strong> launches a window with emulator internal information.</p>
+<p><strong>Status</strong> launches a window with emulator internal information. It includes M68000 cycles counters.</p>
<p><strong>Exit</strong> quits <em>Virtual Jaguar</em> immediately. You can also quit <em>Virtual Jaguar</em> by pressing <strong>Ctrl</strong> + <strong>Q</strong> on your keyboard.</p>
<h2>Help Menu</h2>
<p>This menu has the following options:</p>
<p>When started in Debugger mode, a specific tab is made available in the configuration dialogue which gives you the following options:</p>
<ul>
<li>Disassembly lines</li>
+<li>Source file search paths</li>
<li>Display M68000 opcodes</li>
<li>Display HW labels</li>
<li>Display source filename</li>
+<li>ELF sections check</li>
</ul>
<p><strong>Disassembly lines</strong> represent the number of disassembly lines to display in the M68000 tracing window. This doesn't include the number of source lines displayed.</p>
+<p><strong>Source file search paths</strong> may be used in case of the debugger cannot find files path in the DWARF information.</p>
<p><strong>Display M68000 opcode</strong> allows or not the opcode display. Can be useful in case of user prefers to see the disassembly only.</p>
<p><strong>Display HW labels</strong> allows or not the name of the Jaguar hardware registers as reported in the official documentation.</p>
<p><strong>Display source filename</strong> allows or not the source code filename display depend the disassembly in the M68000 tracing window.</p>
+<p><strong>ELF sections check</strong> allows or not potential unknown ELF section, it will stop, or not stop, the sections decoding.</p>
<p>When started in Alpine mode, or in Debugger mode, a specific tab is made available in the configuration dialogue which gives you the following options:</p>
<ul>
<li>ROM to load</li>
<li>ABS to load</li>
<li>Windows refresh</li>
<li>Allow writes to cartdridge ROM</li>
+<li>Allow M68000 exception catch</li>
</ul>
<p><strong>ROM to load</strong> is the path to a Jaguar executable file that will be loaded into the Jaguar’s cartridge memory space at $800000 (Alpine ROM images will load at $802000). As a convenience to coders, this file can be of any length, as long as it fits into the cartridge memory space (a file of this type is treated as an Alpine ROM and is loaded at $802000). The file thus loaded into memory will not be executed.</p>
<p><strong>ABS to load</strong> is the path to a Jaguar executable file that will be loaded in the Jaguar’s main RAM. This file must have valid headers, otherwise <em>Virtual Jaguar</em> won’t be able to load it. Assuming the file exists and has the correct headers in it, it will be loaded and run when <em>Virtual Jaguar</em> is first run.</p>
<p><strong>Windows refresh</strong> is the refresh rate for open windows. The smaller the rate, the faster the refresh window will occur. A 0 value will disable the refresh operations.</p>
<p><strong>Allow writes to cartdridge ROM</strong> is the option allowing or not the cartdridge ROM writing. If allowed, emulator won't interfere but when turned off the emulator will display a dialog box with proper information, at this point user can allow to continue or stop the code.</p>
+<p><strong>Allow M68000 exception catch</strong> is the option allowing or not the exception catch from the M68000. If allowed, the emulator will display a dialog box with proper information and user will have the choice to continue or to stop the code.</p>
<p>Also, when in Debugger mode, extra toolbar buttons are defined (also found under the extra “Debug” menu) and also include the Alpine mode features:</p>
<ul>
<li>Restart</li>
<li>Step Into</li>
<li>Step Over</li>
+<li>Breakpoints</li>
+<li>New Function Breakpoint</li>
+<li>Delete All Breakpoints</li>
+<li>Disable All Breakpoints</li>
<li>Exception Vector Table</li>
+<li>Output Video</li>
<li>All Watch</li>
<li>Locals</li>
<li>Call Stack</li>
<li>Heap Allocator</li>
<li>Memory (1-4)</li>
+<li>Save Dump As...</li>
+<li>Cartridge directory and files list.</li>
</ul>
<h3>Restart</h3>
<p>Restart M68000 code (PC) and the stack (SP) pointer to the original ones provided in the ROM.</p>
<p>Trace into M68000 instruction, similar to a step by step tracing.</p>
<h3>Step Over</h3>
<p>Trace over M68000 instruction such as jsr/bsr, otherwise this feature functions like a Step Into.</p>
+<h3>Breakpoints</h3>
+<p>List the breakpoints and their status. The first breakpoint represents the breakpoint set via the CPU browser, also named as BPM.</p>
+<h3>New Function Breakpoint</h3>
+<p>Add breakpoint to a function.</p>
+<h3>Delete All Breakpoints</h3>
+<p>Delete all breakpoints, also reset the BPM.</p>
+<h3>Disable All Breakpoints</h3>
+<p>Disable all breakpoints, and also disable BPM.</p>
<h3>Exception Vector Table</h3>
<p>Display a partial table of the M68000 exception vectors as reported by Motorola.</p>
+<h3>Output Video</h3>
+<p>Display the video output window.</p>
<h3>All Watch</h3>
-<p>Display all global variables used by the Jaguar code. It uses the available DWARF debug information.</p>
+<p>Display all global variables used by the Jaguar code. It uses the available DWARF debug information. It has a search feature to look for a specific global variable.</p>
<h3>Locals</h3>
<p>Display the local variables of the traced M68000 function. It uses the available DWARF debug information, and the A6 register to point on the stack.</p>
<h3>Call Stack</h3>
<p>Display the status of all memory allocations. It uses a specific structure memory allocation, if such structure is not found then nothing will be displayed.</p>
<h3>Memory (1-4)</h3>
<p>This 4 independent windows lets you inspect <em>Virtual Jaguar</em>’s emulated memory space. The <strong>PgDn</strong> key will advance the top of the window’s memory location by 480 bytes, and <strong>PgUp</strong> will go back by the same amount. The <strong>Plus (+)</strong> key will advance the top of the window’s memory location by 16 bytes, and <strong>Minus (-)</strong> will go back by the same amount. Entering a memory location, in hexadecimal, label or decimal, in the edit field and pressing the <strong>Go</strong> button will display memory from that location. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
+<h3>Save Dump As...</h3>
+<p>Save a memory portion to a file.</p>
+<h3>Cartridge directory and files list</h3>
+<p>List the cartridge's directory and files; available only if specific structure is used.</p>
<h3><em>Main window</em></h3>
<p>In the debugger mode, the main window doesn't display anymore the video output; it is replaced by a source code files viewer and a disassembly window made of tabs to allow tracing / display of code.</p>
<p><strong>Source code files</strong></p>
<p>It is available for convenience reason; it display all the filenames found in the DWARF information. It is turned off by default but user can turn it on.</p>
+<p><strong>Sources tab</strong></p>
+<p>This tab is populated by C, or asm, source files following the M68000 program counter (PC). User can trace source code within the tab.</p>
<p><strong>Disassembly tabs</strong></p>
<p>There are 3 tabs, each of them is dedicated to a specific processor (M68000, GPU, and DSP). Currently, only the M68000 is tracable, others 2 display only the code pointed by their respective program counter (PC).</p>
<p>Also, when in Alpine mode, extra toolbar buttons are defined (also found under the extra “Debug” menu):</p>
<li>OP Browser</li>
<li>M68K Disassembly Browser</li>
<li>RISC Disassembly Browser</li>
+<li>HW Registers Browser</li>
</ul>
<h3>Memory Browser</h3>
<p>This window lets you inspect <em>Virtual Jaguar</em>’s emulated memory space. The <strong>PgDn</strong> key will advance the top of the window’s memory location by 480 bytes, and <strong>PgUp</strong> will go back by the same amount. The <strong>Plus (+)</strong> key will advance the top of the window’s memory location by 16 bytes, and <strong>Minus (-)</strong> will go back by the same amount. Entering a memory location, in hexadecimal, in the edit field and pressing the <strong>Go</strong> button will display memory from that location. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
<h3>Stack Browser</h3>
<p>This window lets you inspect <em>Virtual Jaguar</em>’s emulated memory stack (SP) space. The <strong>PgDn</strong> key will advance the top of the window’s memory location by 480 bytes, and <strong>PgUp</strong> will go back by the same amount. The <strong>Plus (+)</strong> key will advance the top of the window’s memory location by 16 bytes, and <strong>Minus (-)</strong> will go back by the same amount. Entering a memory location, in hexadecimal, in the edit field and pressing the <strong>Go</strong> button will display memory from that location. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
<h3>CPU Browser</h3>
-<p>This window shows the state of the various CPUs in the emulated Jaguar. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
+<p>This window shows the state of the various CPUs in the emulated Jaguar; a memory breakpoint (read Á write) can also be set via the BPM setting. The window can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
<h3>OP Browser</h3>
<p>This window shows the current state of object list that the Object Processor is pointing to. Note that most of the time, this will likely show an object list that has had its objects processed. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
<h3>M68K Disassembly Browser</h3>
<p>This window provides a disassembly of 68000 opcodes. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
<h3>RISC Disassembly Browser</h3>
<p>This window provides a disassembly of RISC opcodes. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
+<h3>HW Registers Browser</h3>
+<p>This window provides a list of the hardware registers content; for the moment, only the blitter is displayed. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <strong>Esc</strong> key on your keyboard.</p>
<p>The aforementioned options will only work when <em>Virtual Jaguar</em> is run in Alpine or Debugger mode, that is, when the --alpine or --debugger flag is passed in. If you do not pass such flag, <em>Virtual Jaguar</em> will run as it normally does, i.e., as a stock Jaguar, and nothing will be loaded by default.</p>
<h2>For The Curious</h2>
<p>If you’re wondering why some cartridges have labels in the “Insert Cartridge...” dialogue and some don’t, read on...</p>
HCoop / clinton / Virtual-Jaguar-Rx.git / blobdiff