xref: /netbsd/sys/dev/sun/event_var.h (revision c4a72b64)
1 /*	$NetBSD: event_var.h,v 1.4 2002/10/23 09:13:54 jdolecek 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  *	from: @(#)event_var.h	8.1 (Berkeley) 6/11/93
45  *	from: Hdr: event_var.h,v 1.5 92/11/26 01:11:51 torek Exp  (LBL)
46  */
47 
48 /*
49  * Internal `Firm_event' interface for the keyboard and mouse drivers.
50  * The drivers are expected not to place events in the queue above spltty(),
51  * i.e., are expected to run off serial ports.
52  */
53 
54 /* EV_QSIZE should be a power of two so that `%' is fast */
55 #define	EV_QSIZE	256	/* may need tuning; this uses 2k */
56 
57 struct evvar {
58 	u_int	ev_get;		/* get (read) index (modified synchronously) */
59 	volatile u_int ev_put;	/* put (write) index (modified by interrupt) */
60 	struct	selinfo ev_sel;	/* process selecting */
61 	struct	proc *ev_io;	/* process that opened queue (can get SIGIO) */
62 	char	ev_wanted;	/* wake up on input ready */
63 	char	ev_async;	/* send SIGIO on input ready */
64 	struct	firm_event *ev_q;/* circular buffer (queue) of events */
65 };
66 
67 #define	splev()	spltty()
68 
69 #define	EV_WAKEUP(ev) { \
70 	selnotify(&(ev)->ev_sel, 0); \
71 	if ((ev)->ev_wanted) { \
72 		(ev)->ev_wanted = 0; \
73 		wakeup((caddr_t)(ev)); \
74 	} \
75 	if ((ev)->ev_async) \
76 		psignal((ev)->ev_io, SIGIO); \
77 }
78 
79 void	ev_init __P((struct evvar *));
80 void	ev_fini __P((struct evvar *));
81 int	ev_read __P((struct evvar *, struct uio *, int));
82 int	ev_poll __P((struct evvar *, int, struct proc *));
83 int	ev_kqfilter __P((struct evvar *, struct knote *));
84 
85 /*
86  * Hook for 32-bit compatibility on a 64-bit kernel.
87  */
88 extern	int (*ev_out32_hook) __P((struct firm_event *, int, struct uio *));
89 
90 /*
91  * PEVENT is set just above PSOCK, which is just above TTIPRI, on the
92  * theory that mouse and keyboard `user' input should be quick.
93  */
94 #define	PEVENT	23
95