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