]> git.sur5r.net Git - cc65/blob - include/dbg.h
add a comment describing why this file is really included despite an obvious referenc...
[cc65] / include / dbg.h
1 /*****************************************************************************/
2 /*                                                                           */
3 /*                                   dbg.h                                   */
4 /*                                                                           */
5 /*                         Debugger module interface                         */
6 /*                                                                           */
7 /*                                                                           */
8 /*                                                                           */
9 /* (C) 1998-2000 Ullrich von Bassewitz                                       */
10 /*               Wacholderweg 14                                             */
11 /*               D-70597 Stuttgart                                           */
12 /* EMail:        uz@musoftware.de                                            */
13 /*                                                                           */
14 /*                                                                           */
15 /* This software is provided 'as-is', without any expressed or implied       */
16 /* warranty.  In no event will the authors be held liable for any damages    */
17 /* arising from the use of this software.                                    */
18 /*                                                                           */
19 /* Permission is granted to anyone to use this software for any purpose,     */
20 /* including commercial applications, and to alter it and redistribute it    */
21 /* freely, subject to the following restrictions:                            */
22 /*                                                                           */
23 /* 1. The origin of this software must not be misrepresented; you must not   */
24 /*    claim that you wrote the original software. If you use this software   */
25 /*    in a product, an acknowledgment in the product documentation would be  */
26 /*    appreciated but is not required.                                       */
27 /* 2. Altered source versions must be plainly marked as such, and must not   */
28 /*    be misrepresented as being the original software.                      */
29 /* 3. This notice may not be removed or altered from any source              */
30 /*    distribution.                                                          */
31 /*                                                                           */
32 /*****************************************************************************/
33
34
35
36 /*
37  * This is the interface to the cc65 debugger. Since many of the functions
38  * used for the debugger are quite usable even in another context, they
39  * are declared here.
40  *
41  * To use the debugger, just call DbgInit in your application. Once it has
42  * been called, the debugger will catch any BRK opcode. Use the BREAK macro 
43  * defined below to insert breakpoints into your code.
44  *
45  * There are currently a lot of things that cannot be debugged, graphical
46  * applications are an example. The debugger does not save your screen
47  * contents, so even your text screen gets destroyed. However, you can
48  * debug the C and runtime library, even if the debugger is using this
49  * stuff itself.
50  *
51  * Note: When using the debugger, there are some other identifiers with
52  * external linkage, that start with Dbg. Avoid those names if you use the
53  * module.
54  */
55
56
57
58 #ifndef _DBG_H
59 #define _DBG_H
60
61
62
63 /*****************************************************************************/
64 /*                             Utility functions                             */
65 /*****************************************************************************/
66
67
68
69 unsigned __fastcall__ DbgDisAsm (unsigned Addr, char* Buf, unsigned char Len);
70 /* Disassemble one instruction at address addr into the given buffer.
71  * The resulting line has the format, "AAAA__BB_BB_BB___OPC_OPERAND",
72  * where AAAA is the hexadecimal representation of addr, BB are the
73  * bytes (in hex) that make the instruction, OPC is the mnemonic, and
74  * OPERAND is an operand for the instruction.
75  * The buffer is filled with spaces up to the given length and terminated as
76  * a usual C string. NOTE: Buf must be able to hold Len+1 characters.
77  * The function returns the length of the disassembled instruction, so,
78  * to disassemble the next instruction, add the return value to addr
79  * and call the function again.
80  */
81
82 unsigned __fastcall__ DbgDisAsmLen (unsigned Addr);
83 /* Disassemble one instruction, but do only return the length, do not
84  * create a visible representation. This function is useful when
85  * disassembling backwards, it is much faster than DbgDisAsm.
86  */
87
88 int __fastcall__ DbgIsRAM (unsigned Addr);
89 /* Return true if we can read and write the given address */
90
91 char* DbgMemDump (unsigned Addr, char* Buf, unsigned char Len);
92 /* Create a line of a memory dump in the given buffer. The buffer contains
93  * the starting address (4 digits hex), then Len bytes in this format:
94  * "AAAA__XX_YY_ZZ_...". The passed char buffer must hold Len*3+5 bytes
95  * plus a terminator byte.
96  * The function does not work correctly if the created string is longer
97  * than 255 bytes.
98  * The return value is Buf.
99  */
100
101
102
103 /*****************************************************************************/
104 /*                         High level user interface                         */
105 /*****************************************************************************/
106
107
108
109 void __fastcall__ DbgInit (unsigned unused);
110 /* Initialize the debugger. Use 0 as parameter. The debugger will popup on
111  * next brk encountered.
112  */
113
114 #define BREAK()         __asm__ ("brk")
115 /* Use this to insert breakpoints into your code */
116
117
118
119 /* End of dbg.h */
120 #endif
121
122
123
124