1 /*        $NetBSD: event_var.h,v 1.10 2014/03/21 16:58:54 tsutsui 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  *        @(#)event_var.h     8.1 (Berkeley) 6/11/93
41  */
42 
43 /*
44  * Internal `Firm_event' interface for the keyboard and mouse drivers.
45  * The drivers are expected not to place events in the queue above spltty(),
46  * i.e., are expected to run off serial ports.
47  */
48 
49 /* EV_QSIZE should be a power of two so that `%' is fast */
50 #define   EV_QSIZE  256       /* may need tuning; this uses 2k */
51 
52 struct evvar {
53           u_int     ev_get;             /* get (read) index (modified synchronously) */
54           volatile u_int ev_put;        /* put (write) index (modified by interrupt) */
55           struct    selinfo ev_sel;     /* process selecting */
56           struct    proc *ev_io;        /* process that opened queue (can get SIGIO) */
57           bool      ev_wanted;          /* wake up on input ready */
58           bool      ev_async; /* send SIGIO on input ready */
59           struct    firm_event *ev_q;/* circular buffer (queue) of events */
60           kmutex_t *ev_lock;  /* lock from the parent device */
61           kcondvar_t ev_cv;   /* condvar(9) to delever signal */
62 };
63 
64 void      ev_init(struct evvar *, const char *, kmutex_t *);
65 void      ev_fini(struct evvar *);
66 int       ev_read(struct evvar *, struct uio *, int);
67 int       ev_select(struct evvar *, int, struct lwp *);
68 int       ev_poll(struct evvar *, int, struct lwp *);
69 void      ev_wakeup(struct evvar *);
70 int       ev_kqfilter(struct evvar *, struct knote *);
71 
72 /*
73  * PEVENT is set just above PSOCK, which is just above TTIPRI, on the
74  * theory that mouse and keyboard `user' input should be quick.
75  */
76 #define   PEVENT    23
77