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