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 January 10, 2020 15.Dt XHCI 4D 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 23The 24.Nm 25driver supports PCI devices that implement versions 1.0 and 1.1 of the 26Extensible Host Controller Interface Specification. 27These devices provide support for USB 3.0, USB 2.x, and USB 1.x devices and is 28integrated into the broader illumos USB Architecture (USBA). 29.Pp 30The 31.Nm 32driver supports all four USB transfer types: 33.Sy bulk transfers , 34.Sy control transfers , 35.Sy interrupt transfers , 36and 37.Sy isochronous transfers . 38.Pp 39Administrators do not interact with the 40.Nm 41driver directly. 42USB devices are managed with 43.Xr cfgadm 8 . 44See 45.Xr cfgadm_usb 8 46for more information on how to specifically manage USB devices and how 47they are laid out in the system. 48.Xr cfgadm 8 49is only used to manage devices at a USB level. 50For example, a USB NIC would still be managed with 51.Xr dladm 8 52at a networking level. 53.Pp 54On some x86 systems USB ports may be routed to either an instance of the 55.Nm 56driver or an instance of the 57.Xr ehci 4D 58driver. 59By default, all such ports are routed to the 60.Nm 61driver, allowing those devices to operate at USB 3.x speed by default. 62This is most common on Intel platforms and chipsets. 63While this is controlled with the 64.Sy xhci-reroute 65property discussed below, changing it may not be sufficient to change 66the behavior. 67The BIOS or ACPI data for many x86 systems may toggle this automatically. 68.Sh PROPERTIES 69The 70.Nm 71driver supports the following properties which may be tuned in the 72.Nm 73driver's 74.Xr driver.conf 5 75file. 76.Bl -tag -width Sy 77.It Sy xhci-reroute 78The 79.Sy xhci-reroute 80property determines whether or not USB ports are re-routed to the 81.Nm 82driver. 83The default behavior is to route such ports. 84To disable this, the property should be set to 85.Sy 0 . 86Any other value, or the lack of the property, cause the default behavior 87to take place. 88.El 89.Sh ARCHITECTURE 90The 91.Nm 92driver is only supported on 93.Sy x86 94systems at this time. 95.Sh FILES 96.Bl -tag -width Pa 97.It Pa /kernel/drv/amd64/xhci 98Device driver (x86) 99.It Pa /kernel/drv/xhci.conf 100Driver configuration file 101.El 102.Sh SEE ALSO 103.Xr ehci 4D , 104.Xr usba 4D , 105.Xr driver.conf 5 , 106.Xr cfgadm 8 , 107.Xr cfgadm_usb 8 , 108.Xr dladm 8 109