Merge remote branch 'origin/master'
[fw/altos] / src / ao_dbg.c
1 /*
2  * Copyright © 2009 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 #include "ao.h"
19 #include "ao_pins.h"
20
21 static void
22 ao_dbg_send_bits(uint8_t msk, uint8_t val) __reentrant
23 {
24         DBG_PORT = (DBG_PORT & ~msk) | (val & msk);
25         _asm
26                 nop
27                 nop
28         _endasm;
29 }
30
31 void
32 ao_dbg_send_byte(uint8_t byte)
33 {
34         __xdata uint8_t b, d;
35
36         DBG_PORT |= DBG_DATA;
37         DBG_PORT_DIR |= DBG_DATA;
38         for (b = 0; b < 8; b++) {
39                 d = 0;
40                 if (byte & 0x80)
41                         d = DBG_DATA;
42                 byte <<= 1;
43                 ao_dbg_send_bits(DBG_CLOCK|DBG_DATA, DBG_CLOCK|d);
44                 ao_dbg_send_bits(DBG_CLOCK|DBG_DATA,     0    |d);
45         }
46         DBG_PORT_DIR &= ~DBG_DATA;
47 }
48
49 uint8_t
50 ao_dbg_recv_byte(void)
51 {
52         __xdata uint8_t byte, b;
53
54         byte = 0;
55         for (b = 0; b < 8; b++) {
56                 byte = byte << 1;
57                 ao_dbg_send_bits(DBG_CLOCK, DBG_CLOCK);
58                 if (DBG_DATA_PIN)
59                         byte |= 1;
60                 ao_dbg_send_bits(DBG_CLOCK, 0);
61         }
62         return byte;
63 }
64
65 /* 8051 instructions
66  */
67 #define NOP                     0x00
68 #define MOV_direct_data         0x75
69 #define LJMP                    0x02
70 #define MOV_Rn_data(n)          (0x78 | (n))
71 #define DJNZ_Rn_rel(n)          (0xd8 | (n))
72 #define MOV_A_direct            0xe5
73 #define MOV_direct1_direct2     0x85
74 #define MOV_direct_A            0xf5
75 #define MOV_DPTR_data16         0x90
76 #define MOV_A_data              0x74
77 #define MOVX_atDPTR_A           0xf0
78 #define MOVX_A_atDPTR           0xe0
79 #define INC_DPTR                0xa3
80 #define TRAP                    0xa5
81 #define SJMP                    0x80
82 #define JB                      0x20
83
84 #define DEBUG_INSTR(l)          (0x54 | (l))
85
86 #define SFR_PSW                 0xD0
87 #define SFR_DPL0                0x82
88 #define SFR_DPH0                0x83
89 #define SFR_DPL1                0x84
90 #define SFR_DPH1                0x85
91
92 __xdata uint8_t save_acc;
93 __xdata uint8_t save_psw;
94 __xdata uint8_t save_dpl0;
95 __xdata uint8_t save_dph0;
96 __xdata uint8_t save_dpl1;
97 __xdata uint8_t save_dph1;
98
99 static uint8_t
100 ao_dbg_inst1(uint8_t a) __reentrant
101 {
102         ao_dbg_send_byte(DEBUG_INSTR(1));
103         ao_dbg_send_byte(a);
104         return ao_dbg_recv_byte();
105 }
106
107 static uint8_t
108 ao_dbg_inst2(uint8_t a, uint8_t b) __reentrant
109 {
110         ao_dbg_send_byte(DEBUG_INSTR(2));
111         ao_dbg_send_byte(a);
112         ao_dbg_send_byte(b);
113         return ao_dbg_recv_byte();
114 }
115
116 static uint8_t
117 ao_dbg_inst3(uint8_t a, uint8_t b, uint8_t c) __reentrant
118 {
119         ao_dbg_send_byte(DEBUG_INSTR(3));
120         ao_dbg_send_byte(a);
121         ao_dbg_send_byte(b);
122         ao_dbg_send_byte(c);
123         return ao_dbg_recv_byte();
124 }
125
126 void
127 ao_dbg_start_transfer(uint16_t addr)
128 {
129         save_acc  = ao_dbg_inst1(NOP);
130         save_psw  = ao_dbg_inst2(MOV_A_direct, SFR_PSW);
131         save_dpl0 = ao_dbg_inst2(MOV_A_direct, SFR_DPL0);
132         save_dph0 = ao_dbg_inst2(MOV_A_direct, SFR_DPH0);
133         save_dpl1 = ao_dbg_inst2(MOV_A_direct, SFR_DPL1);
134         save_dph1 = ao_dbg_inst2(MOV_A_direct, SFR_DPH1);
135         ao_dbg_inst3(MOV_DPTR_data16, addr >> 8, addr);
136 }
137
138 void
139 ao_dbg_end_transfer(void)
140 {
141         ao_dbg_inst3(MOV_direct_data, SFR_DPL0, save_dpl0);
142         ao_dbg_inst3(MOV_direct_data, SFR_DPH0, save_dph0);
143         ao_dbg_inst3(MOV_direct_data, SFR_DPL1, save_dpl1);
144         ao_dbg_inst3(MOV_direct_data, SFR_DPH1, save_dph1);
145         ao_dbg_inst3(MOV_direct_data, SFR_PSW, save_psw);
146         ao_dbg_inst2(MOV_A_data, save_acc);
147 }
148
149 void
150 ao_dbg_write_byte(uint8_t byte)
151 {
152         ao_dbg_inst2(MOV_A_data, byte);
153         ao_dbg_inst1(MOVX_atDPTR_A);
154         ao_dbg_inst1(INC_DPTR);
155 }
156
157 uint8_t
158 ao_dbg_read_byte(void)
159 {
160         ao_dbg_inst1(MOVX_A_atDPTR);
161         return ao_dbg_inst1(INC_DPTR);
162 }
163
164 static void
165 ao_dbg_set_pins(void)
166 {
167         /* make DBG_DATA tri-state */
168         DBG_PORT_INP |= DBG_DATA;
169
170         /* Raise RESET_N and CLOCK */
171         DBG_PORT |= DBG_RESET_N | DBG_CLOCK;
172
173         /* RESET_N and CLOCK are outputs now */
174         DBG_PORT_DIR |= DBG_RESET_N | DBG_CLOCK;
175         DBG_PORT_DIR &= ~DBG_DATA;
176 }
177
178 static void
179 ao_dbg_long_delay(void)
180 {
181         uint8_t n;
182
183         for (n = 0; n < 20; n++)
184                 _asm nop _endasm;
185 }
186
187 void
188 ao_dbg_debug_mode(void)
189 {
190         ao_dbg_set_pins();
191         ao_dbg_long_delay();
192         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|DBG_RESET_N);
193         ao_dbg_long_delay();
194         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N,     0    |DBG_DATA|    0    );
195         ao_dbg_long_delay();
196         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|    0    );
197         ao_dbg_long_delay();
198         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N,     0    |DBG_DATA|    0    );
199         ao_dbg_long_delay();
200         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|    0    );
201         ao_dbg_long_delay();
202         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N,     0    |DBG_DATA|DBG_RESET_N);
203         ao_dbg_long_delay();
204 }
205
206 void
207 ao_dbg_reset(void)
208 {
209         ao_dbg_set_pins();
210         ao_dbg_long_delay();
211         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|DBG_RESET_N);
212         ao_dbg_long_delay();
213         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|    0    );
214         ao_dbg_long_delay();
215         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|    0    );
216         ao_dbg_long_delay();
217         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|    0    );
218         ao_dbg_long_delay();
219         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|    0    );
220         ao_dbg_long_delay();
221         ao_dbg_send_bits(DBG_CLOCK|DBG_DATA|DBG_RESET_N, DBG_CLOCK|DBG_DATA|DBG_RESET_N);
222         ao_dbg_long_delay();
223 }
224
225 static void
226 debug_enable(void)
227 {
228         ao_dbg_debug_mode();
229 }
230
231 static void
232 debug_reset(void)
233 {
234         ao_dbg_reset();
235 }
236
237 static void
238 debug_put(void)
239 {
240         for (;;) {
241                 ao_cmd_white ();
242                 if (ao_cmd_lex_c == '\n')
243                         break;
244                 ao_cmd_hex();
245                 if (ao_cmd_status != ao_cmd_success)
246                         break;
247                 ao_dbg_send_byte(ao_cmd_lex_i);
248         }
249 }
250
251 static void
252 debug_get(void)
253 {
254         __xdata uint16_t count;
255         __xdata uint16_t i;
256         __xdata uint8_t byte;
257         ao_cmd_hex();
258         if (ao_cmd_status != ao_cmd_success)
259                 return;
260         count = ao_cmd_lex_i;
261         if (count > 256) {
262                 ao_cmd_status = ao_cmd_syntax_error;
263                 return;
264         }
265         for (i = 0; i < count; i++) {
266                 if (i && (i & 7) == 0)
267                         putchar('\n');
268                 byte = ao_dbg_recv_byte();
269                 ao_cmd_put8(byte);
270                 putchar(' ');
271         }
272         putchar('\n');
273 }
274
275 static uint8_t
276 getnibble(void)
277 {
278         __xdata char    c;
279
280         c = getchar();
281         if ('0' <= c && c <= '9')
282                 return c - '0';
283         if ('a' <= c && c <= 'f')
284                 return c - ('a' - 10);
285         if ('A' <= c && c <= 'F')
286                 return c - ('A' - 10);
287         ao_cmd_status = ao_cmd_lex_error;
288         return 0;
289 }
290
291 static void
292 debug_input(void)
293 {
294         __xdata uint16_t count;
295         __xdata uint16_t addr;
296         __xdata uint8_t b;
297         __xdata uint8_t i;
298
299         ao_cmd_hex();
300         count = ao_cmd_lex_i;
301         ao_cmd_hex();
302         addr = ao_cmd_lex_i;
303         if (ao_cmd_status != ao_cmd_success)
304                 return;
305         ao_dbg_start_transfer(addr);
306         i = 0;
307         while (count--) {
308                 if (!(i++ & 7))
309                         putchar('\n');
310                 b = ao_dbg_read_byte();
311                 ao_cmd_put8(b);
312         }
313         ao_dbg_end_transfer();
314         putchar('\n');
315 }
316
317 static void
318 debug_output(void)
319 {
320         __xdata uint16_t count;
321         __xdata uint16_t addr;
322         __xdata uint8_t b;
323
324         ao_cmd_hex();
325         count = ao_cmd_lex_i;
326         ao_cmd_hex();
327         addr = ao_cmd_lex_i;
328         if (ao_cmd_status != ao_cmd_success)
329                 return;
330         ao_dbg_start_transfer(addr);
331         while (count--) {
332                 b = getnibble() << 4;
333                 b |= getnibble();
334                 if (ao_cmd_status != ao_cmd_success)
335                         return;
336                 ao_dbg_write_byte(b);
337         }
338         ao_dbg_end_transfer();
339 }
340
341 __code struct ao_cmds ao_dbg_cmds[7] = {
342         { 'D',  debug_enable,   "D                                  Enable debug mode" },
343         { 'G',  debug_get,      "G <count>                          Get data from debug port" },
344         { 'I',  debug_input,    "I <count> <addr>                   Input <count> bytes to target at <addr>" },
345         { 'O',  debug_output,   "O <count> <addr>                   Output <count> bytes to target at <addr>" },
346         { 'P',  debug_put,      "P <byte> ...                       Put data to debug port" },
347         { 'R',  debug_reset,    "R                                  Reset target" },
348         { 0, debug_reset,       0 },
349 };
350
351 void
352 ao_dbg_init(void)
353 {
354         ao_cmd_register(&ao_dbg_cmds[0]);
355 }