Show the SR value as a readable form in the CPU browser
[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
5b652120 2617) Project has switched to libdwarf 20201201 library 64bits for VS 2017
e09d2abd 2718) Show the SR value as a readable form in the CPU browser
fe41cce0
JPM
28
29Release 4a (15th August 2019)
30-----------------------------
31Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
f04df4f1
JPM
32-
330) Fix specific breakpoint for ROM cartridge or unknown memory location writing
34
35Release 4 (10th August 2019)
36----------------------------
37Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
1081a838
JPM
38-
390) The zoom value setting has been fixed in the registry
401) Debugger mode now shares the same alpine rom path setting
412) Local variables window displays register name now
423) Switch to Zlib 1.2.11 static library 64bits for VS 2017
434) Switch to SDL 1.2.15 static library 64bits for VS 2017
445) Local variables window displays values from function's parameters
456) Fixed the typedef's name display in Local and Watch variables window
467) Breakpoint may now occur in case of a ROM cartridge writing
47-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
48-- 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
498) Local variables window detects now if a variable is used or not by the code
509) The address provided in the debugger memory windows is now verified to prevent crash
51-- Wrong address will be displayed in red
5210) UI changes
53-- Added new icons for the exit and status features
54-- Modified icons for the SP (Stack) browser
55-- Unified icons sizes depend on their usage (drop down menu and main menu)
56-- Underline the active M68K line in the disassembly window
57-- Allow the up/down navigation on the SP (Stack) browser
58-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
59-- Fixed the up navigation on the memory window
6011) Added some log information for the emulator initialisations
6112) Breakpoint will happen in case of writing at unknown memory location
62-- Alert box will display a message and then the code will stop
6313) Added the DRAM size in the emulator status window
6414) Debugger sources code clean-up
6515) Added a call stack feature
6616) Follow platform requirement to prevent source file reading issue
6717) UI modifications
68-- Modified icon for the memory window to make a distinction with the memory browser
69-- The all watch, and Exception Vector Table windows, can be closed using keyboard
70-- Renamed the debugger dedicated icons to make a distinction
71-- Added the call stack window
7218) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
73-- Previously used ELF/DWARF information was still accessible
7419) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
7520) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
7621) Added a Jaguar model and BIOS configuration tab
7722) Jaguar model and BIOS configuration integration
7823) Added LEB128 decoding functions
79-- It is used for the DWARF decoding information
8024) Debugger support improvement
81-- DWARF support for the enum type (partial), structure and subroutine type
82-- Debugger can report variable's unsigned char value
8325) UI modifications
84-- Added a status bar, better status report & information display for the heap allocation window
85-- Added a status bar, better status report & information display for the local variables window
86-- Added better information display for the exception vectors table window, and added some missing vectors
87-- Added a status bar, better status report & information display for the call stack window
88-- Added a status bar, better status report & information display for the all watches window
8926) Added screenshot feature
90-- Not accessible in debugger mode
91-- Added screenshot editable path in the general tab, and a key binding
9227) Minor misspellings fixes
9328) DWARF source code directory path clean-up
9429) Added a source code files list viewer
95-- List comes from the DWARF information
9630) Check potential variables missing/incomplete description found in the DWARF information
97-- No crash involved but can help to reduce such as variables duplicate or the blank ones
9831) Added a sorting filter in the all watches window
9932) Improve source code file reading to avoid additional text/bytes reading
10033) Help & content texts updates
10134) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
10235) Added the support for the used lines source's DWARF structure
103-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
10436) Added the Rx version's contact in the help text
10537) Added search paths in case of missing DWARF directories information
106-- Used to look for the file(s)
10738) Setup CU's low/high PC in case of the DWARF structures doesn't have it
108-- Used mostly to allow display the source assembled with vasm
10939) Added function name support from ELF structure
11040) Added the return address information in the call stack
8d705db0 11141) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 11242) Added timer initialisation for the SDL setup
f99a6ebc 11343) Added a cartridge view menu
24470541 114-- Added a window to display my own directory and his files list
6642f781 11544) Debugger sources code clean-up
acd3342f 11645) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 11746) Fix crash with potential missing DWARF structure tag's type name
c57d3e56 11847) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
aae93d86 11948) Project has switched to Qt 5.12.0 library 64bits for VS 2017
3323d78b 12049) Added a Save Dump As... feature to save a memory zone to a file
9c4d8f10
JPM
12150) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
122-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 12351) Removed the sorting filter in the all watches window
96bd5390 12452) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 12553) Set cartridge view menu for debugger mode only
8b11a1b0 12654) Prevent crash in case of call stack is out of range
1081a838
JPM
127
128Release 3 (13th November 2017)
129------------------------------
130Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
131-
1320) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1331) Added an Exception Vector Table window
1342) Modified the About window to update the credits list in a more appropriate way
135-- Updated the emulator application credits line
1363) Added 'Rx' word to the emulator name
1374) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1385) Added ui, alpine and debugger groups in the settings
1396) Added the possibility to erase settings
1407) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1418) Added a key bindings tab and adapted the configuration dialog tabs
142-- User can modify the key bindings where appropriate
143-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1449) Fixed a crash, in Release mode, when the HW labels setting is turn on
14510) Solved an interference between the HW labels setting and the one used by the debugger
146-- The setting is now only the reference used
14711) Fixed the SP (Stack) browser UI potential missing data
14812) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
14913) Keep the scrollbar position in accordance of the M68K PC pointer
150-- UI displays the source without the need to move down/up the scrollbar
15114) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
152-- This may come from the linker vlink
15315) Improved the .heap section detection to avoid a detection error
154-- Depend vlink version, .heap section may have an Alloc flag
15516) Fixed a crash when DWARF information does references to missing source code files
15617) Added a local variables window
aae93d86 15718) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
1081a838
JPM
158
159Release 2 (3rd September 2017)
160------------------------------
1610) Added some error detections when reading the ELF executable file
1621) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1632) "Step Over" code function for BSR/JSR functions
1643) Added the .debug_ranges detection to avoid a detection error
1654) DWARF support
166-- TAG: Compilation Unit, Subprogram, Variables, Types
167-- Line numbers, symbols, functions
1685) Added an All Watch window for non-local variables
1696) Added a heap allocator window based on my own memory allocation functions
1707) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1718) Windows refreshing executed only if windows is visible
1729) Added a restart function
173-- Restart only the 68000 program counter to his original set
17410) Modified the icons color backgound for the "Step In" and "Step Over" functions
17511) Updated the About window to update the credits list
17612) 64 bits Release executable
17713) Fixed (hacking) the display of the SP (Stack) browser
17814) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
179-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
18015) Added some information in the --help/-h/-? option
18116) --debugger option no longer force the log file
18217) Added a --dram-max option to extend the DRAM size to 8MB
18318) Added the "enter" key support when setting the BPM (Breapoint)
18419) Save the windows positions, size and visibilities (show or hide) status
185-- Such windows will automatically respawn in the next emulator launch
186
187Release 1 (12th February 2017)
188------------------------------
1890) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1901) Clean-up the tracing / no-tracing flags for better U.I understanding
1912) Added SP (Stack) browser
1923) User can change now the number of lines of disassembly displayed in the tracing window
1934) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1945) Added an emulator status window (GPU status, M68K debugger and tracking status)
1956) Added a GPU disassembly tracing window - Display the current PC pointer
1967) Added a DSP disassembly tracing window - Display the current PC pointer
1978) Added possibility to change refresh rate of browsers when emulation is launched
1989) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
199-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
20010) Minor U.I cosmetic changes
20111) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
202-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
203
204Release 0 (5th January 2017)
205----------------------------
2060) New option --debugger
2071) ELF format support
2082) ELF debug symbol support
2093) "Step Into" code function
2104) Menus layout dedicated to the debugger
2115) Added a dedicated main window for tracing (M68K)
2126) Added a Debugger tab in the config tab
2137) Visual Studio 2015 project support
2148) libelf-0.8.13 library support
2159) 64 bits debug executable only
216
217
218Known issues
219============
aae93d86 2201) 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
2212) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
222-- Need to trace over the BPM or unset the BPM
223-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2243) DWARF 2 support
225-- With GCC: the code must be compiled with the -gdwarf-2 option
2264) The Local and Watch variables window may display not available type information or empty information
227-- Such missing information may be included in future release
228-- The 'const' type may not be reported correctly in the DWARF information
2295) The 2MB mirroring is no longer applied in case of --dram-max option usage
2306) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
231-- The application needs to set the SP (Stack) in accordance
2327) The Exception Vector Table window displays only 65 vectors
233-- Missing vectors may be added in future release
2348) User needs to manualy check if the Atari Jaguar executable match his source code files
235-- Otherwise, source code and assembly may not match or leads to instabilities
2369) The emulator needs to be restarted in case of the following actions occur
237-- Key bindings changes
238-- BIOS selection changes and without new executable load
23910) 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
24011) Emulator will crash in case of wrong address value provided in the memory browser
24112) The RAM access log is limited to the 2MB
24213) In various occasions, global variables may be duplicated or without name in the DWARF information
243-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
24414) Source code disply only assembled code from vasm with option -dwarf
24515) After a new breakpoint set, the breakpoint list window is not refreshed
246-- User must perform an operation, such code tracing, to see the breakpoints list update
24716) Some ASCII characters may be not displayed correctly
aae93d86 248-- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
24470541 24917) Potential legacy crash when leaving emulator in pause mode for a long period of time
aae93d86 250-- Need much investigation
1081a838
JPM
251
252Cosmetic / UX issues
253====================
2541) The SP (Stack) icon color backgound doesn't look similar with the other ones
2552) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2563) Not every features have associated key bindings
257
258Legacy issues/hints
259===================
2601) Emulator seems to have easter egg(s)
261-- The option --yarrr displays a single message and end the application
262-- Pressing F8, while in the main window, will create an extra message in the log file
2632) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
264
265Project information
266===================
2671) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
aae93d86
JPM
2682) Visual Studio 2017 project support for 64 bits
2693) libelf 0.8.13 library 64bits for VS 2017
5b652120 2704) libdwarf 20201201 library 64bits for VS 2017
aae93d86
JPM
2715) Qt 5.12.0 library 64bits for VS 2017
2726) Zlib 1.2.11 library 64bits for VS 2017
2737) SDL 1.2.15 library 64bits for VS 2017
2748) The original make files have been modified to follow the requirements and modifications
2759) The 'Rx' word has been added to the emulator name to make distinction with the official version
27610) The project is set at https://github.com/djipi/Virtual-Jaguar-Rx
27711) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
1081a838 278-- Text / License terms are the same
adf158c7 27914) The x86 configuration has been removed in the VS 2017 project
1081a838
JPM
280
281
282Download statistics
283-------------------
284jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
285jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
286No downloads statistics available for the Release 2
287No downloads statistics available for the Release 3