xref: /linux/include/uapi/linux/joystick.h (revision f79e4d5f92a129a1159c973735007d4ddc8541f3)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3  *  Copyright (C) 1996-2000 Vojtech Pavlik
4  *
5  *  Sponsored by SuSE
6  */
7 /*
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21  *
22  * Should you need to contact me, the author, you can do so either by
23  * e-mail - mail your message to <vojtech@suse.cz>, or by paper mail:
24  * Vojtech Pavlik, Ucitelska 1576, Prague 8, 182 00 Czech Republic
25  */
26 #ifndef _UAPI_LINUX_JOYSTICK_H
27 #define _UAPI_LINUX_JOYSTICK_H
28 
29 
30 
31 #include <linux/types.h>
32 #include <linux/input.h>
33 
34 /*
35  * Version
36  */
37 
38 #define JS_VERSION		0x020100
39 
40 /*
41  * Types and constants for reading from /dev/js
42  */
43 
44 #define JS_EVENT_BUTTON		0x01	/* button pressed/released */
45 #define JS_EVENT_AXIS		0x02	/* joystick moved */
46 #define JS_EVENT_INIT		0x80	/* initial state of device */
47 
48 struct js_event {
49 	__u32 time;	/* event timestamp in milliseconds */
50 	__s16 value;	/* value */
51 	__u8 type;	/* event type */
52 	__u8 number;	/* axis/button number */
53 };
54 
55 /*
56  * IOCTL commands for joystick driver
57  */
58 
59 #define JSIOCGVERSION		_IOR('j', 0x01, __u32)				/* get driver version */
60 
61 #define JSIOCGAXES		_IOR('j', 0x11, __u8)				/* get number of axes */
62 #define JSIOCGBUTTONS		_IOR('j', 0x12, __u8)				/* get number of buttons */
63 #define JSIOCGNAME(len)		_IOC(_IOC_READ, 'j', 0x13, len)			/* get identifier string */
64 
65 #define JSIOCSCORR		_IOW('j', 0x21, struct js_corr)			/* set correction values */
66 #define JSIOCGCORR		_IOR('j', 0x22, struct js_corr)			/* get correction values */
67 
68 #define JSIOCSAXMAP		_IOW('j', 0x31, __u8[ABS_CNT])			/* set axis mapping */
69 #define JSIOCGAXMAP		_IOR('j', 0x32, __u8[ABS_CNT])			/* get axis mapping */
70 #define JSIOCSBTNMAP		_IOW('j', 0x33, __u16[KEY_MAX - BTN_MISC + 1])	/* set button mapping */
71 #define JSIOCGBTNMAP		_IOR('j', 0x34, __u16[KEY_MAX - BTN_MISC + 1])	/* get button mapping */
72 
73 /*
74  * Types and constants for get/set correction
75  */
76 
77 #define JS_CORR_NONE		0x00	/* returns raw values */
78 #define JS_CORR_BROKEN		0x01	/* broken line */
79 
80 struct js_corr {
81 	__s32 coef[8];
82 	__s16 prec;
83 	__u16 type;
84 };
85 
86 /*
87  * v0.x compatibility definitions
88  */
89 
90 #define JS_RETURN		sizeof(struct JS_DATA_TYPE)
91 #define JS_TRUE			1
92 #define JS_FALSE		0
93 #define JS_X_0			0x01
94 #define JS_Y_0			0x02
95 #define JS_X_1			0x04
96 #define JS_Y_1			0x08
97 #define JS_MAX			2
98 
99 #define JS_DEF_TIMEOUT		0x1300
100 #define JS_DEF_CORR		0
101 #define JS_DEF_TIMELIMIT	10L
102 
103 #define JS_SET_CAL		1
104 #define JS_GET_CAL		2
105 #define JS_SET_TIMEOUT		3
106 #define JS_GET_TIMEOUT		4
107 #define JS_SET_TIMELIMIT	5
108 #define JS_GET_TIMELIMIT	6
109 #define JS_GET_ALL		7
110 #define JS_SET_ALL		8
111 
112 struct JS_DATA_TYPE {
113 	__s32 buttons;
114 	__s32 x;
115 	__s32 y;
116 };
117 
118 struct JS_DATA_SAVE_TYPE_32 {
119 	__s32 JS_TIMEOUT;
120 	__s32 BUSY;
121 	__s32 JS_EXPIRETIME;
122 	__s32 JS_TIMELIMIT;
123 	struct JS_DATA_TYPE JS_SAVE;
124 	struct JS_DATA_TYPE JS_CORR;
125 };
126 
127 struct JS_DATA_SAVE_TYPE_64 {
128 	__s32 JS_TIMEOUT;
129 	__s32 BUSY;
130 	__s64 JS_EXPIRETIME;
131 	__s64 JS_TIMELIMIT;
132 	struct JS_DATA_TYPE JS_SAVE;
133 	struct JS_DATA_TYPE JS_CORR;
134 };
135 
136 
137 #endif /* _UAPI_LINUX_JOYSTICK_H */
138