xref: /freebsd/share/man/man4/ps4dshock.4 (revision 410556f1f10fd35b350102725fd8504c3cb0afc8)
1.\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.\" $FreeBSD$
25.\"
26.Dd September 19, 2020
27.Dt PS4DSHOCK 4
28.Os
29.Sh NAME
30.Nm ps4dshock
31.Nd Sony PlayStation 4 Dualshock 4 gamepad driver
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device ps4dshock"
38.Cd "device hid"
39.Cd "device hidbus"
40.Cd "device hidmap"
41.Cd "device evdev"
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
48ps4dshock_load="YES"
49.Ed
50.Sh DESCRIPTION
51The
52.Nm
53driver provides support for Sony PlayStation 4 Dualshock 4 gamepad driver.
54.Pp
55The
56.Pa /dev/input/event*
57device presents the game controller as a
58.Ar evdev
59type device.
60.Sh SYSCTL VARIABLES
61Next parameters are available as
62.Xr sysctl 8
63variables.
64Debug parameter is available as
65.Xr loader 8
66tunable as well.
67.Bl -tag -width indent
68.It Va dev.p4dshock.*.led_state
69LED state: 0 - off, 1 - on, 2 - blinking.
70.It Va dev.p4dshock.*.led_color_r
71LED color.
72Red component.
73.It Va dev.p4dshock.*.led_color_g
74LED color.
75Green component.
76.It Va dev.p4dshock.*.led_color_b
77LED color.
78Blue component.
79.It Va dev.p4dshock.*.led_delay_on
80LED blink.
81On delay, msecs.
82.It Va dev.p4dshock.*.led_delay_off
83LED blink.
84Off delay, msecs.
85.It Va hw.hid.ps4dshock.debug
86Debug output level, where 0 is debugging disabled and larger values increase
87debug message verbosity.
88Default is 0.
89.El
90.Sh FILES
91.Bl -tag -width /dev/input/event* -compact
92.It Pa /dev/input/event*
93input event device node.
94.El
95.Sh BUGS
96The
97.Nm
98does not support force-feedback events.
99.Sh HISTORY
100The
101.Nm
102driver first appeared in
103.Fx 13.0.
104.Sh AUTHORS
105.An -nosplit
106The
107.Nm
108driver was written by
109.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
110