diff options
| author | Richard Lowe <richlowe@richlowe.net> | 2022-02-26 16:40:47 -0600 |
|---|---|---|
| committer | Richard Lowe <richlowe@richlowe.net> | 2022-03-10 01:14:35 -0600 |
| commit | bbf215553c7233fbab8a0afdf1fac74c44781867 (patch) | |
| tree | e698415c5d1265b368c58c56199244dc2be86500 /usr/src/man/man7d | |
| parent | 236cb9a89d936b4b681853751c9af1adccc35ef9 (diff) | |
| download | illumos-gate-bbf215553c7233fbab8a0afdf1fac74c44781867.tar.gz | |
14443 resection manual pages per IPD4
Reviewed by: Toomas Soome <tsoome@me.com>
Reviewed by: Robert Mustacchi <rm@fingolfin.org>
Reviewed by: Peter Tribble <peter.tribble@gmail.com>
Reviewed by: Andy Fiddaman <andy@omnios.org>
Approved by: Dan McDonald <danmcd@joyent.com>
Diffstat (limited to 'usr/src/man/man7d')
224 files changed, 0 insertions, 39641 deletions
diff --git a/usr/src/man/man7d/Makefile b/usr/src/man/man7d/Makefile deleted file mode 100644 index 78b9601e29..0000000000 --- a/usr/src/man/man7d/Makefile +++ /dev/null @@ -1,298 +0,0 @@ -# -# 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 2011, Richard Lowe -# Copyright 2016 Garrett D'Amore <garrett@damore.org> -# Copyright 2019 Joyent, Inc. -# Copyright 2016 Hans Rosenfeld <rosenfeld@grumpf.hope-2000.org> -# Copyright 2018 Nexenta Systems, Inc. -# Copyright 2020 Peter Tribble -# Copyright 2022 Oxide Computer Company -# - -include $(SRC)/Makefile.master - -MANSECT= 7d - -_MANFILES= aac.7d \ - afe.7d \ - audio.7d \ - audio1575.7d \ - audioens.7d \ - audiols.7d \ - audiop16x.7d \ - audiopci.7d \ - audiots.7d \ - av1394.7d \ - bge.7d \ - blkdev.7d \ - bnxe.7d \ - ccid.7d \ - chxge.7d \ - console.7d \ - cpuid.7d \ - dca.7d \ - dcam1394.7d \ - devinfo.7d \ - dmfe.7d \ - dtrace.7d \ - e1000g.7d \ - ehci.7d \ - ena.7d \ - fasttrap.7d \ - fbt.7d \ - fcip.7d \ - fcoe.7d \ - fcoei.7d \ - fcoet.7d \ - fcp.7d \ - fctl.7d \ - fd.7d \ - fp.7d \ - full.7d \ - gld.7d \ - hci1394.7d \ - hermon.7d \ - hid.7d \ - hme.7d \ - hubd.7d \ - hxge.7d \ - ib.7d \ - ibcm.7d \ - ibd.7d \ - ibdm.7d \ - ibdma.7d \ - ibtl.7d \ - ieee1394.7d \ - igb.7d \ - ipnet.7d \ - iscsi.7d \ - iser.7d \ - ixgbe.7d \ - kmdb.7d \ - kstat.7d \ - ksensor.7d \ - ksyms.7d \ - llc1.7d \ - lockstat.7d \ - lofi.7d \ - log.7d \ - mem.7d \ - mpt_sas.7d \ - mr_sas.7d \ - msglog.7d \ - mt.7d \ - mxfe.7d \ - myri10ge.7d \ - null.7d \ - nulldriver.7d \ - nxge.7d \ - ohci.7d \ - openprom.7d \ - pcic.7d \ - pcmcia.7d \ - physmem.7d \ - pm.7d \ - poll.7d \ - profile.7d \ - ptm.7d \ - pty.7d \ - qlc.7d \ - ramdisk.7d \ - random.7d \ - rge.7d \ - rtls.7d \ - sad.7d \ - sata.7d \ - scsa1394.7d \ - scsa2usb.7d \ - sd.7d \ - sdp.7d \ - sdt.7d \ - ses.7d \ - sfe.7d \ - sgen.7d \ - srpt.7d \ - st.7d \ - sysmsg.7d \ - systrace.7d \ - ticlts.7d \ - tty.7d \ - tzmon.7d \ - ufm.7d \ - ugen.7d \ - uhci.7d \ - usb_ac.7d \ - usb_as.7d \ - usb_ia.7d \ - usb_mid.7d \ - usba.7d \ - usbftdi.7d \ - usbprn.7d \ - usbsacm.7d \ - usbsksp.7d \ - usbsprl.7d \ - usbvc.7d \ - virtualkm.7d \ - vni.7d \ - vr.7d \ - wscons.7d \ - xge.7d \ - yge.7d \ - zcons.7d \ - zero.7d - -sparc_MANFILES= audiocs.7d \ - bbc_beep.7d \ - dad.7d \ - dm2s.7d \ - dr.7d \ - eri.7d \ - fas.7d \ - gpio_87317.7d \ - grbeep.7d \ - mc-opl.7d \ - n2rng.7d \ - ntwdt.7d \ - oplkmdrv.7d \ - oplmsu.7d \ - oplpanel.7d \ - pcicmu.7d \ - pcipsy.7d \ - pcisch.7d \ - sf.7d \ - smbus.7d \ - socal.7d \ - ssd.7d \ - su.7d \ - todopl.7d \ - tsalarm.7d \ - zs.7d \ - zsh.7d - -i386_MANFILES= ahci.7d \ - amd8111s.7d \ - amdnbtemp.7d \ - amdzen.7d \ - amr.7d \ - arcmsr.7d \ - arn.7d \ - asy.7d \ - ata.7d \ - atge.7d \ - ath.7d \ - atu.7d \ - audio810.7d \ - audiocmi.7d \ - audiocmihd.7d \ - audioemu10k.7d \ - audiohd.7d \ - audioixp.7d \ - audiosolo.7d \ - audiovia823x.7d \ - bcm_sata.7d \ - bfe.7d \ - cmdk.7d \ - coretemp.7d \ - cpqary3.7d \ - dnet.7d \ - ecpp.7d \ - elxl.7d \ - i40e.7d \ - imc.7d \ - imcstub.7d \ - ipmi.7d \ - iprb.7d \ - ipw.7d \ - iwh.7d \ - iwi.7d \ - iwn.7d \ - mega_sas.7d \ - mlxcx.7d \ - npe.7d \ - ntxn.7d \ - nv_sata.7d \ - nvme.7d \ - pchtemp.7d \ - pcn.7d \ - qede.7d \ - ral.7d \ - rtw.7d \ - rum.7d \ - rwd.7d \ - rwn.7d \ - sda.7d \ - sdhost.7d \ - sfxge.7d \ - si3124.7d \ - skd.7d \ - smbios.7d \ - smntemp.7d \ - uath.7d \ - ural.7d \ - urtw.7d \ - usmn.7d \ - vioblk.7d \ - vioif.7d \ - virtio.7d \ - wpi.7d \ - xhci.7d \ - zen_udf.7d \ - zyd.7d - -_MANLINKS= 1394.7d \ - allkmem.7d \ - fdc.7d \ - firewire.7d \ - kmem.7d \ - lo0.7d \ - pts.7d \ - ticots.7d \ - ticotsord.7d \ - urandom.7d \ - usb.7d - -sparc_MANLINKS= drmach.7d - -i386_MANLINKS= amdzen_stub.7d - -MANFILES = $(_MANFILES) $($(MACH)_MANFILES) -MANLINKS = $(_MANLINKS) $($(MACH)_MANLINKS) - -amdzen_stub.7d := LINKSRC = amdzen.7d - -drmach.7d := LINKSRC = dr.7d - -fdc.7d := LINKSRC = fd.7d - -1394.7d := LINKSRC = ieee1394.7d -firewire.7d := LINKSRC = ieee1394.7d - -lo0.7d := LINKSRC = ipnet.7d - -pts.7d := LINKSRC = ptm.7d - -allkmem.7d := LINKSRC = mem.7d -kmem.7d := LINKSRC = mem.7d - -urandom.7d := LINKSRC = random.7d - -ticots.7d := LINKSRC = ticlts.7d -ticotsord.7d := LINKSRC = ticlts.7d - -usb.7d := LINKSRC = usba.7d - -.KEEP_STATE: - -include $(SRC)/man/Makefile.man - -install: $(ROOTMANFILES) $(ROOTMANLINKS) diff --git a/usr/src/man/man7d/aac.7d b/usr/src/man/man7d/aac.7d deleted file mode 100644 index 15b896685d..0000000000 --- a/usr/src/man/man7d/aac.7d +++ /dev/null @@ -1,89 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH AAC 7D "Dec 27, 2007" -.SH NAME -aac \- SCSI HBA driver for Adaptec AdvancedRAID Controller -.SH DESCRIPTION -.sp -.LP -The \fBaac\fR plain SCSI host bus adapter driver is a SCSA-compliant nexus -driver that supports the Adaptec 2200S/2120S SCSI RAID card, Dell PERC 3Di SCSI -RAID controller, Dell PERC 3Si SCSI RAID controller, Adaptec 2820SA SATA -RAID card, Adaptec 4800SAS, 4805SAS SAS RAID cards and SUN's STK RAID REM, STK -RAID INT, and STK RAID EXT RAID cards. -.sp -.LP -The \fBaac\fR driver is ported from FreeBSD and supports RAID disk I/O -functions and the RAID management interface. -.SH DRIVER CONFIGURATION -.sp -.LP -There are no user configurable parameters available. Please configure your -hardware through BIOS. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture T{ -x86, SPARC (Limited to systems with AAC hardware RAID cards.) -T} -.TE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/aac\fR\fR -.ad -.RS 27n -32-bit ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/aac\fR -.ad -.RS 27n -64-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/aac\fR\fR -.ad -.RS 27n -64-bit ELF kernel module. (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/aac.conf\fR\fR -.ad -.RS 27n -Configuration file. (Contains no user-configurable options). -.RE - -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBattributes\fR(5), \fBscsi_hba_attach\fR(9F), -\fBscsi_sync_pkt\fR(9F), \fBscsi_transport\fR(9F), \fBscsi_device\fR(9S), -\fBscsi_inquiry\fR(9S), \fBscsi_pkt\fR(9S) -.sp -.LP -\fISmall Computer System Interface-2 (SCSI-2)\fR diff --git a/usr/src/man/man7d/afe.7d b/usr/src/man/man7d/afe.7d deleted file mode 100644 index 3fb7991769..0000000000 --- a/usr/src/man/man7d/afe.7d +++ /dev/null @@ -1,67 +0,0 @@ -.\" Copyright 2014 Garrett D'Amore <garrett@damore.org> -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS -.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE -.\" COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, -.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -.\" (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 3, 2014" -.Dt AFE 7D -.Os -.Sh NAME -.Nm afe -.Nd ADMtek Fast Ethernet device driver -.Sh SYNOPSIS -.Pa /dev/afe -.Sh DESCRIPTION -The -.Nm -driver provides support for the Centaur and Comet families of Fast Ethernet -PCI controllers originally produced by ADMtek and Infineon. -.Lp -These devices generally support the standard Fast Ethernet features, including -10BASE-T and 100BASE-TX, both full and half duplex operation, IEEE 802.3 -autonegotiation, etc. -They also support full size MTUs (1500 bytes), even when used with VLANs. -Most of them also support flow control. -. -.Lp -The device driver supports the -.Xr ieee802.3 5 -properties, which can be configured with -.Xr dladm 1M . -. -.\" The driver also has a "forcefiber" driver.conf setting, but this is for -.\" very very obscure hardware, and we are not documenting this option -.\" for now. -. -.Sh FILES -.Bl -tag -width /dev/afe -.It Pa /dev/afe -Special character device. -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr ifconfig 1M , -.Xr pci 4 , -.Xr ieee802.3 5 , -.Xr dlpi 7P -.Rs -.%T IEEE 802.3: Ethernet -.%Q IEEE Standards Association -.Re diff --git a/usr/src/man/man7d/ahci.7d b/usr/src/man/man7d/ahci.7d deleted file mode 100644 index 914dbae098..0000000000 --- a/usr/src/man/man7d/ahci.7d +++ /dev/null @@ -1,92 +0,0 @@ -'\" te -.\" 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 AHCI 7D "Sep 10, 2009" -.SH NAME -ahci \- Advanced Host Controller Interface SATA controller driver -.SH SYNOPSIS -.LP -.nf -\fBsata@unit-address\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBahci\fR driver is a SATA framework-compliant HBA driver that supports -SATA HBA controllers that are compatible with the \fIAdvanced Host Controller -Interface 1.0\fR specification. AHCI is an Intel-developed protocol that -describes the register-level interface for host controllers for serial ATA 1.0a -and Serial ATA II. The \fIAHCI 1.0\fR specification describes the interface -between the system software and the host controller hardware. -.sp -.LP -The \fBahci\fR driver currently supports the Intel ICH6/7/8/9/10, VIA vt8251 -and JMicron AHCI controllers which are compliant with the Advanced Host -Controller Interface 1.0 specification. The Intel ICH6/7/8/9 and VIA vt8251 -controllers support standard SATA features. The \fBahci\fR driver currently -supports hard disk, ATAPI DVD, ATAPI tape, ATAPI disk (i.e. Dell RD1000), -hotplug, NCQ (Native command queuing) and Port multipliers (Silicon Image -3726/4726). Power management is not yet supported. -.SH CONFIGURATION -.sp -.LP -The \fBahci\fR module contains no user configurable parameters. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ahci\fR\fR -.ad -.sp .6 -.RS 4n -32-bit \fBELF\fR kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ahci\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBELF\fR kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attribute: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBcfgadm\fR(1M), \fBcfgadm_sata\fR(1M), \fBprtconf\fR(1M), \fBsata\fR(7D) -.sp -.LP -\fIAdvanced Host Controller Interface 1.0\fR -.sp -.LP -\fIWriting Device Drivers\fR -.SH NOTES -.sp -.LP -To bind the \fBahci\fR driver to your controller, choose the [AHCI] BIOS -option. -.sp -.LP -Note that booting is not supported if toggle exists between the [IDE] and -[AHCI] BIOS options diff --git a/usr/src/man/man7d/amd8111s.7d b/usr/src/man/man7d/amd8111s.7d deleted file mode 100644 index ce0600c117..0000000000 --- a/usr/src/man/man7d/amd8111s.7d +++ /dev/null @@ -1,112 +0,0 @@ -'\" te -.\" Copyright (c) 2007 by 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 AMD8111S 7D "Jul 30, 2007" -.SH NAME -amd8111s \- AMD-8111 Fast Ethernet Network Adapter driver -.SH SYNOPSIS -.LP -.nf -/dev/amd8111s -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBamd8111s\fR Fast Ethernet driver is a multi-threaded, loadable, -clonable, GLD-based STREAMS driver supporting the Data Link Provider -Interface, \fBdlpi\fR(7P), on the AMD-8111 Fast Ethernet Network Adapter. -.sp -.LP -The \fBamd8111s\fR driver functions include controller initialization, frame -transmit and receive, promiscuous and multicast support, and error recovery and -reporting. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning, character-special device \fB/dev/amd8111\fR is used to access all -AMD-8111 Fast Ethernet devices installed within the system. -.sp -.LP -The \fBamd8111s\fR driver is managed by the \fBdladm\fR(1M) command line -utility, which allows VLANs to be defined on top of amd8111s instances and for -amd8111s instances to be aggregated. See \fBdladm\fR(1M) for more details. -.SH CONFIGURATION -.sp -.LP -By default, the \fBamd8111s\fR driver performs auto-negotiation to select the -link speed and mode. Link speed and mode can be any of the following: -.sp -.LP -100 Mbps, full-duplex. -.sp -.LP -100 Mbps, half-duplex. -.sp -.LP -10 Mbps, full-duplex. -.sp -.LP -10 Mbps, half-duplex. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/amd8111s*\fR \fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd8111s*\fR \fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/amd8111s*\fR \fR -.ad -.sp .6 -.RS 4n -64-bit ELF Kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -l l -l l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Architecture x86 -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7P) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR diff --git a/usr/src/man/man7d/amdnbtemp.7d b/usr/src/man/man7d/amdnbtemp.7d deleted file mode 100644 index a086ebce99..0000000000 --- a/usr/src/man/man7d/amdnbtemp.7d +++ /dev/null @@ -1,78 +0,0 @@ -.\" -.\" 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 Robert Mustacchi -.\" -.Dd December 24, 2019 -.Dt AMDNBTEMP 7D -.Os -.Sh NAME -.Nm amdnbtemp -.Nd AMD northbridge temperature sensor driver -.Sh SYNOPSIS -.Pa /dev/sensors/temperature/cpu/* -.Sh DESCRIPTION -The -.Nm -driver provides the system the ability to read the temperature sensor -found in several AMD processors. -This includes the K10 microarchitecture, and its derivatives, as well as -the Bulldozer microarchitecture. -The following AMD processors are supported: -.Bl -dash -.It -AMD Family 10h Processors -.Pq K10 -.It -AMD Family 11h Processors -.Pq Turion X2 Ultra -.It -AMD Family 12h Processors -.Pq Llano APUs -.It -AMD Family 14h Processors -.Pq Bobcat -.It -Family 15h models 0-fh, 10h-1fh, 30-3fh -.Pq Bulldozer and Piledriver -.It -AMD Family 16h Processors -.Pq Puma and Jaguar -.El -.Pp -Some AMD Family 10h processors that utilize socket F and socket AM2 are -subject to erratum 319 which indicates that the temperature sensor has -an inaccurate measurement. -If such a processor is detected, the system does not attach a -temperature sensor to the device. -.Pp -AMD Family 15h models 60-7fh -.Pq Steamroller and Excavator -are not supported at this time. -.Pp -For AMD Family 17h -.Pq Zen -processors, the -.Xr smntemp 7D -driver provides access to the temperature sensors. -.Sh SEE ALSO -.Xr fmadm 1M , -.Xr smntemp 7D -.Rs -.%A AMD -.%B BIOS and Kernel Developer’s Guide (BKDG) for AMD Family 16h Models 00h-0Fh Processors -.%O 49125 -.Re -.Rs -.%A AMD -.%B Revision Guide for AMD Family 10h Processors -.%O 41322 -.Re diff --git a/usr/src/man/man7d/amdzen.7d b/usr/src/man/man7d/amdzen.7d deleted file mode 100644 index 919fba4e2a..0000000000 --- a/usr/src/man/man7d/amdzen.7d +++ /dev/null @@ -1,80 +0,0 @@ -.\" -.\" 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 2021 Oxide Computer Company -.\" -.Dd September 26, 2020 -.Dt AMDZEN 7D -.Os -.Sh NAME -.Nm amdzen , -.Nm amdzen_stub -.Nd AMD Zen Nexus Driver -.Sh DESCRIPTION -The -.Nm -driver provides access to the Northbridge, Data Fabric, and System -Management Network -.Pq SMN -for a number of AMD processor lines, including AMD Ryzen CPUs and APUs, -ThreadRipper CPUs, and EPYC CPUs from the following families: -.Bl -bullet -.It -AMD Zen Naples, Summit Ridge, Whitehaven -.Pq Family 17h -.It -AMD Zen+ Colfax, Picasso, and Pinnacle Ridge -.Pq Family 17h -.It -AMD Zen 2 Castle Peak, Matisse, Rome, and Renoir -.Pq Family 17h -.It -AMD Zen 3 Cezanne, Milan, and Vermeer -.Pq Family 19h -.El -.Pp -This driver is a nexus driver and facilitates access to the northbridge, -data fabric, and SMN between various other devices such as -.Xr smntemp 7D . -The various processor devices that make up the northbridge and data -fabric have the -.Sy amdzen_stub -driver attached to them. -The different devices are all amalgamated and a single uniform view is -provided by the -.Sy amdzen -driver. -.Pp -The -.Nm -driver is a nexus driver that has the following children: -.Bl -tag -width "smntemp(7D)" -.It Xr smntemp 7D -Provides access to on-die temperature sensors. -.It Xr usmn 7D -Provides read access to the SMN. -This driver is intended for development purposes. -.It Xr zen_udf 7D -Provides read access to the data fabric. -This driver is intended for development purposes. -.El -.Sh ARCHITECTURE -The -.Sy amdzen -and -.Sy amdzen_stub -drivers are limited to -.Sy x86 -platforms with AMD Family 17h and 19h processors. -.Sh SEE ALSO -.Xr smntemp 7D , -.Xr usmn 7D , -.Xr zen_udf 7D diff --git a/usr/src/man/man7d/amr.7d b/usr/src/man/man7d/amr.7d deleted file mode 100644 index 2b58a19ec1..0000000000 --- a/usr/src/man/man7d/amr.7d +++ /dev/null @@ -1,76 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 AMR 7D "Apr 20, 2005" -.SH NAME -amr \- SCSI HBA driver for Dell PERC 3/DC, 4/SC, 4/DC and 4/DI -.SH DESCRIPTION -.sp -.LP -The \fBamr\fR plain \fBSCSI\fR host bus adapter driver is a SCSA-compliant -nexus driver that supports the Dell PERC 3DC/4SC/4DC/4Di RAID devices. -.sp -.LP -The \fBamr\fR driver ports from FreeBSD and only supports basic RAID disk I/O -functions. -.SH DRIVER CONFIGURATION -.sp -.LP -There are no user configurable parameters available. Please configure your -hardware through BIOS. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amr\fR\fR -.ad -.RS 25n -32-bit ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/amr\fR\fR -.ad -.RS 25n -64-bit kernel module (x86 only). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amr.conf\fR\fR -.ad -.RS 25n -Driver configuration file (contains no user-configurable options). -.RE - -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBattributes\fR(5), \fBlsimega\fR(7D), -\fBscsi_hba_attach_setup\fR(9F), \fBscsi_sync_pkt\fR(9F), -\fBscsi_transport\fR(9F), \fBscsi_inquiry\fR(9S), \fBscsi_device\fR(9S), -\fBscsi_pkt\fR(9S) -.sp -.LP -\fISmall Computer System Interface-2 (SCSI-2)\fR diff --git a/usr/src/man/man7d/arcmsr.7d b/usr/src/man/man7d/arcmsr.7d deleted file mode 100644 index 32dea74672..0000000000 --- a/usr/src/man/man7d/arcmsr.7d +++ /dev/null @@ -1,114 +0,0 @@ -'\" te -.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. -.\" Copyright (c) 2008, 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 ARCMSR 7D "May 28, 2011" -.SH NAME -arcmsr \- SAS and SATA HBA driver for Areca Hardware Raid devices -.SH DESCRIPTION -.sp -.LP -The \fBarcmsr\fR host bus adapter driver is a SCSA-compliant nexus driver that -supports Areca Technology SAS and SATA RAID devices. -.sp -.LP -Supported SATA RAID cards: -.sp -.in +2 -.nf -ARC-1110 pci17d3,1110 -ARC-1120 pci17d3,1120 -ARC-1130 pci17d3,1130 -ARC-1160 pci17d3,1160 -ARC-1170 pci17d3,1170 -ARC-1201 pci17d3,1201 -ARC-1210 pci17d3,1210 -ARC-1220 pci17d3,1220 -ARC-1230 pci17d3,1230 -ARC-1260 pci17d3,1260 -ARC-1270 pci17d3,1270 -ARC-1280 pci17d3,1280 -.fi -.in -2 - -.sp -.LP -Supported SAS RAID cards: -.sp -.in +2 -.nf -ARC-1380 pci17d3,1380 -ARC-1381 pci17d3,1381 -ARC-1680 pci17d3,1680 -ARC-1681 pci17d3,1681 -ARC-1880 pci17d3,1880 -.fi -.in -2 - -.SH CONFIGURATION -.sp -.LP -There are no user configurable parameters available. Please configure your -hardware through the host system BIOS. -.SH FILES -.sp -.ne 2 -.na -\fB/kernel/drv/arcmsr\fR -.ad -.RS 28n -32-bit ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/arcmsr\fR -.ad -.RS 28n -64-bit kernel module (x64 only). -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/arcmsr.conf\fR -.ad -.RS 28n -Driver configuration file (contains no user-configurable options). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBattributes\fR(5), \fBscsi_hba_attach_setup\fR(9F), -\fBscsi_sync_pkt\fR(9F), \fBscsi_transport\fR(9F), \fBscsi_inquiry\fR(9S), -\fBscsi_device\fR(9S), \fBscsi_pkt\fR(9S) -.sp -.LP -\fISmall Computer System Interface-2 (SCSI-2)\fR -.sp -.LP -\fIhttp://www.areca.com.tw/products/main.htm\fR -.sp -.LP -\fIhttp://developer.intel.com/design/iio/index.htm\fR \(em(Intel Corp IO -processors provide the underlying RAID engine for the supported devices). diff --git a/usr/src/man/man7d/arn.7d b/usr/src/man/man7d/arn.7d deleted file mode 100644 index fdf564d05f..0000000000 --- a/usr/src/man/man7d/arn.7d +++ /dev/null @@ -1,75 +0,0 @@ -'\" te -.\" 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 ARN 7D "Aug 24, 2009" -.SH NAME -arn \- Atheros AR9280/9281/9285 IEEE802.11 a/b/g/n wireless network device -.SH DESCRIPTION -.sp -.LP -The \fBarn\fR IEEE802.11 a/b/g/n wireless driver is a loadable, clonable, -GLDv3-based STREAMS driver supporting Atheros AR9280/9281/9285 IEEE802.11 -a/b/g/n wireless network device. -.SS "Configuration" -.sp -.LP -The \fBarn\fR driver performs auto-negotiation to determine the data rate and -mode. The driver supports only BSS networks (also known as \fBap\fR or -\fBinfrastructure\fR networks) and \fBopen\fR(or \fBopen-system\fR) or -\fBshared system\fR authentication. For wireless security, WEP encryption, -WPA-PSK, and WPA2-PSK are currently supported. Configuration and administration -tasks can be performed with the \fBdladm\fR(1M) and \fBwificonfig\fR(1M) -utilities. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/arn\fR\fR -.ad -.RS 25n -Special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/arn\fR\fR -.ad -.RS 25n -32-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/arn\fR\fR -.ad -.RS 25n -64-bit ELF kernel driver module (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBdlpi\fR(7P), -\fBgld\fR(7D) diff --git a/usr/src/man/man7d/asy.7d b/usr/src/man/man7d/asy.7d deleted file mode 100644 index 9de8a2f94d..0000000000 --- a/usr/src/man/man7d/asy.7d +++ /dev/null @@ -1,276 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 ASY 7D "Oct 9, 2004" -.SH NAME -asy \- asynchronous serial port driver -.SH SYNOPSIS -.LP -.nf -#include <fcntl.h> -.fi - -.LP -.nf -#include <sys/termios.h> -.fi - -.LP -.nf -open("/dev/term/\fIn\fR", \fImode\fR); -.fi - -.LP -.nf -open("/dev/tty/\fIn\fR", \fImode\fR); -.fi - -.LP -.nf -open("/dev/cua/\fIn\fR", \fImode\fR); -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBasy\fR module is a loadable STREAMS driver that provides basic support -for Intel-8250, National Semiconductor-16450, 16550, and some 16650 and 16750 -and equivalent UARTs connected via the ISA-bus, in addition to basic -asynchronous communication support. The \fBasy\fR module supports those -\fBtermio\fR(7I) device control functions specified by flags in the -\fBc_cflag\fR word of the \fBtermios\fR structure, and by the \fBIGNBRK,\fR -\fBIGNPAR,\fR \fBPARMRK\fR, \fBINPCK\fR, \fBIXON\fR, \fBIXANY\fR, or -\fBIXOFF\fR flags in the c_iflag word of the termios structure. All other -\fBtermio\fR(7I) functions must be performed by \fBSTREAMS\fR modules pushed -atop the driver. When a device is opened, the \fBldterm\fR(7M) and -\fBttcompat\fR(7M) \fBSTREAMS\fR modules are automatically pushed on top of the -stream, providing the standard \fBtermio\fR(7I) interface. -.sp -.LP -The character-special devices \fB/dev/term/a\fR, \fB/dev/term/b\fR, -\fB/dev/term/c\fR and \fB/dev/term/d\fR are used to access the four standard -serial ports (COM1, COM2, COM3 and COM4 at I/O addresses 3f8, 2f8, 3e8 and 2e8 -respectively). Serial ports on non-standard ISA-bus I/O addresses are accessed -via the character-special devices \fB/dev/term/0\fR, \fB/dev/term/1\fR, etc. -Device names are typically used to provide a logical access point for a dial-in -line that is used with a modem. -.sp -.LP -To allow a single tty line to be connected to a modem and used for incoming and -outgoing calls, a special feature is available that is controlled by the minor -device number. By accessing character-special devices with names of the form -\fB/dev/cua/\fR\fIn, \fR it is possible to open a port without the \fBCarrier -Detect\fR signal being asserted, either through hardware or an equivalent -software mechanism. These devices are commonly known as dial-out lines. -.LP -Note - -.sp -.RS 2 -This module is affected by the setting of certain eeprom variables, -ttya-ignore-cd and ttya-rts-dtr-off (and similarly for ttyb-, ttyc-, and ttyd- -parameters). For information on these parameters, see the \fBeeprom\fR(1M) man -page. -.RE -.LP -Note - -.sp -.RS 2 -For serial ports on the standard COM1 to COM4 I/O addresses above, the default -setting for ttya-ignore-cd and ttya-rts-dtr-off is true. If any of these ports -are connected to a modem, these settings should be changed to false. For serial -ports on non-standard I/O addresses, the default setting for ttya-ignore-cd and -ttya-rts-dtr-off is false. -.RE -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -Once a \fB/dev/cua/\fR\fIn\fR line is opened, the corresponding tty line cannot -be opened until the \fB/dev/cua/\fR\fIn\fR line is closed. A blocking open will -wait until the \fB/dev/cua/\fR\fIn\fR line is closed (which will drop \fBData -Terminal Ready\fR, after which \fBCarrier Detect\fR will usually drop as well) -and carrier is detected again. A non-blocking open will return an error. If the -\fB/dev/ttyd\fR\fIn\fR line has been opened successfully (usually only when -carrier is recognized on the modem), the corresponding \fB/dev/cua/\fR\fIn\fR -line cannot be opened. This allows a modem to be attached to -\fB/dev/term/\fR[\fIn\fR] (renamed from \fB/dev/tty\fR[\fIn\fR]) and used for -dial-in (by enabling the line for login in \fB/etc/inittab\fR) or dial-out (by -\fBtip\fR(1) or \fBuucp\fR(1C)) as \fB/dev/cua/\fR\fIn\fR when no one is logged -in on the line. -.SH IOCTLS -.sp -.LP -The standard set of \fBtermio\fR \fBioctl()\fR calls are supported by -\fBasy\fR. -.sp -.LP -Breaks can be generated by the \fBTCSBRK,\fR \fBTIOCSBRK,\fR and \fBTIOCCBRK\fR -\fBioctl()\fR calls. -.sp -.LP -The input and output line speeds may be set to any speed that is supported by -\fBtermio\fR. The speeds cannot be set independently; for example, when the -output speed is set, the input speed is automatically set to the same speed. -.sp -.LP -When the \fBasy\fR module is used to service the serial console port, it -supports a BREAK condition that allows the system to enter the debugger or the -monitor. The BREAK condition is generated by hardware and it is usually enabled -by default. -.sp -.LP -A BREAK condition originating from erroneous electrical signals cannot be -distinguished from one deliberately sent by remote DCE. The Alternate Break -sequence can be used as a remedy against this. Due to a risk of incorrect -sequence interpretation, SLIP and certain other binary protocols should not be -run over the serial console port when Alternate Break sequence is in effect. -Although PPP is a binary protocol, it is able to avoid these sequences using -the ACCM feature in \fIRFC 1662\fR. For Solaris PPP 4.0, you do this by adding -the following line to the \fB/etc/ppp/options\fR file (or other configuration -files used for the connection; see \fBpppd\fR(1M) for details): -.sp -.in +2 -.nf -asyncmap 0x00002000 -.fi -.in -2 - -.sp -.LP -By default, the Alternate Break sequence is a three character sequence: -carriage return, tilde and control-B (CR ~ CTRL-B), but may be changed by the -driver. For more information on breaking (entering the debugger or monitor), -see \fBkbd\fR(1) and \fBkb\fR(7M). -.SH ERRORS -.sp -.LP -An \fBopen()\fR will fail under the following conditions: -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 9n -The unit being opened does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The dial-out device is being opened while the dial-in device is already open, -or the dial-in device is being opened with a no-delay open and the dial-out -device is already open. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The unit has been marked as exclusive-use by another process with a -\fBTIOCEXCL\fR \fBioctl()\fR call. -.RE - -.sp -.ne 2 -.na -\fB\fBEINTR\fR\fR -.ad -.RS 9n -The open was interrupted by the delivery of a signal. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/term/\fR[\fIa-d\fR]\fR -.ad -.br -.na -\fB\fB/dev/term/\fR[\fI012...\fR]\fR -.ad -.RS 25n -dial-in tty lines -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/cua/\fR[\fIa-d\fR]\fR -.ad -.br -.na -\fB\fB/dev/cua/\fR[\fI012...\fR]\fR -.ad -.RS 25n - dial-out tty lines -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/asy\fR\fR -.ad -.RS 25n -64-bit kernel module for 64-bit x86 platform -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/asy.conf\fR\fR -.ad -.RS 25n -\fBasy\fR configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBtip\fR(1), \fBkbd\fR(1), \fBuucp\fR(1C), \fBeeprom\fR(1M), \fBpppd\fR(1M), -\fBioctl\fR(2), \fBopen\fR(2), \fBtermios\fR(3C), \fBattributes\fR(5), -\fBldterm\fR(7M), \fBttcompat\fR(7M), \fBkb\fR(7M), \fBtermio\fR(7I) -.SH DIAGNOSTICS -.sp -.ne 2 -.na -\fB\fBasy\fR\fIn\fR\fB\|: silo overflow.\fR\fR -.ad -.sp .6 -.RS 4n -The hardware overrun occurred before the input character could be serviced. -.RE - -.sp -.ne 2 -.na -\fB\fBasy\fR\fIn\fR\fB\|: ring buffer overflow.\fR\fR -.ad -.sp .6 -.RS 4n -The driver's character input ring buffer overflowed before it could be -serviced. -.RE - diff --git a/usr/src/man/man7d/ata.7d b/usr/src/man/man7d/ata.7d deleted file mode 100644 index 9a08b674bf..0000000000 --- a/usr/src/man/man7d/ata.7d +++ /dev/null @@ -1,384 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ATA 7D "Aug 18, 2016" -.SH NAME -ata \- AT attachment disk driver -.SH SYNOPSIS -.LP -.nf -\fBide@unit-\fR\fIaddress\fR -.fi - -.SH DESCRIPTION -.LP -The \fBata\fR driver supports disk and ATAPI CD/DVD devices conforming to the -AT Attachment specification including IDE interfaces. Support is provided for -both parallel ATA (PATA) and serial ATA (SATA) interfaces. -.sp -.LP -Refer to the \fISolaris x86 Hardware Compatibility List\fR for a list of -supported controllers. -.SH PRECONFIGURE -.LP -A PCI IDE controller can operate in compatibility mode or in PCI-native mode. -If more than one controller is present in the system, only one can operate in -compatibility mode. -.sp -.LP -If two PATA drives share the same controller, you must set one to master and -the other to slave. If both a PATA disk drive and a PATA CD-ROM drive utilize -the same controller, you can designate the disk drive as the master with the -CD-ROM drive as the slave, although this is not mandatory. -.SS "Supported Settings" -.LP -Supported settings for the primary controller when in compatibility mode are: -.RS +4 -.TP -.ie t \(bu -.el o -IRQ Level: 14 -.RE -.RS +4 -.TP -.ie t \(bu -.el o -I/O Address: 0x1F0 -.RE -.sp -.LP -Supported settings for the secondary controller when in compatibility mode are: -.RS +4 -.TP -.ie t \(bu -.el o -IRQ Level: 15 -.RE -.RS +4 -.TP -.ie t \(bu -.el o -I/O Address: 0x170 -.RE -.LP -Note - -.sp -.RS 2 -When in PCI-native mode, the IRQ and I/O address resources are configured by -the system BIOS. -.RE -.SS "Known Problems and Limitations" -.RS +4 -.TP -.ie t \(bu -.el o -This driver does not support any RAID features present on a PATA/SATA -controller. As a result, you should configure BIOS to select IDE mode rather -than RAID mode. Some systems may require updating BIOS to allow switching -modes. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -On some systems, the SATA controller must have option ROM enabled or BIOS will -not consider SATA drives as bootable devices. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Panasonic LK-MC579B and the Mitsumi FX34005 IDE CD-ROM drives are not supported -and cannot be used to install the Solaris operating environment. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -CMD-604 is unable to handle simultaneous I/O on both IDE interfaces. This -defect causes the Solaris software to hang if both interfaces are used. Use -only the primary IDE interface at address 0x1F0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -NEC CDR-260/CDR-260R/CDR-273 and Sony CDU-55E ATAPI CD-ROM drives might fail -during installation. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Sony CDU-701 CD-ROM drives must be upgraded to use firmware version 1.0r or -later to support booting from the CD. -.sp -A Compact Flash(CF) card can work as an ATA disk through a CF-to-ATA adapter. -If both card and adapter implement Compact Flash Version 2.0, DMA is supported. -If either of them does not, you should set ata-disk-dma-enabled to '0.' -.RE -.SH CONFIGURATION -.LP -The ata driver properties are usually set in \fBata.conf\fR. However, it may be -convenient, or in some cases necessary, for you to set some of the DMA related -properties as a system global boot environment property. You set or modify -properties in the boot environment immediately prior to booting the illumos -kernel using the boot loader command line. You can also set -boot environment properties using the \fBeeprom\fR(1M) command or by editing -the \fBbootenv.rc\fR configuration file. If a property is set in both the -driver's \fBata.conf\fR file and the boot environment, the \fBata.conf\fR -property takes precedence. -.sp -.LP -Property modifications other than with the boot loader command line are -not effective until you reboot the system. Property modifications via the -boot loader command line do not persist across future boots. -.sp -.LP -Direct Memory Access is enabled for disks and atapi CD/DVD by default. If you -want to disable DMA when booting from a CD/DVD, you must first set -atapi-cd-dma-enabled to 0 using the boot loader command line. -.sp -.ne 2 -.na -\fB\fBata-dma-enabled\fR\fR -.ad -.RS 27n -This property is examined before the DMA properties discussed below. If it is -set to '0,' DMA is disabled for all ATA/ATAPI devices, and no further property -checks are made. If this property is absent or is set to '1,' DMA status is -determined by further examining one of the other properties listed below. -.RE - -.sp -.ne 2 -.na -\fB\fBata-disk-dma-enabled\fR\fR -.ad -.RS 27n -This property is examined only for ATA disk devices, and only if -ata-dma-enabled is not set to '0.' -.sp -If ata-disk-dma-enabled set to '0,' DMA is disabled for all ATA disks in the -system. If this property is absent or set to '1,' DMA is enabled for all ATA -disks and no further property checks are made. If needed, this property should -be created by the administrator using the boot loader command line or the -\fBeeprom\fR(1M) command. -.RE - -.sp -.ne 2 -.na -\fB\fBatapi-cd-dma-enabled\fR\fR -.ad -.RS 27n -This property is examined only for ATAPI CD/DVD devices, and only if -ata-dma-enabled is not set to '0.' -.sp -If atapi-cd-dma-enabled is absent or set to '0,' DMA is disabled for all ATAPI -CD/DVD's. If set to '1,' DMA is enabled and no further property checks are -made. -.sp -The Solaris installation program creates this property in the boot environment -with a value of '1.' It can be changed with the boot loader command line -or \fBeeprom\fR(1M) as shown in the Example section of this manpage. -.RE - -.sp -.ne 2 -.na -\fB\fBatapi-other-dma-enabled\fR\fR -.ad -.RS 27n -This property is examined only for non-CD/DVD ATAPI devices such as ATAPI tape -drives, and only if ata-dma-enabled is not set to '0.' -.sp -If atapi-other-dma-enabled is set to '0,' DMA is disabled for all non-CD/DVD -ATAPI devices. If this property is absent or set to '1,' DMA is enabled and no -further property checks are made. -.sp -If needed, this property should be created by the administrator using the -boot loader command line or the \fBeeprom\fR(1M) command. -.RE - -.sp -.ne 2 -.na -\fB\fBdrive0_block_factor\fR\fR -.ad -.br -.na -\fB\fBdrive1_block_factor\fR\fR -.ad -.RS 27n -\fBATA\fR controllers support some amount of buffering (blocking). The purpose -is to interrupt the host when an entire buffer full of data has been read or -written instead of using an interrupt for each sector. This reduces interrupt -overhead and significantly increases throughput. The driver interrogates the -controller to find the buffer size. Some controllers hang when buffering is -used, so the values in the configuration file are used by the driver to reduce -the effect of buffering (blocking). The values presented may be chosen from -\fB0x1\fR, \fB0x2\fR, \fB0x4\fR, \fB0x8\fR and \fB0x10\fR. -.sp -The values as shipped are set to \fB0x1\fR, and they can be tuned to increase -performance. -.sp -If your controller hangs when attempting to use higher block factors, you may -be unable to reboot the system. For x86 based systems, it is recommended that -tuning be performed using a duplicate of the \fB/platform/i86pc/kernel\fR -directory subtree. This ensures that a bootable kernel subtree exists in the -event of a failed test. -.RE - -.sp -.ne 2 -.na -\fB\fBata-revert-to-defaults\fR\fR -.ad -.br -.na -\fB\fBrevert\(em<diskmodel>\fR\fR -.ad -.RS 27n -When rebooting or shutting down, the driver can set a feature which allows the -drive to return to the power-on settings when the drive receives a software -reset (SRST) sequence. If this property is present and set to 1, the driver -will set the feature to revert to defaults during reset. Setting this property -to 1 may prevent some systems from soft-rebooting and would require cycling the -power to boot the system. If this property is not present the system will not -set the feature to revert to defaults during reset. -.sp -To determine the string to substitute for <diskmodel>, boot your system (you -may have to press the reset button or power-cycle) and then view -\fB/var/adm/messages\fR. Look for the string "IDE device at targ" or "ATAPI -device at targ." The next line will contain the word "model" followed by the -model number and a comma. Ignore all characters except letters, digits, ".", -"_", and "-". Change uppercase letters to lower case. If the string -revert-<diskmodel> is longer than 31 characters, use only the first 31 -characters. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSample ata Configuration File -.sp -.in +2 -.nf -\fB# for higher performance - set block factor to 16 - drive0_block_factor=0x1 drive1_block_factor=0x1 - max_transfer=0x100 - flow_control="dmult" queue="qsort" disk="dadk" ;\fR -.fi -.in -2 - -.LP -\fBExample 2 \fRRevert to defaults property -.sp -.in +2 -.nf -\fBrevert-st320420a=1;\fR -.fi -.in -2 - -.sp -.LP -Output of \fB/var/adm/messages\fR: - -.sp -.in +2 -.nf -Aug 17 06:49:43 caesar ata:[ID 640982 kern.info] IDE device at targ 0, - lun 0 lastlun 0x0 -Aug 17 06:49:43 caesar ata:[ID 521533 kern.info] model ST320420A, stat -.fi -.in -2 - -.LP -\fBExample 3 \fRChange DMA property using the boot loader command line -.sp -.LP -To change a DMA property using the boot loader command line: - -.RS +4 -.TP -1. -Reset the system. -.RE -.RS +4 -.TP -2. -Press "Esc" to interrupt the timeout. -.RE -.RS +4 -.TP -3. -Enter: boot -B atapi-cd-dma-enabled=1 -.RE -.LP -\fBExample 4 \fRChange DMA Property with eeprom(1M) -.sp -.LP -To enable DMA for optical devices while the Solaris kernel is running with the -\fBeeprom\fR(1M) system command: - -.sp -.in +2 -.nf -eeprom 'atapi-cd-dma-enabled=1' -.fi -.in -2 - -.SH FILES -.ne 2 -.na -\fB\fB/platform/i86pc/kernel/drv/ata\fR\fR -.ad -.sp .6 -.RS 4n -Device driver. -.RE - -.sp -.ne 2 -.na -\fB\fB/platform/i86pc/kernel/drv/ata.conf\fR\fR -.ad -.sp .6 -.RS 4n -Configuration file. -.RE - -.sp -.ne 2 -.na -\fB\fB/boot/solaris/bootenv.rc\fR\fR -.ad -.sp .6 -.RS 4n -Boot environment variables file for Solaris x86. \fBeeprom\fR(1M) can be used -to modify properties in this file. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.LP -\fBeeprom\fR(1M), \fBattributes\fR(5) -.sp -.LP -\fIINCITS T13 ATA/ATAPI-7\fR specifications diff --git a/usr/src/man/man7d/atge.7d b/usr/src/man/man7d/atge.7d deleted file mode 100644 index 2811ba6558..0000000000 --- a/usr/src/man/man7d/atge.7d +++ /dev/null @@ -1,108 +0,0 @@ -'\" te -.\" Copyright (c) 2012 Gary Mills -.\" 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 ATGE 7D "Sep 11, 2009" -.SH NAME -atge \- Device driver for Atheros/Attansic Ethernet chipsets -.SH DESCRIPTION -.sp -.LP -The \fBatge\fR ethernet driver supports the -Atheros/Attansic L1, L1E, and L1C Ethernet -(AR8121/AR8113/8114, AR8131/AR8132, and AR8151/AR8152) chipsets: -.sp -.in +2 -.nf -pciex1969,1026 Atheros AR8121/8113/8114 -pciex1969,1048 Attansic L1 -pciex1969,1062 Atheros AR8132 Fast Ethernet -pciex1969,1063 Atheros AR8131 Gigabit Ethernet -pciex1969,1073 Atheros AR8151 v1.0 Gigabit Ethernet -pciex1969,1083 Atheros AR8151 v2.0 Gigabit Ethernet -pciex1969,2060 Atheros AR8152 v1.1 Fast Ethernet -pciex1969,2062 Atheros AR8152 v2.0 Fast Ethernet -.fi -.in -2 -.sp - -.sp -.LP -The \fBatge\fR driver supports IEEE 802.3 auto-negotiation, flow control and -VLAN tagging. -.SS "Configuration" -.sp -.LP -The default configuration is auto-negotiation with bi-directional flow control. -The advertised capabilities for auto-negotiation are based on the capabilities -of the \fBPHY\fR. -.sp -.LP -You can set the capabilities advertised by the \fBatge\fR controlled device -using \fBdladm\fR(1M). The driver supports only those parameters which begin -with en (enabled) in the parameters listed by the command \fBdladm\fR(1M). Each -of these boolean parameters determines if the device advertises that mode of -operation when the hardware supports it. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/atge\fR\fR -.ad -.RS 26n -Special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/atge\fR\fR -.ad -.RS 26n -32-bit device drive (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/atge\fR\fR -.ad -.RS 26n -64-bit device driver (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attribute: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBndd\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), -\fBattributes\fR(5), \fBieee802.3\fR(5), \fBdlpi\fR(7P), \fBstreamio\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fINetwork Interface Guide\fR -.sp -.LP -\fISTREAMS Programmer's Guide\fR -.sp -.LP -\fIIEEE 802.3ae Specification, 2002\fR diff --git a/usr/src/man/man7d/ath.7d b/usr/src/man/man7d/ath.7d deleted file mode 100644 index 58dc94a532..0000000000 --- a/usr/src/man/man7d/ath.7d +++ /dev/null @@ -1,93 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 ATH 7D "Nov 14, 2006" -.SH NAME -ath \- Atheros AR52xx 802.11b/g wireless NIC driver -.SH DESCRIPTION -.sp -.LP -The \fBath\fR \fI802.11b/g \fR wireless NIC driver is a multi-threaded, -loadable, clonable, GLDv3-based STREAMS driver for the Atheros AR52xx -(AR5210/5211/5212) chipset-based wireless NIC. -.sp -.LP -The \fBath\fR driver functions include controller initialization, wireless -\fI802.11b/g\fR infrastructure network connection, WEP, frame transmit and -receive, and promiscuous and multi-cast support. -.SH DRIVER CONFIGURATION -.sp -.LP -The \fBath\fR driver performs auto-negotiation to determine the data rates and -mode. Supported \fI802.11b\fR data rates (Mbits/sec.) are 1, 2, 5.5 and 11. -Supported \fI802.11g\fR data rates (Mbits/sec.) are 1, 2, 5.5, 11, 6, 9, 12, -18, 24, 36, 48 and 54. -.sp -.LP - The \fBath\fR driver supports only BSS networks (also known as "ap" or -"infrastructure" networks) and the "open" (or "opensystem") authentication -type. Only WEP encryption is currently supported. Configuration and -administration can be performed through the \fBdladm\fR(1M) or -\fBwificonfig\fR(1M) utilities. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/ath*\fR \fR -.ad -.RS 26n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ath\fR \fR -.ad -.RS 26n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ath\fR \fR -.ad -.RS 26n -64-bit ELF kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBgld\fR(7D) -.sp -.LP -\fIANSI/IEEE Std 802.11\fR- Standard for Wireless LAN Technology, 1999. -.sp -.LP -\fIIEEE Std 802.11a\fR- Standard for Wireless LAN Technology-Rev. A, 2003 -.sp -.LP -\fIIEEE Std 802.11b\fR - Standard for Wireless LAN Technology-Rev.B, 2003 -.sp -.LP -\fIIEEE Std 802.11g\fR\(em Standard for Wireless LAN Technology - Rev. G, 2003 diff --git a/usr/src/man/man7d/atu.7d b/usr/src/man/man7d/atu.7d deleted file mode 100644 index eecb895078..0000000000 --- a/usr/src/man/man7d/atu.7d +++ /dev/null @@ -1,82 +0,0 @@ -'\" te -.\" 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] -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.TH ATU 7D "Mar 26, 2009" -.SH NAME -atu \- Atmel AT76C50x USB IEEE 802.11b Wireless Device Driver -.SH DESCRIPTION -.sp -.LP -The \fBatu 802.11b\fR wireless driver is a multi-threaded, loadable, clonable, -GLDv3-based STREAMS driver supporting the Atmel AT76C50x chipset-based wireless -devices. -.SS "Configuration" -.sp -.LP -The \fBatu\fR driver performs auto-negotiation to determine the data rate and -mode. Supported 802.11b data rates are 1, 2, 5.5, and 11 Mbits/sec. -.sp -.LP -The \fBatu\fR driver supports only BSS networks (also known as \fBap\fR or -\fBinfrastructure\fR networks). -.sp -.LP -\fBopen\fR (or \fBopen-system\fR) and \fBshared key\fR authentication modes are -supported. Encryption types WEP40 and WEP104 are supported. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/atu*\fR\fR -.ad -.RS 25n -Special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/atu\fR\fR -.ad -.RS 25n -32-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/atu\fR\fR -.ad -.RS 25n -64-bit ELF kernel module (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBdlpi\fR(7P), -\fBgld\fR(7D) -.sp -.LP -\fI802.11 - Wireless LAN Media Access Control and Physical Layer Specification -- IEEE, 2001\fR diff --git a/usr/src/man/man7d/audio.7d b/usr/src/man/man7d/audio.7d deleted file mode 100644 index 76aa2bdf8e..0000000000 --- a/usr/src/man/man7d/audio.7d +++ /dev/null @@ -1,177 +0,0 @@ -'\" te -.\" 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 AUDIO 7D "Jan 10, 2020" -.SH NAME -audio \- common audio framework -.SH DESCRIPTION -The \fBaudio\fR driver provides common support routines for audio devices in -Solaris. -.sp -.LP -The audio framework supports multiple \fBpersonalities\fR, allowing for devices -to be accessed with different programming interfaces. -.sp -.LP -The audio framework also provides a number of facilities, such as mixing of -audio streams, and data format and sample rate conversion. -.SS "Overview" -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" -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" -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" -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 -the best approximation of an input signal, the highest possible sampling -frequency and precision should be used. However, increased accuracy comes at a -cost of increased data storage requirements. For instance, one minute of -monaural audio recorded in u-Law format (pronounced \fBmew-law\fR) at 8 KHz -requires nearly 0.5 megabytes of storage, while the standard Compact Disc audio -format (stereo 16-bit linear PCM data sampled at 44.1 KHz) requires -approximately 10 megabytes per minute. -.sp -.LP -An audio data format is characterized in the audio driver by four parameters: -sample Rate, encoding, precision, and channels. Refer to the device-specific -manual pages for a list of the audio formats that each device supports. In -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" -Sample rate is a number that represents the sampling frequency (in samples per -second) of the audio data. -.sp -.LP -The audio mixer always configures the hardware for the highest possible sample -rate for both play and record. This ensures that none of the audio streams -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, 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 -sampled by 160 and then down sampled by 147. This is only done using integer -multipliers. -.sp -.LP -Applications can greatly reduce the impact of sample rate conversion by -carefully picking the sample rate. Applications should always use the highest -sample rate the device supports. An application can also do its own sample rate -conversion (to take advantage of floating point and accelerated instructions) -or use small integers for up and down sampling. -.sp -.LP -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" -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 -also part of CCITT G.711 and is the standard encoding for telephony elsewhere -in the world. A-Law and u-Law audio data are sampled at a rate of 8000 samples -per second with 12-bit precision, with the data compressed to 8-bit samples. -The resulting audio data quality is equivalent to that of stan dard analog -telephone service. -.sp -.LP -Linear Pulse Code Modulation (PCM) is an uncompressed, signed audio format in -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" -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" -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, -corresponding to the left and right channel data. The audio mixer sets the -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" -The audio mixer supports the following audio formats: -.sp -.in +2 -.nf -Encoding Precision Channels -Signed Linear PCM 32-bit Mono or Stereo -Signed Linear PCM 16-bit Mono or Stereo -Signed Linear PCM 8-bit Mono or Stereo -u-Law 8-bit Mono or Stereo -A-Law 8-bit Mono or Stereo -.fi -.in -2 -.sp - -.sp -.LP -The audio mixer converts all audio streams to 24-bit Linear PCM before mixing. -After mixing, conversion is made to the best possible Codec format. The -conversion process is not compute intensive and audio applications can choose -the encoding format that best meets their needs. -.sp -.LP -The mixer discards the low order 8 bits of 32-bit Signed Linear PCM in order to -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 -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audio\fR\fR -.ad -.RS 29n -Device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/audio\fR\fR -.ad -.RS 29n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audio.conf\fR\fR -.ad -.RS 29n -Driver configuration file -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBdsp\fR(7I) diff --git a/usr/src/man/man7d/audio1575.7d b/usr/src/man/man7d/audio1575.7d deleted file mode 100644 index e071e73a30..0000000000 --- a/usr/src/man/man7d/audio1575.7d +++ /dev/null @@ -1,99 +0,0 @@ -'\" te -.\" 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 AUDIO1575 7D "May 13, 2009" -.SH NAME -audio1575 \- Uli M1575 Super South Bridge audio digital controller interface -.SH DESCRIPTION -.sp -.LP -The \fBaudio1575\fR device uses the Uli M1575 AC97-compatible audio digital -controller and an AC-97 Codec to implement the audio device interface. This -interface allows analog only inputs and outputs. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/audio1575\fR\fR -.ad -.sp .6 -.RS 4n -64-bit driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audio1575.conf\fR\fR -.ad -.sp .6 -.RS 4n -Driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -_ -Stability level Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) -.sp -.LP -\fIUli M1575 Super South Bridge Data Sheet Data Sheet\fR\(em Uli USA Inc. -.sp -.LP -\fIAD1981B AC '97 SoundMAX(R) Codec Data Sheet\fR\(em Analog Devices Inc. -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages might appear on the system -console: -.sp -.ne 2 -.na -\fB\fBplay-interrupts too low\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too low\fR\fR -.ad -.RS 30n -The interrupt rate specified in \fBaudio1575.conf\fR is set too low. It has -been reset to the rate specified in the message. Update \fBaudio1575.conf\fR to -a higher interrupt rate. -.RE - -.sp -.ne 2 -.na -\fB\fBplay-interrupts too high\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too high\fR\fR -.ad -.RS 30n -The interrupt rate specified in \fBaudio1575.conf\fR is set too high. It has -been reset to the rate specified in the message. Update \fBaudio1575.conf\fR to -a lower interrupt rate. -.RE - diff --git a/usr/src/man/man7d/audio810.7d b/usr/src/man/man7d/audio810.7d deleted file mode 100644 index 53abf390d5..0000000000 --- a/usr/src/man/man7d/audio810.7d +++ /dev/null @@ -1,104 +0,0 @@ -'\" te -.\" 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 AUDIO810 7D "September 12, 2020" -.SH NAME -audio810 \- Intel ICH series, nVidia nForce series and AMD 8111 audio core -support -.SH DESCRIPTION -The \fBaudio810\fR driver provides support for AC 97 audio controllers embedded -in Intel ICH, nVidia nForce, and AMD 8111 chips. -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/audio810\fR\fR -.ad -.RS 30n -32-bit kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audio810\fR\fR -.ad -.RS 30n -64-bit x86 kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audio810.conf\fR\fR -.ad -.RS 30n -\fBaudio810\fR driver configuration file -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PC-based systems -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) -.sp -.LP -\fIAMD-8111 HyperTransport I/O Hub Data Sheet\fR \(em Advanced Micro Devices -Inc. -.sp -.LP -\fIALC655 Specification\fR \(em Realtek Inc. -.SH NOTES -Some laptops (including Sony VAIO, among others), have their on-board amplifier -powered down by default, meaning that audio is suppressed even if hardware and -the \fBaudio810\fR driver are working normally. To correct this, set the -\fBac97-invert-amp=1\fR property in the \fB/kernel/drv/audio810.conf\fR to -power-up the amplifier. -.SH DIAGNOSTICS -In addition to being logged, the following messages may appear on the system -console: -.sp -.ne 2 -.na -\fB\fBplay-interrupts too low\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too low\fR\fR -.ad -.RS 30n -The interrupt rate in \fBaudio810.conf\fR is set too low. It has been reset to -the rate specified in the message. Update \fBaudio810.conf\fR to a higher -interrupt rate. -.RE - -.sp -.ne 2 -.na -\fB\fBplay-interrupts too high\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too high\fR\fR -.ad -.RS 30n -The interrupt rate set in \fBaudio810.conf\fR is set too high. It has been -reset to the rate specified in the message. Update \fBaudio810.conf\fR to a -lower interrupt rate. -.RE - diff --git a/usr/src/man/man7d/audiocmi.7d b/usr/src/man/man7d/audiocmi.7d deleted file mode 100644 index a74ab6eb81..0000000000 --- a/usr/src/man/man7d/audiocmi.7d +++ /dev/null @@ -1,76 +0,0 @@ -'\" te -.\" 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 AUDIOCMI 7D "Aug 17, 2009" -.SH NAME -audiocmi \- C-Media 8738, 8768, and 8338 driver support -.SH DESCRIPTION -.sp -.LP -The \fBaudiocmi\fR driver provides support for the C-Media 8738, 8768, and 8338 -audio controllers. These are found on some motherboards and some add-in PCI -cards. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiocmi\fR\fR -.ad -.sp .6 -.RS 4n -32-bit kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audiocmi\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/audiocmi\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiocmi.conf\fR\fR -.ad -.sp .6 -.RS 4n -Driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PC-based system -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) diff --git a/usr/src/man/man7d/audiocmihd.7d b/usr/src/man/man7d/audiocmihd.7d deleted file mode 100644 index 52038cb4df..0000000000 --- a/usr/src/man/man7d/audiocmihd.7d +++ /dev/null @@ -1,63 +0,0 @@ -'\" t -.\" 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 2011 Nexenta Systems, Inc. All rights reserved. -.\" -.TH AUDIOCMIHD 7D "Mar 18, 2011" -.SH NAME -audiocmihd \- CMI8788 HD audio driver -.SH DESCRIPTION -.sp -.LP -The \fBaudiocmihd\fR driver provides support for audio devices based on -the CMedia 8788 and similar parts. Most often these are seen in -devices sold under the Asus Xonar brand. -.SH FILES -.sp -.ne 2 -.na -\fB/kernel/drv/audiocmihd\fR -.ad -.sp .6 -.RS 4n -32-bit kernel module -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/audiocmihd\fR -.ad -.sp .6 -.RS 4n -64-bit kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBaudio\fR(7I), \fBdsp\fR(7I), \fBmixer\fR(7I) diff --git a/usr/src/man/man7d/audiocs.7d b/usr/src/man/man7d/audiocs.7d deleted file mode 100644 index ab555b8cd2..0000000000 --- a/usr/src/man/man7d/audiocs.7d +++ /dev/null @@ -1,104 +0,0 @@ -'\" te -.\" 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 AUDIOCS 7D "May 12, 2009" -.SH NAME -audiocs \- Crystal Semiconductor 4231 Audio driver -.SH DESCRIPTION -.sp -.LP -The \fBaudiocs\fR driver supports the Crystal Semiconductor 4231 Codec to -implement the audio device interface. -.sp -.LP -The \fBaudiocs\fR device provides support for the internal speaker, headphone, -line out, line in, microphone, and, on some platforms, internal CD-ROM audio -in. -.SH ERRORS -.sp -.LP -\fBaudiocs\fR errors are described in the \fBaudio\fR(7I) manual page. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/audiocs\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBaudiocs\fR driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiocs.conf\fR\fR -.ad -.sp .6 -.RS 4n -\fBaudiocs\fR driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -_ -Stability level Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) -.sp -.LP -Crystal Semiconductor, Inc. \fBCS4231\fR Data Sheet -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages can appear on the system -console: -.sp -.ne 2 -.na -\fB\fBplay-interrupts too low\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too low\fR\fR -.ad -.RS 30n -The interrupt rate specified in \fBaudiocs.conf\fR is set too low. It is being -reset to the rate specified in the message. Update \fBaudiocs.conf\fR to a -higher interrupt rate. -.RE - -.sp -.ne 2 -.na -\fB\fBplay-interrupts too high\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too high\fR\fR -.ad -.RS 30n -The interrupt rate specified in \fBaudiocs.conf\fR is set too high. It is being -reset to the rate specified in the message. Update \fBaudiocs.conf\fR to a -lower interrupt rate. -.RE - diff --git a/usr/src/man/man7d/audioemu10k.7d b/usr/src/man/man7d/audioemu10k.7d deleted file mode 100644 index a5b3d826fb..0000000000 --- a/usr/src/man/man7d/audioemu10k.7d +++ /dev/null @@ -1,66 +0,0 @@ -'\" t -.\" 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 2011 Nexenta Systems, Inc. All rights reserved. -.\" -.TH AUDIOEMU10K 7D "Mar 18, 2011" -.SH NAME -audioemu10k \- EMU10K audio driver -.SH DESCRIPTION -.sp -.LP -The \fBaudioemu10\fR driver provides support for audio devices based on -the Creative EMU10K1 and EMU10K2 chips. Most often these are seen in -devices sold under the Audigy or Sound Blaster Live! brand names. -.LP -The \fBaudioemu10k\fR driver provides support for surround sound and -SPDIF features on devices with such capabilities. -.SH FILES -.sp -.ne 2 -.na -\fB/kernel/drv/audioemu10k\fR -.ad -.sp .6 -.RS 4n -32-bit kernel module -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/audioemu10k\fR -.ad -.sp .6 -.RS 4n -64-bit kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBaudio\fR(7I), \fBdsp\fR(7I), \fBmixer\fR(7I) diff --git a/usr/src/man/man7d/audioens.7d b/usr/src/man/man7d/audioens.7d deleted file mode 100644 index bfe24ebd8c..0000000000 --- a/usr/src/man/man7d/audioens.7d +++ /dev/null @@ -1,67 +0,0 @@ -'\" te -.\" 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 AUDIOENS 7D "May 15, 2009" -.SH NAME -audioens \- Ensoniq ESS 1371 and ESS 1373 audio driver -.SH DESCRIPTION -.sp -.LP -The \fBaudioens\fR driver provides support for the Ensoniq ESS1371, ESS1373, -and Creative 5880 AC'97 devices. These devices are commonly known by several -different names, including the Sound Blaster PCI128 and AudioPCI '97. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audioens\fR\fR -.ad -.sp .6 -.RS 4n -32-bit kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audioens\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/audioens\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBaudio\fR(7I), \fBdsp\fR(7I), \fBmixer\fR(7I) diff --git a/usr/src/man/man7d/audiohd.7d b/usr/src/man/man7d/audiohd.7d deleted file mode 100644 index 4b50c86861..0000000000 --- a/usr/src/man/man7d/audiohd.7d +++ /dev/null @@ -1,105 +0,0 @@ -'\" te -.\" 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 AUDIOHD 7D "May 12, 2009" -.SH NAME -audiohd \- Intel High Definition Audio Controller support -.SH DESCRIPTION -.sp -.LP -The \fBaudiohd\fR driver provides support for the generic codec chips which are -compatible with the Intel High-Definition Audio Controller 1.0 specification. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiohd.conf\fR\fR -.ad -.RS 29n -\fBaudiohd\fR driver configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiohd\fR\fR -.ad -.RS 29n -32-bit x86 kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audiohd\fR\fR -.ad -.RS 29n -64-bit x86 kernel driver module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PC-based system -_ -Stability level Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) -.sp -.LP -\fIIntel High-Definition Audio Specification 1.0.\fR - Intel Corporation -.sp -.LP -\fIALC880 Specification\fR \(em Realtek Inc. -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages can appear on the system -console: -.sp -.ne 2 -.na -\fB\fBplay-interrupts too low\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too low\fR\fR -.ad -.RS 30n -The interrupt rate in \fBaudiohd.conf\fR is set too low. It has been reset to -the rate specified in the message. Update \fBaudiohd.conf\fR to a higher -interrupt rate. -.RE - -.sp -.ne 2 -.na -\fB\fBredcord-interrupts too low\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too high\fR\fR -.ad -.RS 30n -The interrupt rate in \fBaudiohd.conf\fR is set too low. It has been reset to -the rate specified in the message. Update \fBaudiohd.conf\fR to a higher -interrupt rate -.RE - diff --git a/usr/src/man/man7d/audioixp.7d b/usr/src/man/man7d/audioixp.7d deleted file mode 100644 index c0871fb91d..0000000000 --- a/usr/src/man/man7d/audioixp.7d +++ /dev/null @@ -1,106 +0,0 @@ -'\" te -.\" 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 AUDIOIXP 7D "May 12, 2009" -.SH NAME -audioixp \- ATI IXP400 south bridge audio digital controller interface -.SH DESCRIPTION -.sp -.LP -The \fBaudioixp\fR device uses the IXP400 south bridge audio digital controller -and a AC-97 Codec to implement the audio device interface. -.sp -.LP -The \fBaudioixp\fR device provides support for the internal speaker, -headphone, line out, line in, and microphone. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audioixp.conf\fR\fR -.ad -.RS 30n -Driver configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audioixp\fR\fR -.ad -.RS 30n -32-bit kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audioixp\fR\fR -.ad -.RS 30n -64-bit kernel driver module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PC-based system -_ -Stability level Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) -.sp -.LP -\fIATI IXP400 South Bridge Data Sheet\fR -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages may appear on the system -console: -.sp -.ne 2 -.na -\fB\fBplay-interrupts too low\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too low\fR\fR -.ad -.RS 30n -The interrupt rate in \fBaudioixp.conf\fR is set too low. It has been reset to -the rate specified in the message. Update \fBaudioixp.conf\fR to a higher -interrupt rate. -.RE - -.sp -.ne 2 -.na -\fB\fBplay-interrupts too high\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too high\fR\fR -.ad -.RS 30n -The interrupt rate set in \fBaudioixp.conf\fR is set too high. It has been -reset to the rate specified in the message. Update \fBaudioixp.conf\fR to a -lower interrupt rate. -.RE - diff --git a/usr/src/man/man7d/audiols.7d b/usr/src/man/man7d/audiols.7d deleted file mode 100644 index a1b29e76f2..0000000000 --- a/usr/src/man/man7d/audiols.7d +++ /dev/null @@ -1,60 +0,0 @@ -'\" te -.\" 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 AUDIOLS 7D "Sep 8, 2009" -.SH NAME -audiols \- Creative Audigy LS audio device support -.SH DESCRIPTION -.sp -.LP -The \fBaudiols\fR driver provides support for the Creative Audigy LS audio -device. -.sp -.LP -There are numerous devices marketed under the Audigy brand by Creative, but -only Audigy LS devices are supported by this driver. -.sp -.LP -This device is capable of 5.1 surround sound. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiols\fR\fR -.ad -.RS 29n -32-bit kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audiols\fR\fR -.ad -.RS 29n -64-bit kernel driver module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) diff --git a/usr/src/man/man7d/audiop16x.7d b/usr/src/man/man7d/audiop16x.7d deleted file mode 100644 index fc04871739..0000000000 --- a/usr/src/man/man7d/audiop16x.7d +++ /dev/null @@ -1,73 +0,0 @@ -'\" te -.\" 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 AUDIOP16X 7D "Sep 8, 2009" -.SH NAME -audiop16x \- Creative Sound Blaster Live! OEM support -.SH DESCRIPTION -.sp -.LP -The \fBaudiop16x\fR driver provides support for the Creative Sound Blaster -Live! products based on the P16X device. These chips are also known as the -\fBEMU10K1X\fR device, not to be confused with the \fBEMU10K1\fR. -.sp -.LP -Add-in boards known to work with this driver are Sound Blaster Live! cards with -model numbers SB0200 or SB0213. -.sp -.LP -This device is capable of 5.1 surround sound. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiop16x\fR\fR -.ad -.sp .6 -.RS 4n -32-bit kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audiop16x\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/audiop16x\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC kernel driver module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86, SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) diff --git a/usr/src/man/man7d/audiopci.7d b/usr/src/man/man7d/audiopci.7d deleted file mode 100644 index 116efce9f3..0000000000 --- a/usr/src/man/man7d/audiopci.7d +++ /dev/null @@ -1,71 +0,0 @@ -'\" te -.\" 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 AUDIOPCI 7D "May 13, 2017" -.SH NAME -audiopci \- Ensoniq 1370 driver support -.SH DESCRIPTION -.LP -The \fBaudiopci\fR driver provides support for the Ensoniq 1370 audio -controller. Ensoniq 1370 chips are found on add-in PCI cards commonly -identified as Audio PCI and SoundBlaster PCI. -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/audiopci\fR\fR -.ad -.RS 30n -32-bit kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audiopci\fR\fR -.ad -.RS 30n -64-bit x86 kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/audiopci\fR\fR -.ad -.RS 30n -64-bit SPARC kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiopci.conf\fR\fR -.ad -.RS 30n -Driver configuration file -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) -.sp -.LP -\fICreative Technology Ltd ES1370 Specification\fR diff --git a/usr/src/man/man7d/audiosolo.7d b/usr/src/man/man7d/audiosolo.7d deleted file mode 100644 index cabe29ba74..0000000000 --- a/usr/src/man/man7d/audiosolo.7d +++ /dev/null @@ -1,56 +0,0 @@ -'\" te -.\" 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 AUDIOSOLO 7D "Sep 18, 2009" -.SH NAME -audiosolo \- ESS Solo-1 audio device support -.SH DESCRIPTION -.sp -.LP -The \fBaudiosolo\fR driver provides support for the ESS Solo-1 audio device. -This device is found on certain motherboards and discrete audio cards. It -supports 16-bit 48 kHZ stereo playback and capture. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiosolo\fR\fR -.ad -.sp .6 -.RS 4n -32-bit kernel driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audiosolo\fR\fR -.ad -.sp .6 -.RS 4n -64-bit kernel driver module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) diff --git a/usr/src/man/man7d/audiots.7d b/usr/src/man/man7d/audiots.7d deleted file mode 100644 index 484231026b..0000000000 --- a/usr/src/man/man7d/audiots.7d +++ /dev/null @@ -1,99 +0,0 @@ -'\" te -.\" 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 AUDIOTS 7D "May 12, 2009" -.SH NAME -audiots \- Acer Laboratories Inc. M5451 audio processor interface -.SH DESCRIPTION -.sp -.LP -The \fBaudiots\fR device uses the ALI M5451 audio processor and an AC-97 Codec -to implement the audio device interface. -.sp -.LP -The \fBaudiots\fR device provides support for the internal speaker, headphone, -line out, line in, and microphone. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/audiots\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBaudiots\fR driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiots.conf\fR\fR -.ad -.sp .6 -.RS 4n -\fBaudiots\fR driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -_ -Stability level Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBioctl\fR(2), \fBattributes\fR(5), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I) -.sp -.LP -Acer Laboratories Inc. \fBM5451\fR PCI Audio Processor Technical Specification -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages can appear on the system -console: -.sp -.ne 2 -.na -\fB\fBplay-interrupts too low\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too low\fR\fR -.ad -.RS 30n -The interrupt rate in \fBaudiots.conf\fR is set too low. It has been reset to -the rate specified in the message. Update \fBaudiots.conf\fR to a higher -interrupt rate. -.RE - -.sp -.ne 2 -.na -\fB\fBplay-interrupts too high\fR\fR -.ad -.br -.na -\fB\fBrecord-interrupts too high\fR\fR -.ad -.RS 30n -The interrupt rate set in \fBaudiots.conf\fR is set too high. It has been reset -to the rate specified in the message. Update \fBaudiots.conf\fR to a lower -interrupt rate. -.RE - diff --git a/usr/src/man/man7d/audiovia823x.7d b/usr/src/man/man7d/audiovia823x.7d deleted file mode 100644 index d4c61f09fa..0000000000 --- a/usr/src/man/man7d/audiovia823x.7d +++ /dev/null @@ -1,57 +0,0 @@ -'\" te -.\" 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 AUDIOVIA823X 7D "May 12, 2009" -.SH NAME -audiovia823x \- VIA VT8233, VT8235, and VT8237) support -.SH DESCRIPTION -.sp -.LP -The \fBaudiovia823\fR\fIx\fR driver provides support for the VIA VT8233, -VT8235, and VT8237 AC'97 devices found on motherboards with certain VIA chip -sets. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/audiovia823x\fR\fR -.ad -.sp .6 -.RS 4n -32-bit x86 kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/audiovia823x\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBaudio\fR(7I), \fBdsp\fR(7I), \fBmixer\fR(7I) diff --git a/usr/src/man/man7d/av1394.7d b/usr/src/man/man7d/av1394.7d deleted file mode 100644 index 53ce958979..0000000000 --- a/usr/src/man/man7d/av1394.7d +++ /dev/null @@ -1,85 +0,0 @@ -'\" te -.\" 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] -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.TH AV1394 7D "Jan 10, 2020" -.SH NAME -av1394 \- 1394 audio/video driver -.SH SYNOPSIS -.nf -\fBunit@GUID\fR -.fi - -.SH DESCRIPTION -The \fBav1394\fR driver implements \fBiec61883\fR(7I) interfaces for IEEE 1394 -compliant devices. -.SS "Asynchronous Transactions" -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" -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 -.ne 2 -.na -\fB/dev/av/N/async\fR -.ad -.RS 29n -device node for asynchronous data -.RE - -.sp -.ne 2 -.na -\fB/dev/av/N/isoch\fR -.ad -.RS 29n -device node for isochronous data -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/sparcv9/av1394\fR -.ad -.RS 29n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/av1394\fR -.ad -.RS 29n -Device driver (x86) -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture All -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -\fBread\fR(2), \fBwrite\fR(2), \fBattributes\fR(5), \fBhci1394\fR(7D), -\fBiec61883\fR(7I) -.sp -.LP -\fIIEEE Std 1394-1995 Standard for a High Performance Serial Bus\fR -.sp -.LP -\fIIEC 61883 Consumer audio/video equipment - Digital interface\fR diff --git a/usr/src/man/man7d/bbc_beep.7d b/usr/src/man/man7d/bbc_beep.7d deleted file mode 100644 index 55b50c1e03..0000000000 --- a/usr/src/man/man7d/bbc_beep.7d +++ /dev/null @@ -1,62 +0,0 @@ -'\" te -.\" Copyright (c) 2001, 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 BBC_BEEP 7D "Dec 18, 2001" -.SH NAME -bbc_beep \- Platform-dependent Beep driver for BBC-based hardware. -.SH SYNOPSIS -.LP -.nf -beep@unit-address -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBbbc_beep\fR driver generates beeps on platforms (including Sun Blade -1000) that use BBC-based registers and USB keyboards. When the \fBKIOCCMD\fR -ioctl is issued to the USB keyboard module (see \fBusbkbm\fR(7M)) with command -\fBKBD_CMD_BELL/KBD_CMD_NOBELL\fR, \fBusbkbm\fR(7M) passes the request to the -\fBbbc_beep\fR driver to turn the beep on and off, respectively. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/platform/sun4u/kernel/drv/sparcv9/bbc_beep\fR\fR -.ad -.sp .6 -.RS 4n - 64-bit ELF kernel driver -.RE - -.SH ATTRIBUTES -.sp -.LP -See attributes(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture BBC-based SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBkbd\fR(1), \fBattributes\fR(5), \fBgrbeep\fR(7d), \fBkb\fR(7M), -\fBusbkbm\fR(7M) -.sp -.LP -\fIWriting Device Drivers\fR -.SH DIAGNOSTICS -.sp -.LP -None diff --git a/usr/src/man/man7d/bcm_sata.7d b/usr/src/man/man7d/bcm_sata.7d deleted file mode 100644 index a536507864..0000000000 --- a/usr/src/man/man7d/bcm_sata.7d +++ /dev/null @@ -1,73 +0,0 @@ -'\" te -.\" 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 BCM_SATA 7D "Aug 31, 2009" -.SH NAME -bcm_sata \- Broadcom HT1000 SATA controller driver -.SH SYNOPSIS -.sp -.LP -\fBsata@\fR\fIunit-address\fR -.SH DESCRIPTION -.sp -.LP -The \fBbcm_sata\fR driver is a SATA HBA driver that supports Broadcom HT1000 -SATA HBA controllers. -.sp -.LP -HT1000 SATA controllers are compliant with the Serial ATA 1.0 specification and -SATA II Phase 1.0 specification (the extension to the SATA 1.0 specification). -These HT1000 controllers support standard SATA features including SATA-II -disks, NCQ, hotplug, ATAPI devices and port multiplier. -.sp -.LP -The driver does not currently support NCQ and port multiplier features. -.SS "Configuration" -.sp -.LP -The \fBbcm_sata\fR module contains no user configurable parameters. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/bcm_sata\fR\fR -.ad -.RS 30n -32-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/bcm_sata\fR\fR -.ad -.RS 30n -64-bit ELF kernel module (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBcfgadm\fR(1M), \fBcfgadm_sata\fR(1M), \fBprtconf\fR(1M), -\fBattributes\fR(5), \fBsata\fR(7D), \fBsd\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man7d/bfe.7d b/usr/src/man/man7d/bfe.7d deleted file mode 100644 index 65007f8999..0000000000 --- a/usr/src/man/man7d/bfe.7d +++ /dev/null @@ -1,91 +0,0 @@ -'\" te -.\" 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 BFE 7D "Jun 23, 2009" -.SH NAME -bfe \- Device driver for Broadcom BCM4401 100Base-T NIC -.SH DESCRIPTION -.sp -.LP -The \fBbfe\fR Fast Ethernet driver is GLD-based and supports the Broadcom -BCM4401 100Base-T NIC adapters :\fBpci14e4,170c Broadcom BCM4401 100Base-T.\fR. -.sp -.LP -The \fBbfe\fR driver supports IEEE 802.3 auto-negotiation, flow control and -VLAN tagging. -.SS "Configuration" -.sp -.LP -The default configuration is auto-negotiation with bidirectional flow control. -The advertised capabilities for auto-negotiation are based on the capabilities -of the \fBPHY\fR. -.sp -.LP -You can set the capabilities advertised by the \fBbfe\fR controlled device -using \fBdladm\fR(1M). The driver supports only those parameters which begin -with en (enabled) in the parameters listed by the command \fBdladm\fR(1M). Each -of these boolean parameters determines if the device advertises that mode of -operation when the hardware supports it. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/bfe\fR\fR -.ad -.RS 25n -Special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/bfe\fR\fR -.ad -.RS 25n -32-bit device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/bfe\fR\fR -.ad -.RS 25n -64-bit device driver (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), -\fBieee802.3\fR(5), \fBdlpi\fR(7P), \fBstreamio\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programmer's Guide\fR -.sp -.LP -\fINetwork Interface Guide\fR -.sp -.LP -\fIIEEE 802.3ae Specification - 2002\fR diff --git a/usr/src/man/man7d/bge.7d b/usr/src/man/man7d/bge.7d deleted file mode 100644 index d9be2c667f..0000000000 --- a/usr/src/man/man7d/bge.7d +++ /dev/null @@ -1,312 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 BGE 7D "Apr 9, 2008" -.SH NAME -bge \- SUNW,bge Gigabit Ethernet driver for Broadcom BCM57xx -.SH SYNOPSIS -.LP -.nf -\fB/dev/bge*\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBbge\fR Gigabit Ethernet driver is a multi-threaded, loadable, clonable, -GLD-based STREAMS driver supporting the Data Link Provider Interface, -\fBdlpi\fR(7P), on Broadcom BCM57xx -(BCM5700/5701/5703/5704/5705/5705M/5714/5721/5751/5751M/5782/5788 on x86) -Gigabit Ethernet controllers fitted to the system motherboard. With the -exception of BCM5700/BCM5701/BCM5704S, these devices incorporate both MAC and -PHY functions and provide three-speed (copper) Ethernet operation on the RJ-45 -connectors. (BCM5700/BCM5701/BCM5704S do not have a PHY integrated into the MAC -chipset.) -.sp -.LP -The \fBbge\fR driver functions include controller initialization, frame -transmit and receive, promiscuous and multicast support, and error recovery and -reporting. -.sp -.LP -The \fBbge\fR driver and hardware support auto-negotiation, a protocol -specified by the 1000 Base-T standard. Auto-negotiation allows each device to -advertise its capabilities and discover those of its peer (link partner). The -highest common denominator supported by both link partners is automatically -selected, yielding the greatest available throughput, while requiring no manual -configuration. The \fBbge\fR driver also allows you to configure the advertised -capabilities to less than the maximum (where the full speed of the interface is -not required), or to force a specific mode of operation, irrespective of the -link partner's advertised capabilities. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning character-special device, \fB/dev/bge\fR, is used to access all -BCM57xx devices ( (BCM5700/5701/5703/5704, 5705/5714/5721/5751/5751M/5782 on -x86) fitted to the system motherboard. -.sp -.LP -The \fBbge\fR driver is managed by the \fBdladm\fR(1M) command line utility, -which allows VLANs to be defined on top of bge instances and for \fBbge\fR -instances to be aggregated. See \fBdladm\fR(1M) for more details. -.sp -.LP -You must send an explicit DL_ATTACH_REQ message to associate the opened stream -with a particular device (PPA). The PPA ID is interpreted as an unsigned -integer data type and indicates the corresponding device instance (unit) -number. The driver returns an error (DL_ERROR_ACK) if the PPA field value does -not correspond to a valid device instance number for the system. The device is -initialized on first attach and de-initialized (stopped) at last detach. -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to a -DL_INFO_REQ are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU (default 1500). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU (default 0). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -DLSAP address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is \fBDL_ETHER\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBSAP\fR length value is \fI-2\fR, meaning the physical address component is -followed immediately by a 2-byte \fBSAP\fR component within the \fBDLSAP\fR -address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is the Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.RE -.sp -.LP -Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a -particular Service Access Point (SAP) with the stream. -.SH CONFIGURATION -.sp -.LP -By default, the \fBbge\fR driver performs auto-negotiation to select the link -speed and mode. Link speed and mode can be any one of the following, (as -described in the \fI IEEE803.2\fR standard): -.RS +4 -.TP -.ie t \(bu -.el o -1000 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -1000 Mbps, half-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -100 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -100 Mbps, half-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -10 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -10 Mbps, half-duplex -.RE -.sp -.LP -The auto-negotiation protocol automatically selects: -.RS +4 -.TP -.ie t \(bu -.el o -Speed (1000 Mbps, 100 Mbps, or 10 Mbps) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Operation mode (full-duplex or half-duplex) -.RE -.sp -.LP -as the highest common denominator supported by both link partners. Because the -\fBbge\fR device supports all modes, the effect is to select the highest -throughput mode supported by the other device. -.sp -.LP -Alternatively, you can set the capabilities advertised by the \fBbge\fR device -using \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 whether the device advertises that mode of operation. If -\fBen_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 listed below: -.sp -.in +2 -.nf - (highest priority/greatest throughput) - en_1000fdx_cap 1000Mbps full duplex - en_1000hdx_cap 1000Mbps half duplex - en_100fdx_cap 100Mbps full duplex - en_100hdx_cap 100Mbps half duplex - en_10fdx_cap 10Mbps full duplex - en_10hdx_cap 10Mbps half duplex - (lowest priority/least throughput) -.fi -.in -2 - -.sp -.LP -For example, to prevent the device 'bge2' from advertising gigabit -capabilities, enter (as super-user): -.sp -.in +2 -.nf -# dladm set-linkprop -p enable_1000hdx_cap=0 bge2 -# dladm set-linkprop -p enable_1000fdx_cap=0 bge2 -.fi -.in -2 - -.sp -.LP -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. -.sp -.LP -The current settings of the parameters may be found using dladm show-ether. In -addition, the driver exports the current state, speed, duplex setting, and -working mode of the link via kstat parameters (these are read only and may not -be changed). For example, to check link state of device \fBbge0\fR: -.sp -.in +2 -.nf -# dladm show-ether -x bge0 -LINK PTYPE STATE AUTO SPEED-DUPLEX PAUSE -bge0 current up yes 1G-f bi --- capable -- yes 1G-fh,100M-fh,10M-fh bi --- adv -- yes 1G-fh bi --- peeradv -- yes 1G-f bi -.fi -.in -2 - -.sp -.LP -The output above indicates that the link is up and running at 1Gbps full-duplex -with its rx/tx direction pause capability. -.sp -.LP -To extract link state information for the same link using kstat: -.sp -.in +2 -.nf -# kstat bge:0:mac:link_state -module: bge instance: 0 -name: mac class: net -link_state -.fi -.in -2 - -.sp -.LP -The default MTU is 1500. To enable Jumbo Frames support, you can configure the -\fBbge\fR driver by defining the default_mtu property via \fBdladm\fR(1M) or in -\fBdriver.conf\fR(4) to greater than 1500 bytes (for example: -default_mtu=9000). Note that the largest jumbo size supported by bge is 9000 -bytes. Additionally, not all bge-derived devices currently support Jumbo -Frames. The following devices support Jumbo Frames up to 9KB: BCM5700, 5701, -5702, 5703C, 5703S, 5704C, 5704S, 5714C, 5714S, 5715C and 5715S. Other devices -currently do not support Jumbo Frames. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/bge*\fR\fR -.ad -.RS 27n -32-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/bge\fR\fR -.ad -.RS 27n -64-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/bge\fR\fR -.ad -.RS 27n -64-bit ELF kernel module (SPARC). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBstreamio\fR(7I), -\fBdlpi\fR(7P) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR diff --git a/usr/src/man/man7d/blkdev.7d b/usr/src/man/man7d/blkdev.7d deleted file mode 100644 index 8ff6f4745e..0000000000 --- a/usr/src/man/man7d/blkdev.7d +++ /dev/null @@ -1,82 +0,0 @@ -.\" -.\" 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 2014 Garrett D'Amore <garrett@damore.org> -. -.Dd "Jul 30, 2014" -.Dt BLKDEV 7D -.Os -.Sh NAME -.Nm blkdev -.Nd generic block device driver -.Sh DESCRIPTION -The -.Nm -driver supports generic block-oriented devices, such as non-volatile -memory storage devices. -It provides a hardware independent layer for such storage devices, allowing them -to concentrate on the hardware-specific details, while -.Nm -takes care of all the other details, such as -.Xr dkio 7I . -.Lp -The -.Nm -driver only supports block-oriented, random-access devices. -It does not support traditional rotational media and does not support -SCSI commands. -.Lp -The most typical use case for -.Nm -devices is to be used to host a file system, such as -.Xr pcfs 7FS -or -.Xr zfs 7FS . -. -.Sh INTERFACE STABILITY -.Sy Uncommitted . -. -.Sh FILES -. -.Bl -tag -compact -width Pa -.It Pa /dev/dsk/cndnsn -Block device minor nodes. -.It Pa /dev/rdsk/cndnsn -Raw block device minor nodes. -.El -.Lp -In the above, the following substitutions may occur: -.Bl -tag -offset indent -width Va -.It Va cn -A controller number, typically one for each instance of -each underlying hardware dependent device driver (there can be multiple -such drivers in the system.) Controller numbers are dynamically assigned -by the system. -.It Va dn -Generally, each instance of the underlying hardware will have a -logical unit number as well. -.It Va sn -This is the -.Em slice -number, representing a subset of the disk. -See -.Xr dkio 7I . -.El -. -.Sh SEE ALSO -.Xr rmformat 1 , -.Xr devinfo 1M , -.Xr fdisk 1M , -.Xr mount 1M , -.Xr umount 1M , -.Xr sd 7D , -.Xr pcfs 7FS , -.Xr zfs 7FS , -.Xr dkio 7I diff --git a/usr/src/man/man7d/bnxe.7d b/usr/src/man/man7d/bnxe.7d deleted file mode 100644 index 0696dc6c47..0000000000 --- a/usr/src/man/man7d/bnxe.7d +++ /dev/null @@ -1,153 +0,0 @@ -.\" -.\" 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 (c) 2014 QLogic Corporation. All Rights Reserved -.\" -.TH BNXE 7D "Jan 10, 2020" -.SH NAME -bnxe \- QLogic NetXtreme II 10 Gigabit Ethernet Device Driver - -.SH SYNOPSIS -.na -/dev/bnxe* -.ad - -.SH DESCRIPTION -The -.B bnxe -Ethernet driver is a multi-threaded, loadable, -clonable, GLDv3-based driver supporting the Data Link Provider Interface, -.BR dlpi (7P), -over QLogic NetXtreme II 10 Gigabit Ethernet controllers. Multiple -NetXtreme II controllers installed within the system are supported by -the driver. - -The -.B bnxe -driver provides support for the NetXtreme II 10 Gigabit line of devices. -Functions include chip initialization, frame transmit and receive, -multicast and promiscuous support, error recovery and reporting. These -devices provide 10/100/1000/2500/10000 Mbps networking interfaces. - -.SH DRIVER CONFIGURATION - -The primary methods of configuration are via modification of the -.I /kernel/drv/bnxe.conf -file or execution of the -.BR dladm (1M) -utility. There are many configuration items available and all are thoroughly -documented in the -.I /kernel/drv/bnxe.conf -file. Note that for -changes to this file to take affect the driver must be reloaded or the system -rebooted. In order to reload the driver with new configuration changes all -.B bnxe -interfaces must be first unplumbed and then the -.BR update_drv (1M) -tool must be executed. For the configuration items that do not require a -driver reload the -.BR dladm (1M) -tool can be used to dynamically change the option. - -.SH DEBUGGING - -.SS kstat - -There are many statistics exposed via -.B kstat -by -.BR bnxe . - -The main groups are: -.TP -"intr" -for interrupts stats -.TP -"l2chip" -for layer 2 chip stats, -.TP -"l2driver" -for layer 2 driver stats, -.TP -"l2stats" -for general layer 2 stats, -.TP -"link" -for detailed link status, -.TP -"mac" -for GLDv3 MAC layer stats, -.TP -"rxq#" -for Rx ring stats, -.TP -"txq#" -for Tx ring stats, and -.TP -"stats" -for general driver stats and version info. -.LP -To get a list of all the individual statistics in these groups run: -.na -% kstat -m bnxe -i 0 -l -.ad - -.SH FILES -.ne 2 -.na -/dev/bnxe[instance] -.ad -.RS 16n -.B bnxe -Character special device -.RE - -.sp -.ne 2 -.na -/kernel/drv/bnxe.conf -.ad -.RS 16n -Driver configuration file -.RE - -.sp -.ne 2 -.na -/kernel/drv/amd64/bnxe -.ad -.RS 16n -Device driver (x86) -.RE - -.sp -.ne 2 -.na -/kernel/drv/sparcv9/bnxe -.ad -.RS 16n -Device driver (SPARC) -.RE - -.SH SEE ALSO -.BR dladm (1M), -.BR netstat (1M), -.BR ifconfig (1M), -.BR driver.conf (4), -.BR gld (7P) -.LP -.I QLogic NetXtreme II 10 Gigabit Adapter Driver Installation Notes -.LP -.I Writing Device Drivers -.LP -.I STREAMS Programming Guide -.LP -.I Network Interfaces Guide diff --git a/usr/src/man/man7d/ccid.7d b/usr/src/man/man7d/ccid.7d deleted file mode 100644 index f5158b0d0d..0000000000 --- a/usr/src/man/man7d/ccid.7d +++ /dev/null @@ -1,558 +0,0 @@ -.\" -.\" 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 and the ICC will be reset. -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 -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. -This 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 Ic 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. -This 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 Ic 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. -This 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 Ic 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. -This 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 Ic 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 Xr open 2 -.Nm -slot device nodes can be opened using -.Xr open 2 . -Non-blocking operation can be selected by using the -.Dv O_NONBLOCK -flag when opening the device node. -A device node opened for read-only operations will not allow creating -transactions or doing I/O, but it will allow the ICC/reader status to -be queried. -.Ss Xr close 2 -When no longer needed by a program, a device node can be closed with -.Xr close 2 . -If a transaction is still active when a device node is closed, the transaction -will be ended automatically and the ICC will be reset. -Any unread data is discarded. -.Ss Xr ioctl 2 -The -.Xr ioctl 2 -system call can be used to start or end a transaction, query the reply size for -.Xr read 2 , -query the ICC and CCID reader status, or change the state of an ICC in a reader. -See section -.Sx IOCTLS -for details. -.Ss Xr write 2 -Within an active transaction the -.Xr write 2 -system call can be used to transfer an APDU (application protocol data unit) to -an ICC, one single complete APDU at a time. -Partial writes or writing more than one APDU at a time are not supported. -The data returned by the ICC must be consumed by a subsequent -.Xr read 2 -call before -.Xr write 2 -can be called again within the same transaction. -.Pp -The following errors for -.Xr write 2 -have specific meaning in -.Nm : -.Bl -tag -width Dv -.It Dv E2BIG -The number of bytes to write is larger than the maximum APDU length supported by -.Nm , -currently defined as 261 bytes. -.It Dv EACCES -The device is opened read-only, or no transaction is active. -.It Dv EBUSY -There is unread data from a previous call to -.Xr write 2 . -.It Dv ENOTSUP -The reader and/or ICC is unsupported for I/O. -.It Dv ENXIO -The ICC is inactive and can't be used for I/O. -.It Dv ENODEV -The CCID reader has been disconnected. -.El -.Ss Xr read 2 -Within an active transaction the -.Xr read 2 -system call is used to read the reply from an ICC following sending an APDU with -.Xr write 2 . -The whole reply needs to be read with a single call to -.Xr read 2 . -The size of the reply can be queried before reading by issuing the -.Dv FIONREAD -ioctl. -See section -.Sx IOCTLS -for details. -.Pp -The following errors for -.Xr read 2 -have specific meaning in -.Nm : -.Bl -tag -width Dv -.It Dv EACCES -No transaction is active. -.It Dv EBUSY -Another thread is already blocked in -.Xr read 2 -waiting for data. -.It Dv EOVERFLOW -The buffer size is too small to fit the reply. -.It Dv ENODATA -No -.Xr write 2 -was issued before and consequently there is no reply to be read. -.It Dv ENODEV -The CCID reader has been disconnected. -.El -.Ss Xr poll 2 -Within an active transaction the -.Xr poll 2 -system call is used to wait for status changes on a device node. -See section -.Sx I/O model -for details. -.Pp -The following errors for -.Xr poll 2 -have specific meaning in -.Nm : -.Bl -tag -width Dv -.It Dv EACCES -No transaction is active. -.It Dv ENODEV -The CCID reader has been disconnected. -.El -.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/chxge.7d b/usr/src/man/man7d/chxge.7d deleted file mode 100644 index 05db2a4bde..0000000000 --- a/usr/src/man/man7d/chxge.7d +++ /dev/null @@ -1,130 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 CHXGE 7D "Jan 17, 2005" -.SH NAME -chxge \- Chelsio Ethernet network interface controllers -.SH SYNOPSIS -.LP -.nf -/dev/chxge -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBchxge\fR Ethernet driver is a multi-threaded, loadable, clonable, -STREAMS hardware driver supporting the connectionless Data Link Provider -Interface, \fBdlpi\fR(7P), over Chelsio NIC controllers. Multiple (and mixed) -NIC controllers installed within the system are supported by the driver. The -\fBchxge\fR driver provides basic support for the NIC hardware. Functions -include chip initialization, frame transmit and receive, and error recovery and -reporting. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning, character-special device \fB/dev/chxge\fR is used to access NIC -devices installed within the system. -.SH CHXGE AND DLPI -.sp -.LP -The \fBchxge\fR driver is dependent on \fB/kernel/misc/gld\fR, a loadable -kernel module that provides the \fBchxge\fR driver with the DLPI and STREAMS -functionality required of a LAN driver. See \fBgld\fR(7D) for more details on -the primitives supported by the driver. -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to -the DL_INFO_REQ are: -.RS +4 -.TP -.ie t \(bu -.el o -Default Maximum SDU is 1500 (ETHERMTU). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -dlsap address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is DL_ETHER. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The sap length value is -2, meaning the physical address component is -followed immediately by a 2-byte sap component within the DLSAP address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.RE -.SH FILES -.sp -.ne 2 -.na -\fB/dev/chxge\fR -.ad -.RS 29n -Character special device. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/sparcv9/chxge\fR -.ad -.RS 29n -SPARC chxge driver binary. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/chxge\fR -.ad -.RS 29n -x86 platform kernel module. (32-bit). -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/chxge\fR -.ad -.RS 29n -x86 platform kernel module. (64-bit). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBnetstat\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), \fBdlpi\fR(7P), -\fBgld\fR(9F), \fBgld_mac_info\fR(9S) diff --git a/usr/src/man/man7d/cmdk.7d b/usr/src/man/man7d/cmdk.7d deleted file mode 100644 index 92c90ff360..0000000000 --- a/usr/src/man/man7d/cmdk.7d +++ /dev/null @@ -1,143 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 CMDK 7D "Nov 4, 2008" -.SH NAME -cmdk \- common disk driver -.SH SYNOPSIS -.LP -.nf -cmdk@\fItarget\fR, \fIlun\fR : [ \fIpartition\fR \fB|\fR \fIslice\fR ] -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBcmdk\fR device driver is a common interface to various disk devices. The -driver supports magnetic fixed disks and magnetic removable disks. -.sp -.LP -The \fBcmdk\fR device driver supports three different disk labels: fdisk -partition table, Solaris x86 VTOC and EFI/GPT. -.sp -.LP -The block-files access the disk using the system's normal buffering mechanism -and are read and written without regard to physical disk records. There is also -a "raw" interface that provides for direct transmission between the disk and -the user's read or write buffer. A single read or write call usually results in -one I/O operation; raw I/O is therefore considerably more efficient when many -bytes are transmitted. The names of the block files are found in -\fB/dev/dsk\fR. Raw file names are found in \fB/dev/rdsk\fR. -.sp -.LP -I/O requests to the magnetic disk must have an offset and transfer length that -is a multiple of 512 bytes or the driver returns an \fBEINVAL\fR error. -.sp -.LP -Slice 0 is normally used for the root file system on a disk, slice 1 as a -paging area (for example, swap), and slice 2 for backing up the entire fdisk -partition for Solaris software. Other slices may be used for \fBusr\fR file -systems or system reserved area. -.sp -.LP -The fdisk partition 0 is to access the entire disk and is generally used by the -\fBfdisk\fR(1M) program. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/dsk/c\fR\fIn\fR\fBd\fR\fIn\fR[\fBs\fR|\fBp\fR]\fIn\fR\fR -.ad -.RS 26n -block device (IDE) -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdsk/c\fR\fIn\fR\fBd\fR\fIn\fR[\fBs\fR|\fBp\fR]\fIn\fR\fR -.ad -.RS 26n -raw device (IDE) -.sp -where: -.sp -.ne 2 -.na -\fB\fBc\fR\fIn\fR\fR -.ad -.RS 6n -controller \fIn\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBd\fR\fIn\fR\fR -.ad -.RS 6n -lun \fIn (0-1)\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBs\fR\fIn\fR\fR -.ad -.RS 6n -UNIX system slice \fIn (0-15).\fR -.RE - -.sp -.ne 2 -.na -\fB\fBp\fR\fIn\fR\fR -.ad -.RS 6n -fdisk partition (0-36). -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/cmdk\fR\fR -.ad -.RS 26n -32-bit kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/cmdk\fR\fR -.ad -.RS 26n -64-bit kernel module. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBfdisk\fR(1M), \fBmount\fR(1M), \fBlseek\fR(2), \fBread\fR(2), -\fBwrite\fR(2), \fBreaddir\fR(3C), \fBscsi\fR(4), \fBvfstab\fR(4), -\fBattributes\fR(5), \fBdkio\fR(7I) diff --git a/usr/src/man/man7d/console.7d b/usr/src/man/man7d/console.7d deleted file mode 100644 index d372831b92..0000000000 --- a/usr/src/man/man7d/console.7d +++ /dev/null @@ -1,52 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1997, Sun Microsystems, Inc. -.\" 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 CONSOLE 7D "Apr 23, 1999" -.SH NAME -console \- STREAMS-based console interface -.SH SYNOPSIS -.LP -.nf -\fB/dev/console\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The file \fB/dev/console\fR refers to the system console device. -\fB/dev/console\fR should be used for interactive purposes only. Use of -\fB/dev/console\fR for logging purposes is discouraged; \fBsyslog\fR(3C) or -\fBmsglog\fR(7D) should be used instead. -.sp -.LP -The identity of this device depends on the \fBEEPROM\fR or \fBNVRAM\fR settings -in effect at the most recent system reboot; by default, it is the ``workstation -console'' device consisting of the workstation keyboard and frame buffer acting -in concert to emulate an \fBASCII\fR terminal (see \fBwscons\fR(7D)). -.sp -.LP -Regardless of the system configuration, the console device provides -asynchronous serial driver semantics so that, in conjunction with the -\fBSTREAMS\fR line discipline module \fBldterm\fR(7M), it supports the -\fBtermio\fR(7I) terminal interface. -.SH SEE ALSO -.sp -.LP -\fBsyslog\fR(3C), \fBtermios\fR(3C), \fBldterm\fR(7M), \fBtermio\fR(7I), -\fBmsglog\fR(7D), \fBwscons\fR(7D) -.SH NOTES -.sp -.LP -In contrast to pre-SunOS 5.0 releases, it is no longer possible to redirect I/O -intended for \fB/dev/console\fR to some other device. Instead, redirection now -applies to the workstation console device using a revised programming interface -(see \fBwscons\fR(7D)). Since the system console is normally configured to be -the work station console, the overall effect is largely unchanged from previous -releases. -.sp -.LP -See \fBwscons\fR(7D) for detailed descriptions of control sequence syntax, -\fBANSI\fR control functions, control character functions and escape sequence -functions. diff --git a/usr/src/man/man7d/coretemp.7d b/usr/src/man/man7d/coretemp.7d deleted file mode 100644 index d194d02fde..0000000000 --- a/usr/src/man/man7d/coretemp.7d +++ /dev/null @@ -1,49 +0,0 @@ -.\" -.\" 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 January 10, 2020 -.Dt CORETEMP 7D -.Os -.Sh NAME -.Nm coretemp -.Nd Intel core-family temperature sensor driver -.Sh SYNOPSIS -.Pa /dev/sensors/temperature/cpu/* -.Sh DESCRIPTION -The -.Nm -driver provides the system with a means of reading the per-core and, -when available, per-package digital temperature sensors on Intel CPUs. -Currently, the -.Nm -driver supports Intel Core family processors after Penryn -microarchitecture and Intel Atom processors starting with the Silvermont -microarchitecture. -.Pp -Temperature information is available to the system via the fault -management architecture -.Pq FMA . -The file system location and programming interface to the -.Nm -driver are considered -.Sy Volatile , -subject to change without notice, and should not be used directly. -Raw temperature information can be dumped through the FMA developer -utility fmtopo. -.Sh SEE ALSO -.Xr fmadm 1M -.Rs -.%A Intel Corporation -.%B Intel 64 and IA-32 Architectures Software Developer's Manual -.%V Volume 3 (3A, 3B, 3C & 3D): System Programming Guide -.Re diff --git a/usr/src/man/man7d/cpqary3.7d b/usr/src/man/man7d/cpqary3.7d deleted file mode 100644 index 1ed77081ee..0000000000 --- a/usr/src/man/man7d/cpqary3.7d +++ /dev/null @@ -1,84 +0,0 @@ -.\" -.\" 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 (C) 2013 Hewlett-Packard Development Company, L.P. -.\" -.TH CPQARY3 7D "December 28, 2020" -.SH NAME -cpqary3 - provides disk and SCSI tape support for HP Smart Array controllers -.SH DESCRIPTION -The cpqary3 module provides low-level interface routines between the common -disk I/O subsystem and the HP SMART Array controllers. The cpqary3 driver -provides disk and SCSI tape support for the HP Smart Array controllers. -.LP -Please refer to the cpqary3 release notes, for the supported HP Smart Array -Controllers and Storage boxes. -.LP -Each controller should be the sole initiator on a SCSI bus. Auto -configuration code determines if the adapter is present at the Configured -address and what types of devices are attached to it. -.SH CONFIGURATION -Use the Array Configuration Utility to configure the controllers. Each -controller can support up to 32 logical volumes. In addition, each controller -supports up to a maximum of 28 connected SCSI tape drives. -With 1.90 and later versions of cpqary3 driver, HP Smart Array SAS controllers, -having Firmware Revision 5.10 or later, will support 64 logical drives. This -firmware also supports Dual Domain Multipath configurations. -.LP -The driver attempts to initialize itself in accordance with the information -found in the configuration file, /kernel/drv/cpqary3.conf. -.LP -New component - hmaeventd which logs the storage events onto console and to the -Integrated Management Log is made a part of HPQhma 5.0.0 package, which is not -part of the operating system. Therefore, by default, notify on event -functionality is disabled in the driver from 2.1.0 onwards. Storage event -logging may be enabled in the driver by modifying cpqary3.conf to set the -cpqary3_noe property to "on". Modification of driver properties requires -reloading the driver, which in most cases will occur only following a reboot of -the system. -.LP -The target driver's configuration file shall need entries if support is needed -for targets numbering greater than the default number of targets supported by -the corresponding target driver. -.LP -By default, entries for SCSI target numbers 0 to 15 are present in sd.conf. -Entries for target numbers 16 and above must be added to the \&'scsi' class in -sd.conf to support additional corresponding logical volumes. -.LP -If SCSI tape drives are connected to the supported controllers, entries for -target IDs from 33 to 33+N must be added in the /kernel/drv/st.conf file under -\&'scsi' class, where N is the total number of SCSI tape drives connected to the -controller with largest number of tape drives connected to it, in the existing -configuration. For example, two supported controller, c1 and c2 are present in -the system. If controller c1 has two (2) tape drives and controller c2 has five -(5) tape drives connected, then entries for target IDs 33 thru 38 are required -under 'scsi' class in /kernel/drv/st.conf file. The maximum number of tape -drives that can be connected to a controller is 28. With 1.90 and later versions -of cpqary3 driver, if tape drives are connected to Smart Array SAS controllers, -then target ID entries for tape drives from 65 to 65+N must be added in -/kernel/drv/st.conf file under the \&'scsi' class. -.SH FILES -.PD 0 -.TP 25 -.B /kernel/drv/cpqary3.conf -- configuration file for CPQary3 -.PD -.SH "SEE ALSO" -.BR driver.conf (4), -.BR sd (7D), -.BR st (7D) -.SH NOTES -The Smart Array controllers supported by the current version of the -cpqary3 driver do not support 'format unit' SCSI command. Hence, selecting -\&'format' option under 'format' utility main menu is not supported. In addition, -the 'repair' option under 'format' utility main menu is not supported as this -operation is not applicable to Logical volumes connected to the supported Smart -Array controllers. diff --git a/usr/src/man/man7d/cpuid.7d b/usr/src/man/man7d/cpuid.7d deleted file mode 100644 index cc522b1969..0000000000 --- a/usr/src/man/man7d/cpuid.7d +++ /dev/null @@ -1,155 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 CPUID 7D "April 9, 2016" -.SH NAME -cpuid \- CPU identification driver -.SH SYNOPSIS -.LP -.nf -\fB/dev/cpu/self/cpuid\fR -.fi - -.SH DESCRIPTION -.SS "SPARC and x86 system" -.LP -This device provides implementation-private information via ioctls about -various aspects of the implementation to Solaris libraries and utilities. -.SS "x86 systems only" -.LP -This device also provides a file-like view of the namespace and return values -of the x86 cpuid instruction. The cpuid instruction takes a single 32-bit -integer function code, and returns four 32-bit integer values corresponding to -the input value that describe various aspects of the capabilities and -configuration of the processor. -.LP -The API for the character device consists of using the seek offset to set the -function code value, and using a \fBread\fR(2) or \fBpread\fR(2) of 16 bytes to -fetch the four 32-bit return values of the instruction in the order %\fBeax\fR, -%\fBebx\fR, %\fBecx\fR and %\fBedx\fR. -.LP -No data can be written to the device. Like the \fBcpuid\fR instruction, no -special privileges are required to use the device. -.LP -The device is useful to enable low-level configuration information to be -extracted from the CPU without having to write any assembler code to invoke the -\fBcpuid\fR instruction directly. It also allows the kernel to attempt to -correct any erroneous data returned by the instruction (prompted by occasional -errors in the information exported by various processor implementations over -the years). -.LP -See the processor manufacturers documentation for further information about the -syntax and semantics of the wide variety of information available from this -instruction. -.SH EXAMPLE -.LP -This example allows you to determine if the current x86 processor supports -"long mode," which is a necessary (but not sufficient) condition for running -the 64-bit Solaris kernel on the processor. -.sp -.in +2 -.nf -/* - -#include <sys/types.h> -#include <sys/stat.h> -#include <fcntl.h> -#include <unistd.h> -#include <string.h> -#include <errno.h> -#include <stdio.h> - -static const char devname[] = "/dev/cpu/self/cpuid"; - -/*ARGSUSED*/ -int -main(int argc, char *argv[]) -{ - struct { - uint32_t r_eax, r_ebx, r_ecx, r_edx; - } _r, *rp = &_r; - int d; - char *s; - - if ((d = open(devname, O_RDONLY)) == -1) { - perror(devname); - return (1); - } - - if (pread(d, rp, sizeof (*rp), 0) != sizeof (*rp)) { - perror(devname); - goto fail; - } - - s = (char *)&rp->r_ebx; - if (strncmp(s, "Auth" "cAMD" "enti", 12) != 0 && - strncmp(s, "Genu" "ntel" "ineI", 12) != 0) - goto fail; - - if (pread(d, rp, sizeof (*rp), 0x80000001) == sizeof (*rp)) { - /* - * Read extended feature word; check bit 29 - */ - (void) close(d); - if ((rp->r_edx >> 29) & 1) { - (void) printf("processor supports long mode\en"); - return (0); - } - } -fail: - (void) close(d); - return (1); -} -.fi -.in -2 - -.SH ERRORS -.ne 2 -.na -\fBENXIO\fR -.ad -.RS 10n -Results from attempting to read data from the device on a system that does not -support the CPU identification interfaces -.RE - -.sp -.ne 2 -.na -\fBEINVAL\fR -.ad -.RS 10n -Results from reading from an offset larger than UINT_MAX, or attempting to read -with a size that is not multiple of 16 bytes. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/dev/cpu/self/cpuid\fR\fR -.ad -.RS 23n -Provides access to CPU identification data. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.LP -\fBpsrinfo\fR(1M), \fBprtconf\fR(1M), \fBpread\fR(2), \fBread\fR(2), -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/dad.7d b/usr/src/man/man7d/dad.7d deleted file mode 100644 index 6f1d9312c4..0000000000 --- a/usr/src/man/man7d/dad.7d +++ /dev/null @@ -1,355 +0,0 @@ -'\" te -.\" Copyright 2004 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 DAD 7D "Oct 24, 2005" -.SH NAME -dad \- driver for IDE disk devices -.SH SYNOPSIS -.LP -.nf -\fBdad@\fR \fItarget\fR,\fIlun\fR:\fIpartition\fR -.fi - -.SH DESCRIPTION -.sp -.LP -This driver handles the ide disk drives on SPARC platforms. The type of disk -drive is determined using the ATA IDE identify device command and by reading -the volume label stored on the drive. The \fBdad\fR device driver supports the -Solaris SPARC VTOC and the EFI/GPT disk volume labels. -.sp -.LP -The block-files access the disk using the system's normal buffering mechanism -and are read and written without regard to physical disk records. There is -also a "raw" interface that provides for direct transmission between the disk -and the user's read or write buffer. A single read or write call usually -results in one I/O operation; raw I/O is therefore considerably more efficient -when many bytes are transmitted. The names of the block files are found in -\fB/dev/dsk\fR. Raw file names are found in \fB/dev/rdsk\fR. -.sp -.LP -I/O requests to the raw device must be aligned on a 512-byte (\fBDEV_BSIZE\fR) -boundary and must have a length that is a multiple of 512 bytes. Requests that -do not meet the restrictions cause the driver to return an \fBEINVAL\fR error. -I/O requests to the block device have no alignment or length restrictions. -.SS "Device Statistics Support" -.sp -.LP -Each device maintains I/O statistics both for the device and for each partition -allocated on that device. For each device/partition, the driver accumulates -reads, writes, bytes read, and bytes written. The driver also takes -hi-resolution time stamps at queue entry and exit points, which facilitates -monitoring the residence time and cumulative residence-length product for each -queue. -.sp -.LP -Each device also has error statistics associated with it. These must include -counters for hard errors, soft errors and transport errors. Other data may be -implemented as required. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/dsk/c\fR\fIn\fR\fBt\fR\fIn\fR\fBd\fR\fIn\fR\fBs\fR\fIn\fR \fR -.ad -.RS 23n -block files -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdsk/c\fR\fIn\fR\fBt\fR\fIn\fR\fBd\fR\fIn\fR\fBs\fR\fIn\fR \fR -.ad -.RS 23n -raw files -.RE - -.sp -.LP -where: -.sp -.ne 2 -.na -\fB\fBc\fR\fIn\fR \fR -.ad -.RS 7n -controller \fIn\fR -.RE - -.sp -.ne 2 -.na -\fB\fBt\fR\fIn\fR \fR -.ad -.RS 7n -IDE target id \fIn\fR (0-3) -.RE - -.sp -.ne 2 -.na -\fB\fBd\fR\fIn\fR \fR -.ad -.RS 7n -Always 0. -.RE - -.sp -.ne 2 -.na -\fB\fBs\fR\fIn\fR \fR -.ad -.RS 7n -partition \fIn\fR (0-7) -.RE - -.sp -.LP -The target ide numbers are assigned as: -.sp -.ne 2 -.na -\fB0\fR -.ad -.RS 5n -Master disk on Primary channel. -.RE - -.sp -.ne 2 -.na -\fB1\fR -.ad -.RS 5n -Slave disk on Primary channel. -.RE - -.sp -.ne 2 -.na -\fB2\fR -.ad -.RS 5n -Master disk on Secondary channel -.RE - -.sp -.ne 2 -.na -\fB3\fR -.ad -.RS 5n -Slave disk on Secondary channel. -.RE - -.SH IOCTLS -.sp -.LP -Refer to \fBdkio\fR(7I). -.SH ERRORS -.sp -.ne 2 -.na -\fB\fBEACCES\fR \fR -.ad -.RS 11n -Permission denied. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR \fR -.ad -.RS 11n -The partition was opened exclusively by another thread. -.RE - -.sp -.ne 2 -.na -\fB\fBEFAULT\fR \fR -.ad -.RS 11n -Argument was a bad address. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR \fR -.ad -.RS 11n -Invalid argument. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR \fR -.ad -.RS 11n - I/O error occurred. -.RE - -.sp -.ne 2 -.na -\fB\fBENOTTY\fR \fR -.ad -.RS 11n -The device does not support the requested ioctl function. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR \fR -.ad -.RS 11n -The device did not exist during opening. -.RE - -.sp -.ne 2 -.na -\fB\fBEROFS\fR \fR -.ad -.RS 11n -The device is a read-only device. -.RE - -.SH SEE ALSO -.sp -.LP -\fBformat\fR(1M), \fBmount\fR(1M), \fBlseek\fR(2), \fBread\fR(2), -\fBwrite\fR(2), \fBdriver.conf\fR(4), \fBvfstab\fR(4), \fBdkio\fR(7I) -.sp -.LP -X3T10 ATA-4 specifications. -.SH DIAGNOSTICS -.sp -.ne 2 -.na -\fB\fBCommand:<\fInumber\fR>\fR, Error:<\fInumber\fR>, Status:<\fInumber\fR>\fR -.ad -.sp .6 -.RS 4n -Indicates that the command failed with an error and provides status register -contents. Where <\fInumber\fR> is a hexadecimal value. -.RE - -.sp -.ne 2 -.na -\fB\fBoffline\fR \fR -.ad -.sp .6 -.RS 4n -The driver has decided that the target disk is no longer there. -.RE - -.sp -.ne 2 -.na -\fB\fBdisk ok\fR \fR -.ad -.sp .6 -.RS 4n -The target disk is now responding again. -.RE - -.sp -.ne 2 -.na -\fB\fBdisk not responding to selection\fR \fR -.ad -.sp .6 -.RS 4n -The target disk is not responding. -.RE - -.sp -.ne 2 -.na -\fB\fBi/o to invalid geometry\fR \fR -.ad -.sp .6 -.RS 4n -The geometry of the drive could not be established. -.RE - -.sp -.ne 2 -.na -\fB\fBincomplete read/write - retrying/giving up\fR \fR -.ad -.sp .6 -.RS 4n -There was a residue after the command completed normally. -.RE - -.sp -.ne 2 -.na -\fB\fBno bp for disk label\fR \fR -.ad -.sp .6 -.RS 4n -A bp with consistent memory could not be allocated. -.RE - -.sp -.ne 2 -.na -\fB\fBno memory for disk label\fR \fR -.ad -.sp .6 -.RS 4n -Free memory pool exhausted. -.RE - -.sp -.ne 2 -.na -\fB\fBATA transport failed: reason 'nnnn': {retrying|giving}\fR \fR -.ad -.sp .6 -.RS 4n -The host adapter has failed to transport a command to the target for the reason -stated. The driver will either retry the command or, ultimately, give up. -.RE - -.sp -.ne 2 -.na -\fB\fBno mem for property\fR \fR -.ad -.sp .6 -.RS 4n -Free memory pool exhausted. -.RE - -.sp -.ne 2 -.na -\fB\fBtransport rejected (<n>)\fR \fR -.ad -.sp .6 -.RS 4n -Host adapter driver was unable to accept a command. -.RE - -.sp -.ne 2 -.na -\fB\fBDevice Fault\fR \fR -.ad -.sp .6 -.RS 4n -Device fault - reason for such error is vendor specific. -.RE - diff --git a/usr/src/man/man7d/dca.7d b/usr/src/man/man7d/dca.7d deleted file mode 100644 index 03651d7151..0000000000 --- a/usr/src/man/man7d/dca.7d +++ /dev/null @@ -1,238 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 DCA 7D "Aug 14, 2005" -.SH NAME -dca \- Crypto Accelerator device driver -.SH SYNOPSIS -.LP -.nf -\fBpci108e,5454@\fIpci-slot\fR\fR -.fi - -.LP -.nf -\fBpci108e,5455@\fIpci-slot\fR\fR -.fi - -.LP -.nf -\fBpci108e,5456@\fIpci-slot\fR\fR -.fi - -.LP -.nf -\fBpci14e4,5820@\fIpci-slot\fR\fR -.fi - -.LP -.nf -\fBpci14e4,5821@\fIpci-slot\fR\fR -.fi - -.LP -.nf -\fBpci14e4,5822@\fIpci-slot\fR\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBdca\fR device driver is a multi-threaded, loadable hardware driver -supporting Sun PCI-based (\fBpci108e,5454\fR) cryptographic accelerators, such -as the Sun Crypto Accelerator 1000. -.sp -.LP -The \fBdca\fR driver requires the presence of Solaris Cryptographic Framework -for applications and kernel clients to access the provided services. -.SH EXTENDED DESCRIPTION -.sp -.LP -The \fBdca\fR driver maintains the following statistics: -.sp -.ne 2 -.na -\fB\fB3desjobs\fR\fR -.ad -.RS 16n -Total number of jobs submitted to the device for 3DES encryption. -.RE - -.sp -.ne 2 -.na -\fB\fB3desbytes\fR\fR -.ad -.RS 16n -Total number of bytes submitted to the device for 3DES encryption. -.RE - -.sp -.ne 2 -.na -\fB\fBrsapublic\fR\fR -.ad -.RS 16n -Total number of jobs submitted to the device for RSA public key operations. -.RE - -.sp -.ne 2 -.na -\fB\fBrsaprivate\fR\fR -.ad -.RS 16n -Total number of jobs submitted to the device for RSA private key operations. -.RE - -.sp -.ne 2 -.na -\fB\fBdsasign\fR\fR -.ad -.RS 16n -Total number of jobs submitted to the device for DSA signing. -.RE - -.sp -.ne 2 -.na -\fB\fBdsaverify\fR\fR -.ad -.RS 16n -Total number of jobs submitted to the device for DSA verification. -.RE - -.sp -.ne 2 -.na -\fB\fBrngjobs\fR\fR -.ad -.RS 16n -Total number of jobs submitted for pure entropy generation. -.RE - -.sp -.ne 2 -.na -\fB\fBrngbytes\fR\fR -.ad -.RS 16n -Total number of bytes of pure entropy requested from the device. -.RE - -.sp -.ne 2 -.na -\fB\fBrngsha1jobs\fR\fR -.ad -.RS 16n -Total number of jobs submitted for entropy generation, with SHA-1 -post-processing. -.RE - -.sp -.ne 2 -.na -\fB\fBrngsha1bytes\fR\fR -.ad -.RS 16n -Total number of bytes of entropy requested from the device, with SHA-1 -post-processing. -.RE - -.sp -.LP -Additional statistics may be supplied for Sun support personnel, but are not -useful to end users and are not documented here. -.sp -.LP -The \fBdca\fR driver can be configured by defining properties in -\fB/kernel/drv/dca.conf\fR which override the default settings. The following -properties are supported: -.sp -.ne 2 -.na -\fB\fBnostats\fR\fR -.ad -.RS 13n -Disables the generation of statistics. This property may be used to help -prevent traffic analysis, but this may inhibit support personnel. -.RE - -.sp -.ne 2 -.na -\fB\fBrngdirect\fR\fR -.ad -.RS 13n -Disables the SHA-1 post-processing of generated entropy. This may give "truer" -random numbers, but it may also introduce the risk of external biases -influencing the distribution of generated random numbers. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -_ -Interface Stability Unstable -.TE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/dca.conf\fR\fR -.ad -.RS 27n -\fBdca\fR configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/dca\fR\fR -.ad -.RS 27n -64-bit ELF kernel driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/dca\fR\fR -.ad -.RS 27n -32-bit ELF kernel driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/dca\fR\fR -.ad -.RS 27n -64-bit ELF kernel driver (AMD64) -.RE - -.SH SEE ALSO -.sp -.LP -\fBcryptoadm\fR(1M), \fBkstat\fR(1M), \fBprtconf\fR(1M), \fBdriver.conf\fR(4), -\fBattributes\fR(5) -.sp -.LP -\fISolaris Cryptographic Framework.\fR diff --git a/usr/src/man/man7d/dcam1394.7d b/usr/src/man/man7d/dcam1394.7d deleted file mode 100644 index c1323c8a8f..0000000000 --- a/usr/src/man/man7d/dcam1394.7d +++ /dev/null @@ -1,946 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 DCAM1394 7D "Jan 10, 2020" -.SH NAME -dcam1394 \- 1394-based digital camera (IIDC) driver -.SH SYNOPSIS -.nf -\fB#include <sys/dcam/dcam1394_io.h>\fR -.fi - -.SH DESCRIPTION -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 -Isochronous data is read from the driver frame-by-frame and is maintained -within the driver in a ring buffer. -.sp -.LP -Video frames are read from the isochronous input device using \fBread\fR(2). -.sp -.LP -The \fBdcam1394_frame_t\fR structure describes the frame layout and is defined -as follows: -.sp -.in +2 -.nf - struct { - unsigned int vid_mode; - unsigned int seq_num; - hrtime_t timestamp; - unsigned char *buff; - }; -.fi -.in -2 - -.sp -.LP -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 -The following ioctl requests are supported: -.sp -.ne 2 -.na -\fBDCAM1394_CMD_CAM_RESET\fR -.ad -.sp .6 -.RS 4n -Reset the device. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_CMD_REG_READ\fR -.ad -.sp .6 -.RS 4n -Read the indicated dcam/IIDC register. The argument is a pointer to a -\fBdcam1394_reg_io_t\fR structure, which is defined as follows: -.sp -.in +2 -.nf - struct { - unsigned int offs; - unsigned int val; - }; -.fi -.in -2 - -The offs field should be set to the offset of the register from which to read. -Register offset values are defined in the \fI1394 Trade Association Digital -Camera Specification\fR. -.sp -After the operation is completed, the camera register value is put in the -\fBval\fR field. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_CMD_REG_WRITE\fR -.ad -.sp .6 -.RS 4n -Write the indicated dcam/IIDC register. The argument is a pointer to a -\fBdcam1394_reg_io_t\fR structure (described above). -.sp -The offs field should be set to the offset of the register from which to read. -The register offset values are defined in the \fI1394 Trade Association Digital -Camera Specification\fR. -.sp -The val field should be set to the value to be written to the camera register. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_CMD_PARAM_GET\fR -.ad -.sp .6 -.RS 4n -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 parameter list only supports Format 1 video formats. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_CMD_PARAM_SET\fR -.ad -.sp .6 -.RS 4n -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 parameter list only supports Format 1 video formats. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_CMD_FRAME_RCV_START\fR -.ad -.sp .6 -.RS 4n -Start receiving video frames from the camera. -.sp -The contents of the ring buffer may be accessed by reading the isochronous -stream device. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_CMD_FRAME_RCV_STOP\fR -.ad -.sp .6 -.RS 4n -Stop receiving frames from the camera. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_CMD_RING_BUFF_FLUSH\fR -.ad -.sp .6 -.RS 4n -Flush the frames in the ring buffer. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_CMD_FRAME_SEQ_NUM_COUNT_RESET\fR -.ad -.sp .6 -.RS 4n -Reset frame sequence number. -.RE - -.SH PARAMETER LIST ACCESS -The parameter list is initialized and access through macros. The data type for -the parameter list is \fBdcam1394_param_list_t\fR. -.sp -.LP -The following macros are used to access the parameter list: -.sp -.ne 2 -.na -\fBPARAM_LIST_INIT(param_list)\fR -.ad -.sp .6 -.RS 4n -Initialize the parameter list. -.RE - -.sp -.ne 2 -.na -\fBPARAM_LIST_ADD(param_list, param, subparam)\fR -.ad -.sp .6 -.RS 4n -Add a parameter to the list. -.RE - -.sp -.ne 2 -.na -\fBPARAM_LIST_REMOVE(param_list, param, subparam)\fR -.ad -.sp .6 -.RS 4n -Remove a parameter from the list. -.RE - -.sp -.ne 2 -.na -\fBPARAM_LIST_IS_ENTRY(param_list, param, subparam)\fR -.ad -.sp .6 -.RS 4n -Indicates if a specific parameter is in the list. -.RE - -.sp -.ne 2 -.na -\fBPARAM_VAL(param_list, param, subparam)\fR -.ad -.sp .6 -.RS 4n -Value of a specified parameter. -.RE - -.sp -.ne 2 -.na -\fBPARAM_ERR(param_list, param, subparam)\fR -.ad -.sp .6 -.RS 4n -Indicates if a specific parameter is successfully set. -.RE - -.sp -.LP -When no subparam value is required, the value DCAM1394_SUBPARAM_NONE may be -used. -.SH PARAMETERS -The following parameters may appear in the list: -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_CAP_POWER_CTRL\fR -.ad -.sp .6 -.RS 4n -Queries if the camera can be turned off and on through software. The subparam -value is ignored. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_POWER\fR -.ad -.sp .6 -.RS 4n -Controls or queries if the camera is powered up. Verify this feature using -DCAM1394_PARAM_CAP_POWER_CTRL before use. The subparam field is ignored. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_CAP_VID_MOD\fR -.ad -.sp .6 -.RS 4n -Queries if a specific video mode is supported by the camera. -.sp -subparam is one of the following and is used to determine if a specified video -mode is supported by the camera: -.sp -.in +2 -.nf - DCAM1394_SUBPARAM_VID_MODE_0 - DCAM1394_SUBPARAM_VID_MODE_YUV_444_160_120 - Video mode is 4:4:4, YUV color space, 160x120 resolution. - - DCAM1394_SUBPARAM_VID_MODE_1 - DCAM1394_SUBPARAM_VID_MODE_YUV_422_320_240 - Video mode is 4:2:2, YUV color space, 320x240 resolution. - - DCAM1394_SUBPARAM_VID_MODE_2 - DCAM1394_SUBPARAM_VID_MODE_YUV_411_640_480 - Video mode is 4:1:1, YUV color space, 640x480 resolution. - - DCAM1394_SUBPARAM_VID_MODE_3 - DCAM1394_SUBPARAM_VID_MODE_YUV_422_640_480 - Video mode is 4:2:2, YUV color space, 640x480 resolution. - - DCAM1394_SUBPARAM_VID_MODE_4 - DCAM1394_SUBPARAM_VID_MODE_RGB_640_480 - Video mode is RGB color space, 640x480 resolution. - - DCAM1394_SUBPARAM_VID_MODE_5 - DCAM1394_SUBPARAM_VID_MODE_Y_640_480 - Video mode is Y color space, 640x480 resolution. -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_VID_MODE\fR -.ad -.sp .6 -.RS 4n -Controls or queries the current video mode of the camera. The subparam field -is ignored. When selecting the video mode, it should be compatible with the -capability of the camera, which may be determined by checking the -DCAM1394_PARAM_CAP_VID_MODE parameter. -.sp -The value of this parameter may be one of the following: -.sp -.in +2 -.nf - DCAM1394_VID_MODE_0 - DCAM1394_VID_MODE_YUV_444_160_120 - Video mode is 4:4:4, YUV color space, 160x120 resolution. - - DCAM1394_VID_MODE_1 - DCAM1394_VID_MODE_YUV_422_320_240 - Video mode is 4:2:2, YUV color space, 320x240 resolution. - - DCAM1394_VID_MODE_2 - DCAM1394_VID_MODE_YUV_411_640_480 - Video mode is 4:1:1, YUV color space, 640x480 resolution. - - DCAM1394_VID_MODE_3 - DCAM1394_VID_MODE_YUV_422_640_480 - Video mode is 4:2:2, YUV color space, 640x480 resolution. - - DCAM1394_VID_MODE_4 - DCAM1394_VID_MODE_RGB_640_480 - Video mode is RGB color space, 640x480 resolution. - - DCAM1394_VID_MODE_5 - DCAM1394_VID_MODE_Y_640_480 - Video mode is Y color space, 640x480 resolution. -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_0\fR -.ad -.sp .6 -.RS 4n -Queries if a specific frame rate is supported by the camera in video mode 0 -(4:4:4, YUV, 160x120). -.sp -subparam is one of the following and used to determine if a specified frame -rate is supported by the camera: -.sp -.in +2 -.nf - DCAM1394_SUBPARAM_FRAME_RATE_0 - DCAM1394_SUBPARAM_FRAME_RATE_3_75_FPS - Frame rate is 3.75 frames/second. - - DCAM1394_SUBPARAM_FRAME_RATE_1 - DCAM1394_SUBPARAM_FRAME_RATE_7_5_FPS - Frame rate is 7.5 frames/second. - - DCAM1394_SUBPARAM_FRAME_RATE_2 - DCAM1394_SUBPARAM_FRAME_RATE_15_FPS - Frame rate is 15 frames/second. - - DCAM1394_SUBPARAM_FRAME_RATE_3 - DCAM1394_SUBPARAM_FRAME_RATE_30_FPS - Frame rate is 30 frames/second. - - DCAM1394_SUBPARAM_FRAME_RATE_4 - DCAM1394_SUBPARAM_FRAME_RATE_60_FPS - Frame rate is 60 frames/second. -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_1\fR -.ad -.sp .6 -.RS 4n -Queries if a specific frame rate is supported by the camera in video mode 1 -(4:2:2, YUV, 320x240). See DCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_0 for a -listing of valid subparam values. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_2\fR -.ad -.sp .6 -.RS 4n -Queries if a specific frame rate is supported by the camera in video mode 2 -(4:1:1, YUV, 640x480). See DCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_0 for a -listing of valid subparam values. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_3\fR -.ad -.sp .6 -.RS 4n -Queries if a specific frame rate is supported by the camera in video mode 3 -(4:2:2, YUV, 640x480). See DCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_0 for a -listing of valid subparam values. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_4\fR -.ad -.sp .6 -.RS 4n -Queries if a specific frame rate is supported by the camera in video mode 4. -(RGB, 640x480). See DCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_0 for a listing of -valid subparam values. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_5\fR -.ad -.sp .6 -.RS 4n -Queries if a specific frame rate is supported by the camera in video mode 5. -(Y, 640x480). See DCAM1394_PARAM_CAP_FRAME_RATE_VID_MODE_0 for a listing of -valid subparam values. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_FRAME_RATE\fR -.ad -.sp .6 -.RS 4n -Controls or queries the current frame rate of the camera. The subparam field -is ignored. When selecting a frame rate, it should be compatible with the -capability of the camera, which can be determined by querying one of the frame -rate capability parameters above. -.sp -The value of this parameter may be one of the following: -.sp -.in +2 -.nf - DCAM1394_FRAME_RATE_0 - DCAM1394_3_75_FPS - The frame rate is 3.75 frames per second. - - DCAM1394_FRAME_RATE_1 - DCAM1394_7_5_FPS - The frame rate is 7.5 frames per second. - - DCAM1394_FRAME_RATE_2 - DCAM1394_15_FPS - The frame rate is 15 frames per second. - - DCAM1394_FRAME_RATE_3 - DCAM1394_30_FPS - The frame rate is 30 frames per second. - - DCAM1394_FRAME_RATE_4 - DCAM1394_60_FPS - The frame rate is 60 frames per second. -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_RING_BUFF_CAPACITY\fR -.ad -.sp .6 -.RS 4n -Controls or queries the number of frames that the ring buffer may hold. This -value can range between 2 and 30. The subparam field is ignored. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_RING_BUFF_NUM_FRAMES_READY\fR -.ad -.sp .6 -.RS 4n -Queries the number of frames in the ring buffer ready to be accessed. The -subparam field is ignored. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_RING_BUFF_READ_PTR_INCR\fR -.ad -.sp .6 -.RS 4n -Controls or queries the number of bytes to advance the read pointer as it -consumes data from the ring buffer. The subparam field is ignored. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_FRAME_NUM_BYTES\fR -.ad -.sp .6 -.RS 4n -Queries the number of bytes in a frame at the current video mode. The subparam -field is ignored. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_STATUS\fR -.ad -.sp .6 -.RS 4n -Queries the parameter status. The subparam field is ignored. -.sp -The values for the parameter status is a bit field with the following values -possibly set: -.sp -.ne 2 -.na -\fBDCAM1394_STATUS_FRAME_RCV_DONE\fR -.ad -.sp .6 -.RS 4n -Frame successfully received. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_STATUS_RING_BUFF_LOST_FRAME\fR -.ad -.sp .6 -.RS 4n -A frame has been lost while processing the ring buffer. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_STATUS_PARAM_CHANGE\fR -.ad -.sp .6 -.RS 4n -A parameter has been changed. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_STATUS_FRAME_SEQ_NUM_COUNT_OVERFLOW\fR -.ad -.sp .6 -.RS 4n -Frame sequence number has reached its maximum possible value and has -overflowed. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_STATUS_CAM_UNPLUG\fR -.ad -.sp .6 -.RS 4n -Camera has been unplugged. -.RE - -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_BRIGHTNESS\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the -brightness of the camera. -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_PRESENCE\fR -.ad -.sp .6 -.RS 4n -Indicates if the feature is available. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_CAP_ON_OFF\fR -.ad -.sp .6 -.RS 4n -Indicates if the feature may be enabled and disabled. May only be queried. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_ON_OFF\fR -.ad -.sp .6 -.RS 4n -Indicates if the feature is enabled. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_CAP_CTRL_AUTO\fR -.ad -.sp .6 -.RS 4n -Indicates if the automatic control of this feature is supported by the camera. -May only be queried. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_CAP_CTRL_MANUAL\fR -.ad -.sp .6 -.RS 4n -Indicates if the manual control of this feature is supported by the camera. May -only be queried. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_CTRL_MODE\fR -.ad -.sp .6 -.RS 4n -Indicates if the feature is in auto or manual mode. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_MIN_VAL\fR -.ad -.sp .6 -.RS 4n -Minimum value of the feature. May only be queried. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_MAX_VAL\fR -.ad -.sp .6 -.RS 4n -Maximum value of the feature. May only be queried. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_VALUE\fR -.ad -.sp .6 -.RS 4n -Current value of the feature. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_CAP_READ\fR -.ad -.sp .6 -.RS 4n -Indicates if the feature may be read. May only be queried. -.RE - -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_EXPOSURE\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the -exposure of the camera. The subparams supported by this feature are described -under DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_SHARPNESS\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the -sharpness of the camera. The subparams supported by this feature are described -under DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_WHITE_BALANCE\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the white -balance of the camera. The subparams supported by this feature are described -under DCAM1394_PARAM_BRIGHTNESS, except for DCAM1394_SUBPARAM_VALUE. -DCAM1394_SUBPARAM_VALUE is replaced by two distinct subparams. -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_U_VALUE\fR -.ad -.RS 29n -U or B component of the white balance. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_SUBPARAM_V_VALUE\fR -.ad -.RS 29n -V or R component of the white balance. -.RE - -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_HUE\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the hue of -the camera. The subparams supported by this feature are described under -DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_SATURATION\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the -saturation of the camera. The subparams supported by this feature are described -under DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_GAMMA\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the gamma -of the camera. The subparams supported by this feature are described under -DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_SHUTTER\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the -sharpness of the camera. The subparams supported by this feature are described -under DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_GAIN\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the gain of -the camera. The subparams supported by this feature are described under -DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_IRIS\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the iris of -the camera. The subparams supported by this feature are described under -DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_FOCUS\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the focus -of the camera. The subparams supported by this feature are described under -DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_ZOOM\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the zoom of -the camera. The subparams supported by this feature are described under -DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_PAN\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the pan of -the camera. The subparams supported by this feature are described under -DCAM1394_PARAM_BRIGHTNESS. -.RE - -.sp -.ne 2 -.na -\fBDCAM1394_PARAM_TILT\fR -.ad -.sp .6 -.RS 4n -Query or control a camera feature. This feature queries or controls the tilt of -the camera.The subparams supported by this feature are described under -DCAM1394_PARAM_BRIGHTNESS. -.RE - -.SH DEVICE SPECIAL FILES -.ne 2 -.na -\fB/dev/dcam\fIN\fR\fR -.ad -.RS 17n -Device node for isochronous input from camera. -.RE - -.sp -.ne 2 -.na -\fB/dev/dcamctl\fIN\fR\fR -.ad -.RS 17n -Device node for camera control. -.RE - -.SH FILES -.ne 2 -.na -\fB/kernel/drv/sparcv9/dcam1394\fR -.ad -.sp .6 -.RS 4n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/dcam1394\fR -.ad -.sp .6 -.RS 4n -Device driver (x86) -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -\fBattributes\fR(5), \fBhci1394\fR(7D) -.sp -.LP -\fI1394 Trade Association Digital Camera Specification, Version 1.04 - 1996\fR -.sp -.LP -\fIIEEE Std 1394-2000 Standard for a High Performance Serial Bus - 2000\fR diff --git a/usr/src/man/man7d/devinfo.7d b/usr/src/man/man7d/devinfo.7d deleted file mode 100644 index 834f8528f5..0000000000 --- a/usr/src/man/man7d/devinfo.7d +++ /dev/null @@ -1,41 +0,0 @@ -'\" te -.\" Copyright (c) 1998, 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 DEVINFO 7D "Jan 9, 1998" -.SH NAME -devinfo \- device information driver -.SH DESCRIPTION -.sp -.LP -The \fBdevinfo\fR driver is a private mechanism used by the -\fBlibdevinfo\fR(3LIB) interfaces to access kernel device configuration data -and to guarantee data consistency. -.SH FILES -.sp -.LP -\fB/devices/pseudo/devinfo@0:devinfo\fR -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Stability Level Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBlibdevinfo\fR(3LIB), \fBattributes\fR(5) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man7d/dm2s.7d b/usr/src/man/man7d/dm2s.7d deleted file mode 100644 index 88f16fc8ac..0000000000 --- a/usr/src/man/man7d/dm2s.7d +++ /dev/null @@ -1,40 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 DM2S 7D "Apr 6, 2006" -.SH NAME -dm2s \- loadable STREAMS driver -.SH SYNOPSIS -.LP -.nf -dm2s@0 -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBdm2s\fR module is a loadable STREAMS driver that provides synchronous -serial communication support for DSCP communication. \fBdm2s\fR is specific to -the SPARC Enterprise Server family. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/dmfe.7d b/usr/src/man/man7d/dmfe.7d deleted file mode 100644 index a4a48cf53a..0000000000 --- a/usr/src/man/man7d/dmfe.7d +++ /dev/null @@ -1,197 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH DMFE 7D "Sep 17, 2007" -.SH NAME -dmfe \- Davicom Fast Ethernet driver for Davicom DM9102A -.SH SYNOPSIS -.LP -.nf -/kernel/drv/sparcv9/dmfe -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBdmfe\fR Ethernet device provides 100Base-TX networking interfaces using -the Davicom DM9102A chip, which incorporates its own internal transceiver. -.sp -.LP -The \fBdmfe\fR driver functions include controller initialization, frame -transmit and receive, promiscuous and multicast support, and error recovery and -reporting. Multiple controllers installed within the system are supported by -the driver. -.sp -.LP -The 100Base-TX standard specifies an auto-negotiation protocol to automatically -select the mode and speed of operation. The internal transceiver is capable of -performing auto-negotiation with the remote-end of the link (link partner) and -receives the capabilities of the remote end. It selects the highest common -denominator mode of operation based on the priorities. The internal transceiver -also supports a forced-mode of operation under which the driver selects the -operational mode. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The \fB/dev/dmfe\fR cloning character-special device is used to access all -Davicom DM9102A devices installed in the system. -.sp -.LP -You must send an explicit DL_ATTACH_REQ message to associate the opened stream -with a particular device (ppa). The ppa ID is interpreted as an unsigned -integer data type and indicates the corresponding device instance (unit) -number. If the ppa field value does not correspond to a valid device instance -number for this system, an error (DL_ERROR_ACK) is returned. The device is -initialized on first attach and de-initialized (stopped) at last detach. -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to a -DL_INFO_REQ are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU is 1500 (ETHERMTU - defined in \fBsys/ethernet.h\fR). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -DLSAP address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is DL_ETHER. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The sap length value is -2, meaning the physical address component is -followed immediately by a 2-byte sap component within the DLSAP address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The broadcast address value is the Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.RE -.sp -.LP -Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a -particular Service Access Point (SAP) with the stream. -.SH CONFIGURATION -.sp -.LP -By default, the \fBdmfe\fR driver performs auto-negotiation to select the speed -and mode of the link. Link speed and mode can be 100 Mbps (full or half-duplex) -or 10 Mbps (full or half-duplex) as described in the 100Base-TX standard. -.sp -.LP -The auto-negotiation protocol automatically selects speed mode (either 100 Mbps -or 10 Mbps) and operation mode (either full-duplex or half-duplex) as the -highest common denominator supported by both link partners. Because the -\fBdmfe\fR device supports all modes, this effectively selects the -highest-throughput mode supported by the other device. -.sp -.LP -Alternatively, you can explicitly specify the link parameters by adding entries -to the \fBdmfe\fR driver configuration file (\fB/kernel/drv/dmfe.conf\fR). You -can set the \fBspeed\fR parameter to 10 or 100 to force \fBdmfe\fR devices to -operate at the specified speed. Additionally, you can set the full-duplex -parameter to 0 or 1 to disable or force full-duplex operation, respectively. -.sp -.LP -Note that specifying either "speed" or "full-duplex" explicitly disables -auto-negotiation. To enable the driver to determine the appropriate setting for -each parameter, you should always set both parameters. If it is necessary to -force either speed or duplex setting (for example, because the \fBdmfe\fR -device is connected to an ancient device or hub that does not support -auto-negotiation), both parameters should be explicitly specified to match the -requirements of the external device. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/dmfe\fR\fR -.ad -.RS 28n -Character special device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/dmfe\fR\fR -.ad -.RS 28n -32-bit kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/dmfe\fR\fR -.ad -.RS 28n -64-bit kernel module (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/dmfe\fR\fR -.ad -.RS 28n -64-bit kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/dmfe.conf\fR\fR -.ad -.RS 28n -\fBdmfe\fR configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBgld\fR(7D), \fBdlpi\fR(7P), \fBstreamio\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR diff --git a/usr/src/man/man7d/dnet.7d b/usr/src/man/man7d/dnet.7d deleted file mode 100644 index 348e6b9429..0000000000 --- a/usr/src/man/man7d/dnet.7d +++ /dev/null @@ -1,191 +0,0 @@ -'\" te -.\" All Rights Reserved. Copyright (c) 2000, 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 DNET 7D "Oct 20, 2000" -.SH NAME -dnet \- Ethernet driver for DEC 21040, 21041, 21140 Ethernet cards -.SH SYNOPSIS -.LP -.nf -\fB/kernel/drv/dnet\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBdnet\fR Ethernet driver is a multithreaded, loadable, clonable, -\fBSTREAMS GLD\fR driver. Multiple controllers installed within the system are -supported by the driver. The \fBdnet\fR driver functions include controller -initialization, frame transmit and receive, functional addresses, promiscuous -and multicast support, and error recovery and reporting. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning character-special device, \fB/dev/dnet\fR, is used to access all -DEC 21040/21041/21140 devices installed in the system. -.sp -.LP -The \fBdnet\fR driver is dependent on \fB/kernel/misc/gld\fR, a loadable kernel -module that provides the \fBdnet\fR driver with the \fBDLPI\fR and -\fBSTREAMS\fR functionality required of a \fBLAN\fR driver. See \fBgld\fR(7D) -for more details on the primitives supported by the driver. -.sp -.LP -The device is initialized on the first attach and de-initialized (stopped) on -the last detach. -.sp -.LP -The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in -response to a \fBDL_INFO_REQ\fR from the user are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -The maximum \fBSDU\fR is \fB1500\fR (\fBETHERMTU\fR - defined in -<\fBsys/ethernet.h\fR>). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The minimum \fBSDU\fR is \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBDLSAP\fR address length is \fB8\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBMAC\fR type is \fBDL_ETHER\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBsap\fR length value is \fB\(mi2\fR, meaning the physical address -component is followed immediately by a 2-byte \fBsap\fR component within the -\fBDLSAP\fR address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The broadcast address value is the Ethernet/IEEE broadcast address -(\fBFF:FF:FF:FF:FF:FF\fR). -.RE -.sp -.LP -Once in the \fBDL_ATTACHED\fR state, the user must send a \fBDL_BIND_REQ\fR to -associate a particular Service Access Point (SAP) with the stream. -.SH PRECONFIGURATION -.sp -.LP -The PCI configuration process varies from system to system. Follow the -instructions provided by the vendor. -.SS "Known Problems and Limitations" -.RS +4 -.TP -.ie t \(bu -.el o -On multiport cards (exception: Osicom (Rockwell) RNS2340), the first port is -the top port. (On the Osicom RNS2340, the first port is the bottom port.) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -If the \fBdnet\fR driver fails to determine the correct speed and duplex mode -resulting in a corresponding drop in performance, set the speed and duplex mode -using the \fBdnet.conf\fR file. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBdnet\fR driver incorrectly counts carrier lost or no carrier errors -while in full-duplex mode. There is no carrier signal present when in -full-duplex mode and it should not be counted as an error. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Version 4 SROM formats are not supported. -.RE -.SH CONFIGURATION -.sp -.LP -The \fB/kernel/drv/dnet.conf\fR file supports the following options: -.sp -.ne 2 -.na -\fB\fBfull-duplex\fR\fR -.ad -.RS 15n -For full duplex operation use \fBfull-duplex=1\fR, for half duplex use -\fBfull-duplex=0\fR. Half-duplex operation gives better results on older 10mbit -networks. -.RE - -.sp -.ne 2 -.na -\fB\fBspeed\fR\fR -.ad -.RS 15n -For 10mbit operation use \fBspeed=10\fR, for 100mbit operation use -\fBspeed=100\fR. Certain 21140 based cards will operate at either speed. Use -the speed property to override the 100mbit default in this case. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/dnet\fR\fR -.ad -.RS 25n -character special device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/dnet.conf\fR\fR -.ad -.RS 25n -\fBdnet\fR configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBdlpi\fR(7P), \fBgld\fR(7D) \fBstreamio\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP - \fISTREAMS Programming Guide\fR diff --git a/usr/src/man/man7d/dr.7d b/usr/src/man/man7d/dr.7d deleted file mode 100644 index d3494d1736..0000000000 --- a/usr/src/man/man7d/dr.7d +++ /dev/null @@ -1,35 +0,0 @@ -'\" te -.\" Copyright 2019 Peter Tribble. -.\" Copyright (c) 2001 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 DR 7D "Jun 13, 2019" -.SH NAME -dr, drmach \- dynamic reconfiguration driver -.SH SYNOPSIS -.LP -.nf -\fBdr\fR -.fi - -.LP -.nf -\fBdrmach\fR -.fi - -.SH DESCRIPTION -.LP -The dynamic reconfiguration (DR) driver consists of a platform-independent -driver and a platform-specific module. The DR driver uses standard features of -the Solaris operating environment whenever possible to control DR operations -and calls the platform specific module as needed. The DR driver creates minor -nodes in the file system that serve as attachment points for DR operations. -.sp -.LP -The DR driver provides a pseudo-driver interface to sequence attach and detach -operations on system boards using file system entry points referred to as -"attachment points." The attachment point form depends on the platform. -.SH SEE ALSO -.LP -\fBioctl\fR(2), \fBlibcfgadm(3LIB)\fR diff --git a/usr/src/man/man7d/dtrace.7d b/usr/src/man/man7d/dtrace.7d deleted file mode 100644 index cefee6a2cd..0000000000 --- a/usr/src/man/man7d/dtrace.7d +++ /dev/null @@ -1,41 +0,0 @@ -'\" te -.\" Copyright (c) 2003, 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 DTRACE 7D "Dec 10, 2017" -.SH NAME -dtrace \- DTrace dynamic tracing facility -.SH DESCRIPTION -.LP -The \fBdtrace\fR driver provides the dynamic instrumentation and tracing -facilities for the DTrace software, as well as the built-in \fBdtrace\fR -provider. The \fBdtrace\fR driver is not a public interface and you access the -instrumentation offered by this provider through DTrace tools such as -\fBdtrace\fR(1M). Refer to the \fIDynamic Tracing Guide\fR for a -description of the public documented interfaces available for the DTrace -facility and dtrace provider probes. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.LP -\fBdtrace\fR(1M), \fBlibdtrace\fR(3LIB), \fBattributes\fR(5) -.sp -.LP -\fIDynamic Tracing Guide\fR: -.sp -.LP -https://illumos.org/books/dtrace/ diff --git a/usr/src/man/man7d/e1000g.7d b/usr/src/man/man7d/e1000g.7d deleted file mode 100644 index 3582d0dc20..0000000000 --- a/usr/src/man/man7d/e1000g.7d +++ /dev/null @@ -1,213 +0,0 @@ -.\" -.\" 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 2020 Robert Mustacchi -.\" Copyright 2022 Oxide Computer Company -.\" -.Dd January 17, 2022 -.Dt E1000G 7D -.Os -.Sh NAME -.Nm e1000g -.Nd Intel 1 Gigabit Client Ethernet Controller -.Sh SYNOPSIS -.Pa /dev/net/e1000g* -.Sh DESCRIPTION -The -.Nm -driver is a GLDv3 NIC driver for Intel 1 Gigabit Ethernet devices which -are often found as discrete PCI and PCI expresss add-on-cards and built -into many Intel chipsets and platforms. -.Pp -On most models, the device driver supports transmit and receive -checksumming, 9000 byte jumbo frames, large send offload -.Pq LSO , -LED control and Ethernet Pause frames. -.Pp -For each device supported by the -.Nm -driver, a character special-file will be created for each instance. -The first instance would have id 0 and would be named -.Sy e1000g0 -and found in the file system at -.Pa /dev/net/e1000g0 . -This device node supports the Data Link Provider Interface -.Pq DLPI -which is documented in -.Xr dlpi 7P . -.Xr libdlpi 3LIB -provides a more usable interface on top of that. -.Pp -For administrative control, the device can be manipulated through the -.Xr dladm 1M -utility. -.Pp -The following Ethernet controllers are supported by this driver: -.Bl -bullet -.It -82542 Gigabit Ethernet Controller -.It -82543GC Gigabit Ethernet Controller -.It -82544EI Gigabit Ethernet Controller -.It -82544GC Gigabit Ethernet Controller -.It -82540EM Gigabit Ethernet Controller -.It -82540EP Gigabit Ethernet Controller -.It -8254EM Gigabit Ethernet Controller -.It -82545GM Gigabit Ethernet Controller -.It -82546GB Gigabit Ethernet Adapter -.It -82541EI Gigabit Ethernet Controller -.It -82541ER Gigabit Ethernet Controller -.It -82541GI Gigabit Ethernet Controller -.It -82547EI Gigabit Ethernet Controller -.It -82547GI Gigabit Ethernet Controller -.It -82571EB Gigabit Ethernet Controller -.It -82571GB Gigabit Ethernet Controller -.It -82571PT Gigabit PT Quad Port Server ExpressModule -.It -82572EI Gigabit Ethernet Controller -.It -82573E Gigabit Ethernet Controller -.It -82573V Gigabit Ethernet Controller -.It -82573L Gigabit Ethernet Controller -.It -82574L Gigabit Ethernet Controller -.It -82583V Gigabit Ethernet Controller -.It -80003ES2LAN Gigabit Ethernet Controller -.It -82566MM Gigabit Network Connection -.It -82566DM Gigabit Network Connection v1-2 -.It -82566DC Gigabit Network Connection v1-2 -.It -82562V 10/100 Network Connection v1-2 -.It -82562GT 10/100 Network Connection v1-2 -.It -82562G 10/100 Network Connection v1-2 -.It -82566MC Gigabit Network Connection -.It -82567LM v1-v4 Gigabit Network Connection -.It -82567LF v1-v3 Gigabit Network Connection -.It -82567V v1-v4 Gigabit Network Connection -.It -82577LM Gigabit Network Connection -.It -82577LC Gigabit Network Connection -.It -82578DM Gigabit Ethernet PHY -.It -82578DC Gigabit Ethernet PHY -.It -82579LM Gigabit Network Connection -.It -82579V Gigabit Network Connection -.It -Ethernet Connection I217-LM -.It -Ethernet Connection I217-V -.It -Ethernet Connection I218-LM v1-3 -.It -Ethernet Connection I218-V v1-3 -.It -Ethernet Connection I219-LM v1-23 -.It -Ethernet Connection I219-V v1-23 -.El -.Pp -The following specific devices are supported by this driver: -.Bl -bullet -.It -Gigabit CT2 Desktop Adapter -.It -PRO/1000 Gigabit Server Adapter -.It -PRO/1000 CT Desktop, Mobile, and Network Connection -.It -PRO/1000 F Server Adapter -.It -PRO/1000 GT Desktop, Server, and Quad Port Server Adapter -.It -PRO/1000 MB Server and Dual Port Server Connection -.It -PRO/1000 MF Server and Dual Port Server Adapter -.It -PRO/1000 MT Desktop, Mobile, Network, Server, Dual Port Server, and Quad -Port Server Adapter -.It -PRO/1000 P Dual Port Server Adapter -.It -PRO/1000 PB Dual Port Server Connection -.It -PRO/1000 PF Server, Dual Port Server and Quad Port Server Adapter -.It -PRO/1000 PL Network Connection -.It -PRO/1000 PT Desktop, Server, Dual Port Server, Quad Port Server, and Quad Port LP Server -Adapter -.It -PRO/1000 T Desktop and Server Adapter -.It -PRO/1000 XF Server Adapter -.It -PRO/1000 XT Server and Desktop Adapter -.El -.Pp -The -.Xr igb 7D -driver supports many other Intel Gigabit parts. -.Sh CONFIGURATION -The -.Pa e1000g.conf -file contains some user configurable parameters, the format of which -is documented in -.Xr driver.conf 4 . -Generally, the use of -.Xr dladm 1M -is recommended over editing the configuration file. -.Sh FILES -.Bl -tag -width Pa -.It Pa /kernel/drv/amd64/e1000g -Device driver (x86) -.It Pa /kernel/drv/sparcv9/e1000g -Device driver (SPARC) -.It Pa /kernel/drv/e1000g.conf -Driver configuration file -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr libdlpi 3LIB , -.Xr driver.conf 4 , -.Xr igb 7D , -.Xr dlpi 7P diff --git a/usr/src/man/man7d/ecpp.7d b/usr/src/man/man7d/ecpp.7d deleted file mode 100644 index dc5259dbdf..0000000000 --- a/usr/src/man/man7d/ecpp.7d +++ /dev/null @@ -1,465 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 ECPP 7D "May 17, 2020" -.SH NAME -ecpp \- IEEE 1284 compliant parallel port driver -.SH SYNOPSIS -.nf -#include <sys/types.h> -.fi - -.LP -.nf -#include <sys/ecppio.h> -.fi - -.LP -.nf -ecpp@unit-address -.fi - -.SH DESCRIPTION -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 -driver supports the \fIIEEE 1284\fR Compatibility, Nibble, and ECP protocols. -\fBECPP_COMPAT_MODE\fR and \fBECPP_CENTRONICS\fR modes of operation have -logically identical handshaking protocols, however devices that support -\fBECPP_COMPAT_MODE\fR are \fIIEEE 1284\fR compliant devices. \fIIEEE 1284\fR -compliant devices support at least \fBECPP_COMPAT_MODE\fR and -\fBECPP_NIBBLE_MODE\fR. Centronics devices support only \fBECPP_CENTRONICS\fR -mode. -.sp -.LP -By default, \fBECPP_COMPAT_MODE\fR devices have a strobe handshaking pulse -width of 500ns. For this mode, forward data transfers are conducted by DMA. By -default, the strobe pulse width for \fBECPP_CENTRONICS\fR devices is two -microseconds. Forward transfers for these devices are managed through PIO. The -default characteristics for both \fBECPP_COMPAT_MODE\fR and -\fBECPP_CENTRONICS\fR devices may be changed through tunable variables defined -in \fBecpp.conf\fR. -.sp -.LP -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" -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. -.sp -.LP -The driver sets the mode variable according to the following algorithm: The -driver initially attempts to negotiate the link into \fBECPP_ECP_MODE\fR during -\fBopen\fR(2). If it fails, the driver tries to negotiate into -\fBECPP_NIBBLE_MODE\fR mode. If that fails, the driver operates in -\fBECPP_CENTRONICS\fR mode. Upon successfully opening the device, \fIIEEE -1284\fR compliant devices will be left idle in either reverse idle phase of -\fBECPP_ECP_MODE\fR or in \fBECPP_NIBBLE_MODE\fR. Subsequent calls to -\fBwrite\fR(2) invokes the driver to move the link into either -\fBECPP_COMPAT_MODE\fR or the forward phase of \fBECPP_ECP_MODE\fR. After the -transfer completes, the link returns to idle state. -.sp -.LP -The application may attempt to negotiate the device into a specific mode or set -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" -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. -.sp -.LP -Some Centronics peripherals and certain \fIIEEE 1284\fR compatible peripherals -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" -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" -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 -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" -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 -\fBO_NDELAY\fR is set. If \fBO_NONBLOCK\fR is set, \fBread\fR(2) returns -\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 -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. -.sp -.LP -The ecpp driver supports \fBprnio\fR(7I) interfaces. -.LP -Note - -.sp -.RS 2 -The \fBPRNIOC_RESET\fR command toggles the \fBnInit\fR signal for 2 ms, -followed by default negotiation. -.RE -.sp -.LP -The following \fBioctl\fR(2) calls are supported for backward compatibility and -are not recommended for new applications: -.sp -.ne 2 -.na -\fB\fBECPPIOC_GETPARMS\fR\fR -.ad -.RS 20n -Get current transfer parameters. The argument is a pointer to a struct -\fBecpp_transfer_parms\fR. See below for a description of the elements of this -structure. If no parameters have been configured since the device was opened, -the structure will be set to its default configuration. See Default Operation -above for more information. -.RE - -.sp -.ne 2 -.na -\fB\fBECPPIOC_SETPARMS\fR\fR -.ad -.RS 20n -Set transfer parameters. The argument is a pointer to a struct -\fBecpp_transfer_parms\fR. If a parameter is out of range, \fBEINVAL\fR is -returned. If the peripheral or host device cannot support the requested mode, -\fBEPROTONOSUPPORT\fR is returned. See below for a description of -\fBecpp_transfer_parms\fR and its valid parameters. -.sp -The Transfer Parameters Structure is defined in <\fBsys/ecppio.h\fR>. -.sp -.in +2 -.nf -struct ecpp_transfer_parms { - int write_timeout; - int mode; -}; -.fi -.in -2 - -The \fBwrite_timeout\fR field is set to the value of -\fBecpp-transfer-timeout\fR specified in the \fBecpp.conf\fR. The -\fBwrite_timeout\fR field specifies how long the driver will wait for the -peripheral to respond to a transfer request. The value must be greater than -\fB0\fR and less than \fBECPP_MAX_TIMEOUT.\fR All other values are out of -range. -.sp -The mode field reflects the \fIIEEE 1284\fR mode to which the parallel port is -currently configured. The mode may be set to one of the following values only: -\fBECPP_CENTRONICS\fR, \fBECPP_COMPAT_MODE\fR, \fBECPP_NIBBLE_MODE\fR, -\fBECPP_ECP_MODE\fR. All other values are invalid. If the requested mode is not -supported, \fBECPPIOC_SETPARMS\fR will return \fBEPROTONOSUPPORT\fR and the -mode will be set to \fBECPP_CENTRONICS\fR mode. Afterwards, the application may -change the mode back to the original mode with \fBECPPIOC_SETPARMS\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBECPPIOC_GETDEVID\fR\fR -.ad -.RS 20n -This ioctl gets the \fIIEEE 1284\fR device ID from the peripheral in specified -mode. Currently, the device ID can be retrieved only in Nibble mode. A pointer -to the structure defined in \fB<sys/ecppsys.h>\fR must be passed as an -argument. -.sp -The 1284 device ID structure: -.sp -.in +2 -.nf -struct ecpp_device_id { - int mode; /* mode to use for reading device id */ - int len; /* length of buffer */ - int rlen; /* actual length of device id string */ - char *addr; /* buffer address */ -}; -.fi -.in -2 - -The mode is the \fIIEEE 1284\fR mode into which the port will be negotiated to -retrieve device ID information. If the peripheral or host do not support the -mode, \fBEPROTONOSUPPORT\fR is returned. Applications should set mode to -\fBECPP_NIBBLE_MODE\fR. \fBlen\fR is the length of the buffer pointed to by -\fBaddr\fR. \fBrlen\fR is the actual length of the device ID string returned -from the peripheral. If the returned \fBrlen\fR is greater than \fBlen\fR, the -application can call \fBECPPIOC_GETDEVID\fR again with a buffer length equal or -greater than \fBrlen\fR. Note that the two length bytes of the \fIIEEE 1284\fR -device ID are not taken into account and are not returned in the user buffer. -.sp -After \fBECPPIOC_GETDEVID\fR successfully completes, the driver returns the -link to \fBECPP_COMPAT_MODE\fR. The application is responsible for determining -the previous mode the link was operating in and returning the link to that -mode. -.RE - -.sp -.ne 2 -.na -\fB\fBBPPIOC_TESTIO\fR\fR -.ad -.RS 20n -Tests the forward transfer readiness of a peripheral operating in Centronics or -Compatibility mode. -.sp -\fBTESTIO\fR determines if the peripheral is ready to receive data by checking -the open flags and the Centronics status signals. If the current mode of the -device is \fBECPP_NIBBLE_MODE\fR, the driver negotiates the link into -\fBECPP_COMPAT_MODE\fR, check the status signals and then return the link to -\fBECPP_NIBBLE_MODE\fR mode. If the current mode is \fBECPP_CENTRONICS\fR or -\fBECPP_COMPAT_MODE\fR, \fBTESTIO\fR examines the Centronics status signals in -the current mode. To receive data, the device must have the \fBnErr\fR and -\fBSelect\fR signals asserted and must not have the \fBPE\fR and \fBBusy\fR -signals asserted. If \fBecpp\fR is transferring data, \fBTESTIO\fR waits until -the previous data sent to the driver is delivered before executing -\fBTESTIO\fR. However if an error condition occurs while a \fBTESTIO\fR is -waiting, \fBTESTIO\fR returns immediately. If \fBTESTIO\fR determines that the -conditions are ok, \fB0\fR is returned. Otherwise, \fB-1\fR is returned, errno -is set to \fBEIO\fR and the state of the status pins is captured. The captured -status can be retrieved using the \fBBPPIOC_GETERR\fR \fBioctl\fR(2) call. The -\fBtimeout_occurred\fR and \fBbus_error\fR fields will never be set by this -\fBioctl\fR(2). -.RE - -.sp -.ne 2 -.na -\fB\fBBPPIOC_GETERR\fR\fR -.ad -.RS 20n -Get last error status. The argument is a pointer to a \fBstruct -bpp_error_status\fR defined in \fB<sys/bpp_io.h>\fR header file. The error -status structure is: -.sp -.in +2 -.nf -struct bpp_error_status { - char timeout_occurred; /* 1=timeout */ - char bus_error; /* not used */ - uchar_t pin_status; /* status of pins which - /* could cause error */ -}; -.fi -.in -2 - -The pin_status field indicates possible error conditions. The valid bits for -pin_status are: \fBBPP_ERR_ERR\fR, \fBBPP_SLCT_ERR\fR, \fBBPP_PE_ERR\fR, -\fBBPP_BUSY_ERR\fR. A set bit indicates that the associated pin is asserted. -.sp -This structure indicates the status of all the appropriate status bits at the -time of the most recent error condition during a \fBwrite\fR(2) call, or the -status of the bits at the most recent \fBBPPIOC_TESTIO\fR \fBioctl\fR(2)call. -.sp -\fBpin_status\fR indicates possible error conditions under -\fBECPP_CENTRONICS\fR or \fBECPP_COMPAT_MODE\fR. Under these modes, the state -of the status pins will indicate the state of the device. For instance, many -Centronics printers lower the \fBnErr\fR signal when a paper jam occurs. The -behavior of the status pins depends on the device. Additional status -information may be retrieved through the backchannel. -.sp -The \fBtimeout_occurred\fR value is set when a timeout occurs during -\fBwrite\fR(2). \fBbus_error\fR is not used in this interface. -.RE - -.sp -.LP -The following ioctls are used to directly read and write the parallel port -status and control signals. If the current mode of the device is -\fBECPP_ECP_MODE\fR or \fBECPP_NIBBLE_MODE\fR, the driver negotiates the link -into \fBECPP_COMPAT_MODE\fR, gets or sets the registers and then returns the -link to \fBECPP_NIBBLE_MODE\fR. If the current mode is \fBECPP_CENTRONICS\fR or -\fBECPP_COMPAT_MODE\fR, these ioctls will get/set the register values in the -current mode. -.sp -.ne 2 -.na -\fB\fBECPPIOC_GETREGS\fR\fR -.ad -.RS 19n -Read register values. The argument is a pointer to a \fBstruct ecpp_regs\fR. -See below for a description of this structure. -.RE - -.sp -.ne 2 -.na -\fB\fBECPPIOC_SETREGS\fR\fR -.ad -.RS 19n -Set \fBecpp\fR register values. The argument is a pointer to a \fBstruct -ecpp_regs\fR. See below for a description of this structure. If a parameter is -out of range, \fBEINVAL\fR is returned. -.sp -The Port Register Structure is defined in <\fBsys/ecppio.h\fR>. -.sp -.in +2 -.nf -struct ecpp_regs { - uchar dsr; /* status reg */ - u_char dcr; /* control reg */ -}; -.fi -.in -2 - -The status register is read-only. The \fBECPPIOC_SETREGS\fR ioctl has no affect -on this register. Valid bit values for dsr are: \fBECPP_nERR\fR, -\fBECPP_SLCT\fR, \fBECPP_PE\fR, \fBECPP_nACK\fR, \fBECPP_nBUSY\fR. All other -bits are reserved and always return \fB1\fR. -.sp -The control register is read/write. Valid bit values for dcr are: -\fBECPP_STB\fR, \fBECPP_AFX\fR, \fBECPP_nINIT\fR, \fBECPP_SLCTIN\fR. All other -bits are reserved. Reading reserved bits always return 1. An attempt to write -0s into these bits results in \fBEINVAL\fR. -.RE - -.SH DEVICE SPECIAL FILES -.ne 2 -.na -\fB\fB/dev/lp\fIN\fR\fR\fR -.ad -.RS 19n -x86 only. (Backwards compatibility with former \fBlp\fR(7D) devices.) -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/printers/\fIN\fR\fR\fR -.ad -.RS 19n -1284 compliant parallel port device special files appears in both namespaces. -.RE - -.SH FILES -.ne 2 -.na -\fB/kernel/drv/sparcv9/ecpp\fR -.ad -.sp .6 -.RS 4n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/ecpp\fR -.ad -.sp .6 -.RS 4n -Device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/ecpp.conf\fR -.ad -.sp .6 -.RS 4n -Driver configuration file -.RE - -.SH ERRORS -.ne 2 -.na -\fB\fBEBADF\fR\fR -.ad -.RS 10n -The device is opened for write-only access and a read is attempted, or the -device is opened for read-only access and a write is attempted. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 10n -The device has been opened and another open is attempted. An attempt has been -made to unload the driver while one of the units is open. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -A \fBECPPIOC_SETPARMS\fR \fBioctl()\fR is attempted with an out-of-range value -in the \fBecpp_transfer_parms\fR structure. A \fBECPPIOC_SETREGS\fR -\fBioctl()\fR is attempted with an invalid value in the \fBecpp_regs\fR -structure. An \fBioctl()\fR is attempted with an invalid value in the command -argument.An invalid command argument is received during \fBmodload\fR(1M) or -\fBmodunload\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 10n -The driver encountered a bus error when attempting an access. A read or write -did not complete properly, due to a peripheral error or a transfer timeout. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -The driver has received an open request for a unit for which the attach failed. -The driver has received a write request for a unit which has an active -peripheral error. -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PCI-based systems -_ - ISA-based systems (x86) -_ -Interface stability Evolving -.TE - -.SH SEE ALSO -\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), -\fBusbprn\fR(7D), \fBprnio\fR(7I), \fBstreamio\fR(7I) -.sp -.LP -\fIIEEE Std 1284-1994\fR -.SH DIAGNOSTICS -.ne 2 -.na -\fBParallel port controller not supported\fR -.ad -.sp .6 -.RS 4n -Driver does not support parallel port controller on the given host. Attach -failed. -.RE diff --git a/usr/src/man/man7d/ehci.7d b/usr/src/man/man7d/ehci.7d deleted file mode 100644 index b9ba26cf3d..0000000000 --- a/usr/src/man/man7d/ehci.7d +++ /dev/null @@ -1,314 +0,0 @@ -'\" te -.\" Copyright (c) 2006 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 EHCI 7D "Jan 10, 2020" -.SH NAME -ehci \- Enhanced host controller driver -.SH SYNOPSIS -.nf -\fBusb@unit-address\fR -.fi - -.SH DESCRIPTION -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. -.sp -.LP -A USB 2.0 host controller includes one high-speed host controller and zero or -more USB 1.1 host controllers. The high-speed host controller implements an -EHCI (Enhanced Host Controller Interface) that is used for all high-speed -communications to high-speed-mode devices. -.sp -.LP -All USB 2.0 devices connected to the root ports of the USB 2.0 host -controller and all devices connected to a high-speed-mode hub should be routed -to the EHCI host controller. -.sp -.LP -All full- and low-speed devices connected to the root ports of the USB 2.0 host -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 isochronous transfers -(on USB1.\fIx\fR devices behind a USB2.0 hub). -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/ehci\fR\fR -.ad -.RS 28n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ehci\fR\fR -.ad -.RS 28n -Device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ehci.conf\fR\fR -.ad -.RS 28n -Driver configuration file -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -\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) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Serial Bus Specification 2.0\fR -.sp -.LP -\fIEnhanced Host Controller Interface Specification 1.0\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.sp -.LP -\fIhttp://www.usb.org\fR -.sp -.LP -\fIhttp://www.intel.com/technology/usb/ehcispec.htm\fR -.SH DIAGNOSTICS -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -WARNING: <device path> (ehci<instance number>): Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBUnrecoverable USB hardware error.\fR -.ad -.sp .6 -.RS 4n -There was an unrecoverable USB hardware error reported by the \fBehci\fR -controller. Reboot the system. If this problem persists, contact your system -vendor. -.RE - -.sp -.ne 2 -.na -\fBNo SOF interrupts.\fR -.ad -.br -.na -\fB\fR -.ad -.sp .6 -.RS 4n -No SOF interrupts have been received. This USB EHCI controller is unusable. -.RE - -.sp -.ne 2 -.na -\fBError recovery failure: Please hotplug the 2.0 hub at <device path>.\fR -.ad -.sp .6 -.RS 4n -The driver failed to clear 2.0 hub's TT buffer. Remove and reinsert the -external USB2.0 hub. -.RE - -.sp -.ne 2 -.na -\fBRevision<xx> is not supported.\fR -.ad -.sp .6 -.RS 4n -High speed USB devices prior to revision 0.95 are not supported. -.RE - -.sp -.LP -The following messages may be entered into the system log. They are formatted -in the following manner: -.sp -.in +2 -.nf -<device path> (ehci<instance number>): Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBUnable to take control from BIOS. Failure is ignored.\fR -.ad -.sp .6 -.RS 4n -The driver was unable to take control of the EHCI hardware from the system's -BIOS. This failure is ignored. To abort the attach on this take-over failure, -comment out a property in ehci.conf. (x86 only). -.RE - -.sp -.ne 2 -.na -\fBUnable to take control from BIOS.\fR -.ad -.sp .6 -.RS 4n -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 administrator for possible changes in BIOS settings. You can -disable a property in \fBehci.conf\fR to ignore this failure. (x86 only.) -.RE - -.sp -.ne 2 -.na -\fBLow speed device is not supported.\fR -.ad -.br -.na -\fBFull speed device is not supported.\fR -.ad -.sp .6 -.RS 4n -The driver detected a low or full speed device on its root hub port. Per USB -2.0 specification, the device should be routed to a companion host controller -(OHCI or UHCI). However, no attached companion host controller appears to be -available. Therefore, low and full speed devices are not supported. -.RE - -.sp -.ne 2 -.na -\fBLow speed endpoint's poll interval of <n> ms is below threshold. Rounding up -to 8 ms.\fR -.ad -.sp .6 -.RS 4n -Low speed endpoints are limited to polling intervals between 8 ms and 255 ms. -If a device reports a polling interval that is less than 8 ms, the driver uses -8 ms instead. -.RE - -.sp -.ne 2 -.na -\fBLow speed endpoint's poll interval is greater than 255 ms.\fR -.ad -.sp .6 -.RS 4n -The low speed device's polling interval is out of range. The host controller -does not allocate bandwidth for this device. This device is not usable. -.RE - -.sp -.ne 2 -.na -\fBFull speed endpoint's poll interval must be between 1 and 255 ms.\fR -.ad -.sp .6 -.RS 4n -The full speed device's polling interval is out of range. The host controller -does not allocate bandwidth for this device. This device is not usable. -.RE - -.sp -.ne 2 -.na -\fBHigh speed endpoint's poll interval must be between 1 and 16 units.\fR -.ad -.sp .6 -.RS 4n -The high speed device's polling interval is out of range. The host controller -will not allocate bandwidth for this device. This device will not be usable. -Refer to the USB specification, revision 2.0 for the unit definition. -.RE - -.sp -.ne 2 -.na -\fBehci_modify_qh_status_bit: Failed to halt qh=<address>.\fR -.ad -.sp .6 -.RS 4n -Error recovery failed. Please disconnect and reinsert all devices or reboot. -.RE - -.LP -Note - -.sp -.RS 2 -Due to recently discovered incompatibilities with this USB controller, -USB2.\fIx\fR transfer support has been disabled. However, this device continues -to function as a USB1.\fIx\fR controller. Information on enabling USB2.x -support is provided in this man page. -.LP -VIA chips may not be compatible with this driver. To bind \fBehci\fR -specifically to the chip and eliminate the warnings, and to enable USB2.x -support, a new, more specific driver alias (refer to \fBadd_drv\fR(1M) and -\fBupdate_drv\fR(1M)) must be specified for \fBehci\fR. By default, the -\fBehci\fR alias is 'pciclass,0c0320.' The compatible names in the -\fBprtconf\fR(1M) output provides additional aliases. For example: -.RE -.sp -.in +2 -.nf - # prtconf -vp | grep pciclass,0c0320 - compatible: 'pci1106,3104.1106.3104.2063' + -\&'pci1106,3104.1106.3104' + 'pci1106,3104' + - pci1106,3104.2063' + 'pci1106,3104' + 'pciclass,0c0320' + -\&'pciclass,0c03' - .... - - - A more specific alias is 'pci1106,3104.' Perform the follow- - ing step to add this alias, then reboot the system: - - - # update_drv -a -i '"pci1106,3104"' ehci - - # reboot -.fi -.in -2 - -.sp -.LP -After you apply the above workaround, the following message is displayed in -your system log: -.sp -.LP -Applying VIA workarounds. diff --git a/usr/src/man/man7d/elxl.7d b/usr/src/man/man7d/elxl.7d deleted file mode 100644 index a6d3d3bf64..0000000000 --- a/usr/src/man/man7d/elxl.7d +++ /dev/null @@ -1,103 +0,0 @@ -.\" Copyright 2014 Garrett D'Amore <garrett@damore.org> -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS -.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE -.\" COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, -.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -.\" (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 "Jan 10, 2020" -.Dt ELXL 7D -.Os -.Sh NAME -.Nm elxl -.Nd 3Com Etherlink XL device driver -.Sh SYNOPSIS -.Pa /dev/elxl -.Sh DESCRIPTION -The -.Nm -driver provides support for the 3Com Etherlink XL -family of Ethernet and Fast Ethernet PCI controllers. -These are often known by their part numbers, most often 3c905 or 3c900 variants. -.Lp -The 3c905 devices generally support some form of 100 Mbps Ethernet, -whereas the 3c900 devices usually only support 10 Mbps. -Some devices support legacy media such as 10BASE-15, 10BASE-2, and even -10BASE-FL. -. -Where applicable, the devices support auto-negotiation, both full and -half duplex, etc. -They also support full size MTUs (1500 bytes), even when used with VLANs. -. -.Lp -The device driver supports the -.Xr ieee802.3 5 -properties, which can be configured with -.Xr dladm 1M . -.Lp -In addition, for devices with multiple external media ports, the driver -supports a driver-specific -.Xr dladm 1M -property called -.Sy media , -which can take one of the following values, depending on the available -media options on the device: -.Lp -.Bl -tag -compact -offset indent -width Sy -.It Sy mii -Media Independent Interface (MII), also 100BASE-TX -.It Sy tp-hdx -10 Mbps twisted pair, half-duplex -.It Sy tp-fdx -10 Mbps twisted pair full-duplex -.It Sy fx-hdx -100BASE-FX (fiber), half-duplex -.It Sy fx-hdx -100BASE-FX (fiber), full-duplex -.It Sy bnc -10BASE-2 -.Pq BNC, aka Dq thin-net -.It Sy aui -10BASE-15 -.Pq aka Dq thick-net -.It Sy fl-hdx -10BASE-FL (fiber), half-duplex -.It Sy fl-fdx -10BASE-FL (fiber), full-duplex -.El -.Lp -The specific media options available can be queried with the -device-specific -.Sy available_media -.Xr dladm 1M -property. -.Sh FILES -.Bl -tag -width /dev/elxl -.It Pa /dev/elxl -Special character device. -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr ifconfig 1M , -.Xr pci 4 , -.Xr ieee802.3 5 , -.Xr dlpi 7P -.Rs -.%T IEEE 802.3: Ethernet -.%Q IEEE Standards Association -.Re diff --git a/usr/src/man/man7d/ena.7d b/usr/src/man/man7d/ena.7d deleted file mode 100644 index d4070e1745..0000000000 --- a/usr/src/man/man7d/ena.7d +++ /dev/null @@ -1,135 +0,0 @@ -.\" -.\" 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 2021 Oxide Computer Company -.\" -.Dd Nov 17, 2021 -.Dt ENA 7D -.Os -.Sh NAME -.Nm ena -.Nd Driver for the AWS Elastic Network Adapter -.Sh SYNOPSIS -.Pa /dev/net/ena* -.Sh DESCRIPTION -The -.Sy ena -driver is a GLDv3 NIC driver for the AWS Elastic Network Adapter -family of virtual devices. -The driver supports: -.Bl -dash -offset indent -.It -Jumbo frames up to 9216 bytes. -.It -Multiple Rx and Tx rings. -.El -.Pp -By design, this driver does not support VNICs. -A given ENA device can only ever receive traffic for a single unicast -MAC address and IP address combination, as determined by the AWS configuration. -There is no support for promiscuous mode, or for receiving traffic for -additional unicast or multicast addresses. -.Sh CONFIGURATION -The -.Sy ena.conf -file contains user configurable parameters, each of which is described -below. -This file is read when an ENA device is found and an instance of the -driver is attached to it. -Changes made to this file do not affect running instances. -Only instances attached after the changes will see the effects of -those changes. -Therefore, if you want your change to take effect on a running -instance, you must somehow reload it. -That could be done by a manual reloading of the driver or a system -reboot. -.Sh PROPERTIES -The configuration file can be found at -.Pa /kernel/drv/ena.conf . -.Bl -hang -width Ds -.It Sy rx_queue_num_descs -.Bd -filled -compact -Minimum: -.Sy 64 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -compact -Default: -.Sy device maximum -.Ed -.Bd -filled -The -.Sy rx_queue_num_descs -property determines the number of descriptors provided by the Rx queue. -Currently a single descriptor is equal to a single packet, but in the -future it may be that a single packet consumes multiple descriptors. -.Ed -.It Sy rx_queue_intr_limit -.Bd -filled -compact -Minimum: -.Sy 16 | -Maximum: -.Sy 4096 -.Ed -.Bd -filled -compact -Default: -.Sy 256 -.Ed -.Bd -filled -The -.Sy rx_queue_intr_limit -property determines the number frames an Rx interrupt will attempt to -process before returning and claiming the interrupt. -This is meant to keep the ENA Rx interrupt handler from consuming too -much system time. -In general, when a NIC becomes saturated with packets, the -.Sy MAC -layer will switch the driver into polling mode to reduce interrupt -load. -.Ed -.It Sy tx_queue_num_descs -.Bd -filled -compact -Minimum: -.Sy 64 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -compact -Default: -.Sy device maximum -.Ed -.Bd -filled -The -.Sy tx_queue_num_descs -property determines the number of descriptors provided by the Tx queue. -Currently a single descriptor is equal to a single packet, but in the -future it may be that a single packet consumes multiple descriptors. -.Ed -.El -.Sh FILES -.Bl -tag -width Pa -.It Pa /kernel/drv/amd64/ena -Device driver (x86) -.It Pa /kernel/drv/ena.conf -Driver configuration file containing user-configurable options -.El -.Sh INTERFACE STABILITY -The tunables in -.Pa ena.conf -are considered -.Sy Evolving -and may change in the future. -.Sh SEE ALSO -.Xr dladm 1M , -.Xr snoop 1M , -.Xr driver.conf 4 , -.Xr dlpi 7P diff --git a/usr/src/man/man7d/eri.7d b/usr/src/man/man7d/eri.7d deleted file mode 100644 index 58b5b9aa35..0000000000 --- a/usr/src/man/man7d/eri.7d +++ /dev/null @@ -1,351 +0,0 @@ -'\" te -.\" Copyright (c) 2000, 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 ERI 7D "Mar 1, 2000" -.SH NAME -eri \- eri Fast-Ethernet device driver -.SH SYNOPSIS -.LP -.nf -\fB/dev/eri\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBeri\fR Fast Ethernet driver is a multi-threaded, loadable, clonable, -\fBSTREAMS\fR\(embased hardware driver supporting the connectionless Data Link -Provider Interface \fBdlpi\fR(7P) over an \fBeri\fR Fast-Ethernet controller. -Multiple \fBeri\fR devices installed within the system are supported by the -driver. -.sp -.LP -The \fBeri\fR driver provides basic support for the \fBeri\fR hardware and -handles the \fBeri\fR device. Functions include chip initialization, frame -transit and receive, multicast and promiscuous support, and error recovery and -reporting. -.sp -.LP -The \fBeri\fR device provides 100Base-TX networking interfaces using the SUN -\fBRIO\fR \fBASIC\fR and an internal transceiver. The \fBRIO\fR \fBASIC\fR -provides the \fBPCI\fR interface and \fBMAC\fR functions. The physical layer -functions are provided by the internal transceiver which connects to a RJ-45 -connector. -.sp -.LP -The 100Base-TX standard specifies an auto-negotiation protocol to automatically -select the mode and speed of operation. The internal transceiver is capable of -performing auto-negotiation using the remote-end of the link (link partner) and -receives the capabilities of the remote end. It selects the highest common -denominator mode of operation based on the priorities. It also supports a -forced-mode of operation under which the driver selects the mode of operation. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning character-special device \fB/dev/eri\fR is used to access all -\fBeri\fR controllers installed within the system. -.SS "eri and DLPI" -.sp -.LP -The \fBeri\fR driver is a "style 2" Data Link Service provider. All -\fBM_PROTO\fR and \fBM_PCPROTO\fR type messages are interpreted as \fBDLPI\fR -primitives. Valid \fBDLPI\fR primitives are defined in \fB<sys/dlpi.h>.\fR -Refer to \fBdlpi\fR(7P) for more information. -.sp -.LP -An explicit \fBDL_ATTACH_REQ\fR message by the user is required to associate -the opened stream with a particular device (\fBppa\fR). The \fBppa\fR ID is -interpreted as an \fBunsigned integer\fR data type and indicates the -corresponding device instance (unit) number. An error (\fBDL_ERROR_ACK\fR) is -returned by the driver if the \fBppa\fR field value does not correspond to a -valid device instance number for this system. The device is initialized on -first attach and de-initialized (stopped) at last detach. -.sp -.LP -The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in -response to the \fBDL_INFO_REQ\fR from the user are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -The maximum \fBSDU\fR is \fB1500\fR (\fBETHERMTU\fR - defined in -\fB<sys/ethernet.h>\fR ). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The minimum \fBSDU\fR is \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBdlsap\fR address length is \fB8\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBMAC\fR type is \fBDL_ETHER\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBsap\fR length values is \fB-2\fR, meaning the physical address component -is followed immediately by a 2 byte \fBsap\fR component within the \fBDLSAP\fR -address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The service mode is \fBDL_CLDLS\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Optional quality of service (\fBQOS\fR) is not currently supported so -\fBQOS\fR fields are \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The provider style is \fBDL_STYLE\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The version is \fBDL_VERSION_2\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The broadcast address value is Ethernet/IEEE broadcast address -(\fB0xFFFFFF\fR). -.RE -.sp -.LP -Once in the \fBDL_ATTACHED\fR state, the user must send a \fBDL_BIND_REQ\fR to -associate a particular \fBSAP\fR (Service Access Pointer) with the stream. The -\fBeri\fR driver interprets the \fBsap\fR field within the \fBDL_BIND_REQ\fR as -an Ethernet "type," therefore valid values for the \fBsap\fR field are in the -[\fB0\fR-\fB0xFFFF\fR] range. Only one Ethernet type can be bound to the -stream at any time. -.sp -.LP -If the user selects a \fBsap\fR with a value of \fB0\fR, the receiver will be -in IEEE 802.3 mode. All frames received from the media having a Ethernet type -field in the range [\fB0\fR-\fB1500\fR] are assumed to be 802.3 frames and are -routed up all open Streams which are bound to \fBsap\fR value \fB0\fR. If more -than one Stream is in 802.3 mode, the frame will be duplicated and routed up -multiple Streams as \fBDL_UNITDATA_IND\fR messages. -.sp -.LP -In transmission, the driver checks the \fBsap\fR field of the \fBDL_BIND_REQ\fR -to determine if the value is \fB0\fR or if the Ethernet type field is in the -range [\fB0\fR-\fB1500\fR]. If either is true, the driver computes the length -of the message, not including initial \fBM_PROTO\fR mblk (message block), of -all subsequent \fBDL_UNITDATA_REQ\fR messages, and transmits 802.3 frames that -have this value in the \fBMAC\fR frame header length field. -.sp -.LP -The \fBeri\fR driver's \fBDLSAP\fR address format consists of the 6 byte -physical (Ethernet) address component followed immediately by the 2 byte -\fBsap\fR (type) component, producing an 8 byte \fBDLSAP\fR address. -Applications should \fInot\fR hardcode to this particular -implementation-specific \fBDLSAP\fR address format but use information returned -in the \fBDL_INFO_ACK\fR primitive to compose and decompose \fBDLSAP\fR -addresses. The \fBsap\fR length, full \fBDLSAP\fR length, and -\fBsap\fR/physical ordering are included within the \fBDL_INFO_ACK.\fR The -physical address length can be computed by subtracting the \fBsap\fR length -from the full \fBDLSAP\fR address length or by issuing the -\fBDL_PHYS_ADDR_REQ\fR to obtain the current physical address associated with -the stream. -.sp -.LP -Once in the \fBDL_BOUND\fR state, the user may transmit frames on the Ethernet -by sending \fBDL_UNITDATA_REQ\fR messages to the \fBeri\fR driver. The -\fBeri\fR driver will route received Ethernet frames up all open and bound -streams having a \fBsap\fR which matches the Ethernet type as -\fBDL_UNITDATA_IND\fR messages. Received Ethernet frames are duplicated and -routed up multiple open streams if necessary. The \fBDLSAP\fR address contained -within the \fBDL_UNITDATA_REQ\fR and \fBDL_UNITDATA_IND\fR messages consists of -both the \fBsap\fR (type) and physical (Ethernet) components. -.SS "eri Primitives" -.sp -.LP -In addition to the mandatory connectionless \fBDLPI\fR message set, the driver -also supports the following primitives: -.sp -.LP -The \fBDL_ENABMULTI_REQ\fR and \fBDL_DISABMULTI_REQ\fR primitives -enable/disable reception of individual multicast group addresses. A set of -multicast addresses may be iteratively created and modified on a per-stream -basis using these primitives. These primitives are accepted by the driver in -any state following \fBDL_ATTACHED\fR. -.sp -.LP -The \fBDL_PROMISCON_REQ\fR and \fBDL_PROMISCOFF_REQ\fR primitives with the -\fBDL_PROMISC_PHYS\fR flag set in the \fBdl_level\fR field enables/disables -reception of all promiscuous mode frames on the media, including frames -generated by the local host. When used with the \fBDL_PROMISC_SAP\fR flag set, -this enables/disables reception of all \fBsap\fR (Ethernet type) values. When -used with the \fBDL_PROMISC_MULTI\fR flag set, this enables/disables reception -of all multicast group addresses. The effect of each is always on a per-stream -basis and independent of the other \fBsap\fR and physical level configurations -on this stream or other streams. -.sp -.LP -The \fBDL_PHYS_ADDR_REQ\fR primitive returns the 6 octet Ethernet address -currently associated (attached) to the stream in the \fBDL_PHYS_ADDR_ACK\fR -primitive. This primitive is valid only in states following a successful -\fBDL_ATTACH_REQ\fR. -.sp -.LP -The \fBDL_SET_PHYS_ADDR_REQ\fR primitive changes the 6 octet Ethernet address -currently associated (attached) to this stream. The credentials of the process -which originally opened this stream must be superuser, or \fBEPERM\fR is -returned in the \fBDL_ERROR_ACK\fR. This primitive is destructive because it -affects all current and future streams attached to this device. An \fB -M_ERROR\fR is sent up all other streams attached to this device when this -primitive is successful on this stream. Once changed, all streams subsequently -opened and attached to this device will obtain this new physical address. Once -changed, the physical address will remain until this primitive is used to -change the physical address again or the system is rebooted, whichever comes -first. -.SS "eri DRIVER" -.sp -.LP -By default, the eri driver performs auto-negotiation to select the mode and -speed of the link, which can be in one of the following modes, as described in -the 100Base-TX standard: -.RS +4 -.TP -.ie t \(bu -.el o -100 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -100 Mbps, half-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -10 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -10 Mbps, half-duplex -.RE -.sp -.LP -The auto-negotiation protocol automatically selects: -.RS +4 -.TP -.ie t \(bu -.el o -Operation mode (half-duplex or full-duplex) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Speed (100 Mbps or 10 Mbps) -.RE -.sp -.LP -The auto-negotiation protocol does the following: -.RS +4 -.TP -.ie t \(bu -.el o -Gets all modes of operation supported by the link partner -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Advertises its capabilities to the Link Partner -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Selects the highest common denominator mode of operation based on the -priorities -.RE -.sp -.LP -The internal transceiver is capable of all of the operating speeds and modes -listed above. By default, auto-negotiation is used to select the speed and the -mode of the link and the common mode of operation with the link partner. -.sp -.LP -For users who want to select the speed and mode of the link, the \fBeri\fR -device supports programmable \fBIPG\fR (Inter-Packet Gap) parameters \fBipg1\fR -and \fBipg2\fR. Sometimes, the user may want to alter these values depending -on whether the driver supports 10 Mbps or 100 Mbps and accordingly, \fBIPG\fR -will be set to 9.6 or 0.96 microseconds. -.SS "eri Parameter List" -.sp -.LP -The \fBeri\fR driver provides for setting and getting various parameters for -the \fBeri\fR device. The parameter list includes current transceiver status, -current link status, inter-packet gap, local transceiver capabilities and link -partner capabilities. -.sp -.LP -The local transceiver has two set of capabilities: one set reflects hardware -capabilities, which are read-only \fB(RO)\fR parameters. The second set -reflects the values chosen by the user and is used in speed selection and -possess read/write \fB(RW)\fR capability. At boot time, these two sets of -capabilities will be the same. Because the current default value of these -parameters can only be read and not modified, the link partner capabilities are -also read only. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/eri\fR \fR -.ad -.RS 28n -\fBeri\fR special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/eri.conf\fR \fR -.ad -.RS 28n - System wide default device driver properties -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/eri\fR \fR -.ad -.RS 28n - 64 bit device driver -.RE - -.SH SEE ALSO -.sp -.LP -\fBndd\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBhme\fR(7D), -\fBqfe\fR(7d), \fBdlpi\fR(7P) diff --git a/usr/src/man/man7d/fas.7d b/usr/src/man/man7d/fas.7d deleted file mode 100644 index c993025ee3..0000000000 --- a/usr/src/man/man7d/fas.7d +++ /dev/null @@ -1,1007 +0,0 @@ -'\" te -.\" Copyright (c) 1995, 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 FAS 7D "Jun 20, 1997" -.SH NAME -fas \- FAS SCSI Host Bus Adapter Driver -.SH SYNOPSIS -.LP -.nf -fas@\fIsbus-slot\fR,0x8800000 -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBfas\fR Host Bus Adapter driver is a \fBSCSA\fR compliant nexus driver -that supports the Qlogic FAS366 \fBSCSI\fR chip. -.sp -.LP -The \fBfas\fR driver supports the standard functions provided by the -\fBSCSA\fR interface. The driver supports tagged and untagged queuing, wide and -fast \fBSCSI,\fR almost unlimited transfer size (using a moving \fBDVMA\fR -window approach), and auto request sense; but it does not support linked -commands. -.SS "Driver Configuration" -.sp -.LP -The \fBfas\fR driver can be configured by defining properties in -\fBfas.conf\fR which override the global \fBSCSI\fR settings. Supported -properties are: \fBscsi-options\fR, \fBtarget<\fIn\fR>-scsi-options\fR, -\fBscsi-reset-delay\fR, \fBscsi-watchdog-tick\fR, \fBscsi-tag-age-limit\fR, -\fBscsi-initiator-id\fR. -.sp -.LP -\fBtarget<\fIn\fR>-scsi-options\fR overrides the \fBscsi-options\fR property -value for \fBtarget<\fIn\fR>\fR. <\fIn\fR> can vary from decimal \fB0\fR to -\fB15\fR. The supported \fBscsi-options\fR are: \fBSCSI_OPTIONS_DR\fR, -\fBSCSI_OPTIONS_SYNC\fR, \fBSCSI_OPTIONS_TAG\fR, \fBSCSI_OPTIONS_FAST\fR, and -\fBSCSI_OPTIONS_WIDE\fR. -.sp -.LP -After periodic interval \fBscsi-watchdog-tick\fR, the \fBfas\fR driver searches -all current and disconnected commands for timeouts. -.sp -.LP -\fBscsi-tag-age-limit\fR is the number of times that the \fBfas\fR driver -attempts to allocate a particular tag ID that is currently in use after going -through all tag IDs in a circular fashion. After finding the same tag ID in -use \fBscsi-tag-age-limit\fR times, no more commands will be submitted to this -target until all outstanding commands complete or timeout. -.sp -.LP -Refer to \fBscsi_hba_attach\fR(9F) for details. -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample of fas configuration file -.sp -.LP -Create a file called \fB/kernel/drv/fas.conf\fR and add this line: - -.sp -.LP -\fBscsi-options=0x78;\fR - -.sp -.LP -This disables tagged queuing, Fast \fBSCSI,\fR and Wide mode for all \fBfas\fR -instances. The following example disables an option for one specific \fBfas\fR -(refer to \fBdriver.conf\fR(4) for more details): - -.sp -.in +2 -.nf - name="fas" parent="/iommu@f,e0000000/sbus@f,e0001000" - reg=3,0x8800000,0x10,3,0x8810000,0x40 - target1-scsi-options=0x58 - scsi-options=0x178 scsi-initiator-id=6; -.fi -.in -2 - -.sp -.LP -Note that the default initiator ID in OBP is 7 and that the change to ID 6 will -occur at attach time. It may be preferable to change the initiator ID in OBP. - -.sp -.LP -The example above sets \fBscsi-options\fR for target 1 to \fB0x58\fR and all -other targets on this \fBSCSI\fR bus to \fB0x178\fR. - -.sp -.LP -The physical pathname of the parent can be determined using the \fB/devices\fR -tree or following the link of the logical device name: - -.sp -.in +2 -.nf - # ls \fB-l\fR /dev/rdsk/c1t3d0s0 - lrwxrwxrwx 1 root other 78 Aug 28 16:05 /dev/rdsk/c1t3d0s0 -> - -\&.\|.\|/.\|.\|/devices/iommu@f,e0000000\ - sbus@f,e0001000/SUNW,fas@3,8800000/sd@3,0:a,raw -.fi -.in -2 - -.sp -.LP -Determine the register property values using the output from \fBprtconf\fR(1M) -(with the \fB-v\fR option): - -.sp -.in +2 -.nf -SUNW,fas, instance #0 - \|.\|.\|.\|. - Register Specifications: - Bus Type=0x3, Address=0x8800000, Size=10 - Bus Type=0x3, Address=0x8810000, Size=40 -.fi -.in -2 - -.sp -.LP -\fBscsi-options\fR can also be specified per device type using the device -inquiry string. All the devices with the same inquiry string will have the same -\fBscsi-options\fR set. This can be used to disable some \fBscsi-options\fR on -all the devices of the same type. - -.sp -.in +2 -.nf -device-type-scsi-options-list= - "TOSHIBA XM5701TASUN12XCD", "cd-scsi-options"; -cd-scsi-options = 0x0; -.fi -.in -2 - -.sp -.LP -The above entry in \fB/kernel/drv/fas.conf\fR sets the \fBscsi-options\fR for -all devices with inquiry string \fBTOSHIBA XM5701TASUN12XCD\fR to -\fBcd-scsi-options\fR. To get the inquiry string, run the \fBprobe-scsi\fR or -\fBprobe-scsi-all\fR command at the \fBok\fR prompt before booting the system. - -.sp -.LP -To set \fBscsi-options\fR more specifically per target: - -.sp -.in +2 -.nf -target1-scsi-options=0x78; -device-type-scsi-options-list = - "SEAGATE ST32550W", "seagate-scsi-options" ; -seagate-scsi-options = 0x58; -scsi-options=0x3f8; -.fi -.in -2 - -.sp -.LP -The above sets \fBscsi-options\fR for target 1 to \fB0x78\fR and for all other -targets on this \fBSCSI\fR bus to \fB0x3f8\fR except for one specific disk type -which will have \fBscsi-options\fR set to \fB0x58\fR. - -.sp -.LP -\fBscsi-options\fR specified per target ID have the highest precedence, -followed by \fBscsi-options\fR per device type. Global \fBfas scsi-options\fR -(effecting all instances) per bus have the lowest precedence. - -.sp -.LP -The system needs to be rebooted before the specified \fBscsi-options\fR take -effect. - -.SS "Driver Capabilities" -.sp -.LP -The target driver needs to set capabilities in the \fBfas\fR driver in order to -enable some driver features. The target driver can query and modify these -capabilities: \fBsynchronous\fR, \fBtagged-qing\fR, \fBwide-xfer\fR, -\fBauto-rqsense\fR, \fBqfull-retries\fR, \fBqfull-retry-interval\fR. All other -capabilities can only be queried. -.sp -.LP -By default, \fBtagged-qing\fR, \fBauto-rqsense\fR, and \fBwide-xfer\fR -capabilities are disabled, while \fBdisconnect\fR, \fBsynchronous\fR, and -\fBuntagged-qing\fR are enabled. These capabilities can only have binary values -(\fB0\fR or \fB1\fR). The default value for \fBqfull-retries\fR is \fB10\fR and -the default value for \fBqfull-retry-interval\fR is \fB100\fR. The -\fBqfull-retries\fR capability is a \fBuchar_t\fR (\fB0\fR to \fB255\fR) while -\fBqfull-retry-interval\fR is a \fBushort_t\fR (\fB0\fR to \fB65535\fR). -.sp -.LP -The target driver needs to enable \fBtagged-qing\fR and \fBwide-xfer\fR -explicitly. The \fBuntagged-qing\fR capability is always enabled and its value -cannot be modified, because \fBfas\fR can queue commands even when -\fBtagged-qing\fR is disabled. -.sp -.LP -Whenever there is a conflict between the value of \fBscsi-options\fR and a -capability, the value set in \fBscsi-options\fR prevails. Only \fBwhom != 0\fR -is supported in the \fBscsi_ifsetcap\fR(9F) call. -.sp -.LP -Refer to \fBscsi_ifsetcap\fR(9F) and \fBscsi_ifgetcap\fR(9F) for details. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fas\fR\fR -.ad -.RS 24n -\fBELF\fR Kernel Module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fas.conf\fR\fR -.ad -.RS 24n -Optional configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture T{ -Limited to Sparc SBus-based systems with FAS366-based SCSI port and SunSWIFT SBus SCSI Host Adapter/Fast Ethernet option. -T} -.TE - -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), -\fBscsi_abort\fR(9F), \fBscsi_hba_attach\fR(9F), \fBscsi_ifgetcap\fR(9F), -\fBscsi_ifsetcap\fR(9F), \fBscsi_reset\fR(9F), \fBscsi_sync_pkt\fR(9F), -\fBscsi_transport\fR(9F), \fBscsi_device\fR(9S), \fBscsi_extended_sense\fR(9S), -\fBscsi_inquiry\fR(9S), \fBscsi_pkt\fR(9S) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANSI Small Computer System Interface-2 (SCSI-2)\fR -.sp -.LP -QLogic Corporation, \fIFAS366 Technical Manuals\fR. -.SH DIAGNOSTICS -.sp -.LP -The messages described below are some that may appear on the system console, as -well as being logged. -.sp -.LP -The first five messages may be displayed while the \fBfas\fR driver is trying -to attach; these messages mean that the \fBfas\fR driver was unable to attach. -All of these messages are preceded by "fas%d", where "%d" is the instance -number of the \fBfas\fR controller. -.sp -.ne 2 -.na -\fBDevice in slave-only slot\fR -.ad -.sp .6 -.RS 4n -The SBus device has been placed in a slave-only slot and will not be -accessible; move to non-slave-only SBus slot. -.RE - -.sp -.ne 2 -.na -\fBDevice is using a hilevel intr\fR -.ad -.sp .6 -.RS 4n -The device was configured with an interrupt level that cannot be used with this -\fBfas\fR driver. Check the SBus device. -.RE - -.sp -.ne 2 -.na -\fBCannot alloc dma handle\fR -.ad -.sp .6 -.RS 4n -Driver was unable to allocate memory for a DMA controller. -.RE - -.sp -.ne 2 -.na -\fBCannot alloc cmd area\fR -.ad -.sp .6 -.RS 4n -Driver was unable to allocate memory for a command address. -.RE - -.sp -.ne 2 -.na -\fBCannot create kmem_cache\fR -.ad -.sp .6 -.RS 4n -Driver was unable to allocate memory for internal data structures. -.RE - -.sp -.ne 2 -.na -\fBUnable to map FAS366 registers\fR -.ad -.sp .6 -.RS 4n -Driver was unable to map device registers; check for bad hardware. Driver did -not attach to device; \fBSCSI\fR devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBCannot add intr\fR -.ad -.sp .6 -.RS 4n -Driver could not add its interrupt service routine to the kernel. -.RE - -.sp -.ne 2 -.na -\fBCannot map dma\fR -.ad -.sp .6 -.RS 4n -Driver was unable to locate a \fBDMA\fR controller. This is an -auto-configuration error. -.RE - -.sp -.ne 2 -.na -\fBCannot bind cmdarea\fR -.ad -.sp .6 -.RS 4n -Driver was unable to bind the \fBDMA\fR handle to an address. -.RE - -.sp -.ne 2 -.na -\fBCannot create devctl minor node\fR -.ad -.sp .6 -.RS 4n -Driver is unable to create a minor node for the controller. -.RE - -.sp -.ne 2 -.na -\fBCannot attach\fR -.ad -.sp .6 -.RS 4n -The driver was unable to attach; usually follows another warning that indicates -why attach failed. -.RE - -.sp -.ne 2 -.na -\fBDisabled TQ since disconnects are disabled\fR -.ad -.sp .6 -.RS 4n -Tagged queuing was disabled because disconnects were disabled in -\fBscsi-options\fR. -.RE - -.sp -.ne 2 -.na -\fBBad clock frequency\fR -.ad -.sp .6 -.RS 4n -Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBSync of pkt (<address>) failed\fR -.ad -.sp .6 -.RS 4n -Syncing a \fBSCSI\fR packet failed. Refer to \fBscsi_sync_pkt\fR(9F). -.RE - -.sp -.ne 2 -.na -\fBAll tags in use!\fR -.ad -.sp .6 -.RS 4n -The driver could not allocate another tag number. The target devices do not -properly support tagged queuing. -.RE - -.sp -.ne 2 -.na -\fBGross error in FAS366 status\fR -.ad -.sp .6 -.RS 4n -The driver experienced severe \fBSCSI\fR bus problems. Check cables and -terminator. -.RE - -.sp -.ne 2 -.na -\fBSpurious interrupt\fR -.ad -.sp .6 -.RS 4n -The driver received an interrupt while the hardware was not interrupting. -.RE - -.sp -.ne 2 -.na -\fBLost state in phasemanage\fR -.ad -.sp .6 -.RS 4n -The driver is confused about the state of the \fBSCSI\fR bus. -.RE - -.sp -.ne 2 -.na -\fBUnrecoverable DMA \fBerror\fR \fBduring selection\fR\fR -.ad -.sp .6 -.RS 4n -The \fBDMA\fR controller experienced host SBus problems. Check for bad -hardware. -.RE - -.sp -.ne 2 -.na -\fBBad sequence step (<step number>) in selection\fR -.ad -.sp .6 -.RS 4n -The FAS366 hardware reported a bad sequence step. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBUndetermined selection failure\fR -.ad -.sp .6 -.RS 4n -The selection of a target failed unexpectedly. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (bad reselect bytes)\fR -.ad -.sp .6 -.RS 4n -A reconnect failed, target sent incorrect number of message bytes. Check for -bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (bad identify message)\fR -.ad -.sp .6 -.RS 4n -A reconnect failed, target didn't send identify message or it got corrupted. -Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (not in msgin phase)\fR -.ad -.sp .6 -.RS 4n -Incorrect \fBSCSI\fR bus phase after reconnection. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (unexpected bus free)\fR -.ad -.sp .6 -.RS 4n -Incorrect \fBSCSI\fR bus phase after reconnection. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (timeout on receiving tag msg)\fR -.ad -.sp .6 -.RS 4n -A reconnect failed; target failed to send tag bytes. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (botched tag)\fR -.ad -.sp .6 -.RS 4n -A reconnect failed; target failed to send tag bytes. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (invalid tag)\fR -.ad -.sp .6 -.RS 4n -A reconnect failed; target sent incorrect tag bytes. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (Parity error in reconnect msg's)\fR -.ad -.sp .6 -.RS 4n -A reconnect failed; parity error detected. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n>: failed reselection (no command)\fR -.ad -.sp .6 -.RS 4n -A reconnect failed; target accepted \fBabort\fR or \fBreset\fR, but still tries -to reconnect. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBUnexpected bus free\fR -.ad -.sp .6 -.RS 4n -Target disconnected from the bus without notice. Check for bad hardware. -.RE - -.sp -.ne 2 -.na -\fBTarget <n> didn't disconnect after sending <message>\fR -.ad -.sp .6 -.RS 4n -The target unexpectedly did not disconnect after sending -\fB<\fR\fImessage\fR\fB>.\fR -.RE - -.sp -.ne 2 -.na -\fBBad sequence step (0x?) in selection\fR -.ad -.sp .6 -.RS 4n -The sequence step register shows an improper value. The target might be -misbehaving. -.RE - -.sp -.ne 2 -.na -\fBIllegal dma boundary?\fR -.ad -.sp .6 -.RS 4n -An attempt was made to cross a boundary that the driver could not handle. -.RE - -.sp -.ne 2 -.na -\fBUnwanted data xfer direction for Target <n>\fR -.ad -.sp .6 -.RS 4n -The target went into an unexpected phase. -.RE - -.sp -.ne 2 -.na -\fBUnrecoverable DMA error on dma <send/receive>\fR -.ad -.sp .6 -.RS 4n -There is a \fBDMA\fR error while sending/receiving data. The host \fBDMA\fR -controller is experiencing some problems. -.RE - -.sp -.ne 2 -.na -\fBSCSI bus DATA IN phase parity error\fR -.ad -.sp .6 -.RS 4n -The driver detected parity errors on the \fBSCSI\fR bus. -.RE - -.sp -.ne 2 -.na -\fBSCSI bus MESSAGE IN phase parity error\fR -.ad -.sp .6 -.RS 4n -The driver detected parity errors on the \fBSCSI\fR bus. -.RE - -.sp -.ne 2 -.na -\fBSCSI bus STATUS phase parity \fBerror\fR\fR -.ad -.sp .6 -.RS 4n -The driver detected parity errors on the \fBSCSI\fR bus. -.RE - -.sp -.ne 2 -.na -\fBPremature end of extended message\fR -.ad -.sp .6 -.RS 4n -An extended \fBSCSI\fR bus message did not complete. Suspect a target firmware -problem. -.RE - -.sp -.ne 2 -.na -\fBPremature end of input message\fR -.ad -.sp .6 -.RS 4n -A multibyte input message was truncated. Suspect a target firmware problem. -.RE - -.sp -.ne 2 -.na -\fBInput message botch\fR -.ad -.sp .6 -.RS 4n -The driver is confused about messages coming from the target. -.RE - -.sp -.ne 2 -.na -\fBExtended message <n> is too long\fR -.ad -.sp .6 -.RS 4n -The extended message sent by the target is longer than expected. -.RE - -.sp -.ne 2 -.na -\fB<name> message <n> from Target <m> garbled\fR -.ad -.sp .6 -.RS 4n -Target \fB<\fR\fIm\fR\fB>\fR sent message \fB<\fR\fIname\fR\fB>\fR of value -\fB<\fR\fIn\fR\fB>\fR which the driver did not understand. -.RE - -.sp -.ne 2 -.na -\fBTarget <n> rejects our message <name>\fR -.ad -.sp .6 -.RS 4n -Target \fB<\fR\fIn\fR\fB>\fR rejected a message sent by the driver. -.RE - -.sp -.ne 2 -.na -\fBRejecting message <name> from Target <n>\fR -.ad -.sp .6 -.RS 4n -The driver rejected a message received from target \fB<\fR\fIn\fR\fB>.\fR -.RE - -.sp -.ne 2 -.na -\fBCmd transmission \fBerror\fR\fR -.ad -.sp .6 -.RS 4n -The driver was unable to send out command bytes. -.RE - -.sp -.ne 2 -.na -\fBTarget <n> refused message resend\fR -.ad -.sp .6 -.RS 4n -The target did not accept a message resend. -.RE - -.sp -.ne 2 -.na -\fBMESSAGE OUT phase parity error\fR -.ad -.sp .6 -.RS 4n -The driver detected parity errors on the SCSI bus. -.RE - -.sp -.ne 2 -.na -\fBTwo byte message <name> <value> rejected\fR -.ad -.sp .6 -.RS 4n -The driver does not accept this two byte message. -.RE - -.sp -.ne 2 -.na -\fBGross error in fas status <stat>\fR -.ad -.sp .6 -.RS 4n -The \fBfas\fR chip has indicated a gross error like \fBFIFO\fR overflow. -.RE - -.sp -.ne 2 -.na -\fBPolled cmd failed (target busy)\fR -.ad -.sp .6 -.RS 4n -A polled command failed because the target did not complete outstanding -commands within a reasonable time. -.RE - -.sp -.ne 2 -.na -\fBPolled cmd failed\fR -.ad -.sp .6 -.RS 4n -A polled command failed because of timeouts or bus errors. -.RE - -.sp -.ne 2 -.na -\fBAuto request sense failed\fR -.ad -.sp .6 -.RS 4n -Driver is unable to get request sense from the target. -.RE - -.sp -.ne 2 -.na -\fBDisconnected command timeout for Target <id>.<lun>\fR -.ad -.sp .6 -.RS 4n -A timeout occurred while target \fBid\fR/\fIlun\fR was disconnected. This is -usually a target firmware problem. For tagged queuing targets, -\fB<\fR\fIn\fR\fB>\fR commands were outstanding when the timeout was detected. -.RE - -.sp -.ne 2 -.na -\fBDisconnected tagged cmds (<n>) timeout for Target <id>.<lun>\fR -.ad -.sp .6 -.RS 4n -A timeout occurred while target \fBid\fR/\fIlun\fR was disconnected. This is -usually a target firmware problem. For tagged queuing targets, -\fB<\fR\fIn\fR\fB>\fR commands were outstanding when the timeout was detected. -.RE - -.sp -.ne 2 -.na -\fBConnected command timeout for Target <id>.<lun>\fR -.ad -.sp .6 -.RS 4n -This is usually a \fBSCSI\fR bus problem. Check cables and termination. -.RE - -.sp -.ne 2 -.na -\fBTarget <id>.<lun> reverting to async. mode\fR -.ad -.sp .6 -.RS 4n -A data transfer hang was detected. The driver attempts to eliminate this -problem by reducing the data transfer rate. -.RE - -.sp -.ne 2 -.na -\fBTarget <id>.<lun> reducing sync. transfer rate\fR -.ad -.sp .6 -.RS 4n -A data transfer hang was detected. The driver attempts to eliminate this -problem by reducing the data transfer rate. -.RE - -.sp -.ne 2 -.na -\fBReverting to slow SCSI cable mode\fR -.ad -.sp .6 -.RS 4n -A data transfer hang was detected. The driver attempts to eliminate this -problem by reducing the data transfer rate. -.RE - -.sp -.ne 2 -.na -\fBTarget <id> reducing sync. transfer rate\fR -.ad -.sp .6 -.RS 4n -A data transfer hang was detected. The driver attempts to eliminate this -problem by reducing the data transfer rate. -.RE - -.sp -.ne 2 -.na -\fBTarget <id> reverting to async. mode\fR -.ad -.sp .6 -.RS 4n -A data transfer hang was detected. The driver attempts to eliminate this -problem by reducing the data transfer rate. -.RE - -.sp -.ne 2 -.na -\fBTarget <id> disabled wide SCSI mode\fR -.ad -.sp .6 -.RS 4n -Due to problems on the \fBSCSI\fR bus, the driver goes into more conservative -mode of operation to avoid further problems. -.RE - -.sp -.ne 2 -.na -\fBReset SCSI bus failed\fR -.ad -.sp .6 -.RS 4n -An attempt to reset the \fBSCSI\fR bus failed. -.RE - -.sp -.ne 2 -.na -\fBExternal SCSI bus reset\fR -.ad -.sp .6 -.RS 4n -Another initiator reset the \fBSCSI\fR bus. -.RE - -.SH WARNINGS -.sp -.LP -The \fBfas\fR hardware (FAS366) supports both Wide and Fast \fBSCSI\fR mode, -but fast20 is not supported. The maximum \fBSCSI\fR bandwidth is 20 MB/sec. -Initiator mode block sequence (IBS) is not supported. -.SH NOTES -.sp -.LP -The \fBfas\fR driver exports properties indicating per target the negotiated -transfer speed (\fBtarget<n>-sync-speed\fR), whether wide bus is supported -(\fBtarget<n>-wide\fR), \fBscsi-options\fR for that particular target -(\fBtarget<n>-scsi-options\fR), and whether tagged queuing has been enabled -(\fBtarget<n>-TQ\fR). The \fBsync-speed\fR property value is the data transfer -rate in KB/sec. The \fBtarget<n>-TQ\fR and the \fBtarget<n>-wide\fR property -have value \fB1\fR to indicate that the corresponding capability is enabled, or -\fB0\fR to indicate that the capability is disabled for that target. Refer to -\fBprtconf\fR(1M) (verbose option) for viewing the \fBfas\fR properties. -.sp -.in +2 -.nf -SUNW,fas,instance #1 - Driver software properties: - name <target3-TQ> length <4> - value <0x00000001>. - name <target3-wide> length <4> - value <0x00000000>. - name <target3-sync-speed> length <4> - value <0x00002710>. - name <target3-scsi-options> length <4> - value <0x000003f8>. - name <target0-TQ> length <4> - value <0x00000001>. - name <pm_norm_pwr> length <4> - value <0x00000001>. - name <pm_timestamp> length <4> - value <0x30040346>. - name <scsi-options> length <4> - value <0x000003f8>. - name <scsi-watchdog-tick> length <4> - value <0x0000000a>. - name <scsi-tag-age-limit> length <4> - value <0x00000002>. - name <scsi-reset-delay> length <4> - value <0x00000bb8>. - Register Specifications: - Bus Type=0x3, Address=0x8800000, Size=10 - Bus Type=0x3, Address=0x8810000, Size=40 - Interrupt Specifications: - Interrupt Priority=0x35 (ipl 5) -.fi -.in -2 - diff --git a/usr/src/man/man7d/fasttrap.7d b/usr/src/man/man7d/fasttrap.7d deleted file mode 100644 index 63a1335e25..0000000000 --- a/usr/src/man/man7d/fasttrap.7d +++ /dev/null @@ -1,56 +0,0 @@ -'\" te -.\" Copyright (c) 2003, 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 FASTTRAP 7D "Dec 10, 2017" -.SH NAME -fasttrap \- DTrace user instruction tracing provider -.SH DESCRIPTION -.LP -The \fBfasttrap\fR driver is a DTrace dynamic tracing provider that performs -dynamic instrumentation of arbitrary instructions in illumos processes. The -\fBfasttrap\fR driver implements the DTrace \fBfasttrap\fR and \fBpid\fR -providers. -.sp -.LP -The \fBfasttrap\fR driver is not a public interface and you access -instrumentation offered by this provider through DTrace. Refer to the -\fIDynamic Tracing Guide\fR for a description of the public documented -interfaces available for the DTrace facility and the probes offered by the -\fBfasttrap\fR provider. -.SH SPARC ONLY -.LP -The \fBfasttrap\fR provider provides a DTrace probe that fires each time a user -process executes an instruction. The \fBpid\fR provider allows for the dynamic -creation of DTrace probes corresponding to instruction locations inside any -user process specified using a process ID and an instruction address or symbol -name. Together these providers permit DTrace users to perform instrumentation -of user processes and to trace the interactions between processes and -the operating system. See the chapter entitled "User Process Tracing" in the -\fIDynamic Tracing Guide\fR for information on how to use these -providers to instrument processes. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.LP -\fBdtrace\fR(1M), \fBattributes\fR(5), \fBdtrace\fR(7D) -.sp -.LP -\fIDynamic Tracing Guide\fR: -.sp -.LP -https://illumos.org/books/dtrace/ diff --git a/usr/src/man/man7d/fbt.7d b/usr/src/man/man7d/fbt.7d deleted file mode 100644 index 3b62aa3392..0000000000 --- a/usr/src/man/man7d/fbt.7d +++ /dev/null @@ -1,53 +0,0 @@ -'\" te -.\" Copyright (c) 2003, 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 FBT 7D "Dec 10, 2017" -.SH NAME -fbt \- DTrace function boundary tracing provider -.SH DESCRIPTION -.LP -The \fBfbt\fR driver is a DTrace dynamic tracing provider that performs dynamic -instrumentation at function boundaries in the kernel. -.sp -.LP -The function is the fundamental unit of program text. In a well-designed -system, the function performs a discrete and well-defined operation on a -specified object or series of like objects. Most functions are implemented by -themselves calling functions on encapsulated objects, but some functions -\(emso-called "leaf functions" \(em are implemented without making further -function calls. The Function Boundary Tracing \fBfbt\fR provider contains a -mechanism for instrumenting the vast majority of functions in the kernel and -offering the instrumentation as a set of DTrace probes. -.sp -.LP -The \fBfbt\fR driver is not a public interface and you access the -instrumentation offered by this provider through DTrace. Refer to the -\fIDynamic Tracing Guide\fR for a description of the public documented -interfaces available for the DTrace facility and the probes offered by the -\fBfbt\fR provider. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.LP -\fBdtrace\fR(1M), \fBattributes\fR(5), \fBdtrace\fR(7D) -.sp -.LP -\fIDynamic Tracing Guide\fR: -.sp -.LP -https://illumos.org/books/dtrace/ diff --git a/usr/src/man/man7d/fcip.7d b/usr/src/man/man7d/fcip.7d deleted file mode 100644 index 9f7d7c0093..0000000000 --- a/usr/src/man/man7d/fcip.7d +++ /dev/null @@ -1,246 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 FCIP 7D "Oct 18, 2004" -.SH NAME -fcip \- IP/ARP over Fibre Channel datagram encapsulation driver -.SH SYNOPSIS -.LP -.nf -/dev/fcip -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBfcip\fR driver is a Fibre Channel upper layer protocol module for -encapsulating \fBIP\fR (IPv4) and \fBARP\fR datagrams over Fibre Channel. The -\fBfcip\fR driver is a loadable, clonable, \fBSTREAMS\fR driver supporting -the connectionless Data Link Provider Interface, \fBdlpi\fR(7P) over any Sun -Fibre Channel transport layer-compliant host adapter. -.sp -.LP -The \fBfcip\fR driver complies with the \fIRFC 2625\fR specification for -encapsulating IP/ARP datagrams over Fibre Channel, and allows encapsulation of -IPv4 only, as specified in \fIRFC 2625\fR. The \fBfcip\fR driver interfaces -with the \fBfp\fR(7d) Sun Fibre Channel port driver. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning character-special device \fB/dev/fcip\fR is used to access all -Fibre Channel ports capable of supporting \fBIP\fR/\fBARP\fR traffic on the -system. -.SS "fcip and DLPI" -.sp -.LP -The \fBfcip\fR driver is a "style 2" Data Link Service Provider. All -\fBM_PROTO\fR and \fBM_PCPROTO\fR type messages are interpreted as \fBDLPI\fR -primitives. Valid \fBDLPI\fR primitives are defined in \fB<sys/dlpi.h>\fR\&. -Refer to \fBdlpi\fR(7P) for more information on \fBDLPI\fR primitives. -.sp -.LP -An explicit \fBDL_ATTACH_REQ\fR message must be sent to associate the opened -stream with a particular Fibre Channel port (ppa). The ppa ID is interpreted -as an unsigned long data type and indicates the corresponding Fibre Channel -port driver instance number. An error (\fBDL_ERROR_ACK\fR) is returned by the -driver if the ppa field value does not correspond to a valid port driver -instance number or if the Fibre Channel port is not \fBONLINE\fR. Refer to -\fBfp\fR(7d) for more details on the Fibre Channel port driver. -.sp -.LP -The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in -response to a \fBDL_INFO_REQ\fR from the user are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU is \fB65280\fR (defined in \fIRFC 2625\fR). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBDLSAP\fR address length is \fB8\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is \fBDL_ETHER\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBSAP\fR length is \fB-2\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Service mode is \fBDL_CLDLS\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Optional quality of service (\fBQOS\fR) fields are set to \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Provider style is \fBDL_STYLE2\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Provider version is \fBDL_VERSION_2\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is \fB0xFFFFFFFF\fR. -.RE -.sp -.LP -Once in \fBDL_ATTACHED\fR state, the user must send a \fBDL_BIND_REQ\fR to -associate a particular \fBSAP\fR (Service Access Point) with the stream. The -\fBfcip\fR driver \fBDLSAP\fR address format consists of the 6-byte physical -address component followed immediately by the 2-byte \fBSAP\fR component -producing an 8-byte \fBDLSAP\fR address. Applications should not be programmed -to use this implementation-specific \fBDLSAP\fR address format, but use -information returned in the \fBDL_INFO_ACK\fR primitive to compose and -decompose \fBDLSAP\fR addresses. The \fBSAP\fR length, full \fBDLSAP\fR length, -and \fBSAP\fR/physical ordering are included within the \fBDL_INFO_ACK\fR. -The physical address length is the full \fBDLSAP\fR address length minus the -\fBSAP\fR length. The physical address length can also be computed by -issuing the \fBDL_PHYS_ADDR_REQ\fR primitive to obtain the current physical -address associated with the stream. -.sp -.LP -Once in the \fBDL_BOUND\fR state, the user can transmit frames on the fibre by -sending \fBDL_UNITDATA_REQ\fR messages to the \fBfcip\fR driver. The -\fBfcip\fR driver will route received frames up any of the open and bound -streams having a \fBSAP\fR which matches the received frame's \fBSAP\fR type -as \fBDL_UNITDATA_IND\fR messages. Received Fibre Channel frames are -duplicated and routed up multiple open streams if necessary. The \fBDLSAP\fR -address contained within the \fBDL_UNITDATA_REQ\fR and \fBDL_UNITDATA_IND\fR -messages consists of both the \fBSAP\fR (type) and physical address -(WorldWideName) components. -.SS "Other Primitives" -.sp -.LP -In Fibre Channel, \fBmulticasting\fR is defined as an optional service for -Fibre Channel classes three and six only. If required, the Fibre Channel -broadcast service can be used for multicasting. The \fIRFC 2625\fR -specification does not support \fBIP \fRmulticasting or promiscuous mode. -.SS "fcip Fibre Channel ELS" -.sp -.LP -The \fBfcip\fR driver will use the \fBFARP\fR Fibre Channel Extended Link -Service (\fBELS\fR), where supported, to resolve WorldWide Names (MAC address) -to FC Port Identifiers(Port_ID). The \fBfcip\fR driver also supports InARP to -resolve WorldWide Name and Port_ID to an IP address. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/fcip\fR\fR -.ad -.RS 28n -fcip character-special device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fcip\fR\fR -.ad -.RS 28n -32-bit ELF kernel driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/fcip\fR\fR -.ad -.RS 28n -64-bit ELF kernel driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/fcip\fR\fR -.ad -.RS 28n -64-bit ELF kernel driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fcip.conf\fR\fR -.ad -.RS 28n -fcip driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBnetstat\fR(1M), \fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBfp\fR(7d), -\fBdlpi\fR(7P) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIIP and ARP over Fibre Channel, RFC 2625\fR M. Rajagopal, R. Bhagwat, W. -Rickard. Gadzoox Networks, June 1999 -.sp -.LP -\fIANSI X3.230-1994, Fibre Channel Physical and Signalling Interface (FC-PH)\fR -.sp -.LP -\fIANSI X3.272-1996, Fibre Channel Arbitrated Loop (FC-AL)\fR -.SH NOTES -.sp -.LP -If you use a Fibre Channel adapter with two or more ports that each share a -common Node WorldWideName, the \fBfcip\fR driver will likely attach to the -first port on the adapter. -.sp -.LP -\fIRFC 2625\fR requires that both source and destination WorldWideNames have -their 4 bit NAA identifiers set to binary '0001,' indicating that an IEEE -48-bit MAC address is contained in the lower 48 bits of the network address -fields. For additional details, see the \fIRFC 2625\fR specification. diff --git a/usr/src/man/man7d/fcoe.7d b/usr/src/man/man7d/fcoe.7d deleted file mode 100644 index a3354b5649..0000000000 --- a/usr/src/man/man7d/fcoe.7d +++ /dev/null @@ -1,57 +0,0 @@ -'\" te -.\" 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] -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 2020 Peter Tribble. -.TH FCOE 7D "Jan 10, 2020" -.SH NAME -fcoe \- fibre channel over Ethernet transport driver -.SH DESCRIPTION -The \fBfcoe\fR driver is a pseudo nexus driver which supports the -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 -.ne 2 -.na -\fB/kernel/drv/amd64/fcoe\fR -.ad -.RS 26n -Device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/sparcv9/fcoe\fR -.ad -.RS 26n -Device driver (SPARC) -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for a description of the following attribute: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcoet\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANSI X3.269-1996, Fibre Channel Protocol for SCSI (FCP)\fR diff --git a/usr/src/man/man7d/fcoei.7d b/usr/src/man/man7d/fcoei.7d deleted file mode 100644 index 2835290d9e..0000000000 --- a/usr/src/man/man7d/fcoei.7d +++ /dev/null @@ -1,64 +0,0 @@ -'\" te -.\" 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 "Jan 10, 2020" -.SH NAME -fcoei \- Fibre Channel Over Ethernet Initiator Mode Driver -.SH SYNOPSIS -.in +2 -.nf -fcoei@port,0 -.fi -.in -2 - -.SH DESCRIPTION -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 -services, common transport frames and initiator mode FCP frames. -.sp -.LP -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 -.ne 2 -.na -\fB/kernel/drv/amd64/fcoei\fR -.ad -.RS 27n -Device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/sparcv9/fcoei\fR -.ad -.RS 27n -Device driver (SPARC) -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for a description of the following attribute: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcoe\fR(7D), \fBfcoet\fR(7D), -\fBfp\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANSI X3.269-1996, Fibre Channel Protocol for SCSI (FCP)\fR diff --git a/usr/src/man/man7d/fcoet.7d b/usr/src/man/man7d/fcoet.7d deleted file mode 100644 index dd604f360b..0000000000 --- a/usr/src/man/man7d/fcoet.7d +++ /dev/null @@ -1,57 +0,0 @@ -'\" te -.\" 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] -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.TH FCOET 7D "Jan 10, 2020" -.SH NAME -fcoet \- fibre channel over Ethernet target mode driver -.SH DESCRIPTION -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, -and FCoE transport driver, \fBfcoe\fR(7D). -.SH FILES -.ne 2 -.na -\fB/kernel/drv/amd64/fcoet\fR -.ad -.RS 29n -Device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/sparcv9/fcoet\fR -.ad -.RS 29n -Device driver (SPARC) -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcoe\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANSI X3.269-1996, Fibre Channel Protocol for SCSI (FCP)\fR diff --git a/usr/src/man/man7d/fcp.7d b/usr/src/man/man7d/fcp.7d deleted file mode 100644 index 0d966d4050..0000000000 --- a/usr/src/man/man7d/fcp.7d +++ /dev/null @@ -1,88 +0,0 @@ -'\" te -.\" Copyright (c) 2004 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 FCP 7D "Oct 20, 2004" -.SH NAME -fcp \- Fibre Channel protocol driver -.SH DESCRIPTION -.sp -.LP -The \fBfcp\fR driver is the upper layer protocol that supports mechanisms for -transporting \fBSCSI\fR-3 commands over Fibre Channel. The \fBfcp\fR driver, -which interfaces with the Sun Fibre Channel transport library \fBfctl\fR(7D), -supports the standard functions provided by the \fBSCSA \fRinterface. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fcp\fR\fR -.ad -.RS 27n -32-bit ELF kernel driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/fcp\fR\fR -.ad -.RS 27n -64-bit ELF kernel driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/fcp\fR\fR -.ad -.RS 27n -64-bit ELF kernel driver (SPARC) -.RE - -.SH ATTRIBUTES -.sp -.LP -See attributes(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -_ -Interface stability Unknown -.TE - -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBfctl\fR(7D), \fBfp\fR(7d), -\fBusoc\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIFibre Channel Physical and Signaling Interface (FC-PH) ANSI X3.230: 1994\fR -.sp -.LP -\fIFibre Channel Generic Services (FC-GS-2) Project 1134-D\fR -.sp -.LP -\fIFibre Channel Arbitrated Loop (FC-AL) ANSI X3.272-1996\fR -.sp -.LP -\fIFibre Channel Protocol for SCSI (FCP) ANSI X3.269-1996\fR -.sp -.LP -\fISCSI-3 Architecture Model (SAM) Fibre Channel Private Loop SCSI Direct -Attach (FC-PLDA) ANSI X3.270-1996\fR -.sp -.LP -\fIFabric Loop Attachment (FC-FLA), NCITS TR-20:1998\fR diff --git a/usr/src/man/man7d/fctl.7d b/usr/src/man/man7d/fctl.7d deleted file mode 100644 index 8a7e99442e..0000000000 --- a/usr/src/man/man7d/fctl.7d +++ /dev/null @@ -1,64 +0,0 @@ -'\" te -.\" Copyright (c) 2004 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 FCTL 7D "Oct 20, 2004" -.SH NAME -fctl \- Sun Fibre Channel transport library -.SH DESCRIPTION -.sp -.LP -The \fBfctl\fR kernel module interfaces the Sun Fibre Channel upper layer -protocol (ULP) mapping modules with Sun Fibre Channel adapter (FCA) drivers. -There are no user-configurable options for this module. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/misc/fctl\fR\fR -.ad -.RS 29n - 32-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/fctl\fR\fR -.ad -.RS 29n -64-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/sparcv9/fctl\fR\fR -.ad -.RS 29n -64-bit ELF kernel module (SPARC) -.RE - -.SH ATTRIBUTES -.sp -.LP -See attributes(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -_ -Interface stability Unknown -.TE - -.SH SEE ALSO -.sp -.LP -\fBfp\fR(7d) diff --git a/usr/src/man/man7d/fd.7d b/usr/src/man/man7d/fd.7d deleted file mode 100644 index ecd82a7be6..0000000000 --- a/usr/src/man/man7d/fd.7d +++ /dev/null @@ -1,805 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 FD 7D "Mar 2, 2007" -.SH NAME -fd, fdc \- drivers for floppy disks and floppy disk controllers -.SH SYNOPSIS -.SS "SPARC" -.LP -.nf -\fB/dev/diskette0\fR -.fi - -.LP -.nf -\fB/dev/rdiskette0\fR -.fi - -.SS "x86" -.LP -.nf -\fB/dev/diskette[0-1]\fR -.fi - -.LP -.nf -\fB/dev/rdiskette[0-1]\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBfd\fR and \fBfdc\fR drivers provide the interfaces to floppy disks using -the Intel 8272, Intel 82077, NEC 765, or compatible disk controllers on x86 -based systems. -.sp -.LP -The default partitions for the floppy driver are: -.sp -.ne 2 -.na -\fBa\fR -.ad -.RS 5n -All cylinders except the last -.RE - -.sp -.ne 2 -.na -\fBb\fR -.ad -.RS 5n -Only the last cylinder -.RE - -.sp -.ne 2 -.na -\fBc\fR -.ad -.RS 5n -Entire diskette -.RE - -.sp -.LP -The \fBfd\fR driver autosenses the density of the diskette. -.sp -.LP -When the floppy is first opened the driver looks for a SunOS label in logical -block 0 of the diskette. If attempts to read the SunOS label fail, the open -will fail. If block 0 is read successfully but a SunOS label is not found, -auto-sensed geometry and default partitioning are assumed. -.sp -.LP -The \fBfd\fR driver supports both block and raw interfaces. -.sp -.LP -The block files (\fB/dev/diskette*\fR) access the diskette using the system's -normal buffering mechanism and may be read and written without regard to -physical diskette records. -.sp -.LP -There is also a raw (\fB/dev/rdiskette*\fR) interface that provides for direct -transmission between the diskette and the user's read or write buffer. A single -\fBread\fR(2) or \fBwrite\fR(2) call usually results in one I/O operation; -therefore raw I/O is considerably more efficient when larger blocking factors -are used. A blocking factor of no less than 8 Kbytes is recommended. See the -Notes section, below, for information on the number of sectors per track. -.SS "3.5" Diskettes" -.sp -.LP -For 3.5" double-sided diskettes, the following densities are supported: -.SS "SPARC" -.sp -.ne 2 -.na -\fB1.7 Mbyte density\fR -.ad -.RS 21n -80 cylinders, 21 sectors per track, 1.7 Mbyte capacity -.RE - -.sp -.ne 2 -.na -\fBhigh density\fR -.ad -.RS 21n -80 cylinders, 18 sectors per track, 1.44 Mbyte capacity -.RE - -.sp -.ne 2 -.na -\fBdouble density\fR -.ad -.RS 21n -80 cylinders, 9 sectors per track, 720 Kbyte capacity -.RE - -.SS "x86" -.sp -.ne 2 -.na -\fBextended density\fR -.ad -.RS 21n -80 cylinders, 36 sectors per track, 2.88 Mbyte capacity -.RE - -.sp -.ne 2 -.na -\fB1.7 Mbyte density\fR -.ad -.RS 21n -80 cylinders, 21 sectors per track, 1.7 Mbyte capacity -.RE - -.sp -.ne 2 -.na -\fBhigh density\fR -.ad -.RS 21n -80 cylinders, 18 sectors per track, 1.44 Mbyte capacity -.RE - -.sp -.ne 2 -.na -\fBdouble density\fR -.ad -.RS 21n -80 cylinders, 9 sectors per track, 760 Kbyte capacity -.RE - -.SS "5.25" Diskettes" -.sp -.LP -For 5.25" double-sided diskettes on x86 platforms, the densities listed below -are supported: -.SS "SPARC" -.sp -.LP -5.25" diskettes are not supported on SPARC platforms. -.SS "x86" -.sp -.ne 2 -.na -\fBhigh density\fR -.ad -.RS 18n -80 cylinders, 15 sectors per track, 1.2 Mbyte capacity -.RE - -.sp -.ne 2 -.na -\fBdouble density\fR -.ad -.RS 18n -40 cylinders, 9 sectors per track, 360 Kbyte capacity -.RE - -.sp -.ne 2 -.na -\fBdouble density\fR -.ad -.RS 18n -40 cylinders, 8 sectors per track, 320 Kbyte capacity -.RE - -.sp -.ne 2 -.na -\fBquad density\fR -.ad -.RS 18n -80 cylinders, 9 sectors per track, 720 Kbyte capacity -.RE - -.sp -.ne 2 -.na -\fBdouble density\fR -.ad -.RS 18n -40 cylinders, 16 sectors per track (256 bytes per sector), 320 Kbyte capacity -.RE - -.sp -.ne 2 -.na -\fBdouble density\fR -.ad -.RS 18n -40 cylinders, 4 sectors per track (1024 bytes per sector), 320 Kbyte capacity -.RE - -.SH ERRORS -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 10n -During opening, the partition has been opened for exclusive access and another -process wants to open the partition. Once open, this error is returned if the -floppy disk driver attempted to pass a command to the floppy disk controller -when the controller was busy handling another command. In this case, the -application should try the operation again. -.RE - -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -An invalid address was specified in an ioctl command (see \fBfdio\fR(7I)). -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -The number of bytes read or written is not a multiple of the diskette's sector -size. This error is also returned when an unsupported command is specified -using the \fBFDIOCMD\fR ioctl command (see \fBfdio\fR(7I)). -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 10n -During opening, the diskette does not have a label or there is no diskette in -the drive. Once open, this error is returned if the requested I/O transfer -could not be completed. -.RE - -.sp -.ne 2 -.na -\fB\fBENOSPC\fR\fR -.ad -.RS 10n -An attempt was made to write past the end of the diskette. -.RE - -.sp -.ne 2 -.na -\fB\fBENOTTY\fR\fR -.ad -.RS 10n -The floppy disk driver does not support the requested ioctl functions (see -\fBfdio\fR(7I)). -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -The floppy disk device does not exist or the device is not ready. -.RE - -.sp -.ne 2 -.na -\fB\fBEROFS\fR\fR -.ad -.RS 10n -The floppy disk device is opened for write access and the diskette in the drive -is write protected. -.RE - -.SS "x86 Only" -.sp -.ne 2 -.na -\fB\fBENOSYS\fR\fR -.ad -.RS 10n -The floppy disk device does not support the requested ioctl function ( -\fBFDEJECT\fR). -.RE - -.SH X86 CONFIGURATION -.sp -.LP -The driver attempts to initialize itself using the information found in the -configuration file, \fB/platform/i86pc/kernel/drv/fd.conf\fR. -.sp -.in +2 -.nf -name="fd" parent="fdc" unit=0; -name="fd" parent="fdc" unit=1; -.fi -.in -2 - -.SH FILES -.SS "SPARC" -.sp -.ne 2 -.na -\fB\fB/platform/sun4u/kernel/drv/fd\fR\fR -.ad -.sp .6 -.RS 4n -driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/fdreg.h\fR\fR -.ad -.sp .6 -.RS 4n -structs and definitions for Intel 82072 and 82077 controllers -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/fdvar.h\fR\fR -.ad -.sp .6 -.RS 4n -structs and definitions for floppy drivers -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/diskette\fR\fR -.ad -.sp .6 -.RS 4n -device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/diskette0\fR\fR -.ad -.sp .6 -.RS 4n -device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdiskette\fR\fR -.ad -.sp .6 -.RS 4n -raw device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdiskette0\fR\fR -.ad -.sp .6 -.RS 4n -raw device file -.RE - -.SS "For ucb Compatibility" -.sp -.ne 2 -.na -\fB\fB/dev/fd0[a-c]\fR\fR -.ad -.RS 24n -block file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rfd0[a-c]\fR\fR -.ad -.RS 24n -raw file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/diskette0\fR\fR -.ad -.RS 24n -directory containing volume management character device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdiskette0\fR\fR -.ad -.RS 24n -directory containing the volume management raw character device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/aliases/floppy0\fR\fR -.ad -.RS 24n -symbolic link to the entry in \fB/dev/rdiskette0\fR -.RE - -.SS "x86" -.sp -.ne 2 -.na -\fB\fB/platform/i86pc/kernel/drv/fd\fR\fR -.ad -.sp .6 -.RS 4n -driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/platform/i86pc/kernel/drv/fd.conf\fR\fR -.ad -.sp .6 -.RS 4n -configuration file for floppy driver -.RE - -.sp -.ne 2 -.na -\fB\fB/platform/i86pc/kernel/drv/fdc\fR\fR -.ad -.sp .6 -.RS 4n -floppy-controller driver module -.RE - -.sp -.ne 2 -.na -\fB\fB/platform/i86pc/kernel/drv/fdc.con\fRf\fR -.ad -.sp .6 -.RS 4n -configuration file for the floppy-controller -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/fdc.h\fR\fR -.ad -.sp .6 -.RS 4n -structs and definitions for x86 floppy devices -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/fdmedia.h\fR\fR -.ad -.sp .6 -.RS 4n -structs and definitions for x86 floppy media -.RE - -.SS "x86 First Drive" -.sp -.ne 2 -.na -\fB\fB/dev/diskette\fR\fR -.ad -.RS 19n -device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/diskette0\fR\fR -.ad -.RS 19n -device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdiskette\fR\fR -.ad -.RS 19n -raw device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdiskette0\fR\fR -.ad -.RS 19n -raw device file -.RE - -.SS "For ucb Compatibility" -.sp -.ne 2 -.na -\fB\fB/dev/fd0[a-c]\fR\fR -.ad -.RS 24n -block file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rfd0[a-c]\fR\fR -.ad -.RS 24n -raw file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/diskette0\fR\fR -.ad -.RS 24n -directory containing volume management character device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdiskette0\fR\fR -.ad -.RS 24n -directory containing the volume management raw character device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/aliases/floppy0\fR\fR -.ad -.RS 24n -symbolic link to the entry in /dev/rdiskette0 -.RE - -.SS "x86 Second Drive" -.sp -.ne 2 -.na -\fB\fB/dev/diskette1\fR\fR -.ad -.RS 19n -device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdiskette1\fR\fR -.ad -.RS 19n -raw device file -.RE - -.SS "For ucb Compatibility" -.sp -.ne 2 -.na -\fB\fB/dev/fd1[a-c]\fR\fR -.ad -.RS 24n -block file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rfd1[a-c]\fR\fR -.ad -.RS 24n -raw file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/diskette1\fR\fR -.ad -.RS 24n -directory containing volume management character device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdiskette1\fR\fR -.ad -.RS 24n -directory containing the volume management raw character device file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/aliases/floppy1\fR\fR -.ad -.RS 24n -symbolic link to the entry in \fB/dev/rdiskette1\fR -.RE - -.SH SEE ALSO -.sp -.LP -\fBfdformat\fR(1), \fBdd\fR(1M), \fBdrvconfig\fR(1M), \fBread\fR(2), -\fBwrite\fR(2), \fBdriver.conf\fR(4), \fBdkio\fR(7I) \fBfdio\fR(7I) -.SH DIAGNOSTICS -.SS "All Platforms" -.sp -.ne 2 -.na -\fB\fBfd<n>: <command name> failed (<sr1> <sr2> <sr3>)\fR\fR -.ad -.sp .6 -.RS 4n -The <command name> failed after several retries on drive <n>. The three hex -values in parenthesis are the contents of status register 0, status register 1, -and status register 2 of the Intel 8272, the Intel 82072, and the Intel 82077 -Floppy Disk Controller on completion of the command, as documented in the data -sheet for that part. This error message is usually followed by one of the -following, interpreting the bits of the status register: -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBnot writable\fR -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBcrc error blk <block number>\fR -.sp -There was a data error on <block number>. -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBbad format\fR -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBtimeout\fR -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBdrive not ready\fR -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBunformatted diskette or no diskette in drive\fR -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBblock <block number> is past the end!\fR -.sp -\fB(nblk=<total number of blocks>)\fR -.sp -The operation tried to access a block number that is greater than the total -number of blocks. -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBb_bcount 0x<op_size> not % 0x<sect_size>\fR -.sp -The size of an operation is not a multiple of the sector size. -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBoverrun/underrun\fR -.RE - -.sp -.ne 2 -.na -\fB\fBfd<\fR\fIn\fR\fB>:\fR\fR -.ad -.RS 10n -\fBhost bus error\fR. There was a hardware error on a system bus. -.RE - -.RE - -.SS "SPARC Only" -.sp -.LP -Overrun/underrun errors occur when accessing a diskette while the system is -heavily loaded. Decrease the load on the system and retry the diskette access. -.SH NOTES -.sp -.LP -3.5" high density diskettes have 18 sectors per track and 5.25" high density -diskettes have 15 sectors per track. They can cross a track (though not a -cylinder) boundary without losing data, so when using \fBdd\fR(1M) or -\fBread\fR(2)/\fBwrite\fR(2) calls to or from the raw diskette, you should -specify \fBbs=18k\fR or multiples thereof for 3.5" diskettes, and \fBbs=15k\fR -or multiples thereof for 5.25" diskettes. -.sp -.LP -The SPARC \fBfd\fR driver is \fInot\fR an unloadable module. -.sp -.LP -Under Solaris (x86 Edition), the configuration of the floppy drives is -specified in \fBCMOS\fR configuration memory. Use the \fBBIOS\fR setup program -for the system to define the diskette size and density/capacity for each -installed drive. Note that \fBMS-DOS\fR may operate the floppy drives -correctly, even though the \fBCMOS\fR configuration may be in error. Solaris -(x86 Edition) relies on the \fBCMOS\fR configuration to be accurate. diff --git a/usr/src/man/man7d/fp.7d b/usr/src/man/man7d/fp.7d deleted file mode 100644 index 2cc529486d..0000000000 --- a/usr/src/man/man7d/fp.7d +++ /dev/null @@ -1,193 +0,0 @@ -'\" te -.\" Copyright (c) 2008 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 FP 7D "Jan 10, 2008" -.SH NAME -fp \- Sun Fibre Channel port driver -.SH DESCRIPTION -.sp -.LP -The \fBfp\fR driver is a Sun fibre channel nexus driver that enables fibre -channel topology discovery, device discovery, fibre channel adapter port -management and other capabilities through well-defined fibre channel adapter -driver interfaces. -.sp -.LP -The \fBfp\fR driver requires the presence of a fabric name server in fabric and -public loop topologies to discover fibre channel devices. In private loop -topologies, the driver discovers devices by performing \fBPLOGI\fR to all valid -\fBAL_PA\fRs, provided that devices do not participate in \fBLIRP\fR and -\fBLILP\fR stages of loop initialization. The \fBfp\fR driver also discovers -devices in N_Port point-to-point topologies. -.SH CONFIGURATION -.sp -.LP -The \fBfp\fR driver is configured by defining properties in the \fBfp.conf\fR -file. Note that you must reboot the system to have any changes you make to -\fBfp.conf\fR take effect. The \fBfp\fR driver supports the following -properties: -.sp -.ne 2 -.na -\fBmpxio-disable\fR -.ad -.sp .6 -.RS 4n -Solaris I/O multipathing is enabled or disabled on fibre channel devices with -the mpxio-disable property. Specifying mpxio-disable="no" activates I/O -multipathing, while mpxio-disable="yes" disables the feature. Solaris I/O -multipathing may be enabled or disabled on a per port basis. Per port settings -override the global setting for the specified ports. The following example -shows how to disable multipathing on port 0 whose parent is -/pci@8,600000/SUNW,qlc@4: -.sp -.in +2 -.nf -name="fp" parent="/pci@8,600000/SUNW,qlc@4" port=0 -mpxio-disable="yes"; -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fBmanual_configuration_only\fR -.ad -.sp .6 -.RS 4n -Automatic configuration of SCSI devices in the fabric is enabled by default and -thus allows all devices discovered in the SAN zone to be enumerated in the -kernel's device tree automatically. The \fBmanual_configuration_only\fR -property may be configured to disable the default behavior and force the -manual configuration of the devices in the SAN. Specifying -manual_configuration_only=1 disables the automatic configuration of devices. -.RE - -.sp -.ne 2 -.na -\fBpwwn-lun-blacklist\fR -.ad -.sp .6 -.RS 4n -Allows you to specify target port WWNs and LUN numbers you do not want -configured. LUN numbers are interpreted as decimals. White spaces and commas -(',') can be used in the list of LUN numbers. -.sp -.in +2 -.nf - # - # pwwn-lun-blacklist= - # "target-port-wwn,lun-list" - # - # To prevent LUNs 1 and 2 from being configured for target - # port 510000f010fd92a1 and target port 510000e012079df1, set: - # - # pwwn-lun-blacklist= - # "510000f010fd92a1,1,2", - # "510000e012079df1,1,2"; - # -.fi -.in -2 - -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fp\fR\fR -.ad -.RS 26n -32-bit ELF kernel driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/fp\fR\fR -.ad -.RS 26n -64-bit ELF kernel driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/fp\fR\fR -.ad -.RS 26n -64-bit ELF kernel driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/fp.conf\fR\fR -.ad -.RS 26n -\fBfp\fR driver configuration file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -mpxio-disable Uncommitted -_ -manual_configuration_only Obsolete -.TE - -.SH SEE ALSO -.sp -.LP -\fBcfgadm_fp\fR(1M), \fBprtconf\fR(1M), \fBstmsboot\fR(1M), -\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcp\fR(7D), \fBfctl\fR(7D), -\fBscsi_vhci\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIFibre Channel Physical and Signaling Interface (FC-PH) ANSI X3.230: 1994\fR -.sp -.LP -\fIFibre Channel Generic Services (FC-GS-2) Project 1134-D\fR -.sp -.LP -\fIFibre Channel Arbitrated Loop (FC-AL) ANSI X3.272-1996\fR -.sp -.LP -\fIFibre Channel Protocol for SCSI (FCP) ANSI X3.269-1996\fR -.sp -.LP -\fISCSI-3 Architecture Model (SAM) Fibre Channel Private Loop SCSI Direct -Attach (FC-PLDA) ANSI X3.270-1996\fR -.sp -.LP -\fISCSI Direct Attach (FC-PLDA) ANSI X3.270-1996\fR -.sp -.LP -\fISCSI Direct Attach (FC-PLDA) NCITS TR-19:1998\fR -.sp -.LP -\fIFabric Loop Attachment (FC-FLA), NCITS TR-20:1998\fR -.SH NOTES -.sp -.LP -In N_Port point-to-point topologies, FCP error recovery does not work across -events such as link bounce/cable pull. I/O to devices with FCP-2/FCP-3 support -(for example, FC tape drives) will be disrupted by such events. diff --git a/usr/src/man/man7d/full.7d b/usr/src/man/man7d/full.7d deleted file mode 100644 index 34d58e8e28..0000000000 --- a/usr/src/man/man7d/full.7d +++ /dev/null @@ -1,46 +0,0 @@ -.\" -.\" 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 2017 James S Blachly, MD <james.blachly@gmail.com> -. -.Dd "Feb 7, 2017" -.Dt FULL 7D -.Os -.Sh NAME -.Nm full -.Nd always-full device -.Sh SYNOPSIS -.Pa /dev/full -.Sh DESCRIPTION -The -.Nm -device is used to test program behavior in out-of-space conditions. -.Lp -Writes always yield the error -.Er ENOSPC. -.Lp -Reads supply an endless stream of zeros, identical to -.Xr zero 7D -.Lp -.Xr lseek 2 -will always return successfully. -.Lp -.Xr mmap 2 -is not implemented. -.Sh FILES -. -.Bl -tag -width Pa -.It Pa /dev/full -.El -. -.Sh SEE ALSO -.Xr mem 7D , -.Xr null 7D , -.Xr zero 7D diff --git a/usr/src/man/man7d/gld.7d b/usr/src/man/man7d/gld.7d deleted file mode 100644 index 74e1db2052..0000000000 --- a/usr/src/man/man7d/gld.7d +++ /dev/null @@ -1,1024 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 GLD 7D "Nov 10, 2005" -.SH NAME -gld \- Generic \fBLAN\fR Driver -.SH SYNOPSIS -.nf -\fB#include\fR \fB<sys/stropts.h>\fR -.fi - -.LP -.nf -\fB#include\fR \fB<sys/stream.h>\fR -.fi - -.LP -.nf -\fB#include\fR \fB<sys/dlpi.h>\fR -.fi - -.LP -.nf -\fB#include\fR \fB<sys/gld.h>\fR -.fi - -.SH INTERFACE LEVEL -illumos architecture specific (illumos DDI). -.SH DESCRIPTION -GLD is a multi-threaded, clonable, loadable kernel module providing support for -illumos local area network (\fBLAN\fR) device drivers. \fBLAN\fR drivers in -illumos are \fBSTREAMS\fR-based drivers that use the Data Link Provider -Interface (\fBDLPI\fR) to communicate with network protocol stacks. These -protocol stacks use the network drivers to send and receive packets on a local -area network. A network device driver must implement and adhere to the -requirements imposed by the DDI/DKI specification, \fBSTREAMS\fR specification, -DLPI specification, and programmatic interface of the device itself. -.sp -.LP -GLD implements most \fBSTREAMS\fR and DLPI functionality required of an illumos -LAN driver. Several illumos network drivers are implemented using GLD. -.sp -.LP -An illumos network driver implemented using GLD comprises two distinct parts: a -generic component that deals with \fBSTREAMS\fR and DLPI interfaces, and a -device-specific component that deals with the particular hardware device. The -device-specific module indicates its dependency on the GLD module and registers -itself with GLD from within the driver's \fBattach\fR(9E) function. Once it is -successfully loaded, the driver is \fBDLPI\fR-compliant. The device-specific -part of the driver calls \fBgld\fR(9F) functions when it receives data or needs -some service from GLD. GLD makes calls into the \fBgld\fR(9E) entry points of -the device-specific driver through pointers provided to GLD by the -device-specific driver when it registered itself with GLD. The -\fBgld_mac_info\fR(9S) structure is the main data interface between GLD and the -device-specific driver. -.sp -.LP -The GLD facility currently supports devices of type \fBDL_ETHER\fR, -\fBDL_TPR\fR, and \fBDL_FDDI\fR. GLD drivers are expected to process -fully-formed MAC-layer packets and should not perform logical link control -(LLC) handling. -.LP -Note - -.sp -.RS 2 -Support for the DL_TPR and DL_FDDI media types in GLD is obsolete and may be -removed in a future release of illumos. -.RE -.sp -.LP -In some cases, it may be necessary or desirable to implement a full -DLPI-compliant driver without using the GLD facility. This is true for devices -that are not IEEE 802-style LAN devices, or where a device type or DLPI service -not supported by GLD is required. -.SS "Device Naming Constraints" -The name of the device-specific driver module must adhere to the naming -constraints outlined in the NOTES section of \fBdlpi\fR(7P). -.SS "Type DL_ETHER: Ethernet V2 and ISO 8802-3 (IEEE 802.3)" -For devices designated type \fBDL_ETHER\fR, GLD provides support for both -Ethernet V2 and ISO 8802-3 (IEEE 802.3) packet processing. Ethernet V2 enables -a data link service user to access and use any of a variety of conforming data -link service providers without special knowledge of the provider's protocol. A -service access point (\fBSAP\fR) is the point through which the user -communicates with the service provider. -.sp -.LP -SAP 0 denotes that the user wishes to use \fI802.3\fR mode. In transmission, -GLD checks the destination SAP value of the DL_UNITDATA_REQ and the SAP value -to which the stream is bound. If both are 0, the GLD computes the length of -the packet payload and transmits \fI802.3\fR frames having that length in the -MAC frame header type field. Such lengths will never exceed 1500. -.sp -.LP -All frames received from the media that have a type field in the range [0-1500] -are assumed to be \fI802.3\fR frames and are routed up all open streams that -are in \fI802.3\fR mode, (those streams bound to a SAP value in of 0. If more -than one stream is in \fI802.3\fR mode, the incoming frame is duplicated and -routed up each such stream. -.sp -.LP -Streams bound to a SAP value of 1536 or greater receive incoming packets -whose Ethernet MAC header type value exactly matches the value of the SAP to -which the stream is bound. SAP values in the range [1-1535] are undefined and -should not be used. -.SS "Types DL_TPR and DL_FDDI: SNAP Processing" -Note - -.sp -.RS 2 -Support for the DL_TPR and DL_FDDI media types in GLD is obsolete and may be -removed in a future release of illumos. -.RE -.sp -.LP -For media types DL_TPR and DL_FDDI, GLD implements minimal SNAP (Sub-Net -Access Protocol) processing for SAP values of 1536 or greater. A SAP value of -0 denotes that the user wishes to use LLC mode. SAP values in the range -[1-1535] have undefined semantics and should not be used. -.sp -.LP -\fBSNAP\fR headers are carried under LLC headers with destination SAP 0xAA. For -outgoing packets with SAP values greater than 1535, GLD creates an LLC+SNAP -header that always looks like: -.sp -.LP -``AA AA 03 00 00 00 XX XX'' -.sp -.LP -where ``XX XX'' represents the 16-bit SAP, corresponding to the Ethernet V2 -style ``type.'' This is the only class of SNAP header that is processed - -non-zero OUI fields, and LLC control fields other than 03 are considered to be -LLC packets with SAP 0xAA. -.sp -.LP -A DL_UNITDATA_REQ message specifying a destination SAP value of 0, passed -down a stream bound to SAP 0, is assumed to contain an LLC packet and -will not undergo SNAP processing. -.sp -.LP -Incoming packets are examined to ascertain whether they fall into the format -specified above. Packets that do will be passed to streams bound to the -packet's 16-bit SNAP type, as well as being passed to any stream in LLC mode -(those bound to a SAP value of 0). -.SS "Type DL_TPR: Source Routing" -Note - -.sp -.RS 2 -Support for the DL_TPR media type in GLD is obsolete and may be removed in a -future release of illumos. -.RE -.sp -.LP -For type \fBDL_TPR\fR devices, GLD implements minimal support for source -routing. Source routing enables a station that is sending a packet across a -bridged medium to specify (in the packet MAC header) routing information that -determines the route that the packet will take through the network. -.sp -.LP -Functionally, the source routing support provided by GLD learns routes, -solicits and responds to requests for information about possible multiple -routes and selects among the multiple routes that are available. It adds -\fIRouting Information Fields\fR to the MAC headers of outgoing packets and -recognizes such fields in incoming packets. -.sp -.LP -GLD's source routing support does not implement the full \fIRoute Determination -Entity\fR \fB(RDE)\fR specified in \fIISO 8802-2 (IEEE 802.2)\fR Section 9. -However, it is designed to interoperate with any such implementations that may -exist in the same (or a bridged) network. -.SS "Style 1 and 2 Providers" -GLD implements both Style 1 and Style 2 providers. A physical point of -attachment (\fBPPA\fR) is the point at which a system attaches itself to a -physical communication medium. All communication on that physical medium -funnels through the \fBPPA\fR. The Style 1 provider attaches the stream to a -particular \fBPPA\fR based on the major/minor device that has been opened. The -Style 2 provider requires the DLS user to explicitly identify the desired -\fBPPA\fR using \fBDL_ATTACH_REQ.\fR In this case, \fBopen\fR(9E) creates a -stream between the user and GLD and \fBDL_ATTACH_REQ\fR subsequently associates -a particular \fBPPA\fR with that stream. Style 2 is denoted by a minor number -of zero. If a device node whose minor number is not zero is opened, Style 1 is -indicated and the associated \fBPPA\fR is the minor number minus 1. In both -Style 1 and Style 2 opens, the device is cloned. -.SS "Implemented DLPI Primitives" -GLD implements the following DLPI primitives: -.sp -.LP -The \fBDL_INFO_REQ\fR primitive requests information about the DLPI stream. The -message consists of one \fBM_PROTO\fR message block. GLD returns -device-dependent values in the \fBDL_INFO_ACK\fR response to this request, -based on information the GLD-based driver specified in the -\fBgld_mac_info\fR(9S) structure passed to \fBgld_register()\fR. However GLD -returns the following values on behalf of all GLD-based drivers: -.RS +4 -.TP -.ie t \(bu -.el o -The version is \fBDL_VERSION_2\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The service mode is \fBDL_CLDLS\fR \(em GLD implements connectionless-mode -service. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The provider style is \fBDL_STYLE1\fR or \fBDL_STYLE2,\fR depending on how the -stream was opened. -.RE -.sp -.LP -The \fBDL_ATTACH_REQ\fR primitive is called to associate a \fBPPA\fR with a -stream. This request is needed for Style 2 DLS providers to identify the -physical medium over which the communication will transpire. Upon completion, -the state changes from \fBDL_UNATTACHED\fR to \fBDL_UNBOUND.\fR The message -consists of one \fBM_PROTO\fR message block. This request may not be issued -when using the driver in Style 1 mode; streams opened using Style 1 are already -attached to a \fBPPA\fR by the time the open completes. -.sp -.LP -The \fBDL_DETACH_REQ\fR primitive requests to detach the \fBPPA\fR from the -stream. This is only allowed if the stream was opened using Style 2. -.sp -.LP -The \fBDL_BIND_REQ\fR and \fBDL_UNBIND_REQ\fR primitives bind and unbind a -\fBDLSAP\fR to the stream. The \fBPPA\fR associated with each stream will have -been initialized upon completion of the processing of the \fBDL_BIND_REQ.\fR -Multiple streams may be bound to the same \fBSAP\fR; each such stream receives -a copy of any packets received for that SAP. -.sp -.LP -The \fBDL_ENABMULTI_REQ\fR and \fBDL_DISABMULTI_REQ\fR primitives enable and -disable reception of individual multicast group addresses. A set of multicast -addresses may be iteratively created and modified on a per-stream basis using -these primitives. The stream must be attached to a \fBPPA\fR for these -primitives to be accepted. -.sp -.LP -The \fBDL_PROMISCON_REQ\fR and \fBDL_PROMISCOFF_REQ\fR primitives enable and -disable promiscuous mode on a per-stream basis, either at a physical level or -at the \fBSAP\fR level. The DL Provider will route all received messages on the -media to the DLS user until either a \fBDL_DETACH_REQ\fR or a -\fBDL_PROMISCOFF_REQ\fR is received or the stream is closed. Physical level -promiscuous mode may be specified for all packets on the medium or for -multicast packets only. The stream must be attached to a \fBPPA\fR for these -primitives to be accepted. -.sp -.LP -The \fBDL_UNITDATA_REQ\fR primitive is used to send data in a connectionless -transfer. Because this is an unacknowledged service, there is no guarantee of -delivery. The message consists of one \fBM_PROTO\fR message block followed by -one or more \fBM_DATA\fR blocks containing at least one byte of data. -.sp -.LP -The \fBDL_UNITDATA_IND\fR type is used when a packet is received and is to be -passed upstream. The packet is put into an \fBM_PROTO\fR message with the -primitive set to \fBDL_UNITDATA_IND\fR. -.sp -.LP -The \fBDL_PHYS_ADDR_REQ\fR primitive returns the MAC address currently -associated with the \fBPPA\fR attached to the stream, in the -\fBDL_PHYS_ADDR_ACK\fR primitive. When using style 2, this primitive is only -valid following a successful \fBDL_ATTACH_REQ\fR. -.sp -.LP -The \fBDL_SET_PHYS_ADDR_REQ\fR primitive changes the MAC address currently -associated with the \fBPPA\fR attached to the stream. This primitive affects -all other current and future streams attached to this device. Once changed, all -streams currently or subsequently opened and attached to this device will -obtain this new physical address. The new physical address will remain in -effect until this primitive is used to change the physical address again or the -driver is reloaded. -.sp -.LP -The \fBDL_GET_STATISTICS_REQ\fR primitive requests a -\fBDL_GET_STATISTICS_ACK\fR response containing statistics information -associated with the PPA attached to the stream. Style 2 streams must be -attached to a particular \fBPPA\fR using \fBDL_ATTACH_REQ\fR before this -primitive will be successful. -.sp -.LP -GLD supports the DL_NOTE_LINK_UP, DL_NOTE_LINK_DOWN and DL_NOTE_SPEED -notifications using the DL_NOTIFY_IND primitive. See \fBdlpi\fR(7P). -.SS "Implemented ioctl Functions" -GLD implements the \fBDLIOCRAW\fR ioctl described in \fBdlpi\fR(7P). For any -other ioctl command, GLD passes it to the device-specific driver's -\fBgldm_ioctl()\fR function as described in \fBgld\fR(9E). -.SS "Requirements on GLD Drivers" -GLD-based drivers must include the header file \fB<sys/gld.h>\fR\&. -.sp -.LP -GLD-based drivers must also specify a link dependency on "misc/gld". (See -the -N option in \fBld\fR(1)). -.sp -.LP -GLD implements the \fBopen\fR(9E) and \fBclose\fR(9E) functions and the -required \fBSTREAMS\fR \fBput\fR(9E) and \fBsrv\fR(9E) functions on behalf of -the device-specific driver. GLD also implements the \fBgetinfo\fR(9E) function -for the driver. -.sp -.LP -The \fBmi_idname\fR element of the \fBmodule_info\fR(9S) structure is a string -specifying the name of the driver. This must exactly match the name of the -driver module as it exists in the file system. -.sp -.LP -The read-side \fBqinit\fR(9S) structure should specify the following elements -as shown below: -.sp -.ne 2 -.na -\fB\fBqi_putp\fR \fR -.ad -.RS 14n -\fINULL\fR -.RE - -.sp -.ne 2 -.na -\fB\fBqi_srvp\fR \fR -.ad -.RS 14n -\fBgld_rsrv\fR -.RE - -.sp -.ne 2 -.na -\fB\fBqi_qopen\fR \fR -.ad -.RS 14n -\fBgld_open\fR -.RE - -.sp -.ne 2 -.na -\fB\fBqi_qclose\fR \fR -.ad -.RS 14n -\fBgld_close\fR -.RE - -.sp -.LP -The write-side \fBqinit\fR(9S) structure should specify the following elements -as shown below: -.sp -.ne 2 -.na -\fB\fBqi_putp\fR \fR -.ad -.RS 14n -\fBgld_wput\fR -.RE - -.sp -.ne 2 -.na -\fB\fBqi_srvp\fR \fR -.ad -.RS 14n -\fBgld_wsrv\fR -.RE - -.sp -.ne 2 -.na -\fB\fBqi_qopen\fR \fR -.ad -.RS 14n -\fINULL\fR -.RE - -.sp -.ne 2 -.na -\fB\fBqi_qclose\fR \fR -.ad -.RS 14n -\fINULL\fR -.RE - -.sp -.LP -The \fBdevo_getinfo\fR element of the \fBdev_ops\fR(9S) structure should -specify \fBgld_getinfo\fR as the \fBgetinfo\fR(9E) routine. -.sp -.LP -The driver's \fBattach\fR(9E) function does all the work of associating the -hardware-specific device driver with the GLD facility and preparing the device -and driver for use. -.sp -.LP -The \fBattach\fR(9E) function allocates a \fBgld_mac_info\fR(9S) (``macinfo'') -structure using \fBgld_mac_alloc()\fR. The driver usually needs to save more -information per device than is defined in the macinfo structure; it should -allocate the additional required data structure and save a pointer to it in the -\fBgldm_private\fR member of the \fBgld_mac_info\fR(9S) structure. -.sp -.LP -The \fBattach\fR(9E) routine must initialize the macinfo structure as described -in \fBgld_mac_info\fR(9S) and then call \fBgld_register()\fR to link the driver -with the GLD module. The driver should map registers if necessary and be fully -initialized and prepared to accept interrupts before calling -\fBgld_register()\fR. The \fBattach\fR(9E) function should add interrupts but -not enable the device to generate them. The driver should reset the hardware -before calling \fBgld_register()\fR to ensure it is quiescent; the device must -not be started or put into a state where it may generate an interrupt before -\fBgld_register()\fR is called. That will be done later when GLD calls the -driver's \fBgldm_start()\fR entry point described in \fBgld\fR(9E). Once -\fBgld_register()\fR succeeds, the \fBgld\fR(9E) entry points may be called by -GLD at any time. -.sp -.LP -The \fBattach\fR(9E) routine should return \fBDDI_SUCCESS\fR if -\fBgld_register()\fR succeeds. If \fBgld_register()\fR fails, it returns -\fBDDI_FAILURE\fR and the \fBattach\fR(9E) routine should deallocate any -resources it allocated before calling \fBgld_register()\fR and then also return -\fBDDI_FAILURE\fR. Under no circumstances should a failed macinfo structure be -reused; it should be deallocated using \fBgld_mac_free\fR(). -.sp -.LP -The \fBdetach\fR(9E) function should attempt to unregister the driver from GLD. -This is done by calling \fBgld_unregister()\fR described in \fBgld\fR(9F). The -\fBdetach\fR(9E) routine can get a pointer to the needed \fBgld_mac_info\fR(9S) -structure from the device's private data using -\fBddi_get_driver_private\fR(9F). \fBgld_unregister\fR() checks certain -conditions that could require that the driver not be detached. If the checks -fail, \fBgld_unregister()\fR returns \fBDDI_FAILURE\fR, in which case the -driver's \fBdetach\fR(9E) routine must leave the device operational and return -\fBDDI_FAILURE\fR. If the checks succeed, \fBgld_unregister()\fR ensures that -the device interrupts are stopped, calling the driver's \fBgldm_stop()\fR -routine if necessary, unlinks the driver from the GLD framework, and returns -\fBDDI_SUCCESS\fR. In this case, the \fBdetach\fR(9E) routine should remove -interrupts, deallocate any data structures allocated in the \fBattach\fR(9E) -routine, using \fBgld_mac_free()\fR to deallocate the macinfo structure, and -return \fBDDI_SUCCESS\fR. It is important to remove the interrupt \fIbefore\fR -calling \fBgld_mac_free()\fR. -.SS "Network Statistics" -illumos network drivers must implement statistics variables. GLD itself tallies -some network statistics, but other statistics must be counted by each GLD-based -driver. GLD provides support for GLD-based drivers to report a standard set of -network driver statistics. Statistics are reported by GLD using the -\fBkstat\fR(7D) and \fBkstat\fR(9S) mechanism. The \fBDL_GET_STATISTICS_REQ\fR -DLPI command may also be used to retrieve the current statistics counters. All -statistics are maintained as unsigned, and all are 32 bits unless otherwise -noted. -.sp -.LP -GLD maintains and reports the following statistics. -.sp -.ne 2 -.na -\fB\fBrbytes64\fR \fR -.ad -.RS 15n -Total bytes successfully received on the interface (64 bits). -.RE - -.sp -.ne 2 -.na -\fB\fBrbytes\fR \fR -.ad -.RS 15n -Total bytes successfully received on the interface. -.RE - -.sp -.ne 2 -.na -\fB\fBobytes64\fR \fR -.ad -.RS 15n -Total bytes requested to be transmitted on the interface (64 bits). -.RE - -.sp -.ne 2 -.na -\fB\fBobytes\fR \fR -.ad -.RS 15n -Total bytes requested to be transmitted on the interface. -.RE - -.sp -.ne 2 -.na -\fB\fBipackets64\fR \fR -.ad -.RS 15n -Total packets successfully received on the interface (64 bits). -.RE - -.sp -.ne 2 -.na -\fB\fBipackets\fR \fR -.ad -.RS 15n -Total packets successfully received on the interface. -.RE - -.sp -.ne 2 -.na -\fB\fBopackets64\fR \fR -.ad -.RS 15n -Total packets requested to be transmitted on the interface (64 bits). -.RE - -.sp -.ne 2 -.na -\fB\fBopackets\fR \fR -.ad -.RS 15n -Total packets requested to be transmitted on the interface. -.RE - -.sp -.ne 2 -.na -\fB\fBmultircv\fR \fR -.ad -.RS 15n -Multicast packets successfully received, including group and functional -addresses (long). -.RE - -.sp -.ne 2 -.na -\fB\fBmultixmt\fR \fR -.ad -.RS 15n -Multicast packets requested to be transmitted, including group and functional -addresses (long). -.RE - -.sp -.ne 2 -.na -\fB\fBbrdcstrcv\fR \fR -.ad -.RS 15n -Broadcast packets successfully received (long). -.RE - -.sp -.ne 2 -.na -\fB\fBbrdcstxmt\fR \fR -.ad -.RS 15n -Broadcast packets requested to be transmitted (long). -.RE - -.sp -.ne 2 -.na -\fB\fBunknowns\fR \fR -.ad -.RS 15n -Valid received packets not accepted by any stream (long). -.RE - -.sp -.ne 2 -.na -\fB\fBnoxmtbuf\fR \fR -.ad -.RS 15n -Packets discarded on output because transmit buffer was busy, or no buffer -could be allocated for transmit (long). -.RE - -.sp -.ne 2 -.na -\fB\fBblocked\fR \fR -.ad -.RS 15n -Times a received packet could not be put up a stream because the queue was flow -controlled (long). -.RE - -.sp -.ne 2 -.na -\fB\fBxmtretry\fR \fR -.ad -.RS 15n -Times transmit was retried after having been delayed due to lack of resources -(long). -.RE - -.sp -.ne 2 -.na -\fB\fBpromisc\fR \fR -.ad -.RS 15n -Current ``promiscuous'' state of the interface (string). -.RE - -.sp -.LP -The device dependent driver counts the following statistics, keeping track of -them in a private per-instance structure. When GLD is asked to report -statistics, it calls the driver's \fBgldm_get_stats()\fR entry point, as -described in \fBgld\fR(9E), to update the device-specific statistics in the -\fBgld_stats\fR(9S) structure. GLD then reports the updated statistics using -the named statistics variables below. -.sp -.ne 2 -.na -\fB\fBifspeed\fR \fR -.ad -.RS 13n -Current estimated bandwidth of the interface in bits per second (64 bits). -.RE - -.sp -.ne 2 -.na -\fB\fBmedia\fR \fR -.ad -.RS 13n -Current media type in use by the device (string). -.RE - -.sp -.ne 2 -.na -\fB\fBintr\fR \fR -.ad -.RS 13n -Times interrupt handler was called and claimed the interrupt (long). -.RE - -.sp -.ne 2 -.na -\fB\fBnorcvbuf\fR \fR -.ad -.RS 13n -Times a valid incoming packet was known to have been discarded because no -buffer could be allocated for receive (long). -.RE - -.sp -.ne 2 -.na -\fB\fBierrors\fR \fR -.ad -.RS 13n -Total packets received that couldn't be processed because they contained errors -(long). -.RE - -.sp -.ne 2 -.na -\fB\fBoerrors\fR \fR -.ad -.RS 13n -Total packets that weren't successfully transmitted because of errors (long). -.RE - -.sp -.ne 2 -.na -\fB\fBmissed\fR \fR -.ad -.RS 13n -Packets known to have been dropped by the hardware on receive (long). -.RE - -.sp -.ne 2 -.na -\fB\fBuflo\fR \fR -.ad -.RS 13n -Times FIFO underflowed on transmit (long). -.RE - -.sp -.ne 2 -.na -\fB\fBoflo\fR \fR -.ad -.RS 13n -Times receiver overflowed during receive (long). -.RE - -.sp -.LP -The following group of statistics applies to networks of type \fBDL_ETHER\fR; -these are maintained by device-specific drivers of that type, as above. -.sp -.ne 2 -.na -\fB\fBalign_errors\fR \fR -.ad -.RS 23n -Packets received with framing errors (not an integral number of octets) (long). -.RE - -.sp -.ne 2 -.na -\fB\fBfcs_errors\fR \fR -.ad -.RS 23n -Packets received with CRC errors (long). -.RE - -.sp -.ne 2 -.na -\fB\fBduplex\fR \fR -.ad -.RS 23n -Current duplex mode of the interface (string). -.RE - -.sp -.ne 2 -.na -\fB\fBcarrier_errors\fR \fR -.ad -.RS 23n -Times carrier was lost or never detected on a transmission attempt (long). -.RE - -.sp -.ne 2 -.na -\fB\fBcollisions\fR \fR -.ad -.RS 23n -Ethernet collisions during transmit (long). -.RE - -.sp -.ne 2 -.na -\fB\fBex_collisions\fR \fR -.ad -.RS 23n -Frames where excess collisions occurred on transmit, causing transmit failure -(long). -.RE - -.sp -.ne 2 -.na -\fB\fBtx_late_collisions\fR \fR -.ad -.RS 23n -Times a transmit collision occurred late (after 512 bit times) (long). -.RE - -.sp -.ne 2 -.na -\fB\fBdefer_xmts\fR \fR -.ad -.RS 23n -Packets without collisions where first transmit attempt was delayed because the -medium was busy (long). -.RE - -.sp -.ne 2 -.na -\fB\fBfirst_collisions\fR \fR -.ad -.RS 23n -Packets successfully transmitted with exactly one collision. -.RE - -.sp -.ne 2 -.na -\fB\fBmulti_collisions\fR \fR -.ad -.RS 23n -Packets successfully transmitted with multiple collisions. -.RE - -.sp -.ne 2 -.na -\fB\fBsqe_errors\fR \fR -.ad -.RS 23n -Times SQE test error was reported. -.RE - -.sp -.ne 2 -.na -\fB\fBmacxmt_errors\fR \fR -.ad -.RS 23n -Packets encountering transmit MAC failures, except carrier and collision -failures. -.RE - -.sp -.ne 2 -.na -\fB\fBmacrcv_errors\fR \fR -.ad -.RS 23n -Packets received with MAC errors, except align, fcs, and toolong errors. -.RE - -.sp -.ne 2 -.na -\fB\fBtoolong_errors\fR \fR -.ad -.RS 23n -Packets received larger than the maximum permitted length. -.RE - -.sp -.ne 2 -.na -\fB\fBrunt_errors\fR \fR -.ad -.RS 23n -Packets received smaller than the minimum permitted length (long). -.RE - -.sp -.LP -The following group of statistics applies to networks of type \fBDL_TPR\fR; -these are maintained by device-specific drivers of that type, as above. -.sp -.ne 2 -.na -\fB\fBline_errors\fR \fR -.ad -.RS 24n -Packets received with non-data bits or FCS errors. -.RE - -.sp -.ne 2 -.na -\fB\fBburst_errors\fR \fR -.ad -.RS 24n -Times an absence of transitions for five half-bit timers was detected. -.RE - -.sp -.ne 2 -.na -\fB\fBsignal_losses\fR \fR -.ad -.RS 24n -Times loss of signal condition on the ring was detected. -.RE - -.sp -.ne 2 -.na -\fB\fBace_errors\fR \fR -.ad -.RS 24n -Times an AMP or SMP frame in which A is equal to C is equal to 0, was followed -by another such SMP frame without an intervening AMP frame. -.RE - -.sp -.ne 2 -.na -\fB\fBinternal_errors\fR \fR -.ad -.RS 24n -Times the station recognized an internal error. -.RE - -.sp -.ne 2 -.na -\fB\fBlost_frame_errors\fR \fR -.ad -.RS 24n -Times the TRR timer expired during transmit. -.RE - -.sp -.ne 2 -.na -\fB\fBframe_copied_errors\fR \fR -.ad -.RS 24n -Times a frame addressed to this station was received with the FS field A bit -set to 1. -.RE - -.sp -.ne 2 -.na -\fB\fBtoken_errors\fR \fR -.ad -.RS 24n -Times the station acting as the active monitor recognized an error condition -that needed a token transmitted. -.RE - -.sp -.ne 2 -.na -\fB\fBfreq_errors\fR \fR -.ad -.RS 24n -Times the frequency of the incoming signal differed from the expected -frequency. -.RE - -.sp -.LP -The following group of statistics applies to networks of type \fBDL_FDDI\fR; -these are maintained by device-specific drivers of that type, as above. -.sp -.ne 2 -.na -\fB\fBmac_errors\fR \fR -.ad -.RS 20n -Frames detected in error by this MAC that had not been detected in error by -another MAC. -.RE - -.sp -.ne 2 -.na -\fB\fBmac_lost_errors\fR \fR -.ad -.RS 20n -Frames received with format errors such that the frame was stripped. -.RE - -.sp -.ne 2 -.na -\fB\fBmac_tokens\fR \fR -.ad -.RS 20n -Number of tokens received (total of non-restricted and restricted). -.RE - -.sp -.ne 2 -.na -\fB\fBmac_tvx_expired\fR \fR -.ad -.RS 20n -Number of times that TVX has expired. -.RE - -.sp -.ne 2 -.na -\fB\fBmac_late\fR \fR -.ad -.RS 20n -Number of TRT expirations since this MAC was reset or a token was received. -.RE - -.sp -.ne 2 -.na -\fB\fBmac_ring_ops\fR \fR -.ad -.RS 20n -Number of times the ring has entered the ``Ring_Operational'' state from the -``Ring Not Operational'' state. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/misc/gld\fR \fR -.ad -.RS 21n -loadable kernel module -.RE - -.SH SEE ALSO -\fBld\fR(1), \fBkstat\fR(7D), \fBdlpi\fR(7P), \fBattach\fR(9E), \fBgld\fR(9E), -\fBopen\fR(9E), \fBgld\fR(9F), \fBgld_mac_info\fR(9S), \fBgld_stats\fR(9S), -\fBkstat\fR(9S) -.sp -.LP -\fIWriting Device Drivers\fR -.SH WARNINGS -Contrary to the DLPI specification, GLD returns the device's correct address -length and broadcast address in \fBDL_INFO_ACK\fR even before the stream has -been attached to a \fBPPA\fR. -.sp -.LP -Promiscuous mode may only be entered by streams that are attached to a -\fBPPA\fR. -.sp -.LP -The physical address of a \fBPPA\fR may be changed by the superuser while other -streams are bound to the same PPA. diff --git a/usr/src/man/man7d/gpio_87317.7d b/usr/src/man/man7d/gpio_87317.7d deleted file mode 100644 index 6124f4fe13..0000000000 --- a/usr/src/man/man7d/gpio_87317.7d +++ /dev/null @@ -1,38 +0,0 @@ -'\" te -.\" Copyright (2000 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 GPIO_87317 7D "Apr 12, 2000" -.SH NAME -gpio_87317 \- General purpose I/O driver for SuperIO -.SH DESCRIPTION -.sp -.LP -The \fBgpio_87317\fR driver is the general purpose I/O driver for the National -Semiconductor SuperIO (PC87317) chipset. It supports remote system controller -(RSC) administration via an interface to the SuperIO's general purpose I/O -bits. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture Limited to SPARC systems with SuperIO -_ -Interface Stability Unstable -.TE - -.SH SEE ALSO -.sp -.LP -\fIPC87317VUL/PC97317VUL SuperI/O Data Sheet \fR\(em National Semiconductor diff --git a/usr/src/man/man7d/grbeep.7d b/usr/src/man/man7d/grbeep.7d deleted file mode 100644 index 86bb7f3440..0000000000 --- a/usr/src/man/man7d/grbeep.7d +++ /dev/null @@ -1,61 +0,0 @@ -'\" te -.\" Copyright (c) 2001 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 GRBEEP 7D "Dec 18, 2001" -.SH NAME -grbeep \- Platform-dependent beep driver for SMBus-based hardware -.SH SYNOPSIS -.LP -.nf -beep@unit-address -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBgrbeep\fR driver generates beeps on platforms (including Sun Blade 100, -150, 1500, 2500) that use SMBbus-based registers and USB keyboards. When the -\fBKIOCCMD\fR ioctl is issued to the USB keyboard module (see \fBusbkbm\fR(7M)) -with command \fBKBD_CMD_BELL/KBD_CMD_NOBELL\fR, \fBusbkbm\fR(7M) passes the -request to the \fBgrbeep\fR driver to turn the beep on and off, respectively. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/platform/sun4u/kernel/drv/sparcv9/grbeep\fR\fR -.ad -.sp .6 -.RS 4n - 64-bit ELF kernel driver -.RE - -.SH ATTRIBUTES -.sp -.LP -See attributes(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SMBus-based SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBkbd\fR(1), \fBattributes\fR(5), \fBbbc_beep\fR(7D), \fBkb\fR(7M), -\fBusbkbm\fR(7M) -.sp -.LP -\fIWriting Device Drivers\fR -.SH DIAGNOSTICS -.sp -.LP -None diff --git a/usr/src/man/man7d/hci1394.7d b/usr/src/man/man7d/hci1394.7d deleted file mode 100644 index 34ac56762f..0000000000 --- a/usr/src/man/man7d/hci1394.7d +++ /dev/null @@ -1,64 +0,0 @@ -'\" te -.\" Copyright (c) 2005 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 HCI1394 7D "Jan 10, 2020" -.SH NAME -hci1394 \- 1394 OpenHCI host controller driver -.SH SYNOPSIS -.nf -\fBfirewire@unit-address\fR -.fi - -.SH DESCRIPTION -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 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 -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/hci1394\fR\fR -.ad -.sp .6 -.RS 4n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/hci1394\fR\fR -.ad -.sp .6 -.RS 4n -Device driver (x86) -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -_ -Interface Stability Unstable -.TE - -.SH SEE ALSO -\fBattributes\fR(5), \fBieee1394\fR(7D) -.sp -.LP -\fIIEEE 1394 - IEEE Standard for a High Performance Serial Bus\fR -.sp -.LP -\fI1394 Open Host Controller Interface Specification 1.0\fR diff --git a/usr/src/man/man7d/hermon.7d b/usr/src/man/man7d/hermon.7d deleted file mode 100644 index 708652966d..0000000000 --- a/usr/src/man/man7d/hermon.7d +++ /dev/null @@ -1,171 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 HERMON 7D "Jul 31, 2008" -.SH NAME -hermon \- ConnectX MT25408/MT25418/MT25428 InfiniBand (IB) Driver -.SH DESCRIPTION -.sp -.LP -The \fBhermon\fR driver is an IB Architecture-compliant implementation of an -HCA, which operates on the Mellanox MT25408, MT25418 and MT25428 InfiniBand -ASSPs using host memory for context storage rather than locally attached -memory on the card. Cards based on these ASSP's utilize the PCI-Express I/O -bus. These ASSP's support the link and physical layers of the InfiniBand -specification while the ASSP and the driver support the transport layer. -.sp -.LP -The \fBhermon\fR driver interfaces with the InfiniBand Transport Framework -(IBTF) and provides an implementation of the Channel Interfaces that are -defined by that framework. It also enables management applications and -agents to access the IB fabric. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/hermon\fR\fR -.ad -.sp .6 -.RS 4n -32-bit \fBELF\fR kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/hermon\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBELF\fR kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/hermon\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF Kernel Module. (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/hermon.conf\fR\fR -.ad -.sp .6 -.RS 4n -Driver configuration file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attribute: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PCIe-based systems -.TE - -.SH SEE ALSO -.sp -.LP -\fBdriver.conf\fR(4), \fBprinters.conf\fR(4), \fBattributes\fR(5) -.sp -.LP -\fIWriting Device Drivers\fR -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages may appear on the system -console: -.sp -.ne 2 -.na -\fBhermon\fBi\fR: driver attached for maintenance mode only.\fR -.ad -.sp .6 -.RS 4n -There was a failure in the boot process of the hermon ASSP and the only -function that can be performed is to re-flash firmware on the ASSP. (Note that -\fBi\fR represents the instance of the hermon device number.) -.RE - -.sp -.ne 2 -.na -\fBhermon\fBi:\fR driver failed to attach\fR -.ad -.sp .6 -.RS 4n -The ASSP could not boot into either operational (HCA) mode or into -maintenance mode. The device is inoperable. (Note that \fB i\fR represents the -instance of the hermon device number.) -.RE - -.sp -.ne 2 -.na -\fBUnexpected port number in port state change event.\fR -.ad -.sp .6 -.RS 4n -A port state change event occurred, but the port number in the message does -not exist on this HCA. This message also indicates the port number that was in -the port state changed. -.RE - -.sp -.ne 2 -.na -\fBHermon driver successfully detached.\fR -.ad -.sp .6 -.RS 4n -The driver has been removed from the system and the HCA is no longer available -for transfer operations. -.RE - -.sp -.ne 2 -.na -\fBhermon\fBi:\fR port \fBm\fR up.\fR -.ad -.sp .6 -.RS 4n -A port up asynchronous event has occurred. (Note that \fB i\fR represents the -instance of the Hermon device number while "m" represents the port number on -the Hermon device. -.RE - -.sp -.ne 2 -.na -\fBhermon\fBi:\fR port \fBm\fR down.\fR -.ad -.sp .6 -.RS 4n -A port up asynchronous event has occurred. Similar to port up event. -.RE - -.sp -.ne 2 -.na -\fBhermon: <command name> command failed.\fR -.ad -.sp .6 -.RS 4n -A internal firmware command failed to execute. -.RE - diff --git a/usr/src/man/man7d/hid.7d b/usr/src/man/man7d/hid.7d deleted file mode 100644 index 6601f7997b..0000000000 --- a/usr/src/man/man7d/hid.7d +++ /dev/null @@ -1,240 +0,0 @@ -'\" te -.\" 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 HID 7D "June 19, 2021" -.SH NAME -hid \- Human interface device (HID) class driver -.SH SYNOPSIS -.nf -\fBkeyboard@unit-address\fR -\fBmouse@unit-address\fR -\fBinput@unit-address:consumer_control\fR -\fB#include <sys/usb/clients/hid/hid.h>\fR -\fBint ioctl(int fildes, int command, ... /*arg*/);\fR -.fi - -.SH DESCRIPTION -The \fBhid\fR driver is a USBA (Solaris USB Architecture) compliant client -driver that supports the \fIHuman Interface Device Class (HID) 1.0\fR -specification. The Human Interface Device (HID) class encompasses devices -controlled by humans to operate computer systems. Typical examples of HID -devices include keyboards, mice, trackballs, and joysticks. HID also covers -front-panel controls such as knobs, switches, and buttons. A USB device with -multiple interfaces may have one interface for audio and a HID interface to -define the buttons that control the audio. -.sp -.LP -The \fBhid\fR driver is general and primarily handles the USB functionality of -the device and generic HID functionality. For example, HID interfaces are -required to have an interrupt pipe for the device to send data packets, and the -\fBhid\fR driver opens the pipe to the interrupt endpoint and starts polling. -The \fBhid\fR driver is also responsible for managing the device through the -default control pipe. In addition to being a USB client driver, the \fBhid\fR -driver is also a STREAMS driver so that modules may be pushed on top of it. -.sp -.LP -The HID specification is flexible, and HID devices dynamically describe their -packets and other parameters through a HID report descriptor. The HID parser is -a misc module that parses the HID report descriptor and creates a database of -information about the device. The \fBhid\fR driver queries the HID parser to -find out the type and characteristics of the HID device. The HID specification -predefines packet formats for the boot protocol keyboard and mouse. -.SH IOCTLS -.ne 2 -.na -\fB\fBHIDIOCKMGDIRECT\fR\fR -.ad -.RS 19n -This ioctl should only be addressed to a USB keyboard or mouse device. The -\fBhid\fR driver maintains two streams for each USB keyboard/mouse instance: an -internal one for the use of the kernel and an external one for the use of user -applications. This ioctl returns the information of which stream gets the input -for the moment. -.sp -\fIarg\fR must point to a variable of \fBint\fR type. Upon return, \fB0\fR -means the internal stream gets the input, \fB1\fR means the external stream -gets the input. -.RE - -.sp -.ne 2 -.na -\fB\fBHIDIOCKMSDIRECT\fR\fR -.ad -.RS 19n -This ioctl should only be addressed to a USB keyboard or mouse device. The hid -driver maintains two streams for each USB keyboard/mouse instance: an internal -one for the use of the kernel and an external one for the use of user -applications. This ioctl sets which stream should get the input for the moment. -.sp -\fIarg\fR must point to a variable of \fBint\fR type. The argument \fB0\fR -means the internal stream gets the input, \fB1\fR means the external stream -gets the input. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/amd64/hid\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel hid module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/hid\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel hid module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/hidparser\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel hidparser module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/sparcv9/hidparser\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel hidparser module -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -\fBcfgadm_usb\fR(1M), \fBattributes\fR(5), \fBusba\fR(7D), \fBvirtualkm\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fIUniversal Serial Bus Specification 1.0 and 1.1\fR -.sp -.LP -\fIDevice Class Definition for Human Interface Devices (HID) 1.1\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH DIAGNOSTICS -.ne 2 -.na -\fBhid_attach: Unsupported HID device.\fR -.ad -.sp .6 -.RS 4n -The device requires a protocol not supported by the hid driver. -.RE - -.sp -.ne 2 -.na -\fBParsing of hid descriptor failed.\fR -.ad -.sp .6 -.RS 4n -The HID report descriptor cannot be parsed correctly. The device cannot be -supported by the hid driver. -.RE - -.sp -.ne 2 -.na -\fBInvalid report descriptor.\fR -.ad -.sp .6 -.RS 4n -The HID report descriptor is invalid. The device cannot be supported by the hid -driver. -.RE - -.sp -.LP -The following messages may be logged into the system log. They are formatted in -the following manner: -.sp -.in +2 -.nf -<device path><hid<instance number>): message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBhid_attach: Unsupported HID device.\fR -.ad -.sp .6 -.RS 4n -The device cannot be supported by this version of the HID driver. -.RE - -.sp -.ne 2 -.na -\fBParsing of HID descriptor failed.\fR -.ad -.sp .6 -.RS 4n -The device cannot be supported by this version of the HID driver. -.RE - -.sp -.ne 2 -.na -\fBInvalid report descriptor.\fR -.ad -.sp .6 -.RS 4n -The device cannot be supported by this version of the HID driver. -.RE - -.SH NOTES -The hid driver currently supports only keyboard, mouse and audio HID control -devices. -.sp -.LP -Normally a mouse is not power managed and consequently, screen darkening can be -undone with a mouse movement. If power management of the mouse is required, add -the following line to \fBhid.conf\fR then reboot the system: -.sp -.in +2 -.nf -hid-mouse-pm-enable; -.fi -.in -2 - -.sp -.LP -Modern mice that are power managed require a 'click' to wake up. Occasionally, -this may cause unexpected results. diff --git a/usr/src/man/man7d/hme.7d b/usr/src/man/man7d/hme.7d deleted file mode 100644 index 79944244a2..0000000000 --- a/usr/src/man/man7d/hme.7d +++ /dev/null @@ -1,398 +0,0 @@ -'\" te -.\" Copyright (c) 1995, 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 HME 7D "Sep 5, 1995" -.SH NAME -hme \- SUNW,hme Fast-Ethernet device driver -.SH SYNOPSIS -.LP -.nf -\fB/dev/hme\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBSUNW,hme\fR Fast-Ethernet driver is a multi-threaded, loadable, -clonable, STREAMS hardware driver supporting the connectionless Data Link -Provider Interface, \fBdlpi\fR(7P), over a \fBSUNW,hme\fR Fast-Ethernet -controller. The motherboard and add-in SBus \fBSUNW,hme\fR controllers of -several varieties are supported. Multiple \fBSUNW,hme\fR controllers installed -within the system are supported by the driver. -.sp -.LP -The \fBhme\fR driver provides basic support for the \fBSUNW,hme\fR hardware. It -is used to handle the \fBSUNW,hme\fR device. Functions include chip -initialization, frame transit and receive, multicast and promiscuous support, -and error recovery and reporting. \fBSUNW,hme\fR The \fBSUNW,hme\fR device -provides 100Base-TX networking interfaces using SUN's \fBFEPS ASIC\fR and an -Internal Transceiver. The FEPS ASIC provides the Sbus interface and MAC -functions and the Physical layer functions are provided by the Internal -Transceiver which connects to a \fBRJ-45\fR connector. In addition to the RJ-45 -connector, an \fBMII\fR (Media Independent Interface) connector is also -provided on all \fBSUNW,hme\fR devices except the \fBSunSwith SBus adapter\fR -board. The MII interface is used to connect to an External Transceiver which -may use any physical media (copper or fiber) specified in the 100Base-TX -standard. When an External Transceiver is connected to the MII, the driver -selects the External Transceiver and disables the Internal Transceiver. -.sp -.LP -The 100Base-TX standard specifies an "auto-negotiation" protocol to -automatically select the mode and speed of operation. The Internal transceiver -is capable of doing "auto-negotiation" with the remote-end of the link (Link -Partner) and receives the capabilities of the remote end. It selects the -\fBHighest Common Denominator\fR mode of operation based on the priorities. It -also supports \fBforced-mode\fR of operation where the driver can select the -mode of operation. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning character-special device \fB/dev/hme\fR is used to access all -\fBSUNW,hme\fR controllers installed within the system. -.SS "hme and DLPI" -.sp -.LP -The \fBhme\fR driver is a "style 2" Data Link Service provider. All -\fBM_PROTO\fR and \fBM_PCPROTO\fR type messages are interpreted as \fBDLPI\fR -primitives. Valid \fBDLPI\fR primitives are defined in \fB<sys/dlpi.h>.\fR -Refer to \fBdlpi\fR(7P) for more information. An explicit \fBDL_ATTACH_REQ\fR -message by the user is required to associate the opened stream with a -particular device (\fBppa\fR). The \fBppa\fR ID is interpreted as an -\fBunsigned long\fR data type and indicates the corresponding device instance -(unit) number. An error (\fBDL_ERROR_ACK\fR) is returned by the driver if the -\fBppa\fR field value does not correspond to a valid device instance number for -this system. The device is initialized on first attach and de-initialized -(stopped) at last detach. -.sp -.LP -The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in -response to the \fBDL_INFO_REQ\fR from the user are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -The maximum \fBSDU\fR is \fB1500\fR (\fBETHERMTU\fR - defined in -<sys/ethernet.h> ). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The minimum \fBSDU\fR is \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBdlsap\fR address length is \fB8.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBMAC\fR type is \fBDL_ETHER.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBsap\fR length values is \fB\(mi2\fR meaning the physical address -component is followed immediately by a 2 byte \fBsap\fR component within the -\fBDLSAP\fR address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The service mode is \fBDL_CLDLS.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -No optional quality of service (QOS) support is included at present so the -\fBQOS\fR fields are \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The provider style is \fBDL_STYLE2.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The version is \fBDL_VERSION_2.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The broadcast address value is Ethernet/IEEE broadcast address -(\fB0xFFFFFF\fR). -.RE -.sp -.LP -Once in the \fBDL_ATTACHED\fR state, the user must send a \fBDL_BIND_REQ\fR to -associate a particular \fBSAP\fR (Service Access Pointer) with the stream. The -\fBhme\fR driver interprets the \fBsap\fR field within the \fBDL_BIND_REQ\fR as -an Ethernet "type" therefore valid values for the \fBsap\fR field are in the -[\fB0\fR-\fB0xFFFF\fR] range. Only one Ethernet type can be bound to the -stream at any time. -.sp -.LP -If the user selects a \fBsap\fR with a value of \fB0\fR, the receiver will be -in "802.3 mode". All frames received from the media having a "type" field in -the range [\fB0\fR-\fB1500\fR] are assumed to be 802.3 frames and are routed up -all open Streams which are bound to \fBsap\fR value \fB0\fR. If more than one -Stream is in "802.3 mode" then the frame will be duplicated and routed up -multiple Streams as \fBDL_UNITDATA_IND\fR messages. -.sp -.LP -In transmission, the driver checks the \fBsap\fR field of the \fBDL_BIND_REQ\fR -if the \fBsap\fR value is \fB0\fR, and if the destination type field is in the -range [\fB0\fR-\fB1500\fR]. If either is true, the driver computes the length -of the message, not including initial \fBM_PROTO\fR mblk (message block), of -all subsequent \fBDL_UNITDATA_REQ\fR messages and transmits 802.3 frames that -have this value in the MAC frame header length field. -.sp -.LP -The \fBhme\fR driver \fBDLSAP\fR address format consists of the 6 byte physical -(Ethernet) address component followed immediately by the 2 byte \fBsap\fR -(type) component producing an 8 byte \fBDLSAP\fR address. Applications should -\fInot\fR hardcode to this particular implementation-specific \fBDLSAP\fR -address format but use information returned in the \fBDL_INFO_ACK\fR primitive -to compose and decompose \fBDLSAP\fR addresses. The \fBsap\fR length, full -\fBDLSAP\fR length, and \fBsap\fR/physical ordering are included within the -\fBDL_INFO_ACK.\fR The physical address length can be computed by subtracting -the \fBsap\fR length from the full \fBDLSAP\fR address length or by issuing the -\fBDL_PHYS_ADDR_REQ\fR to obtain the current physical address associated with -the stream. -.sp -.LP -Once in the \fBDL_BOUND\fR state, the user may transmit frames on the Ethernet -by sending \fBDL_UNITDATA_REQ\fR messages to the \fBhme\fR driver. The -\fBhme\fR driver will route received Ethernet frames up all those open and -bound streams having a \fBsap\fR which matches the Ethernet type as -\fBDL_UNITDATA_IND\fR messages. Received Ethernet frames are duplicated and -routed up multiple open streams if necessary. The \fBDLSAP\fR address contained -within the \fBDL_UNITDATA_REQ\fR and \fBDL_UNITDATA_IND\fR messages consists of -both the \fBsap\fR (type) and physical (Ethernet) components. -.sp -.LP -In addition to the mandatory connectionless \fBDLPI\fR message set the driver -additionally supports the following primitives. -.SS "hme Primitives" -.sp -.LP -The \fBDL_ENABMULTI_REQ\fR and \fBDL_DISABMULTI_REQ\fR primitives -enable/disable reception of individual multicast group addresses. A set of -multicast addresses may be iteratively created and modified on a per-stream -basis using these primitives. These primitives are accepted by the driver in -any state following \fBDL_ATTACHED.\fR -.sp -.LP -The \fBDL_PROMISCON_REQ\fR and \fBDL_PROMISCOFF_REQ\fR primitives with the -\fBDL_PROMISC_PHYS\fR flag set in the \fBdl_level\fR field enables/disables -reception of all ("promiscuous mode") frames on the media including frames -generated by the local host. When used with the \fBDL_PROMISC_SAP\fR flag set -this enables/disables reception of all \fBsap\fR (Ethernet type) values. When -used with the \fBDL_PROMISC_MULTI\fR flag set this enables/disables reception -of all multicast group addresses. The effect of each is always on a per-stream -basis and independent of the other \fBsap\fR and physical level configurations -on this stream or other streams. -.sp -.LP -The \fBDL_PHYS_ADDR_REQ\fR primitive returns the 6 octet Ethernet address -currently associated (attached) to the stream in the \fBDL_PHYS_ADDR_ACK\fR -primitive. This primitive is valid only in states following a successful -\fBDL_ATTACH_REQ.\fR -.sp -.LP -The \fBDL_SET_PHYS_ADDR_REQ\fR primitive changes the 6 octet Ethernet address -currently associated (attached) to this stream. The credentials of the process -which originally opened this stream must be superuser. Otherwise \fBEPERM\fR -is returned in the \fBDL_ERROR_ACK.\fR This primitive is destructive in that it -affects all other current and future streams attached to this device. An -\fBM_ERROR\fR is sent up all other streams attached to this device when this -primitive is successful on this stream. Once changed, all streams subsequently -opened and attached to this device will obtain this new physical address. Once -changed, the physical address will remain until this primitive is used to -change the physical address again or the system is rebooted, whichever comes -first. -.SS "hme DRIVER" -.sp -.LP -By default, the hme driver performs "auto-negotiation" to select the -\fBmode\fR and \fBspeed\fR of the link, when the Internal Transceiver is used. -.sp -.LP -When an External Transceiver is connected to the \fBMII\fR interface, the -driver selects the External Transceiver for networking operations. If the -External Transceiver supports "auto-negotiation", the driver uses the -auto-negotiation procedure to select the link speed and mode. If the External -Transceiver does not support auto-negotiation, it will select the highest -priority mode supported by the transceiver. -.RS +4 -.TP -.ie t \(bu -.el o -100 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -100 Mbps, half-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -10 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -10 Mbps, half-duplex -.RE -.sp -.LP -The link can be in one of the \fI4\fR following modes: -.sp -.LP -These speeds and modes are described in the 100Base-TX standard. -.sp -.LP -The \fIauto\(minegotiation\fR protocol automatically selects: -.RS +4 -.TP -.ie t \(bu -.el o -Operation mode (half-duplex or full-duplex) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Speed (100 Mbps or 10 Mbps) -.RE -.sp -.LP -The auto\(minegotiation protocol does the following: -.RS +4 -.TP -.ie t \(bu -.el o -Gets all the modes of operation supported by the Link Partner -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Advertises its capabilities to the Link Partner -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Selects the highest common denominator mode of operation based on the -priorities -.RE -.sp -.LP -The \fIinternal\fR \fItransceiver\fR is capable of all of the operating speeds -and modes listed above. When the internal transceiver is used, by -\fIdefault\fR, auto-negotiation is used to select the speed and the mode of the -link and the common mode of operation with the Link Partner. -.sp -.LP -When an \fIexternal\fR \fItransceiver\fR is connected to the \fBMII\fR -interface, the driver selects the external transceiver for networking -operations. If the external transceiver supports auto-negotiation: -.RS +4 -.TP -.ie t \(bu -.el o -The driver uses the auto-negotiation procedure to select the link speed and -mode. -.RE -.sp -.LP -If the external transceiver \fIdoes\fR \fInot\fR support auto-negotiation -.RS +4 -.TP -.ie t \(bu -.el o -The driver selects the highest priority mode supported by the transceiver. -.RE -.sp -.LP -Sometimes, the user may want to select the speed and mode of the link. The -\fBSUNW,hme\fR device supports programmable \fB"IPG"\fR (Inter-Packet Gap) -parameters \fBipg1\fR and \fBipg2\fR. By default, the driver sets \fBipg1\fR -to 8 \fBbyte-times\fR and \fBipg2\fR to 4 \fBbyte-times\fR (which are the -standard values). Sometimes, the user may want to alter these values depending -on whether the driver supports 10 Mbps or 100 Mbps and accordingly, \fBIPG\fR -will be set to 9.6 or 0.96 microseconds. -.SS "hme Parameter List" -.sp -.LP -The hme driver provides for setting and getting various parameters for the -\fBSUNW,hme\fR device. The parameter list includes: -.br -.in +2 -\fBcurrent transceiver status\fR -.in -2 -.br -.in +2 -\fBcurrent link status\fR -.in -2 -.br -.in +2 -\fBinter-packet gap\fR -.in -2 -.br -.in +2 -\fBlocal transceiver capabilities\fR -.in -2 -.br -.in +2 -\fBlink partner capabilities\fR -.in -2 -.sp -.LP -The local transceiver has two set of capabilities: one set reflects the -capabilities of the \fBhardware\fR, which are \fBread-only\fR \fB(RO)\fR -parameters and the second set reflects the values chosen by the user and is -used in \fBspeed selection\fR. There are \fBread/write\fR \fB(RW)\fR -capabilities. At boot time, these two sets of capabilities will be the same. -The Link Partner capabilities are also read only parameters because the current -default value of these parameters can only be read and cannot be modified. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/hme\fR\fR -.ad -.RS 24n -\fBhme\fR special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/hme.conf\fR\fR -.ad -.RS 24n -System-wide default device driver properties -.RE - -.SH SEE ALSO -.sp -.LP -\fBndd\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBdlpi\fR(7P) diff --git a/usr/src/man/man7d/hubd.7d b/usr/src/man/man7d/hubd.7d deleted file mode 100644 index 881272cadb..0000000000 --- a/usr/src/man/man7d/hubd.7d +++ /dev/null @@ -1,314 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 HUBD 7D "May 13, 2017" -.SH NAME -hubd \- USB hub driver -.SH SYNOPSIS -.LP -.nf -\fBhub@unit-address\fR -.fi - -.SH DESCRIPTION -.LP -The \fBhubd\fR is a USBA (illumos USB Architecture) compliant client driver -that supports USB hubs conforming to the \fIUniversal Serial Bus Specification -3.0\fR. The \fBhubd\fR driver supports bus-powered and self-powered hubs. The -driver supports hubs with individual port power, ganged power and no power -switching. -.sp -.LP -When a device is attached to a hub port, the \fBhubd\fR driver enumerates the -device by determining its type and assigning an address to it. For -multi-configuration devices, \fBhubd\fR sets the preferred configuration (refer -to \fBcfgadm_usb\fR(1M) to select a configuration). The \fBhubd\fR driver -attaches a driver to the device if one is available for the default or selected -configuration. When the device is disconnected from the hub port, the -\fBhubd\fR driver offlines any driver instance attached to the device. -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/hubd\fR\fR -.ad -.RS 28n -32- bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/hubd\fR\fR -.ad -.RS 28n -64- bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/hubd\fR\fR -.ad -.RS 28n -64-bit SPARC ELF kernel module -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBcfgadm_usb\fR(1M), \fBattributes\fR(5), \fBusba\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Serial Bus Specification 2.0\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH DIAGNOSTICS -.LP -In addition to being logged, the following messages may also appear on the -system console. Messages are formatted in the following manner: -.sp -.in +2 -.nf -WARNING: <device path> <hubd<instance number>): Message... -.fi -.in -2 -.sp - -.sp -.LP -where \fB<instance number>\fR is the instance number of \fBhubd\fR and -\fB<device path>\fR is the physical path to the device in \fB/devices\fR -directory. Messages from the root hub are displayed with a \fBusb<instance -number>\fR prefix instead of \fBhub<instance number>\fR as the root hub is an -integrated part of the host controller. -.sp -.ne 2 -.na -\fBConnecting device on port \fI<number>\fR failed.\fR -.ad -.sp .6 -.RS 4n -The driver failed to enumerate the device connected on port \fI<number>\fR of -hub. If enumeration fails, disconnect and re-connect. -.RE - -.sp -.ne 2 -.na -\fBUse of a USB 1.0 hub behind a high speed port may cause unexpected -failures.\fR -.ad -.sp .6 -.RS 4n -Devices connected to a USB 1.0 hub which are in turn connected to an external -USB 2.0 hub, may misbehave unexpectedly or suddenly go offline. This is due to -a documented incompatibility between USB 1.0 hubs and USB 2.0 hub Transaction -Translators. Please use only USB 2.0 or USB 1.1 hubs behind high-speed ports. -.RE - -.sp -.ne 2 -.na -\fBConnecting a high speed device to a non-high speed hub (port x) will result -in a loss of performance. Please connect the device to a high speed port to get -the maximum performance.\fR -.ad -.sp .6 -.RS 4n -USB 2.0 devices connected to USB 1.0 or 1.1 hubs cannot run at their highest -speed, even when the hub is in turn connected to a high-speed port. For best -performance, reconnect without going through a USB 1.0 or 1.1 hub. -.RE - -.sp -.ne 2 -.na -\fBCannot access <device>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -This hub has been disconnected because a device other than the original one has -been inserted. The driver informs you of this fact by displaying the name of -the original device. -.RE - -.sp -.ne 2 -.na -\fBPort <n> overcurrent. \fR -.ad -.sp .6 -.RS 4n -An overcurrent condition was detected. Please remove the device on this port. -.RE - -.sp -.ne 2 -.na -\fBDevices not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -Same condition as described above; however in this case, the driver is unable -to identify the original device with a name string. -.RE - -.sp -.ne 2 -.na -\fBHub driver supports max of \fI<n>\fR ports on hub. Hence, using the first -\fI<number of physical ports>\fR of \fI<n>\fR ports available.\fR -.ad -.sp .6 -.RS 4n -The current hub driver supports hubs that have \fI<n>\fR ports or less. A hub -with more than \fI<n>\fR ports has been plugged in. Only the first \fI<n>\fR -out of the total \fI<number of physical ports>\fR ports are usable. -.RE - -.sp -.ne 2 -.na -\fBHub global over current condition, please disconnect the devices connected -to the hub to clear the condition. You may need to re-connect the hub if the -ports do not work.\fR -.ad -.sp .6 -.RS 4n -An overcurrent condition was detected on the hub. This means that the -aggregate current being drawn by the devices on the downstream ports exceeds a -preset value. Refer to section 7.2.1.2 and 11.13 of the \fIUniversal Serial Bus -Specification 2.0\fR. If this message continues to display, you may need to -remove downstream devices to eliminate the problem. If any port does not work -after the overcurrent condition is cleared, re-connect the hub to re-enable the -ports. -.RE - -.sp -.ne 2 -.na -\fBRoot hub over current condition, please check your system to clear the -condition as soon as possible. You may need to reboot the system if the root -hub does not recover automatically.\fR -.ad -.sp .6 -.RS 4n -An overcurrent condition was detected on the root hub, indicating that -malfunctioning devices on the downstream ports are drawing too much current. -Please disconnect the problematic downstream devices to eliminate the problem. -If the root hub doesn't work after the overcurrent condition is cleared, you -may need to reboot the system. -.RE - -.sp -.LP -The following messages may be logged into the system log. They are formatted in -the following manner: -.sp -.in +2 -.nf -<device path><hubd<instance number>): message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBLocal power has been lost, please disconnect hub.\fR -.ad -.sp .6 -.RS 4n -A USB self-powered hub has lost external power. All USB devices connected -down-stream from this hub will cease to function. Disconnect the hub, plug in -the external power-supply and then plug in the hub again. -.RE - -.sp -.ne 2 -.na -\fBLocal power has been lost, the hub could draw <x> mA power from the USB -bus.\fR -.ad -.sp .6 -.RS 4n -A USB self/bus-powered hub has lost external power. Some USB devices connected -down-stream from this hub may cease to function. Disconnect the -external power-supply and then plug in the hub again. -.RE - -.sp -.ne 2 -.na -\fBTwo bus-powered hubs cannot be concatenated.\fR -.ad -.sp .6 -.RS 4n -A bus-powered hub was connected to a bus powered hub port. Please remove this -bus-powered hub and connect it to a self-powered hub or a root hub port. -.RE - -.sp -.ne 2 -.na -\fBConfiguration <n> for device <device> at port <m> exceeds power available -for this port. Please re-insert your device into another hub port which has -enough power.\fR -.ad -.sp .6 -.RS 4n -The device requires more power than is available on this port. -.RE - -.sp -.ne 2 -.na -\fBPort <\fIn\fR\fB> in over current condition, please check the attached device -to clear the condition. The system will try to recover the port, but if not -successful, you need to re-connect the hub or reboot the system to bring the -port back to work.\fR -.ad -.sp .6 -.RS 4n -An overcurrent condition was detected on port <\fIn\fR>. This means the device -connected to the port is drawing more current than the hub can supply. If this -message continues to display, please disconnect the device to eliminate the -problem. If the port doesn't work after the overcurrent condition is cleared, -please re-connect the hub or reboot the system to enable the port again. -.RE - -.sp -.ne 2 -.na -\fBUnable to attach USB 3.x hub <vendor> <device>. A maximum of 5 hubs -may be cascaded.\fR -.ad -.sp .6 -.RS 4n -USB 3.0 has an upper bound on the number of hubs that may be chained -together. If this limit is exceeded, a hub may not be detected or -attached. The hub will be functional if plugged into a different part of -the USB topology. To determine the depth of the hub, count the number of -devices between it and the host controller. -.RE diff --git a/usr/src/man/man7d/hxge.7d b/usr/src/man/man7d/hxge.7d deleted file mode 100644 index 2574c00391..0000000000 --- a/usr/src/man/man7d/hxge.7d +++ /dev/null @@ -1,201 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 HXGE 7D "June 20, 2021" -.SH NAME -hxge \- Sun Blade 10 Gigabit Ethernet network driver -.SH SYNOPSIS -.nf -/dev/hxge* -.fi - -.SH DESCRIPTION -The \fBhxge\fR Gigabit Ethernet driver is a multi-threaded, loadable, clonable, -GLD-based STREAMS driver supporting the Data Link Provider Interface, -\fBdlpi\fR(7P), on the Sun Blade Shared 10Gb Ethernet Interface. -.sp -.LP -The Shared PCI-Express 10 Gb networking interface provides network I/O -consolidation for up to six Constellation blades, with each blade seeing its -own portion of the network interface. -.sp -.LP -The \fBhxge\fR driver functions include chip initialization, frame transmit and -receive, flow classification, multicast and promiscuous support and error -recovery and reporting in the blade domain. -.SH APPLICATION PROGRAMMING INTERFACE -The cloning character-special device, \fB/dev/hxge\fR, is used to access Sun -Blade Shared 10Gb Ethernet Interface devices installed within the system. -.sp -.LP -The \fBhxge\fR driver is managed by the \fBdladm\fR(1M) command line utility, -which allows VLANs to be defined on top of \fBhxge\fR instances and for -\fBhxge\fR instances to be aggregated. See \fBdladm\fR(1M) for more details. -.sp -.LP -You must send an explicit DL_ATTACH_REQ message to associate the opened stream -with a particular device (PPA). The PPA ID is interpreted as an unsigned -integer data type and indicates the corresponding device instance (unit) -number. The driver returns an error (DL_ERROR_ACK) if the PPA field value does -not correspond to a valid device instance number for the system. The device is -initialized on first attach and de-initialized (stopped) at last detach -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to a -DL_INFO_REQ are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU is 1500 (ETHERMTU - defined in <\fBsys/ethernet.h\fR>). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -DLSAP address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is \fBDL_ETHER\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBSAP\fR length value is \fI-2\fR, meaning the physical address component is -followed immediately by a 2-byte \fBSAP\fR component within the \fBDLSAP\fR -address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is the Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.sp -Due to the nature of the link address definition for IPoIB, the -DL_SET_PHYS_ADDR_REQ DLPI primitive is not supported. -.sp -In the transmit case for streams that have been put in raw mode via the -DLIOCRAW ioctl, the \fBdlpi\fR application must prepend the 20 byte IPoIB -destination address to the data it wants to transmit over-the-wire. In the -receive case, applications receive the IP/ARP datagram along with the IETF -defined 4 byte header. -.RE -.sp -.LP -Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a -particular Service Access Point (SAP) with the stream. -.SH CONFIGURATION -The link speed and mode are fixed at 10 Gbps full-duplex. -.sp -.LP -The default MTU is 1500. To enable jumbo frame support, you configure the -\fBhxge\fR driver by defining the accept-jumbo property to 1 in the -\fBhxge.conf\fR file. Note that the largest jumbo size is 9178 bytes. -.sp -.LP -The driver may be configured to discard certain classes of traffic. By default, -no class of traffic is allowed. You configure the \fBhxge\fR driver by defining -the class option property to 0x20000 in \fBhxge.conf\fR to discard the -specified class of traffic. For example, the following line in \fBhxge.conf\fR -discards all IP Version 4 TCP traffic: -.sp -.in +2 -.nf -class-opt-ipv4-tcp = 0x20000; -.fi -.in -2 - -.sp -.LP -You can also use the \fBndd\fR(1M) command to configure the \fBhxge\fR driver -at runtime to discard any classes of traffic. -.sp -.LP -The \fBhxge\fR driver supports self-healing functionality, see \fBfmd\fR(1M). By -default it is configured to DDI_FM_EREPORT_CAPABLE | DDI_FM_ERRCB_CAPABLE. -You configure the \fBhxge\fR driver by defining the fm-capable property in -\fBhxge.conf\fR to other capabilities or to 0x0 to disable it entirely. -.sp -.LP -The \fBhxge\fR driver may be configured using the standard \fBifconfig\fR(1M) -command. -.sp -.LP -The \fBhxge\fR driver also reports various hardware and software statistics -data. You can view these statistics using the \fBkstat\fR(1M) command. -.SH FILES -.ne 2 -.na -\fB\fB/dev/hxge*\fR\fR -.ad -.RS 28n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/hxge\fR\fR -.ad -.RS 28n -64-bit device driver (SPARC). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/hxge\fR\fR -.ad -.RS 28n -64-bit device driver (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/hxge.conf\fR\fR -.ad -.RS 28n -Configuration file. -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -\fBdladm\fR(1M), \fBfmd\fR(1M), \fBifconfig\fR(1M), \fBkstat\fR(1M), -\fBndd\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), -\fBstreamio\fR(7I), \fBdlpi\fR(7P) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR diff --git a/usr/src/man/man7d/i40e.7d b/usr/src/man/man7d/i40e.7d deleted file mode 100644 index 2bb840c2d7..0000000000 --- a/usr/src/man/man7d/i40e.7d +++ /dev/null @@ -1,335 +0,0 @@ -.\" -.\" 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 (c) 2018 Joyent, Inc. -.\" Copyright 2020 Ryan Zezeski -.\" Copyright 2021 Oxide Computer Company -.\" -.Dd January 18, 2021 -.Dt I40E 7D -.Os -.Sh NAME -.Nm i40e -.Nd Intel 710/722 Ethernet Device Driver -.Sh SYNOPSIS -.Pa /dev/net/i40e* -.Sh DESCRIPTION -The -.Nm -driver is a GLDv3, multi-threaded, clonable, loadable device driver that -supports the Data Link Provider Interface, -.Xr dlpi 7P . -The -.Nm -driver supports the Intel 710 and 722 Ethernet Controller families of -networking interface cards which support speeds of 1 GbE, 2.5 GbE, 5 GbE, 10 -GbE, 25 GbE, and 40 GbE. -.Pp -In addition to basic device initialization and the sending and receiving -of frames, it supports the following features: -.Bl -dash -offset indent -.It -Jumbo frames up to 9710 bytes. -.It -Promiscuous access via -.Xr snoop 1M and -.Xr dlpi 7P -.It -IPv4 Checksum Offload -.It -TCP, UDP, and SCTP checksum offload -.It -IPv4 and IPv6 TCP Segmentation offload -.El -.Pp -At this time, the -.Nm -driver does not enable the use of energy efficient Ethernet (EEE) or -support the use of flow control through hardware pause frames. -.Sh APPLICATION PROGRAMMING INTERFACE -For each device supported by the -.Nm -installed in the system, a character-special file will be created. -This file supports the Data Link Provider Interface (DLPI) which is documented -in -.Xr dlpi 7P . -For most consumers, the use of -.Xr libdlpi 3LIB , -is recommended. -.Pp -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 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 -named -.Sy i40e0 . -It exists in the file system at -.Pa /dev/net/i40e0 . -.Sh CONFIGURATION -The -.Nm i40e -driver always performs auto-negotiation and depending on the model may -negotiate to 40 Gbps, 25 Gbps, 10 Gbps, or 1 Gbps. -At this time, the driver requires the use of auto-negotiation. -.Pp -The -.Nm -driver is managed by the -.Xr dladm 1M -utility. -.Xr dladm 1M -is the preferred interface for setting all properties. -While -.Xr driver.conf 4 -based configuration is possible, -.Xr dladm 1M -is recommended. -The -.Nm -driver may be joined into an aggregation based on the link aggregation -control protocol (LACP) through -.Xr dladm 1M . -.Sh PROPERTIES -The device supports the following properties which may be tuned through -its driver.conf file, -.Pa /kernel/drv/i40e.conf . -Most of these properties cannot be changed after the device has been started. -The device is started in response to a DLPI consumer opening the device and -binding to it. -This happens when an IP interfaces is plumbed or another -.Xr dlpi 7P -consumer such as -.Xr snoop 1M -or an LLDP daemon is started. -.Pp -Some properties may be tuned at runtime with the -.Xr dladm 1M -utility. -Properties that can be will have the name of the dladm property called out -explicitly. -.Pp -These properties are not considered stable at this time. -They may change and should not be relied on. -They are considered -.Sy Volatile . -It is not expected that administrators of the system will have to tune -these values. -.Bl -hang -width Ds -.It Sy default_mtu -.Bd -filled -compact -Minimum: -.Sy 1500 | -Maximum: -.Sy 9710 | -Runtime Property: -.Sy mtu -.Ed -.Bd -filled -The -.Sy default_mtu -property determines the starting MTU of the various device instances. -Note that the device's MTU also determines the upper bound of the MTU of -all VNICs created over the device. -The default MTU is -.Sy 1500 . -.Ed -.It Sy mr_enable -.Bd -filled -compact -Minimum: -.Sy 0 | -Maximum: -.Sy 1 -.Ed -.Bd -filled -The -.Sy mr_enable -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. -.Ed -.It Sy rx_num_groups -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy 32 -.Ed -.Bd -filled -The -.Sy rx_num_groups -property determines the number of receive mac groups provided by the driver. -Each group can handle all unicast traffic for a single MAC address, more groups -means more unicast traffic that can be steered by hardware. -However, more groups also means more demand for kernel memory. -If you are not making heavy use of VNICs, or do not need the efficiency gains -of hardware steering, then reducing this number can reduce kernel memory -taken by -.Nm i40e. -.Ed -.It Sy rx_ring_size -.Bd -filled -compact -Minimum: -.Sy 64 | -Maximum: -.Sy 4096 -.Ed -.Bd -filled -The -.Sy rx_ring_size -property determines the number of descriptors that will be used in each -receive ring on the card. -Administrators should not normally need to tune this value. -Hardware requires that the ring size be a multiple of 32. -The system will round up the set value to the nearest multiple of 32. -.Ed -.It Sy tx_ring_size -.Bd -filled -compact -Minimum: -.Sy 64 | -Maximum: -.Sy 4096 -.Ed -.Bd -filled -The -.Sy tx_ring_size -property determines the number of descriptors that will be used in each -transmit ring on the card. -Administrators should not normally need to tune this value. -Hardware requires that the ring size be a multiple of 32. -The system will round up the set value to the nearest multiple of 32. -.Ed -.It Sy tx_resched_threshold -.Bd -filled -compact -Minimum: -.Sy 8 | -Maximum: -.Sy Variable -.Ed -.Bd -filled -The -.Sy tx_resched_threshold -property determines the number of descriptors that must be available for -a frame to be transmitted. -The maximum is variable. -It is dependent on the value of the -.Sy tx_ring_size -property. -At least eight descriptors must be available for the device to function -correctly. -.Ed -.It Sy rx_limit_per_intr -.Bd -filled -compact -Minimum: -.Sy 16 | -Maximum: -.Sy 4096 -.Ed -.Bd -filled -The -.Sy rx_limit_per_intr -property determines the maximum number of packets that will be processed -on a given ring during a single interrupt. -This is done to try and guarantee some amount of liveness in the system. -It is not expected that administrators will have to tune this value. -.Ed -.It Sy tx_hcksum_enable -.Bd -filled -compact -Minimum: -.Sy 0 | -Maximum: -.Sy 1 -.Ed -.Bd -filled -The -.Sy tx_hcksum_enable -property controls whether or not the device enables support for hardware -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. -.Ed -.It Sy rx_hcksum_enable -.Bd -filled -compact -Minimum: -.Sy 0 | -Maximum: -.Sy 1 -.Ed -.Bd -filled -The -.Sy rx_hcksum_enable -property controls whether or not the device enables support for hardware -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. -.Ed -.It Sy rx_dma_threshold -.Bd -filled -compact -Minimum: -.Sy 0 | -Maximum: -.Sy INT32_MAX | -Runtime Property: -.Sy _rx_dma_threshold -.Ed -.Bd -filled -The -.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. -By setting this property to its minimum, all frames will be processed with DMA -binding. -By setting this property to its maximum, all frames will be processed by copying -the frame. -.Ed -.It Sy tx_lso_enable -.Bd -filled -compact -Minimum: -.Sy 0 | -Maximum: -.Sy 1 -.Ed -.Bd -filled -The -.Sy tx_lso_enable -property controls whether or not the device enables support for Large Segment -Offloand (LSO) when transmitting packets. -The default is to always enable support for this. -Turning it off will decrease throughput when transmitting packets, but should -be done if a hardware bug is suspected. -.Ed -.El -.Sh ARCHITECTURE -The -.Nm -driver is only supported on -.Sy x86 -systems at this time. -.Sh FILES -.Bl -tag -width Pa -.It Pa /dev/net/i40e* -Per-instance character device. -.It Pa /kernel/drv/amd64/i40e -Device driver (x86) -.It Pa /kernel/drv/i40e.conf -Driver configuration file -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr snoop 1M , -.Xr driver.conf 4 , -.Xr dlpi 7P diff --git a/usr/src/man/man7d/ib.7d b/usr/src/man/man7d/ib.7d deleted file mode 100644 index 2fe714dac0..0000000000 --- a/usr/src/man/man7d/ib.7d +++ /dev/null @@ -1,284 +0,0 @@ -'\" te -.\" 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 IB 7D "Jan 26, 2009" -.SH NAME -ib \- InfiniBand Bus Nexus Driver -.SH DESCRIPTION -.sp -.LP -The \fBib\fR (IB nexus) driver is a pseudo nexus driver that supports -enumeration of port devices, VPPA (Virtual Physical Point Attachment), HCA_SVC -(HCA Service) devices, and I/O controllers (IOC) on the InfiniBand fabric that -are visible to the host and provides interfaces to \fBcfgadm_ib\fR(1M) to -manage hot-plugging of IB devices. The \fBib\fR nexus driver enumerates the -port device, VPPA devices and HCA_SVC devices based on entries specified in the -\fBib.conf\fR file. IOC devices are enumerated on demand. The IB nexus driver -uses InfiniBand Device Manager services (\fBibdm\fR(7D)) to enumerate port -devices, VPPA devices, HCA_SVC devices, and IOCs on the IB fabric. -.SH CONFIGURATION -.sp -.LP -You configure the \fBib\fR driver by defining properties in the \fBib.conf\fR -file. The IB nexus driver supports the following properties: -.sp - -.sp -.TS -box; -l | l | l -l | l | l . -PROPERTY NAME DEFAULT POSSIBLE VALUES -_ -port-svc-list \fB""\fR T{ -List of service names, for example: srv -T} -_ -vppa-svc-list \fB""\fR List of service names, for example: ipib -_ -hca-svc-list \fB""\fR T{ -List of service names, for example: hca_nfs -T} -.TE - -.sp -.LP -The \fBport-svc-list\fR property defines the list of port communication service -names per port. The IB nexus driver creates a device instance for each entry in -this property per Host Channel Adapter (\fBHCA\fR) port. The \fBib.conf\fR file -contains a \fBport-svc-list=""\fR entry by default. You update -\fBport-svc-list\fR with service names you want to add to the system. -.sp -.LP -The \fBvppa-svc-list\fR property defines the list of \fBVPPA\fR communication -service names per port per partition key. The IB nexus driver creates a device -instance for each entry in this property per Host Channel Adapter (\fBHCA\fR) -port. The \fBib.conf\fR file contains a \fBvppa-svc-list=""\fR entry by -default. You update \fBvppa-svc-list\fR with service names you want to add to -the system. -.sp -.LP -The \fBhca-svc-list\fR property defines the list of HCA_SVC communication -service names per HCA. The IB nexus driver creates a device instance for each -entry in this property per Host Channel Adapter (HCA). The \fBib.conf\fR file -contains a \fBhca-svc-list=""\fR entry by default. You update -\fBhca-svc-list\fR with service names you want to add to the system. -.sp -.LP -The service name specified in \fBport-svc-list\fR, \fBvppa-svc-list\fR and -\fBhca-svc-list\fR must be unique, be a maximum of four characters long, and -is limited to digits 0-9 and letters a-z and A-Z. -.sp -.LP -IOC drivers (which are parented by the IB nexus driver) may themselves -have .conf files. To distinguish those cases from pseudo drivers parented by IB -nexus, such drivers should include the \fB"ib-node-type"\fR property with value -\fBmerge\fR in the IOC \fBdriver.conf\fR file. That property ensures that -properties from the .conf file are merged with other properties found through -hardware probing. -.SH EXAMPLES -.sp -.LP -Example 1: A sample \fBib.conf\fR file with one service name entry for PORT -communication services. -.sp -.in +2 -.nf - # - # Copyright 2001-2003 Sun Microsystems, Inc. All rights reserved. - # Use is subject to license terms. - # - port-svc-list="" - vppa-svc-list=""; - hca-svc-list=""; -.fi -.in -2 - -.sp -.LP -In Example 1, the IB nexus driver does not create any port/vppa/hca_svc device -instances. -.sp -.LP -Example 2: A sample \fBib.conf\fR file with one entry for \fB"srv"\fR service: -.sp -.in +2 -.nf - - port-svc-list="srv" - vppa-svc-list=""; - hca-svc-list=""; -.fi -.in -2 - -.sp -.LP -The IB nexus driver creates one \fBsrv\fR service instance for every \fBHCA\fR -port that exists on the host. For example, if there are two \fBHCA\fRs, each -with two ports on the host, the IB nexus driver creates four instances of the -\fBsrv\fR service. -.sp -.LP -Example 3: A sample \fBib.conf\fR file with one service name entry for -each of Port and VPPA communication services: -.sp -.in +2 -.nf - - port-svc-list="srv" - vppa-svc-list="ipib"; - hca-svc-list=""; -.fi -.in -2 - -.sp -.LP -If there are two \fBHCA\fRs in the system with two ports each and each port has -two valid PKEY values, the IB nexus driver creates four instances of srv -service (one for each port). It also creates eight instances of \fBipd\fR -service (one per each port/PKEY combination). -.sp -.LP -Example 4: A sample \fBib.conf\fR file with one service name entry for each -of Port, VPPA and HCA_SVC communication services: -.sp -.in +2 -.nf - - port-svc-list="srv"; - vppa-svc-list="ipib"; - hca-svc-list="hca_nfs"; -.fi -.in -2 - -.sp -.LP -The IB nexus driver creates one instance of hca_nfs service for each HCA in the -system. -.sp -.LP -Example 5: IOC \fBdriver .conf\fR -.sp -.in +2 -.nf - ib-node-type="merge"; - enable-special-mode="on"; -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ib\fR\fR -.ad -.RS 26n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ib\fR\fR -.ad -.RS 26n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/ib\fR\fR -.ad -.RS 26n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ib.conf\fR\fR -.ad -.RS 26n -driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attribute: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -_ -Interface Stability Consolidation Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBcfgadm_ib\fR(1M), \fBdriver.conf\fR(4), \fBib\fR(4), \fBattributes\fR(5), -\fBibcm\fR(7D), \fBibdm\fR(7D), \fBibtl\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIInfiniBand Architecture Specification, Volume 1: Release 1.1\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -ib: WARNING: Error message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBunit-address property in \fB%s.conf\fR not well-formed.\fR -.ad -.sp .6 -.RS 4n -The \fBdriver.conf\fR file does not have a valid \fB"unit-addr"\fR property -defined. This property is an array of strings. -.RE - -.sp -.ne 2 -.na -\fBcannot find unit-address in \fB%s.conf\fR.\fR -.ad -.sp .6 -.RS 4n -The \fBdriver.conf\fR file does not have a valid \fB"unit-addr"\fR property -defined. This property is an array of strings. -.RE - -.sp -.ne 2 -.na -\fBWaiting for Port %d initialization.\fR -.ad -.sp .6 -.RS 4n -Waiting for port initialization from subnet manager. -.RE - diff --git a/usr/src/man/man7d/ibcm.7d b/usr/src/man/man7d/ibcm.7d deleted file mode 100644 index 3f0c57dab6..0000000000 --- a/usr/src/man/man7d/ibcm.7d +++ /dev/null @@ -1,74 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 IBCM 7D "Apr 2, 2004" -.SH NAME -ibcm \- Solaris InfiniBand Communication Manager -.SH DESCRIPTION -.sp -.LP -The Solaris InfiniBand Communication Manager (\fBIBCM\fR) is a Solaris kernel -misc module that adheres to the \fIInfiniBand Architecture Specification, -Volume 1: Release 1.1\fR for InfiniBand Communication Management Class. -.sp -.LP -\fBIBCM\fR provides a transport layer abstraction to IB clients to set up -reliable connected channels along with service, multicast, and path -lookup-related functionality. \fBIBCM\fR implements the CM protocol as per the -\fIInfiniBand Architecture Specification, Volume 1: Release 1.1\fR and utilizes -the InfiniBand Management Framework module for all IB management-related -functionality and the InfiniBand Transport Layer (see \fBibtl\fR(7D)) for all -IB Verbs-related functionality. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/misc/ibcm\fR\fR -.ad -.RS 29n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/ibcm\fR\fR -.ad -.RS 29n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/sparcv9/ibcm\fR\fR -.ad -.RS 29n -64-bit SPARC ELF kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attribute: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Consolidation Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBibtl\fR(7D) -.sp -.LP -\fIInfiniBand Architecture Specification, Volume 1: Release 1.1\fR diff --git a/usr/src/man/man7d/ibd.7d b/usr/src/man/man7d/ibd.7d deleted file mode 100644 index 90350ac5c9..0000000000 --- a/usr/src/man/man7d/ibd.7d +++ /dev/null @@ -1,254 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH IBD 7D "April 9, 2016" -.SH NAME -ibd \- Infiniband IPoIB device driver -.SH SYNOPSIS -.LP -.nf -\fB/dev/ibd*\fR -.fi - -.SH DESCRIPTION -.LP -The \fBibd\fR driver implements the IETF IP over Infiniband protocol and -provides IPoIB service for all IBA ports present in the system. -.sp -.LP -The \fBibd\fR driver is a multi-threaded, loadable, clonable, STREAMS hardware -driver supporting the connectionless Data Link Provider Interface, -\fBdlpi\fR(7P)). The \fBibd\fR driver provides basic support for the IBA -Unreliable Datagram Queue Pair hardware. Functions include QP initialization, -frame transmit and receive, multicast and promiscuous mode support, and -statistics reporting. -.sp -.LP -Use the cloning, character-special device \fB/dev/ibd\fR to access all -\fBibd\fR devices installed within the system. -.sp -.LP -The \fBibd\fR driver is dependent on GLD, a loadable kernel module that -provides the \fBibd\fR driver with the DLPI and STREAMS functionality required -of a LAN driver. Except as noted in the Application Programming Interface -section of this manpage, see \fBgld\fR(7D) for more details on the primitives -supported by the driver. The GLD module is located at -\fB/kernel/misc/sparcv9/gld\fR on 64 bit systems and at \fB/kernel/misc/gld\fR -on 32 bit systems. -.sp -.LP -The \fBibd\fR driver expects certain configuration of the IBA fabric prior to -operation (which also implies the SM must be active and managing the fabric). -Specifically, the IBA multicast group representing the IPv4 limited broadcast -address 255.255.255.255 (also defined as broadcast-GID in IETF documents) must -be created prior to initializing the device. IBA properties (including mtu, -qkey and sl) of this group is used by the driver to create any other IBA -multicast group as instructed by higher level (IP) software. The driver probes -for the existence of this broadcast-GID during \fBattach\fR(9E). -.SH APPLICATION PROGRAMMING INTERFACE (DLPI) -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to -your DL_INFO_REQ are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU is the MTU associated with the broadcast-GID group, less the 4 byte -IPoIB header. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -dlsap address length is 22. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is DL_IB. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The sap length value is -2, meaning the physical address component is followed -immediately by a 2-byte sap component within the DLSAP address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is the MAC address consisting of the 4 bytes of QPN -00:FF:FF:FF prepended to the IBA multicast address of the broadcast-GID. -.sp -Due to the nature of link address definition for IPoIB, the -DL_SET_PHYS_ADDR_REQ DLPI primitive is not supported. -.sp -In the transmit case for streams that have been put in raw mode via the -DLIOCRAW ioctl, the DLPI application must prepend the 20 byte IPoIB destination -address to the data it wants to transmit over-the-wire. In the receive case, -applications receive the IP/ARP datagram along with the IETF defined 4 byte -header. -.RE -.SH WARNING -.LP -This section describes warning messages that might be generated by the driver. -Please note that while the format of these messages may be modified in future -versions, the same general information will be provided. -.sp -.LP -While joining IBA multicast groups corresponding to IP multicast groups as part -of multicast promiscuous operations as required by IP multicast routers, or as -part of running \fBsnoop\fR(1M), it is possible that joins to some multicast -groups can fail due to inherent resource constraints in the IBA components. In -such cases, warning message similar to the following appear in the system log, -indicating the interface on which the failure occurred: -.sp -.in +2 -.nf -NOTICE: ibd0: Could not get list of IBA multicast groups -NOTICE: ibd0: IBA promiscuous mode missed multicast group -NOTICE: ibd0: IBA promiscuous mode missed new multicast gid -.fi -.in -2 - -.sp -.LP -Also, if the IBA SM indicates that multicast trap support is suspended or -unavailable, the system log contains a message similar to: -.sp -.in +2 -.nf -NOTICE: ibd0: IBA multicast support degraded due to -unavailability of multicast traps -.fi -.in -2 - -.sp -.LP -And when the SM indicates trap support is restored: -.sp -.in +2 -.nf -NOTICE: ibd0: IBA multicast support restored due to -availability of multicast traps -.fi -.in -2 - -.sp -.LP -Additionally, if the IBA link transitions to an unavailable state (that is, the -IBA link state becomes "Down," "Initialize" or "Armed") and then becomes active -again, the driver tries to rejoin previously joined groups if required. Failure -to rejoin multicast groups will trigger messages like: -.sp -.in +2 -.nf -NOTICE: ibd0: Failure on port up to rejoin multicast gid -.fi -.in -2 - -.sp -.LP -If the corresponding HCA port is in the unavailable state defined above when -initializing an ibd interface using \fBifconfig\fR(1M), a message is emitted by -the driver: -.sp -.in +2 -.nf -NOTICE: ibd0: Port is not active -.fi -.in -2 - -.sp -.LP -Further, as described above, if the broadcast-GID is not found, or the -associated MTU is higher than what the HCA port can support, the following -messages are printed to the system log: -.sp -.in +2 -.nf -NOTICE: ibd0: IPoIB broadcast group absent -NOTICE: ibd0: IPoIB broadcast group MTU 4096 greater than port's -maximum MTU 2048 -.fi -.in -2 - -.sp -.LP -In all cases of these reported problems when running \fBifconfig\fR(1M), it -should be checked that IBA cabling is intact, an SM is running on the fabric, -and the broadcast-GID with appropriate properties has been created in the IBA -partition. -.SH CONFIGURATION -.LP -The IPoIB service comes preconfigured on all HCA ports in the system. To turn -the service off, or back on after turning it off, refer to documentation in -\fBcfgadm_ib(1M)\fR. -.SH FILES -.ne 2 -.na -\fB\fB/dev/ibd*\fR\fR -.ad -.RS 27n -special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ib.conf\fR\fR -.ad -.RS 27n -configuration file to start IPoIB service -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/ibd\fR\fR -.ad -.RS 27n -64-bit SPARC device driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ibd\fR\fR -.ad -.RS 27n -64-bit x86 device driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ibd\fR\fR -.ad -.RS 27n -32-bit x86 device driver -.RE - -.SH SEE ALSO -.LP -\fBcfgadm\fR(1M), \fBcfgadm_ib(1M)\fR, \fBifconfig\fR(1M), \fBsyslogd\fR(1M), -\fBgld\fR(7D), \fBib\fR(7D), \fBkstat\fR(7D), \fBstreamio\fR(7I), -\fBdlpi\fR(7P), \fBattributes\fR(5), \fBattach\fR(9E) -.SH NOTES -.LP -IBD is a GLD-based driver and provides the statistics described by -\fBgld\fR(7D). Note that valid received packets not accepted by any stream -(long) will increase when IBD transmits broadcast IP packets. This happens -because the infiniband hardware copies and loops back the transmitted broadcast -packets to the source. These packets are discarded by GLD and are recorded -as 'unknowns'. diff --git a/usr/src/man/man7d/ibdm.7d b/usr/src/man/man7d/ibdm.7d deleted file mode 100644 index 84ce1b3e09..0000000000 --- a/usr/src/man/man7d/ibdm.7d +++ /dev/null @@ -1,73 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 IBDM 7D "Oct 9, 2004" -.SH NAME -ibdm \- Solaris InfiniBand Device Manager -.SH DESCRIPTION -.sp -.LP -The Infiniband Device Manager (\fBIBDM\fR) is an IBTF-compliant kernel misc -module. \fBIBDM\fR adheres to the InfiniBand Device Management class as -described in \fIInfiniBand Architecture Specification, Volume 1: Release 1.1\fR -and enumerates all the devices which are visible from a given host and -maintains a data base of all IB devices visible to the host. \fBIBDM\fR -provides interfaces to the IB nexus driver that enables the driver to retrieve -information about IB devices on the fabric. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/misc/ibdm\fR\fR -.ad -.RS 29n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/ibdm\fR\fR -.ad -.RS 29n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/sparcv9/ibdm\fR\fR -.ad -.RS 29n -64-bit SPARC ELF kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attribute: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Contract Consolidation Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBib\fR(7D), \fBibtl\fR(7D), \fBibcm\fR(7D) -.sp -.LP -\fIInfiniBand Architecture Specification, Volume 1: Release 1.1\fR -.SH DIAGNOSTICS -.sp -.LP -None. diff --git a/usr/src/man/man7d/ibdma.7d b/usr/src/man/man7d/ibdma.7d deleted file mode 100644 index 7bc7185aeb..0000000000 --- a/usr/src/man/man7d/ibdma.7d +++ /dev/null @@ -1,60 +0,0 @@ -'\" te -.\" 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 IBDMA 7D "May 21, 2009" -.SH NAME -ibdma \- Solaris InfiniBand Device Manager Agent -.SH DESCRIPTION -.sp -.LP -The Infiniband Device Manager Agent (\fBibdma\fR) is an IBTF-compliant kernel -misc module. -.sp -.LP -\fBIBDMA\fR implements limited portions of the target (agent) side of the -InfiniBand Device Management class as described in \fIInfiniBand Architecture -Specification, Volume 1: Release 1.2.1\fR. -.sp -.LP -\fBIBDMA\fR responds to incoming Device Management Datagrams (MADS) by -enumerating available target-side Infiniband services. Initiator systems can -use this service to discover target-side resources such as the virtual I/O -Controllers exported by \fBsrpt\fR(7D). -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/misc/ibdma\fR\fR -.ad -.RS 30n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/ibdma\fR\fR -.ad -.RS 30n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/sparcv9/ibdma\fR\fR -.ad -.RS 30n -64-bit SPARC ELF kernel module -.RE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBib\fR(7D), \fBibdm\fR(7D), \fBibtl\fR(7D), -\fBsrpt\fR(7D) -.sp -.LP -\fIInfiniBand Architecture Specification, Volume 1: Release 1.2.1\fR diff --git a/usr/src/man/man7d/ibtl.7d b/usr/src/man/man7d/ibtl.7d deleted file mode 100644 index 7ebdd6ae6e..0000000000 --- a/usr/src/man/man7d/ibtl.7d +++ /dev/null @@ -1,83 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 IBTL 7D "Oct 9, 2004" -.SH NAME -ibtl \- Solaris InfiniBand Transport Layer -.SH DESCRIPTION -.sp -.LP -InfiniBand (\fBIB\fR) is an I/O technology based on switched fabrics. The -Solaris InfiniBand Transport Layer (\fBIBTL\fR) is a Solaris kernel misc module -and adheres to the \fIIB Architecture Version 1.1\fR specification and provides -a transport layer abstraction to \fBIB\fR client drivers. -.sp -.LP -\fBIBTL\fR implements the programming interfaces for the Solaris InfiniBand -Transport Framework (\fBIBTF\fR), consisting of the IB Channel Interface (CI) -and the IB Transport Interface (TI). -.sp -.LP -The CI consists of Host Channel Adapters (HCAs) and HCA drivers. A host is -attached to the IB fabric through the CI layer. The Solaris InfiniBand CI is -Sun's API rendering of the InfiniBand Architecture (IBTA) "verbs" -specification. -.sp -.LP -The Solaris InfiniBand TI is the kernel service driver interface into the -Solaris InfiniBand Transport Framework. It provides transport and -communications setup programming interfaces for Unreliable Datagram (UD) and -Reliable Connected (RC) transport types only. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/misc/ibtl\fR\fR -.ad -.RS 29n -32-bit x86 ELF kernel misc module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/ibtl\fR\fR -.ad -.RS 29n -64-bit x86 ELF kernel misc module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/sparcv9/ibtl\fR\fR -.ad -.RS 29n -64-bit SPARC ELF kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attribute: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Consolidation Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBib\fR(7D), \fBibcm\fR(7D), \fBibdm\fR(7D) -.sp -.LP -\fIInfiniBand Architecture Specification, Volume 1: Release 1.1\fR diff --git a/usr/src/man/man7d/ieee1394.7d b/usr/src/man/man7d/ieee1394.7d deleted file mode 100644 index 07cf605b11..0000000000 --- a/usr/src/man/man7d/ieee1394.7d +++ /dev/null @@ -1,105 +0,0 @@ -'\" 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 "Jan 10, 2020" -.SH NAME -ieee1394, firewire, 1394 \- illumos IEEE-1394 Architecture -.SH DESCRIPTION -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 IEEE-1394, refer to the -1394 Trade Association website at http://\fIwww.1394ta.org\fR. -.sp -.LP -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 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 -.LP -IEEE-1394 host controllers implementing the 1394 Open Host Controller Interface -specification are supported. Camcorders implementing the \fIIEC 61883\fR -and 1394 Trade Association AV/C specifications are supported. Mass-storage -devices implementing the \fIANSI SBP-2\fR specification are supported. Digital -cameras implementing the 1394 Trade Association 1394-based Digital Camera -(IIDC) specification are supported. -.SH FILES -Listed below are drivers and modules which either utilize or are utilized by -the illumos IEEE-1394 architecture. -.sp - -.sp -.TS -box; -c | c -l | l . -SUPPORT MODULE(S) FUNCTION -_ -/kernel/misc/[sparcv9|amd64]/s1394 IEEE-1394 framework -_ -/kernel/misc/[sparcv9|amd64]/sbp2 Serial Bus Protocol-2 (SBP-2) -.TE - -.sp - -.sp -.TS -box; -c | c -l | l . -TARGET DRIVER DEVICE CLASS -_ -/kernel/drv/[sparcv9|amd64]/scsa1394 mass storage class -_ -/kernel/drv/[sparcv9|amd64]/av1394 camcorder (AV/C) class -_ -/kernel/drv/[sparcv9|amd64]/dcam1394 digital camera (IIDC) class -.TE - -.sp - -.sp -.TS -box; -c | c -l | l . -HOST CONTROLLER INTERFACE DRIVER(S) DEVICE -_ -/kernel/drv/[sparcv9|amd64]/hci1394 Open HCI -.TE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PCI-based systems -.TE - -.SH SEE ALSO -\fBattributes\fR(5), \fBav1394\fR(7D), \fBdcam1394\fR(7D), \fBhci1394\fR(7D), -\fBscsa1394\fR(7D), \fBiec61883\fR(7I) -.sp -.LP -\fIIEEE 1394a\fR Specification - 1394 Trade Association, 2000 -.sp -.LP -\fIIEEE 1394\fR Specification - 1394 Trade Association, 1995 -.SH NOTES -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/igb.7d b/usr/src/man/man7d/igb.7d deleted file mode 100644 index de03b084aa..0000000000 --- a/usr/src/man/man7d/igb.7d +++ /dev/null @@ -1,126 +0,0 @@ -.\" -.\" 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 2020 Oxide Computer Company -.\" -.Dd September 14, 2020 -.Dt IGB 7D -.Os -.Sh NAME -.Nm igb -.Nd Intel 1 GbE Server NIC Driver -.Sh SYNOPSIS -.Pa /dev/net/igb* -.Sh DESCRIPTION -The -.Nm -driver is a GLDv3 NIC driver for Intel 1 Gigabit Ethernet PCIe -controllers which are built-in to motherboards and discrete PCIe -devices. -.Pp -The driver supports the following device families: -.Bl -dash -.It -Intel 82575 Gigabit Ethernet Controller -.It -Intel 82576 Gigabit Ethernet Controller -.It -Intel 82580 Gigabit Ethernet Controller -.It -Intel Ethernet Controller I210 -.It -Intel Ethernet Controller I211 -.It -Intel Ethernet Controller I350 -.El -.Pp -Many other Intel 1 GbE devices are supported by the -.Xr e1000g 7D -driver. -.Pp -The driver supports the following functionality depending on the -controller generation: -.Bl -dash -.It -Jumbo frames up to 9000 bytes. -.It -Checksum offload for TCP and UDP on IPv4 and IPv6. -Checksum offload for IPv4 headers. -.It -TCP Segmentation Offload -.Pq TSO -over IPv4 and IPv6. -.It -Support for multiple hardware rings, enabling receive-side steering -.Pq RSS -and multiple MAC address filters. -.It -Promiscuous access via -.Xr snoop 1M -and -.Xr dlpi 7P . -.It -LED control. -.It -Link auto-negotiation, manual link controls, and IEEE 802.3x flow -control. -.El -.Sh APPLICATION PROGRAMMING INTERFACE -For each supported device instance, which corresponds to a port, a -character-special file is created. -This device can be used with the Data Link Provider Interface -.Pq DLPI -through either -.Xr libdlpi 3LIB -or -.Xr dlpi 7P . -.Pp -Each instance is assigned a unique ascending integer identifier starting -from zero. -The first instance in the system would be enumerated with the id 0 and -be named -.Sy igb0 -and be found in the file system at -.Pa /dev/net/igb0 . -.Sh CONFIGURATION -The -.Nm -driver supports operating at 1 Gbps full-duplex, 100 Mbps full and -half-duplex, and 10 Mbps full and half-duplex. -By default, the device will use auto-negotiation and prefer the highest -compatible speed. -The advertised speeds and broader configuration can be observed and -modified with -.Xr dladm 1M . -While -.Xr driver.conf 4 -based configuration is possible, it is recommended that -.Xr dladm 1M -is used wherever possible. -.Sh FILES -.Bl -tag -width Pa -.It Pa /dev/net/igb* -.Nm -special character device. -.It Pa /kernel/drv/amd64/igb -x86 device driver. -.It Pa /kernel/drv/sparcv9/igb -SPARC device driver -.It Pa /kernel/drv/igb.conf -Configuration file. -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr libdlpi 3LIB , -.Xr driver.conf 4 , -.Xr e1000g 7D , -.Xr dlpi 7P , -.Xr mac 9E diff --git a/usr/src/man/man7d/imc.7d b/usr/src/man/man7d/imc.7d deleted file mode 100644 index 9389afd0f1..0000000000 --- a/usr/src/man/man7d/imc.7d +++ /dev/null @@ -1,103 +0,0 @@ -.\" -.\" 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 June 25, 2019 -.Dt IMC 7D -.Os -.Sh NAME -.Nm imc -.Nd Intel memory controller driver -.Sh SYNOPSIS -.Pa /dev/mc/mc* -.Sh DESCRIPTION -The -.Nm -driver interfaces with the memory controller found on certain -generations of Intel CPUs and provides a means for decoding physical -addresses to the corresponding memory device. -The -.Nm -driver plugs into the operating systems fault management framework -providing additional details to the system about the memory topology and -the ability to decode physical addresses into the corresponding portion -of the memory hierarchy. -.Pp -The -.Nm -driver is supported on the following Intel processors: -.Bl -bullet -offset indent -width Sy -.It -Sandy Bridge E5 and E7 Xeon Processors -.It -Ivy Bridge E5 and E7 Xeon Processors -.It -Haswell E5 and E7 Xeon Processors -.It -Broadwell E5 and E7 Xeon Processors -.It -Skylake Xeon Scalable Processors -.It -Cascade Lake Xeon Scalable Processors -.It -Broadwell and Skylake Xeon-D processors -.El -.Pp -Other lines involving the above microarchitectures, such as Xeon E3 -branded processors, are not supported as they do not provide the -necessary hardware support. -.Pp -The -.Nm -driver is a pseudo-device driver that amalgamates all of the different -.Xr imcstub 7D -instances into a coherent view. -The -.Xr imcstub 7D -driver attaches to all of the different PCI devices that the processor -exposes. -.Pp -One challenge with the -.Nm -driver is the Intel Enhanced Machine Check Architecture v2 -.Pq EMCAv2 . -Many vendors use EMCAv2 to hide memory errors from the operating system. -Such systems limit the effectiveness of the -.Nm -driver and the fault management architecture by hiding correctable and -uncorrectable DIMM errors from the operating system. -.Pp -The -.Nm -driver has a few limitations. -Currently it does not always properly handle lockstep and mirroring -mode, particularly in variants that are common on Skylake and newer -systems. -It also does not properly handle cases where Intel Optane NVDIMMs are in -use on the memory bus. -.Sh ARCHITECTURE -The -.Nm -driver is only supported on specific Intel -.Sy x86 -systems. -.Sh FILES -.Bl -tag -width Pa -.It Pa /platform/i86pc/kernel/drv/amd64/imc -64-bit device driver (x86). -.It Pa /platform/i86pc/kernel/drv/imc.conf -Driver configuration file. -.El -.Sh SEE ALSO -.Xr fmadm 1M , -.Xr fmdump 1M , -.Xr imcstub 7D diff --git a/usr/src/man/man7d/imcstub.7d b/usr/src/man/man7d/imcstub.7d deleted file mode 100644 index d4f69c3b7a..0000000000 --- a/usr/src/man/man7d/imcstub.7d +++ /dev/null @@ -1,46 +0,0 @@ -.\" -.\" 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 June 25, 2019 -.Dt IMCSTUB 7D -.Os -.Sh NAME -.Nm imcstub -.Nd Intel memory controller stub driver -.Sh DESCRIPTION -The -.Nm -driver is a counterpart to the -.Xr imc 7D -driver. -The -.Nm -driver is responsible for attaching to all of the logical PCI devices -that are exposed by Intel CPUs and providing them for use by the -.Xr imc 7D -driver. -For more information on how this is used by the system, please see -.Xr imc 7D . -.Sh ARCHITECTURE -The -.Nm -driver is only supported on certain Intel -.Sy x86 -systems. -.Sh FILES -.Bl -tag -width Pa -.It Pa /platform/i86pc/kernel/drv/amd64/imcstub -64-bit device driver (x86). -.El -.Sh SEE ALSO -.Xr imc 7D diff --git a/usr/src/man/man7d/ipmi.7d b/usr/src/man/man7d/ipmi.7d deleted file mode 100644 index 43a9ead9d6..0000000000 --- a/usr/src/man/man7d/ipmi.7d +++ /dev/null @@ -1,170 +0,0 @@ -'\" -.\" CDDL HEADER START -.\" -.\" 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] -.\" -.\" CDDL HEADER END -.\" -.\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved -.\" Copyright 2013 Nexenta Systems, Inc. All rights reserved. -.\" -.TH IPMI 7D "Oct 31, 2013" -.SH NAME -ipmi \- OpenIPMI compatible IPMI interface driver -.SH SYNOPSIS -.nf -\fB/dev/ipmi0\fR -.fi - -.SH DESCRIPTION -The \fBipmi\fR device is a character special file that provides access to the -Intelligent Platform Management Interface for the system. For more -information on \fBIPMI\fR and to obtain a copy of the \fBIPMI\fR -specification and implementation guidelines, refer to -http://www.intel.com/design/servers/ipmi/. -The driver is adapted from the FreeBSD driver which is in turn adapted from -the Linux driver, however, not all features described in the standard are -supported. The current implementation depends on the \fBsmbios\fR(7d) to -discover the existence of an IPMI device. - -.SH IOCTLS -Sending and receiving messages through the IPMI drivers requires the use of -\fBioctl\fR(2). - -The ioctl command codes below are defined in \fBsys/ipmi.h\fR. -The third argument to ioctl should be a pointer to the type indicated. -Currently the following ioctls are supported: -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_RECEIVE_MSG "struct ipmi_recv" -.br -Receive a message. -.br -Possible error values: -.RS +8 -EAGAIN No messages are in the process queue. -.br -EFAULT An address supplied was invalid. -.br -EMSGSIZE The address could not fit in the message buffer and -will remain in the buffer. -.RE -.RE - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_RECEIVE_MSG_TRUNC "struct ipmi_recv" -.br -Like IPMICTL_RECEIVE_MSG but if the message cannot fit into the buffer, it -will truncate the contents instead of leaving the data in the buffer. -.RE - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_SEND_COMMAND "struct ipmi_req" -.br -Send a message to the interface. -.br -Possible error values: -.RS +8 -EFAULT An address supplied was invalid -.br -ENOMEM Buffers could not be allowed for the command, out of memory. -.RE -.RE - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_SET_MY_ADDRESS_CMD "unsigned int" -.br -Set the slave address for source messages. -.RE - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_GET_MY_ADDRESS_CMD "unsigned int" -.br -Get the slave address for source messages. -.RE - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_SET_MY_LUN_CMD "unsigned int" -.br -Set the slave LUN for source messages. -.RE - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_GET_MY_LUN_CMD "unsigned int" -.br -Get the slave LUN for source messages. -.RE - -Stub Only Ioctl - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_SET_GETS_EVENTS_CMD int -.br -Set whether this interface receives events. -.RE - -Unimplemented Ioctls - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_REGISTER_FOR_CMD -.br -Register to receive a specific command -.RE - -.RS +4 -.TP -.ie t \(bu -.el o -IPMICTL_UNREGISTER_FOR_CMD -.br -Unregister to receive a specific command -.RE - -.SH SEE ALSO -\fBipmitool\fR(1), \fBioctl\fR(2), \fBsmbios\fR(7d) -.sp -.LP -\fIIntelligent Platform Management Interface Specification Second -Generation\fR, v2.0 \(em -June 12, 2009 Markup -.SH NOTES -Not all systems include an \fBIPMI\fR. diff --git a/usr/src/man/man7d/ipnet.7d b/usr/src/man/man7d/ipnet.7d deleted file mode 100644 index eab138ec78..0000000000 --- a/usr/src/man/man7d/ipnet.7d +++ /dev/null @@ -1,190 +0,0 @@ -'\" te -.\" 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 IPNET 7D "Apr 8, 2009" -.SH NAME -ipnet, lo0 \- ipnet device driver -.SH SYNOPSIS -.LP -.nf -\fB/dev/ipnet/*, /dev/lo0\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBipnet\fR device driver creates, removes and manages nodes in the -\fB/dev/ipnet/\fR namespace. -.sp -.LP -A node is created in \fB/dev/ipnet\fR for every IP interface on the system, -including interfaces that exist only in software and for which there is no -hardware device. The \fBipnet\fR device also provides access to all IP traffic -to and from the system. To provide access to packets that are internally -looped-back in IP, the \fBipnet\fR driver creates a \fB/dev/lo0\fR DLPI device. -.SH APPLICATION PROGRAMMING INTERFACE -.SS "ipnet and DLPI" -.sp -.LP -Device nodes created in \fB/dev/ipnet\fR are DLPI style-1 devices. All -\fBM_PROTO\fR and \fBM_PCPROTO\fR-type messages are interpreted as DLPI -primitives. Because the device is read-only and packets can only be observed by -opening them, the following subset of DLPI primitives is supported: -.sp -.in +2 -.nf -DL_INFO_REQ -DL_BIND_REQ -DL_UNBIND_REQ -DL_PROMISCON_REQ -DL_PROMISCOFF_REQ -DLIOCRAW -.fi -.in -2 - -.sp -.LP -The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in -response to the \fBDL_INFO_REQ\fR are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum \fBSDU\fR is \fBINT_MAX\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum \fBSDU\fR is \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBDLSAP\fR address length is \fB2.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBMAC\fR type is \fBDL_IPNET\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBSAP\fR length value is \fB2\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Service mode is \fBDL_CLDLS\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -No optional quality of service (QOS) support is provided. Accordingly, the QOS -fields are 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Provider style is \fBDL_STYLE1\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Version is \fBDL_VERSION_2\fR. -.RE -.sp -.LP -The \fB/dev/ipnet/*\fR and \fB/dev/lo0\fR devices only accept \fBDL_BIND_REQ\fR -requests for SAPs 4 (IPv4 packets), 6 (IPv6 packets), or 0 (all IP packets). -\fBDL_BIND_REQ\fR requests for other SAP values result in a \fBDL_ERROR_ACK\fR -of \fBDL_BADSAP\fR. -.SS "ipnet primitives" -.sp -.LP -For \fB/dev/ipnet/*\fR devices, the \fBDL_PROMISCON_REQ\fR and -\fBDL_PROMISCOFF_REQ\fR primitives with the \fBDL_PROMISC_PHYS\fR flag set in -the \fBdl_level\fR field enables/disables the reception of all packets. When -disabled, only packets with addresses matching any of the configured addresses -on the IP interface are received. When used with the \fBDL_PROMISC_MULTI\fR -flag set, reception of all multicast group addresses can be enabled/disabled. -\fBDL_PROMISC_PHYS\fR and \fBDL_PROMISC_MULTI\fR have no effect for -\fB/dev/lo0\fR. When the \fBDL_PROMISC_SAP\fR flag is set, reception of all -IPv4/IPv6 can be enabled/disabled. -.sp -.LP -The \fBDLIOCRAW\fR ioctl is supported but has no effect on the data returned -from the device. -.sp -.LP -The \fBDL_IOC_IPNET_INFO\fR ioctl enables/disables the inclusion of a -\fBdl_ipnetinfo_t\fR structure that is prepended to the IP header when -receiving packet data. When enabled, a non-zero integer is returned reflecting -the current \fBDL_IOC_IPNET_INFO\fR version. The \fBdl_ipnetinfo_t\fR data -structure is defined in \fB<sys/dlpi.h>\fR and includes the following fields: -.sp -.in +2 -.nf -uint8_t dli_version; /* DL_IPNETINFO_* version */ -uint8_t dli_ipver; /* packet IP header version */ -uint16_t dli_len; /* length of dl_ipnetinfo_t */ -uint64_t dli_srczone; /* packet source zone ID (if any) */ -uint64_t dli_dstzone; /* packet dest zone ID (if any) */ -.fi -.in -2 - -.sp -.LP -The current \fBdli_version\fR is 1. To robustly support future -\fBdl_ipnetinfo_t\fR versions, consumers should check that \fBdli_version\fR is -a value they recognize, and must use the \fBdli_len\fR field to advance past -the \fBdl_ipnetinfo_t\fR header. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/ipnet/*, /dev/lo0\fR\fR -.ad -.RS 26n -Special character devices. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ipnet.conf\fR\fR -.ad -.RS 26n -Configuration file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -l l -l l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Architecture SPARC, x86 -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBdlpi\fR(7P) diff --git a/usr/src/man/man7d/iprb.7d b/usr/src/man/man7d/iprb.7d deleted file mode 100644 index 6ac7c445ac..0000000000 --- a/usr/src/man/man7d/iprb.7d +++ /dev/null @@ -1,66 +0,0 @@ -.\" Copyright 2014 Garrett D'Amore <garrett@damore.org> -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS -.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE -.\" COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, -.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -.\" (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 3, 2014" -.Dt IPRB 7D -.Os -.Sh NAME -.Nm iprb -.Nd Intel PRO/100 Fast Ethernet device driver -.Sh SYNOPSIS -.Pa /dev/iprb -.Sh DESCRIPTION -The -.Nm -driver provides support for the Intel PRO/100 family of Fast Ethernet -PCI controllers. -This includes support for Intel 82558, 82559, 82550, and 82551 parts, as well as -certain controllers found on certain Intel southbridge controllers (ICH2 and -ICH3). -.Lp -These devices generally support the standard Fast Ethernet features, including -10BASE-T and 100BASE-TX, both full and half duplex operation, IEEE 802.3 -autonegotiation, etc. -They also support full size MTUs (1500 bytes), even when used with VLANs. -Some of them also support flow control. -. -.Lp -The device driver supports the -.Xr ieee802.3 5 -properties, which can be configured with -.Xr dladm 1M . -. -.Sh FILES -.Bl -tag -width /dev/iprb -.It Pa /dev/iprb -Special character device. -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr ifconfig 1M , -.Xr pci 4 , -.Xr ieee802.3 5 , -.Xr dlpi 7P -.Rs -.%T IEEE 802.3: Ethernet -.%Q IEEE Standards Association -.Re diff --git a/usr/src/man/man7d/ipw.7d b/usr/src/man/man7d/ipw.7d deleted file mode 100644 index 13d29efd5f..0000000000 --- a/usr/src/man/man7d/ipw.7d +++ /dev/null @@ -1,85 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH IPW 7D "Mar 11, 2007" -.SH NAME -ipw \- Intel Pro. Wireless 802.11b IPW2100B driver -.SH DESCRIPTION -.sp -.LP -The \fBipw\fR \fI802.11b\fR wireless NIC driver is a multi-threaded, loadable, -clonable, GLDv3-based STREAMS driver supporting the Data Link Provider -Interface, \fBdlpi\fR(7P), on Intel Pro Wireless 2100B chipset-based wireless -NIC's. Driver functions include controller initialization, wireless -\fI802.11b\fR infrastructure network connection, WEP, frame transmit and -receive and promiscuous support. -.SH DRIVER CONFIGURATION -.sp -.LP -The \fBipw\fR driver performs auto-negotiation to determine the data rate and -mode. Supported \fI802.11b\fR data rates are 1, 2, 5.5 and 11 Mbits/sec. -.sp -.LP -The \fBipw\fR driver supports only BSS networks (also known as "ap" or -"infrastructure" networks) and the "open" ("open-system") or "shared system" -authentication. Only WEP encryption is currently supported. You perform -configuration and administration tasks using the \fBdladm\fR(1M) and -\fBwificonfig\fR(1M) utilities. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/ipw*\fR\fR -.ad -.RS 25n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/ipw\fR -.ad -.RS 25n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ipw\fR\fR -.ad -.RS 25n -64-bit ELF kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fIANSI/IEEE Std 802.11- Standard for Wireless LAN Technology\fR \(em 1999 -.sp -.LP -\fIIEEE Std 802.11b - Standard for Wireless LAN Technology-Rev. B \fR - -2003 diff --git a/usr/src/man/man7d/iscsi.7d b/usr/src/man/man7d/iscsi.7d deleted file mode 100644 index 7f4d34ab5e..0000000000 --- a/usr/src/man/man7d/iscsi.7d +++ /dev/null @@ -1,101 +0,0 @@ -'\" te -.\" 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 ISCSI 7D "Mar 30, 2009" -.SH NAME -iscsi \- iSCSI software initiator driver and service -.SH DESCRIPTION -.sp -.LP -The \fBiscsi\fR driver is a software initiator that transports SCSI commands -over TCP/IP as described in \fIRFC 3720\fR. -.sp -.LP -The initiator driver is administered through \fBiscsiadm\fR(1M). The -\fBiscsi\fR initiator service is managed by the service management facility, -\fBsmf\fR(5), under the following FMRI: -.sp -.in +2 -.nf -svc:/network/iscsi/initiator:default -.fi -.in -2 -.sp - -.sp -.LP -The \fBiscsi\fR initiator acts as a host adapter driver that attaches the -appropriate target driver, for example, \fBsd\fR(7D) for disks, or \fBst\fR(7D) -for tapes) for devices it discovers. See the \fISystem Administration Guide: -Devices and File Systems\fR for more information. -.sp -.LP -Once enabled, the \fBiscsi\fR initiator service ensures the right timing to -start the discovery and enumeration of iSCSI devices during boot, but it -doesn't guarantee the success of discovery for certain iSCSI devices. If the -service is disabled, \fBiscsi\fR driver stops the discovery and enumeration of -iSCSI devices and also tries to offline all existing iSCSI devices. -\fBiscsiadm\fR(1M) works only when the service is enabled. -.sp -.LP -iSCSI \fBboot\fR(1M) is not affected by the status of the \fBiscsi\fR initiator -service. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/iscsi\fR\fR -.ad -.RS 29n -32-bit ELF kernel driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/iscsi\fR\fR -.ad -.RS 29n -64-bit SPARC ELF kernel driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/iscsi\fR\fR -.ad -.RS 29n -64-bit AMD64 ELF kernel driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/iscsi.conf\fR\fR -.ad -.RS 29n -Driver configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/iscsi/*\fR\fR -.ad -.RS 29n -\fBiscsi\fR persistent store -.RE - -.SH SEE ALSO -.sp -.LP -\fBiscsiadm\fR(1M), \fBattributes\fR(5), \fBsmf\fR(5), \fBsd\fR(7D), -\fBst\fR(7D) -.sp -.LP -\fIRFC 3720 Internet Small Computer Systems Interface (iSCSI)\fR -.sp -.LP -\fISystem Administration Guide: Devices and File Systems\fR diff --git a/usr/src/man/man7d/iser.7d b/usr/src/man/man7d/iser.7d deleted file mode 100644 index 952775ce88..0000000000 --- a/usr/src/man/man7d/iser.7d +++ /dev/null @@ -1,73 +0,0 @@ -'\" te -.\" 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 ISER 7D "Mar 30, 2009" -.SH NAME -iser \- iSCSI Extensions for Remote DMA driver -.SH DESCRIPTION -.sp -.LP -The iSER driver accelerates the iSCSI protocol by mapping the data transfer -phases to Remote DMA (RDMA) operations. No iSER configuration is required for -its use, but an RDMA-capable protocol (RCaP) must be configured and enabled on -both target and initiator endpoints. -.sp -.LP -Currently, InfiniBand RC is the supported RCaP, and for discovery IP over IB -must be configured on both the initiator and target. If Infiniband (IB) -hardware is present and an Infiniband reliable-connected (RC) connection can be -established then an iSER-enabled initiator uses iSER connections to -iSER-enabled targets. Otherwise the connection is established using IP-based -connectivity. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/iser\fR\fR -.ad -.RS 28n -32-bit ELF kernel driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/iser\fR\fR -.ad -.RS 28n -64-bit SPARC ELF kernel drive -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/iser\fR\fR -.ad -.RS 28n -64-bit AMD64 ELF kernel driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/iser.conf\fR\fR -.ad -.RS 28n -Driver configuration file -.RE - -.SH SEE ALSO -.sp -.LP -\fBiscsiadm\fR(1M), \fBitadm\fR(1M), \fBattributes\fR(5), \fBibd\fR(7D) -.sp -.LP -\fISystem Administration Guide: Devices and File Systems\fR -.sp -.LP -\fIRFC 3720 Internet Small Computer Systems Interface (iSCSI)\fR -.sp -.LP -\fIRFC 5046 iSCSI Extensions for RDM\fR diff --git a/usr/src/man/man7d/iwh.7d b/usr/src/man/man7d/iwh.7d deleted file mode 100644 index 6adc1a1c49..0000000000 --- a/usr/src/man/man7d/iwh.7d +++ /dev/null @@ -1,78 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 IWH 7D "Aug 26, 2008" -.SH NAME -iwh \- Intel(R) WiFi Link 5100/5300 Driver -.SH DESCRIPTION -.sp -.LP -The \fBiwh\fR \fI802.11a/g/n\fR wireless NIC driver is a multi-threaded, -loadable, clonable, GLDv3-based STREAMS driver supporting the Intel Shirley -Peak WiFi chipset-based NIC's. Driver functions include controller -initialization, wireless \fI802.11\fR infrastructure network connection, WEP -and frame transmit and receive. -.SH CONFIGURATION -.sp -.LP -The \fBiwh\fR driver performs auto-negotiation to determine the data rate and -mode. Supported \fI802.11b\fR data rates are 1, 2, 5.5 and 11 Mbits/sec. -Supported \fI802.11g\fR data rates are 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48 -and 54 Mbits/sec. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/iwh\fR \fR -.ad -.RS 26n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/iwh\fR \fR -.ad -.RS 26n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/iwh\fR \fR -.ad -.RS 26n -64-bit ELF kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fI802.11 - Wireless LAN Media Access Control and Physical Layer -Specification\fR- IEEE, 2001. diff --git a/usr/src/man/man7d/iwi.7d b/usr/src/man/man7d/iwi.7d deleted file mode 100644 index 9c0c9118c3..0000000000 --- a/usr/src/man/man7d/iwi.7d +++ /dev/null @@ -1,94 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH IWI 7D "Mar 11, 2007" -.SH NAME -iwi \- Intel Pro. Wireless 802.11a/b/g IPW2200B/G IPW2915A/B/G Driver -.SH DESCRIPTION -.sp -.LP -The \fBiwi\fR \fI802.11b/g \fR wireless NIC driver is a multi-threaded, -loadable, clonable, GLDv3-based STREAMS driver supporting the Data Link -Provider Interface, \fBdlpi\fR(7P), on Intel Pro Wireless 2200BG 2915ABG -chipset-based wireless NIC's. Driver functions include controller -initialization, wireless \fI802.11b \fR infrastructure network connection, WEP -and frame transmit and receive. -.SH DRIVER CONFIGURATION -.sp -.LP -The \fBiwi\fR driver performs auto-negotiation to determine the data rate and -mode. Supported \fI802.11b \fR data rates are 1, 2, 5.5 and 11 Mbits/sec. -Supported \fI802.11g\fR data rates are 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48 -and 54 Mbits/sec. -.sp -.LP -The \fBiwi\fR driver supports only BSS networks (also known as "ap" or -"infrastructure" networks) and "open"(or "open-system") or "shared system" -authentication. Only WEP encryption is currently supported. You perform -configuration and administration tasks using the \fBdladm\fR(1M) and -\fBwificonfig\fR(1M) utilities. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/iwi*\fR\fR -.ad -.RS 25n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/iwi\fR -.ad -.RS 25n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/iwi\fR\fR -.ad -.RS 25n -64-bit ELF kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fIANSI/IEEE Std 802.11- Standard for Wireless LAN Technology\fR \(em 1999 -.sp -.LP -\fIIEEE Std 802.11a- Standard for Wireless LAN Technology-Rev. A\fR\(em 2003 -.sp -.LP -\fIIEEE Std 802.11b - Standard for Wireless LAN Technology-Rev. B \fR\(em -2003 -.sp -.LP -\fIIEEE Std 802.11g- Standard for Wireless LAN Technology -Rev. G\fR\(em -2003 diff --git a/usr/src/man/man7d/iwn.7d b/usr/src/man/man7d/iwn.7d deleted file mode 100644 index 3769adb11d..0000000000 --- a/usr/src/man/man7d/iwn.7d +++ /dev/null @@ -1,59 +0,0 @@ -.\" -.\" 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 2016 Hans Rosenfeld <rosenfeld@grumpf.hope-2000.org> -.\" -.Dd Jun 11, 2016 -.Dt IWN 7D -.Os -.Sh NAME -.Nm iwn -.Nd Intel(R) WiFi Link 4965 and 100/1000/2000/5000/6000 Series Driver -.Sh DESCRIPTION -The -.Nm -.Em 802.11a/g/n -wireless NIC driver is a multi-threaded, loadable, clonable, -GLDv3-based STREAMS driver supporting the Intel Wifi Link 4965, 100, -1000, 2000, 5000, and 6000 series of NIC's. -Driver functions include controller initialization, wireless -.Em 802.11 -infrastructure network connection, WEP and frame transmit and receive. -.Sh CONFIGURATION -The -.Nm -driver performs auto-negotiation to determine the data rate and mode -Supported data rates are 1, 2, 5.5, and 11 Mbit/sec for -.Em 802.11b -and -.Em 802.11g , -as well as 6, 9, 12, 18, 24, 36, 48, and 54 Mbit/sec for -.Em 802.11a -and -.Em 802.11g . -.Sh FILES -.Bl -tag -compact -width Pa -.It Pa /dev/iwn -Special character device. -.It Pa /kernel/drv/iwn -32-bit ELF kernel module (x86). -.It Pa /kernel/drv/amd64/iwn -64-bit ELF kernel module (x86). -.It Pa /kernel/firmware/iwn/*.ucode -.Nm -firmware files -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr wificonfig 1M -.Pp -.Em 802.11 - Wireless LAN Media Access Control and Physical Layer -Specification- IEEE, 2001 diff --git a/usr/src/man/man7d/ixgbe.7d b/usr/src/man/man7d/ixgbe.7d deleted file mode 100644 index 5b7f8e25e2..0000000000 --- a/usr/src/man/man7d/ixgbe.7d +++ /dev/null @@ -1,193 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 2012, Nexenta Systems, Inc. All rights reserved. -.\" Copyright 2016, OmniTI Computer Consulting, 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 IXGBE 7D "Jan 10, 2020" -.SH NAME -ixgbe \- Intel 10Gb PCI Express NIC Driver -.SH SYNOPSIS -.nf -\fB/dev/ixgbe*\fR -.fi - -.SH DESCRIPTION -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. -.sp -.LP -The \fBixgbe\fR driver functions include controller initialization, frame -transmit and receive, promiscuous and multicast support, and error recovery and -reporting. -.sp -.LP -The \fBixgbe\fR driver supports the following Intel 10-Gigabit PCI Express Ethernet controllers: -.RS +4 -.TP -.ie t \(bu -.el o -Intel Ethernet Controller 82598EB Family -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Intel Ethernet Controller 82599EB (X520) Family -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Intel Ethernet Controller X540 Family -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Intel Ethernet Controller X550 Family -.RE -.LP -The \fBixgbe\fR driver and hardware support auto-negotiation, a protocol -specified by the \fIIEEE 802.3ae\fR specification. -.SH APPLICATION PROGRAMMING INTERFACE -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 -.LP -The \fBixgbe\fR driver is managed by the \fBdladm\fR(1M) command line utility, -which allows VLANs to be defined on top of \fBixgbe\fR instances and for -\fBixgbe\fR instances to be aggregated. See \fBdladm\fR(1M) for more details. -.sp -.LP -You must send an explicit DL_ATTACH_REQ message to associate the opened stream -with a particular device (PPA). The PPA ID is interpreted as an unsigned -integer data type and indicates the corresponding device instance (unit) -number. The driver returns an error (DL_ERROR_ACK) if the PPA field value does -not correspond to a valid device instance number for the system. The device is -initialized on first attach and de-initialized (stopped) at last detach. -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to -your DL_INFO_REQ are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU for Intel 82598EB is 16366. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU for Intel 82599EB, X540 and X550 is 15500. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -DLSAP address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is DL_ETHER. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -SAP (Service Access Point) length value is -2, meaning the physical address -component is followed immediately by a 2-byte SAP component within the DLSAP -address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is the Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.sp -Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a -particular SAP with the stream. -.RE -.SH CONFIGURATION -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. -.SH FILES -.ne 2 -.na -\fB\fB/dev/ixgbe*\fR\fR -.ad -.RS 29n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ixgbe\fR\fR -.ad -.RS 29n -Device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/ixgbe\fR\fR -.ad -.RS 29n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ixgbe.conf\fR\fR -.ad -.RS 29n -Driver configuration file -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -\fBdladm\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), -\fBstreamio\fR(7I), \fBdlpi\fR(7P) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR -.sp -.LP -\fIIEEE 802.3ae Specification\fR, IEEE - 2002 diff --git a/usr/src/man/man7d/kmdb.7d b/usr/src/man/man7d/kmdb.7d deleted file mode 100644 index d181a42942..0000000000 --- a/usr/src/man/man7d/kmdb.7d +++ /dev/null @@ -1,43 +0,0 @@ -'\" te -.\" Copyright (c) 2004 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 KMDB 7D "May 8, 2004" -.SH NAME -kmdb \- Kernel debugger -.SH DESCRIPTION -.sp -.LP -The \fBkmdb\fR driver is the mechanism used by mdb to invoke and control -\fBkmdb\fR. This is \fBnot\fR a public interface. -.SH FILES -.sp -.ne 2 -.na -\fB/dev/kmdb\fR -.ad -.RS 13n -Kernel debugger driver. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/ksensor.7d b/usr/src/man/man7d/ksensor.7d deleted file mode 100644 index 1c3449f7a5..0000000000 --- a/usr/src/man/man7d/ksensor.7d +++ /dev/null @@ -1,41 +0,0 @@ -.\" -.\" 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 2020 Oxide Computer Company -.\" -.Dd June 9, 2020 -.Dt KSENSOR 7D -.Os -.Sh NAME -.Nm ksensor -.Nd kernel sensor driver -.Sh SYNOPSIS -.In sys/sensors.h -.Pp -.Pa /dev/sensors/ -.Sh DESCRIPTION -The -.Nm -driver provides access to sensors that are built using the kernel sensor -framework. -Sensors register with the framework are automatically made available to -the system and used with the fault management architecture -.Pq FMA . -.Pp -The file system location and programming interface to the -.Nm -driver are considered -.Sy Volatile , -subject to change without notice, and should not be used directly. -Sensor information can be dumped through the FMA developer utility -.Sy fmtopo . -.Sh SEE ALSO -.Xr fmadm 1M diff --git a/usr/src/man/man7d/kstat.7d b/usr/src/man/man7d/kstat.7d deleted file mode 100644 index d468e9489d..0000000000 --- a/usr/src/man/man7d/kstat.7d +++ /dev/null @@ -1,27 +0,0 @@ -'\" te -.\" Copyright (c) 1994, Sun Microsystems, Inc. -.\" 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 KSTAT 7D "May 26, 1994" -.SH NAME -kstat \- kernel statistics driver -.SH DESCRIPTION -.sp -.LP -The \fBkstat\fR driver is the mechanism used by the \fBkstat\fR(3KSTAT) library -to extract kernel statistics. This is NOT a public interface. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/kstat\fR\fR -.ad -.RS 14n -kernel statistics driver -.RE - -.SH SEE ALSO -.sp -.LP -\fBkstat\fR(3KSTAT), \fBkstat\fR(9S) diff --git a/usr/src/man/man7d/ksyms.7d b/usr/src/man/man7d/ksyms.7d deleted file mode 100644 index fe094d97b8..0000000000 --- a/usr/src/man/man7d/ksyms.7d +++ /dev/null @@ -1,113 +0,0 @@ -'\" te -.\" Copyright (c) 2000 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 KSYMS 7D "Dec 11, 2000" -.SH NAME -ksyms \- kernel symbols -.SH SYNOPSIS -.LP -.nf -\fB/dev/ksyms\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The file \fB/dev/ksyms\fR is a character special file that allows read-only -access to an \fBELF\fR format image containing two sections: a symbol table -and a corresponding string table. The contents of the symbol table reflect the -symbol state of the currently running kernel. You can determine the size of -the image with the \fBfstat\fR(\|) system call. The recommended method for -accessing the \fB/dev/ksyms\fR file is by using the \fBELF\fR access library. -See \fBelf\fR(3ELF) for details. If you are not familiar with \fBELF\fR -format, see \fBa.out\fR(4). -.sp -.LP -\fB/dev/ksyms\fR is an executable for the processor on which you are accessing -it. It contains \fBELF\fR program headers which describe the text and data -segment(s) in kernel memory. Since \fB/dev/ksyms\fR has no text or data, the -fields specific to file attributes are initialized to \fINULL\fR. The remaining -fields describe the text or data segment(s) in kernel memory. -.sp -.ne 2 -.na -\fB\fBSymbol table\fR\fR -.ad -.RS 16n -The \fBSYMTAB\fR section contains the symbol table entries present in the -currently running kernel. This section is ordered as defined by the \fBELF\fR -definition with locally-defined symbols first, followed by globally-defined -symbols. Within symbol type, the symbols are ordered by kernel module load -time. For example, the kernel file symbols are first, followed by the first -module's symbols, and so on, ending with the symbols from the last module -loaded. -.sp -The section header index (st_shndx) field of each symbol entry in the symbol -table is set to \fBSHN_ABS,\fR because any necessary symbol relocations are -performed by the kernel link editor at module load time. -.RE - -.sp -.ne 2 -.na -\fB\fBString table\fR\fR -.ad -.RS 16n -The \fBSTRTAB\fR section contains the symbol name strings that the symbol -table entries reference. -.RE - -.SH SEE ALSO -.sp -.LP -\fBkernel\fR(1M), \fBstat\fR(2), \fBelf\fR(3ELF), \fBkvm_open\fR(3KVM), -\fBa.out\fR(4), \fBmem\fR(7D) -.SH WARNINGS -.sp -.LP -The kernel is dynamically configured. It loads kernel modules when necessary. -Because of this aspect of the system, the symbol information present in the -running system can vary from time to time, as kernel modules are loaded and -unloaded. -.sp -.LP -When you open the \fB/dev/ksyms\fR file, you have access to an \fBELF\fR -image which represents a snapshot of the state of the kernel symbol information -at that instant in time. While the \fB/dev/ksyms\fR file remains open, kernel -module autounloading is disabled, so that you are protected from the -possibility of acquiring stale symbol data. Note that new modules can still be -loaded, however. If kernel modules are loaded while you have the -\fB/dev/ksyms\fR file open, the snapshot held by you will not be updated. In -order to have access to the symbol information of the newly loaded modules, you -must first close and then reopen the \fB/dev/ksyms\fR file. Be aware that the -size of the \fB/dev/ksyms\fR file will have changed. You will need to use the -\fBfstat()\fR function (see \fBstat\fR(2)) to determine the new size of the -file. -.sp -.LP -Avoid keeping the \fB/dev/ksyms\fR file open for extended periods of time, -either by using \fBkvm_open\fR(3KVM) of the default namelist file or with a -direct open. There are two reasons why you should not hold \fB/dev/ksyms\fR -open. First, the system's ability to dynamically configure itself is partially -disabled by the locking down of loaded modules. Second, the snapshot of symbol -information held by you will not reflect the symbol information of modules -loaded after your initial open of \fB/dev/ksyms\fR. -.sp -.LP -Note that the \fBksyms\fR driver is a loadable module, and that the kernel -driver modules are only loaded during an open system call. Thus it is possible -to run \fBstat\fR(2) on the \fB/dev/ksyms\fR file without causing the -\fBksyms\fR driver to be loaded. In this case, the file size returned is -\fBUNKNOWN_SIZE\fR. A solution for this behavior is to first open the -\fB/dev/ksyms\fR file, causing the \fBksyms\fR driver to be loaded (if -necessary). You can then use the file descriptor from this open in a -\fBfstat\fR(\|) system call to get the file's size. -.SH NOTES -.sp -.LP -The kernel virtual memory access library (\fBlibkvm\fR) routines use -\fB/dev/ksyms\fR as the default namelist file. See \fBkvm_open\fR(3KVM) for -details. diff --git a/usr/src/man/man7d/llc1.7d b/usr/src/man/man7d/llc1.7d deleted file mode 100644 index ae9c01c024..0000000000 --- a/usr/src/man/man7d/llc1.7d +++ /dev/null @@ -1,233 +0,0 @@ -'\" te -.\" Copyright (c) 1997, 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 LLC1 7D "Feb 13, 1997" -.SH NAME -llc1 \- Logical Link Control Protocol Class 1 Driver -.SH SYNOPSIS -.LP -.nf -\fB#include <sys/stropts.h>\fR -.fi - -.LP -.nf -\fB#include <sys/ethernet.h>\fR -.fi - -.LP -.nf -\fB#include <sys/dlpi.h>\fR -.fi - -.LP -.nf -\fB#include <sys/llc1.h>\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBllc1\fR driver is a multi-threaded, loadable, clonable, STREAMS -multiplexing driver supporting the connectionless Data Link Provider Interface, -\fBdlpi\fR(7P), implementing IEEE 802.2 Logical Link Control Protocol Class 1 -over a STREAM to a MAC level driver. Multiple MAC level interfaces installed -within the system can be supported by the driver. The \fBllc1\fR driver -provides basic support for the LLC1 protocol. Functions provided include frame -transmit and receive, XID, and TEST, multicast support, and error recovery and -reporting. -.sp -.LP -The cloning, character-special device, \fB/dev/llc1\fR, is used to access all -LLC1 controllers configured under \fBllc1\fR. -.sp -.LP -The \fBllc1\fR driver is a "Style 2" Data Link Service provider. All messages -of types \fBM_PROTO\fR and \fBM_PCPROTO\fR are interpreted as DLPI primitives. -An explicit \fBDL_ATTACH_REQ\fR message by the user is required to associate -the opened stream with a particular device (\fBppa\fR). The \fBppa\fR ID is -interpreted as an unsigned long and indicates the corresponding device instance -(unit) number. An error (\fBDL_ERROR_ACK\fR) is returned by the driver if the -\fBppa\fR field value does not correspond to a valid device instance number for -this system. -.sp -.LP -The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in -response to the \fBDL_INFO_REQ\fR from the user are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -The maximum Service Data UNIT (SDU) is derived from the MAC layer linked below -the driver. In the case of an Ethernet driver, the SDU will be 1497. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The minimum SDU is 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The MAC type is \fBDL_CSMACD\fR or \fBDL_TPR\fR as determined by the driver -linked under \fBllc1.\fR If the driver reports that it is \fBDL_ETHER,\fR it -will be changed to \fBDL_CSMACD;\fR otherwise the type is the same as the MAC -type. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBsap\fR length value is \(mi1, meaning the physical address component is -followed immediately by a 1-octet \fBsap\fR component within the DLSAP address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The service mode is \fBDL_CLDLS.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The MAC type is \fBDL_CSMACD\fR or \fBDL_TPR\fR as determined by the driver -linked under \fBllc1.\fR If the driver reports that it is \fBDL_ETHER,\fR it -will be changed to \fBDL_CSMACD;\fR otherwise the type is the same as the MAC -type. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBdlsap\fR address length is 7. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -No optional quality of service (QOS) support is included at present, so the QOS -fields should be initialized to 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The DLPI version is \fBDL_VERSION_2.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The provider style is \fBDL_STYLE2.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The broadcast address value is the broadcast address returned from the lower -level driver. -.RE -.sp -.LP -Once in the \fBDL_ATTACHED\fR state, the user must send a \fBDL_BIND_REQ\fR to -associate a particular Service Access Point (SAP) with the stream. The -\fBllc1\fR driver interprets the \fBsap\fR field within the \fBDL_BIND_REQ\fR -as an IEEE 802.2 "SAP," therefore valid values for the \fBsap\fR field are in -the [0-0xFF] range with only even values being legal. -.sp -.LP -The \fBllc1\fR driver DLSAP address format consists of the 6-octet physical -(e.g., Ethernet) address component followed immediately by the 1-octet -\fBsap\fR (type) component producing a 7-octet DLSAP address. Applications -should \fInot\fR hard-code to this particular implementation-specific DLSAP -address format, but use information returned in the \fBDL_INFO_ACK\fR primitive -to compose and decompose DLSAP addresses. The \fBsap\fR length, full DLSAP -length, and \fBsap\fR/physical ordering are included within the -\fBDL_INFO_ACK.\fR The physical address length can be computed by subtracting -the absolute value of the \fBsap\fR length from the full DLSAP address length -or by issuing the \fBDL_PHYS_ADDR_REQ\fR to obtain the current physical -address associated with the stream. -.sp -.LP -Once in the \fBDL_BOUND\fR state, the user may transmit frames on the LAN by -sending \fBDL_UNITDATA_REQ\fR messages to the \fBllc1\fR driver. The -\fBllc1\fR driver will route received frames up all open and bound streams -having a \fBsap\fR which matches the IEEE 802.2 DSAP as \fBDL_UNITDATA_IND\fR -messages. Received frames are duplicated and routed up multiple open streams if -necessary. The DLSAP address contained within the \fBDL_UNITDATA_REQ\fR and -\fBDL_UNITDATA_IND\fR messages consists of both the \fBsap\fR (type) and -physical (Ethernet) components. -.sp -.LP -In addition to the mandatory, connectionless DLPI message set, the driver -additionally supports the following primitives: -.sp -.LP -The \fBDL_ENABMULTI_REQ\fR and \fBDL_DISABMULTI_REQ\fR primitives -enable/disable reception of specific multicast group addresses. A set of -multicast addresses may be iteratively created and modified on a per-stream -basis using these primitives. These primitives are accepted by the driver in -any driver state that is valid while still being attached to the \fBppa\fR. -.sp -.LP -The \fBDL_PHYS_ADDR_REQ\fR primitive returns the 6-octet physical address -currently associated (attached) to the stream in the \fBDL_PHYS_ADDR_ACK\fR -primitive. This primitive is valid only in states following a successful -\fBDL_ATTACH_REQ.\fR -.sp -.LP -The \fBDL_SET_PHYS_ADDR_REQ\fR primitive changes the 6-octet physical address -currently associated (attached) to this stream. Once changed, all streams -subsequently opened and attached to this device will obtain this new physical -address. Once changed, the physical address will remain set until this -primitive is used to change the physical address again or the system is -rebooted, whichever occurs first. -.sp -.LP -The \fBDL_XID_REQ/DL_TEST_REQ\fR primitives provide the means for a user to -issue an \fBLLC XID\fR or \fBTEST\fR request message. A response to one of -these messages will be in the form of a \fBDL_XID_CON/DL_TEST_CON\fR message. -.sp -.LP -The \fBDL_XID_RES/DL_TEST_RES\fR primitives provide a way for the user to -respond to the receipt of an \fBXID\fR or \fBTEST\fR message that was -received as a \fBDL_XID_IND/DL_TEST_IND\fR message. -.sp -.LP -\fBXID\fR and \fBTEST\fR will be automatically processed by \fBllc1\fR if the -\fBDL_AUTO_XID/DL_AUTO_TEST\fR bits are set in the \fBDL_BIND_REQ.\fR -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/llc1\fR\fR -.ad -.RS 13n -cloning, character-special device -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBdlpi\fR(7P) diff --git a/usr/src/man/man7d/lockstat.7d b/usr/src/man/man7d/lockstat.7d deleted file mode 100644 index 8bd748536f..0000000000 --- a/usr/src/man/man7d/lockstat.7d +++ /dev/null @@ -1,50 +0,0 @@ -'\" te -.\" Copyright (c) 2003Sun 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 LOCKSTAT 7D "Dec 10, 2017" -.SH NAME -lockstat \- DTrace kernel lock instrumentation provider -.SH DESCRIPTION -.LP -The \fBlockstat\fR driver is a DTrace dynamic tracing provider that performs -dynamic instrumentation for locking primitives in the kernel. -.sp -.LP -The \fBlockstat\fR provider makes probes available that you can use to discern -lock contention statistics, or to understand virtually any aspect of locking -behavior inside the operating system kernel. The \fBlockstat\fR(1M) command is -implemented as a DTrace consumer that uses the lockstat provider to gather raw -data. -.sp -.LP -The \fBlockstat\fR driver is not a public interface and you access the -instrumentation offered by this provider through DTrace. Refer to the -\fIDynamic Tracing Guide\fR for a description of the public documented -interfaces available for the DTrace facility and the probes offered by the -\fBlockstat\fR provider. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.LP -\fBdtrace\fR(1M), \fBlockstat\fR(1M), \fBattributes\fR(5), \fBdtrace\fR(7D) -.sp -.LP -\fIDynamic Tracing Guide\fR: -.sp -.LP -https://illumos.org/books/dtrace/ diff --git a/usr/src/man/man7d/lofi.7d b/usr/src/man/man7d/lofi.7d deleted file mode 100644 index 81fffc6354..0000000000 --- a/usr/src/man/man7d/lofi.7d +++ /dev/null @@ -1,138 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 LOFI 7D "Nov 25, 2008" -.SH NAME -lofi \- Loopback file driver -.SH DESCRIPTION -.sp -.LP -The \fBlofi\fR file driver exports a file as a block device, enabling system -utilities such as \fBfstyp\fR(1M), \fBfsck\fR(1M) and \fBmount\fR(1M) to -operate on underlying file system images (including CD-ROM and FAT floppy -images) contained on the block device. Reads and writes to the block device are -translated to reads and writes on the exported file. See \fBlofiadm\fR(1M) for -examples. -.sp -.LP -File block device entries are contained in \fB/dev/lofi\fR. The -\fB/dev/rlofi\fR file contains the character (or raw) device entries. Entries -are in the form of decimal numbers and are assigned through -\fBlofiadm\fR(1M). When created, these device entries are owned by root, in -group sys and have permissions of 0600. Ownership, group, and permission -settings can be altered, however there may be ramifications. See -\fBlofiadm\fR(1M) for more information. -.sp -.LP -\fBlofi\fR devices can be compressed. See \fBlofiadm\fR(1M) for more -information. -.sp -.LP -Files exported through \fBlofi\fR can also be encrypted. See \fBlofiadm\fR(1M) -for details on how to specify encryption keys. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/lofictl\fR\fR -.ad -.sp .6 -.RS 4n -Master control device -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/lofi/\fIn\fR\fR\fR -.ad -.sp .6 -.RS 4n -Block device for file \fIn\fR -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rlofi/\fIn\fR\fR\fR -.ad -.sp .6 -.RS 4n -Character device for file \fIn\fR -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/lofi\fR\fR -.ad -.sp .6 -.RS 4n -32-bit driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/lofi\fR\fR -.ad -.sp .6 -.RS 4n -64-bit driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/lofi\fR\fR -.ad -.sp .6 -.RS 4n -64-bit driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/lofi.conf\fR\fR -.ad -.sp .6 -.RS 4n -Driver configuration file. (Do not alter). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBfstyp\fR(1M), \fBfsck\fR(1M), \fBmount\fR(1M), \fBlofiadm\fR(1M), -\fBnewfs\fR(1M), \fBattributes\fR(5), \fBlofs\fR(7FS) -.SH NOTES -.sp -.LP -Just as you would not directly access a disk device that has mounted file -systems, you should not access a file associated with a block device except -through the \fBlofi\fR file driver. -.sp -.LP -For compatibility purposes, a raw device is also exported with the block -device. (For example, \fBnewfs\fR(1M)). diff --git a/usr/src/man/man7d/log.7d b/usr/src/man/man7d/log.7d deleted file mode 100644 index e6d7fef23d..0000000000 --- a/usr/src/man/man7d/log.7d +++ /dev/null @@ -1,291 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1997, 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 LOG 7D "Mar 11, 1998" -.SH NAME -log \- interface to STREAMS error logging and event tracing -.SH SYNOPSIS -.LP -.nf -\fB#include <sys/strlog.h>\fR -.fi - -.LP -.nf -\fB#include <sys/log.h>\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fBlog\fR is a STREAMS software device driver that provides an interface for -console logging and for the STREAMS error logging and event tracing processes -(see \fBstrerr\fR(1M), and \fBstrace\fR(1M)). \fBlog\fR presents two separate -interfaces: a function call interface in the kernel through which STREAMS -drivers and modules submit \fBlog\fR messages; and a set of \fBioctl\fR(2) -requests and STREAMS messages for interaction with a user level console logger, -an error logger, a trace logger, or processes that need to submit their own -\fBlog\fR messages. -.SS "Kernel Interface" -.sp -.LP -\fBlog\fR messages are generated within the kernel by calls to the function -\fBstrlog()\fR: -.sp -.in +2 -.nf -strlog(short \fImid\fR, - short \fIsid\fR, - char \fIlevel\fR, - ushort_t \fIflags\fR, - char *\fBfmt\fR, - unsigned \fIarg1\fR\fB\|.\|.\|.\| -);\fR -.fi -.in -2 - -.sp -.LP -Required definitions are contained in \fB<sys/strlog.h>\fR, \fB<sys/log.h>\fR, -and \fB<sys/syslog.h>\fR\&. \fImid\fR is the STREAMS module id number for the -module or driver submitting the \fBlog\fR message. \fIsid\fR is an internal -sub-id number usually used to identify a particular minor device of a driver. -\fIlevel\fR is a tracing level that allows for selective screening out of low -priority messages from the tracer. \fIflags\fR are any combination of -\fBSL_ERROR\fR (the message is for the error logger), \fBSL_TRACE\fR (the -message is for the tracer), \fBSL_CONSOLE\fR (the message is for the console -logger), \fBSL_FATAL\fR (advisory notification of a fatal error), and -\fBSL_NOTIFY\fR (request that a copy of the message be mailed to the system -administrator). \fIfmt\fR is a \fBprintf\fR(3C) style format string, except -that \fB%s\fR, \fB%e\fR, \fB%E\fR, \fB%g\fR, and \fB%G\fR conversion -specifications are not handled. Up to \fBNLOGARGS\fR (in this release, three) -numeric or character arguments can be provided. -.SS "User Interface" -.sp -.LP -\fBlog\fR is implemented as a cloneable device, it clones itself without -intervention from the system clone device. Each open of \fB/dev/log\fR obtains -a separate stream to \fBlog\fR. In order to receive \fBlog\fR messages, a -process must first notify \fBlog\fR whether it is an error logger, trace -logger, or console logger using a STREAMS \fBI_STR ioctl\fR call (see below). -For the console logger, the \fBI_STR ioctl\fR has an \fBic_cmd\fR field of -\fBI_CONSLOG\fR, with no accompanying data. For the error logger, the \fBI_STR -ioctl\fR has an \fBic_cmd\fR field of \fBI_ERRLOG\fR, with no accompanying -data. For the trace logger, the \fBioctl\fR has an \fBic_cmd\fR field of -\fBI_TRCLOG\fR, and must be accompanied by a data buffer containing an array of -one or more struct \fBtrace_ids\fR elements. -.sp -.in +2 -.nf -struct trace_ids { - short ti_mid; - short ti_sid; - char ti_level; -}; -.fi -.in -2 - -.sp -.LP -Each \fBtrace_ids\fR structure specifies a \fImid\fR, \fIsid\fR, and -\fIlevel\fR from which messages will be accepted. \fBstrlog\fR(9F) will accept -messages whose \fImid\fR and \fIsid\fR exactly match those in the -\fBtrace_ids\fR structure, and whose level is less than or equal to the level -given in the \fBtrace_ids\fR structure. A value of \(mi1 in any of the fields -of the \fBtrace_ids\fR structure indicates that any value is accepted for that -field. -.sp -.LP -Once the logger process has identified itself using the \fBioctl\fR call, -\fBlog\fR will begin sending up messages subject to the restrictions noted -above. These messages are obtained using the \fBgetmsg\fR(2) function. The -control part of this message contains a \fBlog_ctl\fR structure, which -specifies the \fImid\fR, \fIsid\fR, \fIlevel\fR, \fIflags\fR, time in ticks -since boot that the message was submitted, the corresponding time in seconds -since Jan. 1, 1970, a sequence number, and a priority. The time in seconds -since 1970 is provided so that the date and time of the message can be easily -computed, and the time in ticks since boot is provided so that the relative -timing of \fBlog\fR messages can be determined. -.sp -.in +2 -.nf -struct log_ctl { - short mid; - short sid; - char level; /* level of message for tracing */ - short flags; /* message disposition */ -#if defined(_LP64) || defined(_I32LPx) - clock32_t ltime; /* time in machine ticks since boot */ - time32_t ttime; /* time in seconds since 1970 */ -#else - clock_t ltime; - time_t ttime; -#endif - int seq_no; /* sequence number */ - int pri; /* priority = (facility|level) */ -}; -.fi -.in -2 - -.sp -.LP -The priority consists of a priority code and a facility code, found in -\fB<sys/syslog.h>\fR\&. If \fBSL_CONSOLE\fR is set in \fIflags\fR, the priority -code is set as follows: If \fBSL_WARN\fR is set, the priority code is set to -\fBLOG_WARNING\fR; If \fBSL_FATAL\fR is set, the priority code is set to -\fBLOG_CRIT\fR; If \fBSL_ERROR\fR is set, the priority code is set to -\fBLOG_ERR\fR; If \fBSL_NOTE\fR is set, the priority code is set to -\fBLOG_NOTICE\fR; If \fBSL_TRACE\fR is set, the priority code is set to -\fBLOG_DEBUG\fR; If only \fBSL_CONSOLE\fR is set, the priority code is set to -\fBLOG_INFO\fR. Messages originating from the kernel have the facility code set -to \fBLOG_KERN\fR. Most messages originating from user processes will have the -facility code set to \fBLOG_USER\fR. -.sp -.LP -Different sequence numbers are maintained for the error and trace logging -streams, and are provided so that gaps in the sequence of messages can be -determined (during times of high message traffic some messages may not be -delivered by the logger to avoid hogging system resources). The data part of -the message contains the unexpanded text of the format string (null -terminated), followed by \fBNLOGARGS\fR words for the arguments to the format -string, aligned on the first word boundary following the format string. -.sp -.LP -A process may also send a message of the same structure to \fBlog\fR, even if -it is not an error or trace logger. The only fields of the \fBlog_ctl\fR -structure in the control part of the message that are accepted are the -\fIlevel\fR, \fIflags\fR, and \fIpri\fR fields; all other fields are filled in -by \fBlog\fR before being forwarded to the appropriate logger. The data portion -must contain a null terminated format string, and any arguments (up to -\fBNLOGARGS\fR) must be packed, 32-bits each, on the next 32-bit boundary -following the end of the format string. -.sp -.LP -\fBENXIO\fR is returned for \fBI_TRCLOG\fR ioctls without any \fBtrace_ids\fR -structures, or for any unrecognized \fBioctl\fR calls. The driver silently -ignores incorrectly formatted \fBlog\fR messages sent to the driver by a user -process (no error results). -.sp -.LP -Processes that wish to write a message to the console logger may direct their -output to \fB/dev/conslog\fR, using either \fBwrite\fR(2) or \fBputmsg\fR(2). -.SS "Driver Configuration" -.sp -.LP -The following driver configuration properties may be defined in the -\fBlog.conf\fR file. -.sp -.ne 2 -.na -\fBmsgid=1\fR -.ad -.RS 11n -If \fBmsgid=1\fR, each message will be preceded by a message ID as described in -\fBsyslogd\fR(1M). -.RE - -.sp -.ne 2 -.na -\fBmsgid=0\fR -.ad -.RS 11n - If \fBmsgid=0\fR, message IDs will not be generated. This property is unstable -and may be removed in a future release. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fR\fBI_ERRLOG\fR registration. -.sp -.in +2 -.nf -struct strioctl ioc; -ioc.ic_cmd = I_ERRLOG; -ioc.ic_timout = 0; /* default timeout (15 secs.) */ -ioc.ic_len = 0; -ioc.ic_dp = NULL; -ioctl(log, I_STR, &ioc); -.fi -.in -2 - -.LP -\fBExample 2 \fR\fBI_TRCLOG\fR registration. -.sp -.in +2 -.nf -struct trace_ids tid[2]; -tid[0].ti_mid = 2; -tid[0].ti_sid = 0; -tid[0].ti_level = 1; -tid[1].ti_mid = 1002; -tid[1].ti_sid = \(mi1; /* any sub-id will be allowed */ -tid[1].ti_level = \(mi1; /* any level will be allowed */ -ioc.ic_cmd = I_TRCLOG; -ioc.ic_timout = 0; -ioc.ic_len = 2 * sizeof(struct trace_ids); -ioc.ic_dp = (char *)tid; -ioctl(log, I_STR, &ioc); -.fi -.in -2 - -.sp -.LP -Example of submitting a \fBlog\fR message (no arguments): - -.sp -.in +2 -.nf -struct strbuf ctl, dat; -struct log_ctl lc; -char *message = "Don't forget to pick up some milk - on the way home"; -ctl.len = ctl.maxlen = sizeof(lc); -ctl.buf = (char *)&lc; -dat.len = dat.maxlen = strlen(message); -dat.buf = message; -lc.level = 0; -lc.flags = SL_ERROR|SL_NOTIFY; -putmsg(log, &ctl, &dat, 0); -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/log\fR\fR -.ad -.RS 24n -Log driver. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/conslog\fR\fR -.ad -.RS 24n -Write only instance of the log driver, for console logging. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/log.conf\fR\fR -.ad -.RS 24n -Log configuration file. -.RE - -.SH SEE ALSO -.sp -.LP -\fBstrace\fR(1M), \fBstrerr\fR(1M), \fBIntro\fR(3), \fBgetmsg\fR(2), -\fBioctl\fR(2), \fBputmsg\fR(2), \fBwrite\fR(2), \fBprintf\fR(3C), -\fBstrlog\fR(9F) -.sp -.LP -\fISTREAMS Programming Guide\fR diff --git a/usr/src/man/man7d/mc-opl.7d b/usr/src/man/man7d/mc-opl.7d deleted file mode 100644 index 3dd7028be9..0000000000 --- a/usr/src/man/man7d/mc-opl.7d +++ /dev/null @@ -1,34 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 MC-OPL 7D "Apr 18, 2006" -.SH NAME -mc-opl \- memory controller driver for the SPARC Enterprise Server family -.SH DESCRIPTION -.sp -.LP -The \fBmc-opl\fR driver is the memory controller driver for the SPARC -Enterprise Server family. This driver manages the hardware memory-scrubbing -operations. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/mega_sas.7d b/usr/src/man/man7d/mega_sas.7d deleted file mode 100644 index 6db8635a58..0000000000 --- a/usr/src/man/man7d/mega_sas.7d +++ /dev/null @@ -1,102 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 MEGA_SAS 7D "Aug 14, 2008" -.SH NAME -mega_sas \- SCSI HBA driver for LSI MegaRAID SAS controller -.SH DESCRIPTION -.sp -.LP -The \fBmega_sas\fR MegaRAID controller host bus adapter driver is a -SCSA-compliant nexus driver that supports the Dell PERC 5/E, 5/i, 6/E and 6/i -RAID controllers, the IBM ServeRAID-MR10k SAS/SATA controller and the LSI -MegaRAID SAS/SATA 8308ELP, 8344ELP, 84016E, 8408ELP, 8480ELP, 8704ELP, 8704EM2, -8708ELP, 8708EM2, 8880EM2 and 8888ELP series of controllers. -.sp -.LP -Supported RAID features include RAID levels 0, 1, 5, and 6, RAID spans 10, 50 -and 60, online capacity expansion (OCE), online RAID level migration (RLM), -auto resume after loss of system power during arrays, array rebuild or -reconstruction (RLM) and configurable stripe size up to 1MB. Additional -supported RAID features include check consistency for background data -integrity, patrol read for media scanning and repairing, 64 logical drive -support, up to 64TB LUN support, automatic rebuild and global and dedicated hot -spare support. -.SH CONFIGURATION -.sp -.LP -The \fBmega_sas.conf\fR file contains no user configurable parameters. Please -configure your hardware through the related BIOS utility or the MegaCli -configuration utility. If you want to install to a drive attached to a -mega_sas HBA, you should create the virtual drive first from the BIOS before -running the Solaris install. You can obtain the MegaCli utility from the LSI -website. -.sp -.LP -The \fBmega_sas\fR device can support up to 64 virtual disks. Note that BIOS -numbers the virtual disks as 1 through 64, however in the Solaris operating -environment virtual disks are numbered from 0 to 63. Also note that SAS and -SATA drives cannot be configured into the same virtual disk. -.SH KNOWN PROBLEMS AND LIMITATIONS -.sp -.LP -The \fBmega_sas\fR driver does not support the LSI MegaRAID SAS 8204ELP, -8204XLP, 8208ELP, and 8208XLP controllers. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/mega_sas\fR\fR -.ad -.RS 30n -32-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/mega_sas\fR\fR -.ad -.RS 30n -64-bit kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/mega_sas.conf\fR\fR -.ad -.RS 30n -Driver configuration file (contains no user-configurable options). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86-based systems -_ -Interface stability Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBattributes\fR(5), \fBsata\fR(7D), -\fBscsi_hba_attach_setup\fR(9F), \fBscsi_sync_pkt\fR(9F), -\fBscsi_transport\fR(9F), \fBscsi_inquiry\fR(9S), \fBscsi_device\fR(9S), -\fBscsi_pkt\fR(9S) -.sp -.LP -\fISmall Computer System Interface-2 (SCSI-2)\fR diff --git a/usr/src/man/man7d/mem.7d b/usr/src/man/man7d/mem.7d deleted file mode 100644 index ab430b7092..0000000000 --- a/usr/src/man/man7d/mem.7d +++ /dev/null @@ -1,129 +0,0 @@ -'\" te -.\" Copyright 2002 Sun Microsystems Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 MEM 7D "Feb 18, 2002" -.SH NAME -mem, kmem, allkmem \- physical or virtual memory access -.SH SYNOPSIS -.LP -.nf -/dev/mem -.fi - -.LP -.nf -/dev/kmem -.fi - -.LP -.nf -/dev/allkmem -.fi - -.SH DESCRIPTION -.sp -.LP -The file \fB/dev/mem\fR is a special file that provides access to the physical -memory of the computer. -.sp -.LP -The file \fB/dev/kmem\fR is a special file that provides access to the virtual -address space of the operating system kernel, excluding memory that is -associated with an I/O device. -.sp -.LP -The file \fB/dev/allkmem\fR is a special file that provides access to the -virtual address space of the operating system kernel, including memory that is -associated with an I/O device. You can use any of these devices to examine and -modify the system. -.sp -.LP -Byte addresses in \fB/dev/mem\fR are interpreted as physical memory addresses. -Byte addresses in \fB/dev/kmem\fR and \fB/dev/allkmem\fR are interpreted as -kernel virtual memory addresses. A reference to a non-existent location returns -an error. See ERRORS for more information. -.sp -.LP -The file \fB/dev/mem\fR accesses physical memory; the size of the file is equal -to the amount of physical memory in the computer. This size may be larger than -4GB on a system running the 32-bit operating environment. In this case, you can -access memory beyond 4GB using a series of \fBread\fR(2) and \fBwrite\fR(2) -calls, a \fBpread64()\fR or \fBpwrite64()\fR call, or a combination of -\fBllseek\fR(2) and \fBread\fR(2) or \fBwrite\fR(2). -.SH ERRORS -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -Occurs when trying to \fBwrite\fR(2) a read-only location (\fBallkmem\fR), -\fBread\fR(2) a write-only location (\fBallkmem\fR), or \fBread\fR(2) or -\fBwrite\fR(2) a non-existent or unimplemented location (\fBmem\fR, \fBkmem\fR, -\fBallkmem\fR). -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 10n -Occurs when trying to \fBread\fR(2) or \fBwrite\fR(2) a memory location that is -associated with an I/O device using the \fB/dev/kmem\fR special file. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -Results from attempting to \fBmmap\fR(2) a non-existent physical (\fBmem\fR) or -virtual (\fBkmem\fR, \fBallkmem\fR) memory address. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/mem\fR\fR -.ad -.RS 16n -Provides access to the computer's physical memory. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/kmem\fR\fR -.ad -.RS 16n -Provides access to the virtual address space of the operating system kernel, -excluding memory that is associated with an I/O device. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/allkmem\fR\fR -.ad -.RS 16n -Provides access to the virtual address space of the operating system kernel, -including memory that is associated with an I/O device. -.RE - -.SH SEE ALSO -.sp -.LP -\fBllseek\fR(2), \fBmmap\fR(2), \fBread\fR(2), \fBwrite\fR(2) -.SH WARNINGS -.sp -.LP -Using these devices to modify (that is, write to) the address space of a live -running operating system or to modify the state of a hardware device is -extremely dangerous and may result in a system panic if kernel data structures -are damaged or if device state is changed. diff --git a/usr/src/man/man7d/mlxcx.7d b/usr/src/man/man7d/mlxcx.7d deleted file mode 100644 index ccbc257641..0000000000 --- a/usr/src/man/man7d/mlxcx.7d +++ /dev/null @@ -1,367 +0,0 @@ -.\" -.\" 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 2020 the University of Queensland -.\" -.Dd August 27, 2020 -.Dt MLXCX 7D -.Os -.Sh NAME -.Nm mlxcx -.Nd Mellanox ConnectX-4/5/6 Ethernet controller driver -.Sh SYNOPSIS -.Pa /dev/net/mlxcx* -.Sh DESCRIPTION -The -.Sy mlxcx -driver is a GLDv3 NIC driver for the ConnectX-4, ConnectX-4 Lx, ConnectX-5 and -ConnectX-6 families of ethernet controllers from Mellanox. -It supports the Data Link Provider Interface, -.Xr dlpi 7P . -.Pp -This driver supports: -.Bl -dash -offset indent -.It -Jumbo frames up to 9000 bytes. -.It -Checksum offload for TCP, UDP, IPv4 and IPv6. -.It -Group support with VLAN and MAC steering to avoid software classification -when using VNICs. -.It -Promiscuous access via -.Xr snoop 1M and -.Xr dlpi 7P -.It -LED control -.It -Transceiver information -.It -Internal temperature sensors -.El -.Pp -At this time, the driver does not support Large Send Offload (LSO), energy -efficient Ethernet (EEE), or the use of flow control through hardware pause -frames. -.Sh CONFIGURATION -The -.Sy mlxcx.conf -file contains user configurable parameters, including the ability to set the -number of rings and groups advertised to MAC, the sizes of rings and groups, -and the maximum number of MAC address filters available. -.Sh PROPERTIES -The driver supports the following device properties which may be tuned through -its driver.conf file, -.Pa /kernel/drv/mlxcx.conf . -These properties cannot be changed after the driver has been attached. -.Pp -These properties are not considered stable at this time, and may change. -.Bl -hang -width Ds -.It Sy eq_size_shift -.Bd -filled -compact -Minimum: -.Sy 2 | -Maximum: -.Sy device dependent (up to 255) -.Ed -.Bd -filled -The -.Sy eq_size_shift -property determines the number of entries on Event Queues for the device. -The number of entries is calculated as -.Dv (1 << eq_size_shift) , -so a value of 9 would mean 512 entries are created on each Event Queue. -The default value is -.Sy 9 . -.Ed -.It Sy cq_size_shift -.Bd -filled -compact -Minimum: -.Sy 2 | -Maximum: -.Sy device dependent (up to 255) -.Ed -.Bd -filled -The -.Sy cq_size_shift -property determines the number of entries on Completion Queues for the device. -The number of entries is calculated as -.Li (1 << cq_size_shift) , -so a value of 9 would mean 512 entries are created on each Event Queue. -The default value is device dependent, -.Sy 10 -for devices with maximum supported speed of 10Gb/s or less and -.Sy 12 -for devices with higher supported speeds. -This should be kept very close to the value set for -.Sy rq_size_shift -and -.Sy sq_size_shift . -.Ed -.It Sy rq_size_shift -.Bd -filled -compact -Minimum: -.Sy 2 | -Maximum: -.Sy device dependent (up to 255) -.Ed -.Bd -filled -The -.Sy rq_size_shift -property determines the number of descriptors on Receive Queues for the device. -The number of descriptors is calculated as -.Dv (1 << rq_size_shift) , -so a value of 9 would mean 512 descriptors are created on each Receive Queue. -This sets the number of packets on RX rings advertised to MAC. -The default value is device dependent, -.Sy 10 -for devices with maximum supported speed of 10Gb/s or less and -.Sy 12 -for devices with higher supported speeds. -.Ed -.It Sy sq_size_shift -.Bd -filled -compact -Minimum: -.Sy 2 | -Maximum: -.Sy device dependent (up to 255) -.Ed -.Bd -filled -The -.Sy sq_size_shift -property determines the number of descriptors on Send Queues for the device. -The number of descriptors is calculated as -.Dv (1 << sq_size_shift) , -so a value of 9 would mean 512 descriptors are created on each Send Queue. -This sets the number of packets on RX rings advertised to MAC. -The default value is device dependent, -.Sy 11 -for devices with maximum supported speed of 10Gb/s or less and -.Sy 13 -for devices with higher supported speeds. -Note that large packets often occupy more than one descriptor slot on the SQ, -so it is sometimes a good idea to increase this if using a large MTU. -.Ed -.It Sy tx_ngroups -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -The -.Sy tx_ngroups -property determines the number of TX groups advertised to MAC. -The default value is -.Sy 1 . -.Ed -.It Sy tx_nrings_per_group -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -The -.Sy tx_nrings_per_group -property determines the number of rings in each TX group advertised to MAC. -The default value is -.Sy 64 . -.Ed -.It Sy rx_ngroups_large -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -The -.Sy rx_ngroups_large -property determines the number of "large" RX groups advertised to MAC. -The size of "large" RX groups is set by the -.Sy rx_nrings_per_large_group -property. -The default value is -.Sy 2 . -.Ed -.It Sy rx_nrings_per_large_group -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -The -.Sy rx_nrings_per_large_group -property determines the number of rings in each "large" RX group advertised to -MAC. -The number of such groups is determined by the -.Sy rx_ngroups_large -property. -The default value is -.Sy 16 . -.Ed -.It Sy rx_ngroups_small -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -The -.Sy rx_ngroups_small -property determines the number of "small" RX groups advertised to MAC. -The size of "small" RX groups is set by the -.Sy rx_nrings_per_small_group -property. -It is recommended to use many small groups when using a large number of -VNICs on top of the NIC (e.g. on a system with many zones). -The default value is -.Sy 256 . -.Ed -.It Sy rx_nrings_per_small_group -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -The -.Sy rx_nrings_per_small_group -property determines the number of rings in each "small" RX group advertised to -MAC. -The number of such groups is determined by the -.Sy rx_ngroups_small -property. -The default value is -.Sy 4 . -.Ed -.It Sy ftbl_root_size_shift -.Bd -filled -compact -Minimum: -.Sy 4 | -Maximum: -.Sy device dependent -.Ed -.Bd -filled -The -.Sy ftbl_root_size_shift -property determines the number of flow table entries on the root flow table, -and therefore how many MAC addresses can be filtered into groups across the -entire NIC. -The number of flow entries is calculated as -.Dv (1 << ftbl_root_size_shift) , -so a value of 9 would mean 512 entries are created in the root flow table. -The default value is -.Sy 12 . -.Ed -.It Sy cqemod_period_usec -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy 65535 -.Ed -.Bd -filled -The -.Sy cqemod_period_usec -property determines the maximum delay after a completion event has occurred -before an event queue entry (and thus an interrupt) is generated. -The delay is measured in microseconds. -The default value is -.Sy 50 . -.Ed -.It Sy cqemod_count -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy 65535 -.Ed -.Bd -filled -The -.Sy cqemod_count -property determines the maximum number of completion events that can have -occurred before an event queue entry (and thus an interrupt) is generated. -The default value is -.Sy 80% of the CQ size . -.Ed -.It Sy intrmod_period_usec -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy 65535 -.Ed -.Bd -filled -The -.Sy intrmod_period_usec -property determines the maximum delay after an event queue entry has been -generated before an interrupt is raised. -The delay is measured in microseconds. -The default value is -.Sy 10 . -.Ed -.It Sy tx_bind_threshold -.Bd -filled -compact -Minimum: -.Sy 1 | -Maximum: -.Sy 65535 -.Ed -.Bd -filled -The -.Sy tx_bind_threshold -property determines the minimum number of bytes in a packet before the driver -uses -.Xr ddi_dma_addr_bind_handle 9F -to bind the packet memory for DMA, rather than copying the memory as it does -for small packets. -DMA binds are expensive and involve taking locks in the PCI nexus driver, so it -is seldom worth using them for small packets. -The default value is -.Sy 2048 . -.Ed -.It Sy rx_limit_per_completion -.Bd -filled -compact -Minimum: -.Sy 16 | -Maximum: -.Sy 4096 -.Ed -.Bd -filled -The -.Sy rx_limit_per_completion -property determines the maximum number of packets that -will be processed on a given completion ring during a single interrupt. -This is done to try and guarantee some amount of liveness in the system. -The default value is -.Sy 256 . -.Ed -.El -.Sh FILES -.Bl -tag -width Pa -.It Pa /kernel/drv/amd64/mlxcx -Device driver (x86) -.It Pa /kernel/drv/mlxcx.conf -Driver configuration file containing user-configurable options -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr snoop 1M , -.Xr driver.conf 4 , -.Xr dlpi 7P diff --git a/usr/src/man/man7d/mpt_sas.7d b/usr/src/man/man7d/mpt_sas.7d deleted file mode 100644 index bdb5899ae1..0000000000 --- a/usr/src/man/man7d/mpt_sas.7d +++ /dev/null @@ -1,132 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright (c) 2017, Joyent, Inc. -.\" Copyright 2014, Nexenta Systems, 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 MPT_SAS 7D "Dec 15, 2017" -.SH NAME -mpt_sas \- SAS-2/3 host bus adapter driver -.SH SYNOPSIS -.in +2 -.nf -scsi@unit-address -.fi -.in -2 - -.SH DESCRIPTION -.LP -The \fBmpt_sas\fR host bus adapter driver is a nexus driver that supports -Broadcom (formerly LSI and Avago) SAS chipsets including the SAS200x/2x08/2x16 -and SAS300x/3x08/3x16/3x24 series of chips. These chips support SAS/SATA -interfaces, including tagged and untagged queuing, SATA 3G/SAS 3G/SAS 6G/SAS -12G. -.SS "Configuration" -.LP -The \fBmpt_sas\fR driver is configured by defining properties in -\fBmpt_sas.conf\fR. These properties override the global SCSI settings. The -\fBmpt_sas\fR driver supports one modifiable property: -.sp -.ne 2 -.na -\fB\fBmpxio-disable\fR\fR -.ad -.sp .6 -.RS 4n -Solaris I/O multipathing is enabled or disabled on SAS devices with the -\fBmpxio-disable\fR property. Specifying \fBmpxio-disable="no"\fR activates I/O -multipathing, while \fBmpxio-disable="yes"\fR disables I/O multipathing. -.sp -Solaris I/O multipathing can be enabled or disabled on a per port basis. Per -port settings override the global setting for the specified ports. -.sp -The following example shows how to disable multipathing on port 0 whose parent -is \fB/pci@0,0/pci8086,2940@1c/pci1000,72@0\fR: -.sp -.in +2 -.nf -name="mpt_sas" parent="/pci@0,0/pci8086,2940@1c/pci1000,72@0" -mpxio-disable="yes"; -.fi -.in -2 - -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing the \fBmpt_sas\fR Configuration File to Disable MPXIO -.sp -.LP -Create a file called \fB/kernel/drv/mpt_sas.conf\fR and add the following line: - -.sp -.in +2 -.nf -name="mpt_sas" parent="/pci@0,0/pci8086,2940@1c/pci1000,72@0" -mpxio-disable="yes"; -.fi -.in -2 - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/mpt_sas\fR\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/mpt_sas\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/mpt_sas\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/mpt_sas.conf\fR\fR -.ad -.sp .6 -.RS 4n -Optional configuration file -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.LP -\fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBpci\fR(4), \fBattributes\fR(5), -\fBscsi_abort\fR(9F), \fBscsi_device\fR(9S), \fBscsi_extended_sense\fR(9S), -\fBscsi_inquiry\fR(9S), \fBscsi_hba_attach_setup\fR(9F), -\fBscsi_ifgetcap\fR(9F), \fBscsi_ifsetcap\fR(9F), \fBscsi_pkt\fR(9S), -\fBscsi_reset\fR(9F), \fBscsi_sync_pkt\fR(9F), \fBscsi_transport\fR(9F), diff --git a/usr/src/man/man7d/mr_sas.7d b/usr/src/man/man7d/mr_sas.7d deleted file mode 100644 index bd4913b07b..0000000000 --- a/usr/src/man/man7d/mr_sas.7d +++ /dev/null @@ -1,176 +0,0 @@ -'\" te -.\" 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 MR_SAS 7D "May 28, 2009" -.SH NAME -mr_sas \- LSI MegaRAID SAS2.0 Controller HBA driver -.SH DESCRIPTION -.sp -.LP -The \fBmr_sas\fR MegaRAID SAS2.0 controller host bus adapter driver is a -SCSA-compliant nexus driver that supports the LSI MegaRAID SAS 92\fIxx\fR -series of controllers and the Sun StorageTek 6Gb/s SAS RAID HBA series of -controllers. -.sp -.LP -Some of the RAID Features include the following: -.RS +4 -.TP -.ie t \(bu -.el o -RAID levels 0, 1, 5, and 6 -.RE -.RS +4 -.TP -.ie t \(bu -.el o -RAID spans 10, 50, and 60 -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Online Capacity Expansion (OCE) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Online RAID Level Migration (RLM) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Auto resume after loss of system power during arrays array rebuild or -reconstruction (RLM) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Configurable stripe size up to 1MB -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Check Consistency for background data integrity -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Patrol read for media scanning and repairing -.RE -.RS +4 -.TP -.ie t \(bu -.el o -64 logical drive support -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Up to 64TB LUN support -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Automatic rebuild -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Global and dedicated Hot Spare support -.RE -.SS "Configuration" -.sp -.LP -The \fBmr_sas.conf\fR file contains one user configurable parameter, for MSI or -MSI-X support. Configure your hardware through the related BIOS utility or the -MegaCli Configuration Utility. If you want to install to a drive attached to a -\fBmr_sas\fR HBA, create the virtual drive first from the BIOS (X86) before -running Solaris install. The \fBMegaCli\fR utility can be downloaded from the -LSI website. -.sp -.LP -The LSI MegaRAID SAS device can support up to 64 virtual SAS2.0, SAS1.0, -SATA3.0, or SATA 6.0 disks. The BIOS numbers the virtual disks as 1 through 64, -however in Solaris these drives are numbered from 0 to 63. Also keep in mind -that SAS and SATA drives can not be configured into the same virtual disk. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/mr_sas\fR\fR -.ad -.RS 30n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/mr_sas\fR\fR -.ad -.RS 30n -64-bit kernel module x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/mr_sas\fR\fR -.ad -.RS 30n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/mr_sas.conf\fR\fR -.ad -.RS 30n -Driver configuration file containing one user-configurable option -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBattributes\fR(5), \fBsata\fR(7D), -\fBscsi_hba_attach_setup\fR(9F), \fBscsi_sync_pkt\fR(9F), -\fBscsi_transport\fR(9F), \fBscsi_device\fR(9S), \fBscsi_inquiry\fR(9S), -\fBscsi_pkt\fR(9S) -.sp -.LP -\fISmall Computer System Interface-2 (SCSI-2)\fR -.SH NOTES -.sp -.LP -The \fBmr_sas\fR driver only supports internal and external expanders that are -not fully SAS1.0 or fully SAS2.0 compliant. diff --git a/usr/src/man/man7d/msglog.7d b/usr/src/man/man7d/msglog.7d deleted file mode 100644 index a22f2f1953..0000000000 --- a/usr/src/man/man7d/msglog.7d +++ /dev/null @@ -1,52 +0,0 @@ -'\" te -.\" Copyright (c) 1998, Sun Microsystems, Inc. -.\" 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 MSGLOG 7D "Oct 13, 1998" -.SH NAME -msglog \- message output collection from system startup or background -applications -.SH SYNOPSIS -.LP -.nf -\fB/dev/msglog\fR -.fi - -.SH DESCRIPTION -.sp -.LP -Output from system startup ("rc") scripts is directed to \fB/dev/msglog\fR, -which dispatches it appropriately. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Stable -.TE - -.SH SEE ALSO -.sp -.LP -\fBsyslogd\fR(1M), \fBsyslog\fR(3C), \fBattributes\fR(5), \fBsysmsg\fR(7D) -.SH NOTES -.sp -.LP -In the current version of Solaris, \fB/dev/msglog\fR is an alias for -\fB/dev/sysmsg\fR. In future versions of Solaris, writes to \fB/dev/msglog\fR -may be directed into a more general logging mechanism such as -\fBsyslogd\fR(1M). -.sp -.LP -\fBsyslog\fR(3C) provides a more general logging mechanism than -\fB/dev/msglog\fR and should be used in preference to \fB/dev/msglog\fR -whenever possible. diff --git a/usr/src/man/man7d/mt.7d b/usr/src/man/man7d/mt.7d deleted file mode 100644 index 5f779b5166..0000000000 --- a/usr/src/man/man7d/mt.7d +++ /dev/null @@ -1,32 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (C) 1999, 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 MT 7D "Jul 3, 1990" -.SH NAME -mt \- tape interface -.SH DESCRIPTION -.sp -.LP -The files \fBrmt/*\fR refer to tape controllers and associated tape drives. -.sp -.LP -The \fBlabelit\fR(1M) command requires these magnetic tape file names to work -correctly with the tape controllers. No other tape controller commands require -these file names. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/rmt/*\fR\fR -.ad -.RS 14n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBlabelit\fR(1M) diff --git a/usr/src/man/man7d/mxfe.7d b/usr/src/man/man7d/mxfe.7d deleted file mode 100644 index 5b0f49fe76..0000000000 --- a/usr/src/man/man7d/mxfe.7d +++ /dev/null @@ -1,62 +0,0 @@ -.\" Copyright 2014 Garrett D'Amore <garrett@damore.org> -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS -.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE -.\" COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, -.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -.\" (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" -.Dt MXFE 7D -.Os -.Sh NAME -.Nm mxfe -.Nd Macronix Fast Ethernet device driver -.Sh SYNOPSIS -.Pa /dev/mxfe -.Sh DESCRIPTION -The -.Nm -driver provides support for the -Macronix 98715 family (including the Lite-On PNIC-II) of Fast Ethernet -PCI controllers. -.Lp -These devices generally support the standard Fast Ethernet features, including -10BASE-T and 100BASE-TX, both full and half duplex operation, IEEE 802.3 -autonegotiation, etc. -They also support full size MTUs (1500 bytes), even when used with VLANs. -. -.Lp -The device driver supports the -.Xr ieee802.3 5 -properties, which can be configured with -.Xr dladm 1M . -.Sh FILES -.Bl -tag -width /dev/mxfe -.It Pa /dev/mxfe -Special character device. -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr ifconfig 1M , -.Xr pci 4 , -.Xr ieee802.3 5 , -.Xr dlpi 7P -.Rs -.%T IEEE 802.3: Ethernet -.%Q IEEE Standards Association -.Re diff --git a/usr/src/man/man7d/myri10ge.7d b/usr/src/man/man7d/myri10ge.7d deleted file mode 100644 index 682339de18..0000000000 --- a/usr/src/man/man7d/myri10ge.7d +++ /dev/null @@ -1,188 +0,0 @@ -'\" te -.\" Copyright (c) 2007-2009 Myricom, Inc. All Rights Reserved. Use is subject to license terms. -.\" Portions 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 MYRI10GE 7D "Sep 10, 2009" -.SH NAME -myri10ge \- Myricom Myri10GE 10Gb PCI Express NIC Driver -.SH SYNOPSIS -.LP -.nf -/dev/myri10ge* -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBmyri10ge\fR Gigabit Ethernet driver is a multi-threaded, loadable, -clonable, GLD-based STREAMS driver that supports the Data Link Provider -Interface, \fBdlpi\fR(7P), on Myricom Myri10GE 10-Gigabit Ethernet controllers. -.sp -.LP -The \fBmyri10ge\fR driver functions include controller initialization, frame -transmit and receive, promiscuous and multicast support, multiple transmit and -receive queues, support for TCP Large Send Offload, support for TCP Large -Receive Offload, and error recovery and reporting. -.SS "Application Programming Interface" -.sp -.LP -The cloning character-special device, \fB/dev/myri10ge\fR, is used to access -all Myricom Myri10GE 10 -Gigabit Ethernet dev ices installed within the system. -.sp -.LP -The \fBmyri10ge\fR driver is managed by the \fBdladm\fR(1M) command line -utility. dladm allows VLANs to be defined on top of \fBmyri10ge\fR instances -and for \fBmyri10ge\fR instances to be aggregated. See \fBdladm\fR(1M) for more -details. -.sp -.LP -You must send an explicit \fBDL_ATTACH_REQ\fR message to associate the opened -stream with a particular device (\fBPPA\fR). The \fBPPA\fR ID is interpreted as -an unsigned integer data type and indicates the corresponding device instance -(unit) number. The driver returns an error (\fBDL_ERROR_ACK\fR) if the -\fBPPA\fR field value does not correspond to a valid device instance number for -the system. The device is initialized on first attach and de-initialized -(stopped) at last detach. -.sp -.LP -The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in -response to your \fBDL_INFO_REQ\fR are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum \fBSDU\fR is \fB9000\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum \fBSDU\fR is \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBDLSAP\fR address length is \fB8\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBMAC\fR type is \fBDL_ETHER\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBSAP\fR (Service Access Point) length value is \fB-2\fR, meaning the physical -address component is followed immediately by a 2-byte \fBSAP\fR component -within the \fBDLSAP\fR address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is the Ethernet/IEEE broad- cast address -(\fBFF:FF:FF:FF:FF:FF\fR). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Once in the \fBDL_ATTACHED\fR state, you must send a \fBDL_BIND_REQ\fR to -associate a particular SAP with the stream. -.RE -.SS "Configuration" -.sp -.LP -Link speed and mode can only be 10000 Mbps full-duplex. See the \fIIEEE 802.3 -Standard\fR for more information. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/myri10ge*\fR\fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/myri10ge\fR\fR -.ad -.sp .6 -.RS 4n -32-bit device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/myri10ge\fR\fR -.ad -.sp .6 -.RS 4n -64-bit device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/myri10ge\fR\fR -.ad -.sp .6 -.RS 4n -64-bit device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/myri10ge.conf\fR\fR -.ad -.sp .6 -.RS 4n -Configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), -\fBdlpi\fR(7P), \fBstreamio\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fINetwork Interface Guide\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fIIEEE 802.3 Standard\fR diff --git a/usr/src/man/man7d/n2rng.7d b/usr/src/man/man7d/n2rng.7d deleted file mode 100644 index e851b7bd9e..0000000000 --- a/usr/src/man/man7d/n2rng.7d +++ /dev/null @@ -1,171 +0,0 @@ -'\" te -.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright (c) 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 N2RNG 7D "Jan 12, 2020" -.SH NAME -n2rng \- Ultra-SPARC T2 random number generator device driver -.SH DESCRIPTION -The \fBn2rng\fR device driver is a multi-threaded, loadable hardware driver -supporting hardware assisted random numbers. -This support is built into the Ultra-SPARC T2 and later processors. -.sp -.LP -The \fBn2rng\fR driver requires the presence of the Solaris Cryptographic -Framework to enable applications and kernel clients to access the provided -services. -.SH CONFIGURATION -You configure the \fBn2rng\fR driver by defining properties in -\fB/platform/sun4v/kernel/drv/n2rng.conf\fR which override the default settings. -The following property is supported: -.sp -.ne 2 -.na -\fBnostats\fR -.ad -.RS 28n -Disables the generation of statistics. -The nostats property may be used to help prevent traffic analysis, however, -this may inhibit support personnel. -.RE - -.SH CRYPTO STATISTICS -Solaris crypto drivers must implement statistics variables. -Statistics reported by \fBn2rng\fR may be read using the \fBkstat\fR(1M) -utility. -The \fBn2rng\fR driver maintains the following statistics: -.sp -.ne 2 -.na -\fBstatus\fR -.ad -.RS 28n -Status (online, offline, fail) of RNG device. -.RE - -.sp -.ne 2 -.na -\fBrngjobs\fR -.ad -.RS 28n -Number of requests for random data. -.RE - -.sp -.ne 2 -.na -\fBrngbytes\fR -.ad -.RS 28n -Number of bytes read from the RNG device. -.RE - -.SH KERNEL STATISTICS -The \fBn2rng\fR driver tallies a set of kernel driver statistics when in the -Control domain. -Statistics reported by \fBn2rng\fR may be read using the \fBkstat\fR(1M) -utility. -.sp -.ne 2 -.na -\fBrng(n)-cell0-bias\fR -.ad -.RS 28n -Bias setting for noise cell 0 of RNG \fIn\fR. -.RE - -.sp -.ne 2 -.na -\fBrng(n)-cell0-entropy\fR -.ad -.RS 28n -Entropy value for noise cell 0 of RNG \fIn\fR. -.RE - -.sp -.ne 2 -.na -\fBrng(n)-cell1-bias\fR -.ad -.RS 28n -Bias setting for noise cell 1 of RNG \fIn\fR. -.RE - -.sp -.ne 2 -.na -\fBrng(n)-cell1-entropy\fR -.ad -.RS 28n -Entropy value for noise cell 1 of RNG \fIn\fR. -.RE - -.sp -.ne 2 -.na -\fBrng(n)-cell2-bias\fR -.ad -.RS 28n -Bias setting for noise cell 2 of RNG \fIn\fR. -.RE - -.sp -.ne 2 -.na -\fBrng(n)-cell2-entropy\fR -.ad -.RS 28n -Entropy value for noise cell 2 of RNG \fIn\fR. -.RE - -.sp -.ne 2 -.na -\fBrng(n)-state\fR -.ad -.RS 28n -State of rng number n (online, offline, error, health check). -.RE - -.SH FILES -.ne 2 -.na -\fB/platform/sun4v/kernel/drv/sparcv9/n2rng\fR -.ad -.sp .6 -.RS 4n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB/platform/sun4v/kernel/drv/n2rng.conf\fR -.ad -.sp .6 -.RS 4n -Driver configuration file -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -_ -Interface stability Committed -.TE - -.SH SEE ALSO -\fBcryptoadm\fR(1M), \fBkstat\fR(1M), \fBattributes\fR(5) diff --git a/usr/src/man/man7d/npe.7d b/usr/src/man/man7d/npe.7d deleted file mode 100644 index e00dd4932e..0000000000 --- a/usr/src/man/man7d/npe.7d +++ /dev/null @@ -1,72 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 NPE 7D "Oct 12, 2005" -.SH NAME -npe \- PCI Express bus nexus driver -.SH DESCRIPTION -.sp -.LP -The \fBnpe\fR nexus driver is used on X64 servers for PCI Express Root Complex -devices that provide PCI Express interconnect. This driver is compliant to PCI -Express base specification, Revision 1.0a. -.sp -.LP -This nexus driver provides support for the following features: Access to -extended configuration space, IEEE 1275 extensions for PCI Express, Base line -PCI Express error handling and PCI Express MSI interrupts. -.SH FILES -.sp -.ne 2 -.na -\fB/platform/i86pc/kernel/drv/npe\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB/platform/i86pc/kernel/drv/amd64/npe\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x64 PCI Express-based systems -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBpcie\fR(4), \fBpcie_pci\fR(7D) -.sp -.LP -\fIPCI Express Base Specification v1.0a\fR \(em 2003 -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIIEEE 1275 PCI Bus Binding\fR \(em 1998 -.sp -.LP -\fIhttp://playground.sun.com/1275/bindings/pci/pci-express.txt\fR diff --git a/usr/src/man/man7d/ntwdt.7d b/usr/src/man/man7d/ntwdt.7d deleted file mode 100644 index 553c8c7a38..0000000000 --- a/usr/src/man/man7d/ntwdt.7d +++ /dev/null @@ -1,99 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 NTWDT 7D "Jan 10, 2020" -.SH NAME -ntwdt \- Netra\(embased application watchdog timer driver -.SH SYNOPSIS -.nf -/dev/ntwdt -.fi - -.SH DESCRIPTION -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. -.sp -.LP -The \fBntwdt\fR driver implements a \fBvirtual watchdog timer\fR that a -privileged application (Effective UID == 0) controls via IOCTLs. -.SH CONFIGURATION -You configure the \fBntwdt\fR driver by modifying the contents of the -\fBntwdt.conf\fR file. -.SH ERRORS -An \fBopen()\fR fails if: -.sp -.ne 2 -.na -\fBEPERM\fR -.ad -.RS 10n -Effective user ID is not zero. -.RE - -.sp -.ne 2 -.na -\fBENOENT\fR -.ad -.RS 10n -\fB/dev/ntwdt\fR is not present or driver is not installed. -.RE - -.sp -.ne 2 -.na -\fBEAGAIN\fR -.ad -.RS 10n -\fB/dev/ntwdt\fR has already been successfully open()'d. -.RE - -.SH FILES -.ne 2 -.na -\fB/dev/ntwdt\fR -.ad -.RS 28n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/sparcv9/ntwdt\fR -.ad -.RS 28n -Device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/ntwdt.conf\fR -.ad -.RS 28n -Driver configuration file -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -\fBdriver.conf\fR(4), \fBattributes\fR(5) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man7d/ntxn.7d b/usr/src/man/man7d/ntxn.7d deleted file mode 100644 index 6b14a1cc68..0000000000 --- a/usr/src/man/man7d/ntxn.7d +++ /dev/null @@ -1,153 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 NTXN 7D "Oct 13, 2008" -.SH NAME -ntxn \- NetXen 10/1 Gigabit Ethernet network driver -.SH SYNOPSIS -.LP -.nf -\fB/dev/ntxn*\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBntxn\fR 10/1 Gigabit Ethernet driver is a multi-threaded, loadable, -clonable, GLD-based STREAMS driver supporting the Data Link Provider Interface, -\fBdlpi\fR(7P), on NetXen 10/1 Gigabit Ethernet controllers. -.sp -.LP -The \fBntxn\fR driver functions include chip initialization, frames transmit -and receive, promiscuous and multicast support, TCP and UDP checksum off-load -(IPv4) and 9600 bytes jumbo frame. -.sp -.LP -The \fBntxn\fR driver and hardware support the 10GBASE CX4, 10GBASE-SR/W, LR/W, -and 10/100/1000BASE-T physical layers. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning character-special device, \fB/dev/ntxn\fR, is used to access all -NetXen devices installed within the system. -.sp -.LP -The \fBntxn\fR driver is managed by the \fBdladm\fR(1M) command line utility, -which allows VLANs to be defined on top of \fBntxn\fR instances and for -\fBntxn\fR instances to be aggregated. See \fBdladm\fR(1M) for more details. -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to -your DL_INFO_REQ are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU is 9600. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -DLSAP address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is DL_ETHER. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -SAP (Service Access Point) length value is -2, meaning the physical address -component is followed immediately by a 2-byte SAP component within the DLSAP -address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is the Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.RE -.SH CONFIGURATION -.sp -.LP -By default, the \fBntxn\fR driver works without any configuration file. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/ntxn*\fR\fR -.ad -.RS 26n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ntxn\fR\fR -.ad -.RS 26n -32-bit device driver (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ntxn\fR\fR -.ad -.RS 26n -64-bit device driver (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ntxn.conf\fR\fR -.ad -.RS 26n -Configuration file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -l l -l l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Architecture x86 -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBndd\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), -\fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7P) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR diff --git a/usr/src/man/man7d/null.7d b/usr/src/man/man7d/null.7d deleted file mode 100644 index 4c8cec2277..0000000000 --- a/usr/src/man/man7d/null.7d +++ /dev/null @@ -1,44 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (C) 2001, 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 NULL 7D "Apr 4, 2001" -.SH NAME -null \- the null file, also called the null device -.SH SYNOPSIS -.LP -.nf -\fB/dev/null\fR -.fi - -.SH DESCRIPTION -.sp -.LP -Data written on the null special file, \fB/dev/null\fR, is discarded. -.sp -.LP -Reads from a null special file always return 0 bytes. -.sp -.LP -Mapping a null special file creates an address reservation of a length equal to -the length of the mapping, and rounded up to the nearest page size as returned -by \fBsysconf\fR(3C). No resources are consumed by the reservation. Mappings -can be placed in the resulting address range via subsequent calls to \fBmmap\fR -with the \fB-MAP_FIXED\fR option set. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/null\fR\fR -.ad -.RS 13n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBmmap\fR(2), \fBsysconf\fR(3C) diff --git a/usr/src/man/man7d/nulldriver.7d b/usr/src/man/man7d/nulldriver.7d deleted file mode 100644 index e21efee16d..0000000000 --- a/usr/src/man/man7d/nulldriver.7d +++ /dev/null @@ -1,22 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 NULLDRIVER 7D "Nov 8, 2008" -.SH NAME -nulldriver \- Null driver -.SH DESCRIPTION -.sp -.LP -This driver succeeds \fBprobe\fR(9E), \fBattach\fR(9E) and \fBdetach\fR(9E) but -provides no namespace or functionality. -.sp -.LP -In some circumstances having device nodes bound to \fBnulldriver\fR is -expected. For example, \fBprtconf\fR(1M) might capture a nexus driver with a -\fBnulldriver\fR bound child if the nexus is performing child discovery. -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBattach\fR(9E), \fBdetach\fR(9E), \fBprobe\fR(9E) diff --git a/usr/src/man/man7d/nv_sata.7d b/usr/src/man/man7d/nv_sata.7d deleted file mode 100644 index 29f2b145a6..0000000000 --- a/usr/src/man/man7d/nv_sata.7d +++ /dev/null @@ -1,71 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 2011 Nexenta Systems, 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 NV_SATA 7D "Sep 25, 2011" -.SH NAME -nv_sata \- NVIDIA CK804/MCP04/MCP51/MCP55/MCP61 SATA controller driver -.SH SYNOPSIS -.LP -.nf -\fBsata@unit-address\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBnv_sata\fR driver is a SATA HBA driver that supports NVIDIA CK804/MCP04 -and MCP51/MCP55/MCP61 SATA HBA controllers. Note that while these controllers -support standard SATA features including SATA-II drives, NCQ, hotplug and ATAPI -drives, the driver currently does not support NCQ features. -.SH CONFIGURATION -.sp -.LP -The \fBnv_sata\fR module contains no user configurable parameters. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/nv_sata\fR\fR -.ad -.sp .6 -.RS 4n -32-bit \fBELF\fR kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/nv_sata\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBELF\fR kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attribute: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBcfgadm\fR(1M), \fBcfgadm_sata\fR(1M), \fBprtconf\fR(1M), \fBsata\fR(7D), -\fBsd\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man7d/nvme.7d b/usr/src/man/man7d/nvme.7d deleted file mode 100644 index e7b2dda4c4..0000000000 --- a/usr/src/man/man7d/nvme.7d +++ /dev/null @@ -1,141 +0,0 @@ -.\" -.\" 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 2016 Nexenta Systems, Inc. All rights reserved. -.\" Copyright (c) 2018, Joyent, Inc. -.\" Copyright 2019, Western Digital Corporation -.\" -.Dd January 22, 2022 -.Dt NVME 7D -.Os -.Sh NAME -.Nm nvme -.Nd Intel NVMe compliant storage driver -.Sh DESCRIPTION -The -.Nm -driver uses the -.Xr blkdev 7D -framework to provide access to -NVMe compliant solid-state storage devices. -All NVMe version 1.x devices are supported. -.Lp -NVMe devices supporting multiple namespaces will present each -namespace as its own -.Xr blkdev 7D -instance in the system. -. -.Sh CONFIGURATION -The -.Nm -driver can be configured by defining properties in the -.Pa nvme.conf -file. -The parameters are considered an unstable interface, subject to -change without notice. -The following properties are currently supported: -.Bl -tag -width Va -.It Va strict-version -This can be set to 0 to allow -.Nm -to attach to devices supporting newer version of the NVMe -specification. -The default value is 1, limiting -.Nm -to work with devices that support major version 1. -.It Va ignore-unknown-vendor-status -This can be set to 1 to allow -.Nm -to continue operating even if it receives an unknown vendor command -status. -.It Va admin-queue-len -This is the number of entries in the admin command queue. -Legal values are between 16 and 4096, the default value is 256. -.It Va io-squeue-len -This is the number of entries in each I/O submission queue. -Legal values are between 16 and 65536, the default value is 1024. -.It Va io-cqueue-len -This is the number of entries in each I/O completion queue. -Legal values are between 16 and 65536, the default value is 2048. -When the number of submission and completion queues are the same, -the queue lengths will be both set to the lesser of -.Va io-squeue-len -and -.Va io-cqueue-len . -.It Va async-event-limit -This is the maximum number of asynchronous event requests issued by -the driver. -Asynchronous events are used to report error conditions. -The driver will never use more asynchronous events than this value, or -what the hardware supports if it is less, or 1/10th of the admin queue -length if it is less. -.It Va volatile-write-cache-enable -This property can be set to 0 to disable the volatile write cache, if -the hardware supports it. -The default setting is 1, which enables the volatile write cache. -.It Va min-phys-block-size -This is the minimum physical block size that is reported to -.Xr blkdev 7d . -This value must be a power of 2 greater than or equal to 512. -If the device reports a best block size larger than what is -specified here the driver will ignore the value specified here. -.It Va max-submission-queues -This is the maximum number of submission queues the driver will create per -device. -Legal values are between 1 and 65535, the default is to -match the number for -.Em max-completion-queues . -The number of queues created will not be allowed to exceed the -drive's hardware limitation. -If the number of submission queues is larger than -.Em max-completion-queues -the completion queues will be shared across the submission -queues. -.It Va max-completion-queues -This is the maximum number of completion queues the driver will create per -device. -Legal values are between 1 and 65535, the default is to match -the number of interrupt vectors allocated to the drive. -The number of queues created will not exceed the number of interrupt vectors, -.Em max-submission-queues , -or the drive's hardware limitation. -.El -. -.Sh FILES -.Bl -tag -compact -width Pa -.It Pa /dev/dsk/cntnd0sn -Block device minor nodes. -.It Pa /dev/rdsk/cntnd0sn -Raw block device minor nodes. -.El -.Lp -In the device minor nodes, the following substitutions may occur: -.Bl -tag -offset indent -width Va -.It Va cn -A controller number, typically one for each -.Nm -device found. -Controller numbers are dynamically assigned by the system. -.It Va tn -The target number. -This is the namespace EUI64 if available, or the namespace ID used by -the hardware. -Namespace ID 0 is reserved, hence target numbers start with 1. -.It Va sn -This is the -.Em slice -number, representing a subset of the disk. -See -.Xr dkio 7I . -.El -. -.Sh SEE ALSO -.Xr blkdev 7D diff --git a/usr/src/man/man7d/nxge.7d b/usr/src/man/man7d/nxge.7d deleted file mode 100644 index b940e85cae..0000000000 --- a/usr/src/man/man7d/nxge.7d +++ /dev/null @@ -1,239 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 NXGE 7D "Apr 12, 2008" -.SH NAME -nxge \- Sun 10/1 Gigabit Ethernet network driver -.SH SYNOPSIS -.LP -.nf -/dev/nxge* -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBnxge\fR Gigabit Ethernet driver is a multi-threaded, loadable, clonable, -GLD-based STREAMS driver supporting the Data Link Provider Interface, -\fBdlpi\fR(7P), on Sun Gigabit Ethernet hardware (NIU, Sun x8, Express Dual 10 -Gigabit Ethernet fiber XFP low profile adapter and the 10/100/1000BASE-T x8 -Express low profile adapter). -.sp -.LP -The \fBnxge\fR driver functions include chip initialization, frame transmit and -receive, flow classification, multicast and promiscuous support, and error -recovery and reporting. -.sp -.LP -The \fBnxge\fR device provides fully-compliant \fIIEEE 802.3ae\fR 10Gb/s full -duplex operation using XFP-based 10GigE optics (NIU, dual 10 Gigabit fiber XFP -adapter). The Sun Ethernet hardware supports the \fIIEEE 802.3x\fR frame-based -flow control capabilities. -.sp -.LP -For the 10/100/1000BASE-T adapter, the \fBnxge\fR driver and hardware support -auto-negotiation, a protocol specified by the \fI1000 Base-T\fR standard. -Auto-negotiation allows each device to advertise its capabilities and discover -those of its peer (link partner). The highest common denominator supported by -both link partners is automatically selected, yielding the greatest available -throughput while requiring no manual configuration. The \fBnxge\fR driver also -allows you to configure the advertised capabilities to less than the maximum -(where the full speed of the interface is not required) or to force a specific -mode of operation, irrespective of the link partner's advertised capabilities. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning character-special device, \fB/dev/nxge\fR, is used to access all -Sun Neptune NIU devices installed within the system. -.sp -.LP -The \fBnxge\fR driver is managed by the \fBdladm\fR(1M) command line utility, -which allows VLANs to be defined on top of \fBnxge\fR instances and for -\fBnxge\fR instances to be aggregated. See \fBdladm\fR(1M) for more details. -.sp -.LP -You must send an explicit DL_ATTACH_REQ message to associate the opened stream -with a particular device (PPA). The PPA ID is interpreted as an unsigned -integer data type and indicates the corresponding device instance (unit) -number. The driver returns an error (DL_ERROR_ACK) if the PPA field value does -not correspond to a valid device instance number for the system. The device is -initialized on first attach and de-initialized (stopped) at last detach. -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to a -DL_INFO_REQ are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU (default 1500). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU (default 0). The driver pads to the mandatory 60-octet minimum -packet size. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -DLSAP address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MAC type is \fBDL_ETHER\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBSAP\fR length value is \fI-2\fR, meaning the physical address component is -followed immediately by a 2-byte \fBSAP\fR component within the \fBDLSAP\fR -address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is the Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.sp -Due to the nature of link address definition for IPoIB, the -DL_SET_PHYS_ADDR_REQ DLPI primitive is not supported. -.sp -In the transmit case for streams that have been put in raw mode via the -DLIOCRAW ioctl, the dlpi application must prepend the 20 byte IPoIB destination -address to the data it wants to transmit over-the-wire. In the receive case, -applications receive the IP/ARP datagram along with the IETF defined 4 byte -header. -.RE -.sp -.LP -Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a -particular Service Access Point (SAP) with the stream. -.SH CONFIGURATION -.sp -.LP -For the \fI10/100/1000BASE-T\fR adapter, the \fBnxge\fR driver performs -auto-negotiation to select the link speed and mode. Link speed and mode may be -10000 Mbps full-duplex (10 Gigabit adapter), 1000 Mbps full-duplex, 100 Mbps -full-duplex, or 10 Mbps full-duplex, depending on the hardware adapter type. -See the \fI IEEE802.3\fR standard for more information. -.sp -.LP -The auto-negotiation protocol automatically selects the 1000 Mbps, 100 Mbps, or -10 Mbps operation modes (full-duplex only) as the highest common denominator -supported by both link partners. Because the \fBnxge\fR device supports all -modes, the effect is to select the highest throughput mode supported by the -other device. -.sp -.LP -You can also set the capabilities advertised by the \fBnxge\fR device using -\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 operation. 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 -.in +2 -.nf - (highest priority/greatest throughput) - en_1000fdx_cap 1000Mbps full duplex - en_100fdx_cap 100Mbps full duplex - en_10fdx_cap 10Mbps full duplex - (lowest priority/least throughput) -.fi -.in -2 - -.sp -.LP -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 FILES -.sp -.ne 2 -.na -\fB\fB/dev/nxge*\fR\fR -.ad -.RS 28n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/nxge\fR\fR -.ad -.RS 28n -32-bit device driver (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/nxge\fR\fR -.ad -.RS 28n -64-bit device driver (SPARC). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/nxge\fR\fR -.ad -.RS 28n -64-bit device driver (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/nxge.conf\fR\fR -.ad -.RS 28n -Configuration file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBnetstat\fR(1M), \fBattributes\fR(5), \fBstreamio\fR(7I), -\fBdlpi\fR(7P), \fBdriver.conf\fR(4) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR -.sp -.LP -\fIIEEE 802.3ae Specification\fR \(em 2002 diff --git a/usr/src/man/man7d/ohci.7d b/usr/src/man/man7d/ohci.7d deleted file mode 100644 index 922cd18bfd..0000000000 --- a/usr/src/man/man7d/ohci.7d +++ /dev/null @@ -1,154 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 OHCI 7D "May 13, 2017" -.SH NAME -ohci \- OpenHCI host controller driver -.SH SYNOPSIS -.LP -.nf -\fBusb@unit-address\fR -.fi - -.SH DESCRIPTION -.LP -The \fBohci\fR driver is a USBA (Solaris USB Architecture) compliant nexus -driver that supports the \fIOpen Host Controller Interface Specification -1.1\fR, an industry standard developed by Compaq, Microsoft, and National -Semiconductor. -.sp -.LP -The \fBohci\fR driver supports bulk, interrupt, control and isochronous -transfers. -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/ohci\fR\fR -.ad -.RS 28n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ohci\fR\fR -.ad -.RS 28n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/ohci\fR\fR -.ad -.RS 28n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ohci.conf\fR\fR -.ad -.RS 28n -driver configuration file -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBattributes\fR(5), \fBehci\fR(7D), \fBhubd\fR(7D), \fBuhci\fR(7D), -\fBusba\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Serial Bus Specification 2.0\fR -.sp -.LP -\fIOpen Host Controller Interface Specification for USB 1.0a\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH DIAGNOSTICS -.LP -All host controller errors are passed to the client drivers. Root hub errors -are documented in \fBhubd\fR(7D). -.sp -.LP -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -WARNING: <device path> <ohci><instance number>>: Error message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBUnrecoverable USB Hardware Error.\fR -.ad -.sp .6 -.RS 4n -There was an unrecoverable USB hardware error reported by the OHCI Controller. -Please reboot the system. If this problem persists, contact your system vendor. -.RE - -.sp -.ne 2 -.na -\fBNo SOF interrupts have been received. This OHCI USB controller is -unusable.\fR -.ad -.sp .6 -.RS 4n -The USB hardware is not generating Start Of Frame interrupts. Please reboot the -system. If this problem persists, contact your system vendor. -.RE - -.sp -.LP -The following messages may be entered into the system log. They are formatted -in the following manner: -.sp -.in +2 -.nf -<device path> <ohci<instance number>): Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBFailed to program frame interval register.\fR -.ad -.sp .6 -.RS 4n -For an unspecified reason, the frame interval register has been nulled out by -the Uli M1575 chip. Please reboot the system. If this problem persists, contact -your system vendor. -.RE - diff --git a/usr/src/man/man7d/openprom.7d b/usr/src/man/man7d/openprom.7d deleted file mode 100644 index bc60638cdf..0000000000 --- a/usr/src/man/man7d/openprom.7d +++ /dev/null @@ -1,409 +0,0 @@ -'\" te -.\" Copyright (c) 1997, 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 OPENPROM 7D "Jan 13, 1997" -.SH NAME -openprom \- PROM monitor configuration interface -.SH SYNOPSIS -.LP -.nf -#include <sys/fcntl.h> -.fi - -.LP -.nf -#include <sys/types.h> -.fi - -.LP -.nf -#include <sys/openpromio.h> -.fi - -.LP -.nf -open("/dev/openprom", \fImode\fR); -.fi - -.SH DESCRIPTION -.sp -.LP -The internal encoding of the configuration information stored in \fBEEPROM\fR -or \fBNVRAM\fR varies from model to model, and on some systems the encoding is -"hidden" by the firmware. The \fBopenprom\fR driver provides a consistent -interface that allows a user or program to inspect and modify that -configuration, using \fBioctl\fR(2) requests. These requests are defined in -\fB<sys/openpromio.h>\fR: -.sp -.in +2 -.nf -struct openpromio { - uint_t oprom_size; /* real size of following data */ - union { - char b[1]; /* NB: Adjacent, Null terminated */ - int i; - } opio_u; -}; -#define oprom_array opio_u.b /* property name/value array */ -#define oprom_node opio_u.i /* nodeid from navigation config-ops */ -#define oprom_len opio_u.i /* property len from OPROMGETPROPLEN */ -#define OPROMMAXPARAM 32768 /* max size of array (advisory) */ -.fi -.in -2 - -.sp -.LP -For all \fBioctl\fR(2) requests, the third parameter is a pointer to a -\fBstruct openpromio\fR. All property names and values are null-terminated -strings; the value of a numeric option is its \fBASCII\fR representation. -.sp -.LP -For the raw \fBioctl\fR(2) operations shown below that explicitly or implicitly -specify a nodeid, an error may be returned. This is due to the removal of the -node from the firmware device tree by a Dynamic Reconfiguration operation. -Programs should decide if the appropriate response is to restart the scanning -operation from the beginning or terminate, informing the user that the tree has -changed. -.SH IOCTLS -.sp -.ne 2 -.na -\fB\fBOPROMGETOPT\fR\fR -.ad -.RS 19n -This ioctl takes the null-terminated name of a property in the -\fIoprom_array\fR and returns its null-terminated value (overlaying its name). -\fIoprom_size\fR should be set to the size of \fIoprom_array\fR; on return it -will contain the size of the returned value. If the named property does not -exist, or if there is not enough space to hold its value, then \fIoprom_size\fR -will be set to zero. See \fBBUGS\fR below. -.RE - -.sp -.ne 2 -.na -\fB\fBOPROMSETOPT\fR\fR -.ad -.RS 19n -This ioctl takes two adjacent strings in \fIoprom_array\fR; the null-terminated -property name followed by the null-terminated value. -.RE - -.sp -.ne 2 -.na -\fB\fBOPROMSETOPT2\fR\fR -.ad -.RS 19n -This ioctl is similar to \fBOPROMSETOPT,\fR except that it uses the difference -between the actual user array size and the length of the property name plus its -null terminator. -.RE - -.sp -.ne 2 -.na -\fB\fBOPROMNXTOPT\fR\fR -.ad -.RS 19n -This ioctl is used to retrieve properties sequentially. The null-terminated -name of a property is placed into \fIoprom_array\fR and on return it is -replaced with the null-terminated name of the next property in the sequence, -with \fIoprom_size\fR set to its length. A null string on input means return -the name of the first property; an \fIoprom_size\fR of zero on output means -there are no more properties. -.RE - -.sp -.ne 2 -.na -\fB\fBOPROMNXT\fR\fR -.ad -.br -.na -\fB\fBOPROMCHILD\fR\fR -.ad -.br -.na -\fB\fBOPROMGETPROP\fR\fR -.ad -.br -.na -\fB\fBOPROMNXTPROP\fR\fR -.ad -.RS 19n -These ioctls provide an interface to the raw \fIconfig_ops\fR operations in the -\fBPROM\fR monitor. One can use them to traverse the system device tree; see -\fBprtconf\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fBOPROMGETPROPLEN\fR\fR -.ad -.RS 19n -This ioctl provides an interface to the \fIproperty length\fR raw config op. It -takes the name of a property in the buffer, and returns an integer in the -buffer. It returns the integer \fB-1\fR if the property does not exist; \fB0\fR -if the property exists, but has no value (a boolean property); or a positive -integer which is the length of the property as reported by the \fBPROM\fR -monitor. See \fBBUGS\fR below. -.RE - -.sp -.ne 2 -.na -\fB\fBOPROMGETVERSION\fR\fR -.ad -.RS 19n -This ioctl returns an arbitrary and platform-dependent NULL-terminated string -in \fIoprom_array\fR, representing the underlying version of the firmware. -.RE - -.SH ERRORS -.sp -.ne 2 -.na -\fB\fBEAGAIN\fR\fR -.ad -.RS 10n -There are too many opens of the \fB/dev/openprom\fR device. -.RE - -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -A bad address has been passed to an \fBioctl\fR(2) routine. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -The size value was invalid, or (for \fBOPROMSETOPT\fR) the property does -not exist, or an invalid ioctl is being issued, or the ioctl is not supported -by the firmware, or the nodeid specified does not exist in the firmware device -tree. -.RE - -.sp -.ne 2 -.na -\fB\fBENOMEM\fR\fR -.ad -.RS 10n -The kernel could not allocate space to copy the user's structure. -.RE - -.sp -.ne 2 -.na -\fB\fBEPERM\fR\fR -.ad -.RS 10n -Attempts have been made to write to a read-only entity, or read from a write -only entity. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -Attempting to open a non-existent device. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fR\fIoprom_array\fR Data Allocation and Reuse -.sp -.LP -The following example shows how the \fIoprom_array\fR is allocated and reused -for data returned by the driver. - -.sp -.in +2 -.nf -/* - * This program opens the openprom device and prints the platform - * name (root node name property) and the prom version. - * - * NOTE: /dev/openprom is readable only by user 'root' or group 'sys'. - */ -#include <stdio.h> -#include <string.h> -#include <fcntl.h> -#include <errno.h> -#include <unistd.h> -#include <stdlib.h> -#include <sys/openpromio.h> -#define min(a, b) (a < b ? a : b) -#define max(a, b) (a > b ? a : b) -#define MAXNAMESZ 32 /* Maximum property *name* size */ -#define BUFSZ 1024 /* A Handly default buffer size */ -#define MAXVALSZ (BUFSZ - sizeof (int)) -static char *promdev = "/dev/openprom"; -/* - * Allocate an openpromio structure big enough to contain - * a bufsize'd oprom_array. Zero out the structure and - * set the oprom_size field to bufsize. - */ -static struct openpromio * -opp_zalloc(size_t bufsize) -{ - struct openpromio *opp; - opp = malloc(sizeof (struct openpromio) + bufsize); - (void) memset(opp, 0, sizeof (struct openpromio) + bufsize); - opp->oprom_size = bufsize; - return (opp); -} -/* - * Free a 'struct openpromio' allocated by opp_zalloc - */ -static void -opp_free(struct openpromio *opp) -{ - free(opp); -} -/* - * Get the peer node of the given node. The root node is the peer of zero. - * After changing nodes, property lookups apply to that node. The driver - * 'remembers' what node you are in. - */ -static int -peer(int nodeid, int fd) -{ - struct openpromio *opp; - int i; - opp = opp_zalloc(sizeof (int)); - opp->oprom_node = nodeid; - if (ioctl(fd, OPROMNEXT, opp) < 0) { - perror("OPROMNEXT"); - exit(1); - } - i = opp->oprom_node; - opp_free(opp); - return(i); -} -int -main(void) -{ - struct openpromio *opp; - int fd, proplen; - size_t buflen; - if ((fd = open(promdev, O_RDONLY)) < 0) { - fprintf(stderr, "Cannot open openprom device\en"); - exit(1); - } - /* - * Get and print the length and value of the - * root node 'name' property - */ - (void) peer(0, fd); /* Navigate to the root node */ - /* - * Allocate an openpromio structure sized big enough to - * take the string "name" as input and return the int-sized - * length of the 'name' property. - * Then, get the length of the 'name' property. - */ - buflen = max(sizeof (int), strlen("name") + 1); - opp = opp_zalloc(buflen); - (void) strcpy(opp->oprom_array, "name"); - if (ioctl(fd, OPROMGETPROPLEN, opp) < 0) { - perror("OPROMGETPROPLEN"); - /* exit(1); */ - proplen = 0; /* down-rev driver? */ - } else - proplen = opp->oprom_len; - opp_free(opp); - if (proplen == -1) { - printf("'name' property does not exist!\en"); - exit (1); - } - /* - * Allocate an openpromio structure sized big enough - * to take the string 'name' as input and to return - * 'proplen + 1' bytes. Then, get the value of the - * 'name' property. Note how we make sure to size the - * array at least one byte more than the returned length - * to guarantee NULL termination. - */ - buflen = (proplen ? proplen + 1 : MAXVALSZ); - buflen = max(buflen, strlen("name") + 1); - opp = opp_zalloc(buflen); - (void) strcpy(opp->oprom_array, "name"); - if (ioctl(fd, OPROMGETPROP, opp) < 0) { - perror("OPROMGETPROP"); - exit(1); - } - if (opp->oprom_size != 0) - printf("Platform name <%s> property len <%d>\en", - opp->oprom_array, proplen); - opp_free(opp); - /* - * Allocate an openpromio structure assumed to be - * big enough to get the 'prom version string'. - * Get and print the prom version. - */ - opp_zalloc(MAXVALSZ); - opp->oprom_size = MAXVALSZ; - if (ioctl(fd, OPROMGETVERSION, opp) < 0) { - perror("OPROMGETVERSION"); - exit(1); - } - printf("Prom version <%s>\en", opp->oprom_array); - opp_free(opp); - (void) close(fd); - return (0); -} -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/openprom\fR\fR -.ad -.RS 17n -PROM monitor configuration interface -.RE - -.SH SEE ALSO -.sp -.LP -\fBeeprom\fR(1M), \fBmonitor\fR(1M), \fBprtconf\fR(1M), \fBioctl\fR(2), -\fBmem\fR(7D) -.SH BUGS -.sp -.LP -There should be separate return values for non-existent properties as opposed -to not enough space for the value. -.sp -.LP -An attempt to set a property to an illegal value results in the \fBPROM\fR -setting it to some legal value, with no error being returned. An -\fBOPROMGETOPT\fR should be performed after an \fBOPROMSETOPT\fR to verify that -the set worked. -.sp -.LP -Some \fBPROMS\fR \fIlie\fR about the property length of some string properties, -omitting the \fBNULL\fR terminator from the property length. The -\fBopenprom\fR driver attempts to \fItransparently\fR compensate for these bugs -when returning property values by \fBNULL\fR terminating an extra character in -the user buffer if space is available in the user buffer. This extra character -is excluded from the \fIoprom_size\fR field returned from \fBOPROMGETPROP\fR -and \fBOPROMGETOPT\fR and excluded in the \fIoprom_len\fR field returned from -\fBOPROMGETPROPLEN\fR but is returned in the user buffer from the calls that -return data, if the user buffer is allocated at least one byte larger than the -property length. diff --git a/usr/src/man/man7d/oplkmdrv.7d b/usr/src/man/man7d/oplkmdrv.7d deleted file mode 100644 index 6c73dfdb14..0000000000 --- a/usr/src/man/man7d/oplkmdrv.7d +++ /dev/null @@ -1,43 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 OPLKMDRV 7D "Apr 18, 2006" -.SH NAME -oplkmdrv \- key management driver for the SPARC Enterprise Server family -.SH SYNOPSIS -.LP -.nf -\fBkmdrv\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fBoplkmdrv\fR is a character driver that implements a framework for exchanging -the security keys with the Service Processor on a SPARC Enterprise Server. The -\fBoplkmdrv\fR driver is specific to the SPARC Enterprise Server family. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.sp -.LP -\fBattributes\fR(5) -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/oplmsu.7d b/usr/src/man/man7d/oplmsu.7d deleted file mode 100644 index 003f66cf3f..0000000000 --- a/usr/src/man/man7d/oplmsu.7d +++ /dev/null @@ -1,42 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 OPLMSU 7D "Apr 18, 2006" -.SH NAME -oplmsu \- Serial I/O multiplexing STREAMS device driver -.SH SYNOPSIS -.LP -.nf -\fB/pseudo-console\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBoplmsu\fR driver is a STREAMS multiplexer driver that connects multiple -serial devices to the system console. -.sp -.LP -Currently, this support is provided only on a SPARC Enterprise Server. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/oplpanel.7d b/usr/src/man/man7d/oplpanel.7d deleted file mode 100644 index 21a658aa64..0000000000 --- a/usr/src/man/man7d/oplpanel.7d +++ /dev/null @@ -1,34 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 OPLPANEL 7D "Apr 18, 2006" -.SH NAME -oplpanel \- device driver for the SPARC Enterprise Server family -.SH DESCRIPTION -.sp -.LP -The \fBoplpanel\fR device driver monitors the panel reset button. If the button -is pressed, a high-level interrupt is generated, and the \fBoplpanel\fR driver -causes a system panic. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/pchtemp.7d b/usr/src/man/man7d/pchtemp.7d deleted file mode 100644 index 954a7d76f3..0000000000 --- a/usr/src/man/man7d/pchtemp.7d +++ /dev/null @@ -1,76 +0,0 @@ -.\" -.\" 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. -.\" Copyright 2021 Oxide Computer Company -.\" -.Dd January 21, 2021 -.Dt PCHTEMP 7D -.Os -.Sh NAME -.Nm pchtemp -.Nd Intel platform controller hub temperature sensor driver -.Sh SYNOPSIS -.Pa /dev/sensors/temperature/pch/* -.Sh DESCRIPTION -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 family -(non-Atom) CPUs starting with the Haswell generation: -.Bl -dash -.It -Intel 8 Series / C220 Series Chipset Platform Controller Hub -.It -Intel 9 Series Chipset Family Platform Controller Hub -.It -Intel Mobile 5th Generation Processor Family (Broadwell-U) -.It -Intel C610 Series Chipset and X99 Chipset Platform Controller Hub -.It -Intel 100 Series Chipset Family Platform Controller Hub -.It -Intel C620 Series Chipset Platform Controller Hub -.It -Intel 200 and Z370 Series Chipset Families Platform Controller Hub -.It -Intel 7th/8th Generation Processor Family U/Y Platforms -.It -Intel 300 Series and Intel C240 Series Chipset Family Platform -Controller Hub -.It -Intel 400 Series Chipset Family On-Package Platform Controller Hub -.It -Intel 400 Series Chipset Family Platform Controller Hub -.El -.Pp -Temperature information is available to the system via the fault -management architecture -.Pq FMA . -The file system location and programming interface to the -.Nm -driver are considered -.Sy Volatile , -subject to change without notice, and should not be used directly. -Raw temperature information can be dumped through the FMA developer -utility -.Sy fmtopo . -.Sh SEE ALSO -.Xr fmadm 1M -.Rs -.%A Intel Corporation -.%B Intel 300 Series and Intel C240 Series Chipset Family Platform Controller Hub -.%D March 2019 -.%O Document Number 337347-005 -.%V 1 -.%U https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/300-series-chipset-pch-datasheet-vol-1.pdf -.Re diff --git a/usr/src/man/man7d/pcic.7d b/usr/src/man/man7d/pcic.7d deleted file mode 100644 index 8d74265931..0000000000 --- a/usr/src/man/man7d/pcic.7d +++ /dev/null @@ -1,112 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 PCIC 7D "Jun 27, 2006" -.SH NAME -pcic \- Intel i82365SL PC Card Interface Controller -.SH DESCRIPTION -.sp -.LP -The Intel i82365SL PC Card interface controller provides one or more \fBPCMCIA -PC\fR card sockets. The \fBpcic\fR driver implements a \fBPCMCIA\fR bus nexus -driver. -.sp -.LP -The driver provides basic support for the Intel 82365SL and compatible chips. -Tested chips are: -.RS +4 -.TP -.ie t \(bu -.el o -Intel \(em 82365SL. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Cirrus Logic \(em PD6710/PD6720/PD6722. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Vadem \(em VG365/VG465/VG468/VG469. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Toshiba \(em PCIC and ToPIC -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Ricoh \(em RF5C366/RL5C466/RL5C475/RL5C476/RL5C477/RL5C478. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -02Micro \(em OZ6912/6972. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Texas Instruments \(em PCI1130/PCI1131/PCI1031/PCI1221/PCI1225/PCI1520/PCI -1410/PCI1420/PCI4520/PCI7510/PCI7621. -.RE -.sp -.LP -While most systems using one of the above chips will work, some systems are not -supported due to hardware designs options that may not be software detectable. -.sp -.LP -Direct access to the \fBPCMCIA\fR hardware is not supported. All device access -must be through the DDI. -.SH CONFIGURATION -.sp -.LP -Configuration of PC Card interface controllers are automatically done in the -system by leveraging ACPI on x86 (or OBP on SPARC). Configuration includes -allocation of device memory, I/O ports, CardBus subordinary bus number and -interrupts. There is no user-interference required. Note that the -controller may not work when ACPI is disabled. -.sp -.LP -There is one driver configuration property defined in the \fBpcic.conf\fR file: -.sp -.ne 2 -.na -\fB\fBinterrupt-priorities=6;\fR\fR -.ad -.RS 27n -This property must be defined and must be below 10. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/pcic\fR\fR -.ad -.RS 25n -\fBpcic\fR driver. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/pcic.conf\fR\fR -.ad -.RS 25n -\fBpcic\fR configuration file. -.RE - -.SH SEE ALSO -.sp -.LP -\fBcardbus\fR(4), \fBstp4020\fR(7D), \fBpcmcia\fR(7D) diff --git a/usr/src/man/man7d/pcicmu.7d b/usr/src/man/man7d/pcicmu.7d deleted file mode 100644 index d487645c06..0000000000 --- a/usr/src/man/man7d/pcicmu.7d +++ /dev/null @@ -1,33 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 PCICMU 7D "Apr 18, 2006" -.SH NAME -pcicmu \- PCI bus nexus driver for the SPARC Enterprise Server family -.SH DESCRIPTION -.sp -.LP -The \fBpcicmu\fR nexus driver is used for onboard devices for the SPARC -Enterprise Server family. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/pcipsy.7d b/usr/src/man/man7d/pcipsy.7d deleted file mode 100644 index 327c700827..0000000000 --- a/usr/src/man/man7d/pcipsy.7d +++ /dev/null @@ -1,26 +0,0 @@ -'\" te -.\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 2019 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 PCIPSY 7D "Jan 28, 2019" -.SH NAME -pcipsy \- PCI bus to Safari bus nexus driver -.SH DESCRIPTION -.LP -The \fBpcipsy\fR nexus driver is used for certain IO assemblies for sun4u -servers. -.SH FILES -.ne 2 -.na -\fB/platform/sun4u/kernel/drv/sparcv9/pcipsy\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. -.RE - -.SH SEE ALSO -.LP -\fBpcisch\fR(7D) diff --git a/usr/src/man/man7d/pcisch.7d b/usr/src/man/man7d/pcisch.7d deleted file mode 100644 index a484f11c0b..0000000000 --- a/usr/src/man/man7d/pcisch.7d +++ /dev/null @@ -1,29 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 PCISCH 7D "May 26, 2005" -.SH NAME -pcisch \- PCI Bus to Safari bus nexus driver -.SH DESCRIPTION -.sp -.LP -The \fBpcisch\fR nexus driver is used for Schizo and XMITS-based I/O assemblies -for the following high-end and midrange Sun enterprise servers: Sun Fire E15K, -Sun Fire E25K, Sun Fire E2900, Sun Fire E4900 and Sun Fire E6900. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/platform/sun4u/kernel/drv/sparcv9/pcisch\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. -.RE - -.SH SEE ALSO -.sp -.LP -\fBpcipsy\fR(7D) diff --git a/usr/src/man/man7d/pcmcia.7d b/usr/src/man/man7d/pcmcia.7d deleted file mode 100644 index 415b94047b..0000000000 --- a/usr/src/man/man7d/pcmcia.7d +++ /dev/null @@ -1,27 +0,0 @@ -'\" te -.\" Copyright (c) 1996, 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 PCMCIA 7D "Feb 28, 2005" -.SH NAME -pcmcia \- PCMCIA nexus driver -.SH DESCRIPTION -.sp -.LP -The \fBPCMCIA\fR nexus driver supports \fBPCMCIA\fR card client device -drivers. There are no user-configurable options for this driver. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/misc/pcmcia\fR\fR -.ad -.RS 23n -\fBpcmcia\fR driver -.RE - -.SH SEE ALSO -.sp -.LP -\fBpcmciad\fR(1M) diff --git a/usr/src/man/man7d/pcn.7d b/usr/src/man/man7d/pcn.7d deleted file mode 100644 index f78375239d..0000000000 --- a/usr/src/man/man7d/pcn.7d +++ /dev/null @@ -1,161 +0,0 @@ -'\" te -.\" Copyright 2011 Jason King. All rights reserved. -.\" Copyright (c) 2001-2007 by Garrett D'Amore. -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions are met: -.\" 1. Redistributions of source code must retain the above copyright notice, -.\" this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright notice, -.\" this list of conditions and the following disclaimer in the documentation -.\" and/or other materials provided with the distribution. -.\" 3. Neither the name of the author nor the names of any co-contributors may -.\" be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS -.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED -.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR -.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, -.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, -.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; -.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, -.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR -.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF -.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE -.\" Portions Copyright (c) 2007 by Sun Microsystems, Inc. All Rights Reserved. - -.TH "PCN" "7D" "Jan 10, 2020" -. -.SH "NAME" -\fBpcn\fR \- PCnet Ethernet device driver -.SH "SYNOPSIS" -.nf -\fB/dev/pcn\fR -.fi - -.SH "DESCRIPTION" -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. -.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 -instance number of the \fBpcn\fR controller as assigned by the -operating environment. -.sp -.LP -The values returned by the driver in the \fBDL_INFO_ACK\fR response are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU is 1500. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The dlsap address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -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. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -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). -.SH "CONFIGURATION" -The \fBpcn\fR driver performs auto-negotiation to select the link speed and -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. -.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 -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 -.in +2 -.nf - (highest priority/greatest throughput) - en_100fdx_cap 100Mbps full duplex - en_10fdx_cap 10Mbps full duplex - (lowest priority/least throughput) -.fi -.in -2 - -.sp -.LP -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" -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH "FILES" -.ne 2 -.na -\fB/dev/pcn\fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/amd64/pcn\fR -.ad -.sp .6 -.RS 4n -Device driver (x86) -.RE - -.SH "SEE ALSO" -\fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7p) -.sp -.LP -\fIIEEE 802.3\fR \(em Institute of Electrical and Electronics Engineers, 2002 diff --git a/usr/src/man/man7d/physmem.7d b/usr/src/man/man7d/physmem.7d deleted file mode 100644 index 5881f90aa4..0000000000 --- a/usr/src/man/man7d/physmem.7d +++ /dev/null @@ -1,45 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 PHYSMEM 7D "Nov 15, 2006" -.SH NAME -physmem \- physmem driver -.SH DESCRIPTION -.sp -.LP -The \fBphysmem\fR driver is a private mechanism used by diagnostic test suites -to test the physical memory of the system. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/physmem\fR\fR -.ad -.sp .6 -.RS 4n -Kernel module. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface stability Private -.TE - -.SH CAUTION -.sp -.LP -This driver is used by Sun internal diagnostic programs only. Any other use may -have a harmful impact on the system. diff --git a/usr/src/man/man7d/pm.7d b/usr/src/man/man7d/pm.7d deleted file mode 100644 index 60679b69f7..0000000000 --- a/usr/src/man/man7d/pm.7d +++ /dev/null @@ -1,404 +0,0 @@ -'\" te -.\" Copyright (c) 2001 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 PM 7D "Sep 20, 1999" -.SH NAME -pm \- Power Management driver -.SH SYNOPSIS -.LP -.nf -\fB/dev/pm\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The Power Management ( \fBpm\fR) driver provides an interface for applications -to configure devices within the system for Power Management. The interface is -provided through \fBioctl\fR(2) commands. The \fBpm\fR driver may be accessed -using \fB/dev/pm\fR. -.SS "Power Management Framework" -.sp -.LP -The Power Management framework model allows the system to be viewed as a -collection of devices. Each device is a collection of components that comprise -the smallest power manageable units. The device driver controls the definition -of a device's power manageable components. -.sp -.LP -A component can either be \fBbusy\fR or \fBidle\fR at the current power level. -Normally, the Power Management framework takes an \fBidle\fR component to the -next lower power level. The Power Management framework uses two factors to -determine this transition: the component must have been idle for at least the -threshold time, and the device to which the component belongs must satisfy any -dependency requirements. A dependency occurs when a device requires another -device to be power managed before it can be power managed. Dependencies occur -on a per device basis: when a dependency exists, no components of a device may -be managed unless all the devices it depends upon are first power managed. -.sp -.LP -Using the commands below, an application may take control of the Power -Management of a device from the Power Management framework driver and manage -the transition of device power levels directly. -.sp -.LP -For this set of ioctl commands, \fIarg\fR (see \fBioctl\fR(2)) points to a -structure of type \fBpm_req\fR defined in <\fBsys/pm.h\fR>: -.sp -.in +2 -.nf -typedef struct pm_req { - char *physpath; /* physical path of device */ - /* to configure. See libdevinfo(3LIB) */ - int component; /* device component */ - int value; /* power level, threshold value, or count */ - void *data; /* command-dependent variable-sized data */ - size_t datasize; /* size of data buffer */ - } pm_req_t; -.fi -.in -2 - -.sp -.LP -The fields should contain the following data: -.sp -.ne 2 -.na -\fB\fIphyspath\fR\fR -.ad -.RS 13n -Pointer to the physical path of a device. See \fBlibdevinfo\fR(3LIB). For -example, for the device \fB/devices/pseudo/pm@0:pm\fR the \fIphyspath\fR value -would be \fB/pseudo/pm@0\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIcomponent\fR\fR -.ad -.RS 13n -Non-negative integer specifying which component is being configured. The -numbering starts at zero. -.RE - -.sp -.ne 2 -.na -\fB\fIvalue\fR\fR -.ad -.RS 13n -Non-negative integer specifying the threshold value in seconds or the desired -power level, or the number of levels being specified. -.RE - -.sp -.ne 2 -.na -\fB\fIdata\fR\fR -.ad -.RS 13n -Pointer to a buffer which contains or receives variable-sized data, such as the -name of a device upon which this device has a dependency. -.RE - -.sp -.ne 2 -.na -\fB\fIsize\fR\fR -.ad -.RS 13n -Size of the data buffer. -.RE - -.sp -.LP -Not all fields are used in each command. -.sp -.ne 2 -.na -\fB\fBPM_DIRECT_PM\fR\fR -.ad -.sp .6 -.RS 4n -The device named by \fIphyspath\fR is disabled from being power managed by the -framework. The caller will power manage the device directly using the -\fBPM_DIRECT_NOTIFY\fR, \fBPM_GET_TIME_IDLE\fR and \fBPM_GET_CURRENT_POWER\fR, -\fBPM_GET_FULL_POWER\fR and \fBPM_SET_CURRENT_POWER\fR commands. If the device -needs to have its power level changed either because its driver calls -\fBpm_raise_power\fR(9F), \fBpm_lower_power\fR(9F), or -\fBpm_power_has_changed\fR(9F) or because the device is the parent of another -device that is changing power level or a device that this device depends on is -changing power level, then the power level change of the device will be blocked -and the caller will be notified as described below for the -\fBPM_DIRECT_NOTIFY\fR command. -.sp -Error codes: -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -Device already disabled for Power Management by framework. -.RE - -.sp -.ne 2 -.na -\fB\fBEPERM\fR\fR -.ad -.RS 9n -Caller is neither superuser nor effective group ID of 0. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBPM_RELEASE_DIRECT_PM\fR\fR -.ad -.sp .6 -.RS 4n -The device named by \fIphyspath\fR (which must have been the target of a -\fBPM_DIRECT_PM\fR command) is re-enabled for Power Management by the -framework. -.sp -Error codes: -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -Device component out of range. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBPM_DIRECT_NOTIFY \fR\fBPM_DIRECT_NOTIFY_WAIT\fR\fR -.ad -.sp .6 -.RS 4n -These commands allow the process that is directly power managing a device to be -notified of events that could change the power level of the device. When such -an event occurs, this command returns information about the event. -.sp - \fIarg\fR (see \fBioctl\fR(2)) points to a structure of type -\fBpm_state_change\fR defined in \fB<sys/pm.h>\fR: -.sp -.in +2 -.nf -typedef struct pm_state_change { - char *physpath; /* device which has changed state */ - int component; /* which component changed state */ -#if defined(_BIG_ENDIAN) - ushort_t flags; /* PSC_EVENT_LOST, PSC_ALL_LOWEST */ - ushort_t event; /* type of event */ -#else - ushort_t event; /* type of event * - ushort_t flags; /* PSC_EVENT_LOST, PSC_ALL_LOWEST */ -#endif - time_t timestamp; /* time of state change */+ - int old_level; /* power level changing from */ - int new_level; /* power level changing to */ - size_t size; /* size of buffer physpath points to */ -} pm_state_change_t; -.fi -.in -2 - -When an event occurs, the struct pointed to by \fIarg\fR is filled in. If the -event type is \fBPSC_PENDING_CHANGE\fR, then the information in the rest of the -struct describes an action that the framework would have taken if the device -were not directly power managed by the caller. The caller is responsible for -completing the indicated level changes using \fBPM_SET_CURRENT_POWER\fR below. -.sp -An event type of \fBPSC_HAS_CHANGED\fR indicates that the driver for the -directly power managed device has called \fBpm_power_has_changed\fR(9F) due to -the device changing power on its own. It is provided to allow the caller to -track the power state of the device. -.sp -The system keeps events in a circular buffer. If the buffer overflow, the -oldest events are lost and when the event that next follows a lost event is -retrieved it will have PSC_EVENT_LOST set in flags. -.sp -\fBPM_DIRECT_NOTIFY\fR returns \fBEWOULDBLOCK\fR if no event is pending, and -\fBPM_DIRECT_NOTIFY_WAIT\fR blocks until an event is available. -.sp -\fBpm\fR also supports the \fBpoll\fR(2) interface. When an event is pending a -\fBpoll\fR(2) call that includes a file descriptor for \fB/dev/pm\fR and that -has \fBPOLLIN \fR or \fBPOLLRDNORM \fR set in its event mask will return. -.RE - -.sp -.ne 2 -.na -\fB\fBPM_SET_CURRENT_POWER\fR\fR -.ad -.sp .6 -.RS 4n -Component \fIcomponent\fR of the device named by \fIphyspath\fR (which must -contain the physical path of a device against which the process has issued a -\fBPM_DIRECT_PM\fR command) is set to power level \fIvalue. \fRIf all -components of the device named by \fIphyspath\fR were at level 0, \fIvalue\fR -is non-zero and some device has a dependency on this device, then all -components of that device will be brought to full power before this command -returns. Similarly, if the parent of the target device is powered off, then it -will be brought up as needed before this command returns. When -PM_SET_CURRENT_POWER is issued against a device, the resulting power change is -included in the event list for PM_DIRECT_NOTIFY. -.sp -Error codes: -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -Device component out of range, or power level < 0. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 10n -Failed to power device or its ancestors or the devices on which this device has -dependency or their ancestors. Note that this may not indicate a failure, the -device driver may have rejected the command as inappropriate because the -component has become busy. -.RE - -.sp -.ne 2 -.na -\fB\fBEPERM\fR\fR -.ad -.RS 10n -Caller has not previously issued a successful \fBPM_DIRECT_PM\fR command -against this device. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBPM_GET_FULL_POWER\fR\fR -.ad -.sp .6 -.RS 4n -The highest supported power level of component \fIcomponent\fR of the device -named by \fIphyspath\fR is returned. -.RE - -.sp -.ne 2 -.na -\fB\fBPM_GET_CURRENT_POWER\fR\fR -.ad -.sp .6 -.RS 4n -The current power level of component \fIcomponent\fR of the device named by -\fIphyspath\fR is returned. -.sp -Error codes: -.sp -.ne 2 -.na -\fB\fBEAGAIN\fR\fR -.ad -.RS 10n -Device component power level is not currently known. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBPM_GET_TIME_IDLE\fR\fR -.ad -.sp .6 -.RS 4n -\fBPM_GET_TIME_IDLE\fR returns the number of seconds that component -\fIcomponent\fR of the device named by \fIphyspath\fR has been idle. If the -device is not idle, then \fB0\fR is returned. -.sp -Note that because the state of the device may change between the time the -process issues the \fBPM_GET_TIME_IDLE\fR command and the time the process -issues a \fBPM_SET_CURRENT_POWER\fR command to reduce the power level of an -idle component, the process must be prepared to deal with a -\fBPM_SET_CURRENT_POWER\fR command returning failure because the driver has -rejected the command as inappropriate because the device component has become -busy. This can be differentiated from other types of failures by issuing the -\fBPM_GET_TIME_IDLE\fR command again to see if the component has become busy. -.RE - -.SH ERRORS -.sp -.LP -Upon error, the commands will return \fB\(mi1\fR, and set \fIerrno\fR. In -addition to the error codes listed above by command, the following error codes -are common to all commands: -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n - Bad address passed in as argument. -.RE - -.sp -.ne 2 -.na -\fB\fBENODEV\fR\fR -.ad -.RS 10n - Device is not power manageable, or device is not configured. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n - Too many opens attempted. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface stability Unstable -.TE - -.SH SEE ALSO -.sp -.LP -\fBpmconfig\fR(1M), \fBIntro\fR(2), \fBioctl\fR(2), \fBlibdevinfo\fR(3LIB), -\fBpower.conf\fR(4), \fBattributes\fR(5), \fBattach\fR(9E), \fBdetach\fR(9E), -\fBpower\fR(9E), \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F), -\fBpm_lower_power\fR(9F), \fBpm_power_has_changed\fR(9F), -\fBpm_raise_power\fR(9F) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man7d/poll.7d b/usr/src/man/man7d/poll.7d deleted file mode 100644 index b69594d7da..0000000000 --- a/usr/src/man/man7d/poll.7d +++ /dev/null @@ -1,379 +0,0 @@ -'\" te -.\" Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved. -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH POLL 7D "January 10, 2020" -.SH NAME -poll \- driver for fast poll on many file descriptors -.SH SYNOPSIS -.nf -\fB#include <sys/devpoll.h> -int fd = open("/dev/poll", O_RDWR); -ssize_t n = write(int fd, struct pollfd buf[], int bufsize); -int n = ioctl(int fd, DP_POLL, struct dvpoll* arg); -int n = ioctl(int fd, DP_ISPOLLED, struct pollfd* pfd);\fR -.fi - -.SH PARAMETERS -.ne 2 -.na -\fB\fIfd\fR \fR -.ad -.RS 12n -Open file descriptor that refers to the \fB/dev/poll\fR driver. -.RE - -.sp -.ne 2 -.na -\fB\fIpath\fR \fR -.ad -.RS 12n -\fB/dev/poll\fR -.RE - -.sp -.ne 2 -.na -\fB\fIbuf\fR \fR -.ad -.RS 12n -Array of \fBpollfd\fR structures. -.RE - -.sp -.ne 2 -.na -\fB\fIbufsize\fR \fR -.ad -.RS 12n -Size of \fIbuf\fR in bytes. -.RE - -.sp -.ne 2 -.na -\fB\fIarg\fR \fR -.ad -.RS 12n -Pointer to \fBpollcall\fR structure. -.RE - -.sp -.ne 2 -.na -\fB\fIpfd\fR \fR -.ad -.RS 12n -Pointer to \fBpollfd\fR structure. -.RE - -.SH DESCRIPTION -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 -the \fB/dev/poll\fR driver is provided through \fBopen\fR(2), \fBwrite\fR(2), -and \fBioctl(2)\fR system calls. -.sp -.LP -Writing an array of \fBpollfd\fR struct to the \fB/dev/poll\fR driver has the -effect of adding these file descriptors to the monitored \fBpoll\fR file -descriptor set represented by the \fIfd\fR. To monitor multiple file -descriptor sets, open the \fB/dev/poll\fR driver multiple times. Each \fBfd\fR -corresponds to one set. For each \fBpollfd\fR struct entry (defined in -\fBsys/poll.h\fR): -.sp -.in +2 -.nf - struct pollfd { - int fd; - short events; - short revents; - } -.fi -.in -2 - -.sp -.LP -The \fBfd\fR field specifies the file descriptor being polled. The -\fBevents\fR field indicates the interested \fBpoll\fR \fBevents\fR on the file -descriptor. If a \fBpollfd\fR array contains multiple \fBpollfd\fR entries with -the same \fBfd\fR field, the "events" field in each \fBpollfd\fR entry is -OR'ed. A special \fBPOLLREMOVE\fR event in the \fBevents\fR field of the -\fBpollfd\fR structure removes the \fBfd\fR from the monitored set. The -\fBrevents\fR field is not used. Write returns the number of bytes written -successfully or \fB-1\fR when write fails. -.sp -.LP -The \fBDP_POLL\fR ioctl is used to retrieve returned \fBpoll\fR \fBevents\fR -occurred on the polled file descriptors in the monitored set represented by -\fIfd\fR. \fIarg\fR \fIis\fR \fIa\fR pointer to the devpoll structures which -are defined as follows: -.sp -.in +2 -.nf - struct dvpoll { - struct pollfd* dp_fds; - int dp_nfds; - int dp_timeout; - } -.fi -.in -2 - -.sp -.LP -The \fBdp_fds\fR points to a buffer that holds an array of returned -\fBpollfd\fR structures. The \fBdp_nfds\fR field specifies the size of the -buffer in terms of the number of \fBpollfd\fR entries it contains. The -\fBdp_nfds\fR field also indicates the maximum number of file descriptors from -which poll information can be obtained. If there is no interested \fBevents\fR -on any of the polled file descriptors, the \fBDP_POLL\fR ioctl call will wait -\fBdp_timeout\fR milliseconds before returning. If \fBdp_timeout\fR is -\fB0\fR, the ioctl call returns immediately. If \fBdp_timeout\fR is \fB-1\fR, -the call blocks until an interested \fBpoll\fR \fBevents\fR is available or the -call is interrupted. Upon return, if the ioctl call has failed, \fB-1\fR is -returned. The memory content pointed by \fBdp_fds\fR is not modified. A return -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 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. -.sp -.LP -\fBDP_ISPOLLED\fR ioctl allows you to query if a file descriptor is already in -the monitored set represented by \fBfd\fR. The \fBfd\fR field of the -\fBpollfd\fR structure indicates the file descriptor of interest. The -\fBDP_ISPOLLED\fR ioctl returns \fB1\fR if the file descriptor is in the set. -The \fBevents\fR field contains \fB0\fR. The \fBrevents\fR field contains the -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 -The following example shows how \fB/dev/poll\fR may be used. -.sp -.in +2 -.nf -{ - ... - /* - * open the driver - */ - if ((wfd = open("/dev/poll", O_RDWR)) < 0) { - exit(-1); - } - pollfd = (struct pollfd* )malloc(sizeof(struct pollfd) * MAXBUF); - if (pollfd == NULL) { - close(wfd); - exit(-1); - } - /* - * initialize buffer - */ - for (i = 0; i < MAXBUF; i++) { - pollfd[i].fd = fds[i]; - pollfd[i].events = POLLIN; - pollfd[i].revents = 0; - } - if (write(wfd, &pollfd[0], sizeof(struct pollfd) * MAXBUF) != - sizeof(struct pollfd) * MAXBUF) { - perror("failed to write all pollfds"); - close (wfd); - free(pollfd); - exit(-1); - } - /* - * read from the devpoll driver - */ - dopoll.dp_timeout = -1; - dopoll.dp_nfds = MAXBUF; - dopoll.dp_fds = pollfd; - result = ioctl(wfd, DP_POLL, &dopoll); - if (result < 0) { - perror("/dev/poll ioctl DP_POLL failed"); - close (wfd); - free(pollfd); - exit(-1); - } - for (i = 0; i < result; i++) { - read(dopoll.dp_fds[i].fd, rbuf, STRLEN); - } - ... -} -.fi -.in -2 - -.sp -.LP -The following example is part of a test program which shows how -\fBDP_ISPOLLED()\fR ioctl may be used. -.sp -.in +2 -.nf -{ - ... - - loopcnt = 0; - while (loopcnt < ITERATION) { - rn = random(); - rn %= RANGE; - if (write(fds[rn], TESTSTRING, strlen(TESTSTRING)) != - strlen(TESTSTRING)) { - perror("write to fifo failed."); - close (wfd); - free(pollfd); - error = 1; - goto out1; - } - dpfd.fd = fds[rn]; - dpfd.events = 0; - dpfd.revents = 0; - result = ioctl(wfd, DP_ISPOLLED, &dpfd); - if (result < 0) { - perror("/dev/poll ioctl DP_ISPOLLED failed"); - printf("errno = %d\en", errno); - close (wfd); - free(pollfd); - error = 1; - goto out1; - } - if (result != 1) { - printf("DP_ISPOLLED returned incorrect result: %d.\en", - result); - close (wfd); - free(pollfd); - error = 1; - goto out1; - } - if (dpfd.fd != fds[rn]) { - printf("DP_ISPOLLED returned wrong fd %d, expect %d\en", - dpfd.fd, fds[rn]); - close (wfd); - free(pollfd); - error = 1; - goto out1; - } - if (dpfd.revents != POLLIN) { - printf("DP_ISPOLLED returned unexpected revents %d\en", - dpfd.revents); - close (wfd); - free(pollfd); - error = 1; - goto out1; - } - if (read(dpfd.fd, rbuf, strlen(TESTSTRING)) != - strlen(TESTSTRING)) { - perror("read from fifo failed"); - close (wfd); - free(pollfd); - error = 1; - goto out1; - } - loopcnt++; - } - -.fi -.in -2 - -.SH ERRORS -.ne 2 -.na -\fB\fBEACCES\fR \fR -.ad -.RS 11n -A process does not have permission to access the content cached in -\fB/dev/poll\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBEINTR\fR \fR -.ad -.RS 11n -A signal was caught during the execution of the \fBioctl\fR(2) function. -.RE - -.sp -.ne 2 -.na -\fB\fBEFAULT\fR \fR -.ad -.RS 11n -The request argument requires a data transfer to or from a buffer pointed to by -\fIarg\fR, but \fIarg\fR points to an illegal address. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR \fR -.ad -.RS 11n -The request or \fIarg\fR parameter is not valid for this device, or field of -the dvpoll struct pointed by \fIarg\fR is not valid (for example, when using -write/pwrite dp_nfds is greater than {OPEN_MAX}, or when using the DPPOLL ioctl -dp_nfds is greater than or equal to {OPEN_MAX}}. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR \fR -.ad -.RS 11n -The \fBO_NONBLOCK\fR flag is set, the named file is a FIFO, the \fBO_WRONLY\fR -flag is set, and no process has the file open for reading; or the named file is -a character special or block special file and the device associated with this -special file does not exist. -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l l -l l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Architecture SPARC, x86 -Interface Stability Obsolete -MT-Level Safe -.TE - -.SH SEE ALSO -\fBopen\fR(2), \fBpoll\fR(2), \fBwrite\fR(2), \fBattributes\fR(5) -.SH NOTES -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. -.sp -.LP -When using the \fB/dev/poll\fR driver, you should remove a closed file -descriptor from a monitored poll set. Failure to do so may result in a -\fBPOLLNVAL\fR \fBrevents\fR being returned for the closed file descriptor. -When a file descriptor is closed but not removed from the monitored set, and is -reused in subsequent open of a different device, you will be polling the device -associated with the reused file descriptor. In a multithreaded application, -careful coordination among threads doing close and \fBDP_POLL\fR ioctl is -recommended for consistent results. -.sp -.LP -The \fB/dev/poll\fR driver caches a list of polled file descriptors, which are -specific to a process. Therefore, the \fB/dev/poll\fR file descriptor of a -process will be inherited by its child process, just like any other file -descriptors. But the child process will have very limited access through this -inherited \fB/dev/poll\fR file descriptor. Any attempt to write or do ioctl by -the child process will result in an \fBEACCES\fR error. The child process -should close the inherited \fB/dev/poll\fR file descriptor and open its own if -desired. -.sp -.LP -The \fB/dev/poll\fR driver does not yet support polling. Polling on a -\fB/dev/poll\fR file descriptor will result in \fBPOLLERR\fR being returned in -the \fBrevents\fR field of \fBpollfd\fR structure. diff --git a/usr/src/man/man7d/profile.7d b/usr/src/man/man7d/profile.7d deleted file mode 100644 index 26f6722179..0000000000 --- a/usr/src/man/man7d/profile.7d +++ /dev/null @@ -1,54 +0,0 @@ -'\" te -.\" Copyright (c) 2003, 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 PROFILE 7D "Dec 10, 2017" -.SH NAME -profile \- DTrace profile interrupt provider -.SH DESCRIPTION -.LP -The \fBprofile\fR driver is a DTrace dynamic tracing provider that adds -time-based interrupt event sources that can be used as DTrace probes. -.sp -.LP -Each profile event source is a time-based interrupt firing every fixed, -specified time interval. You can use these probes to sample some aspect of -system state every unit time and the samples can then be used to infer system -behavior. If the sampling rate is high, or the sampling time is long, an -accurate inference is possible. By using the DTrace facility to bind arbitrary -actions to probes, you can use the \fBprofile\fR provider to sample practically -anything in the system. For example, you could sample the state of the current -thread, the CPU state, or the current machine instruction each time a probe -fires. -.sp -.LP -The \fBprofile\fR driver is not a public interface and you access the -instrumentation offered by this provider through DTrace. Refer to the -\fIDynamic Tracing Guide\fR for a description of the public documented -interfaces available for the DTrace facility and the probes offered by the -profile provider. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.LP -\fBdtrace\fR(1M), \fBattributes\fR(5), \fBdtrace\fR(7D) -.sp -.LP -\fIDynamic Tracing Guide\fR: -.sp -.LP -https://illumos.org/books/dtrace/ diff --git a/usr/src/man/man7d/ptm.7d b/usr/src/man/man7d/ptm.7d deleted file mode 100644 index adf66469bc..0000000000 --- a/usr/src/man/man7d/ptm.7d +++ /dev/null @@ -1,258 +0,0 @@ -'\" te -.\" Copyright (c) 1997, 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] -.\" Copyright 2022 Oxide Computer Company -.Dd February 5, 2022 -.Dt PTM 7D -.Os -.Sh NAME -.Nm ptm , -.Nm pts -.Nd STREAMS pseudo-terminal manager and subsidiary drivers -.Sh SYNOPSIS -.Pa /dev/ptmx -.Pp -.Pa /dev/pts/* -.Sh DESCRIPTION -The pseudo-terminal subsystem simulates a terminal connection, where the -manager side represents the terminal and the subsidiary represents the user -process's special device end point. -The manager device is set up as a cloned device where its major device number -is the major for the clone device and its minor device number is the major for -the -.Nm ptm -driver; see -.Dv CLONE_DEV -in -.Xr ddi_create_minor_node 9F . -.Pp -There are no nodes in the file system for manager devices. -The manager pseudo driver is opened using the -.Xr open 2 -system call with -.Pa /dev/ptmx -as the device parameter. -The clone open finds the next available minor device for the -.Nm ptm -major device. -.Pp -A manager device is only available if it and its corresponding subsidiary -device are not already open. -Only one open is allowed on a manager device. -Multiple opens are allowed on the subsidiary device. -.Pp -When the manager device is opened, the corresponding subsidiary device is -automatically locked out. -No user may open the subsidiary device until its permissions are adjusted and -the device is unlocked by calling the functions -.Xr grantpt 3C -and -.Xr unlockpt 3C . -The user can then invoke the -.Xr open 2 -system call with the device name returned by the -.Xr ptsname 3C -function. -.Pp -After both the manager and subsidiary have been opened, the user has two file -descriptors which are the end points of a full duplex connection composed of -two streams which are automatically connected at the manager and subsidiary -drivers. -The user may then push modules onto either side of the stream pair. -Unless compiled in XPG4v2 mode -.Po -see -.Sx "XPG4v2 MODE" -.Pc , -the consumer needs to push the -.Xr ptem 7M -and -.Xr ldterm 7M -modules onto the subsidiary device to get terminal semantics. -.Pp -The manager and subsidiary drivers pass all messages to their adjacent queues. -Only the -.Dv M_FLUSH -needs some processing. -Because the read queue of one side is connected to the write queue of the -other, the -.Dv FLUSHR -flag is changed to the -.Dv FLUSHW -flag and vice versa. -.Pp -When the manager device is closed, an -.Dv M_HANGUP -message is sent to the subsidiary device which will render the device unusable. -The process on the subsidiary side gets an -.Er EIO -error when attempting to write on that stream, but it will be able to read -any data remaining on the stream head read queue. -When all the data has been read, -.Xr read 2 -returns -.Sy 0 -indicating that the stream can no longer be used. -.Pp -On the last close of the subsidiary device, a 0-length message is sent to the -manager device. -When the application on the manager side issues a -.Xr read 2 -or -.Xr getmsg 2 -and -.Sy 0 -is returned, the user of the manager device decides whether to issue a -.Xr close 2 -that dismantles the entire pseudo-terminal. -If the manager device is not closed, the pseudo-terminal will be available to -another user to open the subsidiary device. -.Pp -Since 0-length messages are used to indicate that the process on the -subsidiary side has closed, and should be interpreted that way by the process -on the manager side, applications on the subsidiary side should not write -0-length messages. -Unless the application is compiled in XPG4v2 mode -.Po -see -.Sx "XPG4v2 MODE" -.Pc , -then any 0-length messages written to the subsidiary device will be discarded -by the -.Xr ptem 7M -module. -.Pp -If -.Dv O_NONBLOCK -or -.Dv O_NDELAY -is set on the manager side: -.Bl -bullet -.It -Read on the manager side returns -.Sy -1 -with -.Va errno -set to -.Er EAGAIN -if no data is available -.It -Write returns -.Sy -1 -with -.Va errno -set to -.Er EAGAIN -if there is internal flow control -.El -.Pp -Standard STREAMS system calls can access pseudo-terminal devices. -The subsidiary devices support the -.Dv O_NDELAY -and -.Dv O_NONBLOCK -flags. -.Sh XPG4v2 MODE -.Em XPG4v2 -requires that subsidiary pseudo-terminal devices provide the process with an -interface that is identical to the terminal interface, without needing to -explicitly push any modules to achieve this. -It also requires that 0-length messages written on the subsidiary device will -be propagated to the manager device. -.Pp -Experience has shown that most software does not expect subsidiary -pseudo-terminal devices to operate in this manner. -This XPG4v2-compliant behaviour is only enabled in XPG4v2/SUS -.Po -see -.Xr standards 5 -.Pc -mode. -.Sh IOCTLS -The manager driver provides several ioctls to support the -.Xr grantpt 3C , -.Xr unlockpt 3C , -and -.Xr ptsname 3C -functions: -.Bl -tag -width Ds -.It Dv ISPTM -Determines whether the file descriptor is that of an open manager device. -On success, it returns the value -.Sy 0 . -.It Dv UNLKPT -Unlocks the manager and subsidiary devices. -It returns -.Sy 0 -on success. -On failure, -.Vt errno -is set to -.Vt EINVAL -indicating that the manager device is not open. -.El -.Sh FILES -.Bl -tag -width Pa -.It Pa /dev/ptmx -Pseudo-terminal manager clone device. -.It Pa /dev/pts/N -Pseudo-terminal subsidiary devices, where -.Sy N -is a non-negative integer. -Located via calls to -.Xr ptsname 3C . -.El -.Sh EXAMPLES -.Sy Example 1 -Opening the manager and subsidiary device for a pseudo-terminal. -.Bd -literal -offset Ds -#include <stdlib.h> -#include <sys/types.h> -#include <sys/stat.h> -#include <unistd.h> -#include <stropts.h> -#include <fcntl.h> -#include <err.h> -\&... -int fdm, fds; -char *subsidiaryname; -\&... -/* - * NOTE: Portable applications should use posix_openpt(3C) here: - */ -if ((fdm = open("/dev/ptmx", O_RDWR | O_NOCTTY)) < 0) { - err(1, "open manager"); -} -if (grantpt(fdm) != 0 || unlockpt(fdm) != 0 || - (subsidiaryname = ptsname(fdm)) == NULL) { - close(fdm); - err(1, "locate subsidiary"); -} -if ((fds = open(subsidiaryname, O_RDWR | O_NOCTTY)) < 0) { - close(fdm); - err(1, "open subsidiary"); -} -if (ioctl(fds, I_PUSH, "ptem") != 0 || - ioctl(fds, I_PUSH, "ldterm") != 0) { - close(fds); - close(fdm); - err(1, "push modules"); -} -.Ed -.Sh SEE ALSO -.Xr close 2 , -.Xr getmsg 2 , -.Xr open 2 , -.Xr read 2 , -.Xr grantpt 3C , -.Xr posix_openpt 3C , -.Xr ptsname 3C , -.Xr unlockpt 3C , -.Xr standards 5 , -.Xr ldterm 7M , -.Xr pckt 7M , -.Xr ptem 7M , -.Xr ddi_create_minor_node 9F diff --git a/usr/src/man/man7d/pty.7d b/usr/src/man/man7d/pty.7d deleted file mode 100644 index 8e14dd3ea2..0000000000 --- a/usr/src/man/man7d/pty.7d +++ /dev/null @@ -1,265 +0,0 @@ -'\" te -.\" Copyright (c) 1994, Sun Microsystems, Inc. -.\" 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] -.\" Copyright 2022 Oxide Computer Company -.Dd February 5, 2022 -.Dt PTY 7D -.Os -.Sh NAME -.Nm pty -.Nd legacy pseudo-terminal driver -.Sh SYNOPSIS -.Pa /dev/pty[p-r]* -.Pp -.Pa /dev/tty[p-r]* -.Sh DESCRIPTION -This driver provides support for legacy static pseudo-terminal devices. -Modern software does not use this driver, preferring instead the STREAMS-based -.Xr ptm 7D -and -.Xr pts 7D -pseudo-terminal drivers, consumed through the portable -.Xr posix_openpt 3C -interface. -.Pp -The -.Nm pty -driver provides support for a pair of devices collectively known -as a -.Em pseudo-terminal . -The two devices comprising a pseudo-terminal are known as a -.Em manager -and a -.Em subsidiary . -The subsidiary device distinguishes between the -.Dv B0 baud rate and other baud rates specified in -the -.Fa c_cflag -field of the -.Vt termios -structure, and the -.Dv CLOCAL -flag in that member. -It does not support any of the other -.Xr termio 7I -device control functions specified by flags in the -.Fa c_cflag -field of the -.Vt termios -structure and by the -.Dv IGNBRK , -.Dv IGNPAR , -.Dv PARMRK , -or -.Dv INPCK -flags in the -.Fa c_iflag -field of the -.Vt termios -structure, as these functions apply only to asynchronous serial ports. -All other -.Xr termio 7I -functions must be performed by STREAMS modules pushed atop the driver; when a -subsidiary device is opened, the -.Xr ldterm 7M -and -.Xr ttcompat 7M -STREAMS modules are automatically pushed on top of the stream, providing the -standard -.Xr termio 7I -interface. -.Pp -Instead of having a hardware interface and associated hardware that supports -the terminal functions, the functions are implemented by another process -manipulating the manager device of the pseudo-terminal. -.Pp -The manager and the subsidiary devices of the pseudo-terminal are tightly -connected. -Any data written on the manager device is given to the subsidiary device as -input, as though it had been received from a hardware interface. -Any data written on the subsidiary terminal can be read from the manager device -.Pq "rather than being transmitted from a UAR" . -.Pp -The driver is statically configured to provide 48 pseudo-terminal pairs. -Software that requires dynamic pseudo-terminal devices, or a greater number -of devices, must be converted to use -.Xr ptm 7D . -.Sh IOCTLS -The standard set of -.Xr termio 7I -ioctls are supported by the subsidiary device. -None of the bits in the -.Fa c_cflag -field have any effect on the pseudo-terminal, except that if the baud rate is -set to -.Dv B0 , -it will appear to the process on the manager device as if the last process on -the subsidiary device had closed the line; thus, setting the baud rate to -.Dv B0 -has the effect of -.Dq hanging up -the pseudo-terminal, just as it has the effect of -.Dq hanging up -a real terminal. -.Pp -There is no notion of -.Dq parity -on a pseudo-terminal, so none of the flags in the -.Fa c_iflag -field that control the processing of parity errors have any -effect. -Similarly, there is no notion of a -.Fa break , -so none of the flags that control the processing of breaks, and none of the -ioctls that generate breaks, have any effect. -.Pp -Input flow control is automatically performed; a process that attempts to write -to the manager device will be blocked if too much unconsumed data is buffered -on the subsidiary device. -The input flow control provided by the -.Dv IXOFF -flag in the -.Fa c_iflag -field is not supported. -.Pp -The delays specified in the -.Fa c_oflag -field are not supported. -.Pp -As there are no modems involved in a pseudo-terminal, the ioctls that return or -alter the state of modem control lines are silently ignored. -.Pp -A few special ioctls are provided on the manager devices of pseudo-terminals to -provide the functionality needed by applications programs to emulate real -hardware interfaces: -.Bl -tag -width Ds -.It Dv TIOCSTOP -The argument is ignored. -Output to the pseudo-terminal is suspended, as if a -.Sy STOP -character had been typed. -.It Dv TIOCSTART -The argument is ignored. -Output to the pseudo-terminal is restarted, as if a -.Sy START -character had been typed. -.It Dv TIOCPKT -The argument is a pointer to an -.Vt int . -If the value of the -.Vt int -is non-zero, -.Em packet -mode is enabled; if the value of the -.Vt int -is zero, packet mode is disabled. -When a pseudo-terminal is in packet mode, each subsequent -.Xr read 2 -from the manager device will return data written on the subsidiary device -preceded by a zero byte -.Po -symbolically defined as -.Dv TIOCPKT_DATA -.Pc , -or a single byte reflecting control status information. -In the latter case, the byte is an inclusive-or of zero or more of the bits: -.Bl -tag -width Ds -.It Dv TIOCPKT_FLUSHREAD -Whenever the read queue for the terminal is flushed. -.It Dv TIOCPKT_FLUSHWRITE -Whenever the write queue for the terminal is flushed. -.It Dv TIOCPKT_STOP -Whenever output to the terminal is stopped using -.Sy ^S . -.It Dv TIOCPKT_START -Whenever output to the terminal is restarted. -.It Dv TIOCPKT_DOSTOP -Whenever -.Em XON/XOFF -flow control is enabled after being disabled; it is -considered -.Dq enabled -when the -.Dv IXON -flag in the -.Fa c_iflag -field is set, the -.Dv VSTOP -member of the -.Fa c_cc -array is -.Sy ^S -and the -.Dv VSTART -member of the -.Fa c_cc -array is -.Sy ^Q. -.It Dv TIOCPKT_NOSTOP -Whenever -.Em XON/XOFF -flow control is disabled after being enabled. -.El -.It Dv TIOCREMOTE -The argument is a pointer to an -.Vt int . -If the value of the -.Vt int -is non-zero, -.Em remote -mode is enabled; if the value of the -.Vt int -is zero, remote mode is disabled. -This mode can be enabled or disabled independently of packet mode. -When a pseudo-terminal is in remote mode, input to the subsidiary device of the -pseudo-terminal is flow controlled and not input edited (regardless of the mode -the subsidiary side of the pseudo-terminal). -.Pp -Each write to the manager device produces a record boundary for the process -reading the subsidiary device. -In normal usage, a write of data is like the data typed as a line on the -terminal; a write of 0 bytes is like typing an -.Sy EOF -character. -Note: this means that a process writing to a pseudo-terminal manager in remote -mode must keep track of line boundaries, and write only one line at a time to -the manager. -.Pp -If, for example, it were to buffer up several newline characters and write them -to the manager with one -.Xr write 2 , -it would appear to a process reading from the subsidiary as if a single line -containing several newline characters had been typed -.Po -as if, for example, a user had typed the literal next -.Pq Sy LNEXT -character before typing all but the last of those newline characters -.Pc . -Remote mode can be used when doing remote line editing in a window manager, or -whenever flow controlled input is required. -.El -.Sh FILES -.Bl -tag -width Pa -.It Pa /dev/pty[p-r][0-9a-f] -Pseudo-terminal manager devices. -.It Pa /dev/tty[p-r][0-9a-f] -Pseudo-terminal subsidiary devices. -.El -.Sh SEE ALSO -.Xr rlogin 1 , -.Xr rlogind 1M , -.Xr posix_openpty 3C , -.Xr ptm 7D , -.Xr termio 7I , -.Xr ldterm 7M , -.Xr ttcompat 7M -.Sh NOTES -This is a legacy device and should not be used by new software. -.Pp -It is apparently not possible to send an -.Sy EOT -by writing zero bytes in -.Dv TIOCREMOTE -mode. diff --git a/usr/src/man/man7d/qede.7d b/usr/src/man/man7d/qede.7d deleted file mode 100644 index b819e21697..0000000000 --- a/usr/src/man/man7d/qede.7d +++ /dev/null @@ -1,100 +0,0 @@ -.\" -.\" 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 (c) 2014 QLogic Corporation. All Rights Reserved -.\" -.Dd January 10, 2020 -.Dt QEDE 7D -.Os -.Sh NAME -.Nm qede -.Nd QLogic FastLinQ QL45xxx 10/25/40/50/100 Gigabit Ethernet Driver -.Sh SYNOPSIS -.Pa /dev/net/qede* -.Sh DESCRIPTION -The -.Nm -Ethernet driver is a multi-threaded, loadable, clonable, GLDv3-based -driver supporting the Data Link Provider Interface, -.Xr dlpi 7P , -over QLogic FastLinQ QL45xxx 10/25/40/50/100 Gigabit Ethernet -controllers. -Multiple QLogic FastLinQ controllers installed within the system are -supported by the driver. -.Pp -The -.Nm -driver provides support for the QLogic QL45xxx line of devices. -Functions include chip initialization, frame transmit and receive, -multicast and promiscuous support, error recovery and reporting. -These devices provide 10000/25000/40000/50000/100000 Mbps networking -interfaces. -.Sh DRIVER CONFIGURATION -The primary methods of configuration are via modification of the -.Pa /kernel/drv/qede.conf -file or execution of the -.Xr dladm 1M -utility. -There are many configuration items available and all are thoroughly -documented in the -.Pa /kernel/drv/qede.conf -file. -Note that for changes to this file to take affect the driver must be -reloaded or the system rebooted. -In order to reload the driver with new configuration changes all -.Nm qede -interfaces must be first unplumbed and then the -.Xr update_drv 1M -tool must be executed. -For the configuration items that do not require a driver reload the -.Xr dladm 1M -tool can be used to dynamically change the option. -Use of -.Xr dladm 1M -is the preferred method. -.Sh DEBUGGING -.Ss kstat -There are many statistics exposed via -.Xr kstat 1M -by the -.Nm -driver. -The main groups are: -.Bl -tag -width Em -.It Em intr -for interrupts stats -.It Em l2chip -for layer 2 chip stats -.It Em l2driver -for layer 2 driver stats -.It Em l2stats -for general layer 2 stats -.It Em link -for detailed link status -.It Em mac -for GLDv3 MAC layer stats -.It Em rxq# -for Rx ring stats -.It Em txq# -for Tx ring stats -.It Em stats -for general driver stats and version info. -.El -.Pp -To get a list of all the individual statistics in these groups run: -.Bd -literal -offset indent -# kstat -m qede -i 0 -l -.Ed -.Sh SEE ALSO -.Xr dladm 1M , -.Xr ifconfig 1M , -.Xr driver.conf 4 , -.Xr dlpi 7P diff --git a/usr/src/man/man7d/qlc.7d b/usr/src/man/man7d/qlc.7d deleted file mode 100644 index c4742f95a3..0000000000 --- a/usr/src/man/man7d/qlc.7d +++ /dev/null @@ -1,124 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 QLC 7D "Feb 21, 2005" -.SH NAME -qlc \- ISP2200, ISP2300, and SP212 Family Fibre Channel host bus adapter -driver. -.SH SYNOPSIS -.LP -.nf -SUNW,qlc -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBqlc\fR host bus adapter driver is a Sun Fibre Channel transport -layer-compliant nexus driver for the Qlogic ISP2200, ISP2200A, ISP2310, -ISP2312, and SP212 adapters. These adapters support Fibre Channel SCSI and IP -Protocols, FC-AL public loop profile, point-to-point fabric connection and -Fibre Channel service classes two and three (see NOTES section below). -.sp -.LP -The \fBqlc\fR driver interfaces with the Sun Fibre Channel transport layer to -support the standard functions provided by the SCSA interface. It supports -auto request sense and tagged queueing by default. The driver requires that -all devices have unique hard addresses in private loop configurations. Devices -with conflicting hard addresses are not accessible. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/qlc\fR\fR -.ad -.RS 27n -32-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/qlc\fR\fR -.ad -.RS 27n -64-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/qlc\fR\fR -.ad -.RS 27n -64-bit ELF kernel module (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/qlc.conf\fR\fR -.ad -.RS 27n - Driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBfcp\fR(7D), \fBfp\fR(7d) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANSI X3.230:1994, Fibre Channel Physical Signaling (FC-PH)\fR -.sp -.LP -\fIProject 1134-D, Fibre Channel Generic Services (FC-GS-2)\fR -.sp -.LP -\fIANSI X3.269-1996, Fibre Channel Arbitrated Loop (FC-AL)\fR -.sp -.LP -\fIANSI X3.270-1996, Fibre Channel Protocol for SCSI (FCP-SCSI)\fR -.sp -.LP -\fIANSI X3.270-1996, SCSI-3 Architecture Model (SAM)\fR -.sp -.LP -\fIFibre Channel Private Loop SCSI Direct Attach (FC-PLDA)\fR -.sp -.LP -\fIFabric Loop Attachment (FC-FLA)\fR -.sp -.LP -\fIISP2200 Firmware Interface Specification, QLogic Corporation\fR -.sp -.LP -\fIISP2300 Series Firmware Specification, QLogic Corporation\fR -.SH NOTES -.sp -.LP - SP-212-based host bus adapters (including QLA-210) are supported on x86 -platforms only and are limited to a maximum of 8 targets in fabric and sixteen -targets in local loop topology. FL topology is not supported with the -SP-212-based host bus adapter. diff --git a/usr/src/man/man7d/ral.7d b/usr/src/man/man7d/ral.7d deleted file mode 100644 index 4f636ee8c6..0000000000 --- a/usr/src/man/man7d/ral.7d +++ /dev/null @@ -1,81 +0,0 @@ -'\" te -.\" Copyright (c) 2006 Damien Bergamini -.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL -.\" DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.TH RAL 7D "Jun 25, 2007" -.SH NAME -ral \- Ralink RT2500 802.11b/g Wireless driver -.SH DESCRIPTION -.sp -.LP -The \fBral\fR \fI802.11b/g\fR wireless NIC driver is a multi-threaded, -loadable, clonable, GLDv3-based STREAMS driver supporting Ralink RT2500 -chipset-based NIC's. -.SH CONFIGURATION -.sp -.LP -The \fBral\fR driver performs auto-negotiation to determine the data rate and -mode. Supported \fI802.11b\fR data rates are 1, 2, 5.5 and 11 Mbits/sec. -Supported \fI802.11g\fR data rates are 1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48 -and 54 Mbits/sec. The \fBral\fR driver supports only BSS networks (also known -as "ap" or "infrastructure" networks) and "open"(or "open-system") or "shared -system" authentication. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/ral*\fR\fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/ral\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ral\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fI802.11 - Wireless LAN Media Access Control and Physical Layer -Specification\fR \(em IEEE, 2001 diff --git a/usr/src/man/man7d/ramdisk.7d b/usr/src/man/man7d/ramdisk.7d deleted file mode 100644 index b49b0b1db3..0000000000 --- a/usr/src/man/man7d/ramdisk.7d +++ /dev/null @@ -1,194 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. -.\" 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 RAMDISK 7D "Mar 04, 2003" -.SH NAME -ramdisk \- RAM disk device driver -.SH SYNOPSIS -.LP -.nf -\fBramdisk@0:\fR\fIdiskname\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBramdisk\fR driver supports numerous ramdisk devices that are created by -the system during the boot process (see \fBboot\fR(1M)) or during normal -system operation (see \fBramdiskadm\fR(1M) for more information). -.SH DEVICE SPECIAL FILES -.sp -.LP -Each ramdisk can be accessed either as a block device or as a raw device. When -accessed as a block device, the normal buffering mechanism is used -when reading from and writing to the device, without regard to physical disk -records. Accessing the ramdisk as a raw device enables direct transmission -between the disk and the read or write buffer. A single read or write call -usually results in a single I/O operation, meaning that raw I/O is more -efficient when many bytes are transmitted. You can find block files names in -\fB/dev/ramdisk\fR. Raw file names are found in \fB/dev/rramdisk\fR. -.sp -.LP -There are no alignment or length restrictions on I/O requests to either block -or character devices. -.SH ERRORS -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -The argument features a bad address. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -Invalid argument. EIO. An I/O error occurred. -.RE - -.sp -.ne 2 -.na -\fB\fBEPERM\fR\fR -.ad -.RS 10n -Cannot create or delete a ramdisk without write permission on -\fB/dev/ramdiskctl\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBENOTTY\fR\fR -.ad -.RS 10n -The device does not support the requested ioctl function. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -The device did not exist during opening. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 10n -Cannot exclusively open \fB/dev/ramdiskctl\fR. One or more ramdisks are still -open. -.RE - -.sp -.ne 2 -.na -\fB\fBEEXIST\fR\fR -.ad -.RS 10n -A ramdisk with the indicated name already exists. -.RE - -.sp -.ne 2 -.na -\fB\fBEAGAIN\fR\fR -.ad -.RS 10n -Cannot allocate resource for ramdisk. Try again later. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/ramdisk/diskname\fR\fR -.ad -.sp .6 -.RS 4n -Block device for ramdisk named \fIdiskname\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rramdisk/diskname\fR\fR -.ad -.sp .6 -.RS 4n -Raw device for ramdisk name \fIdiskname\fR -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ramdisk\fR\fR -.ad -.sp .6 -.RS 4n -32-bit driver -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ramdisk.conf\fR\fR -.ad -.sp .6 -.RS 4n -Driver configuration file. (Do not alter). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/ramdisk\fR\fR -.ad -.sp .6 -.RS 4n -64-bit driver -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attribute: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBramdiskadm\fR(1M), \fBfsck\fR(1M), \fBfstyp\fR(1M), \fBmount\fR(1M), -\fBnewfs\fR(1M), \fBdriver.conf\fR(4), \fBfilesystem\fR(5), \fBdkio\fR(7I) -.SH NOTES -.sp -.LP -The percentage of available physical memory that can be allocated to ramdisks -is constrained by the variable \fBrd_percent_physmem\fR. You can tune the -\fBrd_percent_physmem\fR variable in \fB/etc/system\fR. By default, the -percentage of available physical memory that can be allocated to ramdisks is -fixed at 25%. -.sp -.LP -A ramdisk may not be the best possible use of system memory. Accordingly, use -ramdisks only when absolutely necessary. diff --git a/usr/src/man/man7d/random.7d b/usr/src/man/man7d/random.7d deleted file mode 100644 index a1c312bd48..0000000000 --- a/usr/src/man/man7d/random.7d +++ /dev/null @@ -1,157 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 RANDOM 7D "Sep 1, 2008" -.SH NAME -random, urandom \- Strong random number generator device -.SH SYNOPSIS -.LP -.nf -/dev/random -.fi - -.LP -.nf -/dev/urandom -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/dev/random\fR and \fB/dev/urandom\fR files are special files that are a -source for random bytes generated by the kernel random number generator device. -The \fB/dev/random\fR and \fB/dev/urandom\fR files are suitable for -applications requiring high quality random numbers for cryptographic purposes. -.sp -.LP -The generator device produces random numbers from data and devices available to -the kernel and estimates the amount of randomness (or "entropy") collected -from these sources. The entropy level determines the amount of high quality -random numbers that are produced at a given time. -.sp -.LP -Applications retrieve random bytes by reading \fB/dev/random\fR or -\fB/dev/urandom\fR. The \fB/dev/random\fR interface returns random bytes only -when sufficient amount of entropy has been collected. If there is no entropy to -produce the requested number of bytes, \fB/dev/random\fR blocks until more -entropy can be obtained. Non-blocking I/O mode can be used to disable the -blocking behavior. The \fB/dev/random\fR interface also supports \fBpoll\fR(2). -Note that using \fBpoll\fR(2) will not increase the speed at which random -numbers can be read. -.sp -.LP -Bytes retrieved from \fB/dev/random\fR provide the highest quality random -numbers produced by the generator, and can be used to generate long term keys -and other high value keying material. -.sp -.LP -The \fB/dev/urandom\fR interface returns bytes regardless of the amount of -entropy available. It does not block on a read request due to lack of entropy. -While bytes produced by the \fB/dev/urandom\fR interface are of lower quality -than bytes produced by \fB/dev/random\fR, they are nonetheless suitable for -less demanding and shorter term cryptographic uses such as short term session -keys, paddings, and challenge strings. -.sp -.LP -Data can be written to \fB/dev/random\fR and \fB/dev/urandom\fR. Data written -to either special file is added to the generator's internal state. Data that is -difficult to predict by other users may contribute randomness to the generator -state and help improve the quality of future generated random numbers. -.sp -.LP -\fB/dev/random\fR collects entropy from providers that are registered with the -kernel-level cryptographic framework and implement random number generation -routines. The \fBcryptoadm\fR(1M) utility allows an administrator to configure -which providers will be used with \fB/dev/random\fR. -.SH ERRORS -.sp -.ne 2 -.na -\fB\fBEAGAIN\fR\fR -.ad -.RS 11n -\fBO_NDELAY\fR or \fBO_NONBLOCK\fR was set and no random bytes are available -for reading from \fB/dev/random\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBEINTR\fR\fR -.ad -.RS 11n -A signal was caught while reading and no data was transferred. -.RE - -.sp -.ne 2 -.na -\fB\fBENOXIO \fR\fR -.ad -.RS 11n -\fBopen\fR(2) request failed on \fB/dev/random\fR because no entropy provider -is available. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/random\fR\fR -.ad -.RS 16n - -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/urandom\fR\fR -.ad -.RS 16n - -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBcryptoadm\fR(1M), \fBopen\fR(2), \fBpoll\fR(2), \fBattributes\fR(5) -.SH NOTES -.sp -.LP -\fB/dev/random\fR can be configured to use only the hardware-based providers -registered with the kernel-level cryptographic framework by disabling the -software-based provider using \fBcryptoadm\fR(1M). You can also use -\fBcryptoadm\fR(1M) to obtain the name of the software-based provider. -.sp -.LP -Because no entropy is available, disabling all randomness providers causes -\fBread\fR(2) and \fBpoll\fR(2) on \fB/dev/random\fR to block indefinitely and -results in a warning message being logged and displayed on the system console. -However, \fBread\fR(2) and \fBpoll\fR(2) on \fB/dev/urandom\fR continue to work -in this case. -.sp -.LP -An implementation of the \fB/dev/random\fR and \fB/dev/urandom\fR kernel-based -random number generator first appeared in Linux 1.3.30. -.sp -.LP -A \fB/dev/random\fR interface for Solaris first appeared as part of the -CryptoRand implementation. diff --git a/usr/src/man/man7d/rge.7d b/usr/src/man/man7d/rge.7d deleted file mode 100644 index c2c050bba6..0000000000 --- a/usr/src/man/man7d/rge.7d +++ /dev/null @@ -1,231 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH RGE 7D "Dec 21, 2007" -.SH NAME -rge \- Realtek Gigabit/Fast Ethernet Network Adapter driver -.SH SYNOPSIS -.LP -.nf -/dev/rge -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBrge\fR Gigabit/Fast Ethernet driver is a multi-threaded, loadable, -clonable, GLD-based STREAMS driver supporting the Data Link Provider -Interface, \fBdlpi\fR(7P), on the Realtek Gigabit/Fast Ethernet Network -Adapter. -.sp -.LP -The \fBrge\fR driver functions includes controller initialization, frame -transmit and receive, promiscuous and multicast support, and error recovery and -reporting. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning, character-special device \fB/dev/rge\fR is used to access all -Realtek Gigabit/Fast Ethernet devices installed within the system. -.sp -.LP -The \fBrge\fR driver is managed by the \fBdladm\fR(1M) command line utility, -which allows VLANs to be defined on top of \fBrge\fR instances and for -\fBrge\fR instances to be aggregated. See \fBdladm\fR(1M) for more details. -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to -the DL_INFO_REQ are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU (with jumbo frame) is \fB7000\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBDSLAP\fR address length is \fB8\fR bytes. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBMAC\fR type is \fBDL_ETHER.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBSAP\fR length value is -2, meaning the physical address component is -followed immediately by a 2-byte sap component within the DLSAP address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.RE -.sp -.LP -Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a -particular Service Access Point (SAP) with the stream. -.SH CONFIGURATION -.sp -.LP -By default, the \fBrge\fR driver performs auto-negotiation to select the link -speed and mode. Link speed and mode can be any one of the following: -.RS +4 -.TP -.ie t \(bu -.el o -1000 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -100 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -100 Mbps, half-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -10 Mbps, full-duplex -.RE -.RS +4 -.TP -.ie t \(bu -.el o -10 Mbps, half-duplex -.RE -.sp -.LP -Alternatively, you can set the capabilities advertised by the \fBrge\fR device -using \fBndd\fR(1M). The driver supports a number of parameters whose names -begin with \fBadv_\fR. Each of these parameters contains a boolean value that -determines if the device advertises that mode of operation. The -\fIadv_pause_cap\fR indicates if half/full duplex pause is advertised to link -partner. You can set \fIadv_asym_pause_cap\fR to advertise to the link partner -that asymmetric pause is desired. -.sp -.LP -For example, to prevent the device 'rge2' from advertising gigabit -capabilities, enter (as super-user): -.sp -.in +2 -.nf -# ndd -set /dev/rge2 adv_1000fdx_cap 0 -.fi -.in -2 - -.sp -.LP -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. -.sp -.LP -You can find the current parameter settings by using \fBndd\fR \fB-get\fR. In -addition, the driver exports the current state, speed, duplex setting, and -working mode of the link via \fBndd\fR parameters (these are read only and may -not be changed). For example, to check link state of device \fBrge0\fR: -.sp -.in +2 -.nf -# ndd -get /dev/rge0 link_status -1 -# ndd -get /dev/rge0 link_speed -100 -# ndd -get /dev/rge0 link_duplex -2 -.fi -.in -2 - -.sp -.LP -The output above indicates that the link is up and running at 100Mbps -full-duplex. In addition, the driver exports its working mode by -\fIloop_mode\fR. If it is set to 0, the loopback mode is disabled. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/rge*\fR\fR -.ad -.RS 27n -Character special device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/rge\fR\fR -.ad -.RS 27n -32-bit x86 \fBrge\fR driver binary. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/rge\fR\fR -.ad -.RS 27n -64-bit x86 \fBrge\fR driver binary. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/rge\fR\fR -.ad -.RS 27n -SPARC \fBrge\fR driver binary. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7P) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR diff --git a/usr/src/man/man7d/rtls.7d b/usr/src/man/man7d/rtls.7d deleted file mode 100644 index f3159bb278..0000000000 --- a/usr/src/man/man7d/rtls.7d +++ /dev/null @@ -1,62 +0,0 @@ -.\" Copyright 2014 Garrett D'Amore <garrett@damore.org> -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS -.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE -.\" COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, -.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -.\" (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 3, 2014" -.Dt RTLS 7D -.Os -.Sh NAME -.Nm rtls -.Nd RealTek Fast Ethernet device driver -.Sh SYNOPSIS -.Pa /dev/rtls -.Sh DESCRIPTION -The -.Nm -driver provides support for the RealTek 8139 family of Fast Ethernet -PCI controllers. -.Lp -These devices generally support the standard Fast Ethernet features, including -10BASE-T and 100BASE-TX, both full and half duplex operation, IEEE 802.3 -autonegotiation, etc. -They also support full size MTUs (1500 bytes), even when used with VLANs. -. -.Lp -The device driver supports the -.Xr ieee802.3 5 -properties, which can be configured with -.Xr dladm 1M . -. -.Sh FILES -.Bl -tag -width /dev/rtls -.It Pa /dev/rtls -Special character device. -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr ifconfig 1M , -.Xr pci 4 , -.Xr ieee802.3 5 , -.Xr dlpi 7P -.Rs -.%T IEEE 802.3: Ethernet -.%Q IEEE Standards Association -.Re diff --git a/usr/src/man/man7d/rtw.7d b/usr/src/man/man7d/rtw.7d deleted file mode 100644 index 6377b80b1f..0000000000 --- a/usr/src/man/man7d/rtw.7d +++ /dev/null @@ -1,83 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH RTW 7D "Jul 12, 2007" -.SH NAME -rtw \- RealTek 8180L 802.11b Wireless NIC driver -.SH DESCRIPTION -.sp -.LP -The \fBrtw\fR \fI802.11b\fR wireless NIC driver is a multi-threaded, loadable, -clonable, GLDv3-based STREAMS driver supporting RealTek 8180L chipset-based -NIC's. -.SH CONFIGURATION -.sp -.LP -The \fBrtw\fR driver performs auto-negotiation to determine the data rate and -mode. Supported \fI802.11b\fR data rates are 1, 2, 5.5 and 11 Mbits/sec. The -default is 11. -.sp -.LP -The \fBrtw\fR driver supports only BSS networks (also known as "ap" or -"infrastructure" networks) and "open"(or "open-system") or "shared system" -authentication. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/rtw*\fR\fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB/kernel/drv/rtw\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/rtw\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fI802.11 - Wireless LAN Media Access Control and Physical Layer -Specification\fR \(em IEEE, 2001 diff --git a/usr/src/man/man7d/rum.7d b/usr/src/man/man7d/rum.7d deleted file mode 100644 index aeb3c774b2..0000000000 --- a/usr/src/man/man7d/rum.7d +++ /dev/null @@ -1,81 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 RUM 7D "Oct 29, 2008" -.SH NAME -rum \- Ralink RT2501/RT2601/RT73USB 802.11b/g Wireless Driver -.SH DESCRIPTION -.sp -.LP -The \fBrum\fR \fI802.11b/g\fR wireless NIC driver is a multi-threaded, -loadable, clonable, GLDv3-based STREAMS driver supporting the Ralink -RT2501/RT2601/RT73USB chipset-based NIC's. -.SH CONFIGURATION -.sp -.LP -The \fBrum\fR driver performs auto-negotiation to determine the data rate and -mode. Supported 802.11b data rates are 1, 2, 5.5 and 11 Mbits/sec. -Supported 802.11g data rates are 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48 and 54 -Mbits/sec. The \fBrum\fR driver supports only BSS networks (also known as "ap" -or "infrastructure" networks) and "open" (or "open-system") or "shared system" -authentication. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/rum*\fR\fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/rum\fR\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/rum\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fI802.11 - Wireless LAN Media Access Control and Physical Layer -Specification\fR - IEEE, 2001 diff --git a/usr/src/man/man7d/rwd.7d b/usr/src/man/man7d/rwd.7d deleted file mode 100644 index fbef0045c9..0000000000 --- a/usr/src/man/man7d/rwd.7d +++ /dev/null @@ -1,77 +0,0 @@ -'\" te -.\" 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 RWD 7D "Jun 18, 2009" -.SH NAME -rwd \- Ralink RT2561/RT2561S/RT2661 IEEE802.11b/g wireless network driver -.SH DESCRIPTION -.sp -.LP -The rwd IEEE802.11b/g wireless network driver is a multithreaded, loadable, -clonable, GLDv3-based STREAMS driver supporting Ralink RT2561/RT2561S/RT2661 -IEEE802.11b/g wireless network driver. -.SH CONFIGURATION -.sp -.LP -The \fBrwd\fR driver performs auto-negotiation to determine the data rate and -mode. The driver supports only BSS networks (also known as "ap" or -"infrastructure" networks) and "open"(or "open-system") or "shared system" -authentication. For wireless security, WEP encryption, WPA-PSk, and WPA2-PSK -are currently supported. You can perform configuration and administration tasks -using the \fBdladm\fR(1M)and \fBwificonfig\fR(1M) utilities. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/rwd\fR\fR -.ad -.RS 25n -Special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/rwd\fR\fR -.ad -.RS 25n -32-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/rwd\fR\fR -.ad -.RS 25n -64-bit ELF kernel module (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -IEEE802.11b/g - Wireless LAN Standard - IEEE, 2003 diff --git a/usr/src/man/man7d/rwn.7d b/usr/src/man/man7d/rwn.7d deleted file mode 100644 index a0f03c595f..0000000000 --- a/usr/src/man/man7d/rwn.7d +++ /dev/null @@ -1,77 +0,0 @@ -'\" te -.\" 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 RWN 7D "Mar 30, 2009" -.SH NAME -rwn \- Ralink RT2700/2800 IEEE802.11 a/b/g/n wireless network device -.SH DESCRIPTION -.sp -.LP -The \fBrwn\fR IEEE802.11 a/b/g/n wireless driver is a multi-threaded, loadable, -clonable, GLDv3-based STREAMS driver supporting Ralink RT2700/RT2800 IEEE802.11 -a/b/g/n wireless network device. -.SS "Configuration" -.sp -.LP -The \fBrwn\fR driver performs auto-negotiation to determine the data rate and -mode. The driver supports only BSS networks (also known as \fBap\fR or -\fBinfrastructure\fR networks) and \fBopen\fR (\fBopen-system\fR) or \fBshared -system\fR authentication. -.sp -.LP -For wireless security, WEP encryption, WPA-PSK, and WPA2-PSK are currently -supported. You can perform configuration and administration tasks using the -\fBdladm\fR(1M) and \fBwificonfig\fR(1M) utilities. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/rwn\fR\fR -.ad -.RS 25n -Special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/rwn\fR\fR -.ad -.RS 25n -32-bit ELF kernel module, x86 -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/rwn\fR\fR -.ad -.RS 25n -64-bit ELF kernel module, x86 -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5) -.sp -.LP -\fIIEEE802.11b/g - Wireless LAN Standard - IEEE, 2003\fR diff --git a/usr/src/man/man7d/sad.7d b/usr/src/man/man7d/sad.7d deleted file mode 100644 index ed70b755b9..0000000000 --- a/usr/src/man/man7d/sad.7d +++ /dev/null @@ -1,323 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1997, 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 SAD 7D "Apr 16, 1997" -.SH NAME -sad \- STREAMS Administrative Driver -.SH SYNOPSIS -.LP -.nf -#include <sys/types.h> -.fi - -.LP -.nf -#include <sys/conf.h> -.fi - -.LP -.nf -#include <sys/sad.h> -.fi - -.LP -.nf -#include <sys/stropts.h> -.fi - -.LP -.nf -\fBint\fR \fBioctl\fR\fB(int\fR \fIfildes\fR, \fBint\fR \fIcommand\fR, \fBint \fR\fIarg\fR); -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBSTREAMS\fR Administrative Driver provides an interface for -applications to perform administrative operations on \fBSTREAMS\fR modules and -drivers. The interface is provided through \fBioctl\fR(2) commands. Privileged -operations may access the \fBsad\fR driver using \fB/dev/sad/admin\fR. -Unprivileged operations may access the \fBsad\fR driver using -\fB/dev/sad/user\fR. -.sp -.LP -The \fIfildes\fR argument is an open file descriptor that refers to the -\fBsad\fR driver. The \fBcommand\fR argument determines the control function -to be performed as described below. The \fIarg\fR argument represents -additional information that is needed by this command. The type of \fIarg\fR -depends upon the command, but it is generally an integer or a pointer to a -\fBcommand\fR-specific data structure. -.SH COMMAND FUNCTIONS -.sp -.LP -The autopush facility (see \fBautopush\fR(1M)) allows one to configure a list -of modules to be automatically pushed on a stream when a driver is first -opened. Autopush is controlled by the following commands: -.sp -.ne 2 -.na -\fB\fBSAD_SAP\fR\fR -.ad -.RS 11n -Allows the administrator to configure the given device's autopush information. -\fIarg\fR points to a \fBstrapush\fR structure, which contains the following -members: -.sp -.in +2 -.nf - unit_t ap_cmd; - major_t sap_major; - minor_t sap_minor; - minor_t sap_lastminor; - unit_t sap_npush; - unit_t sap_list [MAXAPUSH] [FMNAMESZ + 1]; -.fi -.in -2 - -The \fBsap_cmd\fR field indicates the type of configuration being done. It may -take on one of the following values: -.sp -.ne 2 -.na -\fB\fBSAP_ONE\fR\fR -.ad -.RS 13n -Configure one minor device of a driver. -.RE - -.sp -.ne 2 -.na -\fB\fBSAP_RANGE\fR\fR -.ad -.RS 13n -Configure a range of minor devices of a driver. -.RE - -.sp -.ne 2 -.na -\fB\fBSAP_ALL\fR\fR -.ad -.RS 13n -Configure all minor devices of a driver. -.RE - -.sp -.ne 2 -.na -\fB\fBSAP_CLEAR\fR\fR -.ad -.RS 13n -Undo configuration information for a driver. -.RE - -The \fBsap_major\fR field is the major device number of the device to be -configured. The \fBsap_minor\fR field is the minor device number of the device -to be configured. The \fBsap_lastminor\fR field is used only with the -\fBSAP_RANGE\fR command, which configures a range of minor devices between -\fBsap_minor\fR and \fBsap_lastminor\fR, inclusive. The minor fields have no -meaning for the \fBSAP_ALL\fR command. The \fBsap_npush\fR field indicates -the number of modules to be automatically pushed when the device is opened. It -must be less than or equal to \fBMAXAPUSH\fR \fB,\fR defined in \fBsad.h\fR. -It must also be less than or equal to \fBNSTRPUSH,\fR the maximum number of -modules that can be pushed on a stream, defined in the kernel master file. The -field \fBsap_list\fR is an array of NULL-terminated module names to be pushed -in the order in which they appear in the list. -.sp -When using the \fBSAP_CLEAR\fR command, the user sets only \fBsap_major\fR -and \fBsap_minor\fR. This will undo the configuration information for any of -the other commands. If a previous entry was configured as \fBSAP_ALL, -sap_minor\fR should be set to zero. If a previous entry was configured as -\fBSAP_RANGE\fR \fB, sap_minor\fR should be set to the lowest minor device -number in the range configured. -.sp -On failure, \fBerrno\fR is set to the following value: -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -\fIarg\fR points outside the allocated address space. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -The major device number is invalid, the number of modules is invalid, or the -list of module names is invalid. -.RE - -.sp -.ne 2 -.na -\fB\fBENOSTR\fR\fR -.ad -.RS 10n -The major device number does not represent a \fBSTREAMS\fR driver. -.RE - -.sp -.ne 2 -.na -\fB\fBEEXIST\fR\fR -.ad -.RS 10n -The major-minor device pair is already configured. -.RE - -.sp -.ne 2 -.na -\fB\fBERANGE\fR\fR -.ad -.RS 10n -The command is \fBSAP_RANGE\fR and \fBsap_lastminor\fR is not greater than -\fBsap_minor\fR, or the command is \fBSAP_CLEAR\fR and \fBsap_minor\fR is not -equal to the first minor in the range. -.RE - -.sp -.ne 2 -.na -\fB\fBENODEV\fR\fR -.ad -.RS 10n -The command is \fBSAP_CLEAR\fR and the device is not configured for autopush. -.RE - -.sp -.ne 2 -.na -\fB\fBENOSR\fR\fR -.ad -.RS 10n -An internal autopush data structure cannot be allocated. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBSAD_GAP\fR\fR -.ad -.RS 11n -Allows any user to query the \fBsad\fR driver to get the autopush -configuration information for a given device. \fIarg\fR points to a -\fBstrapush\fR structure as described in the previous command. -.sp -The user should set the \fBsap_major\fR and \fBsap_minor\fR fields of the -\fBstrapush\fR structure to the major and minor device numbers, respectively, -of the device in question. On return, the \fBstrapush\fR structure will be -filled in with the entire information used to configure the device. Unused -entries in the module list will be zero-filled. -.sp -On failure, \fBerrno\fR is set to one of the following values: -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -\fIarg\fR points outside the allocated address space. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -The major device number is invalid. -.RE - -.sp -.ne 2 -.na -\fB\fBENOSTR\fR\fR -.ad -.RS 10n -The major device number does not represent a \fBSTREAMS\fR driver. -.RE - -.sp -.ne 2 -.na -\fB\fBENODEV\fR\fR -.ad -.RS 10n -The device is not configured for autopush. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBSAD_VML\fR\fR -.ad -.RS 11n -Allows any user to validate a list of modules (that is, to see if they are -installed on the system). \fIarg\fR is a pointer to a \fBstr_list\fR structure -with the following members: -.sp -.in +2 -.nf -int sl_nmods; - struct str_mlist *sl_modlist; -.fi -.in -2 - -The \fBstr_mlist\fR structure has the following member: -.sp -.in +2 -.nf -char l_name[FMNAMESZ+1]; -.fi -.in -2 - -\fBsl_nmods\fR indicates the number of entries the user has allocated in the -array and \fBsl_modlist\fR points to the array of module names. The return -value is 0 if the list is valid, 1 if the list contains an invalid module name, -or \(mi1 on failure. On failure, \fBerrno\fR is set to one of the following -values: -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -\fIarg\fR points outside the allocated address space. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -The \fBsl_nmods\fR field of the \fBstr_list\fR structure is less than or -equal to zero. -.RE - -.RE - -.SH SEE ALSO -.sp -.LP -\fBIntro\fR(2), \fBioctl\fR(2), \fBopen\fR(2) -.sp -.LP -\fISTREAMS Programming Guide\fR -.SH DIAGNOSTICS -.sp -.LP -Unless otherwise specified, the return value from \fBioctl()\fR is \fB0\fR -upon success and \fB\(mi1\fR upon failure with \fBerrno\fR set as indicated. diff --git a/usr/src/man/man7d/sata.7d b/usr/src/man/man7d/sata.7d deleted file mode 100644 index 558d273d6e..0000000000 --- a/usr/src/man/man7d/sata.7d +++ /dev/null @@ -1,334 +0,0 @@ -'\" te -.\" 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 SATA 7D "May 13, 2017" -.SH NAME -sata \- Solaris SATA framework -.SH DESCRIPTION -.LP -Serial ATA is an interconnect technology designed to replace parallel ATA -technology. It is used to connect hard drives, optical drives, removable -magnetic media devices and other peripherals to the host system. For complete -information on Serial ATA technology, visit the Serial ATA web site at -http://\fIwww.serialata.org\fR. -.sp -.LP -Up to 32 SATA devices may be plugged directly to each SATA HBA and up to 15 -SATA devices may be plugged directly to each SATA port multiplier supported by -the Solaris SATA framework. The actual number of pluggable devices may be lower, -and is limited by the number of device ports on the SATA HBA or the SATA port -multiplier. The maximum data rate is either 1.5Gb/sec. or 3.0Gb/sec., depending -on the capability of a SATA device, port multiplier and SATA HBA controller. -.sp -.LP -The Solaris SATA framework adheres to the \fISerial ATA 1.0a\fR specification -and supports SATA-2 signaling speed 3.0Gb/sec. SATA devices that are connected -to SATA HBAs controlled by a SATA framework-compliant HBA driver are treated by -the system as SCSI devices. The Solaris SCSI disk driver (\fBsd\fR(7D)) is -attached as a target driver for each device node created by the SATA framework. -You can use the \fBcfgadm\fR(1M) utility to manage hot plugged and unplugged -SATA devices. -.SH FILES -.ne 2 -.na -\fB\fB/kernel/misc/sata\fR\fR -.ad -.RS 27n -32-bit \fBELF\fR kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/sata\fR\fR -.ad -.RS 27n -64-bit \fBELF\fR kernel module (x86). -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attribute: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.LP -\fBcfgadm\fR(1M), \fBprtconf\fR(1M), \fBcfgadm_sata\fR(1M), -\fBattributes\fR(5), \fBahci\fR(7D), \fBnv_sata\fR(7D), -\fBsd\fR(7D), \fBsi3124\fR(7D) -.sp -.LP -\fISerial ATA 1.0a Specification\fR \(em Serial ATA International Organization. -.sp -.LP -\fISerial ATA II (Extension to Serial ATA 1.0.a.)\fR \(em Serial ATA -International Organization. -.SH DIAGNOSTICS -.LP -The messages described below may appear on the system console as well as being -logged. All messages are presented in one of the following formats and are -followed by the diagnostic message: -.sp -.in +2 -.nf -sata: WARNING: <\fBcontroller/devices/.. path\fR>: -.fi -.in -2 -.sp - -.sp -.LP -or: -.sp -.in +2 -.nf -sata: NOTICE: <\fBcontroller/devices/.. path\fR>: -.fi -.in -2 -.sp - -.sp -.LP -\&...where <\fBcontroller/devices/.. path\fR> identifies a specific SATA HBA -issuing a diagnostic message shown below. -.sp -.ne 2 -.na -\fBSATA port X: link lost.\fR -.ad -.sp .6 -.RS 4n -Communication (via serial link) between the HBA and the device plugged to the -specified SATA device port has been lost. -.RE - -.sp -.ne 2 -.na -\fBSATA port X: link established.\fR -.ad -.sp .6 -.RS 4n -Communication (via serial link) between the HBA and the device plugged to the -specified SATA device port has been established. -.RE - -.sp -.ne 2 -.na -\fBSATA port X: device reset.\fR -.ad -.sp .6 -.RS 4n -The device plugged to the specified SATA device port has been reset. The reset -may be due to a communication or command error, command timeout, or an explicit -request from the host. -.RE - -.sp -.ne 2 -.na -\fBSATA port X failed.\fR -.ad -.sp .6 -.RS 4n -The specified SATA device port failed and is in an unusable state. You can -change the port state by deactivating the port and activating it again using -cfgadm SATA hardware-specific commands (see \fBcfgadm_sata\fR(1M)). -.RE - -.sp -.ne 2 -.na -\fBSATA port X error.\fR -.ad -.sp .6 -.RS 4n -An error was detected in specified SATA device port operations. -.RE - -.sp -.ne 2 -.na -\fBSATA device detached at port X.\fR -.ad -.sp .6 -.RS 4n -Communication (via serial link) between the HBA and the device plugged to the -specified SATA device port has been lost and could not be re-established. The -SATA framework assumes that the device is unplugged from the specified SATA -device port. -.RE - -.sp -.ne 2 -.na -\fBSATA device detected at port X.\fR -.ad -.sp .6 -.RS 4n -Communication( via serial link) between the HBA and the device plugged to the -specified empty SATA device port has been established. The SATA framework -assumes that the new device is plugged to the specified SATA device port. -.RE - -.sp -.ne 2 -.na -\fBSATA disk device at port X.\fR -.ad -.sp .6 -.RS 4n -This message is followed by a disk description specifying the disk vendor, -serial number, firmware revision number and the disk capabilities. -.RE - -.sp -.ne 2 -.na -\fBSATA CD/DVD (ATAPI) device at port X.\fR -.ad -.sp .6 -.RS 4n -This message is followed by a SATA CD/DVD description specifying the DVD -vendor, serial number, firmware revision number and the DVD capabilities. -.RE - -.sp -.ne 2 -.na -\fBSATA device at port X cannot be configured. Application(s) accessing -previously attached device have to release it before newly inserted device can -be made accessible.\fR -.ad -.sp .6 -.RS 4n -The port cannot be configured because there is application using the previous -attached device, so the application must release it, then the newly inserted -device can be configured. -.RE - -.sp -.ne 2 -.na -\fBApplication(s) accessing previously attached SATA device have to release it -before newly inserted device can be made accessible.\fR -.ad -.sp .6 -.RS 4n -The target node remained and it belongs to a previously attached device. This -happens when the file was open or the node was waiting for resources at the -time the associated device was removed. Instruct event daemon to retry the -cleanup later. -.RE - -.sp -.ne 2 -.na -\fBsata: error recovery request for non-attached device at cport X.\fR -.ad -.sp .6 -.RS 4n -When error recovery is requested, the device is not yet attached. -.RE - -.sp -.ne 2 -.na -\fBSATA device at port X is not power-managed.\fR -.ad -.sp .6 -.RS 4n -When property \fBpm-capable\fR on the target device node setting fails, the -SATA device won't be power-managed. -.RE - -.sp -.ne 2 -.na -\fBSATA disk device at port X does not support LBA.\fR -.ad -.sp .6 -.RS 4n -The disk device plugged into specified SATA device port does not support LBA -addressing and cannot be used. -.RE - -.sp -.ne 2 -.na -\fBCannot identify SATA device at port X - device is attached.\fR -.ad -.sp .6 -.RS 4n -IDENTIFY (PACKET) DEVICE data cannot be retrieved successfully after the device -is attached to the SATA port. -.RE - -.sp -.ne 2 -.na -\fBsata: <HBA driver name><instance number>:hba attached failed.\fR -.ad -.sp .6 -.RS 4n -The SATA HBA instance attach operation failed. This HBA instance cannot be -configured and is not available. -.RE - -.sp -.ne 2 -.na -\fBsata: invalid ATAPI cdb length<command cdb length>.\fR -.ad -.sp .6 -.RS 4n -The length of the command cdb is greater than that the device can support. -.RE - -.sp -.ne 2 -.na -\fBsata: invalid sata_hba_tran version X for driver <HBA driver name>.\fR -.ad -.sp .6 -.RS 4n -The specified SATA HBA driver and the SATA framework are incompatible. The -driver cannot attach and SATA HBAs controlled by this driver (and devices -plugged to this SATA HBA ports) are not available. -.RE - -.sp -.ne 2 -.na -\fBsata_hba_attach: cannot create SATA attachment point for port X.\fR -.ad -.sp .6 -.RS 4n -The specified SATA device port cannot be configured in the system and a device -plugged to this port could not be not be configured and used. -.RE - -.sp -.ne 2 -.na -\fBsata_create_target_node: cannot create target node for device at port X.\fR -.ad -.sp .6 -.RS 4n -The device target node for the device plugged to the specified SATA device port -could not be created. As a result, the device cannot be configured and used. -.RE - diff --git a/usr/src/man/man7d/scsa1394.7d b/usr/src/man/man7d/scsa1394.7d deleted file mode 100644 index 239dbb0e31..0000000000 --- a/usr/src/man/man7d/scsa1394.7d +++ /dev/null @@ -1,197 +0,0 @@ -'\" te -.\" Copyright (c) 2005 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 SCSA1394 7D "May 13, 2017" -.SH NAME -scsa1394 \- SCSI to 1394 bridge driver -.SH SYNOPSIS -.LP -.nf -\fBunit@GUID\fR -.fi - -.SH DESCRIPTION -.LP -The \fBscsa1394\fR driver is a 1394 target and an SCSA HBA driver that supports -1394 mass storage devices compliant with the \fISerial Bus Protocol 2 -(SBP-2\fR) specification. It supports both bus-powered and self-powered 1394 -mass storage devices. -.sp -.LP -The \fBscsa1394\fR nexus driver maps SCSA target driver requests to SBP-2 -Operation Request Blocks (\fBORB\fR's). -.sp -.LP -The \fBscsa1394\fR driver creates a child device info node for each logical -unit (LUN) on the mass storage device. The standard Solaris SCSI disk driver is -attached to those nodes. Refer to \fBsd\fR(7D). -.sp -.LP -This driver supports multiple LUN devices and creates a separate child device -info node for each LUN. All child LUN nodes attach to \fBsd\fR(7D). -.sp -.LP -In previous releases, all 1394 mass storage devices were treated as removable -media devices and managed by \fBrmformat\fR(1) and volume management software. -In the current release, however, only mass storage devices with a removable bit -(RMB) value of \fB1\fR are removable. (The RMB is part of the device's SCSI -INQUIRY data.) See SCSI specifications T10/995D Revision 11a, T10/1236-D -Revision 20 or T10/1416-D Revision 23 for more information. However, for -backward compatibility, all 1394 mass storage devices can still be managed by -\fBrmformat\fR(1). With or without a volume manager, you can mount, eject, -hot remove and hot insert a 1394 mass storage device as the following sections -explain. -.SH USING VOLUME MANAGEMENT -.LP -Mass storage devices are managed by a volume manager. Software that manages -removable media creates a device nickname that can be listed with -\fBeject\fR(1) or \fBrmmount\fR(1). A device that is not mounted automatically -can be mounted using \fBrmmount\fR(1) under \fB/rmdisk/\fIlabel\fR\fR. Note -that the \fBmount\fR(1M) and \fBmount\fR(1M) commands do not accept nicknames; -you must use explicit device names with these commands. -.sp -.LP -See \fBrmmount\fR(1) to unmount the device and \fBeject\fR(1) to eject the -media. If the device is ejected while it is mounted, volume management software -unmounts the device before ejecting it. It also might kill any active -applications that are accessing the device. -.sp -.LP -Volume management software is hotplug-aware and normally mounts file systems on -USB mass storage devices if the file system is recognized. Before hot removing -the USB device, use \fBeject\fR(1) to unmount the file system. -.sp -.LP -You can disable the automatic mounting and unmounting of removable devices by -inserting a entry for a removable device in \fB/etc/vfstab\fR. In this entry, -you must set the \fBmount at boot\fR field to \fBno\fR. See \fBvfstab\fR(4). -.SH USING \fBmount\fR AND \fBumount\fR -.LP -Use \fBmount\fR(1M) to explicitly mount the device and \fBumount\fR(1M) to -unmount the device. Use \fBeject\fR(1) to eject the media. After you have -explicitly mounted a removable device, you cannot use a nickname as an argument -to \fBeject\fR. -.sp -.LP -Removing the storage device while it is being accessed or mounted fails with a -console warning. To hot remove the storage device from the system, unmount the -file system, then kill all applications accessing the device. Next, hot remove -the device. A storage device can be hot inserted at any time. -.SH DEVICE SPECIAL FILES -.LP -Block special file names are located in \fB/dev/dsk\fR. Raw file names are -located in \fB/dev/rdsk\fR. Input/output requests to the devices must follow -the same restrictions as those for SCSI disks. Refer to \fBsd\fR(7D). -.SH IOCTLS -.LP -Refer to \fBcdio\fR(7I) and \fBdkio\fR(7I). -.SH ERRORS -.LP -Refer to \fBsd\fR(7D). -.SH FILES -.LP -The device special files for the 1394 mass storage device are created like -those for a SCSI disk. Refer to \fBsd\fR(7D). -.sp -.ne 2 -.na -\fB\fB/dev/dsk/c\fIn\fRt\fIn\fRd\fIn\fRs\fIn\fR\fR\fR -.ad -.sp .6 -.RS 4n -Block files -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdsk/c\fIn\fRt\fIn\fRd\fIn\fRs\fIn\fR\fR\fR -.ad -.sp .6 -.RS 4n -Raw files -.RE - -.sp -.ne 2 -.na -\fB\fB/vol/dev/aliases/rmdisk0\fR\fR -.ad -.sp .6 -.RS 4n -Symbolic link to the character device for the media in removable drive 0. This -is a generic removable media device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/scsa1394\fR\fR -.ad -.sp .6 -.RS 4n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/scsa1394\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/scsa1394\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel module -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBcdrw\fR(1), \fBeject\fR(1), \fBrmformat\fR(1), \fBrmmount\fR(1), -\fBcfgadm_scsi\fR(1M), \fBfdisk\fR(1M), \fBmount\fR(1M), \fBumount\fR(1M), -\fBscsi\fR(4), \fBvfstab\fR(4), -\fBattributes\fR(5), \fBhci1394\fR(7D), \fBsd\fR(7D), \fBpcfs\fR(7FS), -\fBcdio\fR(7I), \fBdkio\fR(7I) -.sp -.LP -\fIIEEE Std 1394-1995 Standard for a High Performance Serial Bus\fR -.sp -.LP -\fIANSI NCITS 325-1998 - Serial Bus Protocol 2 (SBP-2)\fR -.sp -.LP -\fISystem Administration Guide: Devices and File Systems\fR -.sp -.LP -SCSI Specification \fIT10/995D Revision 11a\fR \(em March 1997 -.sp -.LP -SCSI Specification \fIT10/1236-D Revision 20\fR \(em July 2001 -.sp -.LP -SCSI Specification \fIT10/1416-D Revision 23\fR \(em May 2005 diff --git a/usr/src/man/man7d/scsa2usb.7d b/usr/src/man/man7d/scsa2usb.7d deleted file mode 100644 index e52a46fb26..0000000000 --- a/usr/src/man/man7d/scsa2usb.7d +++ /dev/null @@ -1,468 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 SCSA2USB 7D "May 23, 2021" -.SH NAME -scsa2usb \- SCSI to USB bridge driver -.SH SYNOPSIS -.nf -\fBstorage@unit-address\fR -.fi - -.SH DESCRIPTION -The \fBscsa2usb\fR driver is a \fBUSBA\fR (Solaris USB architecture) compliant -nexus driver that supports the \fIUSB Mass Storage Bulk Only Transport -Specification 1.0\fR and \fIUSB Control/Bulk/Interrupt (CBI) Transport -Specification 1.0\fR. The \fBscsa2usb\fR driver also supports USB storage -devices that implement CBI Transport without the interrupt completion for -status (that is, Control/Bulk (CB) devices.) It supports bus-powered and -self-powered USB mass storage devices. This nexus driver is both a USB client -driver and a \fBSCSA\fR HBA driver. As such, the \fBscsa2usb\fR driver only -supports storage devices that utilize the above two transports. -.sp -.LP -The \fBscsa2usb\fR driver also supports a \fBugen\fR(7D) interface allowing raw -access to the device, for example by libusb applications, bypassing -the child \fBsd\fR(7D) or \fBst\fR(7D) driver. Because a libusb application -might change the state of the device, you should not access the disk or tape -concurrently. -.sp -.LP -The \fBscsa2usb\fR nexus driver maps \fBSCSA\fR target driver requests to -\fBUSBA\fR client driver requests. -.sp -.LP -The \fBscsa2usb\fR driver creates a child device info node for each logical -unit (LUN) on the mass storage device. The standard Solaris \fBSCSI\fR disk -driver or tape driver is attached to those nodes. Refer to \fBsd\fR(7D) or -\fBst\fR(7D). -.sp -.LP -This driver supports multiple LUN devices and creates a separate child device -info node for each LUN. All child LUN nodes attach to \fBsd\fR(7D) for disks or -\fBst\fR(7D) for tapes. -.sp -.LP -In previous releases, all USB disk storage devices were treated as removable -media devices and managed by \fBrmformat\fR(1) and volume management software. -In the current release, however, only disk storage devices with a removable bit -(RMB) value of \fB1\fR are removable. (The RMB is part of the device's SCSI -INQUIRY data.) See SCSI specifications T10/995D Revision 11a, T10/1236-D -Revision 20 or T10/1416-D Revision 23 for more information. However, for -backward compatibility, all USB disk storage devices can still be managed by -\fBrmformat\fR(1). With or without a volume manager, you can mount, eject, -hot remove and hot insert a 1394 mass storage device as the following sections -explain. -.sp -.LP -Some devices may be supported by the USB mass storage driver even though they -do not identify themselves as compliant with the USB mass storage class. -.sp -.LP -The \fBscsa2usb.conf\fR file contains an \fBattribute-override-list\fR that -lists the vendor ID, product ID, and revision for matching mass storage -devices, as well as fields for overriding the default device attributes. The -entries in this list are commented out by default and may be uncommented to -enable support of particular devices. -.sp -.LP -Follow the information given in the \fBscsa2usb.conf\fR file to see if a -particular device can be supported using the override information. -For example, by adding the following to the -\fBscsa2usb.conf\fR file, many USB memory sticks and card readers might operate -more reliably: -.sp -.in +2 -.nf -attribute-override-list = "vid=* reduced-cmd-support=true"; -.fi -.in -2 - -.sp -.LP -Note that this override applies to all USB mass storage devices and might be -inappropriate for a USB CD writer. If so, you can add an entry for each device -to the attribute override list. -.sp -.LP -If USB mass storage support is considered a security risk, this driver can be -disabled in \fB/etc/system\fR as follows: -.sp -.in +2 -.nf -exclude: scsa2usb -.fi -.in -2 - -.sp -.LP -Alternatively, you can disable automatic handling of a device as described in -the following subsection. -.SS "Using Volume Management" -Disk storage devices are managed by Volume Manager. Software that manages -removable media creates a device nickname that can be listed with -\fBeject\fR(1) or \fBrmmount\fR(1). A device that is not mounted automatically -can be mounted using \fBrmmount\fR(1) under \fB/rmdisk/\fIlabel\fR\fR. Note -that the \fBmount\fR(1M) and \fBmount\fR(1M) commands do not accept nicknames; -you must use explicit device names with these commands. -.sp -.LP -See \fBrmmount\fR(1) to unmount the device and \fBeject\fR(1) to eject the -media. If the device is ejected while it is mounted, volume management software -unmounts the device before ejecting it. It also might kill any active -applications that are accessing the device. -.sp -.LP -Volume management software is hotplug-aware and normally mounts file systems on -USB mass storage devices if the file system is recognized. Before hot removing -the USB device, use \fBeject\fR(1) to unmount the file system. After the device -is removed, a console warning, such as "The disconnected device was busy, -please reconnect," might display. The warning is harmless and you can ignore -it. -.sp -.LP -You can disable the automatic mounting and unmounting of removable devices by -inserting a entry for a removable device in \fB/etc/vfstab\fR. In this entry, -you must set the \fBmount at boot\fR field to \fBno\fR. See \fBvfstab\fR(4). -.SS "Using \fBmount\fR and \fBumount\fR" -Use \fBmount\fR(1M) to explicitly mount the device and \fBumount\fR(1M) to -unmount the device. Use \fBeject\fR(1) to eject the media. After you have -explicitly mounted a removable device, you cannot use a nickname as an argument -to \fBeject\fR. -.sp -.LP -Removing the disk device while it is being accessed or mounted fails with a -console warning. To hot remove the disk device from the system, unmount the -file system, then kill all applications accessing the device. Next, hot remove -the device. A storage device can be hot inserted at any time. -.SH DEVICE SPECIAL FILES -Disk block special file names are located in \fB/dev/dsk\fR, while raw file -names are located in \fB/dev/rdsk\fR. Tape raw file names are located in -\fB/dev/rmt\fR. Input/output requests to the devices must follow the same -restrictions as those for SCSI disks or tapes. Refer to \fBsd\fR(7D) or -\fBst\fR(7D). -.SH IOCTLS -Refer to \fBdkio\fR(7I) and \fBcdio\fR(7I). -.SH ERRORS -Refer to \fBsd\fR(7D) for disks or \fBst\fR(7D) for tapes. -.SH FILES -The device special files for the USB mass storage device are created like those -for a \fBSCSI\fR disk or SCSI tape. Refer to \fBsd\fR(7D) or \fBst\fR(7D). -.sp -.ne 2 -.na -\fB\fB/dev/dsk/c\fIn\fRt\fIn\fRd\fIn\fRs\fIn\fR\fR\fR -.ad -.sp .6 -.RS 4n -Block files for disks. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdsk/c\fIn\fRt\fIn\fRd\fIn\fRs\fIn\fR\fR\fR -.ad -.sp .6 -.RS 4n -Raw files for disks. -.RE - -.sp -.ne 2 -.na -\fB/dev/usb/*/*/*\fR -.ad -.sp .6 -.RS 4n -ugen(7D) nodes -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rmt/[0-127][l,m,h,u,c][b][n]\fR\fR -.ad -.sp .6 -.RS 4n -Raw files for tapes. -.RE - -.sp -.ne 2 -.na -\fB\fB/vol/dev/aliases/zip0\fR\fR -.ad -.sp .6 -.RS 4n -Symbolic link to the character device for the media in Zip drive 0 -.RE - -.sp -.ne 2 -.na -\fB\fB/vol/dev/aliases/jaz0\fR\fR -.ad -.sp .6 -.RS 4n -Symbolic link to the character device for the media in Jaz drive 0. -.RE - -.sp -.ne 2 -.na -\fB\fB/vol/dev/aliases/rmdisk0\fR\fR -.ad -.sp .6 -.RS 4n -Symbolic link to the character device for the media in removable drive 0. This -is a generic removable media device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/scsa2usb\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/scsa2usb\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/scsa2usb.conf\fR\fR -.ad -.sp .6 -.RS 4n -Can be used to override specific characteristics. -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -\fBcdrw\fR(1), \fBeject\fR(1), \fBrmformat\fR(1), \fBrmmount\fR(1), -\fBcfgadm_scsi\fR(1M), \fBcfgadm_usb\fR(1M), \fBfdisk\fR(1M), \fBmount\fR(1M), -\fBumount\fR(1M), -\fBscsi\fR(4), \fBvfstab\fR(4), \fBattributes\fR(5), -\fBieee1394\fR(7D), \fBsd\fR(7D), \fBst\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D), -\fBpcfs\fR(7FS), \fBcdio\fR(7I), \fBdkio\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISystem Administration Guide, Volume I\fR -.sp -.LP -\fIUniversal Serial Bus Specification 2.0\fR -.sp -.LP -\fIUniversal Serial Bus Mass Storage Class Specification Overview 1.0\fR -.sp -.LP -\fIUniversal Serial Bus Mass Storage Class Bulk-Only Transport Specification -1.0\fR -.sp -.LP -\fIUniversal Serial Bus Mass Storage Class Control/Bulk/Interrupt (CBI) -Transport Specification 1.0\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.sp -.LP -SCSI Specification \fIT10/995D Revision 11a\fR \(em March 1997 -.sp -.LP -SCSI Specification \fIT10/1236-D Revision 20\fR \(em July 2001 -.sp -.LP -SCSI Specification \fIT10/1416-D Revision 23\fR \(em May 2005 -.SH DIAGNOSTICS -Refer to \fBsd\fR(7D) and \fBst\fR(7D). -.sp -.LP -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -Warning: <device path> (scsa2usb<instance number>): Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBCannot access <device>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -There was an error in accessing the mass-storage device during reconnect. -Please reconnect the device. -.RE - -.sp -.ne 2 -.na -\fBDevice is not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -Another USB device has been inserted on a port that was connected to a -mass-storage device. Please disconnect the USB device and reconnect the -mass-storage device back into that port. -.RE - -.sp -.ne 2 -.na -\fBReinserted device is accessible again.\fR -.ad -.sp .6 -.RS 4n -The mass-storage device that was hot-removed from its USB slot has been -re-inserted to the same slot and is available for access. -.RE - -.sp -.ne 2 -.na -\fBPlease disconnect and reconnect this device.\fR -.ad -.sp .6 -.RS 4n -A hotplug of the device is needed before it can be restored. -.RE - -.sp -.LP -The following messages may be logged into the system log. They are formatted in -the following manner: -.sp -.in +2 -.nf -<device path><scsa2usb<instance number>): message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBInvalid <record> in scsa2usb.conf file entry.\fR -.ad -.sp .6 -.RS 4n -An unrecognized record was specified in the \fBscsa2usb.conf\fR file. -.RE - -.sp -.ne 2 -.na -\fBPkt submitted with 0 timeout which may cause indefinite hangs.\fR -.ad -.sp .6 -.RS 4n -An application submitted a request but did not specify a timeout. -.RE - -.sp -.ne 2 -.na -\fBSyncing not supported.\fR -.ad -.sp .6 -.RS 4n -Syncing after a panic is not supported. The filesystem may be corrupted. -.RE - -.sp -.ne 2 -.na -\fBscsa2usb.conf override: <record>.\fR -.ad -.sp .6 -.RS 4n -An override record specified in \fBscsa2usb.conf\fR was applied. Examples of an -override record applied to a device with vendor ID 123 and product ID 456 are: -.sp -.in +2 -.nf -vid=0x123 pid=0x456 reduced-cmd-support=true - - or - -vid=* reduced-cmd-support=true -.fi -.in -2 - -\&...meaning that the override record is applied to this device and all other -USB mass storage devices. -.RE - -.SH NOTES -The Zip 100 drive does not comply with \fIUniversal Serial Bus Specification -1.0\fR and cannot be power managed. Power Management support for Zip 100 has -been disabled. -.sp -.LP -If the system panics while a UFS file system is mounted on the mass storage -media, no syncing will take place for the disk mass-storage device. (Syncing is -not supported by the \fBscsa2usb\fR driver.) As a result, the file system on -the media will not be consistent on reboot. -.sp -.LP -If a PCFS file system is mounted, no syncing is needed and the filesystem will -be consistent on reboot. -.sp -.LP -If a mass-storage device is busy, system suspend cannot proceed and the system -will immediately resume again. -.sp -.LP -Attempts to remove a mass-storage device from the system will fail. The failure -will be logged to the console. An attempt to replace the removed device with -some other USB device will also fail. To successfully remove a USB mass-storage -device you must "close" all references to it. -.sp -.LP -Concurrent I/O to devices with multiple LUNs on the same device is not -supported. -.sp -.LP -Some USB CD-RW devices may perform inadequately at their advertised speeds. To -compensate, use USB CD-RW devices at lower speeds (2X versus 4X). See -\fBcdrw\fR(1) for details. -.sp -.LP -This driver also supports CBI devices that do not use USB interrupt pipe for -status completion. diff --git a/usr/src/man/man7d/sd.7d b/usr/src/man/man7d/sd.7d deleted file mode 100644 index 733179ebd3..0000000000 --- a/usr/src/man/man7d/sd.7d +++ /dev/null @@ -1,840 +0,0 @@ -'\" te -.\" 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 SD 7D "September 12, 2020" -.SH NAME -sd \- SCSI disk and ATAPI/SCSI CD-ROM device driver -.SH SYNOPSIS -.nf -\fBsd@target,lun:partition\fR -.fi - -.SH DESCRIPTION -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" -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 -\fBSCSI/ATAPI\fR DVD-ROM drives, IOMEGA \fBSCSI/ATAPI\fR ZIP drives, \fBSCSI -JAZ\fR drives, and USB mass storage devices (refer to \fBscsa2usb\fR(7D)). -.sp -.LP -To determine the disk drive type, use the \fBSCSI/ATAPI\fR inquiry command and -read the volume label stored on block 0 of the drive. (The volume label -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" -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. -.sp -.LP -The x86 BIOS legacy requires a master boot record (MBR) and \fBfdisk\fR table -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 -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 -buffer. A single \fBread\fR or \fBwrite\fR call usually results in a single I/O -operation, therefore raw I/O is more efficient when many bytes are transmitted. -Block files names are found in \fB/dev/dsk\fR; raw file names are found in -\fB/dev/rdsk\fR. -.sp -.LP -I/O requests to the raw device must be aligned on a 512-byte (\fBDEV_BSIZE\fR) -boundary and all I/O request lengths must be in multiples of 512 bytes. -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 -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. -No volume label is required for a CD-ROM. The disk geometry and partitioning -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 -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 -of data, depending on the layer structure used for recording and if the DVD-ROM -is single or double-sided. -.sp -.LP -When the DVD-ROM is opened, the eject button is disabled to prevent the manual -removal of a disk until the last \fBclose()\fR is called. No volume label is -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 -\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 -the appropriate drive. -.sp -.LP -When a \fBZIP/JAZ\fR drive is opened, the eject button is disabled to prevent -the manual removal of a disk until the last \fBclose()\fR is called. No volume -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 -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 -hi-resolution time stamps at queue entry and exit points to enable monitoring -of residence time and cumulative residence-length product for each queue. -.sp -.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 be disabled in their configuration files. -.SH IOCTLS -Refer to \fBdkio\fR(7I), and \fBcdio\fR(7I) -.SS "ERRORS" -.ne 2 -.na -\fB\fBEACCES\fR\fR -.ad -.RS 10n -Permission denied -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 10n -The partition was opened exclusively by another thread -.RE - -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -The argument features a bad address -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -Invalid argument -.RE - -.sp -.ne 2 -.na -\fB\fBENOTTY\fR\fR -.ad -.RS 10n -The device does not support the requested ioctl function -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -During opening, the device did not exist. During close, the drive unlock failed -.RE - -.sp -.ne 2 -.na -\fB\fBEROFS\fR\fR -.ad -.RS 10n -The device is read-only -.RE - -.sp -.ne 2 -.na -\fB\fBEAGAIN\fR\fR -.ad -.RS 10n -Resource temporarily unavailable -.RE - -.sp -.ne 2 -.na -\fB\fBEINTR\fR\fR -.ad -.RS 10n -A signal was caught during the execution of the \fBioctl()\fR function -.RE - -.sp -.ne 2 -.na -\fB\fBENOMEM\fR\fR -.ad -.RS 10n -Insufficient memory -.RE - -.sp -.ne 2 -.na -\fB\fBEPERM\fR\fR -.ad -.RS 10n -Insufficient access permission -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 10n -An I/O error occurred. Refer to notes for details on copy-protected DVD-ROM -media. -.RE - -.SH CONFIGURATION -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 -.ne 2 -.na -\fB\fBenable-partition-kstats\fR\fR -.ad -.RS 27n -The default value is 1, which causes partition IO statistics to be maintained. -Set this value to zero to prevent the driver from recording partition -statistics. This slightly reduces the CPU overhead for IO, minimizes the amount -of \fBsar\fR(1) data collected and makes these statistics unavailable for -reporting by \fBiostat\fR(1M) even though the \fB-p\fR/\fB-P\fR option is -specified. Regardless of this setting, disk IO statistics are always -maintained. -.RE - -.sp -.ne 2 -.na -\fB\fBqfull-retries\fR\fR -.ad -.RS 27n -The supplied value is passed as the \fBqfull-retries\fR capability value of the -HBA driver. See \fBscsi_ifsetcap\fR(9F) for details. -.RE - -.sp -.ne 2 -.na -\fB\fBqfull-retry-interval\fR\fR -.ad -.RS 27n -The supplied value is passed as the \fBqfull-retry interval\fR capability value -of the HBA driver. See \fBscsi_ifsetcap\fR(9F) for details. -.RE - -.sp -.ne 2 -.na -\fB\fBallow-bus-device-reset\fR\fR -.ad -.RS 27n -The default value is 1, which allows resetting to occur. Set this value to -\fB0\fR (zero) to prevent the \fBsd\fR driver from calling \fBscsi_reset\fR(9F) -with a second argument of \fBRESET_TARGET\fR when in error-recovery mode. This -\fBscsi_reset\fR(9F) call may prompt the HBA driver to send a SCSI Bus Device -Reset message. The \fBscsi_reset\fR(9F) call with a second argument of -\fBRESET_TARGET\fR may result from an explicit request via the \fBUSCSICMD\fR -\fBioctl\fR. Some high-availability multi-initiator systems may wish to -prohibit the Bus Device Reset message; to do this, set the -\fBallow-bus-device-reset\fR property to \fB0\fR. -.RE - -.sp -.ne 2 -.na -\fBoptical-device-bind\fR -.ad -.RS 27n -Controls the binding of the driver to non self-identifying SCSI target optical -devices. (See \fBscsi\fR(4)). The default value is 1, which causes \fBsd\fR to -bind to DTYPE_OPTICAL devices (as noted in \fBscsi\fR(4)). Setting this value -to 0 prevents automatic binding. The default behavior for the SPARC-based -\fBsd\fR driver prior to Solaris 9 was not to bind to optical devices. -.RE - -.sp -.ne 2 -.na -\fB\fBpower-condition\fR\fR -.ad -.RS 27n -Boolean type, when set to \fBFalse\fR, it indicates that the disk does not -support \fBpower condition\fR field in the \fBSTART STOP UNIT\fR command. -.RE - -.sp -.LP -In addition to the above properties, some device-specific tunables can be -configured in \fBsd.conf\fR using the \fBsd-config-list\fR global property. The -value of this property is a list of duplets. The formal syntax is: -.sp -.in +2 -.nf -sd-config-list = <duplet> [, <duplet> ]* ; - -where - -<duplet>:= "<vid+pid>" , "<tunable-list>" - -and - -<tunable-list>:= <tunable> [, <tunable> ]*; -<tunable> = <name> : <value> - -The <vid+pid> is the string that is returned by the target device -on a SCSI inquiry command. - -The <tunable-list> contains one or more tunables to apply to -all target devices with the specified <vid+pid>. - -Each <tunable> is a <name> : <value> pair. Supported -tunable names are: - - delay-busy: when busy, nsecs of delay before retry. - - retries-timeout: retries to perform on an IO timeout. -.fi -.in -2 - -.sp -.ne 2 -.na -\fB\fBmmc-gesn-polling\fR\fR -.ad -.RS 20n -For optical drives compliant with \fBMMC-3\fR and supporting the \fBGET EVENT -STATUS NOTIFICATION\fR command, this command is used for periodic media state -polling, usually initiated by the \fBDKIOCSTATE\fR \fBdkio\fR(7I) ioctl. To -disable the use of this command, set this boolean property to \fBfalse\fR. In -that case, either the \fBTEST UNIT READY\fR or zero-length \fBWRITE(10)\fR -command is used instead. -.RE - -.SH EXAMPLES -.in +2 -.nf -The following is an example of a global sd-config-list property: - - sd-config-list = - "SUN T4", "delay-busy:600, retries-timeout:6", - "SUN StorEdge_3510", "retries-timeout:3"; -.fi -.in -2 - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/sd.conf\fR\fR -.ad -.RS 23n -Driver configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/dsk/cntndnsn\fR\fR -.ad -.RS 23n -Block files -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rdsk/cntndnsn\fR\fR -.ad -.RS 23n -Raw files -.RE - -.sp -.LP -Where: -.sp -.ne 2 -.na -\fBcn\fR -.ad -.RS 6n -controller n -.RE - -.sp -.ne 2 -.na -\fBtn\fR -.ad -.RS 6n -SCSI target id n (0-6) -.RE - -.sp -.ne 2 -.na -\fBdn\fR -.ad -.RS 6n -SCSI LUN n (0-7 normally; some HBAs support LUNs to 15 or 32. See the specific -manpage for details) -.RE - -.sp -.ne 2 -.na -\fBsn\fR -.ad -.RS 6n -partition n (0-7) -.RE - -.SS "x86 Only" -.ne 2 -.na -\fB\fB/dev/rdsk/cntndnpn\fR\fR -.ad -.RS 22n -raw files -.RE - -.sp -.LP -Where: -.sp -.ne 2 -.na -\fBpn\fR -.ad -.RS 6n -Where \fIn\fR=0 the node corresponds to the entire disk. -.RE - -.SH SEE ALSO -\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), -\fBfilesystem\fR(5), \fBscsa2usb\fR(7D), \fBssd\fR(7D), \fBhsfs\fR(7FS), -\fBpcfs\fR(7FS), \fBudfs\fR(7FS), \fBcdio\fR(7I), \fBdkio\fR(7I), -\fBscsi_ifsetcap\fR(9F), \fBscsi_reset\fR(9F) -.sp -.LP -\fIANSI Small Computer System Interface-2 (SCSI-2)\fR -.sp -.LP -\fIATA Packet Interface for CD-ROMs, SFF-8020i\fR -.sp -.LP -\fIMt.Fuji Commands for CD and DVD, SFF8090v3\fR -.SH DIAGNOSTICS -.in +2 -.nf -Error for Command:\fI<command name>\fR -Error Level: Fatal -Requested Block: \fI<n>\fR -Error Block: \fI<m>\fR -Vendor:'\fI<vendorname>\fR\&' -Serial Number:'\fI<serial number>\fR\&' -Sense Key:\fI<sense key name>\fR -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBASC: 0x<a> (<ASC name>), ASCQ: 0x<b>, FRU: 0x<c>\fR -.ad -.sp .6 -.RS 4n -The command indicated by <command name> failed. The Requested Block is the -block where the transfer started and the Error Block is the block that caused -the error. Sense Key, \fBASC\fR, and \fBASCQ\fR information is returned by the -target in response to a request sense command. -.RE - -.sp -.ne 2 -.na -\fBCaddy not inserted in drive\fR -.ad -.sp .6 -.RS 4n -The drive is not ready because no caddy has been inserted. -.RE - -.sp -.ne 2 -.na -\fBCheck Condition on REQUEST SENSE\fR -.ad -.sp .6 -.RS 4n -A REQUEST SENSE command completed with a check condition. The original command -will be retried a number of times. -.RE - -.sp -.ne 2 -.na -\fBLabel says <m> blocks Drive says <n> blocks\fR -.ad -.sp .6 -.RS 4n -There is a discrepancy between the label and what the drive returned on the -\fBREAD CAPACITY\fR command. -.RE - -.sp -.ne 2 -.na -\fBNot enough sense information\fR -.ad -.sp .6 -.RS 4n -The request sense data was less than expected. -.RE - -.sp -.ne 2 -.na -\fBRequest Sense couldn't get sense data\fR -.ad -.sp .6 -.RS 4n -The \fBREQUEST SENSE\fR command did not transfer any data. -.RE - -.sp -.ne 2 -.na -\fBReservation Conflict\fR -.ad -.sp .6 -.RS 4n -The drive was reserved by another initiator. -.RE - -.sp -.ne 2 -.na -\fBSCSI transport failed: reason \fB\&'xxxx'\fR: {retrying|giving up}\fR -.ad -.sp .6 -.RS 4n -The host adapter has failed to transport a command to the target for the reason -stated. The driver will either retry the command or, ultimately, give up. -.RE - -.sp -.ne 2 -.na -\fBUnhandled Sense Key<\fIn\fR>\fR -.ad -.sp .6 -.RS 4n -The REQUEST SENSE data included an invalid sense. -.RE - -.sp -.ne 2 -.na -\fBUnit not ready. Additional sense code 0x\fR -.ad -.sp .6 -.RS 4n -\fI<n>\fR The drive is not ready. -.RE - -.sp -.ne 2 -.na -\fBCan't do switch back to mode 1\fR -.ad -.sp .6 -.RS 4n -A failure to switch back to read mode 1. -.RE - -.sp -.ne 2 -.na -\fBCorrupt label - bad geometry\fR -.ad -.sp .6 -.RS 4n -The disk label is corrupted. -.RE - -.sp -.ne 2 -.na -\fBCorrupt label - label checksum failed\fR -.ad -.sp .6 -.RS 4n -The disk label is corrupted. -.RE - -.sp -.ne 2 -.na -\fBCorrupt label - wrong magic number\fR -.ad -.sp .6 -.RS 4n -The disk label is corrupted. -.RE - -.sp -.ne 2 -.na -\fBDevice busy too long\fR -.ad -.sp .6 -.RS 4n -The drive returned busy during a number of retries. -.RE - -.sp -.ne 2 -.na -\fBDisk not responding to selection\fR -.ad -.sp .6 -.RS 4n -The drive is powered down or died -.RE - -.sp -.ne 2 -.na -\fBFailed to handle UA\fR -.ad -.sp .6 -.RS 4n -A retry on a Unit Attention condition failed. -.RE - -.sp -.ne 2 -.na -\fBI/O to invalid geometry\fR -.ad -.sp .6 -.RS 4n -The geometry of the drive could not be established. -.RE - -.sp -.ne 2 -.na -\fBIncomplete read/write - retrying/giving up\fR -.ad -.sp .6 -.RS 4n -There was a residue after the command completed normally. -.RE - -.sp -.ne 2 -.na -\fBNo bp for direct access device format geometry\fR -.ad -.sp .6 -.RS 4n -A bp with consistent memory could not be allocated. -.RE - -.sp -.ne 2 -.na -\fBNo bp for disk label\fR -.ad -.sp .6 -.RS 4n -A bp with consistent memory could not be allocated. -.RE - -.sp -.ne 2 -.na -\fBNo bp for fdisk\fR -.ad -.sp .6 -.RS 4n -A bp with consistent memory could not be allocated. -.RE - -.sp -.ne 2 -.na -\fBNo bp for rigid disk geometry\fR -.ad -.sp .6 -.RS 4n -A bp with consistent memory could not be allocated. -.RE - -.sp -.ne 2 -.na -\fBNo mem for property\fR -.ad -.sp .6 -.RS 4n -Free memory pool exhausted. -.RE - -.sp -.ne 2 -.na -\fBNo memory for direct access device format geometry\fR -.ad -.sp .6 -.RS 4n -Free memory pool exhausted. -.RE - -.sp -.ne 2 -.na -\fBNo memory for disk label\fR -.ad -.sp .6 -.RS 4n -Free memory pool exhausted. -.RE - -.sp -.ne 2 -.na -\fBNo memory for rigid disk geometry\fR -.ad -.sp .6 -.RS 4n -The disk label is corrupted. -.RE - -.sp -.ne 2 -.na -\fBNo resources for dumping\fR -.ad -.sp .6 -.RS 4n -A packet could not be allocated during dumping. -.RE - -.sp -.ne 2 -.na -\fBOffline\fR -.ad -.sp .6 -.RS 4n -Drive went offline; probably powered down. -.RE - -.sp -.ne 2 -.na -\fBRequeue of command fails\fR -.ad -.sp .6 -.RS 4n -Driver attempted to retry a command and experienced a transport error. -.RE - -.sp -.ne 2 -.na -\fBsdrestart transport failed()\fR -.ad -.sp .6 -.RS 4n -Driver attempted to retry a command and experienced a transport error. -.RE - -.sp -.ne 2 -.na -\fBTransfer length not modulo\fR -.ad -.sp .6 -.RS 4n -Illegal request size. -.RE - -.sp -.ne 2 -.na -\fBTransport of request sense fails()\fR -.ad -.sp .6 -.RS 4n -Driver attempted to submit a request sense command and failed. -.RE - -.sp -.ne 2 -.na -\fBTransport rejected()\fR -.ad -.sp .6 -.RS 4n -Host adapter driver was unable to accept a command. -.RE - -.sp -.ne 2 -.na -\fBUnable to read label\fR -.ad -.sp .6 -.RS 4n -Failure to read disk label. -.RE - -.sp -.ne 2 -.na -\fBUnit does not respond to selection\fR -.ad -.sp .6 -.RS 4n -Drive went offline; probably powered down. -.RE - -.SH NOTES -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 -appropriate playback software to view video contents on DVD-ROM media -containing DVD-Video data. diff --git a/usr/src/man/man7d/sda.7d b/usr/src/man/man7d/sda.7d deleted file mode 100644 index 35d7e5d4b0..0000000000 --- a/usr/src/man/man7d/sda.7d +++ /dev/null @@ -1,59 +0,0 @@ -'\" te -.\" 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 SDA 7D "Jan 8, 2009" -.SH NAME -sda \- SD/MMC architecture -.SH DESCRIPTION -.sp -.LP -The \fBsda\fR module provides support services for Secure Digital (SD) and -MultiMediaCard (MMC) slot and card device drivers. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/misc/sda\fR\fR -.ad -.RS 28n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/sda\fR\fR -.ad -.RS 28n -64-bit ELF kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBsdhost\fR(7D) -.SH NOTES -.sp -.LP -The \fBsda\fR module provides support only for SD/MMC devices that are -connected via a supported slot driver. Notably, slots that are on USB busses -are normally treated as USB mass storage devices and are serviced by the -\fBscsa2usb\fR(7D) driver. diff --git a/usr/src/man/man7d/sdhost.7d b/usr/src/man/man7d/sdhost.7d deleted file mode 100644 index c1cc7aaf0b..0000000000 --- a/usr/src/man/man7d/sdhost.7d +++ /dev/null @@ -1,59 +0,0 @@ -'\" te -.\" 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 SDHOST 7D "Jan 8, 2009" -.SH NAME -sdhost \- Standard-compliant Secure Digital slot driver -.SH SYNOPSIS -.LP -.nf -pciclass,080500@unit-address -pciclass,080501@unit-address -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBsdhost\fR driver supports Secure Digital (SD) standard media slots -commonly found on mobile computers. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sdhost\fR\fR -.ad -.RS 30n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/sdhost\fR\fR -.ad -.RS 30n -64-bit ELF kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBsda\fR(7D) diff --git a/usr/src/man/man7d/sdp.7d b/usr/src/man/man7d/sdp.7d deleted file mode 100644 index 2f7411761c..0000000000 --- a/usr/src/man/man7d/sdp.7d +++ /dev/null @@ -1,225 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 SDP 7D "June 19, 2021" -.SH NAME -sdp \- Sockets Direct Protocol driver -.SH SYNOPSIS -.nf -#include <sys/socket.h> -.fi - -.LP -.nf -#include <netinet/in.h> -.fi - -.LP -.nf -\fBs = socket(AF_INET, SOCK_STREAM, PROTO_SDP);\fR -.fi - -.LP -.nf -\fBs = socket(AF_INET6, SOCK_STREAM, PROTO_SDP);\fR -.fi - -.SH DESCRIPTION -The Sockets Direct Protocol (\fBSDP\fR) is a transport protocol layered over -the \fIInfiniband Transport Framework\fR (\fBIBTF\fR). \fBSDP\fR is a standard -implementation based on Annex 4 of the \fIInfiniband Architecture Specification -Vol 1\fR and provides reliable byte-stream, flow controlled two-way data -transmission that closely mimics the Transmission Control Protocol (\fBTCP\fR). -.sp -.LP -\fBSDP\fR supports a sockets-based SOCK_STREAM interface to application -programs. It also supports graceful close (including half-closed sockets), IP -addressing (IPv4 or IPv6), the connecting/accepting connect model, out-of-band -(OOB) data and common socket options. The \fBSDP\fR protocol also supports -kernel bypass data transfers and data transfers from send-upper-layer-protocol -(ULP) buffers to receive ULP buffers. A \fBSDP\fR message includes a BSDH -header followed by data. (A BSDH header advertises the amount of available -buffers on the local side). -.sp -.LP -\fBSDP\fR networking functionality is broken into the \fBsdp\fR driver and a -function call-based sockfs implementation. A new protocol family of PROTO_SDP -is introduced to use the \fBSDP\fR transport provided by the driver. -.sp -.LP -Sockets utilizing \fBSDP\fR are either active or passive. Active sockets -initiate connections to passive sockets. Both active and passive sockets must -have their local IP or IPv6 address and \fBSDP\fR port number bound with the -\fBbind\fR(3SOCKET) system call after the socket is created. By default, -\fBSDP\fR sockets are active. A passive socket is created by calling the -\fBlisten\fR(3SOCKET) system call after binding the socket with bind(). This -process establishes a queueing parameter for the passive socket. Connections to -the passive socket can be received with the \fBaccept\fR(3SOCKET) system call. -Active sockets use the \fBconnect\fR(3SOCKET) call after binding to initiate -connections. -.sp -.LP -In most cases, \fBSDP\fR sends data when it is presented. When outstanding -data is not yet acknowledged, \fBSDP\fR gathers small amounts of output to be -sent in a single packet once an acknowledgement is received. For a small -number of clients this packetization may cause significant delays. To -circumvent this problem, \fBSDP\fR provided by the driver supplies -SDP_NODELAY, a socket-level boolean option. Note that this behavior is similar -to the TCP_NODELAY option. -.sp -.LP -\fBSDP\fR provides an urgent data mechanism that can be invoked using the -out-of-band provisions of \fBsend\fR(3SOCKET). The out-of-band delivery -behavior is identical to TCP. The caller may mark one byte as "urgent" with the -MSG_OOB flag to \fBsend\fR(3SOCKET). This sets an "urgent pointer" pointing to -the byte in the \fBSDP\fR stream. The receiver of the stream is notified of the -urgent data by a \fBSIGURG\fR signal. The SIOCATMARK \fBioctl\fR(2) request -returns a value indicating whether the stream is at the urgent mark. Because -the system never returns data across the urgent mark in a single \fBread\fR(2) -call, it is possible to advance to the urgent data in a simple loop which reads -data, testing the socket with the \fBSIOCATMARK\fR ioctl() request until it -reaches the mark. -.SH ADDRESS FORMATS -\fBSDP\fR uses IP/IPv6 addresses to refer to local and remote devices and -opens a reliable connected IB connection between two end points. The \fBsdp\fR -driver supports a point-to-point connection, however broadcasting and -multicasting are not supported. -.SH SOCKET OPTIONS -\fBSDP\fR supports setsockopt and getsockopt to set and read socket options. -Very few socket options affect \fBSDP\fR protocol operations. Other common -socket options are processed but do not affect SDP protocol operation. All -socket options are checked for validity. A getsockopt returns the values set or -toggled by setsockopt. Socket options that affect protocol operations are -SO_LINGER, SO_DEBUG, SO_REUSEADDR and SO_OOBINLINE. -.SH ERRORS -.ne 2 -.na -\fB\fBEISCONN\fR\fR -.ad -.RS 28n -A connect() operation was attempted on a socket on which a connect() operation -had already been performed. -.RE - -.sp -.ne 2 -.na -\fB\fBECONNRESET\fR\fR -.ad -.RS 28n -The remote peer forced the connection to be closed. This usually occurs when -the remote machine loses state information about the connection due to a crash. -.RE - -.sp -.ne 2 -.na -\fB\fBECONNREFUSED\fR\fR -.ad -.RS 28n -The remote peer actively refused connection establishment. This usually occurs -because no process is listening to the port. -.RE - -.sp -.ne 2 -.na -\fB\fBEADDRINUSE\fR\fR -.ad -.RS 28n -A bind() operation was attempted on a socket with a network address/port pair -that has already been bound to another socket. -.RE - -.sp -.ne 2 -.na -\fB\fBEADDRNOTAVAIL\fR\fR -.ad -.RS 28n -A bind() operation was attempted on a socket with a network address for which -no network interface exists. -.RE - -.sp -.ne 2 -.na -\fB\fBEACCES\fR\fR -.ad -.RS 28n -A bind() operation was attempted with a reserved port number and the effective -user ID of the process was not the privileged user. -.RE - -.sp -.ne 2 -.na -\fB\fBENOBUFS\fR\fR -.ad -.RS 28n -The system ran out of memory for internal data structures. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/amd64/sdp\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBELF\fR kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/sdp\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBELF\fR kernel module (SPARC). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/sdpib\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBELF\fR kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/sdpib\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBELF\fR kernel module (SPARC). -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attribute: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86, SPARC -.TE - -.SH SEE ALSO -\fBread\fR(2), \fBgetsockopt\fR(3XNET), \fBsocket.h\fR(3HEAD), -\fBaccept\fR(3SOCKET), \fBbind\fR(3SOCKET), \fBconnect\fR(3SOCKET), -\fBsend\fR(3SOCKET), \fBattributes\fR(5), \fBstandards\fR(5) -.sp -.LP -\fIInfiniband Architecture Specification Vol 1- Annex 4\fR \(em November, 2002 diff --git a/usr/src/man/man7d/sdt.7d b/usr/src/man/man7d/sdt.7d deleted file mode 100644 index f42b6885a9..0000000000 --- a/usr/src/man/man7d/sdt.7d +++ /dev/null @@ -1,50 +0,0 @@ -'\" te -.\" Copyright (c) 2003, 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 SDT 7D "Dec 10, 2017" -.SH NAME -sdt \- DTrace statically defined tracing provider -.SH DESCRIPTION -.LP -The \fBsdt\fR driver is a DTrace dynamic tracing provider that performs dynamic -instrumentation at statically-defined locations in the kernel. -.sp -.LP -The \fBsdt\fR provider allows kernel developers to explicitly create probes at -formally designated locations in the operating system kernel and loadable -modules, allowing the implementor to consciously choose the points in their -code that are desired probe points, and to convey some semantic knowledge about -that point with the choice of probe name and a relevant set of arguments. -.sp -.LP -The \fBsdt\fR driver is not a public interface and you access instrumentation -offered by this provider through DTrace. Refer to the \fIDynamic -Tracing Guide\fR for a description of the public documented interfaces -available for the DTrace facility and the probes offered by the \fBsdt\fR -provider. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.LP -\fBdtrace\fR(1M), \fBattributes\fR(5), \fBdtrace\fR(7D) -.sp -.LP -\fIDynamic Tracing Guide\fR: -.sp -.LP -https://illumos.org/books/dtrace/ diff --git a/usr/src/man/man7d/ses.7d b/usr/src/man/man7d/ses.7d deleted file mode 100644 index 76e92bd4cb..0000000000 --- a/usr/src/man/man7d/ses.7d +++ /dev/null @@ -1,162 +0,0 @@ -'\" te -.\" Copyright (c) 20081 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 SES 7D "May 27, 2008" -.SH NAME -ses \- SCSI enclosure services device driver -.SH SYNOPSIS -.LP -.nf -\fBses\fR\fI@target\fR\fB,\fR\fIlun\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBses\fR device driver is an interface to \fBSCSI\fR enclosure services -devices. These devices sense and monitor the physical conditions in an -enclosure as well as allow access to the status reporting and configuration -features of the enclosure (such as indicator \fBLEDs\fR on the enclosure.) -.sp -.LP -\fBioctl\fR(9E) calls may be issued to \fBses\fR to determine the state of the -enclosure and to set parameters on the enclosure services device. -.sp -.LP -No \fBses\fR driver properties are defined. Use the \fBses.conf\fR file to -configure the \fBses\fR driver. -.SH EXAMPLES -.LP -\fBExample 1 \fR\fBses.conf\fR File Format -.sp -.LP -The following is an example of the \fBses.conf\fR file format: - -.sp -.in +2 -.nf -# -# Copyright (c) 1996, by Sun Microsystems, Inc. -# All rights reserved. -# -# -#ident "@(#)ses.conf 1.1 97/02/10 SMI" -# - -name="ses" parent="sf" - target=15; - -name="ses" parent="SUNW,pln" port=0 target=15; -name="ses" parent="SUNW,pln" port=1 target=15; -name="ses" parent="SUNW,pln" port=2 target=15; -name="ses" parent="SUNW,pln" port=3 target=15; -name="ses" parent="SUNW,pln" port=4 target=15; -name="ses" parent="SUNW,pln" port=5 target=15; - -name="ses" class="scsi" - target=15 lun=0; -.fi -.in -2 - -.SH IOCTLS -.sp -.LP -The SES driver currently supports the SES, SAFTE and SEN enclosure service -chipsets. SEN and SAFTE protocols are translated internally in the driver into -SES compliant data structures. This enables the SES driver to work seamlessly -with different protocols and eliminates the need to enhance user applications. -.sp -.ne 2 -.na -\fB\fBSESIOC_GETNOBJ\fR\fR -.ad -.RS 21n -Returns an unsigned integer that represents the number of SES data structures -in the enclosure services chip. -.RE - -.sp -.ne 2 -.na -\fB\fBSESIOC_GETOBJMAP\fR\fR -.ad -.RS 21n -Returns a size array containing \fBses_object\fR elements communicated through -\fBSESIOC_GETNOBJ()\fR. \fBses_object\fR is defined in \fBsesio.h\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBSESIOC_INIT\fR\fR -.ad -.RS 21n -Instructs the device to perform a self-diagnostic test. Currently SES & SEN -devices always return success. -.RE - -.sp -.ne 2 -.na -\fB\fBSESIOC_GETENCSTAT\fR\fR -.ad -.RS 21n -Returns an unsigned character that represents status enclosure as defined by -Table 25 in Section 7.1.2 of the SES specification \fINCITS 305-199\fR\fIx\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBSESIOC_GETOBJSTAT\fR\fR -.ad -.RS 21n -This ioctl is passed an \fBses_objarg\fR containing the \fBobj_id\fR you want -to set, then fills in the remaining fields according to element status page of -the SES specification. -.RE - -.sp -.ne 2 -.na -\fB\fBSESIOC_SETOBJSTAT\fR\fR -.ad -.RS 21n -Sets options in the control field. You set control field options by filling out -all fields in \fBses_objarg\fR. Field definitions are presented in Section -7.2.2 of the SES specification. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ses.conf\fR\fR -.ad -.RS 24n -Driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBdriver.conf\fR(4), \fBscsi\fR(4), \fBattributes\fR(5), \fBesp\fR(7D), -\fBisp\fR(7D), \fBioctl\fR(9E) diff --git a/usr/src/man/man7d/sf.7d b/usr/src/man/man7d/sf.7d deleted file mode 100644 index 719e43b46a..0000000000 --- a/usr/src/man/man7d/sf.7d +++ /dev/null @@ -1,262 +0,0 @@ -'\" te -.\" Copyright (c) 1997, 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 SF 7D "Mar 27, 1997" -.SH NAME -sf \- SOC+ FC-AL FCP Driver -.SH SYNOPSIS -.LP -.nf -sf@\fIport\fR,0 -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBsf\fR driver is a SCSA compliant nexus driver which supports the Fibre -Channel Protocol for SCSI on Private Fibre Channel Arbitrated loops. An SBus -card called the \fBSOC+\fR card (see \fBsocal\fR(7D)) connects the Fibre -Channel loop to the host system. -.sp -.LP -The \fBsf\fR driver interfaces with the \fBSOC+\fR device driver, -\fBsocal\fR(7D), the SCSI disk target driver, \fBssd\fR(7D), and the SCSI-3 -Enclosure Services driver, \fBses\fR(7D). It only supports SCSI devices of -type disk and ses. -.sp -.LP -The \fBsf\fR driver supports the standard functions provided by the SCSA -interface. The driver supports auto request sense and tagged queueing by -default. -.sp -.LP -The driver requires that all devices have unique hard addresses defined by -switch settings in hardware. Devices with conflicting hard addresses will not -be accessible. -.SH FILES -.sp -.ne 2 -.na -\fB/platform/\fIarchitecture\fR/kernel/drv/sf\fR -.ad -.sp .6 -.RS 4n -ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB/platform/\fIarchitecture\fR/kernel/drv/sf.conf\fR -.ad -.sp .6 -.RS 4n -\fBsf\fR driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBluxadm\fR(1M), \fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBsocal\fR(7D), -\fBssd\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANSI X3.272-1996, Fibre Channel Arbitrated Loop (FC-AL)\fR -.sp -.LP -\fIANSI X3.269-1996, Fibre Channel Protocol for SCSI (FCP)\fR -.sp -.LP -\fIANSI X3.270-1996, SCSI-3 Architecture Model (SAM)\fR -.sp -.LP -\fIFibre Channel Private Loop SCSI Direct Attach (FC-PLDA)\fR -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the messages below may display on the system -console. -.sp -.LP -The first set of messages indicate that the attachment was unsuccessful, and -will only display while the \fBsf\fR driver is initially attempting to attach. -Each message is preceded by \fBsf\fR\fI%d\fR , where \fI%d\fR is the instance -number of the \fBsf\fR device. -.sp -.ne 2 -.na -\fBFailed to alloc soft state\fR -.ad -.sp .6 -.RS 4n -Driver was unable to allocate space for the internal state structure. Driver -did not attach to device, SCSI devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBBad soft state\fR -.ad -.sp .6 -.RS 4n -Driver requested an invalid internal state structure. Driver did not attach to -device, SCSI devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBFailed to obtain transport handle\fR -.ad -.sp .6 -.RS 4n -Driver was unable to obtain a transport handle to communicate with the socal -driver. Driver did not attach to device, SCSI devices will be inaccessible -.RE - -.sp -.ne 2 -.na -\fBFailed to allocate command/response pool\fR -.ad -.sp .6 -.RS 4n -Driver was unable to allocate space for commands and responses. Driver did not -attach to device, SCSI devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBFailed to allocate kmem cache\fR -.ad -.sp .6 -.RS 4n -Driver was unable to allocate space for the packet cache. Driver did not attach -to device, SCSI devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBFailed to allocate dma handle for\fR -.ad -.sp .6 -.RS 4n -Driver was unable to allocate a dma handle for the loop map. Driver did not -attach to device, SCSI devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBFailed to allocate lilp map\fR -.ad -.sp .6 -.RS 4n -Driver was unable to allocate space for the loop map. Driver did not attach to -device, SCSI devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBFailed to bind dma handle for\fR -.ad -.sp .6 -.RS 4n -Driver was unable to bind a dma handle for the loop map. Driver did not attach -to device, SCSI devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBFailed to attach\fR -.ad -.sp .6 -.RS 4n -Driver was unable to attach for some reason that may be printed. Driver did -not attach to device, SCSI devices will be inaccessible. -.RE - -.sp -.LP -The next set of messages may display at any time. The full device pathname, -followed by the shorter form described above, will precede the message. -.sp -.ne 2 -.na -\fBInvalid lilp map\fR -.ad -.sp .6 -.RS 4n -The driver did not obtain a valid lilp map from the socal driver. SCSI device -will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBTarget t, AL-PA x and hard\fR -.ad -.sp .6 -.RS 4n -The device with a switch setting t has an AL-PA x which does not match its hard -address y. The device will not be accessible. -.RE - -.sp -.ne 2 -.na -\fBDuplicate switch settings\fR -.ad -.sp .6 -.RS 4n -The driver detected devices with the same switch setting. All such devices will -be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBWWN changed on target t\fR -.ad -.sp .6 -.RS 4n -The World Wide Name (WWN) has changed on the device with switch setting t. -.RE - -.sp -.ne 2 -.na -\fBTarget t, unknown device type\fR -.ad -.sp .6 -.RS 4n -The driver does not know the device type reported by the device with switch -setting t. -.RE - diff --git a/usr/src/man/man7d/sfe.7d b/usr/src/man/man7d/sfe.7d deleted file mode 100644 index b1bf0b2902..0000000000 --- a/usr/src/man/man7d/sfe.7d +++ /dev/null @@ -1,201 +0,0 @@ -'\" te -.\" Copyright (c) 2007 by 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 SFE 7D "Dec 12, 2007" -.SH NAME -sfe \- SiS900 series Fast Ethernet device driver -.SH SYNOPSIS -.LP -.nf -\fB/dev/sfe\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBsfe\fR driver is a loadable, clonable, GLD-based STREAMS driver -supporting the Data Link Provider Interface \fBdlpi\fR(7P) on Silicon -Integrated Systems 900 series Fast Ethernet controllers. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The relevant fields returned as part of a \fBDL_INFO_ACK\fR response are: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU is 1500. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is 0. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The dlsap address length is 8. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -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 followed immediately by a -2-byte SAP. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Service mode is \fBDL_CLDLS\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address is the 6-byte Ethernet broadcast address -(\fBff:ff:ff:ff:ff:ff\fR). -.RE -.sp -.LP -If the SAP provided is zero, then \fIIEEE 802.3\fR mode is assumed and outbound -frames will have the frame payload length written into the type field. -Likewise, inbound frames with a SAP between zero and 1500 are interpreted as -\fIIEEE 802.3\fR frames and delivered to any streams that are bound to SAP zero -(the \fI802.3\fR SAP). -.SH PROPERTIES -.sp -.LP -The following properties may be configured using either \fBndd\fR(1M) or -the \fBsfe.conf\fR configuration file as described by \fBdriver.conf\fR(4): -.sp -.ne 2 -.na -\fB\fBadv_100fdx_cap\fR\fR -.ad -.sp .6 -.RS 4n -Enables the 100 Base TX full-duplex link option. (This is generally the fastest -mode if both link partners support it. Most modern equipment supports this -mode.) -.RE - -.sp -.ne 2 -.na -\fB\fBadv_100hdx_cap\fR\fR -.ad -.sp .6 -.RS 4n -Enables the 100 Base TX half-duplex link option. (Typically used when the link -partner is a 100 Mbps hub.) -.RE - -.sp -.ne 2 -.na -\fB\fBadv_10fdx_cap\fR\fR -.ad -.sp .6 -.RS 4n -Enables the 10 Base-T full-duplex link option. (This less-frequently used mode -is typically used when the link partner is a 10 Mbps switch.) -.RE - -.sp -.ne 2 -.na -\fB\fBadv_10hdx_cap\fR\fR -.ad -.sp .6 -.RS 4n -Enables the 10 Base-T half-duplex link option. (This is the fall-back when no -other option is available. It is typically used when the link partner is a 10 -Mbps hub or is an older network card.) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/sfe\fR\fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sfe\fR\fR -.ad -.sp .6 -.RS 4n -32-bit driver binary (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/sfe\fR\fR -.ad -.sp .6 -.RS 4n -64-bit driver binary (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/sfe\fR\fR -.ad -.sp .6 -.RS 4n -64-bit driver binary (SPARC). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sfe.conf\fR\fR -.ad -.sp .6 -.RS 4n -Configuration file. -.RE - -.SH SEE ALSO -.sp -.LP -\fBndd\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBstreamio\fR(7I), -\fBdlpi\fR(7P) -.sp -.LP -\fIIEEE 802.3\fR \(em Institute of Electrical and Electronics Engineers, 2002 diff --git a/usr/src/man/man7d/sfxge.7d b/usr/src/man/man7d/sfxge.7d deleted file mode 100644 index ae375587f1..0000000000 --- a/usr/src/man/man7d/sfxge.7d +++ /dev/null @@ -1,52 +0,0 @@ -.\" -.\" 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 2016 Garrett D'Amore <garrett@damore.org> -.\" -.Dd Apr 11, 2016 -.Dt SFXGE 7D -.Os -.Sh NAME -.Nm sfxge -.Nd Solarflare Ethernet device driver -.Sh SYNOPSIS -.Pa /dev/sfxge -.Sh DESCRIPTION -The -.Nm -driver provides support for 10 and 40 Gbps Ethernet adapters -based on the Solarflare SFC9000 family of controllers. -.Lp -These devices generally support the standard Ethernet features, including -autonegotiation, VLANs, and hardware based flow control. -The maximum frame size supported by these devices is 9202 bytes, including -the tag, if present. -.Lp -The device driver supports the -.Xr ieee802.3 5 -properties, which can be configured with -.Xr dladm 1M . -.Sh FILES -.Bl -tag -width /dev/sfxge -.It Pa /dev/sfxge -Special character device. -.El -. -.Sh SEE ALSO -.Xr dladm 1M , -.Xr ifconfig 1M , -.Xr pci 4 , -.Xr ieee802.3 5 , -.Xr dlpi 7P -.Rs -.%T IEEE 802.3: Ethernet -.%Q IEEE Standards Association -.Re diff --git a/usr/src/man/man7d/sgen.7d b/usr/src/man/man7d/sgen.7d deleted file mode 100644 index dc2c9078f1..0000000000 --- a/usr/src/man/man7d/sgen.7d +++ /dev/null @@ -1,417 +0,0 @@ -'\" te -.\" Copyright (c) 2008 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 SGEN 7D "April 9, 2016" -.SH NAME -sgen \- Generic SCSI device driver -.SH SYNOPSIS -.LP -.nf -\fB#include <sys/scsi/targets/sgendef.h>\fR -.fi - -.LP -.nf -\fBsgen@target,lun:<devtype>\fR -.fi - -.SH DESCRIPTION -.LP -The \fBsgen\fR driver exports the \fBuscsi\fR(7I) interfaces to user processes. -The \fBsgen\fR driver can be configured to bind to \fBSCSI\fR devices for which -no system driver is available. Examples of such devices include \fBSCSI\fR -scanners and \fBSCSI\fR processor devices. -.SH SECURITY -.LP -Typically, drivers which export the \fBuscsi\fR(7I) interface unconditionally -require that the user present superuser credentials. The \fBsgen\fR driver does -not, and relies on the filesystem permissions on its device special file to -govern who may access that device. By default, access is restricted and device -nodes created by the \fBsgen\fR driver are readable and writable by the -superuser exclusively. -.sp -.LP -It is important to understand that \fBSCSI\fR devices coexisting on the same -\fBSCSI\fR bus may potentially interact with each other. This may result from -firmware bugs in \fBSCSI\fR devices, or may be made to happen programmatically -by sending appropriate \fBSCSI\fR commands to a device. Potentially, any -application controlling a device via the \fBsgen\fR driver can introduce data -integrity or security problems in that device or any other device sharing the -same \fBSCSI\fR bus. -.sp -.LP -Granting unprivileged users access to an \fBsgen\fR-controlled \fBSCSI\fR -device may create other problems. It may be possible for a user to instruct a -target device to gather data from another target device on the same bus. It may -also be possible for malicious users to install new firmware onto a device to -which they are granted access. In environments where security is a concern but -user access to devices controlled by the \fBsgen\fR driver is nonetheless -desired, it is recommended that the devices be separated onto a dedicated -\fBSCSI\fR bus to mitigate the risk of data corruption and security violations. -.SH CONFIGURATION -.LP -The \fBsgen\fR driver is configurable via the \fBsgen.conf\fR file. In addition -to standard \fBSCSI\fR device configuration directives (see \fBscsi\fR(4)), -administrators can set several additional properties for the \fBsgen\fR driver. -.sp -.LP -By default, the \fBsgen\fR driver will not claim or bind to any devices on the -system. To do so, it must be configured by the administrator using the -\fBinquiry-config-list\fR and/or the \fBdevice-type-config-list\fR properties. -.sp -.LP -As with other \fBSCSI\fR drivers, the \fBsgen.conf\fR configuration file -enumerates the targets \fBsgen\fR should use. See \fBscsi\fR(4) for more -details. For each target enumerated in the \fBsgen.conf\fR file, the -\fBsgen\fR driver sends a \fBSCSI INQUIRY\fR command to gather information -about the device present at that target. The \fBinquiry-config-list\fR property -specifies that the \fBsgen\fR driver should bind to a particular device -returning a particular set of inquiry data. The \fBdevice-type-config-list\fR -specifies that the \fBsgen\fR driver should bind to every device that is of a -particular \fBSCSI\fR device type. When examining the device, the \fBsgen\fR -driver tests to see if it matches an entry in the \fBdevice-type-config-list\fR -or the \fBinquiry-config-list\fR. For more detail on these two properties, see -the PROPERTIES section. -.sp -.LP -When a match against the \fBINQUIRY\fR data presented by a device is made, the -\fBsgen\fR driver attaches to that device and creates a device node and link in -the \fB/devices\fR and \fB/dev\fR hierarchies. See the FILES section for more -information about how these files are named. -.sp -.LP -It is important for the administrator to ensure that devices claimed by the -\fBsgen\fR driver do not conflict with existing target drivers on the system. -For example, if the \fBsgen\fR driver is configured to bind to a direct access -device, the standard \fBsd.conf\fR file will usually cause \fBsd\fR to claim -the device as well. This can cause unpredictable results. In general, the -\fBuscsi\fR(7I) interface exported by \fBsd\fR(7D) or \fBst\fR(7D) should be -used to gain access to direct access and sequential devices. -.sp -.LP -The \fBsgen\fR driver is disabled by default. The \fBsgen.conf\fR file is -shipped with all of the '\fBname="sgen" class="scsi" target=...\fR' entries -commented out to shorten boot time and to prevent the driver from consuming -kernel resources. To use the \fBsgen\fR driver effectively on desktop systems, -simply uncomment all of the name="\fBsgen\fR" lines in \fBsgen.conf\fR file. On -larger systems with many \fBSCSI\fR controllers, carefully edit the -\fBsgen.conf\fR file so that \fBsgen\fR binds only where needed. Refer to -\fBdriver.conf\fR(4) for further details. -.SH PROPERTIES -.ne 2 -.na -\fB\fBinquiry-config-list\fR\fR -.ad -.RS 23n -The \fBinquiry-config-list\fR property is a list of pairs of strings that -enumerates a list of specific devices to which the \fBsgen\fR driver will bind. -Each pair of strings is referred to as <\fBvendorid\fR, \fBproductid\fR> in the -discussion below. -.RE - -.sp -.ne 2 -.na -\fB\fBvendorid\fR\fR -.ad -.RS 12n - is used to match the Vendor ID reported by the device. The \fBSCSI\fR -specification limits Vendor IDs to eight characters. Correspondingly, the -length of this string should not exceed eight characters. As a special case, -"\fB*\fR" may be used as a wildcard which matches any Vendor ID. This is useful -in situations where more than one vendor produces a particular model of a -product. \fBvendorid\fR is matched against the Vendor ID reported by the device -in a case-insensitive manner. -.RE - -.sp -.ne 2 -.na -\fB\fBproductid\fR\fR -.ad -.RS 13n - is used to match the product ID reported by the device. The \fBSCSI\fR -specification limits product IDs to sixteen characters (unused characters are -filled with the whitespace characters). Correspondingly, the length of -\fBproductid\fR should not exceed sixteen characters. When examining the -product ID of the device, \fBsgen\fR examines the length l of \fBproductid\fR -and performs a match against only the first l characters in the device's -product ID. \fBproductid\fR is matched against the product ID reported by the -device in a case-insensitive manner. -.RE - -.sp -.LP -For example, to match some fictitious devices from ACME corp, the -\fBinquiry-config-list\fR can be configured as follows: -.sp - -.sp -.TS -l l l -l l l . -\fBinquiry-config-list = \fR \fB"ACME"\fR, \fB"UltraToast 3000"\fR, - \fB"ACME"\fR, \fB"UltraToast 4000"\fR, - \fB"ACME"\fR, \fB"UltraToast 5000"\fR; -.TE - -.sp -.LP -To match "UltraToast 4000" devices, regardless of vendor, -\fBinquiry-config-list\fR is modified as follows: -.sp - -.sp -.TS -l l l . -\fBinquiry-config-list = \fR \fB"*",\fR \fB"UltraToast 4000"\fR; -.TE - -.sp -.LP -To match every device from ACME in the "UltraToast" series (i.e UltraToast -3000, 4000, 5000, ...), \fB inquiry-config-list\fR is modified as follows: -.sp - -.sp -.TS -l l l . -\fBinquiry-config-list = \fR \fB"ACME"\fR \fB "UltraToast";\fR -.TE - -.sp -.LP -Whitespace characters \fBare\fR significant when specifying \fBproductid\fR. -For example, a \fBproductid\fR of "UltraToast 1000" is fifteen characters in -length. If a device reported its ID as "UltraToast 10000", the \fBsgen\fR -driver would bind to it because only the first fifteen characters are -considered significant when matching. To remedy this situation, specify -\fBproductid\fR as "UltraToast 1000 ", (note trailing space). This forces the -\fBsgen\fR driver to consider all sixteen characters in the product ID to be -significant. -.sp -.ne 2 -.na -\fB\fBdevice-type-config-list\fR\fR -.ad -.RS 27n -The \fBdevice-type-config-list\fR property is a list of strings that enumerate -a list of device types to which the \fBsgen\fR driver will bind. The valid -device types correspond to those defined by the \fISCSI-3 SPC Draft Standard, -Rev. 11a\fR. These types are: -.RE - -.sp - -.sp -.TS -c | c -l | l . -Type Name Inquiry Type ID -_ -direct 0x00 -sequential 0x01 -printer 0x02 -processor 0x03 -worm 0x04 -rodirect 0x05 -scanner 0x06 -optical 0x07 -changer 0x08 -comm 0x09 -prepress1 0x0a -prepress2 0x0b -array_ctrl 0x0c -ses 0x0d -rbc 0x0e -ocrw 0x0f -bridge 0x10 -type_unknown 0x1f -.TE - -.sp -.LP -Alternately, you can specify device types by \fBINQUIRY\fR type ID. To do -this, specify \fBtype_0x<typenum>\fR in the \fBsgen-config-list\fR. Case is not -significant when specifying device type names. -.sp -.ne 2 -.na -\fB\fBsgen-diag\fR\fR -.ad -.RS 13n -The \fBsgen-diag\fR property sets the diagnostic output level. This property -can be set globally and/or per target/lun pair. \fBsgen-diag\fR is an integer -property, and can be set to 0, 1, 2 or 3. Illegal values will silently default -to 0. The meaning of each diagnostic level is as follows: -.RE - -.sp -.ne 2 -.na -\fB\fB0\fR\fR -.ad -.RS 5n -No error reporting [default] -.RE - -.sp -.ne 2 -.na -\fB\fB1\fR\fR -.ad -.RS 5n -Report driver configuration information, unusual conditions, and indicate when -sense data has been returned from the device. -.RE - -.sp -.ne 2 -.na -\fB\fB2\fR\fR -.ad -.RS 5n -Trace the entry into and exit from routines inside the driver, and provide -extended diagnostic data. No error reporting [default]. -.RE - -.sp -.ne 2 -.na -\fB\fB3\fR\fR -.ad -.RS 5n -Provide detailed output about command characteristics, driver state, and the -contents of each CDB passed to the driver. -.RE - -.sp -.LP -In ascending order, each level includes the diagnostics that the previous level -reports. See the IOCTLS section for more information on the \fBSGEN_IOC_DIAG\fR -ioctl. -.SH FILES -.ne 2 -.na -\fB\fBsgen.conf\fR\fR -.ad -.RS 30n -Driver configuration file. See CONFIGURATION for more details. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/scsi/<devtype>/c\fIn\fRt\fIn\fRd\fIn\fR\fR\fR -.ad -.RS 30n -The \fBsgen\fR driver categorizes each device in a separate directory by its -\fBSCSI\fR device type. The files inside the directory are named according to -their controller number, target ID and LUN as follows: -.sp -c\fIn\fR is the controller number, t\fIn\fR is the \fBSCSI\fR target id and -d\fIn\fR is the \fBSCSI\fR LUN -.sp -This is analogous to the {\fBcontroller;target;device\fR} naming scheme, and -the controller numbers correspond to the same controller numbers which are used -for naming disks. For example, \fB/dev/dsk/c0t0d0s0\fR and -\fB/dev/scsi/scanner/c0t5d0\fR are both connected to controller \fBc0\fR. -.RE - -.SH IOCTLS -.LP -The \fBsgen\fR driver exports the \fBuscsi\fR(7I) interface for each device it -manages. This allows a user process to talk directly to a \fBSCSI\fR device for -which there is no other driver installed in the system. Additionally, the -\fBsgen\fR driver supports the following ioctls: -.sp -.ne 2 -.na -\fB\fBSGEN_IOC_READY\fR\fR -.ad -.RS 18n -Send a \fBTEST UNIT READY\fR command to the device and return 0 upon success, -non-zero upon failure. This ioctl accepts no arguments. -.RE - -.sp -.ne 2 -.na -\fB\fBSGEN_IOC_DIAG\fR\fR -.ad -.RS 18n -Change the level of diagnostic reporting provided by the driver. This ioctl -accepts a single integer argument between 0 and 3. The levels have the same -meaning as in the \fBsgen-diag\fR property discussed in PROPERTIES above. -.RE - -.SH ERRORS -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 10n -The device was opened by another thread or process using the O_EXCL flag, or -the device is currently open and O_EXCL is being requested. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -During opening, the device did not respond to a \fBTEST UNIT READY\fR -\fBSCSI\fR command. -.RE - -.sp -.ne 2 -.na -\fB\fBENOTTY\fR\fR -.ad -.RS 10n -Indicates that the device does not support the requested ioctl function. -.RE - -.SH EXAMPLES -.LP -Here is an example of how \fBsgen\fR can be configured to bind to scanner -devices on the system: -.sp -.LP -\fBdevice-type-config-list = "scanner";\fR -.sp -.LP -The administrator should subsequently uncomment the appropriate -\fBname="sgen"...\fR lines for the \fBSCSI\fR target ID to which the scanner -corresponds. In this example, the scanner is at target 4. -.sp -.LP -\fBname= "sgen" class= "scsi" target=4 lun=0;\fR -.sp -.LP -If it is expected that the scanner will be moved from target to target over -time, or that more scanners might be added in the future, it is recommended -that all of the \fBname="sgen"...\fR lines be uncommented, so that \fBsgen\fR -checks all of the targets on the bus. -.sp -.LP -For large systems where boot times are a concern, it is recommended that the -\fBparent=""\fR property be used to specify which \fBSCSI\fR bus \fBsgen\fR -should examine. -.SH SEE ALSO -.LP -\fBdriver.conf\fR(4), \fBscsi\fR(4), \fBsd\fR(7D), \fBst\fR(7D), -\fBuscsi\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANSI Small Computer System Interface-2 (SCSI-2) \fR -.sp -.LP -\fISCSI-3 SPC Draft Standard, Rev. 11a\fR diff --git a/usr/src/man/man7d/si3124.7d b/usr/src/man/man7d/si3124.7d deleted file mode 100644 index 6205e21618..0000000000 --- a/usr/src/man/man7d/si3124.7d +++ /dev/null @@ -1,69 +0,0 @@ -'\" te -.\" Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved. -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SI3124 7D "Aug 17, 2007" -.SH NAME -si3124 \- SiliconImage 3124/3132/3531 SATA controller driver -.SH SYNOPSIS -.LP -.nf -\fBsata@unit-address\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBsi3124\fR driver is a \fBSATA\fR framework-compliant HBA driver that -supports Silicon Image 3124, 3132 and 3531 \fBSATA\fR controllers. Note that while -the Silicon Image controllers supports standard \fBSATA\fR features including -SATA-II disks, NCQ, hotplug, port multiplier and ATAPI disks, the \fBsi3124\fR -driver currently does not support NCQ, port multiplier or ATAPI features. -.SH CONFIGURATION -.sp -.LP -There are no tunable parameters in the \fBsi3124.conf\fR file. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/si3124\fR\fR -.ad -.RS 28n -32-bit ELF kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/si3124\fR\fR -.ad -.RS 28n -64-bit ELF kernel module. (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBcfgadm\fR(1M), \fBprtconf\fR(1M), \fBcfgadm_sata\fR(1M), -\fBattributes\fR(5), \fBnv_sata\fR(7D), \fBsata\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man7d/skd.7d b/usr/src/man/man7d/skd.7d deleted file mode 100644 index 4d9488674f..0000000000 --- a/usr/src/man/man7d/skd.7d +++ /dev/null @@ -1,25 +0,0 @@ -.\" -.\" 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 2014 Nexenta Systems, Inc. All rights reserved. -.\" - -.TH SKD 7D "August 10, 2013" -.SH NAME -skd \- sTec S112x PCIe Solid-State Disk driver -.SH DESCRIPTION -.LP -The \fBskd\fR driver uses the \fBblkdev\fR framework to provide a solid-state -disk in \fB/dev/dsk/cNt0d0*\fR from the sTec S112x series of PCIe cards. -.LP -The skd.conf file, in \fB/kernel/drv/skd.conf\fR, contains configuration -parameters for the driver, and are documented there. They are considered an -unstable interface, subject to change without notice. diff --git a/usr/src/man/man7d/smbios.7d b/usr/src/man/man7d/smbios.7d deleted file mode 100644 index b38a90b70b..0000000000 --- a/usr/src/man/man7d/smbios.7d +++ /dev/null @@ -1,66 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 SMBIOS 7D "Aug 26, 2005" -.SH NAME -smbios \- System Management BIOS image -.SH SYNOPSIS -.LP -.nf -\fB/dev/smbios\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBsmbios\fR device is a character special file that provides access to a -snapshot of the System Management BIOS (\fBSMBIOS\fR) image exported by the -current system. \fBSMBIOS\fR is an industry-standard mechanism that enables -low-level system software to export hardware configuration information to -higher-level system management software. The \fBSMBIOS\fR data format is -defined by the Distributed Management Task Force (\fBDMTF\fR). For more -information on \fBSMBIOS\fR and to obtain a copy of the \fBSMBIOS\fR -specification and implementation guidelines, refer to -http://\fIwww.dmtf.org\fR. -.sp -.LP -The \fBSMBIOS\fR image consists of a table of structures, each describing some -aspect of the system software or hardware configuration. The content of the -image varies widely by platform and BIOS vendor and may not exist on some -systems. You can use the \fBsmbios\fR(1M) utility to inspect the contents of -the \fBSMBIOS\fR image and copy it to a file. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Stable -.TE - -.SH SEE ALSO -.sp -.LP -\fBprtdiag\fR(1M), \fBsmbios\fR(1M), \fBattributes\fR(5) -.sp -.LP -\fISystem Management BIOS Reference Specification\fR, Version 2, Release 4 \(em -2005 -.SH NOTES -.sp -.LP -The implementation of a System Management BIOS image is entirely at the -discretion of the system and BIOS vendors. Not all systems export a -\fBSMBIOS\fR. The \fBSMBIOS\fR structure content varies widely between systems -and BIOS vendors and frequently does not comply with the guidelines included in -the specification. For example, some structure fields may not be filled in by -the BIOS, while others may be filled in with non-conforming values. diff --git a/usr/src/man/man7d/smbus.7d b/usr/src/man/man7d/smbus.7d deleted file mode 100644 index cbeb16a8c4..0000000000 --- a/usr/src/man/man7d/smbus.7d +++ /dev/null @@ -1,61 +0,0 @@ -'\" te -.\" Copyright 2003 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 SMBUS 7D "Jul 23, 2003" -.SH NAME -smbus \- System Management Bus controller driver -.SH DESCRIPTION -.sp -.LP -The \fBsmbus\fR driver is a I2C (Inter IC) nexus driver that allows the system -to communicate with various system component chips. SMBus is a two-wire -control bus based on the I2C protocol through which systems can communicate -with various I2C devices connected to the bus. -.sp -.LP -The \fBsmbus\fR driver supports byte and block level transfer based on -interrupt and polled mode. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/platform/sun4u/kernel/drv/sparcv9/smbus\fR \fR -.ad -.sp .6 -.RS 4n -64 bit ELF kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISystem Management Bus (SMBus) Specification 2.0\fR \(em SBS Implementation -Forum -.sp -.LP -\fIThe I2C Bus and How To Use It\fR \(emPhilips Semiconductor Document # -98-8080-575-01 diff --git a/usr/src/man/man7d/smntemp.7d b/usr/src/man/man7d/smntemp.7d deleted file mode 100644 index 903d060825..0000000000 --- a/usr/src/man/man7d/smntemp.7d +++ /dev/null @@ -1,56 +0,0 @@ -.\" -.\" 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. -.\" Copyright 2020 Oxide Computer Company -.\" -.Dd September 1, 2020 -.Dt SMNTEMP 7D -.Os -.Sh NAME -.Nm smntemp -.Nd AMD SMN Temperature Sensor Driver -.Sh SYNOPSIS -.Pa /dev/sensors/temperature/cpu/* -.Sh DESCRIPTION -The -.Nm -driver provides the system access to the temperature sensor found in the -AMD System Management Network -.Pq SMN -on AMD Family 17h -.Pq Zen, Zen+, and Zen 2 -processors. -.Pp -From this, the driver exposes temperature sensors. -On Family 17h systems, temperature sensors exist for each Zeppelin die, -of which there may be multiple in a single package. -This means that each sensor covers more than one core. -.Pp -Temperature information is available to the system via the fault -management architecture -.Pq FMA . -The file system location and programming interface to the -.Nm -driver are considered -.Sy Volatile , -subject to change without notice, and should not be used directly. -Raw temperature information can be dumped through the FMA developer -utility fmtopo. -.Sh SEE ALSO -.Xr fmadm 1M , -.Xr amdnbtemp 7D , -.Xr amdzen 7D -.Rs -.%A AMD -.%B Open-Source Register Reference For AMD Family 17h Processors Models 00h-2Fh -.%D July, 2018 -.Re diff --git a/usr/src/man/man7d/socal.7d b/usr/src/man/man7d/socal.7d deleted file mode 100644 index 9a00167866..0000000000 --- a/usr/src/man/man7d/socal.7d +++ /dev/null @@ -1,225 +0,0 @@ -'\" te -.\" Copyright (c) 1997, 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 SOCAL 7D "May 9, 1997" -.SH NAME -socal \- Serial Optical Controller for Fibre Channel Arbitrated Loop (SOC+) -device driver -.SH SYNOPSIS -.LP -.nf -\fBsocal@\fIsbus-slot\fR,0\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The Fibre Channel Host Bus Adapter is an SBus card which implements two full -duplex Fibre Channel interfaces. Each Fibre Channel interface can connect to a -Fibre Channel Arbitrated Loop (FC-AL). -.sp -.LP -The \fBsocal\fR device driver is a nexus driver and implements portions of the -FC-2 and FC-4 layers of FC-AL. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/socal\fR\fR -.ad -.RS 21n -ELF Kernel Module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBsbus\fR(4), \fBsf\fR(7D), \fBssd\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANSI X3.230-1994, Fibre Channel Physical and Signalling Interface (FC-PH)\fR -.sp -.LP -\fIANSI X3.272-1996, Fibre Channel Arbitrated Loop (FC-AL)\fR -.sp -.LP -\fIFibre Channel Private Loop SCSI Direct Attach (FC-PLDA)\fR -.SH DIAGNOSTICS -.sp -.LP -The messages described below may appear on system console in addition to being -logged. -.sp -.LP -On the console, these messages are preceded by: -.sp -.in +2 -.nf -\fBsocal\fR\fI%d\fR\fB: port \fR\fI%a\fR -.fi -.in -2 -.sp - -.sp -.LP -where \fI%d\fR is the instance number of the \fBsocal\fR controller and -\fI%a\fR is the port on the host adapter. -.sp -.ne 2 -.na -\fBFibre Channel Loop is ONLINE\fR -.ad -.sp .6 -.RS 4n -The Fibre Channel loop is now online. -.RE - -.sp -.ne 2 -.na -\fBFibre Channel Loop is OFFLINE\fR -.ad -.sp .6 -.RS 4n -The Fibre Channel loop is now offline. -.RE - -.sp -.ne 2 -.na -\fBattach failed: device in slave-only slot.\fR -.ad -.sp .6 -.RS 4n -Move soc+ card to another slot. -.RE - -.sp -.ne 2 -.na -\fBattach failed: bad soft state.\fR -.ad -.sp .6 -.RS 4n -Driver did not attach, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: unable to alloc xport struct.\fR -.ad -.sp .6 -.RS 4n -Driver did not attach, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: unable to map eeprom\fR -.ad -.sp .6 -.RS 4n -Driver was unable to map device memory; check for bad hardware. Driver did not -attach to device, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: unable to map XRAM\fR -.ad -.sp .6 -.RS 4n -Driver was unable to map device memory; check for bad hardware. Driver did -not attach to device, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: unable to map registers\fR -.ad -.sp .6 -.RS 4n -Driver was unable to map device registers; check for bad hardware. Driver did -not attach to device, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: unable to access status register\fR -.ad -.sp .6 -.RS 4n -Driver was unable to map device registers; check for bad hardware. Driver did -not attach to device, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: unable to install interrupt handler\fR -.ad -.sp .6 -.RS 4n -Driver was not able to add the interrupt routine to the kernel. Driver did -not attach to device, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: unable to access host adapter XRAM\fR -.ad -.sp .6 -.RS 4n -Driver was unable to access device RAM; check for bad hardware. Driver did -not attach to device, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: unable to write host adapter XRAM\fR -.ad -.sp .6 -.RS 4n -Driver was unable to write device RAM; check for bad hardware. Driver did not -attach to device, devices will be inaccessible. -.RE - -.sp -.ne 2 -.na -\fBattach failed: read/write mismatch in XRAM\fR -.ad -.sp .6 -.RS 4n -Driver was unable to verify device RAM; check for bad hardware. Driver did -not attach to device, devices will be inaccessible. -.RE - diff --git a/usr/src/man/man7d/srpt.7d b/usr/src/man/man7d/srpt.7d deleted file mode 100644 index ee9917112c..0000000000 --- a/usr/src/man/man7d/srpt.7d +++ /dev/null @@ -1,88 +0,0 @@ -'\" te -.\" 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 SRPT 7D "May 21, 2009" -.SH NAME -srpt \- SCSI RDMA Protocol Target Driver for Infiniband (IB) -.SH DESCRIPTION -.sp -.LP -The \fBsrpt\fR kernel pseudo device driver is an IB Architecture-compliant -implementation of the target side of the SCSI RDMA Protocol (SRP). SRP -accelerates the SCSI protocol by mapping SCSI data transfer phases to RDMA -operations using InfiniBand as the underlying transport. -.sp -.LP -SRP target services are enabled and disabled through \fBsmf\fR(5), using the -FMRI \fBsvc:/system/ibsrp/target\fR. -.sp -.LP -When enabled, \fBsrpt\fR enumerates each IB Host Channel Adapter (HCA) on the -system and registers each one as a SCSI target using the SCSI Target Mode -Framework (STMF). -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/srpt\fR\fR -.ad -.RS 28n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/srpt\fR\fR -.ad -.RS 28n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/srpt\fR\fR -.ad -.RS 28n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/srpt.conf\fR\fR -.ad -.RS 28n -Driver configuration file -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBstmfadm\fR(1M), \fBib\fR(7D), \fBibdma\fR(7D), \fBibtl\fR(7D), -\fBattributes\fR(5) -.sp -.LP -\fICOMSTAR Administration Guide\fR -.sp -.LP -\fISCSI RDMA Protocol (SRP) T10 Project 1415-D, Revision\fR diff --git a/usr/src/man/man7d/ssd.7d b/usr/src/man/man7d/ssd.7d deleted file mode 100644 index 97e959b598..0000000000 --- a/usr/src/man/man7d/ssd.7d +++ /dev/null @@ -1,591 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 SSD 7D "September 12, 2020" -.SH NAME -ssd \- Fibre Channel Arbitrated Loop disk device driver -.SH SYNOPSIS -.nf -\fBssd@\fR\fIport\fR\fB,\fR\fItarget\fR\fB:\fR\fIpartition\fR -.fi - -.SH DESCRIPTION - The \fBssd\fR driver supports Fibre Channel disk devices. -.sp -.LP -The specific type of each disk is determined by the \fBSCSI\fR inquiry command -and reading the volume label stored on block 0 of the drive. The volume label -describes the disk geometry and partitioning; it must be present or the disk -cannot be mounted by the system. -.sp -.LP -The block-files access the disk using the system's normal buffering mechanism -and are read and written without regard to physical disk records. A "raw" -interface provides for direct transmission between the disk and the read or -write buffer. A single read or write call usually results in one I/O operation; -raw I/O is therefore more efficient when many bytes are transmitted. Block file -names are found in \fB/dev/dsk\fR; the names of the raw files are found in -\fB/dev/rdsk\fR. -.sp -.LP -I/O requests (such as \fBlseek\fR(2)) to the \fBSCSI\fR disk must have an -offset that is a multiple of 512 bytes (\fBDEV_BSIZE\fR), or the driver returns -an \fBEINVAL\fR error. If the transfer length is not a multiple of 512 bytes, -the transfer count is rounded up by the driver. -.sp -.LP -Partition 0 is normally used for the root file system on a disk, with partition -1 as a paging area (for example, \fBswap\fR). Partition 2 is used to back up -the entire disk. Partition 2 normally maps the entire disk and may also be used -as the mount point for secondary disks in the system. The rest of the disk is -normally partition 6. For the primary disk, the user file system is located -here. -.sp -.LP -The device has associated error statistics. These must include counters for -hard errors, soft errors and transport errors. Other data may be implemented as -required. -.SH DEVICE STATISTICS SUPPORT -The 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 hi-resolution -time stamps at queue entry and exit points to enable monitoring of residence -time and cumulative residence-length product for each queue. -.sp -.LP -Not all device drivers make per-partition IO statistics available for -reporting. \fBssd\fR and \fBsd\fR(7D) per-partition statistics are enabled by -default but may be disabled in their configuration files. -.SH IOCTLS -Refer to \fBdkio\fR(7I). -.SH ERRORS -.ne 2 -.na -\fB\fBEACCES\fR\fR -.ad -.RS 10n -Permission denied. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 10n -The partition was opened exclusively by another thread. -.RE - -.sp -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 10n -The argument was a bad address. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -Invalid argument. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 10n -An I/O error occurred. -.RE - -.sp -.ne 2 -.na -\fB\fBENOTTY\fR\fR -.ad -.RS 10n -The device does not support the requested ioctl function. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -When returned during \fBopen\fR(2), this error indicates the device does not -exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEROFS\fR\fR -.ad -.RS 10n -The device is a read-only device. -.RE - -.SH CONFIGURATION -You configure the \fBssd\fR driver by defining properties in the -\fBssd.conf\fR file. The \fBssd\fR driver supports the following properties: -.sp -.ne 2 -.na -\fB\fBenable-partition-kstats\fR\fR -.ad -.RS 27n -The default value is 1, which causes partition IO statistics to be maintained. -Set this value to zero to prevent the driver from recording partition -statistics. This slightly reduces the CPU overhead for IO, minimizes the amount -of \fBsar\fR(1) data collected and makes these statistics unavailable for -reporting by \fBiostat\fR(1M) even though the \fB-p\fR/\fB-P\fR option is -specified. Regardless of this setting, disk IO statistics are always -maintained. -.RE - -.sp -.LP -In addition to the above properties, some device-specific tunables can be -configured in \fBssd.conf\fR using the 'ssd-config-list' global property. The -value of this property is a list of duplets. The formal syntax is: -.sp -.in +2 -.nf -ssd-config-list = <duplet> [, <duplet> ]* ; - -where - -<duplet>:= "<vid+pid>" , "<tunable-list>" - -and - -<tunable-list>:= <tunable> [, <tunable> ]*; -<tunable> = <name> : <value> - -The <vid+pid> is the string that is returned by the target device -on a SCSI inquiry command. - -The <tunable-list> contains one or more tunables to apply to -all target devices with the specified <vid+pid>. - -Each <tunable> is a <name> : <value> pair. Supported -tunable names are: - - delay-busy: when busy, nsecs of delay before retry. - - retries-timeout: retries to perform on an IO timeout. -.fi -.in -2 - -.SH EXAMPLES -.in +2 -.nf -The following is an example of a global ssd-config-list property: - - ssd-config-list = - "SUN T4", "delay-busy:600, retries-timeout:6", - "SUN StorEdge_3510", "retries-timeout:3"; -.fi -.in -2 - -.SH FILES -.ne 2 -.na -\fBssd.conf\fR -.ad -.RS 22n -Driver configuration file -.RE - -.sp -.ne 2 -.na -\fB/dev/dsk/c\fIn\fR\fBt\fR\fIn\fR\fBd\fR\fIn\fR\fBs\fR\fIn\fR\fR -.ad -.RS 22n -block files -.RE - -.sp -.ne 2 -.na -\fB/dev/rdsk/c\fIn\fR\fBt\fR\fIn\fR\fBd\fR\fIn\fR\fBs\fR\fIn\fR\fR -.ad -.RS 22n -raw files -.RE - -.sp -.ne 2 -.na -\fBc\fIn\fR\fR -.ad -.RS 22n -is the controller number on the system. -.RE - -.sp -.ne 2 -.na -\fBt\fIn\fR\fR -.ad -.RS 22n -7-bit disk loop identifier, such as switch setting -.RE - -.sp -.ne 2 -.na -\fBd\fIn\fR\fR -.ad -.RS 22n -SCSI lun \fIn\fR -.RE - -.sp -.ne 2 -.na -\fB\fBs\fR\fIn\fR\fR -.ad -.RS 22n -partition \fIn\fR (0-7) -.RE - -.SH SEE ALSO -\fBsar\fR(1), \fBformat\fR(1M), \fBiostat\fR(1M), \fBioctl\fR(2), -\fBlseek\fR(2), \fBopen\fR(2), \fBread\fR(2), \fBwrite\fR(2), -\fBscsi\fR(4), \fBdriver.conf\fR(4), \fBcdio\fR(7I), \fBdkio\fR(7I) -.sp -.LP -\fIANSI Small Computer System Interface-2 (SCSI-2)\fR -.sp -.LP -\fIANSI X3.272-1996, Fibre Channel Arbitrated Loop (FC-AL)\fR -.sp -.LP -\fIFibre Channel - Private Loop SCSI Direct Attach (FC-PLDA)\fR -.SH DIAGNOSTICS -.in +2 -.nf -Error for command '<command name>' Error Level: Fatal Requested Block <n>, -Error Block: <m>, Sense Key: <sense key name>, Vendor '<vendor name>': -ASC = 0x<a> (<ASC name>), ASCQ = 0x<b>, FRU = 0x<c> -.fi -.in -2 -.sp - -.sp -.LP -The command indicated by <command name> failed. The Requested Block is the -block where the transfer started and the Error Block is the block that caused -the error. Sense Key, ASC, and ASCQ information is returned by the target in -response to a request sense command. -.sp -.in +2 -.nf -Check Condition on REQUEST SENSE -.fi -.in -2 -.sp - -.sp -.LP -A REQUEST SENSE command completed with a check condition. The original command -will be retried a number of times. -.sp -.in +2 -.nf -Label says <m> blocks Drive says <\fIn\fR> blocks -.fi -.in -2 -.sp - -.sp -.LP -There is a discrepancy between the label and what the drive returned on the -READ CAPACITY command. -.sp -.in +2 -.nf -Not enough sense information -.fi -.in -2 -.sp - -.sp -.LP -The request sense data was less than expected. -.sp -.in +2 -.nf -Request Sense couldn't get sense data -.fi -.in -2 -.sp - -.sp -.LP -The REQUEST SENSE command did not transfer any data. -.sp -.in +2 -.nf -Reservation Conflict -.fi -.in -2 -.sp - -.sp -.LP -The drive was reserved by another initiator. -.sp -.in +2 -.nf -SCSI transport failed: reason 'xxxx' : {retrying|giving up} -.fi -.in -2 -.sp - -.sp -.LP -The host adapter has failed to transport a command to the target for the -reason stated. The driver will either retry the command or, ultimately, give -up. -.sp -.in +2 -.nf -Unhandled Sense Key <\fIn\fR> -.fi -.in -2 -.sp - -.sp -.LP -The REQUEST SENSE data included an invalid sense key. -.sp -.in +2 -.nf -Unit not Ready. Additional sense code 0x<\fIn\fR> -.fi -.in -2 -.sp - -.sp -.LP -The drive is not ready. -.sp -.in +2 -.nf -corrupt label - bad geometry -.fi -.in -2 -.sp - -.sp -.LP -The disk label is corrupted. -.sp -.in +2 -.nf -corrupt label - label checksum failed -.fi -.in -2 -.sp - -.sp -.LP -The disk label is corrupted. -.sp -.in +2 -.nf -corrupt label - wrong magic number -.fi -.in -2 -.sp - -.sp -.LP -The disk label is corrupted. -.sp -.in +2 -.nf -device busy too long -.fi -.in -2 -.sp - -.sp -.LP -The drive returned busy during a number of retries. -.sp -.in +2 -.nf -disk not responding to selection -.fi -.in -2 -.sp - -.sp -.LP -The drive was probably powered down or died. -.sp -.in +2 -.nf -i/o to invalid geometry -.fi -.in -2 -.sp - -.sp -.LP -The geometry of the drive could not be established. -.sp -.in +2 -.nf -incomplete read/write - retrying/giving up -.fi -.in -2 -.sp - -.sp -.LP -There was a residue after the command completed normally. -.sp -.in +2 -.nf -logical unit not ready -.fi -.in -2 -.sp - -.sp -.LP -The drive is not ready. -.sp -.in +2 -.nf -no bp for disk label -.fi -.in -2 -.sp - -.sp -.LP -A bp with consistent memory could not be allocated. -.sp -.in +2 -.nf -no mem for property -.fi -.in -2 -.sp - -.sp -.LP -Free memory pool exhausted. -.sp -.in +2 -.nf -no memory for disk label -.fi -.in -2 -.sp - -.sp -.LP -Free memory pool exhausted. -.sp -.in +2 -.nf -no resources for dumping -.fi -.in -2 -.sp - -.sp -.LP -A packet could not be allocated during dumping. -.sp -.in +2 -.nf -offline -.fi -.in -2 -.sp - -.sp -.LP -Drive went offline; probably powered down. -.sp -.in +2 -.nf -requeue of command fails<\fIn\fR> -.fi -.in -2 -.sp - -.sp -.LP -Driver attempted to retry a command and experienced a transport error. -.sp -.in +2 -.nf -ssdrestart transport failed <\fIn\fR> -.fi -.in -2 -.sp - -.sp -.LP -Driver attempted to retry a command and experienced a transport error. -.sp -.in +2 -.nf -transfer length not modulo <\fIn\fR> -.fi -.in -2 -.sp - -.sp -.LP -Illegal request size. -.sp -.in +2 -.nf -transport rejected <\fIn\fR> -.fi -.in -2 -.sp - -.sp -.LP -Host adapter driver was unable to accept a command. -.sp -.in +2 -.nf -unable to read label -.fi -.in -2 -.sp - -.sp -.LP -Failure to read disk label. -.sp -.in +2 -.nf -unit does not respond to selection -.fi -.in -2 -.sp - -.sp -.LP -Drive went offline; probably powered down. diff --git a/usr/src/man/man7d/st.7d b/usr/src/man/man7d/st.7d deleted file mode 100644 index 6d5734d97c..0000000000 --- a/usr/src/man/man7d/st.7d +++ /dev/null @@ -1,1397 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ST 7D "April 9, 2016" -.SH NAME -st \- driver for SCSI tape devices -.SH SYNOPSIS -.LP -.nf -\fBst@\fR\fItarget\fR\fB,\fR\fIlun\fR\fB:\fR\fIl\fR\fB,\fR\fIm\fR\fB,\fR\fIh\fR\fB,\fR\fIc\fR\fB,\fR\fIu\fR\fIb\fR\fIn\fR -.fi - -.SH DESCRIPTION -.LP -The \fBst\fR device driver provides a standard interface to various \fBSCSI\fR -tape devices. See \fBmtio\fR(7I) for details. -.sp -.LP -To determine if the \fBst\fR device driver supports your tape device, SPARC -users should enter the following on a command line: -.sp -.in +2 -.nf -% strings /kernel/drv/sparcv9/st | grep -i <tape device name> -.fi -.in -2 - -.sp -.LP -x86 users can do the following to determine if the \fBst\fR device driver -supports a particular tape device: -.sp -.in +2 -.nf -% strings /kernel/drv/st | grep -i <tape device name> -.fi -.in -2 - -.sp -.LP -The driver can be opened with either rewind on close or no rewind on close -options. It can also be opened with the \fBO_NDELAY\fR (see \fBopen\fR(2)) -option when there is no tape inserted in the drive. A maximum of four tape -formats per device are supported (see \fBFILES\fR below). The tape format is -specified using the device name. (Tape format is also referred to as tape -density). -.sp -.LP -Following are a list of SCSI commands that can be executed while another host -reserves the tape drive. The commands are: -.sp -.in +2 -.nf -SCMD_TEST_UNIT_READY -SCMD_REQUEST_SENSE -SCMD_READ_BLKLIM -SCMD_INQUIRY -SCMD_RESERVE -SCMD_RELEASE -SCMD_DOORLOCK -SCMD_REPORT_DENSITIES -SCMD_LOG_SENSE_G1 -SCMD_PERSISTENT_RESERVE_IN -SCMD_PERSISTENT_RESERVE_OUT -SCMD_REPORT_LUNS -.fi -.in -2 - -.sp -.LP -In multi-initiator environments, the driver will not reserve the tape drive if -above commands are issued. For other SCSI commands, the driver reserves the -tape drive and releases the drive at close if it has been reserved. Refer to -the MTIOCRESERVE and MTIOCRELEASE ioctls in \fBmtio\fR(7I) for information -about how to allow a tape drive to remain reserved upon close. See the flag -options below for information about disabling this feature. -.sp -.LP -If a SCSI-3 persistent reservation is done through the driver, the driver -disables all existing SCSI-2 reservations. -.sp -.LP -If the tape drive is opened in O_NDELAY mode, no reservation occurs during the -open, as per the POSIX standard (see \fBstandards\fR(5)). However, if a command -not found in the above list is used, a reservation will occur to provide -reserve/release functionality before the command is issued. -.SS "Persistent Errors and Asynchronous Tape Operation" -.LP -The \fBst\fR driver now supports persistent errors (see \fBmtio\fR(7I) and -asynchronous tape operations (see \fBmtio\fR(7I), \fBaioread\fR(3C), and -\fBaiowrite\fR(3C)). -.SS "Read Operation" -.LP -If the driver is opened for reading in a different format than the tape is -written in, the driver overrides the user-selected format. For example, if a -1/4" cartridge tape is written in QIC-24 format and opened for reading in -QIC-150, the driver detects a read failure on the first read and automatically -switches to QIC-24 to read the data. -.sp -.LP -Note that if the low density format is used, no indication is given that the -driver has overridden the format you selected. Other formats issue a warning -message to inform you of an overridden format selection. Some devices -automatically perform this function and do not require driver support (1/2" -reel tape drive, for example). -.SS "Write Operation" -.LP -Writing from the beginning of tape is performed in the user-specified format. -The original tape format is used for appending onto previously written tapes. -.SS "Tape Configuration" -.LP -The \fBst\fR driver has a built-in configuration table for most Sun-supported -tape drives. For those tape drives that are not in the table, the \fBst\fR -driver tries to read the configuration from the tape drive through optional -SCSI-3 commands. To support the addition of third party tape devices which are -not in the built-in configuration table or not able to report their -configuration, device information can be supplied in \fBst.conf\fR as global -properties that apply to each node, or as properties that are applicable to one -node only. By supplying the information in \fBst.conf\fR, the built-in -configuration is overridden and the \fBst\fR driver will not query the -configuration from tape drives. The \fBst\fR driver looks for the property -called \fBtape-config-list\fR. The value of this property is a list of -triplets, where each triplet consists of three strings. -.sp -.LP -The formal syntax is: -.sp -.in +2 -.nf -tape-config-list = <triplet> [, <triplet> *]; -.fi -.in -2 -.sp - -.sp -.LP -where -.sp -.in +2 -.nf -<triplet> := <vid+pid>, <pretty print>, <data-property-name> -.fi -.in -2 -.sp - -.sp -.LP -and -.sp -.in +2 -.nf -<data-property-name> = <version>, <type>, <bsize>, - <options>, <number of densities>, - <density> [, <density>*], <default-density>; -.fi -.in -2 -.sp - -.sp -.LP -or -.sp -.in +2 -.nf -<data-property-name> = <version 2>, <type>, <bsize>, - <options>, <number of densities>, - <density> [, <density>*], <default-density>, - <non-motion time-out>, <I/O time-out>, - <rewind time-out>, <space time-out>, - <load time-out>, <unload time-out>, - <erase time-out>; -.fi -.in -2 -.sp - -.sp -.in +2 -.nf - -.fi -.in -2 - -.sp -.LP -A semicolon (\fB;\fR) is used to terminate a prototype devinfo node -specification. Individual elements listed within the specification should not -be separated by a semicolon. (Refer to \fBdriver.conf\fR(4) for more -information.) -.sp -.LP -\fB<vid+pid>\fR is the string that is returned by the tape device on a -\fBSCSI\fR inquiry command. This string may contain any character in the range -\fB0x20-0x7e\fR. Characters such as " " " (double quote) or " ' " (single -quote), which are not permitted in property value strings, are represented by -their octal equivalent (for example, \fB\e042\fR and \fB\e047\fR). Trailing -spaces may be truncated. -.sp -.LP -\fB<pretty print>\fR is used to report the device on the console. This string -may have zero length, in which case the \fB<vid+pid>\fR will be used to report -the device. -.sp -.LP -\fB<data-property-name>\fR is the name of the property which contains all the -tape configuration values (such as \fB<type>\fR, \fB<bsize>\fR, etc.) -corresponding for the tape drive for the specified \fB<vid+pid>\fR\&. -.sp -.LP -\fB<version>\fR is a version number and should be 1 or 2. In the future, higher -version numbers may be used to allow for changes in the syntax of the -\fB<data-property-name>\fR value list. -.sp -.LP -\fB<type>\fR is a type field. Valid types are defined in -\fB/usr/include/sys/mtio.h\fR. For third party tape configuration, the -following generic types are recommended: -.sp - -.sp -.TS -l l -l l . -\fBMT_ISQIC\fR 0x32 -\fBMT_ISREEL\fR 0x33 -\fBMT_ISDAT\fR 0x34 -\fBMT_IS8MM\fR 0x35 -\fBMT_ISOTHER\fR 0x36 -\fBMT_ISTAND25G\fR 0x37 -\fBMT_ISDLT\fR 0x38 -\fBMT_ISSTK9840\fR 0x39 -\fBMT_ISBMDLT1\fR 0x3A -\fBMT_LTO\fR 0x3B -.TE - -.sp -.LP -\fB<bsize>\fR is the preferred block size of the tape device. The value should -be \fB0\fR for variable block size devices. -.sp -.LP -\fB<options>\fR is a bit pattern representing the devices, as defined in -\fB/usr/include/sys/scsi/targets/stdef.h\fR. Valid flags for tape configuration -are shown in the following table. Note that this table does not list flags that -are non-configurable in \fBst.conf\fR (including \fBST_KNOWS_MEDIA\fR which -uses the media type reported from the mode select data to select the correct -density code). -.sp - -.sp -.TS -l l -l l . -\fBST_VARIABLE\fR 0x0001 -\fBST_QIC\fR 0x0002 -\fBST_REEL\fR 0x0004 -\fBST_BSF\fR 0x0008 -\fBST_BSR\fR 0x0010 -\fBST_LONG_ERASE\fR 0x0020 -\fBST_AUTODEN_OVERRIDE\fR 0x0040 -\fBST_NOBUF\fR 0x0080 -\fBST_KNOWS_EOD\fR 0x0200 -\fBST_UNLOADABLE\fR 0x0400 -\fBST_SOFT_ERROR_REPORTING\fR 0x0800 -\fBST_LONG_TIMEOUTS\fR 0x1000 -\fBST_NO_RECSIZE_LIMIT\fR 0x8000 -\fBST_MODE_SEL_COMP\fR 0x10000 -\fBST_NO_RESERVE_RELEASE\fR 0x20000 -\fBST_READ_IGNORE_ILI\fR 0x40000 -\fBST_READ_IGNORE_EOFS\fR 0x80000 -\fBST_SHORT_FILEMARKS\fR 0x100000 -\fBST_EJECT_TAPE_ON_CHANGER_FAILURE\fR 0x200000 -\fBST_RETRY_ON_RECOVERED_DEFERRED_ERROR\fR 0x400000 -\fBST_WORMABLE\fR 0x1000000 -.TE - -.sp -.ne 2 -.na -\fB\fBST_VARIABLE\fR\fR -.ad -.sp .6 -.RS 4n -The flag indicates the tape device supports variable length record sizes. -.RE - -.sp -.ne 2 -.na -\fB\fBST_QIC\fR\fR -.ad -.sp .6 -.RS 4n -The flag indicates a Quarter Inch Cartridge (QIC) tape device. -.RE - -.sp -.ne 2 -.na -\fB\fBST_REEL\fR\fR -.ad -.sp .6 -.RS 4n -The flag indicates a 1/2\(miinch reel tape device. -.RE - -.sp -.ne 2 -.na -\fB\fBST_BSF\fR\fR -.ad -.sp .6 -.RS 4n -If flag is set, the device supports backspace over EOF marks (bsf - see -\fBmt\fR(1)). -.RE - -.sp -.ne 2 -.na -\fB\fBST_BSR\fR\fR -.ad -.sp .6 -.RS 4n -If flag is set, the tape device supports the backspace record operation (bsr - -see \fBmt\fR(1)). If the device does not support bsr, the \fBst\fR driver -emulates the action by rewinding the tape and using the forward space record -(fsf) operation to forward the tape to the correct file. The driver then uses -forward space record (fsr - see \fBmt\fR(1)) to forward the tape to the correct -record. -.RE - -.sp -.ne 2 -.na -\fB\fBST_LONG_ERASE\fR\fR -.ad -.sp .6 -.RS 4n -The flag indicates the tape device needs a longer time than normal to erase. -.RE - -.sp -.ne 2 -.na -\fB\fBST_AUTODEN_OVERRIDE\fR\fR -.ad -.sp .6 -.RS 4n -The auto-density override flag. The device is capable of determining the tape -density automatically without issuing a "mode-select"/"mode-sense command." -.RE - -.sp -.ne 2 -.na -\fB\fBST_NOBUF\fR\fR -.ad -.sp .6 -.RS 4n -The flag disables the device's ability to perform buffered writes. A buffered -write occurs when the device acknowledges the completion of a write request -after the data has been written to the device's buffer, but before all of the -data has been written to the tape. -.RE - -.sp -.ne 2 -.na -\fB\fBST_KNOWS_EOD\fR\fR -.ad -.sp .6 -.RS 4n -If flag is set, the device can determine when EOD (End of Data) has been -reached. When this flag is set, the \fBst\fR driver uses fast file skipping. -Otherwise, file skipping happens one file at a time. -.RE - -.sp -.ne 2 -.na -\fB\fBST_UNLOADABLE\fR\fR -.ad -.sp .6 -.RS 4n -The flag indicates the device will not complain if the \fBst\fR driver is -unloaded and loaded again (see \fBmodload\fR(1M) and \fBmodunload\fR(1M)). That -is, the driver will return the correct inquiry string. -.RE - -.sp -.ne 2 -.na -\fB\fBST_SOFT_ERROR_REPORTING\fR\fR -.ad -.sp .6 -.RS 4n -The flag indicates the tape device will perform a "request sense" or "log -sense" command when the device is closed. Currently, only Exabyte and \fBDAT\fR -drives support this feature. -.RE - -.sp -.ne 2 -.na -\fB\fBST_LONG_TIMEOUTS\fR\fR -.ad -.sp .6 -.RS 4n -The flag indicates the tape device requires timeouts that are five times longer -than usual for normal operation. -.RE - -.sp -.ne 2 -.na -\fB\fBST_NO_RECSIZE_LIMIT\fR \fR -.ad -.sp .6 -.RS 4n -The flag applies to variable-length tape devices. If this flag is set, the -record size is not limited to a 64 Kbyte record size. The record size is only -limited by the smaller of either the record size supported by the device or the -maximum DMA transfer size of the system. (Refer to \fBLarge Record Sizes\fR and -\fBWARNINGS\fR.) The maximum block size that will not be broken into smaller -blocks can be determined from the mt_bf returned from the MTIOCGET ioctl(). -This number is the lesser of the upper block limit returned by the drive from -READ BLOCK LIMITS command and the dma-max property set by the Host Bus Adapter -(HBA) to which the drive is attached. -.RE - -.sp -.ne 2 -.na -\fB\fBST_MODE_SEL_COMP\fR\fR -.ad -.sp .6 -.RS 4n -If the \fBST_MODE_SEL_COMP\fR flag is set, the driver determines which of the -two mode pages the device supports for selecting or deselecting compression. It -first tries the Data Compression mode page (\fB0x0F\fR); if this fails, it -tries the Device Configuration mode page (\fB0x10\fR). Some devices, however, -may need a specific density code for selecting or deselecting compression. -Please refer to the device specific \fBSCSI\fR manual. When the flag is set, -compression is enabled only if the "c" or "u" device is used. Note that when -the lower 2 densities of a drive are identically configured and the upper 2 -densities are identically configured, but the lower and upper differ from each -other and ST_MODE_SEL_COMP is set, the "m" node sets compression \fBon\fR for -the lower density code (for example, 0x42) and the "c" and "u" nodes set -compression \fBon\fR for the higher density (for example, 0x43). For any other -device densities, compression is disabled. -.RE - -.sp -.ne 2 -.na -\fB\fBST_NO_RESERVE_RELEASE\fR\fR -.ad -.sp .6 -.RS 4n -The \fBST_NO_RESERVE_RELEASE\fR flag disables the use of reserve on open and -release on close. If an attempt to use a ioctl of \fBMTRESERVE\fR or -\fBMTRELEASE\fR on a drive with this flag set, it will return an error of -\fBENOTTY\fR (inappropriate ioctl for device). -.RE - -.sp -.ne 2 -.na -\fB\fBST_READ_IGNORE_ILI\fR\fR -.ad -.sp .6 -.RS 4n -The \fBST_READ_IGNORE_ILI\fR flag is applicable only to variable block devices -which support the SILI bit option. The \fBST_READ_IGNORE_ILI\fR flag indicates -that SILI (suppress incorrect length indicator) bit will be set during reads. -When this flag is set, short reads (requested read size is less than the record -size on the tape) will be successful and the number of bytes transferred will -be equal to the record size on the tape. The tape will be positioned at the -start of the next record skipping over the extra data (the remaining data has -been has been lost). Long reads (requested read size is more than the record -size on the tape) will see a large performance gain when this flag is set, due -to overhead reduction. When this flag is not set, short reads will return an -error of \fBENOMEM\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBST_READ_IGNORE_EOFS\fR\fR -.ad -.sp .6 -.RS 4n -The \fBST_READ_IGNORE_EOFS\fR flag is applicable only to 1/2" Reel Tape drives -and when performing consecutive reads only. It should not be used for any other -tape command. Usually End-of-recorded-media (EOM) is indicated by two EOF marks -on 1/2" tape and application cannot read past EOM. When this flag is set, two -EOF marks no longer indicate EOM allowing applications to read past two EOF -marks. In this case it is the responsibility of the application to detect -end-of-recorded-media (EOM). When this flag is set, tape operations (like -MTEOM) which positions the tape at end-of-recorded-media will fail since -detection of end-of-recorded-media (EOM) is to be handled by the application. -This flag should be used when backup applications have embedded double -filemarks between files. -.RE - -.sp -.ne 2 -.na -\fB\fBST_SHORT_FILEMARKS\fR\fR -.ad -.sp .6 -.RS 4n -The \fBST_SHORT_FILEMARKS\fR flag is applicable only to EXABYTE 8mm tape drives -which supports short filemarks. When this flag is set, short filemarks is used -for writing filemarks. Short filemarks could lead to tape incompatible with -some otherwise compatible device. By default long filemarks will be used for -writing filemarks. -.RE - -.sp -.ne 2 -.na -\fB\fBST_EJECT_TAPE_ON_CHANGER_FAILURE\fR\fR -.ad -.sp .6 -.RS 4n -If \fBST_EJECT_TAPE_ON_CHANGER_FAILURE\fR flag is set, the tape is ejected -automatically if the tape cartridge is trapped in the medium due to positioning -problems of the medium changer. -.sp -The following ASC/ASCQ keys are defined to the reasons for causing tape -ejection if \fBST_EJECT_TAPE_ON_CHANGER_FAILURE\fR option is set to 0x200000: -.sp -Sense ASC/ASCQ Description -.sp -Key -.sp -4 15/01 Mechanical Failure -.sp -4 44/00 Internal Target Failure -.sp -2 53/00 Media Load or Eject Failed -.sp -4 53/00 Media Load or Eject Failed -.sp -4 53/01 Unload Tape Failure -.RE - -.sp -.ne 2 -.na -\fB\fBST_RETRY_ON_RECOVERED_DEFERRED_ERROR\fR\fR -.ad -.sp .6 -.RS 4n -If \fBST_RETRY_ON_RECOVERED_DEFERRED_ERROR\fR flag is set, the \fBst\fR driver -will retry the last write if this cmd caused a check condition with error code -0x71 and sense code 0x01. Some tape drives, notably the IBM 3090, require this -option. -.RE - -.sp -.ne 2 -.na -\fB\fBST_WORMABLE\fR\fR -.ad -.sp .6 -.RS 4n -When \fBST_WORMABLE\fR is set, \fBst\fR attempts to detect the presence of WORM -media in the device. -.RE - -.sp -.LP -\fB<number of densities>\fR is the number of densities specified. Each tape -drive can support up to four densities. The value entered should therefore be -between \fB1\fR and \fB4\fR; if less than \fB4\fR, the remaining densities will -be assigned a value of \fB0x0\fR. -.sp -.LP -\fB<density>\fR is a single-byte hexadecimal number. It can either be found in -the device specification manual or be obtained from the device vendor. -.sp -.LP -\fB<default-density>\fR has a value between \fB0\fR and (<number of densities> -- \fB1\fR). -.sp -.LP -\fB<non-motion time-out>\fR Time in seconds that the drive should be able to -perform any SCSI command that doesn't require tape to be moved. This includes -mode sense, mode select, reserve, release, read block limits, and test unit -ready. -.sp -.LP -\fB<I/O time-out>\fR Time in seconds to perform data transfer I/O to or from -tape including worst case error recovery. -.sp -.LP -\fB<rewind time-out>\fR Time in seconds to rewind from anywhere on tape to BOT -including worst case recovery forcing buffered write data to tape. -.sp -.LP -\fB<space time-out>\fR Time in seconds to space to any file, block or end of -data on tape. Including worst case when any form of cataloging is invalid. -.sp -.LP -\fB<load time-out>\fR Time in seconds to load tape and be ready to transfer -first block. This should include worst case recovery reading tape catalog or -drive specific operations done at load. -.sp -.LP -\fB<unload time-out>\fR Time in seconds to unload tape. Should include worst -case time to write to catalog, unthread, and tape cartridge unloading. Also -should include worst case time for any drive specific operations that are -preformed at unload. Should not include rewind time as the driver rewinds tape -before issuing the unload. -.sp -.LP -\fB<erase time-out>\fR Time in seconds to preform a full (BOT to EOT) erase of -longest medium with worst case error recovery. -.SS "Device Statistics Support" -.LP -Each device maintains I/O statistics both for the device and for each partition -allocated on that device. For each device/partition, the driver accumulates -reads, writes, bytes read, and bytes written. The driver also takes -hi-resolution time stamps at queue entry and exit points, which facilitates -monitoring the residence time and cumulative residence-length product for each -queue. -.sp -.LP -Each device also has error statistics associated with it. These must include -counters for hard errors, soft errors and transport errors. Other data may be -implemented as required. -.SH IOCTLS -.LP -The behavior of \fBSCSI\fR tape positioning ioctls is the same across all -devices which support them. (Refer to \fBmtio\fR(7I).) However, not all devices -support all ioctls. The driver returns an \fBENOTTY\fR error on unsupported -ioctls. -.sp -.LP -The retension ioctl only applies to 1/4" cartridge tape devices. It is used to -restore tape tension, thus improving the tape's soft error rate after extensive -start-stop operations or long-term storage. -.sp -.LP -In order to increase performance of variable-length tape devices (particularly -when they are used to read/write small record sizes), two operations in the -\fBMTIOCTOP\fR ioctl, \fBMTSRSZ\fR and \fBMTGRSZ\fR, can be used to set and get -fixed record lengths. The ioctl also works with fixed-length tape drives which -allow multiple record sizes. The min/max limits of record size allowed on a -driver are found by using a SCSI-2 \fBREAD\fR \fBBLOCK\fR \fBLIMITS\fR command -to the device. If this command fails, the default min/max record sizes allowed -are 1 byte and 63k bytes. An application that needs to use a different record -size opens the device, sets the size with the \fBMTSRSZ\fR ioctl, and then -continues with I/O. The scope of the change in record size remains until the -device is closed. The next open to the device resets the record size to the -default record size (retrieved from \fBst.conf\fR). -.sp -.LP -Note that the error status is reset by the \fBMTIOCGET\fR get status ioctl call -or by the next read, write, or other ioctl operation. If no error has occurred -(sense key is \fB0\fR), the current file and record position is returned. -.SH ERRORS -.ne 2 -.na -\fB\fBEACCES\fR\fR -.ad -.RS 10n -The driver is opened for write access and the tape is write-protected or the -tape unit is reserved by another host. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 10n -The tape drive is in use by another process. Only one process can use the tape -drive at a time. The driver will allow a grace period for the other process to -finish before reporting this error. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -The number of bytes read or written is not a multiple of the physical record -size (fixed-length tape devices only). -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 10n -During opening, the tape device is not ready because either no tape is in the -drive, or the drive is not on-line. Once open, this error is returned if the -requested I/O transfer could not be completed. -.RE - -.sp -.ne 2 -.na -\fB\fBENOTTY\fR\fR -.ad -.RS 10n -This indicates that the tape device does not support the requested ioctl -function. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -During opening, the tape device does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBENOMEM\fR\fR -.ad -.RS 10n -This indicates that the record size on the tape drive is more than the -requested size during read operation. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRGlobal tape-config list property -.sp -.LP -The following is an example of a global \fBtape-config-list\fR property: - -.sp -.in +2 -.nf -tape-config-list = -"Magic DAT", "Magic 4mm Helical Scan", "magic-data", -"Major Appliance", "Major Appliance Tape", "major-tape"; - - -magic-data = 1,0x34,1024,0x1639,4,0,0x8c,0x8c,0x8c,3; -major-tape = 2,0x3c,0,0x18619,4,0x0,0x0,0x0,0x0, - 3,0,0,30,120,0,0,36000; - -name="st" class="scsi" - target=0 lun=0; -name="st" class="scsi" - target=1 lun=0; -name="st" class="scsi" - target=2 lun=0; - . - . - . -name="st" class="scsi" - target=6 lun=0; -.fi -.in -2 - -.LP -\fBExample 2 \fRTape-config-list property applicable to target 2 only -.sp -.LP -The following is an example of a tape-config-list property applicable to target -2 only: - -.sp -.in +2 -.nf -name="st" class="scsi" - target=0 lun=0; -name="st" class="scsi" - target=1 lun=0; -name="st" class="scsi" - target=2 lun=0 - tape-config-list = - "Magic DAT", "Magic 4mm Helical Scan", "magic-data" - magic-data = 1,0x34,1024,0x1639,4,0,0x8c,0x8c,0x8c,3; -name="st" class="scsi" - target=3 lun=0; - . - . - . -name="st" class="scsi" - target=6 lun=0; -.fi -.in -2 - -.SS "Large Record Sizes" -.LP -To support applications such as seismic programs that require large record -sizes, the flag \fBST_NO_RECSIZE_LIMIT\fR must be set in drive option in the -configuration entry. A SCSI tape drive that needs to transfer large records -should \fBOR\fR this flag with other flags in the 'options' field in -\fBst.conf\fR. (Refer to \fBTape Configuration\fR.) By default, this flag is -set for the built-in config entries of Archive \fBDAT\fR and Exabyte drives. -.sp -.LP -If this flag is set, the \fBst\fR driver issues a SCSI-2 \fBREAD\fR \fBBLOCK\fR -\fBLIMITS\fR command to the device to determine the maximum record size allowed -by it. If the command fails, \fBst\fR continues to use the maximum record sizes -mentioned in the \fBmtio\fR(7I) man page. -.sp -.LP -If the command succeeds, \fBst\fR restricts the maximum transfer size of a -variable-length device to the minimum of that record size and the maximum -\fBDMA\fR size that the host adapter can handle. Fixed-length devices are bound -by the maximum \fBDMA\fR size allocated by the machine. Note that tapes created -with a large record size may not be readable by earlier releases or on other -platforms. -.sp -.LP -(Refer to the \fBWARNINGS\fR section for more information.) -.SS "EOT Handling" -.LP -The Emulex drives have only a physical end of tape (PEOT); thus it is not -possible to write past EOT. All other drives have a logical end of tape -(\fBLEOT\fR) before \fBPEOT\fR to guarantee flushing the data onto the tape. -The amount of storage between \fBLEOT\fR and \fBPEOT\fR varies from less than 1 -Mbyte to about 20 Mbyte, depending on the tape drive. -.sp -.LP -If \fBEOT\fR is encountered while writing an Emulex, no error is reported but -the number of bytes transferred is \fB0\fR and no further writing is allowed. -On all other drives, the first write that encounters \fBEOT\fR will return a -short count or \fB0\fR. If a short count is returned, then the next write will -return \fB0\fR. After a zero count is returned, the next write returns a full -count or short count. A following write returns \fB0\fR again. It is important -that the number and size of trailer records be kept as small as possible to -prevent data loss. Therefore, writing after \fBEOT\fR is not recommended. -.sp -.LP -Reading past \fBEOT\fR is transparent to the user. Reading is stopped only by -reading EOF's. For 1/2" reel devices, it is possible to read off the end of the -reel if one reads past the two file marks which mark the end of recorded media. -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/st.conf\fR\fR -.ad -.sp .6 -.RS 4n -driver configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/mtio.h\fR\fR -.ad -.sp .6 -.RS 4n -structures and definitions for mag tape io control commands -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/scsi/targets/stdef.h\fR\fR -.ad -.sp .6 -.RS 4n -definitions for \fBSCSI\fR tape drives -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/rmt/[0\(mi 127][l,m,h,u,c][b][n]\fR\fR -.ad -.sp .6 -.RS 4n -where \fBl,m,h,u,c\fR specifies the density (low, medium, high, -ultra/compressed), \fBb\fR the optional BSD behavior (see \fBmtio\fR(7I)), and -\fBn\fR the optional no rewind behavior. For example, \fB/dev/rmt/0lbn\fR -specifies unit 0, low density, BSD behavior, and no rewind. -.sp -For 1/2" reel tape devices (HP-88780), the densities are: -.sp - -.sp -.TS -l l -l l . -\fBl\fR 800 BPI density -\fBm\fR 1600 BPI density -\fBh\fR 6250 BPI density -\fBc\fR data compression -\fB \fR (not supported on all modules) -.TE - -For 8mm tape devices (Exabyte 8200/8500/8505): -.sp - -.sp -.TS -l l -l l . -\fBl\fR Standard 2 Gbyte format -\fBm\fR 5 Gbyte format (8500, 8505 only) -\fBh,c\fR 5 Gbyte compressed format (8505 only) -.TE - -For 4mm \fBDAT\fR tape devices (Archive Python): -.sp - -.sp -.TS -l l -l l . -\fBl\fR Standard format -\fBm,h,c\fR data compression -.TE - -For all QIC (other than QIC-24) tape devices: -.sp - -.sp -.TS -l l -l l . -\fBl,m,h,c\fR density of the tape cartridge type - (not all devices can read and - write all formats) -.TE - -For QIC-24 tape devices (Emulex MT\(mi02): -.sp - -.sp -.TS -l l -l l . -\fBl\fR QIC-11 Format -\fBm,h,c\fR QIC-24 Format -.TE - -.RE - -.SH SEE ALSO -.LP -\fBmt\fR(1), \fBmodload\fR(1M), \fBmodunload\fR(1M), \fBopen\fR(2), -\fBread\fR(2), \fBwrite\fR(2), \fBaioread\fR(3C), \fBaiowrite\fR(3C), -\fBkstat\fR(3KSTAT), \fBdriver.conf\fR(4), \fBscsi\fR(4), \fBstandards\fR(5), -\fBesp\fR(7D), \fBisp\fR(7D), \fBmtio\fR(7I), \fBioctl\fR(9E) -.SH DIAGNOSTICS -.LP -The \fBst\fR driver diagnostics may be printed to the console or messages file. -.sp -.LP -Each diagnostic is dependent on the value of the system variable -\fBst_error_level\fR. \fBst_error_level\fR may be set in the \fB/etc/system\fR -file. The default setting for \fBst_error_level\fR is 4 (SCSI_ERR_RETRYABLE) -which is suitable for most configurations since only actual fault diagnostics -are printed. Settings range from values 0 (SCSI_ERR_ALL) which is most verbose, -to 6 (SCSI_ERR_NONE) which is least verbose. See \fBstdef.h\fR for the full -list of error-levels. SCSI_ERR_ALL level the amount of diagnostic information -is likely to be excessive and unnecessary. -.sp -.LP -The st driver diagnostics are described below: -.sp -.in +2 -.nf -Error for Command: <scsi_cmd_name()> Error Level:<error_class> -Requested Block: <blkno> Error Block: <err_blkno> -Vendor: <name>: Serial Number: <inq_serial> -Sense Key: <es_key> ASC: 0x<es_add_code> (scsi_asc_ascq_name()>), ASCQ: -0x<es_qual_code>, FRU: 0x<ex_fru_code> -.fi -.in -2 - -.sp -.LP -where <error_class> may be any one of the following: "All," "Unknown," -"Informational," "Recovered," "Retryable," "Fatal" -.sp -.LP -The command indicated by <scsi_cmd_name> failed. Requested Block represents the -block where the transfer started. Error Block represents the block that caused -the error. Sense Key, ASC, ASCQ and FRU information is returned by the target -in response to a request sense command. See SCSI protocol documentation for -description of Sense Key, ASC, ASCQ, FRU. -.sp -.LP -The st driver attempts to validate entries in the \fBst.conf\fR file. Each -field in the entry is checked for upper and lower limits and invalid bits set. -The fields are named as follows in config string order: -.sp -.in +2 -.nf - conf version - drive type - block size - options - number of densities - density code - default density - non motion timeout - I/O timeout - space timeout - load timeout - unload timeout - erase timeout -.fi -.in -2 - -.sp -.LP -The \fBst.conf\fR diagnostics are described below: -.sp -.in +2 -.nf -<con-name> <field-in-err> <problem-with-field> -.fi -.in -2 - -.sp -.LP -where <con-name> is the name of the config string. Where <field-in-err> is the -field containing invalid entries and where <problem-with-field> describes the -nature of the invalid entry. -.sp -.in +2 -.nf -Write/read: not modulo <n> block size -.fi -.in -2 -.sp - -.sp -.LP -The request size for fixed record size devices must be a multiple of the -specified block size. -.sp -.in +2 -.nf -Recovery by resets failed -.fi -.in -2 -.sp - -.sp -.LP -After a transport error, the driver attempted to recover by issuing a device -reset and then a bus reset if device reset failed. These recoveries failed. -.sp -.in +2 -.nf -Periodic head cleaning required -.fi -.in -2 -.sp - -.sp -.LP -The driver reported that periodic head cleaning is now required. This -diagnostic is generated either due to a threshold number of retries, or due to -the device communicating to the driver that head cleaning is required. -.sp -.in +2 -.nf -Soft error rate (<n>%) during writing/reading was too high -.fi -.in -2 -.sp - -.sp -.LP -The soft error rate has exceeded the threshold specified by the vendor. -.sp -.in +2 -.nf -SCSI transport failed: reason 'xxxx': {retrying|giving up} -.fi -.in -2 -.sp - -.sp -.LP -The Host Bus Adapter (HBA) has failed to transport a command to the target for -the reason stated. The driver will either retry the command or, ultimately, -give up. -.sp -.in +2 -.nf -Tape not inserted in drive -.fi -.in -2 -.sp - -.sp -.LP -A media access command was attempted while there was no tape inserted into the -specified drive. In this case, the drive returns sense key of DRIVE NOT READY. -.sp -.in +2 -.nf -Transport rejected -.fi -.in -2 -.sp - -.sp -.LP -The Host Bus Adapter (HBA) driver is not accepting commands after failing to -successfully transport a scsi packet to the target. The actual status received -by the \fBst\fR driver from the underlying HBA driver was either -TRAN_FATAL_ERROR or TRAN_BADPKT. -.sp -.in +2 -.nf -Retrying command -.fi -.in -2 -.sp - -.sp -.LP -The \fBst\fR driver failed to complete a command. However the command is -retryable and will be retried. -.sp -.in +2 -.nf -Giving up -.fi -.in -2 -.sp - -.sp -.LP -The \fBst\fR driver has exhausted retries or otherwise is unable to retry the -command and so is giving up. -.sp -.in +2 -.nf -No target struct for st%d -.fi -.in -2 -.sp - -.sp -.LP -The \fBst\fR driver failed to obtain state information because the requested -state structure was not allocated. The specified device was probably not -attached. -.sp -.in +2 -.nf -File mark detected -.fi -.in -2 -.sp - -.sp -.LP -The operation detected an end of file mark. (File marks signify the end of a -file on the tape media). -.sp -.in +2 -.nf -End-of-media detected -.fi -.in -2 -.sp - -.sp -.LP -The operation reached the end of the tape media. -.sp -.in +2 -.nf -Exabyte soft error reporting failed. DAT soft error reporting failed -.fi -.in -2 -.sp - -.sp -.LP -The \fBst\fR driver was unable to determine if the soft error threshold had -been exceeded because it did not successfully read the data it requires or did -not obtain enough data. This data is retrieved using the log sense command. -.sp -.in +2 -.nf -Log sense parameter code does not make sense -.fi -.in -2 -.sp - -.sp -.LP -The log sense command retrieves hardware statistics that are stored on the -drive (for example, soft error counts and retries.) If the data retrieved from -the drive is invalid, this message is printed and the data is not used. -.sp -.in +2 -.nf -Restoring tape position at fileno=%x, blkno=%lx.... -.fi -.in -2 -.sp - -.sp -.LP -The \fBst\fR driver is positioning to the specified file and block. This occurs -on an open. -.sp -.in +2 -.nf -Failed to restore the last <file/block> position: -In this state, tape will be loaded at BOT during next open -.fi -.in -2 -.sp - -.sp -.LP -The \fBst\fR driver could not position to the specified location and will -revert to the beginning of the tape when the next open is attempted. -.sp -.in +2 -.nf -Device does not support compression -.fi -.in -2 -.sp - -.sp -.LP -The compression facility of the device was requested. However the device does -not have a hardware compression capability. -.sp -.in +2 -.nf -DAT soft error reset failed -.fi -.in -2 -.sp - -.sp -.LP -After DAT soft error reporting, the counters within the device that accumulate -this sense data need to be re-set. This operation failed. -.sp -.in +2 -.nf -Errors after pkt alloc (b_flags=0x%x, b_error=0x%x) -.fi -.in -2 -.sp - -.sp -.LP -Memory allocation for a \fBscsi\fR packet failed. -.sp -.in +2 -.nf -Incorrect length indicator set -.fi -.in -2 -.sp - -.sp -.LP -The drive reported the length of data requested in a READ operation, was -incorrect. Incorrect Length Indicator (ILI) is a very commonly used facility in -SCSI tape protocol and should not be seen as an error per-se. Applications -typically probe a new tape with a read of any length, using the returned length -to the read system call for future reads. Along with this operation, an -underlying ILI error is received. ILI errors are therefore informational only -and are masked at the default \fBst_error_level\fR. -.sp -.in +2 -.nf -Data property (%s) has no value -Data property (%s) incomplete -Version # for data property (%s) greater than 1 -.fi -.in -2 -.sp - -.sp -.LP -These diagnostics indicate problems in retrieving the values of the various -property settings. The \fBst\fR driver is in the process of setting the -property/parameter values for the tape drive using information from either the -built-in table within the driver or from uncommented entries in the -\fBst.conf\fR file. The effect on the system may be that the tape drive may be -set with default or generic driver settings which may not be appropriate for -the actual type of tape drive being used. -.sp -.in +2 -.nf -st_attach-RESUME: tape failure tape position will be lost -.fi -.in -2 -.sp - -.sp -.LP -On a resume after a power management suspend, the previously known tape -position is no longer valid. This can occur if the tape was changed while the -system was in power management suspend. The operation will not be retried. -.sp -.in +2 -.nf -Write Data Buffering has been deprecated. Your applications should -continue to work normally. However, they should be ported to use -Asynchronous I/O. -.fi -.in -2 -.sp - -.sp -.LP -Indicates that buffering has been removed from Solaris. -.sp -.in +2 -.nf -Cannot detach: fileno=%x, blkno=%lx -.fi -.in -2 -.sp - -.sp -.LP -The \fBst\fR driver cannot unload because the tape is not positioned at BOT -(beginning of tape). May indicate hardware problems with the tape drive. -.sp -.in +2 -.nf -Variable record length I/O -Fixed record length (%d byte blocks) I/O -.fi -.in -2 -.sp - -.sp -.LP -Tape-drives can use either Fixed or Variable record length. If the drive uses -Fixed length records, then the built in property table or the st.conf file will -contain a non-zero record-length property. Most DAT, Exabyte and DLT drives -support Variable record lengths. Many QIC format tape drives have historically -been of Fixed record length. -.sp -.in +2 -.nf -Command will be retried - un_ncmds: %d can't retry cmd -.fi -.in -2 -.sp - -.sp -.LP -These diagnostics are only seen with tape drives with the -ST_RETRY_ON_RECOVERED_DEFERRED_ERROR bit set. See \fBstdef.h\fR for explanation -of the specific usage of this setting. -.SH WARNINGS -.LP -Effective with Solaris 2.4, the \fBST_NO_RECSIZE_LIMIT\fR flag is set for the -built-in config entries of the Archive \fBDAT\fR and Exabyte drivers by -default. (Refer to \fBLarge Record Sizes\fR.) Tapes written with large block -sizes prior to Solaris 2.4 may cause some applications to fail if the number of -bytes returned by a read request is less than the requested block size (for -example, asking for 128 Kbytes and receiving less than 64 Kbytes). -.sp -.LP -The \fBST_NO_RECSIZE_LIMIT\fR flag can be disabled in the config entry for the -device as a work-around. (Refer to \fBTape Configuration\fR.) This action -disables the ability to read and write with large block sizes and allows the -reading of tapes written prior to Solaris 2.4 with large block sizes. -.sp -.LP -(Refer to \fBmtio\fR(7I) for a description of maximum record sizes.) -.SH BUGS -.LP -Tape devices that do not return a \fBBUSY\fR status during tape loading prevent -user commands from being held until the device is ready. The user must delay -issuing any tape operations until the tape device is ready. This is not a -problem for tape devices supplied by Sun Microsystems. -.sp -.LP -Tape devices that do not report a blank check error at the end of recorded -media may cause file positioning operations to fail. Some tape drives, for -example, mistakenly report media error instead of blank check error. diff --git a/usr/src/man/man7d/su.7d b/usr/src/man/man7d/su.7d deleted file mode 100644 index 564c7e96a0..0000000000 --- a/usr/src/man/man7d/su.7d +++ /dev/null @@ -1,231 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 SU 7D "April 9, 2016" -.SH NAME -su \- asynchronous serial port driver -.SH SYNOPSIS -.LP -.nf -#include <fcntl.h> -#include <sys/termios.h> -open("/dev/tty\fI[a-z]\fR", _\fImode\fR); -open("/dev/term\fI[a-z]\fR", _\fImode\fR); -open("/dev/cua\fI[a-z]\fR", _\fImode\fR); -.fi - -.LP -.nf - -.fi - -.SH DESCRIPTION -.LP -The \fBsu\fR module is a loadable STREAMS driver that provides basic support -for standard \fBUARTS\fR that use Intel-8250, National -Semiconductor-16450/16550 hardware and Southbridge 1535D (16550 compatible) -Super I/O hardware. The module also provides keyboard and mouse I/O support for -Sun machines using those same Intel, National Semiconductor and Southbridge -chipsets. The \fBsu\fR driver provides basic asynchronous communication support -for serial ports. Both the serial devices and keyboard/mouse devices will have -streams built with appropriate modules pushed atop the \fBsu\fR driver by -means of either the \fBautopush\fR(1M) or \fBdacf.conf\fR(4) facilities, -depending on the OS revision and architecture in use. -.sp -.LP -The \fBsu\fR module supports those \fBtermio\fR(7I) device control functions -specified by flags in the \fBc_cflag\fR word of the \fBtermios\fR structure, -and by the \fBIGNBRK,\fR \fBIGNPAR,\fR \fBPARMRK,\fR or \fBINPCK\fR flags in -the \fBc_iflag\fR word of the \fBtermios\fR structure. All other -\fBtermio\fR(7I) functions must be performed by \fBSTREAMS\fR modules pushed -atop the driver. When a device is opened, the \fBldterm\fR(7M) and -\fBttcompat\fR(7M) \fBSTREAMS\fR modules are automatically pushed on top of the -stream, providing the standard \fBtermio\fR(7I) interface. -.sp -.LP -The character-special devices \fB/dev/ttya\fR and \fB/dev/ttyb\fR are used to -access the two standard serial ports. The \fBsu\fR module supports up to ten -serial ports, including the standard ports. The \fBtty\fR\fI[a-z]\fR devices -have minor device numbers in the range 00-03, and may be assigned names of the -form \fB/dev/ttyd_\fR\fIn_,\fR where \fI_n_\fR denotes the line to be accessed. -These device names are typically used to provide a logical access point for a -\fI_dial-in_\fR line that is used with a modem. -.sp -.LP -To allow a single tty line to be connected to a modem and used for incoming and -outgoing calls, a special feature is available that is controlled by the minor -device number. By accessing character-special devices with names of the form -\fB/dev/cua\fR\fI_n, \fR it is possible to open a port without the \fBCarrier -Detect\fR signal being asserted, either through hardware or an equivalent -software mechanism. These devices are commonly known as \fI_dial-out_\fR lines. -.SH APPLICATION PROGRAMMING INTERFACE -.LP -Once a \fB/dev/cua\fR\fI_n_\fR line is opened, the corresponding tty, or ttyd -line cannot be opened until the \fB/dev/cua\fR\fI_n_\fR line is closed. A -blocking open will wait until the \fB/dev/cua\fR\fI_n_\fR line is closed (which -will drop \fBData Terminal Ready\fR, after which \fBCarrier Detect\fR will -usually drop as well) and carrier is detected again. A non-blocking open will -return an error. If the \fB/dev/ttyd\fR\fI_n_\fR line has been opened -successfully (usually only when carrier is recognized on the modem), the -corresponding \fB/dev/cua\fR\fI_n_\fR line cannot be opened. This allows a -modem to be attached to a device, (for example, \fB/dev/ttyd0\fR, which is -renamed from \fB/dev/tty00\fR) and used for dial-in (by enabling the line for -login in \fB/etc/inittab\fR) or dial-out (by \fBtip\fR(1) or \fBuucp\fR(1C)) as -\fB/dev/cua0\fR when no one is logged in on the line. -.SH IOCTLS -.LP -The standard set of \fBtermio\fR \fBioctl()\fR calls are supported by \fBsu\fR. -.sp -.LP -Breaks can be generated by the \fBTCSBRK,\fR \fBTIOCSBRK,\fR and \fBTIOCCBRK\fR -\fBioctl()\fR calls. -.sp -.LP -The input and output line speeds may be set to any of the following baud rates: -0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, -38400, 57600 or 115200. The speeds cannot be set independently; for example, -when the output speed is set, the input speed is automatically set to the same -speed. -.sp -.LP -When the \fBsu\fR module is used to service the serial console port, it -supports a BREAK condition that allows the system to enter the debugger or the -monitor. The BREAK condition is generated by hardware and it is usually enabled -by default. -.sp -.LP -A BREAK condition originating from erroneous electrical signals cannot be -distinguished from one deliberately sent by remote DCE. The Alternate Break -sequence can be used as a remedy against this. Due to a risk of incorrect -sequence interpretation, SLIP and certain other binary protocols should not be -run over the serial console port when Alternate Break sequence is in effect. -Although PPP is a binary protocol, it is able to avoid these sequences using -the ACCM feature in \fIRFC 1662\fR. For Solaris PPP 4.0, you do this by adding -the following line to the \fB/etc/ppp/options\fR file (or other configuration -files used for the connection; see \fBpppd\fR(1M) for details): -.sp -.in +2 -.nf -asyncmap 0x00002000 -.fi -.in -2 - -.sp -.LP -By default, the Alternate Break sequence is a three character sequence: -carriage return, tilde and control-B (CR ~ CTRL-B), but may be changed by the -driver. For more information on breaking (entering the debugger or monitor), -see \fBkbd\fR(1) and \fBkb\fR(7M). -.SH ERRORS -.LP -An \fBopen()\fR will fail under the following conditions: -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 9n -The unit being opened does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The dial-out device is being opened while the dial-in device is already open, -or the dial-in device is being opened with a no-delay open and the dial-out -device is already open. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The unit has been marked as exclusive-use by another process with a -\fBTIOCEXCL\fR \fBioctl()\fR call. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/dev/cua/[a-z]\fR\fR -.ad -.RS 19n -dial-out tty lines -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/term/[a-z]\fR\fR -.ad -.RS 19n -dial-in tty lines -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/tty[a-z]\fR\fR -.ad -.RS 19n -binary compatibility package device names -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.LP -\fBstrconf\fR(1), \fBkbd\fR(1), \fBtip\fR(1), \fBuucp\fR(1C), -\fBautopush\fR(1M), \fBkstat\fR(1M), \fBpppd\fR(1M), \fBioctl\fR(2), -\fBopen\fR(2), \fBtermios\fR(3C), \fBdacf.conf\fR(4), \fBattributes\fR(5), -\fBkb\fR(7M), \fBldterm\fR(7M), \fBttcompat\fR(7M), \fBtermio\fR(7I) -.SH DIAGNOSTICS -.LP -The \fBsu\fR driver keeps track of various warning and error conditions using -\fBkstat\fR counters. The output of the \fBkstat su\fR command provides -\fBkstat\fR counters. The counters and their meaning follow: -.sp -.ne 2 -.na -\fBsilo overflow\fR -.ad -.RS 24n -The internal chip FIFO received more data than it could handle. This indicates -that the Solaris operating environment was not servicing data interrupts fast -enough possibly due to a system with too many interrupts or a data line with a -data rate that is too high. -.RE - -.sp -.ne 2 -.na -\fBring buffer overflow\fR -.ad -.RS 24n -The \fBsu\fR module was unable to store data it removed from the chips -internal FIFO into a software buffer. The user process is not reading data fast -enough, possibly due to an overloaded system. If possible, the application -should enable flow control (either CTSRTS or XONXOFF) to allow the driver to -backpressure the remote system when the local buffers fill up. -.RE - diff --git a/usr/src/man/man7d/sysmsg.7d b/usr/src/man/man7d/sysmsg.7d deleted file mode 100644 index be7166207c..0000000000 --- a/usr/src/man/man7d/sysmsg.7d +++ /dev/null @@ -1,44 +0,0 @@ -'\" te -.\" Copyright (c) 1998, Sun Microsystems, Inc. -.\" 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 SYSMSG 7D "Oct 13, 1998" -.SH NAME -sysmsg \- system message routing to console devices -.SH SYNOPSIS -.LP -.nf -\fB/dev/sysmsg\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The file \fB/dev/sysmsg\fR routes output to a variable set of console devices. -Writes to \fB/dev/sysmsg\fR are always directed to the system console -\fB/dev/console\fR, and are in addition directed to a set of auxiliary console -devices managed by \fBconsadm\fR(1m). -.sp -.LP -Only root has permission to write to this device. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Stable -.TE - -.SH SEE ALSO -.sp -.LP -\fBconsadm\fR(1m), \fBsyslogd\fR(1M) , \fBattributes\fR(5), \fBconsole\fR(7D) diff --git a/usr/src/man/man7d/systrace.7d b/usr/src/man/man7d/systrace.7d deleted file mode 100644 index aab1fa03fd..0000000000 --- a/usr/src/man/man7d/systrace.7d +++ /dev/null @@ -1,45 +0,0 @@ -'\" te -.\" Copyright (c) 2003, 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 SYSTRACE 7D "Dec 10, 2017" -.SH NAME -systrace \- DTrace system call tracing provider -.SH DESCRIPTION -.LP -The \fBsystrace\fR driver implements the DTrace \fBsyscall\fR dynamic tracing -provider. The syscall provider performs dynamic instrumentation to offer probes -that fire whenever a thread enters or returns from a kernel system call entry -point. -.sp -.LP -The \fBsystrace\fR driver is not a public interface and you access the -instrumentation offered by this provider through DTrace. Refer to the -\fIDynamic Tracing Guide\fR for a description of the public documented -interfaces available for the DTrace facility and the probes offered by the -\fBsyscall\fR provider. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.LP -\fBdtrace\fR(1M), \fBattributes\fR(5), \fBdtrace\fR(7D) -.sp -.LP -\fIDynamic Tracing Guide\fR: -.sp -.LP -https://illumos.org/books/dtrace/ diff --git a/usr/src/man/man7d/ticlts.7d b/usr/src/man/man7d/ticlts.7d deleted file mode 100644 index f05474ed85..0000000000 --- a/usr/src/man/man7d/ticlts.7d +++ /dev/null @@ -1,215 +0,0 @@ -'\" te -.\" Copyright 2000, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 TICLTS 7D "Jul 3, 1990" -.SH NAME -ticlts, ticots, ticotsord \- loopback transport providers -.SH SYNOPSIS -.LP -.nf -#include <sys/ticlts.h> -.fi - -.LP -.nf -#include <sys/ticots.h> -.fi - -.LP -.nf -#include <sys/ticotsord.h> -.fi - -.SH DESCRIPTION -.sp -.LP -The devices known as \fBticlts\fR, \fBticots\fR, and \fBticotsord\fR are -``loopback transport providers,'' that is, stand-alone networks at the -transport level. Loopback transport providers are transport providers in every -sense except one: only one host (the local machine) is ``connected to'' a -loopback network. Loopback transports present a \fBTPI\fR (STREAMS-level) -interface to application processes and are intended to be accessed via the -\fBTLI\fR (application-level) interface. They are implemented as clone devices -and support address spaces consisting of ``flex-addresses,'' that is, arbitrary -sequences of octets of length > 0, represented by a \fBnetbuf\fR structure. -.sp -.LP -\fBticlts\fR is a datagram-mode transport provider. It offers (connectionless) -service of type \fBT_CLTS\fR. Its default address size is -\fBTCL_DEFAULTADDRSZ\fR. \fBticlts\fR prints the following error messages (see -\fBt_rcvuderr\fR(3NSL)): -.sp -.ne 2 -.na -\fBTCL_BADADDR\fR -.ad -.RS 20n -bad address specification -.RE - -.sp -.ne 2 -.na -\fBTCL_BADOPT\fR -.ad -.RS 20n -bad option specification -.RE - -.sp -.ne 2 -.na -\fBTCL_NOPEER\fR -.ad -.RS 20n -bound -.RE - -.sp -.ne 2 -.na -\fBTCL_PEERBADSTATE\fR -.ad -.RS 20n -peer in wrong state -.RE - -.sp -.LP -\fBticots\fR is a virtual circuit-mode transport provider. It offers -(connection-oriented) service of type \fBT_COTS\fR. Its default address size is -\fBTCO_DEFAULTADDRSZ\fR. \fBticots\fR prints the following disconnect messages -(see \fBt_rcvdis\fR(3NSL)): -.sp -.ne 2 -.na -\fBTCO_NOPEER\fR -.ad -.RS 25n -no listener on destination address -.RE - -.sp -.ne 2 -.na -\fBTCO_PEERNOROOMONQ\fR -.ad -.RS 25n -peer has no room on connect queue -.RE - -.sp -.ne 2 -.na -\fBTCO_PEERBADSTATE\fR -.ad -.RS 25n -peer in wrong state -.RE - -.sp -.ne 2 -.na -\fBTCO_PEERINITIATED\fR -.ad -.RS 25n -peer-initiated disconnect -.RE - -.sp -.ne 2 -.na -\fBTCO_PROVIDERINITIATED\fR -.ad -.RS 25n -provider-initiated disconnect -.RE - -.sp -.LP -\fBticotsord\fR is a virtual circuit-mode transport provider, offering service -of type \fBT_COTS_ORD\fR (connection-oriented service with orderly release). -Its default address size is \fBTCOO_DEFAULTADDRSZ\fR. \fBticotsord\fR prints -the following disconnect messages (see \fBt_rcvdis\fR(3NSL)): -.sp -.ne 2 -.na -\fBTCOO_NOPEER\fR -.ad -.RS 26n -no listener on destination address -.RE - -.sp -.ne 2 -.na -\fBTCOO_PEERNOROOMONQ\fR -.ad -.RS 26n -peer has no room on connect queue -.RE - -.sp -.ne 2 -.na -\fBTCOO_PEERBADSTATE\fR -.ad -.RS 26n -peer in wrong state -.RE - -.sp -.ne 2 -.na -\fBTCOO_PEERINITIATED\fR -.ad -.RS 26n -provider-initiated disconnect -.RE - -.sp -.ne 2 -.na -\fBTCOO_PROVIDERINITIATED\fR -.ad -.RS 26n -peer-initiated disconnect -.RE - -.SH USAGE -.sp -.LP -Loopback transports support a local \fBIPC\fR mechanism through the \fBTLI\fR -interface. Applications implemented in a transport provider-independent manner -on a client-server model using this \fBIPC\fR are transparently transportable -to networked environments. -.sp -.LP -Transport provider-independent applications must not include the headers listed -in the synopsis section above. In particular, the options are (like all -transport provider options) provider dependent. -.sp -.LP -\fBticlts\fR and \fBticots\fR support the same service types (\fBT_CLTS\fR and -\fBT_COTS\fR) supported by the \fBOSI\fR transport-level model. -.sp -.LP -\fBticotsord\fR supports the same service type (\fBT_COTSORD\fR) supported by -the \fBTCP/IP\fR model. -.SH FILES -.sp -.LP -\fB/dev/ticlts\fR -.sp -.LP -\fB/dev/ticots\fR -.sp -.LP -\fB/dev/ticotsord\fR -.SH SEE ALSO -.sp -.LP -\fBt_rcvdis\fR(3NSL), \fBt_rcvuderr\fR(3NSL) diff --git a/usr/src/man/man7d/todopl.7d b/usr/src/man/man7d/todopl.7d deleted file mode 100644 index 14e0a001f7..0000000000 --- a/usr/src/man/man7d/todopl.7d +++ /dev/null @@ -1,33 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 TODOPOL 7D "Apr 18, 2006" -.SH NAME -todopl \- Time-Of-Day driver for SPARC Enterprise Server family -.SH DESCRIPTION -.sp -.LP -The \fBtodopl\fR driver is the Time-Of-Day (TOD) driver for the SPARC -Enterprise Server family. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man7d/tsalarm.7d b/usr/src/man/man7d/tsalarm.7d deleted file mode 100644 index c2ee9ae421..0000000000 --- a/usr/src/man/man7d/tsalarm.7d +++ /dev/null @@ -1,294 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. -.\" 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 TSALARM 7D "Sep 10, 2013" -.SH NAME -tsalarm \- Alarm device driver -.SH SYNOPSIS -.LP -.nf -tsalarm@0:ctl -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBtsalarm\fR driver is a Multi-threaded, loadable non-STREAMS pseudo -driver that manages ALOM alarms. The \fBtsalarm\fR driver provides an interface -through which alarm relays can be controlled on SUNW,Netra-240 and -SUNW,Netra-440 platforms. -.SH HARDWARE INTERFACE -.sp -.LP -The alarm hardware differs depending on platform. The Netra 240 and 440 -platforms features four dry contact alarm relays which are controlled by -ALOM. You can set each alarm to "on" or "off" by using ioctl interfaces -provided from the host. The four alarms are labeled as "critical," "major," -"minor," and "user." The user alarm is set by a user application depending on -system condition. LED's in front of the box provide a visual indication of the -four alarms. The number of alarms and their meanings/labels may vary across -platforms. -.SH IOCTLS -.sp -.LP -The interface provided by the \fBtsalarm\fR driver comprises ioctls that enable -applications to manipulate the alarm module. The alarm module is accessed via -two device nodes: i) \fB/dev/lom\fR and \fB/dev/tsalarm:ctl\fR. -.sp -.LP -The following ioctls are supported by the \fB/dev/lom\fR and -\fB/dev/tsalarm:ctl\fR devices: -.sp -.ne 2 -.na -\fB\fBTSIOCALCTL - Turn an alarm on or off.\fR\fR -.ad -.sp .6 -.RS 4n -The argument is a pointer to the \fBts_aldata_t/lom_aldata_t\fR structure. This -structure is described below. \fBalarm_no member\fR is an integer which -specifies the alarm to which the command is to be applied. The -\fBalarm_state/state\fR structure member indicates the state to which the alarm -should be set (where 0 == off). An error (\fBEINVAL\fR) is returned if either -an invalid alarm_no or invalid alarm_state is provided. -.RE - -.sp -.ne 2 -.na -\fB\fBTSIOCALSTATE - Get the state of the alarms.\fR\fR -.ad -.sp .6 -.RS 4n -The argument is a pointer to the \fBts_aldata_t/lom_aldata_t\fR structure. This -structure is described below. \fBalarm_no member\fR is an integer which -indicates the alarm to which the command will be applied. The -\fBalarm_state\fR member holds the alarm's current state and is filled in by -the driver. A zero indicates that the alarm is off. An error (\fBEINVAL\fR) is -returned if an invalid alarm_no is provided. The structures and definitions for -the values are defined below. -.RE - -.sp -.LP -Alarm values: -.sp -.in +2 -.nf -The following old style values are defined in <lom.io.h> - - #define ALARM_NUM_0 0 /* number of zero'th alarm */ - - #define ALARM_NUM_1 1 /* number of first alarm */ - - #define ALARM_NUM_2 2 /* number of second alarm */ - - #define ALARM_NUM_3 3 /* number of third alarm */ - - Alarm values defined in <lom.io.h> - - #define ALARM_OFF 0 /* Turn off alarm */ - - #define ALARM_ON 1 /* Turn on alarm */ -.fi -.in -2 - -.sp -.LP -Alarm Data Structure: -.sp -.in +2 -.nf -This structure is defined in <lom.io.h> - - typedef struct { - - int alarm_no; /* alarm to apply command to */ - - int alarm_state; /* state of alarm (0 == off) */ - - } ts_aldata_t; -.fi -.in -2 - -.sp -.LP -Use the following LOM interfaces to get and set the alarms. These definitions -are included in <lom_io.h> -.sp -.in +2 -.nf - #define ALARM_CRITICAL 0 /* number of critical alarm */ - - #define ALARM_MAJOR 1 /* number of major alarm */ - - #define ALARM_MINOR 2 /* number of minor alarm */ - - #define ALARM_USER 3 /* number of user alarm */ -.fi -.in -2 - -.sp -.LP -The following alarm data structure is provided in <lom_io.h>: -.sp -.in +2 -.nf -typedef struct { - - int alarm_no; - - int state; - - } lom_aldata_t; -.fi -.in -2 - -.SH ERRORS -.sp -.LP -An \fBopen()\fR will fail if: -.sp -.ne 2 -.na -\fBENXIO\fR -.ad -.RS 9n -The driver is not installed in the system. -.RE - -.sp -.LP -An \fBioctl()\fR will fail if: -.sp -.ne 2 -.na -\fBEFAULT\fR -.ad -.RS 10n -There was a hardware failure during the specified operation. -.RE - -.sp -.ne 2 -.na -\fBEINVAL\fR -.ad -.RS 10n -The alarm number specified is not valid or an invalid value was supplied. -.RE - -.sp -.ne 2 -.na -\fBENXIO\fR -.ad -.RS 10n -The driver is not installed in the system or the monitor callback routine could -not be scheduled. -.RE - -.SH EXAMPLES -.sp -.in +2 -.nf -How to set an alarm: - - #include <sys/unistd.h> - #include <fcntl.h> - #include <stdio.h> - #include <lom_io.h> - - #define LOM_DEVICE "/dev/lom" - - int - main() - { - lom_aldata_t lld; - int fd = open(LOM_DEVICE, O_RDWR); - - if (fd == -1) { - printf("Error opening device: %s\en", LOM_DEVICE); - exit (1); - } - - lld.alarm_no = ALARM_CRITICAL; /* Set the critical alarm */ - lld.state = ALARM_ON; /* Set the alarm */ - - if (ioctl(fd, LOMIOCALCTL, (char *)&lld) != 0) - printf("Setting alarm failed"); - else - printf("Alarm set successfully"); - - close(fd); - - } -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/lom\fR\fR -.ad -.sp .6 -.RS 4n -LOM device. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/tsalarm:ctl\fR\fR -.ad -.sp .6 -.RS 4n -Alarm control device. -.RE - -.sp -.ne 2 -.na -\fB\fB/platform/platform/kernel/drv/sparcv9/tsalarm\fR\fR -.ad -.sp .6 -.RS 4n -Device driver module. -.RE - -.sp -.ne 2 -.na -\fB\fB/platform/SUNW,Netra-240/kernel/drv/tsalarm.conf\fR\fR -.ad -.sp .6 -.RS 4n -Driver configuration file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man7d/tty.7d b/usr/src/man/man7d/tty.7d deleted file mode 100644 index 0a814ada28..0000000000 --- a/usr/src/man/man7d/tty.7d +++ /dev/null @@ -1,29 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (C) 1999, 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 TTY 7D "Jul 3, 1990" -.SH NAME -tty \- controlling terminal interface -.SH DESCRIPTION -.sp -.LP -The file \fB/dev/tty\fR is, in each process, a synonym for the control terminal -associated with the process group of that process, if any. It is useful for -programs or shell sequences that wish to be sure of writing messages on the -terminal no matter how output has been redirected. It can also be used for -programs that demand the name of a file for output, when typed output is -desired and it is tiresome to find out what terminal is currently in use. -.SH FILES -.sp -.LP -\fB/dev/tty\fR -.sp -.LP -\fB/dev/tty*\fR -.SH SEE ALSO -.sp -.LP -\fBports\fR(1M), \fBconsole\fR(7D) diff --git a/usr/src/man/man7d/tzmon.7d b/usr/src/man/man7d/tzmon.7d deleted file mode 100644 index 388087a506..0000000000 --- a/usr/src/man/man7d/tzmon.7d +++ /dev/null @@ -1,57 +0,0 @@ -'\" te -.\" Copyright (c) 2006 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 TZMON 7D "Oct 31, 2006" -.SH NAME -tzmon \- ACPI Thermal Zone Monitor -.SH DESCRIPTION -.sp -.LP -The \fBtzmon\fR is a pseudo driver that serves as an ACPI thermal zone monitor. -Thermal zones are logical regions within a computer system for which ACPI -performs temperature monitoring and control functions. The number of thermal -zones on a system with ACPI support varies. For example, some systems may have -one or more thermal zones, while others may have none. See the \fIAdvanced -Configuration and Power Interface Specification, (ACPI) Version 3.0A\fR, for -more details. -.sp -.LP -The \fBtzmon\fR handles thermal Zone events from ACPI and polls the temperature -for each zone exposed by the ACPI implementation. If threshold temperatures -are reached, \fBtzmon\fR takes appropriate action. For example, if the -temperature is sufficiently high and the ACPI implementation supports it, -\fBtzmon\fR initiates system shutdown. -.sp -.LP -Note that by default, system temperature control functions are usually -performed by the BIOS and may supersede \fBtzmon\fR functions, depending on the -BIOS implementation. Also, many ACPI implementations expose no thermal zones -and in these cases, \fBtzmon\fR performs no functions. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86/x64 only -_ -Interface stability Private -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) -.sp -.LP -\fIAdvanced Configuration and Power Interface Specification, (ACPI), Version -3.0A.\fR diff --git a/usr/src/man/man7d/uath.7d b/usr/src/man/man7d/uath.7d deleted file mode 100644 index 585e18311f..0000000000 --- a/usr/src/man/man7d/uath.7d +++ /dev/null @@ -1,96 +0,0 @@ -'\" te -.\" 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 UATH 7D "Sep 10, 2009" -.SH NAME -uath \- Atheros AR5523 USB IEEE802.11a/b/g Wireless Network Driver -.SH DESCRIPTION -.sp -.LP -The \fBuath\fR IEEE802.11a/b/g wireless network driver is a multi-threaded, -loadable, clonable, GLDv3-based STREAMS driver supporting Atheros AR5523 USB -IEEE802.11a/b/g wireless network driver. -.SS "Configuration" -.sp -.LP -The \fBuath\fR driver performs auto-negotiation to determine the data rate and -mode. The driver supports only BSS networks (also known as \fBap\fR or -\fBinfrastructure\fR networks) and \fBopen\fR (or \fBopen-system\fR) or shared -system authentication. For wireless security, WEP encryption, WPA-PSk, and -WPA2-PSK are currently supported. You can perform configuration and -administration tasks using the \fBdladm\fR(1M) and \fBwificonfig\fR(1M) -utilities. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/uath\fR\fR -.ad -.RS 29n -Special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/uath\fR\fR -.ad -.RS 29n -32-bit ELF 86 kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/uat\fR\fR -.ad -.RS 29n -64-bit ELF kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/uathfw\fR\fR -.ad -.RS 29n -32-bit ELF firmware kernel module (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/misc/amd64/uathfw\fR\fR -.ad -.RS 29n -64-bit ELF firmware kernel module (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBdlpi\fR(7P), -\fBgld\fR(7D) -.sp -.LP -\fIIEEE802.11b/g - Wireless LAN Standard - IEEE, 2003\fR diff --git a/usr/src/man/man7d/ufm.7d b/usr/src/man/man7d/ufm.7d deleted file mode 100644 index ea3b7fa4c3..0000000000 --- a/usr/src/man/man7d/ufm.7d +++ /dev/null @@ -1,312 +0,0 @@ -.\" -.\" 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. -.\" Copyright 2020 Oxide Computer Company -.\" -.Dd May 23, 2021 -.Dt UFM 7D -.Os -.Sh NAME -.Nm ufm -.Nd Upgradeable Firmware Module driver -.Sh SYNOPSIS -.Pa /dev/ufm -.Lp -.In sys/ddi_ufm.h -.Sh DESCRIPTION -The -.Nm -device is a character special file that provides access to -Upgradeable Firmware Image information, as described in -.Xr ddi_ufm 9E -via a private ioctl interface. -.Pp -The UFM interfaces described below are used in the implementation of the -system through tools such as -.Xr fwflash 1M -or as part of the fault management architecture. -.Sh FILES -.Bl -tag -width Pa -.It Pa /kernel/drv/amd64/ufm -64-bit AMD64 ELF kernel driver -.It Pa /kernel/drv/sparcv9/ufm -64-bit SPARC ELF kernel driver -.El -.Sh IOCTLS -The -.Nm -driver implements a versioned ioctl interface for accessing UFM facilities. -The ioctl interfaces are defined in sys/ddi_ufm.h. -The following ioctl cmds are supported by DDI_UFM_VERSION_ONE: -.Bl -tag -width Dv -.It Dv UFM_IOC_GETCAPS -The -.Dv UFM_IOC_GETCAPS -ioctl is used to retrieve the set of DDI UFM capabilities supported by this -device instance. -.Pp -The ddi_ufm_cap_t type defines a bitfield enumerating the full set of DDI UFM -capabilities. -.Bd -literal -typedef enum { - DDI_UFM_CAP_REPORT = 1 << 0, - DDI_UFM_CAP_READIMG = 1 << 1 -} ddi_ufm_cap_t; -.Ed -.Pp -The capabilities mean: -.Bl -tag -width Dv -.It Dv DDI_UFM_CAP_REPORT -Indicates that the device is capable of reporting UFM information and -supports the -.Dv UFM_IOC_REPORT -and -.Dv UFM_IOC_REPORTSZ -ioctls. -.It Dv DDI_UFM_CAP_READIMG -Indicates that the device is capable of retrieving a firmware image from -a slot and transferring it back to the caller. -The -.Dv UFM_IOC_READIMG -ioctl is supported. -.El -.Pp -The -.Vt ufm_ioc_getcaps_t -structure defines the input/output data for the -.Dv UFM_IOC_GETCAPS -ioctl. -Callers should specify the -.Fa ufmg_version -and -.Fa ufmg_devpath -fields. -On success the -.Fa ufmg_caps -field will be filled in with a value indicating the -supported UFM capabilities of the device specified in -.Fa ufmg_devpath . -.Bd -literal -typedef struct ufm_ioc_getcaps { - uint_t ufmg_version; /* DDI_UFM_VERSION_ONE */ - uint_t ufmg_caps; /* UFM Caps */ - char ufmg_devpath[MAXPATHLEN]; -} ufm_ioc_getcaps_t; -.Ed -.It Dv UFM_IOC_REPORTSZ -The -.Dv UFM_IOC_REPORTSZ -ioctl is used to retrieve the amount of space -(in bytes) required to hold the UFM data for this device instance. -This should be used to allocate a sufficiently sized buffer for the -.Dv UFM_IOC_REPORT -ioctl. -.Pp -The -.Vt ufm_ioc_bufsz_t -structure defines the input/output data for the -.Dv UFM_IOC_REPORTSZ -ioctl. -Callers should specify the -.Fa ufbz_version -and -.Fa ufbz_devpath -fields. -On success the -.Fa ufbz_size -field will be filled in with the required buffer size. -.Bd -literal -typedef struct ufm_ioc_bufsz { - uint_t ufbz_version; /* DDI_UFM_VERSION_ONE */ - size_t ufbz_size; /* sz of buf to be returned by ioctl */ - char ufbz_devpath[MAXPATHLEN]; -} ufm_ioc_bufsz_t; -.Ed -.It Dv UFM_IOC_REPORT -The -.Dv UFM_IOC_REPORT -ioctl returns UFM image and slot data in the form of a packed nvlist. -The -.Vt ufm_ioc_report_t -structure defines the input/output data for the -.Dv UFM_IOC_REPORT -ioctl. -Callers should specify the ufmr_version, ufmr_bufsz and ufmr_devpath fields. -On success, the ufmr_buf field will point to a packed nvlist containing the UFM -data for the specified device instance. -This data can be unpacked and decoded into an nvlist using -.Xr nvlist_unpack 3NVPAIR . -.Bd -literal -typedef struct ufm_ioc_report { - uint_t ufmr_version; /* DDI_UFM_VERSIONONE */ - size_t ufmr_bufsz; /* size of caller-supplied buffer */ - caddr_t ufmr_buf; /* buf to hold packed output nvl */ - char ufmr_devpath[MAXPATHLEN]; -} ufm_ioc_report_t; -.Ed -.Pp -Due to the asynchronous nature of the system, it's possible for a device to -undergo a configuration change in between a -.Dv UFM_IOC_REPORTSZ -ioctl and a subsequent -.Dv UFM_IOC_REPORT -ioctl that would alter the size of the buffer -required to hold the UFM data. -.Pp -If the size of buffer supplied in the -.Dv UFM_IOC_REPORT -ioctl is greater than is required to hold the UFM data, then -the ioctl will succeed and the ufmr_bufsz field will be updated to reflect the -actual size of the returned UFM data. -If the size of buffer supplied in the -.Dv UFM_IOC_REPORT -ioctl is less than what is required to hold the UFM data, -the ioctl will fail with errno set to -.Er EOVERFLOW . -.It Dv UFM_IOC_READIMG -The -.Dv UFM_IOC_READIMG -ioctl retrieves a firmware image and slot from a device. -The -.Vt ufm_ioc_readimg_t -structure defines the input and output data for the ioctl. -Devices may have their own alignment and size constraints which may be -enforced upon issuing this ioctl. -The structure has the following form: -.Bd -literal -typedef struct ufm_ioc_readimg { - uint_t ufri_version; - uint_t ufri_imageno; - uint_t ufri_slotno; - uint64_t ufri_offset; - uint64_t ufri_len; - uint64_t ufri_nread; - void *ufri_buf; - char ufri_devpath[MAXPATHLEN]; -} ufm_ioc_readimg_t; -.Ed -.Pp -The -.Ft ufri_imageno -and -.Ft ufri_slotno -values are used to indicate the image and slot to read. -These indexes correspond to the same indices that are returned in the -nvlist from the -.Dv UFM_IOC_REPORT -ioctl. -The -.Ft ufri_offset -and -.Ft ufri_len -members are used to indicate how many bytes to read from the image and -where in the image to begin. -The -.Fa ufri_buf -member must be set to a valid pointer. -Data read from the device will be placed in that pointer. -The pointer must be at least -.Fa ufri_len -bytes long. -Upon successful completion, the -.Fa ufri_nread -member will be filled in with the number of bytes that have been placed -in -.Fa ufri_buf . -Finally, the -.Fa ufri_version -and -.Fa ufri_devpath -fields must be filled in with the version number, -.Dv DDI_UFM_VERSION_ONE , -and the corresponding /devices path. -.El -.Sh EXAMPLES -This example demonstrates how to use the -.Dv UFM_IOC_GETCAPS -ioctl to determine the UFM capabilities of a given device instance. -.Bd -literal -#include <stdio.h> -#include <stdlib.h> -#include <errno.h> -#include <fcntl.h> -#include <string.h> -#include <unistd.h> -#include <sys/ddi_ufm.h> -#include <sys/types.h> - -static const char devname[] = "/pci@ce,0/pci8086,2030@0/pci15d9,808@0"; - -int -main(int argc, char **argv) -{ - int fd; - ufm_ioc_getcaps_t ioc = { 0 }; - - if ((fd = open(DDI_UFM_DEV, O_RDWR)) < 0) { - (void) fprintf(stderr, "failed to open %s (%s)\n", DDI_UFM_DEV, - strerror(errno)); - return (1); - } - - ioc.ufmg_version = DDI_UFM_CURRENT_VERSION; - (void) strcpy(ioc.ufmg_devpath, devname); - - if (ioctl(fd, UFM_IOC_GETCAPS, &ioc) < 0) { - (void) fprintf(stderr, "getcaps ioctl failed (%s)\n", - strerror(errno)); - (void) close(fd); - return (1); - } - if ((ioc.ufmg_caps & DDI_UFM_CAP_REPORT) == 0) { - (void) printf("Driver does not support DDI_UFM_CAP_REPORT\n"); - } else { - (void) printf("Driver supports DDI_UFM_CAP_REPORT\n"); - } - (void) close(fd); - return (0); -} -.Ed -.Sh ERRORS -On failure to open or perform ioctls to the -.Nm -driver, -.Va errno -will be set to indicate the type of error. -A subset of the more common errors are detailed below. -For a full list of error numbers, see -.Xr Intro 2 -.Bl -tag -width Er -.It Er EAGAIN -The device driver is not currently ready to accept calls to it's DDI UFM entry -points. -This may be because the driver is not fully initialized or because the driver -is in the process of detaching. -.It Er EFAULT -The ufm driver encountered a failure while copying data either from or to the -address space of the calling process. -.It Er EINVAL -The offset or length of an image would have resulted in a read outside -of the image's valid range or with improper alignment. -.It Er EIO -A failure occurred while executing a DDI UFM entry point. -.It Er ENOTSUP -Either the requested ioctl is not supported by the target device, the device -does not exist or the device does not support the UFM interfaces. -.El -.Sh INTERFACE STABILITY -.Sy Evolving -.Sh SEE ALSO -.Xr ddi_ufm 9E , -.Xr ddi_ufm 9F , -.Xr ddi_ufm_image 9F , -.Xr ddi_ufm_slot 9F diff --git a/usr/src/man/man7d/ugen.7d b/usr/src/man/man7d/ugen.7d deleted file mode 100644 index b7a3079a28..0000000000 --- a/usr/src/man/man7d/ugen.7d +++ /dev/null @@ -1,1720 +0,0 @@ -'\" te -.\" Copyright 2017 Peter Tribble -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH UGEN 7D "May 13, 2017" -.SH NAME -ugen \- USB generic driver -.SH SYNOPSIS -.LP -.nf -\fBNode Name@unit-address\fR -.fi - -.LP -.nf -\fB#include <sys/usb/clients/ugen/usb_ugen.h>\fR -.fi - -.SH DESCRIPTION -.LP -\fBugen\fR is a generic USBA (Solaris USB Architecture) compliant client -character driver that presents USB devices to applications through a standard -\fBopen\fR(2), \fBclose\fR(2), \fBread\fR(2), \fBwrite\fR(2), -\fBaioread\fR(3C), \fBaiowrite\fR(3C) Unix interface. Uninterpreted raw data -are transferred to and from the device via file descriptors created for each USB -endpoint. Status is obtained by reading file descriptors created for endpoint -and full device status. -.sp -.LP -\fBugen\fR supports control, bulk, isochronous and interrupt (in and out) -transfers. libusb uses \fBugen\fR to access devices that do not -contain drivers (such as digital cameras and PDAs). -.SH BINDING -.LP -In general, no explicit binding of the \fBugen\fR driver is necessary because -\fBusb_mid\fR(7D) is the default driver for devices without a class or vendor -unique driver. \fBusb_mid\fR(7D) creates the same logical device names as -\fBugen\fR, but only if no child interfaces are explicitly bound to \fBugen\fR. -If it is necessary to bind \fBugen\fR explicitly to a device or interface, the -following section explains the necessary steps. -.sp -.LP -\fBugen\fR can bind to a device with one or more interfaces in its entirety, or -to a single interface of that device. The binding type depends on information -that is passed to \fBadd_drv\fR(1M) or \fBupdate_drv\fR(1M). -.sp -.LP -An \fBadd_drv\fR(1M) command binds \fBugen\fR to a list of device types it is -to control. \fBupdate_drv\fR(1M) adds an additional device type to the list of -device types being managed by the driver. -.sp -.LP -Names used to bind drivers can be found in \fB/var/adm/messages\fR. When a -device is on-lined after hot insertion, and no driver is found, there will be -an entry containing: -.sp -.in +2 -.nf -USB 2.0 device (usb<vid>,<pid>)... -.fi -.in -2 - -.sp -.LP -where vid is the USB vendor identifier in hex and pid is the product -identifier in hex supplied by the device descriptor \fBusb_dev_descr\fR(9S). -Note, the USB device version may vary depending on the device. -.sp -.LP -When using ugen for the first time, you must add the driver utilizing -\fBadd_drv\fR(1M), using a command of the following form: -.sp -.in +2 -.nf -Assuming that the vid is 472 and pid is b0b0: - -add_drv -n -m '* <device perms> <owner> <group>' - -i '"usb472,b0b0"' ugen -.fi -.in -2 - -.sp -.LP -If the command fails with: -.sp -.in +2 -.nf -(ugen) already in use as a driver or alias. -.fi -.in -2 - -.sp -.LP -\&...add the device using \fBupdate_drv\fR(1M): -.sp -.in +2 -.nf -update_drv -a -m '* <device perms> <owner> <group>' - -i '"usb472,b0b0"' ugen -.fi -.in -2 - -.sp -.LP -This binds \fBugen\fR to the entire device. -.sp -.LP -If ugen only binds to one interface of the device, use the following -driver_alias instead of usb<vid>,<pid>: -.sp -.in +2 -.nf - usbif<vid>,<pid>.config<cfg value>.<interface number> -.fi -.in -2 - -.sp -.LP -where cfg value is the value of bConfigurationValue in the configuration -descriptor (\fBusb_cfg_descr\fR(9S)). For example "usbif1234,4567.config1.0." -.sp -.LP -Note that you can use update_drv to also remove bindings. Please see -\fBupdate_drv\fR(1M) for more information. -.sp -.LP -After a successful add_drv or update_drv, remove the device and reinsert. Check -with the \fBprtconf\fR(1M) -D option to determine if \fBugen\fR is successfully -bound to the device and the nodes created in /dev/usb/<vid>.<pid> (see below). -.sp -.LP -An example showing how to bind a child device representing interface 0 of -configuration 1 of a composite device follows: -.sp -.in +2 -.nf -update_drv -a -m '* 0666 root sys' - -i '"usbif472,b0b0.config1.0"' ugen -.fi -.in -2 - -.sp -.LP -Note that if you uninstall the \fBugen\fR driver, and later reinstall it, -any pre-existing ugen driver device-bindings will be reactivated. Likewise, -any pre-existing ugen driver device-bindings are preserved across operating -system updates or upgrades. -.SH LOGICAL DEVICE NAME FORMAT -.LP -For each device or child device it manages, \fBugen\fR creates one logical -device name for device-wide status and one logical device name for endpoint 0. -\fBugen\fR also creates logical device names for all other endpoints within the -device node's binding scope (interface or device), plus logical device names -for their status. -.sp -.LP -If separate \fBugen\fR instances control different interfaces of the same -device, the device-wide status and endpoint logical device names created for -each instance will share access to the same source or endpoint pipes. For -example, a device with two interfaces, each operated by their own \fBugen\fR -instance, will show \fBendpoint0\fR as \fBif0cntrl0\fR to the first interface, -and will show it as \fBif1cntrl0\fR to the second interface. Both of these -logical device names share \fBendpoint0\fR. Likewise for the same device, -\fBugen\fR makes the device-wide status available as \fBif0devstat\fR to the -first interface and as \fBif1devstat\fR to the second interface. -\fBif0devstat\fR and \fBif1devstat\fR both return the same data. -.sp -.LP -Any \fBugen\fR logical device name can be held open by only one user at a time, -regardless of whether the \fBO_EXCL\fR flag passed to \fBopen\fR(2). When a -single pipe or data source is shared by multiple logical device names, such as -if[0,1]cntrl0 or if[0,1]devstat above, more than one logical device name -sharing the pipe or data source can be open at a time. However, only one user -may access the shared pipe or data source at a time, regardless of the logical -device name used for access. -.sp -.LP -When \fBugen\fR is bound to an entire device, the following logical device -names are created (each on a single line). \fIN\fR represents the instance -number of the device type. -.sp -.in +2 -.nf -Endpoint 0 (default endpoint): - - /dev/usb/<vid>.<pid>/<N>/cntrl0 - /dev/usb/<vid>.<pid>/<N>/cntrl0stat - - For example: - - /dev/usb/472.b0b0/0/cntrl0 - /dev/usb/472.b0b0/0/cntrl0stat - -Configuration index 1, Endpoints > 0, alternate 0: - - /dev/usb/<vid>.<pid>/<N>/if<interface#> - <in|out|cntrl><endpoint#> - /dev/usb/<vid>.<pid>/<N>/if<interface#> - <in|out|cntrl><endpoint#>stat - - For example: - - /dev/usb/472.b0b0/0/if0in1 - /dev/usb/472.b0b0/0/if0in1stat - -Configuration index 1, Endpoints > 0, alternate > 0: - - /dev/usb/<vid>.<pid>/<N>/if<interface#>. - <alternate><in|out|cntrl><endpoint#> - /dev/usb/<vid>.<pid>/<N>/if<interface#>. - <alternate<in|out|cntrl><endpoint#>stat - - For example: - - /dev/usb/472.b0b0/0/if0.1in3 - /dev/usb/472.b0b0/0/if0.1in3stat - -Configuration index> 1, Endpoints > 0, alternate 0: - /dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#> - <in|out|cntrl><endpoint#> - /dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#> - <in|out|cntrl><endpoint#>stat - - For example: - - /dev/usb/472.b0b0/0/cfg2if0in1 - /dev/usb/472.b0b0/0/cfg2if0in1stat - - Note that the configuration value from the configuration - descriptor indexed by the configuration index is used in - the node name and not the configuration index itself. - -Configuration index> 1, Endpoints > 0, alternate > 0: - /dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#>. - <alternate<in|out|cntrl><endpoint#> - /dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#>. - <alternate<in|out|cntrl><endpoint#>stat - - For example: - - /dev/usb/472.b0b0/0/cfg2if0.1in1 - /dev/usb/472.b0b0/0/cfg2if0.1in1stat - - Device status: - - /dev/usb/<vid>.<pid>/<N>/devstat - - For example: - - /dev/usb/472.b0b0/0/devstat -.fi -.in -2 - -.sp -.LP -When \fBugen\fR is bound to a single device interface, the following logical -device nodes are created: -.sp -.in +2 -.nf -Endpoint 0 (default endpoint): - - /dev/usb/<vid>.<pid>/<N>/if<interface#>cntrl0 - /dev/usb/<vid>.<pid>/<N>/if<interface#>cntrl0stat - - For example: - - /dev/usb/472.b0b0/0/if0cntrl0 - /dev/usb/472.b0b0/0/if0cntrl0stat - -Device status: - /dev/usb/<vid>.<pid>/<N>/if<interface#>devstat - - For example: - /dev/usb/472.b0b0/0/if0devstat -.fi -.in -2 - -.sp -.LP -The format for all other logical device names is identical to the format used -when \fBugen\fR is bound to the entire device. -.sp -.LP -Opening the endpoint of a different configuration or different alternate -interface will cause an implicit change of configuration or a switch to an -alternate interface. A configuration change is prohibited when any non-zero -endpoint device nodes are open. An alternate interface switch is prohibited if -any endpoint in the same interface is open. -.SH HOT-PLUGGING -.LP -A device may be hot-removed at any time. Following hot-removal, the device -status changes to USB_DEV_STAT_DISCONNECTED, the status of open endpoints -change to USB_LC_STAT_DISCONNECTED upon their access, and all subsequent -transfer requests fail. Endpoints are reactivated by first reinserting the -device and then closing and reopening all endpoints that were open when the -device was disconnected. -.SH CPR (CHECKPOINT/RESUME) -.LP -CPR (Checkpoint/Resume) may be initiated at any time and is treated similarly -to a hot-removal. Upon successful suspend and resume, all subsequent transfer -requests fail as an indication to the application to reinitialize. Applications -should close and reopen all endpoints to reinstate them. All endpoint and -device status on Resume (before close and reopen) is USB_LC_STAT_SUSPENDED. A -system suspend will fail while \fBugen\fR is performing a transfer. -.SH DEVICE POWER MANAGEMENT -.LP -Devices which support remote wakeup can be power managed when they have no open -logical device nodes. When an application opens the first logical device node -of a device, that application should assume that a reinitialization of device -state is required. -.SH DEVICE STATUS MANAGEMENT -.LP -Applications can monitor device status changes by reading the device status -from the device status logical name. When opened without O_NONBLOCK and -O_NDELAY, all reads from that file descriptor (with the exception of the -initial read that follows the open) block until a device status change occurs. -Calls to read will always return immediately if opened with \fBO_NONBLOCK\fR or -\fBO_NDELAY\fR. Nonblocking calls to read which have no data to return, return -no error and zero bytes read. -.sp -.LP -Device statuses are: -.sp -.ne 2 -.na -\fBUSB_DEV_STAT_ONLINE\fR -.ad -.RS 29n -Device is available. -.RE - -.sp -.ne 2 -.na -\fBUSB_DEV_STAT_DISCONNECTED\fR -.ad -.RS 29n -Device has been disconnected. -.RE - -.sp -.ne 2 -.na -\fBUSB_DEV_STAT_RESUMED\fR -.ad -.RS 29n -Device has been resumed, however, endpoints which were open on suspend have not -yet been closed and reopened. -.RE - -.sp -.ne 2 -.na -\fBUSB_DEV_STAT_UNAVAILABLE\fR -.ad -.RS 29n -Device has been reconnected, however, endpoints which were open on disconnect -have not yet been closed and reopened. -.RE - -.sp -.LP -The following code reads the device status device logical name: -.sp -.in +2 -.nf -int fd; -int status; - -if ((fd = open("/dev/usb/472.b0b0/0/devstat", - O_RDONLY)) < 0) { - /* handle error */ -} - -if (read(fd, &status, sizeof(status)) != sizeof(status)) { - /* handle error */ -} - -switch (status) { -case USB_DEV_STAT_DISCONNECTED: - printf ("Terminating as device has been disconnected.\en"); - exit (0); - -case USB_DEV_STAT_RESUMED: -case USB_DEV_STAT_UNAVAILABLE: - /* - * Close and reopen endpoints to reestablish device access, - * then reset device. - */ - break; - -case USB_DEV_STAT_ONLINE: -default: - break; -} -.fi -.in -2 - -.sp -.LP -Use \fBpoll\fR(2) to block on several logical names simultaneously, including -device status logical names. Poll indicates when reading a logical name would -return data. See \fBpoll\fR(2) for details. Calls to read may be done whether -or not they follow calls to poll. -.SH ENDPOINT STATUS MANAGEMENT -.LP -Each data endpoint has a corresponding status logical name. Use the status -logical name to retrieve the state of the data endpoint, including detail on -how its most recent transfer failed. Reads of the status file descriptors -always return immediately. See the ERRORS section for more information on -endpoint status values. All logical device name files created for returning -status must be opened with \fBO_RDONLY\fR. -.sp -.LP -The following code illustrates reading the status file descriptor of an -endpoint which just failed a data transfer in order to get more information on -the failure. -.sp -.in +2 -.nf -int data_xfered, status; -int ep1_data_fd, ep1_stat_fd; -uchar_t request[8]; - -ep1_data_fd = open ("/dev/usb/472.b0b0/0/if0out1", O_WRONLY); - -if (ep1_data_fd < 0) { - /* Handle open error. */ -} - -ep1_stat_fd = open ("/dev/usb/472.b0b0/0/if0out1stat", - O_RDONLY); -if (ep1_stat_fd < 0) { - /* Handle open error. */ -} - -data_xfered = write(ep1_data_fd, request, sizeof (request)); - -/* An error occurred during the data transfer. */ -if (data_xfered != sizeof (request)) { - - /* Read status file descriptor for details on failure. */ - if (read(ep1_stat_fd, (int *)&status, sizeof (status)) != - sizeof (status)) { - status = USB_LC_STAT_UNSPECIFIED_ERR; - } - - /* Take appropriate action. */ - switch (status) { - case USB_LC_STAT_STALL: - printf ("Endpoint stalled.\en"); - break; - case ... - ... - } - -} -.fi -.in -2 - -.SH CONTROL TRANSFERS -.LP -The control endpoint is typically used to set up the device and to query device -status or configuration. -.sp -.LP -Applications requiring I/O on a control endpoint should open the corresponding -logical device name and use regular UNIX I/O system calls. For example: -\fBread\fR(2), \fBwrite\fR(2), \fBaioread\fR(3C) and \fBaiowrite\fR(3C). -\fBpoll\fR(2) is not supported on control endpoints. -.sp -.LP -A control endpoint must be opened with \fBO_RDWR\fR since it is bidirectional. -It cannot be opened with \fBO_NONBLOCK\fR or \fBO_NDELAY\fR. -.sp -.LP -For example: -.sp -.in +2 -.nf -fd = open("/dev/usb/472.b0b0/0/cntrl0", O_RDWR); - -.fi -.in -2 - -.sp -.in +2 -.nf -fdstat = open("/dev/usb/472.b0b0/0/cntrl0stat", O_RDONLY); -.fi -.in -2 - -.sp -.LP -Control endpoints can be read and written. A \fBread\fR operation receives data -\fBfrom\fR the device and a \fBwrite\fR operation sends data \fBto\fR the -device. -.sp -.LP -To perform a control-IN transfer, perform a \fBwrite\fR(2) of USB setup data -(see section 9.3 of the \fIUSB 1.1\fR or \fI2.0\fR specifications) followed by -a \fBread\fR(2) on the same control endpoint to fetch the desired data. For -example: -.sp -.in +2 -.nf -void init_cntrl_req( - uchar_t *req, uchar_t bmRequestType, uchar_t bRequest, - ushort_t wValue, ushort_t wIndex, ushort_t wLength) { - req[0] = bmRequestType; - req[1] = bRequest; - req[2] = 0xFF & wValue; - req[3] = 0xFF & (wValue >> 8); - req[4] = 0xFF & wIndex; - req[5] = 0xFF & (wIndex >> 8); - req[6] = 0xFF & wLength; - req[7] = 0xFF & (wLength >> 8); -} - - .... - - - uchar_t dev_descr_req[8]; - usb_dev_descr_t descr; - - init_cntrl_req(dev_descr_req, - USB_DEV_REQ_DEV_TO_HOST, USB_REQ_GET_DESCR, - USB_DESCR_TYPE_SETUP_DEV, 0, sizeof (descr)); - - count = write(fd, dev_descr_req, sizeof (dev_descr_req)); - if (count != sizeof (dev_descr_req)) { - /* do some error recovery */ - ... - } - - count = read(fd, &descr, sizeof (descr)); - if (count != sizeof (descr)) { - /* do some error recovery */ - } -.fi -.in -2 - -.sp -.LP -The application can issue any number of reads to read data received on a -control endpoint. \fBugen\fR successfully completes all reads, returning the -number of bytes transferred. Zero is returned when there is no data to -transfer. -.sp -.LP -If the \fBread\fR/\fBwrite\fR fails and returns \fB-1\fR, you can access the -endpoint's status device logical name for precise error information: -.sp -.in +2 -.nf - int status; - - count = read(fdstat, &status, sizeof (status)); - if (count == sizeof (status)) { - switch (status) { - case USB_LC_STAT_SUSPENDED: - case USB_LC_STAT_DISCONNECTED: - /* close all endpoints */ - ... - break; - default: - ... - break; - } - } -.fi -.in -2 - -.sp -.LP -Refer to the ERRORS section for all possible error values. -.sp -.LP -To perform a control-OUT transfer, send in a single transfer, the USB setup -data followed by any accompanying data bytes. -.sp -.in +2 -.nf - /* 1st 8 bytes of wbuf are setup. */ - init_cntrl_req(wbuf, .......); - - /* Data bytes begin at byte 8 of wbuf. */ - bcopy(data, &wuf[8], sizeof (data)); - - /* Send it all in a single transfer. */ - count = write(fd, wbuf, sizeof (wbuf)); -.fi -.in -2 - -.sp -.LP -A \fBwrite\fR(2) returns the number of bytes (both setup and data) actually -transferred, (whether or not the \fBwrite\fR is completely successful), -provided that some data is actually transferred. When no data is transferred, -\fBwrite\fR(2) returns \fB-1\fR. Applications can read the corresponding -endpoint status to retrieve detailed error information. Note that it is an -error to specify a size different than: -.sp -.LP -(number of data bytes + number of setup bytes). -.sp -.LP -Here is a more extensive example which gets all descriptors of a device -configuration. For sake of brevity, uninteresting parts are omitted. -.sp -.in +2 -.nf - #include <sys/usb/usba.h> - #include <sys/usb/clients/ugen/usb_ugen.h> - - uchar_t *config_cloud; - uchar_t *curr_descr; - - uchar_t *bytes; - - int curr_descr_len; - int curr_descr_type; - - usb_cfg_descr_t cfg_descr; - usb_if_descr_t if_descr; - usb_ep_descr_t ep_descr; - - /* See 9.13 of USB 2.0 spec for ordering. */ - static char *pipetypes[] = { - "Control", "Isochronous", "Bulk", "Interrupt" - }; - - /* - * Setup to send a request to read just the config descriptor. The - * size of the whole cloud, containing all cfg, interface, endpoint, - * class and vendor-specific descriptors, will be returned as part of - * the config descriptor. - */ - init_cntrl_req(&setup_data, USB_DEV_REQ_DEV_TO_HOST, USB_REQ_GET_DESCR, - USB_DESCR_TYPE_SETUP_CFG, 0, USB_CFG_DESCR_SIZE); - - /* - * Write setup data. USB device will prepare to return the whole - * config cloud as a response to this. We will read this separately. - */ - count = write(ctrl_fd, &setup_data, sizeof (setup_data)); - if (count != sizeof (setup_data)) { - /* Error recovery. */ - } else { - count = read(ctrl_fd, &cfg_descr, USB_CFG_DESCR_SIZE); - if (count != USB_CFG_DESCR_SIZE) { - /* Error recovery. */ - } - } - - /* USB data is little endian. */ - bytes = (uchar_t *)(&cfg_descr.wTotalLength); - totalLength = bytes[0] + (bytes[1] << 8); - - /* - * The size of the whole cloud is in the bLength field. Set up - * to read this amount of data, to get the whole cloud. - */ - config_cloud = malloc(totalLength); - - init_cntrl_req(&setup_data, USB_DEV_REQ_DEV_TO_HOST, USB_REQ_GET_DESCR, - USB_DESCR_TYPE_SETUP_CFG, 0, totalLength); - - count = write(ctrl_fd, &setup_data, sizeof (setup_data)); - if (count != sizeof (setup_data)) { - /* Error recovery. */ - } else { - count = read(ctrl_fd, config_cloud, totalLength); - if (count != totalLength) { - /* Error recovery. */ - } - } - - /* Got the data. Now loop, dumping out the descriptors found. */ - - curr_descr = config_cloud; - offset = 0; - while (offset < totalLength) { - - /* All descr have length and type at offset 0 and 1 */ - curr_descr_len = curr_descr[0]; - curr_descr_type = curr_descr[1]; - - switch (curr_descr_type) { - case USB_DESCR_TYPE_CFG: - - /* - * Copy data into separate structure, needed for - * proper alignment of all non char fields. Note: - * non-char fields of all descriptors begin on aligned - * boundaries. The issue is that some structures may - * be adjacent to others which have an odd-numbered - * byte size, and may thus start on an odd-numbered - * boundary. */ - bcopy(curr_descr, &cfg_descr, curr_descr_len); - - /* Remember to read any words in endian-neutral way. */ - - (void) printf("\enConfig %d found.\en", - cfg_descr.bConfigurationValue); - break; - - case USB_DESCR_TYPE_IF: - bcopy(curr_descr, &if_descr, curr_descr_len); - (void) printf("\en\etInterface %d, Alt %d found.\en", - if_descr.bInterfaceNumber, - if_descr.bAlternateSetting); - break; - - case USB_DESCR_TYPE_EP: - bcopy(curr_descr, &ep_descr, curr_descr_len); - (void) printf("\en\et\etEndpoint %d (%s-%s) found.\en", - (ep_descr.bEndpointAddress & USB_EP_NUM_MASK), - (pipetypes[ - ep_descr.bmAttributes & USB_EP_ATTR_MASK]), - ((ep_descr.bEndpointAddress & - USB_EP_DIR_IN) ? "IN" : "OUT")); - break; - - default: - (void) printf( - "\en\et\et\etOther descriptor found. Type:%d\en", - curr_descr_type); - break; - } - - offset += curr_descr_len; - curr_descr = &config_cloud[offset]; - } -.fi -.in -2 - -.SH INTERRUPT-IN TRANSFERS -.LP -Applications requiring data from an interrupt-IN endpoint should open the -corresponding logical device name and use \fBread\fR(2), \fBaioread\fR(3C) and -\fBpoll\fR(2) system calls. -.sp -.LP -An interrupt-IN endpoint must be opened with \fBO_RDONLY\fR. It can also be -opened using \fBO_NONBLOCK\fR or \fBO_NDELAY\fR if desired. -.sp -.in +2 -.nf -fd = open("/dev/usb/472.b0b0/0/if0in1", O_RDONLY); -.fi -.in -2 - -.sp -.in +2 -.nf -fdstat = open("/dev/usb/472.b0b0/0/if0in1stat", O_RDONLY); - -.fi -.in -2 - -.sp -.LP -\fBugen\fR starts polling interrupt\(emIN endpoints immediately upon opening -them and stops polling them upon closure. (Polling refers to interrogation of -the device by the driver and should not be confused with \fBpoll\fR(2), which -is an interrogation of the driver by the application.) -.sp -.LP -A \fBread\fR(2) of an endpoint opened with the \fBO_NONBLOCK\fR or -\fBO_NDELAY\fR flags set will not block when there is insufficient data -available to satisfy the request. The \fBread\fR simply returns what it can -without signifying any error. -.sp -.LP -Applications should continuously check for and consume interrupt data. -\fBugen\fR enables buffering of up to one second of incoming data. In case of -buffer overflow, \fBugen\fR stops polling the interrupt-IN endpoint until the -application consumes all the data. In this case, a \fBread\fR(2) of an empty -buffer returns \fB-1\fR, sets the endpoint status to -\fBUSB_LC_STAT_INTR_BUF_FULL\fR (to indicate that the buffer had been full and -polling had been stopped) and causes \fBugen\fR to start polling the endpoint -again. To retrieve the status, the application can open and read the -corresponding endpoint's status device logical name. -.sp -.in +2 -.nf -for (;;) { - count = read(fd, buf, sizeof(buf)); - if (count == -1) { - int cnt, status; - - cnt = read(fdstat, &status, sizeof (status)); - if (cnt == -1) { - /* more error recovery here */ - } else { - switch (status) { - case USB_LC_STAT_INTR_BUF_FULL: - ... - break; - default: - ... - break; - } - } - } - /* process the data */ - .... - } -.fi -.in -2 - -.sp -.LP -\fBugen\fR will never drop data. However, the device may drop data if the -application cannot read it at the rate that it is produced. -.sp -.LP -Applications requiring unbuffered data from an interrupt-IN endpoint should -open the associated status endpoint with O_RDWR before opening the associated -interrupt-IN endpoint and write a control byte with USB_EP_INTR_ONE_XFER set. -All other bits are reserved and should be 0. -.sp -.LP -"One transfer" mode will persist until disabled explicitly after the associated -interrupt-IN endpoint has been closed by writing a control byte with -USB_EP_INTR_ONE_XFER cleared. -.sp -.LP -"One transfer" mode is implicitly disabled when the status/control endpoint is -closed. -.sp -.LP -Attempts to change the "one transfer" mode while the endpoint is open will -result in \fBEINVAL\fR. -.sp -.LP -An application can open multiple interrupt-IN endpoints and can call -\fBpoll\fR(2) to monitor the availability of new data. (Note: poll works with -interrupt-IN data endpoints, not their status endpoints.) -.sp -.in +2 -.nf - struct pollfd pfd[2]; - - bzero(pfd, sizeof (pfd)); - pfd[0].fd = fd1; /* fd1 is one interrupt-IN endpoint. */ - pfd[0].events = POLLIN; - pfd[1].fd = fd2; /* fd2 is another interrupt-IN endpoint. */ - pfd[1].events = POLLIN; - - for (;;) { - poll(pfd, 2, -1); - - if (pfd[0].revents & POLLIN) { - count = read(fd1, buf, sizeof (buf)); - .... - } - if (pfd[1].revents & POLLIN) { - count = read(fd2, buf, sizeof (buf)); - .... - } - } -.fi -.in -2 - -.sp -.LP -You can monitor the device status endpoint via \fBpoll\fR(2) concurrently with -the multiple interrupt-IN endpoints. Simply add another pollfd element to the -pfd array in the previous code example, and initialize the new element's -\fBfd\fR field with the file descriptor of the device status endpoint (opened -without O_NONBLOCK or O_NDELAY). Set the new element's event field to POLLIN -like the other elements. Note that only interrupt-IN endpoints and the device -status endpoint can be monitored using \fBpoll\fR(2). -.SH INTERRUPT-OUT TRANSFERS -.LP -Applications requiring output on an interrupt-OUT endpoint can open the -corresponding logical device name and perform regular UNIX I/O system calls -such as \fBwrite\fR(2) and \fBaiowrite\fR(3C). -.sp -.LP -An interrupt-OUT endpoint must be opened with O_WRONLY. -.sp -.in +2 -.nf -fd = open("/dev/usb/472.b0b0/0/if0out3", O_WRONLY); - -fdstat = open("/dev/usb/472.b0b0/0/if0out3stat", O_RDONLY); - - -.fi -.in -2 - -.sp -.LP -Data can be written to an interrupt-OUT endpoint as follows: -.sp -.in +2 -.nf - count = write(fd, buf, sizeof (buf)): - if (count == -1) { - /* error recovery */ - } -.fi -.in -2 - -.SH BULK TRANSFERS -.LP -Applications requiring I/O on a bulk endpoint can open the corresponding -logical device name and perform regular UNIX I/O system calls. For example: -\fBread\fR(2), \fBwrite\fR(2), \fBaioread\fR(3C) and \fBaiowrite\fR(3C). -\fBpoll\fR(2) is not supported on bulk endpoints. -.sp -.LP -A bulk endpoint must be opened with \fBO_RDONLY\fR or \fBO_WRONLY\fR and cannot -be opened with \fBO_NONBLOCK\fR or \fBO_NDELAY:\fR -.sp -.in +2 -.nf -fd = open("/dev/usb/472.b0b0/0/if0in2", O_RDONLY); -.fi -.in -2 - -.sp -.in +2 -.nf -fdstat = open("/dev/usb/472.b0b0/0/if0in2stat", O_RDONLY); -.fi -.in -2 - -.sp -.LP -Data can be read from a bulk-IN endpoint as follows: -.sp -.in +2 -.nf - count = read(fd, buf, sizeof (buf)): - if (count == -1) { - /* error recovery */ - } - - Data can be written to a bulk-OUT endpoint as follows: - - count = write(fd, buf, sizeof (buf)): - if (count == -1) { - /* error recovery */ - } -.fi -.in -2 - -.SH ISOCHRONOUS TRANSFERS -.LP -Applications requiring I/O on an isochronous endpoint can open the -corresponding logical device name and perform regular UNIX I/O system calls -such as \fBread\fR(2), \fBwrite\fR(2), \fBpoll\fR(2), \fBaioread\fR(3C) and -\fBaiowrite\fR(3C). An isochronous endpoint must be opened with \fBO_RDWR\fR. -.sp -.in +2 -.nf -fd = open("/dev/usb/472.b0b0/0/if0.3in2", O_RDWR); - -fdstat = open("/dev/usb/472.b0b0/0/if0.3in2stat", O_RDONLY); -.fi -.in -2 - -.sp -.LP -Applications can use the status logical name to retrieve the state of the -isochronous data endpoint, including details on why the most recent transfer -failed. -.sp -.LP -Applications have the flexibility to specify the number of isochronous packets -and the size of individual packets they want to transfer. Applications should -use the following data structures to exchange isochronous packet information -with the \fBugen\fR driver: -.sp -.in +2 -.nf -typedef struct ugen_isoc_pkt_descr { - /* - * Set by the application, for all isochro. - * requests, to the num. of bytes to xfer - * in a packet. - */ - ushort_t dsc_isoc_pkt_len; - - /* - * Set by ugen to actual num. of bytes sent/received - * in a packet. - */ - ushort_t dsc_isoc_pkt_actual_len; - - /* - * Per pkt. status set by ugen driver both for the - * isochronous IN and OUT requests. Application can - * use USB_LC_STAT_* to parse the status. - */ - int dsc_isoc_pkt_status; - } ugen_isoc_pkt_descr_t; - - typedef struct ugen_isoc_req_head { - /* pkt count of the isoc request */ - int req_isoc_pkts_count; - - /* pkt descriptors */ - ugen_isoc_pkt_descr_t req_isoc_pkt_descrs[1]; - } ugen_isoc_req_head_t; -.fi -.in -2 - -.sp -.LP -\fBreq_isoc_pkts_count\fR is limited by the capability of the USB host -controller driver. The current upper bound for the \fBuhci\fR and \fBohci\fR -drivers is 512. The upper bound for the \fBehci\fR driver is 1024. -.sp -.LP -For an isochronous-IN endpoint, applications must first use the -\fBugen_isoc_req_head_t\fR structure followed by \fBugen_isoc_pkt_descr_t\fR to -write packet request information to the \fBugen\fR node. The \fBugen\fR driver -then checks the validity of the request. If it is valid, the driver immediately -begins isochronous polling on the IN endpoint and applications can proceed with -\fBread\fR(2) of the data on the isochronous-IN endpoint. Upon successful -return of \fBread\fR(2), isochronous packet descriptors (whose -\fBdsc_isoc_pkt_actual_len\fR and \fBdsc_isoc_pkt_status\fR fields were filled -by the driver) are returned, followed by the request's device payload data. -.sp -.LP -Applications should continuously check for and consume isochronous data. The -\fBugen\fR driver enables buffering of up to eight seconds of incoming data for -full-speed isochronous endpoint, one second of data for high-speed isochronous -endpoints who request one transaction per microframe and 1/3 of a second of -incoming data for high-speed high-bandwidth isochronous endpoints who request -three transactions per microframe. In case of buffer overflow, \fBugen\fR -discards the oldest data. -.sp -.LP -The isochronous-IN polling can only be stopped by a \fBclose\fR(2) associated -file descriptor. If applications want to change packet information, they must -first \fBclose\fR(2) the endpoint to stop the isochronous-IN polling, then -\fBopen\fR(2) the endpoint and \fBwrite\fR(2) new packets request. -.sp -.LP -The following example shows how to read an isochronous-IN endpoint: -.sp -.in +2 -.nf - #include <sys/usb/clients/ugen/usb_ugen.h> - - char *buf, *p; - ushort_t pktlen; - int pktcnt, i; - int len; - ugen_isoc_req_head_t *req; - ugen_isoc_pkt_descr_t *pktdesc; - char rdbuf[5000]; - - pktcnt = 4; /* 4 packets in this request */ - - len = sizeof(int) + - sizeof(ugen_isoc_pkt_descr_t) * pktcount; - - buf = malloc(len); - if (!buf) { - /* Error recovery. */ - } - - req = (ugen_isoc_req_head_t *)buf; - req->req_isoc_pkts_count = pktcnt; - - pktdesc = (ugen_isoc_pkt_descr_t *) - (req->req_isoc_pkt_descrs); - - for (i = 0; i < pktcnt; i++) { - /* - * pktlen should not exceed xfer - * capability of an endpoint - */ - pktdesc[i].dsc_isoc_pkt_len = pktlen; - - pktdesc[i].dsc_isoc_pkt_actual_len = 0; - pktdesc[i].dsc_isoc_pkt_status = 0; - } - - /* - * write request info to driver and len must - * be exactly the sum of - * sizeof(int) + sizeof(ugen_isoc_pkt_descr_t) * pktcnt. - * Otherwise, an error is returned. - */ - if (write(fd, buf, len) < 0) { - /* Error recovery. */ - } - - /* - * Read length should be sum of all pkt descriptors - * length + payload data length of all pkts - * (sizeof(ugen_isoc_pkt_descr_t) + pktlen) * pktcnt - */ - if (read(fd, rdbuf, (sizeof(ugen_isoc_pkt_descr_t) + - pktlen) * pktcnt) < 0) { - /* Error recovery. */ - } - - pktdesc = (ugen_isoc_pkt_descr_t *) rdbuf; - - /* points to payload beginning */ - p = rdbuf + pktcnt * sizeof(ugen_isoc_pkt_descr_t); - - for (i = 0; i < pktcnt; i++) { - printf("packet %d len = %d," - " actual_len = %d, status = 0x%x\en", - i, pktdesc->dsc_isoc_pkt_len, - pktdesc->dsc_isoc_pkt_actual_len, - pktdesc->dsc_isoc_pkt_status); - - /* Processing data */ - - /* - * next packet data payload, do NOT use - * dsc_isoc_pkt_actual_len - */ - p += pktdesc->dsc_isoc_pkt_len; - - pktdesc++; - } -.fi -.in -2 - -.sp -.LP -For an isochronous-OUT endpoint, applications use the same packet descriptor -and request structures to write request information to the \fBugen\fR node. -Following the packet request head information is the packet payload data. Upon -successful return of \fBwrite\fR(2), applications can \fBread\fR(2) the same -\fBugen\fR file immediately to retrieve the individual packet transfer status -of the last request. If the application isn't concerned about the status, it -can omit it. -.sp -.LP -In the following example, an application transfers data on an isochronous-OUT -endpoint: -.sp -.in +2 -.nf - #include <sys/usb/clients/ugen/usb_ugen.h> - char *buf, *p; - ushort_t i, pktlen; - int len, pktcnt; - ugen_isoc_req_head_t *req; - ugen_isoc_pkt_descr_t *pktdesc; - char rdbuf[4096]; - - pktcnt = 4; - - /* - * set packet length to a proper value, don't - * exceed endpoint's capability - */ - pktlen = 1024; - - len = sizeof(int) + - sizeof(ugen_isoc_pkt_descr_t) * pktcount; - - len += pktlen * pktcnt; - - buf = malloc(len); - if (!buf) { - /* Error recovery. */ - } - - req = (ugen_isoc_req_head_t *)buf; - req->req_isoc_pkts_count = pktcnt; - - pktdesc = - (ugen_isoc_pkt_descr_t *)(req->req_isoc_pkt_descrs); - - for (i = 0; i < pktcnt; i++) { - pktdesc[i].dsc_isoc_pkt_len = pktlen; - pktdesc[i].dsc_isoc_pkt_actual_len = 0; - pktdesc[i].dsc_isoc_pkt_status = 0; - } - - /* moving to beginning of payload data */ - p = buf + sizeof(int) + sizeof(*pktdesc) * pktcnt; - for (i = 0; i < pktcnt; i++) { - - /* fill in the data buffer */ - - p += pktlen; - } - - /* - * write packet request information and data to ugen driver - * - * len should be the exact value of sizeof(int) + - * sizeof(ugen_isoc_pkt_descr_t) * pktcnt + payload length - */ - if (write(fd, buf, len) < 0) { - /* Error recovery. */ - } - - /* read packet status */ - if (read(fd, rdbuf, sizeof(*pktdesc) * pktcnt) < 0) { - - /* Error recovery. */ - - } else { - - /* Parse every packet's transfer status */ - - } -.fi -.in -2 - -.SH ERRORS -.LP -The following statuses are returned by endpoint status device logical names: -.sp -.ne 2 -.na -\fBUSB_LC_STAT_NOERROR\fR -.ad -.sp .6 -.RS 4n -No error. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_CRC\fR -.ad -.sp .6 -.RS 4n -CRC error detected. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_BITSTUFFING\fR -.ad -.sp .6 -.RS 4n -Bit stuffing error. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_DATA_TOGGLE_MM\fR -.ad -.sp .6 -.RS 4n -Data toggle did not match. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_STALL\fR -.ad -.sp .6 -.RS 4n -Endpoint returned stall. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_DEV_NOT_RESP\fR -.ad -.sp .6 -.RS 4n -Device not responding. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_UNEXP_PID\fR -.ad -.sp .6 -.RS 4n -Unexpected Packet Identifier (PID). -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_PID_CHECKFAILURE\fR -.ad -.sp .6 -.RS 4n -Check bits on PID failed. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_DATA_OVERRUN\fR -.ad -.sp .6 -.RS 4n -Data overrun. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_DATA_UNDERRUN\fR -.ad -.sp .6 -.RS 4n -Data underrun. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_BUFFER_OVERRUN\fR -.ad -.sp .6 -.RS 4n -Buffer overrun. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_BUFFER_UNDERRUN\fR -.ad -.sp .6 -.RS 4n -Buffer underrun. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_TIMEOUT\fR -.ad -.sp .6 -.RS 4n -Command timed out. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_NOT_ACCESSED\fR -.ad -.sp .6 -.RS 4n -Not accessed by the hardware. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_UNSPECIFIED_ERR\fR -.ad -.sp .6 -.RS 4n -Unspecified USBA or HCD error. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_NO_BANDWIDTH\fR -.ad -.sp .6 -.RS 4n -No bandwidth available. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_HW_ERR\fR -.ad -.sp .6 -.RS 4n -Host Controller h/w error. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_SUSPENDED\fR -.ad -.sp .6 -.RS 4n -Device was suspended. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_DISCONNECTED\fR -.ad -.sp .6 -.RS 4n -Device was disconnected. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_INTR_BUF_FULL\fR -.ad -.sp .6 -.RS 4n -Polling was stopped as the interrupt-IN data buffer was full. Buffer is now -empty and polling has been resumed. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_INTERRUPTED\fR -.ad -.sp .6 -.RS 4n -Request was interrupted. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_NO_RESOURCES\fR -.ad -.sp .6 -.RS 4n -No resources available for request. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_INTR_POLLING_FAILED\fR -.ad -.sp .6 -.RS 4n -Failed to restart polling. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_ISOC_POLLING_FAILED\fR -.ad -.sp .6 -.RS 4n -Failed to start isochronous polling. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_ISOC_UNINITIALIZED\fR -.ad -.sp .6 -.RS 4n -Isochronous packet information not initialized. -.RE - -.sp -.ne 2 -.na -\fBUSB_LC_STAT_ISOC_PKT_ERROR\fR -.ad -.sp .6 -.RS 4n -All packets in this isochronous request have errors. The polling on this -isochronous-IN endpoint is suspended and can be resumed on next \fBread\fR(2). -.RE - -.sp -.LP -The following system call \fBerrno\fR values are returned: -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 11n -An attempt was made to enable or disable "one transfer" mode while the -associated endpoint was open. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 11n -The endpoint has been opened and another open is attempted. -.RE - -.sp -.ne 2 -.na -\fB\fBEACCES\fR\fR -.ad -.RS 11n -An endpoint open was attempted with incorrect flags. -.RE - -.sp -.ne 2 -.na -\fB\fBENOTSUP\fR\fR -.ad -.RS 11n -Operation not supported. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 11n -Device associated with the file descriptor does not exist. -.RE - -.sp -.ne 2 -.na -\fBENODEV\fR -.ad -.RS 11n -Device has been hot-removed or a suspend/resume happened before this command. -.RE - -.sp -.ne 2 -.na -\fBEIO\fR -.ad -.RS 11n -An I/O error occurred. Send a read on the endpoint status minor node to get the -exact error information. -.RE - -.sp -.ne 2 -.na -\fBEINTR\fR -.ad -.RS 11n -Interrupted system call. -.RE - -.sp -.ne 2 -.na -\fBENOMEM\fR -.ad -.RS 11n -No memory for the allocation of internal structures. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/ugen\fR\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module. (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ugen\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/ugen\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (SPARC). -.RE - -.sp -.ne 2 -.na -/dev/usb/<vid>.<pid>/<N>/cntrl0 -/dev/usb/<vid>.<pid>/<N>/cntrl0stat - -/dev/usb/<vid>.<pid>/<N>/if<interface#> - <in|out|cntrl><endpoint#> -/dev/usb/<vid>.<pid>/<N>/if<interface#> - <in|out|cntrl><endpoint#>stat - -/dev/usb/<vid>.<pid>/<N>/if<interface#>. - <alternate><in|out|cntrl<endpoint#> -/dev/usb/<vid>.<pid>/<N>/if<interface#>. - <alternate><in|out|cntrl><endpoint#>stat - -/dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#> - <in|out|cntrl><endpoint#> -/dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#> - <in|out|cntrl<endpoint#stat> - -/dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#>. - <alternate><in|out|cntrl><endpoint#> -/dev/usb/<vid>.<pid>/<N>/cfg<value>if<interface#>. - <alternate><in|out|cntrl><endpoint#>stat - -/dev/usb/<vid>.<pid>/<N>/devstat - -/dev/usb/<vid>.<pid>/<N>/if<interface#>cntrl0 -/dev/usb/<vid>.<pid>/<N>/if<interface#>cntrl0stat -.ad -.sp .6 -.RS 4n -where \fIN\fR is an integer representing the instance number of this type of -device. (All logical device names for a single device share the same \fIN\fR.) -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC & x86, PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBclose\fR(2), \fBpoll\fR(2), \fBread\fR(2), -\fBwrite\fR(2), \fBaioread\fR(3C), \fBaiowrite\fR(3C), \fBusba\fR(7D), -\fBusb_dev_descr\fR(9S) -.SH DIAGNOSTICS -.LP -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -Warning: <device path> (ugen<instance num>): Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBToo many minor nodes. \fR -.ad -.sp .6 -.RS 4n -Device has too many minor nodes. Not all are available. -.RE - -.sp -.ne 2 -.na -\fBInstance number too high (<\fInumber\fR>).\fR -.ad -.sp .6 -.RS 4n -Too many devices are using this driver. -.RE - -.sp -.ne 2 -.na -\fBCannot access <device>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -This device has been disconnected because a device other than the original one -has been inserted. The driver informs you of this fact by displaying the name -of the original device. -.RE - -.sp -.ne 2 -.na -\fBDevice is not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -Same condition as described above; however in this case, the driver is unable -to identify the original device with a name string. -.RE - -.SH NOTES -.LP -\fBugen\fR returns \fB-1\fR for all commands and sets \fBerrno\fR to -\fBENODEV\fR when device has been hot-removed or resumed from a suspend. The -application must close and reopen all open minor nodes to reinstate successful -communication. diff --git a/usr/src/man/man7d/uhci.7d b/usr/src/man/man7d/uhci.7d deleted file mode 100644 index b291369a35..0000000000 --- a/usr/src/man/man7d/uhci.7d +++ /dev/null @@ -1,116 +0,0 @@ -'\" te -.\" Copyright (c) 2005, 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 UHCI 7D "May 13, 2017" -.SH NAME -uhci \- host controller driver -.SH SYNOPSIS -.LP -.nf -\fBpcivid,pid@unit-address\fR -.fi - -.SH DESCRIPTION -.LP -The \fBuhci\fR host controller driver is a \fBUSBA \fR (Solaris USB -Architecture) compliant nexus driver that supports the \fIUniversal Host -Controller Interface Specification 1.1\fR, an industry standard developed by -Intel. The \fBuhci\fR driver supports all USB transfers, including interrupt, -control, isochronous and bulk. -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/uhci\fR\fR -.ad -.RS 28n -32-bit ELF kernel module. (SPARC or x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/uhci\fR\fR -.ad -.RS 28n -64-bit ELF kernel module. (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/uhci\fR\fR -.ad -.RS 28n -64-bit SPARC ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/uhci.conf\fR\fR -.ad -.RS 28n -Driver configuration file. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC or x86 PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBattributes\fR(5), \fBehci\fR(7D), \fBhubd\fR(7D), \fBohci\fR(7D), -\fBusba\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Host Controller Interface Specification for USB 1.1\fR -.sp -.LP -\fIUniversal Serial Bus Specification 2.0\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH DIAGNOSTICS -.LP -All host controller errors are passed to the client drivers. Root errors are -documented in \fBhubd\fR(7D). -.sp -.LP -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -WARNING: <device path> <uhci><instance number>>: Error message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBNo SOF interrupts have been received. This USB UHCI host controller is -unusable.\fR -.ad -.sp .6 -.RS 4n -The USB hardware is not generating Start Of Frame interrupts. Please reboot the -system. If this problem persists, contact your system vendor. -.RE - diff --git a/usr/src/man/man7d/ural.7d b/usr/src/man/man7d/ural.7d deleted file mode 100644 index b115ce96d9..0000000000 --- a/usr/src/man/man7d/ural.7d +++ /dev/null @@ -1,81 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 URAL 7D "May 6, 2008" -.SH NAME -ural \- Ralink RT2500USB 802.11b/g Wireless Driver -.SH DESCRIPTION -.sp -.LP -The \fBural\fR \fI802.11b/g\fR wireless NIC driver is a multi-threaded, -loadable, clonable, GLDv3-based STREAMS driver supporting the Ralink -RT2500USB chipset-based NIC's. -.SH CONFIGURATION -.sp -.LP -The \fBural\fR driver performs auto-negotiation to determine the data rate -and mode. Supported 802.11b data rates are 1, 2, 5.5 and 11 Mbits/sec. -Supported \fI802.11g\fR data rates are 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48 -and 54 Mbits/sec. The \fBural\fR driver supports only BSS networks (also known -as "ap" or "infrastructure" networks) and "open" (or "open-system") or "shared -system" authentication. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/ural*\fR\fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/ural\fR\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/ural\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fI802.11 - Wireless LAN Media Access Control and Physical Layer -Specification\fR - IEEE, 2001 diff --git a/usr/src/man/man7d/urtw.7d b/usr/src/man/man7d/urtw.7d deleted file mode 100644 index 39037a6f2f..0000000000 --- a/usr/src/man/man7d/urtw.7d +++ /dev/null @@ -1,78 +0,0 @@ -'\" te -.\" 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 URTW 7D "Aug 20, 2009" -.SH NAME -urtw \- RealTek RTL8187L/RTL8187B USB 802.11b/g Wireless Driver -.SH DESCRIPTION -.sp -.LP -The \fBurtw\fR 802.11b/g wireless driver is a multi-threaded, loadable, -clonable, GLDv3-basedSTREAMS driver supporting the RealTek RTL8187L -chipset-based wireless devices. -.SS "Configuration" -.sp -.LP -The \fBurtw\fR driver performs auto-negotiation to determine the data rate and -mode. Supported 802.11b data rates are 1, 2, 5.5 and 11 Mbits/sec. Supported -802.11g data rates are 1, 2, 5.5, 11, 6, 9, 12, 8, 24, 36, 48 and 54 Mbits/sec. -The \fBatu\fR driver supports only BSS networks (also known as\fBap\fR or -\fBinfrastructure\fR networks) and \fBopen\fR (or \fBopen-system\fR) or -\fBshared system\fR authentication. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/urtw*\fR\fR -.ad -.RS 26n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/urtw\fR\fR -.ad -.RS 26n -32-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/urtw\fR\fR -.ad -.RS 26n -64-bit ELF kernel module. (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fI802.11 \(em Wireless LAN Media Access Control and Physical Layer -Specification, IEEE, 2001\fR diff --git a/usr/src/man/man7d/usb_ac.7d b/usr/src/man/man7d/usb_ac.7d deleted file mode 100644 index d0cd3b3a51..0000000000 --- a/usr/src/man/man7d/usb_ac.7d +++ /dev/null @@ -1,139 +0,0 @@ -'\" te -.\" 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 USB_AC 7D "May 13, 2009" -.SH NAME -usb_ac \- USB audio control driver -.SH SYNOPSIS -.LP -.nf -sound-control@unit-address -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBusb_ac\fR driver is a USBA (Solaris USB Architecture) compliant client -driver that supports the \fIUSB Audio Class 1.0\fR specification. -.sp -.LP -The audio control driver is a USB class driver and offers functionality similar -to the \fBaudiocs\fR (sun4u) and \fBaudiots\fR (Sun Blade 100) drivers which -use the Solaris audio mixer framework (\fBmixer\fR(7I)). Unlike the -\fBaudiocs\fR and \fBaudiots\fR drivers, the USB audio device can have -play-only or record-only capability. -.sp -.LP -Drivers corresponding to other USB audio interfaces on the device, including -the \fBusb_as\fR(7D) audio streaming driver or the \fBhid\fR(7D) driver, are -plumbed under the USB audio control driver and do not directly interface with -user applications. -.sp -.LP -The \fBusb_ac\fR driver supports USB audio class compliant devices with a -feature unit. -.SH ERRORS -.sp -.LP -If a device is hot-removed while it is active, all subsequent opens returns -EIO. All other errors are defined in the \fBaudio\fR(7I) man page. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/usb_ac\fR\fR -.ad -.RS 30n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usb_ac\fR\fR -.ad -.RS 30n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usb_ac\fR\fR -.ad -.RS 30n -64-bit SPARC ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/usb_ac.conf\fR\fR -.ad -.RS 30n -USB audio driver configuration file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -.sp -.LP -\fBcfgadm_usb\fR(1M), \fBioctl\fR(2), \fBattributes\fR(5), \fBhid\fR(7D), -\fBusba\fR(7D), \fBusb_as\fR(7D), \fBaudio\fR(7I), \fBmixer\fR(7I), -\fBstreamio\fR(7I), \fBusb_ah\fR(7M) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Serial Bus Specification 1.0 and 1.1\fR -.sp -.LP -\fIUniversal Serial Bus Device Class Definition for Audio Devices, Release -1.0\fR -.sp -.LP -\fISystem Administration: Basic Administration\fR -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages can appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -Warning: <device path> (usb_ac<instance num>): Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBFailure to plumb audio streams drivers.\fR -.ad -.sp .6 -.RS 4n -The \fBusb\fR audio streaming driver or the \fBhid\fR driver could not be -plumbed under the audio control driver and the device is not usable. -.RE - diff --git a/usr/src/man/man7d/usb_as.7d b/usr/src/man/man7d/usb_as.7d deleted file mode 100644 index 1ab1bdb569..0000000000 --- a/usr/src/man/man7d/usb_as.7d +++ /dev/null @@ -1,157 +0,0 @@ -'\" te -.\" 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 USB_AS 7D "May 15, 2009" -.SH NAME -usb_as \- USB audio streaming driver -.SH SYNOPSIS -.LP -.nf -sound@unit-address -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBusb_as\fR driver is a USBA (Solaris USB Architecture) compliant client -driver that supports the \fIUSB Audio Class 1.0\fR specification. -.sp -.LP -The \fBusb_as\fR driver processes audio data messages during play and record -and sets sample frequency, precision, encoding and other functions on request -from the USB audio control driver. See \fBusb_ac\fR(7D). -.sp -.LP -This driver is plumbed under the USB audio control driver and does not directly -interface with the user application. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/usb_as\fR\fR -.ad -.RS 30n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usb_as\fR\fR -.ad -.RS 30n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usb_as\fR\fR -.ad -.RS 30n -64-bit SPARC ELF kernel module -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -_ -Stability level Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBusba\fR(7D), \fBusb_ac\fR(7D), \fBaudio\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Serial Bus Specification 1.0 and 1.1\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages can appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -Warning: <device path> (usb_as<instance num>): Error Message... -.fi -.in -2 -.sp - -.sp -.LP -where \fI<device path>\fR is the physical path to the device in \fB/devices\fR -directory. -.sp -.ne 2 -.na -\fBNo bandwidth available.\fR -.ad -.sp .6 -.RS 4n -There is no bandwidth available for the isochronous pipe. As a result, no data -is transferred during play and record. -.RE - -.sp -.ne 2 -.na -\fBOperating a full/high speed audio device on a high speed port is not -supported.\fR -.ad -.sp .6 -.RS 4n -The USB software does not currently support full or high speed audio devices -connected to an external USB 2.0 hub that is linked to a port of a USB 2.0 host -controller. Audio devices must be connected directly to a port of a USB 2.0 -controller or to any USB 1.1 port. -.RE - -.sp -.ne 2 -.na -\fBCannot access device. Please reconnect <name>.\fR -.ad -.sp .6 -.RS 4n -There was an error in accessing the device during reconnect. Please reconnect -the device. -.RE - -.sp -.ne 2 -.na -\fBDevice is not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -A USB audio streaming interface was hot-removed while open. A new device was -hot-inserted which is not identical to the original USB audio device. Please -disconnect the USB device and reconnect the device to the same port. -.RE - -.SH NOTES -.sp -.LP -The USB audio streaming interface is power managed if the device is idle. diff --git a/usr/src/man/man7d/usb_ia.7d b/usr/src/man/man7d/usb_ia.7d deleted file mode 100644 index 206d5c0e1e..0000000000 --- a/usr/src/man/man7d/usb_ia.7d +++ /dev/null @@ -1,114 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 USB_IA 7D "May 13, 2017" -.SH NAME -usb_ia \- USB interface association driver -.SH SYNOPSIS -.LP -.nf -interface association@unit-address -.fi - -.LP -.nf - -.fi - -.SH DESCRIPTION -.LP -The \fBusb_ia\fR driver is a USBA (Solaris Universal Serial Bus -Architecture)-compliant nexus driver that binds to a device's interface -association nodes when no vendor or class specific driver is available. To do -this, \fBusb_ia\fR creates nodes for the internal interfaces and then attempts -to bind drivers to each child interface. -.sp -.LP -Each interface association node has a parent device node that is created by -\fBusb_mid\fR(7D) and all \fBugen\fR(7D) interfaces are exported by -\fBusb_mid\fR(7D). (Note: attempting to export \fBugen\fR(7D) interfaces using -\fBusb_ia\fR is prohibited.) -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/usb_ia\fR\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module. (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usb_ia\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usb_ia\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (SPARC). -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC & x86 PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBattributes\fR(5), \fBugen\fR(7D), \fBusb_mid\fR(7D), \fBusba\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.sp -.LP -\fIUniversal Serial Bus Specification 2.0\fR \(em 2000 -.sp -.LP -\fIInterface Association Descriptor Engineering Change Notice (ECN)\fR\(em2003 -.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 -.in +2 -.nf -<device path> (usb_ia<instance num>):message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBNo driver found for interface <n> (nodename: <string>) of <device>.\fR -.ad -.sp .6 -.RS 4n -No driver is available for this interface. -.RE - diff --git a/usr/src/man/man7d/usb_mid.7d b/usr/src/man/man7d/usb_mid.7d deleted file mode 100644 index 6baa22f718..0000000000 --- a/usr/src/man/man7d/usb_mid.7d +++ /dev/null @@ -1,192 +0,0 @@ -'\" te -.\" Copyright 2006 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 USB_MID 7D "May 13, 2017" -.SH NAME -usb_mid \- USB Multi Interface Driver -.SH SYNOPSIS -.LP -.nf -\fBdevice@\fR\fIunit-address\fR -.fi - -.SH DESCRIPTION -.LP -The \fBusb_mid\fR driver is a \fBUSBA\fR (Solaris Universal Serial Bus -Architecture)-compliant nexus driver that binds to device level nodes of a -composite (multi interface) device if no vendor or class-specific driver is -available. The \fBusb_mid\fR driver creates interface nodes or interface -association nodes and attempts to bind drivers to them. If no driver is found -for interface association nodes, \fBusb_ia\fR(7D) is bound by default. -.SS "UGEN (Generic USB)" -.LP -The \fBusb_mid\fR driver also supports a \fBugen\fR(7D) interface allowing raw -access to the device, for example by libusb applications, by -passing the drivers bound to each interface. Since a libusb application might -change the state of the device, you should not access the device through the -child interface drivers. Note that the \fBusb_mid\fR driver creates a ugen -interface only if none of its children are explicitly bound to the -\fBugen\fR(7D) driver. Additionally, \fBusb_mid\fR does not create children. -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/usb_mid\fR \fR -.ad -.sp .6 -.RS 4n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usb_mid\fR \fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usb_mid\fR \fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB/dev/usb/*/*/* \fR -.ad -.sp .6 -.RS 4n -ugen(7D) nodes. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC & x86, PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBcfgadm_usb\fR(1M), \fBattributes\fR(5), \fBusba\fR(7D), -\fBusb_ia\fR(7D) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Serial Bus Specification 2.0\fR\(em2000 -.sp -.LP -\fIInterface Association Descriptor Engineering Change Notice (ECN)\fR\(em2003 -.sp -.LP -\fISystem Administration Guide: Basic Administration\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 -.in +2 -.nf -Warning: <device path> (usb_mid<instance number>): Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBCannot access <device>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -This device has been disconnected because a device other than the original one -has been inserted. The driver informs you of this fact by displaying the name -of the original device. -.RE - -.sp -.ne 2 -.na -\fBDevice not identical to the previous one on this port. Please disconnect and -reconnect.\fR -.ad -.sp .6 -.RS 4n -Same condition as described above; however in this case, the driver is unable -to identify the original device with a name string. -.RE - -.sp -.ne 2 -.na -\fBPlease disconnect and reconnect this device.\fR -.ad -.sp .6 -.RS 4n -A hotplug of the device is needed before it can be restored. -.RE - -.sp -.LP -The following messages may be logged into the system log. They are formatted in -the following manner: -.sp -.in +2 -.nf -<device path><usb_mid<instance number>): message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBNo driver found for interface <n> (nodename: <string>) of <device>. \fR -.ad -.sp .6 -.RS 4n -No driver is available for this interface. -.RE - -.sp -.ne 2 -.na -\fBNo driver found for device <device>. \fR -.ad -.sp .6 -.RS 4n -No driver is available for this interface. -.RE - -.sp -.ne 2 -.na -\fBCan't support ugen for multiple configuration devices that have attached -child interface drivers.\fR -.ad -.sp .6 -.RS 4n -No ugen interface is available and libusb cannot work with this -device. -.RE - diff --git a/usr/src/man/man7d/usba.7d b/usr/src/man/man7d/usba.7d deleted file mode 100644 index 25cc63c8ea..0000000000 --- a/usr/src/man/man7d/usba.7d +++ /dev/null @@ -1,144 +0,0 @@ -.\" 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 Jan 10, 2020 -.Dt USBA 7D -.Os -.Sh NAME -.Nm usba , -.Nm usb -.Nd illumos USB Architecture (USBA) -.Sh DESCRIPTION -USB provides a low-cost means for attaching peripheral devices, including -mass-storage devices, keyboards, mice, and printers, to a system. -For complete information on the USB architecture, visit the USB website at -http://www.usb.org. -.Pp -USBA supports 126 hot-pluggable USB devices per USB bus. -The maximum data transfer rate is 5 Gbits (SuperSpeed USB 3.0), 480 Mbits (high -speed USB 2.0), 12 Mbits (full speed USB 1.x), or 1.5 Mbits (low speed USB 1.x). -.Pp -USBA adheres to the -.Em Universal Serial Bus 3.0 -specification and provides a transport layer abstraction to USB client -drivers. -.Pp -For information on how to write USB client drivers, see -.Em Writing Device Drivers . -For the latest information on writing USB drivers, visit -.Em http://illumos.org/books/wdd . -For a complete list of USBA interfaces, see -.Xr Intro 9F -or -.Xr Intro 9S . -.Pp -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. -.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 -.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 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/[sparcv9|amd64]/uhci Ta Universal HCI -.El -.Sh DIAGNOSTICS -The messages described below may appear on the system console as well as being -logged. -All messages are formatted in the following manner: -.Bl -tag -width Sy -offset 2n -.It WARNING: Error message... -.El -.Bl -tag -width Sy -offset 2n -.It Sy no driver found for device <device_name> (interface <number> node -name=<node_name>) -The installed software does not contain a supported driver for this -hardware. -<number> is the interface number. -<name> is either the device path name or the device name. -.It Sy Draining callbacks timed out! -An internal error occurred. -Please reboot your system. -If this problem persists, contact your system vendor. -.El -.Pp -The following messages may be logged into the system log. -They are formatted in the following manner: -.Bd -literal -offset 2n -<device path><usba<instance number>): message... -.Ed -.Bl -tag -width Sy -offset 2n -.It Sy Incorrect USB driver version for <n.m> . -Driver is incompatible with USBA framework. -.El -.Sh SEE ALSO -.Xr cfgadm_usb 1M , -.Xr attributes 5 , -.Xr ehci 7D , -.Xr hid 7D , -.Xr hubd 7D , -.Xr ohci 7D , -.Xr scsa2usb 7D , -.Xr ugen 7D , -.Xr uhci 7D , -.Xr usb_ac 7D , -.Xr usb_as 7D , -.Xr usb_ia 7D , -.Xr usb_mid 7D , -.Xr usbprn 7D , -.Xr usbsacm 7D , -.Xr usbser_edge 7D , -.Xr usbsksp 7D , -.Xr usbsprl 7D , -.Xr usbvc 7D , -.Xr virtualkm 7D , -.Xr xhci 7D , -.Xr Intro 9F , -.Xr Intro 9S -.Pp -.Rs -.%T Writing Device Drivers -.Re -.Rs -.%T Universal Serial Bus Specification 3.0 -.Re -.Rs -.%T Interface Association Descriptor Engineering Change Notice (ECN) -.Re -.Rs -.%T System Administration Guide: Basic Administration -.Re -.Sh NOTES -Booting from USB mass-storage devices is not supported on SPARC, but is -supported on X86. diff --git a/usr/src/man/man7d/usbftdi.7d b/usr/src/man/man7d/usbftdi.7d deleted file mode 100644 index 0fc49718d7..0000000000 --- a/usr/src/man/man7d/usbftdi.7d +++ /dev/null @@ -1,322 +0,0 @@ -'\" te -.\" 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 USBFTDI 7D "Aug 13, 2021" -.SH NAME -usbftdi \- FTDI USB to serial converter driver -.SH SYNOPSIS -.LP -.nf -\fB#include <fcntl.h>\fR -\fB#include <sys/termio.h>\fR -\fBusbftdi@unit\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBusbftdi\fR driver is a loadable STREAMS and USBA (Solaris USB -Architecture) compliant client driver that provides basic asynchronous -communication support for FTDI USB-to-serial converters. Serial device streams -are built with appropriate modules that are pushed atop the \fBusbftdi\fR -driver by the \fBautopush\fR(1M) facility. -.SS "Application Programming Interface" -.sp -.LP -The \fBusbftdi\fR module supports the \fBtermio\fR(7I) device control functions -specified by flags in the \fBc_cflag\fR word of the \fBtermios\fR structure, -and by the \fBIGNBRK, IGNPAR, PARMRK\fR, and \fBINPCK\fR flags in the -\fBc_iflag\fR word of the \fBtermios\fR structure. All other \fBtermio\fR(7I) -functions must be performed by STREAMS modules pushed atop the driver. When a -device is opened, the , \fBldterm\fR(7M) and \fBttcompat\fR(7M) STREAMS modules -are automatically pushed on top of the stream, providing the standard -\fBtermio\fR(7I) interface. -.sp -.LP -Use device logical names \fB/dev/term/[0-9]*\fR to access the serial ports for -a dial-in line that is used with a modem. -.sp -.LP -Use device logical names \fB/dev/cua/[0-9]*\fR to access the serial ports for -other applications. These names are also used to provide a logical access point -for a dial-out line. -.sp -.LP -Device hot-removal is functionally equivalent to a modem disconnect event, as -defined in \fBtermio\fR(7I). -.sp -.LP -Input and output line speeds can be set to the following baud rates: 300, 600, -1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400, 460800, 921600, -2000000, or 3000000. Input and output line speeds can not be set -independently. For example, when the output speed is set, the input speed is -automatically set to the same speed. -.SS "Soft Carrier Capabilities" -.sp -.LP -Many devices that use this USB serial interface component are not, in fact -dial-in lines connected to carefully configured RS-232 modems. They are often -intelligent peripherals whose manufacturers want to present a serial port -interface to application software. Some applications use only three wire -connections, or are otherwise somewhat casual about the state of the Carrier -Detect (electrical) signal, and the other modem control lines. -.sp -.LP -The configuration file delivered with this driver, \fBusbftdi.conf\fR, -acknowledges this by setting the driver property \fBignore-cd\fR to 1. This -enables \fBsoft carrier\fR mode where the kernel does \fBnot\fR block opens -waiting for DCD to be asserted. -.sp -.LP -This behavior also matches the default \fBignore carrier detect\fR behavior of -the onboard serial ports of machines that have them. See \fBeeprom\fR(1M) for -further details. -.sp -.LP -The \fBhardware carrier\fR behavior (the driver's internal default) can be -selected by either unsetting (commenting out) the \fBignore-cd\fR property, or -by setting the value of the property to zero. -.sp -.LP -More sophisticated selection of which devicesl ignore or obey the DCD signal -can be effected using \fBport-%d-ignore-cd\fR properties. -.SS "Dial-In and Dial-Out Support" -.sp -.LP -A related feature is available for traditional usage that enables a single tty -line to be connected to a modem and used for incoming and outgoing calls. By -accessing through device logical name \fB/dev/cua/[0-9]*\fR, you can open a -port without the carrier detect signal being asserted, either through hardware -or an equivalent software mechanism. These devices are commonly known as -dial-out lines. -.sp -.LP -A dial-in line can be opened only if the corresponding dial-out line is closed. -A blocking \fB/dev/term\fR open waits until the \fB/dev/cua\fR line is closed, -which drops Data Terminal Ready, after which Carrier Detect usually drops as -well. When the carrier is detected again with the \fB/dev/cua\fR device -remaining closed, this indicates an incoming call and the blocking open seizes -exclusive use of the line. -.sp -.LP -A non-blocking \fB/dev/term\fR open returns an error if the \fB/dev/cua\fR -device is open. -.sp -.LP -If the \fB/dev/term\fR line is opened successfully (usually only when carrier -is recognized on the modem, though see \fBSoft Carrier Capabilities\fR section -of this manual page), the corresponding \fB/dev/cua\fR line can not be opened. -This allows a modem and port to be used for dial-in (enabling the line for -login in \fB/etc/inittab\fR) or dial-out (using \fBtip\fR(1) or \fBuucp\fR(1C)) -when no-one is logged in on the line. -.SH ERRORS -.sp -.LP -An \fBopen()\fR fails under the following conditions: -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 9n -The unit being opened does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The \fB/dev/cua\fR (dial-out) device is being opened while the \fB/dev/term\fR -(dial-in device) is open, or the dial-in device is being opened with a no-delay -open while the dial-out device is open. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The unit has been marked as exclusive-use by another process with a -\fBTIOCEXCL\fR \fBioctl()\fR call. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 9n -USB device I/O error. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/usr/kernel/drv/usbftdi\fR\fR -.ad -.sp .6 -.RS 4n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/kernel/drv/usbftdi.conf\fR\fR -.ad -.sp .6 -.RS 4n -Kernel module configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/kernel/drv/amd64/usbftdi\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/kernel/drv/sparcv9/usbftdi\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/cua/[0-9]*\fR\fR -.ad -.sp .6 -.RS 4n -Dial-out tty lines -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/term/[0-9]*\fR\fR -.ad -.sp .6 -.RS 4n -Dial-in tty lines -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attribute: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -.sp -.LP -\fBstrconf\fR(1), \fBtip\fR(1), \fBuucp\fR(1C), \fBautopush\fR(1M), -\fBeeprom\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), \fBtermios\fR(3C), -\fBusba\fR(7D), \fBtermio\fR(7I), \fBldterm\fR(7M), \fBttcompat\fR(7M), -\fBeeprom\fR(1M), \fBattributes\fR(5), -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages might appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -Warning: \fIdevice_path\fR usbftdi\fIinstance num\fR): Error Message ... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fB\fBDevice was disconnected while open. Data may have been lost.\fR\fR -.ad -.sp .6 -.RS 4n -The device has been hot-removed or powered off while it was open and a possible -data transfer was in progress. The job might be aborted. -.RE - -.sp -.ne 2 -.na -\fB\fBDevice is not identical to the previous one on this port. Please -disconnect and reconnect.\fR\fR -.ad -.sp .6 -.RS 4n -The device was hot-removed while open. A new device was hot-inserted which is -not identical to the original device. Please disconnect the device and -reconnect the original device to the same port. -.RE - -.sp -.ne 2 -.na -\fB\fBDevice has been reconnected, but data may have been lost.\fR\fR -.ad -.sp .6 -.RS 4n -The device that was hot-removed from its USB port has been re-inserted again to -the same port. It is available for access but data from a previous transfer -might be lost. -.RE - -.sp -.ne 2 -.na -\fB\fBCannot access \fIdevice\fR. Please reconnect.\fR\fR -.ad -.sp .6 -.RS 4n -This device has been disconnected because a device other than the original one -has been inserted. The driver informs you of this fact by displaying the name -of the original device. -.RE - -.sp -.LP -The following messages might be logged into the system log. They are formatted -in the following manner: -.sp -.in +2 -.nf -\fIdevice_path\fR usbftdi\fIiinstance number\fR): message ... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fB\fBInput overrun.\fR\fR -.ad -.RS 18n -Data was lost. -.RE - diff --git a/usr/src/man/man7d/usbprn.7d b/usr/src/man/man7d/usbprn.7d deleted file mode 100644 index 9f5d326917..0000000000 --- a/usr/src/man/man7d/usbprn.7d +++ /dev/null @@ -1,450 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 USBPRN 7D "May 17, 2020" -.SH NAME -usbprn \- USB printer class driver -.SH SYNOPSIS -.nf -#include <sys/usb/clients/printer/usb_printer.h> -.fi - -.LP -.nf -#include <sys/ecppio.h> -.fi - -.LP -.nf -usbprn@unit-address -.fi - -.SH DESCRIPTION -The \fBusbprn\fR driver is a USBA (Solaris USB Architecture) compliant client -driver that supports the \fIUSB Printer Class 1.0\fR specification. The -\fBusbprn\fR driver supports a subset of the \fBecpp\fR(7D) parallel port -driver functionality. However, unlike the STREAMS-based \fBecpp\fR driver, -\fBusbprn\fR is a character driver. -.sp -.LP -The \fBusbprn\fR driver supports all USB printer-class compliant printers. -.sp -.LP -The \fBusbrpn\fR driver includes support for communicating with many different -printers. To use these printers, it may be necessary to install and configure -additional format conversion packages available in the Solaris distribution. -Configuration of these conversion packages under the Solaris printing system -can be simplified through the use of the \fBprintmgr\fR(1M). This tool allows -selection of printer manufacturer/model information while creating a print -queue. For USB connected printers, it attempts to pre-select the -manufacturer and model information based on the 1284 device id supplied by the -printer. -.SS "UGEN (Generic USB)" -The \fBusbprn\fR driver also supports a \fBugen\fR(7D) interface allowing raw -access to the device, for example by libusb applications, by -passing the drivers bound to each interface. Because a libusb application might -change the state of the device, you should not access the device through the -child interface drivers. -.SH DEFAULT OPERATION -With certain minor exceptions (outlined in the Notes sections below), the -\fBusbprn\fR driver supports a subset of the \fBecpp\fR(7D) ioctl interfaces: -.sp -.LP -Configuration variables are set to their default values each time the USB -printer device is attached. The \fBwrite_timeout\fR period (defined in the -ECPPIOC_SETPARMS ioctl description below) is set to 90 seconds. The mode is set -to centronics mode (ECPP_CENTRONICS). Parameters can be changed through the -ECPPIOC_SETPARMS ioctl and read through the ECPPIOC_GETPARMS ioctl. Each time -the USB printer device is opened, the device is marked as busy and all further -opens will return EBUSY. Once the device is open, applications can write to the -device and the driver can send data and obtain device id and status. -.LP -Note - -.sp -.RS 2 -Unlike the \fBecpp\fR(7D) driver, \fBusbprn\fR resets configuration variables -to their default values with each \fBattach\fR(9E). (The \fBecpp\fR(7D) driver -resets configuration variables with each \fBopen\fR(2).) -.RE -.SH WRITE OPERATION -A \fBwrite\fR(2) operation returns the number of bytes successfully written to -the device. If a failure occurs while a driver is transferring data to printer, -the contents of the status bits are captured at the time of the error and can -be retrieved by the application program using the ECPPIOC_GETERR \fBioctl\fR(2) -call. The captured status information is overwritten each time an -ECPPIOC_TESTIO \fBioctl\fR(2) occurs. -.SH IOCTLS -The \fBusbprn\fR driver supports \fBprnio\fR(7I) interfaces. Note that the -\fBPRNIOC_RESET\fR command has no effect on USB printers. -.sp -.LP -The following \fBioctl\fR(2) calls are supported for backward compatibility and -are not recommended for new applications. -.sp -.ne 2 -.na -\fB\fBECPPIOC_GETPARMS\fR\fR -.ad -.RS 20n -Gets current transfer parameters. The argument is a pointer to \fBstruct -ecpp_transfer_parms\fR. If parameters are not configured after the device is -opened, the structure will be set to its default configuration. -.LP -Note - -.sp -.RS 2 -Unlike the \fBecpp\fR(7D) driver, only the ECPP_CENTRONICS mode is currently -supported in \fBusbprn\fR. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBECPPIOC_SETPARMS\fR\fR -.ad -.RS 20n -Sets transfer parameters. The argument is a pointer to a \fBstruct -ecpp_transfer_parms\fR. If a parameter is out of range, \fBEINVAL\fR is -returned. If the peripheral or host device cannot support the requested mode, -\fBEPROTONOSUPPORT\fR is returned. -.sp -The transfer parameters structure is defined in <\fBsys/ecppio.h\fR>: -.sp -.in +2 -.nf -struct ecpp_transfer_parms { - int write_timeout; - int mode; -}; -.fi -.in -2 - -The \fBwrite_timeout\fR field, which specifies how long the driver will take to -transfer 8192 bytes of data to the device, is set to a default value of 90 -seconds. The \fBwrite_timeout\fR field must be greater than one second and less -than 300 seconds (five minutes.) -.LP -Note - -.sp -.RS 2 -Unlike the \fBecpp\fR(7D) driver, only the ECPP_CENTRONICS mode is currently -supported in \fBusbprn\fR. Also, the semantics of \fBwrite_timeout\fR in -\fBusbprn\fR differ from \fBecpp\fR(7D). Refer to \fBecpp\fR(7D) for -information. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBBPPIOC_TESTIO\fR\fR -.ad -.RS 20n -Tests the transfer readiness of a print device and checks status bits to -determine if a \fBwrite\fR(2) will succeed. If status bits are set, a transfer -will fail. If a transfer will succeed, zero is returned. If a transfer fails, -the driver returns \fBEIO\fR and the state of the status bits are captured. The -captured status can be retrieved using the BPPIOC_GETERR \fBioctl\fR(2) call. -.LP -Note - -.sp -.RS 2 -Unlike the \fBecpp\fR(7D) driver, only the ECPP_CENTRONICS mode is currently -supported in \fBusbprn\fR. Additionally, \fBbus_error\fR and -\fBtimeout_occurred\fR fields are not used in the \fBusbprn\fR interface. (In -\fBecpp\fR(7D), \fBtimeout_occurred\fR is used.) -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBBPPIOC_GETERR\fR\fR -.ad -.RS 20n -Get last error status. The argument is a pointer to a \fBstruct -bpp_error_status\fR. This structure indicates the status of all the appropriate -status bits at the time of the most recent error condition during a -\fBwrite\fR(2) call, or the status of the bits at the most recent BPPIOC_TESTIO -\fBioctl\fR(2) call. -.sp -.in +2 -.nf -struct bpp_error_status { - char timeout_occurred; /* not used */ - char bus_error; /* not used */ - uchar_t pin_status; /* status of pins which - /* could cause error */ -}; -.fi -.in -2 - -The pin_status field indicates possible error conditions. The error status -structure \fBbpp_error_status\fR is defined in the include file -\fB<sys/bpp_io.h>\fR\&. The valid bits for \fBpin_status\fR can be -\fBBPP_ERR_ERR\fR, \fBBPP_SLCT_ERR\fR, and \fBBPP_PE_ERR\fR. A set bit -indicates that the associated pin is asserted. -.LP -Note - -.sp -.RS 2 -Unlike the \fBecpp\fR(7D) driver, only the ECPP_CENTRONICS mode is currently -supported in \fBusbprn\fR. Additionally, the \fBbus_error\fR and -\fBtimeout_occurred\fR fields are not used in the \fBusbprn\fR interface. (In -\fBecpp\fR(7D), \fBtimeout_occurred\fR is used.) Unlike \fBecpp\fR(7D), the -BPP_BUSY_ERR status bit is not supported by USB printers. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBECPPIOC_GETDEVID\fR\fR -.ad -.RS 20n -Gets the IEEE 1284 device ID from the peripheral. The argument is a pointer to -a \fBstruct ecpp_device_id\fR. Applications should set mode to ECPP_CENTRONICS. -If another mode is used, the driver will return \fBEPROTONOSUPPORT\fR. -\fBlen\fR is the length of the buffer pointed to by \fBaddr\fR. \fBrlen\fR is -the actual length of the device ID string returned from the peripheral. If the -returned \fBrlen\fR is greater than \fBlen\fR, the application should call -ECPPIOC_GETDEVID a second time with a buffer length equal to \fBrlen\fR. -.sp -The 1284 device ID structure: -.sp -.in +2 -.nf -struct ecpp_device_id { - int mode; /* mode to use for reading device id */ - int len; /* length of buffer */ - int rlen; /* actual length of device id string */ - char *addr; /* buffer address */ -.fi -.in -2 - -.LP -Note - -.sp -.RS 2 -Unlike \fBecpp\fR(7D), only the ECPP_CENTRONICS mode is currently supported in -\fBusbprn\fR. -.RE -.RE - -.SH READ OPERATION -The \fBread\fR operation is not supported and returns \fBEIO\fR. -.SH ERRORS -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 19n -The device has been opened and another open is attempted. An attempt has been -made to unload the driver while one of the units is open. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 19n -An unsupported IOCTL has been received. A ECPPIOC_SETPARMS \fBioctl\fR(2) is -attempted with an out of range value in the \fBecpp_transfer_parms\fR -structure. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 19n -The driver has received an unrecoverable device error, or the device is not -responding, or the device has stalled when attempting an access. A -\fBwrite\fR(2) or \fBioctl\fR(2) did not complete due to a peripheral access. A -\fBread\fR(2) system call has been issued. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 19n -The driver has received an \fBopen\fR(2) request for a unit for which the -attach failed. -.RE - -.sp -.ne 2 -.na -\fB\fBENODEV\fR\fR -.ad -.RS 19n -The driver has received an \fBopen\fR(2) request for a device that has been -disconnected. -.RE - -.sp -.ne 2 -.na -\fB\fBEPROTONOSUPPORT\fR\fR -.ad -.RS 19n -The driver has received a ECPPIOC_SETPARMS \fBioctl\fR(2) for a mode argument -other than ECPP_CENTRONICS in the \fBecpp_transfer_parms\fR structure. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/usbprn\fR\fR -.ad -.RS 30n -32-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usbprn\fR\fR -.ad -.RS 30n -64-bit x86 ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usbprn\fR\fR -.ad -.RS 30n -64-bit SPARC ELF kernel module -.RE - -.sp -.ne 2 -.na -\fB/dev/usb/*/*/* \fR -.ad -.RS 30n -ugen(7D) nodes. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/printers/\fIn\fR\fR\fR -.ad -.RS 30n -Character special files -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -\fBcfgadm_usb\fR(1M), \fBprintmgr\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), -\fBread\fR(2), \fBwrite\fR(2), \fBattributes\fR(5), -\fBecpp\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D), \fBprnio\fR(7I), -\fBattach\fR(9E) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Serial Bus Specification 1.0 and 1.1\fR -.sp -.LP -\fIUSB Device Class Definition for Printing Devices 1.0\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH DIAGNOSTICS -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -Warning: <device path> (usbprn<instance num>): Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBDevice was disconnected while open. Data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The device has been hot-removed or powered off while it was open and a possible -data transfer was in progress. The job may be aborted. -.RE - -.sp -.ne 2 -.na -\fBCannot access <device>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -There was an error in accessing the printer during reconnect. Please reconnect -the device. -.RE - -.sp -.ne 2 -.na -\fBDevice is not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -A USB printer was hot-removed while open. A new device was hot-inserted which -is not identical to the original USB printer. Please disconnect the USB device -and reconnect the printer to the same port. -.RE - -.sp -.ne 2 -.na -\fBPrinter has been reconnected but data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The printer that was hot-removed from its USB port has been re-inserted again -to the same port. It is available for access but the job that was running prior -to the hot-removal may be lost. -.RE - -.SH NOTES -The USB printer will be power managed if the device is closed. -.sp -.LP -If a printer is hot-removed before a job completes, the job is terminated and -the driver will return EIO. All subsequent opens will return \fBENODEV\fR. If a -printer is hot-removed, an LP reconfiguration may not be needed if a printer is -re-inserted on the same port. If re-inserted on a different port, an LP -reconfiguration may be required. -.sp -.LP -The USB Parallel Printer Adapter is not hotpluggable. The printer should be -connected to USB Parallel Printer Adapter before plugging the USB cable into -host or hub port and should be removed only after disconnecting the USB cable -of USB Parallel Printer Adapter from the host or hub port. diff --git a/usr/src/man/man7d/usbsacm.7d b/usr/src/man/man7d/usbsacm.7d deleted file mode 100644 index ac478e5c21..0000000000 --- a/usr/src/man/man7d/usbsacm.7d +++ /dev/null @@ -1,292 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 USBSACM 7D "Aug 13, 2021" -.SH NAME -usbsacm \- USB communication device class ACM driver -.SH SYNOPSIS -.LP -.nf -#include <sys/termio.h> - -usbsacm@unit -.fi - -.LP -.nf - -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBusbsacm\fR driver is a loadable STREAMS and USBA (Solaris USB -architecture)-compliant client driver that provides basic asynchronous -communication support for USB modems and ISDN terminal adapters that conform to -the \fIUniversal Serial Bus Communication Device Class Abstract Control Model -(USB CDC ACM)\fR specification. You can download the \fIUSB CDC\fR -specification from the USB website at -\fIhttp://www.usb.org/developers/devclass_docs/usbcdc11.pdf\fR. Supported -devices include mobile phones and PCMCIA cards which provide modem function by -the usb cable. Serial device streams are built with appropriate modules that -are pushed atop the usbsacm driver by the \fBautopush\fR(1M) facility. -.sp -.LP -The \fBusbsacm\fR module supports the \fBtermio\fR(7I) device control functions -specified by flags in the c_cflag word of termios structure, and by the IGNBRK, -IGNPAR, PARMRK and INPCK flags in the c_iflag word of the termios structure. -All other \fBtermio\fR(7I) functions must be performed by STREAMS modules -pushed atop the driver. When a device is opened, the \fBldterm\fR(7M) and -\fBttcompat\fR(7M) STREAMS modules are automatically pushed on top of the -stream, providing the standard \fBtermio\fR(7I) interface. -.sp -.LP -You use device logical names /dev/term/[\fI0-9\fR]* to access the serial ports. -These names are typically used to provide a logical access point for a dial-in -line that is used with a modem. You can use \fBpppd\fR(1M) to transmit -datagrams over these serial ports. -.sp -.LP -A special feature (controlled by the minor device number) is available that -enables a single tty line to be connected to a modem and used for incoming and -outgoing calls. By accessing through device logical name /dev/cua/[\fI0-9\fR]*, -you can open a port without the carrier detect signal being asserted, either -through hardware or an equivalent software mechanism. These devices are -commonly known as 'dial-out' lines. -.sp -.LP -Unlike onboard serial ports, the \fBusbsacm\fR ports cannot serve as a local -serial console. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -A dial-in line can be opened only if the corresponding dial-out line is -closed. A blocking /dev/term open waits until the /dev/cua line is closed -(which drops Data Terminal Ready, after which Carrier Detect usually drops as -well) and carrier is detected again. A non-blocking /dev/term open returns an -error if the /dev/cua is open. -.sp -.LP -If the /dev/term line is opened successfully (usually only when carrier is -recognized on the modem), the corresponding /dev/cua line cannot be -opened. This allows a modem and port to be used for dial-in (by enabling the -line for login in \fB/etc/inittab\fR) or dial-out (by \fBtip\fR(1) or -\fBuucp\fR(1C)) as \fB/dev/cua0\fR when no one is logged in on the line. -.sp -.LP -Device hot-removal is functionally equivalent to a modem disconnect event, as -defined in \fBtermio\fR(7I). -.SH IOCTLS -.sp -.LP -The \fBusbsacm\fR driver supports the standard set of \fBtermio\fR(7I) ioctl -calls. -.sp -.LP -The input and output line speeds may be set to any of the following baud rates: -75, 150, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, -230400, 460800, 921600, 1000000, 1152000, 1500000, 2000000, 2500000, 3000000, -3500000, or 4000000. The speeds cannot be set independently. For example, when -the output speed is set, the input speed is automatically set to the same -speed. -.SH ERRORS -.sp -.LP -An \fBopen()\fR fails under the following conditions: -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 9n -The unit being opened does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The /dev/cua (dial-out) device is being opened while the /dev/term (dial-in -device) is open, or the dial-in device is being opened with a no-delay open -while the dial-out device is open. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The unit has been marked as exclusive-use by another process with a -\fBTIOCEXCL\fR \fBioctl()\fR call. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 9n -USB device I/O error. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/usbsacm\fR\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usbsacm\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usbsacm\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/cua/[0-9]\fR\fR -.ad -.sp .6 -.RS 4n -dial-out tty lines -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/term/[0-9]\fR\fR -.ad -.sp .6 -.RS 4n -dial-in tty lines -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 PCI-based systems -.TE - -.SH SEE ALSO -.sp -.LP -\fBstrconf\fR(1), \fBtip\fR(1), \fBuucp\fR(1C), \fBautopush\fR(1M), -\fBpppd\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), \fBtermios\fR(3C), -\fBattributes\fR(5), \fBusba\fR(7D), \fBtermio\fR(7I), \fBldterm\fR(7M), -\fBttcompat\fR(7M) -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -Warning: <device path> (usbsacm<instance num>):Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBDevice was disconnected while open. Data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The device has been hot-removed or powered off while it was open and a possible -data transfer was in progress. The job may be aborted. -.RE - -.sp -.ne 2 -.na -\fBDevice is not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -The device was hot-removed while open. A new device was hot-inserted which is -not identical to the original device. Please disconnect the device and -reconnect the original device to the same port. -.RE - -.sp -.ne 2 -.na -\fBDevice has been reconnected, but data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The device that was hot-removed from its USB port has been re-inserted again -to the same port. It is available for access but data from a previous transfer -may be lost. -.RE - -.sp -.ne 2 -.na -\fBCannot access <device>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -This device has been disconnected because a device other than the original one -has been inserted. The driver informs you of this fact by displaying the name -of the original device. -.RE - -.sp -.LP -The following messages may be logged into the system log. They are formatted in -the following manner: -.sp -.in +2 -.nf -<device path><usbsacm<instance number>): message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBInput overrun.\fR -.ad -.RS 18n -Data was lost. -.RE - diff --git a/usr/src/man/man7d/usbsksp.7d b/usr/src/man/man7d/usbsksp.7d deleted file mode 100644 index c0a946ae97..0000000000 --- a/usr/src/man/man7d/usbsksp.7d +++ /dev/null @@ -1,299 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 USBSKSP 7D "May 13, 2017" -.SH NAME -usbsksp \- Keyspan USB to serial converter driver -.SH SYNOPSIS -.LP -.nf -#include <fcntl.h> -.fi - -.LP -.nf -#include <sys/termio.h> -.fi - -.LP -.nf -usbskpsp@unit -.fi - -.SH DESCRIPTION -.LP -The \fBusbsksp\fR driver is a loadable \fBSTREAMS\fR and \fBUSBA\fR (Solaris -USB architecture) compliant client driver that provides basic asynchronous -communication support for Keyspan USB-to-serial converters. The \fBusbsksp\fR -driver supports the Keyspan USA19HS, USA49WG and USA49WLC models. By default, -the USA19HS and USA49WG models are compatible with the \fBusbsksp\fR driver and -no configuration or installation steps are required. (The USA49WG model is a -USB 2.0 device conforming to \fIUniversal Serial Bus Specification 2.0\fR and -the USB 2.0 host controller is required to support the USA49WG model. Note that -the USA49WG is not compatible with USB 1.1 host controllers). The Keyspan -USA49WLC model requires a firmware package that is no longer publicly available. -Serial device streams are built with appropriate modules that are pushed atop -the \fBusbsksp\fR driver by the \fBautopush\fR(1M) facility. -.sp -.LP -The \fBusbsksp\fR module supports the \fBtermio\fR(7I) device control functions -specified by flags in the \fBc_cflag\fR word of the termios structure, and by -the IGNBRK, IGNPAR, PARMRK and INPCK flags in the \fBc_iflag\fR word of the -termios structure. All other \fBtermio\fR(7I) functions must be performed by -\fBSTREAMS\fR modules pushed atop the driver. When a device is opened, the -\fBldterm\fR(7M) and \fBttcompat\fR(7M) \fBSTREAMS\fR modules are -automatically pushed on top of the stream, providing the standard -\fBtermio\fR(7I) interface. -.sp -.LP -Use device logical names \fB/dev/term/[0-9]\fR* to access the serial ports. -These names are typically used to provide a logical access point for a dial-in -line that is used with a modem. -.sp -.LP -A special feature (controlled by the minor device number) is available that -enables a single tty line to be connected to a modem and used for incoming and -outgoing calls. By accessing through device logical name \fB/dev/cua/[0-9]\fR*, -you can open a port without the carrier detect signal being asserted, either -through hardware or an equivalent software mechanism. These devices are -commonly known as 'dial-out' lines. -.sp -.LP -Unlike onboard serial ports, the \fBusbsksp\fR ports cannot serve as a local -serial console. -.SH APPLICATION PROGRAMMING INTERFACE -.LP -A dial-in line can be opened only if the corresponding dial-out line is closed. -A blocking \fB/dev/term\fR open waits until the \fB/dev/cua\fR line is closed -(which drops Data Terminal Ready, after which Carrier Detect usually drops as -well) and carrier is detected again. A non-blocking \fB/dev/term\fR open -returns an error if the \fB/dev/cua\fR is open. -.sp -.LP -If the \fB/dev/term\fR line is opened successfully (usually only when -carrier is recognized on the modem), the corresponding \fB/dev/cua\fR line -cannot be opened. This allows a modem and port to be used for dial-in (by -enabling the line for login in \fB/etc/inittab\fR) or dial-out (by -\fBtip\fR(1), or \fBuucp\fR(1C)) when no one is logged in on the line. -.sp -.LP -Device hot-removal is functionally equivalent to a modem disconnect event, as -defined in \fBtermio\fR(7I). -.SH IOCTLS -.LP -The \fBusbsksp\fR driver supports the standard set of \fBtermio\fR(7I) ioctl -calls. -.sp -.LP -Input and output line speeds can be set to the following baud rates: 0, 50, -75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, -57600, 115200, or 230400. Input and output line speeds cannot be set -independently. For example, when the output speed is set, the input speed is -automatically set to the same speed. -.SH ERRORS -.LP -An \fBopen()\fR fails under the following conditions: -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 9n -The unit being opened does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The \fB/dev/cua\fR (dial-out) device is being opened while the \fB/dev/term\fR -(dial-in device) is open, or the dial-in device is being opened with a no-delay -open while the dial-out device is open. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The unit has been marked as exclusive-use by another process with a TIOCEXCL -ioctl() call. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 9n -USB device I/O error. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/usbsksp\fR\fR -.ad -.sp .6 -.RS 4n -32-bit x86 ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usbsksp\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usbsksp\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/cua/[0-9]*\fR\fR -.ad -.sp .6 -.RS 4n -dial-out tty lines. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/term/[0-9]*\fR\fR -.ad -.sp .6 -.RS 4n -dial-in tty lines. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBstrconf\fR(1), \fBtip\fR(1), \fBuucp\fR(1C), \fBautopush\fR(1M), -\fBioctl\fR(2), \fBopen\fR(2), \fBtermios\fR(3C), \fBattributes\fR(5), -\fBusba\fR(7D), \fBtermio\fR(7I), \fBldterm\fR(7M), \fBttcompat\fR(7M) -.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 -.in +2 -.nf -Warning: <device path> (usbsksp<instance num>): Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBDevice was disconnected while open. Data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The device has been hot-removed or powered off while it was open and a possible -data transfer was in progress. The job may be aborted. -.RE - -.sp -.ne 2 -.na -\fBDevice is not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -The device was hot-removed while open. A new device was hot-inserted which is -not identical to the original device. Please disconnect the device and -reconnect the original device to the same port. -.RE - -.sp -.ne 2 -.na -\fBDevice has been reconnected, but data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The device that was hot-removed from its USB port has been re-inserted again to -the same port. It is available for access but data from a previous transfer -may be lost. -.RE - -.sp -.ne 2 -.na -\fBCannot access <\fR\fIdevice\fR\fB>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -This device has been disconnected because a device other than the original one -has been inserted. The driver informs you of this fact by displaying the name -of the original device. -.RE - -.sp -.ne 2 -.na -\fBNo valid firmware available for Keyspan usa49wlc usb-to-serial adapter. -Please download it from Keyspan website and install it.\fR -.ad -.sp .6 -.RS 4n -By default, only an empty firmware package is installed for the usa49wlc model. -You will need to obtain a copy of the SUNWukspfw package and install it. -.RE - -.sp -.LP -The following messages may be logged into the system log. They are formatted in -the following manner: -.sp -.in +2 -.nf -<device path><usbsksp<instance number>): message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBInput overrun\fR -.ad -.RS 17n -Data was lost. -.RE - diff --git a/usr/src/man/man7d/usbsprl.7d b/usr/src/man/man7d/usbsprl.7d deleted file mode 100644 index 6b66182f79..0000000000 --- a/usr/src/man/man7d/usbsprl.7d +++ /dev/null @@ -1,286 +0,0 @@ -'\" te -.\" Copyright (c) 2006, 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 USBSPRL 7D "Nov 23, 2006" -.SH NAME -usbsprl \- Prolific PL2303 USB to serial converter driver -.SH SYNOPSIS -.LP -.nf -#include <fcntl.h> -.fi - -.LP -.nf -#include <sys/termio.h> -.fi - -.LP -.nf -usbsprl@unit -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBusbsprl\fR driver is a loadable \fBSTREAMS\fR and \fBUSBA\fR (Solaris -USB architecture) compliant client driver that provides basic asynchronous -communication support for Prolific PL2303 USB-to-serial converters. Supported -devices include PL2303H, PL2303HX and PL2303X. Serial device streams are built -with appropriate modules that are pushed atop the \fBusbsprl\fR driver by the -\fBautopush\fR(1M) facility. -.sp -.LP -The \fBusbsprl\fR module supports the \fBtermio\fR(7I) device control functions -specified by flags in the \fBc_cflag\fR word of the termios structure, and by -the IGNBRK, IGNPAR, PARMRK and INPCK flags in the \fBc_iflag\fR word of the -termios structure. All other \fBtermio\fR(7I) functions must be performed by -\fBSTREAMS\fR modules pushed atop the driver. When a device is opened, the -\fBldterm\fR(7M) and \fBttcompat\fR(7M) \fBSTREAMS\fR modules are -automatically pushed on top of the stream, providing the standard -\fBtermio\fR(7I) interface. -.sp -.LP -Use device logical names \fB/dev/term/[0-9]\fR* to access the serial ports. -These names are typically used to provide a logical access point for a dial-in -line that is used with a modem. -.sp -.LP -A special feature (controlled by the minor device number) is available that -enables a single tty line to be connected to a modem and used for incoming and -outgoing calls. By accessing through device logical name \fB/dev/cua/[0-9]\fR*, -you can open a port without the carrier detect signal being asserted, either -through hardware or an equivalent software mechanism. These devices are -commonly known as 'dial-out' lines. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -A dial-in line can be opened only if the corresponding dial-out line is closed. -A blocking \fB/dev/term\fR open waits until the \fB/dev/cua\fR line is closed -(which drops Data Terminal Ready, after which Carrier Detect usually drops as -well) and carrier is detected again. A non-blocking \fB/dev/term\fR open -returns an error if the \fB/dev/cua\fR is open. -.sp -.LP -If the \fB/dev/term\fR line is opened successfully (usually only when -carrier is recognized on the modem), the corresponding \fB/dev/cua\fR line -cannot be opened. This allows a modem and port to be used for dial-in (by -enabling the line for login in \fB/etc/inittab\fR) or dial-out (by -\fBtip\fR(1), or \fBuucp\fR(1C)) when no one is logged in on the line. -.sp -.LP -Device hot-removal is functionally equivalent to a modem disconnect event, as -defined in \fBtermio\fR(7I). -.SH IOCTLS -.sp -.LP -The \fBusbsprl\fR driver supports the standard set of \fBtermio\fR(7I) ioctl -calls. -.sp -.LP -Input and output line speeds can be set to the following baud rates: 75, 150, -300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400 or -460800. Input and output line speeds cannot be set independently. For example, -when the output speed is set, the input speed is automatically set to the same -speed. -.SH ERRORS -.sp -.LP -An \fBopen()\fR fails under the following conditions: -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 9n -The unit being opened does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The \fB/dev/cua\fR (dial-out) device is being opened while the \fB/dev/term\fR -(dial-in device) is open, or the dial-in device is being opened with a no-delay -open while the dial-out device is open. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The unit has been marked as exclusive-use by another process with a TIOCEXCL -ioctl() call. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 9n -USB device I/O error. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/kernel/drv/usbsprl\fR\fR -.ad -.sp .6 -.RS 4n -32-bit x86 ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usbsprl\fR\fR -.ad -.sp .6 -.RS 4n -64-bit x86 ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usbsprl\fR\fR -.ad -.sp .6 -.RS 4n -64-bit SPARC ELF kernel module. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/cua/[0-9]*\fR\fR -.ad -.sp .6 -.RS 4n -dial-out tty lines. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/term/[0-9]*\fR\fR -.ad -.sp .6 -.RS 4n -dial-in tty lines. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -.sp -.LP -\fBstrconf\fR(1), \fBtip\fR(1), \fBuucp\fR(1C), \fBautopush\fR(1M), -\fBioctl\fR(2), \fBopen\fR(2), \fBtermios\fR(3C), \fBattributes\fR(5), -\fBusba\fR(7D), \fBtermio\fR(7I), \fBldterm\fR(7M), \fBttcompat\fR(7M) -.SH DIAGNOSTICS -.sp -.LP -In addition to being logged, the following messages may appear on the system -console. All messages are formatted in the following manner: -.sp -.in +2 -.nf -Warning: <device path> (usbsprl<instance num>): Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBDevice was disconnected while open. Data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The device has been hot-removed or powered off while it was open and a possible -data transfer was in progress. The job may be aborted. -.RE - -.sp -.ne 2 -.na -\fBDevice is not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -The device was hot-removed while open. A new device was hot-inserted which is -not identical to the original device. Please disconnect the device and -reconnect the original device to the same port. -.RE - -.sp -.ne 2 -.na -\fBDevice has been reconnected, but data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The device that was hot-removed from its USB port has been re-inserted again to -the same port. It is available for access but data from a previou transfer may -be lost. -.RE - -.sp -.ne 2 -.na -\fBCannot access <\fR\fIdevice\fR\fB>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -This device has been disconnected because a device other than the original one -has been inserted. The driver informs you of this fact by displaying the name -of the original device. -.RE - -.sp -.LP -The following messages may be logged into the system log. They are formatted in -the following manner: -.sp -.in +2 -.nf -<device path><usbsprl<instance number>): message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBInput overrun.\fR -.ad -.sp .6 -.RS 4n -Data was lost. -.RE - diff --git a/usr/src/man/man7d/usbvc.7d b/usr/src/man/man7d/usbvc.7d deleted file mode 100644 index 9fe2bd332b..0000000000 --- a/usr/src/man/man7d/usbvc.7d +++ /dev/null @@ -1,456 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 USBVC 7D "May 13, 2017" -.SH NAME -usbvc \- USB video class driver -.SH SYNOPSIS -.LP -.nf -#include <sys/usb/clients/video/usbvc/usbvc.h> - -#include <sys/videodev2.h> - -usbvc@unit-address -.fi - -.LP -.nf - -.fi - -.SH DESCRIPTION -.LP -The \fBusbvc\fR driver is a USBA (Solaris USB Architecture)-compliant client -driver that supports the \fIUSB Device Class Definition for Video Devices\fR -specification, Versions 1.0 and 1.1. The \fBusbvc\fR driver supports a subset -of the video controls and formats described in the USB specification. -.sp -.LP -The \fBusbvc\fR driver also implements the Video4Linux2 API (\fIV4L2\fR), -Version 0.20 for applications. For more information on the \fIV4L2 API\fR, -visit \fIhttp://www.thedirks.org/v4l2\fR. -.sp -.LP -Note that the \fBusbvc\fR driver supports the video capture function only and -that video output is not supported. -.SH READING DATA -.LP -The \fBusbvc\fR driver reads video data from the isochronous endpoint of the -device. Bulk data endpoints are not supported. -.sp -.LP -MJPEG and UNCOMPRESSED video formats are supported. Isochronous data are read -from the isochronous input device frame-by-frame and are maintained in a -buffer array within the driver. Video frames are read from the driver using the -\fBread\fR(2) or \fBmmap\fR(2) I/O method. For \fBread\fR(2), each read returns -a buffer of a video frame. For \fBmmap\fR(2), each \fBVIDIOC_DQBUF\fR ioctl -returns the buffer structure v4l2_buffer. (A video frame buffer pointer is -included in the structure). See the \fIV4L2 API\fR for buffer structure and -other related data structure information. -.SH IOCTLS -.LP -A brief overview of supported ioctl requests appears below. For more detailed -information, refer to the \fIV4L2 API\fR document. Note: ioctl information -presented in the \fIV4L2 API\fR document may differ slightly from the content -of this manpage. In such cases, you should rely on the information in this -manpage. -.sp -.ne 2 -.na -\fBVIDIOC_QUERYCAP\fR -.ad -.sp .6 -.RS 4n -Query the device capabilities. Besides device capabilities, the \fBusbvc\fR -driver returns structure v4l2_capability which includes information on the -driver, data bus and OS kernel. Please note that the "Version" structure member -has no meaning in Solaris and is always set to 1. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_ENUM_FMT\fR -.ad -.sp .6 -.RS 4n -Enumerate the video formats supported by the device. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_S_FMT\fR -.ad -.sp .6 -.RS 4n -Set a video format. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_G_FMT\fR -.ad -.sp .6 -.RS 4n -Get a video format. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_REQBUFS\fR -.ad -.sp .6 -.RS 4n -Request the \fBusbvc\fR driver to allocate video data buffers. If a buffer is -set to zero, the driver stops reading video data from the device and releases -all allocated buffers. (For \fBmmap\fR(2) only). -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_QUERYBUF\fR -.ad -.sp .6 -.RS 4n -Query a given buffer's status. (For \fBmmap\fR(2) only). -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_QBUF\fR -.ad -.sp .6 -.RS 4n -Enqueue an empty buffer to the video data buffer array. (For \fBmmap\fR(2) -only). -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_DQBUF\fR -.ad -.sp .6 -.RS 4n -Dequeue a done buffer from the video data buffer array. (For \fBmmap\fR(2) -only). -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_STREAMON\fR -.ad -.sp .6 -.RS 4n -Start reading video data. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_STREAMOFF\fR -.ad -.sp .6 -.RS 4n -Stop reading video data. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_ENUMINPUT\fR -.ad -.sp .6 -.RS 4n -Enumerate all device inputs. Currently, the \fBusbvc\fR driver supports one -input only. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_G_INPUT\fR -.ad -.sp .6 -.RS 4n -Get the device's current input. At this time, the \fBusbvc\fR driver supports -one input only. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_S_INPUT\fR -.ad -.sp .6 -.RS 4n -Set the device's current input. At this time, the \fBusbvc\fR driver supports -one input only. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_QUERYCTRL\fR -.ad -.sp .6 -.RS 4n -Query the device and driver for supported video controls. Currently, the -\fBusbvc\fR driver supports the brightness, contrast, saturation, hue, and -gamma video controls. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_G_CTRL\fR -.ad -.sp .6 -.RS 4n -Get the device's current video control. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_S_CTRL\fR -.ad -.sp .6 -.RS 4n -Set the device's current video control. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_G_PARM\fR -.ad -.sp .6 -.RS 4n -Get streaming parameters, the number of frames per second and number of buffers -used internally by driver in read/write mode. -.RE - -.sp -.ne 2 -.na -\fBVIDIOC_S_PARM\fR -.ad -.sp .6 -.RS 4n -Set streaming parameters, the number of frames per second and number of buffers -used internally by driver in read/write mode. -.RE - -.SH ERRORS -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 10n -An open was attempted after the device has already been opened. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -An unsupported ioctl is received or an ioctl is attempted with an out-of-range -value. -.RE - -.sp -.ne 2 -.na -\fB\fBEIO\fR\fR -.ad -.RS 10n -The driver received an unrecoverable device error or the device did not -respond or the device stalled when attempting an access. A \fBread\fR(2) or -\fBioctl\fR(2) did not complete due to a peripheral access. -.RE - -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 10n -The driver received an \fBopen\fR(2) request for a device for which the attach -failed. -.RE - -.sp -.ne 2 -.na -\fBENODEV\fR -.ad -.RS 10n -The driver received an \fBopen\fR(2) request for a disconnected device. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/kernel/drv/usbvc\fR\fR -.ad -.sp .6 -.RS 4n -32-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/usbvc\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/usbvc\fR\fR -.ad -.sp .6 -.RS 4n -64-bit ELF kernel module. (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/usb/*/*/*\fR\fR -.ad -.sp .6 -.RS 4n -\fBugen\fR(7D) nodes. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/videoN\fR\fR -.ad -.sp .6 -.RS 4n -Device node for isochronous input from USB video device and device control. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86, PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBcfgadm_usb\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), \fBmmap\fR(2), -\fBread\fR(2), \fBattributes\fR(5), \fBugen\fR(7D), -\fBusba\fR(7D), \fBattach\fR(9E) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.sp -.LP -\fIUniversal Serial Bus Specification 1.0, 1.1 and 2.0\fR\(em 1996, 1998, 2000 -.sp -.LP -\fIUSB Device Class Definition for Video Devices 1.0 and 1.1\fR\(em 2003, 2005 -.sp -.LP -\fIVideo4Linux2 API (V4L2), Version 0.20\fR -.sp -.LP -\fIhttp://www.usb.org\fR -.sp -.LP -\fIhttp://www.thedirks.org/v4l2\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 -.in +2 -.nf -Warning: <device path> (usbvc<instance num>):Error Message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBDevice was disconnected while open. Data may have been lost.\fR -.ad -.sp .6 -.RS 4n -The device has been hot-removed or powered off while it was open and a possible -data transfer was in progress. The job may be aborted. -.RE - -.sp -.ne 2 -.na -\fBCannot access <device>. Please reconnect.\fR -.ad -.sp .6 -.RS 4n -This device has been disconnected because a device other than the original one -has been inserted. The driver informs you of this fact by displaying the name -of the original device. -.RE - -.sp -.ne 2 -.na -\fBDevice is not identical to the previous one on this port. Please disconnect -and reconnect.\fR -.ad -.sp .6 -.RS 4n -The device was hot-removed while open. A new device was hot-inserted which is -not identical to the original device. Please disconnect the device and -reconnect the original device to the same port. -.RE - -.SH NOTES -.LP -The USB video device will be power-managed when the device is idle. -.sp -.LP -If a USB video device is hot-removed while active, a console warning is -displayed requesting you to put the device back in the same port and telling -you of potential data loss. Hot-removal of an active video device is strongly -discouraged. -.sp -.LP -Always close all applications before hot-removing or hot-inserting a device. -If an application is open when a device is hot-removed, inserting the device -in a different port will create new \fB/dev/video\fR\fIN\fR links. Moving -an active device to another port is not recommended. diff --git a/usr/src/man/man7d/usmn.7d b/usr/src/man/man7d/usmn.7d deleted file mode 100644 index 97655c0c79..0000000000 --- a/usr/src/man/man7d/usmn.7d +++ /dev/null @@ -1,42 +0,0 @@ -.\" -.\" 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 2021 Oxide Computer Company -.\" -.Dd July 30, 2021 -.Dt USMN 7D -.Os -.Sh NAME -.Nm usmn -.Nd AMD SMN user access driver -.Sh SYNOPSIS -.Pa /devices/pseudo/amdzen@0/usmn@2:usmn.* -.Sh DESCRIPTION -The -.Nm -driver provides the ability to read and write data from the AMD System -Management Network -.Pq SMN -on AMD Family 17h -.Pq Zen, Zen+, and Zen 2 -and AMD Family 19h -.Pq Zen 3 -processors. -.Pp -This driver is intended strictly for facilitating platform development -and is not recommended for systems that aren't doing kernel and platform -development on AMD Zen platforms. -Arbitrary writes to the SMN can severely damage and destabilize the system. -If you do not need access to the SMN, then this driver should not be -present on the system. -.Sh SEE ALSO -.Xr amdzen 7D , -.Xr zen_udf 7D diff --git a/usr/src/man/man7d/vioblk.7d b/usr/src/man/man7d/vioblk.7d deleted file mode 100644 index 26c45507bb..0000000000 --- a/usr/src/man/man7d/vioblk.7d +++ /dev/null @@ -1,92 +0,0 @@ -.\" -.\" 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 2020 Oxide Computer Company -.\" -.Dd August 28, 2021 -.Dt VIOBLK 7D -.Os -.Sh NAME -.Nm vioblk -.Nd virtio block device -.Sh SYNOPSIS -.Pa /dev/dsk/cXt0d0 -.Pa /dev/rdsk/cXt0d0 -.Sh DESCRIPTION -The -.Nm -driver is a -.Xr blkdev 7D -based device that supports the virtio para-virtualization block device -specification which is commonly used by many hypervisors and emulators. -The device supports what the specification calls the more commonly found -.Sq legacy -interface for devices. -.Pp -The driver supports the following features, if offered by the device: -.Bl -dash -.It -Volatile write-cache -.It -Discarding unused sectors -.Pq ala TRIM, UNMAP -.It -Read-only device support -.It -Physical block sizes that are distinct from logical 512-byte blocks -.It -Synthesized disk geometry -.El -.Sh APPLICATION PROGRAMMING INTERFACE -For each device instance, a -.Xr blkdev 7D -instance is created and treated as an independent controller with a -single device, meaning that the -.Em cX -part of -.Em cXt0d0 -will vary for each device. -Because the driver leverages the -.Xr blkdev 7D -framework, most standard disk manipulation utilities will function such -as -.Xr diskinfo 1M -for discovering devices, -.Xr format 1M -for manipulating partition tables, -.Xr iostat 1M -for seeing device I/O statistics, and a subset of the -.Xr dkio 7I -ioctl requests to retrieve information about the device. -.Sh ARCHITECTURE -The -.Nm -driver is only supported on -.Sy x86 . -.Sh FILES -.Bl -tag -width Pa -.It Pa /dev/dsk/cXt0d0 -Block device minor node. -.It Pa /dev/rdsk/cXt0d0 -Character device minor node. -.It Pa /kernel/drv/amd64/vioblk -x86 device driver. -.El -.Sh SEE ALSO -.Xr diskinfo 1M , -.Xr blkdev 7D , -.Xr virtio 7D , -.Xr dkio 7I -.Rs -.%T Virtual I/O Device (VIRTIO) Version 1.1 -.%D April, 2019 -.%U https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html -.Re diff --git a/usr/src/man/man7d/vioif.7d b/usr/src/man/man7d/vioif.7d deleted file mode 100644 index b2302cf36c..0000000000 --- a/usr/src/man/man7d/vioif.7d +++ /dev/null @@ -1,91 +0,0 @@ -.\" -.\" 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 2020 Oxide Computer Company -.\" -.Dd October 3, 2020 -.Dt VIOIF 7D -.Os -.Sh NAME -.Nm vioif -.Nd Virtio Networking Driver -.Sh SYNOPSIS -.Pa /dev/net/vioif* -.Sh DESCRIPTION -The -.Nm -driver is a GLDv3 NIC driver that supports the virtio para-virtualization -specification which is commonly used by many hypervisors and emulators. -The device supports what the specification calls the more commonly found -.Sq legacy -interface for devices. -.Pp -The driver supports the following networking features, if offered by the -device: -.Bl -dash -.It -Jumbo frames up to 65535 bytes -.It -Transmit and receive TCP and UDP checksum offload -.It -IPv4 and IPv6 TCP segmentation offload -.El -.Sh APPLICATION PROGRAMMING INTERFACE -For each supported device instance, which corresponds to a port, a -character-special file is created. -This device can be used with the Data Link Provider Interface -.Pq DLPI -through either -.Xr libdlpi 3LIB -or -.Xr dlpi 7P . -.Pp -Each instance is assigned a unique ascending integer identifier starting -from zero. -The first instance in the system would be enumerated with the id 0 and -be named -.Sy vioif0 -and be found in the file system at -.Pa /dev/net/vioif0 . -.Sh CONFIGURATION -The networking devices created by the -.Nm -driver can be controlled through -.Xr dladm 1M . -There is no -.Xr driver.conf 4 -file for -.Nm -currently. -.Sh ARCHITECTURE -The -.Nm -driver is only supported on -.Sy x86 . -.Sh FILES -.Bl -tag -width Pa -.It Pa /dev/net/vioif* -.Nm -special character device. -.It Pa /kernel/drv/amd64/vioif -x86 device driver. -.El -.Sh SEE ALSO -.Xr dladm 1M , -.Xr libdlpi 3LIB , -.Xr virtio 7D , -.Xr dlpi 7P , -.Xr mac 9E -.Rs -.%T Virtual I/O Device (VIRTIO) Version 1.1 -.%D April, 2019 -.%U https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html -.Re diff --git a/usr/src/man/man7d/virtio.7d b/usr/src/man/man7d/virtio.7d deleted file mode 100644 index f5751f4fa7..0000000000 --- a/usr/src/man/man7d/virtio.7d +++ /dev/null @@ -1,47 +0,0 @@ -.\" -.\" 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 2020 Oxide Computer Company -.\" -.Dd October 3, 2020 -.Dt VIRTIO 7D -.Os -.Sh NAME -.Nm virtio -.Nd virtio framework driver -.Sh DESCRIPTION -The -.Nm -driver provides a framework for other device drivers that implement -specific types of virtio devices -.Pq network, block, etc. . -The driver takes care of feature negotiation, virtqueue management, -used and available rings, interrupts, and more. -The driver provides support for both direct and indirect descriptors -inside of virtqueues. -.Sh ARCHITECTURE -The -.Nm -driver is only supported on -.Sy x86 . -.Sh FILES -.Bl -tag -width Pa -.It Pa /kernel/drv/amd64/virtio -x86 device driver. -.El -.Sh SEE ALSO -.Xr vioblk 7D , -.Xr vioif 7D -.Rs -.%T Virtual I/O Device (VIRTIO) Version 1.1 -.%D April, 2019 -.%U https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html -.Re diff --git a/usr/src/man/man7d/virtualkm.7d b/usr/src/man/man7d/virtualkm.7d deleted file mode 100644 index f5eb32a428..0000000000 --- a/usr/src/man/man7d/virtualkm.7d +++ /dev/null @@ -1,279 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems 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 VIRTUALKM 7D "May 13, 2017" -.SH NAME -virtualkm \- Virtual keyboard and mouse -.SH SYNOPSIS -.LP -.nf -\fB/dev/kbd\fR -.fi - -.LP -.nf -\fB/dev/mouse\fR -.fi - -.LP -.nf -\fB#include <sys/types.h>\fR -.fi - -.LP -.nf -\fB#include <sys/kbio.h>\fR -.fi - -.LP -.nf -\fBint ioctl(int fildes, int command, ... /*arg*/);\fR -.fi - -.SH DESCRIPTION -.LP -A virtual keyboard or mouse is an abstraction of one or more physical keyboards -or mice (USB or PS2) connected to a system. Input streams for these physical -devices are coalesced into a single input stream and appear as a single device -to the upper layers. -.sp -.LP -\fB/dev/kbd\fR is the virtual keyboard device file. Inputs from multiple -keyboards are coalesced into a single input stream, meaning that all keyboards -appear as a single keyboard to a console or window system and accordingly, are -treated as a single device. The virtual keyboard layout is consistent with the -layout of the first keyboard plugged into the system. Note that on x86 -platforms, the virtual keyboard layout can be overloaded by \fBeeprom\fR(1M). -.sp -.LP -\fB/dev/mouse\fR is the virtual mouse device file. Inputs from multiple mice -are coalesced into a single input stream, meaning that all mice appear as -single mouse to the window system. -.sp -.LP -Commands from applications are dispatched by the virtual keyboard/mouse -facility to the underlying physical devices and will succeed provided that one -of the underlying devices responds with success. For example, a single command -issued to turn on LED's will turn on corresponding LED's for all underlying -physical keyboards. -.sp -.LP -Although physical keyboards/mice are linked to the virtual keyboard/mouse -facility, each may be opened separately by accessing its associated device -file. (For example, \fB/dev/usb/hid0\fR for a usb mouse). Directly accessing a -device file can be useful for multi-seat or similar purposes. -.sp -.LP -When a single physical device is opened via its associated device file, it is -automatically removed from the single virtual input stream. When closed, it is -automatically re- coalesced into the single virtual input stream. -.sp -.LP -Under the \fBvirtualkm\fR facility, the PS/2 mouse is coalesced into a virtual -mouse single input stream and can be accessed using the \fB/dev/mouse\fR file. -(Note that in previous releases, the PS/2 mouse was accessed via the -\fB/dev/kdmouse\fR physical device file). In the current release, you use the -\fB/dev/kdmouse\fR file to directly access the physical PS/2 mouse. -.SS "INTERFACES" -.LP -The virtual mouse provides the following event ID's for mouse capability -changes: -.sp -.ne 2 -.na -\fBMOUSE_CAP_CHANGE_NUM_BUT\fR -.ad -.RS 30n -This event is reported when the total number of mouse buttons changes. The -\fBFirm_event.value\fR is set to the new button total, which is the maximum -number of all mice buttons. Other fields are ignored. -.RE - -.sp -.ne 2 -.na -\fBMOUSE_CAP_CHANGE_NUM_WHEEL\fR -.ad -.RS 30n -This event is reported when the total number of mouse wheels changes. The -\fBFirm_event.value\fR is set to the new wheel total. Other fields are ignored. -The event value (\fBFirm_event.value\fR) can be 0 (no wheel), 1 (vertical -wheel), or 2 (vertical and horizontal wheel). -.RE - -.sp -.LP -The \fBFirm_event\fR structure is described in <\fBsys/vuid_event.h\fR>. As -with other events, firm events are received using \fBread\fR(2). -.sp -.LP -Event ID's are used by applications (including certain mouse demo applications) -that are programmed to graphically represent the actual number of buttons and -wheels on a mouse. When an application of this type receives a \fBFirm_event\fR -with a ID MOUSE_CAP_CHANGE_NUM_BUT or MOUSE_CAP_CHANGE_NUM_WHEEL event, it is -instructed to update its state information using the new value. Consider, for -example, a mouse demo application whose sole function is to display a mouse -with buttons that graphically correspond to the actual number of buttons on the -mouse. If, for example, the system has a single two-button USB mouse attached, -the application, by default, will graphically display the mouse with a left and -a right button. However, if a another three-button USB mouse is hot-plugged -into the system, a MOUSE_CAP_CHANGE_NUM_BUT Firm event with -\fBFirm_event.value\fR of three instructs the demo application to update the -mouse display to indicate three buttons. -.SH IOCTLS -.ne 2 -.na -\fBKIOCSETFREQ\fR -.ad -.RS 15n -Sets the frequency for either keyboard beeper or console beeper. To set the -corresponding beeper frequency, \fIarg\fR must point to a \fBfreq_request\fR -structure: -.sp -.in +2 -.nf -struct freq_request { - enum fr_beep_type type; /* beep type */ - int16_t freq; /* frequency */ -}; -.fi -.in -2 - -Where \fItype\fR is the corresponding beeper type defined as: -.sp -.in +2 -.nf -enum fr_beep_type { CONSOLE_BEEP =1, KBD_BEEP =2 }; -.fi -.in -2 - -and \fIfreq\fR is the frequency value to be set as the beeper frequency -indicated by \fItype\fR. This value should be between 0 and 32767 with border -inclusive. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/dev/kbd\fR\fR -.ad -.RS 18n -Virtual Keyboard device file. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/mouse\fR\fR -.ad -.RS 18n -Virtual Mouse device file. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/kdmouse\fR\fR -.ad -.RS 18n -Physical PS/2 mouse device file. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/usb/hid*\fR\fR -.ad -.RS 18n -Physical USB keyboard/mouse device file. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/dacf.conf\fR\fR -.ad -.RS 18n -Device auto-configuration file. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -l l -l l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Architecture SPARC, x86 -Interface Stability Evolving -.TE - -.SH SEE ALSO -.LP -\fBkbd\fR(1), \fBeeprom\fR(1M), \fBread\fR(2), \fBattributes\fR(5), -\fBhid\fR(7D), \fBusba\fR(7D), \fBkb\fR(7M), \fBusbkbm\fR(7M), \fBusbms\fR(7M), -\fBvuidmice\fR(7M) -.SH DIAGNOSTICS -.LP -The messages described below may appear on the system console as well as -being logged. All messages are formatted in the following manner: -.sp -.in +2 -.nf -WARNING: Error message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBconskbd: keyboard is not available for system debugging: -\fIdevice_path\fR.\fR -.ad -.sp .6 -.RS 4n -Errors were encountered while entering kmdb during initialization for debugger -mode. As a result, the keyboard is not available. -.RE - -.sp -.ne 2 -.na -\fBconskbd: keyboard is not available: <\fIdevice_path\fR>\fR -.ad -.sp .6 -.RS 4n -Errors were encountered while exiting kmdb during un-initialization for -debugger mode. As a result, the keyboard is not available. -.RE - -.sp -.ne 2 -.na -\fBFailed to relink the mouse <\fR\fIdevice_path\fR\fB> underneath virtual mouse\fR -.ad -.sp .6 -.RS 4n -An error was encountered and the mouse is unavailable. (When a mouse is -physically opened via a physical device file such as \fB/dev/usb/hid0\fR, it is -removed from the single virtual input stream (\fB/dev/mouse\fR). When closed, -it is re-coalesced into a single virtual input stream beneath \fB/dev/mouse\fR. -If an error is encountered, (for example, the mouse has been physically -removed), it is unavailable beneath \fB/dev/mouse\fR. -.RE - -.SH NOTES -.LP -Currently, the \fBvirtualkm\fR device supports only USB and PS2 keyboards and -mice. -.sp -.LP -The \fBvirtualkm\fR device maintains complete compatibility on select legacy -systems, (including Ultra 10's), that are equipped with serial keyboard/mouse. diff --git a/usr/src/man/man7d/vni.7d b/usr/src/man/man7d/vni.7d deleted file mode 100644 index f97ec438d2..0000000000 --- a/usr/src/man/man7d/vni.7d +++ /dev/null @@ -1,61 +0,0 @@ -'\" te -.\" Copyright (c) 2004 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 VNI 7D "Jul 18, 2004" -.SH NAME -vni \- STREAMS virtual network interface driver -.SH DESCRIPTION -.sp -.LP -The \fBvni\fR pseudo device is a multi-threaded, loadable, clonable, STREAMS -pseudo-device supporting the connectionless Data Link Provider Interface -\fBdlpi\fR(7P) Style 2. Note that DLPI is intended to interact with IP, meaning -that DLPI access to applications is not supported. (For example, snoop fails on -the \fBvni\fR interface.) -.sp -.LP -The \fBvni\fR device is a software-only interface and does not send or receive -data. The device provides a DLPI upper interface that identifies itself to IP -with a private media type. It can be configured via \fBifconfig\fR(1M) and can -have IP addresses assigned to it, making aliases possible. -.sp -.LP -The \fBvni\fR pseudo device is particularly useful in hosting an IP address -when used in conjunction with the 'usesrc' \fBifconfig\fR option (see -\fBifconfig\fR(1M) for examples). The logical instances of the device can also -be used to host addresses as an alternative to hosting them over the loopback -interface. -.sp -.LP -Multicast is not supported on this device. More specifically, the following -options return an error when used with an address specified on \fBvni\fR: -IP_MULTICAST_IF, IP_ADD_MEMBERSHIP, IP_DROP_MEMBERSHIP, IPV6_MULTICAST_IF, -IPV6_JOIN_GROUP, IPV6_LEAVE_GROUP. In addition, broadcast is not supported. -.sp -.LP -Because there is no physical hardware configured below it, no traffic can be -received through nor transmitted on a virtual interface. All packet -transmission and reception is accomplished with existing physical interfaces -and tunnels. Because applications that deal with packet transmission and -reception (such as packet filters) cannot filter traffic on virtual interfaces, -you cannot set up a packet filter on a virtual interface. Instead, you should -configure the policy rules to apply to the physical interfaces and tunnels, and -if necessary, use the virtual IP addresses themselves as part of the rule -configuration. Also, note that the virtual interface cannot be part of an IP -multipathing (IPMP) group. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/vni\fR\fR -.ad -.RS 12n -64-bit ELF kernel driver -.RE - -.SH SEE ALSO -.sp -.LP -\fBifconfig\fR(1M), \fBin.mpathd\fR(1M), \fBip\fR(7P), \fBip6\fR(7P) diff --git a/usr/src/man/man7d/vr.7d b/usr/src/man/man7d/vr.7d deleted file mode 100644 index b6f98c46a1..0000000000 --- a/usr/src/man/man7d/vr.7d +++ /dev/null @@ -1,137 +0,0 @@ -'\" te -.\" 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 VR 7D "May 5, 2009" -.SH NAME -vr \- driver for VIA Rhine fast Ethernet controllers -.SH DESCRIPTION -.sp -.LP -The \fBvr\fR Fast Ethernet driver is GLD based and supporting the VIA Rhine -family of Fast Ethernet adapters: -.sp -.in +2 -.nf -pci1106,3043 VIA VT86C100A Fast Ethernet -pci1106,3065 VT6102 VIA Rhine II -pci1106,3106 VT6105 VIA Rhine III -pci1106,3053 VT6105 VIA Rhine III Management Adapter -.fi -.in -2 -.sp - -.sp -.LP -The \fBvr\fR driver supports IEEE 802.3 auto-negotiation, flow control and VLAN -tagging. -.SS "Configuration" -.sp -.LP -The default configuration is \fBautonegotiation\fR with bidirectional flow -control. The advertised capabilities for \fBautonegotiation\fR are based on the -capabilities of the PHY. -.sp -.LP -You can set the capabilities advertised by the \fBvr\fR controlled device using -\fBdladm\fR(1M). The driver supports a number of parameters, the names of which -begin with \fBen_\fR (enabled). Each of these boolean parameters determines if -the device advertises that mode of operation when the hardware supports it. -.sp -.LP -The \fBadv_autoneg_cap\fR parameter controls whether auto-negotiation is -performed. If \fBadv_autoneg_cap\fR is 0, the driver selects the speed/duplex -combination from the first non-zero parameter from this list: -.sp -.in +2 -.nf -en_100fdx_cap 100Mbps full duplex -en_100hdx_cap 100Mbps half duplex -en_10fdx_cap 10Mbps full duplex -en_10hdx_cap 10Mbps half duplex -.fi -.in -2 -.sp - -.sp -.LP -All capabilities default to enabled. Changing any capability parameter causes -the link to go down while the link partners renegotiate the link using the -newly changed capabilities. -.SS "Limitations" -.sp -.LP -The \fBvr\fR driver does not support asymmetric \fBflowcontrol\fR. VT86C100A -and Rhine II adapters are not capable of transmitting \fBflowcontrol\fR -messages -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/vr\fR\fR -.ad -.RS 26n -Special character device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/vr\fR\fR -.ad -.RS 26n -32-bit device driver (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/vr\fR\fR -.ad -.RS 26n -64-bit device driver (SPARC) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/vr\fR\fR -.ad -.RS 26n -64-bit device driver (x86) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), -\fBieee802.3\fR(5), \fBdlpi\fR(7P), \fBstreamio\fR(7I) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programmer's Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR -.sp -.LP -\fIIEEE 802.3ae Specification - 2002\fR diff --git a/usr/src/man/man7d/wpi.7d b/usr/src/man/man7d/wpi.7d deleted file mode 100644 index 6cf2991334..0000000000 --- a/usr/src/man/man7d/wpi.7d +++ /dev/null @@ -1,82 +0,0 @@ -'\" te -.\" Copyright (c) 2006 Damien Bergamini -.\" Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the author nor the names of any co-contributors may be used to endorse -.\" or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; -.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE -.\" Portions Copyright (c) 2007 by Sun Microsystems, Inc. All Rights Reserved. -.TH WPI 7D "Apr 23, 2007" -.SH NAME -wpi \- Intel Pro Wireless 802.11a/b/g 3945 driver -.SH DESCRIPTION -.sp -.LP -The \fBwpi\fR \fI802.11b/g\fR wireless NIC driver is a multi-threaded, -loadable, clonable, GLDv3-based STREAMS driver supporting the Intel Pro -Wireless 3945ABG chipset-based NIC's. -.SH CONFIGURATION -.sp -.LP -The \fBwpi\fR driver performs auto-negotiation to determine the data rate and -mode. Supported \fI802.11b\fR data rates are 1, 2, 5.5 and 11 Mbits/sec. -Supported \fI802.11g\fR data rates are 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48 -and 54 Mbits/sec. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/wpi\fR\fR -.ad -.sp .6 -.RS 4n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/wpi\fR\fR -.ad -.sp .6 -.RS 4n -32-bit \fBELF\fR kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/wpi\fR\fR -.ad -.sp .6 -.RS 4n -64-bit \fBELF\fR kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fI802.11 \(em Wireless LAN Media Access Control and Physical Layer -Specification\fR \(em IEEE, 2001 diff --git a/usr/src/man/man7d/wscons.7d b/usr/src/man/man7d/wscons.7d deleted file mode 100644 index cbafe66ddd..0000000000 --- a/usr/src/man/man7d/wscons.7d +++ /dev/null @@ -1,1039 +0,0 @@ -'\" te -.\" Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2021 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 WSCONS 7D "August 29, 2021" -.SH NAME -wscons \- workstation console -.SH SYNOPSIS -.nf -\fB#include <sys/strredir.h>\fR -.fi - -.LP -.nf -\fBioctl\fR(\fIfd\fR, SRIOCSREDIR, \fItarget\fR); -.fi - -.LP -.nf -\fBioctl\fR(\fIfd\fR, SRIOCISREDIR, \fItarget\fR); -.fi - -.SH DESCRIPTION -The \fBwscons\fR workstation console consists of a workstation keyboard and -frame buffer that act together to emulate an \fBASCII\fR terminal. It includes -a redirection facility that allows I/O issued to the workstation console to be -diverted to a STREAMS device, enabling window systems to redirect output that -would otherwise appear directly on the frame buffer in corrupted form. -.SS "Redirection" -The \fBwscons\fR redirection facility maintains a list of devices that are -designated as redirection targets through the \fBSRIOCSREDIR\fR ioctl described -below. Only the current entry is active; when the active entry is closed, the -most recent remaining entry becomes active. The active entry acts as a proxy -for the device being redirected and handles all \fBread\fR(2), \fBwrite\fR(2), -\fBioctl\fR(2), and \fBpoll\fR(2) calls issued against the redirectee. -.sp -.LP -The ioctls described below control the redirection facility. In both cases, -\fIfd\fR is a descriptor for the device being redirected (or workstation -console) and \fItarget\fR is a descriptor for a STREAMS device. -.sp -.ne 2 -.na -\fB\fBSRIOCSREDIR\fR\fR -.ad -.RS 16n -Designates \fItarget\fR as the source and destination of I/O ostensibly -directed to the device denoted by \fIfd\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBSRIOCISREDIR\fR\fR -.ad -.RS 16n -Returns 1 if \fItarget\fR names the device currently acting as proxy for the -device denoted by \fIfd\fR, and 0 if it is not. -.RE - -.SS "ANSI Standard Terminal Emulation" -The Solaris kernel terminal emulator provides ANSI X3.64 emulation both on -SPARC and x86 systems. -.sp -.LP -On SPARC systems, the PROM monitor is used to emulate an ANSI X3.64 terminal -if the kernel terminal emulator is not available for emulation. See -\fBvisual_io\fR(7I) for more details. -.sp -.LP -Note: The \fBVT100\fR adheres the \fBANSI\fR X3.64 standard. However, because -the \fBVT100\fR features nonstandard extensions to \fBANSI\fR X3.64, it is -incompatible with Sun terminal emulators. -.sp -.LP -The SPARC console displays 34 lines of 80 ASCII characters per line. The x86 -console displays 25 lines of 80 ASCII characters per line. Devices with -smaller text capacities may display less. On SPARC systems, the \fBscreen-#rows -screen-#columns\fR should be set to 34 or 80 respectively or text capacities -will vary from those described above. On SPARC systems, the \fBscreen-#rows and -screen-#columns\fR fields are stored in \fBNVRAM/EEPROM\fR. See -\fBeeprom\fR(1M) for more information. Both SPARC and x86 consoles offer -scrolling, (x, y) cursor addressing ability and a number of other control -functions. -.sp -.LP -The console cursor marks the current line and character position on the screen. -\fBASCII\fR characters between \fB0x20 \fR(space) and \fB0x7E\fR (tilde) -inclusive are printing characters. When a print character is written to the -console (and is not part of an escape sequence), it is displayed at the current -cursor position and the cursor moves one position to the right on the current -line. -.sp -.LP -On SPARC based systems, later \fBPROM\fR revisions have the full 8-bit ISO -Latin-1 (\fIISO 8859-1\fR) character set. Earlier \fBPROM\fR revisions display -characters in the range \fB0xA0 \fRthrough \fB0xFE \fRas spaces. -.sp -.LP -When the cursor is at the right edge of the screen, it moves to the first -character position on the next line. When the cursor is at the screen's -right-bottom edge, the line-feed function is performed (see \fBCTRL-J\fR -below). The line-feed function scrolls the screen up by one or more lines -before moving the cursor to the first character position on the next line. -.SS "Control Sequence Syntax" -The \fBwscons\fR console defines a number of control sequences that may occur -during input. When a control sequence is written to the console, it affects -one of the control functions described below. Control sequences are not -displayed on screen. -.sp -.LP -A number of control sequences (or control character functions) are of the form: -.sp -.LP -\fBCTRL-\fR\fIx\fR -.sp -.LP -where \fIx\fR represents a single character, such as \fBCNTRL-J\fR for a line -feed. -.sp -.LP -Other \fBANSI\fR control sequences are of the form: -.sp -.in +2 -.nf -ESC [ \fIparams char\fR -.fi -.in -2 - -.LP -Note - -.sp -.RS 2 -Spaces are included only for readability; these characters must occur in the -given sequence without the intervening spaces. -.RE -.sp -.ne 2 -.na -\fBESC\fR -.ad -.RS 10n -\fBASCII\fR escape character (\fBESC, CTRL-[, 0x1B\fR). -.RE - -.sp -.ne 2 -.na -\fB[\fR -.ad -.RS 10n -Left square bracket `[' (\fB0x5B)\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIparams\fR\fR -.ad -.RS 10n -Sequence of zero or more decimal numbers made up of digits between 0 and 9, -separated by semicolons. Parameters are represented by \fIn\fR in the syntax -descriptions for escape sequence functions. -.RE - -.sp -.ne 2 -.na -\fB\fIchar\fR\fR -.ad -.RS 10n -Function character, which is different for each control sequence and it -represented by \fIx\fR in the syntax descriptions for control character -functions. -.RE - -.sp -.LP -In the following examples of syntactically valid escape sequences, \fBESC -\fRrepresent the single \fBASCII\fR character, Escape: -.sp -.ne 2 -.na -\fBESC[m\fR -.ad -.RS 22n -Select graphic rendition with default parameter -.RE - -.sp -.ne 2 -.na -\fBESC[7m\fR -.ad -.RS 22n -Select graphic rendition with reverse image -.RE - -.sp -.ne 2 -.na -\fBESC[33;54H\fR -.ad -.RS 22n -Set cursor position -.RE - -.sp -.ne 2 -.na -\fBESC[123;456;0;;3;B\fR -.ad -.RS 22n -Move cursor down -.RE - -.sp -.LP -Syntactically valid control characters and \fBANSI\fR escape sequences that are -not currently interpreted by the console are ignored. -.sp -.LP -Each control function requires a specified number of parameters. If fewer -parameters are supplied, the remaining parameters (with certain exceptions -noted below) default to 1. If more parameters are supplied, the first \fIn\fR -parameters are used by kernel terminal emulator. In contrast, only the last -\fIn\fR parameters are used by PROM based emulator, where \fIn\fR is the number -required by that particular command character. -.sp -.LP -Parameters which are omitted or set to 0 are reset to the default value of 1 -(with certain exceptions). For example, the command character \fBM\fR requires -one parameter. \fBESC[;M\fR, \fBESC[0M\fR, \fBESC[M\fR and -\fBESC[23;15;32;1M\fR are all equivalent to \fBESC[1M\fR and provide a -parameter value of 1. Note that \fBESC[;5M\fR (interpreted as \fB`ESC[5M\fR') -is \fInot\fR equivalent to \fBESC[5;M\fR (interpreted as `\fBESC[5;1M\fR') -which is ultimately interpreted as `\fBESC[1M\fR'). -.SS "ANSI Control Functions" -The following paragraphs specify the \fBANSI\fR control functions implemented -by the console. Each description provides: -.RS +4 -.TP -.ie t \(bu -.el o -Control sequence syntax -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Hexadecimal equivalent of control characters where applicable -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Control function name and \fBANSI\fR or Sun abbreviation (if any). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Description of parameters required, if any -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Description of the control function -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Initial setting of the mode for functions that set a mode. To restore the -initial settings, use the \fBSUNRESET\fR escape sequence. -.RE -.SS "Control Character Functions" -The \fBwscons \fRcontrol character functions are: -.sp -.ne 2 -.na -\fBBell (BEL),\fR -.ad -.br -.na -\fBCTRL-G\fR -.ad -.br -.na -\fB0x7\fR -.ad -.RS 22n -Used for consoles that are not equipped with an audible bell. Current Sun -workstation models also flash the screen if the keyboard is not the console -input device. -.RE - -.sp -.ne 2 -.na -\fBBackspace (BS),\fR -.ad -.br -.na -\fBCTRL-H,\fR -.ad -.br -.na -\fB0x8\fR -.ad -.RS 22n -The cursor moves one position to the left on the current line. If it is -already at the left edge of the screen, no change takes place. -.RE - -.sp -.ne 2 -.na -\fBTab (TAB),\fR -.ad -.br -.na -\fBCTRL-I,\fR -.ad -.br -.na -\fB0x9\fR -.ad -.RS 22n -The cursor moves right on the current line to the next tab stop. The tab stops -are fixed at every multiple of eight columns. If the cursor is already at the -right edge of the screen, nothing change takes place. Otherwise, the cursor -moves right a minimum of one and a maximum of eight character positions. -.RE - -.sp -.ne 2 -.na -\fBLine-feed (LF),\fR -.ad -.br -.na -\fBCTRL-J,\fR -.ad -.br -.na -\fB0xA\fR -.ad -.RS 22n -The cursor, while remaining at the same character position on the line, moves -down one line. If the cursor is at the bottom line, the screen either scrolls -up or wraps around depending on the setting of an internal variable \fIn\fR -(initially 1) . The internal variable can be changed using the \fBESC[r\fR -control sequence. If \fIn\fR is greater than zero, the entire screen -(including the cursor) is scrolled up by \fIn\fR lines before executing the -line-feed. The top \fIn\fR lines scroll off the screen and are lost. New blank -lines \fIn\fR scroll onto the bottom of the screen. After scrolling, move the -cursor down one line to execute the line feed. -.sp -If \fIn\fR is zero, wrap-around mode is entered. The \fBESC [ 1 r\fR exits back -to scroll mode. If a line-feed occurs on the bottom line in wrap mode, the -cursor goes to the same character position in the top line of the screen. -During line-feeds, the line that the cursor moves to is cleared and no -scrolling occurs. Wrap-around mode is not implemented in the window system. -.sp -On SPARC based systems, the speed at which the screen scrolls is dependent on -the amount of data waiting to be printed. Whenever a scroll occurs and the -console is in normal scroll mode (\fBESC [ 1 r\fR), it scans the rest of the -data awaiting printing to see how many line-feeds occur in it. This scan stops -when the console finds a control character from the set {\fBVT\fR, \fBFF\fR, -\fBSO\fR, \fBSI\fR, \fBDLE\fR, \fBDC1\fR, \fBDC2\fR, \fBDC3\fR, \fBDC4\fR, -\fBNAK\fR, \fBSYN\fR, \fBETB\fR, \fBCAN\fR, \fBEM\fR, \fBSUB\fR, \fBESC\fR, -\fBFS\fR, \fBGS\fR, \fBRS\fR, \fBUS\fR} . At that point, the screen is -scrolled by \fIn\fR lines (\fIn\fR \(>= 1) and processing continues. The -scanned text is processed normally and fills in the newly created lines. As -long as escape codes or other control characters are not intermixed with the -text, this results in faster scrolling -.RE - -.sp -.ne 2 -.na -\fBReverse Line-feed,\fR -.ad -.br -.na -\fBCTRL-K,\fR -.ad -.br -.na -\fB0xB\fR -.ad -.RS 22n -With kernel terminal emulator (while remaining at the same character position -on the line), the cursor moves down one line. However, with PROM based -emulator (while remaining at the same character position on the line), the -cursor moves up one line. If the cursor is already at the top line, no -change takes place. -.RE - -.sp -.ne 2 -.na -\fBForm-feed (FF)\fR -.ad -.br -.na -\fBCTRL-L,\fR -.ad -.br -.na -\fB0xC\fR -.ad -.RS 22n -The cursor is positioned to the home position (upper-left corner) and the -entire screen is cleared. -.RE - -.sp -.ne 2 -.na -\fBReturn (CR),\fR -.ad -.br -.na -\fBCTRL-M,\fR -.ad -.br -.na -\fB0xD\fR -.ad -.RS 22n -The cursor moves to the leftmost character position on the current line. -.RE - -.SS "Escape Sequence Functions" -The \fBwscons \fRescape sequence functions are: -.sp -.ne 2 -.na -\fBEscape (ESC),\fR -.ad -.br -.na -\fBCTRL-[,\fR -.ad -.br -.na -\fB0x1B\fR -.ad -.sp .6 -.RS 4n -The escape character. Escape initiates a multi-character control sequence. -.RE - -.sp -.ne 2 -.na -\fBInsert Character (ICH)\fR -.ad -.br -.na -\fBESC[#@\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 1). Inserts \fIn\fR spaces at the -current cursor position. The current line, starting at the current cursor -position inclusive, is shifted to the right by \fIn\fR character positions to -make room for the spaces. The rightmost \fIn\fR character positions shift off -the line and are lost. The position of the cursor is unchanged. -.RE - -.sp -.ne 2 -.na -\fBCursor Up (CUU),\fR -.ad -.br -.na -\fBESC[#A\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 1). Moves the cursor up \fIn\fR lines. -If the cursor is fewer than \fIn\fR lines from the top of the screen, moves -the cursor to the topmost line on the screen. The character position of the -cursor on the line is unchanged. -.RE - -.sp -.ne 2 -.na -\fBCursor Down (CUD),\fR -.ad -.br -.na -\fBESC[#B\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, (default 1). Moves the cursor down \fIn\fR lines. If -the cursor is fewer than \fIn\fR lines from the bottom of the screen, move the -cursor to the last line on the screen. The character position of the cursor on -the line is unchanged. -.RE - -.sp -.ne 2 -.na -\fBCursor Forward (CUF),\fR -.ad -.br -.na -\fBESC[#C\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 1). Moves the cursor to the right by -\fIn\fR character positions on the current line. If the cursor is fewer than -\fIn\fR positions from the right edge of the screen, moves the cursor to the -rightmost position on the current line. -.RE - -.sp -.ne 2 -.na -\fBCursor Backward (CUB),\fR -.ad -.br -.na -\fBESC[#D\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 1). Moves the cursor to the left by -\fIn\fR character positions on the current line. If the cursor is fewer than -\fIn\fR positions from the left edge of the screen, moves the cursor to the -leftmost position on the current line. -.RE - -.sp -.ne 2 -.na -\fBCursor Next Line (CNL),\fR -.ad -.br -.na -\fBESC[#E\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 1). Positions the cursor at the -leftmost character position on the \fIn\fR-th line below the current line. If -the current line is less than \fIn\fR lines from the bottom of the screen, -positions the cursor at the leftmost character position on the bottom line. -.RE - -.sp -.ne 2 -.na -\fBHorizontal and Vertical Position (HVP),\fR -.ad -.br -.na -\fBESC[#1;#2f\fR -.ad -.sp .6 -.RS 4n -or -.RE - -.sp -.ne 2 -.na -\fBCursor Position (CUP),\fR -.ad -.br -.na -\fBESC[#1;#2H\fR -.ad -.sp .6 -.RS 4n -Takes two parameters, \fIn\fR1 and \fIn\fR2 (default 1, 1). Moves the cursor -to the \fIn\fR2-th character position on the \fIn\fR1-th line. Character -positions are numbered from 1 at the left edge of the screen; line positions -are numbered from 1 at the top of the screen. Hence, if both parameters are -omitted, the default action moves the cursor to the home position (upper left -corner). If only one parameter is supplied, the cursor moves to column 1 of -the specified line. -.RE - -.sp -.ne 2 -.na -\fBErase in Display (ED),\fR -.ad -.br -.na -\fBESC[J\fR -.ad -.sp .6 -.RS 4n -Takes no parameters. Erases from the current cursor position inclusive to the -end of the screen, that is, to the end of the current line and all lines below -the current line. The cursor position is unchanged. -.RE - -.sp -.ne 2 -.na -\fBErase in Line (EL),\fR -.ad -.br -.na -\fBESC[K\fR -.ad -.sp .6 -.RS 4n -Takes no parameters. Erases from the current cursor position inclusive to the -end of the current line. The cursor position is unchanged. -.RE - -.sp -.ne 2 -.na -\fBInsert Line (IL),\fR -.ad -.br -.na -\fBESC[#L\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 1). Makes room for \fIn\fR new lines -starting at the current line by scrolling down by \fIn\fR lines the portion of -the screen from the current line inclusive to the bottom. The \fIn\fR new -lines at the cursor are filled with spaces; the bottom \fIn\fR lines shift off -the bottom of the screen and are lost. The position of the cursor on the -screen is unchanged. -.RE - -.sp -.ne 2 -.na -\fBDelete Line (DL),\fR -.ad -.br -.na -\fBESC[#M\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 1). Deletes \fIn\fR lines beginning -with the current line. The portion of the screen from the current line -inclusive to the bottom is scrolled upward by \fIn\fR lines. The \fIn\fR new -lines scrolling onto the bottom of the screen are filled with spaces; the -\fIn\fR old lines beginning at the cursor line are deleted. The position of -the cursor on the screen is unchanged. -.RE - -.sp -.ne 2 -.na -\fBDelete Character (DCH),\fR -.ad -.br -.na -\fBESC[#P\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 1). Deletes \fIn\fR characters -starting with the current cursor position. Shifts the tail of the current line -to the left by \fIn\fR character positions from the current cursor position, -inclusive, to the end of the line. Blanks are shifted into the rightmost -\fIn\fR character positions. The position of the cursor on the screen is -unchanged. -.RE - -.sp -.ne 2 -.na -\fBSelect Graphic Rendition (SGR),\fR -.ad -.br -.na -\fBESC[#m\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 0). Note that unlike most escape -sequences, the parameter defaults to zero if omitted. Invokes the graphic -rendition specified by the parameter. All following printing characters in the -data stream are rendered according to the parameter until the next occurrence -of this escape sequence in the data stream. With PROM-based emulator, only two -graphic renditions are defined: -.sp -.ne 2 -.na -\fB0\fR -.ad -.RS 5n -Normal rendition -.RE - -.sp -.ne 2 -.na -\fB7\fR -.ad -.RS 5n -Negative (reverse) image -.RE - -Negative image displays characters as white-on-black if the screen mode is -currently black-on white, and vice-versa. Any non-zero value of \fIn\fR is -currently equivalent to 7 and selects the negative image rendition. -.sp -In addition to the two renditions mentioned above, the following\fI ISO -6429-1983\fR graphic rendition values support color text with kernel terminal -emulator: -.sp -.ne 2 -.na -\fB30\fR -.ad -.RS 6n -black foreground -.RE - -.sp -.ne 2 -.na -\fB31\fR -.ad -.RS 6n -red foreground -.RE - -.sp -.ne 2 -.na -\fB32\fR -.ad -.RS 6n -green foreground -.RE - -.sp -.ne 2 -.na -\fB33\fR -.ad -.RS 6n -brown foreground -.RE - -.sp -.ne 2 -.na -\fB34\fR -.ad -.RS 6n -blue foreground -.RE - -.sp -.ne 2 -.na -\fB35\fR -.ad -.RS 6n -magenta foreground -.RE - -.sp -.ne 2 -.na -\fB36\fR -.ad -.RS 6n -cyan foreground -.RE - -.sp -.ne 2 -.na -\fB37\fR -.ad -.RS 6n -white foreground -.RE - -.sp -.ne 2 -.na -\fB40\fR -.ad -.RS 6n -black background -.RE - -.sp -.ne 2 -.na -\fB41\fR -.ad -.RS 6n -red background -.RE - -.sp -.ne 2 -.na -\fB42\fR -.ad -.RS 6n -green background -.RE - -.sp -.ne 2 -.na -\fB43\fR -.ad -.RS 6n -brown background -.RE - -.sp -.ne 2 -.na -\fB44\fR -.ad -.RS 6n -blue background -.RE - -.sp -.ne 2 -.na -\fB45\fR -.ad -.RS 6n -magenta background -.RE - -.sp -.ne 2 -.na -\fB46\fR -.ad -.RS 6n -cyan background -.RE - -.sp -.ne 2 -.na -\fB47\fR -.ad -.RS 6n -white background -.RE - -.RE - -.sp -.ne 2 -.na -\fBBlack On White (SUNBOW),\fR -.ad -.br -.na -\fBESC[p\fR -.ad -.sp .6 -.RS 4n -Takes no parameters. On SPARC, sets the screen mode to black-on-white. If the -screen mode is already black-on-white, has no effect. In this mode, spaces -display as solid white, other characters as black-on-white. The cursor is a -solid black block. Characters displayed in negative image rendition (see -`Select Graphic Rendition' above) are white-on-black. This comprises the -initial setting of the screen mode on reset. On x86 systems, use \fBESC[q\fR to -set black-on-white. -.RE - -.sp -.ne 2 -.na -\fBWhite On Black (SUNWOB),\fR -.ad -.br -.na -\fBESC[q\fR -.ad -.sp .6 -.RS 4n -Takes no parameters. On SPARC, sets the screen mode to white-on-black. If the -screen mode is already white-on-black, has no effect. In this mode spaces -display as solid black, other characters as white-on-black. The cursor is a -solid white block. Characters displayed in negative image rendition (see -`Select Graphic Rendition' above) are black-on-white. Initial setting of the -screen mode on reset is black on white. On x86 systems, use \fBESC[p\fR to set -white-on-black. -.RE - -.sp -.ne 2 -.na -\fBESC[#r\fR -.ad -.br -.na -\fBSet Scrolling (SUNSCRL)\fR -.ad -.sp .6 -.RS 4n -Takes one parameter, \fIn\fR (default 0). Sets to \fIn\fR an internal -register which determines how many lines the screen scrolls up when a line-feed -function is performed with the cursor on the bottom line. A parameter of 2 or -3 introduces a small amount of jump when a scroll occurs. A parameter of 34 -clears the screen rather than scrolling. The initial setting is 1 on reset. -.sp -A parameter of zero initiates wrap mode instead of scrolling. If a linefeed -occurs on the bottom line during wrap mode, the cursor goes to the same -character position in the top line of the screen. When a line feed occurs, the -line that the cursor moves to is cleared and no scrolling occurs. \fBESC [ 1 -r\fR exits back to scroll mode. -.sp -For more information, see the description of the Line-feed (\fBCTRL-J\fR) -control function above. -.RE - -.sp -.ne 2 -.na -\fBESC[s\fR -.ad -.br -.na -\fBReset terminal emulator (SUNRESET)\fR -.ad -.sp .6 -.RS 4n -Takes no parameters. Resets all modes to default, restores current font from -\fBPROM.\fR Screen and cursor position are unchanged. -.RE - -.SH RETURN VALUES -When there are no errors, the redirection ioctls have return values as -described above. Otherwise, they return \fB\(mi1\fR and set \fBerrno\fR to -indicate the error. If the target stream is in an error state, \fBerrno \fRis -set accordingly. -.sp -.LP -If the \fItarget\fR stream is in an error state, \fBerrno\fR is set -accordingly. -.SH ERRORS -.ne 2 -.na -\fB\fBEBADF\fR\fR -.ad -.RS 10n -\fItarget\fR does not denote an open file. -.RE - -.sp -.ne 2 -.na -\fB\fBENOSTR\fR\fR -.ad -.RS 10n -\fItarget\fR does not denote a \fBSTREAMS\fR device. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/dev/wscons\fR\fR -.ad -.RS 16n -Workstation console, accessed via the redirection facility -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/systty\fR\fR -.ad -.RS 16n -Devices that must be opened for the \fBSRIOCSREDIR\fR and \fBSRIOCISREDIR\fR -ioctls. -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/syscon\fR\fR -.ad -.RS 16n -Access system console -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/console\fR\fR -.ad -.RS 16n -Access system console -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Stable -.TE - -.SH SEE ALSO -\fBeeprom\fR(1M), \fBioctl\fR(2), \fBpoll\fR(2), \fBread\fR(2), -\fBwrite\fR(2), \fBconsole\fR(7D), \fBvisual_io\fR(7I) -.SH WARNINGS -The redirection ioctls block while there is I/O outstanding on the device -instance being redirected. If you try to redirect the workstation console while -there is a outstanding read, the workstation console will hang until the read -completes. diff --git a/usr/src/man/man7d/xge.7d b/usr/src/man/man7d/xge.7d deleted file mode 100644 index c55d8bedd4..0000000000 --- a/usr/src/man/man7d/xge.7d +++ /dev/null @@ -1,163 +0,0 @@ -'\" te -.\" Copyright (c) 2005, Sun Microsystems 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 XGE 7D "Oct 3, 2005" -.SH NAME -xge \- Neterion Xframe 10Gigabit Ethernet Network Adapter driver -.SH SYNOPSIS -.LP -.nf -/dev/xge -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBxge\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 S2IO Xframe 10-Gigabit Ethernet Network Adapter. -.sp -.LP -The \fBxge\fR driver functions includes controller initialization, frame -transmit and receive, promiscuous and multicast support, TCP and UDP checksum -offload (IPv4 and IPv6), 9622-byte jumbo frame, and error recovery and -reporting. -.sp -.LP -The \fBxge\fR driver and hardware support the 10GBase-SR/W, LR/W, and ER/W -\fI802.3\fR physical layer. -.SH APPLICATION PROGRAMMING INTERFACE -.sp -.LP -The cloning, character-special device \fB/dev/xge\fR is used to access all -Xframe devices installed within the system. -.sp -.LP -The \fBxge\fR driver is managed by the \fBdladm\fR(1M) command line utility, -which allows VLANs to be defined on top of xge instances and for \fBxge\fR -instances to be aggregated. See \fBdladm\fR(1M) for more details. -.sp -.LP -The values returned by the driver in the DL_INFO_ACK primitive in response to -the DL_INFO_REQ are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -Maximum SDU is \fB9600\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Minimum SDU is \fB0\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBDSLAP\fR address length is \fB8\fR bytes. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBMAC\fR type is \fBDL_ETHER.\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBSAP\fR length value is -2 meaning the physical address component is -followed immediately by a 2-byte sap component within the DLSAP address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Broadcast address value is Ethernet/IEEE broadcast address -(FF:FF:FF:FF:FF:FF). -.RE -.SH CONFIGURATION -.sp -.LP -By default, the \fBxge\fR driver works without any configuration file. -.sp -.LP -You can check the running-time status of a device instance using -\fBndd\fR(1M). Currently, the driver provides an interface to print all -hardware statistics. -.sp -.LP -For example, to print statistics of device xge0: -.sp -.in +2 -.nf - #ndd /dev/xge0 stats - tmac_data_octets 772 - tmac_frms 15 - tmac_drop_frms 0 - tmac_bcst_frms 6 - tmac_mcst_frms 6 - - ... - - rmac_vld_frms 13 - rmac_fcs_err_frms 0 - rmac_drop_frms 0 - rmac_vld_bcst_frms 7 - rmac_vld_mcst_frms 11 - rmac_out_rng_len_err_frms 0 - rmac_in_rng_len_err_frms 0 - rmac_long_frms 0 - - ... - - not_traffic_intr_cnt 242673 - traffic_intr_cnt 28 - - ... -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/xge\fR \fR -.ad -.RS 13n -\fBxge\fR special character device -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -l l -l l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBndd\fR(1M), \fBattributes\fR(5), \fBstreamio\fR(7I), -\fBdlpi\fR(7P) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fISTREAMS Programming Guide\fR -.sp -.LP -\fINetwork Interfaces Programmer's Guide\fR diff --git a/usr/src/man/man7d/xhci.7d b/usr/src/man/man7d/xhci.7d deleted file mode 100644 index a915a099b1..0000000000 --- a/usr/src/man/man7d/xhci.7d +++ /dev/null @@ -1,108 +0,0 @@ -.\" -.\" 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 2016 Joyent, Inc. -.\" -.Dd January 10, 2020 -.Dt XHCI 7D -.Os -.Sh NAME -.Nm xhci -.Nd Extensible Host Controller Interface Driver -.Sh SYNOPSIS -.Sy usb@unit-address -.Sh DESCRIPTION -The -.Nm -driver supports PCI devices that implement versions 1.0 and 1.1 of the -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 -The -.Nm -driver supports all four USB transfer types: -.Sy bulk transfers , -.Sy control transfers , -.Sy interrupt transfers , -and -.Sy isochronous transfers . -.Pp -Administrators do not interact with the -.Nm -driver directly. -USB devices are managed with -.Xr cfgadm 1M . -See -.Xr cfgadm_usb 1M -for more information on how to specifically manage USB devices and how -they are laid out in the system. -.Xr cfgadm 1M -is only used to manage devices at a USB level. -For example, a USB NIC would still be managed with -.Xr dladm 1M -at a networking level. -.Pp -On some x86 systems USB ports may be routed to either an instance of the -.Nm -driver or an instance of the -.Xr ehci 7D -driver. -By default, all such ports are routed to the -.Nm -driver, allowing those devices to operate at USB 3.x speed by default. -This is most common on Intel platforms and chipsets. -While this is controlled with the -.Sy xhci-reroute -property discussed below, changing it may not be sufficient to change -the behavior. -The BIOS or ACPI data for many x86 systems may toggle this automatically. -.Sh PROPERTIES -The -.Nm -driver supports the following properties which may be tuned in the -.Nm -driver's -.Xr driver.conf 4 -file. -.Bl -tag -width Sy -.It Sy xhci-reroute -The -.Sy xhci-reroute -property determines whether or not USB ports are re-routed to the -.Nm -driver. -The default behavior is to route such ports. -To disable this, the property should be set to -.Sy 0 . -Any other value, or the lack of the property, cause the default behavior -to take place. -.El -.Sh ARCHITECTURE -The -.Nm -driver is only supported on -.Sy x86 -systems at this time. -.Sh FILES -.Bl -tag -width Pa -.It Pa /kernel/drv/amd64/xhci -Device driver (x86) -.It Pa /kernel/drv/xhci.conf -Driver configuration file -.El -.Sh SEE ALSO -.Xr cfgadm 1M , -.Xr cfgadm_usb 1M , -.Xr dladm 1M , -.Xr driver.conf 4 , -.Xr ehci 7D , -.Xr usba 7D diff --git a/usr/src/man/man7d/yge.7d b/usr/src/man/man7d/yge.7d deleted file mode 100644 index 1d1d013478..0000000000 --- a/usr/src/man/man7d/yge.7d +++ /dev/null @@ -1,172 +0,0 @@ -'\" te -.\" 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 YGE 7D "Sep 15, 2009" -.SH NAME -yge \- Marvell Yukon 2 Ethernet device driver -.SH SYNOPSIS -.sp -.in +2 -.nf -/dev/net/yge -.fi -.in -2 - -.SH DESCRIPTION -.sp -.LP -The \fByge\fR driver supports Marvell Yukon 2 Fast Ethernet and Gigabit -Ethernet controllers. -.SS "Properties" -.sp -.LP -The following properties can be configured using \fBdladm\fR(1M): -.sp -.ne 2 -.na -\fB\fBadv_autoneg_cap\fR\fR -.ad -.RS 19n -Enables (default) or disables IEEE 802.3 auto-negotiation of link speed and -duplex settings. If enabled, the device negotiates among the supported (and -configured, see below) link options with the link partner. If disabled, at -least one of the link options below must be specified. The driver selects the -first enabled link option according to the IEEE 802.3 specified preferences. -.RE - -.sp -.ne 2 -.na -\fB\fBadv_1000fdx_cap\fR\fR -.ad -.RS 19n -Enables the 1000 Mbps full-duplex link option. -.RE - -.sp -.ne 2 -.na -\fB\fBadv_1000hdx_cap\fR\fR -.ad -.RS 19n -Enables the 1000 Mbps half-duplex link option. -.RE - -.sp -.ne 2 -.na -\fB\fBadv_100T4_cap\fR\fR -.ad -.RS 19n -Enables the 100 BaseT4 link option. (Note that most hardware does not support -this unusual link style. Also, this uses two pairs of wires for data, rather -than one.) -.RE - -.sp -.ne 2 -.na -\fB\fBadv_100fdx_cap\fR\fR -.ad -.RS 19n -Enables the 1000 Mbps full-duplex link option. -.RE - -.sp -.ne 2 -.na -\fB\fBadv_100hdx_cap\fR\fR -.ad -.RS 19n -Enables the 1000 Mbps half-duplex link option. -.RE - -.sp -.ne 2 -.na -\fB\fBadv_10fdx_cap\fR\fR -.ad -.RS 19n -Enables the 10 Base-T full-duplex link option. -.RE - -.sp -.ne 2 -.na -\fB\fBadv_10hdx_cap\fR\fR -.ad -.RS 19n -Enables the 10 Base-T half-duplex link option. -.RE - -.sp -.ne 2 -.na -\fB\fBmtu\fR\fR -.ad -.RS 19n -On most devices, can be set between 1500 (default) and 9000. This property can -only be changed when the device is not in use. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/net/yge\fR\fR -.ad -.RS 27n -Special network device -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/yge\fR\fR -.ad -.RS 27n -32-bit driver binary (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/yge\fR\fR -.ad -.RS 27n -64-bit driver binary (x86) -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/sparcv9/yge\fR\fR -.ad -.RS 27n -64-bit driver binary (SPARC) -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86, SPARC -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBattributes\fR(5), \fBdlpi\fR(7P) diff --git a/usr/src/man/man7d/zcons.7d b/usr/src/man/man7d/zcons.7d deleted file mode 100644 index 07df6b458e..0000000000 --- a/usr/src/man/man7d/zcons.7d +++ /dev/null @@ -1,64 +0,0 @@ -'\" te -.\" Copyright 2003 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] -.\" Copyright 2022 Oxide Computer Company -.Dd February 5, 2022 -.Dt ZCONS 7D -.Os -.Sh NAME -.Nm zcons -.Nd Zone console device driver -.Sh DESCRIPTION -The -.Nm zcons -character driver exports the console for system zones. -The driver is fundamentally similar to a pseudo-terminal device, and is thus -comprised of two sides: -.Bl -bullet -.It -a manager device, which applications in the global zone can open for -communication -.It -a subsidiary device, which processes in the non-global zone can write to, to -communicate with global zone management applications -.El -.Pp -Applications must not depend on the location of -.Pa /dev -or -.Pa /devices -entries exposed by -.Nm zcons -in the global zone. -Inside a non-global zone, the -.Nm zcons -subsidiary device is fronted by -.Pa /dev/console -and other console-related symbolic links, which are used by applications that -expect to write to the system console. -.Pp -The -.Nm -driver is not a -.Sy Committed -interface, and may change at any time. -.Sh FILES -.Bl -tag -width Pa -.It Pa /dev/zcons/ZONENAME/globalconsole -Global zone console manager device for zone -.Sy ZONENAME . -.It Pa /dev/zcons/ZONENAME/zoneconsole -Global zone console subsidiary device for zone -.Sy ZONENAME . -.It Pa /dev/zconsole -Non-global zone console (subsidiary device). -.El -.Sh INTERFACE STABILITY -.Sy Uncommitted -.Sh SEE ALSO -.Xr zoneadm 1M , -.Xr zonecfg 1M , -.Xr attributes 5 , -.Xr zones 5 diff --git a/usr/src/man/man7d/zen_udf.7d b/usr/src/man/man7d/zen_udf.7d deleted file mode 100644 index a2243ef67f..0000000000 --- a/usr/src/man/man7d/zen_udf.7d +++ /dev/null @@ -1,36 +0,0 @@ -.\" -.\" 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 2020 Oxide Computer Company -.\" -.Dd October 7, 2020 -.Dt ZEN_UDF 7D -.Os -.Sh NAME -.Nm zen_udf -.Nd AMD data fabric user access driver -.Sh SYNOPSIS -.Pa /devices/pseudo/amdzen@0/zen_udf@3:zen_udf.* -.Sh DESCRIPTION -The -.Nm -driver provides the ability to read data from the AMD data fabric -.Pq DF -on AMD Family 17h -.Pq Zen, Zen+, and Zen 2 -processors. -.Pp -This driver is intended strictly for facilitating platform development -and is not recommended for systems that aren't doing kernel development -on AMD Zen platforms. -.Sh SEE ALSO -.Xr amdzen 7D , -.Xr usmn 7D diff --git a/usr/src/man/man7d/zero.7d b/usr/src/man/man7d/zero.7d deleted file mode 100644 index 35734e6f6c..0000000000 --- a/usr/src/man/man7d/zero.7d +++ /dev/null @@ -1,41 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1990, 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 ZERO 7D "Jul 3, 1990" -.SH NAME -zero \- source of zeroes -.SH DESCRIPTION -.sp -.LP -A zero special file is a source of zeroed unnamed memory. -.sp -.LP -Reads from a zero special file always return a buffer full of zeroes. The file -is of infinite length. -.sp -.LP -Writes to a zero special file are always successful, but the data written is -ignored. -.sp -.LP -Mapping a zero special file creates a zero-initialized unnamed memory object of -a length equal to the length of the mapping and rounded up to the nearest page -size as returned by \fBsysconf\fR. Multiple processes can share such a zero -special file object provided a common ancestor mapped the object -\fBMAP_SHARED\fR. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/zero\fR\fR -.ad -.RS 13n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBfork\fR(2), \fBmmap\fR(2), \fBsysconf\fR(3C) diff --git a/usr/src/man/man7d/zs.7d b/usr/src/man/man7d/zs.7d deleted file mode 100644 index 690935cca8..0000000000 --- a/usr/src/man/man7d/zs.7d +++ /dev/null @@ -1,279 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. -.\" 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 ZS 7D "April 9, 2016" -.SH NAME -zs \- Zilog 8530 SCC serial communications driver -.SH SYNOPSIS -.LP -.nf -#include <fcntl.h> -.fi - -.LP -.nf -#include <sys/termios.h> -.fi - -.LP -.nf -open("/dev/term/\fIn\fR", \fImode\fR); -.fi - -.LP -.nf -open("/dev/tty\fIn\fR", \fImode\fR); -.fi - -.LP -.nf -open("/dev/cua/\fIn\fR", \fImode\fR); -.fi - -.SH DESCRIPTION -.LP -The Zilog 8530 provides two serial input/output channels capable of supporting -a variety of communication protocols. A typical system uses two or more of -these devices to implement essential functions, including RS-423 ports (which -also support most RS-232 equipment), and the console keyboard and mouse -devices. -.sp -.LP -The \fBzs\fR module is a loadable STREAMS driver that provides basic support -for the Zilog 8530 hardware and basic asynchronous communication support. The -driver supports the \fBtermio\fR(7I) device control functions specified by -flags in the \fBc_cflag\fR word of the \fBtermios\fR structure and by the -\fBIGNBRK,\fR \fBIGNPAR,\fR \fBPARMRK,\fR or \fBINPCK\fR flags in the -\fBc_iflag\fR word. All other \fBtermio\fR(7I) functions must be performed by -\fBSTREAMS\fR modules pushed atop the driver. When a device is opened, the -\fBldterm\fR(7M) and \fBttcompat\fR(7M) \fBSTREAMS\fR modules are automatically -pushed on top of the stream, providing the standard \fBtermio\fR(7I) interface. -.sp -.LP -The character-special devices \fB/dev/term/a\fR and \fB/dev/term/b\fR are used -to access the two serial ports on the \fBCPU\fR board. -.sp -.LP -Valid name space entries are \fB/dev/cua/\fR[\fIa-z\fR], -\fB/dev/term/\fR[\fIa-z\fR] and \fB/dev/tty\fR[\fIa-z\fR]. The number of -entries used in a name space are machine dependent. -.sp -.LP -To allow a single tty line to be connected to a modem and used for both -incoming and outgoing calls, a special feature is available that is controlled -by the minor device number. By accessing character-special devices with names -of the form \fB/dev/cua/\fR[\fIn\fR], it is possible to open a port without -the \fBCarrier Detect\fR signal being asserted, either through hardware or an -equivalent software mechanism. These devices are commonly known as dial-out -lines. -.sp -.LP -Once a \fB/dev/cua/\fR[\fIn\fR] line is opened, the corresponding tty line -cannot be opened until the \fB/dev/cua/\fR\fIn\fR line is closed. A blocking -open will wait until the \fB/dev/cua/\fR[\fIn\fR] line is closed (which will -drop \fBData Terminal Ready\fR, and \fBCarrier Detect\fR) and carrier is -detected again. A non-blocking open will return an error. If the tty line has -been opened successfully (usually only when carrier is recognized on the modem) -, the corresponding \fB/dev/cua/\fR[\fIn\fR] line cannot be opened. This allows -a modem to be attached to \fB/dev/term/\fR[\fIn\fR] (renamed from -\fB/dev/tty\fR[\fIn\fR]) and used for dial-in (by enabling the line for login -in \fB/etc/inittab\fR) and also used for dial-out (by \fBtip\fR(1) or -\fBuucp\fR(1C)) as \fB/dev/cua/\fR[\fIn\fR] when no one is logged in on the -line. -.LP -Note - -.sp -.RS 2 -This module is affected by the setting of specific eeprom variables. For -information on parameters that are persistent across reboots, see the -\fBeeprom\fR(1M) man page. -.RE -.SH IOCTLS -.LP -The \fBzs\fR module supports the standard set of \fBtermio ioctl\fR(\|) calls. -.sp -.LP -If the \fBCRTSCTS\fR flag in the \fBc_cflag\fR field is set, output will be -generated only if \fBCTS\fR is high; if \fBCTS\fR is low, output will be -frozen. If the \fBCRTSCTS\fR flag is clear, the state of \fBCTS\fR has no -effect. -.sp -.LP -If the \fBCRTSXOFF\fR flag in the \fBc_cflag\fR field is set, input will be -received only if \fBRTS\fR is high; if \fBRTS\fR is low, input will be frozen. -If the \fBCRTSXOFF\fR flag is clear, the state of \fBRTS\fR has no effect. -.sp -.LP -The \fBtermios\fR \fBCRTSCTS\fR (respectively \fBCRTSXOFF)\fR flag and -\fBtermiox\fR \fBCTSXON\fR (respectively \fBRTSXOFF)\fR can be used -interchangeably. -.sp -.LP -Breaks can be generated by the \fBTCSBRK,\fR \fBTIOCSBRK,\fR and \fBTIOCCBRK -ioctl\fR(\|) calls. -.sp -.LP -The state of the \fBDCD,\fR \fBCTS,\fR \fBRTS,\fR and \fBDTR\fR interface -signals may be queried through the use of the \fBTIOCM_CAR,\fR \fBTIOCM_CTS,\fR -\fBTIOCM_RTS,\fR and \fBTIOCM_DTR\fR arguments to the \fBTIOCMGET ioctl\fR -command, respectively. Due to hardware limitations, only the \fBRTS\fR and -\fBDTR\fR signals may be set through their respective arguments to the -\fBTIOCMSET,\fR \fBTIOCMBIS,\fR and \fBTIOCMBIC ioctl\fR commands. -.sp -.LP -The input and output line speeds may be set to any of the speeds supported by -\fBtermio\fR. The input and output line speeds cannot be set independently; for -example, when you set the output speed, the input speed is automatically -set to the same speed. -.sp -.LP -When the driver is used to service the serial console port, it supports a BREAK -condition that allows the system to enter the debugger or the monitor. The -BREAK condition is generated by hardware and it is usually enabled by default. -A BREAK condition originating from erroneous electrical signals cannot be -distinguished from one deliberately sent by remote DCE. The Alternate Break -sequence can be used to remedy this. -.sp -.LP -Due to a risk of incorrect sequence interpretation, SLIP and certain other -binary protocols should not be run over the serial console port when Alternate -Break sequence is in effect. Although PPP is a binary protocol, it is able to -avoid these sequences using the ACCM feature in \fIRFC 1662\fR. For Solaris PPP -4.0, you do this by adding the following line to the \fB/etc/ppp/options\fR -file (or other configuration files used for the connection; see \fBpppd\fR(1M) -for details): -.sp -.in +2 -.nf -asyncmap 0x00002000 -.fi -.in -2 - -.sp -.LP -By default, the Alternate Break sequence is three characters: carriage return, -tilde and control-B (CR ~ CTRL-B), but may be changed by the driver. For more -information on breaking (entering the debugger or monitor), see \fBkbd\fR(1) -and \fBkb\fR(7M). -.SH ERRORS -.LP -An \fBopen\fR will fail under the following conditions: -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 9n -The unit being opened does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The dial-out device is being opened and the dial-in device is already open, or -the dial-in device is being opened with a no-delay open and the dial-out device -is already open. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The port is in use by another serial protocol. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The unit has been marked as exclusive-use by another process with a \fBTIOCEXCL -ioctl\fR(\|) call. -.RE - -.sp -.ne 2 -.na -\fB\fBEINTR\fR\fR -.ad -.RS 9n -The open was interrupted by the delivery of a signal. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/dev/cua/\fR[\fIa-z\fR]\fR -.ad -.RS 19n -dial-out tty lines -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/term/\fR[\fIa-z\fR]\fR -.ad -.RS 19n -dial-in tty lines -.RE - -.sp -.ne 2 -.na -\fB\fB/dev/tty\fR[\fIa-z\fR]\fR -.ad -.RS 19n -binary compatibility package device names -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.LP -\fBeeprom\fR(1M), \fBkadb\fR(1M), \fBtip\fR(1), \fBcu\fR(1C), \fBuucp\fR(1C), -\fBports\fR(1M), \fBpppd\fR(1M), \fBioctl\fR(2), \fBopen\fR(2), -\fBattributes\fR(5), \fBzsh\fR(7D), \fBtermio\fR(7I), \fBkb\fR(7M), -\fBldterm\fR(7M), \fBttcompat\fR(7M) -.SH DIAGNOSTICS -.ne 2 -.na -\fB\fBzs\fR\fIn\fR\fB\|: silo overflow.\fR\fR -.ad -.sp .6 -.RS 4n -The Zilog 8530 character input silo overflowed before it could be serviced. -.RE - -.sp -.ne 2 -.na -\fB\fBzs\fR\fIn\fR\fB\|: ring buffer overflow.\fR\fR -.ad -.sp .6 -.RS 4n -The driver's character input ring buffer overflowed before it could be -serviced. -.RE - diff --git a/usr/src/man/man7d/zsh.7d b/usr/src/man/man7d/zsh.7d deleted file mode 100644 index a62707e8a2..0000000000 --- a/usr/src/man/man7d/zsh.7d +++ /dev/null @@ -1,360 +0,0 @@ -'\" te -.\" Copyright (c) 1997, Sun Microsystems, Inc. -.\" 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 ZSH 7D "Jan 1, 1997" -.SH NAME -zsh \- On-board serial HDLC/SDLC interface -.SH SYNOPSIS -.LP -.nf -#include <fcntl.h> -.fi - -.LP -.nf -open(/dev/zsh\fIn, mode \fR\fB);\fR -.fi - -.LP -.nf -open(/dev/zsh\fI, mode \fR\fB);\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBzsh\fR module is a loadable \fBSTREAMS\fR driver that implements the -sending and receiving of data packets as \fBHDLC\fR frames over synchronous -serial lines. The module is not a standalone driver, but instead depends upon -the \fBzs\fR module for the hardware support required by all on-board serial -devices. When loaded this module acts as an extension to the \fBzs\fR driver, -providing access to an \fBHDLC\fR interface through character-special devices. -.sp -.LP -The \fBzsh\fR\fIn\fR devices provide what is known as a \fBdata path\fR which -supports the transfer of data via \fBread\fR(2) and \fBwrite\fR(2) system -calls, as well as \fBioctl\fR(2) calls. Data path opens are exclusive in order -to protect against injection or diversion of data by another process. -.sp -.LP -The \fBzsh\fR device provides a separate \fBcontrol path\fR for use by programs -that need to configure or monitor a connection independent of any exclusive -access restrictions imposed by data path opens. Up to three control paths may -be active on a particular serial channel at any one time. Control path -accesses are restricted to \fBioctl\fR(2) calls only; no data transfer is -possible. -.sp -.LP -When used in synchronous modes, the \fBZ8530 SCC\fR supports several options -for \fBclock sourcing\fR and \fBdata encoding\fR. Both the transmit and receive -clock sources can be set to be the external \fBT\fRransmit \fBC\fRlock -(\fBTRxC\fR), external \fBR\fReceive \fBC\fRlock (\fBRTxC\fR), the internal -\fBB\fRaud \fBR\fRate \fBG\fRenerator (\fBBRG\fR), or the output of the -\fBSCC\fR's \fBD\fRigital \fBP\fRhase-\fBL\fRock \fBL\fRoop (\fBDPLL\fR). -.sp -.LP -The \fBB\fRaud \fBR\fRate \fBG\fRenerator is a programmable divisor that -derives a clock frequency from the \fBPCLK\fR input signal to the \fBSCC\fR. A -programmed baud rate is translated into a 16-bit \fBtime\fR \fBconstant\fR that -is stored in the \fBSCC\fR. When using the \fBBRG\fR as a clock source the -driver may answer a query of its current speed with a value different from the -one specified. This is because baud rates translate into time constants in -discrete steps, and reverse translation shows the change. If an exact baud -rate is required that cannot be obtained with the \fBBRG\fR, an external clock -source must be selected. -.sp -.LP -Use of the \fBDPLL\fR option requires the selection of \fBNRZI\fR data encoding -and the setting of a non-zero value for the baud rate, because the \fBDPLL\fR -uses the \fBBRG\fR as its reference clock source. -.sp -.LP -A \fBlocal loopback mode\fR is available, primarily for use by the -\fBsyncloop\fR(1M) utility for testing purposes, and should not be confused -with \fBSDLC\fR loop mode, which is not supported on this interface. Also, an -\fBauto-echo\fR feature may be selected that causes all incoming data to be -routed to the transmit data line, allowing the port to act as the remote end of -a digital loop. Neither of these options should be selected casually, or left -in use when not needed. -.sp -.LP -The \fBzsh\fR driver keeps running totals of various hardware generated events -for each channel. These include numbers of packets and characters sent and -received, abort conditions detected by the receiver, receive \fBCRC\fR errors, -transmit underruns, receive overruns, input errors and output errors, and -message block allocation failures. Input errors are logged whenever an incoming -message must be discarded, such as when an abort or \fBCRC\fR error is -detected, a receive overrun occurs, or when no message block is available to -store incoming data. Output errors are logged when the data must be discarded -due to underruns, \fBCTS\fR drops during transmission, \fBCTS\fR timeouts, or -excessive watchdog timeouts caused by a cable break. -.SH IOCTLS -.sp -.LP -The \fBzsh\fR driver supports several \fBioctl()\fR commands, including: -.sp -.ne 2 -.na -\fB\fBS_IOCGETMODE\fR\fR -.ad -.RS 17n -Return a \fBstruct scc_mode\fR containing parameters currently in use. These -include the transmit and receive clock sources, boolean loopback and -\fBNRZI\fR mode flags and the integer baud rate. -.RE - -.sp -.ne 2 -.na -\fB\fBS_IOCSETMODE\fR\fR -.ad -.RS 17n -The argument is a \fBstruct scc_mode\fR from which the \fBSCC\fR channel will -be programmed. -.RE - -.sp -.ne 2 -.na -\fB\fBS_IOCGETSTATS\fR\fR -.ad -.RS 17n -Return a \fBstruct sl_stats\fR containing the current totals of -hardware-generated events. These include numbers of packets and characters sent -and received by the driver, aborts and \fBCRC\fR errors detected, transmit -underruns, and receive overruns. -.RE - -.sp -.ne 2 -.na -\fB\fBS_IOCCLRSTATS\fR\fR -.ad -.RS 17n -Clear the hardware statistics for this channel. -.RE - -.sp -.ne 2 -.na -\fB\fBS_IOCGETSPEED\fR\fR -.ad -.RS 17n -Returns the currently set baud rate as an integer. This may not reflect the -actual data transfer rate if external clocks are used. -.RE - -.sp -.ne 2 -.na -\fB\fBS_IOCGETMCTL\fR\fR -.ad -.RS 17n -Returns the current state of the \fBCTS\fR and \fBDCD\fR incoming modem -interface signals as an integer. -.RE - -.sp -.LP -The following structures are used with \fBzsh\fR \fBioctl()\fR commands: -.sp -.in +2 -.nf -struct scc_mode { - char sm_txclock; /* transmit clock sources */ - char sm_rxclock; /* receive clock sources */ - char sm_iflags; /* data and clock inversion flags (non-zsh) */ - uchar_t sm_config; /* boolean configuration options */ - int sm_baudrate; /* real baud rate */ - int sm_retval; /* reason codes for ioctl failures */ -}; -struct sl_stats { - long ipack; /* input packets */ - long opack; /* output packets */ - long ichar; /* input bytes */ - long ochar; /* output bytes */ - long abort; /* abort received */ - long crc; /* CRC error */ - long cts; /* CTS timeouts */ - long dcd; /* Carrier drops */ - long overrun; /* receive overrun */ - long underrun; /* transmit underrun */ - long ierror; /* input error */ - long oerror; /* output error */ - long nobuffers; /* receive side memory allocation failure */ -}; -.fi -.in -2 - -.SH ERRORS -.sp -.LP -An \fBopen()\fR will fail if a \fBSTREAMS\fR message block cannot be allocated, -or: -.sp -.ne 2 -.na -\fB\fBENXIO\fR\fR -.ad -.RS 9n -The unit being opened does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBEBUSY\fR\fR -.ad -.RS 9n -The device is in use by another serial protocol. -.RE - -.sp -.LP -An \fBioctl()\fR will fail if: -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -An attempt was made to select an invalid clocking source. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 10n -The baud rate specified for use with the baud rate generator would translate to -a null time constant in the \fBSCC\fR's registers. -.RE - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/zsh[0-1]\fR,\fB/dev/zsh\fR\fR -.ad -.sp .6 -.RS 4n -character-special devices -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/ser_sync.h\fR\fR -.ad -.sp .6 -.RS 4n -header file specifying synchronous serial communication definitions -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBsyncinit\fR(1M), \fBsyncloop\fR(1M), \fBsyncstat\fR(1M), \fBioctl\fR(2), -\fBopen\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBattributes\fR(5), \fBzs\fR(7D) -.sp -.LP -Refer to the \fIZilog Z8530 SCC Serial Communications Controller Technical -Manual\fR for details of the \fBSCC\fR's operation and capabilities. -.SH DIAGNOSTICS -.sp -.ne 2 -.na -\fB\fBzsh data open failed, no memory, rq=\fR\fInnn\fR\fR -.ad -.sp .6 -.RS 4n - -.RE - -.sp -.ne 2 -.na -\fB\fBzsh clone open failed, no memory, rq=\fR\fInnn\fR\fR -.ad -.sp .6 -.RS 4n -A kernel memory allocation failed for one of the private data structures. The -value of \fInnn\fR is the address of the read queue passed to \fBopen\fR(2). -.RE - -.sp -.ne 2 -.na -\fB\fBzsh_open: can't alloc message block\fR\fR -.ad -.sp .6 -.RS 4n -The open could not proceed because an initial \fBSTREAMS\fR message block could -not be made available for incoming data. -.RE - -.sp -.ne 2 -.na -\fB\fBzsh: clone device \fR\fId\fR\fB must be attached before use!\fR\fR -.ad -.sp .6 -.RS 4n -An operation was attempted through a control path before that path had been -attached to a particular serial channel. -.RE - -.sp -.ne 2 -.na -\fB\fBzsh\fR\fIn\fR\fB: invalid operation for clone dev.\fR\fR -.ad -.sp .6 -.RS 4n -An inappropriate \fBSTREAMS\fR message type was passed through a control path. -Only \fBM_IOCTL\fR and \fBM_PROTO\fR message types are permitted. -.RE - -.sp -.ne 2 -.na -\fB\fBzsh\fR\fIn\fR\fB: not initialized, can't send message\fR\fR -.ad -.sp .6 -.RS 4n -An \fBM_DATA\fR message was passed to the driver for a channel that had not -been programmed at least once since the driver was loaded. The \fBSCC\fR's -registers were in an unknown state. The \fBS_IOCSETMODE\fR ioctl command -performs the programming operation. -.RE - -.sp -.ne 2 -.na -\fB\fBzsh\fR\fIn\fR\fB: transmit hung\fR\fR -.ad -.sp .6 -.RS 4n -The transmitter was not successfully restarted after the watchdog timer -expired. -.RE - diff --git a/usr/src/man/man7d/zyd.7d b/usr/src/man/man7d/zyd.7d deleted file mode 100644 index 83a2912dd2..0000000000 --- a/usr/src/man/man7d/zyd.7d +++ /dev/null @@ -1,79 +0,0 @@ -'\" te -.\" Copyright (c) 2008, 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 ZYD 7D "Dec 10, 2008" -.SH NAME -zyd \- ZyDAS ZD1211/ZD1211B USB 802.11b/g Wireless Driver -.SH DESCRIPTION -.sp -.LP -The \fBzyd\fR \fI802.11b/g\fR wireless driver is a multi-threaded, loadable, -clonable, GLDv3-based STREAMS driver supporting the ZyDAS ZD1211/ZD1211B USB -chipset-based wireless devices. -.SH CONFIGURATION -.sp -.LP -The \fBzyd\fR driver performs auto-negotiation to determine the data rate and -mode. Supported \fI802.11b\fR data rates are 1, 2, 5.5 and 11 Mbits/sec. -Supported \fI802.11g\fR data rates are 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48 -and 54 Mbits/sec. The \fBzyd\fR driver supports only BSS networks (also known -as "ap" or "infrastructure" networks) and open (or "open-system"), shared key -and WPA/WPA2 authentication. Supported encryption types are WEP40, WEP104, TKIP -and AES-CCMP. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/dev/zyd*\fR\fR -.ad -.RS 25n -Special character device. -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/zyd\fR\fR -.ad -.RS 25n -32-bit kernel module (x86). -.RE - -.sp -.ne 2 -.na -\fB\fB/kernel/drv/amd64/zyd\fR\fR -.ad -.RS 25n -64-bit kernel module (x86). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdladm\fR(1M), \fBwificonfig\fR(1M), \fBattributes\fR(5), \fBgld\fR(7D), -\fBdlpi\fR(7P) -.sp -.LP -\fI802.11 - Wireless LAN Media Access Control and Physical Layer -Specification\fR - IEEE, 2001 |