diff options
Diffstat (limited to 'usr/src/man/man7d')
| -rw-r--r-- | usr/src/man/man7d/audiopci.7d | 11 | ||||
| -rw-r--r-- | usr/src/man/man7d/ecpp.7d | 22 | ||||
| -rw-r--r-- | usr/src/man/man7d/ehci.7d | 27 | ||||
| -rw-r--r-- | usr/src/man/man7d/hid.7d | 14 | ||||
| -rw-r--r-- | usr/src/man/man7d/hubd.7d | 7 | ||||
| -rw-r--r-- | usr/src/man/man7d/ieee1394.7d | 18 | ||||
| -rw-r--r-- | usr/src/man/man7d/ohci.7d | 12 | ||||
| -rw-r--r-- | usr/src/man/man7d/sata.7d | 14 | ||||
| -rw-r--r-- | usr/src/man/man7d/scsa1394.7d | 31 | ||||
| -rw-r--r-- | usr/src/man/man7d/scsa2usb.7d | 49 | ||||
| -rw-r--r-- | usr/src/man/man7d/sd.7d | 24 | ||||
| -rw-r--r-- | usr/src/man/man7d/ugen.7d | 136 | ||||
| -rw-r--r-- | usr/src/man/man7d/uhci.7d | 10 | ||||
| -rw-r--r-- | usr/src/man/man7d/usb_ia.7d | 15 | ||||
| -rw-r--r-- | usr/src/man/man7d/usb_mid.7d | 19 | ||||
| -rw-r--r-- | usr/src/man/man7d/usba.7d | 6 | ||||
| -rw-r--r-- | usr/src/man/man7d/usbprn.7d | 23 | ||||
| -rw-r--r-- | usr/src/man/man7d/usbsksp.7d | 50 | ||||
| -rw-r--r-- | usr/src/man/man7d/usbvc.7d | 42 | ||||
| -rw-r--r-- | usr/src/man/man7d/virtualkm.7d | 43 |
20 files changed, 189 insertions, 384 deletions
diff --git a/usr/src/man/man7d/audiopci.7d b/usr/src/man/man7d/audiopci.7d index 68a2e5cee0..116efce9f3 100644 --- a/usr/src/man/man7d/audiopci.7d +++ b/usr/src/man/man7d/audiopci.7d @@ -3,17 +3,15 @@ .\" 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. .\" 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 the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH AUDIOPCI 7D "May 6, 2009" +.TH AUDIOPCI 7D "May 13, 2017" .SH NAME audiopci \- Ensoniq 1370 driver support .SH DESCRIPTION -.sp .LP The \fBaudiopci\fR driver provides support for the Ensoniq 1370 audio controller. Ensoniq 1370 chips are found on add-in PCI cards commonly identified as Audio PCI and SoundBlaster PCI. .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/audiopci\fR\fR @@ -34,7 +32,7 @@ identified as Audio PCI and SoundBlaster PCI. .sp .ne 2 .na -\fB\fB/kernel/drv/amd64/audiopci\fR\fR +\fB\fB/kernel/drv/sparcv9/audiopci\fR\fR .ad .RS 30n 64-bit SPARC kernel driver module @@ -50,7 +48,6 @@ Driver configuration file .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -66,13 +63,9 @@ Architecture PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), \fBstreamio\fR(7I) .sp .LP \fICreative Technology Ltd ES1370 Specification\fR -.sp -.LP -http://www.sun.com diff --git a/usr/src/man/man7d/ecpp.7d b/usr/src/man/man7d/ecpp.7d index 6723835203..9c81264ef1 100644 --- a/usr/src/man/man7d/ecpp.7d +++ b/usr/src/man/man7d/ecpp.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ECPP 7D "Oct 9, 2004" +.TH ECPP 7D "May 13, 2017" .SH NAME ecpp \- IEEE 1284 compliant parallel port driver .SH SYNOPSIS @@ -23,7 +23,6 @@ ecpp@unit-address .fi .SH DESCRIPTION -.sp .LP The \fBecpp\fR driver provides a bi-directional interface to \fIIEEE 1284\fR compliant devices as well as a forward single-directional interface to @@ -49,7 +48,6 @@ in \fBecpp.conf\fR. The \fBecpp\fR driver is an \fIexclusive-use\fR device, meaning that if the device is already open, subsequent opens fail with \fBEBUSY\fR. .SS "Default Operation" -.sp .LP Each time the \fBecpp\fR device is opened, the device is marked as \fBEBUSY\fR and the configuration variables are set to their default values. The @@ -73,7 +71,6 @@ the \fBwrite_timeout\fR values through the \fBECPPIOC_SETPARMS\fR \fBioctl\fR(2) call. For mode negotiation to be successful, both the host workstation and the peripheral must support the requested mode. .SS "Tunables" -.sp .LP Characteristics of the \fBecpp\fR driver may be tuned by the variables described in \fB/kernel/drv/ecpp.conf\fR. These variables are read by the @@ -86,13 +83,11 @@ will not operate with the parallel port operating in a fast handshaking mode. If printing problems occur, set "fast-centronics" and "fast-1284-compatible" to "false." See \fB/kernel/drv/ecpp.conf\fR for more information. .SS "Read/Write Operation" -.sp .LP The \fBecpp\fR driver is a full duplex STREAMS device driver. While an application is writing to an \fIIEEE 1284\fR compliant device, another thread may read from it. .SS "Write Operation" -.sp .LP A \fBwrite\fR(2) operation returns the number of bytes successfully written to the stream head. If a failure occurs while a Centronics device is transferring @@ -101,7 +96,6 @@ and can be retrieved by the application program using the \fBBPPIOC_GETERR\fR \fBioctl\fR(2) call. The captured status information is overwritten each time an attempted transfer or a \fBBPPIOC_TESTIO\fR \fBioctl\fR(2) occurs. .SS "Read Operation" -.sp .LP If a failure or error condition occurs during a \fBread\fR(2), the number of bytes successfully read is returned (short read). When attempting to read a @@ -110,7 +104,6 @@ port that has no data currently available, \fBread\fR(2) returns \fB0\fR if \fB-1\fR and sets errno to \fBEAGAIN.\fR If \fBO_NDELAY\fR and \fBO_NONBLOCK\fR are clear, \fBread\fR(2) blocks until data become available. .SH IOCTLS -.sp .LP The \fBioctl\fR(2) calls described below are supported. Note that when \fBecpp\fR is transferring data, the driver waits until the data has been sent @@ -127,7 +120,7 @@ followed by default negotiation. .RE .sp .LP -The following \fBioctl(2)\fR calls are supported for backward compatibility and +The following \fBioctl\fR(2) calls are supported for backward compatibility and are not recommended for new applications: .sp .ne 2 @@ -342,7 +335,6 @@ bits are reserved. Reading reserved bits always return 1. An attempt to write .RE .SH DEVICE SPECIAL FILES -.sp .ne 2 .na \fB\fB/dev/lp\fIN\fR\fR\fR @@ -361,7 +353,6 @@ Solaris x86 only. (Backwards compatibility with former \fBlp\fR(7D) devices.) .RE .SH FILES -.sp .ne 2 .na \fB\fBkernel/drv/ecpp\fR\fR @@ -422,7 +413,6 @@ driver configuration file for 64-bit x86 .RE .SH ERRORS -.sp .ne 2 .na \fB\fBEBADF\fR\fR @@ -478,7 +468,6 @@ peripheral error. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -498,19 +487,14 @@ Interface stability Evolving .TE .SH SEE ALSO -.sp .LP -\fBmodload\fR(1M), \fBmodunload\fR(1M), \fBupdate_drv\fR(1M)\fBioctl\fR(2), +\fBmodload\fR(1M), \fBmodunload\fR(1M), \fBupdate_drv\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBattributes\fR(5), \fBbpp\fR(7D), \fBusbprn\fR(7D), \fBprnio\fR(7I), \fBstreamio\fR(7I) .sp .LP \fIIEEE Std 1284-1994\fR -.sp -.LP -\fIhttp://www.sun.com/io\fR .SH DIAGNOSTICS -.sp .ne 2 .na \fBParallel port controller not supported\fR diff --git a/usr/src/man/man7d/ehci.7d b/usr/src/man/man7d/ehci.7d index 618a1562ea..a1a9a3efb8 100644 --- a/usr/src/man/man7d/ehci.7d +++ b/usr/src/man/man7d/ehci.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH EHCI 7D "Apr 13, 2006" +.TH EHCI 7D "May 13, 2017" .SH NAME ehci \- Enhanced host controller driver .SH SYNOPSIS @@ -13,7 +13,6 @@ ehci \- Enhanced host controller driver .fi .SH DESCRIPTION -.sp .LP The \fBehci\fR driver is a USBA (Solaris USB Architecture) compliant nexus driver that supports the Enhanced Host Controller Interface Specification 2.0, @@ -26,8 +25,8 @@ EHCI (Enhanced Host Controller Interface) that is used for all high-speed communications to high-speed-mode devices. .sp .LP -All USB 2.0 devices connected to the root ports of the USB 2.0 host -controller and all devices connected to a high- speed-mode hub should be routed +All USB 2.0 devices connected to the root ports of the USB 2.0 host +controller and all devices connected to a high-speed-mode hub should be routed to the EHCI host controller. .sp .LP @@ -36,10 +35,9 @@ controller should be routed to the companion USB 1.1 host controllers. (OHCI or UHCI host controller). .sp .LP -The \fBehci\fR supports bulk, interrupt, control and iso chronous transfers +The \fBehci\fR supports bulk, interrupt, control and iso chronous transfers (on USB1.\fIx\fR devices behind a USB2.0 hub). .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/ehci\fR\fR @@ -76,7 +74,6 @@ Driver configuration file .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -92,7 +89,6 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBadd_drv\fR(1M), \fBprtconf\fR(1M), \fBrem_drv\fR(1M), \fBupdate_drv\fR(1M), \fBattributes\fR(5), \fBhubd\fR(7D), \fBuhci\fR(7D), \fBohci\fR(7D), @@ -114,15 +110,8 @@ Architecture SPARC, x86, PCI-based systems \fIhttp://www.usb.org\fR .sp .LP -\fIhttp://www.sun.com/io\fR -.sp -.LP -\fIhttp://www.sun.com/bigadmin/hcl\fR -.sp -.LP \fIhttp://www.intel.com/technology/usb/ehcispec.htm\fR .SH DIAGNOSTICS -.sp .LP In addition to being logged, the following messages may appear on the system console. All messages are formatted in the following manner: @@ -212,7 +201,7 @@ comment out a property in ehci.conf. (x86 only). .ad .sp .6 .RS 4n -The driver is unable to take control of the EHCI hardware from the +The driver is unable to take control of the EHCI hardware from the system's BIOS and aborts the attach. High speed (USB 2.0) support is disabled. In this case, all USB devices run at full/low speed. Contact your system vendor or your system administror for possible changes in BIOS settings. You can @@ -300,13 +289,11 @@ Note - Due to recently discovered incompatibilities with this USB controller, USB2.\fIx\fR transfer support has been disabled. However, this device continues to function as a USB1.\fIx\fR controller. Information on enabling USB2.x -support is provided in this man page. Please refer to \fIwww.sun.com/io\fR for -Solaris Ready products and to \fIwww.sun.com/bigadmin/hcl\fR for additional -compatible USB products. +support is provided in this man page. .LP VIA chips may not be compatible with this driver. To bind \fBehci\fR specifically to the chip and eliminate the warnings, and to enable USB2.x -suppport, a new, more specific driver alias (refer to \fBadd_drv\fR(1M) and +support, a new, more specific driver alias (refer to \fBadd_drv\fR(1M) and \fBupdate_drv\fR(1M)) must be specified for \fBehci\fR. By default, the \fBehci\fR alias is 'pciclass,0c0320.' The compatible names in the \fBprtconf\fR(1M) output provides additional aliases. For example: diff --git a/usr/src/man/man7d/hid.7d b/usr/src/man/man7d/hid.7d index 15ccca13dd..e6538e34a0 100644 --- a/usr/src/man/man7d/hid.7d +++ b/usr/src/man/man7d/hid.7d @@ -3,7 +3,7 @@ .\" 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. .\" 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 the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH HID 7D "Aug 21, 2009" +.TH HID 7D "May 13, 2017" .SH NAME hid \- Human interface device (HID) class driver .SH SYNOPSIS @@ -17,7 +17,6 @@ hid \- Human interface device (HID) class driver .fi .SH DESCRIPTION -.sp .LP The \fBhid\fR driver is a USBA (Solaris USB Architecture) compliant client driver that supports the \fIHuman Interface Device Class (HID) 1.0\fR @@ -45,7 +44,6 @@ information about the device. The \fBhid\fR driver queries the HID parser to find out the type and characteristics of the HID device. The HID specification predefines packet formats for the boot protocol keyboard and mouse. .SH IOCTLS -.sp .ne 2 .na \fB\fBHIDIOCKMGDIRECT\fR\fR @@ -79,7 +77,6 @@ gets the input. .RE .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/hid\fR\fR @@ -140,7 +137,6 @@ gets the input. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -156,7 +152,6 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBcfgadm_usb\fR(1M), \fBattributes\fR(5), \fBusba\fR(7D), \fBvirtualkm\fR(7D) .sp @@ -174,11 +169,7 @@ Architecture SPARC, x86, PCI-based systems .sp .LP \fISystem Administration Guide: Basic Administration\fR -.sp -.LP -\fIhttp://www.sun.com\fR .SH DIAGNOSTICS -.sp .ne 2 .na \fBhid_attach: Unsupported HID device.\fR @@ -253,13 +244,12 @@ The device cannot be supported by this version of the HID driver. .RE .SH NOTES -.sp .LP The hid driver currently supports only keyboard, mouse and audio HID control devices. .sp .LP -Normally a mouse is not power managed and consquently, screen darkening can be +Normally a mouse is not power managed and consequently, screen darkening can be undone with a mouse movement. If power management of the mouse is required, add the following line to \fBhid.conf\fR then reboot the system: .sp diff --git a/usr/src/man/man7d/hubd.7d b/usr/src/man/man7d/hubd.7d index cabb1f938e..881272cadb 100644 --- a/usr/src/man/man7d/hubd.7d +++ b/usr/src/man/man7d/hubd.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH HUBD 7D "Oct 4, 2016" +.TH HUBD 7D "May 13, 2017" .SH NAME hubd \- USB hub driver .SH SYNOPSIS @@ -82,9 +82,6 @@ Architecture SPARC, x86, PCI-based systems .sp .LP \fISystem Administration Guide: Basic Administration\fR -.sp -.LP -http://\fIwww.sun.com/io\fR .SH DIAGNOSTICS .LP In addition to being logged, the following messages may also appear on the @@ -257,7 +254,7 @@ bus.\fR .sp .6 .RS 4n A USB self/bus-powered hub has lost external power. Some USB devices connected -down-stream from this hub may cease to function. Disconnect the +down-stream from this hub may cease to function. Disconnect the external power-supply and then plug in the hub again. .RE diff --git a/usr/src/man/man7d/ieee1394.7d b/usr/src/man/man7d/ieee1394.7d index 41b63a6744..bcdf216811 100644 --- a/usr/src/man/man7d/ieee1394.7d +++ b/usr/src/man/man7d/ieee1394.7d @@ -3,16 +3,15 @@ .\" 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. .\" 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 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH IEEE1394 7D "Apr 3, 2009" +.TH IEEE1394 7D "May 13, 2017" .SH NAME ieee1394, firewire, 1394 \- Solaris IEEE-1394 Architecture .SH DESCRIPTION -.sp .LP -IEEE-1394 provides a means for interconnecting devices in computer and home +IEEE-1394 provides a means for interconnecting devices in computer and home entertainment systems. (The IEEE-1394 architecture is also known as Firewire, an Apple Computer trademark, and i.Link, a Sony trademark). The most common -IEEE-1394 devices are digital camcorders, mass-storage devices and cameras +IEEE-1394 devices are digital camcorders, mass-storage devices and cameras (including webcam-type devices). For more information on USB, refer to the 1394 Trade Association website at http://\fIwww.1394ta.org\fR. .sp @@ -28,13 +27,12 @@ in the \fIIEEE 1394-1995\fR and \fIIEEE 1394a-2000\fR specifications. .sp .LP IEEE-1394 host controllers implementing the 1394 Open Host Controller Interface -specification are supported. Camcorders implementing the \fIIEC 61883\fR +specification are supported. Camcorders implementing the \fIIEC 61883\fR and 1394 Trade Association AV/C specifications are supported. Mass-storage devices implementing the \fIANSI SBP-2\fR specification are supported. Digital cameras implementing the 1394 Trade Association 1394-based Digital Camera (IIDC) specification are supported. .SH FILES -.sp .LP Listed below are drivers and modules which either utilize or are utilized by the Solaris IEEE-1394 architecture. Drivers in \fB/kernel/drv\fR are 32 bit @@ -85,7 +83,6 @@ _ .TE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -101,21 +98,16 @@ Architecture PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBav1394\fR(7D), \fBdcam1394\fR(7D), \fBhci1394\fR(7D), \fBscsa1394\fR(7D), \fBiec61883\fR(7I) .sp .LP -http://www.sun.com -.sp -.LP \fIIEEE 1394a\fR Specification - 1394 Trade Association, 2000 .sp .LP \fIIEEE 1394\fR Specification - 1394 Trade Association, 1995 .SH NOTES -.sp .LP Booting from IEEE-1394 mass-storage devices is not supported, but may be -possible if supported by the BIOS of the computer system. +possible if supported by the BIOS of the computer system. diff --git a/usr/src/man/man7d/ohci.7d b/usr/src/man/man7d/ohci.7d index b2a60de881..922cd18bfd 100644 --- a/usr/src/man/man7d/ohci.7d +++ b/usr/src/man/man7d/ohci.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH OHCI 7D "Nov 23, 2006" +.TH OHCI 7D "May 13, 2017" .SH NAME ohci \- OpenHCI host controller driver .SH SYNOPSIS @@ -13,7 +13,6 @@ ohci \- OpenHCI host controller driver .fi .SH DESCRIPTION -.sp .LP The \fBohci\fR driver is a USBA (Solaris USB Architecture) compliant nexus driver that supports the \fIOpen Host Controller Interface Specification @@ -24,7 +23,6 @@ Semiconductor. The \fBohci\fR driver supports bulk, interrupt, control and isochronous transfers. .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/ohci\fR\fR @@ -61,7 +59,6 @@ driver configuration file .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -77,7 +74,6 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBehci\fR(7D), \fBhubd\fR(7D), \fBuhci\fR(7D), \fBusba\fR(7D) @@ -93,11 +89,7 @@ Architecture SPARC, x86, PCI-based systems .sp .LP \fISystem Administration Guide: Basic Administration\fR -.sp -.LP -\fIhttp://www.sun.com/io\fR .SH DIAGNOSTICS -.sp .LP All host controller errors are passed to the client drivers. Root hub errors are documented in \fBhubd\fR(7D). @@ -138,7 +130,7 @@ system. If this problem persists, contact your system vendor. .sp .LP -The following messages may be entered into the system log. They are formatted +The following messages may be entered into the system log. They are formatted in the following manner: .sp .in +2 diff --git a/usr/src/man/man7d/sata.7d b/usr/src/man/man7d/sata.7d index b3ad7f9692..558d273d6e 100644 --- a/usr/src/man/man7d/sata.7d +++ b/usr/src/man/man7d/sata.7d @@ -3,11 +3,10 @@ .\" 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. .\" 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 the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SATA 7D "Sep 10, 2009" +.TH SATA 7D "May 13, 2017" .SH NAME sata \- Solaris SATA framework .SH DESCRIPTION -.sp .LP Serial ATA is an interconnect technology designed to replace parallel ATA technology. It is used to connect hard drives, optical drives, removable @@ -18,7 +17,7 @@ http://\fIwww.serialata.org\fR. .LP Up to 32 SATA devices may be plugged directly to each SATA HBA and up to 15 SATA devices may be plugged directly to each SATA port multiplier supported by -the Solaris SATA framework. The actual number of pluggable devices my be lower, +the Solaris SATA framework. The actual number of pluggable devices may be lower, and is limited by the number of device ports on the SATA HBA or the SATA port multiplier. The maximum data rate is either 1.5Gb/sec. or 3.0Gb/sec., depending on the capability of a SATA device, port multiplier and SATA HBA controller. @@ -32,7 +31,6 @@ attached as a target driver for each device node created by the SATA framework. You can use the \fBcfgadm\fR(1M) utility to manage hot plugged and unplugged SATA devices. .SH FILES -.sp .ne 2 .na \fB\fB/kernel/misc/sata\fR\fR @@ -51,7 +49,6 @@ SATA devices. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attribute: .sp @@ -67,10 +64,9 @@ Architecture x86 .TE .SH SEE ALSO -.sp .LP \fBcfgadm\fR(1M), \fBprtconf\fR(1M), \fBcfgadm_sata\fR(1M), -\fBattributes\fR(5), \fBahci\fR(7D), \fBmarvell88sx\fR(7D), \fBnv_sata\fR(7D), +\fBattributes\fR(5), \fBahci\fR(7D), \fBnv_sata\fR(7D), \fBsd\fR(7D), \fBsi3124\fR(7D) .sp .LP @@ -79,11 +75,7 @@ Architecture x86 .LP \fISerial ATA II (Extension to Serial ATA 1.0.a.)\fR \(em Serial ATA International Organization. -.sp -.LP -\fIhttp://www.sun.com/\fR .SH DIAGNOSTICS -.sp .LP The messages described below may appear on the system console as well as being logged. All messages are presented in one of the following formats and are diff --git a/usr/src/man/man7d/scsa1394.7d b/usr/src/man/man7d/scsa1394.7d index 4c4e66b047..a9ae97d88b 100644 --- a/usr/src/man/man7d/scsa1394.7d +++ b/usr/src/man/man7d/scsa1394.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SCSA1394 7D "Mar 2, 2007" +.TH SCSA1394 7D "May 13, 2017" .SH NAME scsa1394 \- SCSI to 1394 bridge driver .SH SYNOPSIS @@ -13,7 +13,6 @@ scsa1394 \- SCSI to 1394 bridge driver .fi .SH DESCRIPTION -.sp .LP The \fBscsa1394\fR driver is a 1394 target and an SCSA HBA driver that supports 1394 mass storage devices compliant with the \fISerial Bus Protocol 2 @@ -41,11 +40,10 @@ In the current release, however, only mass storage devices with a removable bit INQUIRY data.) See SCSI specifications T10/995D Revision 11a, T10/1236-D Revision 20 or T10/1416-D Revision 23 for more information. However, for backward compatibility, all 1394 mass storage devices can still be managed by -\fBrmformat\fR(1). With or without a volume manager, you can mount, eject, -hot remove and hot insert a 1394 mass storage device as the following sections +\fBrmformat\fR(1). With or without a volume manager, you can mount, eject, +hot remove and hot insert a 1394 mass storage device as the following sections explain. .SH USING VOLUME MANAGEMENT -.sp .LP Mass storage devices are managed by a volume manager. Software that manages removable media creates a device nickname that can be listed with @@ -69,12 +67,7 @@ the USB device, use \fBeject\fR(1) to unmount the file system. You can disable the automatic mounting and unmounting of removable devices by inserting a entry for a removable device in \fB/etc/vfstab\fR. In this entry, you must set the \fBmount at boot\fR field to \fBno\fR. See \fBvfstab\fR(4). -See the \fISystem Administration Guide, Volume I\fR and \fISolaris Common -Desktop Environment: User's Guide\fR for details on how to manage a removable -device with CDE and Removable Media Manager. See \fBdtfile.1X\fR under CDE for -information on how to use Removable Media Manager. .SH USING \fBmount\fR AND \fBumount\fR -.sp .LP Use \fBmount\fR(1M) to explicitly mount the device and \fBumount\fR(1M) to unmount the device. Use \fBeject\fR(1) to eject the media. After you have @@ -86,26 +79,18 @@ Removing the storage device while it is being accessed or mounted fails with a console warning. To hot remove the storage device from the system, unmount the file system, then kill all applications accessing the device. Next, hot remove the device. A storage device can be hot inserted at any time. -.sp -.LP -For a comprehensive listing of (non-bootable) 1394 mass-storage devices that -are compatible with this driver, see \fBwww.sun.com/io\fR. .SH DEVICE SPECIAL FILES -.sp .LP Block special file names are located in \fB/dev/dsk\fR. Raw file names are located in \fB/dev/rdsk\fR. Input/output requests to the devices must follow the same restrictions as those for SCSI disks. Refer to \fBsd\fR(7D). .SH IOCTLS -.sp .LP Refer to \fBcdio\fR(7I) and \fBdkio\fR(7I). .SH ERRORS -.sp .LP Refer to \fBsd\fR(7D). .SH FILES -.sp .LP The device special files for the 1394 mass storage device are created like those for a SCSI disk. Refer to \fBsd\fR(7D). @@ -171,7 +156,6 @@ is a generic removable media device. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -187,11 +171,10 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBcdrw\fR(1), \fBeject\fR(1), \fBrmformat\fR(1), \fBrmmount\fR(1), \fBcfgadm_scsi\fR(1M), \fBfdisk\fR(1M), \fBmount\fR(1M), \fBumount\fR(1M), -\fBdtfile.1X\fR (in CDE man pages), \fBscsi\fR(4), \fBvfstab\fR(4), +\fBscsi\fR(4), \fBvfstab\fR(4), \fBattributes\fR(5), \fBhci1394\fR(7D), \fBsd\fR(7D), \fBpcfs\fR(7FS), \fBcdio\fR(7I), \fBdkio\fR(7I) .sp @@ -212,9 +195,3 @@ SCSI Specification\fIT10/1236-D Revision 20\fR \(em July 2001 .sp .LP SCSI Specification\fIT10/1416-D Revision 23\fR\(em May 2005 -.sp -.LP -\fISolaris Common Desktop Environment: User's Guide\fR -.sp -.LP -\fIhttp://www.sun.com/io\fR diff --git a/usr/src/man/man7d/scsa2usb.7d b/usr/src/man/man7d/scsa2usb.7d index 94903e0cbe..7a14176b7b 100644 --- a/usr/src/man/man7d/scsa2usb.7d +++ b/usr/src/man/man7d/scsa2usb.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SCSA2USB 7D "Jul 28, 2008" +.TH SCSA2USB 7D "May 13, 2017" .SH NAME scsa2usb \- SCSI to USB bridge driver .SH SYNOPSIS @@ -13,7 +13,6 @@ scsa2usb \- SCSI to USB bridge driver .fi .SH DESCRIPTION -.sp .LP The \fBscsa2usb\fR driver is a \fBUSBA\fR (Solaris USB architecture) compliant nexus driver that supports the \fIUSB Mass Storage Bulk Only Transport @@ -27,7 +26,7 @@ supports storage devices that utilize the above two transports. .sp .LP The \fBscsa2usb\fR driver also supports a \fBugen\fR(7D) interface allowing raw -access to the device, for example by \fBlibusb\fR(3LIB) applications, bypassing +access to the device, for example by libusb applications, bypassing the child \fBsd\fR(7D) or \fBst\fR(7D) driver. Because a libusb application might change the state of the device, you should not access the disk or tape concurrently. @@ -55,8 +54,8 @@ In the current release, however, only disk storage devices with a removable bit INQUIRY data.) See SCSI specifications T10/995D Revision 11a, T10/1236-D Revision 20 or T10/1416-D Revision 23 for more information. However, for backward compatibility, all USB disk storage devices can still be managed by -\fBrmformat\fR(1). With or without a volume manager, you can mount, eject, -hot remove and hot insert a 1394 mass storage device as the following sections +\fBrmformat\fR(1). With or without a volume manager, you can mount, eject, +hot remove and hot insert a 1394 mass storage device as the following sections explain. .sp .LP @@ -72,8 +71,8 @@ enable support of particular devices. .sp .LP Follow the information given in the \fBscsa2usb.conf\fR file to see if a -particular device can be supported using the override information. Also see -http:/\fI/www.sun.com/io\fR. For example, by adding the following to the +particular device can be supported using the override information. +For example, by adding the following to the \fBscsa2usb.conf\fR file, many USB memory sticks and card readers might operate more reliably: .sp @@ -104,7 +103,6 @@ exclude: scsa2usb Alternatively, you can disable automatic handling of a device as described in the following subsection. .SS "Using Volume Management" -.sp .LP Disk storage devices are managed by Volume Manager. Software that manages removable media creates a device nickname that can be listed with @@ -131,12 +129,7 @@ it. You can disable the automatic mounting and unmounting of removable devices by inserting a entry for a removable device in \fB/etc/vfstab\fR. In this entry, you must set the \fBmount at boot\fR field to \fBno\fR. See \fBvfstab\fR(4). -See the \fISystem Administration Guide, Volume I\fR and \fISolaris Common -Desktop Environment: User's Guide\fR for details on how to manage a removable -device with CDE and Removable Media Manager. See \fBdtfile.1X\fR under CDE for -information on how to use Removable Media Manager. .SS "Using \fBmount\fR and \fBumount\fR" -.sp .LP Use \fBmount\fR(1M) to explicitly mount the device and \fBumount\fR(1M) to unmount the device. Use \fBeject\fR(1) to eject the media. After you have @@ -148,12 +141,7 @@ Removing the disk device while it is being accessed or mounted fails with a console warning. To hot remove the disk device from the system, unmount the file system, then kill all applications accessing the device. Next, hot remove the device. A storage device can be hot inserted at any time. -.sp -.LP -For a comprehensive listing of (non-bootable) USB mass-storage devices that are -compatible with this driver, see \fBwww.sun.com/io\fR. .SH DEVICE SPECIAL FILES -.sp .LP Disk block special file names are located in \fB/dev/dsk\fR, while raw file names are located in \fB/dev/rdsk\fR. Tape raw file names are located in @@ -161,15 +149,12 @@ names are located in \fB/dev/rdsk\fR. Tape raw file names are located in restrictions as those for SCSI disks or tapes. Refer to \fBsd\fR(7D) or \fBst\fR(7D). .SH IOCTLS -.sp .LP Refer to \fBdkio\fR(7I) and \fBcdio\fR(7I). .SH ERRORS -.sp .LP Refer to \fBsd\fR(7D) for disks or \fBst\fR(7D) for tapes. .SH FILES -.sp .LP The device special files for the USB mass storage device are created like those for a \fBSCSI\fR disk or SCSI tape. Refer to \fBsd\fR(7D) or \fBst\fR(7D). @@ -285,7 +270,6 @@ Can be used to override specific characteristics. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -301,13 +285,12 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBcdrw\fR(1), \fBeject\fR(1), \fBrmformat\fR(1), \fBrmmount\fR(1), \fBcfgadm_scsi\fR(1M), \fBcfgadm_usb\fR(1M), \fBfdisk\fR(1M), \fBmount\fR(1M), -\fBumount\fR(1M), \fBdtfile.1X\fR (in CDE man pages), \fBlibusb\fR(3LIB), +\fBumount\fR(1M), \fBscsi\fR(4), \fBvfstab\fR(4), \fBattributes\fR(5), -\fBieee1394\fR(7D)\fBsd\fR(7D), \fBst\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D), +\fBieee1394\fR(7D), \fBsd\fR(7D), \fBst\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D), \fBpcfs\fR(7FS), \fBcdio\fR(7I), \fBdkio\fR(7I) .sp .LP @@ -317,9 +300,6 @@ Architecture SPARC, x86, PCI-based systems \fISystem Administration Guide, Volume I\fR .sp .LP -\fISolaris Common Desktop Environment: User's Guide\fR -.sp -.LP \fIUniversal Serial Bus Specification 2.0\fR .sp .LP @@ -343,12 +323,8 @@ SCSI Specification \fIT10/995D Revision 11a\fR \(em March 1997 SCSI Specification\fIT10/1236-D Revision 20\fR \(em July 2001 .sp .LP -SCSI Specification\fIT10/1416-D Revision 23\fR\(em May 2005 -.sp -.LP -http://\fIwww.sun.com/io\fR +SCSI Specification\fIT10/1416-D Revision 23\fR \(em May 2005 .SH DIAGNOSTICS -.sp .LP Refer to \fBsd\fR(7D) and \fBst\fR(7D). .sp @@ -475,7 +451,6 @@ USB mass storage devices. .RE .SH NOTES -.sp .LP The Zip 100 drive does not comply with \fIUniversal Serial Bus Specification 1.0\fR and cannot be power managed. Power Management support for Zip 100 has @@ -502,17 +477,13 @@ some other USB device will also fail. To successfully remove a USB mass-storage device you must "close" all references to it. .sp .LP -An Iomega Zip 100Mb disk cannot be formatted on an Iomega Zip250 drive. See the -Iomega web site at \fIhttp://www.iomega.com\fR for details. -.sp -.LP Concurrent I/O to devices with multiple LUNs on the same device is not supported. .sp .LP Some USB CD-RW devices may perform inadequately at their advertised speeds. To compensate, use USB CD-RW devices at lower speeds (2X versus 4X). See -\fBcdrw(1)\fR for details. +\fBcdrw\fR(1) for details. .sp .LP This driver also supports CBI devices that do not use USB interrupt pipe for diff --git a/usr/src/man/man7d/sd.7d b/usr/src/man/man7d/sd.7d index e0cbc53c7d..476a048757 100644 --- a/usr/src/man/man7d/sd.7d +++ b/usr/src/man/man7d/sd.7d @@ -3,7 +3,7 @@ .\" 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. .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SD 7D "Sep 8, 2009" +.TH SD 7D "May 13, 2017" .SH NAME sd \- SCSI disk and ATAPI/SCSI CD-ROM device driver .SH SYNOPSIS @@ -13,7 +13,6 @@ sd \- SCSI disk and ATAPI/SCSI CD-ROM device driver .fi .SH DESCRIPTION -.sp .LP To open a device without checking if the vtoc is valid, use the O_NDELAY flag. When the device is opened using O_NDELAY, the first read or write to the device @@ -21,7 +20,6 @@ that happens after the open results in the label being read if the label is not currently valid. Once read, the label remains valid until the last close of the device. Except for reading the label, O_NDELAY has no impact on the driver. .SS "SPARC" -.sp .LP The \fBsd\fR \fBSCSI\fR and \fBSCSI/ATAPI\fR driver supports embedded \fBSCSI\fR-2 and \fBCCS\fR-compatible \fBSCSI\fR disk and CD-ROM drives, @@ -36,7 +34,6 @@ describes the disk geometry and partitioning and must be present for the disk to be mounted by the system.) A volume label is not required for removable, re-writable or read-only media. .SS "x86 Only" -.sp .LP The \fBsd\fRdriver supports embedded \fBSCSI\fR-2 and \fBCCS\fR-compatible \fBSCSI \fRdisk and CD-ROM drives, \fBATAPI \fR2.6 (SFF-8020i)-compliant CD-ROM @@ -49,7 +46,6 @@ in the first physical sector of the bootable media. If the x86 hard disk contains a Solaris disk label, it is located in the second 512-byte sector of the FDISK partition. .SH DEVICE SPECIAL FILES -.sp .LP Block-files access the disk using normal buffering mechanism and are read-from and written-to without regard to physical disk records. A \fBraw\fR interface @@ -66,7 +62,6 @@ Requests that do not meet these requirements will trigger an \fBEINVAL\fR error. There are no alignment or length restrictions on I/O requests to the block device. .SH CD-ROM DRIVE SUPPORT -.sp .LP A CD-ROM disk is single-sided and contains approximately 640 megabytes of data or 74 minutes of audio. When the CD-ROM is opened, the eject button is disabled @@ -76,7 +71,6 @@ information are constant and never change. If the CD-ROM contains data recorded in a Solaris-aware file system format, it can be mounted using the appropriate Solaris file system support. .SH DVD-ROM DRIVE SUPPORT -.sp .LP DVD-ROM media can be single or double-sided and can be recorded upon using a single or double layer structure. Double-layer media provides parallel or @@ -91,7 +85,6 @@ required for a DVD-ROM. If the DVD-ROM contains data recorded in a Solaris-aware file system format, it can be mounted using the appropriate Solaris file system support. .SH ZIP/JAZ DRIVE SUPPORT -.sp .LP \fBZIP/JAZ\fR media provide varied data capacity points; a single \fBJAZ \fRdrive can store up to 2 GBytes of data, while a ZIP-250 can store up to @@ -105,7 +98,6 @@ label is required for a \fBZIP/JAZ\fR drive. If the \fBZIP/JAZ\fR drive contains data recorded in a Solaris-aware file system format, it can be mounted using the appropriate Solaris file system support. .SH DEVICE STATISTICS SUPPORT -.sp .LP Each device maintains I/O statistics for the device and for partitions allocated for that device. For each device/partition, the driver accumulates @@ -118,11 +110,9 @@ Not all device drivers make per-partition IO statistics available for reporting. \fBsd\fR and \fBssd\fR(7D) per-partition statistics are enabled by default but may disabled in their configuration files. .SH IOCTLS -.sp .LP Refer to \fBdkio\fR(7I), and \fBcdio\fR(7I) .SS "ERRORS" -.sp .ne 2 .na \fB\fBEACCES\fR\fR @@ -232,7 +222,6 @@ media. .RE .SH CONFIGURATION -.sp .LP The \fBsd\fR driver can be configured by defining properties in the \fBsd.conf\fR file. The \fBsd\fR driver supports the following properties: @@ -308,7 +297,7 @@ to 0 prevents automatic binding. The default behavior for the SPARC-based .ad .RS 27n Boolean type, when set to \fBFalse\fR, it indicates that the disk does not -support \fBpower condition\fR field in th\fBe START STOP UNIT\fR command. +support \fBpower condition\fR field in the \fBSTART STOP UNIT\fR command. .RE .sp @@ -360,7 +349,6 @@ command is used instead. .RE .SH EXAMPLES -.sp .in +2 .nf The following is an example of a global sd-config-list property: @@ -372,7 +360,6 @@ The following is an example of a global sd-config-list property: .in -2 .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/sd.conf\fR\fR @@ -440,7 +427,6 @@ partition n (0-7) .RE .SS "x86 Only" -.sp .ne 2 .na \fB\fB/dev/rdsk/cntndnpn\fR\fR @@ -462,7 +448,6 @@ Where \fIn\fR=0 the node corresponds to the entire disk. .RE .SH SEE ALSO -.sp .LP \fBsar\fR(1), \fBcfgadm_scsi\fR(1M), \fBfdisk\fR(1M), \fBformat\fR(1M), \fBiostat\fR(1M), \fBclose\fR(2), \fBioctl\fR(2), \fBlseek\fR(2), @@ -479,11 +464,7 @@ Where \fIn\fR=0 the node corresponds to the entire disk. .sp .LP \fIMt.Fuji Commands for CD and DVD, SFF8090v3\fR -.sp -.LP -http://\fIwww.sun.com/io\fR .SH DIAGNOSTICS -.sp .in +2 .nf Error for Command:\fI<command name>\fR @@ -864,7 +845,6 @@ Drive went offline; probably powered down. .RE .SH NOTES -.sp .LP DVD-ROM media containing DVD-Video data may follow/adhere to the requirements of content scrambling system or copy protection scheme. Reading of diff --git a/usr/src/man/man7d/ugen.7d b/usr/src/man/man7d/ugen.7d index bab5b5a847..cb5f430d2c 100644 --- a/usr/src/man/man7d/ugen.7d +++ b/usr/src/man/man7d/ugen.7d @@ -1,9 +1,10 @@ '\" te +.\" Copyright 2017 Peter Tribble .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH UGEN 7D "April 9, 2016" +.TH UGEN 7D "May 13, 2017" .SH NAME ugen \- USB generic driver .SH SYNOPSIS @@ -28,8 +29,8 @@ endpoint. Status is obtained by reading file descriptors created for endpoint and full device status. .sp .LP -\fBugen\fR supports control, bulk, isochronous and interrupt (in and out) -transfers. \fBlibusb\fR(3LIB) uses \fBugen\fR to access devices that do not +\fBugen\fR supports control, bulk, isochronous and interrupt (in and out) +transfers. libusb uses \fBugen\fR to access devices that do not contain drivers (such as digital cameras and PDAs). .SH BINDING .LP @@ -63,12 +64,12 @@ USB 2.0 device (usb<vid>,<pid>)... .sp .LP -where vid is the USB vendor identifier in hex and pid is the product -identifier in hex supplied by the device descriptor \fBusb_dev_descr\fR(9S). +where vid is the USB vendor identifier in hex and pid is the product +identifier in hex supplied by the device descriptor \fBusb_dev_descr\fR(9S). Note, the USB device version may vary depending on the device. .sp .LP -When using ugen for the first time, you must add the driver utilizing +When using ugen for the first time, you must add the driver utilizing \fBadd_drv\fR(1M), using a command of the following form: .sp .in +2 @@ -121,7 +122,7 @@ where cfg value is the value of bConfigurationValue in the configuration descriptor (\fBusb_cfg_descr\fR(9S)). For example "usbif1234,4567.config1.0." .sp .LP -Note that you can use update_drv to also remove bindings. Please see +Note that you can use update_drv to also remove bindings. Please see \fBupdate_drv\fR(1M) for more information. .sp .LP @@ -142,23 +143,10 @@ update_drv -a -m '* 0666 root sys' .sp .LP -Note that you can completely uninstall the \fBugen\fR driver and delete it from -the system by doing: -.sp -.in +2 -.nf -pkgrm SUNWugen -.fi -.in -2 - -.sp -.LP -Any \fBpkgadd\fR of SUNWugen after the \fBpkgrm\fR reactivates any pre-existing -ugen driver device-bindings. -.sp -.LP -Any pre-existing ugen driver device-bindings are preserved across operating -system upgrades. +Note that if you uninstall the \fBugen\fR driver, and later reinstall it, +any pre-existing ugen driver device-bindings will be reactivated. Likewise, +any pre-existing ugen driver device-bindings are preserved across operating +system updates or upgrades. .SH LOGICAL DEVICE NAME FORMAT .LP For each device or child device it manages, \fBugen\fR creates one logical @@ -181,7 +169,7 @@ first interface and as \fBif1devstat\fR to the second interface. .sp .LP Any \fBugen\fR logical device name can be held open by only one user at a time, -regardless of whether the\fB O_EXCL\fR flag passed to \fBopen\fR(2). When a +regardless of whether the \fBO_EXCL\fR flag passed to \fBopen\fR(2). When a single pipe or data source is shared by multiple logical device names, such as if[0,1]cntrl0 or if[0,1]devstat above, more than one logical device name sharing the pipe or data source can be open at a time. However, only one user @@ -884,14 +872,14 @@ interrupt-IN data endpoints, not their status endpoints.) You can monitor the device status endpoint via \fBpoll\fR(2) concurrently with the multiple interrupt-IN endpoints. Simply add another pollfd element to the pfd array in the previous code example, and initialize the new element's -\fBfd\fR field with the file descriptor of the device status endpoint (opened -without O_NONBLOCK or O_NDELAY). Set the new element's event field to POLLIN +\fBfd\fR field with the file descriptor of the device status endpoint (opened +without O_NONBLOCK or O_NDELAY). Set the new element's event field to POLLIN like the other elements. Note that only interrupt-IN endpoints and the device status endpoint can be monitored using \fBpoll\fR(2). .SH INTERRUPT-OUT TRANSFERS .LP Applications requiring output on an interrupt-OUT endpoint can open the -corresponding logical device name and perform regular UNIX I/O system calls +corresponding logical device name and perform regular UNIX I/O system calls such as \fBwrite\fR(2) and \fBaiowrite\fR(3C). .sp .LP @@ -1147,7 +1135,7 @@ The following example shows how to read an isochronous-IN endpoint: .sp .LP For an isochronous-OUT endpoint, applications use the same packet descriptor -and request structures to write request information to the \fBugen\fR node. +and request structures to write request information to the \fBugen\fR node. Following the packet request head information is the packet payload data. Upon successful return of \fBwrite\fR(2), applications can \fBread\fR(2) the same \fBugen\fR file immediately to retrieve the individual packet transfer status @@ -1430,7 +1418,7 @@ Device was disconnected. .ad .sp .6 .RS 4n -Polling was stopped as the interrupt-IN data buffer was full. Buffer is now +Polling was stopped as the interrupt-IN data buffer was full. Buffer is now empty and polling has been resumed. .RE @@ -1582,46 +1570,72 @@ No memory for the allocation of internal structures. .RE .SH FILES -.in +2 -.nf - /kernel/drv/ugen 32 bit ELF kernel module (x86 platform only) - /kernel/drv/sparcv9/ugen 64 bit ELF kernel module +.ne 2 +.na +\fB\fB/kernel/drv/ugen\fR\fR +.ad +.sp .6 +.RS 4n +32-bit ELF kernel module. (x86). +.RE - /dev/usb/<vid>.<pid>/<N>/cntrl0 - /dev/usb/<vid>.<pid>/<N>/cntrl0stat +.sp +.ne 2 +.na +\fB\fB/kernel/drv/amd64/ugen\fR\fR +.ad +.sp .6 +.RS 4n +64-bit ELF kernel module. (x86). +.RE - /dev/usb/<vid>.<pid>/<N>/if<interface#> - <in|out|cntrl><endpoint#> - /dev/usb/<vid>.<pid>/<N>/if<interface#> - <in|out|cntrl><endpoint#>stat +.sp +.ne 2 +.na +\fB\fB/kernel/drv/sparcv9/ugen\fR\fR +.ad +.sp .6 +.RS 4n +64-bit ELF kernel module. (SPARC). +.RE - /dev/usb/<vid>.<pid>/<N>/if<interface#>. - <alternate><in|out|cntrl<endpoint#> - /dev/usb/<vid>.<pid>/<N>/if<interface#>. - <alternate><in|out|cntrl><endpoint#>stat +.sp +.ne 2 +.na +/dev/usb/<vid>.<pid>/<N>/cntrl0 +/dev/usb/<vid>.<pid>/<N>/cntrl0stat - /dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#> - <in|out|cntrl><endpoint#> - /dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#> - <in|out|cntrl<endpoint#stat> +/dev/usb/<vid>.<pid>/<N>/if<interface#> + <in|out|cntrl><endpoint#> +/dev/usb/<vid>.<pid>/<N>/if<interface#> + <in|out|cntrl><endpoint#>stat - /dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#>. - <alternate><in|out|cntrl><endpoint#> - /dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#>. - <alternate><in|out|cntrl><endpoint#>stat +/dev/usb/<vid>.<pid>/<N>/if<interface#>. + <alternate><in|out|cntrl<endpoint#> +/dev/usb/<vid>.<pid>/<N>/if<interface#>. + <alternate><in|out|cntrl><endpoint#>stat +/dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#> + <in|out|cntrl><endpoint#> +/dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#> + <in|out|cntrl<endpoint#stat> - /dev/usb/<vid>.<pid>/<N>/devstat +/dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#>. + <alternate><in|out|cntrl><endpoint#> +/dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#>. + <alternate><in|out|cntrl><endpoint#>stat - /dev/usb/<vid>.<pid>/<N>/if<interface#>cntrl0 - /dev/usb/<vid>.<pid>/<N>/if<interface#>cntrl0stat -.fi -.in -2 +/dev/usb/<vid>.<pid>/<N>/devstat -.sp -.LP +/dev/usb/<vid>.<pid>/<N>/if<interface#>cntrl0 +/dev/usb/<vid>.<pid>/<N>/if<interface#>cntrl0stat +.ad +.sp .6 +.RS 4n where \fIN\fR is an integer representing the instance number of this type of device. (All logical device names for a single device share the same \fIN\fR.) +.RE + .SH ATTRIBUTES .LP See \fBattributes\fR(5) for descriptions of the following attributes: @@ -1634,12 +1648,12 @@ c | c l | l . ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Architecture PCI-based SPARC +Architecture SPARC & x86, PCI-based systems .TE .SH SEE ALSO .LP -\fBlibusb\fR(3LIB), \fBclose\fR(2), \fBpoll\fR(2), \fBread\fR(2), +\fBclose\fR(2), \fBpoll\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBaioread\fR(3C), \fBaiowrite\fR(3C), \fBusba\fR(7D), \fBusb_dev_descr\fR(9S). .SH DIAGNOSTICS diff --git a/usr/src/man/man7d/uhci.7d b/usr/src/man/man7d/uhci.7d index 0d77b5bba6..b291369a35 100644 --- a/usr/src/man/man7d/uhci.7d +++ b/usr/src/man/man7d/uhci.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH UHCI 7D "Jul 26, 2005" +.TH UHCI 7D "May 13, 2017" .SH NAME uhci \- host controller driver .SH SYNOPSIS @@ -13,7 +13,6 @@ uhci \- host controller driver .fi .SH DESCRIPTION -.sp .LP The \fBuhci\fR host controller driver is a \fBUSBA \fR (Solaris USB Architecture) compliant nexus driver that supports the \fIUniversal Host @@ -21,7 +20,6 @@ Controller Interface Specification 1.1\fR, an industry standard developed by Intel. The \fBuhci\fR driver supports all USB transfers, including interrupt, control, isochronous and bulk. .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/uhci\fR\fR @@ -58,7 +56,6 @@ Driver configuration file. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -74,7 +71,6 @@ Architecture SPARC or x86 PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBehci\fR(7D), \fBhubd\fR(7D), \fBohci\fR(7D), \fBusba\fR(7D) @@ -90,11 +86,7 @@ Architecture SPARC or x86 PCI-based systems .sp .LP \fISystem Administration Guide: Basic Administration\fR -.sp -.LP -http://\fIwww.sun.com/io\fR .SH DIAGNOSTICS -.sp .LP All host controller errors are passed to the client drivers. Root errors are documented in \fBhubd\fR(7D). diff --git a/usr/src/man/man7d/usb_ia.7d b/usr/src/man/man7d/usb_ia.7d index 9b8e74d81b..206d5c0e1e 100644 --- a/usr/src/man/man7d/usb_ia.7d +++ b/usr/src/man/man7d/usb_ia.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_IA 7D "Dec 21, 2006" +.TH USB_IA 7D "May 13, 2017" .SH NAME usb_ia \- USB interface association driver .SH SYNOPSIS @@ -18,7 +18,6 @@ interface association@unit-address .fi .SH DESCRIPTION -.sp .LP The \fBusb_ia\fR driver is a USBA (Solaris Universal Serial Bus Architecture)-compliant nexus driver that binds to a device's interface @@ -32,7 +31,6 @@ Each interface association node has a parent device node that is created by \fBusb_mid\fR(7D). (Note: attempting to export \fBugen\fR(7D) interfaces using \fBusb_ia\fR is prohibited.) .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/usb_ia\fR\fR @@ -63,7 +61,6 @@ Each interface association node has a parent device node that is created by .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -79,9 +76,8 @@ Architecture SPARC & x86 PCI-based systems .TE .SH SEE ALSO -.sp .LP -\fBattributes\fR(5),\fBugen\fR(7D), \fBusb_mid\fR(7D), \fBusba\fR(7D) +\fBattributes\fR(5), \fBugen\fR(7D), \fBusb_mid\fR(7D), \fBusba\fR(7D) .sp .LP \fIWriting Device Drivers\fR @@ -94,14 +90,7 @@ Architecture SPARC & x86 PCI-based systems .sp .LP \fIInterface Association Descriptor Engineering Change Notice (ECN)\fR\(em2003 -.sp -.LP -\fIhttp://www.sun.com/io\fR -.sp -.LP -\fIhttp://docs.sun.com\fR .SH DIAGNOSTICS -.sp .LP In addition to being logged, the following messages may appear on the system console. All messages are formatted in the following manner: diff --git a/usr/src/man/man7d/usb_mid.7d b/usr/src/man/man7d/usb_mid.7d index bcd784c2fc..6baa22f718 100644 --- a/usr/src/man/man7d/usb_mid.7d +++ b/usr/src/man/man7d/usb_mid.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_MID 7D "Dec 22, 2006" +.TH USB_MID 7D "May 13, 2017" .SH NAME usb_mid \- USB Multi Interface Driver .SH SYNOPSIS @@ -13,26 +13,23 @@ usb_mid \- USB Multi Interface Driver .fi .SH DESCRIPTION -.sp .LP The \fBusb_mid\fR driver is a \fBUSBA\fR (Solaris Universal Serial Bus -Architecture)-compliant nexus driver that binds to device level nodes of a +Architecture)-compliant nexus driver that binds to device level nodes of a composite (multi interface) device if no vendor or class-specific driver is available. The \fBusb_mid\fR driver creates interface nodes or interface association nodes and attempts to bind drivers to them. If no driver is found for interface association nodes, \fBusb_ia\fR(7D) is bound by default. .SS "UGEN (Generic USB)" -.sp .LP The \fBusb_mid\fR driver also supports a \fBugen\fR(7D) interface allowing raw -access to the device, for example by \fBlibusb\fR(3LIB) applications, by +access to the device, for example by libusb applications, by passing the drivers bound to each interface. Since a libusb application might change the state of the device, you should not access the device through the child interface drivers. Note that the \fBusb_mid\fR driver creates a ugen interface only if none of its children are explicitly bound to the \fBugen\fR(7D) driver. Additionally, \fBusb_mid\fR does not create children. .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/usb_mid\fR \fR @@ -73,7 +70,6 @@ ugen(7D) nodes. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -89,9 +85,8 @@ Architecture SPARC & x86, PCI-based systems .TE .SH SEE ALSO -.sp .LP -\fBcfgadm_usb\fR(1M), \fBlibusb\fR(3LIB), \fBattributes\fR(5), \fBusba\fR(7D), +\fBcfgadm_usb\fR(1M), \fBattributes\fR(5), \fBusba\fR(7D), \fBusb_ia\fR(7D) .sp .LP @@ -105,11 +100,7 @@ Architecture SPARC & x86, PCI-based systems .sp .LP \fISystem Administration Guide: Basic Administration\fR -.sp -.LP -http://\fIwww.sun.com/io\fR .SH DIAGNOSTICS -.sp .LP In addition to being logged, the following messages may appear on the system console. All messages are formatted in the following manner: @@ -195,7 +186,7 @@ child interface drivers.\fR .ad .sp .6 .RS 4n -No ugen interface is available and \fBlibusb\fR(3LIB) cannot work with this +No ugen interface is available and libusb cannot work with this device. .RE diff --git a/usr/src/man/man7d/usba.7d b/usr/src/man/man7d/usba.7d index 3565badc61..dfd59bb244 100644 --- a/usr/src/man/man7d/usba.7d +++ b/usr/src/man/man7d/usba.7d @@ -3,7 +3,7 @@ .\" 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. .\" 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 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.Dd October 4, 2016 +.Dd May 13, 2017 .Dt USBA 7D .Os .Sh NAME @@ -34,8 +34,7 @@ For a complete list of USBA interfaces, see or .Xr Intro 9S . .Pp -Devices without a driver may be able to leverage -.Xr libusb 3LIB . +Devices without a driver may be able to leverage libusb. .Sh FILES Listed below are drivers and modules which either utilize or are utilized by USBA. @@ -148,7 +147,6 @@ Driver is incompatible with USBA framework. .El .Sh SEE ALSO .Xr cfgadm_usb 1M , -.Xr libusb 3LIB , .Xr attributes 5 , .Xr ehci 7D , .Xr hid 7D , diff --git a/usr/src/man/man7d/usbprn.7d b/usr/src/man/man7d/usbprn.7d index 017e648cd7..b28b0a7626 100644 --- a/usr/src/man/man7d/usbprn.7d +++ b/usr/src/man/man7d/usbprn.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USBPRN 7D "April 9, 2016" +.TH USBPRN 7D "May 13, 2017" .SH NAME usbprn \- USB printer class driver .SH SYNOPSIS @@ -31,13 +31,11 @@ driver functionality. However, unlike the STREAMS-based \fBecpp\fR driver, \fBusbprn\fR is a character driver. .sp .LP -The \fBusbprn\fR driver supports all USB printer-class compliant printers. For -a list of recommended printers and USB parallel printer adapters, visit -http://\fIwww.sun.com/io\fR. +The \fBusbprn\fR driver supports all USB printer-class compliant printers. .sp .LP The \fBusbrpn\fR driver includes support for communicating with many different -printers. To use these printers, it may be nesessary to install and configure +printers. To use these printers, it may be necessary to install and configure additional format conversion packages available in the Solaris distribution. Configuration of these conversion packages under the Solaris printing system can be simplified through the use of the \fBprintmgr\fR(1M). This tool allows @@ -48,7 +46,7 @@ printer. .SS "UGEN (Generic USB)" .LP The \fBusbprn\fR driver also supports a \fBugen\fR(7D) interface allowing raw -access to the device, for example by \fBlibusb\fR(3LIB) applications, by +access to the device, for example by libusb applications, by passing the drivers bound to each interface. Because a libusb application might change the state of the device, you should not access the device through the child interface drivers. @@ -84,7 +82,7 @@ call. The captured status information is overwritten each time an ECPPIOC_TESTIO \fBioctl\fR(2) occurs. .SH IOCTLS .LP -The \fBusbprn\fR driver supports \fBprnio(7I)\fR interfaces. Note that the +The \fBusbprn\fR driver supports \fBprnio\fR(7I) interfaces. Note that the \fBPRNIOC_RESET\fR command has no effect on USB printers. .sp .LP @@ -246,14 +244,14 @@ Unlike \fBecpp\fR(7D), only the ECPP_CENTRONICS mode is currently supported in .SH READ OPERATION .LP - The \fBread\fR operation is not supported and returns \fBEIO\fR. +The \fBread\fR operation is not supported and returns \fBEIO\fR. .SH ERRORS .ne 2 .na \fB\fBEBUSY\fR\fR .ad .RS 19n - The device has been opened and another open is attempted. An attempt has been +The device has been opened and another open is attempted. An attempt has been made to unload the driver while one of the units is open. .RE @@ -373,8 +371,8 @@ Architecture SPARC, x86, PCI-based systems .SH SEE ALSO .LP \fBcfgadm_usb\fR(1M), \fBprintmgr\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), -\fBread\fR(2), \fBwrite\fR(2), \fBlibusb\fR(3LIB), \fBattributes\fR(5), -\fBbpp\fR(7D), \fBecpp\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D)\fBprnio\fR(7I), +\fBread\fR(2), \fBwrite\fR(2), \fBattributes\fR(5), +\fBbpp\fR(7D), \fBecpp\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D), \fBprnio\fR(7I), \fBattach\fR(9E) .sp .LP @@ -388,9 +386,6 @@ Architecture SPARC, x86, PCI-based systems .sp .LP \fISystem Administration Guide: Basic Administration\fR -.sp -.LP -http://\fIwww.sun.com/io\fR .SH DIAGNOSTICS .LP In addition to being logged, the following messages may appear on the system diff --git a/usr/src/man/man7d/usbsksp.7d b/usr/src/man/man7d/usbsksp.7d index c6c59ef923..80e23ae628 100644 --- a/usr/src/man/man7d/usbsksp.7d +++ b/usr/src/man/man7d/usbsksp.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USBSKSP 7D "Aug 23, 2006" +.TH USBSKSP 7D "May 13, 2017" .SH NAME usbsksp \- Keyspan USB to serial converter driver .SH SYNOPSIS @@ -32,25 +32,23 @@ the USA19HS and USA49WG models are compatible with the \fBusbsksp\fR driver and no configuration or installation steps are required. (The USA49WG model is a USB 2.0 device conforming to \fIUniversal Serial Bus Specification 2.0\fR and the USB 2.0 host controller is required to support the USA49WG model. Note that -the USA49WG is not compatible with USB 1.1 host controllers). If you use the -Keyspan USA49WLC model, you must download and install a firmware package to -enable the device to work with the \fBusbsksp\fR driver. See the Keyspan -website (\fIhttp://www.keyspan.com/downloads/sun/\fR) for more information. -Serial device streams are built with appropriate modules that are pushed atop +the USA49WG is not compatible with USB 1.1 host controllers). The Keyspan +USA49WLC model requires a firmware package that is no longer publicly available. +Serial device streams are built with appropriate modules that are pushed atop the \fBusbsksp\fR driver by the \fBautopush\fR(1M) facility. .sp .LP The \fBusbsksp\fR module supports the \fBtermio\fR(7I) device control functions specified by flags in the \fBc_cflag\fR word of the termios structure, and by -the IGNBRK, IGNPAR, PARMRK and INPCK flags in the \fBc_iflag\fR word of the +the IGNBRK, IGNPAR, PARMRK and INPCK flags in the \fBc_iflag\fR word of the termios structure. All other \fBtermio\fR(7I) functions must be performed by \fBSTREAMS\fR modules pushed atop the driver. When a device is opened, the -\fBldterm\fR(7M) and \fBttcompat\fR(7M) \fBSTREAMS\fR modules are +\fBldterm\fR(7M) and \fBttcompat\fR(7M) \fBSTREAMS\fR modules are automatically pushed on top of the stream, providing the standard \fBtermio\fR(7I) interface. .sp .LP -Use device logical names \fB/dev/term/[0-9]\fR* to access the serial ports. +Use device logical names \fB/dev/term/[0-9]\fR* to access the serial ports. These names are typically used to provide a logical access point for a dial-in line that is used with a modem. .sp @@ -58,12 +56,12 @@ line that is used with a modem. A special feature (controlled by the minor device number) is available that enables a single tty line to be connected to a modem and used for incoming and outgoing calls. By accessing through device logical name \fB/dev/cua/[0-9]\fR*, -you can open a port without the carrier detect signal being asserted, either +you can open a port without the carrier detect signal being asserted, either through hardware or an equivalent software mechanism. These devices are -commonly known as 'dial-out' lines. +commonly known as 'dial-out' lines. .sp .LP -Unlike onboard serial ports, the \fBusbsksp\fR ports cannot serve as a local +Unlike onboard serial ports, the \fBusbsksp\fR ports cannot serve as a local serial console. .SH APPLICATION PROGRAMMING INTERFACE .LP @@ -74,24 +72,24 @@ well) and carrier is detected again. A non-blocking \fB/dev/term\fR open returns an error if the \fB/dev/cua\fR is open. .sp .LP -If the \fB/dev/term\fR line is opened successfully (usually only when +If the \fB/dev/term\fR line is opened successfully (usually only when carrier is recognized on the modem), the corresponding \fB/dev/cua\fR line -cannot be opened. This allows a modem and port to be used for dial-in (by +cannot be opened. This allows a modem and port to be used for dial-in (by enabling the line for login in \fB/etc/inittab\fR) or dial-out (by \fBtip\fR(1), or \fBuucp\fR(1C)) when no one is logged in on the line. .sp .LP -Device hot-removal is functionally equivalent to a modem disconnect event, as +Device hot-removal is functionally equivalent to a modem disconnect event, as defined in \fBtermio\fR(7I). .SH IOCTLS .LP -The \fBusbsksp\fR driver supports the standard set of \fBtermio\fR(7I) ioctl +The \fBusbsksp\fR driver supports the standard set of \fBtermio\fR(7I) ioctl calls. .sp .LP -Input and output line speeds can be set to the following baud rates: 0, 50, -75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, -57600, 115200, or 230400. Input and output line speeds cannot be set +Input and output line speeds can be set to the following baud rates: 0, 50, +75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, +57600, 115200, or 230400. Input and output line speeds cannot be set independently. For example, when the output speed is set, the input speed is automatically set to the same speed. .SH ERRORS @@ -103,7 +101,7 @@ An \fBopen()\fR fails under the following conditions: \fB\fBENXIO\fR\fR .ad .RS 9n -The unit being opened does not exist. +The unit being opened does not exist. .RE .sp @@ -112,7 +110,7 @@ The unit being opened does not exist. \fB\fBEBUSY\fR\fR .ad .RS 9n -The \fB/dev/cua\fR (dial-out) device is being opened while the \fB/dev/term\fR +The \fB/dev/cua\fR (dial-out) device is being opened while the \fB/dev/term\fR (dial-in device) is open, or the dial-in device is being opened with a no-delay open while the dial-out device is open. .RE @@ -123,7 +121,7 @@ open while the dial-out device is open. \fB\fBEBUSY\fR\fR .ad .RS 9n -The unit has been marked as exclusive-use by another process with a TIOCEXCL +The unit has been marked as exclusive-use by another process with a TIOCEXCL ioctl() call. .RE @@ -237,7 +235,7 @@ and reconnect.\fR .ad .sp .6 .RS 4n -The device was hot-removed while open. A new device was hot-inserted which is +The device was hot-removed while open. A new device was hot-inserted which is not identical to the original device. Please disconnect the device and reconnect the original device to the same port. .RE @@ -250,7 +248,7 @@ reconnect the original device to the same port. .sp .6 .RS 4n The device that was hot-removed from its USB port has been re-inserted again to -the same port. It is available for access but data from a previous transfer +the same port. It is available for access but data from a previous transfer may be lost. .RE @@ -263,7 +261,7 @@ may be lost. .RS 4n This device has been disconnected because a device other than the original one has been inserted. The driver informs you of this fact by displaying the name -of the original device. +of the original device. .RE .sp @@ -275,7 +273,7 @@ Please download it from Keyspan website and install it.\fR .sp .6 .RS 4n By default, only an empty firmware package is installed for the usa49wlc model. -Please download the SUNWukspfw package from Keyspan's web site and install it. +You will need to obtain a copy of the SUNWukspfw package and install it. .RE .sp diff --git a/usr/src/man/man7d/usbvc.7d b/usr/src/man/man7d/usbvc.7d index 9ff2377634..9fe2bd332b 100644 --- a/usr/src/man/man7d/usbvc.7d +++ b/usr/src/man/man7d/usbvc.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USBVC 7D "Jul 18, 2008" +.TH USBVC 7D "May 13, 2017" .SH NAME usbvc \- USB video class driver .SH SYNOPSIS @@ -22,7 +22,6 @@ usbvc@unit-address .fi .SH DESCRIPTION -.sp .LP The \fBusbvc\fR driver is a USBA (Solaris USB Architecture)-compliant client driver that supports the \fIUSB Device Class Definition for Video Devices\fR @@ -36,17 +35,15 @@ visit \fIhttp://www.thedirks.org/v4l2\fR. .sp .LP Note that the \fBusbvc\fR driver supports the video capture function only and -that video output is not supported. For more information on supported USB -video-class devices and functions, visit \fIhttp://www.sun.com/io\fR. +that video output is not supported. .SH READING DATA -.sp .LP The \fBusbvc\fR driver reads video data from the isochronous endpoint of the device. Bulk data endpoints are not supported. .sp .LP MJPEG and UNCOMPRESSED video formats are supported. Isochronous data are read -from the isochronous input device frame-by-frame and are maintained in a +from the isochronous input device frame-by-frame and are maintained in a buffer array within the driver. Video frames are read from the driver using the \fBread\fR(2) or \fBmmap\fR(2) I/O method. For \fBread\fR(2), each read returns a buffer of a video frame. For \fBmmap\fR(2), each \fBVIDIOC_DQBUF\fR ioctl @@ -54,7 +51,6 @@ returns the buffer structure v4l2_buffer. (A video frame buffer pointer is included in the structure). See the \fIV4L2 API\fR for buffer structure and other related data structure information. .SH IOCTLS -.sp .LP A brief overview of supported ioctl requests appears below. For more detailed information, refer to the \fIV4L2 API\fR document. Note: ioctl information @@ -197,7 +193,7 @@ one input only. .ad .sp .6 .RS 4n -Set the device's current input. At this time, the \fBusbvc\fR driver supports +Set the device's current input. At this time, the \fBusbvc\fR driver supports one input only. .RE @@ -256,7 +252,6 @@ used internally by driver in read/write mode. .RE .SH ERRORS -.sp .ne 2 .na \fB\fBEBUSY\fR\fR @@ -271,7 +266,7 @@ An open was attempted after the device has already been opened. \fB\fBEINVAL\fR\fR .ad .RS 10n -An unsupported ioctl is received or an ioctl is attempted with an out-of-range +An unsupported ioctl is received or an ioctl is attempted with an out-of-range value. .RE @@ -281,7 +276,7 @@ value. \fB\fBEIO\fR\fR .ad .RS 10n -The driver received an unrecoverable device error or the device did not +The driver received an unrecoverable device error or the device did not respond or the device stalled when attempting an access. A \fBread\fR(2) or \fBioctl\fR(2) did not complete due to a peripheral access. .RE @@ -292,7 +287,7 @@ respond or the device stalled when attempting an access. A \fBread\fR(2) or \fB\fBENXIO\fR\fR .ad .RS 10n -The driver received an \fBopen\fR(2) request for a device for which the attach +The driver received an \fBopen\fR(2) request for a device for which the attach failed. .RE @@ -302,11 +297,10 @@ failed. \fBENODEV\fR .ad .RS 10n -The driver received an \fBopen\fR(2) request for a disconnected device. +The driver received an \fBopen\fR(2) request for a disconnected device. .RE .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/usbvc\fR\fR @@ -357,7 +351,6 @@ Device node for isochronous input from USB video device and device control. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -373,10 +366,9 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBcfgadm_usb\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), \fBmmap\fR(2), -\fBread\fR(2), \fBlibusb\fR(3LIB), \fBattributes\fR(5),\fBugen\fR(7D), +\fBread\fR(2), \fBattributes\fR(5), \fBugen\fR(7D), \fBusba\fR(7D), \fBattach\fR(9E) .sp .LP @@ -395,21 +387,14 @@ Architecture SPARC, x86, PCI-based systems \fIVideo4Linux2 API (V4L2), Version 0.20\fR .sp .LP -\fII/O Technologies and Solutions \(emhttp://www.sun.com/io\fR -.sp -.LP -\fIhttp://docs.sun.com\fR -.sp -.LP \fIhttp://www.usb.org\fR .sp .LP \fIhttp://www.thedirks.org/v4l2\fR .SH DIAGNOSTICS -.sp .LP In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: +console. All messages are formatted in the following manner: .sp .in +2 .nf @@ -455,7 +440,6 @@ reconnect the original device to the same port. .RE .SH NOTES -.sp .LP The USB video device will be power-managed when the device is idle. .sp @@ -466,7 +450,7 @@ you of potential data loss. Hot-removal of an active video device is strongly discouraged. .sp .LP -Always close all applications before hot-removing or hot-inserting a device. -If an application is open when a device is hot-removed, inserting the device -in a different port will create new \fB/dev/video\fR\fIN\fR links. Moving +Always close all applications before hot-removing or hot-inserting a device. +If an application is open when a device is hot-removed, inserting the device +in a different port will create new \fB/dev/video\fR\fIN\fR links. Moving an active device to another port is not recommended. diff --git a/usr/src/man/man7d/virtualkm.7d b/usr/src/man/man7d/virtualkm.7d index fc09fadb4f..03d7535ff1 100644 --- a/usr/src/man/man7d/virtualkm.7d +++ b/usr/src/man/man7d/virtualkm.7d @@ -3,7 +3,7 @@ .\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH VIRTUALKM 7D "Jan 16, 2007" +.TH VIRTUALKM 7D "May 13, 2017" .SH NAME virtualkm \- Virtual keyboard and mouse .SH SYNOPSIS @@ -33,11 +33,10 @@ virtualkm \- Virtual keyboard and mouse .fi .SH DESCRIPTION -.sp .LP A virtual keyboard or mouse is an abstraction of one or more physical keyboards -or mice (USB or PS2) connected to a system. Input streams for these physical -devices are coalesced into a single input stream and appear as a single device +or mice (USB or PS2) connected to a system. Input streams for these physical +devices are coalesced into a single input stream and appear as a single device to the upper layers. .sp .LP @@ -57,28 +56,27 @@ single mouse to the window system. Commands from applications are dispatched by the virtual keyboard/mouse facility to the underlying physical devices and will succeed provided that one of the underlying devices responds with success. For example, a single command -issued to turn on LED's will turn on corresponding LED's for all underlying +issued to turn on LED's will turn on corresponding LED's for all underlying physical keyboards. .sp .LP -Although physical keyboards/mice are linked to the virtual keyboard/mouse -facility, each may be opened separately by accessing its associated device +Although physical keyboards/mice are linked to the virtual keyboard/mouse +facility, each may be opened separately by accessing its associated device file. (For example, \fB/dev/usb/hid0\fR for a usb mouse). Directly accessing a -device file can be useful for multi-seat, \fBgok(1)\fR or similar purposes. +device file can be useful for multi-seat or similar purposes. .sp .LP -When a single physical device is opened via its associated device file, it is +When a single physical device is opened via its associated device file, it is automatically removed from the single virtual input stream. When closed, it is automatically re- coalesced into the single virtual input stream. .sp .LP Under the \fBvirtualkm\fR facility, the PS/2 mouse is coalesced into a virtual mouse single input stream and can be accessed using the \fB/dev/mouse\fR file. -(Note that in previous releases, the PS/2 mouse was accessed via the +(Note that in previous releases, the PS/2 mouse was accessed via the \fB/dev/kdmouse\fR physical device file). In the current release, you use the -\fB/dev/kdmouse\fR file to directly access the physical PS/2 mouse. +\fB/dev/kdmouse\fR file to directly access the physical PS/2 mouse. .SS "INTERFACES" -.sp .LP The virtual mouse provides the following event ID's for mouse capability changes: @@ -112,7 +110,7 @@ with other events, firm events are received using \fBread\fR(2). .sp .LP Event ID's are used by applications (including certain mouse demo applications) -that are programmed to graphically represent the actual number of buttons and +that are programmed to graphically represent the actual number of buttons and wheels on a mouse. When an application of this type receives a \fBFirm_event\fR with a ID MOUSE_CAP_CHANGE_NUM_BUT or MOUSE_CAP_CHANGE_NUM_WHEEL event, it is instructed to update its state information using the new value. Consider, for @@ -122,17 +120,16 @@ mouse. If, for example, the system has a single two-button USB mouse attached, the application, by default, will graphically display the mouse with a left and a right button. However, if a another three-button USB mouse is hot-plugged into the system, a MOUSE_CAP_CHANGE_NUM_BUT Firm event with -\fBFirm_event.value\fR of three instructs the demo application to update the +\fBFirm_event.value\fR of three instructs the demo application to update the mouse display to indicate three buttons. .SH IOCTLS -.sp .ne 2 .na \fBKIOCSETFREQ\fR .ad .RS 15n Sets the frequency for either keyboard beeper or console beeper. To set the -corresponding beeper frequency, \fIarg\fR must point to a \fBfreq_request\fR +corresponding beeper frequency, \fIarg\fR must point to a \fBfreq_request\fR structure: .sp .in +2 @@ -158,7 +155,6 @@ inclusive. .RE .SH FILES -.sp .ne 2 .na \fB\fB/dev/kbd\fR\fR @@ -204,7 +200,6 @@ Device auto-configuration file. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -220,19 +215,14 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp .LP \fBkbd\fR(1), \fBeeprom\fR(1M), \fBread\fR(2), \fBattributes\fR(5), \fBhid\fR(7D), \fBusba\fR(7D), \fBkb\fR(7M), \fBusbkbm\fR(7M), \fBusbms\fR(7M), \fBvuidmice\fR(7M) -.sp -.LP -See gok(1) in the GNOME man pages, available in the SUNWgnome package. .SH DIAGNOSTICS -.sp .LP -The messages described below may appear on the system console as well as -being logged. All messages are formatted in the following manner: +The messages described below may appear on the system console as well as +being logged. All messages are formatted in the following manner: .sp .in +2 .nf @@ -280,9 +270,8 @@ removed), it is unavailable beneath \fB/dev/mouse\fR. .RE .SH NOTES -.sp .LP -Currently, the \fBvirtualkm\fR device supports only USB and PS2 keyboards and +Currently, the \fBvirtualkm\fR device supports only USB and PS2 keyboards and mice. .sp .LP |