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