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 /* Boot serial mode (see bits below). */ 49 extern uint32_t serialmode; 50 51 /* Is output supported ? */ 52 #define SERIALMODE_OUTPUT 0x01 53 54 /* Is input supported ? */ 55 #define SERIALMODE_INPUT 0x02 56 57 /* Force synchronous output ? */ 58 #define SERIALMODE_SYNCDRAIN 0x04 59 60 /* Load Base/Recovery/FVUnlock TTY */ 61 #define SERIALMODE_BASE_TTY 0x08 62 63 /* Prevent IOLogs writing to serial */ 64 #define SERIALMODE_NO_IOLOG 0x10 65 66 /* Allow DriverKit os_log/IOLogs writing to serial */ 67 #define SERIALMODE_DKLOG 0x20 68 69 /** Start logging on to a serial only once data has been received on this 70 * serial. Requires SERIALMODE_INPUT set, ingored otherwise. */ 71 #define SERIALMODE_ON_DEMAND 0x40 72 73 #if CONFIG_EXCLAVES 74 /* Prevent Exclave Logs writing to serial */ 75 #define SERIALMODE_NO_EXCLAVE 0x80 76 #endif 77 78 extern uint32_t cons_ops_index; 79 extern const uint32_t nconsops; 80 81 /* disable_serial_output disables kprintf() *and* unbuffered panic output. */ 82 extern bool disable_serial_output; 83 84 /* Shortcuts for serialmode & {SERIALMODE_NOIOLOG, SERIALMODE_DKLOG}. */ 85 extern bool disable_iolog_serial_output; 86 extern bool enable_dklog_serial_output; 87 88 void console_init(void); 89 90 int _serial_getc(bool wait); 91 int _vcgetc(bool wait); 92 93 struct console_ops { 94 void (*putc)(char, bool); 95 int (*getc)(bool); 96 }; 97 98 boolean_t console_is_serial(void); 99 int switch_to_serial_console(void); 100 int switch_to_video_console(void); 101 void switch_to_old_console(int old_console); 102 103 #define SERIAL_CONS_OPS 0 104 #define VC_CONS_OPS 1 105 106 #ifdef XNU_KERNEL_PRIVATE 107 108 #define SERIAL_CONS_BUF_SIZE 256 109 struct console_printbuf_state { 110 int pos; 111 int total; 112 int flags; 113 #define CONS_PB_WRITE_NEWLINE 0x1 114 #define CONS_PB_CANBLOCK 0x2 115 char str[SERIAL_CONS_BUF_SIZE]; 116 }; 117 118 extern int console_printbuf_drain_initialized; 119 void console_printbuf_state_init(struct console_printbuf_state * data, int write_on_newline, int can_block); 120 void console_printbuf_putc(int ch, void *arg); 121 void console_printbuf_clear(struct console_printbuf_state * info); 122 int console_write_try(char * str, int size); 123 124 125 #endif /* XNU_KERNEL_PRIVATE */ 126 127 #ifdef __cplusplus 128 } 129 #endif 130 131 132 #endif /* _CONSOLE_SERIAL_PROTOS_H_ */ 133