1/* Generic support for remote debugging interfaces.
2
3   Copyright 1993, 1994, 2000, 2001 Free Software Foundation, Inc.
4
5   This file is part of GDB.
6
7   This program is free software; you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation; either version 2 of the License, or
10   (at your option) any later version.
11
12   This program is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program; if not, write to the Free Software
19   Foundation, Inc., 59 Temple Place - Suite 330,
20   Boston, MA 02111-1307, USA.  */
21
22#ifndef REMOTE_UTILS_H
23#define REMOTE_UTILS_H
24
25struct target_ops;
26
27#include "target.h"
28struct serial;
29
30/* Stuff that should be shared (and handled consistently) among the various
31   remote targets.  */
32
33struct _sr_settings
34  {
35    unsigned int timeout;
36
37    int retries;
38
39    char *device;
40    struct serial *desc;
41
42  };
43
44extern struct _sr_settings sr_settings;
45
46/* get and set debug value. */
47#define sr_get_debug()			(remote_debug)
48#define sr_set_debug(newval)		(remote_debug = (newval))
49
50/* get and set timeout. */
51#define sr_get_timeout()		(sr_settings.timeout)
52#define sr_set_timeout(newval)		(sr_settings.timeout = (newval))
53
54/* get and set device. */
55#define sr_get_device()			(sr_settings.device)
56#define sr_set_device(newval) \
57{ \
58    if (sr_settings.device) xfree (sr_settings.device); \
59    sr_settings.device = (newval); \
60}
61
62/* get and set descriptor value. */
63#define sr_get_desc()			(sr_settings.desc)
64#define sr_set_desc(newval)		(sr_settings.desc = (newval))
65
66/* get and set retries. */
67#define sr_get_retries()		(sr_settings.retries)
68#define sr_set_retries(newval)		(sr_settings.retries = (newval))
69
70#define sr_is_open()			(sr_settings.desc != NULL)
71
72#define sr_check_open() 	{ if (!sr_is_open()) \
73				    error ("Remote device not open"); }
74
75struct gr_settings
76  {
77    char *prompt;
78    struct target_ops *ops;
79    int (*clear_all_breakpoints) (void);
80    void (*checkin) (void);
81  };
82
83extern struct gr_settings *gr_settings;
84
85/* get and set prompt. */
86#define gr_get_prompt()			(gr_settings->prompt)
87#define gr_set_prompt(newval)		(gr_settings->prompt = (newval))
88
89/* get and set ops. */
90#define gr_get_ops()			(gr_settings->ops)
91#define gr_set_ops(newval)		(gr_settings->ops = (newval))
92
93#define gr_clear_all_breakpoints()	((gr_settings->clear_all_breakpoints)())
94#define gr_checkin()			((gr_settings->checkin)())
95
96/* Keep discarding input until we see the prompt.
97
98   The convention for dealing with the prompt is that you
99   o give your command
100   o *then* wait for the prompt.
101
102   Thus the last thing that a procedure does with the serial line
103   will be an gr_expect_prompt().  Exception:  resume does not
104   wait for the prompt, because the terminal is being handed over
105   to the inferior.  However, the next thing which happens after that
106   is a bug_wait which does wait for the prompt.
107   Note that this includes abnormal exit, e.g. error().  This is
108   necessary to prevent getting into states from which we can't
109   recover.  */
110
111#define gr_expect_prompt()	sr_expect(gr_get_prompt())
112
113int gr_multi_scan (char *list[], int passthrough);
114int sr_get_hex_digit (int ignore_space);
115int sr_pollchar (void);
116int sr_readchar (void);
117int sr_timed_read (char *buf, int n);
118long sr_get_hex_word (void);
119void gr_close (int quitting);
120void gr_create_inferior (char *execfile, char *args, char **env);
121void gr_detach (char *args, int from_tty);
122void gr_files_info (struct target_ops *ops);
123void gr_generic_checkin (void);
124void gr_kill (void);
125void gr_mourn (void);
126void gr_prepare_to_store (void);
127void sr_expect (char *string);
128void sr_get_hex_byte (char *byt);
129void sr_scan_args (char *proto, char *args);
130void sr_write (char *a, int l);
131void sr_write_cr (char *s);
132
133void gr_open (char *args, int from_tty, struct gr_settings *gr_settings);
134void gr_load_image (char *, int from_tty);
135#endif /* REMOTE_UTILS_H */
136