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