xref: /netbsd-src/sys/dev/sun/kbdvar.h (revision de1dfb1250df962f1ff3a011772cf58e605aed11)
1 /*	$NetBSD: kbdvar.h,v 1.13 2003/08/27 01:37:38 uwe 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 struct kbd_softc {
48 	struct device k_dev;	/* required first: base device */
49 
50 	/* middle layer methods */
51 	const struct kbd_ops *k_ops;
52 
53 	/* state of the upper layer */
54 	int k_evmode;		/* set if we should produce events */
55 	struct evvar k_events;	/* event queue state */
56 
57 #if NWSKBD > 0
58 	struct device * k_wskbd;/* handle for wskbd, if it is attached */
59 	int k_wsenabled;	/* set if we are using wskbd */
60 	struct callout k_wsbell;/* to shut the bell off */
61 #endif
62 
63 	/* ACSII translation state */
64 	struct kbd_state k_state;
65 
66 	/* console hooks */
67 	int k_isconsole;
68 	struct cons_channel *k_cc;
69 
70 	/* autorepeat for console input */
71 	int k_repeat_start; 	/* initial delay */
72 	int k_repeat_step;  	/* inter-char delay */
73 	int k_repeatsym;	/* repeating symbol */
74 	int k_repeating;	/* callout is active (use callout_active?) */
75 	struct callout k_repeat_ch;
76 };
77 
78 
79 /*
80  * Downcalls to the middle layer.
81  */
82 struct kbd_ops {
83 	int (*open)(struct kbd_softc *);
84 	int (*close)(struct kbd_softc *);
85 	int (*docmd)(struct kbd_softc *, int, int);
86 	int (*setleds)(struct kbd_softc *, int, int);
87 };
88 
89 
90 /*
91  * kbd console input channel interface.
92  * XXX - does not belong in this header; but for now, kbd is the only user...
93  */
94 struct cons_channel {
95 	/*
96 	 * Callbacks provided by underlying device (e.g. keyboard driver).
97 	 * Console driver will call these before console is opened/closed.
98 	 */
99 	void *cc_dev;		/* underlying device private data */
100 	int (*cc_iopen)(struct cons_channel *);  /* open underlying device */
101 	int (*cc_iclose)(struct cons_channel *); /* close underlying device */
102 
103 	/*
104 	 * Callback provided by the console driver.  Keyboard driver
105 	 * calls it to pass input character up as console input.
106 	 */
107 	void (*cc_upstream)(int);
108 };
109 
110 
111 /*
112  * Allocate and link up console channel.
113  * Should be called by the lower layer during attachment.
114  */
115 extern struct cons_channel *kbd_cc_alloc(struct kbd_softc *);
116 
117 /*
118  * Feed sun make/break code as keyboard input to the upper layer.
119  * Should be called by the middle layer.
120  */
121 extern void kbd_input(struct kbd_softc *, int);
122 
123 /*
124  * Special hook to attach the keyboard driver to the console.
125  * XXX: this should be hidden in kbd_cc_alloc().
126  */
127 struct consdev;
128 extern void cons_attach_input(struct cons_channel *, struct consdev *);
129