From: Jean-Paul Mari Date: Thu, 27 May 2021 01:22:41 +0000 (-0400) Subject: Documentation updates X-Git-Tag: v2.1.3-R5^2 X-Git-Url: http://git.hcoop.net/clinton/Virtual-Jaguar-Rx.git/commitdiff_plain/82c1bdccf419782059efafbeb2370d6c20fae258?ds=sidebyside Documentation updates --- diff --git a/docs/INSTALL b/docs/INSTALL index b95c96b..6eb8760 100644 --- a/docs/INSTALL +++ b/docs/INSTALL @@ -16,9 +16,9 @@ The minimum requirements for compiling Virtual Jaguar from source are: o libcdio v0.90 or higher (optional, for Jaguar CD support) o OpenGL libraries o Qt 5.5.1 or higher - o Visual Studio 2015 or 2017 (if any of interest) + o Visual Studio 2017 (if any of interest) o supported OS (WIN64 through msys2/MinGW64, Windows 64 bits); other - OSs may work to but you may need to change some items in the Makefile or adapt the Visual Studio project. + OSs may work too but you may need to change some items in the Makefile or adapt the Visual Studio project. o cygwin64 support is done but no test has been completed Previously supported OS (BeOS, Linux, FreeBSD and WIN32 through mingw, MacOS); @@ -90,4 +90,4 @@ You may have to adapt such files to handle your own development environement, usualy to put the right include and library paths will be enough assuming you have all the requirements properly set. Assuming all went well, you will have either Debug or Release executables. -You will also need the QT5 & SDL necessary DLLs in the executable directory. +You will also need the necessary DLLs in the executable directory. diff --git a/docs/WHATSNEW b/docs/WHATSNEW index 8b6491e..271bf48 100644 --- a/docs/WHATSNEW +++ b/docs/WHATSNEW @@ -1,3 +1,23 @@ +Virtual Jaguar v2.1.3 R5 GCC/Qt +------------------------------- + +* Specific breakpoints for the M68000 "illegal instruction", "address error", "bus error", "Unimplemented instruction", and "Exception not referenced" exceptions +* Specific breakpoints will occur in case of a rom writes at an unknown location +* Added a HW registers browser window for the Blitter +* Fixes for the Linux platform from @richard42 +* Stability & improvements for the debugger mode +- ELF & DWARF information support improvements +- Modified the call stack layout window +- Added a search feature in the All Watch global variables window +- Added a video output display in a specific window +- Show the SR value as a readable form in the M68000 CPU browser +- Added a tracing, step in and step over, at source code level +- Added a source code file date check when reading DWARF information +- Support the structure's members in the Local variables window +- Improvements for the two Breakpoints windows +- Added two M68000 cycles counters in the status window + + Virtual Jaguar v2.1.3 R4 GCC/Qt ------------------------------- @@ -8,7 +28,7 @@ Virtual Jaguar v2.1.3 R4 GCC/Qt * Breakpoint / alert box may now occur in case of writing at unknown memory location or in case of ROM writing * UI modifications mostly for the debugger mode, key bindings, and icons * Added screenshot & call stack window features, Jaguar model & BIOS configurations, and a source code files list viewer -* Added multiple breakpoints feature but only for M68K functions +* Added multiple breakpoints feature but only for M68000 functions * Added a Save Dump As... feature to save a memory zone to a file * Added a cartdridge view menu to display cartdridge directory system and his files list * Added some log information for the emulator initialisations @@ -32,7 +52,7 @@ Virtual Jaguar v2.1.3 R3 GCC/Qt * Fixed a crash, in Release mode, when the HW labels setting is turn on * Fixed the SP (Stack) window UI potential missing data * Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist -* Keep the scrollbar position in accordance of the M68K PC pointer +* Keep the scrollbar position in accordance of the M68000 PC pointer * Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file * Improved the .heap section detection to avoid a detection error * Fixed a crash when DWARF information does references to missing source code files @@ -68,13 +88,13 @@ Virtual Jaguar v2.1.3 R1 GCC/Qt * BPM (Breapoint) now stop at the designated address and no longer stop after executing the code * Added SP (Stack) memory browser * User can change now the number of lines of disassembly displayed in the tracing window -* User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window -* Added an emulator status window (GPU status, M68K debugger & tracking status) +* User can turn on/off the op-codes associated in the disassembly lines displayed in the M68000 tracing window +* Added an emulator status window (GPU status, M68000 debugger & tracking status) * Added a GPU disassembly tracing window - Display the current PC pointer * Added a DSP disassembly tracing window - Display the current PC pointer * Added possibility to change refresh rate of browser windows when emulation is launched -* Display partial hardware labels (Internal Memory & Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window -* User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window +* Display partial hardware labels (Internal Memory & Graphics sub-system address space) in the disassembly lines displayed in the M68000 tracing window +* User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68000 tracing window Virtual Jaguar v2.1.3 R0 GCC/Qt @@ -85,7 +105,7 @@ Virtual Jaguar v2.1.3 R0 GCC/Qt * ELF debug symbol support * "Step Into" code function * Menus layout dedicated to the debugger -* Added a dedicated main window for tracing (M68K) +* Added a dedicated main window for tracing (M68000) * Added a Debugger tab in the config tab diff --git a/docs/virtualjaguar.1 b/docs/virtualjaguar.1 index 9c85eb2..35c4795 100644 --- a/docs/virtualjaguar.1 +++ b/docs/virtualjaguar.1 @@ -1,4 +1,4 @@ -.TH virtualjaguar 1 2018-09-19 Virtualjaguar Rx +.TH virtualjaguar 1 2021-05-24 Virtualjaguar Rx .SH NAME virtualjaguar \- An Atari Jaguar emulator @@ -8,12 +8,12 @@ virtualjaguar \- An Atari Jaguar emulator .RI [rom image file] .SH DESCRIPTION -Virtualjaguar is an emulator for the Atari Jaguar videogame system. +Virtual Jaguar Rx is an emulator for the Atari Jaguar videogame system. It includes a debugger. .SH OPTIONS .TP .B [rom image file] -Name of file to load; +Name of file to load .TP .B \-a, \-\-alpine Run in Alpine emulation mode @@ -27,7 +27,7 @@ Do not use Jaguar BIOS .B \-D, \-\-debugger Run in Debugger emulation mode .TP -.B , \-\-dram-max +.B \-\-dram-max Set the main ram to 8MB .TP .B \-g, \-\-gpu @@ -48,16 +48,19 @@ Show command line help .SH SETTINGS .TP .B \-\-es\-all -Erase all settings, +Erase all settings +.TP .B \-\-es\-ui -Erase UI settings only, +Erase UI settings only +.TP .B \-\-es\-alpine -Erase alpine mode settings only, +Erase alpine mode settings only +.TP .B \-\-es\-debugger Erase debugger mode settings only .SH SOUND -DSP emulation is needed for audio output; +DSP emulation is needed for audio output. .TP .B \-d, \-\-dsp Enable DSP emulation @@ -89,38 +92,47 @@ Do not show emulation of tv static. This can be slow on low end CPUs. .TP The default key bindings are: .TP -.B Ctrl-Q -Quit virtualjaguar, +.B Ctrl+Q +Quit virtualjaguar .TP -.B Ctrl-I -Load a new program, +.B Ctrl+I +Pick file to load a new program .TP .B Ctrl+C -Configure tab, +Configure tab .TP .B Ctrl+S -Emulator status, +Emulator status .TP .B Ctrl+Shift+F5 -Restart program, +Restart program .TP .B F11 -Step into code, +Step into code .TP .B F10 -Step over code, +Step over code .TP .B Esc -Pause emulation, +Pause emulation .TP .B F7 -Advance the emulation by a single frame, +Advance the emulation by a single frame .TP .B F9 -Toggle full screen mode, +Toggle full screen mode .TP .B F8 Screenshot +.TP +.B Ctrl+B +Function breakpoint +.TP +.B Ctrl+Alt+B +Breakpoints list +.TP +.B Ctrl+Shift+F9 +Delete all breakpoints .SH CONTROLS .TP @@ -128,31 +140,31 @@ The default key bindings for controller 1 are: (Key bindings can be changed in the configuration dialog.) .TP .B S -Up, +Up .TP .B X -Down, +Down .TP .B A -Left, +Left .TP .B D -Right, +Right .TP .B P -Pause, +Pause .TP .B O -Option, +Option .TP .B J -Button C, +Button C .TP .B K -Button B, +Button B .TP .B L -Button A, +Button A .TP .B 1 through 0 Buttons 1 through 0 on the keypad diff --git a/docs/vj_HistoryNotes.txt b/docs/vj_HistoryNotes.txt index 36a4f21..dac67a6 100644 --- a/docs/vj_HistoryNotes.txt +++ b/docs/vj_HistoryNotes.txt @@ -37,13 +37,15 @@ Release 5 (TBA) -- The cycles are displayed in the emulator status window 24) Improve the DWARF source line number reporting 25) Added a #line in the call stack window -26) Add a search feature in the all watches window -27) Added video output display in a specific window -28) Fixed potential crash with the debugger tabs reset -29) Added a search feature in the All Watch variables window -30) Support the structure's members in the Local variables window -31) Code refactoring for the variables support in debugger mode -32) Support the structure and union members from the DWARF information +26) Added video output display in a specific window +27) Fixed potential crash with the debugger tabs reset +28) Added a search feature in the All Watch variables window +29) Support the structure's members in the Local variables window +30) Code refactoring for the variables support in debugger mode +31) Support the structure and union members from the DWARF information +32) Added a Virtual Jaguar Rx logo in the About window +33) Fix compilation / link error for MSYS2 / MinGW64 +34) Documentation updates Release 4a (15th August 2019) ----------------------------- diff --git a/res/help.html b/res/help.html index cf23d34..e070a97 100644 --- a/res/help.html +++ b/res/help.html @@ -82,7 +82,7 @@

