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