usr/src/man/man7d/xhci.7d

   1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright 2016 Joyent, Inc.
  13 .\"
  14 .Dd October 17, 2016
  15 .Dt XHCI 7D
  16 .Os
  17 .Sh NAME
  18 .Nm xhci
  19 .Nd Extensible Host Controller Interface Driver
  20 .Sh SYNOPSIS
  21 .Sy usb@unit-address
  22 .Sh DESCRIPTION
  23 The
  24 .Nm
  25 driver supports PCI devices that implement versions 1.0 and 1.1 of the
  26 Extensible Host Controller Inteface Specification. These devices provide
  27 support for USB 3.0, USB 2.x, and USB 1.x devices and is integrated into
  28 the broader illumos USB Architecture (USBA).
  29 .Pp
  30 The
  31 .Nm
  32 driver supports all four USB transfer types:
  33 .Sy bulk transfers ,
  34 .Sy control transfers ,
  35 .Sy interrupt transfers ,
  36 and
  37 .Sy isochronous transfers .
  38 .Pp
  39 Administrators do not interact with the
  40 .Nm
  41 driver directly. USB devices are managed with
  42 .Xr cfgadm 1M .
  43 See
  44 .Xr cfgadm_usb 1M
  45 for more information on how to specifically manage USB devices and how
  46 they are laid out in the system.
  47 .Xr cfgadm 1M
  48 is only used to manage devices at a USB level. For example, a USB NIC
  49 would still be managed with
  50 .Xr dladm 1M
  51 at a networking level.
  52 .Pp
  53 On some x86 systems USB ports may be routed to either an instance of the
  54 .Nm
  55 driver or an instance of the
  56 .Xr ehci 7D
  57 driver. By default, all such ports are routed to the
  58 .Nm
  59 driver, allowing those devices to operate at USB 3.x speed by default.
  60 This is most common on Intel platforms and chipsets. While this is
  61 controlled with the
  62 .Sy xhci-reroute
  63 property discussed below, changing it may not be sufficient to change
  64 the behavior. The BIOS or ACPI data for many x86 systems may toggle this
  65 automatically.
  66 .Sh PROPERTIES
  67 The
  68 .Nm
  69 driver supports the following properties which may be tuned in the
  70 .Nm
  71 driver's
  72 .Xr driver.conf 4
  73 file.
  74 .Bl -tag -width Sy
  75 .It Sy xhci-reroute
  76 The
  77 .Sy xhci-reroute
  78 property determines whether or not USB ports are re-routed to the
  79 .Nm
  80 driver. The default behavior is to route such ports.  To disable this,
  81 the property should be set to
  82 .Sy 0 .
  83 Any other value, or the lack of the property, cause the default behavior
  84 to take place.
  85 .El
  86 .Sh ARCHITECTURE
  87 The
  88 .Nm
  89 driver is only supported on
  90 .Sy x86
  91 systems at this time.
  92 .Sh FILES
  93 .Bl -tag -width Pa
  94 .It Pa /kernel/drv/xhci
  95 32-bit device driver (x86).
  96 .It Pa /kernel/drv/amd64/xhci
  97 64-bit device driver (x86).
  98 .It Pa /kernel/drv/xhci.conf
  99 Driver configuration file.
 100 .El
 101 .Sh SEE ALSO
 102 .Xr cfgadm 1M ,
 103 .Xr cfgadm_usb 1M ,
 104 .Xr dladm 1M ,
 105 .Xr driver.conf 4 ,
 106 .Xr ehci 7D ,
 107 .Xr usba 7D