share/man/man4/ps4dshock.4

   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
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel 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
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 ps4dshock_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for Sony PlayStation 4 Dualshock 4 gamepad driver.
  54 .Pp
  55 The
  56 .Pa /dev/input/event*
  57 device presents the game controller as a
  58 .Ar evdev
  59 type device.
  60 .Sh SYSCTL VARIABLES
  61 Next parameters are available as
  62 .Xr sysctl 8
  63 variables.
  64 Debug parameter is available as
  65 .Xr loader 8
  66 tunable as well.
  67 .Bl -tag -width indent
  68 .It Va dev.p4dshock.*.led_state
  69 LED state: 0 - off, 1 - on, 2 - blinking.
  70 .It Va dev.p4dshock.*.led_color_r
  71 LED color.
  72 Red component.
  73 .It Va dev.p4dshock.*.led_color_g
  74 LED color.
  75 Green component.
  76 .It Va dev.p4dshock.*.led_color_b
  77 LED color.
  78 Blue component.
  79 .It Va dev.p4dshock.*.led_delay_on
  80 LED blink.
  81 On delay, msecs.
  82 .It Va dev.p4dshock.*.led_delay_off
  83 LED blink.
  84 Off delay, msecs.
  85 .It Va hw.hid.ps4dshock.debug
  86 Debug output level, where 0 is debugging disabled and larger values increase
  87 debug message verbosity.
  88 Default is 0.
  89 .El
  90 .Sh FILES
  91 .Bl -tag -width /dev/input/event* -compact
  92 .It Pa /dev/input/event*
  93 input event device node.
  94 .El
  95 .Sh BUGS
  96 The
  97 .Nm
  98 does not support force-feedback events.
  99 .Sh HISTORY
 100 The
 101 .Nm
 102 driver first appeared in
 103 .Fx 13.0.
 104 .Sh AUTHORS
 105 .An -nosplit
 106 The
 107 .Nm
 108 driver was written by
 109 .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .