mouse.h - Change to be not per-architecture.
[dragonfly.git] / sys / sys / mouse.h
CommitLineData
984263bc
MD
1/*-
2 * Copyright (c) 1992, 1993 Erik Forsberg.
3 * Copyright (c) 1996, 1997 Kazutaka YOKOTA
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * THIS SOFTWARE IS PROVIDED BY ``AS IS'' AND ANY EXPRESS OR IMPLIED
13 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
14 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
15 * NO EVENT SHALL I BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
16 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
17 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
18 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
19 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
20 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22 *
23 * $FreeBSD: src/sys/i386/include/mouse.h,v 1.15.2.2 2002/04/15 00:52:08 will Exp $
24 */
25
26#ifndef _MACHINE_MOUSE_H_
27#define _MACHINE_MOUSE_H_
28
29#include <sys/types.h>
30#include <sys/ioccom.h>
31
32/* ioctls */
33#define MOUSE_GETSTATUS _IOR('M', 0, mousestatus_t)
34#define MOUSE_GETHWINFO _IOR('M', 1, mousehw_t)
35#define MOUSE_GETMODE _IOR('M', 2, mousemode_t)
36#define MOUSE_SETMODE _IOW('M', 3, mousemode_t)
37#define MOUSE_GETLEVEL _IOR('M', 4, int)
38#define MOUSE_SETLEVEL _IOW('M', 5, int)
39#define MOUSE_GETVARS _IOR('M', 6, mousevar_t)
40#define MOUSE_SETVARS _IOW('M', 7, mousevar_t)
41#define MOUSE_READSTATE _IOWR('M', 8, mousedata_t)
42#define MOUSE_READDATA _IOWR('M', 9, mousedata_t)
43
44#if notyet
45#define MOUSE_SETRESOLUTION _IOW('M', 10, int)
46#define MOUSE_SETSCALING _IOW('M', 11, int)
47#define MOUSE_SETRATE _IOW('M', 12, int)
48#define MOUSE_GETHWID _IOR('M', 13, int)
49#endif
50
51/* mouse status block */
52typedef struct mousestatus {
53 int flags; /* state change flags */
54 int button; /* button status */
55 int obutton; /* previous button status */
56 int dx; /* x movement */
57 int dy; /* y movement */
58 int dz; /* z movement */
59} mousestatus_t;
60
61/* button */
62#define MOUSE_BUTTON1DOWN 0x0001 /* left */
63#define MOUSE_BUTTON2DOWN 0x0002 /* middle */
64#define MOUSE_BUTTON3DOWN 0x0004 /* right */
65#define MOUSE_BUTTON4DOWN 0x0008
66#define MOUSE_BUTTON5DOWN 0x0010
67#define MOUSE_BUTTON6DOWN 0x0020
68#define MOUSE_BUTTON7DOWN 0x0040
69#define MOUSE_BUTTON8DOWN 0x0080
70#define MOUSE_MAXBUTTON 31
71#define MOUSE_STDBUTTONS 0x0007 /* buttons 1-3 */
72#define MOUSE_EXTBUTTONS 0x7ffffff8 /* the others (28 of them!) */
73#define MOUSE_BUTTONS (MOUSE_STDBUTTONS | MOUSE_EXTBUTTONS)
74
75/* flags */
76#define MOUSE_STDBUTTONSCHANGED MOUSE_STDBUTTONS
77#define MOUSE_EXTBUTTONSCHANGED MOUSE_EXTBUTTONS
78#define MOUSE_BUTTONSCHANGED MOUSE_BUTTONS
79#define MOUSE_POSCHANGED 0x80000000
80
81typedef struct mousehw {
82 int buttons; /* -1 if unknown */
83 int iftype; /* MOUSE_IF_XXX */
84 int type; /* mouse/track ball/pad... */
85 int model; /* I/F dependent model ID: MOUSE_MODEL_XXX */
86 int hwid; /* I/F dependent hardware ID
62770245 87 * for the PS/2 mouse, it will be PSM_XXX_ID
984263bc
MD
88 */
89} mousehw_t;
90
91/* iftype */
92#define MOUSE_IF_UNKNOWN (-1)
93#define MOUSE_IF_SERIAL 0
94#define MOUSE_IF_BUS 1
95#define MOUSE_IF_INPORT 2
96#define MOUSE_IF_PS2 3
97#define MOUSE_IF_SYSMOUSE 4
98#define MOUSE_IF_USB 5
99
100/* type */
101#define MOUSE_UNKNOWN (-1) /* should be treated as a mouse */
102#define MOUSE_MOUSE 0
103#define MOUSE_TRACKBALL 1
104#define MOUSE_STICK 2
105#define MOUSE_PAD 3
106
107/* model */
108#define MOUSE_MODEL_UNKNOWN (-1)
109#define MOUSE_MODEL_GENERIC 0
110#define MOUSE_MODEL_GLIDEPOINT 1
111#define MOUSE_MODEL_NETSCROLL 2
112#define MOUSE_MODEL_NET 3
113#define MOUSE_MODEL_INTELLI 4
114#define MOUSE_MODEL_THINK 5
115#define MOUSE_MODEL_EASYSCROLL 6
116#define MOUSE_MODEL_MOUSEMANPLUS 7
117#define MOUSE_MODEL_KIDSPAD 8
118#define MOUSE_MODEL_VERSAPAD 9
119#define MOUSE_MODEL_EXPLORER 10
120#define MOUSE_MODEL_4D 11
121#define MOUSE_MODEL_4DPLUS 12
122
123typedef struct mousemode {
124 int protocol; /* MOUSE_PROTO_XXX */
125 int rate; /* report rate (per sec), -1 if unknown */
126 int resolution; /* MOUSE_RES_XXX, -1 if unknown */
127 int accelfactor; /* accelation factor (must be 1 or greater) */
128 int level; /* driver operation level */
129 int packetsize; /* the length of the data packet */
130 unsigned char syncmask[2]; /* sync. data bits in the header byte */
131} mousemode_t;
132
133/* protocol */
134/*
135 * Serial protocols:
136 * Microsoft, MouseSystems, Logitech, MM series, MouseMan, Hitachi Tablet,
137 * GlidePoint, IntelliMouse, Thinking Mouse, MouseRemote, Kidspad,
138 * VersaPad
139 * Bus mouse protocols:
140 * bus, InPort
141 * PS/2 mouse protocol:
142 * PS/2
143 */
144#define MOUSE_PROTO_UNKNOWN (-1)
145#define MOUSE_PROTO_MS 0 /* Microsoft Serial, 3 bytes */
146#define MOUSE_PROTO_MSC 1 /* Mouse Systems, 5 bytes */
147#define MOUSE_PROTO_LOGI 2 /* Logitech, 3 bytes */
148#define MOUSE_PROTO_MM 3 /* MM series, 3 bytes */
149#define MOUSE_PROTO_LOGIMOUSEMAN 4 /* Logitech MouseMan 3/4 bytes */
150#define MOUSE_PROTO_BUS 5 /* MS/Logitech bus mouse */
151#define MOUSE_PROTO_INPORT 6 /* MS/ATI InPort mouse */
152#define MOUSE_PROTO_PS2 7 /* PS/2 mouse, 3 bytes */
153#define MOUSE_PROTO_HITTAB 8 /* Hitachi Tablet 3 bytes */
154#define MOUSE_PROTO_GLIDEPOINT 9 /* ALPS GlidePoint, 3/4 bytes */
155#define MOUSE_PROTO_INTELLI 10 /* MS IntelliMouse, 4 bytes */
156#define MOUSE_PROTO_THINK 11 /* Kensignton Thinking Mouse, 3/4 bytes */
157#define MOUSE_PROTO_SYSMOUSE 12 /* /dev/sysmouse */
158#define MOUSE_PROTO_X10MOUSEREM 13 /* X10 MouseRemote, 3 bytes */
159#define MOUSE_PROTO_KIDSPAD 14 /* Genius Kidspad */
160#define MOUSE_PROTO_VERSAPAD 15 /* Interlink VersaPad, 6 bytes */
161#define MOUSE_PROTO_JOGDIAL 16 /* Vaio's JogDial */
162
163#define MOUSE_RES_UNKNOWN (-1)
164#define MOUSE_RES_DEFAULT 0
165#define MOUSE_RES_LOW (-2)
166#define MOUSE_RES_MEDIUMLOW (-3)
167#define MOUSE_RES_MEDIUMHIGH (-4)
168#define MOUSE_RES_HIGH (-5)
169
170typedef struct mousedata {
171 int len; /* # of data in the buffer */
172 int buf[16]; /* data buffer */
173} mousedata_t;
174
175#if (defined(MOUSE_GETVARS))
176
177typedef struct mousevar {
178 int var[16];
179} mousevar_t;
180
181/* magic numbers in var[0] */
182#define MOUSE_VARS_PS2_SIG 0x00325350 /* 'PS2' */
183#define MOUSE_VARS_BUS_SIG 0x00535542 /* 'BUS' */
184#define MOUSE_VARS_INPORT_SIG 0x00504e49 /* 'INP' */
185
186#endif /* MOUSE_GETVARS */
187
188/* Microsoft Serial mouse data packet */
189#define MOUSE_MSS_PACKETSIZE 3
190#define MOUSE_MSS_SYNCMASK 0x40
191#define MOUSE_MSS_SYNC 0x40
192#define MOUSE_MSS_BUTTONS 0x30
193#define MOUSE_MSS_BUTTON1DOWN 0x20 /* left */
194#define MOUSE_MSS_BUTTON2DOWN 0x00 /* no middle button */
195#define MOUSE_MSS_BUTTON3DOWN 0x10 /* right */
196
197/* Logitech MouseMan data packet (M+ protocol) */
198#define MOUSE_LMAN_BUTTON2DOWN 0x20 /* middle button, the 4th byte */
199
200/* ALPS GlidePoint extention (variant of M+ protocol) */
201#define MOUSE_ALPS_BUTTON2DOWN 0x20 /* middle button, the 4th byte */
202#define MOUSE_ALPS_TAP 0x10 /* `tapping' action, the 4th byte */
203
204/* Kinsington Thinking Mouse extention (variant of M+ protocol) */
205#define MOUSE_THINK_BUTTON2DOWN 0x20 /* lower-left button, the 4th byte */
206#define MOUSE_THINK_BUTTON4DOWN 0x10 /* lower-right button, the 4th byte */
207
208/* MS IntelliMouse (variant of MS Serial) */
209#define MOUSE_INTELLI_PACKETSIZE 4
210#define MOUSE_INTELLI_BUTTON2DOWN 0x10 /* middle button in the 4th byte */
211
212/* Mouse Systems Corp. mouse data packet */
213#define MOUSE_MSC_PACKETSIZE 5
214#define MOUSE_MSC_SYNCMASK 0xf8
215#define MOUSE_MSC_SYNC 0x80
216#define MOUSE_MSC_BUTTONS 0x07
217#define MOUSE_MSC_BUTTON1UP 0x04 /* left */
218#define MOUSE_MSC_BUTTON2UP 0x02 /* middle */
219#define MOUSE_MSC_BUTTON3UP 0x01 /* right */
220#define MOUSE_MSC_MAXBUTTON 3
221
222/* MM series mouse data packet */
223#define MOUSE_MM_PACKETSIZE 3
224#define MOUSE_MM_SYNCMASK 0xe0
225#define MOUSE_MM_SYNC 0x80
226#define MOUSE_MM_BUTTONS 0x07
227#define MOUSE_MM_BUTTON1DOWN 0x04 /* left */
228#define MOUSE_MM_BUTTON2DOWN 0x02 /* middle */
229#define MOUSE_MM_BUTTON3DOWN 0x01 /* right */
230#define MOUSE_MM_XPOSITIVE 0x10
231#define MOUSE_MM_YPOSITIVE 0x08
232
233/* PS/2 mouse data packet */
234#define MOUSE_PS2_PACKETSIZE 3
235#define MOUSE_PS2_SYNCMASK 0xc8
236#define MOUSE_PS2_SYNC 0x08
237#define MOUSE_PS2_BUTTONS 0x07 /* 0x03 for 2 button mouse */
238#define MOUSE_PS2_BUTTON1DOWN 0x01 /* left */
239#define MOUSE_PS2_BUTTON2DOWN 0x04 /* middle */
240#define MOUSE_PS2_BUTTON3DOWN 0x02 /* right */
241#define MOUSE_PS2_TAP MOUSE_PS2_SYNC /* GlidePoint (PS/2) `tapping'
62770245 242 * Yes! this is the same bit
984263bc 243 * as SYNC!
62770245 244 */
984263bc
MD
245
246#define MOUSE_PS2_XNEG 0x10
247#define MOUSE_PS2_YNEG 0x20
248#define MOUSE_PS2_XOVERFLOW 0x40
249#define MOUSE_PS2_YOVERFLOW 0x80
250
251/* Logitech MouseMan+ (PS/2) data packet (PS/2++ protocol) */
252#define MOUSE_PS2PLUS_SYNCMASK 0x48
253#define MOUSE_PS2PLUS_SYNC 0x48
254#define MOUSE_PS2PLUS_ZNEG 0x08 /* sign bit */
255#define MOUSE_PS2PLUS_BUTTON4DOWN 0x10 /* 4th button on MouseMan+ */
256#define MOUSE_PS2PLUS_BUTTON5DOWN 0x20
257
258/* IBM ScrollPoint (PS/2) also uses PS/2++ protocol */
259#define MOUSE_SPOINT_ZNEG 0x80 /* sign bits */
260#define MOUSE_SPOINT_WNEG 0x08
261
262/* MS IntelliMouse (PS/2) data packet */
263#define MOUSE_PS2INTELLI_PACKETSIZE 4
264/* some compatible mice have additional buttons */
265#define MOUSE_PS2INTELLI_BUTTON4DOWN 0x40
266#define MOUSE_PS2INTELLI_BUTTON5DOWN 0x80
267
268/* MS IntelliMouse Explorer (PS/2) data packet (variation of IntelliMouse) */
269#define MOUSE_EXPLORER_ZNEG 0x08 /* sign bit */
270/* IntelliMouse Explorer has additional button data in the fourth byte */
271#define MOUSE_EXPLORER_BUTTON4DOWN 0x10
272#define MOUSE_EXPLORER_BUTTON5DOWN 0x20
273
274/* Interlink VersaPad (serial I/F) data packet */
275#define MOUSE_VERSA_PACKETSIZE 6
276#define MOUSE_VERSA_IN_USE 0x04
277#define MOUSE_VERSA_SYNCMASK 0xc3
278#define MOUSE_VERSA_SYNC 0xc0
279#define MOUSE_VERSA_BUTTONS 0x30
280#define MOUSE_VERSA_BUTTON1DOWN 0x20 /* left */
281#define MOUSE_VERSA_BUTTON2DOWN 0x00 /* middle */
282#define MOUSE_VERSA_BUTTON3DOWN 0x10 /* right */
283#define MOUSE_VERSA_TAP 0x08
284
285/* Interlink VersaPad (PS/2 I/F) data packet */
286#define MOUSE_PS2VERSA_PACKETSIZE 6
287#define MOUSE_PS2VERSA_IN_USE 0x10
288#define MOUSE_PS2VERSA_SYNCMASK 0xe8
289#define MOUSE_PS2VERSA_SYNC 0xc8
290#define MOUSE_PS2VERSA_BUTTONS 0x05
291#define MOUSE_PS2VERSA_BUTTON1DOWN 0x04 /* left */
292#define MOUSE_PS2VERSA_BUTTON2DOWN 0x00 /* middle */
293#define MOUSE_PS2VERSA_BUTTON3DOWN 0x01 /* right */
294#define MOUSE_PS2VERSA_TAP 0x02
295
296/* A4 Tech 4D Mouse (PS/2) data packet */
62770245 297#define MOUSE_4D_PACKETSIZE 3
984263bc
MD
298#define MOUSE_4D_WHEELBITS 0xf0
299
300/* A4 Tech 4D+ Mouse (PS/2) data packet */
62770245 301#define MOUSE_4DPLUS_PACKETSIZE 3
984263bc
MD
302#define MOUSE_4DPLUS_ZNEG 0x04 /* sign bit */
303#define MOUSE_4DPLUS_BUTTON4DOWN 0x08
304
305/* sysmouse extended data packet */
306/*
307 * /dev/sysmouse sends data in two formats, depending on the protocol
308 * level. At the level 0, format is exactly the same as MousSystems'
309 * five byte packet. At the level 1, the first five bytes are the same
310 * as at the level 0. There are additional three bytes which shows
311 * `dz' and the states of additional buttons. `dz' is expressed as the
312 * sum of the byte 5 and 6 which contain signed seven bit values.
62770245 313 * The states of the button 4 though 10 are in the bit 0 though 6 in
984263bc
MD
314 * the byte 7 respectively: 1 indicates the button is up.
315 */
316#define MOUSE_SYS_PACKETSIZE 8
317#define MOUSE_SYS_SYNCMASK 0xf8
318#define MOUSE_SYS_SYNC 0x80
319#define MOUSE_SYS_BUTTON1UP 0x04 /* left, 1st byte */
320#define MOUSE_SYS_BUTTON2UP 0x02 /* middle, 1st byte */
321#define MOUSE_SYS_BUTTON3UP 0x01 /* right, 1st byte */
322#define MOUSE_SYS_BUTTON4UP 0x0001 /* 7th byte */
323#define MOUSE_SYS_BUTTON5UP 0x0002
324#define MOUSE_SYS_BUTTON6UP 0x0004
325#define MOUSE_SYS_BUTTON7UP 0x0008
326#define MOUSE_SYS_BUTTON8UP 0x0010
327#define MOUSE_SYS_BUTTON9UP 0x0020
328#define MOUSE_SYS_BUTTON10UP 0x0040
329#define MOUSE_SYS_MAXBUTTON 10
330#define MOUSE_SYS_STDBUTTONS 0x07
331#define MOUSE_SYS_EXTBUTTONS 0x7f /* the others */
332
333/* Mouse remote socket */
334#define _PATH_MOUSEREMOTE "/var/run/MouseRemote"
335
336#endif /* _MACHINE_MOUSE_H_ */