summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/xhci.4 3.html
blob: 0ed1eb09602317792531ea14328df4907136daf6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<table class="head">
  <tr>
    <td class="head-ltitle">XHCI(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">XHCI(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">xhci</code> &#x2014; <span class="Nd">USB
    eXtensible Host Controller driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">options USB_DEBUG</code>
  <br/>
  <code class="Cd">device xhci</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">xhci</code> driver provides support for the
    USB eXtensible Host Controller Interface, which allows use of USB 1.0, 2.0
    and 3.0 devices on the same USB port.</p>
<p class="Pp">The XHCI controller supports USB connection speeds from 5.0Gbps
    and above when using USB 3.x compliant devices.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">xhci</code> driver supports XHCI compatible
    controllers having PCI class 12 (serial bus), subclass 3 (USB) and
    programming interface 48 (XHCI).</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL
  VARIABLES</a></h1>
<p class="Pp">The following variables are available as both
    <a class="Xr">sysctl(8)</a> variables and <a class="Xr">loader(8)</a>
    tunables:</p>
<dl class="Bl-tag">
  <dt id="hw.usb.xhci.debug"><var class="Va">hw.usb.xhci.debug</var></dt>
  <dd>Set debug output level, where 0 is debugging disabled and larger values
      increase debug message verbosity. The default value is 0.</dd>
  <dt id="hw.usb.xhci.dcepquirk"><var class="Va">hw.usb.xhci.dcepquirk</var></dt>
  <dd>Set to enable quirk for deconfiguration of endpoints. The default value is
      0.</dd>
  <dt id="hw.usb.xhci.ctlquirk"><var class="Va">hw.usb.xhci.ctlquirk</var></dt>
  <dd>Set to submit full USB control request as one job, up to 64kBytes. Else
      the USB control request will be split into multiple smaller requests. The
      default value is 1.</dd>
  <dt id="hw.usb.xhci.streams"><var class="Va">hw.usb.xhci.streams</var></dt>
  <dd>Set to enable USB streams support. The default value is 0.</dd>
  <dt id="hw.usb.xhci.route"><var class="Va">hw.usb.xhci.route</var></dt>
  <dd>Set bitmap for switching EHCI ports to the XHCI controller. The default
      value is 0.</dd>
  <dt id="hw.usb.xhci.polling"><var class="Va">hw.usb.xhci.polling</var></dt>
  <dd>Set to use a timer to poll the interrupt handler. The default value is
    0.</dd>
  <dt id="hw.usb.xhci.dma32"><var class="Va">hw.usb.xhci.dma32</var></dt>
  <dd>Set to only use 32-bit DMA for the XHCI controller. The default value is
      0.</dd>
  <dt id="hw.usb.xhci.ctlstep"><var class="Va">hw.usb.xhci.ctlstep</var></dt>
  <dd>Set to enable control endpoint status state stepping. The default value is
      0.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">ehci(4)</a>, <a class="Xr">ohci(4)</a>,
    <a class="Xr">uhci(4)</a> and <a class="Xr">usb(4)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">xhci</code> device driver first appeared in
    <span class="Ux">FreeBSD 8.2</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">October 21, 2022</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>