osfmk/kdp/ml/i386/kdp_x86_common.h

   1 /*
   2  * Copyright (c) 2011 Apple 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 #ifndef _KDP_X86_COMMON_H_
  30 #define _KDP_X86_COMMON_H_
  31
  32 #include <libsa/types.h>
  33 #include <mach/machine/vm_types.h>
  34 #include <i386/pmap.h>
  35
  36 /* data required for JTAG extraction of coredump */
  37 typedef struct _kdp_jtag_coredump_t {
  38         uint64_t signature;
  39         uint64_t version;
  40         uint64_t kernel_map_start;
  41         uint64_t kernel_map_end;
  42         uint64_t kernel_pmap_pml4;
  43         uint64_t pmap_memory_regions;
  44         uint64_t pmap_memory_region_count;
  45         uint64_t pmap_memory_region_t_size;
  46         uint64_t physmap_base;
  47 } kdp_jtag_coredump_t;
  48
  49 /* signature used to verify kdp_jtag_coredump_t structure */
  50 #define KDP_JTAG_COREDUMP_SIGNATURE     0x434f524544554d50
  51
  52 /* version of kdp_jtag_coredump_t structure */
  53 #define KDP_JTAG_COREDUMP_VERSION_1     1
  54
  55 void kdp_map_debug_pagetable_window(void);
  56 void kdp_jtag_coredump_init(void);
  57
  58 #endif /* _KDP_X86_COMMON_H_ */