cons.h revision 125467 
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: head/sys/sys/cons.h 125467 2004-02-05 01:56:43Z kan $
40 */
41
42#ifndef _MACHINE_CONS_H_
43#define	_MACHINE_CONS_H_
44
45struct consdev;
46typedef	void	cn_probe_t(struct consdev *);
47typedef	void	cn_init_t(struct consdev *);
48typedef	void	cn_term_t(struct consdev *);
49typedef	int	cn_getc_t(struct consdev *);
50typedef	int	cn_checkc_t(struct consdev *);
51typedef	void	cn_putc_t(struct consdev *, int);
52typedef	void	cn_dbctl_t(struct consdev *, int);
53
54struct consdev {
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_checkc_t	*cn_checkc;
64				/* kernel "return char if available" interface */
65	cn_putc_t	*cn_putc;
66				/* kernel putchar interface */
67	cn_dbctl_t	*cn_dbctl;
68				/* debugger control interface */
69	struct	tty *cn_tp;	/* tty structure for console device */
70	short	cn_pri;		/* pecking order; the higher the better */
71	void	*cn_arg;	/* drivers method argument */
72	int	cn_unit;	/* some drivers prefer this */
73	int	cn_flags;	/* capabilities of this console */
74	char	cn_name[SPECNAMELEN + 1];	/* console (device) name */
75};
76
77/* values for cn_pri - reflect our policy for console selection */
78#define	CN_DEAD		0	/* device doesn't exist */
79#define CN_LOW		1	/* device is a last restort only */
80#define CN_NORMAL	2	/* device exists but is nothing special */
81#define CN_INTERNAL	3	/* "internal" bit-mapped display */
82#define CN_REMOTE	4	/* serial interface with remote bit set */
83
84/* Values for cn_flags. */
85#define	CN_FLAG_NODEBUG	0x00000001	/* Not supported with debugger. */
86#define	CN_FLAG_NOAVAIL	0x00000002	/* Temporarily not available. */
87
88#ifdef _KERNEL
89
90#define CONS_DRIVER(name, probe, init, term, getc, checkc, putc, dbctl)	\
91	static struct consdev name##_consdev = {			\
92		probe, init, term, getc, checkc, putc, dbctl		\
93	};								\
94	DATA_SET(cons_set, name##_consdev)
95
96/* Other kernel entry points. */
97void	cninit(void);
98void	cninit_finish(void);
99int	cnadd(struct consdev *);
100void	cnavailable(struct consdev *, int);
101void	cnremove(struct consdev *);
102void	cnselect(struct consdev *);
103int	cncheckc(void);
104int	cngetc(void);
105void	cndbctl(int);
106void	cnputc(int);
107int	cn_unavailable(void);
108
109#endif /* _KERNEL */
110
111#endif /* !_MACHINE_CONS_H_ */
112