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. */
667 hms_wait (pid, status)
671 /* Strings to look for. '?' means match any single character.
672 Note that with the algorithm we use, the initial character
673 of the string cannot recur in the string, or we will not
674 find some cases of the string in the input. */
676 static char bpt[] = "At breakpoint:";
678 /* It would be tempting to look for "\n[__exit + 0x8]\n"
679 but that requires loading symbols with "yc i" and even if
680 we did do that we don't know that the file has symbols. */
681 static char exitmsg[] = "HMS>";
685 /* Large enough for either sizeof (bpt) or sizeof (exitmsg) chars. */
688 /* Current position in swallowed. */
689 char *swallowed_p = swallowed;
693 int old_timeout = timeout;
694 int old_immediate_quit = immediate_quit;
695 int swallowed_cr = 0;
697 WSETEXIT ((*status), 0);
699 if (need_artificial_trap != 0)
701 WSETSTOP ((*status), SIGTRAP);
702 need_artificial_trap--;
706 timeout = -1; /* Don't time out -- user program is running. */
707 immediate_quit = 1; /* Helps ability to QUIT */
710 QUIT; /* Let user quit and leave process running */
726 if (ch == *ep || *ep == '?')
745 /* Print out any characters which have been swallowed. */
746 for (p = swallowed; p < swallowed_p; ++p)
748 swallowed_p = swallowed;
750 if ((ch != '\r' && ch != '\n') || swallowed_cr > 10)
761 WSETSTOP ((*status), SIGTRAP);
766 WSETEXIT ((*status), 0);
769 timeout = old_timeout;
770 immediate_quit = old_immediate_quit;
774 /* Return the name of register number REGNO
775 in the form input and output by hms.
777 Returns a pointer to a static buffer containing the answer. */
782 static char *rn[] = REGISTER_NAMES;
787 /* Read the remote registers. */
789 gethex (length, start, ok)
799 if (*start >= 'a' && *start <= 'f')
801 result += *start - 'a' + 10;
803 else if (*start >= 'A' && *start <= 'F')
805 result += *start - 'A' + 10;
807 else if (*start >= '0' && *start <= '9')
809 result += *start - '0';
819 timed_read (buf, n, timeout)
845 SERIAL_WRITE (desc, a, l);
848 for (i = 0; i < l; i++)
857 hms_write (s, strlen (s));
862 hms_fetch_register (dummy)
865 #define REGREPLY_SIZE 79
866 char linebuf[REGREPLY_SIZE + 1];
871 REGISTER_TYPE reg[NUM_REGS];
880 s = timed_read (linebuf, REGREPLY_SIZE, 1);
882 linebuf[REGREPLY_SIZE] = 0;
884 if (linebuf[0] == 'r' &&
888 linebuf[75] == 'H' &&
889 linebuf[76] == 'M' &&
893 PC=XXXX CCR=XX:XXXXXXXX R0-R7= XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX
894 5436789012345678901234567890123456789012345678901234567890123456789012
899 reg[PC_REGNUM] = gethex (4, linebuf + 6, &gottok);
900 reg[CCR_REGNUM] = gethex (2, linebuf + 15, &gottok);
901 for (i = 0; i < 8; i++)
903 reg[i] = gethex (4, linebuf + 34 + 5 * i, &gottok);
908 for (i = 0; i < NUM_REGS; i++)
913 swapped[0] = (reg[i]) >> 8;
915 supply_register (i, swapped);
919 /* Store register REGNO, or all if REGNO == -1.
920 Return errno value. */
922 hms_store_register (regno)
927 for (regno = 0; regno < NUM_REGS; regno++)
929 hms_store_register (regno);
934 char *name = get_reg_name (regno);
937 sprintf (buffer, "r %s=%x", name, read_register (regno));
938 hms_write_cr (buffer);
943 /* Get ready to modify the registers array. On machines which store
944 individual registers, this doesn't need to do anything. On machines
945 which store all the registers in one fell swoop, this makes sure
946 that registers contains all the registers from the program being
950 hms_prepare_to_store ()
952 /* Do nothing, since we can store individual regs */
956 translate_addr (addr)
964 /* Read a word from remote address ADDR and return it.
965 * This goes through the data cache.
968 hms_fetch_word (addr)
971 return dcache_fetch (addr);
974 /* Write a word WORD into remote address ADDR.
975 This goes through the data cache. */
978 hms_store_word (addr, word)
982 dcache_poke (addr, word);
986 hms_xfer_inferior_memory (memaddr, myaddr, len, write, target)
991 struct target_ops *target; /* ignored */
995 /* Round starting address down to longword boundary. */
996 register CORE_ADDR addr;
998 /* Round ending address up; get number of longwords that makes. */
1001 /* Allocate buffer of that many longwords. */
1002 register int *buffer;
1005 addr = memaddr & -sizeof (int);
1006 count = (((memaddr + len) - addr) + sizeof (int) - 1) / sizeof (int);
1008 buffer = (int *) alloca (count * sizeof (int));
1012 /* Fill start and end extra bytes of buffer with existing memory data. */
1014 if (addr != memaddr || len < (int) sizeof (int))
1016 /* Need part of initial word -- fetch it. */
1017 buffer[0] = hms_fetch_word (addr);
1020 if (count > 1) /* FIXME, avoid if even boundary */
1023 = hms_fetch_word (addr + (count - 1) * sizeof (int));
1026 /* Copy data to be written over corresponding part of buffer */
1028 memcpy ((char *) buffer + (memaddr & (sizeof (int) - 1)), myaddr, len);
1030 /* Write the entire buffer. */
1032 for (i = 0; i < count; i++, addr += sizeof (int))
1035 hms_store_word (addr, buffer[i]);
1046 /* Read all the longwords */
1047 for (i = 0; i < count; i++, addr += sizeof (int))
1050 buffer[i] = hms_fetch_word (addr);
1058 /* Copy appropriate bytes out of the buffer. */
1059 memcpy (myaddr, (char *) buffer + (memaddr & (sizeof (int) - 1)), len);
1066 hms_write_inferior_memory (memaddr, myaddr, len)
1068 unsigned char *myaddr;
1082 thisgo = len - done;
1086 sprintf (buffer, "M.B %4x =", memaddr + done);
1087 hms_write (buffer, 10);
1088 for (idx = 0; idx < thisgo; idx++)
1092 sprintf (buf, "%2x ", myaddr[idx + done]);
1105 char *file = "nothing";
1108 file = bfd_get_filename (exec_bfd);
1112 printf_filtered ("\tAttached to DOS asynctsr and running program %s\n", file);
1114 printf_filtered ("\tAttached to %s at %d baud and running program %s\n", dev_name, baudrate, file);
1116 printf_filtered ("\ton an H8/300 processor.\n");
1119 /* Copy LEN bytes of data from debugger memory at MYADDR
1120 to inferior's memory at MEMADDR. Returns errno value.
1121 * sb/sh instructions don't work on unaligned addresses, when TU=1.
1124 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
1125 at debugger address MYADDR. Returns errno value. */
1127 hms_read_inferior_memory (memaddr, myaddr, len)
1132 /* Align to nearest low 16 bits */
1136 CORE_ADDR start = memaddr & ~0xf;
1137 CORE_ADDR end = ((memaddr + len + 16) & ~0xf) - 1;
1140 CORE_ADDR start = memaddr;
1141 CORE_ADDR end = memaddr + len - 1;
1146 AAAA: XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX '................'
1147 012345678901234567890123456789012345678901234567890123456789012345
1157 sprintf (buffer, "m %4x %4x", start & 0xffff, end & 0xffff);
1158 hms_write_cr (buffer);
1159 /* drop the echo and newline*/
1160 for (i = 0; i < 13; i++)
1163 /* Grab the lines as they come out and fill the area */
1174 buffer[0] = readchar ();
1175 if (buffer[0] == 'M')
1177 for (i = 1; i < 66; i++)
1178 buffer[i] = readchar ();
1180 /* Now parse the line */
1182 addr = gethex (4, buffer, &ok);
1184 for (p = 0; p < 16; p += 2)
1186 byte[p] = gethex (2, buffer + idx, &ok);
1187 byte[p + 1] = gethex (2, buffer + idx + 2, &ok);
1192 for (p = 0; p < 16; p++)
1194 if (addr + p >= memaddr &&
1195 addr + p < memaddr + len)
1197 myaddr[(addr + p) - memaddr] = byte[p];
1209 /* This routine is run as a hook, just before the main command loop is
1210 entered. If gdb is configured for the H8, but has not had its
1211 target specified yet, this will loop prompting the user to do so.
1214 hms_before_main_loop ()
1218 extern FILE *instream;
1220 push_target (&hms_ops);
1223 #define MAX_BREAKS 16
1224 static int num_brkpts = 0;
1226 hms_insert_breakpoint (addr, save)
1228 char *save; /* Throw away, let hms save instructions */
1232 if (num_brkpts < MAX_BREAKS)
1237 sprintf (buffer, "b %x", addr & 0xffff);
1238 hms_write_cr (buffer);
1244 fprintf_filtered (stderr,
1245 "Too many break points, break point not installed\n");
1251 hms_remove_breakpoint (addr, save)
1253 char *save; /* Throw away, let hms save instructions */
1260 sprintf (buffer, "b - %x", addr & 0xffff);
1261 hms_write_cr (buffer);
1268 /* Clear the hmss notion of what the break points are */
1270 hms_clear_breakpoints ()
1275 hms_write_cr ("b -");
1283 hms_clear_breakpoints ();
1284 unpush_target (&hms_ops);
1285 generic_mourn_inferior ();
1288 /* Put a command string, in args, out to the hms. The hms is assumed to
1289 be in raw mode, all writing/reading done through desc.
1290 Ouput from the hms is placed on the users terminal until the
1291 prompt from the hms is seen.
1292 FIXME: Can't handle commands that take input. */
1295 hms_com (args, fromtty)
1304 /* Clear all input so only command relative output is displayed */
1306 hms_write_cr (args);
1307 hms_write ("\030", 1);
1311 /* Define the target subroutine names */
1313 struct target_ops hms_ops =
1315 "hms", "Remote HMS monitor",
1316 "Use the H8 evaluation board running the HMS monitor connected\n\
1319 hms_open, hms_close,
1320 0, hms_detach, hms_resume, hms_wait, /* attach */
1321 hms_fetch_register, hms_store_register,
1322 hms_prepare_to_store,
1323 hms_xfer_inferior_memory,
1325 hms_insert_breakpoint, hms_remove_breakpoint, /* Breakpoints */
1326 0, 0, 0, 0, 0, /* Terminal handling */
1327 hms_kill, /* FIXME, kill */
1329 0, /* lookup_symbol */
1330 hms_create_inferior, /* create_inferior */
1331 hms_mourn, /* mourn_inferior FIXME */
1333 0, /* notice_signals */
1334 process_stratum, 0, /* next */
1335 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
1336 0, 0, /* Section pointers */
1337 OPS_MAGIC, /* Always the last thing */
1344 printf_filtered ("Snoop disabled\n");
1346 printf_filtered ("Snoop enabled\n");
1355 dev_name = get_word (&s);
1368 int newrate = atoi (s);
1371 if (SERIAL_SETBAUDRATE (desc, newrate))
1372 error ("Can't use %d baud\n", newrate);
1374 printf_filtered ("Checking target is in sync\n");
1376 printf_filtered ("Sending commands to set target to %d\n",
1379 sprintf (buffer, "tm %d. N 8 1", baudrate);
1380 hms_write_cr (buffer);
1384 /***********************************************************************/
1387 _initialize_remote_hms ()
1389 add_target (&hms_ops);
1391 add_com ("hms <command>", class_obscure, hms_com,
1392 "Send a command to the HMS monitor.");
1393 add_com ("snoop", class_obscure, hms_quiet,
1394 "Show what commands are going to the monitor");
1396 add_com ("device", class_obscure, hms_device,
1397 "Set the terminal line for HMS communications");
1399 add_com ("speed", class_obscure, hms_speed,
1400 "Set the terminal line speed for HMS communications");