aboutsummaryrefslogtreecommitdiff
path: root/AT91SAM7S256/armdebug/Debugger/debug_macros.h
blob: f66e42c374cfb9691e1fc3af5998239eab41afc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
/** @file debug_macros.h
 *  @brief internal macros used by debug_stub routines
 *
 */

/* Copyright (C) 2007-2010 the NxOS developers
 *
 * Module Developed by: TC Wan <tcwan@cs.usm.my>
 *
 * See AUTHORS for a full list of the developers.
 *
 * See COPYING for redistribution license
 *
 */

#ifndef __DEBUG_MACROS_H__
#define __DEBUG_MACROS_H__



/** @addtogroup debug_macros */
/*@{*/

/* _dbg_jumpTableHandler
 *      Call Jump Table Routine based on Index
 *	On entry:
 *	  jumptableaddr is the address (constant) of the Jump Table
 *	  jumpreg is the register used to perform the indirect jump
 *	  indexreg contains jump table index value
 */
	.macro  _dbg_jumpTableHandler   jumptableaddr, jumpreg, indexreg

	ldr	 \jumpreg, =\jumptableaddr
	ldr	 \jumpreg, [\jumpreg, \indexreg, lsl #2]
	mov	 lr, pc
	bx	  \jumpreg	/* Call Command Handler Routine */
	.endm


/* _dbg_thumbDecodeEntry
 *      Load Thumb Instruction Decoder Entry
 *      On entry:
 *        instrreg is the register to load the instruction into
 *        instrmask is the register to load the instruction mask into
 *        codehandler is the register to load the code handling routine into
 *        indexreg contains decode table index value
 *      NOTE: instrreg, instrmask, codehandler must be in increasing register number order
 */
        .macro  _dbg_thumbDecodeEntry   instrreg, instrmask, codehandler, indexreg

        ldr      \instrmask, =debug_thumbDecodeTable                    /* Temporary register */
        add      \instrmask, \instrmask, \indexreg, lsl #3
        ldm      \instrmask, {\instrreg, \codehandler}                  /* LSHW: IID, MSHW: IBM */
        mov      \instrmask, \instrreg, lsr #16
        and      \instrreg, \instrreg, #HLFWRD0
        .endm

/* _dbg_armDecodeEntry
 *      Load ARM Instruction Decoder Entry
 *      On entry:
 *        instrreg is the register to load the instruction into
 *        instrmask is the register to load the instruction mask into
 *        codehandler is the register to load the code handling routine into
 *        indexreg contains decode table index value
 *      NOTE: instrreg, instrmask, codehandler must be in increasing register number order
 */
        .macro  _dbg_armDecodeEntry   instrreg, instrmask, codehandler, indexreg

        ldr      \instrmask, =debug_thumbDecodeTable                    /* Temporary register */
        add      \instrmask, \instrmask, \indexreg, lsl #3
        add      \instrmask, \instrmask, \indexreg, lsl #2              /* 12  byte entries */
        ldm      \instrmask, {\instrreg, \instrmask, \codehandler}
        .endm



/* _dbg_stpcpy
 *	_dbg_stpcpy macro
 *	On entry:
 *	  deststrptr: Destination string [Cannot be R0]
 *	  sourcestrptr: Source string [Cannot be R0]
 *	On exit:
 *	  deststrptr: Pointer to NULL character in destination string
 *	  R0: destroyed
 */
	.macro  _dbg_stpcpy	 deststrptr, sourcestrptr
1:	ldrb	r0, [\sourcestrptr], #1
	strb	r0, [\deststrptr], #1
	teq	 r0, #0
	bne	 1b
	sub	 \deststrptr, \deststrptr, #1	/* Adjust Destination string pointer to point at NULL character */
	.endm

/* _dbg_memcpy
 *      _dbg_stpcpy macro
 *      On entry:
 *        deststrptr: Destination string [Cannot be R0]
 *        sourcestrptr: Source string [Cannot be R0]
 *        sizereg: Number of bytes to copy [Cannot be R0]
 *      On exit:
 *        deststrptr: Pointer to NULL character in destination string
 *        R0: destroyed
 */
        .macro  _dbg_memcpy      deststrptr, sourcestrptr, sizereg
1:      ldrb    r0, [\sourcestrptr], #1
        strb    r0, [\deststrptr], #1
        subs    \sizereg, \sizereg, #1
        bne      1b
        .endm

/* _dbg_outputMsgValidResponse
 *	Return Message with valid response ('+$')
 *	On exit:
 *	  R0: destroyed
 *	  R1: points to NULL character after the prefix
 *	  R2: destroyed
 */
	.macro  _dbg_outputMsgValidResponse
	ldr	 r1, =debug_OutMsgBuf
	ldr	 r2, =debug_ValidResponsePrefix
	_dbg_stpcpy	 r1, r2
	.endm


/* _dbg_outputMsgStatusOk
 *	Return Message with Ok ('+OK') status
 *	On exit:
 *	  R0: destroyed
 *	  R1: destroyed
 *	  R2: destroyed
 */
	.macro  _dbg_outputMsgStatusOk
	ldr	 r1, =debug_OutMsgBuf
	ldr	 r2, =debug_OkResponse
	_dbg_stpcpy	 r1, r2
	.endm

/* _dbg_outputMsgStatusErr
 *	Return Message with Error ('-ENN') status
 *	On entry:
 *	  R0: register containing error value (byte)
 *	On exit:
 *	  R0: destroyed
 *	  R1: destroyed
 *	  R2: destroyed
 *	  R3: destroyed
 */
	.macro  _dbg_outputMsgStatusErr
	mov	 r3, r0
	ldr	 r1, =debug_OutMsgBuf
	ldr	 r2, =debug_ErrorResponsePrefix
	_dbg_stpcpy	 r1, r2
	mov	 r0, r3
	bl	  byte2ascii	  /* R1 points to NULL character after the prefix */
	.endm

/* _dbg_outputMsgStatusSig
 *	Return Message with Signal ('+SNN') status
 *	On entry:
 *	  R0: register containing error value (byte)
 *	On exit:
 *	  R0: destroyed
 *	  R1: destroyed
 *	  R2: destroyed
 *	  R3: destroyed
 */
	.macro  _dbg_outputMsgStatusSig
	mov	 r3, r0
	ldr	 r1, =debug_OutMsgBuf
	ldr	 r2, =debug_SignalResponsePrefix
	_dbg_stpcpy	 r1, r2
	mov	 r0, r3
	bl	  byte2ascii	  /* R1 points to NULL character after the prefix */
	.endm

/* _getdbgregisterfromindex
 *      Retrieve register contents from debugger stack given index
 *
 *      On entry:
 *        indexreg contains debugger stack index value (0-max entries)
 *      On exit:
 *        indexreg: Breakpoint index (preserved)
 *        contentsreg: Register Contents for given index
 */
        .macro  _getdbgregisterfromindex  indexreg, contentsreg
        ldr      \contentsreg, =__debugger_stack_bottom__
        ldr      \contentsreg, [\contentsreg, \indexreg, lsl #2]
        .endm


/* _index2bkptindex_addr
 *	Convert Breakpoint index to breakpoing entry address
 *
 *	On entry:
 *	  indexreg contains breakpoint index value
 *	On exit:
 *	  indexreg: Breakpoint index (preserved)
 *	  addrreg: Breakpoint Entry Address
 */
	.macro _index2bkptindex_addr indexreg, addrreg
	ldr	 \addrreg, =__breakpoints_start__
	add	 \addrreg, \addrreg, \indexreg, lsl #3	   /* Calculate Breakpoint Entry Address */
	.endm

/* _dbg_getstate
 *	Get Debugger State
 *	On exit:
 *	  reg: Debugger State enum
 */
	.macro _dbg_getstate	reg
	ldr	 \reg, =debug_state
	ldr	 \reg, [\reg]
	.endm

/* _dbg_setstate
 *	Set Debugger State to given value
 *	On exit:
 *	  r0, r1: destroyed
 */
	.macro _dbg_setstate	state
	ldr	 r0, =\state
	ldr	 r1, =debug_state
	str	 r0, [r1]
	.endm

/* _dbg_getcurrbkpt_index
 *	Get current breakpoint index
 *	On exit:
 *	  reg: Breakpoint index
 */
	.macro _dbg_getcurrbkpt_index   reg
	ldr	 \reg, =debug_curr_breakpoint
	ldr	 \reg, [\reg]
	.endm

/* _dbg_setcurrbkpt_index
 *	Set current breakpoint index
 *	On exit:
 *	  r1: destroyed
 */
	.macro _dbg_setcurrbkpt_index  reg
	ldr	 r1, =debug_curr_breakpoint
	str	 \reg, [r1]
	.endm

/* _dbg_getabortedinstr_addr
 *	Get aborted instruction address
 *	On exit:
 *	  reg: aborted instruction address
 */
        .macro _dbg_getabortedinstr_addr  reg
	ldr	 \reg, =__debugger_stack_bottom__
	ldr	 \reg, [\reg]
	.endm

/* _dbg_setabortedinstr_addr
 *	Set aborted instruction address
 *	On exit:
 *	  r1: destroyed
 */
        .macro _dbg_setabortedinstr_addr  reg
        ldr   r1, =__debugger_stack_bottom__
        str   \reg, [r1]
        .endm


 /*@}*/

#endif /* __DEBUG_MACROS_H__ */