]> git.saurik.com Git - apple/xnu.git/blame - osfmk/kdp/kdp_core.h
xnu-792.18.15.tar.gz
[apple/xnu.git] / osfmk / kdp / kdp_core.h
CommitLineData
91447636
A
1/*
2 * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
3 *
8f6c56a5 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636 5 *
8f6c56a5
A
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
8ad349bb 24 * limitations under the License.
8f6c56a5
A
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
91447636
A
27 */
28
29/* HISTORY
30 * 8 Aug. 2003 - Created (Derek Kumar)
31 */
32
55e303ae 33/* Various protocol definitions
91447636 34 * for the core transfer protocol, which is a variant of TFTP
55e303ae
A
35 */
36
37/*
38 * Packet types.
39 */
40#define KDP_RRQ 1 /* read request */
41#define KDP_WRQ 2 /* write request */
42#define KDP_DATA 3 /* data packet */
43#define KDP_ACK 4 /* acknowledgement */
44#define KDP_ERROR 5 /* error code */
45#define KDP_SEEK 6 /* Seek to specified offset */
46#define KDP_EOF 7 /* signal end of file */
47struct corehdr {
48 short th_opcode; /* packet type */
49 union {
50 unsigned int tu_block; /* block # */
51 unsigned int tu_code; /* error code */
52 char tu_rpl[1]; /* request packet payload */
53 } th_u;
54 char th_data[1]; /* data or error string */
55}__attribute__((packed));
56
57#define th_block th_u.tu_block
58#define th_code th_u.tu_code
59#define th_stuff th_u.tu_rpl
60#define th_msg th_data
61
62/*
63 * Error codes.
64 */
65#define EUNDEF 0 /* not defined */
66#define ENOTFOUND 1 /* file not found */
67#define EACCESS 2 /* access violation */
68#define ENOSPACE 3 /* disk full or allocation exceeded */
69#define EBADOP 4 /* illegal TFTP operation */
70#define EBADID 5 /* unknown transfer ID */
71#define EEXISTS 6 /* file already exists */
72#define ENOUSER 7 /* no such user */
73
74#define CORE_REMOTE_PORT 1069 /* hardwired, we can't really query the services file */
75
76void kdp_panic_dump (void);
77
78void abort_panic_transfer (void);
79
80struct corehdr *create_panic_header(unsigned int request, const char *corename, unsigned length, unsigned block);
81
89b3af67
A
82int kdp_send_crashdump_pkt(unsigned int request, char *corename,
83 unsigned int length, void *panic_data);
84
85int kdp_send_crashdump_data(unsigned int request, char *corename,
86 unsigned int length, caddr_t txstart);