1 /* Remote debugging interface for Hitachi HMS Monitor Version 1.0
2 Copyright 1992 Free Software Foundation, Inc.
3 Contributed by Cygnus Support. Written by Steve Chamberlain
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
37 /* External data declarations */
38 extern int stop_soon_quietly; /* for wait_for_inferior */
40 /* Forward data declarations */
41 extern struct target_ops hms_ops; /* Forward declaration */
43 /* Forward function declarations */
44 static void hms_fetch_registers ();
45 static int hms_store_registers ();
46 static void hms_close ();
47 static int hms_clear_breakpoints ();
49 extern struct target_ops hms_ops;
56 /***********************************************************************/
57 /* Caching stuff stolen from remote-nindy.c */
59 /* The data cache records all the data read from the remote machine
60 since the last time it stopped.
62 Each cache block holds LINE_SIZE bytes of data
63 starting at a multiple-of-LINE_SIZE address. */
65 #define LINE_SIZE_POWER 4
66 #define LINE_SIZE (1<<LINE_SIZE_POWER) /* eg 1<<3 == 8 */
67 #define LINE_SIZE_MASK ((LINE_SIZE-1)) /* eg 7*2+1= 111*/
68 #define DCACHE_SIZE 64 /* Number of cache blocks */
69 #define XFORM(x) ((x&LINE_SIZE_MASK)>>2)
72 struct dcache_block *next, *last;
73 unsigned int addr; /* Address for which data is recorded. */
74 int data[LINE_SIZE / sizeof (int)];
77 struct dcache_block dcache_free, dcache_valid;
79 /* Free all the data cache blocks, thus discarding all cached data. */
84 register struct dcache_block *db;
86 while ((db = dcache_valid.next) != &dcache_valid)
89 insque (db, &dcache_free);
94 * If addr is present in the dcache, return the address of the block
102 register struct dcache_block *db;
107 /* Search all cache blocks for one that is at this address. */
108 db = dcache_valid.next;
109 while (db != &dcache_valid)
111 if ((addr & ~LINE_SIZE_MASK) == db->addr)
118 /* Return the int data at address ADDR in dcache block DC. */
121 dcache_value (db, addr)
122 struct dcache_block *db;
127 return (db->data[XFORM (addr)]);
130 /* Get a free cache block, put or keep it on the valid list,
131 and return its address. The caller should store into the block
132 the address and data that it describes, then remque it from the
133 free list and insert it into the valid list. This procedure
134 prevents errors from creeping in if a ninMemGet is interrupted
135 (which used to put garbage blocks in the valid list...). */
137 struct dcache_block *
140 register struct dcache_block *db;
142 if ((db = dcache_free.next) == &dcache_free)
144 /* If we can't get one from the free list, take last valid and put
145 it on the free list. */
146 db = dcache_valid.last;
148 insque (db, &dcache_free);
152 insque (db, &dcache_valid);
156 /* Return the contents of the word at address ADDR in the remote machine,
157 using the data cache. */
163 register struct dcache_block *db;
165 db = dcache_hit (addr);
168 db = dcache_alloc ();
170 hms_read_inferior_memory (addr & ~LINE_SIZE_MASK, (unsigned char *) db->data, LINE_SIZE);
172 db->addr = addr & ~LINE_SIZE_MASK;
173 remque (db); /* Off the free list */
174 insque (db, &dcache_valid); /* On the valid list */
176 return (dcache_value (db, addr));
179 /* Write the word at ADDR both in the data cache and in the remote machine. */
181 dcache_poke (addr, data)
185 register struct dcache_block *db;
187 /* First make sure the word is IN the cache. DB is its cache block. */
188 db = dcache_hit (addr);
191 db = dcache_alloc ();
193 hms_write_inferior_memory (addr & ~LINE_SIZE_MASK, (unsigned char *) db->data, LINE_SIZE);
195 db->addr = addr & ~LINE_SIZE_MASK;
196 remque (db); /* Off the free list */
197 insque (db, &dcache_valid); /* On the valid list */
200 /* Modify the word in the cache. */
201 db->data[XFORM (addr)] = data;
203 /* Send the changed word. */
205 hms_write_inferior_memory (addr, (unsigned char *) &data, 4);
209 /* The cache itself. */
210 struct dcache_block the_cache[DCACHE_SIZE];
212 /* Initialize the data cache. */
217 register struct dcache_block *db;
220 dcache_free.next = dcache_free.last = &dcache_free;
221 dcache_valid.next = dcache_valid.last = &dcache_valid;
222 for (i = 0; i < DCACHE_SIZE; i++, db++)
223 insque (db, &dcache_free);
226 /***********************************************************************
227 * I/O stuff stolen from remote-eb.c
228 ***********************************************************************/
230 static int timeout = 2;
232 static const char *dev_name;
234 /* Descriptor for I/O to remote machine. Initialize it to -1 so that
235 hms_open knows that we don't have a file open when the program
244 error ("remote device not open");
251 /* Read a character from the remote system, doing all the fancy
258 buf = SERIAL_READCHAR (desc, timeout);
260 if (buf == SERIAL_TIMEOUT)
261 error ("Timeout reading from remote system.");
274 buf = SERIAL_READCHAR (desc, timeout);
275 if (buf == SERIAL_TIMEOUT)
284 /* Keep discarding input from the remote system, until STRING is found.
285 Let the user break out immediately. */
295 if (readchar () == *p)
309 /* Keep discarding input until we see the hms prompt.
311 The convention for dealing with the prompt is that you
313 o *then* wait for the prompt.
315 Thus the last thing that a procedure does with the serial line
316 will be an expect_prompt(). Exception: hms_resume does not
317 wait for the prompt, because the terminal is being handed over
318 to the inferior. However, the next thing which happens after that
319 is a hms_wait which does wait for the prompt.
320 Note that this includes abnormal exit, e.g. error(). This is
321 necessary to prevent getting into states from which we can't
329 /* Get a hex digit from the remote system & return its value.
330 If ignore_space is nonzero, ignore spaces (not newline, tab, etc). */
332 get_hex_digit (ignore_space)
340 if (ch >= '0' && ch <= '9')
342 else if (ch >= 'A' && ch <= 'F')
343 return ch - 'A' + 10;
344 else if (ch >= 'a' && ch <= 'f')
345 return ch - 'a' + 10;
346 else if (ch == ' ' && ignore_space)
351 error ("Invalid hex digit from remote system.");
356 /* Get a byte from hms_desc and put it in *BYT. Accept any number
364 val = get_hex_digit (1) << 4;
365 val |= get_hex_digit (0);
369 /* Read a 32-bit hex word from the hms, preceded by a space */
377 for (j = 0; j < 8; j++)
378 val = (val << 4) + get_hex_digit (j == 0);
382 /* Called when SIGALRM signal sent due to alarm() timeout. */
384 /* Number of SIGTRAPs we need to simulate. That is, the next
385 NEED_ARTIFICIAL_TRAP calls to hms_wait should just return
386 SIGTRAP without actually waiting for anything. */
388 static int need_artificial_trap = 0;
391 hms_kill (arg, from_tty)
399 * Download a file specified in 'args', to the hms.
402 hms_load (args, fromtty)
415 abfd = bfd_openr (args, gnutarget);
418 printf_filtered ("Unable to open file %s\n", args);
422 if (bfd_check_format (abfd, bfd_object) == 0)
424 printf_filtered ("File is not an object file\n");
429 while (s != (asection *) NULL)
431 if (s->flags & SEC_LOAD)
436 char *buffer = xmalloc (DELTA);
438 printf_filtered ("%s\t: 0x%4x .. 0x%4x ", s->name, s->vma, s->vma + s->_raw_size);
439 for (i = 0; i < s->_raw_size; i += DELTA)
443 if (delta > s->_raw_size - i)
444 delta = s->_raw_size - i;
446 bfd_get_section_contents (abfd, s, buffer, i, delta);
447 hms_write_inferior_memory (s->vma + i, buffer, delta);
448 printf_filtered ("*");
451 printf_filtered ("\n");
456 sprintf (buffer, "r PC=%x", abfd->start_address);
457 hms_write_cr (buffer);
461 /* This is called not only when we first attach, but also when the
462 user types "run" after having attached. */
464 hms_create_inferior (execfile, args, env)
473 error ("Can't pass arguments to remote hms process.");
475 if (execfile == 0 || exec_bfd == 0)
476 error ("No exec file specified");
478 entry_pt = (int) bfd_get_start_address (exec_bfd);
481 hms_kill (NULL, NULL);
482 hms_clear_breakpoints ();
483 init_wait_for_inferior ();
487 insert_breakpoints (); /* Needed to get correct instruction in cache */
488 proceed (entry_pt, -1, 0);
491 /* Open a connection to a remote debugger.
492 NAME is the filename used for communication, then a space,
500 while (*s && !isspace (*s))
521 while (*s && !isspace (*s))
527 copy = xmalloc (len + 1);
528 memcpy (copy, word, len);
534 static int baudrate = 9600;
541 /* Put this port into NORMAL mode, send the 'normal' character */
543 hms_write ("\001", 1); /* Control A */
544 hms_write ("\r", 1); /* Cr */
548 ok = SERIAL_READCHAR (desc, timeout);
555 if (readchar_nofail () == 'r')
558 /* Not the right baudrate, or the board's not on */
564 if (!SERIAL_SETBAUDRATE (desc, baudrate))
565 error ("Can't set baudrate");
570 hms_open (name, from_tty)
583 dev_name = strdup (name);
585 if (!(desc = SERIAL_OPEN (dev_name)))
586 perror_with_name ((char *) dev_name);
593 /* Hello? Are you there? */
594 SERIAL_WRITE (desc, "\r", 1);
597 /* Clear any break points */
598 hms_clear_breakpoints ();
600 printf_filtered ("Connected to remote H8/300 HMS system.\n");
603 /* Close out all files and local state before this target loses control. */
609 /* Clear any break points */
610 hms_clear_breakpoints ();
611 sleep (1); /* Let any output make it all the way back */
614 SERIAL_WRITE (desc, "R\r", 2);
620 /* Terminate the open connection to the remote debugger.
621 Use this when you want to detach and do something else
624 hms_detach (args, from_tty)
630 hms_clear_breakpoints ();
633 pop_target (); /* calls hms_close to do the real work */
635 printf_filtered ("Ending remote %s debugging\n", target_shortname);
638 /* Tell the remote machine to resume. */
641 hms_resume (pid, step, sig)
651 /* Force the next hms_wait to return a trap. Not doing anything
652 about I/O from the target means that the user has to type
653 "continue" to see any. FIXME, this should be fixed. */
654 need_artificial_trap = 1;
663 /* Wait until the remote machine stops, then return,
664 storing status in STATUS just as `wait' would. */
670 /* Strings to look for. '?' means match any single character.
671 Note that with the algorithm we use, the initial character
672 of the string cannot recur in the string, or we will not
673 find some cases of the string in the input. */
675 static char bpt[] = "At breakpoint:";
677 /* It would be tempting to look for "\n[__exit + 0x8]\n"
678 but that requires loading symbols with "yc i" and even if
679 we did do that we don't know that the file has symbols. */
680 static char exitmsg[] = "HMS>";
684 /* Large enough for either sizeof (bpt) or sizeof (exitmsg) chars. */
687 /* Current position in swallowed. */
688 char *swallowed_p = swallowed;
692 int old_timeout = timeout;
693 int old_immediate_quit = immediate_quit;
694 int swallowed_cr = 0;
696 WSETEXIT ((*status), 0);
698 if (need_artificial_trap != 0)
700 WSETSTOP ((*status), SIGTRAP);
701 need_artificial_trap--;
705 timeout = -1; /* Don't time out -- user program is running. */
706 immediate_quit = 1; /* Helps ability to QUIT */
709 QUIT; /* Let user quit and leave process running */
725 if (ch == *ep || *ep == '?')
744 /* Print out any characters which have been swallowed. */
745 for (p = swallowed; p < swallowed_p; ++p)
747 swallowed_p = swallowed;
749 if ((ch != '\r' && ch != '\n') || swallowed_cr > 10)
760 WSETSTOP ((*status), SIGTRAP);
765 WSETEXIT ((*status), 0);
768 timeout = old_timeout;
769 immediate_quit = old_immediate_quit;
773 /* Return the name of register number REGNO
774 in the form input and output by hms.
776 Returns a pointer to a static buffer containing the answer. */
781 static char *rn[] = REGISTER_NAMES;
786 /* Read the remote registers. */
788 gethex (length, start, ok)
798 if (*start >= 'a' && *start <= 'f')
800 result += *start - 'a' + 10;
802 else if (*start >= 'A' && *start <= 'F')
804 result += *start - 'A' + 10;
806 else if (*start >= '0' && *start <= '9')
808 result += *start - '0';
818 timed_read (buf, n, timeout)
844 SERIAL_WRITE (desc, a, l);
847 for (i = 0; i < l; i++)
856 hms_write (s, strlen (s));
861 hms_fetch_register (dummy)
864 #define REGREPLY_SIZE 79
865 char linebuf[REGREPLY_SIZE + 1];
870 REGISTER_TYPE reg[NUM_REGS];
879 s = timed_read (linebuf, REGREPLY_SIZE, 1);
881 linebuf[REGREPLY_SIZE] = 0;
883 if (linebuf[0] == 'r' &&
887 linebuf[75] == 'H' &&
888 linebuf[76] == 'M' &&
892 PC=XXXX CCR=XX:XXXXXXXX R0-R7= XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX
893 5436789012345678901234567890123456789012345678901234567890123456789012
898 reg[PC_REGNUM] = gethex (4, linebuf + 6, &gottok);
899 reg[CCR_REGNUM] = gethex (2, linebuf + 15, &gottok);
900 for (i = 0; i < 8; i++)
902 reg[i] = gethex (4, linebuf + 34 + 5 * i, &gottok);
907 for (i = 0; i < NUM_REGS; i++)
912 swapped[0] = (reg[i]) >> 8;
914 supply_register (i, swapped);
918 /* Store register REGNO, or all if REGNO == -1.
919 Return errno value. */
921 hms_store_register (regno)
926 for (regno = 0; regno < NUM_REGS; regno++)
928 hms_store_register (regno);
933 char *name = get_reg_name (regno);
936 sprintf (buffer, "r %s=%x", name, read_register (regno));
937 hms_write_cr (buffer);
942 /* Get ready to modify the registers array. On machines which store
943 individual registers, this doesn't need to do anything. On machines
944 which store all the registers in one fell swoop, this makes sure
945 that registers contains all the registers from the program being
949 hms_prepare_to_store ()
951 /* Do nothing, since we can store individual regs */
955 translate_addr (addr)
963 /* Read a word from remote address ADDR and return it.
964 * This goes through the data cache.
967 hms_fetch_word (addr)
970 return dcache_fetch (addr);
973 /* Write a word WORD into remote address ADDR.
974 This goes through the data cache. */
977 hms_store_word (addr, word)
981 dcache_poke (addr, word);
985 hms_xfer_inferior_memory (memaddr, myaddr, len, write, target)
990 struct target_ops *target; /* ignored */
994 /* Round starting address down to longword boundary. */
995 register CORE_ADDR addr;
997 /* Round ending address up; get number of longwords that makes. */
1000 /* Allocate buffer of that many longwords. */
1001 register int *buffer;
1004 addr = memaddr & -sizeof (int);
1005 count = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
1007 buffer = (int *) alloca (count * sizeof (int));
1011 /* Fill start and end extra bytes of buffer with existing memory data. */
1013 if (addr != memaddr || len < (int) sizeof (int))
1015 /* Need part of initial word -- fetch it. */
1016 buffer[0] = hms_fetch_word (addr);
1019 if (count > 1) /* FIXME, avoid if even boundary */
1022 = hms_fetch_word (addr + (count - 1) * sizeof (int));
1025 /* Copy data to be written over corresponding part of buffer */
1027 memcpy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
1029 /* Write the entire buffer. */
1031 for (i = 0; i < count; i++, addr += sizeof (int))
1034 hms_store_word (addr, buffer[i]);
1045 /* Read all the longwords */
1046 for (i = 0; i < count; i++, addr += sizeof (int))
1049 buffer[i] = hms_fetch_word (addr);
1057 /* Copy appropriate bytes out of the buffer. */
1058 memcpy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
1065 hms_write_inferior_memory (memaddr, myaddr, len)
1067 unsigned char *myaddr;
1081 thisgo = len - done;
1085 sprintf (buffer, "M.B %4x =", memaddr + done);
1086 hms_write (buffer, 10);
1087 for (idx = 0; idx < thisgo; idx++)
1091 sprintf (buf, "%2x ", myaddr[idx + done]);
1104 char *file = "nothing";
1107 file = bfd_get_filename (exec_bfd);
1111 printf_filtered ("\tAttached to DOS asynctsr and running program %s\n", file);
1113 printf_filtered ("\tAttached to %s at %d baud and running program %s\n", dev_name, baudrate, file);
1115 printf_filtered ("\ton an H8/300 processor.\n");
1118 /* Copy LEN bytes of data from debugger memory at MYADDR
1119 to inferior's memory at MEMADDR. Returns errno value.
1120 * sb/sh instructions don't work on unaligned addresses, when TU=1.
1123 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
1124 at debugger address MYADDR. Returns errno value. */
1126 hms_read_inferior_memory (memaddr, myaddr, len)
1131 /* Align to nearest low 16 bits */
1135 CORE_ADDR start = memaddr & ~0xf;
1136 CORE_ADDR end = ((memaddr + len + 16) & ~0xf) - 1;
1139 CORE_ADDR start = memaddr;
1140 CORE_ADDR end = memaddr + len - 1;
1145 AAAA: XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX '................'
1146 012345678901234567890123456789012345678901234567890123456789012345
1156 sprintf (buffer, "m %4x %4x", start & 0xffff, end & 0xffff);
1157 hms_write_cr (buffer);
1158 /* drop the echo and newline*/
1159 for (i = 0; i < 13; i++)
1162 /* Grab the lines as they come out and fill the area */
1173 buffer[0] = readchar ();
1174 if (buffer[0] == 'M')
1176 for (i = 1; i < 66; i++)
1177 buffer[i] = readchar ();
1179 /* Now parse the line */
1181 addr = gethex (4, buffer, &ok);
1183 for (p = 0; p < 16; p += 2)
1185 byte[p] = gethex (2, buffer + idx, &ok);
1186 byte[p + 1] = gethex (2, buffer + idx + 2, &ok);
1191 for (p = 0; p < 16; p++)
1193 if (addr + p >= memaddr &&
1194 addr + p < memaddr + len)
1196 myaddr[(addr + p) - memaddr] = byte[p];
1208 /* This routine is run as a hook, just before the main command loop is
1209 entered. If gdb is configured for the H8, but has not had its
1210 target specified yet, this will loop prompting the user to do so.
1213 hms_before_main_loop ()
1217 extern FILE *instream;
1219 push_target (&hms_ops);
1222 #define MAX_BREAKS 16
1223 static int num_brkpts = 0;
1225 hms_insert_breakpoint (addr, save)
1227 char *save; /* Throw away, let hms save instructions */
1231 if (num_brkpts < MAX_BREAKS)
1236 sprintf (buffer, "b %x", addr & 0xffff);
1237 hms_write_cr (buffer);
1243 fprintf_filtered (stderr,
1244 "Too many break points, break point not installed\n");
1250 hms_remove_breakpoint (addr, save)
1252 char *save; /* Throw away, let hms save instructions */
1259 sprintf (buffer, "b - %x", addr & 0xffff);
1260 hms_write_cr (buffer);
1267 /* Clear the hmss notion of what the break points are */
1269 hms_clear_breakpoints ()
1274 hms_write_cr ("b -");
1282 hms_clear_breakpoints ();
1283 unpush_target (&hms_ops);
1284 generic_mourn_inferior ();
1287 /* Put a command string, in args, out to the hms. The hms is assumed to
1288 be in raw mode, all writing/reading done through desc.
1289 Ouput from the hms is placed on the users terminal until the
1290 prompt from the hms is seen.
1291 FIXME: Can't handle commands that take input. */
1294 hms_com (args, fromtty)
1303 /* Clear all input so only command relative output is displayed */
1305 hms_write_cr (args);
1306 hms_write ("\030", 1);
1310 /* Define the target subroutine names */
1312 struct target_ops hms_ops =
1314 "hms", "Remote HMS monitor",
1315 "Use the H8 evaluation board running the HMS monitor connected\n\
1318 hms_open, hms_close,
1319 0, hms_detach, hms_resume, hms_wait, /* attach */
1320 hms_fetch_register, hms_store_register,
1321 hms_prepare_to_store,
1322 hms_xfer_inferior_memory,
1324 hms_insert_breakpoint, hms_remove_breakpoint, /* Breakpoints */
1325 0, 0, 0, 0, 0, /* Terminal handling */
1326 hms_kill, /* FIXME, kill */
1328 0, /* lookup_symbol */
1329 hms_create_inferior, /* create_inferior */
1330 hms_mourn, /* mourn_inferior FIXME */
1332 0, /* notice_signals */
1333 process_stratum, 0, /* next */
1334 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
1335 0, 0, /* Section pointers */
1336 OPS_MAGIC, /* Always the last thing */
1343 printf_filtered ("Snoop disabled\n");
1345 printf_filtered ("Snoop enabled\n");
1354 dev_name = get_word (&s);
1367 int newrate = atoi (s);
1370 if (SERIAL_SETBAUDRATE (desc, newrate))
1371 error ("Can't use %d baud\n", newrate);
1373 printf_filtered ("Checking target is in sync\n");
1375 printf_filtered ("Sending commands to set target to %d\n",
1378 sprintf (buffer, "tm %d. N 8 1", baudrate);
1379 hms_write_cr (buffer);
1383 /***********************************************************************/
1386 _initialize_remote_hms ()
1388 add_target (&hms_ops);
1390 add_com ("hms <command>", class_obscure, hms_com,
1391 "Send a command to the HMS monitor.");
1392 add_com ("snoop", class_obscure, hms_quiet,
1393 "Show what commands are going to the monitor");
1395 add_com ("device", class_obscure, hms_device,
1396 "Set the terminal line for HMS communications");
1398 add_com ("speed", class_obscure, hms_speed,
1399 "Set the terminal line speed for HMS communications");