xref: /freebsd/share/man/man4/xhci.4 (revision 389e4940069316fe667ffa263fa7d6390d0a960f)
1.\"
2.\" Copyright (c) 2011 Hans Petter Selasky. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd April 24, 2018
28.Dt XHCI 4
29.Os
30.Sh NAME
31.Nm xhci
32.Nd USB eXtensible Host Controller driver
33.Sh SYNOPSIS
34.Cd "device xhci"
35.Sh DESCRIPTION
36The
37.Nm
38driver provides support for the
39.Tn USB
40eXtensible Host Controller Interface,
41which allows use of
42.Tn USB
431.0, 2.0 and 3.0 devices on the same
44.Tn USB
45port.
46.Pp
47The
48.Tn XHCI
49controller supports
50.Tn USB
51connection speeds up to 5.0Gbps when using a USB 3.0 compliant device.
52.Sh HARDWARE
53The
54.Nm
55driver supports
56.Tn XHCI
57compatible controllers having PCI class 12 (serial bus),
58subclass 3 (USB) and programming interface 48 (XHCI).
59.Sh SYSCTL VARIABLES
60The following variables are available as both
61.Xr sysctl 8
62variables and
63.Xr loader 8
64tunables:
65.Bl -tag -width indent
66.It Va hw.usb.xhci.debug
67Debug output level, where 0 is debugging disabled and larger values increase
68debug message verbosity.
69Default is 0.
70.Sh SEE ALSO
71.Xr ehci 4 ,
72.Xr ohci 4 ,
73.Xr uhci 4 ,
74.Xr usb 4
75.Sh HISTORY
76The
77.Nm
78device driver first appeared in
79.Fx 8.2 .
80