xref: /netbsd/sys/dev/sun/kbdvar.h (revision 6550d01e)
1 /*	$NetBSD: kbdvar.h,v 1.20 2009/05/12 14:46:39 cegger Exp $	*/
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This software was developed by the Computer Systems Engineering group
8  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9  * contributed to Berkeley.
10  *
11  * All advertising materials mentioning features or use of this software
12  * must display the following acknowledgement:
13  *	This product includes software developed by the University of
14  *	California, Lawrence Berkeley Laboratory.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *	@(#)kbd.c	8.2 (Berkeley) 10/30/93
41  */
42 
43 #include "wskbd.h"	/* for NWSKBD */
44 #include <dev/wscons/wsconsio.h>
45 #include <dev/wscons/wskbdvar.h>
46 
47 #if NWSKBD > 0
48 #include "opt_wsdisplay_compat.h"
49 #endif
50 
51 struct kbd_softc {
52 	device_t k_dev;		/* required first: base device */
53 
54 	/* middle layer methods */
55 	const struct kbd_ops *k_ops;
56 
57 	/* state of the upper layer */
58 	int k_evmode;		/* set if we should produce events */
59 	struct evvar k_events;	/* event queue state */
60 
61 #if NWSKBD > 0
62 	device_t  k_wskbd;/* handle for wskbd, if it is attached */
63 	int k_wsenabled;	/* set if we are using wskbd */
64 #ifdef WSDISPLAY_COMPAT_RAWKBD
65 	int k_wsraw;		/* send raw events to wscons */
66 #endif
67 	struct callout k_wsbell;/* to shut the bell off */
68 #endif
69 
70 	/* ASCII translation state */
71 	struct kbd_state k_state;
72 
73 	/* console hooks */
74 	int k_isconsole;
75 	struct cons_channel *k_cc;
76 
77 	/* autorepeat for console input */
78 	int k_repeat_start; 	/* initial delay */
79 	int k_repeat_step;  	/* inter-char delay */
80 	int k_repeatsym;	/* repeating symbol */
81 	int k_repeating;	/* callout is active (use callout_active?) */
82 	struct callout k_repeat_ch;
83 	int k_leds;
84 };
85 
86 
87 /*
88  * Downcalls to the middle layer.
89  */
90 struct kbd_ops {
91 	int (*open)(struct kbd_softc *);
92 	int (*close)(struct kbd_softc *);
93 	int (*docmd)(struct kbd_softc *, int, int);
94 	int (*setleds)(struct kbd_softc *, int, int);
95 };
96 
97 
98 /*
99  * kbd console input channel interface.
100  * XXX - does not belong in this header; but for now, kbd is the only user...
101  */
102 struct cons_channel {
103 	/*
104 	 * Callbacks provided by underlying device (e.g. keyboard driver).
105 	 * Console driver will call these before console is opened/closed.
106 	 */
107 	void *cc_private;	/* underlying device private data */
108 	int (*cc_iopen)(struct cons_channel *);  /* open underlying device */
109 	int (*cc_iclose)(struct cons_channel *); /* close underlying device */
110 
111 	/*
112 	 * Callback provided by the console driver.  Keyboard driver
113 	 * calls it to pass input character up as console input.
114 	 */
115 	void (*cc_upstream)(int);
116 };
117 
118 
119 /*
120  * Allocate and link up console channel.
121  * Should be called by the lower layer during attachment.
122  */
123 extern struct cons_channel *kbd_cc_alloc(struct kbd_softc *);
124 
125 /*
126  * Feed sun make/break code as keyboard input to the upper layer.
127  * Should be called by the middle layer.
128  */
129 extern void kbd_input(struct kbd_softc *, int);
130 
131 /*
132  * Special hook to attach the keyboard driver to the console.
133  * XXX: this should be hidden in kbd_cc_alloc().
134  */
135 struct consdev;
136 extern void cons_attach_input(struct cons_channel *, struct consdev *);
137