Insert Cartridge... does the same as the toolbar button; see the “Insert Cartridge” toolbar button description for details.

Use CD Unit does the same as the toolbar button; see the “Use CD Unit” toolbar button description for details.

Configure launches the Configure dialogue. A full description is given in the “Configure Dialog” section below.

-

Status launches a window with emulator internal information.

+

Status launches a window with emulator internal information. It includes M68000 cycles counters.

Exit quits Virtual Jaguar immediately. You can also quit Virtual Jaguar by pressing Ctrl + Q on your keyboard.

Help Menu

This menu has the following options:

@@ -175,12 +175,14 @@

When started in Debugger mode, a specific tab is made available in the configuration dialogue which gives you the following options:

Disassembly lines represent the number of disassembly lines to display in the M68000 tracing window. This doesn't include the number of source lines displayed.

+

Source file search paths may be used in case of the debugger cannot find files path in the DWARF information.

Display M68000 opcode allows or not the opcode display. Can be useful in case of user prefers to see the disassembly only.

Display HW labels allows or not the name of the Jaguar hardware registers as reported in the official documentation.

Display source filename allows or not the source code filename display depend the disassembly in the M68000 tracing window.

@@ -191,11 +193,13 @@
  • ABS to load
  • Windows refresh
  • Allow writes to cartdridge ROM
    • +
  • Allow M68000 exception catch

    • ROM to load 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.

    ABS to load 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 Virtual Jaguar 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 Virtual Jaguar is first run.

    Windows refresh 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.

    Allow writes to cartdridge ROM 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.

    +

    Allow M68000 exception catch 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.

    Also, when in Debugger mode, extra toolbar buttons are defined (also found under the extra “Debug” menu) and also include the Alpine mode features: