xref: /freebsd/share/man/man4/xb360gp.4 (revision 0b4531511ead79951918e9e7b58937f6a8b59fd8)
1d97d5c0cSVladimir Kondratyev.\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
2d97d5c0cSVladimir Kondratyev.\"
3d97d5c0cSVladimir Kondratyev.\" Redistribution and use in source and binary forms, with or without
4d97d5c0cSVladimir Kondratyev.\" modification, are permitted provided that the following conditions
5d97d5c0cSVladimir Kondratyev.\" are met:
6d97d5c0cSVladimir Kondratyev.\" 1. Redistributions of source code must retain the above copyright
7d97d5c0cSVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer.
8d97d5c0cSVladimir Kondratyev.\" 2. Redistributions in binary form must reproduce the above copyright
9d97d5c0cSVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer in the
10d97d5c0cSVladimir Kondratyev.\"    documentation and/or other materials provided with the distribution.
11d97d5c0cSVladimir Kondratyev.\"
12d97d5c0cSVladimir Kondratyev.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13d97d5c0cSVladimir Kondratyev.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14d97d5c0cSVladimir Kondratyev.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15d97d5c0cSVladimir Kondratyev.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16d97d5c0cSVladimir Kondratyev.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17d97d5c0cSVladimir Kondratyev.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18d97d5c0cSVladimir Kondratyev.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19d97d5c0cSVladimir Kondratyev.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20d97d5c0cSVladimir Kondratyev.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21d97d5c0cSVladimir Kondratyev.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22d97d5c0cSVladimir Kondratyev.\" SUCH DAMAGE.
23d97d5c0cSVladimir Kondratyev.\"
24d97d5c0cSVladimir Kondratyev.\" $FreeBSD$
25d97d5c0cSVladimir Kondratyev.\"
26d97d5c0cSVladimir Kondratyev.Dd September 16, 2020
27d97d5c0cSVladimir Kondratyev.Dt XB360GP 4
28d97d5c0cSVladimir Kondratyev.Os
29d97d5c0cSVladimir Kondratyev.Sh NAME
30d97d5c0cSVladimir Kondratyev.Nm xb360gp
31d97d5c0cSVladimir Kondratyev.Nd XBox 360 gamepad driver
32d97d5c0cSVladimir Kondratyev.Sh SYNOPSIS
33d97d5c0cSVladimir KondratyevTo compile this driver into the kernel,
34d97d5c0cSVladimir Kondratyevplace the following lines in your
35d97d5c0cSVladimir Kondratyevkernel configuration file:
36d97d5c0cSVladimir Kondratyev.Bd -ragged -offset indent
37d97d5c0cSVladimir Kondratyev.Cd "device xb360gp"
38d97d5c0cSVladimir Kondratyev.Cd "device hgame"
39d97d5c0cSVladimir Kondratyev.Cd "device hid"
40d97d5c0cSVladimir Kondratyev.Cd "device hidbus"
41d97d5c0cSVladimir Kondratyev.Cd "device hidmap"
42d97d5c0cSVladimir Kondratyev.Cd "device evdev"
43d97d5c0cSVladimir Kondratyev.Ed
44d97d5c0cSVladimir Kondratyev.Pp
45d97d5c0cSVladimir KondratyevAlternatively, to load the driver as a
46d97d5c0cSVladimir Kondratyevmodule at boot time, place the following line in
47d97d5c0cSVladimir Kondratyev.Xr loader.conf 5 :
48d97d5c0cSVladimir Kondratyev.Bd -literal -offset indent
49d97d5c0cSVladimir Kondratyevxb360gp_load="YES"
50d97d5c0cSVladimir Kondratyev.Ed
51d97d5c0cSVladimir Kondratyev.Sh DESCRIPTION
52d97d5c0cSVladimir KondratyevThe
53d97d5c0cSVladimir Kondratyev.Nm
54d97d5c0cSVladimir Kondratyevdriver provides support for XBox 360 gamepad driver.
55d97d5c0cSVladimir Kondratyev.Pp
56d97d5c0cSVladimir KondratyevThe
57d97d5c0cSVladimir Kondratyev.Pa /dev/input/event*
58d97d5c0cSVladimir Kondratyevdevice presents the game controller as a
59d97d5c0cSVladimir Kondratyev.Ar evdev
60d97d5c0cSVladimir Kondratyevtype device.
61d97d5c0cSVladimir Kondratyev.Sh SYSCTL VARIABLES
62d97d5c0cSVladimir KondratyevThe following variable is available as both
63d97d5c0cSVladimir Kondratyev.Xr sysctl 8
64d97d5c0cSVladimir Kondratyevvariable and
65d97d5c0cSVladimir Kondratyev.Xr loader 8
66d97d5c0cSVladimir Kondratyevtunable:
67d97d5c0cSVladimir Kondratyev.Bl -tag -width indent
68d97d5c0cSVladimir Kondratyev.It Va dev.xb360gp.X.debug
69d97d5c0cSVladimir KondratyevDebug output level, where 0 is debugging disabled and larger values increase
70d97d5c0cSVladimir Kondratyevdebug message verbosity.
71d97d5c0cSVladimir KondratyevDefault is 0.
72d97d5c0cSVladimir Kondratyev.El
73d97d5c0cSVladimir Kondratyev.Pp
74d97d5c0cSVladimir KondratyevIt's default value is set with
75d97d5c0cSVladimir Kondratyev.Xr loader 8
76d97d5c0cSVladimir Kondratyevtunable:
77d97d5c0cSVladimir Kondratyev.Bl -tag -width indent
78d97d5c0cSVladimir Kondratyev.It Va hw.hid.xb360gp.debug
79d97d5c0cSVladimir Kondratyev.El
80d97d5c0cSVladimir Kondratyev.Sh FILES
81d97d5c0cSVladimir Kondratyev.Bl -tag -width /dev/input/event* -compact
82d97d5c0cSVladimir Kondratyev.It Pa /dev/input/event*
83d97d5c0cSVladimir Kondratyevinput event device node.
84d97d5c0cSVladimir Kondratyev.El
85d97d5c0cSVladimir Kondratyev.Sh HISTORY
86d97d5c0cSVladimir KondratyevThe
87d97d5c0cSVladimir Kondratyev.Nm
88d97d5c0cSVladimir Kondratyevdriver first appeared in
89d97d5c0cSVladimir Kondratyev.Fx 13.0.
90d97d5c0cSVladimir Kondratyev.Sh AUTHORS
91d97d5c0cSVladimir Kondratyev.An -nosplit
92d97d5c0cSVladimir KondratyevThe
93d97d5c0cSVladimir Kondratyev.Nm
94d97d5c0cSVladimir Kondratyevdriver was written by
95*0b453151SVal Packett.An Val Packett Aq Mt val@packett.cool .
96d97d5c0cSVladimir Kondratyev.Pp
97d97d5c0cSVladimir KondratyevThis manual page was written by
98d97d5c0cSVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
99