11639-gate Wdiff usr/src/man/man7d/usba.7d

Print this page

11639 some man pages show incorrect driver locations

Split	Close
Expand all
Collapse all

          --- old/usr/src/man/man7d/usba.7d
          +++ new/usr/src/man/man7d/usba.7d
   1    1  .\" Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved
   2    2  .\" Copyright 2016 Joyent, Inc.
        3 +.\" Copyright 2020 Peter Tribble.
   3    4  .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4    5  .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5    6  .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6      -.Dd May 13, 2017
        7 +.Dd Jan 10, 2020
   7    8  .Dt USBA 7D
   8    9  .Os
   9   10  .Sh NAME
  10   11  .Nm usba ,
  11   12  .Nm usb
  12   13  .Nd illumos USB Architecture (USBA)
  13   14  .Sh DESCRIPTION
  14   15  USB provides a low-cost means for attaching peripheral devices, including
  15   16  mass-storage devices, keyboards, mice, and printers, to a system.
  16   17  For complete information on the USB architecture, visit the USB website at

  17   18  http://www.usb.org.
  18   19  .Pp
  19   20  USBA supports 126 hot-pluggable USB devices per USB bus.
  20   21  The maximum data transfer rate is 5 Gbits (SuperSpeed USB 3.0), 480 Mbits (high
  21   22  speed USB 2.0), 12 Mbits (full speed USB 1.x), or 1.5 Mbits (low speed USB 1.x).
  22   23  .Pp
  23   24  USBA adheres to the
  24   25  .Em Universal Serial Bus 3.0
  25   26  specification and provides a transport layer abstraction to USB client
  26   27  drivers.
  27   28  .Pp
  28   29  For information on how to write USB client drivers, see
  29   30  .Em Writing Device Drivers .
  30   31  For the latest information on writing USB drivers, visit

↓ open down ↓

14 lines elided

