1 .. _input-event-codes: 1 .. _input-event-codes: 2 2 3 ================= 3 ================= 4 Input event codes 4 Input event codes 5 ================= 5 ================= 6 6 7 7 8 The input protocol uses a map of types and cod 8 The input protocol uses a map of types and codes to express input device values 9 to userspace. This document describes the type 9 to userspace. This document describes the types and codes and how and when they 10 may be used. 10 may be used. 11 11 12 A single hardware event generates multiple inp 12 A single hardware event generates multiple input events. Each input event 13 contains the new value of a single data item. 13 contains the new value of a single data item. A special event type, EV_SYN, is 14 used to separate input events into packets of 14 used to separate input events into packets of input data changes occurring at 15 the same moment in time. In the following, the 15 the same moment in time. In the following, the term "event" refers to a single 16 input event encompassing a type, code, and val 16 input event encompassing a type, code, and value. 17 17 18 The input protocol is a stateful protocol. Eve 18 The input protocol is a stateful protocol. Events are emitted only when values 19 of event codes have changed. However, the stat 19 of event codes have changed. However, the state is maintained within the Linux 20 input subsystem; drivers do not need to mainta 20 input subsystem; drivers do not need to maintain the state and may attempt to 21 emit unchanged values without harm. Userspace 21 emit unchanged values without harm. Userspace may obtain the current state of 22 event code values using the EVIOCG* ioctls def 22 event code values using the EVIOCG* ioctls defined in linux/input.h. The event 23 reports supported by a device are also provide 23 reports supported by a device are also provided by sysfs in 24 class/input/event*/device/capabilities/, and t 24 class/input/event*/device/capabilities/, and the properties of a device are 25 provided in class/input/event*/device/properti 25 provided in class/input/event*/device/properties. 26 26 27 Event types 27 Event types 28 =========== 28 =========== 29 29 30 Event types are groupings of codes under a log 30 Event types are groupings of codes under a logical input construct. Each 31 type has a set of applicable codes to be used 31 type has a set of applicable codes to be used in generating events. See the 32 Codes section for details on valid codes for e 32 Codes section for details on valid codes for each type. 33 33 34 * EV_SYN: 34 * EV_SYN: 35 35 36 - Used as markers to separate events. Events 36 - Used as markers to separate events. Events may be separated in time or in 37 space, such as with the multitouch protoco 37 space, such as with the multitouch protocol. 38 38 39 * EV_KEY: 39 * EV_KEY: 40 40 41 - Used to describe state changes of keyboard 41 - Used to describe state changes of keyboards, buttons, or other key-like 42 devices. 42 devices. 43 43 44 * EV_REL: 44 * EV_REL: 45 45 46 - Used to describe relative axis value chang 46 - Used to describe relative axis value changes, e.g. moving the mouse 5 units 47 to the left. 47 to the left. 48 48 49 * EV_ABS: 49 * EV_ABS: 50 50 51 - Used to describe absolute axis value chang 51 - Used to describe absolute axis value changes, e.g. describing the 52 coordinates of a touch on a touchscreen. 52 coordinates of a touch on a touchscreen. 53 53 54 * EV_MSC: 54 * EV_MSC: 55 55 56 - Used to describe miscellaneous input data 56 - Used to describe miscellaneous input data that do not fit into other types. 57 57 58 * EV_SW: 58 * EV_SW: 59 59 60 - Used to describe binary state input switch 60 - Used to describe binary state input switches. 61 61 62 * EV_LED: 62 * EV_LED: 63 63 64 - Used to turn LEDs on devices on and off. 64 - Used to turn LEDs on devices on and off. 65 65 66 * EV_SND: 66 * EV_SND: 67 67 68 - Used to output sound to devices. 68 - Used to output sound to devices. 69 69 70 * EV_REP: 70 * EV_REP: 71 71 72 - Used for autorepeating devices. 72 - Used for autorepeating devices. 73 73 74 * EV_FF: 74 * EV_FF: 75 75 76 - Used to send force feedback commands to an 76 - Used to send force feedback commands to an input device. 77 77 78 * EV_PWR: 78 * EV_PWR: 79 79 80 - A special type for power button and switch 80 - A special type for power button and switch input. 81 81 82 * EV_FF_STATUS: 82 * EV_FF_STATUS: 83 83 84 - Used to receive force feedback device stat 84 - Used to receive force feedback device status. 85 85 86 Event codes 86 Event codes 87 =========== 87 =========== 88 88 89 Event codes define the precise type of event. 89 Event codes define the precise type of event. 90 90 91 EV_SYN 91 EV_SYN 92 ------ 92 ------ 93 93 94 EV_SYN event values are undefined. Their usage 94 EV_SYN event values are undefined. Their usage is defined only by when they are 95 sent in the evdev event stream. 95 sent in the evdev event stream. 96 96 97 * SYN_REPORT: 97 * SYN_REPORT: 98 98 99 - Used to synchronize and separate events in 99 - Used to synchronize and separate events into packets of input data changes 100 occurring at the same moment in time. For 100 occurring at the same moment in time. For example, motion of a mouse may set 101 the REL_X and REL_Y values for one motion, 101 the REL_X and REL_Y values for one motion, then emit a SYN_REPORT. The next 102 motion will emit more REL_X and REL_Y valu 102 motion will emit more REL_X and REL_Y values and send another SYN_REPORT. 103 103 104 * SYN_CONFIG: 104 * SYN_CONFIG: 105 105 106 - TBD 106 - TBD 107 107 108 * SYN_MT_REPORT: 108 * SYN_MT_REPORT: 109 109 110 - Used to synchronize and separate touch eve 110 - Used to synchronize and separate touch events. See the 111 multi-touch-protocol.txt document for more 111 multi-touch-protocol.txt document for more information. 112 112 113 * SYN_DROPPED: 113 * SYN_DROPPED: 114 114 115 - Used to indicate buffer overrun in the evd 115 - Used to indicate buffer overrun in the evdev client's event queue. 116 Client should ignore all events up to and 116 Client should ignore all events up to and including next SYN_REPORT 117 event and query the device (using EVIOCG* 117 event and query the device (using EVIOCG* ioctls) to obtain its 118 current state. 118 current state. 119 119 120 EV_KEY 120 EV_KEY 121 ------ 121 ------ 122 122 123 EV_KEY events take the form KEY_<name> or BTN_ 123 EV_KEY events take the form KEY_<name> or BTN_<name>. For example, KEY_A is used 124 to represent the 'A' key on a keyboard. When a 124 to represent the 'A' key on a keyboard. When a key is depressed, an event with 125 the key's code is emitted with value 1. When t 125 the key's code is emitted with value 1. When the key is released, an event is 126 emitted with value 0. Some hardware send event 126 emitted with value 0. Some hardware send events when a key is repeated. These 127 events have a value of 2. In general, KEY_<nam 127 events have a value of 2. In general, KEY_<name> is used for keyboard keys, and 128 BTN_<name> is used for other types of momentar 128 BTN_<name> is used for other types of momentary switch events. 129 129 130 A few EV_KEY codes have special meanings: 130 A few EV_KEY codes have special meanings: 131 131 132 * BTN_TOOL_<name>: 132 * BTN_TOOL_<name>: 133 133 134 - These codes are used in conjunction with i 134 - These codes are used in conjunction with input trackpads, tablets, and 135 touchscreens. These devices may be used wi 135 touchscreens. These devices may be used with fingers, pens, or other tools. 136 When an event occurs and a tool is used, t 136 When an event occurs and a tool is used, the corresponding BTN_TOOL_<name> 137 code should be set to a value of 1. When t 137 code should be set to a value of 1. When the tool is no longer interacting 138 with the input device, the BTN_TOOL_<name> 138 with the input device, the BTN_TOOL_<name> code should be reset to 0. All 139 trackpads, tablets, and touchscreens shoul 139 trackpads, tablets, and touchscreens should use at least one BTN_TOOL_<name> 140 code when events are generated. Likewise a !! 140 code when events are generated. 141 touchscreens should export only one BTN_TO << 142 existing userspace, it is recommended to n << 143 but first emitting the old BTN_TOOL_<name> << 144 and then set the new BTN_TOOL_<name> at 1. << 145 141 146 * BTN_TOUCH: 142 * BTN_TOUCH: 147 143 148 BTN_TOUCH is used for touch contact. While 144 BTN_TOUCH is used for touch contact. While an input tool is determined to be 149 within meaningful physical contact, the va 145 within meaningful physical contact, the value of this property must be set 150 to 1. Meaningful physical contact may mean 146 to 1. Meaningful physical contact may mean any contact, or it may mean 151 contact conditioned by an implementation d 147 contact conditioned by an implementation defined property. For example, a 152 touchpad may set the value to 1 only when 148 touchpad may set the value to 1 only when the touch pressure rises above a 153 certain value. BTN_TOUCH may be combined w 149 certain value. BTN_TOUCH may be combined with BTN_TOOL_<name> codes. For 154 example, a pen tablet may set BTN_TOOL_PEN 150 example, a pen tablet may set BTN_TOOL_PEN to 1 and BTN_TOUCH to 0 while the 155 pen is hovering over but not touching the 151 pen is hovering over but not touching the tablet surface. 156 152 157 Note: For appropriate function of the legacy m 153 Note: For appropriate function of the legacy mousedev emulation driver, 158 BTN_TOUCH must be the first evdev code emitted 154 BTN_TOUCH must be the first evdev code emitted in a synchronization frame. 159 155 160 Note: Historically a touch device with BTN_TOO 156 Note: Historically a touch device with BTN_TOOL_FINGER and BTN_TOUCH was 161 interpreted as a touchpad by userspace, while 157 interpreted as a touchpad by userspace, while a similar device without 162 BTN_TOOL_FINGER was interpreted as a touchscre 158 BTN_TOOL_FINGER was interpreted as a touchscreen. For backwards compatibility 163 with current userspace it is recommended to fo 159 with current userspace it is recommended to follow this distinction. In the 164 future, this distinction will be deprecated an 160 future, this distinction will be deprecated and the device properties ioctl 165 EVIOCGPROP, defined in linux/input.h, will be 161 EVIOCGPROP, defined in linux/input.h, will be used to convey the device type. 166 162 167 * BTN_TOOL_FINGER, BTN_TOOL_DOUBLETAP, BTN_TOO 163 * BTN_TOOL_FINGER, BTN_TOOL_DOUBLETAP, BTN_TOOL_TRIPLETAP, BTN_TOOL_QUADTAP: 168 164 169 - These codes denote one, two, three, and fo 165 - These codes denote one, two, three, and four finger interaction on a 170 trackpad or touchscreen. For example, if t 166 trackpad or touchscreen. For example, if the user uses two fingers and moves 171 them on the touchpad in an effort to scrol 167 them on the touchpad in an effort to scroll content on screen, 172 BTN_TOOL_DOUBLETAP should be set to value 168 BTN_TOOL_DOUBLETAP should be set to value 1 for the duration of the motion. 173 Note that all BTN_TOOL_<name> codes and th 169 Note that all BTN_TOOL_<name> codes and the BTN_TOUCH code are orthogonal in 174 purpose. A trackpad event generated by fin 170 purpose. A trackpad event generated by finger touches should generate events 175 for one code from each group. At most only 171 for one code from each group. At most only one of these BTN_TOOL_<name> 176 codes should have a value of 1 during any 172 codes should have a value of 1 during any synchronization frame. 177 173 178 Note: Historically some drivers emitted multip 174 Note: Historically some drivers emitted multiple of the finger count codes with 179 a value of 1 in the same synchronization frame 175 a value of 1 in the same synchronization frame. This usage is deprecated. 180 176 181 Note: In multitouch drivers, the input_mt_repo 177 Note: In multitouch drivers, the input_mt_report_finger_count() function should 182 be used to emit these codes. Please see multi- 178 be used to emit these codes. Please see multi-touch-protocol.txt for details. 183 179 184 EV_REL 180 EV_REL 185 ------ 181 ------ 186 182 187 EV_REL events describe relative changes in a p 183 EV_REL events describe relative changes in a property. For example, a mouse may 188 move to the left by a certain number of units, 184 move to the left by a certain number of units, but its absolute position in 189 space is unknown. If the absolute position is 185 space is unknown. If the absolute position is known, EV_ABS codes should be used 190 instead of EV_REL codes. 186 instead of EV_REL codes. 191 187 192 A few EV_REL codes have special meanings: 188 A few EV_REL codes have special meanings: 193 189 194 * REL_WHEEL, REL_HWHEEL: 190 * REL_WHEEL, REL_HWHEEL: 195 191 196 - These codes are used for vertical and hori 192 - These codes are used for vertical and horizontal scroll wheels, 197 respectively. The value is the number of d 193 respectively. The value is the number of detents moved on the wheel, the 198 physical size of which varies by device. F 194 physical size of which varies by device. For high-resolution wheels 199 this may be an approximation based on the 195 this may be an approximation based on the high-resolution scroll events, 200 see REL_WHEEL_HI_RES. These event codes ar 196 see REL_WHEEL_HI_RES. These event codes are legacy codes and 201 REL_WHEEL_HI_RES and REL_HWHEEL_HI_RES sho 197 REL_WHEEL_HI_RES and REL_HWHEEL_HI_RES should be preferred where 202 available. 198 available. 203 199 204 * REL_WHEEL_HI_RES, REL_HWHEEL_HI_RES: 200 * REL_WHEEL_HI_RES, REL_HWHEEL_HI_RES: 205 201 206 - High-resolution scroll wheel data. The acc 202 - High-resolution scroll wheel data. The accumulated value 120 represents 207 movement by one detent. For devices that d 203 movement by one detent. For devices that do not provide high-resolution 208 scrolling, the value is always a multiple 204 scrolling, the value is always a multiple of 120. For devices with 209 high-resolution scrolling, the value may b 205 high-resolution scrolling, the value may be a fraction of 120. 210 206 211 If a vertical scroll wheel supports high-r 207 If a vertical scroll wheel supports high-resolution scrolling, this code 212 will be emitted in addition to REL_WHEEL o 208 will be emitted in addition to REL_WHEEL or REL_HWHEEL. The REL_WHEEL 213 and REL_HWHEEL may be an approximation bas 209 and REL_HWHEEL may be an approximation based on the high-resolution 214 scroll events. There is no guarantee that 210 scroll events. There is no guarantee that the high-resolution data 215 is a multiple of 120 at the time of an emu 211 is a multiple of 120 at the time of an emulated REL_WHEEL or REL_HWHEEL 216 event. 212 event. 217 213 218 EV_ABS 214 EV_ABS 219 ------ 215 ------ 220 216 221 EV_ABS events describe absolute changes in a p 217 EV_ABS events describe absolute changes in a property. For example, a touchpad 222 may emit coordinates for a touch location. 218 may emit coordinates for a touch location. 223 219 224 A few EV_ABS codes have special meanings: 220 A few EV_ABS codes have special meanings: 225 221 226 * ABS_DISTANCE: 222 * ABS_DISTANCE: 227 223 228 - Used to describe the distance of a tool fr 224 - Used to describe the distance of a tool from an interaction surface. This 229 event should only be emitted while the too 225 event should only be emitted while the tool is hovering, meaning in close 230 proximity of the device and while the valu 226 proximity of the device and while the value of the BTN_TOUCH code is 0. If 231 the input device may be used freely in thr 227 the input device may be used freely in three dimensions, consider ABS_Z 232 instead. 228 instead. 233 - BTN_TOOL_<name> should be set to 1 when th 229 - BTN_TOOL_<name> should be set to 1 when the tool comes into detectable 234 proximity and set to 0 when the tool leave 230 proximity and set to 0 when the tool leaves detectable proximity. 235 BTN_TOOL_<name> signals the type of tool t 231 BTN_TOOL_<name> signals the type of tool that is currently detected by the 236 hardware and is otherwise independent of A 232 hardware and is otherwise independent of ABS_DISTANCE and/or BTN_TOUCH. 237 233 238 * ABS_PROFILE: << 239 << 240 - Used to describe the state of a multi-valu << 241 emitted only when the selected profile cha << 242 selected profile value. << 243 << 244 * ABS_MT_<name>: 234 * ABS_MT_<name>: 245 235 246 - Used to describe multitouch input events. 236 - Used to describe multitouch input events. Please see 247 multi-touch-protocol.txt for details. 237 multi-touch-protocol.txt for details. 248 238 249 * ABS_PRESSURE/ABS_MT_PRESSURE: << 250 << 251 - For touch devices, many devices converted << 252 A finger flattens with pressure, causing << 253 pressure and contact size are directly re << 254 for other devices, for example digitizers << 255 pressure sensor ("pressure pads"). << 256 << 257 A device should set the resolution of the << 258 pressure is in measurable units. If the r << 259 pressure data is in arbitrary units. If t << 260 pressure data is in units/gram. For examp << 261 resolution of 1 represents 10 gram, a val << 262 1000 represents 10 microgram. << 263 << 264 EV_SW 239 EV_SW 265 ----- 240 ----- 266 241 267 EV_SW events describe stateful binary switches 242 EV_SW events describe stateful binary switches. For example, the SW_LID code is 268 used to denote when a laptop lid is closed. 243 used to denote when a laptop lid is closed. 269 244 270 Upon binding to a device or resuming from susp 245 Upon binding to a device or resuming from suspend, a driver must report 271 the current switch state. This ensures that th 246 the current switch state. This ensures that the device, kernel, and userspace 272 state is in sync. 247 state is in sync. 273 248 274 Upon resume, if the switch state is the same a 249 Upon resume, if the switch state is the same as before suspend, then the input 275 subsystem will filter out the duplicate switch 250 subsystem will filter out the duplicate switch state reports. The driver does 276 not need to keep the state of the switch at an 251 not need to keep the state of the switch at any time. 277 252 278 EV_MSC 253 EV_MSC 279 ------ 254 ------ 280 255 281 EV_MSC events are used for input and output ev 256 EV_MSC events are used for input and output events that do not fall under other 282 categories. 257 categories. 283 258 284 A few EV_MSC codes have special meaning: 259 A few EV_MSC codes have special meaning: 285 260 286 * MSC_TIMESTAMP: 261 * MSC_TIMESTAMP: 287 262 288 - Used to report the number of microseconds 263 - Used to report the number of microseconds since the last reset. This event 289 should be coded as an uint32 value, which 264 should be coded as an uint32 value, which is allowed to wrap around with 290 no special consequence. It is assumed that 265 no special consequence. It is assumed that the time difference between two 291 consecutive events is reliable on a reason 266 consecutive events is reliable on a reasonable time scale (hours). 292 A reset to zero can happen, in which case 267 A reset to zero can happen, in which case the time since the last event is 293 unknown. If the device does not provide t 268 unknown. If the device does not provide this information, the driver must 294 not provide it to user space. 269 not provide it to user space. 295 270 296 EV_LED 271 EV_LED 297 ------ 272 ------ 298 273 299 EV_LED events are used for input and output to 274 EV_LED events are used for input and output to set and query the state of 300 various LEDs on devices. 275 various LEDs on devices. 301 276 302 EV_REP 277 EV_REP 303 ------ 278 ------ 304 279 305 EV_REP events are used for specifying autorepe 280 EV_REP events are used for specifying autorepeating events. 306 281 307 EV_SND 282 EV_SND 308 ------ 283 ------ 309 284 310 EV_SND events are used for sending sound comma 285 EV_SND events are used for sending sound commands to simple sound output 311 devices. 286 devices. 312 287 313 EV_FF 288 EV_FF 314 ----- 289 ----- 315 290 316 EV_FF events are used to initialize a force fe 291 EV_FF events are used to initialize a force feedback capable device and to cause 317 such device to feedback. 292 such device to feedback. 318 293 319 EV_PWR 294 EV_PWR 320 ------ 295 ------ 321 296 322 EV_PWR events are a special type of event used 297 EV_PWR events are a special type of event used specifically for power 323 management. Its usage is not well defined. To 298 management. Its usage is not well defined. To be addressed later. 324 299 325 Device properties 300 Device properties 326 ================= 301 ================= 327 302 328 Normally, userspace sets up an input device ba 303 Normally, userspace sets up an input device based on the data it emits, 329 i.e., the event types. In the case of two devi 304 i.e., the event types. In the case of two devices emitting the same event 330 types, additional information can be provided 305 types, additional information can be provided in the form of device 331 properties. 306 properties. 332 307 333 INPUT_PROP_DIRECT + INPUT_PROP_POINTER 308 INPUT_PROP_DIRECT + INPUT_PROP_POINTER 334 -------------------------------------- 309 -------------------------------------- 335 310 336 The INPUT_PROP_DIRECT property indicates that 311 The INPUT_PROP_DIRECT property indicates that device coordinates should be 337 directly mapped to screen coordinates (not tak 312 directly mapped to screen coordinates (not taking into account trivial 338 transformations, such as scaling, flipping and 313 transformations, such as scaling, flipping and rotating). Non-direct input 339 devices require non-trivial transformation, su 314 devices require non-trivial transformation, such as absolute to relative 340 transformation for touchpads. Typical direct i 315 transformation for touchpads. Typical direct input devices: touchscreens, 341 drawing tablets; non-direct devices: touchpads 316 drawing tablets; non-direct devices: touchpads, mice. 342 317 343 The INPUT_PROP_POINTER property indicates that 318 The INPUT_PROP_POINTER property indicates that the device is not transposed 344 on the screen and thus requires use of an on-s 319 on the screen and thus requires use of an on-screen pointer to trace user's 345 movements. Typical pointer devices: touchpads 320 movements. Typical pointer devices: touchpads, tablets, mice; non-pointer 346 device: touchscreen. 321 device: touchscreen. 347 322 348 If neither INPUT_PROP_DIRECT or INPUT_PROP_POI 323 If neither INPUT_PROP_DIRECT or INPUT_PROP_POINTER are set, the property is 349 considered undefined and the device type shoul 324 considered undefined and the device type should be deduced in the 350 traditional way, using emitted event types. 325 traditional way, using emitted event types. 351 326 352 INPUT_PROP_BUTTONPAD 327 INPUT_PROP_BUTTONPAD 353 -------------------- 328 -------------------- 354 329 355 For touchpads where the button is placed benea 330 For touchpads where the button is placed beneath the surface, such that 356 pressing down on the pad causes a button click 331 pressing down on the pad causes a button click, this property should be 357 set. Common in Clickpad notebooks and Macbooks !! 332 set. Common in clickpad notebooks and macbooks from 2009 and onwards. 358 333 359 Originally, the buttonpad property was coded i 334 Originally, the buttonpad property was coded into the bcm5974 driver 360 version field under the name integrated button 335 version field under the name integrated button. For backwards 361 compatibility, both methods need to be checked 336 compatibility, both methods need to be checked in userspace. 362 337 363 INPUT_PROP_SEMI_MT 338 INPUT_PROP_SEMI_MT 364 ------------------ 339 ------------------ 365 340 366 Some touchpads, most common between 2008 and 2 341 Some touchpads, most common between 2008 and 2011, can detect the presence 367 of multiple contacts without resolving the ind 342 of multiple contacts without resolving the individual positions; only the 368 number of contacts and a rectangular shape is 343 number of contacts and a rectangular shape is known. For such 369 touchpads, the SEMI_MT property should be set. !! 344 touchpads, the semi-mt property should be set. 370 345 371 Depending on the device, the rectangle may enc 346 Depending on the device, the rectangle may enclose all touches, like a 372 bounding box, or just some of them, for instan 347 bounding box, or just some of them, for instance the two most recent 373 touches. The diversity makes the rectangle of 348 touches. The diversity makes the rectangle of limited use, but some 374 gestures can normally be extracted from it. 349 gestures can normally be extracted from it. 375 350 376 If INPUT_PROP_SEMI_MT is not set, the device i 351 If INPUT_PROP_SEMI_MT is not set, the device is assumed to be a true MT 377 device. 352 device. 378 353 379 INPUT_PROP_TOPBUTTONPAD 354 INPUT_PROP_TOPBUTTONPAD 380 ----------------------- 355 ----------------------- 381 356 382 Some laptops, most notably the Lenovo 40 serie 357 Some laptops, most notably the Lenovo 40 series provide a trackstick 383 device but do not have physical buttons associ 358 device but do not have physical buttons associated with the trackstick 384 device. Instead, the top area of the touchpad 359 device. Instead, the top area of the touchpad is marked to show 385 visual/haptic areas for left, middle, right bu 360 visual/haptic areas for left, middle, right buttons intended to be used 386 with the trackstick. 361 with the trackstick. 387 362 388 If INPUT_PROP_TOPBUTTONPAD is set, userspace s 363 If INPUT_PROP_TOPBUTTONPAD is set, userspace should emulate buttons 389 accordingly. This property does not affect ker 364 accordingly. This property does not affect kernel behavior. 390 The kernel does not provide button emulation f 365 The kernel does not provide button emulation for such devices but treats 391 them as any other INPUT_PROP_BUTTONPAD device. 366 them as any other INPUT_PROP_BUTTONPAD device. 392 367 393 INPUT_PROP_ACCELEROMETER 368 INPUT_PROP_ACCELEROMETER 394 ------------------------ 369 ------------------------ 395 370 396 Directional axes on this device (absolute and/ 371 Directional axes on this device (absolute and/or relative x, y, z) represent 397 accelerometer data. Some devices also report g 372 accelerometer data. Some devices also report gyroscope data, which devices 398 can report through the rotational axes (absolu 373 can report through the rotational axes (absolute and/or relative rx, ry, rz). 399 374 400 All other axes retain their meaning. A device 375 All other axes retain their meaning. A device must not mix 401 regular directional axes and accelerometer axe 376 regular directional axes and accelerometer axes on the same event node. 402 377 403 Guidelines 378 Guidelines 404 ========== 379 ========== 405 380 406 The guidelines below ensure proper single-touc 381 The guidelines below ensure proper single-touch and multi-finger functionality. 407 For multi-touch functionality, see the multi-t !! 382 For multi-touch functionality, see the multi-touch-protocol.txt document for 408 more information. 383 more information. 409 384 410 Mice 385 Mice 411 ---- 386 ---- 412 387 413 REL_{X,Y} must be reported when the mouse move 388 REL_{X,Y} must be reported when the mouse moves. BTN_LEFT must be used to report 414 the primary button press. BTN_{MIDDLE,RIGHT,4, 389 the primary button press. BTN_{MIDDLE,RIGHT,4,5,etc.} should be used to report 415 further buttons of the device. REL_WHEEL and R 390 further buttons of the device. REL_WHEEL and REL_HWHEEL should be used to report 416 scroll wheel events where available. 391 scroll wheel events where available. 417 392 418 Touchscreens 393 Touchscreens 419 ------------ 394 ------------ 420 395 421 ABS_{X,Y} must be reported with the location o 396 ABS_{X,Y} must be reported with the location of the touch. BTN_TOUCH must be 422 used to report when a touch is active on the s 397 used to report when a touch is active on the screen. 423 BTN_{MOUSE,LEFT,MIDDLE,RIGHT} must not be repo 398 BTN_{MOUSE,LEFT,MIDDLE,RIGHT} must not be reported as the result of touch 424 contact. BTN_TOOL_<name> events should be repo 399 contact. BTN_TOOL_<name> events should be reported where possible. 425 400 426 For new hardware, INPUT_PROP_DIRECT should be 401 For new hardware, INPUT_PROP_DIRECT should be set. 427 402 428 Trackpads 403 Trackpads 429 --------- 404 --------- 430 405 431 Legacy trackpads that only provide relative po 406 Legacy trackpads that only provide relative position information must report 432 events like mice described above. 407 events like mice described above. 433 408 434 Trackpads that provide absolute touch position 409 Trackpads that provide absolute touch position must report ABS_{X,Y} for the 435 location of the touch. BTN_TOUCH should be use 410 location of the touch. BTN_TOUCH should be used to report when a touch is active 436 on the trackpad. Where multi-finger support is 411 on the trackpad. Where multi-finger support is available, BTN_TOOL_<name> should 437 be used to report the number of touches active 412 be used to report the number of touches active on the trackpad. 438 413 439 For new hardware, INPUT_PROP_POINTER should be 414 For new hardware, INPUT_PROP_POINTER should be set. 440 415 441 Tablets 416 Tablets 442 ------- 417 ------- 443 418 444 BTN_TOOL_<name> events must be reported when a 419 BTN_TOOL_<name> events must be reported when a stylus or other tool is active on 445 the tablet. ABS_{X,Y} must be reported with th 420 the tablet. ABS_{X,Y} must be reported with the location of the tool. BTN_TOUCH 446 should be used to report when the tool is in c 421 should be used to report when the tool is in contact with the tablet. 447 BTN_{STYLUS,STYLUS2} should be used to report 422 BTN_{STYLUS,STYLUS2} should be used to report buttons on the tool itself. Any 448 button may be used for buttons on the tablet e 423 button may be used for buttons on the tablet except BTN_{MOUSE,LEFT}. 449 BTN_{0,1,2,etc} are good generic codes for unl 424 BTN_{0,1,2,etc} are good generic codes for unlabeled buttons. Do not use 450 meaningful buttons, like BTN_FORWARD, unless t 425 meaningful buttons, like BTN_FORWARD, unless the button is labeled for that 451 purpose on the device. 426 purpose on the device. 452 427 453 For new hardware, both INPUT_PROP_DIRECT and I 428 For new hardware, both INPUT_PROP_DIRECT and INPUT_PROP_POINTER should be set.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.