xref: /xnu-8019.80.24/osfmk/console/serial_protos.h (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1 /*
2  * Copyright (c) 2005-2020 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  * @OSF_COPYRIGHT@
30  */
31 /*
32  * @APPLE_FREE_COPYRIGHT@
33  */
34 
35 #ifndef _CONSOLE_SERIAL_PROTOS_H_
36 #define _CONSOLE_SERIAL_PROTOS_H_
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 #include <stdbool.h>
43 
44 void serial_keyboard_init(void);
45 void serial_keyboard_start(void) __dead2;
46 void serial_keyboard_poll(void) __dead2;
47 
48 extern uint32_t serialmode;
49 
50 #define SERIALMODE_OUTPUT    0x01
51 #define SERIALMODE_INPUT     0x02
52 #define SERIALMODE_SYNCDRAIN 0x04
53 #define SERIALMODE_BASE_TTY  0x08 /* Load Base/Recovery/FVUnlock TTY */
54 #define SERIALMODE_NO_IOLOG  0x10 /* prevent IOLogs writing to serial */
55 
56 extern uint32_t cons_ops_index;
57 extern const uint32_t nconsops;
58 extern bool disable_serial_output;
59 extern bool disable_iolog_serial_output;
60 
61 void console_init(void);
62 
63 int _serial_getc(bool wait);
64 int _vcgetc(bool wait);
65 
66 struct console_ops {
67 	void (*putc)(char, bool);
68 	int (*getc)(bool);
69 };
70 
71 boolean_t console_is_serial(void);
72 int switch_to_serial_console(void);
73 int switch_to_video_console(void);
74 void switch_to_old_console(int old_console);
75 
76 #define SERIAL_CONS_OPS 0
77 #define VC_CONS_OPS 1
78 
79 #ifdef XNU_KERNEL_PRIVATE
80 
81 #define SERIAL_CONS_BUF_SIZE  256
82 struct console_printbuf_state {
83 	int pos;
84 	int total;
85 	int flags;
86 #define CONS_PB_WRITE_NEWLINE  0x1
87 #define CONS_PB_CANBLOCK       0x2
88 	char str[SERIAL_CONS_BUF_SIZE];
89 };
90 
91 extern int console_printbuf_drain_initialized;
92 void console_printbuf_state_init(struct console_printbuf_state * data, int write_on_newline, int can_block);
93 void console_printbuf_putc(int ch, void *arg);
94 void console_printbuf_clear(struct console_printbuf_state * info);
95 int console_write_try(char * str, int size);
96 
97 
98 #endif /* XNU_KERNEL_PRIVATE */
99 
100 #ifdef __cplusplus
101 }
102 #endif
103 
104 
105 #endif /* _CONSOLE_SERIAL_PROTOS_H_ */
106