[mirror_ubuntu-hirsute-kernel.git] / Documentation / input / devices / appletouch.rst

.. include:: <isonum.txt>

----------------------------------
Apple Touchpad Driver (appletouch)
----------------------------------

:Copyright: |copy| 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 [#f1]_,
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 [#f2]_), 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:

.. [#f1] http://johannes.sipsolutions.net/PowerBook/touchpad/

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