c52c65839ec852a0026ae03055056e524e6e519c
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
1 Release 5 (TBA)
2 ---------------
3 0) 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
5 1) Added a specific breakpoint for the M68K illegal instruction exception
6 -- Alert box will display a message and then the code will stop
7 2) Added a specific breakpoint for the M68K address error exception
8 -- Alert box will display a message and then the code will stop
9 3) Added a HW registers browser window and set a tab for the Blitter
10 4) Added detection for the unsigned/signed short type
11 -- Will allow the return of a short type variable's value
12 5) Added a specific breakpoint for the M68K Unimplemented instruction, and Exception not referenced exceptions
13
14 Release 4a (15th August 2019)
15 -----------------------------
16 Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
17 -
18 0) Fix specific breakpoint for ROM cartridge or unknown memory location writing
19
20 Release 4 (10th August 2019)
21 ----------------------------
22 Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
23 -
24 0) The zoom value setting has been fixed in the registry
25 1) Debugger mode now shares the same alpine rom path setting
26 2) Local variables window displays register name now
27 3) Switch to Zlib 1.2.11 static library 64bits for VS 2017
28 4) Switch to SDL 1.2.15 static library 64bits for VS 2017
29 5) Local variables window displays values from function's parameters
30 6) Fixed the typedef's name display in Local and Watch variables window
31 7) 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
34 8) Local variables window detects now if a variable is used or not by the code
35 9) The address provided in the debugger memory windows is now verified to prevent crash
36 -- Wrong address will be displayed in red
37 10) 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
45 11) Added some log information for the emulator initialisations
46 12) Breakpoint will happen in case of writing at unknown memory location
47 -- Alert box will display a message and then the code will stop
48 13) Added the DRAM size in the emulator status window
49 14) Debugger sources code clean-up
50 15) Added a call stack feature
51 16) Follow platform requirement to prevent source file reading issue
52 17) 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
57 18) 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
59 19) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
60 20) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
61 21) Added a Jaguar model and BIOS configuration tab
62 22) Jaguar model and BIOS configuration integration
63 23) Added LEB128 decoding functions
64 -- It is used for the DWARF decoding information
65 24) Debugger support improvement
66 -- DWARF support for the enum type (partial), structure and subroutine type
67 -- Debugger can report variable's unsigned char value
68 25) 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
74 26) Added screenshot feature
75 -- Not accessible in debugger mode
76 -- Added screenshot editable path in the general tab, and a key binding
77 27) Minor misspellings fixes
78 28) DWARF source code directory path clean-up
79 29) Added a source code files list viewer
80 -- List comes from the DWARF information
81 30) 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
83 31) Added a sorting filter in the all watches window
84 32) Improve source code file reading to avoid additional text/bytes reading
85 33) Help & content texts updates
86 34) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
87 35) 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
89 36) Added the Rx version's contact in the help text
90 37) Added search paths in case of missing DWARF directories information
91 -- Used to look for the file(s)
92 38) 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
94 39) Added function name support from ELF structure
95 40) Added the return address information in the call stack
96 41) Added multiple breakpoints feature, and their key bindings, for functions only
97 42) Added timer initialisation for the SDL setup
98 43) Added a cartridge view menu
99 -- Added a window to display my own directory and his files list
100 44) Debugger sources code clean-up
101 45) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
102 46) Fix crash with potential missing DWARF structure tag's type name
103 47) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
104 48) Project has switched to QT 5.12.0 library 64bits for VS 2017
105 49) Added a Save Dump As... feature to save a memory zone to a file
106 50) 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
108 51) Removed the sorting filter in the all watches window
109 52) Fix the support of the DRAM size limit option in the heap allocation window
110 53) Set cartridge view menu for debugger mode only
111 54) Prevent crash in case of call stack is out of range
112
113 Release 3 (13th November 2017)
114 ------------------------------
115 Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
116 -
117 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
118 1) Added an Exception Vector Table window
119 2) Modified the About window to update the credits list in a more appropriate way
120 -- Updated the emulator application credits line
121 3) Added 'Rx' word to the emulator name
122 4) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
123 5) Added ui, alpine and debugger groups in the settings
124 6) Added the possibility to erase settings
125 7) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
126 8) 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)
129 9) Fixed a crash, in Release mode, when the HW labels setting is turn on
130 10) Solved an interference between the HW labels setting and the one used by the debugger
131 -- The setting is now only the reference used
132 11) Fixed the SP (Stack) browser UI potential missing data
133 12) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
134 13) 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
136 14) 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
138 15) Improved the .heap section detection to avoid a detection error
139 -- Depend vlink version, .heap section may have an Alloc flag
140 16) Fixed a crash when DWARF information does references to missing source code files
141 17) Added a local variables window
142 18) Project has switched to Visual Studio 2017 and QT 5.9.1 library
143
144 Release 2 (3rd September 2017)
145 ------------------------------
146 0) Added some error detections when reading the ELF executable file
147 1) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
148 2) "Step Over" code function for BSR/JSR functions
149 3) Added the .debug_ranges detection to avoid a detection error
150 4) DWARF support
151 -- TAG: Compilation Unit, Subprogram, Variables, Types
152 -- Line numbers, symbols, functions
153 5) Added an All Watch window for non-local variables
154 6) Added a heap allocator window based on my own memory allocation functions
155 7) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
156 8) Windows refreshing executed only if windows is visible
157 9) Added a restart function
158 -- Restart only the 68000 program counter to his original set
159 10) Modified the icons color backgound for the "Step In" and "Step Over" functions
160 11) Updated the About window to update the credits list
161 12) 64 bits Release executable
162 13) Fixed (hacking) the display of the SP (Stack) browser
163 14) 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
165 15) Added some information in the --help/-h/-? option
166 16) --debugger option no longer force the log file
167 17) Added a --dram-max option to extend the DRAM size to 8MB
168 18) Added the "enter" key support when setting the BPM (Breapoint)
169 19) Save the windows positions, size and visibilities (show or hide) status
170 -- Such windows will automatically respawn in the next emulator launch
171
172 Release 1 (12th February 2017)
173 ------------------------------
174 0) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
175 1) Clean-up the tracing / no-tracing flags for better U.I understanding
176 2) Added SP (Stack) browser
177 3) User can change now the number of lines of disassembly displayed in the tracing window
178 4) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
179 5) Added an emulator status window (GPU status, M68K debugger and tracking status)
180 6) Added a GPU disassembly tracing window - Display the current PC pointer
181 7) Added a DSP disassembly tracing window - Display the current PC pointer
182 8) Added possibility to change refresh rate of browsers when emulation is launched
183 9) 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
185 10) Minor U.I cosmetic changes
186 11) 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
188
189 Release 0 (5th January 2017)
190 ----------------------------
191 0) New option --debugger
192 1) ELF format support
193 2) ELF debug symbol support
194 3) "Step Into" code function
195 4) Menus layout dedicated to the debugger
196 5) Added a dedicated main window for tracing (M68K)
197 6) Added a Debugger tab in the config tab
198 7) Visual Studio 2015 project support
199 8) libelf-0.8.13 library support
200 9) 64 bits debug executable only
201
202
203 Known issues
204 ============
205 1) 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
206 2) 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
209 3) DWARF 2 support
210 -- With GCC: the code must be compiled with the -gdwarf-2 option
211 4) 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
214 5) The 2MB mirroring is no longer applied in case of --dram-max option usage
215 6) 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
217 7) The Exception Vector Table window displays only 65 vectors
218 -- Missing vectors may be added in future release
219 8) 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
221 9) 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
224 10) 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
225 11) Emulator will crash in case of wrong address value provided in the memory browser
226 12) The RAM access log is limited to the 2MB
227 13) 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
229 14) Source code disply only assembled code from vasm with option -dwarf
230 15) 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
232 16) 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
234 17) Potential legacy crash when leaving emulator in pause mode for a long period of time
235
236 Cosmetic / UX issues
237 ====================
238 1) The SP (Stack) icon color backgound doesn't look similar with the other ones
239 2) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
240 3) Not every features have associated key bindings
241
242 Legacy issues/hints
243 ===================
244 1) 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
247 2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
248
249 Project information
250 ===================
251 1) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
252 2) Visual Studio 2015/2017 project support for 64 bits
253 3) libelf 0.8.13 library 64bits for VS 2015/2017
254 4) libdwarf 1.41 library 64bits for VS 2015, cygwin64 and Msys2/MinGW64
255 5) QT 5.5.1 library 64bits for VS 2015
256 6) QT 5.12.0 library 64bits for VS 2017
257 7) Zlib 1.2.8 library 64bits for VS 2015
258 8) Zlib 1.2.11 library 64bits for VS 2017
259 9) SDL 1.2.15 library 64bits for VS 2015/2017
260 10) The original make files have been modified to follow the requirements and modifications
261 11) The 'Rx' word has been added to the emulator name to make distinction with the official version
262 12) The project is set at https://github.com/djipi/Virtual-Jaguar-Rx
263 13) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
264 -- Text / License terms are the same
265 14) The x86 configuration has been removed in the VS 2017 project
266
267
268 Download statistics
269 -------------------
270 jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
271 jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
272 No downloads statistics available for the Release 2
273 No downloads statistics available for the Release 3