Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/ps4dshock.4
- This file was added.
| .\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org> | |||||
| .\" | |||||
| .\" Redistribution and use in source and binary forms, with or without | |||||
| .\" modification, are permitted provided that the following conditions | |||||
| .\" are met: | |||||
| .\" 1. Redistributions of source code must retain the above copyright | |||||
| .\" notice, this list of conditions and the following disclaimer. | |||||
| .\" 2. Redistributions in binary form must reproduce the above copyright | |||||
| .\" notice, this list of conditions and the following disclaimer in the | |||||
| .\" documentation and/or other materials provided with the distribution. | |||||
| .\" | |||||
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||
| .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
| .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||
| .\" SUCH DAMAGE. | |||||
| .\" | |||||
| .\" $FreeBSD$ | |||||
| .\" | |||||
| .Dd September 19, 2020 | |||||
| .Dt PS4DSHOCK 4 | |||||
| .Os | |||||
| .Sh NAME | |||||
| .Nm ps4dshock | |||||
| .Nd Sony PlayStation 4 Dualshock 4 gamepad driver | |||||
| .Sh SYNOPSIS | |||||
| To compile this driver into the kernel, | |||||
| place the following lines in your | |||||
| kernel configuration file: | |||||
| .Bd -ragged -offset indent | |||||
| .Cd "device ps4dshock" | |||||
| .Cd "device hid" | |||||
| .Cd "device hidbus" | |||||
| .Cd "device hidmap" | |||||
| .Cd "device evdev" | |||||
| .Ed | |||||
| .Pp | |||||
| Alternatively, to load the driver as a | |||||
| module at boot time, place the following line in | |||||
| .Xr loader.conf 5 : | |||||
| .Bd -literal -offset indent | |||||
| ps4dshock_load="YES" | |||||
| .Ed | |||||
| .Sh DESCRIPTION | |||||
| The | |||||
| .Nm | |||||
| driver provides support for Sony PlayStation 4 Dualshock 4 gamepad driver. | |||||
| .Pp | |||||
| The | |||||
| .Pa /dev/input/event* | |||||
| device presents the game controller as a | |||||
| .Ar evdev | |||||
| type device. | |||||
| .Sh SYSCTL VARIABLES | |||||
| Next parameters are available as | |||||
| .Xr sysctl 8 | |||||
| variables. | |||||
| Debug parameter is available as | |||||
| .Xr loader 8 | |||||
| tunable as well. | |||||
| .Bl -tag -width indent | |||||
| .It Va dev.p4dshock.*.led_state | |||||
| LED state: 0 - off, 1 - on, 2 - blinking. | |||||
| .It Va dev.p4dshock.*.led_color_r | |||||
| LED color. | |||||
| Red component. | |||||
| .It Va dev.p4dshock.*.led_color_g | |||||
| LED color. | |||||
| Green component. | |||||
| .It Va dev.p4dshock.*.led_color_b | |||||
| LED color. | |||||
| Blue component. | |||||
| .It Va dev.p4dshock.*.led_delay_on | |||||
| LED blink. | |||||
| On delay, msecs. | |||||
| .It Va dev.p4dshock.*.led_delay_off | |||||
| LED blink. | |||||
| Off delay, msecs. | |||||
| .It Va hw.hid.ps4dshock.debug | |||||
| Debug output level, where 0 is debugging disabled and larger values increase | |||||
| debug message verbosity. | |||||
| Default is 0. | |||||
| .El | |||||
| .Sh FILES | |||||
| .Bl -tag -width /dev/input/event* -compact | |||||
| .It Pa /dev/input/event* | |||||
| input event device node. | |||||
| .El | |||||
| .Sh BUGS | |||||
| The | |||||
| .Nm | |||||
| does not support force-feedback events. | |||||
| .Sh HISTORY | |||||
| The | |||||
| .Nm | |||||
| driver first appeared in | |||||
| .Fx 13.0. | |||||
| .Sh AUTHORS | |||||
| .An -nosplit | |||||
| The | |||||
| .Nm | |||||
| driver was written by | |||||
| .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . | |||||