↑ open up ↑

  31   32  .Em http://illumos.org/books/wdd .
  32   33  For a complete list of USBA interfaces, see
  33   34  .Xr Intro 9F
  34   35  or
  35   36  .Xr Intro 9S .
  36   37  .Pp
  37   38  Devices without a driver may be able to leverage libusb.
  38   39  .Sh FILES
  39   40  Listed below are drivers and modules which either utilize or are utilized by
  40   41  USBA.
  41      -Drivers in
  42      -.Pa /kernel/drv
  43      -are 32 bit drivers (x86 only).
  44      -Drivers in
  45      -.Pa /kernel/drv/sparcv9
  46      -or
  47      -.Pa kernel/drv/amd64
  48      -are 64 bit drivers.
  49      -.Bl -column -offset indent ".Pa kernel/drv/[sparcv9|amd64/]usbser_edge" "Edgeport USB to serial port"
       42 +.Bl -column -offset indent ".Pa /kernel/drv/[sparcv9|amd64]/usbser_edge" "Edgeport USB to serial port"
  50   43  .It Em Client Driver Ta Em Function/Device
  51   44  .It Ta
  52      -.It Pa kernel/drv/[sparcv9|amd64/]hid Ta HID class
  53      -.It Pa kernel/drv/[sparcv9|amd64/]hubd Ta hub class
  54      -.It Pa kernel/drv/[sparcv9|amd64/]scsa2usb Ta mass storage class
  55      -.It Pa kernel/drv/[sparcv9|amd64/]usbprn Ta printer class
  56      -.It Pa kernel/drv/[sparcv9|amd64/]usb_as Ta audio streaming class
  57      -.It Pa kernel/drv/[sparcv9|amd64/]usb_ac Ta audio control class
  58      -.It Pa kernel/drv/[sparcv9|amd64/]usbvc Ta video class
  59      -.It Pa kernel/drv/[sparcv9|amd64/]usb_mid Ta multi-interface device
  60      -.It Pa kernel/drv/[sparcv9|amd64/]usb_ia Ta interface-association driver
  61      -.It Pa kernel/drv/[sparcv9|amd64/]usbser_edge Ta Edgeport USB to serial port
  62      -.It Pa kernel/drv/[sparcv9|amd64/]usbsksp Ta Keyspan USB to serial port
  63      -.It Pa kernel/drv/[sparcv9|amd64/]usbsprl Ta pl2303 USB to serial port
  64      -.It Pa kernel/drv/[sparcv9|amd64/]usbsacm Ta CDC ACM class to serial port
  65      -.It Pa kernel/drv/[sparcv9|amd64/]ugen Ta generic USB driver
  66      -.It Pa kernel/drv/[sparcv9|amd64/]ohci Ta open host controller driver
  67      -.It Pa kernel/drv/[sparcv9|amd64/]uhci Ta universal host controller driver
  68      -.It Pa kernel/drv/[sparcv9|amd64/]ehci Ta enhanced host controller driver
  69      -.It Pa kernel/drv/[sparcv9|amd64/]xhci Ta extensible host controller driver
       45 +.It Pa /kernel/drv/[sparcv9|amd64]/hid Ta HID class
       46 +.It Pa /kernel/drv/[sparcv9|amd64]/hubd Ta hub class
       47 +.It Pa /kernel/drv/[sparcv9|amd64]/scsa2usb Ta mass storage class
       48 +.It Pa /kernel/drv/[sparcv9|amd64]/usbprn Ta printer class
       49 +.It Pa /kernel/drv/[sparcv9|amd64]/usb_as Ta audio streaming class
       50 +.It Pa /kernel/drv/[sparcv9|amd64]/usb_ac Ta audio control class
       51 +.It Pa /kernel/drv/[sparcv9|amd64]/usbvc Ta video class
       52 +.It Pa /kernel/drv/[sparcv9|amd64]/usb_mid Ta multi-interface device
       53 +.It Pa /kernel/drv/[sparcv9|amd64]/usb_ia Ta interface-association driver
       54 +.It Pa /kernel/drv/[sparcv9|amd64]/usbser_edge Ta Edgeport USB to serial port
       55 +.It Pa /kernel/drv/[sparcv9|amd64]/usbsksp Ta Keyspan USB to serial port
       56 +.It Pa /kernel/drv/[sparcv9|amd64]/usbsprl Ta pl2303 USB to serial port
       57 +.It Pa /kernel/drv/[sparcv9|amd64]/usbsacm Ta CDC ACM class to serial port
       58 +.It Pa /kernel/drv/[sparcv9|amd64]/ugen Ta generic USB driver
  70   59  .El
  71   60  .Bl -column -offset indent ".Pa /kernel/strmod/[sparcv9|amd64/]usb_ah" "Function/Device"
  72   61  .It Ta
  73   62  .It Em Client Streams Modules Ta Em Function/Device
  74   63  .It Ta
  75      -.It Pa /kernel/strmod/[sparcv9|amd64/]usbkbm Ta Keyboad
  76      -.It Pa /kernel/strmod/[sparcv9|amd64/]usbms Ta Mouse
  77      -.It Pa /kernel/strmod/[sparcv9|amd64/]usb_ah Ta Audio HID
       64 +.It Pa /kernel/strmod/[sparcv9|amd64]/usbkbm Ta Keyboard
       65 +.It Pa /kernel/strmod/[sparcv9|amd64]/usbms Ta Mouse
       66 +.It Pa /kernel/strmod/[sparcv9|amd64]/usb_ah Ta Audio HID
  78   67  .El
  79   68  .Bl -column -offset indent ".Em Host Controller Interface Drivers" "Extensible HCI"
  80   69  .It Em Host Controller Interface Drivers Ta Em Device
  81   70  .It Ta
  82      -.It Pa /kernel/drv/[amd64/]xhci Ta Extensible HCI
  83      -.It Pa /kernel/drv/[sparcv9|amd64/]ehci Ta Enhanced HCI
  84      -.It Pa /kernel/drv/[sparcv9|amd64/]ohci Ta Open HCI
  85      -.It Pa /kernel/drv/[sparcv|amd64/]uhci Ta Universal HCI
       71 +.It Pa /kernel/drv/amd64/xhci Ta Extensible HCI
       72 +.It Pa /kernel/drv/[sparcv9|amd64]/ehci Ta Enhanced HCI
       73 +.It Pa /kernel/drv/[sparcv9|amd64]/ohci Ta Open HCI
       74 +.It Pa /kernel/drv/[sparcv9|amd64]/uhci Ta Universal HCI
  86   75  .El
  87   76  .Sh DIAGNOSTICS
  88   77  The messages described below may appear on the system console as well as being
  89   78  logged.
  90   79  All  messages are formatted in the following manner:
  91   80  .Bl -tag -width Sy -offset 2n
  92   81  .It WARNING: Error message...
  93   82  .El
  94   83  .Bl -tag -width Sy -offset 2n
  95   84  .It Sy no driver found for device <device_name> (interface <number> node

  96   85  name=<node_name>)
  97   86  The installed software does not contain a supported driver for this
  98   87  hardware.
  99   88  <number> is the interface number.
 100   89  <name> is either the device path name or the device name.
 101   90  .It Sy Draining callbacks timed out!
 102   91  An internal error occurred.

↓ open down ↓

7 lines elided

↑ open up ↑

 103   92  Please reboot your system.
 104   93  If this problem persists, contact your system vendor.
 105   94  .El
 106   95  .Pp
 107   96  The following messages may be logged into the system log.
 108   97  They are formatted in the following manner:
 109   98  .Bd -literal -offset 2n
 110   99  <device path><usba<instance number>): message...
 111  100  .Ed
 112  101  .Bl -tag -width Sy -offset 2n
 113      -.It Sy Incorrect USB driver version for <n.m>.
      102 +.It Sy Incorrect USB driver version for <n.m> .
 114  103  Driver is incompatible with USBA framework.
 115  104  .El
 116  105  .Sh SEE ALSO
 117  106  .Xr cfgadm_usb 1M ,
 118  107  .Xr attributes 5 ,
 119  108  .Xr ehci 7D ,
 120  109  .Xr hid 7D ,
 121  110  .Xr hubd 7D ,
 122  111  .Xr ohci 7D ,
 123  112  .Xr scsa2usb 7D ,

 124  113  .Xr ugen 7D ,
 125  114  .Xr uhci 7D ,
 126  115  .Xr usb_ac 7D ,
 127  116  .Xr usb_as 7D ,
 128  117  .Xr usb_ia 7D ,
 129  118  .Xr usb_mid 7D ,
 130  119  .Xr usbprn 7D ,
 131  120  .Xr usbsacm 7D ,
 132  121  .Xr usbser_edge 7D ,
 133  122  .Xr usbsksp 7D ,
 134  123  .Xr usbsprl 7D ,
 135  124  .Xr usbvc 7D ,
 136  125  .Xr virtualkm 7D ,
 137  126  .Xr xhci 7D ,
 138  127  .Xr Intro 9F ,
 139  128  .Xr Intro 9S
 140  129  .Pp
 141  130  .Rs
 142  131  .%T Writing Device Drivers
 143  132  .Re
 144  133  .Rs
 145  134  .%T Universal Serial Bus Specification 3.0
 146  135  .Re
 147  136  .Rs
 148  137  .%T Interface Association Descriptor Engineering Change Notice (ECN)
 149  138  .Re
 150  139  .Rs
 151  140  .%T System Administration Guide: Basic Administration
 152  141  .Re
 153  142  .Sh NOTES
 154  143  Booting from USB mass-storage devices is not supported on SPARC, but is
 155  144  supported on X86.

↓ open down ↓

32 lines elided

↑ open up ↑

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX