cons.h revision 335659 
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: stable/11/sys/sys/cons.h 335659 2018-06-26 09:04:24Z avg $
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	void	cn_grab_t(struct consdev *);
48typedef	void	cn_ungrab_t(struct consdev *);
49typedef	int	cn_getc_t(struct consdev *);
50typedef	void	cn_putc_t(struct consdev *, int);
51
52struct consdev_ops {
53	cn_probe_t	*cn_probe;
54				/* probe hardware and fill in consdev info */
55	cn_init_t	*cn_init;
56				/* turn on as console */
57	cn_term_t	*cn_term;
58				/* turn off as console */
59	cn_getc_t	*cn_getc;
60				/* kernel getchar interface */
61	cn_putc_t	*cn_putc;
62				/* kernel putchar interface */
63	cn_grab_t	*cn_grab;
64				/* grab console for exclusive kernel use */
65	cn_ungrab_t	*cn_ungrab;
66				/* ungrab console */
67	cn_init_t	*cn_resume;
68				/* set up console after sleep, optional */
69};
70
71struct consdev {
72	const struct consdev_ops *cn_ops;
73				/* console device operations. */
74	short	cn_pri;		/* pecking order; the higher the better */
75	void	*cn_arg;	/* drivers method argument */
76	int	cn_flags;	/* capabilities of this console */
77	char	cn_name[SPECNAMELEN + 1];	/* console (device) name */
78};
79
80/* values for cn_pri - reflect our policy for console selection */
81#define	CN_DEAD		0	/* device doesn't exist */
82#define CN_LOW		1	/* device is a last restort only */
83#define CN_NORMAL	2	/* device exists but is nothing special */
84#define CN_INTERNAL	3	/* "internal" bit-mapped display */
85#define CN_REMOTE	4	/* serial interface with remote bit set */
86
87/* Values for cn_flags. */
88#define	CN_FLAG_NODEBUG	0x00000001	/* Not supported with debugger. */
89#define	CN_FLAG_NOAVAIL	0x00000002	/* Temporarily not available. */
90
91/* Visibility of characters in cngets() */
92#define	GETS_NOECHO	0	/* Disable echoing of characters. */
93#define	GETS_ECHO	1	/* Enable echoing of characters. */
94#define	GETS_ECHOPASS	2	/* Print a * for every character. */
95
96#ifdef _KERNEL
97
98extern	struct msgbuf consmsgbuf; /* Message buffer for constty. */
99extern	struct tty *constty;	/* Temporary virtual console. */
100
101#define	CONSOLE_DEVICE(name, ops, arg)					\
102	static struct consdev name = {					\
103		.cn_ops = &ops,						\
104		.cn_arg = (arg),					\
105	};								\
106	DATA_SET(cons_set, name)
107
108#define	CONSOLE_DRIVER(name, ...)					\
109	static const struct consdev_ops name##_consdev_ops = {		\
110		/* Mandatory methods. */				\
111		.cn_probe = name##_cnprobe,				\
112		.cn_init = name##_cninit,				\
113		.cn_term = name##_cnterm,				\
114		.cn_getc = name##_cngetc,				\
115		.cn_putc = name##_cnputc,				\
116		.cn_grab = name##_cngrab,				\
117		.cn_ungrab = name##_cnungrab,				\
118		/* Optional fields. */					\
119		__VA_ARGS__						\
120	};								\
121	CONSOLE_DEVICE(name##_consdev, name##_consdev_ops, NULL)
122
123/* Other kernel entry points. */
124void	cninit(void);
125void	cninit_finish(void);
126int	cnadd(struct consdev *);
127void	cnavailable(struct consdev *, int);
128void	cnremove(struct consdev *);
129void	cnselect(struct consdev *);
130void	cngrab(void);
131void	cnungrab(void);
132void	cnresume(void);
133int	cncheckc(void);
134int	cngetc(void);
135void	cngets(char *, size_t, int);
136void	cnputc(int);
137void	cnputs(char *);
138int	cnunavailable(void);
139void	constty_set(struct tty *tp);
140void	constty_clear(void);
141
142/* sc(4) / vt(4) coexistence shim */
143#define	VTY_SC 0x01
144#define	VTY_VT 0x02
145int	vty_enabled(unsigned int);
146void	vty_set_preferred(unsigned int);
147
148#endif /* _KERNEL */
149
150#endif /* !_MACHINE_CONS_H_ */
151