[mirror_ubuntu-artful-kernel.git] / Documentation / input / appletouch.txt

Apple Touchpad Driver (appletouch)
----------------------------------
	Copyright (C) 2005 Stelian Pop <stelian@popies.net>

appletouch is a Linux kernel driver for the USB touchpad found on post
February 2005 and October 2005 Apple Aluminium Powerbooks.

This driver is derived from Johannes Berg's appletrackpad driver[1], but it has
been improved in some areas:
	* appletouch is a full kernel driver, no userspace program is necessary
	* appletouch can be interfaced with the synaptics X11 driver, in order
	  to have touchpad acceleration, scrolling, etc.

Credits go to Johannes Berg for reverse-engineering the touchpad protocol,
Frank Arnold for further improvements, and Alex Harper for some additional
information about the inner workings of the touchpad sensors. Michael
Hanselmann added support for the October 2005 models.

Usage:
------

In order to use the touchpad in the basic mode, compile the driver and load
the module. A new input device will be detected and you will be able to read
the mouse data from /dev/input/mice (using gpm, or X11).

In X11, you can configure the touchpad to use the synaptics X11 driver, which
will give additional functionalities, like acceleration, scrolling, 2 finger
tap for middle button mouse emulation, 3 finger tap for right button mouse
emulation, etc. In order to do this, make sure you're using a recent version of
the synaptics driver (tested with 0.14.2, available from [2]), and configure a
new input device in your X11 configuration file (take a look below for an
example). For additional configuration, see the synaptics driver documentation.

	Section "InputDevice"
        	Identifier      "Synaptics Touchpad"
	        Driver          "synaptics"
		Option          "SendCoreEvents"        "true"
		Option          "Device"                "/dev/input/mice"
		Option          "Protocol"              "auto-dev"
		Option		"LeftEdge"		"0"
		Option		"RightEdge"		"850"
		Option		"TopEdge"		"0"
		Option		"BottomEdge"		"645"
		Option		"MinSpeed"		"0.4"
		Option		"MaxSpeed"		"1"
		Option		"AccelFactor"		"0.02"
		Option		"FingerLow"		"0"
		Option		"FingerHigh"		"30"
		Option		"MaxTapMove"		"20"
		Option		"MaxTapTime"		"100"
		Option		"HorizScrollDelta"	"0"
		Option		"VertScrollDelta"	"30"
		Option		"SHMConfig"		"on"
	EndSection

	Section "ServerLayout"
		...
		InputDevice	"Mouse"
		InputDevice	"Synaptics Touchpad"
	...
	EndSection

Fuzz problems:
--------------

The touchpad sensors are very sensitive to heat, and will generate a lot of
noise when the temperature changes. This is especially true when you power-on
the laptop for the first time.

The appletouch driver tries to handle this noise and auto adapt itself, but it
is not perfect. If finger movements are not recognized anymore, try reloading
the driver.

You can activate debugging using the 'debug' module parameter. A value of 0
deactivates any debugging, 1 activates tracing of invalid samples, 2 activates
full tracing (each sample is being traced):
	modprobe appletouch debug=1
		or
	echo "1" > /sys/module/appletouch/parameters/debug

Links:
------

[1]: http://johannes.sipsolutions.net/PowerBook/touchpad/
[2]: http://web.archive.org/web/*/http://web.telia.com/~u89404340/touchpad/index.html
Commit	Line	Data
f7214ff4 SP	1	Apple Touchpad Driver (appletouch)
	2	----------------------------------
	3	Copyright (C) 2005 Stelian Pop <stelian@popies.net>
	4
	5	appletouch is a Linux kernel driver for the USB touchpad found on post
e1e02c9f	6	February 2005 and October 2005 Apple Aluminium Powerbooks.
f7214ff4 SP	7
	8	This driver is derived from Johannes Berg's appletrackpad driver[1], but it has
	9	been improved in some areas:
	10	* appletouch is a full kernel driver, no userspace program is necessary
	11	* appletouch can be interfaced with the synaptics X11 driver, in order
	12	to have touchpad acceleration, scrolling, etc.
	13
	14	Credits go to Johannes Berg for reverse-engineering the touchpad protocol,
	15	Frank Arnold for further improvements, and Alex Harper for some additional
e1e02c9f MH	16	information about the inner workings of the touchpad sensors. Michael
e1e02c9f MH	17	Hanselmann added support for the October 2005 models.
f7214ff4 SP	18
	19	Usage:
	20	------
	21
	22	In order to use the touchpad in the basic mode, compile the driver and load
	23	the module. A new input device will be detected and you will be able to read
	24	the mouse data from /dev/input/mice (using gpm, or X11).
	25
	26	In X11, you can configure the touchpad to use the synaptics X11 driver, which
	27	will give additional functionalities, like acceleration, scrolling, 2 finger
	28	tap for middle button mouse emulation, 3 finger tap for right button mouse
	29	emulation, etc. In order to do this, make sure you're using a recent version of
	30	the synaptics driver (tested with 0.14.2, available from [2]), and configure a
	31	new input device in your X11 configuration file (take a look below for an
	32	example). For additional configuration, see the synaptics driver documentation.
	33
	34	Section "InputDevice"
	35	Identifier "Synaptics Touchpad"
	36	Driver "synaptics"
	37	Option "SendCoreEvents" "true"
	38	Option "Device" "/dev/input/mice"
	39	Option "Protocol" "auto-dev"
	40	Option "LeftEdge" "0"
	41	Option "RightEdge" "850"
	42	Option "TopEdge" "0"
	43	Option "BottomEdge" "645"
	44	Option "MinSpeed" "0.4"
	45	Option "MaxSpeed" "1"
	46	Option "AccelFactor" "0.02"
	47	Option "FingerLow" "0"
	48	Option "FingerHigh" "30"
	49	Option "MaxTapMove" "20"
	50	Option "MaxTapTime" "100"
	51	Option "HorizScrollDelta" "0"
	52	Option "VertScrollDelta" "30"
	53	Option "SHMConfig" "on"
	54	EndSection
	55
	56	Section "ServerLayout"
	57	...
	58	InputDevice "Mouse"
	59	InputDevice "Synaptics Touchpad"
	60	...
	61	EndSection
	62
	63	Fuzz problems:
	64	--------------
	65
	66	The touchpad sensors are very sensitive to heat, and will generate a lot of
	67	noise when the temperature changes. This is especially true when you power-on
	68	the laptop for the first time.
	69
	70	The appletouch driver tries to handle this noise and auto adapt itself, but it
	71	is not perfect. If finger movements are not recognized anymore, try reloading
	72	the driver.
	73
	74	You can activate debugging using the 'debug' module parameter. A value of 0
	75	deactivates any debugging, 1 activates tracing of invalid samples, 2 activates
	76	full tracing (each sample is being traced):
	77	modprobe appletouch debug=1
	78	or
	79	echo "1" > /sys/module/appletouch/parameters/debug
	80
	81	Links:
82	------
83
84	[1]: http://johannes.sipsolutions.net/PowerBook/touchpad/
0ea6e611	85	[2]: http://web.archive.org/web/*/http://web.telia.com/~u89404340/touchpad/index.html