1 /*        $NetBSD: cons.h,v 1.29 2022/10/03 19:12:29 riastradh Exp $  */
2 
3 /*
4  * Copyright (c) 1988 University of Utah.
5  * Copyright (c) 1990, 1993
6  *        The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * the Systems Programming Group of the University of Utah Computer
10  * Science Department.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  * from: Utah $Hdr: cons.h 1.6 92/01/21$
37  *
38  *        @(#)cons.h          8.1 (Berkeley) 6/10/93
39  */
40 
41 #ifndef _SYS_DEV_CONS_H_
42 #define _SYS_DEV_CONS_H_
43 
44 #include <sys/types.h>
45 
46 struct consdev {
47           void      (*cn_probe)         /* probe hardware and fill in consdev info */
48                        (struct consdev *);
49           void      (*cn_init)          /* turn on as console */
50                        (struct consdev *);
51           int       (*cn_getc)          /* kernel getchar interface */
52                        (dev_t);
53           void      (*cn_putc)          /* kernel putchar interface */
54                        (dev_t, int);
55           void      (*cn_pollc)         /* turn on and off polling */
56                        (dev_t, int);
57           void      (*cn_bell)          /* ring bell */
58                        (dev_t, u_int, u_int, u_int);
59           void      (*cn_halt)          /* stop device */
60                        (dev_t);
61           void      (*cn_flush)         /* flush output */
62                        (dev_t);
63           dev_t     cn_dev;             /* major/minor of device */
64           int       cn_pri;             /* pecking order; the higher the better */
65 };
66 
67 /* values for cn_pri - reflect our policy for console selection */
68 #define   CN_DEAD             0         /* device doesn't exist */
69 #define CN_NULL               1         /* noop console */
70 #define CN_NORMAL   2         /* device exists but is nothing special */
71 #define CN_INTERNAL 3         /* "internal" bit-mapped display */
72 #define CN_REMOTE   4         /* serial interface with remote bit set */
73 
74 #ifdef _KERNEL
75 
76 extern    struct consdev constab[];
77 extern    struct consdev *cn_tab;
78 
79 void      cn_set_tab(struct consdev *);
80 
81 void      cninit(void);
82 int       cngetc(void);
83 int       cngetsn(char *, int);
84 void      cnputc(int);
85 void      cnpollc(int);
86 void      cnbell(u_int, u_int, u_int);
87 void      cnflush(void);
88 void      cnhalt(void);
89 void      cnrint(void);
90 void      nullcnprobe(struct consdev *);
91 void      nullcninit(struct consdev *);
92 void      nullcnpollc(dev_t, int);
93 void      nullconsattach(int);
94 
95 /* console-specific types */
96 #define   dev_type_cnprobe(n) void n(struct consdev *)
97 #define   dev_type_cninit(n)  void n(struct consdev *)
98 #define   dev_type_cngetc(n)  int n(dev_t)
99 #define   dev_type_cnputc(n)  void n(dev_t, int)
100 #define   dev_type_cnpollc(n) void n(dev_t, int)
101 #define   dev_type_cnbell(n)  void n(dev_t, u_int, u_int, u_int)
102 #define   dev_type_cnhalt(n)  void n(dev_t)
103 #define   dev_type_cnflush(n) void n(dev_t)
104 
105 #define   dev_decl(n,t)                 __CONCAT(dev_type_,t)(__CONCAT(n,t))
106 #define   dev_init(n,t)                 __CONCAT(n,t)
107 
108 #define   cons_decl(n) \
109           dev_decl(n,cnprobe); dev_decl(n,cninit); dev_decl(n,cngetc); \
110           dev_decl(n,cnputc); dev_decl(n,cnpollc); dev_decl(n,cnbell); \
111           dev_decl(n,cnflush); dev_decl(n,cnhalt);
112 
113 #define   cons_init(n) { \
114           dev_init(n,cnprobe), dev_init(n,cninit), dev_init(n,cngetc), \
115           dev_init(n,cnputc), dev_init(n,cnpollc), NULL, NULL, NULL, \
116           0, 0 }
117 
118 #define   cons_init_bell(n) { \
119           dev_init(n,cnprobe), dev_init(n,cninit), dev_init(n,cngetc), \
120           dev_init(n,cnputc), dev_init(n,cnpollc), dev_init(n,cnbell) }
121 
122 #define   cons_init_halt(n) { \
123           dev_init(n,cnprobe), dev_init(n,cninit), dev_init(n,cngetc), \
124           dev_init(n,cnputc), dev_init(n,cnpollc), 0,                    \
125           dev_init(n,cnhalt) }
126 
127 #endif
128 
129 #endif /* _SYS_DEV_CONS_H_ */
130