1*43a90889SApple OSS Distributions /* 2*43a90889SApple OSS Distributions * Copyright (c) 2005-2020 Apple Computer, Inc. All rights reserved. 3*43a90889SApple OSS Distributions * 4*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*43a90889SApple OSS Distributions * 6*43a90889SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*43a90889SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*43a90889SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*43a90889SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*43a90889SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*43a90889SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*43a90889SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*43a90889SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*43a90889SApple OSS Distributions * 15*43a90889SApple OSS Distributions * Please obtain a copy of the License at 16*43a90889SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*43a90889SApple OSS Distributions * 18*43a90889SApple OSS Distributions * The Original Code and all software distributed under the License are 19*43a90889SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*43a90889SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*43a90889SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*43a90889SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*43a90889SApple OSS Distributions * Please see the License for the specific language governing rights and 24*43a90889SApple OSS Distributions * limitations under the License. 25*43a90889SApple OSS Distributions * 26*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*43a90889SApple OSS Distributions */ 28*43a90889SApple OSS Distributions /* 29*43a90889SApple OSS Distributions * @OSF_COPYRIGHT@ 30*43a90889SApple OSS Distributions */ 31*43a90889SApple OSS Distributions /* 32*43a90889SApple OSS Distributions * @APPLE_FREE_COPYRIGHT@ 33*43a90889SApple OSS Distributions */ 34*43a90889SApple OSS Distributions 35*43a90889SApple OSS Distributions #ifndef _CONSOLE_SERIAL_PROTOS_H_ 36*43a90889SApple OSS Distributions #define _CONSOLE_SERIAL_PROTOS_H_ 37*43a90889SApple OSS Distributions 38*43a90889SApple OSS Distributions #ifdef __cplusplus 39*43a90889SApple OSS Distributions extern "C" { 40*43a90889SApple OSS Distributions #endif 41*43a90889SApple OSS Distributions 42*43a90889SApple OSS Distributions #include <stdbool.h> 43*43a90889SApple OSS Distributions 44*43a90889SApple OSS Distributions void serial_keyboard_init(void); 45*43a90889SApple OSS Distributions void serial_keyboard_start(void) __dead2; 46*43a90889SApple OSS Distributions void serial_keyboard_poll(void) __dead2; 47*43a90889SApple OSS Distributions 48*43a90889SApple OSS Distributions /* Boot serial mode (see bits below). */ 49*43a90889SApple OSS Distributions extern uint32_t serialmode; 50*43a90889SApple OSS Distributions 51*43a90889SApple OSS Distributions /* Is output supported ? */ 52*43a90889SApple OSS Distributions #define SERIALMODE_OUTPUT 0x01 53*43a90889SApple OSS Distributions 54*43a90889SApple OSS Distributions /* Is input supported ? */ 55*43a90889SApple OSS Distributions #define SERIALMODE_INPUT 0x02 56*43a90889SApple OSS Distributions 57*43a90889SApple OSS Distributions /* Force synchronous output ? */ 58*43a90889SApple OSS Distributions #define SERIALMODE_SYNCDRAIN 0x04 59*43a90889SApple OSS Distributions 60*43a90889SApple OSS Distributions /* Load Base/Recovery/FVUnlock TTY */ 61*43a90889SApple OSS Distributions #define SERIALMODE_BASE_TTY 0x08 62*43a90889SApple OSS Distributions 63*43a90889SApple OSS Distributions /* Prevent IOLogs writing to serial */ 64*43a90889SApple OSS Distributions #define SERIALMODE_NO_IOLOG 0x10 65*43a90889SApple OSS Distributions 66*43a90889SApple OSS Distributions /* Allow DriverKit os_log/IOLogs writing to serial */ 67*43a90889SApple OSS Distributions #define SERIALMODE_DKLOG 0x20 68*43a90889SApple OSS Distributions 69*43a90889SApple OSS Distributions /** Start logging on to a serial only once data has been received on this 70*43a90889SApple OSS Distributions * serial. Requires SERIALMODE_INPUT set, ingored otherwise. */ 71*43a90889SApple OSS Distributions #define SERIALMODE_ON_DEMAND 0x40 72*43a90889SApple OSS Distributions 73*43a90889SApple OSS Distributions #if CONFIG_EXCLAVES 74*43a90889SApple OSS Distributions /* Prevent Exclave Logs writing to serial */ 75*43a90889SApple OSS Distributions #define SERIALMODE_NO_EXCLAVE 0x80 76*43a90889SApple OSS Distributions #endif 77*43a90889SApple OSS Distributions 78*43a90889SApple OSS Distributions extern uint32_t cons_ops_index; 79*43a90889SApple OSS Distributions extern const uint32_t nconsops; 80*43a90889SApple OSS Distributions 81*43a90889SApple OSS Distributions /* disable_serial_output disables kprintf() *and* unbuffered panic output. */ 82*43a90889SApple OSS Distributions extern bool disable_serial_output; 83*43a90889SApple OSS Distributions 84*43a90889SApple OSS Distributions /* Shortcuts for serialmode & {SERIALMODE_NOIOLOG, SERIALMODE_DKLOG}. */ 85*43a90889SApple OSS Distributions extern bool disable_iolog_serial_output; 86*43a90889SApple OSS Distributions extern bool enable_dklog_serial_output; 87*43a90889SApple OSS Distributions 88*43a90889SApple OSS Distributions void console_init(void); 89*43a90889SApple OSS Distributions 90*43a90889SApple OSS Distributions int _serial_getc(bool wait); 91*43a90889SApple OSS Distributions int _vcgetc(bool wait); 92*43a90889SApple OSS Distributions 93*43a90889SApple OSS Distributions struct console_ops { 94*43a90889SApple OSS Distributions void (*putc)(char, bool); 95*43a90889SApple OSS Distributions int (*getc)(bool); 96*43a90889SApple OSS Distributions }; 97*43a90889SApple OSS Distributions 98*43a90889SApple OSS Distributions boolean_t console_is_serial(void); 99*43a90889SApple OSS Distributions int switch_to_serial_console(void); 100*43a90889SApple OSS Distributions int switch_to_video_console(void); 101*43a90889SApple OSS Distributions void switch_to_old_console(int old_console); 102*43a90889SApple OSS Distributions 103*43a90889SApple OSS Distributions #define SERIAL_CONS_OPS 0 104*43a90889SApple OSS Distributions #define VC_CONS_OPS 1 105*43a90889SApple OSS Distributions 106*43a90889SApple OSS Distributions #ifdef XNU_KERNEL_PRIVATE 107*43a90889SApple OSS Distributions 108*43a90889SApple OSS Distributions #define SERIAL_CONS_BUF_SIZE 256 109*43a90889SApple OSS Distributions struct console_printbuf_state { 110*43a90889SApple OSS Distributions int pos; 111*43a90889SApple OSS Distributions int total; 112*43a90889SApple OSS Distributions int flags; 113*43a90889SApple OSS Distributions #define CONS_PB_WRITE_NEWLINE 0x1 114*43a90889SApple OSS Distributions #define CONS_PB_CANBLOCK 0x2 115*43a90889SApple OSS Distributions char str[SERIAL_CONS_BUF_SIZE]; 116*43a90889SApple OSS Distributions }; 117*43a90889SApple OSS Distributions 118*43a90889SApple OSS Distributions extern int console_printbuf_drain_initialized; 119*43a90889SApple OSS Distributions void console_printbuf_state_init(struct console_printbuf_state * data, int write_on_newline, int can_block); 120*43a90889SApple OSS Distributions void console_printbuf_putc(int ch, void *arg); 121*43a90889SApple OSS Distributions void console_printbuf_clear(struct console_printbuf_state * info); 122*43a90889SApple OSS Distributions int console_write_try(char * str, int size); 123*43a90889SApple OSS Distributions 124*43a90889SApple OSS Distributions 125*43a90889SApple OSS Distributions #endif /* XNU_KERNEL_PRIVATE */ 126*43a90889SApple OSS Distributions 127*43a90889SApple OSS Distributions #ifdef __cplusplus 128*43a90889SApple OSS Distributions } 129*43a90889SApple OSS Distributions #endif 130*43a90889SApple OSS Distributions 131*43a90889SApple OSS Distributions 132*43a90889SApple OSS Distributions #endif /* _CONSOLE_SERIAL_PROTOS_H_ */ 133