/* $NetBSD: db_machdep.h,v 1.23 2023/11/22 01:58:02 thorpej Exp $ */

/*
 * Copyright (c) 1995 Carnegie-Mellon University.
 * All rights reserved.
 *
 * Author: Chris G. Demetriou
 *
 * Permission to use, copy, modify and distribute this software and
 * its documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 *
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 *
 * Carnegie Mellon requests users of this software to return to
 *
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 *
 * any improvements or extensions that they make and grant Carnegie the
 * rights to redistribute these changes.
 */

#ifndef _ALPHA_DB_MACHDEP_H_
#define _ALPHA_DB_MACHDEP_H_

/*
 * Machine-dependent defines for new kernel debugger.
 */

#include <sys/param.h>
#include <uvm/uvm_extern.h>
#include <machine/frame.h>

#include <ddb/db_user.h>

typedef vaddr_t         db_addr_t;      /* address - unsigned */
#define DDB_EXPR_FMT    "l"             /* expression is long */
typedef long            db_expr_t;      /* expression - signed */

typedef struct trapframe db_regs_t;
extern db_regs_t        *ddb_regp;      /* pointer to current register state */
#define DDB_REGS        (ddb_regp)

#define PC_REGS(regs)   ((regs)->tf_regs[FRAME_PC])

#define BKPT_ADDR(addr) (addr)          /* breakpoint address */
#define BKPT_INST       0x00000080      /* breakpoint instruction */
#define BKPT_SIZE       (4)             /* size of breakpoint inst */
#define BKPT_SET(inst, addr)    (BKPT_INST)

#define FIXUP_PC_AFTER_BREAK(regs) \
        ((regs)->tf_regs[FRAME_PC] -= BKPT_SIZE)

#define SOFTWARE_SSTEP  1               /* no hardware support */
#define IS_BREAKPOINT_TRAP(type, code)  ((type) == ALPHA_KENTRY_IF && \
                                         (code) == ALPHA_IF_CODE_BPT)
#define IS_WATCHPOINT_TRAP(type, code)  0

/*
 * Functions needed for software single-stepping.
 */

bool            db_inst_trap_return(int inst);
bool            db_inst_return(int inst);
bool            db_inst_call(int inst);
bool            db_inst_branch(int inst);
bool            db_inst_load(int inst);
bool            db_inst_store(int inst);
bool            db_inst_unconditional_flow_transfer(int inst);
db_addr_t       db_branch_taken(int inst, db_addr_t pc, db_regs_t *regs);

#define inst_trap_return(ins)   db_inst_trap_return(ins)
#define inst_return(ins)        db_inst_return(ins)
#define inst_call(ins)          db_inst_call(ins)
#define inst_branch(ins)        db_inst_branch(ins)
#define inst_load(ins)          db_inst_load(ins)
#define inst_store(ins)         db_inst_store(ins)
#define inst_unconditional_flow_transfer(ins) \
                                db_inst_unconditional_flow_transfer(ins)
#define branch_taken(ins, pc, regs) \
                                db_branch_taken((ins), (pc), (regs))

/* No delay slots on Alpha. */
#define next_instr_address(v, b) ((db_addr_t) ((b) ? (v) : ((v) + 4)))

u_long  db_register_value(db_regs_t *, int);
int     ddb_trap(unsigned long, unsigned long, unsigned long,
            unsigned long, struct trapframe *);

int     alpha_debug(unsigned long, unsigned long, unsigned long,
            unsigned long, struct trapframe *);

struct alpha_bus_space;
void    alpha_kgdb_init(const char **, struct alpha_bus_space *);

/*
 * We define some of our own commands.
 */
#define DB_MACHINE_COMMANDS

/*
 * We use Elf64 symbols in DDB.
 */
#define DB_ELF_SYMBOLS

/*
 * Stuff for KGDB.
 */
