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.");
264 printf_unfiltered ("%c", buf);
274 buf = SERIAL_READCHAR (desc, timeout);
275 if (buf == SERIAL_TIMEOUT)
278 printf_unfiltered ("%c", buf);
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 ("*");
449 gdb_flush (gdb_stdout);
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, TARGET_SIGNAL_DEFAULT, 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)
643 enum target_signal sig;
652 /* Force the next hms_wait to return a trap. Not doing anything
653 about I/O from the target means that the user has to type
654 "continue" to see any. FIXME, this should be fixed. */
655 need_artificial_trap = 1;
664 /* Wait until the remote machine stops, then return,
665 storing status in STATUS just as `wait' would. */
668 hms_wait (pid, status)
670 struct target_waitstatus *status;
672 /* Strings to look for. '?' means match any single character.
673 Note that with the algorithm we use, the initial character
674 of the string cannot recur in the string, or we will not
675 find some cases of the string in the input. */
677 static char bpt[] = "At breakpoint:";
679 /* It would be tempting to look for "\n[__exit + 0x8]\n"
680 but that requires loading symbols with "yc i" and even if
681 we did do that we don't know that the file has symbols. */
682 static char exitmsg[] = "HMS>";
686 /* Large enough for either sizeof (bpt) or sizeof (exitmsg) chars. */
689 /* Current position in swallowed. */
690 char *swallowed_p = swallowed;
694 int old_timeout = timeout;
695 int old_immediate_quit = immediate_quit;
696 int swallowed_cr = 0;
698 status->kind = TARGET_WAITKIND_EXITED;
699 status->value.integer = 0;
701 if (need_artificial_trap != 0)
703 status->kind = TARGET_WAITKIND_STOPPED;
704 status->value.sig = TARGET_SIGNAL_TRAP;
705 need_artificial_trap--;
709 timeout = -1; /* Don't time out -- user program is running. */
710 immediate_quit = 1; /* Helps ability to QUIT */
713 QUIT; /* Let user quit and leave process running */
729 if (ch == *ep || *ep == '?')
748 /* Print out any characters which have been swallowed. */
749 for (p = swallowed; p < swallowed_p; ++p)
750 putc_unfiltered (*p);
751 swallowed_p = swallowed;
753 if ((ch != '\r' && ch != '\n') || swallowed_cr > 10)
755 putc_unfiltered (ch);
764 status->kind = TARGET_WAITKIND_STOPPED;
765 status->value.sig = TARGET_SIGNAL_TRAP;
770 status->kind = TARGET_WAITKIND_EXITED;
771 status->value.integer = 0;
774 timeout = old_timeout;
775 immediate_quit = old_immediate_quit;
779 /* Return the name of register number REGNO
780 in the form input and output by hms.
782 Returns a pointer to a static buffer containing the answer. */
787 static char *rn[] = REGISTER_NAMES;
792 /* Read the remote registers. */
794 gethex (length, start, ok)
804 if (*start >= 'a' && *start <= 'f')
806 result += *start - 'a' + 10;
808 else if (*start >= 'A' && *start <= 'F')
810 result += *start - 'A' + 10;
812 else if (*start >= '0' && *start <= '9')
814 result += *start - '0';
824 timed_read (buf, n, timeout)
850 SERIAL_WRITE (desc, a, l);
853 for (i = 0; i < l; i++)
855 printf_unfiltered ("%c", a[i]);
862 hms_write (s, strlen (s));
867 hms_fetch_register (dummy)
870 #define REGREPLY_SIZE 79
871 char linebuf[REGREPLY_SIZE + 1];
876 unsigned LONGEST reg[NUM_REGS];
885 s = timed_read (linebuf, REGREPLY_SIZE, 1);
887 linebuf[REGREPLY_SIZE] = 0;
889 if (linebuf[0] == 'r' &&
893 linebuf[75] == 'H' &&
894 linebuf[76] == 'M' &&
898 PC=XXXX CCR=XX:XXXXXXXX R0-R7= XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX
899 5436789012345678901234567890123456789012345678901234567890123456789012
904 reg[PC_REGNUM] = gethex (4, linebuf + 6, &gottok);
905 reg[CCR_REGNUM] = gethex (2, linebuf + 15, &gottok);
906 for (i = 0; i < 8; i++)
908 reg[i] = gethex (4, linebuf + 34 + 5 * i, &gottok);
913 for (i = 0; i < NUM_REGS; i++)
918 swapped[0] = (reg[i]) >> 8;
920 supply_register (i, swapped);
924 /* Store register REGNO, or all if REGNO == -1.
925 Return errno value. */
927 hms_store_register (regno)
932 for (regno = 0; regno < NUM_REGS; regno++)
934 hms_store_register (regno);
939 char *name = get_reg_name (regno);
942 sprintf (buffer, "r %s=%x", name, read_register (regno));
943 hms_write_cr (buffer);
948 /* Get ready to modify the registers array. On machines which store
949 individual registers, this doesn't need to do anything. On machines
950 which store all the registers in one fell swoop, this makes sure
951 that registers contains all the registers from the program being
955 hms_prepare_to_store ()
957 /* Do nothing, since we can store individual regs */
961 translate_addr (addr)
969 /* Read a word from remote address ADDR and return it.
970 * This goes through the data cache.
973 hms_fetch_word (addr)
976 return dcache_fetch (addr);
979 /* Write a word WORD into remote address ADDR.
980 This goes through the data cache. */
983 hms_store_word (addr, word)
987 dcache_poke (addr, word);
991 hms_xfer_inferior_memory (memaddr, myaddr, len, write, target)
996 struct target_ops *target; /* ignored */
1000 /* Round starting address down to longword boundary. */
1001 register CORE_ADDR addr;
1003 /* Round ending address up; get number of longwords that makes. */
1006 /* Allocate buffer of that many longwords. */
1007 register int *buffer;
1010 addr = memaddr & -sizeof (int);
1011 count = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
1013 buffer = (int *) alloca (count * sizeof (int));
1017 /* Fill start and end extra bytes of buffer with existing memory data. */
1019 if (addr != memaddr || len < (int) sizeof (int))
1021 /* Need part of initial word -- fetch it. */
1022 buffer[0] = hms_fetch_word (addr);
1025 if (count > 1) /* FIXME, avoid if even boundary */
1028 = hms_fetch_word (addr + (count - 1) * sizeof (int));
1031 /* Copy data to be written over corresponding part of buffer */
1033 memcpy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
1035 /* Write the entire buffer. */
1037 for (i = 0; i < count; i++, addr += sizeof (int))
1040 hms_store_word (addr, buffer[i]);
1051 /* Read all the longwords */
1052 for (i = 0; i < count; i++, addr += sizeof (int))
1055 buffer[i] = hms_fetch_word (addr);
1063 /* Copy appropriate bytes out of the buffer. */
1064 memcpy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
1071 hms_write_inferior_memory (memaddr, myaddr, len)
1073 unsigned char *myaddr;
1087 thisgo = len - done;
1091 sprintf (buffer, "M.B %4x =", memaddr + done);
1092 hms_write (buffer, 10);
1093 for (idx = 0; idx < thisgo; idx++)
1097 sprintf (buf, "%2x ", myaddr[idx + done]);
1110 char *file = "nothing";
1113 file = bfd_get_filename (exec_bfd);
1117 printf_filtered ("\tAttached to DOS asynctsr and running program %s\n", file);
1119 printf_filtered ("\tAttached to %s at %d baud and running program %s\n", dev_name, baudrate, file);
1121 printf_filtered ("\ton an H8/300 processor.\n");
1124 /* Copy LEN bytes of data from debugger memory at MYADDR
1125 to inferior's memory at MEMADDR. Returns errno value.
1126 * sb/sh instructions don't work on unaligned addresses, when TU=1.
1129 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
1130 at debugger address MYADDR. Returns errno value. */
1132 hms_read_inferior_memory (memaddr, myaddr, len)
1137 /* Align to nearest low 16 bits */
1141 CORE_ADDR start = memaddr & ~0xf;
1142 CORE_ADDR end = ((memaddr + len + 16) & ~0xf) - 1;
1145 CORE_ADDR start = memaddr;
1146 CORE_ADDR end = memaddr + len - 1;
1151 AAAA: XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX '................'
1152 012345678901234567890123456789012345678901234567890123456789012345
1162 sprintf (buffer, "m %4x %4x", start & 0xffff, end & 0xffff);
1163 hms_write_cr (buffer);
1164 /* drop the echo and newline*/
1165 for (i = 0; i < 13; i++)
1168 /* Grab the lines as they come out and fill the area */
1179 buffer[0] = readchar ();
1180 if (buffer[0] == 'M')
1182 for (i = 1; i < 66; i++)
1183 buffer[i] = readchar ();
1185 /* Now parse the line */
1187 addr = gethex (4, buffer, &ok);
1189 for (p = 0; p < 16; p += 2)
1191 byte[p] = gethex (2, buffer + idx, &ok);
1192 byte[p + 1] = gethex (2, buffer + idx + 2, &ok);
1197 for (p = 0; p < 16; p++)
1199 if (addr + p >= memaddr &&
1200 addr + p < memaddr + len)
1202 myaddr[(addr + p) - memaddr] = byte[p];
1214 /* This routine is run as a hook, just before the main command loop is
1215 entered. If gdb is configured for the H8, but has not had its
1216 target specified yet, this will loop prompting the user to do so.
1219 hms_before_main_loop ()
1223 extern GDB_FILE *instream;
1225 push_target (&hms_ops);
1228 #define MAX_BREAKS 16
1229 static int num_brkpts = 0;
1231 hms_insert_breakpoint (addr, save)
1233 char *save; /* Throw away, let hms save instructions */
1237 if (num_brkpts < MAX_BREAKS)
1242 sprintf (buffer, "b %x", addr & 0xffff);
1243 hms_write_cr (buffer);
1249 fprintf_filtered (gdb_stderr,
1250 "Too many break points, break point not installed\n");
1256 hms_remove_breakpoint (addr, save)
1258 char *save; /* Throw away, let hms save instructions */
1265 sprintf (buffer, "b - %x", addr & 0xffff);
1266 hms_write_cr (buffer);
1273 /* Clear the hmss notion of what the break points are */
1275 hms_clear_breakpoints ()
1280 hms_write_cr ("b -");
1288 hms_clear_breakpoints ();
1289 unpush_target (&hms_ops);
1290 generic_mourn_inferior ();
1293 /* Put a command string, in args, out to the hms. The hms is assumed to
1294 be in raw mode, all writing/reading done through desc.
1295 Ouput from the hms is placed on the users terminal until the
1296 prompt from the hms is seen.
1297 FIXME: Can't handle commands that take input. */
1300 hms_com (args, fromtty)
1309 /* Clear all input so only command relative output is displayed */
1311 hms_write_cr (args);
1312 hms_write ("\030", 1);
1316 /* Define the target subroutine names */
1318 struct target_ops hms_ops =
1320 "hms", "Remote HMS monitor",
1321 "Use the H8 evaluation board running the HMS monitor connected\n\
1324 hms_open, hms_close,
1325 0, hms_detach, hms_resume, hms_wait, /* attach */
1326 hms_fetch_register, hms_store_register,
1327 hms_prepare_to_store,
1328 hms_xfer_inferior_memory,
1330 hms_insert_breakpoint, hms_remove_breakpoint, /* Breakpoints */
1331 0, 0, 0, 0, 0, /* Terminal handling */
1332 hms_kill, /* FIXME, kill */
1334 0, /* lookup_symbol */
1335 hms_create_inferior, /* create_inferior */
1336 hms_mourn, /* mourn_inferior FIXME */
1338 0, /* notice_signals */
1339 process_stratum, 0, /* next */
1340 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
1341 0, 0, /* Section pointers */
1342 OPS_MAGIC, /* Always the last thing */
1349 printf_filtered ("Snoop disabled\n");
1351 printf_filtered ("Snoop enabled\n");
1360 dev_name = get_word (&s);
1373 int newrate = atoi (s);
1376 if (SERIAL_SETBAUDRATE (desc, newrate))
1377 error ("Can't use %d baud\n", newrate);
1379 printf_filtered ("Checking target is in sync\n");
1381 printf_filtered ("Sending commands to set target to %d\n",
1384 sprintf (buffer, "tm %d. N 8 1", baudrate);
1385 hms_write_cr (buffer);
1389 /***********************************************************************/
1392 _initialize_remote_hms ()
1394 add_target (&hms_ops);
1396 add_com ("hms <command>", class_obscure, hms_com,
1397 "Send a command to the HMS monitor.");
1398 add_com ("snoop", class_obscure, hms_quiet,
1399 "Show what commands are going to the monitor");
1401 add_com ("device", class_obscure, hms_device,
1402 "Set the terminal line for HMS communications");
1404 add_com ("speed", class_obscure, hms_speed,
1405 "Set the terminal line speed for HMS communications");