xref: /freebsd/share/man/man4/ietp.4 (revision d9a42747950146bf03cda7f6e25d219253f8a57a)
1.\" Copyright (c) 2022 Vladimir Kondratyev <wulf@FreeBSD.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.\" $FreeBSD$
26.\"
27.Dd February 27, 2022
28.Dt IETP 4
29.Os
30.Sh NAME
31.Nm ietp
32.Nd Elantech I2C touchpad device driver
33.Sh SYNOPSIS
34To compile this driver into the kernel, place the following lines into
35your kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device ietp"
38.Cd "device hidbus"
39.Cd "device hid"
40.Cd "device iichid"
41.Cd "device iicbus"
42.Cd "device evdev"
43
44.Ed
45.Pp
46Alternatively, to load the driver as a
47module at boot time, place the following line in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50ietp_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for the Elantech I2C touchpad multi-touch devices
56found in many laptops.
57.Pp
58To get multi-touch device working in
59.Xr X 7 Pq Pa ports/x11/xorg-docs ,
60install
61.Pa ports/x11-drivers/xf86-input-libinput .
62.Sh FILES
63.Nm
64creates a pseudo-device file,
65.Pa /dev/input/eventX
66which presents the multi-touch device as an input event device.
67.Sh SEE ALSO
68.Xr hid 4 ,
69.Xr loader.conf 5 ,
70.Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
71.Xr libinput 4 Pq Pa ports/x11-drivers/xf86-input-libinput .
72.Sh AUTHORS
73.An -nosplit
74The
75.Nm
76driver was written by
77.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
78.Sh BUGS
79.Nm
80cannot act like
81.Xr sysmouse 4
82