FreeBSD/Linux Kernel Cross Reference
sys/sys/cons.h
1 /*-
2 * Copyright (c) 1988 University of Utah.
3 * Copyright (c) 1991 The Regents of the University of California.
4 * All rights reserved.
5 *
6 * This code is derived from software contributed to Berkeley by
7 * the Systems Programming Group of the University of Utah Computer
8 * Science Department.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * from: @(#)cons.h 7.2 (Berkeley) 5/9/91
35 * $FreeBSD: src/sys/sys/cons.h,v 1.42 2008/10/27 11:45:31 ed Exp $
36 */
37
38 #ifndef _MACHINE_CONS_H_
39 #define _MACHINE_CONS_H_
40
41 struct consdev;
42 struct tty;
43
44 typedef void cn_probe_t(struct consdev *);
45 typedef void cn_init_t(struct consdev *);
46 typedef void cn_term_t(struct consdev *);
47 typedef int cn_getc_t(struct consdev *);
48 typedef int cn_checkc_t(struct consdev *);
49 typedef void cn_putc_t(struct consdev *, int);
50
51 struct consdev {
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_checkc_t *cn_checkc;
61 /* kernel "return char if available" interface */
62 cn_putc_t *cn_putc;
63 /* kernel putchar interface */
64 short cn_pri; /* pecking order; the higher the better */
65 void *cn_arg; /* drivers method argument */
66 int cn_flags; /* capabilities of this console */
67 char cn_name[SPECNAMELEN + 1]; /* console (device) name */
68 };
69
70 /* values for cn_pri - reflect our policy for console selection */
71 #define CN_DEAD 0 /* device doesn't exist */
72 #define CN_LOW 1 /* device is a last restort only */
73 #define CN_NORMAL 2 /* device exists but is nothing special */
74 #define CN_INTERNAL 3 /* "internal" bit-mapped display */
75 #define CN_REMOTE 4 /* serial interface with remote bit set */
76
77 /* Values for cn_flags. */
78 #define CN_FLAG_NODEBUG 0x00000001 /* Not supported with debugger. */
79 #define CN_FLAG_NOAVAIL 0x00000002 /* Temporarily not available. */
80
81 #ifdef _KERNEL
82
83 extern struct msgbuf consmsgbuf; /* Message buffer for constty. */
84 extern struct tty *constty; /* Temporary virtual console. */
85
86 #define CONS_DRIVER(name, probe, init, term, getc, checkc, putc, dbctl) \
87 static struct consdev name##_consdev = { \
88 probe, init, term, getc, checkc, putc \
89 }; \
90 DATA_SET(cons_set, name##_consdev)
91
92 #define CONSOLE_DRIVER(name) \
93 static struct consdev name##_consdev = { \
94 .cn_probe = name##_cnprobe, \
95 .cn_init = name##_cninit, \
96 .cn_term = name##_cnterm, \
97 .cn_getc = name##_cngetc, \
98 .cn_putc = name##_cnputc, \
99 }; \
100 DATA_SET(cons_set, name##_consdev)
101
102 /* Other kernel entry points. */
103 void cninit(void);
104 void cninit_finish(void);
105 int cnadd(struct consdev *);
106 void cnavailable(struct consdev *, int);
107 void cnremove(struct consdev *);
108 void cnselect(struct consdev *);
109 int cncheckc(void);
110 int cngetc(void);
111 void cnputc(int);
112 void cnputs(char *);
113 int cnunavailable(void);
114 void constty_set(struct tty *tp);
115 void constty_clear(void);
116
117 #endif /* _KERNEL */
118
119 #endif /* !_MACHINE_CONS_H_ */
120
|