xref: /freebsd/share/man/man4/hgame.4 (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
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.Dd September 14, 2020
25.Dt HGAME 4
26.Os
27.Sh NAME
28.Nm hgame
29.Nd Generic HID game controller (joystick/gamepad) driver
30.Sh SYNOPSIS
31To compile this driver into the kernel,
32place the following lines in your
33kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "device hgame"
36.Cd "device hid"
37.Cd "device hidbus"
38.Cd "device hidmap"
39.Cd "device evdev"
40.Ed
41.Pp
42Alternatively, to load the driver as a
43module at boot time, place the following line in
44.Xr loader.conf 5 :
45.Bd -literal -offset indent
46hgame_load="YES"
47.Ed
48.Sh DESCRIPTION
49The
50.Nm
51driver provides support for generic game controllers (joysticks/gamepads)
52that attach to the HID transport backend.
53See
54.Xr iichid 4
55or
56.Xr usbhid 4 .
57.Pp
58The
59.Pa /dev/input/event*
60device presents the game controller as a
61.Ar evdev
62type device.
63.Sh SYSCTL VARIABLES
64The following variable is available as both
65.Xr sysctl 8
66variable and
67.Xr loader 8
68tunable:
69.Bl -tag -width indent
70.It Va dev.hgame.X.debug
71Debug output level, where 0 is debugging disabled and larger values increase
72debug message verbosity.
73Default is 0.
74.El
75.Pp
76It's default value is set with
77.Xr loader 8
78tunable:
79.Bl -tag -width indent
80.It Va hw.hid.hgame.debug
81.El
82.Sh FILES
83.Bl -tag -width /dev/input/event* -compact
84.It Pa /dev/input/event*
85input event device node.
86.El
87.Sh SEE ALSO
88.Xr iichid 4 ,
89.Xr usbhid 4
90.Sh HISTORY
91The
92.Nm
93driver first appeared in
94.Fx 13.0 .
95.Sh AUTHORS
96.An -nosplit
97The
98.Nm
99driver was written by
100.An Val Packett Aq Mt val@packett.cool .
101.Pp
102This manual page was written by
103.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
104