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