xref: /illumos-gate/usr/src/uts/common/sys/vuid_state.h (revision 2d6eb4a5e0a47d30189497241345dc5466bb68ab)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright (c) 1985,1997-1998 by Sun Microsystems, Inc.
24  * All rights reserved.
25  */
26 
27 /*
28  * This file describes a virtual user input device (vuid) state
29  * maintainence package (see ../sundev/vuid_event.h for a description
30  * of what vuid is).  This header file defines the interface that a
31  * client of this package sees.	 This package is used to maintain the
32  * state of all the events generated by an arbitrary number of physical
33  * devices which are all producing Firm_events.
34  */
35 
36 #ifndef _SYS_VUID_STATE_H
37 #define	_SYS_VUID_STATE_H
38 
39 #ifdef	__cplusplus
40 extern "C" {
41 #endif
42 
43 typedef caddr_t Vuid_state;
44 #define	VUID_STATE_NULL ((Vuid_state)0)
45 
46 void	vuid_set_value();	/* (Vuid_state *state, Firm_event *event) */
47 				/* Don't call in critical section or */
48 				/* at interrupt level */
49 int	vuid_get_value();	/* (Vuid_state state, ushort_t id) */
50 void	vuid_destroy_state();	/* (Vuid_state state) Don't call in critical */
51 				/* section or at interrupt level */
52 Vuid_state vuid_copy_state();	/* (Vuid_state state) Don't call in critical */
53 				/* section or at interrupt level */
54 
55 #ifdef	__cplusplus
56 }
57 #endif
58 
59 #endif	/* _SYS_VUID_STATE_H */
60