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 * $FreeBSD: stable/11/sys/sys/mouse.h 307576 2016-10-18 20:17:57Z gonzo $ 25 */ 26 27 #ifndef _SYS_MOUSE_H_ 28 #define _SYS_MOUSE_H_ 29 30 #include <sys/types.h> 31 #include <sys/ioccom.h> 32 33 /* ioctls */ 34 #define MOUSE_GETSTATUS _IOR('M', 0, mousestatus_t) 35 #define MOUSE_GETHWINFO _IOR('M', 1, mousehw_t) 36 #define MOUSE_GETMODE _IOR('M', 2, mousemode_t) 37 #define MOUSE_SETMODE _IOW('M', 3, mousemode_t) 38 #define MOUSE_GETLEVEL _IOR('M', 4, int) 39 #define MOUSE_SETLEVEL _IOW('M', 5, int) 40 #define MOUSE_GETVARS _IOR('M', 6, mousevar_t) 41 #define MOUSE_SETVARS _IOW('M', 7, mousevar_t) 42 #define MOUSE_READSTATE _IOWR('M', 8, mousedata_t) 43 #define MOUSE_READDATA _IOWR('M', 9, mousedata_t) 44 45 #if 0 /* notyet */ 46 #define MOUSE_SETRESOLUTION _IOW('M', 10, int) 47 #define MOUSE_SETSCALING _IOW('M', 11, int) 48 #define MOUSE_SETRATE _IOW('M', 12, int) 49 #define MOUSE_GETHWID _IOR('M', 13, int) 50 #endif 51 52 #define MOUSE_SYN_GETHWINFO _IOR('M', 100, synapticshw_t) 53 54 /* mouse status block */ 55 typedef struct mousestatus { 56 int flags; /* state change flags */ 57 int button; /* button status */ 58 int obutton; /* previous button status */ 59 int dx; /* x movement */ 60 int dy; /* y movement */ 61 int dz; /* z movement */ 62 } mousestatus_t; 63 64 /* button */ 65 #define MOUSE_BUTTON1DOWN 0x0001 /* left */ 66 #define MOUSE_BUTTON2DOWN 0x0002 /* middle */ 67 #define MOUSE_BUTTON3DOWN 0x0004 /* right */ 68 #define MOUSE_BUTTON4DOWN 0x0008 69 #define MOUSE_BUTTON5DOWN 0x0010 70 #define MOUSE_BUTTON6DOWN 0x0020 71 #define MOUSE_BUTTON7DOWN 0x0040 72 #define MOUSE_BUTTON8DOWN 0x0080 73 #define MOUSE_MAXBUTTON 31 74 #define MOUSE_STDBUTTONS 0x0007 /* buttons 1-3 */ 75 #define MOUSE_EXTBUTTONS 0x7ffffff8 /* the others (28 of them!) */ 76 #define MOUSE_BUTTONS (MOUSE_STDBUTTONS | MOUSE_EXTBUTTONS) 77 78 /* flags */ 79 #define MOUSE_STDBUTTONSCHANGED MOUSE_STDBUTTONS 80 #define MOUSE_EXTBUTTONSCHANGED MOUSE_EXTBUTTONS 81 #define MOUSE_BUTTONSCHANGED MOUSE_BUTTONS 82 #define MOUSE_POSCHANGED 0x80000000 83 84 typedef struct mousehw { 85 int buttons; /* -1 if unknown */ 86 int iftype; /* MOUSE_IF_XXX */ 87 int type; /* mouse/track ball/pad... */ 88 int model; /* I/F dependent model ID: MOUSE_MODEL_XXX */ 89 int hwid; /* I/F dependent hardware ID 90 * for the PS/2 mouse, it will be PSM_XXX_ID 91 */ 92 } mousehw_t; 93 94 typedef struct synapticshw { 95 int infoMajor; 96 int infoMinor; 97 int infoRot180; 98 int infoPortrait; 99 int infoSensor; 100 int infoHardware; 101 int infoNewAbs; 102 int capPen; 103 int infoSimplC; 104 int infoGeometry; 105 int capExtended; 106 int capSleep; 107 int capFourButtons; 108 int capMultiFinger; 109 int capPalmDetect; 110 int capPassthrough; 111 int capMiddle; 112 int capLowPower; 113 int capMultiFingerReport; 114 int capBallistics; 115 int nExtendedButtons; 116 int nExtendedQueries; 117 int capClickPad; 118 int capDeluxeLEDs; 119 int noAbsoluteFilter; 120 int capReportsV; 121 int capUniformClickPad; 122 int capReportsMin; 123 int capInterTouch; 124 int capReportsMax; 125 int capClearPad; 126 int capAdvancedGestures; 127 int multiFingerMode; 128 int capCoveredPad; 129 int verticalScroll; 130 int horizontalScroll; 131 int verticalWheel; 132 int capEWmode; 133 int minimumXCoord; 134 int minimumYCoord; 135 int maximumXCoord; 136 int maximumYCoord; 137 int infoXupmm; 138 int infoYupmm; 139 } synapticshw_t; 140 141 /* iftype */ 142 #define MOUSE_IF_UNKNOWN (-1) 143 #define MOUSE_IF_SERIAL 0 144 #define MOUSE_IF_BUS 1 145 #define MOUSE_IF_INPORT 2 146 #define MOUSE_IF_PS2 3 147 #define MOUSE_IF_SYSMOUSE 4 148 #define MOUSE_IF_USB 5 149 150 /* type */ 151 #define MOUSE_UNKNOWN (-1) /* should be treated as a mouse */ 152 #define MOUSE_MOUSE 0 153 #define MOUSE_TRACKBALL 1 154 #define MOUSE_STICK 2 155 #define MOUSE_PAD 3 156 157 /* model */ 158 #define MOUSE_MODEL_UNKNOWN (-1) 159 #define MOUSE_MODEL_GENERIC 0 160 #define MOUSE_MODEL_GLIDEPOINT 1 161 #define MOUSE_MODEL_NETSCROLL 2 162 #define MOUSE_MODEL_NET 3 163 #define MOUSE_MODEL_INTELLI 4 164 #define MOUSE_MODEL_THINK 5 165 #define MOUSE_MODEL_EASYSCROLL 6 166 #define MOUSE_MODEL_MOUSEMANPLUS 7 167 #define MOUSE_MODEL_KIDSPAD 8 168 #define MOUSE_MODEL_VERSAPAD 9 169 #define MOUSE_MODEL_EXPLORER 10 170 #define MOUSE_MODEL_4D 11 171 #define MOUSE_MODEL_4DPLUS 12 172 #define MOUSE_MODEL_SYNAPTICS 13 173 #define MOUSE_MODEL_TRACKPOINT 14 174 #define MOUSE_MODEL_ELANTECH 15 175 176 typedef struct mousemode { 177 int protocol; /* MOUSE_PROTO_XXX */ 178 int rate; /* report rate (per sec), -1 if unknown */ 179 int resolution; /* MOUSE_RES_XXX, -1 if unknown */ 180 int accelfactor; /* accelation factor (must be 1 or greater) */ 181 int level; /* driver operation level */ 182 int packetsize; /* the length of the data packet */ 183 unsigned char syncmask[2]; /* sync. data bits in the header byte */ 184 } mousemode_t; 185 186 /* protocol */ 187 /* 188 * Serial protocols: 189 * Microsoft, MouseSystems, Logitech, MM series, MouseMan, Hitachi Tablet, 190 * GlidePoint, IntelliMouse, Thinking Mouse, MouseRemote, Kidspad, 191 * VersaPad 192 * Bus mouse protocols: 193 * bus, InPort 194 * PS/2 mouse protocol: 195 * PS/2 196 */ 197 #define MOUSE_PROTO_UNKNOWN (-1) 198 #define MOUSE_PROTO_MS 0 /* Microsoft Serial, 3 bytes */ 199 #define MOUSE_PROTO_MSC 1 /* Mouse Systems, 5 bytes */ 200 #define MOUSE_PROTO_LOGI 2 /* Logitech, 3 bytes */ 201 #define MOUSE_PROTO_MM 3 /* MM series, 3 bytes */ 202 #define MOUSE_PROTO_LOGIMOUSEMAN 4 /* Logitech MouseMan 3/4 bytes */ 203 #define MOUSE_PROTO_BUS 5 /* MS/Logitech bus mouse */ 204 #define MOUSE_PROTO_INPORT 6 /* MS/ATI InPort mouse */ 205 #define MOUSE_PROTO_PS2 7 /* PS/2 mouse, 3 bytes */ 206 #define MOUSE_PROTO_HITTAB 8 /* Hitachi Tablet 3 bytes */ 207 #define MOUSE_PROTO_GLIDEPOINT 9 /* ALPS GlidePoint, 3/4 bytes */ 208 #define MOUSE_PROTO_INTELLI 10 /* MS IntelliMouse, 4 bytes */ 209 #define MOUSE_PROTO_THINK 11 /* Kensignton Thinking Mouse, 3/4 bytes */ 210 #define MOUSE_PROTO_SYSMOUSE 12 /* /dev/sysmouse */ 211 #define MOUSE_PROTO_X10MOUSEREM 13 /* X10 MouseRemote, 3 bytes */ 212 #define MOUSE_PROTO_KIDSPAD 14 /* Genius Kidspad */ 213 #define MOUSE_PROTO_VERSAPAD 15 /* Interlink VersaPad, 6 bytes */ 214 #define MOUSE_PROTO_JOGDIAL 16 /* Vaio's JogDial */ 215 #define MOUSE_PROTO_GTCO_DIGIPAD 17 216 217 #define MOUSE_RES_UNKNOWN (-1) 218 #define MOUSE_RES_DEFAULT 0 219 #define MOUSE_RES_LOW (-2) 220 #define MOUSE_RES_MEDIUMLOW (-3) 221 #define MOUSE_RES_MEDIUMHIGH (-4) 222 #define MOUSE_RES_HIGH (-5) 223 224 typedef struct mousedata { 225 int len; /* # of data in the buffer */ 226 int buf[16]; /* data buffer */ 227 } mousedata_t; 228 229 #if (defined(MOUSE_GETVARS)) 230 231 typedef struct mousevar { 232 int var[16]; 233 } mousevar_t; 234 235 /* magic numbers in var[0] */ 236 #define MOUSE_VARS_PS2_SIG 0x00325350 /* 'PS2' */ 237 #define MOUSE_VARS_BUS_SIG 0x00535542 /* 'BUS' */ 238 #define MOUSE_VARS_INPORT_SIG 0x00504e49 /* 'INP' */ 239 240 #endif /* MOUSE_GETVARS */ 241 242 /* Synaptics Touchpad */ 243 #define MOUSE_SYNAPTICS_PACKETSIZE 6 /* '3' works better */ 244 245 /* Elantech Touchpad */ 246 #define MOUSE_ELANTECH_PACKETSIZE 6 247 248 /* Microsoft Serial mouse data packet */ 249 #define MOUSE_MSS_PACKETSIZE 3 250 #define MOUSE_MSS_SYNCMASK 0x40 251 #define MOUSE_MSS_SYNC 0x40 252 #define MOUSE_MSS_BUTTONS 0x30 253 #define MOUSE_MSS_BUTTON1DOWN 0x20 /* left */ 254 #define MOUSE_MSS_BUTTON2DOWN 0x00 /* no middle button */ 255 #define MOUSE_MSS_BUTTON3DOWN 0x10 /* right */ 256 257 /* Logitech MouseMan data packet (M+ protocol) */ 258 #define MOUSE_LMAN_BUTTON2DOWN 0x20 /* middle button, the 4th byte */ 259 260 /* ALPS GlidePoint extention (variant of M+ protocol) */ 261 #define MOUSE_ALPS_BUTTON2DOWN 0x20 /* middle button, the 4th byte */ 262 #define MOUSE_ALPS_TAP 0x10 /* `tapping' action, the 4th byte */ 263 264 /* Kinsington Thinking Mouse extention (variant of M+ protocol) */ 265 #define MOUSE_THINK_BUTTON2DOWN 0x20 /* lower-left button, the 4th byte */ 266 #define MOUSE_THINK_BUTTON4DOWN 0x10 /* lower-right button, the 4th byte */ 267 268 /* MS IntelliMouse (variant of MS Serial) */ 269 #define MOUSE_INTELLI_PACKETSIZE 4 270 #define MOUSE_INTELLI_BUTTON2DOWN 0x10 /* middle button in the 4th byte */ 271 272 /* Mouse Systems Corp. mouse data packet */ 273 #define MOUSE_MSC_PACKETSIZE 5 274 #define MOUSE_MSC_SYNCMASK 0xf8 275 #define MOUSE_MSC_SYNC 0x80 276 #define MOUSE_MSC_BUTTONS 0x07 277 #define MOUSE_MSC_BUTTON1UP 0x04 /* left */ 278 #define MOUSE_MSC_BUTTON2UP 0x02 /* middle */ 279 #define MOUSE_MSC_BUTTON3UP 0x01 /* right */ 280 #define MOUSE_MSC_MAXBUTTON 3 281 282 /* MM series mouse data packet */ 283 #define MOUSE_MM_PACKETSIZE 3 284 #define MOUSE_MM_SYNCMASK 0xe0 285 #define MOUSE_MM_SYNC 0x80 286 #define MOUSE_MM_BUTTONS 0x07 287 #define MOUSE_MM_BUTTON1DOWN 0x04 /* left */ 288 #define MOUSE_MM_BUTTON2DOWN 0x02 /* middle */ 289 #define MOUSE_MM_BUTTON3DOWN 0x01 /* right */ 290 #define MOUSE_MM_XPOSITIVE 0x10 291 #define MOUSE_MM_YPOSITIVE 0x08 292 293 /* PS/2 mouse data packet */ 294 #define MOUSE_PS2_PACKETSIZE 3 295 #define MOUSE_PS2_SYNCMASK 0xc8 296 #define MOUSE_PS2_SYNC 0x08 297 #define MOUSE_PS2_BUTTONS 0x07 /* 0x03 for 2 button mouse */ 298 #define MOUSE_PS2_BUTTON1DOWN 0x01 /* left */ 299 #define MOUSE_PS2_BUTTON2DOWN 0x04 /* middle */ 300 #define MOUSE_PS2_BUTTON3DOWN 0x02 /* right */ 301 #define MOUSE_PS2_TAP MOUSE_PS2_SYNC /* GlidePoint (PS/2) `tapping' 302 * Yes! this is the same bit 303 * as SYNC! 304 */ 305 306 #define MOUSE_PS2_XNEG 0x10 307 #define MOUSE_PS2_YNEG 0x20 308 #define MOUSE_PS2_XOVERFLOW 0x40 309 #define MOUSE_PS2_YOVERFLOW 0x80 310 311 /* Logitech MouseMan+ (PS/2) data packet (PS/2++ protocol) */ 312 #define MOUSE_PS2PLUS_SYNCMASK 0x48 313 #define MOUSE_PS2PLUS_SYNC 0x48 314 #define MOUSE_PS2PLUS_ZNEG 0x08 /* sign bit */ 315 #define MOUSE_PS2PLUS_BUTTON4DOWN 0x10 /* 4th button on MouseMan+ */ 316 #define MOUSE_PS2PLUS_BUTTON5DOWN 0x20 317 318 /* IBM ScrollPoint (PS/2) also uses PS/2++ protocol */ 319 #define MOUSE_SPOINT_ZNEG 0x80 /* sign bits */ 320 #define MOUSE_SPOINT_WNEG 0x08 321 322 /* MS IntelliMouse (PS/2) data packet */ 323 #define MOUSE_PS2INTELLI_PACKETSIZE 4 324 /* some compatible mice have additional buttons */ 325 #define MOUSE_PS2INTELLI_BUTTON4DOWN 0x40 326 #define MOUSE_PS2INTELLI_BUTTON5DOWN 0x80 327 328 /* MS IntelliMouse Explorer (PS/2) data packet (variation of IntelliMouse) */ 329 #define MOUSE_EXPLORER_ZNEG 0x08 /* sign bit */ 330 /* IntelliMouse Explorer has additional button data in the fourth byte */ 331 #define MOUSE_EXPLORER_BUTTON4DOWN 0x10 332 #define MOUSE_EXPLORER_BUTTON5DOWN 0x20 333 334 /* Interlink VersaPad (serial I/F) data packet */ 335 #define MOUSE_VERSA_PACKETSIZE 6 336 #define MOUSE_VERSA_IN_USE 0x04 337 #define MOUSE_VERSA_SYNCMASK 0xc3 338 #define MOUSE_VERSA_SYNC 0xc0 339 #define MOUSE_VERSA_BUTTONS 0x30 340 #define MOUSE_VERSA_BUTTON1DOWN 0x20 /* left */ 341 #define MOUSE_VERSA_BUTTON2DOWN 0x00 /* middle */ 342 #define MOUSE_VERSA_BUTTON3DOWN 0x10 /* right */ 343 #define MOUSE_VERSA_TAP 0x08 344 345 /* Interlink VersaPad (PS/2 I/F) data packet */ 346 #define MOUSE_PS2VERSA_PACKETSIZE 6 347 #define MOUSE_PS2VERSA_IN_USE 0x10 348 #define MOUSE_PS2VERSA_SYNCMASK 0xe8 349 #define MOUSE_PS2VERSA_SYNC 0xc8 350 #define MOUSE_PS2VERSA_BUTTONS 0x05 351 #define MOUSE_PS2VERSA_BUTTON1DOWN 0x04 /* left */ 352 #define MOUSE_PS2VERSA_BUTTON2DOWN 0x00 /* middle */ 353 #define MOUSE_PS2VERSA_BUTTON3DOWN 0x01 /* right */ 354 #define MOUSE_PS2VERSA_TAP 0x02 355 356 /* A4 Tech 4D Mouse (PS/2) data packet */ 357 #define MOUSE_4D_PACKETSIZE 3 358 #define MOUSE_4D_WHEELBITS 0xf0 359 360 /* A4 Tech 4D+ Mouse (PS/2) data packet */ 361 #define MOUSE_4DPLUS_PACKETSIZE 3 362 #define MOUSE_4DPLUS_ZNEG 0x04 /* sign bit */ 363 #define MOUSE_4DPLUS_BUTTON4DOWN 0x08 364 365 /* sysmouse extended data packet */ 366 /* 367 * /dev/sysmouse sends data in two formats, depending on the protocol 368 * level. At the level 0, format is exactly the same as MousSystems' 369 * five byte packet. At the level 1, the first five bytes are the same 370 * as at the level 0. There are additional three bytes which shows 371 * `dz' and the states of additional buttons. `dz' is expressed as the 372 * sum of the byte 5 and 6 which contain signed seven bit values. 373 * The states of the button 4 though 10 are in the bit 0 though 6 in 374 * the byte 7 respectively: 1 indicates the button is up. 375 */ 376 #define MOUSE_SYS_PACKETSIZE 8 377 #define MOUSE_SYS_SYNCMASK 0xf8 378 #define MOUSE_SYS_SYNC 0x80 379 #define MOUSE_SYS_BUTTON1UP 0x04 /* left, 1st byte */ 380 #define MOUSE_SYS_BUTTON2UP 0x02 /* middle, 1st byte */ 381 #define MOUSE_SYS_BUTTON3UP 0x01 /* right, 1st byte */ 382 #define MOUSE_SYS_BUTTON4UP 0x0001 /* 7th byte */ 383 #define MOUSE_SYS_BUTTON5UP 0x0002 384 #define MOUSE_SYS_BUTTON6UP 0x0004 385 #define MOUSE_SYS_BUTTON7UP 0x0008 386 #define MOUSE_SYS_BUTTON8UP 0x0010 387 #define MOUSE_SYS_BUTTON9UP 0x0020 388 #define MOUSE_SYS_BUTTON10UP 0x0040 389 #define MOUSE_SYS_MAXBUTTON 10 390 #define MOUSE_SYS_STDBUTTONS 0x07 391 #define MOUSE_SYS_EXTBUTTONS 0x7f /* the others */ 392 393 /* Mouse remote socket */ 394 #define _PATH_MOUSEREMOTE "/var/run/MouseRemote" 395 396 #endif /* !_SYS_MOUSE_H_ */ 397