Added a specific breakpoint for the M68K Unimplemented instruction, and Exception...
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
1Release 5 (TBA)
30) Added a date creation stamp in the application command line information
4- This date already appears in the Release 4 executable but was not referenced in his history note
51) Added a specific breakpoint for the M68K illegal instruction exception
6-- Alert box will display a message and then the code will stop
72) Added a specific breakpoint for the M68K address error exception
8-- Alert box will display a message and then the code will stop
2d99e2b7 93) Added a HW registers browser window and set a tab for the Blitter
104) Added detection for the unsigned/signed short type
11-- Will allow the return of a short type variable's value
0029c507 125) Added a specific breakpoint for the M68K Unimplemented instruction, and Exception not referenced exceptions
14Release 4a (15th August 2019)
16Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
180) Fix specific breakpoint for ROM cartridge or unknown memory location writing
20Release 4 (10th August 2019)
22Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
240) The zoom value setting has been fixed in the registry
251) Debugger mode now shares the same alpine rom path setting
262) Local variables window displays register name now
273) Switch to Zlib 1.2.11 static library 64bits for VS 2017
284) Switch to SDL 1.2.15 static library 64bits for VS 2017
295) Local variables window displays values from function's parameters
306) Fixed the typedef's name display in Local and Watch variables window
317) Breakpoint may now occur in case of a ROM cartridge writing
32-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
33-- Alert box will display a message with possibility to pass or not the breakpoint only if this is related to a 8 or 16 bits ROM access
348) Local variables window detects now if a variable is used or not by the code
359) The address provided in the debugger memory windows is now verified to prevent crash
36-- Wrong address will be displayed in red
3710) UI changes
38-- Added new icons for the exit and status features
39-- Modified icons for the SP (Stack) browser
40-- Unified icons sizes depend on their usage (drop down menu and main menu)
41-- Underline the active M68K line in the disassembly window
42-- Allow the up/down navigation on the SP (Stack) browser
43-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
44-- Fixed the up navigation on the memory window
4511) Added some log information for the emulator initialisations
4612) Breakpoint will happen in case of writing at unknown memory location
47-- Alert box will display a message and then the code will stop
4813) Added the DRAM size in the emulator status window
4914) Debugger sources code clean-up
5015) Added a call stack feature
5116) Follow platform requirement to prevent source file reading issue
5217) UI modifications
53-- Modified icon for the memory window to make a distinction with the memory browser
54-- The all watch, and Exception Vector Table windows, can be closed using keyboard
55-- Renamed the debugger dedicated icons to make a distinction
56-- Added the call stack window
5718) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
58-- Previously used ELF/DWARF information was still accessible
5919) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
6020) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
6121) Added a Jaguar model and BIOS configuration tab
6222) Jaguar model and BIOS configuration integration
6323) Added LEB128 decoding functions
64-- It is used for the DWARF decoding information
6524) Debugger support improvement
66-- DWARF support for the enum type (partial), structure and subroutine type
67-- Debugger can report variable's unsigned char value
6825) UI modifications
69-- Added a status bar, better status report & information display for the heap allocation window
70-- Added a status bar, better status report & information display for the local variables window
71-- Added better information display for the exception vectors table window, and added some missing vectors
72-- Added a status bar, better status report & information display for the call stack window
73-- Added a status bar, better status report & information display for the all watches window
7426) Added screenshot feature
75-- Not accessible in debugger mode
76-- Added screenshot editable path in the general tab, and a key binding
7727) Minor misspellings fixes
7828) DWARF source code directory path clean-up
7929) Added a source code files list viewer
80-- List comes from the DWARF information
8130) Check potential variables missing/incomplete description found in the DWARF information
82-- No crash involved but can help to reduce such as variables duplicate or the blank ones
8331) Added a sorting filter in the all watches window
8432) Improve source code file reading to avoid additional text/bytes reading
8533) Help & content texts updates
8634) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
8735) Added the support for the used lines source's DWARF structure
88-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
8936) Added the Rx version's contact in the help text
9037) Added search paths in case of missing DWARF directories information
91-- Used to look for the file(s)
9238) Setup CU's low/high PC in case of the DWARF structures doesn't have it
93-- Used mostly to allow display the source assembled with vasm
9439) Added function name support from ELF structure
9540) Added the return address information in the call stack
8d705db0 9641) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 9742) Added timer initialisation for the SDL setup
f99a6ebc 9843) Added a cartridge view menu
24470541 99-- Added a window to display my own directory and his files list
6642f781 10044) Debugger sources code clean-up
acd3342f 10145) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 10246) Fix crash with potential missing DWARF structure tag's type name
10347) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
10448) Project has switched to QT 5.12.0 library 64bits for VS 2017
3323d78b 10549) Added a Save Dump As... feature to save a memory zone to a file
10650) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
107-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 10851) Removed the sorting filter in the all watches window
96bd5390 10952) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 11053) Set cartridge view menu for debugger mode only
8b11a1b0 11154) Prevent crash in case of call stack is out of range
113Release 3 (13th November 2017)
115Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
1170) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1181) Added an Exception Vector Table window
1192) Modified the About window to update the credits list in a more appropriate way
120-- Updated the emulator application credits line
1213) Added 'Rx' word to the emulator name
1224) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1235) Added ui, alpine and debugger groups in the settings
1246) Added the possibility to erase settings
1257) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1268) Added a key bindings tab and adapted the configuration dialog tabs
127-- User can modify the key bindings where appropriate
128-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1299) Fixed a crash, in Release mode, when the HW labels setting is turn on
13010) Solved an interference between the HW labels setting and the one used by the debugger
131-- The setting is now only the reference used
13211) Fixed the SP (Stack) browser UI potential missing data
13312) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
13413) Keep the scrollbar position in accordance of the M68K PC pointer
135-- UI displays the source without the need to move down/up the scrollbar
13614) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
137-- This may come from the linker vlink
13815) Improved the .heap section detection to avoid a detection error
139-- Depend vlink version, .heap section may have an Alloc flag
14016) Fixed a crash when DWARF information does references to missing source code files
14117) Added a local variables window
14218) Project has switched to Visual Studio 2017 and QT 5.9.1 library
144Release 2 (3rd September 2017)
1460) Added some error detections when reading the ELF executable file
1471) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1482) "Step Over" code function for BSR/JSR functions
1493) Added the .debug_ranges detection to avoid a detection error
1504) DWARF support
151-- TAG: Compilation Unit, Subprogram, Variables, Types
152-- Line numbers, symbols, functions
1535) Added an All Watch window for non-local variables
1546) Added a heap allocator window based on my own memory allocation functions
1557) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1568) Windows refreshing executed only if windows is visible
1579) Added a restart function
158-- Restart only the 68000 program counter to his original set
15910) Modified the icons color backgound for the "Step In" and "Step Over" functions
16011) Updated the About window to update the credits list
16112) 64 bits Release executable
16213) Fixed (hacking) the display of the SP (Stack) browser
16314) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
164-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
16515) Added some information in the --help/-h/-? option
16616) --debugger option no longer force the log file
16717) Added a --dram-max option to extend the DRAM size to 8MB
16818) Added the "enter" key support when setting the BPM (Breapoint)
16919) Save the windows positions, size and visibilities (show or hide) status
170-- Such windows will automatically respawn in the next emulator launch
172Release 1 (12th February 2017)
1740) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1751) Clean-up the tracing / no-tracing flags for better U.I understanding
1762) Added SP (Stack) browser
1773) User can change now the number of lines of disassembly displayed in the tracing window
1784) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1795) Added an emulator status window (GPU status, M68K debugger and tracking status)
1806) Added a GPU disassembly tracing window - Display the current PC pointer
1817) Added a DSP disassembly tracing window - Display the current PC pointer
1828) Added possibility to change refresh rate of browsers when emulation is launched
1839) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
184-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
18510) Minor U.I cosmetic changes
18611) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
187-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
189Release 0 (5th January 2017)
1910) New option --debugger
1921) ELF format support
1932) ELF debug symbol support
1943) "Step Into" code function
1954) Menus layout dedicated to the debugger
1965) Added a dedicated main window for tracing (M68K)
1976) Added a Debugger tab in the config tab
1987) Visual Studio 2015 project support
1998) libelf-0.8.13 library support
2009) 64 bits debug executable only
203Known issues
2051) Video output is not displayed due to my OpenGL / QT5 5.5.1 integration with VS 2015 but solved when using the QT 5.9.1 package for VS 2017
2062) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
207-- Need to trace over the BPM or unset the BPM
208-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2093) DWARF 2 support
210-- With GCC: the code must be compiled with the -gdwarf-2 option
2114) The Local and Watch variables window may display not available type information or empty information
212-- Such missing information may be included in future release
213-- The 'const' type may not be reported correctly in the DWARF information
2145) The 2MB mirroring is no longer applied in case of --dram-max option usage
2156) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
216-- The application needs to set the SP (Stack) in accordance
2177) The Exception Vector Table window displays only 65 vectors
218-- Missing vectors may be added in future release
2198) User needs to manualy check if the Atari Jaguar executable match his source code files
220-- Otherwise, source code and assembly may not match or leads to instabilities
2219) The emulator needs to be restarted in case of the following actions occur
222-- Key bindings changes
223-- BIOS selection changes and without new executable load
22410) In the case of a ROM cartridge writing, and with occuring breakpoint, the PC pointer will point at the next instruction and not at the instruction causing the breakpoint
22511) Emulator will crash in case of wrong address value provided in the memory browser
22612) The RAM access log is limited to the 2MB
22713) In various occasions, global variables may be duplicated or without name in the DWARF information
228-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
22914) Source code disply only assembled code from vasm with option -dwarf
23015) After a new breakpoint set, the breakpoint list window is not refreshed
231-- User must perform an operation, such code tracing, to see the breakpoints list update
23216) Some ASCII characters may be not displayed correctly
233-- It depend how the text is displayed, this is related to the QT/HTML encoding done when reading DWARF file
24470541 23417) Potential legacy crash when leaving emulator in pause mode for a long period of time
236Cosmetic / UX issues
2381) The SP (Stack) icon color backgound doesn't look similar with the other ones
2392) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2403) Not every features have associated key bindings
242Legacy issues/hints
2441) Emulator seems to have easter egg(s)
245-- The option --yarrr displays a single message and end the application
246-- Pressing F8, while in the main window, will create an extra message in the log file
2472) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
249Project information
2511) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2522) Visual Studio 2015/2017 project support for 64 bits
2533) libelf 0.8.13 library 64bits for VS 2015/2017
2544) libdwarf 1.41 library 64bits for VS 2015, cygwin64 and Msys2/MinGW64
2555) QT 5.5.1 library 64bits for VS 2015
f951022b 2566) QT 5.12.0 library 64bits for VS 2017
2577) Zlib 1.2.8 library 64bits for VS 2015
2588) Zlib 1.2.11 library 64bits for VS 2017
2599) SDL 1.2.15 library 64bits for VS 2015/2017
26010) The original make files have been modified to follow the requirements and modifications
26111) The 'Rx' word has been added to the emulator name to make distinction with the official version
26212) The project is set at
26313) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
264-- Text / License terms are the same
adf158c7 26514) The x86 configuration has been removed in the VS 2017 project
268Download statistics
270jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
271jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
272No downloads statistics available for the Release 2
273No downloads statistics available for the Release 3