typedef long            kgdb_reg_t;
#define KGDB_NUMREGS    66      /* from tm-alpha.h, NUM_REGS */
#define KGDB_REG_V0     0
#define KGDB_REG_T0     1
#define KGDB_REG_T1     2
#define KGDB_REG_T2     3
#define KGDB_REG_T3     4
#define KGDB_REG_T4     5
#define KGDB_REG_T5     6
#define KGDB_REG_T6     7
#define KGDB_REG_T7     8
#define KGDB_REG_S0     9
#define KGDB_REG_S1     10
#define KGDB_REG_S2     11
#define KGDB_REG_S3     12
#define KGDB_REG_S4     13
#define KGDB_REG_S5     14
#define KGDB_REG_S6     15      /* FP */
#define KGDB_REG_A0     16
#define KGDB_REG_A1     17
#define KGDB_REG_A2     18
#define KGDB_REG_A3     19
#define KGDB_REG_A4     20
#define KGDB_REG_A5     21
#define KGDB_REG_T8     22
#define KGDB_REG_T9     23
#define KGDB_REG_T10    24
#define KGDB_REG_T11    25
#define KGDB_REG_RA     26
#define KGDB_REG_T12    27
#define KGDB_REG_AT     28
#define KGDB_REG_GP     29
#define KGDB_REG_SP     30
#define KGDB_REG_ZERO   31
#define KGDB_REG_F0     32
#define KGDB_REG_F1     33
#define KGDB_REG_F2     34
#define KGDB_REG_F3     35
#define KGDB_REG_F4     36
#define KGDB_REG_F5     37
#define KGDB_REG_F6     38
#define KGDB_REG_F7     39
#define KGDB_REG_F8     40
#define KGDB_REG_F9     41
#define KGDB_REG_F10    42
#define KGDB_REG_F11    43
#define KGDB_REG_F12    44
#define KGDB_REG_F13    45
#define KGDB_REG_F14    46
#define KGDB_REG_F15    47
#define KGDB_REG_F16    48
#define KGDB_REG_F17    49
#define KGDB_REG_F18    50
#define KGDB_REG_F19    51
#define KGDB_REG_F20    52
#define KGDB_REG_F21    53
#define KGDB_REG_F22    54
#define KGDB_REG_F23    55
#define KGDB_REG_F24    56
#define KGDB_REG_F25    57
#define KGDB_REG_F26    58
#define KGDB_REG_F27    59
#define KGDB_REG_F28    60
#define KGDB_REG_F29    61
#define KGDB_REG_F30    62
#define KGDB_REG_F31    63
#define KGDB_REG_PC     64
#define KGDB_REG_VFP    65

/* Too much?  Must be large enough for register transfer. */
#define KGDB_BUFLEN     1024

/*
 * Private alpha ddb internals.
 */
#define SYM_XentArith                   0
#define SYM_XentIF                      1
#define SYM_XentInt                     2
#define SYM_XentMM                      3
#define SYM_XentSys                     4
#define SYM_XentUna                     5
#define SYM_XentRestart                 6
#define SYM_exception_return            7
#define SYM_alpha_kthread_backstop      8
#ifdef _KERNEL
#define SYM___eol                       (SYM_alpha_kthread_backstop + 1)
#else
#define SYM_dumppcb                     9
#define SYM___eol                       (SYM_dumppcb + 1)
#endif /* _KERNEL */

#ifdef _KERNEL
struct db_alpha_nlist {
        vaddr_t         n_value;
};

typedef struct db_alpha_nlist db_alpha_nlist;

#define DB_ALPHA_SYM(i, x)      [(i)] = { .n_value = (vaddr_t)&(x) }
#define DB_ALPHA_SYM_EOL        [SYM___eol] = { .n_value = 0 }
#else
#include <nlist.h>

typedef struct nlist db_alpha_nlist;

#define DB_ALPHA_SYM(i, x)      [(i)] = { .n_name = __STRING(x) }
#define DB_ALPHA_SYM_EOL        [SYM___eol] = { .n_name = NULL }
#endif /* _KERNEL */

bool            db_alpha_sym_is_trap(db_addr_t);
bool            db_alpha_sym_is_backstop(db_addr_t);
bool            db_alpha_sym_is_syscall(db_addr_t);
const char *    db_alpha_trapsym_description(db_addr_t);

unsigned long   db_alpha_read_saved_reg(unsigned long *);
unsigned long   db_alpha_tf_reg(struct trapframe *, unsigned int);

/*
 * Extra ddb options.
 */
#define __HAVE_DB_STACK_TRACE_PRINT_RA
void db_stack_trace_print_ra(db_expr_t, bool, db_expr_t, bool,
    db_expr_t, const char *, void (*)(const char *, ...));

#endif  /* _ALPHA_DB_MACHDEP_H_ */