1.\" Copyright (c) 2014 Hans Petter Selasky <hselasky at freebsd dot org>. 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.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.Dd February 9, 2021 26.Dt WSP 4 27.Os 28.Sh NAME 29.Nm wsp 30.Nd Wellspring touchpad driver 31.Sh SYNOPSIS 32To compile this driver into the kernel, place the following lines into 33your kernel configuration file: 34.Bd -ragged -offset indent 35.Cd "device wsp" 36.Cd "device hid" 37.Cd "device usb" 38.Ed 39.Pp 40Alternatively, to load the driver as a module at boot time, 41place the following line in 42.Xr loader.conf 5 : 43.Bd -literal -offset indent 44wsp_load="YES" 45.Ed 46.Sh DESCRIPTION 47The 48.Nm 49driver provides support for the Apple Internal Trackpad 50device found in many Apple laptops. 51.Pp 52The driver simulates a three-button mouse using multi-finger tap 53detection. 54A single-finger press generates a left button click. 55A two-finger tap maps to the right button; whereas a three-finger tap 56gets treated as a middle button click. 57.Pp 58.Nm 59supports dynamic reconfiguration using 60.Xr sysctl 8 61through nodes under 62.Nm hw.usb.wsp . 63Pointer sensitivity can be controlled using the sysctl tunable 64.Nm hw.usb.wsp.scale_factor . 65Tap to left-click can be controlled using the sysctl tunable 66.Nm hw.usb.wsp.enable_single_tap_clicks , 67set to 0 to disable single tap clicks or 1 to enable them (default). 68Z-Axis sensitivity can be controlled using the sysctl tunable 69.Nm hw.usb.wsp.z_factor . 70Z-Axis inversion can be controlled using the sysctl tunable 71.Nm hw.usb.wsp.z_invert , 72set to 0 to disable (default) or 1 to enable inversion. 73.Sh FILES 74.Nm 75creates a blocking pseudo-device file, 76.Pa /dev/wsp0 , 77which presents the mouse as a 78.Em sysmouse 79or 80.Em mousesystems 81type device--see 82.Xr moused 8 83for an explanation of these mouse 84types. 85.Sh SEE ALSO 86.Xr sysmouse 4 , 87.Xr usb 4 , 88.Xr loader.conf 5 , 89.Xr xorg.conf 5 Pq Pa ports/x11/xorg , 90.Xr moused 8 , 91.Xr sysctl 8 92.Sh AUTHORS 93.An -nosplit 94The 95.Nm 96driver was written by 97.An Huang Wen Hui Aq Mt huanghwh@gmail.com . 98