Added detection for the unsigned/signed short type
[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
fe41cce0
JPM
12
13Release 4a (15th August 2019)
14-----------------------------
15Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
f04df4f1
JPM
16-
170) Fix specific breakpoint for ROM cartridge or unknown memory location writing
18
19Release 4 (10th August 2019)
20----------------------------
21Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
1081a838
JPM
22-
230) The zoom value setting has been fixed in the registry
241) Debugger mode now shares the same alpine rom path setting
252) Local variables window displays register name now
263) Switch to Zlib 1.2.11 static library 64bits for VS 2017
274) Switch to SDL 1.2.15 static library 64bits for VS 2017
285) Local variables window displays values from function's parameters
296) Fixed the typedef's name display in Local and Watch variables window
307) Breakpoint may now occur in case of a ROM cartridge writing
31-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
32-- 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
338) Local variables window detects now if a variable is used or not by the code
349) The address provided in the debugger memory windows is now verified to prevent crash
35-- Wrong address will be displayed in red
3610) UI changes
37-- Added new icons for the exit and status features
38-- Modified icons for the SP (Stack) browser
39-- Unified icons sizes depend on their usage (drop down menu and main menu)
40-- Underline the active M68K line in the disassembly window
41-- Allow the up/down navigation on the SP (Stack) browser
42-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
43-- Fixed the up navigation on the memory window
4411) Added some log information for the emulator initialisations
4512) Breakpoint will happen in case of writing at unknown memory location
46-- Alert box will display a message and then the code will stop
4713) Added the DRAM size in the emulator status window
4814) Debugger sources code clean-up
4915) Added a call stack feature
5016) Follow platform requirement to prevent source file reading issue
5117) UI modifications
52-- Modified icon for the memory window to make a distinction with the memory browser
53-- The all watch, and Exception Vector Table windows, can be closed using keyboard
54-- Renamed the debugger dedicated icons to make a distinction
55-- Added the call stack window
5618) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
57-- Previously used ELF/DWARF information was still accessible
5819) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
5920) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
6021) Added a Jaguar model and BIOS configuration tab
6122) Jaguar model and BIOS configuration integration
6223) Added LEB128 decoding functions
63-- It is used for the DWARF decoding information
6424) Debugger support improvement
65-- DWARF support for the enum type (partial), structure and subroutine type
66-- Debugger can report variable's unsigned char value
6725) UI modifications
68-- Added a status bar, better status report & information display for the heap allocation window
69-- Added a status bar, better status report & information display for the local variables window
70-- Added better information display for the exception vectors table window, and added some missing vectors
71-- Added a status bar, better status report & information display for the call stack window
72-- Added a status bar, better status report & information display for the all watches window
7326) Added screenshot feature
74-- Not accessible in debugger mode
75-- Added screenshot editable path in the general tab, and a key binding
7627) Minor misspellings fixes
7728) DWARF source code directory path clean-up
7829) Added a source code files list viewer
79-- List comes from the DWARF information
8030) Check potential variables missing/incomplete description found in the DWARF information
81-- No crash involved but can help to reduce such as variables duplicate or the blank ones
8231) Added a sorting filter in the all watches window
8332) Improve source code file reading to avoid additional text/bytes reading
8433) Help & content texts updates
8534) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
8635) Added the support for the used lines source's DWARF structure
87-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
8836) Added the Rx version's contact in the help text
8937) Added search paths in case of missing DWARF directories information
90-- Used to look for the file(s)
9138) Setup CU's low/high PC in case of the DWARF structures doesn't have it
92-- Used mostly to allow display the source assembled with vasm
9339) Added function name support from ELF structure
9440) Added the return address information in the call stack
8d705db0 9541) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 9642) Added timer initialisation for the SDL setup
f99a6ebc 9743) Added a cartridge view menu
24470541 98-- Added a window to display my own directory and his files list
6642f781 9944) Debugger sources code clean-up
acd3342f 10045) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 10146) Fix crash with potential missing DWARF structure tag's type name
c57d3e56
JPM
10247) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
10348) Project has switched to QT 5.12.0 library 64bits for VS 2017
3323d78b 10449) Added a Save Dump As... feature to save a memory zone to a file
9c4d8f10
JPM
10550) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
106-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 10751) Removed the sorting filter in the all watches window
96bd5390 10852) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 10953) Set cartridge view menu for debugger mode only
8b11a1b0 11054) Prevent crash in case of call stack is out of range
1081a838
JPM
111
112Release 3 (13th November 2017)
113------------------------------
114Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
115-
1160) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1171) Added an Exception Vector Table window
1182) Modified the About window to update the credits list in a more appropriate way
119-- Updated the emulator application credits line
1203) Added 'Rx' word to the emulator name
1214) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1225) Added ui, alpine and debugger groups in the settings
1236) Added the possibility to erase settings
1247) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1258) Added a key bindings tab and adapted the configuration dialog tabs
126-- User can modify the key bindings where appropriate
127-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1289) Fixed a crash, in Release mode, when the HW labels setting is turn on
12910) Solved an interference between the HW labels setting and the one used by the debugger
130-- The setting is now only the reference used
13111) Fixed the SP (Stack) browser UI potential missing data
13212) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
13313) Keep the scrollbar position in accordance of the M68K PC pointer
134-- UI displays the source without the need to move down/up the scrollbar
13514) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
136-- This may come from the linker vlink
13715) Improved the .heap section detection to avoid a detection error
138-- Depend vlink version, .heap section may have an Alloc flag
13916) Fixed a crash when DWARF information does references to missing source code files
14017) Added a local variables window
14118) Project has switched to Visual Studio 2017 and QT 5.9.1 library
142
143Release 2 (3rd September 2017)
144------------------------------
1450) Added some error detections when reading the ELF executable file
1461) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1472) "Step Over" code function for BSR/JSR functions
1483) Added the .debug_ranges detection to avoid a detection error
1494) DWARF support
150-- TAG: Compilation Unit, Subprogram, Variables, Types
151-- Line numbers, symbols, functions
1525) Added an All Watch window for non-local variables
1536) Added a heap allocator window based on my own memory allocation functions
1547) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1558) Windows refreshing executed only if windows is visible
1569) Added a restart function
157-- Restart only the 68000 program counter to his original set
15810) Modified the icons color backgound for the "Step In" and "Step Over" functions
15911) Updated the About window to update the credits list
16012) 64 bits Release executable
16113) Fixed (hacking) the display of the SP (Stack) browser
16214) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
163-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
16415) Added some information in the --help/-h/-? option
16516) --debugger option no longer force the log file
16617) Added a --dram-max option to extend the DRAM size to 8MB
16718) Added the "enter" key support when setting the BPM (Breapoint)
16819) Save the windows positions, size and visibilities (show or hide) status
169-- Such windows will automatically respawn in the next emulator launch
170
171Release 1 (12th February 2017)
172------------------------------
1730) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1741) Clean-up the tracing / no-tracing flags for better U.I understanding
1752) Added SP (Stack) browser
1763) User can change now the number of lines of disassembly displayed in the tracing window
1774) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1785) Added an emulator status window (GPU status, M68K debugger and tracking status)
1796) Added a GPU disassembly tracing window - Display the current PC pointer
1807) Added a DSP disassembly tracing window - Display the current PC pointer
1818) Added possibility to change refresh rate of browsers when emulation is launched
1829) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
183-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
18410) Minor U.I cosmetic changes
18511) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
186-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
187
188Release 0 (5th January 2017)
189----------------------------
1900) New option --debugger
1911) ELF format support
1922) ELF debug symbol support
1933) "Step Into" code function
1944) Menus layout dedicated to the debugger
1955) Added a dedicated main window for tracing (M68K)
1966) Added a Debugger tab in the config tab
1977) Visual Studio 2015 project support
1988) libelf-0.8.13 library support
1999) 64 bits debug executable only
200
201
202Known issues
203============
2041) 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
2052) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
206-- Need to trace over the BPM or unset the BPM
207-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2083) DWARF 2 support
209-- With GCC: the code must be compiled with the -gdwarf-2 option
2104) The Local and Watch variables window may display not available type information or empty information
211-- Such missing information may be included in future release
212-- The 'const' type may not be reported correctly in the DWARF information
2135) The 2MB mirroring is no longer applied in case of --dram-max option usage
2146) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
215-- The application needs to set the SP (Stack) in accordance
2167) The Exception Vector Table window displays only 65 vectors
217-- Missing vectors may be added in future release
2188) User needs to manualy check if the Atari Jaguar executable match his source code files
219-- Otherwise, source code and assembly may not match or leads to instabilities
2209) The emulator needs to be restarted in case of the following actions occur
221-- Key bindings changes
222-- BIOS selection changes and without new executable load
22310) 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
22411) Emulator will crash in case of wrong address value provided in the memory browser
22512) The RAM access log is limited to the 2MB
22613) In various occasions, global variables may be duplicated or without name in the DWARF information
227-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
22814) Source code disply only assembled code from vasm with option -dwarf
22915) After a new breakpoint set, the breakpoint list window is not refreshed
230-- User must perform an operation, such code tracing, to see the breakpoints list update
23116) Some ASCII characters may be not displayed correctly
232-- It depend how the text is displayed, this is related to the QT/HTML encoding done when reading DWARF file
24470541 23317) Potential legacy crash when leaving emulator in pause mode for a long period of time
1081a838
JPM
234
235Cosmetic / UX issues
236====================
2371) The SP (Stack) icon color backgound doesn't look similar with the other ones
2382) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2393) Not every features have associated key bindings
240
241Legacy issues/hints
242===================
2431) Emulator seems to have easter egg(s)
244-- The option --yarrr displays a single message and end the application
245-- Pressing F8, while in the main window, will create an extra message in the log file
2462) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
247
248Project information
249===================
2501) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2512) Visual Studio 2015/2017 project support for 64 bits
2523) libelf 0.8.13 library 64bits for VS 2015/2017
2534) libdwarf 1.41 library 64bits for VS 2015, cygwin64 and Msys2/MinGW64
2545) QT 5.5.1 library 64bits for VS 2015
f951022b 2556) QT 5.12.0 library 64bits for VS 2017
1081a838
JPM
2567) Zlib 1.2.8 library 64bits for VS 2015
2578) Zlib 1.2.11 library 64bits for VS 2017
2589) SDL 1.2.15 library 64bits for VS 2015/2017
25910) The original make files have been modified to follow the requirements and modifications
26011) The 'Rx' word has been added to the emulator name to make distinction with the official version
26112) The project is set at https://github.com/djipi/Virtual-Jaguar-Rx
26213) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
263-- Text / License terms are the same
adf158c7 26414) The x86 configuration has been removed in the VS 2017 project
1081a838
JPM
265
266
267Download statistics
268-------------------
269jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
270jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
271No downloads statistics available for the Release 2
272No downloads statistics available for the Release 3