osfmk/kdp/kdp_internal.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 /*
  30  * Internal definitions for kdp module
  31  */
  32
  33 #include <kdp/kdp.h>
  34 #include <kdp/kdp_protocol.h>
  35 #include <mach/vm_types.h>
  36 #include <libsa/types.h>
  37
  38 typedef struct {
  39     unsigned short              reply_port;
  40     unsigned int                conn_seq;
  41     boolean_t                   is_conn;
  42     void                        *saved_state;
  43     boolean_t                   is_halted;
  44     unsigned short              exception_port;
  45     unsigned char               exception_seq;
  46     boolean_t                   exception_ack_needed;
  47     int                         kdp_cpu;
  48     thread_t                    kdp_thread;
  49 } kdp_glob_t;
  50
  51 extern kdp_glob_t       kdp;
  52
  53 extern volatile int     kdp_flag;
  54
  55 #define KDP_READY       0x1
  56 #define KDP_ARP         0x2
  57 #define KDP_BP_DIS      0x4
  58 #define KDP_GETC_ENA    0x8
  59 #define KDP_PANIC_DUMP_ENABLED 0x10
  60 #define PANIC_CORE_ON_NMI 0x20
  61 #define DBG_POST_CORE     0x40
  62 #define PANIC_LOG_DUMP    0x80
  63 #define REBOOT_POST_CORE  0x100
  64 typedef boolean_t
  65 (*kdp_dispatch_t) (
  66     kdp_pkt_t *,
  67     int  *,
  68     unsigned short *
  69 );
  70
  71 extern
  72 boolean_t
  73 kdp_packet(
  74     unsigned char *,
  75     int *,
  76     unsigned short *
  77 );
  78
  79 extern
  80 boolean_t
  81 kdp_remove_all_breakpoints (void);
  82
  83 extern
  84 void
  85 kdp_exception(
  86     unsigned char *,
  87     int *,
  88     unsigned short *,
  89     unsigned int,
  90     unsigned int,
  91     unsigned int
  92 );
  93
  94 extern
  95 boolean_t
  96 kdp_exception_ack(
  97     unsigned char *,
  98     int
  99 );
 100
 101 extern
 102 void
 103 kdp_panic(
 104     const char          *msg
 105 );
 106
 107 extern
 108 void
 109 kdp_machine_reboot(
 110     void
 111 );
 112
 113 extern
 114 void
 115 kdp_us_spin(
 116     int usec
 117 );
 118
 119 extern
 120 int
 121 kdp_intr_disbl(
 122     void
 123 );
 124
 125 extern
 126 void
 127 kdp_intr_enbl(
 128     int s
 129 );
 130
 131 extern
 132 kdp_error_t
 133 kdp_machine_read_regs(
 134     unsigned int cpu,
 135     unsigned int flavor,
 136     char *data,
 137     int *size
 138 );
 139
 140 extern
 141 kdp_error_t
 142 kdp_machine_write_regs(
 143     unsigned int cpu,
 144     unsigned int flavor,
 145     char *data,
 146     int *size
 147 );
 148
 149 extern
 150 void
 151 kdp_machine_hostinfo(
 152     kdp_hostinfo_t *hostinfo
 153 );
 154
 155 extern
 156 void
 157 kdp_sync_cache(
 158     void
 159 );
 160
 161 /* Return a byte array that can be byte-copied to a memory address
 162  * to trap into the debugger. Must be 4 bytes or less in the current
 163  * implementation
 164  */
 165 #define MAX_BREAKINSN_BYTES 4
 166
 167 void
 168 kdp_machine_get_breakinsn(
 169                                                   uint8_t *bytes,
 170                                                   uint32_t *size
 171 );
 172
 173 extern void
 174 kdp_ml_enter_debugger(
 175         void
 176 );
 177
 178 mach_vm_size_t
 179 kdp_machine_vm_read( mach_vm_address_t, caddr_t, mach_vm_size_t);
 180
 181 mach_vm_size_t
 182 kdp_machine_vm_write( caddr_t, mach_vm_address_t, mach_vm_size_t);
 183
 184 mach_vm_size_t
 185 kdp_machine_phys_read(kdp_readphysmem64_req_t *rq, caddr_t /* data */,
 186                       uint16_t /* lcpu */);
 187
 188 mach_vm_size_t
 189 kdp_machine_phys_write(kdp_writephysmem64_req_t *rq, caddr_t /* data */,
 190                        uint16_t /* lcpu */);
 191
 192 int
 193 kdp_machine_ioport_read(kdp_readioport_req_t *, caddr_t /* data */, uint16_t /* lcpu */);
 194
 195 int
 196 kdp_machine_ioport_write(kdp_writeioport_req_t *, caddr_t /* data */, uint16_t /* lcpu */);
 197
 198 int
 199 kdp_machine_msr64_read(kdp_readmsr64_req_t *, caddr_t /* data */, uint16_t /* lcpu */);
 200
 201 int
 202 kdp_machine_msr64_write(kdp_writemsr64_req_t *, caddr_t /* data */, uint16_t /* lcpu */);
 203