Re: [PATCH 2/4] Documentation: Add evdev type and code definitions

[Dmitry Torokhov <dmitry.torokhov@gmail.com>]

On Thu, Dec 16, 2010 at 08:56:58AM -0600, Chris Bagwell wrote:
> On Wed, Dec 15, 2010 at 5:59 PM, Peter Hutterer
> <peter.hutterer@who-t.net> wrote:
> > On Tue, Dec 14, 2010 at 01:21:10PM -0800, Chase Douglas wrote:
> >> This commit adds the file Documentation/input/evdev-codes.txt.
> >>
> >> Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
> >> ---
> >>  Documentation/input/evdev-codes.txt |  160 +++++++++++++++++++++++++++++++++++
> >>  1 files changed, 160 insertions(+), 0 deletions(-)
> >>  create mode 100644 Documentation/input/evdev-codes.txt
> >>
> >> diff --git a/Documentation/input/evdev-codes.txt b/Documentation/input/evdev-codes.txt
> >> new file mode 100644
> >> index 0000000..69c810f
> >> --- /dev/null
> >> +++ b/Documentation/input/evdev-codes.txt
> >> @@ -0,0 +1,160 @@
> >> +The evdev protocol uses a map of types and codes to express input device values
> >> +to userspace. This document describes the types and codes and how and when they
> >> +may be used.
> >> +
> >> +Types:
> >> +==========
> >> +Types are groupings of codes under a logical input construct. Each type has a
> >> +set of applicable codes to be used in generating events. See the Codes section
> >> +for details on valid codes for each type.
> >> +
> >> +* EV_SYN:
> >> +  - Used as markers to separate events. Events may be separated in time or in
> >> +    space, such as with the multitouch protocol.
> >> +* EV_KEY:
> >> +  - Used to describe keyboard and other key-like input events.
> >> +* EV_REL:
> >> +  - Used to describe relative input events, e.g. moving the mouse 5 units to the
> >> +    left.
> >> +* EV_ABS:
> >> +  - Used to describe absolute input events, e.g. describing the coordinates of a
> >> +    touch on a touchscreen.
> >> +* EV_MSC:
> >> +  - Used to describe miscellaneous input events that do not fit into other
> >> +    types.
> >> +* EV_SW:
> >> +  - Used to describe binary state input switches.
> >> +* EV_LED:
> >> +  - Used to turn LEDs on devices on and off.
> >> +* EV_SND:
> >> +  - Used to output sound to devices.
> >> +* EV_REP:
> >> +  - Used for autorepeating devices.
> >> +* EV_FF:
> >> +  - Used to send force feedback commands to an input device.
> >> +* EV_PWR:
> >> +  - A special type for power button and switch input.
> >> +* EV_FF_STATUS:
> >> +  - Used to receive force feedback device status.
> >> +
> >> +Codes:
> >> +==========
> >> +Codes define the precise type of event.
> >> +
> >> +EV_SYN Codes:
> >> +----------
> >> +EV_SYN event values are undefined. Their usage is
> >> +defined only by when they are sent in the evdev event stream.
> >> +
> >> +* SYN_REPORT:
> >> +  - Used to synchronize and separate events in time. For example, motion of a
> >> +    mouse may set the REL_X and REL_Y values for one motion, then emit a
> >> +    SYN_REPORT. The next motion will emit more REL_X and REL_Y values and send
> >> +    another SYN_REPORT.
> >> +* SYN_CONFIG:
> >> +  - TBD
> >> +* SYN_MT_REPORT:
> >> +  - Used to synchronize and separate touch events. See the
> >> +    multi-touch-protocol.txt document for more information.
> >> +
> >> +EV_KEY:
> >> +----------
> >> +EV_KEY events take the form KEY_<name> or BTN_<name>. For example, KEY_A is used
> >> +to represent the 'A' key on a keyboard. When a key is depressed, an event with
> >> +the key's code is emitted with value 1. When the key is depressed, an event is
> >> +emitted with value 0. In general, KEY_<name> is used for keyboard keys, and
> >> +BTN_<name> is used for other types of momentary switch events.
> >
> > repeat keys have value 2, might want to add this here.
> >
> >> +
> >> +A few EV_KEY codes have special meanings:
> >> +
> >> +* BTN_TOOL_<name>, BTN_TOUCH:
> >> +  - These codes are used in conjunction with input trackpads, tablets, and
> >> +    touchscreens. These devices may be used with fingers, pens, or other tools.
> >> +    When an event occurs and a tool is used, the corresponding BTN_TOOL_<name>
> >> +    code should be set to a value of 1. When the tool is no longer interacting
> >> +    with the input device, the BTN_TOOL_<name> code should be reset to 0. All
> >> +    trackpads, tablets, and touchscreens should use at least one BTN_TOOL_<name>
> >> +    code when events are generated. For non-tablet devices, the tool is usually
> >> +    BTN_TOUCH.
> >
> > BTN_TOUCH is used as proximity delimiter. e.g. wacom sends BTN_TOOL_PEN when
> > the pen comes into proximity and (in addition) BTN_TOUCH when the pen
> > actually touches the tablet. synaptics does the same IIRC except that it
> > doesn't support hovering, so BTN_TOOL_FINGER and BTN_TOUCH are always
> > set/unset in the same EV_SYN frame.
> 
> This area is where most special cases are so somehow I think it
> deserves extra attention.  Either in paragraphs or in sample events.
> 
> There is the special historical case of touchscreen were
> BTN_TOOL_FINGER is not sent; which mostly works because most
> touchscreens do not support proximity/hover concepts.  It can
> recommend not to use this approach and to use new ioctl() to convey
> touchscreen vs. touchpad information.
> 
> Just an FYI: Synaptics is only sending BTN_TOUCH when pressure is >30
> for what ever historical reason (and duplicating logic in
> xf86-input-synaptics) so it usually won't be in same sync window as
> BTN_TOOL_FINGER.

mousedev. Synaptics devices used to be (still are?) very sensitive and
if you start sending BTN_TOUCH whenever you detect contact the touchpad
is not useable without synaptics X driver.

>  I think its only touchpad left doing this so I think
> we may want to recommend best practice is to have BTN_TOOL_FINGER/*TAP
> and BTN_TOUCH track each other when hover is not supported.

Alps does this as well. Any device that starts sending contacts while
hovering should consider legacy drivers when choosing when to emit
BTN_TOUCH.

-- 
Dmitry
--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html