diff options
Diffstat (limited to 'usr/src/man')
29 files changed, 869 insertions, 643 deletions
diff --git a/usr/src/man/man1/sleep.1 b/usr/src/man/man1/sleep.1 index 4b90194707..3ee7898bfa 100644 --- a/usr/src/man/man1/sleep.1 +++ b/usr/src/man/man1/sleep.1 @@ -44,202 +44,133 @@ .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved Portions +.\" Copyright 2019 Robert Mustacchi .\" -.TH SLEEP 1 "May 13, 2017" -.SH NAME -sleep \- suspend execution for an interval -.SH SYNOPSIS -.SS "/usr/bin/sleep" -.LP -.nf -\fB/usr/bin/sleep\fR \fIseconds\fR -.fi - -.SS "ksh93" -.LP -.nf -\fBsleep\fR \fIseconds\fR -.fi - -.SH DESCRIPTION -.LP -\fBsleep\fR suspends execution for at least the time in seconds specified by -\fIseconds\fR or until a \fBSIGALRM\fR signal is received. The \fIseconds\fR -operand can be specified as a floating point number but the actual granularity -normally depends on the underlying system. -.SH OPERANDS -.SS "/usr/bin/sleep" -.LP -The following operands are supported for \fB/usr/bin/sleep\fR and \fBksh93\fR's -\fBsleep\fR built-in command: -.sp -.ne 2 -.na -\fB\fIseconds\fR\fR -.ad -.RS 11n -A non-negative floating-point number specifying the number of seconds for which -to suspend execution. The floating-point number may be specified in all formats -required by C99/XPG6, including constants such as "Inf" or "infinity". -.RE - -.SS "ksh93" -.LP -The following operands are supported: -.sp -.ne 2 -.na -\fB\fItime\fR\fR -.ad -.RS 8n -Specify \fItime\fR in seconds as a floating point number. The actual -granularity depends on the underlying system, normally around 1 millisecond. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSuspending Command Execution -.sp -.LP +.Dd September 12, 2019 +.Dt SLEEP 1 +.Os +.Sh NAME +.Nm sleep +.Nd suspend execution for an interval +.Sh SYNOPSIS +.Nm sleep +.Ar time[suffix] +.Sh DESCRIPTION +.Nm +suspends execution for at least the time in seconds specified by +.Ar time +or until a +.Dv SIGALRM +signal is received. +The +.Ar time +operand can be specified as a non-negative floating point number but the +actual granularity depends on the underlying system. +The +.Ar time +operand may be passed as a decimal or hexadecimal string. +Other floating point values such as Inf or infinity are also honored. +.Pp +A single suffix may be applied to the +.Ar time +operand to represent units other than seconds. +Supported suffixes for the +.Ar suffix +operand include: +.Bl -tag -offset indent -width 6n +.It Sy s +Represents time in seconds. +.It Sy m +Represents time in minutes. +.It Sy h +Represents time in hours. +.It Sy d +Represents time in days. +.It Sy w +Represents time in weeks. +.It Sy y +Represents time in years. +.El +.Pp +The use of suffixes is generally not portable to other systems. +.Ss Signals +If the +.Nm +program receives a signal, unless it is the +.Dv SIGALRM +signal, it will follow with the default signal handling disposition. +If such a signal would interrupt the sleep, then the program may +terminate with an error. +.Sh EXIT STATUS +The following exit values are returned: +.Bl -inset +.It Sy 0 +The execution was successfully suspended for at least +.Ar time +seconds, or a +.Dv SIGALRM +signal was received. +.It Sy >0 +An error has occurred. +.El +.Sh EXAMPLES +.Sy Example 1 +Suspending Command Execution +.Pp The following example executes a command after a certain amount of time: - -.sp -.in +2 -.nf +.Bd -literal -offset indent example% \fB(sleep 105; \fIcommand\fR)&\fR -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRExecuting a Command Every So Often -.sp -.LP +.Ed +.Pp +.Sy Example 2 +Executing a Command Every So Often +.Pp The following example executes a command every so often: - -.sp -.in +2 -.nf -example% \fBwhile true -do +.Bd -literal -offset indent +example% \fBwhile true; do \fIcommand\fR sleep 37 done\fR -.fi -.in -2 -.sp - -.LP -\fBExample 3 \fRSuspend command execution forever (or until a \fBSIGALRM\fR -signal is received) -.sp -.in +2 -.nf +.Ed +.Pp +.Sy Example 3 +Suspend command execution forever +.Po +or until a +.Dv SIGALRM +signal is received +.Pc +.Bd -literal example% sleep Inf -.fi -.in -2 -.sp - -.LP -\fBExample 4 \fRSuspending command execution for 0.5 seconds -.sp -.LP +.Ed +.Pp +.Sy Example 4 +Suspending command execution for 0.5 seconds +.Pp Suspending command execution for 0.5 seconds using an alternative -floating-point representation for the value "0.5" - -.sp -.in +2 -.nf +floating-point representation for the value "0.5". +.Bd -literal example% printf "%a\en" 0.5 0x1.0000000000000000000000000000p-01 -.fi -.in -2 -.sp - -.sp -.in +2 -.nf example% sleep 0x1.0000000000000000000000000000p-01 -.fi -.in -2 -.sp - -.SH ENVIRONMENT VARIABLES -.LP -See \fBenviron\fR(5) for descriptions of the following environment variables -that affect the execution of \fBsleep\fR: \fBLANG\fR, \fBLC_ALL\fR, -\fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. -.SH EXIT STATUS -.LP -The following exit values are returned: -.sp -.ne 2 -.na -\fB\fB0\fR\fR -.ad -.RS 6n -The execution was successfully suspended for at least \fItime\fR seconds, or a -\fBSIGALRM\fR signal was received (see NOTES). -.RE - -.sp -.ne 2 -.na -\fB\fB>0\fR\fR -.ad -.RS 6n -An error has occurred. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.SS "/usr/bin/sleep" -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -_ -Standard See \fBstandards\fR(5). -.TE - -.SS "ksh93" -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -.LP -\fBksh93\fR(1), \fBwait\fR(1), \fBalarm\fR(2), \fBsleep\fR(3C), -\fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5) -.SH NOTES -.LP -If the \fBsleep\fR utility receives a \fBSIGALRM\fR signal, one of the -following actions is taken: -.RS +4 -.TP -.ie t \(bu -.el o -Terminate normally with a zero exit status. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Effectively ignore the signal. -.RE -.sp -.LP -The \fBsleep\fR utility takes the standard action for all other signals. -.sp -.LP -The behavior for input values such as "NaN" (not-a-number) or negative values -is undefined. +.Ed +.Sh ENVIRONMENT VARIABLES +See +.Xr environ 5 +for descriptions of the following environment variables +that affect the execution of +.Nm : +.Ev LANG , +.Ev LC_ALL , +.Ev LC_MESSAGES , +.Ev LC_NUMERIC , +and +.Ev NLSPATH . +.Sh INTERFACE STABILITY +.Sy Committed +.Sh SEE ALSO +.Xr wait 1 , +.Xr alarm 2 , +.Xr nanosleep 3C , +.Xr sleep 3C , +.Xr environ 5 diff --git a/usr/src/man/man1m/Makefile b/usr/src/man/man1m/Makefile index 2152864b8d..f5683c36fd 100644 --- a/usr/src/man/man1m/Makefile +++ b/usr/src/man/man1m/Makefile @@ -60,6 +60,7 @@ _MANFILES= 6to4relay.1m \ busstat.1m \ captoinfo.1m \ catman.1m \ + ccidadm.1m \ cfgadm.1m \ cfgadm_ac.1m \ cfgadm_cardbus.1m \ diff --git a/usr/src/man/man1m/ccidadm.1m b/usr/src/man/man1m/ccidadm.1m new file mode 100644 index 0000000000..686db8cb46 --- /dev/null +++ b/usr/src/man/man1m/ccidadm.1m @@ -0,0 +1,120 @@ +.\" +.\" This file and its contents are supplied under the terms of the +.\" Common Development and Distribution License ("CDDL"), version 1.0. +.\" You may only use this file in accordance with the terms of version +.\" 1.0 of the CDDL. +.\" +.\" A full copy of the text of the CDDL should have accompanied this +.\" source. A copy of the CDDL is also available via the Internet at +.\" http://www.illumos.org/license/CDDL. +.\" +.\" +.\" Copyright 2019 Joyent, Inc. +.\" +.Dd December 17, 2019 +.Dt CCIDADM 1M +.Os +.Sh NAME +.Nm ccidadm +.Nd CCID administration utility +.Sh SYNOPSIS +.Nm /usr/lib/ccid/ccidadm +.Ar list +.Nm /usr/lib/ccid/ccidadm +.Ar atr +.Op Fl pvx +.Op Ar device +.Nm /usr/lib/ccid/ccidadm +.Ar reader +.Op Ar device +.Sh DESCRIPTION +The +.Nm +utility can be used to list the CCID controllers and their slots known to the +.Xr ccid 7D +driver, query the features and capabilities of a CCID controller, and print +the ATR of an ICC (integrated circuit card) that is inserted in a slot on an +CCID controller. +.Pp +The information returned by the hardware is printed by +.Nm +in a human-readable form were applicable. +.Sh ARGUMENTS +.Nm +expects the following kinds of arguments: +.Bl -tag -width "device" +.It Ar command +Any command +.Nm +understands. +See section +.Sx COMMANDS . +.It Ar device +Specifies a CCID reader or a slot, either as absolute path to the device node +or in a short-hand form. +The short-hand form consists of the reader instance, specified by the driver +name +.Qq ccid +followed by the instance number of the reader, and optionally a slot instance +separated by a +.Qq / , +consisting of the word +.Qq slot +followed by the slot number. +Here's an example for slot 1 on ccid reader 5: +.Qq ccid5/slot1 +.El +.Sh COMMANDS +.Bl -tag -width "" +.It Xo +.Nm +.Cm list +.Xc +Lists the CCID controllers and their slots known to the system and prints their +product name, device node, card state, and the transport protocol in use. +.It Xo +.Nm +.Cm atr +.Op Fl pvx +.Op Ar device +.Xc +Prints the ATR of an ICC that is inserted in the specified slot. +If a device is specified it must refer to a certain slot. +If no device is specified the command will print the ATR of all inserted slots +in the system. +A human-readable summary of the ATR data is printed when no flags are given. +The following options can be used to alter the output of the +.Cm atr +command:: +.Bl -tag -width Ds +.It Fl v +Verbose output, the individual bytes of the ATR are printed and decoded +bit-by-bit in a human-readable form. +Additionally the historic data in the ATR is printed as a hexadecimal dump. +.It Fl x +The complete ATR is printed as a hexadecimal dump. +.El +.It Xo +.Nm +.Cm reader +.Op Ar device +.Xc +Print the capabilities of the specified CCID reader. +Specifying slot number is not required but can optionally be specified. +If no device is given, the command will print the capabilities of all attached +CCID readers. +.El +.Sh EXIT STATUS +.Ex -std +.Sh INTERFACE STABILITY +The command line interface of +.Nm +is +.Sy Evolving . +The output of +.Nm +is +.Sy Not-an-Interface +and may change any time. +.Sh SEE ALSO +.Xr ccid 7D diff --git a/usr/src/man/man7d/Makefile b/usr/src/man/man7d/Makefile index c652a3134f..327c7b73b9 100644 --- a/usr/src/man/man7d/Makefile +++ b/usr/src/man/man7d/Makefile @@ -36,6 +36,7 @@ _MANFILES= aac.7d \ blkdev.7d \ bnxe.7d \ bscv.7d \ + ccid.7d \ chxge.7d \ console.7d \ cpuid.7d \ diff --git a/usr/src/man/man7d/audio.7d b/usr/src/man/man7d/audio.7d index 9a50a93d0d..76aa2bdf8e 100644 --- a/usr/src/man/man7d/audio.7d +++ b/usr/src/man/man7d/audio.7d @@ -3,12 +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 AUDIO 7D "Aug 3, 2009" +.TH AUDIO 7D "Jan 10, 2020" .SH NAME audio \- common audio framework .SH DESCRIPTION -.sp -.LP The \fBaudio\fR driver provides common support routines for audio devices in Solaris. .sp @@ -20,25 +18,17 @@ to be accessed with different programming interfaces. The audio framework also provides a number of facilities, such as mixing of audio streams, and data format and sample rate conversion. .SS "Overview" -.sp -.LP The audio framework provides a software mixing engine (audio mixer) for all audio devices, allowing more than one process to play or record audio at the same time. .SS "Multi-Stream Codecs" -.sp -.LP The audio mixer supports multi-stream Codecs. These devices have DSP engines that provide sample rate conversion, hardware mixing, and other features. The use of such hardware features is opaque to applications. .SS "Backward Compatibility" -.sp -.LP It is not possible to disable the mixing function. Applications must not assume that they have exclusive access to the audio device. .SS "Audio Formats" -.sp -.LP Digital audio data represents a quantized approximation of an analog audio signal waveform. In the simplest case, these quantized numbers represent the amplitude of the input waveform at particular sampling intervals. To achieve @@ -58,8 +48,6 @@ addition to the formats that the audio device supports directly, other formats provide higher data compression. Applications can convert audio data to and from these formats when playing or recording. .SS "Sample Rate" -.sp -.LP Sample rate is a number that represents the sampling frequency (in samples per second) of the audio data. .sp @@ -70,7 +58,7 @@ require compute-intensive low pass filtering. The result is that high sample rate audio streams are not degraded by filtering. .sp .LP -Sample rate conversion can be a compute-intensive operation, dependingon the +Sample rate conversion can be a compute-intensive operation, depending on the number of channels and a device's sample rate. For example, an 8KHz signal can be easily converted to 48KHz, requiring a low cost up sampling by 6. However, converting from 44.1KHz to 48KHz is computer intensive because it must be up @@ -89,8 +77,6 @@ All modern audio devices run at 48 kHz or a multiple thereof, hence just using 48 kHz can be a reasonable compromise if the application is not prepared to select higher sample rates. .SS "Encodings" -.sp -.LP An encoding parameter specifies the audiodata representation. u-Law encoding corresponds to CCITT G.711, and is the standard for voice data used by telephone companies in the United States, Canada, and Japan. A-Law encoding is @@ -106,14 +92,10 @@ which sample values are directly proportional to audio signal voltages. Each sample is a 2's complement number that represents a positive or negative amplitude. .SS "Precision" -.sp -.LP Precision indicates the number of bits used to store each audio sample. For instance, u-Law and A-Law data are stored with 8-bit precision. PCM data can be stored at various precisions, though 16-bit is the most common. .SS "Channels" -.sp -.LP Multiple channels of audio can be interleaved at sample boundaries. A sample frame consists of a single sample from each active channel. For example, a sample frame of stereo 16-bit PCM data consists of 2 16-bit samples, @@ -122,8 +104,6 @@ hardware to the maximum number of channels supported. If a mono signal is played or recorded, it is mixed on the first two (usually the left and right) channel only. Silence is mixed on the remaining channels. .SS "Supported Formats" -.sp -.LP The audio mixer supports the following audio formats: .sp .in +2 @@ -151,22 +131,12 @@ perform mixing. (This is done to allow for possible overflows to fit into 32-bits when mixing multiple streams together.) Hence, the maximum effective precision is 24-bits. .SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audio\fR\fR -.ad -.RS 29n -32-bit kernel driver module -.RE - -.sp .ne 2 .na \fB\fB/kernel/drv/amd64/audio\fR\fR .ad .RS 29n -64-bit x86 kernel driver module +Device driver (x86) .RE .sp @@ -175,7 +145,7 @@ precision is 24-bits. \fB\fB/kernel/drv/sparcv9/audio\fR\fR .ad .RS 29n -64-bit SPARC kernel driver module +Device driver (SPARC) .RE .sp @@ -184,12 +154,10 @@ precision is 24-bits. \fB\fB/kernel/drv/audio.conf\fR\fR .ad .RS 29n -\fBaudio\fR configuration file +Driver configuration file .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -206,6 +174,4 @@ Interface Stability Uncommitted .TE .SH SEE ALSO -.sp -.LP \fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBdsp\fR(7I) diff --git a/usr/src/man/man7d/av1394.7d b/usr/src/man/man7d/av1394.7d index 8fdf0652ce..53ce958979 100644 --- a/usr/src/man/man7d/av1394.7d +++ b/usr/src/man/man7d/av1394.7d @@ -3,37 +3,29 @@ .\" 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] .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.TH AV1394 7D "Apr 3, 2009" +.TH AV1394 7D "Jan 10, 2020" .SH NAME av1394 \- 1394 audio/video driver .SH SYNOPSIS -.LP .nf \fBunit@GUID\fR .fi .SH DESCRIPTION -.sp -.LP The \fBav1394\fR driver implements \fBiec61883\fR(7I) interfaces for IEEE 1394 compliant devices. .SS "Asynchronous Transactions" -.sp -.LP The driver allows applications to act as FCP controllers, but not FCP targets. Only \fBIEC61883_FCP_CMD\fR requests can be sent with \fBwrite\fR(2). Only \fBIEC61883_FCP_RESP\fR requests can be received with \fBread\fR(2). .SS "Isochronous Transactions" -.sp -.LP When the read/write method of is used for transmit, the driver is capable of auto-detecting and transmitting SD-DVCR 525/60 and 625/50 streams. See \fBiec61883\fR(7I) for details. .SH FILES -.sp .ne 2 .na -\fB\fB/dev/av/N/async\fR\fR +\fB/dev/av/N/async\fR .ad .RS 29n device node for asynchronous data @@ -42,7 +34,7 @@ device node for asynchronous data .sp .ne 2 .na -\fB\fB/dev/av/N/isoch\fR\fR +\fB/dev/av/N/isoch\fR .ad .RS 29n device node for isochronous data @@ -51,33 +43,22 @@ device node for isochronous data .sp .ne 2 .na -\fB\fBkernel/drv/sparcv9/av1394\fR\fR +\fB/kernel/drv/sparcv9/av1394\fR .ad .RS 29n -64-bit ELF kernel module +Device driver (SPARC) .RE .sp .ne 2 .na -\fB\fBkernel/drv/av1394\fR\fR +\fB/kernel/drv/amd64/av1394\fR .ad .RS 29n -32-bit ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fBkernel/drv/amd64/av1394\fR\fR -.ad -.RS 29n -64-bit ELF kernel module +Device driver (x86) .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -94,8 +75,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBread\fR(2), \fBwrite\fR(2), \fBattributes\fR(5), \fBhci1394\fR(7D), \fBiec61883\fR(7I) .sp diff --git a/usr/src/man/man7d/bnxe.7d b/usr/src/man/man7d/bnxe.7d index 78100d16eb..0696dc6c47 100644 --- a/usr/src/man/man7d/bnxe.7d +++ b/usr/src/man/man7d/bnxe.7d @@ -11,7 +11,7 @@ .\" .\" Copyright (c) 2014 QLogic Corporation. All Rights Reserved .\" -.TH BNXE 7D "Jul 17, 2014" +.TH BNXE 7D "Jan 10, 2020" .SH NAME bnxe \- QLogic NetXtreme II 10 Gigabit Ethernet Device Driver @@ -21,7 +21,6 @@ bnxe \- QLogic NetXtreme II 10 Gigabit Ethernet Device Driver .ad .SH DESCRIPTION -.LP The .B bnxe Ethernet driver is a multi-threaded, loadable, @@ -96,7 +95,7 @@ for Tx ring stats, and "stats" for general driver stats and version info. .LP -To get a list of all the individual statistics in these goups run: +To get a list of all the individual statistics in these groups run: .na % kstat -m bnxe -i 0 -l .ad @@ -117,16 +116,7 @@ Character special device /kernel/drv/bnxe.conf .ad .RS 16n -Driver configuration file. -.RE - -.sp -.ne 2 -.na -/kernel/drv/bnxe -.ad -.RS 16n -32-bit i386 driver binary. +Driver configuration file .RE .sp @@ -135,7 +125,7 @@ Driver configuration file. /kernel/drv/amd64/bnxe .ad .RS 16n -64-bit i386 driver binary. +Device driver (x86) .RE .sp @@ -144,7 +134,7 @@ Driver configuration file. /kernel/drv/sparcv9/bnxe .ad .RS 16n -SPARC driver binary. +Device driver (SPARC) .RE .SH SEE ALSO diff --git a/usr/src/man/man7d/ccid.7d b/usr/src/man/man7d/ccid.7d new file mode 100644 index 0000000000..86ada626e9 --- /dev/null +++ b/usr/src/man/man7d/ccid.7d @@ -0,0 +1,460 @@ +.\" +.\" This file and its contents are supplied under the terms of the +.\" Common Development and Distribution License ("CDDL"), version 1.0. +.\" You may only use this file in accordance with the terms of version +.\" 1.0 of the CDDL. +.\" +.\" A full copy of the text of the CDDL should have accompanied this +.\" source. A copy of the CDDL is also available via the Internet at +.\" http://www.illumos.org/license/CDDL. +.\" +.\" +.\" Copyright 2019 Joyent, Inc. +.\" +.Dd December 20, 2019 +.Dt CCID 7D +.Os +.Sh NAME +.Nm ccid +.Nd chip card interface device USB client class driver +.Sh SYNOPSIS +.In sys/usb/clients/ccid/uccid.h +.Sh INTERFACE LEVEL +.Sy Volatile +.Pp +The interfaces provided by this driver are private at this time and +subject to change. +It should not be relied upon. +.Sh DESCRIPTION +The +.Nm +driver is a USB CCID (chip card interface device) class device driver. +.Pp +The driver exposes interfaces that allow consumers to send and receive +APDUs (application protocol data unit) to a given smart card that is +plugged into a reader. +The driver also provides interfaces to obtain status information, the +ATR (answer to reset), and obtain exclusive access to the device. +In addition, the system exposes control of CCID devices through +.Xr cfgadm 1M . +.Ss Supported Devices +The CCID specification allows for readers to come in different flavors. +These different flavors support different communication protocols and +have different levels of automation for determining the protocol and +transfers that are required. +.Pp +At this time, only the short APDU protocol is supported, which also works with +readers using the extended APDU protocol. +TPDU and character level readers are not supported by the driver. +Readers in this category will still attach; however, +I/O cannot be performed to them. +.Pp +In addition, at this time the driver does not support devices which +require manually setting the clock and data rates to support an ICC. +.Ss Device Model +Each CCID class device provides a number of slots. +Each slot may have an independent ICC (integrated circuit card or Smart +Card) inserted into it. +Each device, or reader, has its own directory under +.Pa /dev/ccid +based on its device number. +Inside of each directory is a character device for each slot. +A slot exists regardless of whether or not an ICC is inserted into it. +As long as a CCID device is present in the system, its device nodes will +be present. +.Pp +Slots are enumerated using this pattern: +.Pa /dev/ccid/ccid%instance/slot%slot . +.Pp +For example, all the slots that belong to CCID instance 5 will be +enumerated under the directory +.Pa /dev/ccid/ccid5 . +Slots are numbered starting at zero for each reader and increment from +there. +For example, the second physical slot would be numbered as slot one. +If this were on CCID instance zero, then we would find a character +device at: +.Pa /dev/ccid/ccid0/slot1 . +.Pp +To enumerate all of the ccid devices present on the system, one could +read all of the directories under +.Pa /dev/ccid . +To enumerate all of the slots on a device, one could read all of the +device nodes under a particular CCID device, such as: +.Pa /dev/ccid/ccid0 . +The number of slots is also obtainable through various ioctls that will +be discussed later on. +It's important to note that while slot numbering will always be +consistent for a given device, the CCID numbering is based on the driver +instance. +Therefore, it is possible for a device to change device numbers. +To deal with this, symlinks based on other properties will be provided +(for example, the USB serial number). +.Pp +All of the CCID devices in the system can also be listed by using the +.Xr ccidadm 1M +command. +.Ss I/O Model +To send and receive responses to commands, a program must open up the +corresponding slot's device node. +In many of the commands that use an ICC, there is a logical notion of +state associated with the ICC that is mutated by performing commands on +it. +For example, a command might be issued that uses a PIN to unlock a slot +or that selects a particular PIV applet for use. +Because of this, all I/O to a given device must be performed inside the +context of a transaction. +When a program begins a transaction, it is guaranteed that no one else +may send commands to the ICC. +When a program is finished, it must explicitly end the transaction, +which may have the side effect of resetting the ICC. +If a program with an open transaction crashes or closes the file +descriptor without taking other actions, then the transaction will be +automatically closed. +Without a transaction open, it will still be possible to issue ioctls +that obtain the status of the slot and the reader. +.Pp +While in an active transaction, a program may send commands to a card. +Sending a command and reading a response are done through the +traditional +.Xr read 2 +and +.Xr write 2 +family of system calls. +To submit a command, the program would issue a +.Xr write 2 +family system call that contained the payload to send to the ICC. +Once submitted, the call would return and the program would be able to +issue a +.Xr read 2 +system call to obtain the results. +Once a command has been submitted, it is illegal to submit another one. +The next command cannot be submitted until the response has been fully +consumed. +Similarly, if a command has not been submitted, one cannot issue a +.Xr read 2 +system call to obtain results. +Only a single thread may be blocked waiting to submit a command or +read a response. +.Pp +To facilitate non-blocking operation, the underlying file descriptor may +be opened with +.Dv O_NONBLOCK . +.Pp +While a transaction is active, +.Xr poll 2 +may be used to receive status information about the slot. +The following events are used by +.Nm : +.Bl -tag -width POLLRDNORM +.It Dv POLLOUT +The device is ready to receive a command using +.Xr write 2 . +.It Dv POLLIN, POLLRDNORM +The device has completed a command the results may be retrieved with +.Xr read 2 . +.It Dv POLLHUP +The card has been removed from the slot. +.It Dv POLLERR +An hardware error has occurred, or the CCID reader has been disconnected. +.El +.Pp +If +.Xr poll 2 +is called while no transaction is active, none of these events will ever occur +and +.Xr poll 2 +may block indefinitely if no timeout is given. +.Pp +One important note is that readers with multiple slots often still only +allow I/O a single command to be outstanding across all of the slots in +the system. +Because transactions are on a per-slot basis, it is still possible for a +command submission to block even though one has a transaction open. +.Pp +While a transaction is open, various events can occur that cause a fatal +error on the transaction. +These include: +.Bl -bullet -offset indent +.It +USB CCID reader removed +.It +ICC removed +.It +A fatal error while communicating to the device +.It +An administrator issued an ioctl to power off or reset the ICC +.El +.Pp +Once such a fatal error has occurred, all new I/O will fail though it +will still be possible to read any successfully completed commands. +To clear the error state the program will need to end the transaction +and begin a new one or close the file descriptor if the device has been +removed. +.Ss Opening Devices, Exclusive Access, and Performing I/O +To perform I/O to a particular card, one must first open the slot of +interest. +Opening the slot requires that the process be in the global zone and +that it have the privilege +.Sy PRIV_SYS_DEVICES . +The device node can be opened through the +.Xr open 2 +or +.Xr openat 2 +system calls. +For programs that just want to query the slot status using the +.Dv UCCID_CMD_STATUS +command, opening the device node read-only is sufficient. +All other uses require that the device be opened both for reading and +writing +.Po Dv O_RDWR Pc . +.Pp +Once the device has been opened, the program may issue ioctls to get +status information. +.Pp +To perform general I/O to the card, a program must be in the context of +a transaction as discussed in the +.Sx I/O model +section. +To open a transaction, a program must issue the +.Dv UCCID_CMD_TXN_BEGIN +command through the +.Xr ioctl 2 +system call. +.Pp +When a program is done, it must issue the +.Dv UCCID_CMD_TXN_END +command to release the transaction. +As part of issuing the command, the program must determine a disposition +of what it would like done with the card when it has completed. +These options include leaving the ICC alone and resetting the ICC. +For many use cases, such as those where a pin is entered or the ICC's +state is mutated, a reset is the recommended option. +If the program crashes or closes the file descriptor without issuing a +transaction end, then the ICC will be reset. +.Pp +Please see the ioctl listing in the +.Sx IOCTLS +section for more information on the command structure. +.Pp +If a multi-threaded application opens a slot once and shares it among multiple +threads performing I/O to that slot, there can still only be one transaction +active or waiting on the slot shared by all threads. +Acquiring another transaction on the same slot minor while another thread is +already blocked waiting for one will return +.Dv EINPROGRESS . +If another transaction is already active, +.Dv EINVAL +will be returned. +Consequently, all threads in a multi-threaded application share the transaction +state and may issue writes, and read the results. +The same applies to any other method of sharing an open file descriptor of a slot +minor, be it by sharing the fd over a socket, a child process inheriting it from +its parent during +.Xr fork 2 , +even across calls to +.Xr exec 2 . +.Ss Device Status and ATR +Once a slot has been opened, any caller may issue commands to get the +status of the slot. +This can also be used to obtain the ATR (answer to reset) of an ICC that +is present on the slot, if it is known. +.Pp +While exclusive access is not required to issue these commands, there is +no guarantee that they will not have changed between the time that the +program issued the command and it obtains a transaction. +.Pp +To obtain information about the reader, slot, and the ATR, one should +issue the +.Dv UCCID_CMD_STATUS +command. +Please see the ioctl listing in the +.Sx IOCTLS +section for more information. +.Sh IOCTLS +This section lists the different commands that may be issued to a CCID +device through the +.Xr ioctl 2 +system call. +.Ss Ic UCCID_CMD_STATUS +This command is used to obtain the status of the slot. +It may be used regardless of whether or not the caller has exclusive access. +.Pp +The +.Ic UCCID_CMD_STATUS +command uses the structure +.Vt uccid_cmd_status_t , +the fields of which have the following meanings: +.Bl -tag -width Fa +.It Fa uint32_t ucs_version +Indicates the current version of the structure. +Should be set to +.Dv UCCID_CURRENT_VERSION . +.It Fa uint32_t ucs_status +This value is ignored when issuing the command. +On return, it will be filled in with various flags that describe the +current status of the slot and the contents returned in the +.Vt uccid_cmd_status_t . +The following flags are defined: +.Bl -tag -width Dv +.It Dv UCCID_STATUS_F_CARD_PRESENT +A card has been inserted into the slot of the CCID class device. +.It Dv UCCID_STATUS_F_CARD_ACTIVE +The inserted card has been successfully activated. +This will only be set if the +.Dv UCCID_STATUS_F_CARD_PRESENT +flag is also set. +.It Dv UCCID_STATUS_F_PRODUCT_VALID +The contents of +.Fa ucs_product +are valid. +.It Dv UCCID_STATUS_F_SERIAL_VALID +The contents of +.Fa ucs_serial +are valid. +.It Dv UCCID_STATUS_F_PARAMS_VALID +The parameters returned in +.Fa ucs_params +are valid. +.El +.It Fa int32_t ucs_instance +The instance number of the CCID device. +.It Fa uint32_t ucs_slot +The slot number currently in use. +.It Fa uint8_t ucs_atr[UCCID_ATR_MAX] +The ATR (answer to reset) of the card. +.It Fa uint8_t ucs_atrlen +The actual length of the ATR data. +A length of 0 indicates that there is no ATR data. +.It Fa int8_t ucs_product[256] +The product string of the CCID device. +.It Fa int8_t ucs_serial[256] +The serial number of the CCID device. +.It Fa ccid_class_descr_t ucs_class +The CCID class descriptor of the CCID device. +.It Fa uccid_prot_t ucs_prot +The protocol in use by the ICC. +This can be either +.Dv UCCID_PROT_T0 +for the TPDU T=0 protocol or +.Dv UCCID_PROT_T1 +for the TPDU T=1 protocol. +.It Fa ccid_params_t ucs_params +The CCID parameters available on the card. +.El +.Ss UCCID_CMD_TXN_BEGIN +This command is used to begin a transaction. +The command will block until exclusive access is available to the +caller. +If the caller does not wish to block, it should set the +.Dv UCCID_TXN_DONT_BLOCK +flag. +.Pp +The command uses the structure +.Vt uccid_cmd_txn_begin_t +with the following members: +.Bl -tag -width Fa +.It Fa uint32_t ucs_version +Indicates the current version of the structure. +Should be set to +.Dv UCCID_CURRENT_VERSION . +.It Fa uint32_t uct_flags +Flags that impact the behavior of the command. +The following flags are defined: +.Bl -tag -width Dv +.It Dv UCCID_TXN_DONT_BLOCK +The command should not block for exclusive access. +If exclusive access is not available, then the command will fail +immediately. +.El +.Pp +If an unknown flag is specified, an error will be returned. +.El +.Ss UCCID_CMD_TXN_END +The +.Dv UCCID_CMD_TXN_END +command is used to end a transaction and relinquish exclusive access +to the ICC. +.Pp +The command uses the structure +.Vt uccid_cmd_txn_end_t +with the following members: +.Bl -tag -width Fa +.It Fa uint32_t uct_version +Indicates the current version of the structure. +Should be set to +.Dv UCCID_CURRENT_VERSION . +.It Fa uint32_t uct_flags +.Bl -tag -width Dv +.It Dv UCCID_TXN_END_RESET +The ICC should be reset at the end of the transaction. +.It Dv UCCID_TXN_END_RELEASE +The ICC should be released without being reset at the end of the +transaction. +.El +.Pp +Exactly one of these two flags must be specified. +It is an error if neither flag or both flags are specified at the same +time. +If the device is closed without ending a transaction first, then the ICC +will be reset. +.El +.Ss UCCID_CMD_ICC_MODIFY +This command can be used to change the state of an ICC, if present. +.Pp +The command uses the structure +.Vt uccid_cmd_icc_modify_t +with the following members: +.Bl -tag -width Fa +.It Fa uint32_t uci_version +Indicates the current version of the structure. +Should be set to +.Dv UCCID_CURRENT_VERSION . +.It Fa uint32_t uci_action +The action to be taken on the ICC. +The following actions are defined: +.Bl -tag -width Dv +.It Dv UCCID_ICC_POWER_ON +Power on the ICC. +.It Dv UCCID_ICC_POWER_OFF +Power off the ICC. +.It Dv UCCID_ICC_WARM_RESET +Perform a warm reset of the ICC. +.El +.El +.Ss FIONREAD +This command returns the size in bytes of a command response available +for reading with +.Xr read 2 . +The size is returned in an +.Vt int +pointed to by the argument. +.Sh SYSTEM CALLS +This section lists the different system calls that may be issued to a +CCID device. +.Ss open +.Ss close +.Ss write +.Ss read +.Ss poll +.Sh SEE ALSO +.Xr ccidadm 1M , +.Xr cfgadm 1M , +.Xr close 2 , +.Xr ioctl 2 , +.Xr open 2 , +.Xr poll 2 , +.Xr read 2 , +.Xr write 2 +.Rs +.%T Universal Serial Bus Device Class: Smart Card CCID +.%O Revision 1.1 +.%D April 22, 2005 +.Re +.Rs +.%Q ISO/IEC +.%B Identification Cards - Integrated Circuits +.%N Part 3: Cards with contacts — Electrical interface and transmission protocols +.%O ISO/IEC 7616-3:2006 +.%D 2006 +.Re diff --git a/usr/src/man/man7d/coretemp.7d b/usr/src/man/man7d/coretemp.7d index 2ac1008e55..d194d02fde 100644 --- a/usr/src/man/man7d/coretemp.7d +++ b/usr/src/man/man7d/coretemp.7d @@ -11,7 +11,7 @@ .\" .\" Copyright 2019, Joyent, Inc. .\" -.Dd March 20, 2019 +.Dd January 10, 2020 .Dt CORETEMP 7D .Os .Sh NAME @@ -28,7 +28,7 @@ Currently, the .Nm driver supports Intel Core family processors after Penryn microarchitecture and Intel Atom processors starting with the Silvermont -microarchitecure. +microarchitecture. .Pp Temperature information is available to the system via the fault management architecture diff --git a/usr/src/man/man7d/dcam1394.7d b/usr/src/man/man7d/dcam1394.7d index 22ad775895..c1323c8a8f 100644 --- a/usr/src/man/man7d/dcam1394.7d +++ b/usr/src/man/man7d/dcam1394.7d @@ -3,24 +3,19 @@ .\" 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 DCAM1394 7D "May 19, 2004" +.TH DCAM1394 7D "Jan 10, 2020" .SH NAME dcam1394 \- 1394-based digital camera (IIDC) driver .SH SYNOPSIS -.LP .nf \fB#include <sys/dcam/dcam1394_io.h>\fR .fi .SH DESCRIPTION -.sp -.LP The \fBdcam1394\fR driver supports devices implementing the \fI1394 Trade Association Digital Camera Specification\fR (also referred to as the IIDC specification). Only a subset of the specification is supported. .SH READING DATA -.sp -.LP Isochronous data is read from the driver frame-by-frame and is maintained within the driver in a ring buffer. .sp @@ -48,8 +43,6 @@ The size to allocate for the structure is determined by the video mode for which the camera is configured. Possible values for the vid_mode field are listed under DCAM1394_PARAM_VID_MODE below. .SH IOCTL REQUESTS -.sp -.LP The following ioctl requests are supported: .sp .ne 2 @@ -116,7 +109,7 @@ Gets a list of parameters associated with a camera. The argument is a pointer to a \fBdcam1394_param_list_t\fR structure (described below). The parameter list is accessed through macros defined below. .sp -The paramter list only supports Format 1 video formats. +The parameter list only supports Format 1 video formats. .RE .sp @@ -130,7 +123,7 @@ Sets a list of parameters associated with a camera. The argument is a pointer to a \fBdcam1394_param_list_t structure\fR (described below). The parameter list is accessed through macros defined below. .sp -The paramter list only supports Format 1 video formats. +The parameter list only supports Format 1 video formats. .RE .sp @@ -177,8 +170,6 @@ Reset frame sequence number. .RE .SH PARAMETER LIST ACCESS -.sp -.LP The parameter list is initialized and access through macros. The data type for the parameter list is \fBdcam1394_param_list_t\fR. .sp @@ -249,8 +240,6 @@ Indicates if a specific parameter is successfully set. When no subparam value is required, the value DCAM1394_SUBPARAM_NONE may be used. .SH PARAMETERS -.sp -.LP The following parameters may appear in the list: .sp .ne 2 @@ -896,10 +885,9 @@ DCAM1394_PARAM_BRIGHTNESS. .RE .SH DEVICE SPECIAL FILES -.sp .ne 2 .na -\fB\fB/dev/dcam\fIN\fR\fR\fR +\fB/dev/dcam\fIN\fR\fR .ad .RS 17n Device node for isochronous input from camera. @@ -908,36 +896,33 @@ Device node for isochronous input from camera. .sp .ne 2 .na -\fB\fB/dev/dcamctl\fIN\fR\fR\fR +\fB/dev/dcamctl\fIN\fR\fR .ad .RS 17n Device node for camera control. .RE .SH FILES -.sp .ne 2 .na -\fB\fBkernel/drv/sparcv9/dcam1394\fR\fR +\fB/kernel/drv/sparcv9/dcam1394\fR .ad .sp .6 .RS 4n -64-bit ELF kernel module. +Device driver (SPARC) .RE .sp .ne 2 .na -\fB\fBkernel/drv/dcam1394\fR\fR +\fB/kernel/drv/amd64/dcam1394\fR .ad .sp .6 .RS 4n -32-bit ELF kernel module. +Device driver (x86) .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -952,8 +937,6 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBhci1394\fR(7D) .sp .LP diff --git a/usr/src/man/man7d/ecpp.7d b/usr/src/man/man7d/ecpp.7d index 9c81264ef1..7d10e4ee9c 100644 --- a/usr/src/man/man7d/ecpp.7d +++ b/usr/src/man/man7d/ecpp.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 ECPP 7D "May 13, 2017" +.TH ECPP 7D "Jan 10, 2020" .SH NAME ecpp \- IEEE 1284 compliant parallel port driver .SH SYNOPSIS -.LP .nf #include <sys/types.h> .fi @@ -23,7 +22,6 @@ ecpp@unit-address .fi .SH DESCRIPTION -.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 Centronics devices. In addition to the Centronics protocol, the \fBecpp\fR @@ -48,7 +46,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" -.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 \fBwrite_timeout\fR period is set to 90 seconds. @@ -71,8 +68,7 @@ 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" -.LP - Characteristics of the \fBecpp\fR driver may be tuned by the variables +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 kernel during system startup. To tune the variables, edit the \fBecpp.conf\fR file and invoke \fBupdate_drv\fR(1M) to have the kernel read the file again. @@ -83,12 +79,10 @@ 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" -.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" -.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 data, the content of the status bits will be captured at the time of the error @@ -96,7 +90,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" -.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 port that has no data currently available, \fBread\fR(2) returns \fB0\fR if @@ -104,7 +97,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 -.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 to the device before processing the \fBioctl\fR(2) call. @@ -340,7 +332,7 @@ bits are reserved. Reading reserved bits always return 1. An attempt to write \fB\fB/dev/lp\fIN\fR\fR\fR .ad .RS 19n -Solaris x86 only. (Backwards compatibility with former \fBlp\fR(7D) devices.) +x86 only. (Backwards compatibility with former \fBlp\fR(7D) devices.) .RE .sp @@ -355,61 +347,31 @@ Solaris x86 only. (Backwards compatibility with former \fBlp\fR(7D) devices.) .SH FILES .ne 2 .na -\fB\fBkernel/drv/ecpp\fR\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fBkernel/drv/sparcv9/ecpp\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fBkernel/drv/amd64/ecpp\fR\fR +\fB/kernel/drv/sparcv9/ecpp\fR .ad .sp .6 .RS 4n -64-bit x86 ELF kernel module +Device driver (SPARC) .RE .sp .ne 2 .na -\fB\fBkernel/drv/ecpp.conf\fR\fR +\fB/kernel/drv/amd64/ecpp\fR .ad .sp .6 .RS 4n -driver configuration file +Device driver (x86) .RE .sp .ne 2 .na -\fB\fBkernel/drv/sparcv9/ecpp.conf\fR\fR +\fB/kernel/drv/ecpp.conf\fR .ad .sp .6 .RS 4n -driver configuration file for 64-bit SPARC -.RE - -.sp -.ne 2 -.na -\fB\fBkernel/drv/amd64/ecpp.conf\fR\fR -.ad -.sp .6 -.RS 4n -driver configuration file for 64-bit x86 +Driver configuration file .RE .SH ERRORS @@ -468,7 +430,6 @@ peripheral error. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -487,7 +448,6 @@ Interface stability Evolving .TE .SH SEE ALSO -.LP \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) diff --git a/usr/src/man/man7d/ehci.7d b/usr/src/man/man7d/ehci.7d index a1a9a3efb8..b9ba26cf3d 100644 --- a/usr/src/man/man7d/ehci.7d +++ b/usr/src/man/man7d/ehci.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 EHCI 7D "May 13, 2017" +.TH EHCI 7D "Jan 10, 2020" .SH NAME ehci \- Enhanced host controller driver .SH SYNOPSIS -.LP .nf \fBusb@unit-address\fR .fi .SH DESCRIPTION -.LP The \fBehci\fR driver is a USBA (Solaris USB Architecture) compliant nexus driver that supports the Enhanced Host Controller Interface Specification 2.0, an industry standard developed by Intel. @@ -35,24 +33,15 @@ 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 isochronous transfers (on USB1.\fIx\fR devices behind a USB2.0 hub). .SH FILES .ne 2 .na -\fB\fB/kernel/drv/ehci\fR\fR -.ad -.RS 28n -32-bit ELF 86 kernel module -.RE - -.sp -.ne 2 -.na \fB\fB/kernel/drv/sparcv9/ehci\fR\fR .ad .RS 28n -64-bit SPARC ELF kernel module +Device driver (SPARC) .RE .sp @@ -61,7 +50,7 @@ The \fBehci\fR supports bulk, interrupt, control and iso chronous transfers \fB\fB/kernel/drv/amd64/ehci\fR\fR .ad .RS 28n -64-bit x86 ELF kernel module +Device driver (x86) .RE .sp @@ -74,7 +63,6 @@ Driver configuration file .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -89,7 +77,6 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.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), \fBusba\fR(7D) @@ -112,7 +99,6 @@ Architecture SPARC, x86, PCI-based systems .LP \fIhttp://www.intel.com/technology/usb/ehcispec.htm\fR .SH DIAGNOSTICS -.LP In addition to being logged, the following messages may appear on the system console. All messages are formatted in the following manner: .sp @@ -204,7 +190,7 @@ comment out a property in ehci.conf. (x86 only). 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 +or your system administrator for possible changes in BIOS settings. You can disable a property in \fBehci.conf\fR to ignore this failure. (x86 only.) .RE diff --git a/usr/src/man/man7d/elxl.7d b/usr/src/man/man7d/elxl.7d index cc49101dbd..a6d3d3bf64 100644 --- a/usr/src/man/man7d/elxl.7d +++ b/usr/src/man/man7d/elxl.7d @@ -20,7 +20,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE .\" -.Dd "Aug 7, 2014" +.Dd "Jan 10, 2020" .Dt ELXL 7D .Os .Sh NAME @@ -60,7 +60,7 @@ media options on the device: .Lp .Bl -tag -compact -offset indent -width Sy .It Sy mii -Media Indendent Interface (MII), also 100BASE-TX +Media Independent Interface (MII), also 100BASE-TX .It Sy tp-hdx 10 Mbps twisted pair, half-duplex .It Sy tp-fdx diff --git a/usr/src/man/man7d/fcoe.7d b/usr/src/man/man7d/fcoe.7d index 3a8e290139..a3354b5649 100644 --- a/usr/src/man/man7d/fcoe.7d +++ b/usr/src/man/man7d/fcoe.7d @@ -3,50 +3,37 @@ .\" 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] .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.TH FCOE 7D "Mar 18, 2009" +.\" Copyright 2020 Peter Tribble. +.TH FCOE 7D "Jan 10, 2020" .SH NAME fcoe \- fibre channel over Ethernet transport driver .SH DESCRIPTION -.sp -.LP The \fBfcoe\fR driver is a pseudo nexus driver which supports the -transportation of FCoE encapsualted frames. FCoE Ethernet frame will +transportation of FCoE encapsulated frames. FCoE Ethernet frame will encapsulate the raw Fibre Channel frame. .sp .LP The \fBfcoe\fR driver interfaces with FCoE target mode device driver, \fBfcoet\fR(7D). .SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fcoe\fR\fR -.ad -.RS 26n -32-bit ELF kernel module (x86) -.RE - -.sp .ne 2 .na -\fB\fB/kernel/drv/amd64/fcoe\fR\fR +\fB/kernel/drv/amd64/fcoe\fR .ad .RS 26n -64-bit ELF kernel module (x86) +Device driver (x86) .RE .sp .ne 2 .na -\fB\fBkernel/drv/sparcv\fR\fR +\fB/kernel/drv/sparcv9/fcoe\fR .ad .RS 26n -64-bit ELF kernel module (SPARC) +Device driver (SPARC) .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attribute: .sp @@ -61,8 +48,6 @@ Architecture SPARC, x86 .TE .SH SEE ALSO -.sp -.LP \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcoet\fR(7D) .sp .LP diff --git a/usr/src/man/man7d/fcoei.7d b/usr/src/man/man7d/fcoei.7d index 1b08d363f1..2835290d9e 100644 --- a/usr/src/man/man7d/fcoei.7d +++ b/usr/src/man/man7d/fcoei.7d @@ -2,11 +2,10 @@ .\" Copyright (c) 2009, 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 FCOEI 7D "Sep 11, 2009" +.TH FCOEI 7D "Jan 10, 2020" .SH NAME fcoei \- Fibre Channel Over Ethernet Initiator Mode Driver .SH SYNOPSIS -.sp .in +2 .nf fcoei@port,0 @@ -14,8 +13,6 @@ fcoei@port,0 .in -2 .SH DESCRIPTION -.sp -.LP The \fBfcoei\fR driver is a pseudo device driver which encapsulates the raw Fibre Channel frames into FCoE ethernet frames, or decapsulates FC frames from FCoE ethernet frames. The supported FC frames include extended/basic link @@ -25,36 +22,24 @@ services, common transport frames and initiator mode FCP frames. The \fBfcoei\fR driver interfaces with the Sun Fibre Channel port driver, \fBfp\fR(7D), and the FCoE transport driver, \fBfcoe\fR(7D). .SH FILES -.sp .ne 2 .na -\fB\fB/kernel/drv/fcoei\fR\fR +\fB/kernel/drv/amd64/fcoei\fR .ad .RS 27n -32-bit ELF kernel module (x86) +Device driver (x86) .RE .sp .ne 2 .na -\fB\fB/kernel/drv/amd64/fcoei\fR\fR +\fB/kernel/drv/sparcv9/fcoei\fR .ad .RS 27n -64-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fBkernel/drv/sparcv/fcoei\fR\fR -.ad -.RS 27n -64-bit ELF kernel module (SPARC) +Device driver (SPARC) .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attribute: .sp @@ -69,8 +54,6 @@ Architecture SPARC, x86 .TE .SH SEE ALSO -.sp -.LP \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcoe\fR(7D), \fBfcoet\fR(7D), \fBfp\fR(7D) .sp diff --git a/usr/src/man/man7d/fcoet.7d b/usr/src/man/man7d/fcoet.7d index 53da09f911..dd604f360b 100644 --- a/usr/src/man/man7d/fcoet.7d +++ b/usr/src/man/man7d/fcoet.7d @@ -3,51 +3,37 @@ .\" 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] .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.TH FCOET 7D "Mar 18, 2009" +.TH FCOET 7D "Jan 10, 2020" .SH NAME fcoet \- fibre channel over Ethernet target mode driver .SH DESCRIPTION -.sp -.LP The \fBfcoet\fR driver is a pseudo device driver which encapsulates the raw Fibre Channel frames into FCoE Ethernet frames, or decapsulates FC frames from FCoE Ethernet frames. The supported FC frames contain extended/basic link services, common transport frames and target mode FCP frames. .sp .LP -The \fBfcoet\fR driver interfaces with COMSTAR FC transport driver,\fBfct\fR, +The \fBfcoet\fR driver interfaces with COMSTAR FC transport driver, \fBfct\fR, and FCoE transport driver, \fBfcoe\fR(7D). .SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fcoet\fR\fR -.ad -.RS 29n -32-bit ELF kernel module (x86) -.RE - -.sp .ne 2 .na -\fB\fB/kernel/drv/amd64/fcoet\fR\fR +\fB/kernel/drv/amd64/fcoet\fR .ad .RS 29n -64-bit ELF kernel module (x86) +Device driver (x86) .RE .sp .ne 2 .na -\fB\fB/kernel/drv/sparcv9/fcoet\fR\fR +\fB/kernel/drv/sparcv9/fcoet\fR .ad .RS 29n -64-bit ELF kernel module (SPARC) +Device driver (SPARC) .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -62,8 +48,6 @@ Architecture SPARC, x86 .TE .SH SEE ALSO -.sp -.LP \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcoe\fR(7D) .sp .LP diff --git a/usr/src/man/man7d/hci1394.7d b/usr/src/man/man7d/hci1394.7d index 8eea798743..34ac56762f 100644 --- a/usr/src/man/man7d/hci1394.7d +++ b/usr/src/man/man7d/hci1394.7d @@ -3,43 +3,29 @@ .\" 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 HCI1394 7D "Aug 30, 2005" +.TH HCI1394 7D "Jan 10, 2020" .SH NAME hci1394 \- 1394 OpenHCI host controller driver .SH SYNOPSIS -.LP .nf \fBfirewire@unit-address\fR .fi .SH DESCRIPTION -.sp -.LP The \fBhci1394\fR host controller driver is an IEEE 1394 compliant nexus driver that supports the \fI1394 Open Host Controller Interface Specification 1.0\fR, an industry standard developed by Sun, Apple, Compaq, Intel, Microsoft, -National Semconductor, and Texas Instruments. The \fBhci1394\fR driver supports +National Semiconductor, and Texas Instruments. The \fBhci1394\fR driver supports asynchronous transfers, isochronous transfers, and bus reset management. The \fBhci1394\fR driver also supports the nexus device control interface. .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/sparcv9/hci1394\fR\fR .ad .sp .6 .RS 4n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/hci1394\fR\fR -.ad -.sp .6 -.RS 4n -32-bit x86 ELF kernel module +Device driver (SPARC) .RE .sp @@ -49,12 +35,10 @@ asynchronous transfers, isochronous transfers, and bus reset management. The .ad .sp .6 .RS 4n -64-bit x86 ELF kernel module +Device driver (x86) .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -71,8 +55,6 @@ Interface Stability Unstable .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBieee1394\fR(7D) .sp .LP diff --git a/usr/src/man/man7d/i40e.7d b/usr/src/man/man7d/i40e.7d index f025fba01a..81ab257f6e 100644 --- a/usr/src/man/man7d/i40e.7d +++ b/usr/src/man/man7d/i40e.7d @@ -11,7 +11,7 @@ .\" .\" Copyright (c) 2018 Joyent, Inc. .\" -.Dd May 23, 2018 +.Dd Jan 10, 2020 .Dt I40E 7D .Os .Sh NAME @@ -64,7 +64,7 @@ is recommended. Each instance is assigned a unique ascending integer identifier. A device which has multiple ports may appear to the system as separate instances. -The system does not provide a guarnatee on how these will be presented. +The system does not provide a guarantee on how these will be presented. Using this instance identifier, one can determine the exact character-special file to open. For example, the first instance enumerated in the system, with id 0, would be @@ -150,7 +150,7 @@ Maximum: .Bd -filled The .Sy mr_enable -proeprty determines whether or not support for multiple rings is enabled +property determines whether or not support for multiple rings is enabled for the device. The default is always to enable them. It is not recommended to to disable them. @@ -232,7 +232,7 @@ Maximum: The .Sy tx_hcksum_enable property controls whether or not the device enables support for hardware -checksuming of outgoing packets. +checksumming of outgoing packets. The default is to always enable support for this. Turning it off will increase latency and decrease throughput when transmitting packets, but should be done if a hardware bug is suspected. @@ -248,7 +248,7 @@ Maximum: The .Sy rx_hcksum_enable property controls whether or not the device enables support for hardware -checksuming of incoming packets. +checksumming of incoming packets. The default is to always enable support for this. Turning it off will increase latency and decrease throughput when receiving packets, but should be done if a hardware bug is suspected. @@ -260,11 +260,11 @@ Minimum: Maximum: .Sy INT32_MAX | Runtime Property: -.Sy _rx_dma_treshold +.Sy _rx_dma_threshold .Ed .Bd -filled The -.Sy rx_dma_treshold +.Sy rx_dma_threshold indicates the size in bytes of a received frame, including all of its headers, at which the driver should not copy the frame but instead bind DMA memory. @@ -300,12 +300,10 @@ systems at this time. .Bl -tag -width Pa .It Pa /dev/net/i40e* Per-instance character device. -.It Pa /kernel/drv/i40e -32-bit device driver (x86). .It Pa /kernel/drv/amd64/i40e -64-bit device driver (x86). +Device driver (x86) .It Pa /kernel/drv/i40e.conf -Driver configuration file. +Driver configuration file .El .Sh SEE ALSO .Xr dladm 1M , diff --git a/usr/src/man/man7d/ieee1394.7d b/usr/src/man/man7d/ieee1394.7d index bcdf216811..07cf605b11 100644 --- a/usr/src/man/man7d/ieee1394.7d +++ b/usr/src/man/man7d/ieee1394.7d @@ -1,27 +1,27 @@ '\" te .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2020 Peter Tribble. .\" 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 "May 13, 2017" +.TH IEEE1394 7D "Jan 10, 2020" .SH NAME -ieee1394, firewire, 1394 \- Solaris IEEE-1394 Architecture +ieee1394, firewire, 1394 \- illumos IEEE-1394 Architecture .SH DESCRIPTION -.LP 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 -(including webcam-type devices). For more information on USB, refer to the 1394 -Trade Association website at http://\fIwww.1394ta.org\fR. +(including webcam-type devices). For more information on IEEE-1394, refer to the +1394 Trade Association website at http://\fIwww.1394ta.org\fR. .sp .LP -The Solaris IEEE-1394 architecture supports up to 63 hot-pluggable IEEE-1394 +The illumos IEEE-1394 architecture supports up to 63 hot-pluggable IEEE-1394 devices per IEEE-1394 bus. The maximum data transfer rate is 400 Mbits, depending on the capabilities of the attached device. .sp .LP -The Solaris IEEE-1394 architecture supports devices implementing a number of +The illumos IEEE-1394 architecture supports devices implementing a number of different specifications. The basic behavior of the IEEE-1394 bus is described in the \fIIEEE 1394-1995\fR and \fIIEEE 1394a-2000\fR specifications. .sp @@ -33,11 +33,8 @@ 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 -.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 -drivers (only). Drivers in \fB/kernel/drv/sparcv9\fR or \fB/kernel/drv/amd64\fR -are 64 bit drivers. +the illumos IEEE-1394 architecture. .sp .sp @@ -47,9 +44,9 @@ c | c l | l . SUPPORT MODULE(S) FUNCTION _ -/kernel/misc/[sparcv9|amd64/]s1394 IEEE-1394 framework +/kernel/misc/[sparcv9|amd64]/s1394 IEEE-1394 framework _ -/kernel/misc/[sparcv9|amd64/]sbp2 Serial Bus Protocol-2 (SBP-2) +/kernel/misc/[sparcv9|amd64]/sbp2 Serial Bus Protocol-2 (SBP-2) .TE .sp @@ -61,13 +58,11 @@ c | c l | l . TARGET DRIVER DEVICE CLASS _ -/kernel/drv/[sparcv9|amd64/]s1394 IEEE-1394 framework -_ -/kernel/drv/[sparcv9|amd64/]scsa1394 mass storage class +/kernel/drv/[sparcv9|amd64]/scsa1394 mass storage class _ -/kernel/drv/[sparcv9|amd64/]av1394 camcorder (AV/C) class +/kernel/drv/[sparcv9|amd64]/av1394 camcorder (AV/C) class _ -/kernel/drv/[sparcv9|amd64/]dcam1394 digital camera (IIDC) class +/kernel/drv/[sparcv9|amd64]/dcam1394 digital camera (IIDC) class .TE .sp @@ -79,11 +74,10 @@ c | c l | l . HOST CONTROLLER INTERFACE DRIVER(S) DEVICE _ -/kernel/drv/[sparcv9|amd64/]hci1394 Open HCI +/kernel/drv/[sparcv9|amd64]/hci1394 Open HCI .TE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -98,7 +92,6 @@ Architecture PCI-based systems .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBav1394\fR(7D), \fBdcam1394\fR(7D), \fBhci1394\fR(7D), \fBscsa1394\fR(7D), \fBiec61883\fR(7I) .sp @@ -108,6 +101,5 @@ Architecture PCI-based systems .LP \fIIEEE 1394\fR Specification - 1394 Trade Association, 1995 .SH NOTES -.LP Booting from IEEE-1394 mass-storage devices is not supported, but may be possible if supported by the BIOS of the computer system. diff --git a/usr/src/man/man7d/ixgbe.7d b/usr/src/man/man7d/ixgbe.7d index 324ced1012..5b7f8e25e2 100644 --- a/usr/src/man/man7d/ixgbe.7d +++ b/usr/src/man/man7d/ixgbe.7d @@ -5,17 +5,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 IXGBE 7D "Apr 10, 2016" +.TH IXGBE 7D "Jan 10, 2020" .SH NAME ixgbe \- Intel 10Gb PCI Express NIC Driver .SH SYNOPSIS -.LP .nf \fB/dev/ixgbe*\fR .fi .SH DESCRIPTION -.LP The \fBixgbe\fR 10 Gigabit Ethernet driver is a multi-threaded, loadable, clonable, GLD-based STREAMS driver supporting the Data Link Provider Interface, \fBdlpi\fR(7P), on Intel 10-Gigabit PCI Express Ethernet controllers. @@ -55,7 +53,6 @@ Intel Ethernet Controller X550 Family The \fBixgbe\fR driver and hardware support auto-negotiation, a protocol specified by the \fIIEEE 802.3ae\fR specification. .SH APPLICATION PROGRAMMING INTERFACE -.LP The cloning character-special device, \fB/dev/ixgbe\fR, is used to access all Intel 10-Gigabit PCI Express Ethernet devices installed within the system. .sp @@ -124,7 +121,6 @@ Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a particular SAP with the stream. .RE .SH CONFIGURATION -.LP By default, the \fBixgbe\fR driver performs auto-negotiation to select the link speed and mode. Link speed and mode can only be 10000 Mbps full-duplex for fiber, and only 10000, 1000, or 100 Mbps full-duplex for copper. See the \fIIEEE802.3\fR standard for more information. @@ -140,19 +136,10 @@ Special character device. .sp .ne 2 .na -\fB\fB/kernel/drv/ixgbe\fR\fR -.ad -.RS 29n -32-bit device driver (x86). -.RE - -.sp -.ne 2 -.na \fB\fB/kernel/drv/amd64/ixgbe\fR\fR .ad .RS 29n -64-bit device driver (x86). +Device driver (x86) .RE .sp @@ -161,7 +148,7 @@ Special character device. \fB\fB/kernel/drv/sparcv9/ixgbe\fR\fR .ad .RS 29n -64-bit device driver (SPARC). +Device driver (SPARC) .RE .sp @@ -170,11 +157,10 @@ Special character device. \fB\fB/kernel/drv/ixgbe.conf\fR\fR .ad .RS 29n -Configuration file. +Driver configuration file .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -191,7 +177,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBdladm\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7P) .sp @@ -205,4 +190,4 @@ Interface Stability Committed \fINetwork Interfaces Programmer's Guide\fR .sp .LP -\fIIEEE 802.3ae Specificiation\fR, IEEE - 2002 +\fIIEEE 802.3ae Specification\fR, IEEE - 2002 diff --git a/usr/src/man/man7d/ntwdt.7d b/usr/src/man/man7d/ntwdt.7d index d5e37c1edc..553c8c7a38 100644 --- a/usr/src/man/man7d/ntwdt.7d +++ b/usr/src/man/man7d/ntwdt.7d @@ -3,18 +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 NTWDT 7D "Feb 05, 2005" +.TH NTWDT 7D "Jan 10, 2020" .SH NAME ntwdt \- Netra\(embased application watchdog timer driver .SH SYNOPSIS -.LP .nf /dev/ntwdt .fi .SH DESCRIPTION -.sp -.LP The \fBntwdt\fR driver is a multithreaded, loadable, non-STREAMS pseudo driver that provides an application with an interface for controlling a system watchdog timer. @@ -23,13 +20,9 @@ watchdog timer. The \fBntwdt\fR driver implements a \fBvirtual watchdog timer\fR that a privileged application (Effective UID == 0) controls via IOCTLs. .SH CONFIGURATION -.sp -.LP You configure the \fBntwdt\fR driver by modifying the contents of the \fBntwdt.conf\fR file. .SH ERRORS -.sp -.LP An \fBopen()\fR fails if: .sp .ne 2 @@ -59,7 +52,6 @@ Effective user ID is not zero. .RE .SH FILES -.sp .ne 2 .na \fB/dev/ntwdt\fR @@ -71,24 +63,22 @@ Special character device. .sp .ne 2 .na -\fBkernel/drv/sparcv9/ntwdt\fR +\fB/kernel/drv/sparcv9/ntwdt\fR .ad .RS 28n -SPARC ntwdt driver binary. +Device driver (SPARC) .RE .sp .ne 2 .na -\fBkernel/drv/ntwdt.conf\fR +\fB/kernel/drv/ntwdt.conf\fR .ad .RS 28n -Driver configuraton file. +Driver configuration file .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -103,8 +93,6 @@ Architecture SPARC .TE .SH SEE ALSO -.sp -.LP \fBdriver.conf\fR(4), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man7d/pchtemp.7d b/usr/src/man/man7d/pchtemp.7d index d89f09ab90..00635cb6cd 100644 --- a/usr/src/man/man7d/pchtemp.7d +++ b/usr/src/man/man7d/pchtemp.7d @@ -11,7 +11,7 @@ .\" .\" Copyright 2019 Joyent, Inc. .\" -.Dd April 26, 2019 +.Dd January 10, 2020 .Dt PCHTEMP 7D .Os .Sh NAME @@ -24,7 +24,7 @@ The .Nm driver provides the system the ability to read the digital temperature sensor found on several Intel platform controller hub (PCH) chipsets. -The following chipsets are supported which cover most Intel Core familiy +The following chipsets are supported which cover most Intel Core family (non-Atom) CPUs starting with the Haswell generation: .Bl -dash .It diff --git a/usr/src/man/man7d/pcn.7d b/usr/src/man/man7d/pcn.7d index 087ca63179..f78375239d 100644 --- a/usr/src/man/man7d/pcn.7d +++ b/usr/src/man/man7d/pcn.7d @@ -24,27 +24,24 @@ .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE .\" Portions Copyright (c) 2007 by Sun Microsystems, Inc. All Rights Reserved. -.TH "PCN" "7D" "Sep 16, 2011" +.TH "PCN" "7D" "Jan 10, 2020" . .SH "NAME" \fBpcn\fR \- PCnet Ethernet device driver .SH "SYNOPSIS" -.LP .nf \fB/dev/pcn\fR .fi .SH "DESCRIPTION" -.sp -.LP The \fBpcn\fR driver is a multi\-threaded, loadable, clonable GLDv3\-based STREAMS driver supporting the Data Link Provider Interface \fBdlpi\fR(7P) for -the AMD PCnet family of Ethernet controllers\. +the AMD PCnet family of Ethernet controllers. .SH "APPLICATION PROGRAMMING INTERFACE" The \fBpcn\fR driver can be used as either a "style 1" or a "style 2" Data Link -Service Provider\. Physical points of attachment (PPAs) are interpreted as the +Service Provider. Physical points of attachment (PPAs) are interpreted as the instance number of the \fBpcn\fR controller as assigned by the -operating environment\. +operating environment. .sp .LP The values returned by the driver in the \fBDL_INFO_ACK\fR response are: @@ -52,60 +49,58 @@ The values returned by the driver in the \fBDL_INFO_ACK\fR response are: .TP .ie t \(bu .el o -Maximum SDU is 1500\. +Maximum SDU is 1500. .RE .RS +4 .TP .ie t \(bu .el o -Minimum SDU is 0\. +Minimum SDU is 0. .RE .RS +4 .TP .ie t \(bu .el o -The dlsap address length is 8\. +The dlsap address length is 8. .RE .RS +4 .TP .ie t \(bu .el o -MAC type is \fBDL_ETHER\fR\. +MAC type is \fBDL_ETHER\fR. .RE .RS +4 .TP .ie t \(bu .el o -SAP length is \-2\. The 6\-byte physical address is immediately followed by a -2\-byte SAP\. +SAP length is \-2. The 6\-byte physical address is immediately followed by a +2\-byte SAP. .RE .RS +4 .TP .ie t \(bu .el o -Service mode is \fBDL_CLDLS\fR\. +Service mode is \fBDL_CLDLS\fR. .RE .RS +4 .TP .ie t \(bu .el o The broadcast address is the 6\-byte Ethernet broadcast address -(\fBff:ff:ff:ff:ff:ff\fR)\. +(\fBff:ff:ff:ff:ff:ff\fR). .SH "CONFIGURATION" -.sp -.LP The \fBpcn\fR driver performs auto-negotiation to select the link speed and -mode\. Link sped may be 100Mbps full\-duplex, 100Mbps half\-duplex, +mode. Link speed may be 100Mbps full\-duplex, 100Mbps half\-duplex, 10Mbps full\-duplex, or 10Mbps half\-duplex, depending on the hardware -adapter type\. See the \fIIEEE802.3\fR standard for more information\. +adapter type. See the \fIIEEE802.3\fR standard for more information. .sp .LP The capabilities advertised by the \fBpcn\fR device can be set using -\fBdladm\fR(1m)\. The driver supports a number of parameters whose names -being with \fBen_\fR (see below)\. Each of these parameters contains a -boolean value that determines if the devices advertises that mode of -operations\. The \fBadv_autoneg_cap\fR parameter controls whether -auto-negotioation is performed\. If \fBadv_autoneg_cap\fR is set to 0, the +\fBdladm\fR(1m). The driver supports a number of parameters whose names +begin with \fBen_\fR (see below). Each of these parameters contains a +boolean value that determines if the device advertises that mode of +operations. The \fBadv_autoneg_cap\fR parameter controls whether +auto-negotiation is performed. If \fBadv_autoneg_cap\fR is set to 0, the driver forces the mode of operation selected by the first non-zero parameter in priority order as shown below: .sp @@ -120,12 +115,10 @@ parameter in priority order as shown below: .sp .LP -All capabilities default to enabled\. Note that changing any capability -parameter causes te link to go down while the link partners renegotiate -the link speed/duplex using the newly changed capabilities\. +All capabilities default to enabled. Note that changing any capability +parameter causes the link to go down while the link partners renegotiate +the link speed/duplex using the newly changed capabilities. .SH "ATTRIBUTES" -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -142,39 +135,26 @@ Interface Stability Committed .TE .SH "FILES" -.sp .ne 2 .na -\fB\fB/dev/pcn\fR\fR +\fB/dev/pcn\fR .ad .sp .6 .RS 4n -Special character device\. +Special character device. .RE .sp .ne 2 .na -\fB\fB/kernel/drv/pcn\fR\fR -.ad -.sp 6 -.RS 4n -32\-bit driver binary\. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/pcn\fR\fR +\fB/kernel/drv/amd64/pcn\fR .ad .sp .6 .RS 4n -64\-bit driver binary (x86)\. +Device driver (x86) .RE .SH "SEE ALSO" -.sp -.LP \fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7p) .sp .LP diff --git a/usr/src/man/man7d/poll.7d b/usr/src/man/man7d/poll.7d index 450da9ec5b..b69594d7da 100644 --- a/usr/src/man/man7d/poll.7d +++ b/usr/src/man/man7d/poll.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 POLL 7D "April 9, 2016" +.TH POLL 7D "January 10, 2020" .SH NAME poll \- driver for fast poll on many file descriptors .SH SYNOPSIS -.LP .nf \fB#include <sys/devpoll.h> int fd = open("/dev/poll", O_RDWR); @@ -71,7 +70,6 @@ Pointer to \fBpollfd\fR structure. .RE .SH DESCRIPTION -.LP The \fB/dev/poll\fR driver is a special driver that enables you to monitor multiple sets of polled file descriptors. By using the \fB/dev/poll\fR driver, you can efficiently poll large numbers of file descriptors. Access to @@ -140,7 +138,7 @@ value \fB0\fR means the ioctl is timed out. In this case, the memory content pointed by \fBdp_fds\fR is not modified. If the call is successful, it returns the number of valid \fBpollfd\fR entries in the array pointed by \fBdp_fds\fR; the contents of the rest of the buffer is undefined. For each valid -\fBpollfd\fR entry, the \fBfd\fR field indicates the file desciptor on which +\fBpollfd\fR entry, the \fBfd\fR field indicates the file descriptor on which the polled \fBevents\fR happened. The \fBevents\fR field is the user specified \fBpoll\fR \fBevents\fR. The \fBrevents\fR field contains the \fBevents\fR occurred. \fB-1\fR is returned if the call fails. @@ -155,7 +153,6 @@ currently polled \fBevents\fR. The ioctl returns \fB0\fR if the file descriptor is not in the set. The \fBpollfd\fR structure pointed by \fIpfd\fR is not modified. The ioctl returns a \fB-1\fR if the call fails. .SH EXAMPLES -.LP The following example shows how \fB/dev/poll\fR may be used. .sp .in +2 @@ -335,7 +332,6 @@ special file does not exist. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -351,10 +347,8 @@ MT-Level Safe .TE .SH SEE ALSO -.LP \fBopen\fR(2), \fBpoll\fR(2), \fBwrite\fR(2), \fBattributes\fR(5) .SH NOTES -.LP The \fB/dev/poll\fR API is particularly beneficial to applications that poll a large number of file descriptors repeatedly. Applications will exhibit the best performance gain if the polled file descriptor list rarely change. diff --git a/usr/src/man/man7d/qede.7d b/usr/src/man/man7d/qede.7d index 28472dbf8f..b819e21697 100644 --- a/usr/src/man/man7d/qede.7d +++ b/usr/src/man/man7d/qede.7d @@ -11,7 +11,7 @@ .\" .\" Copyright (c) 2014 QLogic Corporation. All Rights Reserved .\" -.Dd August 28, 2017 +.Dd January 10, 2020 .Dt QEDE 7D .Os .Sh NAME @@ -89,7 +89,7 @@ for Tx ring stats for general driver stats and version info. .El .Pp -To get a list of all the individual statistics in these goups run: +To get a list of all the individual statistics in these groups run: .Bd -literal -offset indent # kstat -m qede -i 0 -l .Ed diff --git a/usr/src/man/man7d/sd.7d b/usr/src/man/man7d/sd.7d index 476a048757..cefbde57e7 100644 --- a/usr/src/man/man7d/sd.7d +++ b/usr/src/man/man7d/sd.7d @@ -3,24 +3,21 @@ .\" 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 "May 13, 2017" +.TH SD 7D "Jan 10, 2020" .SH NAME sd \- SCSI disk and ATAPI/SCSI CD-ROM device driver .SH SYNOPSIS -.LP .nf \fBsd@target,lun:partition\fR .fi .SH DESCRIPTION -.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 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" -.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, \fBATAPI \fR 2.6 (SFF-8020i)-compliant CD-ROM drives, SFF-8090-compliant @@ -34,8 +31,7 @@ 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" -.LP -The \fBsd\fRdriver supports embedded \fBSCSI\fR-2 and \fBCCS\fR-compatible +The \fBsd\fR driver supports embedded \fBSCSI\fR-2 and \fBCCS\fR-compatible \fBSCSI \fRdisk and CD-ROM drives, \fBATAPI \fR2.6 (SFF-8020i)-compliant CD-ROM drives, SFF-8090-compliant \fBSCSI/ATAPI\fR DVD-ROM drives, IOMEGA \fBSCSI/ATAPI\fR ZIP drives\fB, and SCSI JAZ\fR drives. @@ -46,7 +42,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 -.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 enables direct transmission between the disk and the user's read or write @@ -62,7 +57,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 -.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 to prevent manual removal of the disk until the last \fBclose()\fR is called. @@ -71,7 +65,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 -.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 opposite track paths. A DVD-ROM can hold from between 4.5 Gbytes and 17 Gbytes @@ -85,7 +78,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 -.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 250MBytes of data. \fBZIP/JAZ\fR drives can be read-from or written-to using @@ -98,7 +90,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 -.LP Each device maintains I/O statistics for the device and for partitions allocated for that device. For each device/partition, the driver accumulates reads, writes, bytes read, and bytes written. The driver also initiates @@ -108,9 +99,8 @@ of residence time and cumulative residence-length product for each queue. .LP 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. +default but may be disabled in their configuration files. .SH IOCTLS -.LP Refer to \fBdkio\fR(7I), and \fBcdio\fR(7I) .SS "ERRORS" .ne 2 @@ -208,7 +198,7 @@ Insufficient memory \fB\fBEPERM\fR\fR .ad .RS 10n -Insufficent access permission +Insufficient access permission .RE .sp @@ -222,7 +212,6 @@ media. .RE .SH CONFIGURATION -.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: .sp @@ -448,7 +437,6 @@ Where \fIn\fR=0 the node corresponds to the entire disk. .RE .SH SEE ALSO -.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), \fBread\fR(2), \fBwrite\fR(2), \fBdriver.conf\fR(4), \fBscsi\fR(4), @@ -845,7 +833,6 @@ Drive went offline; probably powered down. .RE .SH NOTES -.LP DVD-ROM media containing DVD-Video data may follow/adhere to the requirements of content scrambling system or copy protection scheme. Reading of copy-protected sector will cause I/O error. Users are advised to use the diff --git a/usr/src/man/man7d/usba.7d b/usr/src/man/man7d/usba.7d index 3b87e86dff..25cc63c8ea 100644 --- a/usr/src/man/man7d/usba.7d +++ b/usr/src/man/man7d/usba.7d @@ -1,9 +1,10 @@ .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved .\" Copyright 2016 Joyent, Inc. +.\" Copyright 2020 Peter Tribble. .\" 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 May 13, 2017 +.Dd Jan 10, 2020 .Dt USBA 7D .Os .Sh NAME @@ -38,51 +39,39 @@ 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. -Drivers in -.Pa /kernel/drv -are 32 bit drivers (x86 only). -Drivers in -.Pa /kernel/drv/sparcv9 -or -.Pa kernel/drv/amd64 -are 64 bit drivers. -.Bl -column -offset indent ".Pa kernel/drv/[sparcv9|amd64/]usbser_edge" "Edgeport USB to serial port" +.Bl -column -offset indent ".Pa /kernel/drv/[sparcv9|amd64]/usbser_edge" "Edgeport USB to serial port" .It Em Client Driver Ta Em Function/Device .It Ta -.It Pa kernel/drv/[sparcv9|amd64/]hid Ta HID class -.It Pa kernel/drv/[sparcv9|amd64/]hubd Ta hub class -.It Pa kernel/drv/[sparcv9|amd64/]scsa2usb Ta mass storage class -.It Pa kernel/drv/[sparcv9|amd64/]usbprn Ta printer class -.It Pa kernel/drv/[sparcv9|amd64/]usb_as Ta audio streaming class -.It Pa kernel/drv/[sparcv9|amd64/]usb_ac Ta audio control class -.It Pa kernel/drv/[sparcv9|amd64/]usbvc Ta video class -.It Pa kernel/drv/[sparcv9|amd64/]usb_mid Ta multi-interface device -.It Pa kernel/drv/[sparcv9|amd64/]usb_ia Ta interface-association driver -.It Pa kernel/drv/[sparcv9|amd64/]usbser_edge Ta Edgeport USB to serial port -.It Pa kernel/drv/[sparcv9|amd64/]usbsksp Ta Keyspan USB to serial port -.It Pa kernel/drv/[sparcv9|amd64/]usbsprl Ta pl2303 USB to serial port -.It Pa kernel/drv/[sparcv9|amd64/]usbsacm Ta CDC ACM class to serial port -.It Pa kernel/drv/[sparcv9|amd64/]ugen Ta generic USB driver -.It Pa kernel/drv/[sparcv9|amd64/]ohci Ta open host controller driver -.It Pa kernel/drv/[sparcv9|amd64/]uhci Ta universal host controller driver -.It Pa kernel/drv/[sparcv9|amd64/]ehci Ta enhanced host controller driver -.It Pa kernel/drv/[sparcv9|amd64/]xhci Ta extensible host controller driver +.It Pa /kernel/drv/[sparcv9|amd64]/hid Ta HID class +.It Pa /kernel/drv/[sparcv9|amd64]/hubd Ta hub class +.It Pa /kernel/drv/[sparcv9|amd64]/scsa2usb Ta mass storage class +.It Pa /kernel/drv/[sparcv9|amd64]/usbprn Ta printer class +.It Pa /kernel/drv/[sparcv9|amd64]/usb_as Ta audio streaming class +.It Pa /kernel/drv/[sparcv9|amd64]/usb_ac Ta audio control class +.It Pa /kernel/drv/[sparcv9|amd64]/usbvc Ta video class +.It Pa /kernel/drv/[sparcv9|amd64]/usb_mid Ta multi-interface device +.It Pa /kernel/drv/[sparcv9|amd64]/usb_ia Ta interface-association driver +.It Pa /kernel/drv/[sparcv9|amd64]/usbser_edge Ta Edgeport USB to serial port +.It Pa /kernel/drv/[sparcv9|amd64]/usbsksp Ta Keyspan USB to serial port +.It Pa /kernel/drv/[sparcv9|amd64]/usbsprl Ta pl2303 USB to serial port +.It Pa /kernel/drv/[sparcv9|amd64]/usbsacm Ta CDC ACM class to serial port +.It Pa /kernel/drv/[sparcv9|amd64]/ugen Ta generic USB driver .El .Bl -column -offset indent ".Pa /kernel/strmod/[sparcv9|amd64/]usb_ah" "Function/Device" .It Ta .It Em Client Streams Modules Ta Em Function/Device .It Ta -.It Pa /kernel/strmod/[sparcv9|amd64/]usbkbm Ta Keyboad -.It Pa /kernel/strmod/[sparcv9|amd64/]usbms Ta Mouse -.It Pa /kernel/strmod/[sparcv9|amd64/]usb_ah Ta Audio HID +.It Pa /kernel/strmod/[sparcv9|amd64]/usbkbm Ta Keyboard +.It Pa /kernel/strmod/[sparcv9|amd64]/usbms Ta Mouse +.It Pa /kernel/strmod/[sparcv9|amd64]/usb_ah Ta Audio HID .El .Bl -column -offset indent ".Em Host Controller Interface Drivers" "Extensible HCI" .It Em Host Controller Interface Drivers Ta Em Device .It Ta -.It Pa /kernel/drv/[amd64/]xhci Ta Extensible HCI -.It Pa /kernel/drv/[sparcv9|amd64/]ehci Ta Enhanced HCI -.It Pa /kernel/drv/[sparcv9|amd64/]ohci Ta Open HCI -.It Pa /kernel/drv/[sparcv|amd64/]uhci Ta Universal HCI +.It Pa /kernel/drv/amd64/xhci Ta Extensible HCI +.It Pa /kernel/drv/[sparcv9|amd64]/ehci Ta Enhanced HCI +.It Pa /kernel/drv/[sparcv9|amd64]/ohci Ta Open HCI +.It Pa /kernel/drv/[sparcv9|amd64]/uhci Ta Universal HCI .El .Sh DIAGNOSTICS The messages described below may appear on the system console as well as being @@ -110,7 +99,7 @@ They are formatted in the following manner: <device path><usba<instance number>): message... .Ed .Bl -tag -width Sy -offset 2n -.It Sy Incorrect USB driver version for <n.m>. +.It Sy Incorrect USB driver version for <n.m> . Driver is incompatible with USBA framework. .El .Sh SEE ALSO diff --git a/usr/src/man/man7d/xhci.7d b/usr/src/man/man7d/xhci.7d index 4f2836b97e..a915a099b1 100644 --- a/usr/src/man/man7d/xhci.7d +++ b/usr/src/man/man7d/xhci.7d @@ -11,7 +11,7 @@ .\" .\" Copyright 2016 Joyent, Inc. .\" -.Dd October 17, 2016 +.Dd January 10, 2020 .Dt XHCI 7D .Os .Sh NAME @@ -23,7 +23,7 @@ The .Nm driver supports PCI devices that implement versions 1.0 and 1.1 of the -Extensible Host Controller Inteface Specification. +Extensible Host Controller Interface Specification. These devices provide support for USB 3.0, USB 2.x, and USB 1.x devices and is integrated into the broader illumos USB Architecture (USBA). .Pp @@ -94,12 +94,10 @@ driver is only supported on systems at this time. .Sh FILES .Bl -tag -width Pa -.It Pa /kernel/drv/xhci -32-bit device driver (x86). .It Pa /kernel/drv/amd64/xhci -64-bit device driver (x86). +Device driver (x86) .It Pa /kernel/drv/xhci.conf -Driver configuration file. +Driver configuration file .El .Sh SEE ALSO .Xr cfgadm 1M , diff --git a/usr/src/man/man7i/Makefile b/usr/src/man/man7i/Makefile index 12e4489be5..9d5267ddb2 100644 --- a/usr/src/man/man7i/Makefile +++ b/usr/src/man/man7i/Makefile @@ -16,7 +16,7 @@ include $(SRC)/Makefile.master -MANSECT= 7i +MANSECT= 7i MANFILES= audio.7i \ cdio.7i \ @@ -41,6 +41,10 @@ MANFILES= audio.7i \ visual_io.7i \ vt.7i +MANLINKS= uccid.7i + +uccid.7i := LINKSRC = ../man7d/ccid.7d + .KEEP_STATE: include $(SRC)/man/Makefile.man |