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