xref: /xnu-11215.41.3/osfmk/kdp/kdp_serial.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 2008 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 #ifndef _KDP_SERIAL_H_
29 #define _KDP_SERIAL_H_
30 
31 /*
32  * APIs for escaping a KDP UDP packet into a byte stream suitable
33  * for a standard serial console
34  */
35 
36 enum {SERIALIZE_WAIT_START, SERIALIZE_READING};
37 
38 /*
39  * Take a buffer of specified length and output it with the given
40  * function. Escapes special characters as needed
41  */
42 void kdp_serialize_packet(unsigned char *, unsigned int, void (*func)(char));
43 
44 /*
45  * Add a new character to an internal buffer, and return that
46  * buffer when a fully constructed packet has been identified.
47  * Will track intermediate state using magic enums above
48  */
49 unsigned char *kdp_unserialize_packet(unsigned char, unsigned int *);
50 
51 #endif
52