Added credit in source codes
[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 6) Fix potential emulator freeze after an exception has occured
14 7) Fix a random crash when reading the source lines information
15 8) Added ELF & DWARF .debug* types
16 9) Added ELF section types check and new error messages
17 10) Modified the call stack layout window and added source filename from the called source line
18 11) Added a source tab in the main window for step into tracing
19 12) Added the step over for source level tracing
20 13) Set text conversion to Qt/HTML format for the M68K tracing window
21 14) Added a source code file date check when reading DWARF information
22 -- Will avoid source code mismatching with the ELF executable
23 15) Remove Visual Studio 2015 support
24 16) Work around fix for a compilation error on Linux
25 -- EEPROM directory creation allowed only for Windows at the moment
26 17) Project has switched to libdwarf 20201201 library 64bits for VS 2017
27 18) Show the SR value as a readable form in the CPU browser
28 19) Potential fix to compile on Linux
29 -- Added the relative directory path for the Qt include files
30 20) Merge the Linux build fixes from @richard42
31 -- Jaguar core's makefile and Qt pro file updates, fix filenames case sensitive & fixes for Linux
33 Release 4a (15th August 2019)
34 -----------------------------
35 Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
36 -
37 0) Fix specific breakpoint for ROM cartridge or unknown memory location writing
39 Release 4 (10th August 2019)
40 ----------------------------
41 Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
42 -
43 0) The zoom value setting has been fixed in the registry
44 1) Debugger mode now shares the same alpine rom path setting
45 2) Local variables window displays register name now
46 3) Switch to Zlib 1.2.11 static library 64bits for VS 2017
47 4) Switch to SDL 1.2.15 static library 64bits for VS 2017
48 5) Local variables window displays values from function's parameters
49 6) Fixed the typedef's name display in Local and Watch variables window
50 7) Breakpoint may now occur in case of a ROM cartridge writing
51 -- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
52 -- 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
53 8) Local variables window detects now if a variable is used or not by the code
54 9) The address provided in the debugger memory windows is now verified to prevent crash
55 -- Wrong address will be displayed in red
56 10) UI changes
57 -- Added new icons for the exit and status features
58 -- Modified icons for the SP (Stack) browser
59 -- Unified icons sizes depend on their usage (drop down menu and main menu)
60 -- Underline the active M68K line in the disassembly window
61 -- Allow the up/down navigation on the SP (Stack) browser
62 -- Restart function cleans-up the SP (Stack) browser and the heap allocator system
63 -- Fixed the up navigation on the memory window
64 11) Added some log information for the emulator initialisations
65 12) Breakpoint will happen in case of writing at unknown memory location
66 -- Alert box will display a message and then the code will stop
67 13) Added the DRAM size in the emulator status window
68 14) Debugger sources code clean-up
69 15) Added a call stack feature
70 16) Follow platform requirement to prevent source file reading issue
71 17) UI modifications
72 -- Modified icon for the memory window to make a distinction with the memory browser
73 -- The all watch, and Exception Vector Table windows, can be closed using keyboard
74 -- Renamed the debugger dedicated icons to make a distinction
75 -- Added the call stack window
76 18) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
77 -- Previously used ELF/DWARF information was still accessible
78 19) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
79 20) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
80 21) Added a Jaguar model and BIOS configuration tab
81 22) Jaguar model and BIOS configuration integration
82 23) Added LEB128 decoding functions
83 -- It is used for the DWARF decoding information
84 24) Debugger support improvement
85 -- DWARF support for the enum type (partial), structure and subroutine type
86 -- Debugger can report variable's unsigned char value
87 25) UI modifications
88 -- Added a status bar, better status report & information display for the heap allocation window
89 -- Added a status bar, better status report & information display for the local variables window
90 -- Added better information display for the exception vectors table window, and added some missing vectors
91 -- Added a status bar, better status report & information display for the call stack window
92 -- Added a status bar, better status report & information display for the all watches window
93 26) Added screenshot feature
94 -- Not accessible in debugger mode
95 -- Added screenshot editable path in the general tab, and a key binding
96 27) Minor misspellings fixes
97 28) DWARF source code directory path clean-up
98 29) Added a source code files list viewer
99 -- List comes from the DWARF information
100 30) Check potential variables missing/incomplete description found in the DWARF information
101 -- No crash involved but can help to reduce such as variables duplicate or the blank ones
102 31) Added a sorting filter in the all watches window
103 32) Improve source code file reading to avoid additional text/bytes reading
104 33) Help & content texts updates
105 34) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
106 35) Added the support for the used lines source's DWARF structure
107 -- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
108 36) Added the Rx version's contact in the help text
109 37) Added search paths in case of missing DWARF directories information
110 -- Used to look for the file(s)
111 38) Setup CU's low/high PC in case of the DWARF structures doesn't have it
112 -- Used mostly to allow display the source assembled with vasm
113 39) Added function name support from ELF structure
114 40) Added the return address information in the call stack
115 41) Added multiple breakpoints feature, and their key bindings, for functions only
116 42) Added timer initialisation for the SDL setup
117 43) Added a cartridge view menu
118 -- Added a window to display my own directory and his files list
119 44) Debugger sources code clean-up
120 45) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
121 46) Fix crash with potential missing DWARF structure tag's type name
122 47) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
123 48) Project has switched to Qt 5.12.0 library 64bits for VS 2017
124 49) Added a Save Dump As... feature to save a memory zone to a file
125 50) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
126 -- -d has been renamed by -D because another -d was also used for the dsp command line option
127 51) Removed the sorting filter in the all watches window
128 52) Fix the support of the DRAM size limit option in the heap allocation window
129 53) Set cartridge view menu for debugger mode only
130 54) Prevent crash in case of call stack is out of range
132 Release 3 (13th November 2017)
133 ------------------------------
134 Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
135 -
136 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
137 1) Added an Exception Vector Table window
138 2) Modified the About window to update the credits list in a more appropriate way
139 -- Updated the emulator application credits line
140 3) Added 'Rx' word to the emulator name
141 4) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
142 5) Added ui, alpine and debugger groups in the settings
143 6) Added the possibility to erase settings
144 7) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
145 8) Added a key bindings tab and adapted the configuration dialog tabs
146 -- User can modify the key bindings where appropriate
147 -- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
148 9) Fixed a crash, in Release mode, when the HW labels setting is turn on
149 10) Solved an interference between the HW labels setting and the one used by the debugger
150 -- The setting is now only the reference used
151 11) Fixed the SP (Stack) browser UI potential missing data
152 12) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
153 13) Keep the scrollbar position in accordance of the M68K PC pointer
154 -- UI displays the source without the need to move down/up the scrollbar
155 14) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
156 -- This may come from the linker vlink
157 15) Improved the .heap section detection to avoid a detection error
158 -- Depend vlink version, .heap section may have an Alloc flag
159 16) Fixed a crash when DWARF information does references to missing source code files
160 17) Added a local variables window
161 18) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
163 Release 2 (3rd September 2017)
164 ------------------------------
165 0) Added some error detections when reading the ELF executable file
166 1) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
167 2) "Step Over" code function for BSR/JSR functions
168 3) Added the .debug_ranges detection to avoid a detection error
169 4) DWARF support
170 -- TAG: Compilation Unit, Subprogram, Variables, Types
171 -- Line numbers, symbols, functions
172 5) Added an All Watch window for non-local variables
173 6) Added a heap allocator window based on my own memory allocation functions
174 7) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
175 8) Windows refreshing executed only if windows is visible
176 9) Added a restart function
177 -- Restart only the 68000 program counter to his original set
178 10) Modified the icons color backgound for the "Step In" and "Step Over" functions
179 11) Updated the About window to update the credits list
180 12) 64 bits Release executable
181 13) Fixed (hacking) the display of the SP (Stack) browser
182 14) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
183 -- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
184 15) Added some information in the --help/-h/-? option
185 16) --debugger option no longer force the log file
186 17) Added a --dram-max option to extend the DRAM size to 8MB
187 18) Added the "enter" key support when setting the BPM (Breapoint)
188 19) Save the windows positions, size and visibilities (show or hide) status
189 -- Such windows will automatically respawn in the next emulator launch
191 Release 1 (12th February 2017)
192 ------------------------------
193 0) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
194 1) Clean-up the tracing / no-tracing flags for better U.I understanding
195 2) Added SP (Stack) browser
196 3) User can change now the number of lines of disassembly displayed in the tracing window
197 4) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
198 5) Added an emulator status window (GPU status, M68K debugger and tracking status)
199 6) Added a GPU disassembly tracing window - Display the current PC pointer
200 7) Added a DSP disassembly tracing window - Display the current PC pointer
201 8) Added possibility to change refresh rate of browsers when emulation is launched
202 9) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
203 -- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
204 10) Minor U.I cosmetic changes
205 11) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
206 -- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
208 Release 0 (5th January 2017)
209 ----------------------------
210 0) New option --debugger
211 1) ELF format support
212 2) ELF debug symbol support
213 3) "Step Into" code function
214 4) Menus layout dedicated to the debugger
215 5) Added a dedicated main window for tracing (M68K)
216 6) Added a Debugger tab in the config tab
217 7) Visual Studio 2015 project support
218 8) libelf-0.8.13 library support
219 9) 64 bits debug executable only
222 Known issues
223 ============
224 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
225 2) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
226 -- Need to trace over the BPM or unset the BPM
227 -- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
228 3) DWARF 2 support
229 -- With GCC: the code must be compiled with the -gdwarf-2 option
230 4) The Local and Watch variables window may display not available type information or empty information
231 -- Such missing information may be included in future release
232 -- The 'const' type may not be reported correctly in the DWARF information
233 5) The 2MB mirroring is no longer applied in case of --dram-max option usage
234 6) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
235 -- The application needs to set the SP (Stack) in accordance
236 7) The Exception Vector Table window displays only 65 vectors
237 -- Missing vectors may be added in future release
238 8) User needs to manualy check if the Atari Jaguar executable match his source code files
239 -- Otherwise, source code and assembly may not match or leads to instabilities
240 9) The emulator needs to be restarted in case of the following actions occur
241 -- Key bindings changes
242 -- BIOS selection changes and without new executable load
243 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
244 11) Emulator will crash in case of wrong address value provided in the memory browser
245 12) The RAM access log is limited to the 2MB
246 13) In various occasions, global variables may be duplicated or without name in the DWARF information
247 -- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
248 14) Source code disply only assembled code from vasm with option -dwarf
249 15) After a new breakpoint set, the breakpoint list window is not refreshed
250 -- User must perform an operation, such code tracing, to see the breakpoints list update
251 16) Some ASCII characters may be not displayed correctly
252 -- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
253 17) Potential legacy crash when leaving emulator in pause mode for a long period of time
254 -- Need much investigation
256 Cosmetic / UX issues
257 ====================
258 1) The SP (Stack) icon color backgound doesn't look similar with the other ones
259 2) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
260 3) Not every features have associated key bindings
262 Legacy issues/hints
263 ===================
264 1) Emulator seems to have easter egg(s)
265 -- The option --yarrr displays a single message and end the application
266 -- Pressing F8, while in the main window, will create an extra message in the log file
267 2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
269 Project information
270 ===================
271 1) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
272 2) Visual Studio 2017 project support for 64 bits
273 3) libelf 0.8.13 library 64bits for VS 2017
274 4) libdwarf 20201201 library 64bits for VS 2017
275 5) Qt 5.12.0 library 64bits for VS 2017
276 6) Zlib 1.2.11 library 64bits for VS 2017
277 7) SDL 1.2.15 library 64bits for VS 2017
278 8) The original make files have been modified to follow the requirements and modifications
279 9) The 'Rx' word has been added to the emulator name to make distinction with the official version
280 10) The project is set at
281 11) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
282 -- Text / License terms are the same
283 14) The x86 configuration has been removed in the VS 2017 project
286 Download statistics
287 -------------------
288 jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
289 jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
290 No downloads statistics available for the Release 2
291 No downloads statistics available for the Release 3