xref: /netbsd/sys/dev/sun/kbdvar.h (revision c4a72b64)
1 /*	$NetBSD: kbdvar.h,v 1.11 2002/10/26 19:11:13 martin 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. All advertising materials mentioning features or use of this software
25  *    must display the following acknowledgement:
26  *	This product includes software developed by the University of
27  *	California, Berkeley and its contributors.
28  * 4. Neither the name of the University nor the names of its contributors
29  *    may be used to endorse or promote products derived from this software
30  *    without specific prior written permission.
31  *
32  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
36  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
40  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
41  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42  * SUCH DAMAGE.
43  *
44  *	@(#)kbd.c	8.2 (Berkeley) 10/30/93
45  */
46 
47 #include "wskbd.h"	/* for NWSKBD */
48 #include <dev/wscons/wsconsio.h>
49 #include <dev/wscons/wskbdvar.h>
50 
51 struct kbd_softc {
52 	struct device 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 	struct device * k_wskbd;/* handle for wskbd, if it is attached */
63 	int k_wsenabled;	/* set if we are using wskbd */
64 	struct callout k_wsbell;/* to shut the bell off */
65 #endif
66 
67 	/* ACSII translation state */
68 	struct kbd_state k_state;
69 
70 	/* console hooks */
71 	int k_isconsole;
72 	struct cons_channel *k_cc;
73 
74 	/* autorepeat for console input */
75 	int k_repeat_start; 	/* initial delay */
76 	int k_repeat_step;  	/* inter-char delay */
77 	int k_repeatsym;	/* repeating symbol */
78 	int k_repeating;	/* callout is active (use callout_active?) */
79 	struct callout k_repeat_ch;
80 };
81 
82 
83 /*
84  * Downcalls to the middle layer.
85  */
86 struct kbd_ops {
87 	int (*open)(struct kbd_softc *);
88 	int (*close)(struct kbd_softc *);
89 	int (*docmd)(struct kbd_softc *, int, int);
90 	int (*setleds)(struct kbd_softc *, int, int);
91 };
92 
93 
94 /*
95  * kbd console input channel interface.
96  * XXX - does not belong in this header; but for now, kbd is the only user...
97  */
98 struct cons_channel {
99 	/* XXX: only used by PROM console, probably belongs to kd.c */
100 	struct callout cc_callout;
101 
102 	/*
103 	 * Callbacks provided by underlying device (e.g. keyboard driver).
104 	 * Console driver will call these before console is opened/closed.
105 	 */
106 	void *cc_dev;		/* underlying device private data */
107 	int (*cc_iopen)(struct cons_channel *);  /* open underlying device */
108 	int (*cc_iclose)(struct cons_channel *); /* close underlying device */
109 
110 	/*
111 	 * Callback provided by the console driver.  Keyboard driver
112 	 * calls it to pass input character up as console input.
113 	 */
114 	void (*cc_upstream)(int);
115 };
116 
117 
118 /*
119  * Allocate and link up console channel.
120  * Should be called by the lower layer during attachment.
121  */
122 extern struct cons_channel *kbd_cc_alloc(struct kbd_softc *);
123 
124 /*
125  * Feed sun make/break code as keyboard input to the upper layer.
126  * Should be called by the middle layer.
127  */
128 extern void kbd_input(struct kbd_softc *, int);
129 
130 /*
131  * Special hook to attach the keyboard driver to the console.
132  * XXX: this should be hidden in kbd_cc_alloc().
133  */
134 struct consdev;
135 extern void cons_attach_input(struct cons_channel *, struct consdev *);
136