xref: /freebsd/share/man/man4/bcm5974.4 (revision 8aac90f18aef7c9eea906c3ff9a001ca7b94f375)
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.Dd February 27, 2022
26.Dt BCM5974 4
27.Os
28.Sh NAME
29.Nm bcm5974
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 bcm5974"
36.Cd "device hidbus"
37.Cd "device hid"
38.Cd "device usbhid"
39.Cd "device usb"
40.Cd "device evdev"
41
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48bcm5974_load="YES"
49.Ed
50.Sh DESCRIPTION
51The
52.Nm
53driver provides support for the Wellspring touchpads found in many Apple
54laptops.
55.Pp
56To get multi-touch device working in
57.Xr X 7 Pq Pa ports/x11/xorg-docs ,
58install
59.Pa ports/x11-drivers/xf86-input-libinput .
60.Sh FILES
61.Nm
62creates a pseudo-device file,
63.Pa /dev/input/eventX
64which presents the multi-touch device as an input event device.
65.Sh SEE ALSO
66.Xr hid 4 ,
67.Xr loader.conf 5 ,
68.Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
69.Xr libinput 4 Pq Pa ports/x11-drivers/xf86-input-libinput .
70.Sh AUTHORS
71.An -nosplit
72The
73.Nm
74driver was written by
75.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
76It is based on
77.Xr wsp 4
78driver written by
79.An Huang Wen Hui Aq Mt huanghwh@gmail.com .
80.Sh BUGS
81.Nm
82cannot act like
83.Xr sysmouse 4
84