include/asm-sh/kgdb.h

   1 /*
   2  * May be copied or modified under the terms of the GNU General Public
   3  * License.  See linux/COPYING for more information.
   4  *
   5  * Based on original code by Glenn Engel, Jim Kingdon,
   6  * David Grothe <dave@gcom.com>, Tigran Aivazian, <tigran@sco.com> and
   7  * Amit S. Kale <akale@veritas.com>
   8  *
   9  * Super-H port based on sh-stub.c (Ben Lee and Steve Chamberlain) by
  10  * Henry Bell <henry.bell@st.com>
  11  *
  12  * Header file for low-level support for remote debug using GDB.
  13  *
  14  */
  15
  16 #ifndef __KGDB_H
  17 #define __KGDB_H
  18
  19 #include <asm/ptrace.h>
  20
  21 /* Same as pt_regs but has vbr in place of syscall_nr */
  22 struct kgdb_regs {
  23         unsigned long regs[16];
  24         unsigned long pc;
  25         unsigned long pr;
  26         unsigned long sr;
  27         unsigned long gbr;
  28         unsigned long mach;
  29         unsigned long macl;
  30         unsigned long vbr;
  31 };
  32
  33 /* State info */
  34 extern char kgdb_in_gdb_mode;
  35 extern int kgdb_done_init;
  36 extern int kgdb_enabled;
  37 extern int kgdb_nofault;        /* Ignore bus errors (in gdb mem access) */
  38 extern int kgdb_halt;           /* Execute initial breakpoint at startup */
  39 extern char in_nmi;             /* Debounce flag to prevent NMI reentry*/
  40
  41 /* SCI */
  42 extern int kgdb_portnum;
  43 extern int kgdb_baud;
  44 extern char kgdb_parity;
  45 extern char kgdb_bits;
  46 extern int kgdb_console_setup(struct console *, char *);
  47
  48 /* Init and interface stuff */
  49 extern int kgdb_init(void);
  50 extern int (*kgdb_serial_setup)(void);
  51 extern int (*kgdb_getchar)(void);
  52 extern void (*kgdb_putchar)(int);
  53
  54 struct kgdb_sermap {
  55         char *name;
  56         int namelen;
  57         int (*setup_fn)(struct console *, char *);
  58         struct kgdb_sermap *next;
  59 };
  60 extern void kgdb_register_sermap(struct kgdb_sermap *map);
  61 extern struct kgdb_sermap *kgdb_porttype;
  62
  63 /* Trap functions */
  64 typedef void (kgdb_debug_hook_t)(struct pt_regs *regs);
  65 typedef void (kgdb_bus_error_hook_t)(void);
  66 extern kgdb_debug_hook_t  *kgdb_debug_hook;
  67 extern kgdb_bus_error_hook_t *kgdb_bus_err_hook;
  68
  69 extern void breakpoint(void);
  70
  71 /* Console */
  72 struct console;
  73 void kgdb_console_write(struct console *co, const char *s, unsigned count);
  74 void kgdb_console_init(void);
  75
  76 /* Prototypes for jmp fns */
  77 #define _JBLEN 9
  78 typedef        int jmp_buf[_JBLEN];
  79 extern void    longjmp(jmp_buf __jmpb, int __retval);
  80 extern int     setjmp(jmp_buf __jmpb);
  81
  82 /* Variadic macro to print our own message to the console */
  83 #define KGDB_PRINTK(...) printk("KGDB: " __VA_ARGS__)
  84
  85 /* Forced breakpoint */
  86 #define BREAKPOINT() do {                                     \
  87   if (kgdb_enabled) {                                         \
  88     asm volatile("trapa   #0xff");                            \
  89   }                                                           \
  90 } while (0)
  91
  92 /* Kernel assert macros */
  93 #ifdef CONFIG_KGDB_KERNEL_ASSERTS
  94
  95 /* Predefined conditions */
  96 #define KA_VALID_ERRNO(errno) ((errno) > 0 && (errno) <= EMEDIUMTYPE)
  97 #define KA_VALID_PTR_ERR(ptr) KA_VALID_ERRNO(-PTR_ERR(ptr))
  98 #define KA_VALID_KPTR(ptr)  (!(ptr) || \
  99               ((void *)(ptr) >= (void *)PAGE_OFFSET &&  \
 100                (void *)(ptr) < ERR_PTR(-EMEDIUMTYPE)))
 101 #define KA_VALID_PTRORERR(errptr) \
 102                (KA_VALID_KPTR(errptr) || KA_VALID_PTR_ERR(errptr))
 103 #define KA_HELD_GKL()  (current->lock_depth >= 0)
 104
 105 /* The actual assert */
 106 #define KGDB_ASSERT(condition, message) do {                   \
 107        if (!(condition) && (kgdb_enabled)) {                   \
 108                KGDB_PRINTK("Assertion failed at %s:%d: %s\n",  \
 109                                   __FILE__, __LINE__, message);\
 110                BREAKPOINT();                                   \
 111        }                                                       \
 112 } while (0)
 113 #else
 114 #define KGDB_ASSERT(condition, message)
 115 #endif
 116
 117 #endif