1 /* $NetBSD: db_machdep.h,v 1.13 2024/11/25 22:04:14 skrll Exp $ */ 2 3 /*- 4 * Copyright (c) 2014 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Matt Thomas of 3am Software Foundry. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #ifndef _RISCV_DB_MACHDEP_H_ 33 #define _RISCV_DB_MACHDEP_H_ 34 35 #include <riscv/frame.h> 36 37 #ifndef _KERNEL 38 #include <stdbool.h> 39 #endif /* _KERNEL */ 40 41 #define DB_ELF_SYMBOLS 42 43 typedef vaddr_t db_addr_t; /* address - unsigned */ 44 #define DDB_EXPR_FMT "l" /* expression is long */ 45 typedef long db_expr_t; /* expression - signed */ 46 47 typedef struct trapframe db_regs_t; 48 49 extern const uint32_t cpu_Debugger_insn[]; 50 extern const uint32_t cpu_Debugger_ret[]; 51 extern db_regs_t ddb_regs; 52 #define DDB_REGS (&ddb_regs) 53 54 #define PC_REGS(tf) ((tf)->tf_pc) 55 56 #define PC_ADVANCE(tf) do { \ 57 if (db_get_value((tf)->tf_pc, sizeof(uint32_t), false) == BKPT_INST) \ 58 (tf)->tf_pc += BKPT_SIZE; \ 59 } while(0) 60 61 /* Similar to PC_ADVANCE(), except only advance on cpu_Debugger()'s bpt */ 62 #define PC_BREAK_ADVANCE(tf) do { \ 63 if ((tf)->tf_pc == (register_t)cpu_Debugger_insn) \ 64 (tf)->tf_pc = (register_t)cpu_Debugger_ret; \ 65 } while(0) 66 67 #define BKPT_ADDR(addr) (addr) /* breakpoint address */ 68 #define BKPT_INST 0x00100073 69 #define BKPT_SIZE (sizeof(uint32_t)) /* size of bkpt inst */ 70 #define BKPT_SET(inst, addr) (BKPT_INST) 71 72 /* 73 * XXX with the C extension there's also a 16-bit-wide breakpoint 74 * instruction, the idea being that you use it when inserting a 75 * breakpoint into a stream of 16-bit instructions, but it looks like 76 * MI ddb can't cope with having two sizes :-( 77 */ 78 #if 0 79 #define BKPT_INST_2 0x9002 80 #define BKPT_SIZE_2 (sizeof(uint16_t)) 81 #endif 82 83 #define IS_BREAKPOINT_TRAP(type, code) ((type) == CAUSE_BREAKPOINT) 84 #define IS_WATCHPOINT_TRAP(type, code) (0) 85 86 /* 87 * Interface to disassembly 88 */ 89 db_addr_t db_disasm_insn(uint32_t, db_addr_t, bool); 90 91 92 /* 93 * Entrypoints to DDB for kernel, keyboard drivers, init hook 94 */ 95 void kdb_kbd_trap(db_regs_t *); 96 int kdb_trap(int, db_regs_t *); 97 98 /* 99 * Constants for KGDB. 100 */ 101 typedef register_t kgdb_reg_t; 102 #define KGDB_NUMREGS 90 103 #define KGDB_BUFLEN 1024 104 105 /* 106 * RISC-V harts have no hardware single-step. 107 */ 108 #define SOFTWARE_SSTEP 109 110 #define inst_trap_return(ins) ((ins)&0) 111 112 bool inst_branch(uint32_t inst); 113 bool inst_call(uint32_t inst); 114 bool inst_return(uint32_t inst); 115 bool inst_load(uint32_t inst); 116 bool inst_store(uint32_t inst); 117 bool inst_unconditional_flow_transfer(uint32_t inst); 118 db_addr_t branch_taken(uint32_t inst, db_addr_t pc, db_regs_t *regs); 119 db_addr_t next_instr_address(db_addr_t pc, bool bd); 120 121 bool ddb_running_on_this_cpu_p(void); 122 bool ddb_running_on_any_cpu_p(void); 123 void db_resume_others(void); 124 125 /* 126 * We have machine-dependent commands. 127 */ 128 #define DB_MACHINE_COMMANDS 129 130 void dump_trapframe(const struct trapframe *, void (*)(const char *, ...) __printflike(1, 2)); 131 132 #endif /* _RISCV_DB_MACHDEP_H_ */ 133