sys/gdb/gdb.h

   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_H_
  30 #define _GDB_GDB_H_
  31
  32 typedef int gdb_checkc_f(void);
  33 typedef int gdb_getc_f(void);
  34 typedef void gdb_init_f(void);
  35 typedef int gdb_probe_f(void);
  36 typedef void gdb_putc_f(int);
  37 typedef void gdb_term_f(void);
  38
  39 struct gdb_dbgport {
  40         const char      *gdb_name;
  41         gdb_getc_f      *gdb_getc;
  42         gdb_init_f      *gdb_init;
  43         gdb_probe_f     *gdb_probe;
  44         gdb_putc_f      *gdb_putc;
  45         gdb_term_f      *gdb_term;
  46         int             gdb_active;
  47         void            (*gdb_sendpacket)(const void *, size_t);
  48         int             gdb_dbfeatures;
  49 };
  50
  51 #define GDB_DBGP_FEAT_WANTTERM  0x1     /* Want gdb_term() invocation when
  52                                            leaving GDB.  gdb_term has been
  53                                            deadcode and never invoked for so
  54                                            long I don't want to just blindly
  55                                            start invoking it without opt-in. */
  56 #define GDB_DBGP_FEAT_RELIABLE  0x2     /* The debugport promises it is a
  57                                            reliable transport, which allows GDB
  58                                            acks to be turned off. */
  59
  60 #define GDB_DBGPORT(name, probe, init, term, getc, putc)                \
  61         static struct gdb_dbgport name##_gdb_dbgport = {                \
  62                 .gdb_name = #name,                                      \
  63                 .gdb_probe = probe,                                     \
  64                 .gdb_init = init,                                       \
  65                 .gdb_term = term,                                       \
  66                 .gdb_getc = getc,                                       \
  67                 .gdb_putc = putc,                                       \
  68         };                                                              \
  69         DATA_SET(gdb_dbgport_set, name##_gdb_dbgport)
  70
  71 #endif /* !_GDB_GDB_H_ */