xref: /freebsd/share/man/man4/xb360gp.4 (revision f61e92ca5a23450bc28169bbdd71d7674df98c19)
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 16, 2020
27.Dt XB360GP 4
28.Os
29.Sh NAME
30.Nm xb360gp
31.Nd XBox 360 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 xb360gp"
38.Cd "device hgame"
39.Cd "device hid"
40.Cd "device hidbus"
41.Cd "device hidmap"
42.Cd "device evdev"
43.Ed
44.Pp
45Alternatively, to load the driver as a
46module at boot time, place the following line in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49xb360gp_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54driver provides support for XBox 360 gamepad driver.
55.Pp
56The
57.Pa /dev/input/event*
58device presents the game controller as a
59.Ar evdev
60type device.
61.Sh SYSCTL VARIABLES
62The following variable is available as both
63.Xr sysctl 8
64variable and
65.Xr loader 8
66tunable:
67.Bl -tag -width indent
68.It Va dev.xb360gp.X.debug
69Debug output level, where 0 is debugging disabled and larger values increase
70debug message verbosity.
71Default is 0.
72.El
73.Pp
74It's default value is set with
75.Xr loader 8
76tunable:
77.Bl -tag -width indent
78.It Va hw.hid.xb360gp.debug
79.El
80.Sh FILES
81.Bl -tag -width /dev/input/event* -compact
82.It Pa /dev/input/event*
83input event device node.
84.El
85.Sh HISTORY
86The
87.Nm
88driver first appeared in
89.Fx 13.0.
90.Sh AUTHORS
91.An -nosplit
92The
93.Nm
94driver was written by
95.An Greg V Aq Mt greg@unrelenting.technology .
96.Pp
97This manual page was written by
98.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
99