Merge from vendor branch GDB:
[dragonfly.git] / 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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *      from: @(#)cons.h        7.2 (Berkeley) 5/9/91
39  * $FreeBSD: src/sys/sys/cons.h,v 1.24 2000/01/11 14:54:01 yokota Exp $
40  * $DragonFly: src/sys/sys/cons.h,v 1.4 2003/11/10 06:12:17 dillon Exp $
41  */
42
43 #ifndef _MACHINE_CONS_H_
44 #define _MACHINE_CONS_H_
45
46 struct consdev;
47 typedef void    cn_probe_t (struct consdev *);
48 typedef void    cn_init_t (struct consdev *);
49 typedef void    cn_term_t (struct consdev *);
50 typedef int     cn_getc_t (dev_t);
51 typedef int     cn_checkc_t (dev_t);
52 typedef void    cn_putc_t (dev_t, int);
53 typedef void    cn_dbctl_t (dev_t, int);
54
55 struct consdev {
56         cn_probe_t      *cn_probe;
57                                 /* probe hardware and fill in consdev info */
58         cn_init_t       *cn_init;
59                                 /* turn on as console */
60         cn_term_t       *cn_term;
61                                 /* turn off as console */
62         cn_getc_t       *cn_getc;
63                                 /* kernel getchar interface */
64         cn_checkc_t     *cn_checkc;
65                                 /* kernel "return char if available" interface */
66         cn_putc_t       *cn_putc;
67                                 /* kernel putchar interface */
68         cn_dbctl_t      *cn_dbctl;
69                                 /* debugger control interface */
70         struct  tty *cn_tp;     /* tty structure for console device */
71         dev_t   cn_dev;         /* major/minor of device */
72         short   cn_pri;         /* pecking order; the higher the better */
73 };
74
75 /* values for cn_pri - reflect our policy for console selection */
76 #define CN_DEAD         0       /* device doesn't exist */
77 #define CN_NORMAL       1       /* device exists but is nothing special */
78 #define CN_INTERNAL     2       /* "internal" bit-mapped display */
79 #define CN_REMOTE       3       /* serial interface with remote bit set */
80
81 #ifdef _KERNEL
82 extern  int cons_unavail;
83 extern  struct consdev *cn_tab;
84
85 #define CONS_DRIVER(name, probe, init, term, getc, checkc, putc, dbctl) \
86         static struct consdev name##_consdev = {                        \
87                 probe, init, term, getc, checkc, putc, dbctl            \
88         };                                                              \
89         DATA_SET(cons_set, name##_consdev)
90
91 /* Other kernel entry points. */
92 int     cncheckc (void);
93 int     cngetc (void);
94 void    cninit (void);
95 void    cninit_finish (void);
96 void    cndbctl (int);
97 void    cnputc (int);
98
99 #endif /* _KERNEL */
100
101 #endif /* !_MACHINE_CONS_H_ */