Fix specific breakpoint for ROM cartridge or unknown memory location writing
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
1Release 4a (TBA)
3Git commit:
50) Fix specific breakpoint for ROM cartridge or unknown memory location writing
7Release 4 (10th August 2019)
9Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
110) The zoom value setting has been fixed in the registry
121) Debugger mode now shares the same alpine rom path setting
132) Local variables window displays register name now
143) Switch to Zlib 1.2.11 static library 64bits for VS 2017
154) Switch to SDL 1.2.15 static library 64bits for VS 2017
165) Local variables window displays values from function's parameters
176) Fixed the typedef's name display in Local and Watch variables window
187) Breakpoint may now occur in case of a ROM cartridge writing
19-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
20-- 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
218) Local variables window detects now if a variable is used or not by the code
229) The address provided in the debugger memory windows is now verified to prevent crash
23-- Wrong address will be displayed in red
2410) UI changes
25-- Added new icons for the exit and status features
26-- Modified icons for the SP (Stack) browser
27-- Unified icons sizes depend on their usage (drop down menu and main menu)
28-- Underline the active M68K line in the disassembly window
29-- Allow the up/down navigation on the SP (Stack) browser
30-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
31-- Fixed the up navigation on the memory window
3211) Added some log information for the emulator initialisations
3312) Breakpoint will happen in case of writing at unknown memory location
34-- Alert box will display a message and then the code will stop
3513) Added the DRAM size in the emulator status window
3614) Debugger sources code clean-up
3715) Added a call stack feature
3816) Follow platform requirement to prevent source file reading issue
3917) UI modifications
40-- Modified icon for the memory window to make a distinction with the memory browser
41-- The all watch, and Exception Vector Table windows, can be closed using keyboard
42-- Renamed the debugger dedicated icons to make a distinction
43-- Added the call stack window
4418) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
45-- Previously used ELF/DWARF information was still accessible
4619) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
4720) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
4821) Added a Jaguar model and BIOS configuration tab
4922) Jaguar model and BIOS configuration integration
5023) Added LEB128 decoding functions
51-- It is used for the DWARF decoding information
5224) Debugger support improvement
53-- DWARF support for the enum type (partial), structure and subroutine type
54-- Debugger can report variable's unsigned char value
5525) UI modifications
56-- Added a status bar, better status report & information display for the heap allocation window
57-- Added a status bar, better status report & information display for the local variables window
58-- Added better information display for the exception vectors table window, and added some missing vectors
59-- Added a status bar, better status report & information display for the call stack window
60-- Added a status bar, better status report & information display for the all watches window
6126) Added screenshot feature
62-- Not accessible in debugger mode
63-- Added screenshot editable path in the general tab, and a key binding
6427) Minor misspellings fixes
6528) DWARF source code directory path clean-up
6629) Added a source code files list viewer
67-- List comes from the DWARF information
6830) Check potential variables missing/incomplete description found in the DWARF information
69-- No crash involved but can help to reduce such as variables duplicate or the blank ones
7031) Added a sorting filter in the all watches window
7132) Improve source code file reading to avoid additional text/bytes reading
7233) Help & content texts updates
7334) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
7435) Added the support for the used lines source's DWARF structure
75-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
7636) Added the Rx version's contact in the help text
7737) Added search paths in case of missing DWARF directories information
78-- Used to look for the file(s)
7938) Setup CU's low/high PC in case of the DWARF structures doesn't have it
80-- Used mostly to allow display the source assembled with vasm
8139) Added function name support from ELF structure
8240) Added the return address information in the call stack
8d705db0 8341) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 8442) Added timer initialisation for the SDL setup
f99a6ebc 8543) Added a cartridge view menu
24470541 86-- Added a window to display my own directory and his files list
6642f781 8744) Debugger sources code clean-up
acd3342f 8845) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 8946) Fix crash with potential missing DWARF structure tag's type name
9047) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
9148) Project has switched to QT 5.12.0 library 64bits for VS 2017
3323d78b 9249) Added a Save Dump As... feature to save a memory zone to a file
9350) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
94-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 9551) Removed the sorting filter in the all watches window
96bd5390 9652) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 9753) Set cartridge view menu for debugger mode only
8b11a1b0 9854) Prevent crash in case of call stack is out of range
100Release 3 (13th November 2017)
102Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
1040) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1051) Added an Exception Vector Table window
1062) Modified the About window to update the credits list in a more appropriate way
107-- Updated the emulator application credits line
1083) Added 'Rx' word to the emulator name
1094) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1105) Added ui, alpine and debugger groups in the settings
1116) Added the possibility to erase settings
1127) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1138) Added a key bindings tab and adapted the configuration dialog tabs
114-- User can modify the key bindings where appropriate
115-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1169) Fixed a crash, in Release mode, when the HW labels setting is turn on
11710) Solved an interference between the HW labels setting and the one used by the debugger
118-- The setting is now only the reference used
11911) Fixed the SP (Stack) browser UI potential missing data
12012) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
12113) Keep the scrollbar position in accordance of the M68K PC pointer
122-- UI displays the source without the need to move down/up the scrollbar
12314) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
124-- This may come from the linker vlink
12515) Improved the .heap section detection to avoid a detection error
126-- Depend vlink version, .heap section may have an Alloc flag
12716) Fixed a crash when DWARF information does references to missing source code files
12817) Added a local variables window
12918) Project has switched to Visual Studio 2017 and QT 5.9.1 library
131Release 2 (3rd September 2017)
1330) Added some error detections when reading the ELF executable file
1341) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1352) "Step Over" code function for BSR/JSR functions
1363) Added the .debug_ranges detection to avoid a detection error
1374) DWARF support
138-- TAG: Compilation Unit, Subprogram, Variables, Types
139-- Line numbers, symbols, functions
1405) Added an All Watch window for non-local variables
1416) Added a heap allocator window based on my own memory allocation functions
1427) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1438) Windows refreshing executed only if windows is visible
1449) Added a restart function
145-- Restart only the 68000 program counter to his original set
14610) Modified the icons color backgound for the "Step In" and "Step Over" functions
14711) Updated the About window to update the credits list
14812) 64 bits Release executable
14913) Fixed (hacking) the display of the SP (Stack) browser
15014) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
151-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
15215) Added some information in the --help/-h/-? option
15316) --debugger option no longer force the log file
15417) Added a --dram-max option to extend the DRAM size to 8MB
15518) Added the "enter" key support when setting the BPM (Breapoint)
15619) Save the windows positions, size and visibilities (show or hide) status
157-- Such windows will automatically respawn in the next emulator launch
159Release 1 (12th February 2017)
1610) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1621) Clean-up the tracing / no-tracing flags for better U.I understanding
1632) Added SP (Stack) browser
1643) User can change now the number of lines of disassembly displayed in the tracing window
1654) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1665) Added an emulator status window (GPU status, M68K debugger and tracking status)
1676) Added a GPU disassembly tracing window - Display the current PC pointer
1687) Added a DSP disassembly tracing window - Display the current PC pointer
1698) Added possibility to change refresh rate of browsers when emulation is launched
1709) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
171-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
17210) Minor U.I cosmetic changes
17311) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
174-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
176Release 0 (5th January 2017)
1780) New option --debugger
1791) ELF format support
1802) ELF debug symbol support
1813) "Step Into" code function
1824) Menus layout dedicated to the debugger
1835) Added a dedicated main window for tracing (M68K)
1846) Added a Debugger tab in the config tab
1857) Visual Studio 2015 project support
1868) libelf-0.8.13 library support
1879) 64 bits debug executable only
190Known issues
1921) 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
1932) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
194-- Need to trace over the BPM or unset the BPM
195-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
1963) DWARF 2 support
197-- With GCC: the code must be compiled with the -gdwarf-2 option
1984) The Local and Watch variables window may display not available type information or empty information
199-- Such missing information may be included in future release
200-- The 'const' type may not be reported correctly in the DWARF information
2015) The 2MB mirroring is no longer applied in case of --dram-max option usage
2026) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
203-- The application needs to set the SP (Stack) in accordance
2047) The Exception Vector Table window displays only 65 vectors
205-- Missing vectors may be added in future release
2068) User needs to manualy check if the Atari Jaguar executable match his source code files
207-- Otherwise, source code and assembly may not match or leads to instabilities
2089) The emulator needs to be restarted in case of the following actions occur
209-- Key bindings changes
210-- BIOS selection changes and without new executable load
21110) 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
21211) Emulator will crash in case of wrong address value provided in the memory browser
21312) The RAM access log is limited to the 2MB
21413) In various occasions, global variables may be duplicated or without name in the DWARF information
215-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
21614) Source code disply only assembled code from vasm with option -dwarf
21715) After a new breakpoint set, the breakpoint list window is not refreshed
218-- User must perform an operation, such code tracing, to see the breakpoints list update
21916) Some ASCII characters may be not displayed correctly
220-- It depend how the text is displayed, this is related to the QT/HTML encoding done when reading DWARF file
24470541 22117) Potential legacy crash when leaving emulator in pause mode for a long period of time
223Cosmetic / UX issues
2251) The SP (Stack) icon color backgound doesn't look similar with the other ones
2262) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2273) Not every features have associated key bindings
229Legacy issues/hints
2311) Emulator seems to have easter egg(s)
232-- The option --yarrr displays a single message and end the application
233-- Pressing F8, while in the main window, will create an extra message in the log file
2342) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
236Project information
2381) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2392) Visual Studio 2015/2017 project support for 64 bits
2403) libelf 0.8.13 library 64bits for VS 2015/2017
2414) libdwarf 1.41 library 64bits for VS 2015, cygwin64 and Msys2/MinGW64
2425) QT 5.5.1 library 64bits for VS 2015
f951022b 2436) QT 5.12.0 library 64bits for VS 2017
2447) Zlib 1.2.8 library 64bits for VS 2015
2458) Zlib 1.2.11 library 64bits for VS 2017
2469) SDL 1.2.15 library 64bits for VS 2015/2017
24710) The original make files have been modified to follow the requirements and modifications
24811) The 'Rx' word has been added to the emulator name to make distinction with the official version
24912) The project is set at
25013) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
251-- Text / License terms are the same
254Download statistics
256jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
257jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
258No downloads statistics available for the Release 2
259No downloads statistics available for the Release 3