FreeBSD/Linux Kernel Cross Reference
sys/sys/cons.h
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 * from: @(#)cons.h 7.2 (Berkeley) 5/9/91
37 * $FreeBSD: releng/12.0/sys/sys/cons.h 334340 2018-05-29 16:16:24Z avg $
38 */
39
40 #ifndef _MACHINE_CONS_H_
41 #define _MACHINE_CONS_H_
42
43 struct consdev;
44 struct tty;
45
46 typedef void cn_probe_t(struct consdev *);
47 typedef void cn_init_t(struct consdev *);
48 typedef void cn_term_t(struct consdev *);
49 typedef void cn_grab_t(struct consdev *);
50 typedef void cn_ungrab_t(struct consdev *);
51 typedef int cn_getc_t(struct consdev *);
52 typedef void cn_putc_t(struct consdev *, int);
53
54 struct consdev_ops {
55 cn_probe_t *cn_probe;
56 /* probe hardware and fill in consdev info */
57 cn_init_t *cn_init;
58 /* turn on as console */
59 cn_term_t *cn_term;
60 /* turn off as console */
61 cn_getc_t *cn_getc;
62 /* kernel getchar interface */
63 cn_putc_t *cn_putc;
64 /* kernel putchar interface */
65 cn_grab_t *cn_grab;
66 /* grab console for exclusive kernel use */
67 cn_ungrab_t *cn_ungrab;
68 /* ungrab console */
69 cn_init_t *cn_resume;
70 /* set up console after sleep, optional */
71 };
72
73 struct consdev {
74 const struct consdev_ops *cn_ops;
75 /* console device operations. */
76 short cn_pri; /* pecking order; the higher the better */
77 void *cn_arg; /* drivers method argument */
78 int cn_flags; /* capabilities of this console */
79 char cn_name[SPECNAMELEN + 1]; /* console (device) name */
80 };
81
82 /* values for cn_pri - reflect our policy for console selection */
83 #define CN_DEAD 0 /* device doesn't exist */
84 #define CN_LOW 1 /* device is a last restort only */
85 #define CN_NORMAL 2 /* device exists but is nothing special */
86 #define CN_INTERNAL 3 /* "internal" bit-mapped display */
87 #define CN_REMOTE 4 /* serial interface with remote bit set */
88
89 /* Values for cn_flags. */
90 #define CN_FLAG_NODEBUG 0x00000001 /* Not supported with debugger. */
91 #define CN_FLAG_NOAVAIL 0x00000002 /* Temporarily not available. */
92
93 /* Visibility of characters in cngets() */
94 #define GETS_NOECHO 0 /* Disable echoing of characters. */
95 #define GETS_ECHO 1 /* Enable echoing of characters. */
96 #define GETS_ECHOPASS 2 /* Print a * for every character. */
97
98 #ifdef _KERNEL
99
100 extern struct msgbuf consmsgbuf; /* Message buffer for constty. */
101 extern struct tty *constty; /* Temporary virtual console. */
102
103 #define CONSOLE_DEVICE(name, ops, arg) \
104 static struct consdev name = { \
105 .cn_ops = &ops, \
106 .cn_arg = (arg), \
107 }; \
108 DATA_SET(cons_set, name)
109
110 #define CONSOLE_DRIVER(name, ...) \
111 static const struct consdev_ops name##_consdev_ops = { \
112 /* Mandatory methods. */ \
113 .cn_probe = name##_cnprobe, \
114 .cn_init = name##_cninit, \
115 .cn_term = name##_cnterm, \
116 .cn_getc = name##_cngetc, \
117 .cn_putc = name##_cnputc, \
118 .cn_grab = name##_cngrab, \
119 .cn_ungrab = name##_cnungrab, \
120 /* Optional fields. */ \
121 __VA_ARGS__ \
122 }; \
123 CONSOLE_DEVICE(name##_consdev, name##_consdev_ops, NULL)
124
125 /* Other kernel entry points. */
126 void cninit(void);
127 void cninit_finish(void);
128 int cnadd(struct consdev *);
129 void cnavailable(struct consdev *, int);
130 void cnremove(struct consdev *);
131 void cnselect(struct consdev *);
132 void cngrab(void);
133 void cnungrab(void);
134 void cnresume(void);
135 int cncheckc(void);
136 int cngetc(void);
137 void cngets(char *, size_t, int);
138 void cnputc(int);
139 void cnputs(char *);
140 int cnunavailable(void);
141 void constty_set(struct tty *tp);
142 void constty_clear(void);
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_ */
Cache object: 23c2c8e8c26c17e15e0b9e7c27410784
|