xref: /freebsd/share/man/man4/uep.4 (revision 397e83df75e0fcd0d3fcb95ae4d794cb7600fc89)
1.\" Copyright (c) 2010 Gleb Smirnoff <glebius@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.Dd August 5, 2018
26.Dt UEP 4
27.Os
28.Sh NAME
29.Nm uep
30.Nd eGalax touchscreen 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 uep"
36.Cd "device usb"
37.Ed
38.Pp
39Alternatively, to load the driver as a
40module at boot time, place the following line in
41.Xr loader.conf 5 :
42.Bd -literal -offset indent
43uep_load="YES"
44.Ed
45.Pp
46To compile this driver with evdev support enabled, place the
47following lines into the kernel configuration file:
48.Bd -ragged -offset indent
49.Cd "options EVDEV_SUPPORT"
50.Cd "device evdev"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for the eGalax onscreen touch panels.
56.Pp
57The driver is a stub.
58It just probes and attaches to USB device, creates a device entry
59and feeds reassembled packets from the hardware to it.
60Depending on compile-time kernel options it supports either native
61or evdev operation modes.
62.Pp
63To get the mouse working in
64.Xr X 7 Pq Pa ports/x11/xorg-docs
65in native mode, install
66.Pa ports/x11-drivers/xf86-input-egalax .
67.Pp
68To get the mouse working in
69.Xr X 7 Pq Pa ports/x11/xorg-docs
70in evdev mode, install
71.Pa ports/x11-drivers/xf86-input-evdev .
72.Sh FILES
73.Nm
74creates a blocking pseudo-device file,
75.Pa /dev/uep0
76in native mode or
77.Pa /dev/input/eventN
78in evdev mode.
79.Sh SEE ALSO
80.Xr usb 4 ,
81.Xr loader.conf 5 ,
82.Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
83.Xr egalax 4 Pq Pa ports/x11-drivers/xf86-input-egalax ,
84.Xr evdev 4 Pq Pa ports/x11-drivers/xf86-input-evdev .
85.Sh AUTHORS
86.An -nosplit
87The
88.Nm
89driver was written by
90.An Gleb Smirnoff Aq Mt glebius@FreeBSD.org .
91.Sh BUGS
92.Nm
93cannot act like
94.Xr sysmouse 4 ,
95as
96.Xr sysmouse 4
97does not support absolute motion events.
98