cons.h revision 196506 
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: head/sys/sys/cons.h 196506 2009-08-24 10:53:30Z ed $
36 */
37
38#ifndef _MACHINE_CONS_H_
39#define	_MACHINE_CONS_H_
40
41struct consdev;
42struct tty;
43
44typedef	void	cn_probe_t(struct consdev *);
45typedef	void	cn_init_t(struct consdev *);
46typedef	void	cn_term_t(struct consdev *);
47typedef	int	cn_getc_t(struct consdev *);
48typedef	void	cn_putc_t(struct consdev *, int);
49
50struct consdev_ops {
51	cn_probe_t	*cn_probe;
52				/* probe hardware and fill in consdev info */
53	cn_init_t	*cn_init;
54				/* turn on as console */
55	cn_term_t	*cn_term;
56				/* turn off as console */
57	cn_getc_t	*cn_getc;
58				/* kernel getchar interface */
59	cn_putc_t	*cn_putc;
60				/* kernel putchar interface */
61};
62
63struct consdev {
64	const struct consdev_ops *cn_ops;
65				/* console device operations. */
66	short	cn_pri;		/* pecking order; the higher the better */
67	void	*cn_arg;	/* drivers method argument */
68	int	cn_flags;	/* capabilities of this console */
69	char	cn_name[SPECNAMELEN + 1];	/* console (device) name */
70};
71
72/* values for cn_pri - reflect our policy for console selection */
73#define	CN_DEAD		0	/* device doesn't exist */
74#define CN_LOW		1	/* device is a last restort only */
75#define CN_NORMAL	2	/* device exists but is nothing special */
76#define CN_INTERNAL	3	/* "internal" bit-mapped display */
77#define CN_REMOTE	4	/* serial interface with remote bit set */
78
79/* Values for cn_flags. */
80#define	CN_FLAG_NODEBUG	0x00000001	/* Not supported with debugger. */
81#define	CN_FLAG_NOAVAIL	0x00000002	/* Temporarily not available. */
82
83#ifdef _KERNEL
84
85extern	struct msgbuf consmsgbuf; /* Message buffer for constty. */
86extern	struct tty *constty;	/* Temporary virtual console. */
87
88#define	CONSOLE_DEVICE(name, ops, arg)					\
89	static struct consdev name = {					\
90		.cn_ops = &ops,						\
91		.cn_arg = (arg),					\
92	};								\
93	DATA_SET(cons_set, name)
94
95#define	CONSOLE_DRIVER(name)						\
96	static const struct consdev_ops name##_consdev_ops = {		\
97		.cn_probe = name##_cnprobe,				\
98		.cn_init = name##_cninit,				\
99		.cn_term = name##_cnterm,				\
100		.cn_getc = name##_cngetc,				\
101		.cn_putc = name##_cnputc,				\
102	};								\
103	CONSOLE_DEVICE(name##_consdev, name##_consdev_ops, NULL)
104
105/* Other kernel entry points. */
106void	cninit(void);
107void	cninit_finish(void);
108int	cnadd(struct consdev *);
109void	cnavailable(struct consdev *, int);
110void	cnremove(struct consdev *);
111void	cnselect(struct consdev *);
112int	cncheckc(void);
113int	cngetc(void);
114void	cnputc(int);
115void	cnputs(char *);
116int	cnunavailable(void);
117void	constty_set(struct tty *tp);
118void	constty_clear(void);
119
120#endif /* _KERNEL */
121
122#endif /* !_MACHINE_CONS_H_ */
123