1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1988 University of Utah. 5 * Copyright (c) 1991 The Regents of the University of California. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * the Systems Programming Group of the University of Utah Computer 10 * Science Department. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 */ 36 37 #ifndef _MACHINE_CONS_H_ 38 #define _MACHINE_CONS_H_ 39 40 struct consdev; 41 struct tty; 42 43 typedef void cn_probe_t(struct consdev *); 44 typedef void cn_init_t(struct consdev *); 45 typedef void cn_term_t(struct consdev *); 46 typedef void cn_grab_t(struct consdev *); 47 typedef void cn_ungrab_t(struct consdev *); 48 typedef int cn_getc_t(struct consdev *); 49 typedef void cn_putc_t(struct consdev *, int); 50 51 struct consdev_ops { 52 cn_probe_t *cn_probe; 53 /* probe hardware and fill in consdev info */ 54 cn_init_t *cn_init; 55 /* turn on as console */ 56 cn_term_t *cn_term; 57 /* turn off as console */ 58 cn_getc_t *cn_getc; 59 /* kernel getchar interface */ 60 cn_putc_t *cn_putc; 61 /* kernel putchar interface */ 62 cn_grab_t *cn_grab; 63 /* grab console for exclusive kernel use */ 64 cn_ungrab_t *cn_ungrab; 65 /* ungrab console */ 66 cn_init_t *cn_resume; 67 /* set up console after sleep, optional */ 68 }; 69 70 struct consdev { 71 const struct consdev_ops *cn_ops; 72 /* console device operations. */ 73 short cn_pri; /* pecking order; the higher the better */ 74 void *cn_arg; /* drivers method argument */ 75 int cn_flags; /* capabilities of this console */ 76 char cn_name[SPECNAMELEN + 1]; /* console (device) name */ 77 }; 78 79 /* values for cn_pri - reflect our policy for console selection */ 80 #define CN_DEAD 0 /* device doesn't exist */ 81 #define CN_LOW 1 /* device is a last restort only */ 82 #define CN_NORMAL 2 /* device exists but is nothing special */ 83 #define CN_INTERNAL 3 /* "internal" bit-mapped display */ 84 #define CN_REMOTE 4 /* serial interface with remote bit set */ 85 86 /* Values for cn_flags. */ 87 #define CN_FLAG_NODEBUG 0x00000001 /* Not supported with debugger. */ 88 #define CN_FLAG_NOAVAIL 0x00000002 /* Temporarily not available. */ 89 90 /* Visibility of characters in cngets() */ 91 #define GETS_NOECHO 0 /* Disable echoing of characters. */ 92 #define GETS_ECHO 1 /* Enable echoing of characters. */ 93 #define GETS_ECHOPASS 2 /* Print a * for every character. */ 94 95 #ifdef _KERNEL 96 97 extern int cn_mute; 98 99 extern struct msgbuf consmsgbuf; /* Message buffer for constty. */ 100 extern struct tty *constty; /* Temporary virtual console. */ 101 102 #define CONSOLE_DEVICE(name, ops, arg) \ 103 static struct consdev name = { \ 104 .cn_ops = &ops, \ 105 .cn_arg = (arg), \ 106 }; \ 107 DATA_SET(cons_set, name) 108 109 #define CONSOLE_DRIVER(name, ...) \ 110 static const struct consdev_ops name##_consdev_ops = { \ 111 /* Mandatory methods. */ \ 112 .cn_probe = name##_cnprobe, \ 113 .cn_init = name##_cninit, \ 114 .cn_term = name##_cnterm, \ 115 .cn_getc = name##_cngetc, \ 116 .cn_putc = name##_cnputc, \ 117 .cn_grab = name##_cngrab, \ 118 .cn_ungrab = name##_cnungrab, \ 119 /* Optional fields. */ \ 120 __VA_ARGS__ \ 121 }; \ 122 CONSOLE_DEVICE(name##_consdev, name##_consdev_ops, NULL) 123 124 /* Other kernel entry points. */ 125 void cninit(void); 126 void cninit_finish(void); 127 int cnadd(struct consdev *); 128 void cnavailable(struct consdev *, int); 129 void cnremove(struct consdev *); 130 void cnselect(struct consdev *); 131 void cngrab(void); 132 void cnungrab(void); 133 void cnresume(void); 134 int cncheckc(void); 135 int cngetc(void); 136 void cngets(char *, size_t, int); 137 void cnputc(int); 138 void cnputs(const char *); 139 void cnputsn(const char *, size_t); 140 int cnunavailable(void); 141 int constty_set(struct tty *tp); 142 int constty_clear(struct tty *tp); 143 144 /* sc(4) / vt(4) coexistence shim */ 145 #define VTY_SC 0x01 146 #define VTY_VT 0x02 147 int vty_enabled(unsigned int); 148 void vty_set_preferred(unsigned int); 149 150 #endif /* _KERNEL */ 151 152 #endif /* !_MACHINE_CONS_H_ */ 153