share/man/man4/atp.4

   1 .\" Copyright (c) 2014 Rohit Grover <rgrover1 at gmail dot com>.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the author nor the names of any co-contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"   without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd February 24, 2014
  31 .Dt ATP 4
  32 .Os
  33 .Sh NAME
  34 .Nm atp
  35 .Nd Apple touchpad driver
  36 .Sh SYNOPSIS
  37 To compile this driver into the kernel, place the following lines into
  38 your kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device atp"
  41 .Cd "device usb"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 atp_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides support for the Apple Internal Trackpad device found in many
  53 Apple laptops. Older (Fountain/Geyser) and the newer (Wellspring) trackpad
  54 families are all supported through a unified driver.
  55 .Pp
  56 The driver simulates a three\-button mouse using multi\-finger tap detection.
  57 Single finger tap generates a left\-button click; two\-finger tap maps to the
  58 middle button; whereas a three\-finger tap gets treated as a right button
  59 click.
  60 .Pp
  61 There is support for 2\-finger horizontal scrolling, which translates to
  62 page\-back/forward events; vertical multi\-finger scrolling emulates the mouse
  63 wheel.
  64 .Pp
  65 A double\-tap followed by a drag is treated as a selection gesture; a
  66 virtual left\-button click is assumed for the lifespan of the drag.
  67 .Pp
  68 .Nm
  69 supports dynamic reconfiguration using
  70 .Xr sysctl 8 ;
  71 through nodes under
  72 .Nm hw.usb.atp .
  73 Pointer sensitivity can be controlled using the sysctl tunable
  74 .Nm hw.usb.atp.scale_factor .
  75 Smaller values of
  76 .Fa scale_factor
  77 result in faster movement.
  78 .
  79 A simple high-pass filter is used to reduce contributions
  80 from small movements; the threshold for this filter may be controlled by
  81 .Nm hw.usb.atp.small_movement .
  82 .
  83 The maximum tolerable duration of a touch gesture is controlled by
  84 .Nm hw.usb.atp.touch_timeout
  85 (in microseconds); beyond this period, touches are considered to be slides.
  86 (This conversion also happens when a finger stroke accumulates at least
  87 .Nm hw.usb.atp.slide_min_movement
  88 movement (in mickeys).
  89 .
  90 The maximum time (in microseconds) to allow an association between a double-
  91 tap and drag gesture may be controlled by
  92 .Nm hw.usb.atp.double_tap_threshold .
  93 .
  94 Should one want to disable tap detection and rely only upon physical button
  95 presses, set the following sysctl to a value of 2
  96 .Nm hw.usb.atp.tap_minimum .
  97 .
  98 .Sh HARDWARE
  99 The
 100 .Nm
 101 driver provides support for the following Product IDs:
 102 .Pp
 103 .Bl -bullet -compact
 104 .It
 105 PowerBooks, iBooks (IDs: 0x020e, 0x020f, 0x0210, 0x0214, 0x0215, 0x0216)
 106 .It
 107 Core Duo MacBook & MacBook Pro (IDs: 0x0217, 0x0218, 0x0219)
 108 .It
 109 Core2 Duo MacBook & MacBook Pro (IDs: 0x021a, 0x021b, 0x021c)
 110 .It
 111 Core2 Duo MacBook3,1 (IDs: 0x0229, 0x022a, 0x022b)
 112 .It
 113 12 inch PowerBook and iBook (IDs: 0x030a, 0x030b)
 114 .It
 115 15 inch PowerBook (IDs: 0x020e, 0x020f, 0x0215)
 116 .It
 117 17 inch PowerBook (ID: 0x020d)
 118 .It
 119 Almost all recent Macbook-Pros and Airs (IDs: 0x0223, 0x0223, 0x0224, 0x0224,
 120 0x0225, 0x0225, 0x0230, 0x0230, 0x0231, 0x0231, 0x0232, 0x0232, 0x0236,
 121 0x0236, 0x0237, 0x0237, 0x0238, 0x0238, 0x023f, 0x023f, 0x0240, 0x0241,
 122 0x0242, 0x0243, 0x0244, 0x0245, 0x0246, 0x0247, 0x0249, 0x024a, 0x024b,
 123 0x024c, 0x024d, 0x024e, 0x0252, 0x0252, 0x0253, 0x0253, 0x0254, 0x0254,
 124 0x0259, 0x025a, 0x025b, 0x0262, 0x0262, 0x0263, 0x0264, 0x0290, 0x0291,
 125 0x0292)
 126 .El
 127 .Pp
 128 To discover the product\-id of a touchpad, search for 'Trackpad' in the
 129 output of
 130 .Xr lshal 1
 131 and look up the property
 132 .Nm usb_device.product_id .
 133 .Sh FILES
 134 .Nm
 135 creates a blocking pseudo\-device file,
 136 .Pa /dev/atp0 ,
 137 which presents the mouse as a
 138 .Ar sysmouse
 139 or
 140 .Ar mousesystems
 141 type device\-\-see
 142 .Xr moused 8
 143 for an explanation of these mouse
 144 types.
 145 .Sh SEE ALSO
 146 .Xr sysmouse 4 ,
 147 .Xr usb 4 ,
 148 .Xr loader.conf 5 ,
 149 .Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
 150 .Xr moused 8 ,
 151 .Xr sysctl 8
 152 .Sh AUTHORS
 153 .An -nosplit
 154 The
 155 .Nm
 156 driver was written by
 157 .An Rohit Grover Aq rgrover1@gmail.com .