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
29#ifndef _GDB_GDB_INT_H_
30#define	_GDB_GDB_INT_H_
31
32#include "opt_ddb.h"
33
34#include <sys/sysctl.h>
35
36#ifdef DDB
37#include <ddb/ddb.h>
38#endif
39
40#ifndef EOF
41#define EOF	(-1)
42#endif
43
44SYSCTL_DECL(_debug_gdb);
45
46extern struct gdb_dbgport *gdb_cur;
47
48extern int gdb_listening;
49void gdb_consinit(void);
50
51extern char *gdb_rxp;
52extern size_t gdb_rxsz;
53extern char *gdb_txp;
54
55extern bool gdb_ackmode;
56
57#ifdef DDB
58/* If set, return to DDB when controlling GDB detaches. */
59extern bool gdb_return_to_ddb;
60#endif
61
62int gdb_rx_begin(void);
63int gdb_rx_equal(const char *);
64int gdb_rx_mem(unsigned char *, size_t);
65int gdb_rx_varhex(uintmax_t *);
66
67static __inline int
68gdb_rx_char(void)
69{
70	int c;
71
72	if (gdb_rxsz > 0) {
73		c = *gdb_rxp++;
74		gdb_rxsz--;
75	} else
76		c = EOF;
77	return (c);
78}
79
80void gdb_tx_begin(char);
81int gdb_tx_end(void);
82int gdb_tx_mem(const unsigned char *, size_t);
83void gdb_tx_reg(int);
84bool gdb_txbuf_has_capacity(size_t);
85int gdb_rx_bindata(unsigned char *data, size_t datalen, size_t *amt);
86int gdb_search_mem(const unsigned char *addr, size_t size,
87    const unsigned char *pat, size_t patlen, const unsigned char **found);
88
89static __inline void
90gdb_tx_char(char c)
91{
92	*gdb_txp++ = c;
93}
94
95static __inline int
96gdb_tx_empty(void)
97{
98	gdb_tx_begin('\0');
99	return (gdb_tx_end());
100}
101
102static __inline void
103gdb_tx_hex(uintmax_t n, int sz)
104{
105	gdb_txp += sprintf(gdb_txp, "%0*jx", sz, n);
106}
107
108static __inline int
109gdb_tx_err(int err)
110{
111	gdb_tx_begin('E');
112	gdb_tx_hex(err, 2);
113	return (gdb_tx_end());
114}
115
116static __inline int
117gdb_tx_ok(void)
118{
119	gdb_tx_begin('O');
120	gdb_tx_char('K');
121	return (gdb_tx_end());
122}
123
124static __inline void
125gdb_tx_str(const char *s)
126{
127	while (*s)
128		*gdb_txp++ = *s++;
129}
130
131static __inline void
132gdb_tx_varhex(uintmax_t n)
133{
134	gdb_txp += sprintf(gdb_txp, "%jx", n);
135}
136
137static __inline void
138gdb_nack(void)
139{
140	if (gdb_ackmode)
141		gdb_cur->gdb_putc('-');
142}
143
144static __inline void
145gdb_ack(void)
146{
147	if (gdb_ackmode)
148		gdb_cur->gdb_putc('+');
149}
150
151#endif /* !_GDB_GDB_INT_H_ */
152