xref: /illumos-gate/usr/src/uts/common/sys/usb/clients/hid/hidminor.h (revision cfe80fe3616624773746461f58f667b0c4141275)
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 (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Copyright 2017 Joyent, Inc.
24  */
25 
26 #ifndef _SYS_USB_HIDMINOR_H
27 #define	_SYS_USB_HIDMINOR_H
28 
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 /*
35  * In order to support virtual keyboard/mouse, we should distinguish
36  * between internal virtual open and external physical open.
37  *
38  * When the physical devices are opened by application, they will
39  * be unlinked from the virtual device and their data stream will
40  * not be sent to the virtual device. When the opened physical
41  * devices are closed, they will be relinked to the virtual devices.
42  *
43  * All these automatic switch between virtual and physical are
44  * transparent.
45  *
46  * So we change minor node numbering scheme to be:
47  *	external node minor num == instance << 9
48  *	internal node minor num == instance << 9 | 0x100
49  * (There are only internal nodes for keyboard/mouse now.)
50  *
51  * The 8 bits of the LSB are used for ugen minor numbering (hence the use
52  * of the first bit of the next byte for the "internal" flag)
53  */
54 #define	HID_MINOR_BITS_MASK		0x1ff
55 #define	HID_MINOR_UGEN_BITS_MASK	0xff
56 #define	HID_MINOR_INSTANCE_MASK		~HID_MINOR_BITS_MASK
57 #define	HID_MINOR_INSTANCE_SHIFT	9
58 
59 #define	HID_MINOR_INTERNAL		0x100
60 #define	HID_MINOR_MAKE_INTERNAL(minor) \
61 		((minor) | HID_MINOR_INTERNAL)
62 
63 #define	HID_IS_INTERNAL_OPEN(minor) \
64 		(((minor) & HID_MINOR_INTERNAL))
65 
66 #define	HID_IS_UGEN_OPEN(minor) \
67 		(((minor) & HID_MINOR_UGEN_BITS_MASK))
68 
69 #define	HID_MINOR_TO_INSTANCE(minor) \
70 		(((minor) & HID_MINOR_INSTANCE_MASK) >> \
71 		HID_MINOR_INSTANCE_SHIFT)
72 
73 #define	HID_CONSTRUCT_INTERNAL_MINOR(inst) \
74 		(((inst) << HID_MINOR_INSTANCE_SHIFT) | \
75 		HID_MINOR_INTERNAL)
76 
77 #define	HID_CONSTRUCT_EXTERNAL_MINOR(inst) \
78 		((inst) << HID_MINOR_INSTANCE_SHIFT)
79 
80 #ifdef __cplusplus
81 }
82 #endif
83 
84 #endif	/* _SYS_USB_HIDMINOR_H */
85