xref: /dragonfly/sys/sys/cons.h (revision 36a3d1d6)
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.7 2007/05/07 05:21:42 dillon Exp $
41  */
42 
43 #ifndef _MACHINE_CONS_H_
44 #define	_MACHINE_CONS_H_
45 
46 #ifndef _SYS_TYPES_H_
47 #include <sys/types.h>
48 #endif
49 
50 struct consdev;
51 
52 typedef	void	cn_probe_t (struct consdev *);
53 typedef	void	cn_init_t (struct consdev *);
54 typedef	void	cn_init_fini_t (struct consdev *);
55 typedef	void	cn_term_t (struct consdev *);
56 typedef	int	cn_getc_t (void *);
57 typedef	int	cn_checkc_t (void *);
58 typedef	void	cn_putc_t (void *, int);
59 typedef	void	cn_dbctl_t (void *, int);
60 
61 struct consdev {
62 	cn_probe_t	*cn_probe;	/* probe hardware */
63 	cn_init_t	*cn_init;	/* initialize for use */
64 	cn_init_fini_t	*cn_init_fini;	/* tie in cdev_t */
65 	cn_term_t	*cn_term;	/* terminate use as console */
66 	cn_getc_t	*cn_getc;	/* kernel getchar interface */
67 	cn_checkc_t	*cn_checkc;	/* kernel test char ready */
68 	cn_putc_t	*cn_putc;	/* kernel putchar interface */
69 	cn_dbctl_t	*cn_dbctl;	/* debugger control interface */
70 	struct	tty *cn_tp;	/* tty structure for console device */
71 	cdev_t	cn_dev;		/* device after cn_init_fini tie-in */
72 	short	cn_pri;		/* pecking order; the higher the better */
73 	short	cn_probegood;	/* probe routine must set to non-zero */
74 	void	*cn_private;	/* private data for get/check/put/dbctl */
75 	void	*cn_gdbprivate;	/* private data for gdb */
76 	int		cn_unit;	/* some drivers prefer this */
77 	int		cn_flags;	/* capabilities of this console */
78 	//char	cn_name[SPECNAMELEN + 1];	/* console (device) name */
79 
80 };
81 
82 /* Values for cn_flags. */
83 #define	CN_FLAG_NODEBUG	0x00000001	/* Not supported with debugger. */
84 #define	CN_FLAG_NOAVAIL	0x00000002	/* Temporarily not available. */
85 
86 
87 /* values for cn_pri - reflect our policy for console selection */
88 #define	CN_DEAD		0	/* device doesn't exist */
89 #define CN_NORMAL	1	/* device exists but is nothing special */
90 #define CN_INTERNAL	2	/* "internal" bit-mapped display */
91 #define CN_REMOTE	3	/* serial interface with remote bit set */
92 
93 #ifdef _KERNEL
94 extern	int cons_unavail;
95 extern	struct consdev *cn_tab;	/* console device */
96 extern  struct consdev *gdb_tab;/* gdb debugger device */
97 
98 #define CONS_DRIVER(name, probe, init, initfini, term, getc, checkc, putc, dbctl)	\
99 	static struct consdev name##_consdev = {			\
100 		probe, init, initfini, term, getc, checkc, putc, dbctl	\
101 	};								\
102 	DATA_SET(cons_set, name##_consdev)
103 
104 /* Other kernel entry points. */
105 int	cncheckc (void);
106 int	cngetc (void);
107 void	cninit (void);
108 void	cninit_finish (void);
109 void	cndbctl (int);
110 void	cnputc (int);
111 
112 #endif /* _KERNEL */
113 
114 #endif /* !_MACHINE_CONS_H_ */
115