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