xref: /freebsd/sys/gdb/gdb.h (revision a466cc55373fc3cf86837f09da729535b57e69a1)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2004 Marcel Moolenaar
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _GDB_GDB_H_
32 #define	_GDB_GDB_H_
33 
34 typedef int gdb_checkc_f(void);
35 typedef int gdb_getc_f(void);
36 typedef void gdb_init_f(void);
37 typedef int gdb_probe_f(void);
38 typedef void gdb_putc_f(int);
39 typedef void gdb_term_f(void);
40 
41 struct gdb_dbgport {
42 	const char	*gdb_name;
43 	gdb_getc_f	*gdb_getc;
44 	gdb_init_f	*gdb_init;
45 	gdb_probe_f	*gdb_probe;
46 	gdb_putc_f	*gdb_putc;
47 	gdb_term_f	*gdb_term;
48 	int		gdb_active;
49 	void		(*gdb_sendpacket)(const void *, size_t);
50 	int		gdb_dbfeatures;
51 };
52 
53 #define	GDB_DBGP_FEAT_WANTTERM	0x1	/* Want gdb_term() invocation when
54 					   leaving GDB.  gdb_term has been
55 					   deadcode and never invoked for so
56 					   long I don't want to just blindly
57 					   start invoking it without opt-in. */
58 #define	GDB_DBGP_FEAT_RELIABLE	0x2	/* The debugport promises it is a
59 					   reliable transport, which allows GDB
60 					   acks to be turned off. */
61 
62 #define	GDB_DBGPORT(name, probe, init, term, getc, putc)		\
63 	static struct gdb_dbgport name##_gdb_dbgport = {		\
64 		.gdb_name = #name,					\
65 		.gdb_probe = probe,					\
66 		.gdb_init = init,					\
67 		.gdb_term = term,					\
68 		.gdb_getc = getc,					\
69 		.gdb_putc = putc,					\
70 	};								\
71 	DATA_SET(gdb_dbgport_set, name##_gdb_dbgport)
72 
73 #endif /* !_GDB_GDB_H_ */
74