Added video output display in a specific window
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
CommitLineData
fe41cce0
JPM
1Release 5 (TBA)
2---------------
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
f6eb33e6
JPM
51) Added a specific breakpoint for the M68K illegal instruction exception
6-- Alert box will display a message and then the code will stop
0cbc132e
JPM
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
ef0da6de
JPM
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
2a13a691 136) Fix potential emulator freeze after an exception has occured
258b1c16 147) Fix a random crash when reading the source lines information
c3b14e59 158) Added ELF & DWARF .debug* types
7575ebee 169) Added ELF section types check and new error messages
009df4d7
JPM
1710) Modified the call stack layout window and added source filename from the called source line
1811) Added a source tab in the main window for step into tracing
1912) Added the step over for source level tracing
368f46d1
JPM
2013) Set text conversion to Qt/HTML format for the M68K tracing window
2114) Added a source code file date check when reading DWARF information
009df4d7 22-- Will avoid source code mismatching with the ELF executable
36452de8 2315) Remove Visual Studio 2015 support
5b652120 2416) Work around fix for a compilation error on Linux
b45a1df3 25-- EEPROM directory creation allowed only for Windows at the moment
40692bae
JPM
2617) Show the SR value as a readable form in the CPU browser
2718) Potential fix to compile on Linux
8646ea44 28-- Added the relative directory path for the Qt include files
40692bae 2919) Merge the Linux build fixes from @richard42
c4fe5864 30-- Jaguar core's makefile and Qt pro file updates, fix filenames case sensitive & fixes for Linux
40692bae 3120) Updated the M68K exception catch
28c2bdc6
JPM
32-- Added a M68K exception catch check in the Alpine tab settings
33-- Added a specific breakpoint for the M68K bus error exception
40692bae 3421) Project has switched to libdwarf 20210305 library 64bits for VS 2017
cbd79f66 3522) Breakpoint list window is now refreshed after a new breakpoint is set
44432db5
JPM
3623) Handle number of M68K cycles used when tracing in debugger mode
37-- The cycles are displayed in the emulator status window
1cd9e492 3824) Improve the DWARF source line number reporting
03458eec
JPM
3925) Added a #line in the call stack window
4026) Add a search feature in the all watches window
96aa54e4 4127) Added video output display in a specific window
fe41cce0
JPM
42
43Release 4a (15th August 2019)
44-----------------------------
45Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
f04df4f1
JPM
46-
470) Fix specific breakpoint for ROM cartridge or unknown memory location writing
48
49Release 4 (10th August 2019)
50----------------------------
51Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
1081a838
JPM
52-
530) The zoom value setting has been fixed in the registry
541) Debugger mode now shares the same alpine rom path setting
552) Local variables window displays register name now
563) Switch to Zlib 1.2.11 static library 64bits for VS 2017
574) Switch to SDL 1.2.15 static library 64bits for VS 2017
585) Local variables window displays values from function's parameters
596) Fixed the typedef's name display in Local and Watch variables window
607) Breakpoint may now occur in case of a ROM cartridge writing
61-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
62-- 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
638) Local variables window detects now if a variable is used or not by the code
649) The address provided in the debugger memory windows is now verified to prevent crash
65-- Wrong address will be displayed in red
6610) UI changes
67-- Added new icons for the exit and status features
68-- Modified icons for the SP (Stack) browser
69-- Unified icons sizes depend on their usage (drop down menu and main menu)
70-- Underline the active M68K line in the disassembly window
71-- Allow the up/down navigation on the SP (Stack) browser
72-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
73-- Fixed the up navigation on the memory window
7411) Added some log information for the emulator initialisations
7512) Breakpoint will happen in case of writing at unknown memory location
76-- Alert box will display a message and then the code will stop
7713) Added the DRAM size in the emulator status window
7814) Debugger sources code clean-up
7915) Added a call stack feature
8016) Follow platform requirement to prevent source file reading issue
8117) UI modifications
82-- Modified icon for the memory window to make a distinction with the memory browser
83-- The all watch, and Exception Vector Table windows, can be closed using keyboard
84-- Renamed the debugger dedicated icons to make a distinction
85-- Added the call stack window
8618) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
87-- Previously used ELF/DWARF information was still accessible
8819) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
8920) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
9021) Added a Jaguar model and BIOS configuration tab
9122) Jaguar model and BIOS configuration integration
9223) Added LEB128 decoding functions
93-- It is used for the DWARF decoding information
9424) Debugger support improvement
95-- DWARF support for the enum type (partial), structure and subroutine type
96-- Debugger can report variable's unsigned char value
9725) UI modifications
98-- Added a status bar, better status report & information display for the heap allocation window
99-- Added a status bar, better status report & information display for the local variables window
100-- Added better information display for the exception vectors table window, and added some missing vectors
101-- Added a status bar, better status report & information display for the call stack window
102-- Added a status bar, better status report & information display for the all watches window
10326) Added screenshot feature
104-- Not accessible in debugger mode
105-- Added screenshot editable path in the general tab, and a key binding
10627) Minor misspellings fixes
10728) DWARF source code directory path clean-up
10829) Added a source code files list viewer
109-- List comes from the DWARF information
11030) Check potential variables missing/incomplete description found in the DWARF information
111-- No crash involved but can help to reduce such as variables duplicate or the blank ones
11231) Added a sorting filter in the all watches window
11332) Improve source code file reading to avoid additional text/bytes reading
11433) Help & content texts updates
11534) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
11635) Added the support for the used lines source's DWARF structure
117-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
11836) Added the Rx version's contact in the help text
11937) Added search paths in case of missing DWARF directories information
120-- Used to look for the file(s)
12138) Setup CU's low/high PC in case of the DWARF structures doesn't have it
122-- Used mostly to allow display the source assembled with vasm
12339) Added function name support from ELF structure
12440) Added the return address information in the call stack
8d705db0 12541) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 12642) Added timer initialisation for the SDL setup
f99a6ebc 12743) Added a cartridge view menu
24470541 128-- Added a window to display my own directory and his files list
6642f781 12944) Debugger sources code clean-up
acd3342f 13045) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 13146) Fix crash with potential missing DWARF structure tag's type name
c57d3e56 13247) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
aae93d86 13348) Project has switched to Qt 5.12.0 library 64bits for VS 2017
3323d78b 13449) Added a Save Dump As... feature to save a memory zone to a file
9c4d8f10
JPM
13550) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
136-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 13751) Removed the sorting filter in the all watches window
96bd5390 13852) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 13953) Set cartridge view menu for debugger mode only
8b11a1b0 14054) Prevent crash in case of call stack is out of range
1081a838
JPM
141
142Release 3 (13th November 2017)
143------------------------------
144Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
145-
1460) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1471) Added an Exception Vector Table window
1482) Modified the About window to update the credits list in a more appropriate way
149-- Updated the emulator application credits line
1503) Added 'Rx' word to the emulator name
1514) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1525) Added ui, alpine and debugger groups in the settings
1536) Added the possibility to erase settings
1547) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1558) Added a key bindings tab and adapted the configuration dialog tabs
156-- User can modify the key bindings where appropriate
157-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1589) Fixed a crash, in Release mode, when the HW labels setting is turn on
15910) Solved an interference between the HW labels setting and the one used by the debugger
160-- The setting is now only the reference used
16111) Fixed the SP (Stack) browser UI potential missing data
16212) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
16313) Keep the scrollbar position in accordance of the M68K PC pointer
164-- UI displays the source without the need to move down/up the scrollbar
16514) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
166-- This may come from the linker vlink
16715) Improved the .heap section detection to avoid a detection error
168-- Depend vlink version, .heap section may have an Alloc flag
16916) Fixed a crash when DWARF information does references to missing source code files
17017) Added a local variables window
aae93d86 17118) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
1081a838
JPM
172
173Release 2 (3rd September 2017)
174------------------------------
1750) Added some error detections when reading the ELF executable file
1761) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1772) "Step Over" code function for BSR/JSR functions
1783) Added the .debug_ranges detection to avoid a detection error
1794) DWARF support
180-- TAG: Compilation Unit, Subprogram, Variables, Types
181-- Line numbers, symbols, functions
1825) Added an All Watch window for non-local variables
1836) Added a heap allocator window based on my own memory allocation functions
1847) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1858) Windows refreshing executed only if windows is visible
1869) Added a restart function
187-- Restart only the 68000 program counter to his original set
18810) Modified the icons color backgound for the "Step In" and "Step Over" functions
18911) Updated the About window to update the credits list
19012) 64 bits Release executable
19113) Fixed (hacking) the display of the SP (Stack) browser
19214) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
193-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
19415) Added some information in the --help/-h/-? option
19516) --debugger option no longer force the log file
19617) Added a --dram-max option to extend the DRAM size to 8MB
19718) Added the "enter" key support when setting the BPM (Breapoint)
19819) Save the windows positions, size and visibilities (show or hide) status
199-- Such windows will automatically respawn in the next emulator launch
200
201Release 1 (12th February 2017)
202------------------------------
2030) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
2041) Clean-up the tracing / no-tracing flags for better U.I understanding
2052) Added SP (Stack) browser
2063) User can change now the number of lines of disassembly displayed in the tracing window
2074) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
2085) Added an emulator status window (GPU status, M68K debugger and tracking status)
2096) Added a GPU disassembly tracing window - Display the current PC pointer
2107) Added a DSP disassembly tracing window - Display the current PC pointer
2118) Added possibility to change refresh rate of browsers when emulation is launched
2129) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
213-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
21410) Minor U.I cosmetic changes
21511) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
216-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
217
218Release 0 (5th January 2017)
219----------------------------
2200) New option --debugger
2211) ELF format support
2222) ELF debug symbol support
2233) "Step Into" code function
2244) Menus layout dedicated to the debugger
2255) Added a dedicated main window for tracing (M68K)
2266) Added a Debugger tab in the config tab
2277) Visual Studio 2015 project support
2288) libelf-0.8.13 library support
2299) 64 bits debug executable only
230
231
232Known issues
233============
aae93d86 2341) 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
1081a838
JPM
2352) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
236-- Need to trace over the BPM or unset the BPM
237-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2383) DWARF 2 support
239-- With GCC: the code must be compiled with the -gdwarf-2 option
2404) The Local and Watch variables window may display not available type information or empty information
241-- Such missing information may be included in future release
242-- The 'const' type may not be reported correctly in the DWARF information
2435) The 2MB mirroring is no longer applied in case of --dram-max option usage
2446) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
245-- The application needs to set the SP (Stack) in accordance
2467) The Exception Vector Table window displays only 65 vectors
247-- Missing vectors may be added in future release
2488) User needs to manualy check if the Atari Jaguar executable match his source code files
249-- Otherwise, source code and assembly may not match or leads to instabilities
2509) The emulator needs to be restarted in case of the following actions occur
251-- Key bindings changes
252-- BIOS selection changes and without new executable load
25310) 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
25411) Emulator will crash in case of wrong address value provided in the memory browser
25512) The RAM access log is limited to the 2MB
25613) In various occasions, global variables may be duplicated or without name in the DWARF information
257-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
25814) Source code disply only assembled code from vasm with option -dwarf
25915) After a new breakpoint set, the breakpoint list window is not refreshed
260-- User must perform an operation, such code tracing, to see the breakpoints list update
26116) Some ASCII characters may be not displayed correctly
aae93d86 262-- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
24470541 26317) Potential legacy crash when leaving emulator in pause mode for a long period of time
aae93d86 264-- Need much investigation
1081a838
JPM
265
266Cosmetic / UX issues
267====================
2681) The SP (Stack) icon color backgound doesn't look similar with the other ones
2692) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2703) Not every features have associated key bindings
271
272Legacy issues/hints
273===================
2741) Emulator seems to have easter egg(s)
275-- The option --yarrr displays a single message and end the application
276-- Pressing F8, while in the main window, will create an extra message in the log file
2772) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
278
279Project information
280===================
2811) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
aae93d86
JPM
2822) Visual Studio 2017 project support for 64 bits
2833) libelf 0.8.13 library 64bits for VS 2017
40692bae 2844) libdwarf 20210305 library 64bits for VS 2017
aae93d86
JPM
2855) Qt 5.12.0 library 64bits for VS 2017
2866) Zlib 1.2.11 library 64bits for VS 2017
2877) SDL 1.2.15 library 64bits for VS 2017
2888) The original make files have been modified to follow the requirements and modifications
2899) The 'Rx' word has been added to the emulator name to make distinction with the official version
29010) The project is set at https://github.com/djipi/Virtual-Jaguar-Rx
29111) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
1081a838 292-- Text / License terms are the same
adf158c7 29314) The x86 configuration has been removed in the VS 2017 project
1081a838
JPM
294
295
296Download statistics
297-------------------
298jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
299jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
300No downloads statistics available for the Release 2
301No downloads statistics available for the Release 3