xref: /freebsd/share/man/man4/xhci.4 (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1.\"
2.\" Copyright (c) 2011-2022 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.Dd October 21, 2022
26.Dt XHCI 4
27.Os
28.Sh NAME
29.Nm xhci
30.Nd USB eXtensible Host Controller driver
31.Sh SYNOPSIS
32.Cd "options USB_DEBUG"
33.Cd "device xhci"
34.Sh DESCRIPTION
35The
36.Nm
37driver provides support for the
38.Tn USB
39eXtensible Host Controller Interface,
40which allows use of
41.Tn USB
421.0, 2.0 and 3.0 devices on the same
43.Tn USB
44port.
45.Pp
46The
47.Tn XHCI
48controller supports
49.Tn USB
50connection speeds from 5.0Gbps and above when using USB 3.x
51compliant devices.
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
67Set debug output level, where 0 is debugging disabled and larger
68values increase debug message verbosity.
69The default value is 0.
70.It Va hw.usb.xhci.dcepquirk
71Set to enable quirk for deconfiguration of endpoints.
72The default value is 0.
73.It Va hw.usb.xhci.ctlquirk
74Set to submit full USB control request as one job, up to 64kBytes.
75Else the USB control request will be split into multiple smaller
76requests.
77The default value is 1.
78.It Va hw.usb.xhci.streams
79Set to enable USB streams support.
80The default value is 0.
81.It Va hw.usb.xhci.route
82Set bitmap for switching EHCI ports to the XHCI controller.
83The default value is 0.
84.It Va hw.usb.xhci.polling
85Set to use a timer to poll the interrupt handler.
86The default value is 0.
87.It Va hw.usb.xhci.dma32
88Set to only use 32-bit DMA for the XHCI controller.
89The default value is 0.
90.It Va hw.usb.xhci.ctlstep
91Set to enable control endpoint status state stepping.
92The default value is 0.
93.El
94.Sh SEE ALSO
95.Xr ehci 4 ,
96.Xr ohci 4 ,
97.Xr uhci 4 and
98.Xr usb 4
99.Sh HISTORY
100The
101.Nm
102device driver first appeared in
103.Fx 8.2 .
104