e2d431eab199fcd0b8f1d455ce8be25a99df90b5
[platform/upstream/binutils.git] / gdb / remote-mips.c
1 /* Remote debugging interface for MIPS remote debugging protocol.
2    Copyright 1993, 1994, 1995, 2000, 2001 Free Software Foundation, Inc.
3    Contributed by Cygnus Support.  Written by Ian Lance Taylor
4    <ian@cygnus.com>.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 59 Temple Place - Suite 330,
21    Boston, MA 02111-1307, USA.  */
22
23 #include "defs.h"
24 #include "inferior.h"
25 #include "bfd.h"
26 #include "symfile.h"
27 #include "gdb_wait.h"
28 #include "gdbcmd.h"
29 #include "gdbcore.h"
30 #include "serial.h"
31 #include "target.h"
32 #include "remote-utils.h"
33 #include "gdb_string.h"
34
35 #include <signal.h>
36 #include <sys/types.h>
37 #include <sys/stat.h>
38
39 #include <ctype.h>
40
41 /* Microsoft C's stat.h doesn't define all the POSIX file modes.  */
42 #ifndef S_IROTH
43 #define S_IROTH S_IREAD
44 #endif
45
46 \f
47
48 /* Breakpoint types.  Values 0, 1, and 2 must agree with the watch
49    types passed by breakpoint.c to target_insert_watchpoint.
50    Value 3 is our own invention, and is used for ordinary instruction
51    breakpoints.  Value 4 is used to mark an unused watchpoint in tables.  */
52 enum break_type
53   {
54     BREAK_WRITE,                /* 0 */
55     BREAK_READ,                 /* 1 */
56     BREAK_ACCESS,               /* 2 */
57     BREAK_FETCH,                /* 3 */
58     BREAK_UNUSED                /* 4 */
59   };
60
61 /* Prototypes for local functions.  */
62
63 static int mips_readchar (int timeout);
64
65 static int mips_receive_header (unsigned char *hdr, int *pgarbage,
66                                 int ch, int timeout);
67
68 static int mips_receive_trailer (unsigned char *trlr, int *pgarbage,
69                                  int *pch, int timeout);
70
71 static int mips_cksum (const unsigned char *hdr,
72                        const unsigned char *data, int len);
73
74 static void mips_send_packet (const char *s, int get_ack);
75
76 static void mips_send_command (const char *cmd, int prompt);
77
78 static int mips_receive_packet (char *buff, int throw_error, int timeout);
79
80 static ULONGEST mips_request (int cmd, ULONGEST addr, ULONGEST data,
81                               int *perr, int timeout, char *buff);
82
83 static void mips_initialize (void);
84
85 static void mips_open (char *name, int from_tty);
86
87 static void pmon_open (char *name, int from_tty);
88
89 static void ddb_open (char *name, int from_tty);
90
91 static void lsi_open (char *name, int from_tty);
92
93 static void mips_close (int quitting);
94
95 static void mips_detach (char *args, int from_tty);
96
97 static void mips_resume (int pid, int step, enum target_signal siggnal);
98
99 static int mips_wait (int pid, struct target_waitstatus *status);
100
101 static int mips_map_regno (int regno);
102
103 static void mips_fetch_registers (int regno);
104
105 static void mips_prepare_to_store (void);
106
107 static void mips_store_registers (int regno);
108
109 static unsigned int mips_fetch_word (CORE_ADDR addr);
110
111 static int mips_store_word (CORE_ADDR addr, unsigned int value,
112                             char *old_contents);
113
114 static int mips_xfer_memory (CORE_ADDR memaddr, char *myaddr, int len,
115                              int write, 
116                              struct mem_attrib *attrib,
117                              struct target_ops *target);
118
119 static void mips_files_info (struct target_ops *ignore);
120
121 static void mips_create_inferior (char *execfile, char *args, char **env);
122
123 static void mips_mourn_inferior (void);
124
125 static int pmon_makeb64 (unsigned long v, char *p, int n, int *chksum);
126
127 static int pmon_zeroset (int recsize, char **buff, int *amount,
128                          unsigned int *chksum);
129
130 static int pmon_checkset (int recsize, char **buff, int *value);
131
132 static void pmon_make_fastrec (char **outbuf, unsigned char *inbuf,
133                                int *inptr, int inamount, int *recsize,
134                                unsigned int *csum, unsigned int *zerofill);
135
136 static int pmon_check_ack (char *mesg);
137
138 static void pmon_start_download (void);
139
140 static void pmon_end_download (int final, int bintotal);
141
142 static void pmon_download (char *buffer, int length);
143
144 static void pmon_load_fast (char *file);
145
146 static void mips_load (char *file, int from_tty);
147
148 static int mips_make_srec (char *buffer, int type, CORE_ADDR memaddr,
149                            unsigned char *myaddr, int len);
150
151 static int set_breakpoint (CORE_ADDR addr, int len, enum break_type type);
152
153 static int clear_breakpoint (CORE_ADDR addr, int len, enum break_type type);
154
155 static int common_breakpoint (int set, CORE_ADDR addr, int len,
156                               enum break_type type);
157
158 /* Forward declarations.  */
159 extern struct target_ops mips_ops;
160 extern struct target_ops pmon_ops;
161 extern struct target_ops ddb_ops;
162 \f/* *INDENT-OFF* */
163 /* The MIPS remote debugging interface is built on top of a simple
164    packet protocol.  Each packet is organized as follows:
165
166    SYN  The first character is always a SYN (ASCII 026, or ^V).  SYN
167    may not appear anywhere else in the packet.  Any time a SYN is
168    seen, a new packet should be assumed to have begun.
169
170    TYPE_LEN
171    This byte contains the upper five bits of the logical length
172    of the data section, plus a single bit indicating whether this
173    is a data packet or an acknowledgement.  The documentation
174    indicates that this bit is 1 for a data packet, but the actual
175    board uses 1 for an acknowledgement.  The value of the byte is
176    0x40 + (ack ? 0x20 : 0) + (len >> 6)
177    (we always have 0 <= len < 1024).  Acknowledgement packets do
178    not carry data, and must have a data length of 0.
179
180    LEN1 This byte contains the lower six bits of the logical length of
181    the data section.  The value is
182    0x40 + (len & 0x3f)
183
184    SEQ  This byte contains the six bit sequence number of the packet.
185    The value is
186    0x40 + seq
187    An acknowlegment packet contains the sequence number of the
188    packet being acknowledged plus 1 modulo 64.  Data packets are
189    transmitted in sequence.  There may only be one outstanding
190    unacknowledged data packet at a time.  The sequence numbers
191    are independent in each direction.  If an acknowledgement for
192    the previous packet is received (i.e., an acknowledgement with
193    the sequence number of the packet just sent) the packet just
194    sent should be retransmitted.  If no acknowledgement is
195    received within a timeout period, the packet should be
196    retransmitted.  This has an unfortunate failure condition on a
197    high-latency line, as a delayed acknowledgement may lead to an
198    endless series of duplicate packets.
199
200    DATA The actual data bytes follow.  The following characters are
201    escaped inline with DLE (ASCII 020, or ^P):
202    SYN (026)    DLE S
203    DLE (020)    DLE D
204    ^C  (003)    DLE C
205    ^S  (023)    DLE s
206    ^Q  (021)    DLE q
207    The additional DLE characters are not counted in the logical
208    length stored in the TYPE_LEN and LEN1 bytes.
209
210    CSUM1
211    CSUM2
212    CSUM3
213    These bytes contain an 18 bit checksum of the complete
214    contents of the packet excluding the SEQ byte and the
215    CSUM[123] bytes.  The checksum is simply the twos complement
216    addition of all the bytes treated as unsigned characters.  The
217    values of the checksum bytes are:
218    CSUM1: 0x40 + ((cksum >> 12) & 0x3f)
219    CSUM2: 0x40 + ((cksum >> 6) & 0x3f)
220    CSUM3: 0x40 + (cksum & 0x3f)
221
222    It happens that the MIPS remote debugging protocol always
223    communicates with ASCII strings.  Because of this, this
224    implementation doesn't bother to handle the DLE quoting mechanism,
225    since it will never be required.  */
226 /* *INDENT-ON* */
227
228
229 /* The SYN character which starts each packet.  */
230 #define SYN '\026'
231
232 /* The 0x40 used to offset each packet (this value ensures that all of
233    the header and trailer bytes, other than SYN, are printable ASCII
234    characters).  */
235 #define HDR_OFFSET 0x40
236
237 /* The indices of the bytes in the packet header.  */
238 #define HDR_INDX_SYN 0
239 #define HDR_INDX_TYPE_LEN 1
240 #define HDR_INDX_LEN1 2
241 #define HDR_INDX_SEQ 3
242 #define HDR_LENGTH 4
243
244 /* The data/ack bit in the TYPE_LEN header byte.  */
245 #define TYPE_LEN_DA_BIT 0x20
246 #define TYPE_LEN_DATA 0
247 #define TYPE_LEN_ACK TYPE_LEN_DA_BIT
248
249 /* How to compute the header bytes.  */
250 #define HDR_SET_SYN(data, len, seq) (SYN)
251 #define HDR_SET_TYPE_LEN(data, len, seq) \
252   (HDR_OFFSET \
253    + ((data) ? TYPE_LEN_DATA : TYPE_LEN_ACK) \
254    + (((len) >> 6) & 0x1f))
255 #define HDR_SET_LEN1(data, len, seq) (HDR_OFFSET + ((len) & 0x3f))
256 #define HDR_SET_SEQ(data, len, seq) (HDR_OFFSET + (seq))
257
258 /* Check that a header byte is reasonable.  */
259 #define HDR_CHECK(ch) (((ch) & HDR_OFFSET) == HDR_OFFSET)
260
261 /* Get data from the header.  These macros evaluate their argument
262    multiple times.  */
263 #define HDR_IS_DATA(hdr) \
264   (((hdr)[HDR_INDX_TYPE_LEN] & TYPE_LEN_DA_BIT) == TYPE_LEN_DATA)
265 #define HDR_GET_LEN(hdr) \
266   ((((hdr)[HDR_INDX_TYPE_LEN] & 0x1f) << 6) + (((hdr)[HDR_INDX_LEN1] & 0x3f)))
267 #define HDR_GET_SEQ(hdr) ((unsigned int)(hdr)[HDR_INDX_SEQ] & 0x3f)
268
269 /* The maximum data length.  */
270 #define DATA_MAXLEN 1023
271
272 /* The trailer offset.  */
273 #define TRLR_OFFSET HDR_OFFSET
274
275 /* The indices of the bytes in the packet trailer.  */
276 #define TRLR_INDX_CSUM1 0
277 #define TRLR_INDX_CSUM2 1
278 #define TRLR_INDX_CSUM3 2
279 #define TRLR_LENGTH 3
280
281 /* How to compute the trailer bytes.  */
282 #define TRLR_SET_CSUM1(cksum) (TRLR_OFFSET + (((cksum) >> 12) & 0x3f))
283 #define TRLR_SET_CSUM2(cksum) (TRLR_OFFSET + (((cksum) >>  6) & 0x3f))
284 #define TRLR_SET_CSUM3(cksum) (TRLR_OFFSET + (((cksum)      ) & 0x3f))
285
286 /* Check that a trailer byte is reasonable.  */
287 #define TRLR_CHECK(ch) (((ch) & TRLR_OFFSET) == TRLR_OFFSET)
288
289 /* Get data from the trailer.  This evaluates its argument multiple
290    times.  */
291 #define TRLR_GET_CKSUM(trlr) \
292   ((((trlr)[TRLR_INDX_CSUM1] & 0x3f) << 12) \
293    + (((trlr)[TRLR_INDX_CSUM2] & 0x3f) <<  6) \
294    + ((trlr)[TRLR_INDX_CSUM3] & 0x3f))
295
296 /* The sequence number modulos.  */
297 #define SEQ_MODULOS (64)
298
299 /* PMON commands to load from the serial port or UDP socket.  */
300 #define LOAD_CMD        "load -b -s tty0\r"
301 #define LOAD_CMD_UDP    "load -b -s udp\r"
302
303 /* The target vectors for the four different remote MIPS targets.
304    These are initialized with code in _initialize_remote_mips instead
305    of static initializers, to make it easier to extend the target_ops
306    vector later.  */
307 struct target_ops mips_ops, pmon_ops, ddb_ops, lsi_ops;
308
309 enum mips_monitor_type
310   {
311     /* IDT/SIM monitor being used: */
312     MON_IDT,
313     /* PMON monitor being used: */
314     MON_PMON,                   /* 3.0.83 [COGENT,EB,FP,NET] Algorithmics Ltd. Nov  9 1995 17:19:50 */
315     MON_DDB,                    /* 2.7.473 [DDBVR4300,EL,FP,NET] Risq Modular Systems,  Thu Jun 6 09:28:40 PDT 1996 */
316     MON_LSI,                    /* 4.3.12 [EB,FP], LSI LOGIC Corp. Tue Feb 25 13:22:14 1997 */
317     /* Last and unused value, for sizing vectors, etc. */
318     MON_LAST
319   };
320 static enum mips_monitor_type mips_monitor = MON_LAST;
321
322 /* The monitor prompt text.  If the user sets the PMON prompt
323    to some new value, the GDB `set monitor-prompt' command must also
324    be used to inform GDB about the expected prompt.  Otherwise, GDB
325    will not be able to connect to PMON in mips_initialize().
326    If the `set monitor-prompt' command is not used, the expected
327    default prompt will be set according the target:
328    target               prompt
329    -----                -----
330    pmon         PMON> 
331    ddb          NEC010>
332    lsi          PMON>
333  */
334 static char *mips_monitor_prompt;
335
336 /* Set to 1 if the target is open.  */
337 static int mips_is_open;
338
339 /* Currently active target description (if mips_is_open == 1) */
340 static struct target_ops *current_ops;
341
342 /* Set to 1 while the connection is being initialized.  */
343 static int mips_initializing;
344
345 /* Set to 1 while the connection is being brought down.  */
346 static int mips_exiting;
347
348 /* The next sequence number to send.  */
349 static unsigned int mips_send_seq;
350
351 /* The next sequence number we expect to receive.  */
352 static unsigned int mips_receive_seq;
353
354 /* The time to wait before retransmitting a packet, in seconds.  */
355 static int mips_retransmit_wait = 3;
356
357 /* The number of times to try retransmitting a packet before giving up.  */
358 static int mips_send_retries = 10;
359
360 /* The number of garbage characters to accept when looking for an
361    SYN for the next packet.  */
362 static int mips_syn_garbage = 10;
363
364 /* The time to wait for a packet, in seconds.  */
365 static int mips_receive_wait = 5;
366
367 /* Set if we have sent a packet to the board but have not yet received
368    a reply.  */
369 static int mips_need_reply = 0;
370
371 /* Handle used to access serial I/O stream.  */
372 static serial_t mips_desc;
373
374 /* UDP handle used to download files to target.  */
375 static serial_t udp_desc;
376 static int udp_in_use;
377
378 /* TFTP filename used to download files to DDB board, in the form
379    host:filename.  */
380 static char *tftp_name;         /* host:filename */
381 static char *tftp_localname;    /* filename portion of above */
382 static int tftp_in_use;
383 static FILE *tftp_file;
384
385 /* Counts the number of times the user tried to interrupt the target (usually
386    via ^C.  */
387 static int interrupt_count;
388
389 /* If non-zero, means that the target is running. */
390 static int mips_wait_flag = 0;
391
392 /* If non-zero, monitor supports breakpoint commands. */
393 static int monitor_supports_breakpoints = 0;
394
395 /* Data cache header.  */
396
397 #if 0                           /* not used (yet?) */
398 static DCACHE *mips_dcache;
399 #endif
400
401 /* Non-zero means that we've just hit a read or write watchpoint */
402 static int hit_watchpoint;
403
404 /* Table of breakpoints/watchpoints (used only on LSI PMON target).
405    The table is indexed by a breakpoint number, which is an integer
406    from 0 to 255 returned by the LSI PMON when a breakpoint is set.
407  */
408 #define MAX_LSI_BREAKPOINTS 256
409 struct lsi_breakpoint_info
410   {
411     enum break_type type;       /* type of breakpoint */
412     CORE_ADDR addr;             /* address of breakpoint */
413     int len;                    /* length of region being watched */
414     unsigned long value;        /* value to watch */
415   }
416 lsi_breakpoints[MAX_LSI_BREAKPOINTS];
417
418 /* Error/warning codes returned by LSI PMON for breakpoint commands.
419    Warning values may be ORed together; error values may not.  */
420 #define W_WARN  0x100           /* This bit is set if the error code is a warning */
421 #define W_MSK   0x101           /* warning: Range feature is supported via mask */
422 #define W_VAL   0x102           /* warning: Value check is not supported in hardware */
423 #define W_QAL   0x104           /* warning: Requested qualifiers are not supported in hardware */
424
425 #define E_ERR   0x200           /* This bit is set if the error code is an error */
426 #define E_BPT   0x200           /* error: No such breakpoint number */
427 #define E_RGE   0x201           /* error: Range is not supported */
428 #define E_QAL   0x202           /* error: The requested qualifiers can not be used */
429 #define E_OUT   0x203           /* error: Out of hardware resources */
430 #define E_NON   0x204           /* error: Hardware breakpoint not supported */
431
432 struct lsi_error
433   {
434     int code;                   /* error code */
435     char *string;               /* string associated with this code */
436   };
437
438 struct lsi_error lsi_warning_table[] =
439 {
440   {W_MSK, "Range feature is supported via mask"},
441   {W_VAL, "Value check is not supported in hardware"},
442   {W_QAL, "Requested qualifiers are not supported in hardware"},
443   {0, NULL}
444 };
445
446 struct lsi_error lsi_error_table[] =
447 {
448   {E_BPT, "No such breakpoint number"},
449   {E_RGE, "Range is not supported"},
450   {E_QAL, "The requested qualifiers can not be used"},
451   {E_OUT, "Out of hardware resources"},
452   {E_NON, "Hardware breakpoint not supported"},
453   {0, NULL}
454 };
455
456 /* Set to 1 with the 'set monitor-warnings' command to enable printing
457    of warnings returned by PMON when hardware breakpoints are used.  */
458 static int monitor_warnings;
459
460
461 static void
462 close_ports (void)
463 {
464   mips_is_open = 0;
465   SERIAL_CLOSE (mips_desc);
466
467   if (udp_in_use)
468     {
469       SERIAL_CLOSE (udp_desc);
470       udp_in_use = 0;
471     }
472   tftp_in_use = 0;
473 }
474
475 /* Handle low-level error that we can't recover from.  Note that just
476    error()ing out from target_wait or some such low-level place will cause
477    all hell to break loose--the rest of GDB will tend to get left in an
478    inconsistent state.  */
479
480 static NORETURN void
481 mips_error (char *string,...)
482 {
483   va_list args;
484
485   va_start (args, string);
486
487   target_terminal_ours ();
488   wrap_here ("");               /* Force out any buffered output */
489   gdb_flush (gdb_stdout);
490   if (error_pre_print)
491     fprintf_filtered (gdb_stderr, error_pre_print);
492   vfprintf_filtered (gdb_stderr, string, args);
493   fprintf_filtered (gdb_stderr, "\n");
494   va_end (args);
495   gdb_flush (gdb_stderr);
496
497   /* Clean up in such a way that mips_close won't try to talk to the
498      board (it almost surely won't work since we weren't able to talk to
499      it).  */
500   close_ports ();
501
502   printf_unfiltered ("Ending remote MIPS debugging.\n");
503   target_mourn_inferior ();
504
505   return_to_top_level (RETURN_ERROR);
506 }
507
508 /* putc_readable - print a character, displaying non-printable chars in
509    ^x notation or in hex.  */
510
511 static void
512 fputc_readable (int ch, struct ui_file *file)
513 {
514   if (ch == '\n')
515     fputc_unfiltered ('\n', file);
516   else if (ch == '\r')
517     fprintf_unfiltered (file, "\\r");
518   else if (ch < 0x20)           /* ASCII control character */
519     fprintf_unfiltered (file, "^%c", ch + '@');
520   else if (ch >= 0x7f)          /* non-ASCII characters (rubout or greater) */
521     fprintf_unfiltered (file, "[%02x]", ch & 0xff);
522   else
523     fputc_unfiltered (ch, file);
524 }
525
526
527 /* puts_readable - print a string, displaying non-printable chars in
528    ^x notation or in hex.  */
529
530 static void
531 fputs_readable (const char *string, struct ui_file *file)
532 {
533   int c;
534
535   while ((c = *string++) != '\0')
536     fputc_readable (c, file);
537 }
538
539
540 /* Wait until STRING shows up in mips_desc.  Returns 1 if successful, else 0 if
541    timed out.  TIMEOUT specifies timeout value in seconds.
542  */
543
544 int
545 mips_expect_timeout (const char *string, int timeout)
546 {
547   const char *p = string;
548
549   if (remote_debug)
550     {
551       fprintf_unfiltered (gdb_stdlog, "Expected \"");
552       fputs_readable (string, gdb_stdlog);
553       fprintf_unfiltered (gdb_stdlog, "\", got \"");
554     }
555
556   immediate_quit++;
557   while (1)
558     {
559       int c;
560
561 /* Must use SERIAL_READCHAR here cuz mips_readchar would get confused if we
562    were waiting for the mips_monitor_prompt... */
563
564       c = SERIAL_READCHAR (mips_desc, timeout);
565
566       if (c == SERIAL_TIMEOUT)
567         {
568           if (remote_debug)
569             fprintf_unfiltered (gdb_stdlog, "\": FAIL\n");
570           return 0;
571         }
572
573       if (remote_debug)
574         fputc_readable (c, gdb_stdlog);
575
576       if (c == *p++)
577         {
578           if (*p == '\0')
579             {
580               immediate_quit--;
581               if (remote_debug)
582                 fprintf_unfiltered (gdb_stdlog, "\": OK\n");
583               return 1;
584             }
585         }
586       else
587         {
588           p = string;
589           if (c == *p)
590             p++;
591         }
592     }
593 }
594
595 /* Wait until STRING shows up in mips_desc.  Returns 1 if successful, else 0 if
596    timed out.  The timeout value is hard-coded to 2 seconds.  Use
597    mips_expect_timeout if a different timeout value is needed.
598  */
599
600 int
601 mips_expect (const char *string)
602 {
603   return mips_expect_timeout (string, remote_timeout);
604 }
605
606 /* Read the required number of characters into the given buffer (which
607    is assumed to be large enough). The only failure is a timeout. */
608 int
609 mips_getstring (char *string, int n)
610 {
611   char *p = string;
612   int c;
613
614   immediate_quit++;
615   while (n > 0)
616     {
617       c = SERIAL_READCHAR (mips_desc, remote_timeout);
618
619       if (c == SERIAL_TIMEOUT)
620         {
621           fprintf_unfiltered (gdb_stderr,
622                  "Failed to read %d characters from target (TIMEOUT)\n", n);
623           immediate_quit--;
624           return 0;
625         }
626
627       *p++ = c;
628       n--;
629     }
630
631   immediate_quit--;
632   return 1;
633 }
634
635 /* Read a character from the remote, aborting on error.  Returns
636    SERIAL_TIMEOUT on timeout (since that's what SERIAL_READCHAR
637    returns).  FIXME: If we see the string mips_monitor_prompt from
638    the board, then we are debugging on the main console port, and we
639    have somehow dropped out of remote debugging mode.  In this case,
640    we automatically go back in to remote debugging mode.  This is a
641    hack, put in because I can't find any way for a program running on
642    the remote board to terminate without also ending remote debugging
643    mode.  I assume users won't have any trouble with this; for one
644    thing, the IDT documentation generally assumes that the remote
645    debugging port is not the console port.  This is, however, very
646    convenient for DejaGnu when you only have one connected serial
647    port.  */
648
649 static int
650 mips_readchar (int timeout)
651 {
652   int ch;
653   static int state = 0;
654   int mips_monitor_prompt_len = strlen (mips_monitor_prompt);
655
656   {
657     int i;
658
659     i = timeout;
660     if (i == -1 && watchdog > 0)
661       i = watchdog;
662   }
663
664   if (state == mips_monitor_prompt_len)
665     timeout = 1;
666   ch = SERIAL_READCHAR (mips_desc, timeout);
667
668   if (ch == SERIAL_TIMEOUT && timeout == -1)    /* Watchdog went off */
669     {
670       target_mourn_inferior ();
671       error ("Watchdog has expired.  Target detached.\n");
672     }
673
674   if (ch == SERIAL_EOF)
675     mips_error ("End of file from remote");
676   if (ch == SERIAL_ERROR)
677     mips_error ("Error reading from remote: %s", safe_strerror (errno));
678   if (remote_debug > 1)
679     {
680       /* Don't use _filtered; we can't deal with a QUIT out of
681          target_wait, and I think this might be called from there.  */
682       if (ch != SERIAL_TIMEOUT)
683         fprintf_unfiltered (gdb_stdlog, "Read '%c' %d 0x%x\n", ch, ch, ch);
684       else
685         fprintf_unfiltered (gdb_stdlog, "Timed out in read\n");
686     }
687
688   /* If we have seen mips_monitor_prompt and we either time out, or
689      we see a @ (which was echoed from a packet we sent), reset the
690      board as described above.  The first character in a packet after
691      the SYN (which is not echoed) is always an @ unless the packet is
692      more than 64 characters long, which ours never are.  */
693   if ((ch == SERIAL_TIMEOUT || ch == '@')
694       && state == mips_monitor_prompt_len
695       && !mips_initializing
696       && !mips_exiting)
697     {
698       if (remote_debug > 0)
699         /* Don't use _filtered; we can't deal with a QUIT out of
700            target_wait, and I think this might be called from there.  */
701         fprintf_unfiltered (gdb_stdlog, "Reinitializing MIPS debugging mode\n");
702
703       mips_need_reply = 0;
704       mips_initialize ();
705
706       state = 0;
707
708       /* At this point, about the only thing we can do is abort the command
709          in progress and get back to command level as quickly as possible. */
710
711       error ("Remote board reset, debug protocol re-initialized.");
712     }
713
714   if (ch == mips_monitor_prompt[state])
715     ++state;
716   else
717     state = 0;
718
719   return ch;
720 }
721
722 /* Get a packet header, putting the data in the supplied buffer.
723    PGARBAGE is a pointer to the number of garbage characters received
724    so far.  CH is the last character received.  Returns 0 for success,
725    or -1 for timeout.  */
726
727 static int
728 mips_receive_header (unsigned char *hdr, int *pgarbage, int ch, int timeout)
729 {
730   int i;
731
732   while (1)
733     {
734       /* Wait for a SYN.  mips_syn_garbage is intended to prevent
735          sitting here indefinitely if the board sends us one garbage
736          character per second.  ch may already have a value from the
737          last time through the loop.  */
738       while (ch != SYN)
739         {
740           ch = mips_readchar (timeout);
741           if (ch == SERIAL_TIMEOUT)
742             return -1;
743           if (ch != SYN)
744             {
745               /* Printing the character here lets the user of gdb see
746                  what the program is outputting, if the debugging is
747                  being done on the console port.  Don't use _filtered:
748                  we can't deal with a QUIT out of target_wait and
749                  buffered target output confuses the user. */
750               if (!mips_initializing || remote_debug > 0)
751                 {
752                   if (isprint (ch) || isspace (ch))
753                     {
754                       fputc_unfiltered (ch, gdb_stdtarg);
755                     }
756                   else
757                     {
758                       fputc_readable (ch, gdb_stdtarg);
759                     }
760                   gdb_flush (gdb_stdtarg);
761                 }
762               
763               /* Only count unprintable characters. */
764               if (! (isprint (ch) || isspace (ch)))
765                 (*pgarbage) += 1;
766
767               if (mips_syn_garbage > 0
768                   && *pgarbage > mips_syn_garbage)
769                 mips_error ("Debug protocol failure:  more than %d characters before a sync.",
770                             mips_syn_garbage);
771             }
772         }
773
774       /* Get the packet header following the SYN.  */
775       for (i = 1; i < HDR_LENGTH; i++)
776         {
777           ch = mips_readchar (timeout);
778           if (ch == SERIAL_TIMEOUT)
779             return -1;
780           /* Make sure this is a header byte.  */
781           if (ch == SYN || !HDR_CHECK (ch))
782             break;
783
784           hdr[i] = ch;
785         }
786
787       /* If we got the complete header, we can return.  Otherwise we
788          loop around and keep looking for SYN.  */
789       if (i >= HDR_LENGTH)
790         return 0;
791     }
792 }
793
794 /* Get a packet header, putting the data in the supplied buffer.
795    PGARBAGE is a pointer to the number of garbage characters received
796    so far.  The last character read is returned in *PCH.  Returns 0
797    for success, -1 for timeout, -2 for error.  */
798
799 static int
800 mips_receive_trailer (unsigned char *trlr, int *pgarbage, int *pch, int timeout)
801 {
802   int i;
803   int ch;
804
805   for (i = 0; i < TRLR_LENGTH; i++)
806     {
807       ch = mips_readchar (timeout);
808       *pch = ch;
809       if (ch == SERIAL_TIMEOUT)
810         return -1;
811       if (!TRLR_CHECK (ch))
812         return -2;
813       trlr[i] = ch;
814     }
815   return 0;
816 }
817
818 /* Get the checksum of a packet.  HDR points to the packet header.
819    DATA points to the packet data.  LEN is the length of DATA.  */
820
821 static int
822 mips_cksum (const unsigned char *hdr, const unsigned char *data, int len)
823 {
824   register const unsigned char *p;
825   register int c;
826   register int cksum;
827
828   cksum = 0;
829
830   /* The initial SYN is not included in the checksum.  */
831   c = HDR_LENGTH - 1;
832   p = hdr + 1;
833   while (c-- != 0)
834     cksum += *p++;
835
836   c = len;
837   p = data;
838   while (c-- != 0)
839     cksum += *p++;
840
841   return cksum;
842 }
843
844 /* Send a packet containing the given ASCII string.  */
845
846 static void
847 mips_send_packet (const char *s, int get_ack)
848 {
849   /* unsigned */ int len;
850   unsigned char *packet;
851   register int cksum;
852   int try;
853
854   len = strlen (s);
855   if (len > DATA_MAXLEN)
856     mips_error ("MIPS protocol data packet too long: %s", s);
857
858   packet = (unsigned char *) alloca (HDR_LENGTH + len + TRLR_LENGTH + 1);
859
860   packet[HDR_INDX_SYN] = HDR_SET_SYN (1, len, mips_send_seq);
861   packet[HDR_INDX_TYPE_LEN] = HDR_SET_TYPE_LEN (1, len, mips_send_seq);
862   packet[HDR_INDX_LEN1] = HDR_SET_LEN1 (1, len, mips_send_seq);
863   packet[HDR_INDX_SEQ] = HDR_SET_SEQ (1, len, mips_send_seq);
864
865   memcpy (packet + HDR_LENGTH, s, len);
866
867   cksum = mips_cksum (packet, packet + HDR_LENGTH, len);
868   packet[HDR_LENGTH + len + TRLR_INDX_CSUM1] = TRLR_SET_CSUM1 (cksum);
869   packet[HDR_LENGTH + len + TRLR_INDX_CSUM2] = TRLR_SET_CSUM2 (cksum);
870   packet[HDR_LENGTH + len + TRLR_INDX_CSUM3] = TRLR_SET_CSUM3 (cksum);
871
872   /* Increment the sequence number.  This will set mips_send_seq to
873      the sequence number we expect in the acknowledgement.  */
874   mips_send_seq = (mips_send_seq + 1) % SEQ_MODULOS;
875
876   /* We can only have one outstanding data packet, so we just wait for
877      the acknowledgement here.  Keep retransmitting the packet until
878      we get one, or until we've tried too many times.  */
879   for (try = 0; try < mips_send_retries; try++)
880     {
881       int garbage;
882       int ch;
883
884       if (remote_debug > 0)
885         {
886           /* Don't use _filtered; we can't deal with a QUIT out of
887              target_wait, and I think this might be called from there.  */
888           packet[HDR_LENGTH + len + TRLR_LENGTH] = '\0';
889           fprintf_unfiltered (gdb_stdlog, "Writing \"%s\"\n", packet + 1);
890         }
891
892       if (SERIAL_WRITE (mips_desc, packet,
893                         HDR_LENGTH + len + TRLR_LENGTH) != 0)
894         mips_error ("write to target failed: %s", safe_strerror (errno));
895
896       if (!get_ack)
897         return;
898
899       garbage = 0;
900       ch = 0;
901       while (1)
902         {
903           unsigned char hdr[HDR_LENGTH + 1];
904           unsigned char trlr[TRLR_LENGTH + 1];
905           int err;
906           unsigned int seq;
907
908           /* Get the packet header.  If we time out, resend the data
909              packet.  */
910           err = mips_receive_header (hdr, &garbage, ch, mips_retransmit_wait);
911           if (err != 0)
912             break;
913
914           ch = 0;
915
916           /* If we get a data packet, assume it is a duplicate and
917              ignore it.  FIXME: If the acknowledgement is lost, this
918              data packet may be the packet the remote sends after the
919              acknowledgement.  */
920           if (HDR_IS_DATA (hdr))
921             {
922               int i;
923
924               /* Ignore any errors raised whilst attempting to ignore
925                  packet. */
926
927               len = HDR_GET_LEN (hdr);
928
929               for (i = 0; i < len; i++)
930                 {
931                   int rch;
932
933                   rch = mips_readchar (remote_timeout);
934                   if (rch == SYN)
935                     {
936                       ch = SYN;
937                       break;
938                     }
939                   if (rch == SERIAL_TIMEOUT)
940                     break;
941                   /* ignore the character */
942                 }
943
944               if (i == len)
945                 (void) mips_receive_trailer (trlr, &garbage, &ch,
946                                              remote_timeout);
947
948               /* We don't bother checking the checksum, or providing an
949                  ACK to the packet. */
950               continue;
951             }
952
953           /* If the length is not 0, this is a garbled packet.  */
954           if (HDR_GET_LEN (hdr) != 0)
955             continue;
956
957           /* Get the packet trailer.  */
958           err = mips_receive_trailer (trlr, &garbage, &ch,
959                                       mips_retransmit_wait);
960
961           /* If we timed out, resend the data packet.  */
962           if (err == -1)
963             break;
964
965           /* If we got a bad character, reread the header.  */
966           if (err != 0)
967             continue;
968
969           /* If the checksum does not match the trailer checksum, this
970              is a bad packet; ignore it.  */
971           if (mips_cksum (hdr, (unsigned char *) NULL, 0)
972               != TRLR_GET_CKSUM (trlr))
973             continue;
974
975           if (remote_debug > 0)
976             {
977               hdr[HDR_LENGTH] = '\0';
978               trlr[TRLR_LENGTH] = '\0';
979               /* Don't use _filtered; we can't deal with a QUIT out of
980                  target_wait, and I think this might be called from there.  */
981               fprintf_unfiltered (gdb_stdlog, "Got ack %d \"%s%s\"\n",
982                                   HDR_GET_SEQ (hdr), hdr + 1, trlr);
983             }
984
985           /* If this ack is for the current packet, we're done.  */
986           seq = HDR_GET_SEQ (hdr);
987           if (seq == mips_send_seq)
988             return;
989
990           /* If this ack is for the last packet, resend the current
991              packet.  */
992           if ((seq + 1) % SEQ_MODULOS == mips_send_seq)
993             break;
994
995           /* Otherwise this is a bad ack; ignore it.  Increment the
996              garbage count to ensure that we do not stay in this loop
997              forever.  */
998           ++garbage;
999         }
1000     }
1001
1002   mips_error ("Remote did not acknowledge packet");
1003 }
1004
1005 /* Receive and acknowledge a packet, returning the data in BUFF (which
1006    should be DATA_MAXLEN + 1 bytes).  The protocol documentation
1007    implies that only the sender retransmits packets, so this code just
1008    waits silently for a packet.  It returns the length of the received
1009    packet.  If THROW_ERROR is nonzero, call error() on errors.  If not,
1010    don't print an error message and return -1.  */
1011
1012 static int
1013 mips_receive_packet (char *buff, int throw_error, int timeout)
1014 {
1015   int ch;
1016   int garbage;
1017   int len;
1018   unsigned char ack[HDR_LENGTH + TRLR_LENGTH + 1];
1019   int cksum;
1020
1021   ch = 0;
1022   garbage = 0;
1023   while (1)
1024     {
1025       unsigned char hdr[HDR_LENGTH];
1026       unsigned char trlr[TRLR_LENGTH];
1027       int i;
1028       int err;
1029
1030       if (mips_receive_header (hdr, &garbage, ch, timeout) != 0)
1031         {
1032           if (throw_error)
1033             mips_error ("Timed out waiting for remote packet");
1034           else
1035             return -1;
1036         }
1037
1038       ch = 0;
1039
1040       /* An acknowledgement is probably a duplicate; ignore it.  */
1041       if (!HDR_IS_DATA (hdr))
1042         {
1043           len = HDR_GET_LEN (hdr);
1044           /* Check if the length is valid for an ACK, we may aswell
1045              try and read the remainder of the packet: */
1046           if (len == 0)
1047             {
1048               /* Ignore the error condition, since we are going to
1049                  ignore the packet anyway. */
1050               (void) mips_receive_trailer (trlr, &garbage, &ch, timeout);
1051             }
1052           /* Don't use _filtered; we can't deal with a QUIT out of
1053              target_wait, and I think this might be called from there.  */
1054           if (remote_debug > 0)
1055             fprintf_unfiltered (gdb_stdlog, "Ignoring unexpected ACK\n");
1056           continue;
1057         }
1058
1059       len = HDR_GET_LEN (hdr);
1060       for (i = 0; i < len; i++)
1061         {
1062           int rch;
1063
1064           rch = mips_readchar (timeout);
1065           if (rch == SYN)
1066             {
1067               ch = SYN;
1068               break;
1069             }
1070           if (rch == SERIAL_TIMEOUT)
1071             {
1072               if (throw_error)
1073                 mips_error ("Timed out waiting for remote packet");
1074               else
1075                 return -1;
1076             }
1077           buff[i] = rch;
1078         }
1079
1080       if (i < len)
1081         {
1082           /* Don't use _filtered; we can't deal with a QUIT out of
1083              target_wait, and I think this might be called from there.  */
1084           if (remote_debug > 0)
1085             fprintf_unfiltered (gdb_stdlog,
1086                                 "Got new SYN after %d chars (wanted %d)\n",
1087                                 i, len);
1088           continue;
1089         }
1090
1091       err = mips_receive_trailer (trlr, &garbage, &ch, timeout);
1092       if (err == -1)
1093         {
1094           if (throw_error)
1095             mips_error ("Timed out waiting for packet");
1096           else
1097             return -1;
1098         }
1099       if (err == -2)
1100         {
1101           /* Don't use _filtered; we can't deal with a QUIT out of
1102              target_wait, and I think this might be called from there.  */
1103           if (remote_debug > 0)
1104             fprintf_unfiltered (gdb_stdlog, "Got SYN when wanted trailer\n");
1105           continue;
1106         }
1107
1108       /* If this is the wrong sequence number, ignore it.  */
1109       if (HDR_GET_SEQ (hdr) != mips_receive_seq)
1110         {
1111           /* Don't use _filtered; we can't deal with a QUIT out of
1112              target_wait, and I think this might be called from there.  */
1113           if (remote_debug > 0)
1114             fprintf_unfiltered (gdb_stdlog,
1115                                 "Ignoring sequence number %d (want %d)\n",
1116                                 HDR_GET_SEQ (hdr), mips_receive_seq);
1117           continue;
1118         }
1119
1120       if (mips_cksum (hdr, buff, len) == TRLR_GET_CKSUM (trlr))
1121         break;
1122
1123       if (remote_debug > 0)
1124         /* Don't use _filtered; we can't deal with a QUIT out of
1125            target_wait, and I think this might be called from there.  */
1126         printf_unfiltered ("Bad checksum; data %d, trailer %d\n",
1127                            mips_cksum (hdr, buff, len),
1128                            TRLR_GET_CKSUM (trlr));
1129
1130       /* The checksum failed.  Send an acknowledgement for the
1131          previous packet to tell the remote to resend the packet.  */
1132       ack[HDR_INDX_SYN] = HDR_SET_SYN (0, 0, mips_receive_seq);
1133       ack[HDR_INDX_TYPE_LEN] = HDR_SET_TYPE_LEN (0, 0, mips_receive_seq);
1134       ack[HDR_INDX_LEN1] = HDR_SET_LEN1 (0, 0, mips_receive_seq);
1135       ack[HDR_INDX_SEQ] = HDR_SET_SEQ (0, 0, mips_receive_seq);
1136
1137       cksum = mips_cksum (ack, (unsigned char *) NULL, 0);
1138
1139       ack[HDR_LENGTH + TRLR_INDX_CSUM1] = TRLR_SET_CSUM1 (cksum);
1140       ack[HDR_LENGTH + TRLR_INDX_CSUM2] = TRLR_SET_CSUM2 (cksum);
1141       ack[HDR_LENGTH + TRLR_INDX_CSUM3] = TRLR_SET_CSUM3 (cksum);
1142
1143       if (remote_debug > 0)
1144         {
1145           ack[HDR_LENGTH + TRLR_LENGTH] = '\0';
1146           /* Don't use _filtered; we can't deal with a QUIT out of
1147              target_wait, and I think this might be called from there.  */
1148           printf_unfiltered ("Writing ack %d \"%s\"\n", mips_receive_seq,
1149                              ack + 1);
1150         }
1151
1152       if (SERIAL_WRITE (mips_desc, ack, HDR_LENGTH + TRLR_LENGTH) != 0)
1153         {
1154           if (throw_error)
1155             mips_error ("write to target failed: %s", safe_strerror (errno));
1156           else
1157             return -1;
1158         }
1159     }
1160
1161   if (remote_debug > 0)
1162     {
1163       buff[len] = '\0';
1164       /* Don't use _filtered; we can't deal with a QUIT out of
1165          target_wait, and I think this might be called from there.  */
1166       printf_unfiltered ("Got packet \"%s\"\n", buff);
1167     }
1168
1169   /* We got the packet.  Send an acknowledgement.  */
1170   mips_receive_seq = (mips_receive_seq + 1) % SEQ_MODULOS;
1171
1172   ack[HDR_INDX_SYN] = HDR_SET_SYN (0, 0, mips_receive_seq);
1173   ack[HDR_INDX_TYPE_LEN] = HDR_SET_TYPE_LEN (0, 0, mips_receive_seq);
1174   ack[HDR_INDX_LEN1] = HDR_SET_LEN1 (0, 0, mips_receive_seq);
1175   ack[HDR_INDX_SEQ] = HDR_SET_SEQ (0, 0, mips_receive_seq);
1176
1177   cksum = mips_cksum (ack, (unsigned char *) NULL, 0);
1178
1179   ack[HDR_LENGTH + TRLR_INDX_CSUM1] = TRLR_SET_CSUM1 (cksum);
1180   ack[HDR_LENGTH + TRLR_INDX_CSUM2] = TRLR_SET_CSUM2 (cksum);
1181   ack[HDR_LENGTH + TRLR_INDX_CSUM3] = TRLR_SET_CSUM3 (cksum);
1182
1183   if (remote_debug > 0)
1184     {
1185       ack[HDR_LENGTH + TRLR_LENGTH] = '\0';
1186       /* Don't use _filtered; we can't deal with a QUIT out of
1187          target_wait, and I think this might be called from there.  */
1188       printf_unfiltered ("Writing ack %d \"%s\"\n", mips_receive_seq,
1189                          ack + 1);
1190     }
1191
1192   if (SERIAL_WRITE (mips_desc, ack, HDR_LENGTH + TRLR_LENGTH) != 0)
1193     {
1194       if (throw_error)
1195         mips_error ("write to target failed: %s", safe_strerror (errno));
1196       else
1197         return -1;
1198     }
1199
1200   return len;
1201 }
1202 \f
1203 /* Optionally send a request to the remote system and optionally wait
1204    for the reply.  This implements the remote debugging protocol,
1205    which is built on top of the packet protocol defined above.  Each
1206    request has an ADDR argument and a DATA argument.  The following
1207    requests are defined:
1208
1209    \0   don't send a request; just wait for a reply
1210    i    read word from instruction space at ADDR
1211    d    read word from data space at ADDR
1212    I    write DATA to instruction space at ADDR
1213    D    write DATA to data space at ADDR
1214    r    read register number ADDR
1215    R    set register number ADDR to value DATA
1216    c    continue execution (if ADDR != 1, set pc to ADDR)
1217    s    single step (if ADDR != 1, set pc to ADDR)
1218
1219    The read requests return the value requested.  The write requests
1220    return the previous value in the changed location.  The execution
1221    requests return a UNIX wait value (the approximate signal which
1222    caused execution to stop is in the upper eight bits).
1223
1224    If PERR is not NULL, this function waits for a reply.  If an error
1225    occurs, it sets *PERR to 1 and sets errno according to what the
1226    target board reports.  */
1227
1228 static ULONGEST
1229 mips_request (int cmd,
1230               ULONGEST addr,
1231               ULONGEST data,
1232               int *perr,
1233               int timeout,
1234               char *buff)
1235 {
1236   char myBuff[DATA_MAXLEN + 1];
1237   int len;
1238   int rpid;
1239   char rcmd;
1240   int rerrflg;
1241   unsigned long rresponse;
1242
1243   if (buff == (char *) NULL)
1244     buff = myBuff;
1245
1246   if (cmd != '\0')
1247     {
1248       if (mips_need_reply)
1249         internal_error ("mips_request: Trying to send command before reply");
1250       sprintf (buff, "0x0 %c 0x%s 0x%s", cmd, paddr_nz (addr), paddr_nz (data));
1251       mips_send_packet (buff, 1);
1252       mips_need_reply = 1;
1253     }
1254
1255   if (perr == (int *) NULL)
1256     return 0;
1257
1258   if (!mips_need_reply)
1259     internal_error ("mips_request: Trying to get reply before command");
1260
1261   mips_need_reply = 0;
1262
1263   len = mips_receive_packet (buff, 1, timeout);
1264   buff[len] = '\0';
1265
1266   if (sscanf (buff, "0x%x %c 0x%x 0x%lx",
1267               &rpid, &rcmd, &rerrflg, &rresponse) != 4
1268       || (cmd != '\0' && rcmd != cmd))
1269     mips_error ("Bad response from remote board");
1270
1271   if (rerrflg != 0)
1272     {
1273       *perr = 1;
1274
1275       /* FIXME: This will returns MIPS errno numbers, which may or may
1276          not be the same as errno values used on other systems.  If
1277          they stick to common errno values, they will be the same, but
1278          if they don't, they must be translated.  */
1279       errno = rresponse;
1280
1281       return 0;
1282     }
1283
1284   *perr = 0;
1285   return rresponse;
1286 }
1287
1288 static void
1289 mips_initialize_cleanups (PTR arg)
1290 {
1291   mips_initializing = 0;
1292 }
1293
1294 static void
1295 mips_exit_cleanups (PTR arg)
1296 {
1297   mips_exiting = 0;
1298 }
1299
1300 static void
1301 mips_send_command (const char *cmd, int prompt)
1302 {
1303   SERIAL_WRITE (mips_desc, cmd, strlen (cmd));
1304   mips_expect (cmd);
1305   mips_expect ("\n");
1306   if (prompt)
1307     mips_expect (mips_monitor_prompt);
1308 }
1309
1310 /* Enter remote (dbx) debug mode: */
1311 static void
1312 mips_enter_debug (void)
1313 {
1314   /* Reset the sequence numbers, ready for the new debug sequence: */
1315   mips_send_seq = 0;
1316   mips_receive_seq = 0;
1317
1318   if (mips_monitor != MON_IDT)
1319     mips_send_command ("debug\r", 0);
1320   else                          /* assume IDT monitor by default */
1321     mips_send_command ("db tty0\r", 0);
1322
1323   sleep (1);
1324   SERIAL_WRITE (mips_desc, "\r", sizeof "\r" - 1);
1325
1326   /* We don't need to absorb any spurious characters here, since the
1327      mips_receive_header will eat up a reasonable number of characters
1328      whilst looking for the SYN, however this avoids the "garbage"
1329      being displayed to the user. */
1330   if (mips_monitor != MON_IDT)
1331     mips_expect ("\r");
1332
1333   {
1334     char buff[DATA_MAXLEN + 1];
1335     if (mips_receive_packet (buff, 1, 3) < 0)
1336       mips_error ("Failed to initialize (didn't receive packet).");
1337   }
1338 }
1339
1340 /* Exit remote (dbx) debug mode, returning to the monitor prompt: */
1341 static int
1342 mips_exit_debug (void)
1343 {
1344   int err;
1345   struct cleanup *old_cleanups = make_cleanup (mips_exit_cleanups, NULL);
1346
1347   mips_exiting = 1;
1348
1349   if (mips_monitor != MON_IDT)
1350     {
1351       /* The DDB (NEC) and MiniRISC (LSI) versions of PMON exit immediately,
1352          so we do not get a reply to this command: */
1353       mips_request ('x', 0, 0, NULL, mips_receive_wait, NULL);
1354       mips_need_reply = 0;
1355       if (!mips_expect (" break!"))
1356         return -1;
1357     }
1358   else
1359     mips_request ('x', 0, 0, &err, mips_receive_wait, NULL);
1360
1361   if (!mips_expect (mips_monitor_prompt))
1362     return -1;
1363
1364   do_cleanups (old_cleanups);
1365
1366   return 0;
1367 }
1368
1369 /* Initialize a new connection to the MIPS board, and make sure we are
1370    really connected.  */
1371
1372 static void
1373 mips_initialize (void)
1374 {
1375   int err;
1376   struct cleanup *old_cleanups = make_cleanup (mips_initialize_cleanups, NULL);
1377   int j;
1378
1379   /* What is this code doing here?  I don't see any way it can happen, and
1380      it might mean mips_initializing didn't get cleared properly.
1381      So I'll make it a warning.  */
1382
1383   if (mips_initializing)
1384     {
1385       warning ("internal error: mips_initialize called twice");
1386       return;
1387     }
1388
1389   mips_wait_flag = 0;
1390   mips_initializing = 1;
1391
1392   /* At this point, the packit protocol isn't responding.  We'll try getting
1393      into the monitor, and restarting the protocol.  */
1394
1395   /* Force the system into the monitor.  After this we *should* be at
1396      the mips_monitor_prompt.  */
1397   if (mips_monitor != MON_IDT)
1398     j = 0;                      /* start by checking if we are already at the prompt */
1399   else
1400     j = 1;                      /* start by sending a break */
1401   for (; j <= 4; j++)
1402     {
1403       switch (j)
1404         {
1405         case 0:         /* First, try sending a CR */
1406           SERIAL_FLUSH_INPUT (mips_desc);
1407           SERIAL_WRITE (mips_desc, "\r", 1);
1408           break;
1409         case 1:         /* First, try sending a break */
1410           SERIAL_SEND_BREAK (mips_desc);
1411           break;
1412         case 2:         /* Then, try a ^C */
1413           SERIAL_WRITE (mips_desc, "\003", 1);
1414           break;
1415         case 3:         /* Then, try escaping from download */
1416           {
1417             if (mips_monitor != MON_IDT)
1418               {
1419                 char tbuff[7];
1420
1421                 /* We shouldn't need to send multiple termination
1422                    sequences, since the target performs line (or
1423                    block) reads, and then processes those
1424                    packets. In-case we were downloading a large packet
1425                    we flush the output buffer before inserting a
1426                    termination sequence. */
1427                 SERIAL_FLUSH_OUTPUT (mips_desc);
1428                 sprintf (tbuff, "\r/E/E\r");
1429                 SERIAL_WRITE (mips_desc, tbuff, 6);
1430               }
1431             else
1432               {
1433                 char srec[10];
1434                 int i;
1435
1436                 /* We are possibly in binary download mode, having
1437                    aborted in the middle of an S-record.  ^C won't
1438                    work because of binary mode.  The only reliable way
1439                    out is to send enough termination packets (8 bytes)
1440                    to fill up and then overflow the largest size
1441                    S-record (255 bytes in this case).  This amounts to
1442                    256/8 + 1 packets.
1443                  */
1444
1445                 mips_make_srec (srec, '7', 0, NULL, 0);
1446
1447                 for (i = 1; i <= 33; i++)
1448                   {
1449                     SERIAL_WRITE (mips_desc, srec, 8);
1450
1451                     if (SERIAL_READCHAR (mips_desc, 0) >= 0)
1452                       break;    /* Break immediatly if we get something from
1453                                    the board. */
1454                   }
1455               }
1456           }
1457           break;
1458         case 4:
1459           mips_error ("Failed to initialize.");
1460         }
1461
1462       if (mips_expect (mips_monitor_prompt))
1463         break;
1464     }
1465
1466   if (mips_monitor != MON_IDT)
1467     {
1468       /* Sometimes PMON ignores the first few characters in the first
1469          command sent after a load.  Sending a blank command gets
1470          around that.  */
1471       mips_send_command ("\r", -1);
1472
1473       /* Ensure the correct target state: */
1474       if (mips_monitor != MON_LSI)
1475         mips_send_command ("set regsize 64\r", -1);
1476       mips_send_command ("set hostport tty0\r", -1);
1477       mips_send_command ("set brkcmd \"\"\r", -1);
1478       /* Delete all the current breakpoints: */
1479       mips_send_command ("db *\r", -1);
1480       /* NOTE: PMON does not have breakpoint support through the
1481          "debug" mode, only at the monitor command-line. */
1482     }
1483
1484   mips_enter_debug ();
1485
1486   /* Clear all breakpoints: */
1487   if ((mips_monitor == MON_IDT
1488        && clear_breakpoint (-1, 0, BREAK_UNUSED) == 0)
1489       || mips_monitor == MON_LSI)
1490     monitor_supports_breakpoints = 1;
1491   else
1492     monitor_supports_breakpoints = 0;
1493
1494   do_cleanups (old_cleanups);
1495
1496   /* If this doesn't call error, we have connected; we don't care if
1497      the request itself succeeds or fails.  */
1498
1499   mips_request ('r', 0, 0, &err, mips_receive_wait, NULL);
1500   set_current_frame (create_new_frame (read_fp (), read_pc ()));
1501   select_frame (get_current_frame (), 0);
1502 }
1503
1504 /* Open a connection to the remote board.  */
1505 static void
1506 common_open (struct target_ops *ops, char *name, int from_tty,
1507              enum mips_monitor_type new_monitor,
1508              const char *new_monitor_prompt)
1509 {
1510   char *ptype;
1511   char *serial_port_name;
1512   char *remote_name = 0;
1513   char *local_name = 0;
1514   char **argv;
1515
1516   if (name == 0)
1517     error (
1518             "To open a MIPS remote debugging connection, you need to specify what serial\n\
1519 device is attached to the target board (e.g., /dev/ttya).\n"
1520             "If you want to use TFTP to download to the board, specify the name of a\n"
1521             "temporary file to be used by GDB for downloads as the second argument.\n"
1522             "This filename must be in the form host:filename, where host is the name\n"
1523             "of the host running the TFTP server, and the file must be readable by the\n"
1524             "world.  If the local name of the temporary file differs from the name as\n"
1525             "seen from the board via TFTP, specify that name as the third parameter.\n");
1526
1527   /* Parse the serial port name, the optional TFTP name, and the
1528      optional local TFTP name.  */
1529   if ((argv = buildargv (name)) == NULL)
1530     nomem (0);
1531   make_cleanup_freeargv (argv);
1532
1533   serial_port_name = xstrdup (argv[0]);
1534   if (argv[1])                  /* remote TFTP name specified? */
1535     {
1536       remote_name = argv[1];
1537       if (argv[2])              /* local TFTP filename specified? */
1538         local_name = argv[2];
1539     }
1540
1541   target_preopen (from_tty);
1542
1543   if (mips_is_open)
1544     unpush_target (current_ops);
1545
1546   /* Open and initialize the serial port.  */
1547   mips_desc = SERIAL_OPEN (serial_port_name);
1548   if (mips_desc == (serial_t) NULL)
1549     perror_with_name (serial_port_name);
1550
1551   if (baud_rate != -1)
1552     {
1553       if (SERIAL_SETBAUDRATE (mips_desc, baud_rate))
1554         {
1555           SERIAL_CLOSE (mips_desc);
1556           perror_with_name (serial_port_name);
1557         }
1558     }
1559
1560   SERIAL_RAW (mips_desc);
1561
1562   /* Open and initialize the optional download port.  If it is in the form
1563      hostname#portnumber, it's a UDP socket.  If it is in the form
1564      hostname:filename, assume it's the TFTP filename that must be
1565      passed to the DDB board to tell it where to get the load file.  */
1566   if (remote_name)
1567     {
1568       if (strchr (remote_name, '#'))
1569         {
1570           udp_desc = SERIAL_OPEN (remote_name);
1571           if (!udp_desc)
1572             perror_with_name ("Unable to open UDP port");
1573           udp_in_use = 1;
1574         }
1575       else
1576         {
1577           /* Save the remote and local names of the TFTP temp file.  If
1578              the user didn't specify a local name, assume it's the same
1579              as the part of the remote name after the "host:".  */
1580           if (tftp_name)
1581             xfree (tftp_name);
1582           if (tftp_localname)
1583             xfree (tftp_localname);
1584           if (local_name == NULL)
1585             if ((local_name = strchr (remote_name, ':')) != NULL)
1586               local_name++;     /* skip over the colon */
1587           if (local_name == NULL)
1588             local_name = remote_name;   /* local name same as remote name */
1589           tftp_name = xstrdup (remote_name);
1590           tftp_localname = xstrdup (local_name);
1591           tftp_in_use = 1;
1592         }
1593     }
1594
1595   current_ops = ops;
1596   mips_is_open = 1;
1597
1598   /* Reset the expected monitor prompt if it's never been set before.  */
1599   if (mips_monitor_prompt == NULL)
1600     mips_monitor_prompt = xstrdup (new_monitor_prompt);
1601   mips_monitor = new_monitor;
1602
1603   mips_initialize ();
1604
1605   if (from_tty)
1606     printf_unfiltered ("Remote MIPS debugging using %s\n", serial_port_name);
1607
1608   /* Switch to using remote target now.  */
1609   push_target (ops);
1610
1611   /* FIXME: Should we call start_remote here?  */
1612
1613   /* Try to figure out the processor model if possible.  */
1614   ptype = mips_read_processor_type ();
1615   if (ptype)
1616     mips_set_processor_type_command (xstrdup (ptype), 0);
1617
1618 /* This is really the job of start_remote however, that makes an assumption
1619    that the target is about to print out a status message of some sort.  That
1620    doesn't happen here (in fact, it may not be possible to get the monitor to
1621    send the appropriate packet).  */
1622
1623   flush_cached_frames ();
1624   registers_changed ();
1625   stop_pc = read_pc ();
1626   set_current_frame (create_new_frame (read_fp (), stop_pc));
1627   select_frame (get_current_frame (), 0);
1628   print_stack_frame (selected_frame, -1, 1);
1629   xfree (serial_port_name);
1630 }
1631
1632 static void
1633 mips_open (char *name, int from_tty)
1634 {
1635   const char *monitor_prompt = NULL;
1636   if (TARGET_ARCHITECTURE != NULL
1637       && TARGET_ARCHITECTURE->arch == bfd_arch_mips)
1638     {
1639     switch (TARGET_ARCHITECTURE->mach)
1640       {
1641       case bfd_mach_mips4100:
1642       case bfd_mach_mips4300:
1643       case bfd_mach_mips4600:
1644       case bfd_mach_mips4650:
1645       case bfd_mach_mips5000:
1646         monitor_prompt = "<RISQ> ";
1647         break;
1648       }
1649     }
1650   if (monitor_prompt == NULL)
1651     monitor_prompt = "<IDT>";
1652   common_open (&mips_ops, name, from_tty, MON_IDT, monitor_prompt);
1653 }
1654
1655 static void
1656 pmon_open (char *name, int from_tty)
1657 {
1658   common_open (&pmon_ops, name, from_tty, MON_PMON, "PMON> ");
1659 }
1660
1661 static void
1662 ddb_open (char *name, int from_tty)
1663 {
1664   common_open (&ddb_ops, name, from_tty, MON_DDB, "NEC010>");
1665 }
1666
1667 static void
1668 lsi_open (char *name, int from_tty)
1669 {
1670   int i;
1671
1672   /* Clear the LSI breakpoint table.  */
1673   for (i = 0; i < MAX_LSI_BREAKPOINTS; i++)
1674     lsi_breakpoints[i].type = BREAK_UNUSED;
1675
1676   common_open (&lsi_ops, name, from_tty, MON_LSI, "PMON> ");
1677 }
1678
1679 /* Close a connection to the remote board.  */
1680
1681 static void
1682 mips_close (int quitting)
1683 {
1684   if (mips_is_open)
1685     {
1686       /* Get the board out of remote debugging mode.  */
1687       (void) mips_exit_debug ();
1688
1689       close_ports ();
1690     }
1691 }
1692
1693 /* Detach from the remote board.  */
1694
1695 static void
1696 mips_detach (char *args, int from_tty)
1697 {
1698   if (args)
1699     error ("Argument given to \"detach\" when remotely debugging.");
1700
1701   pop_target ();
1702
1703   mips_close (1);
1704
1705   if (from_tty)
1706     printf_unfiltered ("Ending remote MIPS debugging.\n");
1707 }
1708
1709 /* Tell the target board to resume.  This does not wait for a reply
1710    from the board, except in the case of single-stepping on LSI boards,
1711    where PMON does return a reply.  */
1712
1713 static void
1714 mips_resume (int pid, int step, enum target_signal siggnal)
1715 {
1716   int err;
1717
1718   /* LSI PMON requires returns a reply packet "0x1 s 0x0 0x57f" after
1719      a single step, so we wait for that.  */
1720   mips_request (step ? 's' : 'c', 1, siggnal,
1721                 mips_monitor == MON_LSI && step ? &err : (int *) NULL,
1722                 mips_receive_wait, NULL);
1723 }
1724
1725 /* Return the signal corresponding to SIG, where SIG is the number which
1726    the MIPS protocol uses for the signal.  */
1727 enum target_signal
1728 mips_signal_from_protocol (int sig)
1729 {
1730   /* We allow a few more signals than the IDT board actually returns, on
1731      the theory that there is at least *some* hope that perhaps the numbering
1732      for these signals is widely agreed upon.  */
1733   if (sig <= 0
1734       || sig > 31)
1735     return TARGET_SIGNAL_UNKNOWN;
1736
1737   /* Don't want to use target_signal_from_host because we are converting
1738      from MIPS signal numbers, not host ones.  Our internal numbers
1739      match the MIPS numbers for the signals the board can return, which
1740      are: SIGINT, SIGSEGV, SIGBUS, SIGILL, SIGFPE, SIGTRAP.  */
1741   return (enum target_signal) sig;
1742 }
1743
1744 /* Wait until the remote stops, and return a wait status.  */
1745
1746 static int
1747 mips_wait (int pid, struct target_waitstatus *status)
1748 {
1749   int rstatus;
1750   int err;
1751   char buff[DATA_MAXLEN];
1752   int rpc, rfp, rsp;
1753   char flags[20];
1754   int nfields;
1755   int i;
1756
1757   interrupt_count = 0;
1758   hit_watchpoint = 0;
1759
1760   /* If we have not sent a single step or continue command, then the
1761      board is waiting for us to do something.  Return a status
1762      indicating that it is stopped.  */
1763   if (!mips_need_reply)
1764     {
1765       status->kind = TARGET_WAITKIND_STOPPED;
1766       status->value.sig = TARGET_SIGNAL_TRAP;
1767       return 0;
1768     }
1769
1770   /* No timeout; we sit here as long as the program continues to execute.  */
1771   mips_wait_flag = 1;
1772   rstatus = mips_request ('\000', 0, 0, &err, -1, buff);
1773   mips_wait_flag = 0;
1774   if (err)
1775     mips_error ("Remote failure: %s", safe_strerror (errno));
1776
1777   /* On returning from a continue, the PMON monitor seems to start
1778      echoing back the messages we send prior to sending back the
1779      ACK. The code can cope with this, but to try and avoid the
1780      unnecessary serial traffic, and "spurious" characters displayed
1781      to the user, we cheat and reset the debug protocol. The problems
1782      seems to be caused by a check on the number of arguments, and the
1783      command length, within the monitor causing it to echo the command
1784      as a bad packet. */
1785   if (mips_monitor == MON_PMON)
1786     {
1787       mips_exit_debug ();
1788       mips_enter_debug ();
1789     }
1790
1791   /* See if we got back extended status.  If so, pick out the pc, fp, sp, etc... */
1792
1793   nfields = sscanf (buff, "0x%*x %*c 0x%*x 0x%*x 0x%x 0x%x 0x%x 0x%*x %s",
1794                     &rpc, &rfp, &rsp, flags);
1795   if (nfields >= 3)
1796     {
1797       char buf[MAX_REGISTER_RAW_SIZE];
1798
1799       store_unsigned_integer (buf, REGISTER_RAW_SIZE (PC_REGNUM), rpc);
1800       supply_register (PC_REGNUM, buf);
1801
1802       store_unsigned_integer (buf, REGISTER_RAW_SIZE (PC_REGNUM), rfp);
1803       supply_register (30, buf);        /* This register they are avoiding and so it is unnamed */
1804
1805       store_unsigned_integer (buf, REGISTER_RAW_SIZE (SP_REGNUM), rsp);
1806       supply_register (SP_REGNUM, buf);
1807
1808       store_unsigned_integer (buf, REGISTER_RAW_SIZE (FP_REGNUM), 0);
1809       supply_register (FP_REGNUM, buf);
1810
1811       if (nfields == 9)
1812         {
1813           int i;
1814
1815           for (i = 0; i <= 2; i++)
1816             if (flags[i] == 'r' || flags[i] == 'w')
1817               hit_watchpoint = 1;
1818             else if (flags[i] == '\000')
1819               break;
1820         }
1821     }
1822
1823   if (strcmp (target_shortname, "lsi") == 0)
1824     {
1825 #if 0
1826       /* If this is an LSI PMON target, see if we just hit a hardrdware watchpoint.
1827          Right now, PMON doesn't give us enough information to determine which
1828          breakpoint we hit.  So we have to look up the PC in our own table
1829          of breakpoints, and if found, assume it's just a normal instruction
1830          fetch breakpoint, not a data watchpoint.  FIXME when PMON
1831          provides some way to tell us what type of breakpoint it is.  */
1832       int i;
1833       CORE_ADDR pc = read_pc ();
1834
1835       hit_watchpoint = 1;
1836       for (i = 0; i < MAX_LSI_BREAKPOINTS; i++)
1837         {
1838           if (lsi_breakpoints[i].addr == pc
1839               && lsi_breakpoints[i].type == BREAK_FETCH)
1840             {
1841               hit_watchpoint = 0;
1842               break;
1843             }
1844         }
1845 #else
1846       /* If a data breakpoint was hit, PMON returns the following packet:
1847          0x1 c 0x0 0x57f 0x1
1848          The return packet from an ordinary breakpoint doesn't have the
1849          extra 0x01 field tacked onto the end.  */
1850       if (nfields == 1 && rpc == 1)
1851         hit_watchpoint = 1;
1852 #endif
1853     }
1854
1855   /* NOTE: The following (sig) numbers are defined by PMON:
1856      SPP_SIGTRAP     5       breakpoint
1857      SPP_SIGINT      2
1858      SPP_SIGSEGV     11
1859      SPP_SIGBUS      10
1860      SPP_SIGILL      4
1861      SPP_SIGFPE      8
1862      SPP_SIGTERM     15 */
1863
1864   /* Translate a MIPS waitstatus.  We use constants here rather than WTERMSIG
1865      and so on, because the constants we want here are determined by the
1866      MIPS protocol and have nothing to do with what host we are running on.  */
1867   if ((rstatus & 0xff) == 0)
1868     {
1869       status->kind = TARGET_WAITKIND_EXITED;
1870       status->value.integer = (((rstatus) >> 8) & 0xff);
1871     }
1872   else if ((rstatus & 0xff) == 0x7f)
1873     {
1874       status->kind = TARGET_WAITKIND_STOPPED;
1875       status->value.sig = mips_signal_from_protocol (((rstatus) >> 8) & 0xff);
1876
1877       /* If the stop PC is in the _exit function, assume
1878          we hit the 'break 0x3ff' instruction in _exit, so this
1879          is not a normal breakpoint.  */
1880       if (strcmp (target_shortname, "lsi") == 0)
1881         {
1882           char *func_name;
1883           CORE_ADDR func_start;
1884           CORE_ADDR pc = read_pc ();
1885
1886           find_pc_partial_function (pc, &func_name, &func_start, NULL);
1887           if (func_name != NULL && strcmp (func_name, "_exit") == 0
1888               && func_start == pc)
1889             status->kind = TARGET_WAITKIND_EXITED;
1890         }
1891     }
1892   else
1893     {
1894       status->kind = TARGET_WAITKIND_SIGNALLED;
1895       status->value.sig = mips_signal_from_protocol (rstatus & 0x7f);
1896     }
1897
1898   return 0;
1899 }
1900
1901 /* We have to map between the register numbers used by gdb and the
1902    register numbers used by the debugging protocol.  This function
1903    assumes that we are using tm-mips.h.  */
1904
1905 #define REGNO_OFFSET 96
1906
1907 static int
1908 mips_map_regno (int regno)
1909 {
1910   if (regno < 32)
1911     return regno;
1912   if (regno >= FP0_REGNUM && regno < FP0_REGNUM + 32)
1913     return regno - FP0_REGNUM + 32;
1914   switch (regno)
1915     {
1916     case PC_REGNUM:
1917       return REGNO_OFFSET + 0;
1918     case CAUSE_REGNUM:
1919       return REGNO_OFFSET + 1;
1920     case HI_REGNUM:
1921       return REGNO_OFFSET + 2;
1922     case LO_REGNUM:
1923       return REGNO_OFFSET + 3;
1924     case FCRCS_REGNUM:
1925       return REGNO_OFFSET + 4;
1926     case FCRIR_REGNUM:
1927       return REGNO_OFFSET + 5;
1928     default:
1929       /* FIXME: Is there a way to get the status register?  */
1930       return 0;
1931     }
1932 }
1933
1934 /* Fetch the remote registers.  */
1935
1936 static void
1937 mips_fetch_registers (int regno)
1938 {
1939   unsigned LONGEST val;
1940   int err;
1941
1942   if (regno == -1)
1943     {
1944       for (regno = 0; regno < NUM_REGS; regno++)
1945         mips_fetch_registers (regno);
1946       return;
1947     }
1948
1949   if (regno == FP_REGNUM || regno == ZERO_REGNUM)
1950     /* FP_REGNUM on the mips is a hack which is just supposed to read
1951        zero (see also mips-nat.c).  */
1952     val = 0;
1953   else
1954     {
1955       /* If PMON doesn't support this register, don't waste serial
1956          bandwidth trying to read it.  */
1957       int pmon_reg = mips_map_regno (regno);
1958       if (regno != 0 && pmon_reg == 0)
1959         val = 0;
1960       else
1961         {
1962           /* Unfortunately the PMON version in the Vr4300 board has been
1963              compiled without the 64bit register access commands. This
1964              means we cannot get hold of the full register width. */
1965           if (mips_monitor == MON_DDB)
1966             val = (unsigned) mips_request ('t', pmon_reg, 0,
1967                                            &err, mips_receive_wait, NULL);
1968           else
1969             val = mips_request ('r', pmon_reg, 0,
1970                                 &err, mips_receive_wait, NULL);
1971           if (err)
1972             mips_error ("Can't read register %d: %s", regno,
1973                         safe_strerror (errno));
1974         }
1975     }
1976
1977   {
1978     char buf[MAX_REGISTER_RAW_SIZE];
1979
1980     /* We got the number the register holds, but gdb expects to see a
1981        value in the target byte ordering.  */
1982     store_unsigned_integer (buf, REGISTER_RAW_SIZE (regno), val);
1983     supply_register (regno, buf);
1984   }
1985 }
1986
1987 /* Prepare to store registers.  The MIPS protocol can store individual
1988    registers, so this function doesn't have to do anything.  */
1989
1990 static void
1991 mips_prepare_to_store (void)
1992 {
1993 }
1994
1995 /* Store remote register(s).  */
1996
1997 static void
1998 mips_store_registers (int regno)
1999 {
2000   int err;
2001
2002   if (regno == -1)
2003     {
2004       for (regno = 0; regno < NUM_REGS; regno++)
2005         mips_store_registers (regno);
2006       return;
2007     }
2008
2009   mips_request ('R', mips_map_regno (regno),
2010                 read_register (regno),
2011                 &err, mips_receive_wait, NULL);
2012   if (err)
2013     mips_error ("Can't write register %d: %s", regno, safe_strerror (errno));
2014 }
2015
2016 /* Fetch a word from the target board.  */
2017
2018 static unsigned int
2019 mips_fetch_word (CORE_ADDR addr)
2020 {
2021   unsigned int val;
2022   int err;
2023
2024   val = mips_request ('d', addr, 0, &err, mips_receive_wait, NULL);
2025   if (err)
2026     {
2027       /* Data space failed; try instruction space.  */
2028       val = mips_request ('i', addr, 0, &err,
2029                           mips_receive_wait, NULL);
2030       if (err)
2031         mips_error ("Can't read address 0x%s: %s",
2032                     paddr_nz (addr), safe_strerror (errno));
2033     }
2034   return val;
2035 }
2036
2037 /* Store a word to the target board.  Returns errno code or zero for
2038    success.  If OLD_CONTENTS is non-NULL, put the old contents of that
2039    memory location there.  */
2040
2041 /* FIXME! make sure only 32-bit quantities get stored! */
2042 static int
2043 mips_store_word (CORE_ADDR addr, unsigned int val, char *old_contents)
2044 {
2045   int err;
2046   unsigned int oldcontents;
2047
2048   oldcontents = mips_request ('D', addr, val, &err,
2049                               mips_receive_wait, NULL);
2050   if (err)
2051     {
2052       /* Data space failed; try instruction space.  */
2053       oldcontents = mips_request ('I', addr, val, &err,
2054                                   mips_receive_wait, NULL);
2055       if (err)
2056         return errno;
2057     }
2058   if (old_contents != NULL)
2059     store_unsigned_integer (old_contents, 4, oldcontents);
2060   return 0;
2061 }
2062
2063 /* Read or write LEN bytes from inferior memory at MEMADDR,
2064    transferring to or from debugger address MYADDR.  Write to inferior
2065    if SHOULD_WRITE is nonzero.  Returns length of data written or
2066    read; 0 for error.  Note that protocol gives us the correct value
2067    for a longword, since it transfers values in ASCII.  We want the
2068    byte values, so we have to swap the longword values.  */
2069
2070 static int mask_address_p = 1;
2071
2072 static int
2073 mips_xfer_memory (CORE_ADDR memaddr, char *myaddr, int len, int write,
2074                   struct mem_attrib *attrib ATTRIBUTE_UNUSED,
2075                   struct target_ops *target ATTRIBUTE_UNUSED)
2076 {
2077   int i;
2078   CORE_ADDR addr;
2079   int count;
2080   char *buffer;
2081   int status;
2082
2083   /* PMON targets do not cope well with 64 bit addresses.  Mask the
2084      value down to 32 bits. */
2085   if (mask_address_p)
2086     memaddr &= (CORE_ADDR) 0xffffffff;
2087
2088   /* Round starting address down to longword boundary.  */
2089   addr = memaddr & ~3;
2090   /* Round ending address up; get number of longwords that makes.  */
2091   count = (((memaddr + len) - addr) + 3) / 4;
2092   /* Allocate buffer of that many longwords.  */
2093   buffer = alloca (count * 4);
2094
2095   if (write)
2096     {
2097       /* Fill start and end extra bytes of buffer with existing data.  */
2098       if (addr != memaddr || len < 4)
2099         {
2100           /* Need part of initial word -- fetch it.  */
2101           store_unsigned_integer (&buffer[0], 4, mips_fetch_word (addr));
2102         }
2103
2104       if (count > 1)
2105         {
2106           /* Need part of last word -- fetch it.  FIXME: we do this even
2107              if we don't need it.  */
2108           store_unsigned_integer (&buffer[(count - 1) * 4], 4,
2109                                   mips_fetch_word (addr + (count - 1) * 4));
2110         }
2111
2112       /* Copy data to be written over corresponding part of buffer */
2113
2114       memcpy ((char *) buffer + (memaddr & 3), myaddr, len);
2115
2116       /* Write the entire buffer.  */
2117
2118       for (i = 0; i < count; i++, addr += 4)
2119         {
2120           status = mips_store_word (addr,
2121                                extract_unsigned_integer (&buffer[i * 4], 4),
2122                                     NULL);
2123           /* Report each kilobyte (we download 32-bit words at a time) */
2124           if (i % 256 == 255)
2125             {
2126               printf_unfiltered ("*");
2127               gdb_flush (gdb_stdout);
2128             }
2129           if (status)
2130             {
2131               errno = status;
2132               return 0;
2133             }
2134           /* FIXME: Do we want a QUIT here?  */
2135         }
2136       if (count >= 256)
2137         printf_unfiltered ("\n");
2138     }
2139   else
2140     {
2141       /* Read all the longwords */
2142       for (i = 0; i < count; i++, addr += 4)
2143         {
2144           store_unsigned_integer (&buffer[i * 4], 4, mips_fetch_word (addr));
2145           QUIT;
2146         }
2147
2148       /* Copy appropriate bytes out of the buffer.  */
2149       memcpy (myaddr, buffer + (memaddr & 3), len);
2150     }
2151   return len;
2152 }
2153
2154 /* Print info on this target.  */
2155
2156 static void
2157 mips_files_info (struct target_ops *ignore)
2158 {
2159   printf_unfiltered ("Debugging a MIPS board over a serial line.\n");
2160 }
2161
2162 /* Kill the process running on the board.  This will actually only
2163    work if we are doing remote debugging over the console input.  I
2164    think that if IDT/sim had the remote debug interrupt enabled on the
2165    right port, we could interrupt the process with a break signal.  */
2166
2167 static void
2168 mips_kill (void)
2169 {
2170   if (!mips_wait_flag)
2171     return;
2172
2173   interrupt_count++;
2174
2175   if (interrupt_count >= 2)
2176     {
2177       interrupt_count = 0;
2178
2179       target_terminal_ours ();
2180
2181       if (query ("Interrupted while waiting for the program.\n\
2182 Give up (and stop debugging it)? "))
2183         {
2184           /* Clean up in such a way that mips_close won't try to talk to the
2185              board (it almost surely won't work since we weren't able to talk to
2186              it).  */
2187           mips_wait_flag = 0;
2188           close_ports ();
2189
2190           printf_unfiltered ("Ending remote MIPS debugging.\n");
2191           target_mourn_inferior ();
2192
2193           return_to_top_level (RETURN_QUIT);
2194         }
2195
2196       target_terminal_inferior ();
2197     }
2198
2199   if (remote_debug > 0)
2200     printf_unfiltered ("Sending break\n");
2201
2202   SERIAL_SEND_BREAK (mips_desc);
2203
2204 #if 0
2205   if (mips_is_open)
2206     {
2207       char cc;
2208
2209       /* Send a ^C.  */
2210       cc = '\003';
2211       SERIAL_WRITE (mips_desc, &cc, 1);
2212       sleep (1);
2213       target_mourn_inferior ();
2214     }
2215 #endif
2216 }
2217
2218 /* Start running on the target board.  */
2219
2220 static void
2221 mips_create_inferior (char *execfile, char *args, char **env)
2222 {
2223   CORE_ADDR entry_pt;
2224
2225   if (args && *args)
2226     {
2227       warning ("\
2228 Can't pass arguments to remote MIPS board; arguments ignored.");
2229       /* And don't try to use them on the next "run" command.  */
2230       execute_command ("set args", 0);
2231     }
2232
2233   if (execfile == 0 || exec_bfd == 0)
2234     error ("No executable file specified");
2235
2236   entry_pt = (CORE_ADDR) bfd_get_start_address (exec_bfd);
2237
2238   init_wait_for_inferior ();
2239
2240   /* FIXME: Should we set inferior_pid here?  */
2241
2242   proceed (entry_pt, TARGET_SIGNAL_DEFAULT, 0);
2243 }
2244
2245 /* Clean up after a process.  Actually nothing to do.  */
2246
2247 static void
2248 mips_mourn_inferior (void)
2249 {
2250   if (current_ops != NULL)
2251     unpush_target (current_ops);
2252   generic_mourn_inferior ();
2253 }
2254 \f
2255 /* We can write a breakpoint and read the shadow contents in one
2256    operation.  */
2257
2258 /* Insert a breakpoint.  On targets that don't have built-in breakpoint
2259    support, we read the contents of the target location and stash it,
2260    then overwrite it with a breakpoint instruction.  ADDR is the target
2261    location in the target machine.  CONTENTS_CACHE is a pointer to 
2262    memory allocated for saving the target contents.  It is guaranteed
2263    by the caller to be long enough to save sizeof BREAKPOINT bytes (this
2264    is accomplished via BREAKPOINT_MAX).  */
2265
2266 static int
2267 mips_insert_breakpoint (CORE_ADDR addr, char *contents_cache)
2268 {
2269   if (monitor_supports_breakpoints)
2270     return set_breakpoint (addr, MIPS_INSTLEN, BREAK_FETCH);
2271   else
2272     return memory_insert_breakpoint (addr, contents_cache);
2273 }
2274
2275 static int
2276 mips_remove_breakpoint (CORE_ADDR addr, char *contents_cache)
2277 {
2278   if (monitor_supports_breakpoints)
2279     return clear_breakpoint (addr, MIPS_INSTLEN, BREAK_FETCH);
2280   else
2281     return memory_remove_breakpoint (addr, contents_cache);
2282 }
2283
2284 #if 0                           /* currently not used */
2285 /* PMON does not currently provide support for the debug mode 'b'
2286    commands to manipulate breakpoints. However, if we wanted to use
2287    the monitor breakpoints (rather than the GDB BREAK_INSN version)
2288    then this code performs the work needed to leave debug mode,
2289    set/clear the breakpoint, and then return to debug mode. */
2290
2291 #define PMON_MAX_BP (33)        /* 32 SW, 1 HW */
2292 static CORE_ADDR mips_pmon_bp_info[PMON_MAX_BP];
2293 /* NOTE: The code relies on this vector being zero-initialised by the system */
2294
2295 static int
2296 pmon_insert_breakpoint (CORE_ADDR addr, char *contents_cache)
2297 {
2298   int status;
2299
2300   if (monitor_supports_breakpoints)
2301     {
2302       char tbuff[12];           /* space for breakpoint command */
2303       int bpnum;
2304       CORE_ADDR bpaddr;
2305
2306       /* PMON does not support debug level breakpoint set/remove: */
2307       if (mips_exit_debug ())
2308         mips_error ("Failed to exit debug mode");
2309
2310       sprintf (tbuff, "b %08x\r", addr);
2311       mips_send_command (tbuff, 0);
2312
2313       mips_expect ("Bpt ");
2314
2315       if (!mips_getstring (tbuff, remote_timeout))
2316         return 1;
2317       tbuff[2] = '\0';          /* terminate the string */
2318       if (sscanf (tbuff, "%d", &bpnum) != 1)
2319         {
2320           fprintf_unfiltered (gdb_stderr,
2321               "Invalid decimal breakpoint number from target: %s\n", tbuff);
2322           return 1;
2323         }
2324
2325       mips_expect (" = ");
2326
2327       /* Lead in the hex number we are expecting: */
2328       tbuff[0] = '0';
2329       tbuff[1] = 'x';
2330
2331       /* FIXME!! only 8 bytes!  need to expand for Bfd64; 
2332          which targets return 64-bit addresses?  PMON returns only 32! */
2333       if (!mips_getstring (&tbuff[2], 8))
2334         return 1;
2335       tbuff[10] = '\0';         /* terminate the string */
2336
2337       if (sscanf (tbuff, "0x%08x", &bpaddr) != 1)
2338         {
2339           fprintf_unfiltered (gdb_stderr,
2340                             "Invalid hex address from target: %s\n", tbuff);
2341           return 1;
2342         }
2343
2344       if (bpnum >= PMON_MAX_BP)
2345         {
2346           fprintf_unfiltered (gdb_stderr,
2347                               "Error: Returned breakpoint number %d outside acceptable range (0..%d)\n",
2348                               bpnum, PMON_MAX_BP - 1);
2349           return 1;
2350         }
2351
2352       if (bpaddr != addr)
2353         fprintf_unfiltered (gdb_stderr, "Warning: Breakpoint addresses do not match: 0x%x != 0x%x\n", addr, bpaddr);
2354
2355       mips_pmon_bp_info[bpnum] = bpaddr;
2356
2357       mips_expect ("\r\n");
2358       mips_expect (mips_monitor_prompt);
2359
2360       mips_enter_debug ();
2361
2362       return 0;
2363     }
2364
2365   return mips_store_word (addr, BREAK_INSN, contents_cache);
2366 }
2367
2368 static int
2369 pmon_remove_breakpoint (CORE_ADDR addr, char *contents_cache)
2370 {
2371   if (monitor_supports_breakpoints)
2372     {
2373       int bpnum;
2374       char tbuff[7];            /* enough for delete breakpoint command */
2375
2376       for (bpnum = 0; bpnum < PMON_MAX_BP; bpnum++)
2377         if (mips_pmon_bp_info[bpnum] == addr)
2378           break;
2379
2380       if (bpnum >= PMON_MAX_BP)
2381         {
2382           fprintf_unfiltered (gdb_stderr,
2383                               "pmon_remove_breakpoint: Failed to find breakpoint at address 0x%s\n",
2384                               paddr_nz (addr));
2385           return 1;
2386         }
2387
2388       if (mips_exit_debug ())
2389         mips_error ("Failed to exit debug mode");
2390
2391       sprintf (tbuff, "db %02d\r", bpnum);
2392
2393       mips_send_command (tbuff, -1);
2394       /* NOTE: If the breakpoint does not exist then a "Bpt <dd> not
2395          set" message will be returned. */
2396
2397       mips_enter_debug ();
2398
2399       return 0;
2400     }
2401
2402   return target_write_memory (addr, contents_cache, BREAK_INSN_SIZE);
2403 }
2404 #endif
2405
2406
2407 /* Tell whether this target can support a hardware breakpoint.  CNT
2408    is the number of hardware breakpoints already installed.  This
2409    implements the TARGET_CAN_USE_HARDWARE_WATCHPOINT macro.  */
2410
2411 int
2412 remote_mips_can_use_hardware_watchpoint (int cnt)
2413 {
2414   return cnt < MAX_LSI_BREAKPOINTS && strcmp (target_shortname, "lsi") == 0;
2415 }
2416
2417
2418 /* Compute a don't care mask for the region bounding ADDR and ADDR + LEN - 1.
2419    This is used for memory ref breakpoints.  */
2420
2421 static unsigned long
2422 calculate_mask (CORE_ADDR addr, int len)
2423 {
2424   unsigned long mask;
2425   int i;
2426
2427   mask = addr ^ (addr + len - 1);
2428
2429   for (i = 32; i >= 0; i--)
2430     if (mask == 0)
2431       break;
2432     else
2433       mask >>= 1;
2434
2435   mask = (unsigned long) 0xffffffff >> i;
2436
2437   return mask;
2438 }
2439
2440
2441 /* Insert a hardware breakpoint.  This works only on LSI targets, which
2442    implement ordinary breakpoints using hardware facilities.  */
2443
2444 int
2445 remote_mips_insert_hw_breakpoint (CORE_ADDR addr, char *contents_cache)
2446 {
2447   if (strcmp (target_shortname, "lsi") == 0)
2448     return mips_insert_breakpoint (addr, contents_cache);
2449   else
2450     return -1;
2451 }
2452
2453
2454 /* Remove a hardware breakpoint.  This works only on LSI targets, which
2455    implement ordinary breakpoints using hardware facilities.  */
2456
2457 int
2458 remote_mips_remove_hw_breakpoint (CORE_ADDR addr, char *contents_cache)
2459 {
2460   if (strcmp (target_shortname, "lsi") == 0)
2461     return mips_remove_breakpoint (addr, contents_cache);
2462   else
2463     return -1;
2464 }
2465
2466 /* Set a data watchpoint.  ADDR and LEN should be obvious.  TYPE is 0
2467    for a write watchpoint, 1 for a read watchpoint, or 2 for a read/write
2468    watchpoint. */
2469
2470 int
2471 remote_mips_set_watchpoint (CORE_ADDR addr, int len, int type)
2472 {
2473   if (set_breakpoint (addr, len, type))
2474     return -1;
2475
2476   return 0;
2477 }
2478
2479 int
2480 remote_mips_remove_watchpoint (CORE_ADDR addr, int len, int type)
2481 {
2482   if (clear_breakpoint (addr, len, type))
2483     return -1;
2484
2485   return 0;
2486 }
2487
2488 int
2489 remote_mips_stopped_by_watchpoint (void)
2490 {
2491   return hit_watchpoint;
2492 }
2493
2494
2495 /* Insert a breakpoint.  */
2496
2497 static int
2498 set_breakpoint (CORE_ADDR addr, int len, enum break_type type)
2499 {
2500   return common_breakpoint (1, addr, len, type);
2501 }
2502
2503
2504 /* Clear a breakpoint.  */
2505
2506 static int
2507 clear_breakpoint (CORE_ADDR addr, int len, enum break_type type)
2508 {
2509   return common_breakpoint (0, addr, len, type);
2510 }
2511
2512
2513 /* Check the error code from the return packet for an LSI breakpoint
2514    command.  If there's no error, just return 0.  If it's a warning,
2515    print the warning text and return 0.  If it's an error, print
2516    the error text and return 1.  <ADDR> is the address of the breakpoint
2517    that was being set.  <RERRFLG> is the error code returned by PMON. 
2518    This is a helper function for common_breakpoint.  */
2519
2520 static int
2521 check_lsi_error (CORE_ADDR addr, int rerrflg)
2522 {
2523   struct lsi_error *err;
2524   char *saddr = paddr_nz (addr);        /* printable address string */
2525
2526   if (rerrflg == 0)             /* no error */
2527     return 0;
2528
2529   /* Warnings can be ORed together, so check them all.  */
2530   if (rerrflg & W_WARN)
2531     {
2532       if (monitor_warnings)
2533         {
2534           int found = 0;
2535           for (err = lsi_warning_table; err->code != 0; err++)
2536             {
2537               if ((err->code & rerrflg) == err->code)
2538                 {
2539                   found = 1;
2540                   fprintf_unfiltered (gdb_stderr,
2541                                   "common_breakpoint (0x%s): Warning: %s\n",
2542                                       saddr,
2543                                       err->string);
2544                 }
2545             }
2546           if (!found)
2547             fprintf_unfiltered (gdb_stderr,
2548                         "common_breakpoint (0x%s): Unknown warning: 0x%x\n",
2549                                 saddr,
2550                                 rerrflg);
2551         }
2552       return 0;
2553     }
2554
2555   /* Errors are unique, i.e. can't be ORed together.  */
2556   for (err = lsi_error_table; err->code != 0; err++)
2557     {
2558       if ((err->code & rerrflg) == err->code)
2559         {
2560           fprintf_unfiltered (gdb_stderr,
2561                               "common_breakpoint (0x%s): Error: %s\n",
2562                               saddr,
2563                               err->string);
2564           return 1;
2565         }
2566     }
2567   fprintf_unfiltered (gdb_stderr,
2568                       "common_breakpoint (0x%s): Unknown error: 0x%x\n",
2569                       saddr,
2570                       rerrflg);
2571   return 1;
2572 }
2573
2574
2575 /* This routine sends a breakpoint command to the remote target.
2576
2577    <SET> is 1 if setting a breakpoint, or 0 if clearing a breakpoint.
2578    <ADDR> is the address of the breakpoint.
2579    <LEN> the length of the region to break on.
2580    <TYPE> is the type of breakpoint:
2581    0 = write                    (BREAK_WRITE)
2582    1 = read                     (BREAK_READ)
2583    2 = read/write               (BREAK_ACCESS)
2584    3 = instruction fetch        (BREAK_FETCH)
2585
2586    Return 0 if successful; otherwise 1.  */
2587
2588 static int
2589 common_breakpoint (int set, CORE_ADDR addr, int len, enum break_type type)
2590 {
2591   char buf[DATA_MAXLEN + 1];
2592   char cmd, rcmd;
2593   int rpid, rerrflg, rresponse, rlen;
2594   int nfields;
2595
2596   addr = ADDR_BITS_REMOVE (addr);
2597
2598   if (mips_monitor == MON_LSI)
2599     {
2600       if (set == 0)             /* clear breakpoint */
2601         {
2602           /* The LSI PMON "clear breakpoint" has this form:
2603              <pid> 'b' <bptn> 0x0
2604              reply:
2605              <pid> 'b' 0x0 <code>
2606
2607              <bptn> is a breakpoint number returned by an earlier 'B' command.
2608              Possible return codes: OK, E_BPT.  */
2609
2610           int i;
2611
2612           /* Search for the breakpoint in the table.  */
2613           for (i = 0; i < MAX_LSI_BREAKPOINTS; i++)
2614             if (lsi_breakpoints[i].type == type
2615                 && lsi_breakpoints[i].addr == addr
2616                 && lsi_breakpoints[i].len == len)
2617               break;
2618
2619           /* Clear the table entry and tell PMON to clear the breakpoint.  */
2620           if (i == MAX_LSI_BREAKPOINTS)
2621             {
2622               warning ("common_breakpoint: Attempt to clear bogus breakpoint at %s\n",
2623                        paddr_nz (addr));
2624               return 1;
2625             }
2626
2627           lsi_breakpoints[i].type = BREAK_UNUSED;
2628           sprintf (buf, "0x0 b 0x%x 0x0", i);
2629           mips_send_packet (buf, 1);
2630
2631           rlen = mips_receive_packet (buf, 1, mips_receive_wait);
2632           buf[rlen] = '\0';
2633
2634           nfields = sscanf (buf, "0x%x b 0x0 0x%x", &rpid, &rerrflg);
2635           if (nfields != 2)
2636             mips_error ("common_breakpoint: Bad response from remote board: %s", buf);
2637
2638           return (check_lsi_error (addr, rerrflg));
2639         }
2640       else
2641         /* set a breakpoint */
2642         {
2643           /* The LSI PMON "set breakpoint" command has this form:
2644              <pid> 'B' <addr> 0x0
2645              reply:
2646              <pid> 'B' <bptn> <code>
2647
2648              The "set data breakpoint" command has this form:
2649
2650              <pid> 'A' <addr1> <type> [<addr2>  [<value>]]
2651
2652              where: type= "0x1" = read
2653              "0x2" = write
2654              "0x3" = access (read or write)
2655
2656              The reply returns two values:
2657              bptn - a breakpoint number, which is a small integer with
2658              possible values of zero through 255.
2659              code - an error return code, a value of zero indicates a
2660              succesful completion, other values indicate various
2661              errors and warnings.
2662
2663              Possible return codes: OK, W_QAL, E_QAL, E_OUT, E_NON.  
2664
2665            */
2666
2667           if (type == BREAK_FETCH)      /* instruction breakpoint */
2668             {
2669               cmd = 'B';
2670               sprintf (buf, "0x0 B 0x%s 0x0", paddr_nz (addr));
2671             }
2672           else
2673             /* watchpoint */
2674             {
2675               cmd = 'A';
2676               sprintf (buf, "0x0 A 0x%s 0x%x 0x%s", paddr_nz (addr),
2677                      type == BREAK_READ ? 1 : (type == BREAK_WRITE ? 2 : 3),
2678                        paddr_nz (addr + len - 1));
2679             }
2680           mips_send_packet (buf, 1);
2681
2682           rlen = mips_receive_packet (buf, 1, mips_receive_wait);
2683           buf[rlen] = '\0';
2684
2685           nfields = sscanf (buf, "0x%x %c 0x%x 0x%x",
2686                             &rpid, &rcmd, &rresponse, &rerrflg);
2687           if (nfields != 4 || rcmd != cmd || rresponse > 255)
2688             mips_error ("common_breakpoint: Bad response from remote board: %s", buf);
2689
2690           if (rerrflg != 0)
2691             if (check_lsi_error (addr, rerrflg))
2692               return 1;
2693
2694           /* rresponse contains PMON's breakpoint number.  Record the
2695              information for this breakpoint so we can clear it later.  */
2696           lsi_breakpoints[rresponse].type = type;
2697           lsi_breakpoints[rresponse].addr = addr;
2698           lsi_breakpoints[rresponse].len = len;
2699
2700           return 0;
2701         }
2702     }
2703   else
2704     {
2705       /* On non-LSI targets, the breakpoint command has this form:
2706          0x0 <CMD> <ADDR> <MASK> <FLAGS>
2707          <MASK> is a don't care mask for addresses.
2708          <FLAGS> is any combination of `r', `w', or `f' for read/write/fetch.
2709        */
2710       unsigned long mask;
2711
2712       mask = calculate_mask (addr, len);
2713       addr &= ~mask;
2714
2715       if (set)                  /* set a breakpoint */
2716         {
2717           char *flags;
2718           switch (type)
2719             {
2720             case BREAK_WRITE:   /* write */
2721               flags = "w";
2722               break;
2723             case BREAK_READ:    /* read */
2724               flags = "r";
2725               break;
2726             case BREAK_ACCESS:  /* read/write */
2727               flags = "rw";
2728               break;
2729             case BREAK_FETCH:   /* fetch */
2730               flags = "f";
2731               break;
2732             default:
2733               abort ();
2734             }
2735
2736           cmd = 'B';
2737           sprintf (buf, "0x0 B 0x%s 0x%s %s", paddr_nz (addr),
2738                    paddr_nz (mask), flags);
2739         }
2740       else
2741         {
2742           cmd = 'b';
2743           sprintf (buf, "0x0 b 0x%s", paddr_nz (addr));
2744         }
2745
2746       mips_send_packet (buf, 1);
2747
2748       rlen = mips_receive_packet (buf, 1, mips_receive_wait);
2749       buf[rlen] = '\0';
2750
2751       nfields = sscanf (buf, "0x%x %c 0x%x 0x%x",
2752                         &rpid, &rcmd, &rerrflg, &rresponse);
2753
2754       if (nfields != 4 || rcmd != cmd)
2755         mips_error ("common_breakpoint: Bad response from remote board: %s",
2756                     buf);
2757
2758       if (rerrflg != 0)
2759         {
2760           /* Ddb returns "0x0 b 0x16 0x0\000", whereas
2761              Cogent returns "0x0 b 0xffffffff 0x16\000": */
2762           if (mips_monitor == MON_DDB)
2763             rresponse = rerrflg;
2764           if (rresponse != 22)  /* invalid argument */
2765             fprintf_unfiltered (gdb_stderr,
2766                              "common_breakpoint (0x%s):  Got error: 0x%x\n",
2767                                 paddr_nz (addr), rresponse);
2768           return 1;
2769         }
2770     }
2771   return 0;
2772 }
2773 \f
2774 static void
2775 send_srec (char *srec, int len, CORE_ADDR addr)
2776 {
2777   while (1)
2778     {
2779       int ch;
2780
2781       SERIAL_WRITE (mips_desc, srec, len);
2782
2783       ch = mips_readchar (remote_timeout);
2784
2785       switch (ch)
2786         {
2787         case SERIAL_TIMEOUT:
2788           error ("Timeout during download.");
2789           break;
2790         case 0x6:               /* ACK */
2791           return;
2792         case 0x15:              /* NACK */
2793           fprintf_unfiltered (gdb_stderr, "Download got a NACK at byte %s!  Retrying.\n", paddr_u (addr));
2794           continue;
2795         default:
2796           error ("Download got unexpected ack char: 0x%x, retrying.\n", ch);
2797         }
2798     }
2799 }
2800
2801 /*  Download a binary file by converting it to S records. */
2802
2803 static void
2804 mips_load_srec (char *args)
2805 {
2806   bfd *abfd;
2807   asection *s;
2808   char *buffer, srec[1024];
2809   unsigned int i;
2810   unsigned int srec_frame = 200;
2811   int reclen;
2812   static int hashmark = 1;
2813
2814   buffer = alloca (srec_frame * 2 + 256);
2815
2816   abfd = bfd_openr (args, 0);
2817   if (!abfd)
2818     {
2819       printf_filtered ("Unable to open file %s\n", args);
2820       return;
2821     }
2822
2823   if (bfd_check_format (abfd, bfd_object) == 0)
2824     {
2825       printf_filtered ("File is not an object file\n");
2826       return;
2827     }
2828
2829 /* This actually causes a download in the IDT binary format: */
2830   mips_send_command (LOAD_CMD, 0);
2831
2832   for (s = abfd->sections; s; s = s->next)
2833     {
2834       if (s->flags & SEC_LOAD)
2835         {
2836           unsigned int numbytes;
2837
2838           /* FIXME!  vma too small????? */
2839           printf_filtered ("%s\t: 0x%4lx .. 0x%4lx  ", s->name,
2840                            (long) s->vma,
2841                            (long) (s->vma + s->_raw_size));
2842           gdb_flush (gdb_stdout);
2843
2844           for (i = 0; i < s->_raw_size; i += numbytes)
2845             {
2846               numbytes = min (srec_frame, s->_raw_size - i);
2847
2848               bfd_get_section_contents (abfd, s, buffer, i, numbytes);
2849
2850               reclen = mips_make_srec (srec, '3', s->vma + i, buffer, numbytes);
2851               send_srec (srec, reclen, s->vma + i);
2852
2853               if (hashmark)
2854                 {
2855                   putchar_unfiltered ('#');
2856                   gdb_flush (gdb_stdout);
2857                 }
2858
2859             }                   /* Per-packet (or S-record) loop */
2860
2861           putchar_unfiltered ('\n');
2862         }                       /* Loadable sections */
2863     }
2864   if (hashmark)
2865     putchar_unfiltered ('\n');
2866
2867   /* Write a type 7 terminator record. no data for a type 7, and there
2868      is no data, so len is 0.  */
2869
2870   reclen = mips_make_srec (srec, '7', abfd->start_address, NULL, 0);
2871
2872   send_srec (srec, reclen, abfd->start_address);
2873
2874   SERIAL_FLUSH_INPUT (mips_desc);
2875 }
2876
2877 /*
2878  * mips_make_srec -- make an srecord. This writes each line, one at a
2879  *      time, each with it's own header and trailer line.
2880  *      An srecord looks like this:
2881  *
2882  * byte count-+     address
2883  * start ---+ |        |       data        +- checksum
2884  *          | |        |                   |
2885  *        S01000006F6B692D746573742E73726563E4
2886  *        S315000448600000000000000000FC00005900000000E9
2887  *        S31A0004000023C1400037DE00F023604000377B009020825000348D
2888  *        S30B0004485A0000000000004E
2889  *        S70500040000F6
2890  *
2891  *      S<type><length><address><data><checksum>
2892  *
2893  *      Where
2894  *      - length
2895  *        is the number of bytes following upto the checksum. Note that
2896  *        this is not the number of chars following, since it takes two
2897  *        chars to represent a byte.
2898  *      - type
2899  *        is one of:
2900  *        0) header record
2901  *        1) two byte address data record
2902  *        2) three byte address data record
2903  *        3) four byte address data record
2904  *        7) four byte address termination record
2905  *        8) three byte address termination record
2906  *        9) two byte address termination record
2907  *       
2908  *      - address
2909  *        is the start address of the data following, or in the case of
2910  *        a termination record, the start address of the image
2911  *      - data
2912  *        is the data.
2913  *      - checksum
2914  *        is the sum of all the raw byte data in the record, from the length
2915  *        upwards, modulo 256 and subtracted from 255.
2916  *
2917  * This routine returns the length of the S-record.
2918  *
2919  */
2920
2921 static int
2922 mips_make_srec (char *buf, int type, CORE_ADDR memaddr, unsigned char *myaddr,
2923                 int len)
2924 {
2925   unsigned char checksum;
2926   int i;
2927
2928   /* Create the header for the srec. addr_size is the number of bytes in the address,
2929      and 1 is the number of bytes in the count.  */
2930
2931   /* FIXME!! bigger buf required for 64-bit! */
2932   buf[0] = 'S';
2933   buf[1] = type;
2934   buf[2] = len + 4 + 1;         /* len + 4 byte address + 1 byte checksum */
2935   /* This assumes S3 style downloads (4byte addresses). There should
2936      probably be a check, or the code changed to make it more
2937      explicit. */
2938   buf[3] = memaddr >> 24;
2939   buf[4] = memaddr >> 16;
2940   buf[5] = memaddr >> 8;
2941   buf[6] = memaddr;
2942   memcpy (&buf[7], myaddr, len);
2943
2944   /* Note that the checksum is calculated on the raw data, not the
2945      hexified data.  It includes the length, address and the data
2946      portions of the packet.  */
2947   checksum = 0;
2948   buf += 2;                     /* Point at length byte */
2949   for (i = 0; i < len + 4 + 1; i++)
2950     checksum += *buf++;
2951
2952   *buf = ~checksum;
2953
2954   return len + 8;
2955 }
2956
2957 /* The following manifest controls whether we enable the simple flow
2958    control support provided by the monitor. If enabled the code will
2959    wait for an affirmative ACK between transmitting packets. */
2960 #define DOETXACK (1)
2961
2962 /* The PMON fast-download uses an encoded packet format constructed of
2963    3byte data packets (encoded as 4 printable ASCII characters), and
2964    escape sequences (preceded by a '/'):
2965
2966    'K'     clear checksum
2967    'C'     compare checksum (12bit value, not included in checksum calculation)
2968    'S'     define symbol name (for addr) terminated with "," and padded to 4char boundary
2969    'Z'     zero fill multiple of 3bytes
2970    'B'     byte (12bit encoded value, of 8bit data)
2971    'A'     address (36bit encoded value)
2972    'E'     define entry as original address, and exit load
2973
2974    The packets are processed in 4 character chunks, so the escape
2975    sequences that do not have any data (or variable length data)
2976    should be padded to a 4 character boundary.  The decoder will give
2977    an error if the complete message block size is not a multiple of
2978    4bytes (size of record).
2979
2980    The encoding of numbers is done in 6bit fields.  The 6bit value is
2981    used to index into this string to get the specific character
2982    encoding for the value: */
2983 static char encoding[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789,.";
2984
2985 /* Convert the number of bits required into an encoded number, 6bits
2986    at a time (range 0..63).  Keep a checksum if required (passed
2987    pointer non-NULL). The function returns the number of encoded
2988    characters written into the buffer. */
2989 static int
2990 pmon_makeb64 (unsigned long v, char *p, int n, int *chksum)
2991 {
2992   int count = (n / 6);
2993
2994   if ((n % 12) != 0)
2995     {
2996       fprintf_unfiltered (gdb_stderr,
2997                           "Fast encoding bitcount must be a multiple of 12bits: %dbit%s\n", n, (n == 1) ? "" : "s");
2998       return (0);
2999     }
3000   if (n > 36)
3001     {
3002       fprintf_unfiltered (gdb_stderr,
3003                           "Fast encoding cannot process more than 36bits at the moment: %dbits\n", n);
3004       return (0);
3005     }
3006
3007   /* Deal with the checksum: */
3008   if (chksum != NULL)
3009     {
3010       switch (n)
3011         {
3012         case 36:
3013           *chksum += ((v >> 24) & 0xFFF);
3014         case 24:
3015           *chksum += ((v >> 12) & 0xFFF);
3016         case 12:
3017           *chksum += ((v >> 0) & 0xFFF);
3018         }
3019     }
3020
3021   do
3022     {
3023       n -= 6;
3024       *p++ = encoding[(v >> n) & 0x3F];
3025     }
3026   while (n > 0);
3027
3028   return (count);
3029 }
3030
3031 /* Shorthand function (that could be in-lined) to output the zero-fill
3032    escape sequence into the data stream. */
3033 static int
3034 pmon_zeroset (int recsize, char **buff, int *amount, unsigned int *chksum)
3035 {
3036   int count;
3037
3038   sprintf (*buff, "/Z");
3039   count = pmon_makeb64 (*amount, (*buff + 2), 12, chksum);
3040   *buff += (count + 2);
3041   *amount = 0;
3042   return (recsize + count + 2);
3043 }
3044
3045 static int
3046 pmon_checkset (int recsize, char **buff, int *value)
3047 {
3048   int count;
3049
3050   /* Add the checksum (without updating the value): */
3051   sprintf (*buff, "/C");
3052   count = pmon_makeb64 (*value, (*buff + 2), 12, NULL);
3053   *buff += (count + 2);
3054   sprintf (*buff, "\n");
3055   *buff += 2;                   /* include zero terminator */
3056   /* Forcing a checksum validation clears the sum: */
3057   *value = 0;
3058   return (recsize + count + 3);
3059 }
3060
3061 /* Amount of padding we leave after at the end of the output buffer,
3062    for the checksum and line termination characters: */
3063 #define CHECKSIZE (4 + 4 + 4 + 2)
3064 /* zero-fill, checksum, transfer end and line termination space. */
3065
3066 /* The amount of binary data loaded from the object file in a single
3067    operation: */
3068 #define BINCHUNK (1024)
3069
3070 /* Maximum line of data accepted by the monitor: */
3071 #define MAXRECSIZE (550)
3072 /* NOTE: This constant depends on the monitor being used. This value
3073    is for PMON 5.x on the Cogent Vr4300 board. */
3074
3075 static void
3076 pmon_make_fastrec (char **outbuf, unsigned char *inbuf, int *inptr,
3077                    int inamount, int *recsize, unsigned int *csum,
3078                    unsigned int *zerofill)
3079 {
3080   int count = 0;
3081   char *p = *outbuf;
3082
3083   /* This is a simple check to ensure that our data will fit within
3084      the maximum allowable record size. Each record output is 4bytes
3085      in length. We must allow space for a pending zero fill command,
3086      the record, and a checksum record. */
3087   while ((*recsize < (MAXRECSIZE - CHECKSIZE)) && ((inamount - *inptr) > 0))
3088     {
3089       /* Process the binary data: */
3090       if ((inamount - *inptr) < 3)
3091         {
3092           if (*zerofill != 0)
3093             *recsize = pmon_zeroset (*recsize, &p, zerofill, csum);
3094           sprintf (p, "/B");
3095           count = pmon_makeb64 (inbuf[*inptr], &p[2], 12, csum);
3096           p += (2 + count);
3097           *recsize += (2 + count);
3098           (*inptr)++;
3099         }
3100       else
3101         {
3102           unsigned int value = ((inbuf[*inptr + 0] << 16) | (inbuf[*inptr + 1] << 8) | inbuf[*inptr + 2]);
3103           /* Simple check for zero data. TODO: A better check would be
3104              to check the last, and then the middle byte for being zero
3105              (if the first byte is not). We could then check for
3106              following runs of zeros, and if above a certain size it is
3107              worth the 4 or 8 character hit of the byte insertions used
3108              to pad to the start of the zeroes. NOTE: This also depends
3109              on the alignment at the end of the zero run. */
3110           if (value == 0x00000000)
3111             {
3112               (*zerofill)++;
3113               if (*zerofill == 0xFFF)   /* 12bit counter */
3114                 *recsize = pmon_zeroset (*recsize, &p, zerofill, csum);
3115             }
3116           else
3117             {
3118               if (*zerofill != 0)
3119                 *recsize = pmon_zeroset (*recsize, &p, zerofill, csum);
3120               count = pmon_makeb64 (value, p, 24, csum);
3121               p += count;
3122               *recsize += count;
3123             }
3124           *inptr += 3;
3125         }
3126     }
3127
3128   *outbuf = p;
3129   return;
3130 }
3131
3132 static int
3133 pmon_check_ack (char *mesg)
3134 {
3135 #if defined(DOETXACK)
3136   int c;
3137
3138   if (!tftp_in_use)
3139     {
3140       c = SERIAL_READCHAR (udp_in_use ? udp_desc : mips_desc,
3141                            remote_timeout);
3142       if ((c == SERIAL_TIMEOUT) || (c != 0x06))
3143         {
3144           fprintf_unfiltered (gdb_stderr,
3145                               "Failed to receive valid ACK for %s\n", mesg);
3146           return (-1);          /* terminate the download */
3147         }
3148     }
3149 #endif /* DOETXACK */
3150   return (0);
3151 }
3152
3153 /* pmon_download - Send a sequence of characters to the PMON download port,
3154    which is either a serial port or a UDP socket.  */
3155
3156 static void
3157 pmon_start_download (void)
3158 {
3159   if (tftp_in_use)
3160     {
3161       /* Create the temporary download file.  */
3162       if ((tftp_file = fopen (tftp_localname, "w")) == NULL)
3163         perror_with_name (tftp_localname);
3164     }
3165   else
3166     {
3167       mips_send_command (udp_in_use ? LOAD_CMD_UDP : LOAD_CMD, 0);
3168       mips_expect ("Downloading from ");
3169       mips_expect (udp_in_use ? "udp" : "tty0");
3170       mips_expect (", ^C to abort\r\n");
3171     }
3172 }
3173
3174 static int
3175 mips_expect_download (char *string)
3176 {
3177   if (!mips_expect (string))
3178     {
3179       fprintf_unfiltered (gdb_stderr, "Load did not complete successfully.\n");
3180       if (tftp_in_use)
3181         remove (tftp_localname);        /* Remove temporary file */
3182       return 0;
3183     }
3184   else
3185     return 1;
3186 }
3187
3188 static void
3189 pmon_check_entry_address (char *entry_address, int final)
3190 {
3191   char hexnumber[9];            /* includes '\0' space */
3192   mips_expect_timeout (entry_address, tftp_in_use ? 15 : remote_timeout);
3193   sprintf (hexnumber, "%x", final);
3194   mips_expect (hexnumber);
3195   mips_expect ("\r\n");
3196 }
3197
3198 static int
3199 pmon_check_total (int bintotal)
3200 {
3201   char hexnumber[9];            /* includes '\0' space */
3202   mips_expect ("\r\ntotal = 0x");
3203   sprintf (hexnumber, "%x", bintotal);
3204   mips_expect (hexnumber);
3205   return mips_expect_download (" bytes\r\n");
3206 }
3207
3208 static void
3209 pmon_end_download (int final, int bintotal)
3210 {
3211   char hexnumber[9];            /* includes '\0' space */
3212
3213   if (tftp_in_use)
3214     {
3215       static char *load_cmd_prefix = "load -b -s ";
3216       char *cmd;
3217       struct stat stbuf;
3218
3219       /* Close off the temporary file containing the load data.  */
3220       fclose (tftp_file);
3221       tftp_file = NULL;
3222
3223       /* Make the temporary file readable by the world.  */
3224       if (stat (tftp_localname, &stbuf) == 0)
3225         chmod (tftp_localname, stbuf.st_mode | S_IROTH);
3226
3227       /* Must reinitialize the board to prevent PMON from crashing.  */
3228       mips_send_command ("initEther\r", -1);
3229
3230       /* Send the load command.  */
3231       cmd = xmalloc (strlen (load_cmd_prefix) + strlen (tftp_name) + 2);
3232       strcpy (cmd, load_cmd_prefix);
3233       strcat (cmd, tftp_name);
3234       strcat (cmd, "\r");
3235       mips_send_command (cmd, 0);
3236       xfree (cmd);
3237       if (!mips_expect_download ("Downloading from "))
3238         return;
3239       if (!mips_expect_download (tftp_name))
3240         return;
3241       if (!mips_expect_download (", ^C to abort\r\n"))
3242         return;
3243     }
3244
3245   /* Wait for the stuff that PMON prints after the load has completed.
3246      The timeout value for use in the tftp case (15 seconds) was picked
3247      arbitrarily but might be too small for really large downloads. FIXME. */
3248   switch (mips_monitor)
3249     {
3250     case MON_LSI:
3251       pmon_check_ack ("termination");
3252       pmon_check_entry_address ("Entry address is ", final);
3253       if (!pmon_check_total (bintotal))
3254         return;
3255       break;
3256     default:
3257       pmon_check_entry_address ("Entry Address  = ", final);
3258       pmon_check_ack ("termination");
3259       if (!pmon_check_total (bintotal))
3260         return;
3261       break;
3262     }
3263
3264   if (tftp_in_use)
3265     remove (tftp_localname);    /* Remove temporary file */
3266 }
3267
3268 static void
3269 pmon_download (char *buffer, int length)
3270 {
3271   if (tftp_in_use)
3272     fwrite (buffer, 1, length, tftp_file);
3273   else
3274     SERIAL_WRITE (udp_in_use ? udp_desc : mips_desc, buffer, length);
3275 }
3276
3277 static void
3278 pmon_load_fast (char *file)
3279 {
3280   bfd *abfd;
3281   asection *s;
3282   unsigned char *binbuf;
3283   char *buffer;
3284   int reclen;
3285   unsigned int csum = 0;
3286   int hashmark = !tftp_in_use;
3287   int bintotal = 0;
3288   int final = 0;
3289   int finished = 0;
3290
3291   buffer = (char *) xmalloc (MAXRECSIZE + 1);
3292   binbuf = (unsigned char *) xmalloc (BINCHUNK);
3293
3294   abfd = bfd_openr (file, 0);
3295   if (!abfd)
3296     {
3297       printf_filtered ("Unable to open file %s\n", file);
3298       return;
3299     }
3300
3301   if (bfd_check_format (abfd, bfd_object) == 0)
3302     {
3303       printf_filtered ("File is not an object file\n");
3304       return;
3305     }
3306
3307   /* Setup the required download state: */
3308   mips_send_command ("set dlproto etxack\r", -1);
3309   mips_send_command ("set dlecho off\r", -1);
3310   /* NOTE: We get a "cannot set variable" message if the variable is
3311      already defined to have the argument we give. The code doesn't
3312      care, since it just scans to the next prompt anyway. */
3313   /* Start the download: */
3314   pmon_start_download ();
3315
3316   /* Zero the checksum */
3317   sprintf (buffer, "/Kxx\n");
3318   reclen = strlen (buffer);
3319   pmon_download (buffer, reclen);
3320   finished = pmon_check_ack ("/Kxx");
3321
3322   for (s = abfd->sections; s && !finished; s = s->next)
3323     if (s->flags & SEC_LOAD)    /* only deal with loadable sections */
3324       {
3325         bintotal += s->_raw_size;
3326         final = (s->vma + s->_raw_size);
3327
3328         printf_filtered ("%s\t: 0x%4x .. 0x%4x  ", s->name, (unsigned int) s->vma,
3329                          (unsigned int) (s->vma + s->_raw_size));
3330         gdb_flush (gdb_stdout);
3331
3332         /* Output the starting address */
3333         sprintf (buffer, "/A");
3334         reclen = pmon_makeb64 (s->vma, &buffer[2], 36, &csum);
3335         buffer[2 + reclen] = '\n';
3336         buffer[3 + reclen] = '\0';
3337         reclen += 3;            /* for the initial escape code and carriage return */
3338         pmon_download (buffer, reclen);
3339         finished = pmon_check_ack ("/A");
3340
3341         if (!finished)
3342           {
3343             unsigned int binamount;
3344             unsigned int zerofill = 0;
3345             char *bp = buffer;
3346             unsigned int i;
3347
3348             reclen = 0;
3349
3350             for (i = 0; ((i < s->_raw_size) && !finished); i += binamount)
3351               {
3352                 int binptr = 0;
3353
3354                 binamount = min (BINCHUNK, s->_raw_size - i);
3355
3356                 bfd_get_section_contents (abfd, s, binbuf, i, binamount);
3357
3358                 /* This keeps a rolling checksum, until we decide to output
3359                    the line: */
3360                 for (; ((binamount - binptr) > 0);)
3361                   {
3362                     pmon_make_fastrec (&bp, binbuf, &binptr, binamount, &reclen, &csum, &zerofill);
3363                     if (reclen >= (MAXRECSIZE - CHECKSIZE))
3364                       {
3365                         reclen = pmon_checkset (reclen, &bp, &csum);
3366                         pmon_download (buffer, reclen);
3367                         finished = pmon_check_ack ("data record");
3368                         if (finished)
3369                           {
3370                             zerofill = 0;       /* do not transmit pending zerofills */
3371                             break;
3372                           }
3373
3374                         if (hashmark)
3375                           {
3376                             putchar_unfiltered ('#');
3377                             gdb_flush (gdb_stdout);
3378                           }
3379
3380                         bp = buffer;
3381                         reclen = 0;     /* buffer processed */
3382                       }
3383                   }
3384               }
3385
3386             /* Ensure no out-standing zerofill requests: */
3387             if (zerofill != 0)
3388               reclen = pmon_zeroset (reclen, &bp, &zerofill, &csum);
3389
3390             /* and then flush the line: */
3391             if (reclen > 0)
3392               {
3393                 reclen = pmon_checkset (reclen, &bp, &csum);
3394                 /* Currently pmon_checkset outputs the line terminator by
3395                    default, so we write out the buffer so far: */
3396                 pmon_download (buffer, reclen);
3397                 finished = pmon_check_ack ("record remnant");
3398               }
3399           }
3400
3401         putchar_unfiltered ('\n');
3402       }
3403
3404   /* Terminate the transfer. We know that we have an empty output
3405      buffer at this point. */
3406   sprintf (buffer, "/E/E\n");   /* include dummy padding characters */
3407   reclen = strlen (buffer);
3408   pmon_download (buffer, reclen);
3409
3410   if (finished)
3411     {                           /* Ignore the termination message: */
3412       SERIAL_FLUSH_INPUT (udp_in_use ? udp_desc : mips_desc);
3413     }
3414   else
3415     {                           /* Deal with termination message: */
3416       pmon_end_download (final, bintotal);
3417     }
3418
3419   return;
3420 }
3421
3422 /* mips_load -- download a file. */
3423
3424 static void
3425 mips_load (char *file, int from_tty)
3426 {
3427   /* Get the board out of remote debugging mode.  */
3428   if (mips_exit_debug ())
3429     error ("mips_load:  Couldn't get into monitor mode.");
3430
3431   if (mips_monitor != MON_IDT)
3432     pmon_load_fast (file);
3433   else
3434     mips_load_srec (file);
3435
3436   mips_initialize ();
3437
3438   /* Finally, make the PC point at the start address */
3439   if (mips_monitor != MON_IDT)
3440     {
3441       /* Work around problem where PMON monitor updates the PC after a load
3442          to a different value than GDB thinks it has. The following ensures
3443          that the write_pc() WILL update the PC value: */
3444       register_valid[PC_REGNUM] = 0;
3445     }
3446   if (exec_bfd)
3447     write_pc (bfd_get_start_address (exec_bfd));
3448
3449   inferior_pid = 0;             /* No process now */
3450
3451 /* This is necessary because many things were based on the PC at the time that
3452    we attached to the monitor, which is no longer valid now that we have loaded
3453    new code (and just changed the PC).  Another way to do this might be to call
3454    normal_stop, except that the stack may not be valid, and things would get
3455    horribly confused... */
3456
3457   clear_symtab_users ();
3458 }
3459
3460
3461 /* Pass the command argument as a packet to PMON verbatim.  */
3462
3463 static void
3464 pmon_command (char *args, int from_tty)
3465 {
3466   char buf[DATA_MAXLEN + 1];
3467   int rlen;
3468
3469   sprintf (buf, "0x0 %s", args);
3470   mips_send_packet (buf, 1);
3471   printf_filtered ("Send packet: %s\n", buf);
3472
3473   rlen = mips_receive_packet (buf, 1, mips_receive_wait);
3474   buf[rlen] = '\0';
3475   printf_filtered ("Received packet: %s\n", buf);
3476 }
3477 \f
3478 void
3479 _initialize_remote_mips (void)
3480 {
3481   /* Initialize the fields in mips_ops that are common to all four targets.  */
3482   mips_ops.to_longname = "Remote MIPS debugging over serial line";
3483   mips_ops.to_close = mips_close;
3484   mips_ops.to_detach = mips_detach;
3485   mips_ops.to_resume = mips_resume;
3486   mips_ops.to_fetch_registers = mips_fetch_registers;
3487   mips_ops.to_store_registers = mips_store_registers;
3488   mips_ops.to_prepare_to_store = mips_prepare_to_store;
3489   mips_ops.to_xfer_memory = mips_xfer_memory;
3490   mips_ops.to_files_info = mips_files_info;
3491   mips_ops.to_insert_breakpoint = mips_insert_breakpoint;
3492   mips_ops.to_remove_breakpoint = mips_remove_breakpoint;
3493   mips_ops.to_kill = mips_kill;
3494   mips_ops.to_load = mips_load;
3495   mips_ops.to_create_inferior = mips_create_inferior;
3496   mips_ops.to_mourn_inferior = mips_mourn_inferior;
3497   mips_ops.to_stratum = process_stratum;
3498   mips_ops.to_has_all_memory = 1;
3499   mips_ops.to_has_memory = 1;
3500   mips_ops.to_has_stack = 1;
3501   mips_ops.to_has_registers = 1;
3502   mips_ops.to_has_execution = 1;
3503   mips_ops.to_magic = OPS_MAGIC;
3504
3505   /* Copy the common fields to all four target vectors.  */
3506   pmon_ops = ddb_ops = lsi_ops = mips_ops;
3507
3508   /* Initialize target-specific fields in the target vectors.  */
3509   mips_ops.to_shortname = "mips";
3510   mips_ops.to_doc = "\
3511 Debug a board using the MIPS remote debugging protocol over a serial line.\n\
3512 The argument is the device it is connected to or, if it contains a colon,\n\
3513 HOST:PORT to access a board over a network";
3514   mips_ops.to_open = mips_open;
3515   mips_ops.to_wait = mips_wait;
3516
3517   pmon_ops.to_shortname = "pmon";
3518   pmon_ops.to_doc = "\
3519 Debug a board using the PMON MIPS remote debugging protocol over a serial\n\
3520 line. The argument is the device it is connected to or, if it contains a\n\
3521 colon, HOST:PORT to access a board over a network";
3522   pmon_ops.to_open = pmon_open;
3523   pmon_ops.to_wait = mips_wait;
3524
3525   ddb_ops.to_shortname = "ddb";
3526   ddb_ops.to_doc = "\
3527 Debug a board using the PMON MIPS remote debugging protocol over a serial\n\
3528 line. The first argument is the device it is connected to or, if it contains\n\
3529 a colon, HOST:PORT to access a board over a network.  The optional second\n\
3530 parameter is the temporary file in the form HOST:FILENAME to be used for\n\
3531 TFTP downloads to the board.  The optional third parameter is the local name\n\
3532 of the TFTP temporary file, if it differs from the filename seen by the board.";
3533   ddb_ops.to_open = ddb_open;
3534   ddb_ops.to_wait = mips_wait;
3535
3536   lsi_ops.to_shortname = "lsi";
3537   lsi_ops.to_doc = pmon_ops.to_doc;
3538   lsi_ops.to_open = lsi_open;
3539   lsi_ops.to_wait = mips_wait;
3540
3541   /* Add the targets.  */
3542   add_target (&mips_ops);
3543   add_target (&pmon_ops);
3544   add_target (&ddb_ops);
3545   add_target (&lsi_ops);
3546
3547   add_show_from_set (
3548                       add_set_cmd ("timeout", no_class, var_zinteger,
3549                                    (char *) &mips_receive_wait,
3550                        "Set timeout in seconds for remote MIPS serial I/O.",
3551                                    &setlist),
3552                       &showlist);
3553
3554   add_show_from_set (
3555                   add_set_cmd ("retransmit-timeout", no_class, var_zinteger,
3556                                (char *) &mips_retransmit_wait,
3557                                "Set retransmit timeout in seconds for remote MIPS serial I/O.\n\
3558 This is the number of seconds to wait for an acknowledgement to a packet\n\
3559 before resending the packet.", &setlist),
3560                       &showlist);
3561
3562   add_show_from_set (
3563                    add_set_cmd ("syn-garbage-limit", no_class, var_zinteger,
3564                                 (char *) &mips_syn_garbage,
3565                                 "Set the maximum number of characters to ignore when scanning for a SYN.\n\
3566 This is the maximum number of characters GDB will ignore when trying to\n\
3567 synchronize with the remote system.  A value of -1 means that there is no limit\n\
3568 (Note that these characters are printed out even though they are ignored.)",
3569                                 &setlist),
3570                       &showlist);
3571
3572   add_show_from_set
3573     (add_set_cmd ("monitor-prompt", class_obscure, var_string,
3574                   (char *) &mips_monitor_prompt,
3575                   "Set the prompt that GDB expects from the monitor.",
3576                   &setlist),
3577      &showlist);
3578
3579   add_show_from_set (
3580                add_set_cmd ("monitor-warnings", class_obscure, var_zinteger,
3581                             (char *) &monitor_warnings,
3582                             "Set printing of monitor warnings.\n"
3583                 "When enabled, monitor warnings about hardware breakpoints "
3584                             "will be displayed.",
3585                             &setlist),
3586                       &showlist);
3587
3588   add_com ("pmon <command>", class_obscure, pmon_command,
3589            "Send a packet to PMON (must be in debug mode).");
3590
3591   add_show_from_set (add_set_cmd ("mask-address", no_class,
3592                                   var_boolean, &mask_address_p,
3593                                   "Set zeroing of upper 32 bits of 64-bit addresses when talking to PMON targets.\n\
3594 Use \"on\" to enable the masking and \"off\" to disable it.\n",
3595                                   &setlist),
3596                      &showlist);
3597 }