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