- Emerald Hunter
-
- Posts: 831
- Joined: 11-October 10
- Gender:Male
- Location:Brasil
- Project:Sonic Classic Heroes; Sonic 2 Special Stage Editor; Sonic 3&K Heroes (on hold)
- Wiki edits:12
31
Edit: I made a new version fixing a bug and adding a binary-blob version. See this post for more information. The original post now follows:
I was going to make this an update to the old topic... but decided it would be best suited to a new topic entirely.
So, you remember that aging debugger I made for address/bus errors? I updated. A few things that changed:
There is another warning I must give: I won't give support for anything but the Community disassemblies, so if you insist on using outdated disassemblies, you are on your own.
With those out of the way: first, let me explain how you will go about generating a listing file. In the previous version, I talked about map files; listing files are much better because they are generated much faster; the S2 and S&K disassemblies disable it by default, though. In S2, you have to edit 3 places: one in s2.macrosetup.asm and the rest in s2.asm; so:
in s2.macrosetup.asm: find this:
and change it to this:
You can also use "on" or "noskipped" instead of "purecode", but I recommend using the latter. So now over to s2.asm, do the same twice. Now whenever you build your hack, a s2.lst file will also be generated.
For S&K, you have to do the same once in sonic3k.macrosetup.asm, then in sonic3k.asm find this:
and change it to this:
Now that you are armed with listing files, time to hook up the new debugger! So go on ahead and grab it here. There are seven files in this archive; only 6 are needed for S2, the seventh is for compatibility with the S&K disassembly. Extract these to your hack's main folder. You can move these around, as long as you edit the includes in the relevant files. You want to add these includes:
For S2:
For S&K:
These are enough to get everything working; he other files are pulled in automatically. Now the debugger is being assembled inside your hack; you want to setup the interrupt vector table to make use of it:
In S2: find ";Vectors:" and replace the whole table with this:
In S&K: find "Vectors:" and replace the whole table with this:
If you try to assemble and you get errors, it is because you are using an older version of AS; get the new version and replace the ones you have. The Git repositories for the Community disassemblies already have this version, by the way.
Now you just need to trigger an error to see it in action; but if you do that, you will notice that your name and e-mail are wrong; so open "Debugger.asm" and find the following lines:
Except that the e-mail will not be in yellow and underlined, that is just the forum software being an ass. Anyway, supported colors are WHITE, RED, GREEN and BLUE; you can edit the text at will, but your name should not exceed 11 characters -- this is all the space available in the current setup. As the comment near this says, you can use any of the characters int he ASCII set.
Another thing to do is edit the value of the "Revision" constant in the same file -- this number can be used to uniquely identify the version in which the error happened, so you will know if you already fixed the error or not.
When all is said and done, this is what you will see (using two manufactured examples):
As a bonus: since the code is logically separate, the disassembler can be used on its own; here is an example of a minimal disassembler that can be build using it:
This was done with this code:
I was going to make this an update to the old topic... but decided it would be best suited to a new topic entirely.
So, you remember that aging debugger I made for address/bus errors? I updated. A few things that changed:
- The disassembler is now logically separate from the drawing code and from the debugger (the debugger depends on both of them, the disassembler depends on the drawing code);
- I made sure that the code almost fully position-independent, meaning a binary blob can possibly be made (but see below);
- loads of bug fixes;
- recovers more information from branches and jumps, and does so correctly now for dbCC opcodes;
- brand new font;
- handles far more errors than just the address and bus errors (the latter of which I have since learned never happens on a real Genesis...);
- has code that will make macro haters want to stay away.
There is another warning I must give: I won't give support for anything but the Community disassemblies, so if you insist on using outdated disassemblies, you are on your own.
With those out of the way: first, let me explain how you will go about generating a listing file. In the previous version, I talked about map files; listing files are much better because they are generated much faster; the S2 and S&K disassemblies disable it by default, though. In S2, you have to edit 3 places: one in s2.macrosetup.asm and the rest in s2.asm; so:
in s2.macrosetup.asm: find this:
listing off
and change it to this:
listing purecode
You can also use "on" or "noskipped" instead of "purecode", but I recommend using the latter. So now over to s2.asm, do the same twice. Now whenever you build your hack, a s2.lst file will also be generated.
For S&K, you have to do the same once in sonic3k.macrosetup.asm, then in sonic3k.asm find this:
Z80_Snd_Driver: include "Sound/Z80 Sound Driver.asm"
and change it to this:
Z80_Snd_Driver: include "Sound/Z80 Sound Driver.asm" listing purecode
Now that you are armed with listing files, time to hook up the new debugger! So go on ahead and grab it here. There are seven files in this archive; only 6 are needed for S2, the seventh is for compatibility with the S&K disassembly. Extract these to your hack's main folder. You can move these around, as long as you edit the includes in the relevant files. You want to add these includes:
For S2:
include "_inc/Debugger.asm"
For S&K:
include "skcompat.asm" include "Debugger.asm"
These are enough to get everything working; he other files are pulled in automatically. Now the debugger is being assembled inside your hack; you want to setup the interrupt vector table to make use of it:
In S2: find ";Vectors:" and replace the whole table with this:
;Vectors: dc.l System_Stack , EntryPoint , BusError , AddressError ; 4 dc.l IllegalInstrError , ZeroDivideError, CHKExceptionError, TRAPVError ; 8 dc.l PrivilegeViolation, TraceError , LineAEmulation , LineFEmulation ; 12 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 16 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 20 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 24 dc.l SpuriousException , ErrorTrap , ErrorTrap , ErrorTrap ; 28 dc.l H_Int , ErrorTrap , V_Int , ErrorTrap ; 32 dc.l TrapVector , TrapVector , TrapVector , TrapVector ; 36 dc.l TrapVector , TrapVector , TrapVector , TrapVector ; 40 dc.l TrapVector , TrapVector , TrapVector , TrapVector ; 44 dc.l TrapVector , TrapVector , TrapVector , TrapVector ; 48 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 52 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 56 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 60 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 64
In S&K: find "Vectors:" and replace the whole table with this:
Vectors: dc.l Vectors , EntryPoint , BusError , AddressError ; 4 dc.l IllegalInstrError , ZeroDivideError, CHKExceptionError, TRAPVError ; 8 dc.l PrivilegeViolation, TraceError , LineAEmulation , LineFEmulation ; 12 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 16 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 20 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 24 dc.l SpuriousException , ErrorTrap , ErrorTrap , ErrorTrap ; 28 dc.l H_int_jump , ErrorTrap , V_int_jump , ErrorTrap ; 32 dc.l TrapVector , TrapVector , TrapVector , TrapVector ; 36 dc.l TrapVector , TrapVector , TrapVector , TrapVector ; 40 dc.l TrapVector , TrapVector , TrapVector , TrapVector ; 44 dc.l TrapVector , TrapVector , TrapVector , TrapVector ; 48 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 52 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 56 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 60 dc.l ErrorTrap , ErrorTrap , ErrorTrap , ErrorTrap ; 64
If you try to assemble and you get errors, it is because you are using an older version of AS; get the new version and replace the ones you have. The Git repositories for the Community disassemblies already have this version, by the way.
Now you just need to trigger an error to see it in action; but if you do that, you will notice that your name and e-mail are wrong; so open "Debugger.asm" and find the following lines:
HackerName: vtstring WHITE,"Your name" EMailmsg: vtstring BLUE ,"[email protected]"
Except that the e-mail will not be in yellow and underlined, that is just the forum software being an ass. Anyway, supported colors are WHITE, RED, GREEN and BLUE; you can edit the text at will, but your name should not exceed 11 characters -- this is all the space available in the current setup. As the comment near this says, you can use any of the characters int he ASCII set.
Another thing to do is edit the value of the "Revision" constant in the same file -- this number can be used to uniquely identify the version in which the error happened, so you will know if you already fixed the error or not.
When all is said and done, this is what you will see (using two manufactured examples):
As a bonus: since the code is logically separate, the disassembler can be used on its own; here is an example of a minimal disassembler that can be build using it:
This was done with this code:
DisassemblyTest: bsr.w InitTerminal lea DrawTerminal(pc),a3 tellp.l -(sp) ; Save end of buffer setcursor DisassemblyAlign,0 .instr_loop: shared .instr_loop move.l (sp),d0 ; Get end of screen buffer vtchkp.l d0 ; Is this after current position? blo.w .draw_terminal ; Branch if not tellp.l -(sp) ; Save start of line move.w (a3)+,d5 ; Read instruction lea RewindStub(pc),a4 ; Pointer to rts bsr.w Disassemble_Opcode movea.l a2,a3 ; PC for next instruction tellp.l d0 ; Save current position on buffer seekset (sp)+ ; Seek back to old position .next_line: seekp.l nCols ; Advance it by one line vtchkp.l d0 ; Is this after current position on buffer? bhs.s .next_line ; Branch if not bra.s .instr_loop ;--------------------------------------------------------------------------------------- .draw_terminal: addq.w #4,sp ; Pop end of screen buffer from stack bsr.w DrawTerminal .error_trap: nop nop bra.s .error_trap ; ===========================================================================
This post has been edited by flamewing: 12 August 2014 - 11:38 AM
