diff options
author | Dan McDonald <danmcd@joyent.com> | 2021-06-18 11:27:14 -0400 |
---|---|---|
committer | Dan McDonald <danmcd@joyent.com> | 2021-06-18 11:27:21 -0400 |
commit | 179a42abb379d203e6ff3867a77f8be89e1ac5e9 (patch) | |
tree | e2f9d8d8edb9b86983e5f754a24b3b6427f9e64a | |
parent | 43e443cf314f0181bdd958df4333caa1aee086c8 (diff) | |
parent | 26e7d9a88aea4fa6939315466aa8b8b9946409d8 (diff) | |
download | illumos-joyent-179a42abb379d203e6ff3867a77f8be89e1ac5e9.tar.gz |
[illumos-gate merge]
commit 26e7d9a88aea4fa6939315466aa8b8b9946409d8
13856 findunref runs too early
commit b7afa311209be3c026130832cda2a5199c7f44e1
13855 example code in ddi_dmae_req(9S) isn't code
commit 3184921aa9155f2314caa4909eba31a0be558b3d
13854 manual should say "illumos DDI"
Conflicts:
usr/src/man/man9f/ddi_fm_init.9f
443 files changed, 683 insertions, 5735 deletions
diff --git a/usr/src/man/man3devinfo/di_walk_minor.3devinfo b/usr/src/man/man3devinfo/di_walk_minor.3devinfo index 60f87ea80a..88a5722aaa 100644 --- a/usr/src/man/man3devinfo/di_walk_minor.3devinfo +++ b/usr/src/man/man3devinfo/di_walk_minor.3devinfo @@ -7,7 +7,6 @@ .SH NAME di_walk_minor \- traverse libdevinfo minor nodes .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldevinfo\fR [ \fIlibrary\fR... ] #include <libdevinfo.h> @@ -18,7 +17,6 @@ di_walk_minor \- traverse libdevinfo minor nodes .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIarg\fR\fR @@ -52,7 +50,7 @@ The minor node visited. .ad .RS 18n A character string specifying the minor data type, which may be one of the -types defined by the Solaris DDI framework, for example, \fBDDI_NT_BLOCK\fR. +types defined by the illumos DDI framework, for example, \fBDDI_NT_BLOCK\fR. \fBNULL\fR matches all \fIminor_node\fR types. See \fBddi_create_minor_node\fR(9F). .RE @@ -76,16 +74,12 @@ Root of subtree to visit. .RE .SH DESCRIPTION -.sp -.LP The \fBdi_walk_minor()\fR function visits all minor nodes attached to device nodes in a subtree rooted at \fIroot\fR. For each minor node that matches \fIminor_nodetype\fR, the caller-supplied function \fIminor_callback\fR() is invoked. The walk terminates immediately when \fIminor_callback\fR() returns \fBDI_WALK_TERMINATE\fR. .SH RETURN VALUES -.sp -.LP Upon successful completion, \fBdi_walk_minor()\fR returns 0. Otherwise, -1 is returned and errno is set to indicate the error. .sp @@ -110,8 +104,6 @@ Terminate the walk immediately. .RE .SH ERRORS -.sp -.LP The \fBdi_walk_minor()\fR function will fail if: .sp .ne 2 @@ -123,8 +115,6 @@ Invalid argument. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -141,8 +131,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBdladm\fR(1M), \fBdi_minor_nodetype\fR(3DEVINFO), dlpi_walk(3DLPI), \fBlibdevinfo\fR(3LIB), \fBattributes\fR(5), \fBfilesystem\fR(5), \fBddi_create_minor_node\fR(9F) @@ -150,14 +138,12 @@ MT-Level Safe .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The \fBdi_walk_minor()\fR function is no longer an accurate method for walking network datalink interfaces on the system. Applications should use \fBdlpi_walk\fR(3DLPI) instead. It has been common for applications to use \fBdi_walk_minor()\fR to walk networking devices by passing in a \fBminor_nodetype\fR of \fBDDI_NT_NET\fR, in most cases to discover the set of -DLPI devices on the system. Solaris now makes a layering distinction between +DLPI devices on the system. illumos now makes a layering distinction between networking devices (the objects displayed in the \fBDEVICE\fR field by \fBdladm\fR \fBshow-phys\fR) and network datalink interfaces (the objects displayed by \fBdladm\fR \fBshow-link\fR). Datalink interfaces are represented diff --git a/usr/src/man/man4/scsi.4 b/usr/src/man/man4/scsi.4 index 70050596a9..76346a4d0a 100644 --- a/usr/src/man/man4/scsi.4 +++ b/usr/src/man/man4/scsi.4 @@ -7,9 +7,7 @@ .SH NAME scsi \- configuration files for SCSI target drivers .SH DESCRIPTION -.sp -.LP -The architecture of the Solaris \fBSCSI\fR subsystem distinguishes two types of +The architecture of the illumos \fBSCSI\fR subsystem distinguishes two types of device drivers: \fBSCSI\fR target drivers, and \fBSCSI\fR host adapter drivers. Target drivers like \fBsd\fR(7D) and \fBst\fR(7D) manage the device on the other end of the \fBSCSI\fR bus. Host adapter drivers manage the \fBSCSI\fR bus @@ -18,7 +16,7 @@ on behalf of all the devices that share it. .LP Drivers for host adapters provide a common set of interfaces for target drivers. These interfaces comprise the Sun Common \fBSCSI\fR Architecture ( -\fBSCSA)\fR which are documented as part of the Solaris DDI/DKI. See +\fBSCSA)\fR which are documented as part of the illumos DDI/DKI. See \fBscsi_ifgetcap\fR(9F), \fBscsi_init_pkt\fR(9F), and \fBscsi_transport\fR(9F) for further details of these, and associated routines. .sp @@ -33,8 +31,6 @@ the Fibre Channel interconnects, \fBfcp\fR(7D), \fBifp\fR(7D), interconnects target devices by using the target driver \fBdriver.conf\fR(4) configuration files. .SS "Self-Identifying" -.sp -.LP Host adapter drivers of class scsi-self-identifying that dynamically create self-identifying target device children establish a \fBcompatible\fR property on each child. The compatible property is an ordered array of strings, each @@ -203,12 +199,10 @@ characters. .sp .LP -Solaris might create additional \fBcompatible\fR forms not described. These -forms are for Solaris internal use only. Any additional use of these forms is -discouraged. Future releases of Solaris might not produce these forms. +illumos might create additional \fBcompatible\fR forms not described. These +forms are for illumos internal use only. Any additional use of these forms is +discouraged. Future releases of illumos might not produce these forms. .SS "driver.conf" -.sp -.LP Configuration files for \fBSCSI\fR target drivers should identify the host adapter driver implicitly using the \fIclass\fR keyword to remove any dependency on the particular host adapter involved. @@ -247,12 +241,11 @@ target driver configuration file stub device definitions must be defined by property class or parent. .sp .LP -The \fBSCSI\fR target driver configuration files shipped with Solaris have +The \fBSCSI\fR target driver configuration files shipped with illumos have entries for \fBLUN\fR \fB0\fR only. For devices that support other \fBLUNs,\fR such as some \fBCD\fR changers, the system administrator can edit the driver configuration file to add entries for other \fBLUNs.\fR .SH EXAMPLES -.LP \fBExample 1 \fRAn Example Configuration File for a SCSI Target Driver .sp .LP @@ -291,7 +284,7 @@ name="sd" class="scsi" target=3 lun=5; .sp .LP It is not necessary to add the line for \fBLUN\fR \fB0\fR, as it already exists -in the file shipped with Solaris. +in the file shipped with illumos. .LP \fBExample 2 \fRA Stub Device Definition of \fBsd.conf\fR @@ -310,8 +303,6 @@ name="sd" class="scsi-self-identifying"; .sp .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -326,8 +317,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBadd_drv\fR(1M), \fBrem_drv\fR(1M), \fBupdate_drv\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcp\fR(7D), \fBifp\fR(7D), \fBsata\fR(7D), \fBscsi_vhci\fR(7D), \fBsd\fR(7D), \fBsf\fR(7D), \fBst\fR(7D), @@ -348,8 +337,6 @@ Interface Stability Committed .LP \fIIEEE 1275 SCSI Target Device Binding\fR .SH NOTES -.sp -.LP With \fBdriver.conf\fR(4) configuration, you need to ensure that the \fBtarget\fR and \fBlun\fR values claimed by your target driver do not conflict with existing target drivers on the system. For example, if the target is a diff --git a/usr/src/man/man7d/gld.7d b/usr/src/man/man7d/gld.7d index dd0e016540..74e1db2052 100644 --- a/usr/src/man/man7d/gld.7d +++ b/usr/src/man/man7d/gld.7d @@ -7,7 +7,6 @@ .SH NAME gld \- Generic \fBLAN\fR Driver .SH SYNOPSIS -.LP .nf \fB#include\fR \fB<sys/stropts.h>\fR .fi @@ -28,15 +27,11 @@ gld \- Generic \fBLAN\fR Driver .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH DESCRIPTION -.sp -.LP GLD is a multi-threaded, clonable, loadable kernel module providing support for -Solaris local area network (\fBLAN\fR) device drivers. \fBLAN\fR drivers in -Solaris are \fBSTREAMS\fR-based drivers that use the Data Link Provider +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 @@ -44,11 +39,11 @@ 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 a Solaris -LAN driver. Several Solaris network drivers are implemented using GLD. +GLD implements most \fBSTREAMS\fR and DLPI functionality required of an illumos +LAN driver. Several illumos network drivers are implemented using GLD. .sp .LP -A Solaris network driver implemented using GLD comprises two distinct parts: a +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 @@ -71,7 +66,7 @@ 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 Solaris. +removed in a future release of illumos. .RE .sp .LP @@ -80,13 +75,9 @@ 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" -.sp -.LP 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)" -.sp -.LP 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 @@ -114,12 +105,11 @@ 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" -.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 Solaris. +removed in a future release of illumos. .RE .sp .LP @@ -153,12 +143,11 @@ 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" -.LP Note - .sp .RS 2 Support for the DL_TPR media type in GLD is obsolete and may be removed in a -future release of Solaris. +future release of illumos. .RE .sp .LP @@ -180,8 +169,6 @@ 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" -.sp -.LP 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 @@ -195,8 +182,6 @@ 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" -.sp -.LP GLD implements the following DLPI primitives: .sp .LP @@ -301,14 +286,10 @@ primitive will be successful. 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" -.sp -.LP 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" -.sp -.LP GLD-based drivers must include the header file \fB<sys/gld.h>\fR\&. .sp .LP @@ -462,9 +443,7 @@ 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" -.sp -.LP -Solaris network drivers must implement statistics variables. GLD itself tallies +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 @@ -1016,7 +995,6 @@ Number of times the ring has entered the ``Ring_Operational'' state from the .RE .SH FILES -.sp .ne 2 .na \fB\fB/kernel/misc/gld\fR \fR @@ -1026,8 +1004,6 @@ loadable kernel module .RE .SH SEE ALSO -.sp -.LP \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) @@ -1035,8 +1011,6 @@ loadable kernel module .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP 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. diff --git a/usr/src/man/man9e/Intro.9e b/usr/src/man/man9e/Intro.9e index 5c18acbee2..37e3f95013 100644 --- a/usr/src/man/man9e/Intro.9e +++ b/usr/src/man/man9e/Intro.9e @@ -9,20 +9,14 @@ Intro, intro \- overview of device driver interfaces and introduction to driver entry points .SH DESCRIPTION -.sp -.LP This page provides an overview of device driver interfaces and all of the Section 9 man pages (9E, 9F, 9P, and 9S). This overview is followed by an introduction to Section 9E, the driver entry-point routines. .SS "Overview of Device Driver Interfaces" -.sp -.LP Section 9 provides reference information needed to write device drivers for the -Solaris operating environment. It describes the interfaces provided by the +illumos operating system. It describes the interfaces provided by the Device Driver Interface and the Driver-Kernel Interface (DDI/DKI). .SS "Porting" -.sp -.LP Software is usually considered portable if it can be adapted to run in a different environment more cheaply than it can be rewritten. The new environment may include a different processor, operating system, and even the @@ -75,8 +69,6 @@ computers of the same family. Although they may run the same operating system as those being replaced, architecture-specific code may prevent the software from porting. .SS "Scope of Interfaces" -.sp -.LP Although application programs have all of the porting problems mentioned, developers attempting to port device drivers have special challenges. Before describing the DDI/DKI, it is necessary to understand the position of device @@ -115,8 +107,6 @@ Driver-Boot/Configuration Software. The interaction between the driver and the boot and configuration software is the third interface affecting drivers. .RE .SS "Scope of the DDI/DKI" -.sp -.LP The primary goal of the DDI/DKI is to facilitate both source and binary portability across successive releases of the operating systems on a particular machine. In addition, it promotes source portability across implementations of @@ -141,21 +131,21 @@ class, \fBsegmap\fR(9E) and \fBhat_getkpfnum\fR(9F) .TP .ie t \(bu .el o -Solaris DDI - These interfaces specific to Solaris. +illumos DDI - These interfaces specific to illumos. .RE .RS +4 .TP .ie t \(bu .el o -Solaris SPARC specific DDI - These interfaces are specific to the SPARC -processor, and may not be available on other processors supported by Solaris. +illumos SPARC specific DDI - These interfaces are specific to the SPARC +processor, and may not be available on other processors supported by illumos. .RE .RS +4 .TP .ie t \(bu .el o -Solaris x86 specific DDI - These interfaces are specific to the x86 processor, -and may not be available on other processors supported by Solaris. +illumos x86 specific DDI - These interfaces are specific to the x86 processor, +and may not be available on other processors supported by illumos. .RE .sp .LP @@ -185,23 +175,17 @@ The headers \fB<sys/ddi.h>\fR and \fB<sys/sunddi.h>\fR must be the last header files included by the driver. .RE .SS "Audience" -.sp -.LP Section 9 is for software engineers responsible for creating, modifying, or maintaining drivers that run on this operating system and beyond. It assumes that the reader is familiar with system internals and the C programming language. .SS "PCMCIA Standard" -.sp -.LP The \fIPC\fR \fICard\fR \fI95\fR \fIStandard\fR is listed under the \fBSEE\fR \fBALSO\fR heading in some Section 9 reference pages. This refers to documentation published by the Personal Computer Memory Card International Association (PCMCIA) and the Japan Electronic Industry Development Association (JEIDA). .SS "How to Use Section 9" -.sp -.LP Section 9 is divided into the following subsections: .sp .ne 2 @@ -241,8 +225,6 @@ Data Structures - contains reference pages for driver-related structures. .RE .SS "Compatibility Note" -.sp -.LP Sun Microsystem's implementation of the DDI/DKI was designed to provide binary compatibility for third-party device drivers across currently supported hardware platforms across minor releases of the operating system. However, @@ -251,8 +233,6 @@ DDI/DKI. We cannot therefore promise or in any way assure that DDI/DKI-compliant device drivers will continue to operate correctly on future releases. .SS "Introduction to Section 9E" -.sp -.LP Section 9E describes the entry-point routines a developer can include in a device driver. These are called entry-point because they provide the calling and return syntax from the kernel into the driver. Entry-points are called, for @@ -309,8 +289,6 @@ discouraged. \fBSEE ALSO\fR gives sources for further information. .RE .SS "Overview of Driver Entry-Point Routines and Naming Conventions" -.sp -.LP By convention, a prefix string is added to the driver routine names. For a driver with the prefix \fIprefix\fR, the driver code may contain routines named \fIprefix\fRopen, \fIprefix\fRclose, \fIprefix\fRread, \fIprefix\fRwrite, and @@ -351,51 +329,51 @@ c c l l . \fBRoutine\fR \fBType \fR _ -\fB_fini\fR Solaris DDI -\fB_info\fR Solaris DDI -\fB_init\fR Solaris DDI -\fBaread\fR Solaris DDI -\fBattach\fR Solaris DDI -\fBawrite\fR Solaris DDI +\fB_fini\fR illumos DDI +\fB_info\fR illumos DDI +\fB_init\fR illumos DDI +\fBaread\fR illumos DDI +\fBattach\fR illumos DDI +\fBawrite\fR illumos DDI \fBchpoll\fR DDI/DKI \fBclose\fR DDI/DKI -\fBdetach\fR Solaris DDI -\fBdevmap\fR Solaris DDI -\fBdevmap_access\fR Solaris DDI -\fBdevmap_contextmgt\fR Solaris DDI -\fBdevmap_dup\fR Solaris DDI -\fBdevmap_map\fR Solaris DDI -\fBdevmap_unmap\fR Solaris DDI -\fBdump\fR Solaris DDI -\fBgetinfo\fR Solaris DDI -\fBidentify\fR Solaris DDI +\fBdetach\fR illumos DDI +\fBdevmap\fR illumos DDI +\fBdevmap_access\fR illumos DDI +\fBdevmap_contextmgt\fR illumos DDI +\fBdevmap_dup\fR illumos DDI +\fBdevmap_map\fR illumos DDI +\fBdevmap_unmap\fR illumos DDI +\fBdump\fR illumos DDI +\fBgetinfo\fR illumos DDI +\fBidentify\fR illumos DDI \fBioctl\fR DDI/DKI -\fBks_update\fR Solaris DDI -\fBmapdev_access\fR Solaris DDI -\fBmapdev_dup\fR Solaris DDI -\fBmapdev_free\fR Solaris DDI +\fBks_update\fR illumos DDI +\fBmapdev_access\fR illumos DDI +\fBmapdev_dup\fR illumos DDI +\fBmapdev_free\fR illumos DDI \fBmmap\fR DKI only \fBopen\fR DDI/DKI -\fBpower\fR Solaris DDI +\fBpower\fR illumos DDI \fBprint\fR DDI/DKI -\fBprobe\fR Solaris DDI -\fBprop_op\fR Solaris DDI +\fBprobe\fR illumos DDI +\fBprop_op\fR illumos DDI \fBread\fR DDI/DKI \fBsegmap\fR DKI only \fBstrategy\fR DDI/DKI -\fBtran_abort\fR Solaris DDI -\fBtran_destroy_pkt\fR Solaris DDI -\fBtran_dmafree\fR Solaris DDI -\fBtran_getcap\fR Solaris DDI -\fBtran_init_pkt\fR Solaris DDI -\fBtran_reset\fR Solaris DDI -\fBtran_reset_notify\fR Solaris DDI -\fBtran_setcap\fR Solaris DDI -\fBtran_start\fR Solaris DDI -\fBtran_sync_pkt\fR Solaris DDI -\fBtran_tgt_free\fR Solaris DDI -\fBtran_tgt_init\fR Solaris DDI -\fBtran_tgt_probe\fR Solaris DDI +\fBtran_abort\fR illumos DDI +\fBtran_destroy_pkt\fR illumos DDI +\fBtran_dmafree\fR illumos DDI +\fBtran_getcap\fR illumos DDI +\fBtran_init_pkt\fR illumos DDI +\fBtran_reset\fR illumos DDI +\fBtran_reset_notify\fR illumos DDI +\fBtran_setcap\fR illumos DDI +\fBtran_start\fR illumos DDI +\fBtran_sync_pkt\fR illumos DDI +\fBtran_tgt_free\fR illumos DDI +\fBtran_tgt_init\fR illumos DDI +\fBtran_tgt_probe\fR illumos DDI \fBwrite\fR DDI/DKI .TE @@ -474,11 +452,9 @@ EINTR EIO EINTR EINTR EINVAL ENXIO EINVAL EINVAL EIO EIO EIO ENXIO ENXIO ENXIO -EPERM EPERM -EROFS +EPERM EPERM +EROFS .TE .SH SEE ALSO -.sp -.LP \fBIntro\fR(9F), \fBIntro\fR(9S) diff --git a/usr/src/man/man9e/_fini.9e b/usr/src/man/man9e/_fini.9e index 72bfbb8979..a585779c3e 100644 --- a/usr/src/man/man9e/_fini.9e +++ b/usr/src/man/man9e/_fini.9e @@ -26,7 +26,7 @@ _fini, _info, _init \- loadable module configuration entry points .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI). These entry points are required. You must +illumos DDI specific (illumos DDI). These entry points are required. You must write them. .SH PARAMETERS .SS "_info(\|)" diff --git a/usr/src/man/man9e/aread.9e b/usr/src/man/man9e/aread.9e index c163e35f18..e640836684 100644 --- a/usr/src/man/man9e/aread.9e +++ b/usr/src/man/man9e/aread.9e @@ -8,7 +8,6 @@ .SH NAME aread \- asynchronous read from a device .SH SYNOPSIS -.LP .nf #include <sys/uio.h> #include <sys/aio_req.h> @@ -21,13 +20,10 @@ int\fIprefix\fR .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRspecific (Solaris DDI). This entry point is \fIoptional\fR. +illumos \fBDDI \fRspecific (illumos DDI). This entry point is \fIoptional\fR. Drivers that do not support an \fBaread()\fR entry point should use \fBnodev\fR(9F) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdev\fR \fR @@ -56,8 +52,6 @@ Pointer to the credential structure. .RE .SH DESCRIPTION -.sp -.LP The driver's \fBaread()\fR routine is called to perform an asynchronous read. \fBgetminor\fR(9F) can be used to access the minor number component of the \fIdev\fR argument. \fBaread()\fR may use the credential structure pointed to @@ -72,16 +66,11 @@ No fields of the \fBuio\fR(9S) structure pointed to by \fBaio_req\fR, other than \fBuio_offset\fR or \fBuio_loffset\fR, may be modified for non-seekable devices. .SH RETURN VALUES -.sp -.LP The \fBaread()\fR routine should return \fB0\fR for success, or the appropriate error number. .SH CONTEXT -.sp -.LP This function is called from user context only. .SH EXAMPLES -.LP \fBExample 1 \fRThe following is an example of an \fBaread()\fR routine: .sp .in +2 @@ -97,14 +86,12 @@ xxaread(dev_t dev, struct aio_req *aio, cred_t *cred_p) if (xsp == NULL) return (ENXIO); return (aphysio(xxstrategy, anocancel, - dev, B_READ, xxminphys, aio)); + dev, B_READ, xxminphys, aio)); } .fi .in -2 .SH SEE ALSO -.sp -.LP \fBread\fR(2), \fBaioread\fR(3C), \fBawrite\fR(9E), \fBread\fR(9E), \fBstrategy\fR(9E), \fBwrite\fR(9E), \fBanocancel\fR(9F), \fBaphysio\fR(9F), \fBddi_get_soft_state\fR(9F), \fBdrv_priv\fR(9F), \fBgetminor\fR(9F), @@ -114,7 +101,5 @@ xxaread(dev_t dev, struct aio_req *aio, cred_t *cred_p) .LP \fIWriting Device Drivers\fR .SH BUGS -.sp -.LP There is no way other than calling \fBaphysio\fR(9F) to accomplish an asynchronous read. diff --git a/usr/src/man/man9e/attach.9e b/usr/src/man/man9e/attach.9e index 39ec5635cc..47f85a44c4 100644 --- a/usr/src/man/man9e/attach.9e +++ b/usr/src/man/man9e/attach.9e @@ -7,7 +7,6 @@ .SH NAME attach \- Attach a device to the system, or resume it .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ attach \- Attach a device to the system, or resume it .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -43,13 +39,9 @@ values are passed to it. .RE .SH DESCRIPTION -.sp -.LP The \fBattach\fR(9E) function is the device-specific initialization entry point. This entry point is \fBrequired\fR and must be written. .SS "DDI_ATTACH" -.sp -.LP The \fBDDI_ATTACH\fR command must be provided in the \fBattach\fR(9E) entry point. \fBDDI_ATTACH\fR is used to initialize a given device instance. When \fBattach\fR(9E) is called with \fIcmd\fR set to \fBDDI_ATTACH\fR, all normal @@ -72,8 +64,6 @@ function can be used to set the power level of a component. This function must not be called before data structures referenced in \fBpower\fR(9E) have been initialized. .SS "DDI_RESUME" -.sp -.LP The \fBattach()\fR function may be called with \fIcmd\fR set to \fBDDI_RESUME\fR after \fBdetach\fR(9E) has been successfully called with \fIcmd\fR set to \fBDDI_SUSPEND\fR. @@ -121,8 +111,6 @@ an operation on the device as part of its \fBDDI_RESUME\fR processing (such as loading firmware so that it can detect hot-plug events). .RE .SH RETURN VALUES -.sp -.LP The \fBattach()\fR function returns: .sp .ne 2 @@ -143,8 +131,6 @@ Operation failed .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -159,8 +145,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBcpr\fR(7), \fBpm\fR(7D), \fBpm\fR(9P), \fBpm-components\fR(9P), \fBdetach\fR(9E), \fBgetinfo\fR(9E), \fBidentify\fR(9E), \fBopen\fR(9E), \fBpower\fR(9E), \fBprobe\fR(9E), \fBddi_add_intr\fR(9F), diff --git a/usr/src/man/man9e/awrite.9e b/usr/src/man/man9e/awrite.9e index 17752ab754..fb19606f7c 100644 --- a/usr/src/man/man9e/awrite.9e +++ b/usr/src/man/man9e/awrite.9e @@ -20,7 +20,7 @@ awrite \- asynchronous write to a device .fi .SH INTERFACE LEVEL -Solaris \fBDDI \fRspecific (Solaris DDI). This entry point is optional. Drivers +illumos \fBDDI \fRspecific (illumos DDI). This entry point is optional. Drivers that do not support an \fBawrite()\fR entry point should use \fBnodev\fR(9F) .SH PARAMETERS .ne 2 diff --git a/usr/src/man/man9e/csx_event_handler.9e b/usr/src/man/man9e/csx_event_handler.9e index 66a4369844..4d0453e17e 100644 --- a/usr/src/man/man9e/csx_event_handler.9e +++ b/usr/src/man/man9e/csx_event_handler.9e @@ -7,7 +7,6 @@ .SH NAME csx_event_handler \- PC Card driver event handler .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_event_handler \- PC Card driver event handler .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris \fBDDI) \fR +illumos architecture specific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIevent\fR\fR @@ -50,8 +46,6 @@ A pointer to the \fBevent_callback_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP Each instance of a \fBPC \fRCard driver must register an event handler to manage events associated with its \fBPC \fRCard. The driver event handler is registered using the \fBevent_handler\fR field of the \fBclient_req_t\fR @@ -81,8 +75,6 @@ events begin to be delivered to the driver until after a successful call to In all cases, Card Services delivers an event to each driver instance associated with a function on a multiple function \fBPC \fRCard. .SS "Event Indications" -.sp -.LP The events and their indications are listed below; they are always delivered as low priority unless otherwise noted: .sp @@ -413,8 +405,6 @@ Card is write protected. .RE .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBevent_callback_args_t\fR are: .sp .in +2 @@ -445,7 +435,6 @@ char DriverName[MODMAXNAMELEN]; .in -2 .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -473,12 +462,9 @@ Error occurred while handling this event. .RE .SH CONTEXT -.sp -.LP This function is called from high-level interrupt context in the case of high priority events, and from kernel context in the case of low priority events. .SH EXAMPLES -.sp .in +2 .nf static int @@ -566,8 +552,6 @@ xx_event(event_t event, int priority, event_callback_args_t *args) .in -2 .SH SEE ALSO -.sp -.LP \fBcsx_Event2Text\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_RequestSocketMask\fR(9F) .sp diff --git a/usr/src/man/man9e/detach.9e b/usr/src/man/man9e/detach.9e index 544cb7536e..a181748c14 100644 --- a/usr/src/man/man9e/detach.9e +++ b/usr/src/man/man9e/detach.9e @@ -7,7 +7,6 @@ .SH NAME detach \- detach or suspend a device .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,8 +17,7 @@ detach \- detach or suspend a device .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -40,10 +38,8 @@ than \fBDDI_DETACH\fR or \fBDDI_SUSPEND\fR is passed to it. .RE .SH DESCRIPTION -.LP The \fBdetach()\fR function complements the \fBattach\fR(9E) routine. .SS "DDI_DETACH" -.LP If \fIcmd\fR is set to \fBDDI_DETACH\fR, \fBdetach()\fR is used to remove the state associated with a given instance of a device node prior to the removal of that instance from the system. @@ -79,7 +75,6 @@ The system guarantees that the function will only be called for a particular will only be called when there are no outstanding \fBopen\fR(9E) calls on the device. .SS "DDI_SUSPEND" -.LP The \fBDDI_SUSPEND\fR \fIcmd\fR is issued when the entire system is being suspended and power removed from it or when the system must be made quiescent. It will be issued only to devices which have a \fBreg\fR property or which @@ -138,10 +133,8 @@ unchanged. .RE .SH CONTEXT -.LP This function is called from user context only. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -156,7 +149,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBcpr\fR(7), \fBpm\fR(7D), \fBpm\fR(9P), \fBpm-components\fR(9P), \fBattach\fR(9E), \fBdump\fR(9E), \fBopen\fR(9E), \fBpower\fR(9E), \fBddi_add_intr\fR(9F), \fBddi_dev_is_needed\fR(9F), \fBddi_map_regs\fR(9F), diff --git a/usr/src/man/man9e/devmap.9e b/usr/src/man/man9e/devmap.9e index 09a65be767..d1bada6827 100644 --- a/usr/src/man/man9e/devmap.9e +++ b/usr/src/man/man9e/devmap.9e @@ -8,7 +8,6 @@ .SH NAME devmap \- validate and translate virtual mapping for memory mapped device .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -20,11 +19,8 @@ devmap \- validate and translate virtual mapping for memory mapped device .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdev\fR \fR @@ -80,8 +76,6 @@ The data model type of the current thread. .RE .SH DESCRIPTION -.sp -.LP \fBdevmap()\fR is a required entry point for character drivers supporting memory-mapped devices if the drivers use the devmap framework to set up the mapping. A memory mapped device has memory that can be mapped into a process's @@ -174,7 +168,6 @@ within the register address space to \fBdevmap_devmem_setup\fR(9F). For kernel memory mapping, the system selects a user virtual address that is aligned with the kernel address being mapped for cache coherence. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR \fR @@ -193,7 +186,6 @@ An error occurred. .RE .SH EXAMPLES -.LP \fBExample 1 \fRImplementing the \fBdevmap()\fR Entry Point .sp .LP @@ -294,8 +286,6 @@ xxdevmap(dev_t dev, devmap_cookie_t dhp, offset_t off, size_t len, .in -2 .SH SEE ALSO -.sp -.LP \fBmmap\fR(2), \fBattach\fR(9E), \fBdetach\fR(9E), \fBmmap\fR(9E), \fBsegmap\fR(9E), \fBddi_devmap_segmap\fR(9F), \fBddi_model_convert_from\fR(9F), \fBddi_soft_state\fR(9F), diff --git a/usr/src/man/man9e/devmap_access.9e b/usr/src/man/man9e/devmap_access.9e index 47d4e9b630..d154eedfcb 100644 --- a/usr/src/man/man9e/devmap_access.9e +++ b/usr/src/man/man9e/devmap_access.9e @@ -7,7 +7,6 @@ .SH NAME devmap_access \- device mapping access entry point .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ devmap_access \- device mapping access entry point .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdhp\fR \fR @@ -132,8 +128,6 @@ Execution access attempted. .RE .SH DESCRIPTION -.sp -.LP The \fBdevmap_access()\fR entry point is an optional routine. It notifies drivers whenever an access is made to a mapping described by \fIdhp\fR that has not been validated or does not have sufficient protection for the access. @@ -167,8 +161,6 @@ drivers should perform on the memory object. If \fBtype\fR is either A non-zero return value from \fBdevmap_access()\fR may result in a \fBSIGSEGV\fR or \fBSIGBUS\fR signal being delivered to the process. .SH RETURN VALUES -.sp -.LP \fBdevmap_access()\fR returns the following values: .sp .ne 2 @@ -190,7 +182,6 @@ An error occurred. The return value from \fBdevmap_do_ctxmgt\fR(9F) or .RE .SH EXAMPLES -.LP \fBExample 1 \fR\fBdevmap_access()\fR entry point .sp .LP @@ -263,8 +254,6 @@ xxdevmap_access(devmap_cookie_t dhp, void *pvtp, offset_t off, .in -2 .SH SEE ALSO -.sp -.LP \fBdevmap_map\fR(9E), \fBdevmap_default_access\fR(9F), \fBdevmap_do_ctxmgt\fR(9F), \fBdevmap_callback_ctl\fR(9S) .sp diff --git a/usr/src/man/man9e/devmap_contextmgt.9e b/usr/src/man/man9e/devmap_contextmgt.9e index 2eda12f9a2..83b8089329 100644 --- a/usr/src/man/man9e/devmap_contextmgt.9e +++ b/usr/src/man/man9e/devmap_contextmgt.9e @@ -7,7 +7,6 @@ .SH NAME devmap_contextmgt \- driver callback function for context management .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ devmap_contextmgt \- driver callback function for context management .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdhp\fR \fR @@ -123,8 +119,6 @@ Write access attempted. .RE .SH DESCRIPTION -.sp -.LP \fBdevmap_contextmgt()\fR is a driver-supplied function that performs device context switching on a mapping. Device drivers pass \fBdevmap_contextmgt()\fR as an argument to \fBdevmap_do_ctxmgt\fR(9F) in the \fBdevmap_access\fR(9E) @@ -163,7 +157,6 @@ A non-zero return value from \fBdevmap_contextmgt()\fR will be returned to failure may result in a \fBSIGSEGV\fR or \fBSIGBUS\fR signal being delivered to the process. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR \fR @@ -182,7 +175,6 @@ An error occurred. .RE .SH EXAMPLES -.LP \fBExample 1 \fRmanaging a device context .sp .LP @@ -232,8 +224,6 @@ xxdevmap_contextmgt(devmap_cookie_t dhp, void *pvtp, offset_t off, .in -2 .SH SEE ALSO -.sp -.LP \fBdevmap_access\fR(9E), \fBdevmap_do_ctxmgt\fR(9F) \fBdevmap_load\fR(9F), \fBdevmap_unload\fR(9F) .sp diff --git a/usr/src/man/man9e/devmap_dup.9e b/usr/src/man/man9e/devmap_dup.9e index 1225ba19bf..6b4b68088c 100644 --- a/usr/src/man/man9e/devmap_dup.9e +++ b/usr/src/man/man9e/devmap_dup.9e @@ -7,7 +7,6 @@ .SH NAME devmap_dup \- device mapping duplication entry point .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h @@ -19,11 +18,8 @@ devmap_dup \- device mapping duplication entry point .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdhp\fR \fR @@ -63,8 +59,6 @@ data for the duplicated device mapping. .RE .SH DESCRIPTION -.sp -.LP The system calls \fBdevmap_dup()\fR when a device mapping is duplicated, such as during the execution of the \fBfork\fR(2) system call. The system expects \fBdevmap_dup()\fR to generate new driver private data for the new mapping, and @@ -75,8 +69,6 @@ mapped object. A non-zero return value from \fBdevmap_dup()\fR will cause a corresponding operation such as \fBfork()\fR to fail. .SH RETURN VALUES -.sp -.LP \fBdevmap_dup()\fR returns the following values: .sp .ne 2 @@ -97,7 +89,6 @@ An error occurred. .RE .SH EXAMPLES -.sp .in +2 .nf static int @@ -125,8 +116,6 @@ xxdevmap_dup(devmap_cookie_t dhp, void *pvtp, \e .in -2 .SH SEE ALSO -.sp -.LP \fBfork\fR(2), \fBdevmap_callback_ctl\fR(9S) .sp .LP diff --git a/usr/src/man/man9e/devmap_map.9e b/usr/src/man/man9e/devmap_map.9e index c458ab1e64..741a7e9e55 100644 --- a/usr/src/man/man9e/devmap_map.9e +++ b/usr/src/man/man9e/devmap_map.9e @@ -7,7 +7,6 @@ .SH NAME devmap_map \- device mapping create entry point .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ devmap_map \- device mapping create entry point .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdhp\fR \fR @@ -98,8 +94,6 @@ data. .RE .SH DESCRIPTION -.sp -.LP The \fBdevmap_map()\fR entry point is an optional routine that allows drivers to perform additional processing or to allocate private resources during the mapping setup time. For example, in order for device drivers to support @@ -134,8 +128,6 @@ not the driver should allocate a private context for the mapping. For example, a driver may allocate a memory region to store the device context if \fIflags\fR is set to \fBMAP_PRIVATE\fR. .SH RETURN VALUES -.sp -.LP \fBdevmap_map()\fR returns the following values: .sp .ne 2 @@ -156,7 +148,6 @@ An error occurred. .RE .SH EXAMPLES -.LP \fBExample 1 \fR \fBdevmap_map()\fRimplementation .sp .LP @@ -189,8 +180,6 @@ xxdevmap_map(devmap_cookie_t dhp, dev_t dev, uint_t flags, \e .in -2 .SH SEE ALSO -.sp -.LP \fBdevmap_unmap\fR(9E), \fBdevmap_unload\fR(9F), \fBdevmap_callback_ctl\fR(9S) .sp .LP diff --git a/usr/src/man/man9e/devmap_unmap.9e b/usr/src/man/man9e/devmap_unmap.9e index 545a002603..bd23ec56c4 100644 --- a/usr/src/man/man9e/devmap_unmap.9e +++ b/usr/src/man/man9e/devmap_unmap.9e @@ -7,7 +7,6 @@ .SH NAME devmap_unmap \- device mapping unmap entry point .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -20,11 +19,8 @@ devmap_unmap \- device mapping unmap entry point .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdhp\fR \fR @@ -103,8 +99,6 @@ for the new region that begins at (\fIoff\fR + \fIlen\fR); ignored if .RE .SH DESCRIPTION -.sp -.LP \fBdevmap_unmap()\fR is called when the system removes the mapping in the range [ \fIoff\fR, \fIoff\fR + \fIlen\fR ], such as in the \fBmunmap\fR(2) or \fBexit\fR(2) system calls. Device drivers use \fBdevmap_unmap()\fR to free up @@ -146,7 +140,6 @@ example, stored in \fIpvtp\fR) and to set \fI*new_pvtp1\fR to point to it. The drivers should free up the driver private data, \fIpvtp\fR, previously allocated in \fBdevmap_map\fR(9E) before returning to the system. .SH EXAMPLES -.LP \fBExample 1 \fR\fBdevmap_unmap()\fR implementation .sp .in +2 @@ -193,8 +186,6 @@ xxdevmap_unmap(devmap_cookie_t dhp, void *pvtp, offset_t off, .in -2 .SH SEE ALSO -.sp -.LP \fBexit\fR(2), \fBmunmap\fR(2), \fBdevmap_map\fR(9E), \fBdevmap_callback_ctl\fR(9S) .sp diff --git a/usr/src/man/man9e/dump.9e b/usr/src/man/man9e/dump.9e index 9d35b0dce0..b3a395697e 100644 --- a/usr/src/man/man9e/dump.9e +++ b/usr/src/man/man9e/dump.9e @@ -7,7 +7,6 @@ .SH NAME dump \- dump memory to device during system failure .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -19,12 +18,9 @@ dump \- dump memory to device during system failure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris specific (Solaris DDI). This entry point is \fBrequired\fR. For drivers +illumos specific (illumos DDI). This entry point is \fBrequired\fR. For drivers that do not implement \fBdump()\fR routines, \fBnodev\fR(9F) should be used. .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdev\fR \fR @@ -61,8 +57,6 @@ Number of blocks to dump. .RE .SH DESCRIPTION -.sp -.LP \fBdump()\fR is used to dump a portion of virtual address space directly to a device in the case of system failure. It can also be used for checking the state of the kernel during a checkpoint operation. The memory area to be dumped @@ -79,12 +73,8 @@ can delay(9F) be relied upon, since it is implemented via \fBtimeout()\fR. See .LP \fBdump()\fR is called at interrupt priority. .SH RETURN VALUES -.sp -.LP \fBdump()\fR returns \fB0\fR on success, or the appropriate error number. .SH SEE ALSO -.sp -.LP \fBcpr\fR(7), \fBnodev\fR(9F) .sp .LP diff --git a/usr/src/man/man9e/getinfo.9e b/usr/src/man/man9e/getinfo.9e index cb766ccee0..60484b7e7d 100644 --- a/usr/src/man/man9e/getinfo.9e +++ b/usr/src/man/man9e/getinfo.9e @@ -7,7 +7,6 @@ .SH NAME getinfo \- get device driver information .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,12 +18,9 @@ getinfo \- get device driver information .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). This entry point is \fBrequired\fR for +illumos DDI specific (illumos DDI). This entry point is \fBrequired\fR for drivers which export \fBcb_ops\fR(9S) entry points. .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -62,8 +58,6 @@ Pointer to where the requested information is stored. .RE .SH DESCRIPTION -.sp -.LP When \fIcmd\fR is set to \fBDDI_INFO_DEVT2DEVINFO\fR, \fBgetinfo()\fR should return the \fBdev_info_t\fR pointer associated with the \fBdev_t\fR \fIarg\fR. The \fBdev_info_t\fR pointer should be returned in the field pointed to by @@ -81,8 +75,6 @@ provide a \fBgetinfo()\fR entry point, and may use \fBnodev\fR(9F) in the \fRdriver is an example of a driver which is not required to provide \fBcb_ops\fR(9S) entry points. .SH RETURN VALUES -.sp -.LP \fBgetinfo()\fR should return: .sp .ne 2 @@ -103,36 +95,37 @@ on failure. .RE .SH EXAMPLES -.LP \fBExample 1 \fR\fBgetinfo()\fR implementation .sp .in +2 .nf /*ARGSUSED*/ static int -rd_getinfo(dev_info_t *dip, ddi_info_cmd_t infocmd, void *arg, \e -void **resultp) +rd_getinfo(dev_info_t *dip, ddi_info_cmd_t infocmd, void *arg, + void **resultp) { - /* Note that in this simple example - * the minor number is the instance - * number. */ + /* + * Note that in this simple example + * the minor number is the instance + * number. + */ devstate_t *sp; int error = DDI_FAILURE; switch (infocmd) { case DDI_INFO_DEVT2DEVINFO: - if ((sp = ddi_get_soft_state(statep, - getminor((dev_t) arg))) != NULL) { - *resultp = sp->devi; - error = DDI_SUCCESS; - } else - *result = NULL; - break; + if ((sp = ddi_get_soft_state(statep, + getminor((dev_t) arg))) != NULL) { + *resultp = sp->devi; + error = DDI_SUCCESS; + } else + *result = NULL; + break; case DDI_INFO_DEVT2INSTANCE: - *resultp = (void *) (uintptr_t) getminor((dev_t) arg); - error = DDI_SUCCESS; - break; + *resultp = (void *) (uintptr_t) getminor((dev_t) arg); + error = DDI_SUCCESS; + break; } return (error); @@ -141,15 +134,11 @@ void **resultp) .in -2 .SH SEE ALSO -.sp -.LP \fBddi_no_info\fR(9F), \fBnodev\fR(9F), \fBcb_ops\fR(9S), \fBdev_ops\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Non-\fBgld\fR(7D)-based DLPI network streams drivers are encouraged to switch to \fBgld\fR(7D). Failing this, a driver that creates DLPI style-2 minor nodes must specify CLONE_DEV for its style-2 \fBddi_create_minor_node\fR(9F) diff --git a/usr/src/man/man9e/gld.9e b/usr/src/man/man9e/gld.9e index 7e6c463634..0f6162245c 100644 --- a/usr/src/man/man9e/gld.9e +++ b/usr/src/man/man9e/gld.9e @@ -9,7 +9,6 @@ gld, gldm_reset, gldm_start, gldm_stop, gldm_set_mac_addr, gldm_set_multicast, gldm_set_promiscuous, gldm_send, gldm_intr, gldm_get_stats, gldm_ioctl \- Generic LAN Driver entry points .SH SYNOPSIS -.LP .nf #include <sys/gld.h> @@ -70,11 +69,8 @@ Generic LAN Driver entry points .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImacinfo\fR \fR @@ -157,8 +153,6 @@ Pointer to the \fBqueue\fR(9S) structure to be used in the reply to the ioctl. .RE .SH DESCRIPTION -.sp -.LP These entry points must be implemented by a device-specific network driver designed to interface with the Generic LAN Driver (GLD). .sp @@ -326,8 +320,6 @@ via the message passed to \fBqreply\fR(9F). If the \fBgldm_ioctl\fR element is specified as \fINULL\fR, GLD will return a message of type \fBM_IOCNAK\fR with an error of \fBEINVAL\fR. .SH RETURN VALUES -.sp -.LP \fBgldm_intr\fR(\|) must return: .sp .ne 2 @@ -412,8 +404,6 @@ on hardware failure. .RE .SH SEE ALSO -.sp -.LP \fBgld\fR(7D), \fBgld\fR(9F), \fBgld_mac_info\fR(9S), \fBgld_stats\fR(9S), \fBdlpi\fR(7P), \fBattach\fR(9E), \fBddi_add_intr\fR(9F) .sp diff --git a/usr/src/man/man9e/identify.9e b/usr/src/man/man9e/identify.9e index f60b571443..1f6740cbf7 100644 --- a/usr/src/man/man9e/identify.9e +++ b/usr/src/man/man9e/identify.9e @@ -7,17 +7,11 @@ .SH NAME identify \- determine if a driver is associated with a device .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). This entry point is no longer supported. +illumos DDI specific (illumos DDI). This entry point is no longer supported. \fBnulldev\fR(9F) must be specified in the \fBdev_ops\fR(9S) structure. .SH SEE ALSO -.sp -.LP \fBnulldev\fR(9F), \fBdev_ops\fR(9S) .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -32,8 +26,6 @@ Stability Level Obsolete .TE .SH WARNING -.sp -.LP -For Solaris 10 and later versions, drivers must remove the \fBidentify(9e)\fR -implementation to recompile. Otherwise, the compiler generates errors about -DDI_IDENTIFIED and DDI_NOT_IDENTIFIED. +Drivers must remove the \fBidentify(9e)\fR implementation to +recompile. Otherwise, the compiler generates errors about DDI_IDENTIFIED and +DDI_NOT_IDENTIFIED. diff --git a/usr/src/man/man9e/ks_snapshot.9e b/usr/src/man/man9e/ks_snapshot.9e index 47d490d4bc..9364820b92 100644 --- a/usr/src/man/man9e/ks_snapshot.9e +++ b/usr/src/man/man9e/ks_snapshot.9e @@ -7,7 +7,6 @@ .SH NAME ks_snapshot \- take a snapshot of kstat data .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -20,8 +19,7 @@ ks_snapshot \- take a snapshot of kstat data .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -68,7 +66,6 @@ Copy statistics from the buffer to the driver. .RE .SH DESCRIPTION -.LP The \fBkstat\fR mechanism allows for an optional \fBks_snapshot()\fR function to copy \fBkstat\fR data. This is the routine that is called to marshall the \fBkstat\fR data to be copied to user-land. A driver can opt to use a custom @@ -147,10 +144,8 @@ For any other error .RE .SH CONTEXT -.LP This function is called from user context only. .SH EXAMPLES -.LP \fBExample 1 \fRNamed \fBkstat\fRs with Long Strings (\fBKSTAT_DATA_STRING\fR) .sp .in +2 @@ -187,7 +182,6 @@ xxx_kstat_snapshot(kstat_t *ksp, void *buf, int rw) .sp .SH SEE ALSO -.LP \fBks_update\fR(9E), \fBkstat_create\fR(9F), \fBkstat_install\fR(9F), \fBkstat\fR(9S) .sp diff --git a/usr/src/man/man9e/ks_update.9e b/usr/src/man/man9e/ks_update.9e index 4b3865742a..7b184380a2 100644 --- a/usr/src/man/man9e/ks_update.9e +++ b/usr/src/man/man9e/ks_update.9e @@ -7,7 +7,6 @@ .SH NAME ks_update \- dynamically update kstats .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -20,11 +19,8 @@ ks_update \- dynamically update kstats .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIksp\fR \fR @@ -61,8 +57,6 @@ Update driver statistics from the kstat structure. .RE .SH DESCRIPTION -.sp -.LP The kstat mechanism allows for an optional \fBks_update()\fR function to update kstat data. This is useful for drivers where the underlying device keeps cheap hardware statistics, but extraction is expensive. Instead of constantly @@ -102,8 +96,6 @@ No \fBkstat\fR locking should be done inside the \fBks_update()\fR routine. The caller will already be holding the \fBkstat's\fR \fBks_lock\fR (to ensure consistent data) and will prevent the \fBkstat\fR from being removed. .SH RETURN VALUES -.sp -.LP \fBks_update()\fR should return .sp .ne 2 @@ -133,8 +125,6 @@ For any other error. .RE .SH SEE ALSO -.sp -.LP \fBkstat_create\fR(9F), \fBkstat_install\fR(9F), \fBkstat\fR(9S) .sp .LP diff --git a/usr/src/man/man9e/power.9e b/usr/src/man/man9e/power.9e index 0133969362..27f26f76a3 100644 --- a/usr/src/man/man9e/power.9e +++ b/usr/src/man/man9e/power.9e @@ -7,7 +7,6 @@ .SH NAME power \- power a device attached to the system .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,8 +17,7 @@ power \- power a device attached to the system .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). This entry point is required. If the driver +illumos DDI specific (illumos DDI). This entry point is required. If the driver writer does not supply this entry point, the value \fBNULL\fR must be used in the \fBdev_ops\fR(9S) structure instead. .SH PARAMETERS @@ -50,7 +48,6 @@ Desired component power level. .RE .SH DESCRIPTION -.LP The \fBpower\fR(9E) function is the device-specific Power Management entry point. This function is called when the system wants the driver to set the power level of \fIcomponent\fR to \fIlevel\fR. @@ -82,7 +79,6 @@ If the system requests an inappropriate power transition for the device (for example, a request to power down a device which has just become busy), then the power level should not be changed and power should return \fBDDI_FAILURE\fR. .SH RETURN VALUES -.LP The \fBpower()\fR function returns: .sp .ne 2 @@ -103,10 +99,8 @@ Failed to set the power to the requested \fIlevel\fR. .RE .SH CONTEXT -.LP The \fBpower()\fR function is called from user or kernel context only. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -121,7 +115,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattach\fR(9E), \fBdetach\fR(9E), \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F), \fBpm_raise_power\fR(9F), \fBdev_ops\fR(9S) .sp diff --git a/usr/src/man/man9e/probe.9e b/usr/src/man/man9e/probe.9e index 7152609ce2..e9babc64cc 100644 --- a/usr/src/man/man9e/probe.9e +++ b/usr/src/man/man9e/probe.9e @@ -19,7 +19,7 @@ probe \- determine if a non-self-identifying device is present .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI). This entry point is required for +illumos DDI specific (illumos DDI). This entry point is required for non-self-identifying devices. You must write it for such devices. For self-identifying devices, \fBnulldev\fR(9F) should be specified in the \fBdev_ops\fR(9S) structure if a probe routine is not necessary. diff --git a/usr/src/man/man9e/prop_op.9e b/usr/src/man/man9e/prop_op.9e index 904c19be01..1f84d53093 100644 --- a/usr/src/man/man9e/prop_op.9e +++ b/usr/src/man/man9e/prop_op.9e @@ -7,7 +7,6 @@ .SH NAME prop_op \- report driver property information .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -21,12 +20,9 @@ prop_op \- report driver property information .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). This entry point is required, but it can be +illumos DDI specific (illumos DDI). This entry point is required, but it can be \fBddi_prop_op\fR(9F). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdev\fR\fR @@ -131,8 +127,6 @@ contains the length of caller's buffer, before calling \fBprop_op()\fR. .RE .SH DESCRIPTION -.sp -.LP \fBprop_op()\fR is an entry point which reports the values of certain properties of the driver or device to the system. Each driver must have a \fIprefix\fR \fBprop_op\fR entry point, but most drivers that do not need to @@ -140,8 +134,6 @@ create or manage their own properties can use \fBddi_prop_op()\fR for this entry point. Then the driver can use \fBddi_prop_update\fR(9F) to create properties for its device. .SH RETURN VALUES -.sp -.LP \fBprop_op()\fR should return: .sp .ne 2 @@ -191,7 +183,6 @@ correct property length. .RE .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBprop_op()\fR to Report Property Information .sp .LP @@ -237,8 +228,6 @@ xxprop_op(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, .in -2 .SH SEE ALSO -.sp -.LP \fBIntro\fR(9E), \fBddi_prop_op\fR(9F), \fBddi_prop_update\fR(9F) .sp .LP diff --git a/usr/src/man/man9e/quiesce.9e b/usr/src/man/man9e/quiesce.9e index f6cc33dd11..f7abbb42ea 100644 --- a/usr/src/man/man9e/quiesce.9e +++ b/usr/src/man/man9e/quiesce.9e @@ -7,7 +7,6 @@ .SH NAME quiesce \- quiesce a device .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -21,11 +20,8 @@ quiesce \- quiesce a device .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -35,8 +31,6 @@ A pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP The \fBquiesce()\fR function quiesces a device so that the device no longer generates interrupts, modifies or accesses memory. The driver should reset the device to a hardware state from which the device can be correctly configured by @@ -79,8 +73,6 @@ its functionality must be merged into \fBquiesce()\fR. The driver's set its \fBdevo_quiesce\fR device function to \fBddi_quiesce_not_needed()\fR to indicate that the device it manages does not need to be quiesced. .SH RETURN VALUES -.sp -.LP \fBquiesce()\fR returns the following: .sp .ne 2 @@ -101,18 +93,12 @@ The operation failed. .RE .SH CONTEXT -.sp -.LP This function is called from kernel context only. .SH SEE ALSO -.sp -.LP \fBreboot\fR(1M), \fBuadmin\fR(1M), \fBuadmin\fR(2), \fBattach\fR(9E), \fBdetach\fR(9E), \fBddi_add_intr\fR(9F), \fBddi_map_regs\fR(9F), \fBpci_config_setup\fR(9F), \fBtimeout\fR(9F), \fBdev_ops\fR(9S) .SH NOTES -.sp -.LP When \fBquiesce()\fR is called, the system is single-threaded, therefore the driver's \fBquiesce()\fR implementation must not be blocked. For example, the implementation must not create or tear down mappings, call \fBFMA\fR functions, diff --git a/usr/src/man/man9e/tran_abort.9e b/usr/src/man/man9e/tran_abort.9e index 5d8ddf4de4..1c95ff55aa 100644 --- a/usr/src/man/man9e/tran_abort.9e +++ b/usr/src/man/man9e/tran_abort.9e @@ -7,7 +7,6 @@ .SH NAME tran_abort \- abort a SCSI command .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,11 +17,8 @@ tran_abort \- abort a SCSI command .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIap\fR \fR @@ -41,8 +37,6 @@ Pointer to a \fBscsi_pkt\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_abort()\fR vector in the \fBscsi_hba_tran\fR(9S) structure must be initialized during the HBA driver's \fBattach\fR(9E) to point to an HBA entry point to be called when a target driver calls \fBscsi_abort\fR(9F). @@ -66,8 +60,6 @@ For each packet successfully aborted, \fBtran_abort()\fR must set the \fBpkt_reason\fR to \fBCMD_ABORTED\fR, and \fBpkt_statistics\fR must be \fBOR'ed\fR with \fBSTAT_ABORTED\fR . .SH RETURN VALUES -.sp -.LP \fBtran_abort()\fR must return: .sp .ne 2 @@ -88,21 +80,15 @@ upon failure. .RE .SH CONTEXT -.sp -.LP The \fBtran_abort()\fR function can be called from user or interrupt context. This requirement comes from \fBscsi_abort()\fR. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBscsi_abort\fR(9F), \fBscsi_hba_attach\fR(9F), \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S), \fBscsi_pkt\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP If \fBpkt_reason\fR already indicates that an earlier error had occurred, \fBtran_abort()\fR should not overwrite \fBpkt_reason\fR with \fBCMD_ABORTED\fR. diff --git a/usr/src/man/man9e/tran_bus_reset.9e b/usr/src/man/man9e/tran_bus_reset.9e index 34698a2515..451135f925 100644 --- a/usr/src/man/man9e/tran_bus_reset.9e +++ b/usr/src/man/man9e/tran_bus_reset.9e @@ -7,7 +7,6 @@ .SH NAME tran_bus_reset \- reset a SCSI bus .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> int \fIprefix\fR @@ -15,11 +14,8 @@ tran_bus_reset \- reset a SCSI bus .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI +illumos DDI .SH PARAMETERS -.sp .ne 2 .na \fB\fIhba_dip\fR\fR @@ -38,8 +34,6 @@ The level of reset required. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_bus_reset()\fR vector in the \fBscsi_hba_tran\fR(9S) structure should be initialized during the HBA driver's \fBattach\fR(9E). It is an HBA entry point to be called when a user initiates a bus reset through device @@ -65,8 +59,6 @@ Implementation is hardware specific. If it is not possible to reset the SCSI bus without changing the state and operating mode of the targets, the HBA driver should not initialize this vector or return failure. .SH RETURN VALUES -.sp -.LP \fBtran_bus_reset()\fR should return: .sp .ne 2 @@ -87,8 +79,6 @@ on failure. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -103,6 +93,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBtran_quiesce\fR(9E), \fBscsi_hba_tran\fR(9S) diff --git a/usr/src/man/man9e/tran_dmafree.9e b/usr/src/man/man9e/tran_dmafree.9e index c9c2408710..00a46b173f 100644 --- a/usr/src/man/man9e/tran_dmafree.9e +++ b/usr/src/man/man9e/tran_dmafree.9e @@ -7,7 +7,6 @@ .SH NAME tran_dmafree \- SCSI HBA DMA deallocation entry point .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ tran_dmafree \- SCSI HBA DMA deallocation entry point .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIap\fR\fR @@ -40,8 +36,6 @@ A pointer to a \fIscsi_pkt\fR structure. See \fBscsi_pkt\fR(9S). .RE .SH DESCRIPTION -.sp -.LP The \fBtran_dmafree()\fR vector in the \fIscsi_hba_tran\fR structure must be initialized during the \fBHBA \fRdriver's \fBattach()\fR to point to an \fBHBA \fRentry point to be called when a target driver calls \fBscsi_dmafree\fR(9F). @@ -55,8 +49,6 @@ itself. Since \fBtran_destroy_pkt\fR(9E) must also free \fBDMA \fRresources, it is important that the \fBHBA \fRdriver keeps accurate note of whether \fBscsi_pkt\fR(9S) structures have \fBDMA \fRresources allocated. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBtran_destroy_pkt\fR(9E), \fBtran_init_pkt\fR(9E), \fBscsi_dmafree\fR(9F), \fBscsi_dmaget\fR(9F), \fBscsi_hba_attach\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S), @@ -65,7 +57,5 @@ it is important that the \fBHBA \fRdriver keeps accurate note of whether .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP A target driver may call \fBtran_dmafree()\fR on packets for which no \fBDMA \fRresources were allocated. diff --git a/usr/src/man/man9e/tran_getcap.9e b/usr/src/man/man9e/tran_getcap.9e index cc70777dfe..c10f5714c3 100644 --- a/usr/src/man/man9e/tran_getcap.9e +++ b/usr/src/man/man9e/tran_getcap.9e @@ -7,7 +7,6 @@ .SH NAME tran_getcap, tran_setcap \- get/set SCSI transport capability .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -23,11 +22,8 @@ tran_getcap, tran_setcap \- get/set SCSI transport capability .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR \fR @@ -64,8 +60,6 @@ Specifies whether all targets or only the specified target is affected. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_getcap()\fR and \fBtran_setcap()\fR vectors in the \fBscsi_hba_tran\fR(9S) structure must be initialized during the \fBHBA \fRdriver's \fBattach\fR(9E) to point to \fBHBA \fRentry points to be called @@ -102,8 +96,6 @@ Refer to \fBscsi_ifgetcap\fR(9F) for the list of defined capabilities. \fBHBA \fRdrivers should use \fBscsi_hba_lookup_capstr\fR(9F) to match \fIcap\fR against the canonical capability strings. .SH RETURN VALUES -.sp -.LP \fBtran_setcap()\fR must return \fB1\fR if the capability was successfully set to the new value, \fB0\fR if the \fBHBA \fR driver does not support changing the capability, and \fB\(mi1\fR if the capability was not defined. @@ -112,8 +104,6 @@ the capability, and \fB\(mi1\fR if the capability was not defined. \fBtran_getcap()\fR must return the current value of a capability or \fB\(mi1\fR if the capability was not defined. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBscsi_hba_attach\fR(9F), \fBscsi_hba_lookup_capstr\fR(9F), \fBscsi_ifgetcap\fR(9F), \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S) .sp diff --git a/usr/src/man/man9e/tran_init_pkt.9e b/usr/src/man/man9e/tran_init_pkt.9e index 0e20c8d489..567801b357 100644 --- a/usr/src/man/man9e/tran_init_pkt.9e +++ b/usr/src/man/man9e/tran_init_pkt.9e @@ -7,7 +7,6 @@ .SH NAME tran_init_pkt, tran_destroy_pkt \- SCSI HBA packet preparation and deallocation .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -24,11 +23,8 @@ tran_init_pkt, tran_destroy_pkt \- SCSI HBA packet preparation and deallocation .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR\fR @@ -115,15 +111,11 @@ Always \fINULL\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_init_pkt()\fR and \fBtran_destroy_pkt()\fR vectors in the \fBscsi_hba_tran\fR structure must be initialized during the \fBHBA \fRdriver's \fBattach\fR(9E) to point to \fBHBA \fRentry points to be called when a target driver calls \fBscsi_init_pkt\fR(9F) and \fBscsi_destroy_pkt\fR(9F). .SS "\fBtran_init_pkt()\fR" -.sp -.LP \fBtran_init_pkt()\fR is the entry point into the \fBHBA \fRwhich is used to allocate and initialize a \fBscsi_pkt\fR structure on behalf of a \fBSCSI \fRtarget driver. If \fIpkt\fR is \fINULL,\fR the \fBHBA \fRdriver must use @@ -216,14 +208,10 @@ Wait indefinitely for resources. .RE .SS "tran_destroy_pkt()" -.sp -.LP \fBtran_destroy_pkt()\fR is the entry point into the \fBHBA \fRthat must free all of the resources that were allocated to the \fBscsi_pkt\fR(9S) structure during \fBtran_init_pkt()\fR. .SH RETURN VALUES -.sp -.LP \fBtran_init_pkt()\fR must return a pointer to a \fBscsi_pkt\fR(9S) structure on success, or \fINULL\fR on failure. .sp @@ -233,8 +221,6 @@ packet through \fBscsi_hba_pkt_alloc\fR(9F) but was unable to allocate \fBDMA \fRresources, \fBtran_init_pkt()\fR must free the packet through \fBscsi_hba_pkt_free\fR(9F) before returning \fINULL\fR. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBtran_setup_pkt\fR(9E), \fBtran_sync_pkt\fR(9E), \fBbiodone\fR(9F), \fBbioerror\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_buf_setup\fR(9F), \fBkmem_cache_create\fR(9F), @@ -246,8 +232,6 @@ packet through \fBscsi_hba_pkt_alloc\fR(9F) but was unable to allocate \fBDMA .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP If a \fBDMA\fR allocation request fails with \fBDDI_DMA_NOMAPPING\fR, indicate the error by calling \fBbioerror\fR(9F) with \fIbp\fR and an error code of \fBEFAULT\fR. diff --git a/usr/src/man/man9e/tran_quiesce.9e b/usr/src/man/man9e/tran_quiesce.9e index cf5c96cc93..4f2f7bdab5 100644 --- a/usr/src/man/man9e/tran_quiesce.9e +++ b/usr/src/man/man9e/tran_quiesce.9e @@ -7,7 +7,6 @@ .SH NAME tran_quiesce, tran_unquiesce \- quiesce and unquiesce a SCSI bus .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -20,11 +19,8 @@ tran_quiesce, tran_unquiesce \- quiesce and unquiesce a SCSI bus .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI +illumos DDI .SH PARAMETERS -.sp .ne 2 .na \fB\fIhba_dip\fR\fR @@ -34,8 +30,6 @@ The \fBdev_info_t\fR pointer associated with the SCSI HBA. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_quiesce()\fR and \fBtran_unquiesce()\fR vectors in the \fBscsi_hba_tran\fR(9S) structure should be initialized during the HBA driver's \fBattach\fR(9E). They are HBA entry points to be called when a user initiates @@ -49,8 +43,6 @@ I/O activities to resume on the SCSI bus. .LP Implementation is hardware specific. .SH RETURN VALUES -.sp -.LP \fBtran_quiesce()\fR and \fBtran_unquiesce()\fR should return: .sp .ne 2 @@ -71,8 +63,6 @@ An error occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -87,6 +77,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBtran_bus_reset\fR(9E), \fBscsi_hba_tran\fR(9S) diff --git a/usr/src/man/man9e/tran_reset.9e b/usr/src/man/man9e/tran_reset.9e index 8091eef104..4e3770a3bf 100644 --- a/usr/src/man/man9e/tran_reset.9e +++ b/usr/src/man/man9e/tran_reset.9e @@ -7,7 +7,6 @@ .SH NAME tran_reset \- reset a SCSI bus or target .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ tran_reset \- reset a SCSI bus or target .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR \fR @@ -40,8 +36,6 @@ The level of reset required. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_reset()\fR vector in the \fBscsi_hba_tran\fR(9S) structure must be initialized during the \fBHBA\fR driver's \fBattach\fR(9E) to point to an \fBHBA\fR entry point to be called when a target driver calls @@ -107,8 +101,6 @@ provide the means to return the current value of the \fBlun-reset\fR capability in its \fBtran_getcap\fR(9E) routine, as well as the means to change the value of the \fBlun_reset\fR capability in its \fBtran_getcap\fR(9E) routine. .SH RETURN VALUES -.sp -.LP \fBtran_reset()\fR should return: .sp .ne 2 @@ -129,21 +121,15 @@ on failure. .RE .SH CONTEXT -.sp -.LP The \fBtran_reset()\fR function can be called from user or interrupt context. This requirement comes from \fBscsi_reset()\fR. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBddi_dma_buf_setup\fR(9F), \fBscsi_hba_attach\fR(9F), \fBscsi_reset\fR(9F), \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP If \fBpkt_reason\fR already indicates that an earlier error had occurred for a particular \fIpkt\fR, \fBtran_reset()\fR should not overwrite \fBpkt_reason\fR with \fBCMD_RESET\fR. diff --git a/usr/src/man/man9e/tran_reset_notify.9e b/usr/src/man/man9e/tran_reset_notify.9e index f61d593769..7919f576f9 100644 --- a/usr/src/man/man9e/tran_reset_notify.9e +++ b/usr/src/man/man9e/tran_reset_notify.9e @@ -7,7 +7,6 @@ .SH NAME tran_reset_notify \- request to notify SCSI target of bus reset .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,11 +17,8 @@ tran_reset_notify \- request to notify SCSI target of bus reset .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR \fR @@ -59,8 +55,6 @@ The callback function argument. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_reset_notify()\fR entry point is called when a target driver requests notification of a bus reset. .sp @@ -98,8 +92,6 @@ registered by the target drivers. When a bus reset occurs, the \fBHBA \fRdriver notifies registered target drivers by calling the callback routine, \fIcallback\fR, with the argument, \fIarg\fR, for each registered target. .SH RETURN VALUES -.sp -.LP For \fBSCSI_RESET_NOTIFY\fR requests, \fBtran_reset_notify()\fR must return \fBDDI_SUCCESS\fR if the notification request has been accepted, and \fBDDI_FAILURE\fR otherwise. @@ -109,8 +101,6 @@ For \fBSCSI_RESET_CANCEL\fR requests, \fBtran_reset_notify()\fR must return \fBDDI_SUCCESS\fR if the notification request has been canceled, and \fBDDI_FAILURE\fR otherwise. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBscsi_ifgetcap\fR(9F), \fBscsi_reset_notify\fR(9F), \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S) .sp diff --git a/usr/src/man/man9e/tran_setup_pkt.9e b/usr/src/man/man9e/tran_setup_pkt.9e index 04628358e2..5892677566 100644 --- a/usr/src/man/man9e/tran_setup_pkt.9e +++ b/usr/src/man/man9e/tran_setup_pkt.9e @@ -8,7 +8,6 @@ tran_setup_pkt, tran_teardown_pkt, tran_pkt_constructor, tran_pkt_destructor \- SCSI HBA packet allocation and deallocation .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -34,8 +33,7 @@ SCSI HBA packet allocation and deallocation .fi .SH INTERFACE LEVEL -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -82,14 +80,12 @@ Either \fBKM_SLEEP\fR or \fBKM_NOSLEEP\fR. .RE .SH DESCRIPTION -.LP The \fBtran_setup_pkt()\fR and \fBtran_destroy_pkt()\fR vectors in the \fBscsi_hba_tran\fR(9S) structure are alternatives to the \fBtran_init_pkt()\fR and \fBtran_destroy_pkt()\fR entry points. They are initialized during the \fBHBA\fR driver's \fBattach\fR(9E) and they are used when a target driver calls \fBscsi_init_pkt\fR(9F) and \fBscsi_destroy_pkt\fR(9F). .SS "tran_setup_pkt(\|)" -.LP The \fBtran_setup_pkt()\fR vector is the entry point into the \fBHBA\fR which is used to initialize \fBHBA\fR specific information in a \fBscsi_pkt\fR structure on behalf of a SCSI target driver. All fields documented in @@ -147,12 +143,10 @@ Wait indefinitely for resources. .RE .SS "tran_teardown_pkt(\|)" -.LP The \fBtran_teardown_pkt()\fR is the entry point into the \fBHBA\fR that must free all of the resources that were allocated to the \fBscsi_pkt\fR(9S) structure during \fBtran_setup_pkt()\fR. .SS "tran_pkt_constructor(\|) tran_pkt_destructor(\|)" -.LP When using \fBtran_pkt_setup()\fR and \fBtran_pkt_teardown()\fR, \fBtran_pkt_constructor()\fR and \fBtran_pkt_destructor()\fR are additional optional entry points that perform the actions of a constructor and destructor. @@ -219,10 +213,8 @@ HBA drivers that implement \fBtran_setup_pkt()\fR must signal use of the \fBscsi_pkt\fR \fIpkt_comp\fR field is not permitted and results in undefined behavior. .SH RETURN VALUES -.LP \fBtran_setup_pkt()\fR must return zero on success, and \fB-1\fR on failure. .SH SEE ALSO -.LP \fBattach\fR(9E), \fBtran_sync_pkt\fR(9E), \fBbioerror\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBkmem_cache_create\fR(9F), \fBscsi_alloc_consistent_buf\fR(9F), \fBscsi_destroy_pkt\fR(9F), diff --git a/usr/src/man/man9e/tran_start.9e b/usr/src/man/man9e/tran_start.9e index f48dc83fd1..b94cec0ca4 100644 --- a/usr/src/man/man9e/tran_start.9e +++ b/usr/src/man/man9e/tran_start.9e @@ -7,7 +7,6 @@ .SH NAME tran_start \- request to transport a SCSI command .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,8 +17,7 @@ tran_start \- request to transport a SCSI command .fi .SH INTERFACE LEVEL -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -39,7 +37,6 @@ Pointer to a \fBscsi_address\fR(9S) structure. .RE .SH DESCRIPTION -.LP The \fBtran_start()\fR vector in the \fBscsi_hba_tran\fR(9S) structure must be initialized during the \fBHBA \fRdriver's \fBattach\fR(9E) to point to an \fBHBA \fRentry point to be called when a target driver calls @@ -185,7 +182,6 @@ by the transport layer. .RE .SH RETURN VALUES -.LP \fBtran_start()\fR must return: .sp .ne 2 @@ -227,11 +223,9 @@ A fatal error has occurred in the \fBHBA. \fR .RE .SH CONTEXT -.LP The \fBtran_start()\fR function can be called from user or interrupt context. This requirement comes from \fBscsi_transport()\fR. .SH SEE ALSO -.LP \fBattach\fR(9E), \fBtran_init_pkt\fR(9E), \fBscsi_hba_attach\fR(9F), \fBscsi_transport\fR(9F), \fBscsi_address\fR(9S), \fBscsi_arq_status\fR(9S), \fBscsi_hba_tran\fR(9S), \fBscsi_pkt\fR(9S) diff --git a/usr/src/man/man9e/tran_sync_pkt.9e b/usr/src/man/man9e/tran_sync_pkt.9e index a1298cb0ee..8c957a236c 100644 --- a/usr/src/man/man9e/tran_sync_pkt.9e +++ b/usr/src/man/man9e/tran_sync_pkt.9e @@ -7,7 +7,6 @@ .SH NAME tran_sync_pkt \- SCSI HBA memory synchronization entry point .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,11 +17,8 @@ tran_sync_pkt \- SCSI HBA memory synchronization entry point .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR \fR @@ -41,8 +37,6 @@ A pointer to a \fBscsi_pkt\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_sync_pkt()\fR vector in the \fBscsi_hba_tran\fR(9S) structure must be initialized during the \fBHBA\fR driver's \fBattach\fR(9E) to point to an \fBHBA\fR driver entry point to be called when a target driver calls @@ -55,8 +49,6 @@ data associated with the \fIpkt\fR, typically by calling hardware-specific details, such as flushing \fBI/O\fR caches, or stalling until hardware buffers have been drained. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBtran_init_pkt\fR(9E), \fBddi_dma_sync\fR(9F), \fBscsi_hba_attach\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_sync_pkt\fR(9F), \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S), \fBscsi_pkt\fR(9S) @@ -64,7 +56,5 @@ until hardware buffers have been drained. .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP A target driver may call \fBtran_sync_pkt()\fR on packets for which no \fBDMA\fR resources were allocated. diff --git a/usr/src/man/man9e/tran_tgt_free.9e b/usr/src/man/man9e/tran_tgt_free.9e index d4262beb31..0642699897 100644 --- a/usr/src/man/man9e/tran_tgt_free.9e +++ b/usr/src/man/man9e/tran_tgt_free.9e @@ -7,7 +7,6 @@ .SH NAME tran_tgt_free \- request to free HBA resources allocated on behalf of a target .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,11 +17,8 @@ tran_tgt_free \- request to free HBA resources allocated on behalf of a target .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIhba_dip\fR \fR @@ -62,8 +58,6 @@ Pointer to a \fBscsi_device\fR(9S) structure, describing the target. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_tgt_free()\fR vector in the \fBscsi_hba_tran\fR(9S) structure may be initialized during the \fBHBA\fR driver's \fBattach\fR(9E) to point to an \fBHBA\fR driver function to be called by the system when an instance of a @@ -75,8 +69,6 @@ should release any resources allocated during its \fBtran_tgt_init()\fR or \fBtran_tgt_probe()\fR initialization performed for this target device instance. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBdetach\fR(9E), \fBtran_tgt_init\fR(9E), \fBtran_tgt_probe\fR(9E), \fBscsi_device\fR(9S), \fBscsi_hba_tran\fR(9S) .sp diff --git a/usr/src/man/man9e/tran_tgt_init.9e b/usr/src/man/man9e/tran_tgt_init.9e index 12c358785c..51c5519ab4 100644 --- a/usr/src/man/man9e/tran_tgt_init.9e +++ b/usr/src/man/man9e/tran_tgt_init.9e @@ -8,7 +8,6 @@ tran_tgt_init \- request to initialize HBA resources on behalf of a particular target .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -19,8 +18,7 @@ target .fi .SH INTERFACE LEVEL -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -61,7 +59,6 @@ Pointer to a \fBscsi_device\fR(9S) structure, describing the target. .RE .SH DESCRIPTION -.LP The \fBtran_tgt_init()\fR vector in the \fBscsi_hba_tran\fR(9S) structure may be initialized during the \fBHBA\fR driver's \fBattach\fR(9E) to point to an \fBHBA\fR driver function to be called by the system when an instance of a @@ -81,7 +78,6 @@ initialize the \fItran_tgt_private\fR field in the structure pointed to by \fIhba_tran\fR, to point to the data specific to the particular target device instance. .SH RETURN VALUES -.LP \fBtran_tgt_init()\fR must return: .sp .ne 2 @@ -106,7 +102,6 @@ instance of the target device will not be continued, the target driver's .RE .SH SEE ALSO -.LP \fBattach\fR(9E), \fBprobe\fR(9E), \fBtran_tgt_free\fR(9E), \fBtran_tgt_probe\fR(9E), \fBscsi_hba_attach_setup\fR(9F), \fBscsi_device\fR(9S), \fBscsi_hba_tran\fR(9S) diff --git a/usr/src/man/man9e/tran_tgt_probe.9e b/usr/src/man/man9e/tran_tgt_probe.9e index 1b66da0737..f086b6bbb6 100644 --- a/usr/src/man/man9e/tran_tgt_probe.9e +++ b/usr/src/man/man9e/tran_tgt_probe.9e @@ -7,7 +7,6 @@ .SH NAME tran_tgt_probe \- request to probe SCSI bus for a particular target .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,11 +17,8 @@ tran_tgt_probe \- request to probe SCSI bus for a particular target .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIsd\fR \fR @@ -41,8 +37,6 @@ Pointer to either \fBNULL_FUNC\fR or \fBSLEEP_FUNC\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBtran_tgt_probe()\fR vector in the \fBscsi_hba_tran\fR(9S) structure may be initialized during the \fBHBA \fRdriver's \fBattach\fR(9E) to point to a function to be called by \fBscsi_probe\fR(9F) when called by a target driver @@ -93,8 +87,6 @@ Wait indefinitely for resources. .RE .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBprobe\fR(9E), \fBtran_tgt_free\fR(9E), \fBtran_tgt_init\fR(9E), \fBscsi_hba_probe\fR(9F), \fBscsi_probe\fR(9F), \fBscsi_device\fR(9S), \fBscsi_hba_tran\fR(9S) diff --git a/usr/src/man/man9f/STRUCT_DECL.9f b/usr/src/man/man9f/STRUCT_DECL.9f index 833f6e4098..fb80a1c341 100644 --- a/usr/src/man/man9f/STRUCT_DECL.9f +++ b/usr/src/man/man9f/STRUCT_DECL.9f @@ -9,7 +9,6 @@ STRUCT_DECL, SIZEOF_PTR, SIZEOF_STRUCT, STRUCT_BUF, STRUCT_FADDR, STRUCT_FGET, STRUCT_FGETP, STRUCT_FSET, STRUCT_FSETP, STRUCT_HANDLE, STRUCT_INIT, STRUCT_SIZE, STRUCT_SET_HANDLE \- 32-bit application data access macros .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -80,12 +79,8 @@ STRUCT_SIZE, STRUCT_SET_HANDLE \- 32-bit application data access macros .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP The macros take the following parameters: .sp .ne 2 @@ -133,8 +128,6 @@ whatever complex expression would naturally follow the first . or ->. .RE .SH DESCRIPTION -.sp -.LP The above macros allow a device driver to access data consumed from a 32-bit application regardless whether the driver was compiled to the ILP32 or LP64 data model. These macros effectively hide the difference between the data model @@ -144,8 +137,6 @@ of the user application and the driver. The macros can be broken up into two main categories described in the following sections. .SS "Declaration and Initialization Macros" -.sp -.LP The macros \fBSTRUCT_DECL()\fR and \fBSTRUCT_HANDLE()\fR declare structure handles on the stack, whereas the macros \fBSTRUCT_INIT()\fR and \fBSTRUCT_SET_HANDLE()\fR initialize the structure handles to point to an @@ -222,7 +213,6 @@ When used in an \fBioctl\fR(9E), \fIumodel\fR is the flag parameter. In a .RE .SS "Operation Macros" -.sp .ne 2 .na \fBsize_t STRUCT_SIZE(handle)\fR @@ -296,7 +286,6 @@ Returns a pointer to the native mode instance of the structure described by .RE .SS "Macros Not Using Handles" -.sp .ne 2 .na \fBsize_t SIZEOF_STRUCT(structname, umodel)\fR @@ -317,7 +306,6 @@ Returns the size of a pointer based on \fIumodel\fR. .RE .SH EXAMPLES -.LP \fBExample 1 \fRCopying a Structure .sp .LP @@ -445,8 +433,6 @@ wput_iocdata(queue_t *q, mblk_t *msgp) .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -461,8 +447,6 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp -.LP \fBdevmap\fR(9E), \fBioctl\fR(9E), \fBmmap\fR(9E), \fBddi_mmap_get_model\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/bioclone.9f b/usr/src/man/man9f/bioclone.9f index 7f4aaad771..a1ef08525b 100644 --- a/usr/src/man/man9f/bioclone.9f +++ b/usr/src/man/man9f/bioclone.9f @@ -7,7 +7,6 @@ .SH NAME bioclone \- clone another buffer .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ bioclone \- clone another buffer .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIbp\fR\fR @@ -99,8 +95,6 @@ to return \fINULL\fR immediately if memory is not available. .RE .SH DESCRIPTION -.sp -.LP The \fBbioclone()\fR function returns an initialized buffer to perform \fBI/O\fR to a portion of another buffer. The new buffer will be set up to perform \fBI/O\fR to the range within the original \fBI/O\fR request specified @@ -135,18 +129,13 @@ clone buffers is still performing \fBI/O\fR. The \fBbiodone()\fR function has to be called on all clone buffers \fBbefore\fR it is called on the original buffer. .SH RETURN VALUES -.sp -.LP The \fBbioclone()\fR function returns a pointer to the initialized buffer header, or \fBNULL\fR if no space is available. .SH CONTEXT -.sp -.LP The \fBbioclone()\fR function can be called from user, interrup, or interrupt context. Drivers must not allow \fBbioclone()\fR to sleep if called from an interrupt routine. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBbioclone()\fR for Disk Striping .sp .LP @@ -202,8 +191,6 @@ stripe_done(struct buf *bp) .in -2 .SH SEE ALSO -.sp -.LP \fBbiodone\fR(9F), \fBbp_mapin\fR(9F), \fBfreerbuf\fR(9F), \fBgetrbuf\fR(9F), \fBbuf\fR(9S) .sp diff --git a/usr/src/man/man9f/bioerror.9f b/usr/src/man/man9f/bioerror.9f index e20dafb834..7a5f267aa0 100644 --- a/usr/src/man/man9f/bioerror.9f +++ b/usr/src/man/man9f/bioerror.9f @@ -7,7 +7,6 @@ .SH NAME bioerror \- indicate error in buffer header .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/buf.h> @@ -19,8 +18,7 @@ bioerror \- indicate error in buffer header .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -40,7 +38,6 @@ Error number to be set, or zero to clear an error indication. .RE .SH DESCRIPTION -.LP If \fIerror\fR is non-zero, \fBbioerror()\fR indicates an error has occurred in the \fBbuf\fR(9S) structure. A subsequent call to \fBgeterror\fR(9F) will return \fIerror\fR. @@ -49,8 +46,6 @@ return \fIerror\fR. If \fIerror\fR is \fB0\fR, the error indication is cleared and a subsequent call to \fBgeterror\fR(9F) will return \fB0\fR. .SH CONTEXT -.LP \fBbioerror()\fR can be called from any context. .SH SEE ALSO -.LP \fBstrategy\fR(9E), \fBgeterror\fR(9F), \fBgetrbuf\fR(9F), \fBbuf\fR(9S) diff --git a/usr/src/man/man9f/biofini.9f b/usr/src/man/man9f/biofini.9f index 0fd09d444c..9afe2877e4 100644 --- a/usr/src/man/man9f/biofini.9f +++ b/usr/src/man/man9f/biofini.9f @@ -7,7 +7,6 @@ .SH NAME biofini \- uninitialize a buffer structure .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -16,11 +15,8 @@ biofini \- uninitialize a buffer structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIbp\fR\fR @@ -30,8 +26,6 @@ Pointer to the buffer header structure. .RE .SH DESCRIPTION -.sp -.LP The \fBbiofini()\fR function uninitializes a \fBbuf\fR(9S) structure. If a buffer structure has been allocated and initialized using \fBkmem_alloc\fR(9F) and \fBbioinit\fR(9F) it needs to be uninitialized using \fBbiofini()\fR before @@ -39,26 +33,21 @@ calling \fBkmem_free\fR(9F). It is not necessary to call \fBbiofini()\fR before freeing a buffer structure using \fBfreerbuf\fR(9F) because \fBfreerbuf()\fR will call \fBbiofini()\fR directly. .SH CONTEXT -.sp -.LP The \fBbiofini()\fR function can be called from any context. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBbiofini()\fR .sp .in +2 .nf -struct buf *bp = kmem_alloc(biosize(), KM_SLEEP); -bioinit(bp); -/* use buffer */ -biofini(bp); +struct buf *bp = kmem_alloc(biosize(), KM_SLEEP); +bioinit(bp); +/* use buffer */ +biofini(bp); kmem_free(bp, biosize()); .fi .in -2 .SH SEE ALSO -.sp -.LP \fBbioinit\fR(9F), \fBbioreset\fR(9F), \fBbiosize\fR(9F), \fBfreerbuf\fR(9F), \fBkmem_alloc\fR(9F), \fBkmem_free\fR(9F), \fBbuf\fR(9S) .sp diff --git a/usr/src/man/man9f/bioinit.9f b/usr/src/man/man9f/bioinit.9f index a302cb608d..a643404c93 100644 --- a/usr/src/man/man9f/bioinit.9f +++ b/usr/src/man/man9f/bioinit.9f @@ -7,7 +7,6 @@ .SH NAME bioinit \- initialize a buffer structure .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -16,11 +15,8 @@ bioinit \- initialize a buffer structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIbp\fR\fR @@ -30,24 +26,19 @@ Pointer to the buffer header structure. .RE .SH DESCRIPTION -.sp -.LP The \fBbioinit()\fR function initializes a \fBbuf\fR(9S) structure. A buffer structure contains state information which has to be initialized if the memory for the buffer was allocated using \fBkmem_alloc\fR(9F). This is not necessary for a buffer allocated using \fBgetrbuf\fR(9F) because \fBgetrbuf()\fR will call \fBbioinit()\fR directly. .SH CONTEXT -.sp -.LP The \fBbioinit()\fR function can be called from any context. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBbioinit()\fR .sp .in +2 .nf - + struct buf *bp = kmem_alloc(biosize(), KM_SLEEP); bioinit(bp); /* use buffer */ @@ -55,8 +46,6 @@ bioinit(bp); .in -2 .SH SEE ALSO -.sp -.LP \fBbiofini\fR(9F), \fBbioreset\fR(9F), \fBbiosize\fR(9F), \fBgetrbuf\fR(9F), \fBkmem_alloc\fR(9F), \fBbuf\fR(9S) .sp diff --git a/usr/src/man/man9f/biomodified.9f b/usr/src/man/man9f/biomodified.9f index 8cba5a3d39..14c8c57a7a 100644 --- a/usr/src/man/man9f/biomodified.9f +++ b/usr/src/man/man9f/biomodified.9f @@ -7,7 +7,6 @@ .SH NAME biomodified \- check if a buffer is modified .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -16,11 +15,8 @@ biomodified \- check if a buffer is modified .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIbp\fR\fR @@ -30,8 +26,6 @@ Pointer to the buffer header structure. .RE .SH DESCRIPTION -.sp -.LP The \fBbiomodified()\fR function returns status to indicate if the buffer is modified. The \fBbiomodified()\fR function is only supported for paged- \fBI/O \fRrequest, that is the \fBB_PAGEIO\fRflag must be set in the \fIb_flags\fR @@ -52,8 +46,6 @@ copies on all submirrors are identical. The \fBbiomodified()\fR function can be used in the device driver to detect any modifications to the buffer by the user program during the time the buffer is written to multiple submirrors. .SH RETURN VALUES -.sp -.LP The \fBbiomodified()\fR function returns the following values: .sp .ne 2 @@ -83,12 +75,8 @@ Buffer is not used for paged \fBI/O\fR request. .RE .SH CONTEXT -.sp -.LP \fBbiomodified()\fR can be called from any context. .SH SEE ALSO -.sp -.LP \fBbp_mapin\fR(9F), \fBbuf\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/bioreset.9f b/usr/src/man/man9f/bioreset.9f index 53480990ba..bc6638b764 100644 --- a/usr/src/man/man9f/bioreset.9f +++ b/usr/src/man/man9f/bioreset.9f @@ -7,7 +7,6 @@ .SH NAME bioreset \- reuse a private buffer header after I/O is complete .SH SYNOPSIS -.LP .nf #include <sys/buf.h> #include <sys/ddi.h> @@ -18,11 +17,8 @@ bioreset \- reuse a private buffer header after I/O is complete .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIbp\fR \fR @@ -32,23 +28,15 @@ Pointer to the \fBbuf\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP \fBbioreset()\fR is used by drivers that allocate private buffers with \fBgetrbuf\fR(9F) or \fBkmem_alloc\fR(9F) and want to reuse them in multiple transfers before freeing them with \fBfreerbuf\fR(9F) or \fBkmem_free\fR(9F). \fBbioreset()\fR resets the buffer header to the state it had when initially allocated by \fBgetrbuf()\fR or initialized by \fBbioinit\fR(9F). .SH CONTEXT -.sp -.LP \fBbioreset()\fR can be called from any context. .SH SEE ALSO -.sp -.LP \fBstrategy\fR(9E), \fBbioinit\fR(9F), \fBbiofini\fR(9F), \fBfreerbuf\fR(9F), \fBgetrbuf\fR(9F), \fBkmem_alloc\fR(9F), \fBkmem_free\fR(9F), \fBbuf\fR(9S) .SH NOTES -.sp -.LP \fIbp\fR must not describe a transfer in progress. diff --git a/usr/src/man/man9f/biosize.9f b/usr/src/man/man9f/biosize.9f index b763924b17..772bd0125f 100644 --- a/usr/src/man/man9f/biosize.9f +++ b/usr/src/man/man9f/biosize.9f @@ -7,7 +7,6 @@ .SH NAME biosize \- returns size of a buffer structure .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -16,23 +15,15 @@ biosize \- returns size of a buffer structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBbiosize()\fR function returns the size in bytes of the \fBbuf\fR(9S) structure. The \fBbiosize()\fR function is used by drivers in combination with \fBkmem_alloc\fR(9F) and \fBbioinit\fR(9F) to allocate buffer structures embedded in other data structures. .SH CONTEXT -.sp -.LP The \fBbiosize()\fR function can be called from any context. .SH SEE ALSO -.sp -.LP \fBbiofini\fR(9F), \fBbioinit\fR(9F), \fBgetrbuf\fR(9F), \fBkmem_alloc\fR(9F), \fBbuf\fR(9S) .sp diff --git a/usr/src/man/man9f/condvar.9f b/usr/src/man/man9f/condvar.9f index b09695927a..cfd496a8d4 100644 --- a/usr/src/man/man9f/condvar.9f +++ b/usr/src/man/man9f/condvar.9f @@ -9,7 +9,6 @@ condvar, cv_init, cv_destroy, cv_wait, cv_signal, cv_broadcast, cv_wait_sig, cv_timedwait, cv_timedwait_sig \- condition variable routines .SH SYNOPSIS -.LP .nf #include <sys/ksynch.h> @@ -66,8 +65,7 @@ cv_timedwait, cv_timedwait_sig \- condition variable routines .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -186,7 +184,6 @@ and .RE .SH DESCRIPTION -.LP Condition variables are a standard form of thread synchronization. They are designed to be used with mutual exclusion locks (mutexes). The associated mutex is used to ensure that a condition can be checked atomically and that the @@ -290,7 +287,6 @@ or \fBcv_broadcast()\fR, or due to a premature wakeup (see NOTES). .RE .SH CONTEXT -.LP These functions can be called from user, kernel or interrupt context. In most cases, however, \fBcv_wait()\fR, \fBcv_timedwait()\fR, \fBcv_wait_sig()\fR, \fBcv_timedwait_sig()\fR, \fBcv_reltimedwait()\fR, and @@ -313,7 +309,6 @@ serviced. In general, situations like this are hard to predict, so it is advisable to avoid waiting on condition variables or semaphores in an interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRWaiting for a Flag Value in a Driver's Unit .sp .LP @@ -342,7 +337,7 @@ unblock any threads blocked by the above code. .sp .in +2 .nf - + mutex_enter(&un->un_lock); un->un_flag &= ~UNIT_BUSY; cv_broadcast(&un->un_cv); @@ -351,7 +346,6 @@ mutex_exit(&un->un_lock); .in -2 .SH NOTES -.LP It is possible for \fBcv_wait()\fR, \fBcv_wait_sig()\fR, \fBcv_timedwait()\fR, \fBcv_timedwait_sig()\fR, \fBcv_reltimedwait()\fR, and \fBcv_reltimedwait_sig()\fR to return prematurely, that is, not due to a call to @@ -378,7 +372,6 @@ processes, users of these functions may need to protect against waiting indefinitely for events that might not occur. The \fBddi_can_receive_sig\fR(9F) function is provided to detect when signal reception is possible. .SH SEE ALSO -.LP \fBkill\fR(2), \fBddi_can_receive_sig\fR(9F), \fBddi_get_lbolt\fR(9F), \fBdrv_usectohz\fR(9F) \fBmutex\fR(9F), \fBmutex_init\fR(9F), .sp diff --git a/usr/src/man/man9f/csx_AccessConfigurationRegister.9f b/usr/src/man/man9f/csx_AccessConfigurationRegister.9f index 622d14252b..cc3778747c 100644 --- a/usr/src/man/man9f/csx_AccessConfigurationRegister.9f +++ b/usr/src/man/man9f/csx_AccessConfigurationRegister.9f @@ -8,7 +8,6 @@ csx_AccessConfigurationRegister \- read or write a PC Card Configuration Register .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -19,11 +18,8 @@ Register .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -42,13 +38,9 @@ Pointer to an \fBaccess_config_reg_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function allows a client to read or write a \fBPC\fRCard Configuration Register. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBaccess_config_reg_t\fR are: .sp .in +2 @@ -69,7 +61,7 @@ The fields are defined as follows: \fB\fBSocket\fR\fR .ad .RS 10n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -128,7 +120,6 @@ function should be used. Unlike \fBcsx_AccessConfigurationRegister()\fR, the to all clients using the \fBPC \fRCard, so they can re-establish the appropriate card state after the reset operation is complete. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -185,12 +176,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_ParseTuple\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_RequestConfiguration\fR(9F), \fBcsx_ResetFunction\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_CS_DDI_Info.9f b/usr/src/man/man9f/csx_CS_DDI_Info.9f index 3d4595df59..2008bc7e0d 100644 --- a/usr/src/man/man9f/csx_CS_DDI_Info.9f +++ b/usr/src/man/man9f/csx_CS_DDI_Info.9f @@ -7,7 +7,6 @@ .SH NAME csx_CS_DDI_Info \- obtain DDI information .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_CS_DDI_Info \- obtain DDI information .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIcdi\fR \fR @@ -31,15 +27,11 @@ Pointer to a \fBcs_ddi_info_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP -This function is a Solaris-specific extension that is used by clients that need +This function is an illumos-specific extension that is used by clients that need to provide the \fIxx_getinfo\fR driver entry point (see \fBgetinfo\fR(9E)). It provides a method for clients to obtain \fBDDI \fRinformation based on their socket number and client driver name. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcs_ddi_info_t\fR are: .sp .in +2 @@ -86,7 +78,6 @@ If the \fBdriver_name\fR is found on the \fBSocket\fR, the \fBcsx_CS_DDI_Info()\fR function returns both the \fBdev_info\fR pointer and the \fBinstance\fR fields for the requested driver instance. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -114,11 +105,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fR: Using csx_CS_DDI_Info .sp .LP @@ -172,8 +160,6 @@ pcepp_getinfo(dev_info_t *dip, ddi_info_cmd_t cmd, void *arg, .in -2 .SH SEE ALSO -.sp -.LP \fBgetinfo\fR(9E), \fBcsx_RegisterClient\fR(9F), \fBddi_get_instance\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_ConvertSize.9f b/usr/src/man/man9f/csx_ConvertSize.9f index a7aa89f78c..e177d6f367 100644 --- a/usr/src/man/man9f/csx_ConvertSize.9f +++ b/usr/src/man/man9f/csx_ConvertSize.9f @@ -7,7 +7,6 @@ .SH NAME csx_ConvertSize \- convert device sizes .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_ConvertSize \- convert device sizes .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIcs\fR \fR @@ -31,14 +27,10 @@ Pointer to a \fBconvert_size_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP -\fBcsx_ConvertSize()\fR is a Solaris-specific extension that provides a method +\fBcsx_ConvertSize()\fR is an illumos-specific extension that provides a method for clients to convert from one type of device size representation to another, that is, from \fIdevsize\fR format to \fIbytes\fR and vice versa. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBconvert_size_t\fR are: .sp .in +2 @@ -101,7 +93,6 @@ is converted to a \fIbytes\fR value and returned in the \fBbytes\fR field. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -129,12 +120,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_ModifyWindow\fR(9F), \fBcsx_RequestWindow\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_ConvertSpeed.9f b/usr/src/man/man9f/csx_ConvertSpeed.9f index e434730de1..bd9f0e5962 100644 --- a/usr/src/man/man9f/csx_ConvertSpeed.9f +++ b/usr/src/man/man9f/csx_ConvertSpeed.9f @@ -7,7 +7,6 @@ .SH NAME csx_ConvertSpeed \- convert device speeds .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_ConvertSpeed \- convert device speeds .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIcs\fR \fR @@ -31,14 +27,10 @@ Pointer to a \fBconvert_speed_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP -This function is a Solaris-specific extension that provides a method for +This function is an illumos-specific extension that provides a method for clients to convert from one type of device speed representation to another, that is, from \fIdevspeed\fR format to \fInS\fR and vice versa. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBconvert_speed_t\fR are: .sp .in +2 @@ -101,7 +93,6 @@ is converted to an \fInS\fR value and returned in the \fBnS\fR field. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -138,12 +129,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_ModifyWindow\fR(9F), \fBcsx_RequestWindow\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_DeregisterClient.9f b/usr/src/man/man9f/csx_DeregisterClient.9f index babb0b7988..ba271beda9 100644 --- a/usr/src/man/man9f/csx_DeregisterClient.9f +++ b/usr/src/man/man9f/csx_DeregisterClient.9f @@ -7,7 +7,6 @@ .SH NAME csx_DeregisterClient \- remove client from Card Services list .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_DeregisterClient \- remove client from Card Services list .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -31,8 +27,6 @@ Client handle returned from \fBcsx_RegisterClient\fR(9F). .RE .SH DESCRIPTION -.sp -.LP This function removes a client from the list of registered clients maintained by Card Services. The Client Handle returned by \fBcsx_RegisterClient\fR(9F) is passed in the \fBclient_handle_t\fR argument. @@ -41,7 +35,6 @@ passed in the \fBclient_handle_t\fR argument. The client must have returned all requested resources before this function is called. If any resources have not been released, \fBCS_IN_USE\fR is returned. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -78,18 +71,12 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_RegisterClient\fR(9F) .sp .LP \fIPC Card 95 Standard, PCMCIA/JEIDA\fR .SH WARNINGS -.sp -.LP Clients should be prepared to receive callbacks until Card Services returns from this request successfully. diff --git a/usr/src/man/man9f/csx_DupHandle.9f b/usr/src/man/man9f/csx_DupHandle.9f index 392828eed1..4c8a77b747 100644 --- a/usr/src/man/man9f/csx_DupHandle.9f +++ b/usr/src/man/man9f/csx_DupHandle.9f @@ -7,7 +7,6 @@ .SH NAME csx_DupHandle \- duplicate access handle .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_DupHandle \- duplicate access handle .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle1\fR \fR @@ -51,8 +47,6 @@ The access attributes that will be applied to the new handle. .RE .SH DESCRIPTION -.sp -.LP This function duplicates the handle, \fIhandle1\fR, into a new handle, \fIhandle2\fR, that has the access attributes specified in the \fIflags\fR argument. Both the original handle and the new handle are active and can be @@ -155,7 +149,6 @@ These values are advisory, not mandatory. For example, data can be ordered without being merged or cached, even though a driver requests unordered, merged and cached together. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -184,12 +177,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_Get8\fR(9F), \fBcsx_GetMappedAddr\fR(9F), \fBcsx_Put8\fR(9F), \fBcsx_RepGet8\fR(9F), \fBcsx_RepPut8\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestWindow\fR(9F) diff --git a/usr/src/man/man9f/csx_Error2Text.9f b/usr/src/man/man9f/csx_Error2Text.9f index ec01fb57ee..568c0e54e0 100644 --- a/usr/src/man/man9f/csx_Error2Text.9f +++ b/usr/src/man/man9f/csx_Error2Text.9f @@ -7,7 +7,6 @@ .SH NAME csx_Error2Text \- convert error return codes to text strings .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_Error2Text \- convert error return codes to text strings .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIer\fR \fR @@ -31,13 +27,9 @@ Pointer to an \fBerror2text_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP -This function is a Solaris-specific extension that provides a method for +This function is an illumos-specific extension that provides a method for clients to convert Card Services error return codes to text strings. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBerror2text_t\fR are: .sp .in +2 @@ -58,7 +50,6 @@ Card Services error return code specified in the item field is not found, the .LP "{\fIunknown Card Services return code\fR}" .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -77,11 +68,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fR: Using the csxError2Text function .sp .in +2 @@ -99,8 +87,6 @@ if ((ret = csx_RegisterClient(&client_handle, & .in -2 .SH SEE ALSO -.sp -.LP \fBcsx_Event2Text\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_Event2Text.9f b/usr/src/man/man9f/csx_Event2Text.9f index 8331c65d7e..9e1087e502 100644 --- a/usr/src/man/man9f/csx_Event2Text.9f +++ b/usr/src/man/man9f/csx_Event2Text.9f @@ -7,7 +7,6 @@ .SH NAME csx_Event2Text \- convert events to text strings .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_Event2Text \- convert events to text strings .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIev\fR\fR @@ -31,13 +27,9 @@ Pointer to an \fBevent2text_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP -This function is a Solaris-specific extension that provides a method for +This function is an illumos-specific extension that provides a method for clients to convert Card Services events to text strings. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBevent2text_t\fR are: .sp .in +2 @@ -71,7 +63,6 @@ The text string describing the name of the event. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -90,18 +81,15 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fR: Using \fBcsx_Event2Text()\fR .sp .in +2 .nf xx_event(event_t event, int priority, event_callback_args_t *eca) -{ - event2text_t event2text; +{ + event2text_t event2text; event2text.event = event; csx_Event2Text(&event2text); @@ -111,8 +99,6 @@ xx_event(event_t event, int priority, event_callback_args_t *eca) .in -2 .SH SEE ALSO -.sp -.LP \fBcsx_event_handler\fR(9E), \fBcsx_Error2Text\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_FreeHandle.9f b/usr/src/man/man9f/csx_FreeHandle.9f index f5a74242a3..43e4966d07 100644 --- a/usr/src/man/man9f/csx_FreeHandle.9f +++ b/usr/src/man/man9f/csx_FreeHandle.9f @@ -7,7 +7,6 @@ .SH NAME csx_FreeHandle \- free access handle .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_FreeHandle \- free access handle .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -32,15 +28,12 @@ The access handle returned from \fBcsx_RequestIO\fR(9F), .RE .SH DESCRIPTION -.sp -.LP This function frees the handle, \fIhandle\fR. If the handle was created by the \fBcsx_DupHandle\fR(9F) function, this function will free the storage associated with this handle, but will not modify any resources that the original handle refers to. If the handle was created by a common access setup function, this function will release the resources associated with this handle. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -59,12 +52,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_DupHandle\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestWindow\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_Get8.9f b/usr/src/man/man9f/csx_Get8.9f index 544413006e..ecc8c0e86e 100644 --- a/usr/src/man/man9f/csx_Get8.9f +++ b/usr/src/man/man9f/csx_Get8.9f @@ -7,7 +7,6 @@ .SH NAME csx_Get8, csx_Get16, csx_Get32, csx_Get64 \- read data from device address .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -32,11 +31,8 @@ csx_Get8, csx_Get16, csx_Get32, csx_Get64 \- read data from device address .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -56,8 +52,6 @@ The offset in bytes from the base of the mapped resource. .RE .SH DESCRIPTION -.sp -.LP These functions generate a read of various sizes from the mapped memory or device register. .sp @@ -73,16 +67,10 @@ maintain a consistent view between the host and the device based on the encoded information in the data access handle. The translation may involve byte swapping if the host and the device have incompatible endian characteristics. .SH RETURN VALUES -.sp -.LP These functions return the value read from the mapped address. .SH CONTEXT -.sp -.LP These functions may be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBcsx_DupHandle\fR(9F), \fBcsx_GetMappedAddr\fR(9F), \fBcsx_Put8\fR(9F), \fBcsx_RepGet8\fR(9F), \fBcsx_RepPut8\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestWindow\fR(9F) diff --git a/usr/src/man/man9f/csx_GetFirstClient.9f b/usr/src/man/man9f/csx_GetFirstClient.9f index c1e799eca1..e357a4a1cb 100644 --- a/usr/src/man/man9f/csx_GetFirstClient.9f +++ b/usr/src/man/man9f/csx_GetFirstClient.9f @@ -7,7 +7,6 @@ .SH NAME csx_GetFirstClient, csx_GetNextClient \- return first or next client .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -22,11 +21,8 @@ csx_GetFirstClient, csx_GetNextClient \- return first or next client .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIfnc\fR \fR @@ -36,14 +32,10 @@ Pointer to a \fBget_firstnext_client_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP The functions \fBcsx_GetFirstClient()\fR and \fBcsx_GetNextClient()\fR return information about the first or subsequent \fBPC \fRcards, respectively, that are installed in the system. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBget_firstnext_client_t\fR are: .sp .in +2 @@ -117,7 +109,6 @@ The number of clients is returned in this field. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -172,12 +163,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_event_handler\fR(9E) .sp .LP diff --git a/usr/src/man/man9f/csx_GetFirstTuple.9f b/usr/src/man/man9f/csx_GetFirstTuple.9f index 6ab28891d3..68644e61ce 100644 --- a/usr/src/man/man9f/csx_GetFirstTuple.9f +++ b/usr/src/man/man9f/csx_GetFirstTuple.9f @@ -7,7 +7,6 @@ .SH NAME csx_GetFirstTuple, csx_GetNextTuple \- return Card Information Structure tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -22,11 +21,8 @@ csx_GetFirstTuple, csx_GetNextTuple \- return Card Information Structure tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -45,14 +41,10 @@ Pointer to a \fBtuple_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP The functions \fBcsx_GetFirstTuple()\fR and \fBcsx_GetNextTuple()\fR return the first and next tuple, respectively, of the specified type in the Card Information Structure (CIS) for the specified socket. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBtuple_t\fR are: .sp .in +2 @@ -74,7 +66,7 @@ The fields are defined as follows: \fB\fBSocket\fR\fR .ad .RS 23n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -154,7 +146,6 @@ structure, some fields in the \fBtuple_t\fR structure are unused or reserved when calling this function and these fields must not be initialized by the client. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -209,12 +200,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetTupleData\fR(9F), \fBcsx_ParseTuple\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_GetHandleOffset.9f b/usr/src/man/man9f/csx_GetHandleOffset.9f index ee4cf2d740..243291426a 100644 --- a/usr/src/man/man9f/csx_GetHandleOffset.9f +++ b/usr/src/man/man9f/csx_GetHandleOffset.9f @@ -7,7 +7,6 @@ .SH NAME csx_GetHandleOffset \- return current access handle offset .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -15,11 +14,8 @@ csx_GetHandleOffset \- return current access handle offset .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -39,12 +35,9 @@ returned. .RE .SH DESCRIPTION -.sp -.LP This function returns the current offset for the access handle, \fIhandle\fR, in \fIoffset\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -54,12 +47,8 @@ Successful operation. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_RequestIO\fR(9F), \fBcsx_RequestIRQ\fR(9F), \fBcsx_SetHandleOffset\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_GetMappedAddr.9f b/usr/src/man/man9f/csx_GetMappedAddr.9f index 133f11ba59..6a9633ccc7 100644 --- a/usr/src/man/man9f/csx_GetMappedAddr.9f +++ b/usr/src/man/man9f/csx_GetMappedAddr.9f @@ -7,7 +7,6 @@ .SH NAME csx_GetMappedAddr \- return mapped virtual address .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_GetMappedAddr \- return mapped virtual address .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -41,12 +37,9 @@ The virtual or \fBI/O \fRport number represented by the handle. .RE .SH DESCRIPTION -.sp -.LP This function returns the mapped virtual address or the mapped \fBI/O \fRport number represented by the handle, \fIhandle\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -77,12 +70,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBcsx_DupHandle\fR(9F), \fBcsx_Get8\fR(9F), \fBcsx_Put8\fR(9F), \fBcsx_RepGet8\fR(9F), \fBcsx_RepPut8\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestWindow\fR(9F) diff --git a/usr/src/man/man9f/csx_GetStatus.9f b/usr/src/man/man9f/csx_GetStatus.9f index 24e600d361..86c82b577f 100644 --- a/usr/src/man/man9f/csx_GetStatus.9f +++ b/usr/src/man/man9f/csx_GetStatus.9f @@ -7,7 +7,6 @@ .SH NAME csx_GetStatus \- return the current status of a PC Card and its socket .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_GetStatus \- return the current status of a PC Card and its socket .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -40,12 +36,8 @@ Pointer to a \fBget_status_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function returns the current status of a \fBPC \fRCard and its socket. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBget_status_t\fR are: .sp .in +2 @@ -66,7 +58,7 @@ The fields are defined as follows: \fB\fBSocket\fR \fR .ad .RS 18n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -424,7 +416,7 @@ only on the state reported in the \fBCardState\fR field. \fB\fBraw_CardState\fR \fR .ad .RS 18n -The \fBraw_CardState\fR field is a Solaris-specific extension that allows the +The \fBraw_CardState\fR field is an illumos-specific extension that allows the client to determine if any card is inserted in the socket. The bit definitions in the \fBraw_CardState\fR field are identical to those in the \fBCardState\fR field with the exception that the \fBCS_STATUS_CARD_INSERTED\fR bit in the @@ -432,7 +424,6 @@ field with the exception that the \fBCS_STATUS_CARD_INSERTED\fR bit in the .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -473,12 +464,8 @@ No \fBPCMCIA \fRhardware installed. \fBCS_NO_CARD\fR will not be returned if there is no \fBPC \fRCard present in the socket. .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_RegisterClient\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_GetTupleData.9f b/usr/src/man/man9f/csx_GetTupleData.9f index ed59e10e13..f0d3c49c56 100644 --- a/usr/src/man/man9f/csx_GetTupleData.9f +++ b/usr/src/man/man9f/csx_GetTupleData.9f @@ -7,7 +7,6 @@ .SH NAME csx_GetTupleData \- return the data portion of a tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_GetTupleData \- return the data portion of a tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -40,13 +36,9 @@ Pointer to a \fBtuple_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function returns the data portion of a tuple, as returned by the \fBcsx_GetFirstTuple\fR(9F) and \fBcsx_GetNextTuple\fR(9F) functions. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBtuple_t\fR are: .sp .LP @@ -72,7 +64,7 @@ cisdata_t TupleLink; /* tuple link */ \fB\fBSocket\fR\fR .ad .RS 16n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -158,7 +150,6 @@ client must not modify the value in this field. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -223,12 +214,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_ParseTuple\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_MakeDeviceNode.9f b/usr/src/man/man9f/csx_MakeDeviceNode.9f index 1888d83c94..ca0b3deb77 100644 --- a/usr/src/man/man9f/csx_MakeDeviceNode.9f +++ b/usr/src/man/man9f/csx_MakeDeviceNode.9f @@ -8,7 +8,6 @@ csx_MakeDeviceNode, csx_RemoveDeviceNode \- create and remove minor nodes on behalf of the client .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -23,11 +22,8 @@ behalf of the client .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -46,14 +42,10 @@ Pointer to a \fBmake_device_node_t\fR or \fBremove_device_node_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fBcsx_MakeDeviceNode()\fR and \fBcsx_RemoveDeviceNode()\fR are -Solaris-specific extensions to allow the client to request that device nodes in +illumos-specific extensions to allow the client to request that device nodes in the filesystem are created or removed, respectively, on its behalf. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBmake_device_node_t\fR are: .sp .in +2 @@ -174,7 +166,6 @@ will be removed from the filesystem. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -229,12 +220,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_RegisterClient\fR(9F), \fBddi_create_minor_node\fR(9F), \fBddi_remove_minor_node\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_MapLogSocket.9f b/usr/src/man/man9f/csx_MapLogSocket.9f index 5a5092f6c4..d69474adb9 100644 --- a/usr/src/man/man9f/csx_MapLogSocket.9f +++ b/usr/src/man/man9f/csx_MapLogSocket.9f @@ -8,7 +8,6 @@ csx_MapLogSocket \- return the physical socket number associated with the client handle .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ client handle .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -41,13 +37,9 @@ Pointer to a \fBmap_log_socket_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function returns the physical socket number associated with the client handle. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBmap_log_socket_t\fR are: .sp .in +2 @@ -77,7 +69,7 @@ arbitrary value. \fB\fBPhyAdapter\fR \fR .ad .RS 15n -Returns the physical adapter number, which is always \fB0\fR in the Solaris +Returns the physical adapter number, which is always \fB0\fR in the illumos implementation of Card Services. .RE @@ -93,7 +85,6 @@ or if the client creates minor nodes based on the physical socket number. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -121,12 +112,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_RegisterClient\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_MapMemPage.9f b/usr/src/man/man9f/csx_MapMemPage.9f index 6d670ccd96..4ffc97be24 100644 --- a/usr/src/man/man9f/csx_MapMemPage.9f +++ b/usr/src/man/man9f/csx_MapMemPage.9f @@ -7,7 +7,6 @@ .SH NAME csx_MapMemPage \- map the memory area on a PC Card .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_MapMemPage \- map the memory area on a PC Card .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIwh\fR \fR @@ -40,13 +36,9 @@ Pointer to a \fBmap_mem_page_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function maps the memory area on a \fBPC \fRCard into a page of a window allocated with the \fBcsx_RequestWindow\fR(9F) function. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBmap_mem_page_t\fR are: .sp .in +2 @@ -80,7 +72,6 @@ calling this function. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -135,12 +126,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_ModifyWindow\fR(9F), \fBcsx_ReleaseWindow\fR(9F), \fBcsx_RequestWindow\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_ModifyConfiguration.9f b/usr/src/man/man9f/csx_ModifyConfiguration.9f index ef403999b7..39fa1c80d0 100644 --- a/usr/src/man/man9f/csx_ModifyConfiguration.9f +++ b/usr/src/man/man9f/csx_ModifyConfiguration.9f @@ -7,7 +7,6 @@ .SH NAME csx_ModifyConfiguration \- modify socket and PC Card Configuration Register .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_ModifyConfiguration \- modify socket and PC Card Configuration Register .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -40,14 +36,10 @@ Pointer to a \fBmodify_config_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function allows a socket and \fBPC \fRCard configuration to be modified. This function can only modify a configuration requested via \fBcsx_RequestConfiguration\fR(9F). .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBmodify_config_t\fR are: .sp .in +2 @@ -68,7 +60,7 @@ The fields are defined as follows: \fB\fBSocket\fR \fR .ad .RS 15n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -147,7 +139,6 @@ and \fBVpp\fR. (See \fBWARNINGS\fR.) .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -202,12 +193,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_RegisterClient\fR(9F), \fBcsx_ReleaseConfiguration\fR(9F), \fBcsx_ReleaseIO\fR(9F), \fBcsx_ReleaseIRQ\fR(9F), \fBcsx_RequestConfiguration\fR(9F), \fBcsx_RequestIO\fR(9F), @@ -233,8 +220,6 @@ result in the loss of a \fBPC \fRCard's state. Any client setting \fBVpp\fR to restored when power is re-applied to the card. .RE .SH NOTES -.sp -.LP Mapped \fBIO \fRaddresses can only be changed by first releasing the current configuration and \fBIO \fRresources with \fBcsx_ReleaseConfiguration\fR(9F) and \fBcsx_ReleaseIO\fR(9F), requesting new \fBIO \fRresources and a new diff --git a/usr/src/man/man9f/csx_ModifyWindow.9f b/usr/src/man/man9f/csx_ModifyWindow.9f index 575e237304..04e60b7e03 100644 --- a/usr/src/man/man9f/csx_ModifyWindow.9f +++ b/usr/src/man/man9f/csx_ModifyWindow.9f @@ -8,7 +8,6 @@ .SH NAME csx_ModifyWindow \- modify window attributes .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_ModifyWindow \- modify window attributes .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIwh\fR \fR @@ -41,8 +37,6 @@ Pointer to a \fBmodify_win_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function modifies the attributes of a window allocated by the \fBcsx_RequestWindow\fR(9F) function. .sp @@ -53,8 +47,6 @@ offset into \fBPC \fRCard memory to be mapped into system memory for paged windows. The \fBcsx_RequestWindow\fR(9F) and \fBcsx_ReleaseWindow\fR(9F) functions must be used to change the window base or size. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBmodify_win_t\fR are: .sp .in +2 @@ -186,7 +178,6 @@ perturbing the \fBAccessSpeed\fR field. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -250,12 +241,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_ConvertSpeed\fR(9F), \fBcsx_MapMemPage\fR(9F), \fBcsx_ReleaseWindow\fR(9F), \fBcsx_RequestWindow\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_ParseTuple.9f b/usr/src/man/man9f/csx_ParseTuple.9f index 4d5416a5ca..7f5e34d06c 100644 --- a/usr/src/man/man9f/csx_ParseTuple.9f +++ b/usr/src/man/man9f/csx_ParseTuple.9f @@ -7,7 +7,6 @@ .SH NAME csx_ParseTuple \- generic tuple parser .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_ParseTuple \- generic tuple parser .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -61,12 +57,8 @@ Extended tuple data for some tuples. .RE .SH DESCRIPTION -.sp -.LP This function is the generic tuple parser entry point. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcisparse_t\fR are: .sp .in +2 @@ -101,7 +93,6 @@ The structure members of \fBcisparse_t\fR are: .in -2 .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -165,12 +156,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_BATTERY\fR(9F), \fBcsx_Parse_CISTPL_BYTEORDER\fR(9F), \fBcsx_Parse_CISTPL_CFTABLE_ENTRY\fR(9F), \fBcsx_Parse_CISTPL_CONFIG\fR(9F), diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_BATTERY.9f b/usr/src/man/man9f/csx_Parse_CISTPL_BATTERY.9f index d674de04b3..98e2471a49 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_BATTERY.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_BATTERY.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_BATTERY \- parse the Battery Replacement Date tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_BATTERY \- parse the Battery Replacement Date tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_battery_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Battery Replacement Date tuple, \fBCISTPL_BATTERY,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -63,8 +57,6 @@ in \fBPC \fRCards with battery-backed storage. It indicates the date on which the battery was replaced, and the date on which the battery is expected to need replacement. Only one \fBCISTPL_BATTERY\fR tuple is allowed per \fBPC \fRCard. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_battery_t\fR are: .sp .in +2 @@ -96,7 +88,6 @@ This field indicates the date on which the battery should be replaced. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -151,12 +142,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_BYTEORDER.9f b/usr/src/man/man9f/csx_Parse_CISTPL_BYTEORDER.9f index 12bcffd451..eab95ee20d 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_BYTEORDER.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_BYTEORDER.9f @@ -8,7 +8,6 @@ .SH NAME csx_Parse_CISTPL_BYTEORDER \- parse the Byte Order tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -19,11 +18,8 @@ csx_Parse_CISTPL_BYTEORDER \- parse the Byte Order tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -53,8 +49,6 @@ Pointer to a \fBcistpl_byteorder_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Byte Order tuple, \fBCISTPL_BYTEORDER\fR, into a form usable by \fBPC \fRCard drivers. .sp @@ -63,8 +57,6 @@ The \fBCISTPL_BYTEORDER\fR tuple shall only appear in a partition tuple set for a memory-like partition. It specifies two parameters: the order for multi-byte data, and the order in which bytes map into words for 16-bit cards. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_byteorder_t\fR are: .sp .in +2 @@ -141,7 +133,6 @@ Vendor specific mapping .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -196,12 +187,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_CFTABLE_ENTRY.9f b/usr/src/man/man9f/csx_Parse_CISTPL_CFTABLE_ENTRY.9f index 053b5b3ef9..bf9552b8c9 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_CFTABLE_ENTRY.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_CFTABLE_ENTRY.9f @@ -8,7 +8,6 @@ csx_Parse_CISTPL_CFTABLE_ENTRY \- parse 16-bit Card Configuration Table Entry tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -19,11 +18,8 @@ tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -53,8 +49,6 @@ Pointer to a \fBcistpl_cftable_entry_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the 16 bit Card Configuration Table Entry tuple, \fBCISTPL_CFTABLE_ENTRY,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -64,8 +58,6 @@ configuration of a \fBPC \fRCard and to distinguish among the permitted configurations. The \fBCISTPL_CONFIG\fR tuple must precede all \fBCISTPL_CFTABLE_ENTRY\fR tuples. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_cftable_entry_t\fR are: .sp .in +2 @@ -805,7 +797,6 @@ DMA width 16 bits .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -860,12 +851,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_CONFIG\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_CONFIG.9f b/usr/src/man/man9f/csx_Parse_CISTPL_CONFIG.9f index 4bbf84e1a1..ec02b836a4 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_CONFIG.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_CONFIG.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_CONFIG \- parse Configuration tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_CONFIG \- parse Configuration tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_config_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Configuration tuple, \fBCISTPL_CONFIG,\fR into a form usable by \fBPC \fRCard drivers. The \fBCISTPL_CONFIG\fR tuple is used to describe the general characteristics of 16-bit \fBPC \fRCards containing \fBI/O @@ -61,8 +55,6 @@ describe the general characteristics of 16-bit \fBPC \fRCards containing \fBI/O including Memory Only cards, which exceed nominal power supply specifications, or which need descriptions of their power requirements or other information. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_config_t\fR are: .sp .in +2 @@ -232,7 +224,6 @@ This field contains the value of the last valid configuration index for this .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -287,12 +278,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_CFTABLE_ENTRY\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) @@ -300,7 +287,5 @@ This function may be called from user or kernel context. .LP \fIPC Card 95 Standard, PCMCIA/JEIDA\fR .SH NOTES -.sp -.LP \fBPC \fRCard drivers should not attempt to use configurations beyond the "last" member in the \fBcistpl_config_t\fR structure. diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_DATE.9f b/usr/src/man/man9f/csx_Parse_CISTPL_DATE.9f index b84bcae7f0..88a0989c91 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_DATE.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_DATE.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_DATE \- parse the Card Initialization Date tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_DATE \- parse the Card Initialization Date tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_date_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Card Initialization Date tuple, \fBCISTPL_DATE,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -62,8 +56,6 @@ The \fBCISTPL_DATE\fR tuple is an optional tuple. It indicates the date and time at which the card was formatted. Only one \fBCISTPL_DATE\fR tuple is allowed per \fBPC \fRCard. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_date_t\fR are: .sp .in +2 @@ -95,7 +87,6 @@ This field indicates the date the \fBPC \fRCard was initialized. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -150,12 +141,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_DEVICE.9f b/usr/src/man/man9f/csx_Parse_CISTPL_DEVICE.9f index d467b353c0..129ad0211f 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_DEVICE.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_DEVICE.9f @@ -8,7 +8,6 @@ csx_Parse_CISTPL_DEVICE, csx_Parse_CISTPL_DEVICE_A, csx_Parse_CISTPL_DEVICE_OC, csx_Parse_CISTPL_DEVICE_OA \- parse Device Information tuples .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -37,11 +36,8 @@ csx_Parse_CISTPL_DEVICE_OA \- parse Device Information tuples .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -73,8 +69,6 @@ respectively. .RE .SH DESCRIPTION -.sp -.LP \fBcsx_Parse_CISTPL_DEVICE()\fR and \fBcsx_Parse_CISTPL_DEVICE_A()\fR parse the 5 volt Device Information tuples, \fBCISTPL_DEVICE\fR and \fBCISTPL_DEVICE_A,\fR respectively, into a form usable by \fBPC \fRCard @@ -97,8 +91,6 @@ The \fBCISTPL_DEVICE_OC\fR and \fBCISTPL_DEVICE_OA\fR tuples are used to describe the information about the card's device under a set of operating conditions for Common Memory or Attribute Memory space, respectively. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_device_t\fR are: .sp .in +2 @@ -352,7 +344,6 @@ Extended type follows .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -407,12 +398,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_JEDEC_C\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO.9f b/usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO.9f index 25780efec7..58336ddced 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_DEVICEGEO \- parse the Device Geo tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_DEVICEGEO \- parse the Device Geo tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -52,8 +48,6 @@ Device Geo tuple information upon return from this function. .RE .SH DESCRIPTION -.sp -.LP This function parses the Device Geo tuple, \fBCISTPL_DEVICEGEO,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -61,8 +55,6 @@ usable by \fBPC \fRCard drivers. The \fBCISTPL_DEVICEGEO\fR tuple describes the device geometry of common memory partitions. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_devicegeo_t\fR are: .sp .in +2 @@ -141,7 +133,6 @@ This field indicates the hardware interleave .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -196,12 +187,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetNextTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_DEVICEGEO_A\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBtuple\fR(9S) diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO_A.9f b/usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO_A.9f index c311e8b2d6..f7b5d1d72e 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO_A.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO_A.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_DEVICEGEO_A \- parse the Device Geo A tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_DEVICEGEO_A \- parse the Device Geo A tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -52,8 +48,6 @@ Device Geo A tuple information upon return from this function. .RE .SH DESCRIPTION -.sp -.LP This function parses the Device Geo A tuple, \fBCISTPL_DEVICEGEO_A,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -61,8 +55,6 @@ form usable by \fBPC \fRCard drivers. The \fBCISTPL_DEVICEGEO_A\fR tuple describes the device geometry of attribute memory partitions. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_devicegeo_t\fR are: .sp .in +2 @@ -141,7 +133,6 @@ This field indicates the hardware interleave for the given partition. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -196,12 +187,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetNextTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_DEVICEGEO\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBtuple\fR(9S) diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_FORMAT.9f b/usr/src/man/man9f/csx_Parse_CISTPL_FORMAT.9f index c5e9abb1d7..a64ad600b1 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_FORMAT.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_FORMAT.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_FORMAT \- parse the Data Recording Format tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_FORMAT \- parse the Data Recording Format tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_format_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Data Recording Format tuple, \fBCISTPL_FORMAT,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -61,8 +55,6 @@ a form usable by \fBPC \fRCard drivers. The \fBCISTPL_FORMAT\fR tuple indicates the data recording format for a device partition. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_format_t\fR are: .sp .in +2 @@ -241,7 +233,6 @@ devices. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -296,12 +287,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_FUNCE.9f b/usr/src/man/man9f/csx_Parse_CISTPL_FUNCE.9f index ccb6f1b7ed..f634a15b4d 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_FUNCE.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_FUNCE.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_FUNCE \- parse Function Extension tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -19,11 +18,8 @@ csx_Parse_CISTPL_FUNCE \- parse Function Extension tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -63,8 +59,6 @@ The function \fBID \fRcode to which this \fBCISTPL_FUNCE\fR tuple refers. See .RE .SH DESCRIPTION -.sp -.LP This function parses the Function Extension tuple, \fBCISTPL_FUNCE,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -74,8 +68,6 @@ The \fBCISTPL_FUNCE\fR tuple is used to describe information about a specific Identification tuple, \fBCISTPL_FUNCID,\fR that is being extended. Each function has a defined set of extension tuples. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_funce_t\fR are: .sp .in +2 @@ -1090,7 +1082,6 @@ Point to point infra red .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -1145,12 +1136,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_FUNCID\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_FUNCID.9f b/usr/src/man/man9f/csx_Parse_CISTPL_FUNCID.9f index 1d1de256aa..3f8dcf198d 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_FUNCID.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_FUNCID.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_FUNCID \- parse Function Identification tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_FUNCID \- parse Function Identification tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_funcid_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Function Identification tuple, \fBCISTPL_FUNCID,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -65,8 +59,6 @@ during system initialization. If additional function specific information is available, one or more function extension tuples of type \fBCISTPL_FUNCE\fR follow this tuple (see \fBcsx_Parse_CISTPL_FUNCE\fR(9F)). .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_funcid_t\fR are: .sp .in +2 @@ -224,7 +216,6 @@ Map ROM during sys init .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -279,12 +270,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_FUNCE\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_GEOMETRY.9f b/usr/src/man/man9f/csx_Parse_CISTPL_GEOMETRY.9f index 7159f29fa6..b268945b0c 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_GEOMETRY.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_GEOMETRY.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_GEOMETRY \- parse the Geometry tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_GEOMETRY \- parse the Geometry tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,16 +48,12 @@ Pointer to a \fBcistpl_geometry_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Geometry tuple, \fBCISTPL_GEOMETRY\fR, into a form usable by \fBPC\fR Card drivers. .sp .LP The \fBCISTPL_GEOMETRY\fR tuple indicates the geometry of a disk-like device. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_geometry_t\fR are: .sp .in +2 @@ -103,7 +95,6 @@ This field indicates the number of cylinders. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -158,12 +149,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_JEDEC_C.9f b/usr/src/man/man9f/csx_Parse_CISTPL_JEDEC_C.9f index 0d8a4d0d1e..7155d448ec 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_JEDEC_C.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_JEDEC_C.9f @@ -8,7 +8,6 @@ csx_Parse_CISTPL_JEDEC_C, csx_Parse_CISTPL_JEDEC_A \- parse JEDEC Identifier tuples .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -25,11 +24,8 @@ tuples .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -60,8 +56,6 @@ these functions, respectively. .RE .SH DESCRIPTION -.sp -.LP \fBcsx_Parse_CISTPL_JEDEC_C()\fR and \fBcsx_Parse_CISTPL_JEDEC_A()\fR parse the \fBJEDEC\fR Identifier tuples, \fBCISTPL_JEDEC_C\fR and \fBCISTPL_JEDEC_A,\fR respectively, into a form usable by \fBPC\fR Card drivers. @@ -71,8 +65,6 @@ The \fBCISTPL_JEDEC_C\fR and \fBCISTPL_JEDEC_A\fR tuples are optional tuples provided for cards containing programmable devices. They describe information for Common Memory or Attribute Memory space, respectively. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_jedec_t\fR are: .sp .in +2 @@ -94,7 +86,6 @@ The structure members of \fBjedec_ident_t\fR are: .in -2 .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -149,12 +140,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_DEVICE\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_LINKTARGET.9f b/usr/src/man/man9f/csx_Parse_CISTPL_LINKTARGET.9f index 4d99088577..6f4ebb3715 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_LINKTARGET.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_LINKTARGET.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_LINKTARGET \- parse the Link Target tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_Parse_CISTPL_LINKTARGET \- parse the Link Target tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -51,8 +47,6 @@ Pointer to a \fBcistpl_linktarget_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Link Target tuple, \fBCISTPL_LINKTARGET,\fR into a form usable by \fBPC\fRCard drivers. .sp @@ -61,8 +55,6 @@ The \fBCISTPL_LINKTARGET\fR tuple is used to verify that tuple chains other than the primary chain are valid. All secondary tuple chains are required to contain this tuple as the first tuple of the chain. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_linktarget_t\fR are: .sp .in +2 @@ -94,7 +86,6 @@ This field provides the Link Target tuple information. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -149,12 +140,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_A.9f b/usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_A.9f index 4a17849e66..64a9745c5c 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_A.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_A.9f @@ -8,7 +8,6 @@ csx_Parse_CISTPL_LONGLINK_A, csx_Parse_CISTPL_LONGLINK_C \- parse the Long Link A and C tuples .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -25,11 +24,8 @@ A and C tuples .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -60,8 +56,6 @@ return from this function. .RE .SH DESCRIPTION -.sp -.LP This function parses the Long Link A and C tuples, \fBCISTPL_LONGLINK_A\fR and \fBCISTPL_LONGLINK_A,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -69,8 +63,6 @@ This function parses the Long Link A and C tuples, \fBCISTPL_LONGLINK_A\fR and The \fBCISTPL_LONGLINK_A\fR and \fBCISTPL_LONGLINK_C\fR tuples provide links to Attribute and Common Memory. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_longlink_ac_t\fR are: .sp .in +2 @@ -121,7 +113,6 @@ space. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -176,12 +167,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_MFC.9f b/usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_MFC.9f index b44a5bb3c2..77d6d23d19 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_MFC.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_MFC.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_LONGLINK_MFC \- parse the Multi-Function tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_LONGLINK_MFC \- parse the Multi-Function tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_longlink_mfc_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Multi-Function tuple, \fBCISTPL_LONGLINK_MFC,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -61,8 +55,6 @@ a form usable by \fBPC \fRCard drivers. The \fBCISTPL_LONGLINK_MFC\fR tuple describes the start of the function-specific \fBCIS \fRfor each function on a multi-function card. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_longlink_mfc_t\fR are: .sp .in +2 @@ -140,7 +132,6 @@ This field provides the target address offset for each function on the \fBPC .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -195,12 +186,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_MANFID.9f b/usr/src/man/man9f/csx_Parse_CISTPL_MANFID.9f index 60baa632dc..545cc80c9a 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_MANFID.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_MANFID.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_MANFID \- parse Manufacturer Identification tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_MANFID \- parse Manufacturer Identification tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_manfid_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Manufacturer Identification tuple, \fBCISTPL_MANFID,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -62,8 +56,6 @@ The \fBCISTPL_MANFID\fR tuple is used to describe the information about the manufacturer of a \fBPC \fRCard. There are two types of information, the \fBPC \fRCard's manufacturer and a manufacturer card number. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_manfid_t\fR are: .sp .in +2 @@ -75,7 +67,6 @@ uint32_t card; /* manufacturer information .in -2 .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -130,12 +121,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_ORG.9f b/usr/src/man/man9f/csx_Parse_CISTPL_ORG.9f index 060629bf9c..fa5bca3308 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_ORG.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_ORG.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_ORG \- parse the Data Organization tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_ORG \- parse the Data Organization tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,16 +48,12 @@ Pointer to a \fBcistpl_org_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Data Organization tuple, \fBCISTPL_ORG,\fR into a form usable by \fBPC \fRCard drivers. .sp .LP The \fBCISTPL_ORG\fR tuple provides a text description of the organization. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_org_t\fR are: .sp .in +2 @@ -95,7 +87,6 @@ This field provides the text description of this organization. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -150,12 +141,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_SPCL.9f b/usr/src/man/man9f/csx_Parse_CISTPL_SPCL.9f index 21138c72a8..509f771ca3 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_SPCL.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_SPCL.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_SPCL \- parse the Special Purpose tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_SPCL \- parse the Special Purpose tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_spcl_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Special Purpose tuple, \fBCISTPL_SPCL,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -65,8 +59,6 @@ stored in a single tuple; the maximum data area of a series of \fBCISTPL_SPCL\fR tuples is unlimited. Another field gives the number of bytes in the data field in this tuple. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_date_t\fR are: .sp .in +2 @@ -122,7 +114,6 @@ The data component of this tuple. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -177,12 +168,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_SWIL.9f b/usr/src/man/man9f/csx_Parse_CISTPL_SWIL.9f index cbf00e90c7..267bfa88e2 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_SWIL.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_SWIL.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_SWIL \- parse the Software Interleaving tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_SWIL \- parse the Software Interleaving tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_swil_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Software Interleaving tuple, \fBCISTPL_SWIL,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -61,8 +55,6 @@ form usable by \fBPC \fRCard drivers. The \fBCISTPL_SWIL\fR tuple provides the software interleaving of data within a partition on the card. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_swil_t\fR are: .sp .in +2 @@ -84,7 +76,6 @@ This field provides the software interleaving for a partition. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -139,12 +130,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_VERS_1.9f b/usr/src/man/man9f/csx_Parse_CISTPL_VERS_1.9f index dff92c9bba..11d68c2781 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_VERS_1.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_VERS_1.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_VERS_1 \- parse Level-1 Version/Product Information tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_VERS_1 \- parse Level-1 Version/Product Information tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_vers_1_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Level-1 Version/Product Information tuple, \fBCISTPL_VERS_1,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -61,8 +55,6 @@ This function parses the Level-1 Version/Product Information tuple, The \fBCISTPL_VERS_1\fR tuple is used to describe the card Level-1 version compliance and card manufacturer information. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_vers_1_t\fR are: .sp .in +2 @@ -77,7 +69,6 @@ char pi[CISTPL_VERS_1_MAX_PROD_STRINGS] .in -2 .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -132,12 +123,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Parse_CISTPL_VERS_2.9f b/usr/src/man/man9f/csx_Parse_CISTPL_VERS_2.9f index 98b76edc9c..787f13fce5 100644 --- a/usr/src/man/man9f/csx_Parse_CISTPL_VERS_2.9f +++ b/usr/src/man/man9f/csx_Parse_CISTPL_VERS_2.9f @@ -7,7 +7,6 @@ .SH NAME csx_Parse_CISTPL_VERS_2 \- parse Level-2 Version and Information tuple .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -18,11 +17,8 @@ csx_Parse_CISTPL_VERS_2 \- parse Level-2 Version and Information tuple .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBcistpl_vers_2_t\fR structure which contains the parsed .RE .SH DESCRIPTION -.sp -.LP This function parses the Level-2 Version and Information tuple, \fBCISTPL_VERS_2,\fR into a form usable by \fBPC \fRCard drivers. .sp @@ -61,8 +55,6 @@ This function parses the Level-2 Version and Information tuple, The \fBCISTPL_VERS_2\fR tuple is used to describe the card Level-2 information which has the logical organization of the card's data. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcistpl_vers_2_t\fR are: .sp .in +2 @@ -81,7 +73,6 @@ char info[CIS_MAX_TUPLE_DATA_LEN]; .in -2 .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -136,12 +127,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S) .sp diff --git a/usr/src/man/man9f/csx_Put8.9f b/usr/src/man/man9f/csx_Put8.9f index e9f8d3b3a4..949559e82b 100644 --- a/usr/src/man/man9f/csx_Put8.9f +++ b/usr/src/man/man9f/csx_Put8.9f @@ -7,7 +7,6 @@ .SH NAME csx_Put8, csx_Put16, csx_Put32, csx_Put64 \- write to device register .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -32,11 +31,8 @@ csx_Put8, csx_Put16, csx_Put32, csx_Put64 \- write to device register .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI\fR) +illumos \fBDDI \fRSpecific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -65,8 +61,6 @@ The data to be written to the device. .RE .SH DESCRIPTION -.sp -.LP These functions generate a write of various sizes to the mapped memory or device register. .sp @@ -82,12 +76,8 @@ maintain a consistent view between the host and the device based on the encoded information in the data access handle. The translation may involve byte swapping if the host and the device have incompatible endian characteristics. .SH CONTEXT -.sp -.LP These functions may be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBcsx_DupHandle\fR(9F), \fBcsx_Get8\fR(9F), \fBcsx_GetMappedAddr\fR(9F), \fBcsx_RepGet8\fR(9F), \fBcsx_RepPut8\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestWindow\fR(9F) diff --git a/usr/src/man/man9f/csx_RegisterClient.9f b/usr/src/man/man9f/csx_RegisterClient.9f index fe807b8a08..ec37c52292 100644 --- a/usr/src/man/man9f/csx_RegisterClient.9f +++ b/usr/src/man/man9f/csx_RegisterClient.9f @@ -7,7 +7,6 @@ .SH NAME csx_RegisterClient \- register a client .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,8 +16,7 @@ csx_RegisterClient \- register a client .fi .SH INTERFACE LEVEL -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS .ne 2 .na @@ -38,12 +36,10 @@ Pointer to a \fBclient_reg_t\fR structure. .RE .SH DESCRIPTION -.LP This function registers a client with Card Services and returns a unique client handle for the client. The client handle must be passed to \fBcsx_DeregisterClient\fR(9F) when the client terminates. .SH STRUCTURE MEMBERS -.LP The structure members of \fBclient_reg_t\fR are: .sp .in +2 @@ -305,10 +301,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.LP This function may be called from user or kernel context. .SH SEE ALSO -.LP \fBcsx_DeregisterClient\fR(9F), \fBcsx_RequestSocketMask\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_ReleaseConfiguration.9f b/usr/src/man/man9f/csx_ReleaseConfiguration.9f index c6b3b1800e..5b7057a71e 100644 --- a/usr/src/man/man9f/csx_ReleaseConfiguration.9f +++ b/usr/src/man/man9f/csx_ReleaseConfiguration.9f @@ -7,7 +7,6 @@ .SH NAME csx_ReleaseConfiguration \- release PC Card and socket configuration .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_ReleaseConfiguration \- release PC Card and socket configuration .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -40,8 +36,6 @@ Pointer to a \fBrelease_config_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function returns a \fBPC\fR Card and socket to a simple memory only interface and sets the card to configuration zero by writing a \fB0\fR to the \fBPC\fR card's \fBCOR\fR (Configuration Option Register). @@ -65,8 +59,6 @@ Card Services via the corresponding \fBcsx_ReleaseIO\fR(9F), socket configuration before releasing any resources requested by the driver via the request functions named above. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBrelease_config_t\fR are: .sp .in +2 @@ -77,10 +69,9 @@ uint32_t Socket; /* socket number */ .sp .LP -The \fBSocket\fR field is not used in Solaris, but for portability with other +The \fBSocket\fR field is not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -126,12 +117,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_RegisterClient\fR(9F), \fBcsx_RequestConfiguration\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestIRQ\fR(9F), \fBcsx_RequestWindow\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_RepGet8.9f b/usr/src/man/man9f/csx_RepGet8.9f index 710bf2c91b..22e68ddeb4 100644 --- a/usr/src/man/man9f/csx_RepGet8.9f +++ b/usr/src/man/man9f/csx_RepGet8.9f @@ -8,7 +8,6 @@ csx_RepGet8, csx_RepGet16, csx_RepGet32, csx_RepGet64 \- read repetitively from the device register .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -37,11 +36,8 @@ the device register .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -88,8 +84,6 @@ Device address flags. .RE .SH DESCRIPTION -.sp -.LP These functions generate multiple reads of various sizes from the mapped memory or device register. .sp @@ -114,12 +108,8 @@ However, when the \fIflags\fR argument is set to \fBCS_DEV_NO_AUTOINCR\fR, the same device offset will be used for every datum access. For example, this flag may be useful when reading from a data register. .SH CONTEXT -.sp -.LP These functions may be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBcsx_DupHandle\fR(9F), \fBcsx_Get8\fR(9F), \fBcsx_GetMappedAddr\fR(9F), \fBcsx_Put8\fR(9F), \fBcsx_RepPut8\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestWindow\fR(9F) diff --git a/usr/src/man/man9f/csx_RepPut8.9f b/usr/src/man/man9f/csx_RepPut8.9f index 5145006327..5ba097f510 100644 --- a/usr/src/man/man9f/csx_RepPut8.9f +++ b/usr/src/man/man9f/csx_RepPut8.9f @@ -8,7 +8,6 @@ csx_RepPut8, csx_RepPut16, csx_RepPut32, csx_RepPut64 \- write repetitively to the device register .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -37,11 +36,8 @@ the device register .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -88,8 +84,6 @@ Device address flags. .RE .SH DESCRIPTION -.sp -.LP These functions generate multiple writes of various sizes to the mapped memory or device register. .sp @@ -114,12 +108,8 @@ However, when the \fIflags\fR argument is set to \fBCS_DEV_NO_AUTOINCR\fR, the same device offset will be used for every datum access. For example, this flag may be useful when writing to a data register. .SH CONTEXT -.sp -.LP These functions may be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBcsx_DupHandle\fR(9F), \fBcsx_Get8\fR(9F), \fBcsx_GetMappedAddr\fR(9F), \fBcsx_Put8\fR(9F), \fBcsx_RepGet8\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestWindow\fR(9F) diff --git a/usr/src/man/man9f/csx_RequestConfiguration.9f b/usr/src/man/man9f/csx_RequestConfiguration.9f index c91f799f5f..8c70e154db 100644 --- a/usr/src/man/man9f/csx_RequestConfiguration.9f +++ b/usr/src/man/man9f/csx_RequestConfiguration.9f @@ -7,7 +7,6 @@ .SH NAME csx_RequestConfiguration \- configure the PC Card and socket .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_RequestConfiguration \- configure the PC Card and socket .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -40,8 +36,6 @@ Pointer to a \fBconfig_req_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function configures the \fBPC\fR Card and socket. It must be used by clients that require \fBI/O\fR or \fBIRQ\fR resources for their \fBPC\fR Card. .sp @@ -54,8 +48,6 @@ programs the Base and Limit registers of multi-function \fBPC\fR Cards if these registers exist. The values programmed into these registers depend on the \fBIO\fR requirements of this configuration. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBconfig_req_t\fR are: .sp .in +2 @@ -86,7 +78,7 @@ The fields are defined as follows: .ad .sp .6 .RS 4n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -354,7 +346,6 @@ set to \fIlevel\fR mode by Card Services. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -436,12 +427,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_AccessConfigurationRegister\fR(9F), \fBcsx_GetStatus\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_ReleaseConfiguration\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestIRQ\fR(9F) diff --git a/usr/src/man/man9f/csx_RequestIO.9f b/usr/src/man/man9f/csx_RequestIO.9f index 3201cf9c48..697c571673 100644 --- a/usr/src/man/man9f/csx_RequestIO.9f +++ b/usr/src/man/man9f/csx_RequestIO.9f @@ -7,7 +7,6 @@ .SH NAME csx_RequestIO, csx_ReleaseIO \- request or release I/O resources for the client .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -22,11 +21,8 @@ csx_RequestIO, csx_ReleaseIO \- request or release I/O resources for the client .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI\fR) +illumos \fBDDI \fRSpecific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -45,8 +41,6 @@ Pointer to an \fBio_req_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP The functions \fBcsx_RequestIO()\fR and \fBcsx_ReleaseIO()\fR request or release, respectively, \fBI/O\fR resources for the client. .sp @@ -67,8 +61,6 @@ corresponding \fBcsx_ReleaseIO()\fR. Card Services window resource list is adjusted by this function. Depending on the adapter hardware, the \fBI/O\fR window might also be disabled. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBio_req_t\fR are: .sp .in +2 @@ -101,7 +93,7 @@ The fields are defined as follows: \fB\fBSocket\fR\fR .ad .RS 20n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -361,7 +353,6 @@ On some systems, multiple calls to \fBcsx_RequestIO()\fR with different made to find an acceptable combination of parameters that can be used by Card Services to allocate \fBI/O\fR resources for the client. (See \fBNOTES\fR). .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -453,19 +444,13 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_RegisterClient\fR(9F), \fBcsx_RequestConfiguration\fR(9F) .sp .LP \fIPC Card 95 Standard\fR, PCMCIA/JEIDA .SH NOTES -.sp -.LP It is important for clients to try to use the minimum amount of \fBI/O\fR resources necessary. One way to do this is for the client to parse the \fBCIS\fR of the \fBPC\fR Card and call \fBcsx_RequestIO()\fR first with any diff --git a/usr/src/man/man9f/csx_RequestIRQ.9f b/usr/src/man/man9f/csx_RequestIRQ.9f index 6c5e33296d..75c9df1b5f 100644 --- a/usr/src/man/man9f/csx_RequestIRQ.9f +++ b/usr/src/man/man9f/csx_RequestIRQ.9f @@ -8,7 +8,6 @@ .SH NAME csx_RequestIRQ, csx_ReleaseIRQ \- request or release IRQ resource .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -23,11 +22,8 @@ csx_RequestIRQ, csx_ReleaseIRQ \- request or release IRQ resource .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -46,8 +42,6 @@ Pointer to an \fBirq_req_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP The function \fBcsx_RequestIRQ()\fR requests an \fBIRQ\fR resource and registers the client's \fBIRQ\fR handler with Card Services. .sp @@ -67,15 +61,13 @@ resource. The Card Services \fBIRQ\fR resource list is adjusted by \fBcsx_ReleaseIRQ()\fR. Depending on the adapter hardware, the host bus \fBIRQ\fR connection might also be disabled. Client \fBIRQ\fR handlers always -run above lock level and so should take care to perform only Solaris operations +run above lock level and so should take care to perform only illumos operations that are appropriate for an above-lock-level \fBIRQ\fR handler. .sp .LP \fBcsx_RequestIRQ()\fR fails if it has already been called without a corresponding \fBcsx_ReleaseIRQ()\fR. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBirq_req_t\fR are: .sp .in +2 @@ -100,7 +92,7 @@ The fields are defined as follows: \fB\fBSocket\fR \fR .ad .RS 20n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -165,7 +157,6 @@ structure must be the same as those returned from the previous \fBcsx_RequestIRQ()\fR call; otherwise, \fBCS_BAD_ARGS\fR is returned and no changes are made to Card Services resources or the socket and adapter hardware. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -249,12 +240,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_ReleaseConfiguration\fR(9F), \fBcsx_RequestConfiguration\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/csx_RequestSocketMask.9f b/usr/src/man/man9f/csx_RequestSocketMask.9f index a688ebd490..c8901cfd77 100644 --- a/usr/src/man/man9f/csx_RequestSocketMask.9f +++ b/usr/src/man/man9f/csx_RequestSocketMask.9f @@ -8,7 +8,6 @@ csx_RequestSocketMask, csx_ReleaseSocketMask \- set or clear the client's client event mask .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -25,11 +24,8 @@ client event mask .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -57,8 +53,6 @@ Pointer to a \fBrelease_socket_mask_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP The function \fBcsx_RequestSocketMask()\fR sets the client's client event mask and enables the client to start receiving events at its event callback handler. Once this function returns successfully, the client can start receiving events @@ -76,8 +70,6 @@ mask for this socket. The function \fBcsx_ReleaseSocketMask()\fR clears the client's client event mask. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBrequest_socket_mask_t\fR are: .sp .in +2 @@ -106,7 +98,7 @@ The fields are defined as follows: \fB\fBSocket\fR\fR .ad .RS 13n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -122,7 +114,6 @@ additional information about handling events. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -168,12 +159,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_event_handler\fR(9E), \fBcsx_GetEventMask\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_SetEventMask\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_RequestWindow.9f b/usr/src/man/man9f/csx_RequestWindow.9f index 318b4f6e0c..a9dacffb54 100644 --- a/usr/src/man/man9f/csx_RequestWindow.9f +++ b/usr/src/man/man9f/csx_RequestWindow.9f @@ -7,7 +7,6 @@ .SH NAME csx_RequestWindow, csx_ReleaseWindow \- request or release window resources .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -23,11 +22,8 @@ csx_RequestWindow, csx_ReleaseWindow \- request or release window resources .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -55,8 +51,6 @@ Pointer to a \fBwin_req_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP The function \fBcsx_RequestWindow()\fR requests a block of system address space be assigned to a \fBPC \fRCard in a socket. .sp @@ -75,8 +69,6 @@ window. The \fBPC\fR Card Attribute or Common Memory offset for this window is set by \fBcsx_MapMemPage\fR(9F). .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBwin_req_t\fR are: .sp .in +2 @@ -104,7 +96,7 @@ The fields are defined as follows: \fB\fBSocket\fR\fR .ad .RS 26n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -368,12 +360,11 @@ specified socket. Access to the \fBI/O \fRwindow is not enabled until \fB\fBReqOffset\fR\fR .ad .RS 26n -This field is a Solaris-specific extension that can be used by clients to +This field is an illumos-specific extension that can be used by clients to generate optimum window offsets passed to \fBcsx_MapMemPage\fR(9F). .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -446,12 +437,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_ConvertSpeed\fR(9F), \fBcsx_MapMemPage\fR(9F), \fBcsx_ModifyWindow\fR(9F), \fBcsx_RegisterClient\fR(9F), \fBcsx_RequestConfiguration\fR(9F) diff --git a/usr/src/man/man9f/csx_ResetFunction.9f b/usr/src/man/man9f/csx_ResetFunction.9f index 00baf5a416..33aebf329b 100644 --- a/usr/src/man/man9f/csx_ResetFunction.9f +++ b/usr/src/man/man9f/csx_ResetFunction.9f @@ -7,7 +7,6 @@ .SH NAME csx_ResetFunction \- reset a function on a PC card .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_ResetFunction \- reset a function on a PC card .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -40,13 +36,9 @@ Pointer to a \fBreset_function_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fBcsx_ResetFunction()\fR requests that the specified function on the \fBPC\fR card initiate a reset operation. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBreset_function_t\fR are: .sp .in +2 @@ -65,7 +57,7 @@ The fields are defined as follows: \fB\fBSocket\fR\fR .ad .RS 14n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -79,7 +71,6 @@ Must be \fB0\fR. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -134,18 +125,12 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_event_handler\fR(9E), \fBcsx_RegisterClient\fR(9F) .sp .LP \fIPC Card 95 Standard\fR, PCMCIA/JEIDA .SH NOTES -.sp -.LP \fBcsx_ResetFunction()\fR has not been implemented in this release and always returns \fBCS_IN_USE\fR. diff --git a/usr/src/man/man9f/csx_SetEventMask.9f b/usr/src/man/man9f/csx_SetEventMask.9f index ae9e4264d6..8764765140 100644 --- a/usr/src/man/man9f/csx_SetEventMask.9f +++ b/usr/src/man/man9f/csx_SetEventMask.9f @@ -8,7 +8,6 @@ csx_SetEventMask, csx_GetEventMask \- set or return the client event mask for the client .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -23,11 +22,8 @@ the client .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR +illumos \fBDDI \fRSpecific (illumos \fBDDI) \fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR \fR @@ -46,8 +42,6 @@ Pointer to a \fBsockevent_t\fR structure .RE .SH DESCRIPTION -.sp -.LP The function \fBcsx_SetEventMask()\fR sets the client or global event mask for the client. .sp @@ -59,8 +53,6 @@ for the client. \fBcsx_RequestSocketMask\fR(9F) must be called before calling \fBcsx_SetEventMask()\fR for the client event mask for this socket. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBsockevent_t\fR are: .sp .in +2 @@ -119,12 +111,11 @@ additional information about handling events. \fB\fBSocket\fR \fR .ad .RS 14n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -161,12 +152,8 @@ No \fBPCMCIA \fRhardware installed. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_event_handler\fR(9E), \fBcsx_RegisterClient\fR(9F), \fBcsx_ReleaseSocketMask\fR(9F), \fBcsx_RequestSocketMask\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_SetHandleOffset.9f b/usr/src/man/man9f/csx_SetHandleOffset.9f index 7e1427d69c..8b000da33e 100644 --- a/usr/src/man/man9f/csx_SetHandleOffset.9f +++ b/usr/src/man/man9f/csx_SetHandleOffset.9f @@ -7,7 +7,6 @@ .SH NAME csx_SetHandleOffset \- set current access handle offset .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_SetHandleOffset \- set current access handle offset .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -40,12 +36,9 @@ New access handle offset. .RE .SH DESCRIPTION -.sp -.LP This function sets the current offset for the access handle, \fIhandle\fR, to \fIoffset\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR \fR @@ -55,12 +48,8 @@ Successful operation. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetHandleOffset\fR(9F), \fBcsx_RequestIO\fR(9F), \fBcsx_RequestIRQ\fR(9F) .sp diff --git a/usr/src/man/man9f/csx_ValidateCIS.9f b/usr/src/man/man9f/csx_ValidateCIS.9f index dc64445b06..b1b8495f15 100644 --- a/usr/src/man/man9f/csx_ValidateCIS.9f +++ b/usr/src/man/man9f/csx_ValidateCIS.9f @@ -7,7 +7,6 @@ .SH NAME csx_ValidateCIS \- validate the Card Information Structure (CIS) .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> @@ -17,11 +16,8 @@ csx_ValidateCIS \- validate the Card Information Structure (CIS) .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR) +illumos \fBDDI\fR Specific (illumos \fBDDI\fR) .SH PARAMETERS -.sp .ne 2 .na \fB\fIch\fR\fR @@ -40,13 +36,9 @@ Pointer to a \fBcisinfo_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP This function validates the Card Information Structure (CIS) on the \fBPC\fR Card in the specified socket. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBcisinfo_t\fR are: .sp .in +2 @@ -66,7 +58,7 @@ The fields are defined as follows: \fB\fBSocket\fR\fR .ad .RS 10n -Not used in Solaris, but for portability with other Card Services +Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number. .RE @@ -86,12 +78,11 @@ If \fB0\fR is returned, the \fBCIS\fR is not valid. \fB\fBTuples\fR\fR .ad .RS 10n -This field is a Solaris-specific extension and it returns the total number of +This field is an illumos-specific extension and it returns the total number of tuples on all the chains in the \fBPC\fR Card's \fBCIS\fR. .RE .SH RETURN VALUES -.sp .ne 2 .na \fB\fBCS_SUCCESS\fR\fR @@ -128,12 +119,8 @@ No \fBPCMCIA\fR hardware installed. .RE .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_ParseTuple\fR(9F), \fBcsx_RegisterClient\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_add_event_handler.9f b/usr/src/man/man9f/ddi_add_event_handler.9f index 1e0cc57267..1bf322d413 100644 --- a/usr/src/man/man9f/ddi_add_event_handler.9f +++ b/usr/src/man/man9f/ddi_add_event_handler.9f @@ -7,7 +7,6 @@ .SH NAME ddi_add_event_handler \- add an NDI event service callback handler .SH SYNOPSIS -.LP .nf #include <sys/dditypes.h> #include <sys/sunddi.h> @@ -18,8 +17,7 @@ ddi_add_event_handler \- add an NDI event service callback handler .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -75,7 +73,6 @@ Registration ID must be saved and used when calling .RE .SH DESCRIPTION -.LP The \fBddi_add_event_handler()\fR function adds a callback handler to be invoked in the face of the event specified by \fIcookie\fR. The process of adding a callback handler is also known as subscribing to an event. Upon @@ -147,11 +144,9 @@ or a bad cookie. .RE .SH CONTEXT -.LP The \fBddi_add_event_handler()\fR and \fBhandler()\fR function can be called from user and kernel contexts only. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -166,13 +161,11 @@ Stability Level Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBddi_get_eventcookie\fR(9F), \fBddi_remove_event_handler\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.LP Drivers must remove all registered callback handlers for a device instance by calling \fBddi_remove_event_handler\fR(9F) before detach completes. diff --git a/usr/src/man/man9f/ddi_add_intr.9f b/usr/src/man/man9f/ddi_add_intr.9f index e8c445a525..1a68b1bb04 100644 --- a/usr/src/man/man9f/ddi_add_intr.9f +++ b/usr/src/man/man9f/ddi_add_intr.9f @@ -8,7 +8,6 @@ ddi_add_intr, ddi_get_iblock_cookie, ddi_remove_intr \- hardware interrupt handling routines .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -37,14 +36,10 @@ handling routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). These interfaces are obsolete. Use the new +illumos DDI specific (illumos DDI). These interfaces are obsolete. Use the new interrupt interfaces referenced in \fBIntro\fR(9F). Refer to \fIWriting Device Drivers\fR for more information. .SH PARAMETERS -.sp -.LP For \fBddi_get_iblock_cookie()\fR: .sp .ne 2 @@ -164,8 +159,6 @@ Block cookie which identifies the interrupt handler to be removed. .SH DESCRIPTION .SS "ddi_get_iblock_cookie(\|)" -.sp -.LP \fBddi_get_iblock_cookie()\fR retrieves the interrupt block cookie associated with a particular interrupt specification. This routine should be called before \fBddi_add_intr()\fR to retrieve the interrupt block cookie needed to @@ -189,8 +182,6 @@ locks. This may happen when an interrupt for a different device occurs on the same interrupt level. If the interrupt routine acquires the lock before the lock has been initialized, undefined behavior may result. .SS "ddi_add_intr(\|)" -.sp -.LP \fBddi_add_intr()\fR adds an interrupt handler to the system. The interrupt number \fIinumber\fR determines which interrupt the handler will be associated with. (Refer to \fBddi_get_iblock_cookie()\fR above.) @@ -224,8 +215,6 @@ information cannot be found on the sun4u architecture, either sun4m architectures, if the interrupt information cannot be found, \fBDDI_INTR_NOTFOUND\fR is returned. .SS "ddi_remove_intr(\|)" -.sp -.LP \fBddi_remove_intr()\fR removes an interrupt handler from the system. Unloadable drivers should call this routine during their \fBdetach\fR(9E) routine to remove their interrupt handler from the system. @@ -237,14 +226,10 @@ for the device interrupt routine to complete before returning. Therefore, locks acquired by the interrupt handler should not be held across the call to \fBddi_remove_intr()\fR or deadlock may result. .SS "For All Three Functions:" -.sp -.LP For certain bus types, you can call these \fBDDI\fR functions from a high-interrupt context. These types include \fBISA\fR and SBus buses. See \fBsysbus\fR(4), \fBisa\fR(4), and \fBsbus\fR(4) for details. .SH RETURN VALUES -.sp -.LP \fBddi_add_intr()\fR and \fBddi_get_iblock_cookie()\fR return: .sp .ne 2 @@ -275,13 +260,9 @@ On failure. \fBDDI_FAILURE\fR can also be returned on failure to find interrupt .RE .SH CONTEXT -.sp -.LP \fBddi_add_intr()\fR, \fBddi_remove_intr()\fR, and \fBddi_get_iblock_cookie()\fR can be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -296,8 +277,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBdriver.conf\fR(4), \fBisa\fR(4), \fBsbus\fR(4), \fBsysbus\fR(4), \fBattach\fR(9E), \fBdetach\fR(9E), \fBddi_intr_hilevel\fR(9F), \fBIntro\fR(9F), \fBmutex\fR(9F), \fBmutex_init\fR(9F), \fBrw_init\fR(9F), @@ -306,8 +285,6 @@ Interface Stability Obsolete .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP \fBddi_get_iblock_cookie()\fR must not be called \fBafter\fR the driver adds an interrupt handler for the interrupt specification corresponding to \fIinumber\fR. @@ -317,8 +294,6 @@ All consumers of these interfaces, checking return codes, should verify \fBreturn_code != DDI_SUCCESS\fR. Checking for specific failure codes can result in inconsistent behaviors among platforms. .SH BUGS -.sp -.LP The \fIidevice_cookiep\fR should really point to a data structure that is specific to the bus architecture that the device operates on. Currently the SBus and PCI buses are supported and a single data structure is used to diff --git a/usr/src/man/man9f/ddi_add_softintr.9f b/usr/src/man/man9f/ddi_add_softintr.9f index 3b150df889..725b7ea8d2 100644 --- a/usr/src/man/man9f/ddi_add_softintr.9f +++ b/usr/src/man/man9f/ddi_add_softintr.9f @@ -8,7 +8,6 @@ ddi_add_softintr, ddi_get_soft_iblock_cookie, ddi_remove_softintr, ddi_trigger_softintr \- software interrupt handling routines .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -41,14 +40,10 @@ ddi_trigger_softintr \- software interrupt handling routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). These interfaces are obsolete. Use the new +illumos DDI specific (illumos DDI). These interfaces are obsolete. Use the new interrupt interfaces referenced in \fBIntro\fR(9F). Refer to \fIWriting Device Drivers\fR for more information. .SH PARAMETERS -.sp -.LP \fBddi_get_soft_iblock_cookie()\fR .sp .ne 2 @@ -172,8 +167,6 @@ interrupt handler will be called. .RE .SH DESCRIPTION -.sp -.LP For \fBddi_get_soft_iblock_cookie()\fR: .sp .LP @@ -294,8 +287,6 @@ identifier \fIid\fR is used to determine which soft interrupt to trigger. This function is used by device drivers when they wish to trigger a soft interrupt which has been set up using \fBddi_add_softintr()\fR. .SH RETURN VALUES -.sp -.LP \fBddi_add_softintr()\fR and \fBddi_get_soft_iblock_cookie()\fR return: .sp .ne 2 @@ -316,13 +307,10 @@ on failure .RE .SH CONTEXT -.sp -.LP These functions can be called from user or kernel context. \fBddi_trigger_softintr()\fR may be called from high-level interrupt context as well. .SH EXAMPLES -.LP \fBExample 1 \fRdevice using high-level interrupts .sp .LP @@ -508,8 +496,6 @@ xxsoftintr(caddr_t arg) .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -524,16 +510,12 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBddi_add_intr\fR(9F), \fBddi_in_panic\fR(9F), \fBddi_intr_hilevel\fR(9F), \fBddi_remove_intr\fR(9F), \fBIntro\fR(9F), \fBmutex_init\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP \fBddi_add_softintr()\fR may not be used to add the same software interrupt handler more than once. This is true even if a different value is used for \fIint_handler_arg\fR in each of the calls to \fBddi_add_softintr()\fR. diff --git a/usr/src/man/man9f/ddi_binding_name.9f b/usr/src/man/man9f/ddi_binding_name.9f index a51fa2b003..858d9e28e2 100644 --- a/usr/src/man/man9f/ddi_binding_name.9f +++ b/usr/src/man/man9f/ddi_binding_name.9f @@ -7,7 +7,6 @@ .SH NAME ddi_binding_name, ddi_get_name \- return driver binding name .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -23,11 +22,8 @@ ddi_binding_name, ddi_get_name \- return driver binding name .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR \fR @@ -37,32 +33,22 @@ A pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fBddi_binding_name()\fR and \fBddi_get_name()\fR return the driver binding name. This is the name used to select a driver for the device. This name is typically derived from the device \fBname\fR property or the device \fBcompatible\fR property. The name returned may be a driver alias or the driver name. .SH RETURN VALUES -.sp -.LP \fBddi_binding_name()\fR and \fBddi_get_name()\fR return the name used to bind a driver to a device. .SH CONTEXT -.sp -.LP \fBddi_binding_name()\fR and \fBddi_get_name()\fR can be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_node_name\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP The name returned by \fBddi_binding_name()\fR and \fBddi_get_name()\fR is read-only. diff --git a/usr/src/man/man9f/ddi_btop.9f b/usr/src/man/man9f/ddi_btop.9f index 072f261cc6..79af087a99 100644 --- a/usr/src/man/man9f/ddi_btop.9f +++ b/usr/src/man/man9f/ddi_btop.9f @@ -7,7 +7,6 @@ .SH NAME ddi_btop, ddi_btopr, ddi_ptob \- page size conversions .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -28,12 +27,8 @@ ddi_btop, ddi_btopr, ddi_ptob \- page size conversions .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP This set of routines use the parent nexus driver to perform conversions in page size units. .sp @@ -57,17 +52,12 @@ facilities, these routines should be used in preference to the corresponding DDI/DKI routines \fBbtop\fR(9F), \fBbtopr\fR(9F), and \fBptob\fR(9F), which only deal in terms of the pagesize of the main system MMU. .SH RETURN VALUES -.sp -.LP The \fBddi_btop()\fR and \fBddi_btopr()\fR functions return the number of corresponding pages. \fBddi_ptob()\fR returns the corresponding number of bytes. There are no error return values. .SH CONTEXT -.sp -.LP This function can be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRFind the size (in bytes) of one page .sp .in +2 @@ -77,8 +67,6 @@ pagesize = ddi_ptob(dip, 1L); .in -2 .SH SEE ALSO -.sp -.LP \fBbtop\fR(9F), \fBbtopr\fR(9F), \fBptob\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_can_receive_sig.9f b/usr/src/man/man9f/ddi_can_receive_sig.9f index f04801b4c4..333e2ad97b 100644 --- a/usr/src/man/man9f/ddi_can_receive_sig.9f +++ b/usr/src/man/man9f/ddi_can_receive_sig.9f @@ -7,7 +7,6 @@ .SH NAME ddi_can_receive_sig \- Test for ability to receive signals .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,16 +17,10 @@ ddi_can_receive_sig \- Test for ability to receive signals .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP None. .SH DESCRIPTION -.sp -.LP The \fBddi_can_receive_sig()\fR function returns a boolean value indicating whether the current thread can receive signals sent by \fBkill\fR(2). If the return value is \fBB_FALSE\fR, then the calling thread @@ -38,7 +31,6 @@ Drivers that can block indefinitely awaiting an event should use this function to determine if additional means (such as \fBtimeout\fR(9F)) may be necessary to avoid creating unkillable threads. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBB_FALSE\fR \fR @@ -61,11 +53,7 @@ are blocked (see \fBsigprocmask\fR(2)). .RE .SH CONTEXT -.sp -.LP The \fBddi_can_receive_sig()\fR function may be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBclose\fR(9E), \fBcv_wait\fR(9F), \fBqwait\fR(9F) diff --git a/usr/src/man/man9f/ddi_cb_register.9f b/usr/src/man/man9f/ddi_cb_register.9f index da3ee4cb54..d7f6323560 100644 --- a/usr/src/man/man9f/ddi_cb_register.9f +++ b/usr/src/man/man9f/ddi_cb_register.9f @@ -8,7 +8,6 @@ ddi_cb_register, ddi_cb_unregister \- register and unregister a device driver callback handler .SH SYNOPSIS -.LP .nf #include <sys/sunddi.h> @@ -23,10 +22,8 @@ callback handler .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.LP \fBddi_cb_register()\fR .sp .ne 2 @@ -95,7 +92,6 @@ Handle to the registered callback handler that is to be unregistered. .RE .SH DESCRIPTION -.LP The \fBddi_cb_register()\fR function installs a callback handler which processes various actions that require the driver's attention while it is attached. The driver specifies which callback actions it can handle through the @@ -192,7 +188,6 @@ functions to respond accordingly. A driver is not required to allocate all interrupts that are available to it, but it is required to manage its allocations so that it never uses more interrupts than are currently available. .SH RETURN VALUES -.LP The \fBddi_cb_register()\fR and \fBddi_cb_unregister()\fR functions return: .sp .ne 2 @@ -254,10 +249,8 @@ Implementation specific failure .RE .SH CONTEXT -.LP These functions can be called from kernel, non-interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRddi_cb_register .sp .in +2 @@ -505,7 +498,6 @@ These functions can be called from kernel, non-interrupt context. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -522,11 +514,9 @@ MT-Level Unsafe .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBddi_intr_alloc\fR(9F), \fBddi_intr_free\fR(9F), \fBddi_intr_set_nreq\fR(9F) .SH NOTES -.LP Users of these interfaces that register for \fBDDI_CB_FLAG_INTR\fR become participants in interrupt resource management. With that participation comes a responsibility to properly adjust interrupt usage. In the case of a diff --git a/usr/src/man/man9f/ddi_check_acc_handle.9f b/usr/src/man/man9f/ddi_check_acc_handle.9f index 4c049c32ea..05424bd313 100644 --- a/usr/src/man/man9f/ddi_check_acc_handle.9f +++ b/usr/src/man/man9f/ddi_check_acc_handle.9f @@ -8,7 +8,6 @@ .SH NAME ddi_check_acc_handle, ddi_check_dma_handle \- Check data access and DMA handles .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -24,11 +23,8 @@ ddi_check_acc_handle, ddi_check_dma_handle \- Check data access and DMA handles .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIacc_handle\fR \fR @@ -48,8 +44,6 @@ DMA handle obtained from \fBddi_dma_alloc_handle\fP(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBddi_check_acc_handle()\fR\fB and ddi_check_dma_handle()\fR functions check for faults that can interfere with communication between a driver and the device it controls. Each function checks a single handle of a specific type and @@ -88,14 +82,11 @@ is not indicated, this does not constitute a guarantee that communication is possible. However, if a check fails, this is a positive indication that a problem \fBdoes\fR exist with respect to communication using that handle. .SH RETURN VALUES -.sp -.LP The \fBddi_check_acc_handle()\fR and \fBddi_check_dma_handle()\fR functions return \fBDDI_SUCCESS\fR if no faults affecting the supplied handle are detected and \fBDDI_FAILURE\fR if any fault affecting the supplied handle is detected. .SH EXAMPLES -.sp .in +2 .nf static int @@ -124,12 +115,8 @@ xxread(dev_t dev, struct uio *uio_p, cred_t *cred_p) .in -2 .SH CONTEXT -.sp -.LP The \fBddi_check_acc_handle()\fR and \fBddi_check_dma_handle()\fR functions may be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_regs_map_setup\fR(9F), \fBddi_dma_alloc_handle\fR(9F), \fBddi_dev_report_fault\fR(9F), \fBddi_get8\fR(9F), \fBddi_put8\fR(9F) diff --git a/usr/src/man/man9f/ddi_copyin.9f b/usr/src/man/man9f/ddi_copyin.9f index a8c5cf3d98..1b78110f44 100644 --- a/usr/src/man/man9f/ddi_copyin.9f +++ b/usr/src/man/man9f/ddi_copyin.9f @@ -7,7 +7,6 @@ .SH NAME ddi_copyin \- copy data to a driver buffer .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ ddi_copyin \- copy data to a driver buffer .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIbuf\fR\fR @@ -60,8 +56,6 @@ Set of flag bits that provide address space information about \fIbuf\fR. .RE .SH DESCRIPTION -.sp -.LP This routine is designed for use in driver \fBioctl\fR(9E) routines for drivers that support layered ioctls. \fBddi_copyin()\fR copies data from a source address to a driver buffer. The driver developer must ensure that adequate @@ -79,8 +73,6 @@ Addresses that are word-aligned are moved most efficiently. However, the driver developer is not obliged to ensure alignment. This function automatically finds the most efficient move according to address alignment. .SH RETURN VALUES -.sp -.LP \fBddi_copyin()\fR returns \fB0\fR, indicating a successful copy. It returns \(mi\fB1\fR if one of the following occurs: .RS +4 @@ -115,11 +107,8 @@ For example, an uncorrectable parity or \fBECC\fR error occurred. If \(mi\fB1\fR is returned to the caller, driver entry point routines should return \fBEFAULT\fR. .SH CONTEXT -.sp -.LP \fBddi_copyin()\fR can be called from user or kernel context only. .SH EXAMPLES -.LP \fBExample 1 \fR\fBddi_copyin()\fR example .sp .LP @@ -182,16 +171,12 @@ specified argument contains an invalid address, an error code is returned. .in -2 .SH SEE ALSO -.sp -.LP \fBioctl\fR(9E), \fBbcopy\fR(9F), \fBcopyin\fR(9F), \fBcopyout\fR(9F), \fBddi_copyout\fR(9F), \fBuiomove\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The value of the \fIflags\fR argument to \fBddi_copyin()\fR should be passed through directly from the \fImode\fR argument of \fBioctl()\fR untranslated. .sp diff --git a/usr/src/man/man9f/ddi_copyout.9f b/usr/src/man/man9f/ddi_copyout.9f index 0a199e7bbf..4f5bcc98ea 100644 --- a/usr/src/man/man9f/ddi_copyout.9f +++ b/usr/src/man/man9f/ddi_copyout.9f @@ -7,7 +7,6 @@ .SH NAME ddi_copyout \- copy data from a driver .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ ddi_copyout \- copy data from a driver .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdriverbuf\fR\fR @@ -60,8 +56,6 @@ Set of flag bits that provide address space information about \fIbuf\fR. .RE .SH DESCRIPTION -.sp -.LP This routine is designed for use in driver \fBioctl\fR(9E) routines for drivers that support layered ioctls. \fBddi_copyout()\fR copies data from a driver buffer to a destination address, \fIbuf\fR. @@ -79,8 +73,6 @@ driver developer is not obliged to ensure alignment. This function automatically finds the most efficient move algorithm according to address alignment. .SH RETURN VALUES -.sp -.LP Under normal conditions, \fB0\fR is returned to indicate a successful copy. Otherwise, \(mi\fB1\fR is returned if one of the following occurs: .RS +4 @@ -115,11 +107,8 @@ For example, an uncorrectable parity or \fBECC\fR error occurred. If \(mi\fB1\fR is returned to the caller, driver entry point routines should return \fBEFAULT\fR. .SH CONTEXT -.sp -.LP \fBddi_copyout()\fR can be called from user or kernel context only. .SH EXAMPLES -.LP \fBExample 1 \fR\fBddi_copyout()\fR example .sp .LP @@ -182,16 +171,12 @@ specified argument contains an invalid address, an error code is returned. .in -2 .SH SEE ALSO -.sp -.LP \fBioctl\fR(9E), \fBbcopy\fR(9F), \fBcopyin\fR(9F), \fBcopyout\fR(9F), \fBddi_copyin\fR(9F), \fBuiomove\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The value of the \fIflags\fR argument to \fBddi_copyout()\fR should be passed through directly from the \fImode\fR argument of \fBioctl()\fR untranslated. .sp diff --git a/usr/src/man/man9f/ddi_create_minor_node.9f b/usr/src/man/man9f/ddi_create_minor_node.9f index b33ba2704b..8683fda0ef 100644 --- a/usr/src/man/man9f/ddi_create_minor_node.9f +++ b/usr/src/man/man9f/ddi_create_minor_node.9f @@ -19,7 +19,7 @@ ddi_create_minor_node \- Create a minor node for this device .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -275,4 +275,4 @@ the results of a \fBmodunload\fR(1M) of the driver or a \fBcfgadm\fR(1M) remove of hardware controlled by the driver are undefined. .SH WARNING Drivers must remove references to GLOBAL_DEV, NODEBOUND_DEV, NODESPECIFIC_DEV, -and ENUMERATED_DEV to compile under Solaris 10 and later versions. +and ENUMERATED_DEV to compile. diff --git a/usr/src/man/man9f/ddi_cred.9f b/usr/src/man/man9f/ddi_cred.9f index a8aa7bcd19..83bc480c64 100644 --- a/usr/src/man/man9f/ddi_cred.9f +++ b/usr/src/man/man9f/ddi_cred.9f @@ -9,7 +9,6 @@ ddi_cred, crgetuid, crgetruid, crgetsuid, crgetgid, crgetrgid, crgetsgid, crgetzoneid, crgetgroups, crgetngroups \- access and change parts of the cred_t structure .SH SYNOPSIS -.LP .nf #include <sys/cred.h> @@ -79,11 +78,8 @@ structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIcr\fR\fR @@ -129,8 +125,6 @@ pointer to array of new groups .RE .SH DESCRIPTION -.sp -.LP The user credential is a shared, read-only, ref-counted data structure. Its actual size and layout are subject to change. The functions described in this page allow the programmer to retrieve fields from the structure and to @@ -180,8 +174,6 @@ to \fIgid\fR. It is an error to call this any of the \fBcrset*()\fR functions on a user credential structure that was newly allocated. .SH RETURN VALUES -.sp -.LP The \fBcrget*()\fR functions return the requested information. .sp .LP @@ -189,12 +181,8 @@ The \fBcrset*id()\fR functions return 0 on success and -1 if any of the specified ids are invalid. The functions might cause a system panic if called on a user credential structure that is referenced by other parts of the system. .SH CONTEXT -.sp -.LP These functions can be called from user and kernel contexts. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -211,8 +199,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBprivileges\fR(5), \fBdrv_priv\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_dev_is_needed.9f b/usr/src/man/man9f/ddi_dev_is_needed.9f index 00c7f84475..293e2509ee 100644 --- a/usr/src/man/man9f/ddi_dev_is_needed.9f +++ b/usr/src/man/man9f/ddi_dev_is_needed.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dev_is_needed \- inform the system that a device's component is required .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ ddi_dev_is_needed \- inform the system that a device's component is required .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -50,8 +46,6 @@ Power level at which the component is needed. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_dev_is_needed()\fR function is obsolete and will be removed in a future release. It is recommended that device drivers use \fBpm_raise_power\fR(9F) and \fBpm_lower_power\fR(9F). @@ -76,8 +70,6 @@ The \fBddi_dev_is_needed()\fR function might cause re-entry of the driver. Deadlock may result if driver locks are held across the call to \fBddi_dev_is_needed()\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_dev_is_needed()\fR function returns: .sp .ne 2 @@ -98,7 +90,6 @@ An error occurred. .RE .SH EXAMPLES -.LP \fBExample 1 \fRdisk driver code .sp .LP @@ -144,12 +135,8 @@ xxdisk_strategy(struct buf *bp) .in -2 .SH CONTEXT -.sp -.LP This function can be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -164,8 +151,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBpm\fR(7D), \fBpm-components\fR(9P), \fBattach\fR(9E), \fBdetach\fR(9E), \fBpower\fR(9E), \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_dev_is_sid.9f b/usr/src/man/man9f/ddi_dev_is_sid.9f index 4f9ab92513..c8ab5e9308 100644 --- a/usr/src/man/man9f/ddi_dev_is_sid.9f +++ b/usr/src/man/man9f/ddi_dev_is_sid.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dev_is_sid \- tell whether a device is self-identifying .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ ddi_dev_is_sid \- tell whether a device is self-identifying .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -33,15 +29,12 @@ A pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_dev_is_sid()\fR function tells the caller whether the device described by \fIdip\fR is self-identifying, that is, a device that can unequivocally tell the system that it exists. This is useful for drivers that support both a self-identifying as well as a non-self-identifying variants of a device (and therefore must be probed). .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_SUCCESS\fR\fR @@ -60,37 +53,32 @@ Device is not self-identifying. .RE .SH CONTEXT -.sp -.LP The \fBddi_dev_is_sid()\fR function can be called from user, interrupt, or kernel context. .SH EXAMPLES -.sp .in +2 .nf 1 ... 2 int 3 bz_probe(dev_info_t *dip) 4 { -5 ... -6 if (ddi_dev_is_sid(dip) == DDI_SUCCESS) { -7 /* -8 * This is the self-identifying version (OpenBoot). -9 * No need to probe for it because we know it is there. -10 * The existence of dip && ddi_dev_is_sid() proves this. -11 */ -12 return (DDI_PROBE_DONTCARE); -13 } -14 /* -15 * Not a self-identifying variant of the device. Now we have to -16 * do some work to see whether it is really attached to the -17 * system. -18 */ +5 ... +6 if (ddi_dev_is_sid(dip) == DDI_SUCCESS) { +7 /* +8 * This is the self-identifying version (OpenBoot). +9 * No need to probe for it because we know it is there. +10 * The existence of dip && ddi_dev_is_sid() proves this. +11 */ +12 return (DDI_PROBE_DONTCARE); +13 } +14 /* +15 * Not a self-identifying variant of the device. Now we have to +16 * do some work to see whether it is really attached to the +17 * system. +18 */ 19 ... .fi .in -2 .SH SEE ALSO -.sp -.LP \fBprobe\fR(9E) \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_dev_nintrs.9f b/usr/src/man/man9f/ddi_dev_nintrs.9f index bfa783a4ea..06d70a41db 100644 --- a/usr/src/man/man9f/ddi_dev_nintrs.9f +++ b/usr/src/man/man9f/ddi_dev_nintrs.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dev_nintrs \- return the number of interrupt specifications a device has .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -19,19 +18,13 @@ ddi_dev_nintrs \- return the number of interrupt specifications a device has .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). This interface is obsolete. Use the new +illumos DDI specific (illumos DDI). This interface is obsolete. Use the new interrupt interfaces referenced in \fBIntro\fR(9F). Refer to \fIWriting Device Drivers\fR for more information. .SH DESCRIPTION -.sp -.LP The \fBddi_dev_nintrs()\fR function returns the number of interrupt specifications a device has in \fB*\fR\fIresultp\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_dev_nintrs()\fR function returns: .sp .ne 2 @@ -53,13 +46,9 @@ The device has no interrupt specifications. .RE .SH CONTEXT -.sp -.LP The \fBddi_dev_nintrs()\fR function can be called from user, interrupt, or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -74,8 +63,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBisa\fR(4), \fBsbus\fR(4), \fBddi_add_intr\fR(9F), \fBddi_dev_nregs\fR(9F), \fBddi_dev_regsize\fR(9F), \fBIntro\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_dev_nregs.9f b/usr/src/man/man9f/ddi_dev_nregs.9f index 1c9ee779df..f538e44931 100644 --- a/usr/src/man/man9f/ddi_dev_nregs.9f +++ b/usr/src/man/man9f/ddi_dev_nregs.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dev_nregs \- return the number of register sets a device has .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ ddi_dev_nregs \- return the number of register sets a device has .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -42,13 +38,9 @@ Pointer to an integer that holds the number of register sets on return. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_dev_nregs()\fR function returns the number of sets of registers the device has. .SH RETURN VALUES -.sp -.LP The \fBddi_dev_nregs()\fR function returns: .sp .ne 2 @@ -69,13 +61,9 @@ The device has no registers. .RE .SH CONTEXT -.sp -.LP The \fBddi_dev_nregs()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBddi_dev_nintrs\fR(9F), \fBddi_dev_regsize\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_dev_regsize.9f b/usr/src/man/man9f/ddi_dev_regsize.9f index 43fe73396b..7a6208a778 100644 --- a/usr/src/man/man9f/ddi_dev_regsize.9f +++ b/usr/src/man/man9f/ddi_dev_regsize.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dev_regsize \- return the size of a device's register .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ ddi_dev_regsize \- return the size of a device's register .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -55,15 +51,11 @@ Pointer to an integer that holds the size, in bytes, of the described register .RE .SH DESCRIPTION -.sp -.LP The \fBddi_dev_regsize()\fR function returns the size, in bytes, of the device register specified by \fIdip\fR and \fIrnumber\fR. This is useful when, for example, one of the registers is a frame buffer with a varying size known only to its proms. .SH RETURN VALUES -.sp -.LP The \fBddi_dev_regsize()\fR function returns: .sp .ne 2 @@ -85,13 +77,9 @@ An invalid (nonexistent) register number was specified. .RE .SH CONTEXT -.sp -.LP The \fBddi_dev_regsize()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBddi_dev_nintrs\fR(9F), \fBddi_dev_nregs\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_dev_report_fault.9f b/usr/src/man/man9f/ddi_dev_report_fault.9f index a8e167c1ac..1b854204cc 100644 --- a/usr/src/man/man9f/ddi_dev_report_fault.9f +++ b/usr/src/man/man9f/ddi_dev_report_fault.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dev_report_fault \- Report a hardware failure .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -20,11 +19,8 @@ ddi_dev_report_fault \- Report a hardware failure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR \fR @@ -64,8 +60,6 @@ Text of the message describing the fault being reported. .RE .SH DESCRIPTION -.sp -.LP This function provides a standardized mechanism through which device drivers can report hardware faults. Use of this reporting mechanism enables systems equipped with a fault management system to respond to faults discovered by a @@ -178,8 +172,6 @@ software problems such as memory (or other resource) exhaustion. .RE .SH EXAMPLES -.sp -.LP An Ethernet driver receives an error interrupt from its device if various fault conditions occur. The driver must read an error status register to determine the nature of the fault, and report it appropriately: @@ -212,12 +204,8 @@ xx_error_intr(xx_soft_state *ssp) .in -2 .SH CONTEXT -.sp -.LP The \fBddi_dev_report_fault()\fR function may be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_check_acc_handle\fR(9F), \fBddi_check_dma_handle\fR(9F), \fBddi_get_devstate\fR(9F) diff --git a/usr/src/man/man9f/ddi_device_copy.9f b/usr/src/man/man9f/ddi_device_copy.9f index 5adb569f61..03465634d7 100644 --- a/usr/src/man/man9f/ddi_device_copy.9f +++ b/usr/src/man/man9f/ddi_device_copy.9f @@ -8,7 +8,6 @@ ddi_device_copy \- copy data from one device register to another device register .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -22,11 +21,8 @@ register .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIsrc_handle\fR \fR @@ -135,8 +131,6 @@ The size of each data word. Possible values are defined as: .RE .SH DESCRIPTION -.sp -.LP \fBddi_device_copy()\fR copies \fIbytecount\fR bytes from the source address, \fIsrc_addr\fR, to the destination address, \fIdest_addr\fR. The attributes encoded in the access handles, \fIsrc_handle\fR and \fIdest_handle\fR, govern @@ -161,8 +155,6 @@ negative value decrements the device address. The \fIdev_datasz\fR argument determines the size of the data word on each access. The data size must be the same between the source and destination. .SH RETURN VALUES -.sp -.LP \fBddi_device_copy()\fR returns: .sp .ne 2 @@ -183,12 +175,8 @@ The byte count is not a multiple \fIdev_datasz\fR. .RE .SH CONTEXT -.sp -.LP \fBddi_device_copy()\fR can be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_device_zero.9f b/usr/src/man/man9f/ddi_device_zero.9f index 45ba71be76..735e3102a0 100644 --- a/usr/src/man/man9f/ddi_device_zero.9f +++ b/usr/src/man/man9f/ddi_device_zero.9f @@ -7,7 +7,6 @@ .SH NAME ddi_device_zero \- zero fill the device .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ ddi_device_zero \- zero fill the device .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -106,8 +102,6 @@ The size of each data word. Possible values are defined as: .RE .SH DESCRIPTION -.sp -.LP \fBddi_device_zero()\fR function fills the given, \fIbytecount\fR, number of byte of zeroes to the device register or memory. .sp @@ -122,8 +116,6 @@ units. .LP The \fIdev_datasz\fR argument determines the size of data word on each access. .SH RETURN VALUES -.sp -.LP \fBddi_device_zero()\fR returns: .sp .ne 2 @@ -144,12 +136,8 @@ The byte count is not a multiple of \fIdev_datasz\fR. .RE .SH CONTEXT -.sp -.LP \fBddi_device_zero()\fR can be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_devid_compare.9f b/usr/src/man/man9f/ddi_devid_compare.9f index dec1f16b94..68e63e427d 100644 --- a/usr/src/man/man9f/ddi_devid_compare.9f +++ b/usr/src/man/man9f/ddi_devid_compare.9f @@ -199,7 +199,7 @@ The return address of a minor name. Free string with .RE .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION The following routines are used to provide unique identifiers, device \fBID\fRs, for devices. Specifically, kernel modules use these interfaces to diff --git a/usr/src/man/man9f/ddi_dma_addr_bind_handle.9f b/usr/src/man/man9f/ddi_dma_addr_bind_handle.9f index fa94c3cdf5..f63d208da9 100644 --- a/usr/src/man/man9f/ddi_dma_addr_bind_handle.9f +++ b/usr/src/man/man9f/ddi_dma_addr_bind_handle.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_addr_bind_handle \- binds an address to a DMA handle .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -20,8 +19,7 @@ ddi_dma_addr_bind_handle \- binds an address to a DMA handle .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -193,7 +191,6 @@ by calling \fBddi_dma_ncookies\fR(9F). .RE .SH DESCRIPTION -.LP \fBddi_dma_addr_bind_handle()\fR allocates \fBDMA\fR resources for a memory object such that a device can perform \fBDMA\fR to or from the object. \fBDMA\fR resources are allocated considering the device's \fBDMA\fR attributes @@ -310,7 +307,6 @@ functions accessible from interrupt context are be available. The callback function must take whatever steps are necessary to protect its critical resources, data structures, queues, and so on. .SH RETURN VALUES -.LP \fBddi_dma_addr_bind_handle()\fR returns: .sp .ne 2 @@ -371,12 +367,10 @@ configuration. .RE .SH CONTEXT -.LP \fBddi_dma_addr_bind_handle()\fR can be called from user, kernel, or interrupt context, except when \fIcallback\fR is set to \fBDDI_DMA_SLEEP\fR, in which case it can only be called from user or kernel context. .SH SEE ALSO -.LP \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_cookie_get\fR(9F), \fBddi_dma_cookie_iter\fR(9F), \fBddi_dma_free_handle\fR(9F), \fBddi_dma_getwin\fR(9F), \fBddi_dma_mem_alloc\fR(9F), @@ -387,7 +381,6 @@ case it can only be called from user or kernel context. .LP \fIWriting Device Drivers\fR .SH NOTES -.LP If the driver permits partial mapping with the \fBDDI_DMA_PARTIAL\fR flag, the number of cookies in each window may exceed the size of the device's scatter/gather list as specified in the \fBdma_attr_sgllen\fR field in the diff --git a/usr/src/man/man9f/ddi_dma_alloc_handle.9f b/usr/src/man/man9f/ddi_dma_alloc_handle.9f index ca018d3b58..5319ab7dc7 100644 --- a/usr/src/man/man9f/ddi_dma_alloc_handle.9f +++ b/usr/src/man/man9f/ddi_dma_alloc_handle.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_alloc_handle \- allocate DMA handle .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ ddi_dma_alloc_handle \- allocate DMA handle .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -89,8 +85,6 @@ Pointer to the \fBDMA\fR handle to be initialized. .RE .SH DESCRIPTION -.sp -.LP \fBddi_dma_alloc_handle()\fR allocates a new \fBDMA\fR handle. A \fBDMA\fR handle is an opaque object used as a reference to subsequently allocated \fBDMA\fR resources. \fBddi_dma_alloc_handle()\fR accepts as parameters the @@ -127,8 +121,6 @@ resources, data structures, queues, and so forth. When a \fBDMA\fR handle is no longer needed, \fBddi_dma_free_handle\fR(9F) must be called to free the handle. .SH RETURN VALUES -.sp -.LP \fBddi_dma_alloc_handle()\fR returns: .sp .ne 2 @@ -159,14 +151,10 @@ No resources are available. .RE .SH CONTEXT -.sp -.LP \fBddi_dma_alloc_handle()\fR can be called from user, kernel, or interrupt context, except when \fIcallback\fR is set to \fBDDI_DMA_SLEEP\fR, in which case it can be called from user or kernel context only. .SH SEE ALSO -.sp -.LP \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_burstsizes\fR(9F), \fBddi_dma_free_handle\fR(9F), \fBddi_dma_unbind_handle\fR(9F), \fBddi_dma_attr\fR(9S) diff --git a/usr/src/man/man9f/ddi_dma_buf_bind_handle.9f b/usr/src/man/man9f/ddi_dma_buf_bind_handle.9f index e68135a8bd..7b92477f1a 100644 --- a/usr/src/man/man9f/ddi_dma_buf_bind_handle.9f +++ b/usr/src/man/man9f/ddi_dma_buf_bind_handle.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_buf_bind_handle \- binds a system buffer to a DMA handle .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -20,8 +19,7 @@ ddi_dma_buf_bind_handle \- binds a system buffer to a DMA handle .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -174,7 +172,6 @@ by calling \fBddi_dma_ncookies\fR(9F). .RE .SH DESCRIPTION -.LP \fBddi_dma_buf_bind_handle()\fR allocates \fBDMA\fR resources for a system buffer such that a device can perform \fBDMA\fR to or from the buffer. \fBDMA\fR resources are allocated considering the device's \fBDMA\fR attributes @@ -292,7 +289,6 @@ functions accessible from interrupt context are be available. The callback function must take whatever steps necessary to protect its critical resources, data structures, queues, etc. .SH RETURN VALUES -.LP \fBddi_dma_buf_bind_handle()\fR returns: .sp .ne 2 @@ -353,12 +349,10 @@ configuration. .RE .SH CONTEXT -.LP \fBddi_dma_buf_bind_handle()\fR can be called from user, kernel, or interrupt context, except when \fIcallback\fR is set to \fBDDI_DMA_SLEEP\fR, in which case it can be called from user or kernel context only. .SH SEE ALSO -.LP \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_cookie_get\fR(9F), \fBddi_dma_cookie_iter\fR(9F), \fBddi_dma_free_handle\fR(9F), \fBddi_dma_getwin\fR(9F), @@ -369,7 +363,6 @@ case it can be called from user or kernel context only. .LP \fIWriting Device Drivers\fR .SH NOTES -.LP If the driver permits partial mapping with the \fBDDI_DMA_PARTIAL\fR flag, the number of cookies in each window may exceed the size of the device's scatter/gather list as specified in the \fBdma_attr_sgllen\fR field in the diff --git a/usr/src/man/man9f/ddi_dma_burstsizes.9f b/usr/src/man/man9f/ddi_dma_burstsizes.9f index 2c7c4b2ddb..ff0e6f1951 100644 --- a/usr/src/man/man9f/ddi_dma_burstsizes.9f +++ b/usr/src/man/man9f/ddi_dma_burstsizes.9f @@ -8,7 +8,6 @@ .SH NAME ddi_dma_burstsizes \- find out the allowed burst sizes for a DMA mapping .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -20,11 +19,8 @@ ddi_dma_burstsizes \- find out the allowed burst sizes for a DMA mapping .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -34,26 +30,18 @@ A \fBDMA\fR handle. .RE .SH DESCRIPTION -.sp -.LP \fBddi_dma_burstsizes()\fR returns the allowed burst sizes for a \fBDMA\fR mapping. This value is derived from the \fBdma_attr_burstsizes\fR member of the \fBddi_dma_attr\fR(9S) structure, but it shows the allowable burstsizes \fBafter\fR imposing on it the limitations of other device layers in addition to device's own limitations. .SH RETURN VALUES -.sp -.LP \fBddi_dma_burstsizes()\fR returns a binary encoded value of the allowable \fBDMA\fR burst sizes. See \fBddi_dma_attr\fR(9S) for a discussion of \fBDMA\fR burst sizes. .SH CONTEXT -.sp -.LP This function can be called from user or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_attr\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/ddi_dma_free_handle.9f b/usr/src/man/man9f/ddi_dma_free_handle.9f index bfcd40b879..52e7a16103 100644 --- a/usr/src/man/man9f/ddi_dma_free_handle.9f +++ b/usr/src/man/man9f/ddi_dma_free_handle.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_free_handle \- free DMA handle .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,7 +17,6 @@ ddi_dma_free_handle \- free DMA handle .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -29,25 +27,17 @@ A pointer to the \fBDMA\fR handle previously allocated by a call to .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_dma_free_handle()\fR destroys the \fBDMA \fRhandle pointed to by \fIhandle\fR. Any further references to the \fBDMA\fR handle will have undefined results. Note that \fBddi_dma_unbind_handle\fR(9F) must be called prior to \fBddi_dma_free_handle()\fR to free any resources the system may be caching on the handle. .SH CONTEXT -.sp -.LP \fBddi_dma_free_handle()\fR can be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_unbind_handle\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_dma_getwin.9f b/usr/src/man/man9f/ddi_dma_getwin.9f index aee028587d..44ad7e51cb 100644 --- a/usr/src/man/man9f/ddi_dma_getwin.9f +++ b/usr/src/man/man9f/ddi_dma_getwin.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_getwin \- activate a new DMA window .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -20,8 +19,7 @@ ddi_dma_getwin \- activate a new DMA window .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -84,7 +82,6 @@ by calling \fBddi_dma_ncookies\fR(9F). .RE .SH DESCRIPTION -.LP \fBddi_dma_getwin()\fR activates a new \fBDMA\fR window. If a \fBDMA\fR resource allocation request returns \fBDDI_DMA_PARTIAL_MAP\fR indicating that resources for less than the entire object were allocated, the current @@ -122,7 +119,6 @@ the interrupt routine returns without invoking another \fBDMA\fR transfer. Otherwise, it calls \fBddi_dma_getwin()\fR to shift the current window and start another \fBDMA\fR transfer. .SH RETURN VALUES -.LP \fBddi_dma_getwin()\fR returns: .sp .ne 2 @@ -143,10 +139,8 @@ Resources for the specified \fBDMA\fR window are allocated. .RE .SH CONTEXT -.LP \fBddi_dma_getwin()\fR can be called from user, kernel, or interrupt context. .SH SEE ALSO -.LP \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_cookie_get\fR(9F), \fBddi_dma_cookie_iter\fR(9F), \fBddi_dma_ncookies\fR(9F), diff --git a/usr/src/man/man9f/ddi_dma_mem_alloc.9f b/usr/src/man/man9f/ddi_dma_mem_alloc.9f index 2bb76ecc95..e3261e30e6 100644 --- a/usr/src/man/man9f/ddi_dma_mem_alloc.9f +++ b/usr/src/man/man9f/ddi_dma_mem_alloc.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_mem_alloc \- allocate memory for DMA transfer .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -21,11 +20,8 @@ ddi_dma_mem_alloc \- allocate memory for DMA transfer .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -192,8 +188,6 @@ Pointer to a data access handle. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_dma_mem_alloc()\fR function allocates memory for \fBDMA\fR transfers to or from a device. The allocation will obey the alignment, padding constraints and device granularity as specified by the \fBDMA\fR attributes @@ -238,8 +232,6 @@ ensure the consistency of a memory object shared between the \fBCPU\fR and the device after a \fBDMA\fR transfer, explicit synchronization steps using \fBddi_dma_sync\fR(9F) or \fBddi_dma_unbind_handle\fR(9F) are required. .SH RETURN VALUES -.sp -.LP The \fBddi_dma_mem_alloc()\fR function returns: .sp .ne 2 @@ -260,14 +252,10 @@ Memory allocation failed. .RE .SH CONTEXT -.sp -.LP The \fBddi_dma_mem_alloc()\fR function can be called from user, interrupt, or kernel context except when \fIwaitfp\fR is set to \fBDDI_DMA_SLEEP\fR, in which case it cannot be called from interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_mem_free\fR(9F), \fBddi_dma_sync\fR(9F), \fBddi_dma_unbind_handle\fR(9F), \fBddi_get8\fR(9F), \fBddi_put8\fR(9F), @@ -276,8 +264,6 @@ case it cannot be called from interrupt context. .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP If \fBDDI_NEVERSWAP_ACC\fR is specified, memory can be used for any purpose; but if either endian mode is specified, you must use \fBddi_get/put*\fR and never anything else. diff --git a/usr/src/man/man9f/ddi_dma_mem_free.9f b/usr/src/man/man9f/ddi_dma_mem_free.9f index 6f919b3b7b..d8b1b4ad3e 100644 --- a/usr/src/man/man9f/ddi_dma_mem_free.9f +++ b/usr/src/man/man9f/ddi_dma_mem_free.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_mem_free \- free previously allocated memory .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,7 +17,6 @@ ddi_dma_mem_free \- free previously allocated memory .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandlep\fR \fR @@ -29,22 +27,14 @@ Pointer to the data access handle previously allocated by a call to .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_dma_mem_free()\fR deallocates the memory acquired by \fBddi_dma_mem_alloc\fR(9F). In addition, it destroys the data access handle \fIhandlep\fR associated with the memory. .SH CONTEXT -.sp -.LP \fBddi_dma_mem_free()\fR can be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_dma_mem_alloc\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_dma_numwin.9f b/usr/src/man/man9f/ddi_dma_numwin.9f index 475fbe2e53..fb2d07522c 100644 --- a/usr/src/man/man9f/ddi_dma_numwin.9f +++ b/usr/src/man/man9f/ddi_dma_numwin.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_numwin \- retrieve number of DMA windows .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,7 +17,6 @@ ddi_dma_numwin \- retrieve number of DMA windows .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -39,17 +37,11 @@ windows for this object. .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_dma_numwin()\fR returns the number of \fBDMA\fR windows for a \fBDMA\fR object if partial resource allocation was permitted. .SH RETURN VALUES -.sp -.LP \fBddi_dma_numwin()\fR returns: .sp .ne 2 @@ -70,12 +62,8 @@ Successfully filled in the number of \fBDMA\fR windows. .RE .SH CONTEXT -.sp -.LP \fBddi_dma_numwin()\fR can be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_unbind_handle\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_dma_set_sbus64.9f b/usr/src/man/man9f/ddi_dma_set_sbus64.9f index d3255c6c0d..f30340e032 100644 --- a/usr/src/man/man9f/ddi_dma_set_sbus64.9f +++ b/usr/src/man/man9f/ddi_dma_set_sbus64.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_set_sbus64 \- allow 64-bit transfers on SBus .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ ddi_dma_set_sbus64 \- allow 64-bit transfers on SBus .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -42,8 +38,6 @@ mode. .RE .SH DESCRIPTION -.sp -.LP \fBddi_dma_set_sbus64()\fR informs the system that the device wishes to perform 64-bit data transfers on the SBus. The driver must first allocate a \fBDMA\fR handle using \fBddi_dma_alloc_handle\fR(9F) with a \fBddi_dma_attr\fR(9S) @@ -64,8 +58,6 @@ driver should retrieve the available burst sizes by calling 64-bit mode if the system was able to activate 64-bit transfers. Otherwise burst sizes will be returned in 32-bit mode. .SH RETURN VALUES -.sp -.LP \fBddi_dma_set_sbus64()\fR returns: .sp .ne 2 @@ -86,13 +78,9 @@ Successfully set the SBus to 64-bit mode. .RE .SH CONTEXT -.sp -.LP \fBddi_dma_set_sbus64()\fR can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -107,14 +95,10 @@ Architecture SBus .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_burstsizes\fR(9F), \fBddi_dma_attr\fR(9S) .SH NOTES -.sp -.LP 64-bit SBus mode is activated on a per SBus slot basis. If there are multiple SBus cards in one slot, they all must operate in 64-bit mode or they all must operate in 32-bit mode. diff --git a/usr/src/man/man9f/ddi_dma_sync.9f b/usr/src/man/man9f/ddi_dma_sync.9f index d064019214..fd6004dacc 100644 --- a/usr/src/man/man9f/ddi_dma_sync.9f +++ b/usr/src/man/man9f/ddi_dma_sync.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_sync \- synchronize CPU and I/O views of memory .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -17,11 +16,8 @@ ddi_dma_sync \- synchronize CPU and I/O views of memory .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -62,8 +58,6 @@ synchronize. The possible values are \fBDDI_DMA_SYNC_FORDEV\fR, .RE .SH DESCRIPTION -.sp -.LP The \fBddi_dma_sync()\fR function is used to selectively synchronize either a \fBDMA\fR device's or a \fBCPU\fR's view of a memory object that has \fBDMA\fR resources allocated for I/O . This may involve operations such as flushes of @@ -107,8 +101,6 @@ in the kernel's view (kernel-space part of the \fBCPU\fR's view) you may use is more economical to synchronize the kernel's view only, then do so; otherwise, synchronize for \fBCPU\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_dma_sync()\fR function returns: .sp .ne 2 @@ -130,13 +122,9 @@ The address range to be flushed is out of the address range established by .RE .SH CONTEXT -.sp -.LP The \fBddi_dma_sync()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_mem_alloc\fR(9F), \fBddi_dma_unbind_handle\fR(9F) diff --git a/usr/src/man/man9f/ddi_dma_unbind_handle.9f b/usr/src/man/man9f/ddi_dma_unbind_handle.9f index 36b23524b6..fb21ee1747 100644 --- a/usr/src/man/man9f/ddi_dma_unbind_handle.9f +++ b/usr/src/man/man9f/ddi_dma_unbind_handle.9f @@ -7,7 +7,6 @@ .SH NAME ddi_dma_unbind_handle \- unbinds the address in a DMA handle .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,7 +17,6 @@ ddi_dma_unbind_handle \- unbinds the address in a DMA handle .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -29,12 +27,8 @@ The \fBDMA\fR handle previously allocated by a call to .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_dma_unbind_handle()\fR frees all \fBDMA\fR resources associated with an existing \fBDMA\fR handle. When a \fBDMA\fR transfer completes, the driver should call \fBddi_dma_unbind_handle()\fR to free system \fBDMA\fR resources @@ -43,7 +37,6 @@ established by a call to \fBddi_dma_buf_bind_handle\fR(9F) or implicit \fBddi_dma_sync\fR(9F) making further synchronization steps unnecessary. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_SUCCESS\fR \fR @@ -62,13 +55,9 @@ on failure .RE .SH CONTEXT -.sp -.LP \fBddi_dma_unbind_handle()\fR can be called from user, kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_free_handle\fR(9F), \fBddi_dma_sync\fR(9F) diff --git a/usr/src/man/man9f/ddi_dmae.9f b/usr/src/man/man9f/ddi_dmae.9f index 8bb2d955bd..3e97f00451 100644 --- a/usr/src/man/man9f/ddi_dmae.9f +++ b/usr/src/man/man9f/ddi_dmae.9f @@ -10,7 +10,6 @@ ddi_dmae, ddi_dmae_alloc, ddi_dmae_release, ddi_dmae_prog, ddi_dmae_disable, ddi_dmae_enable, ddi_dmae_stop, ddi_dmae_getcnt, ddi_dmae_1stparty, ddi_dmae_getattr \- system DMA engine functions .SH SYNOPSIS -.LP .nf \fBint\fR \fBddi_dmae_alloc\fR(\fBdev_info_t *\fR\fIdip\fR, \fBint\fR \fIchnl\fR, \fBint (*\fR\fIcallback\fR) (caddr_t), \fBcaddr_t\fR \fIarg\fR); @@ -58,8 +57,7 @@ ddi_dmae_getattr \- system DMA engine functions .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -155,7 +153,6 @@ A pointer to a \fBDMA \fR attribute structure. See \fBddi_dma_attr\fR(9S). .RE .SH DESCRIPTION -.LP There are three possible ways that a device can perform \fBDMA\fR engine functions: .sp @@ -198,7 +195,6 @@ configuration is necessary to enable this mode. .RE .SS "\fBddi_dmae_alloc()\fR" -.LP The \fBddi_dmae_alloc()\fR function is used to acquire a \fBDMA\fR channel of the system \fBDMA\fR engine. \fBddi_dmae_alloc()\fR allows only one device at a time to have a particular \fBDMA\fR channel allocated. It must be called prior @@ -224,7 +220,6 @@ the value \fBDDI_DMA_CALLBACK_DONE\fR. If it tries to allocate the channel but fails to do so, it must return the value \fBDDI_DMA_CALLBACK_RUNOUT\fR. In this case, the callback function is put back on a list to be called again later. .SS "\fBddi_dmae_prog()\fR" -.LP The \fBddi_dmae_prog()\fR function programs the \fBDMA\fR channel for a \fBDMA\fR transfer. The \fBddi_dmae_req\fR structure contains all the information necessary to set up the channel, except for the memory address and @@ -245,26 +240,21 @@ resources using \fBDMA\fR setup functions such as \fBddi_dma_mem_alloc\fR(9F). contains the address and count. Then this cookie is passed to \fBddi_dmae_prog()\fR. .SS "\fBddi_dmae_disable()\fR" -.LP The \fBddi_dmae_disable()\fR function disables the \fBDMA\fR channel so that it no longer responds to a device's \fBDMA\fR service requests. .SS "\fBddi_dmae_enable()\fR" -.LP The \fBddi_dmae_enable()\fR function enables the \fBDMA\fR channel for operation. This may be used to re-enable the channel after a call to \fBddi_dmae_disable()\fR. The channel is automatically enabled after successful programming by \fBddi_dmae_prog()\fR. .SS "\fBddi_dmae_stop()\fR" -.LP The \fBddi_dmae_stop()\fR function disables the channel and terminates any active operation. .SS "\fBddi_dmae_getcnt()\fR" -.LP The \fBddi_dmae_getcnt()\fR function examines the count register of the \fBDMA\fR channel and sets \fI*countp\fR to the number of bytes remaining to be transferred. The channel is assumed to be stopped. .SS "\fBddi_dmae_1stparty()\fR" -.LP In the case of \fBISA\fR buses, \fBddi_dmae_1stparty()\fR configures a channel in the system's \fBDMA\fR engine to operate in a ``slave'' (``cascade'') mode. .sp @@ -275,7 +265,6 @@ first be allocated using \fBddi_dmae_alloc()\fR and then configured using I/O, including the necessary \fBDMA\fR address and count values obtained from the \fBddi_dma_cookie\fR(9S). .SS "\fBddi_dmae_getattr()\fR" -.LP The \fBddi_dmae_getattr()\fR function fills in the \fBDMA\fR attribute structure, pointed to by \fIattrp\fR, with the \fBDMA\fR attributes of the system \fBDMA\fR engine. Drivers for devices that perform their own bus @@ -314,13 +303,11 @@ available and the value of \fIdmae_waitfp\fR is not \fBDDI_DMA_SLEEP\fR. .RE .SH CONTEXT -.LP If \fBddi_dmae_alloc()\fR is called from interrupt context, then its \fIdmae_waitfp\fR argument and the callback function must not have the value \fBDDI_DMA_SLEEP\fR. Otherwise, all these routines can be called from user, interrupt, or kernel context. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -335,7 +322,6 @@ Architecture x86 .TE .SH SEE ALSO -.LP \fBisa\fR(4), \fBattributes\fR(5), \fBddi_dma_buf_setup\fR(9F), \fBddi_dma_cookie_iter\fR(9F), \fBddi_dma_getwin\fR(9F), \fBddi_dma_mem_alloc\fR(9F), \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_attr\fR(9S), diff --git a/usr/src/man/man9f/ddi_driver_major.9f b/usr/src/man/man9f/ddi_driver_major.9f index 49fcafba36..18ec5585d3 100644 --- a/usr/src/man/man9f/ddi_driver_major.9f +++ b/usr/src/man/man9f/ddi_driver_major.9f @@ -7,7 +7,6 @@ .SH NAME ddi_driver_major \- return driver's major device number .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -16,17 +15,12 @@ ddi_driver_major \- return driver's major device number .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP \fBddi_driver_major()\fR returns the major device number for the driver associated with the supplied \fBdev_info node\fR. This value can then be used as an argument to \fBmakedevice\fR(9F) to construct a complete \fBdev_t\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -36,17 +30,11 @@ A pointer to the device's \fBdev_info\fR structure. .RE .SH RETURN VALUES -.sp -.LP \fBddi_driver_major()\fR returns the major number of the driver bound to a device, if any, or \fBDDI_MAJOR_T_NONE\fR otherwise. .SH CONTEXT -.sp -.LP \fBddi_driver_major()\fR can be called from kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_driver_name\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_driver_name.9f b/usr/src/man/man9f/ddi_driver_name.9f index bd7d9f7464..3fcf24eaaa 100644 --- a/usr/src/man/man9f/ddi_driver_name.9f +++ b/usr/src/man/man9f/ddi_driver_name.9f @@ -7,7 +7,6 @@ .SH NAME ddi_driver_name \- return normalized driver name .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -16,11 +15,8 @@ ddi_driver_name \- return normalized driver name .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fBdip\fR \fR @@ -30,29 +26,19 @@ A pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fBddi_driver_name()\fR returns the normalized driver name. This name is typically derived from the device name property or the device compatible property. If this name is a driver alias, the corresponding driver name is returned. .SH RETURN VALUES -.sp -.LP \fBddi_driver_name()\fR returns the actual name of the driver bound to a device. .SH CONTEXT -.sp -.LP \fBddi_driver_name()\fR can be called from kernel, or interrupt context. .SH SEE ALSO -.sp -.LP \fBddi_get_name\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP The name returned by \fBddi_driver_name()\fR is read-only. diff --git a/usr/src/man/man9f/ddi_enter_critical.9f b/usr/src/man/man9f/ddi_enter_critical.9f index 3516ab7a15..4d1b3b973f 100644 --- a/usr/src/man/man9f/ddi_enter_critical.9f +++ b/usr/src/man/man9f/ddi_enter_critical.9f @@ -8,7 +8,6 @@ ddi_enter_critical, ddi_exit_critical \- enter and exit a critical region of control .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -25,11 +24,8 @@ control .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIddic\fR\fR @@ -40,8 +36,6 @@ to \fBddi_exit_critical()\fR. .RE .SH DESCRIPTION -.sp -.LP Nearly all driver operations can be done without any special synchronization and protection mechanisms beyond those provided by, for example, mutexes (see \fBmutex\fR(9F)). However, for certain devices there can exist a very short @@ -57,17 +51,11 @@ The driver may not call any functions external to itself in between the time it calls \fBddi_enter_critical()\fR and the time it calls \fBddi_exit_critical()\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_enter_critical()\fR function returns an opaque unsigned integer which must be used in the subsequent call to \fBddi_exit_critical()\fR. .SH CONTEXT -.sp -.LP This function can be called from user, interrupt, or kernel context. .SH WARNINGS -.sp -.LP Driver writers should note that in a multiple processor system this function does not temporarily suspend other processors from executing. This function also cannot guarantee to actually block the hardware from doing such things as @@ -79,8 +67,6 @@ Do not write code bracketed by \fBddi_enter_critical()\fR and \fBddi_exit_critical()\fR that can get caught in an infinite loop, as the machine may crash if you do. .SH SEE ALSO -.sp -.LP \fBmutex\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_ffs.9f b/usr/src/man/man9f/ddi_ffs.9f index 3c9172edc9..b7605695f9 100644 --- a/usr/src/man/man9f/ddi_ffs.9f +++ b/usr/src/man/man9f/ddi_ffs.9f @@ -23,7 +23,7 @@ ddi_ffs, ddi_fls \- find first (last) bit set in a long integer .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na diff --git a/usr/src/man/man9f/ddi_fm_acc_err_clear.9f b/usr/src/man/man9f/ddi_fm_acc_err_clear.9f index eaec617f5b..e475f36ea4 100644 --- a/usr/src/man/man9f/ddi_fm_acc_err_clear.9f +++ b/usr/src/man/man9f/ddi_fm_acc_err_clear.9f @@ -8,7 +8,6 @@ ddi_fm_acc_err_clear, ddi_fm_dma_err_clear \- clear the error status for an access or DMA handle .SH SYNOPSIS -.LP .nf #include <sys/ndifma.h> @@ -23,11 +22,8 @@ access or DMA handle .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIacc_handle\fR\fR @@ -58,8 +54,6 @@ Version number of \fBddi_fm_error_t\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_fm_dma_err_clear()\fR and \fBddi_fm_acc_err_clear()\fR functions clear the error status of a \fBDMA\fR or access handle respectively. .sp @@ -67,8 +61,6 @@ clear the error status of a \fBDMA\fR or access handle respectively. Once cleared, the driver is again able to access the mapped registers or memory using programmed \fBI/O\fR through the handle. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -83,8 +75,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_dma_mem_alloc\fR(9F), \fBddi_fm_acc_err_get\fR(9F), \fBddi_fm_dma_err_get\fR(9F), \fBddi_regs_map_setup\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_fm_acc_err_get.9f b/usr/src/man/man9f/ddi_fm_acc_err_get.9f index dcf8c50a71..1d1bc27666 100644 --- a/usr/src/man/man9f/ddi_fm_acc_err_get.9f +++ b/usr/src/man/man9f/ddi_fm_acc_err_get.9f @@ -8,7 +8,6 @@ ddi_fm_acc_err_get, ddi_fm_dma_err_get \- get the error status for an access or DMA handle .SH SYNOPSIS -.LP .nf #include <sys/ddifm.h> @@ -23,8 +22,7 @@ DMA handle .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -67,7 +65,6 @@ Version number of \fBddi_fm_error_t\fR. The driver should always set this to .RE .SH DESCRIPTION -.LP The \fBddi_fm_dma_err_get()\fR and \fBddi_fm_acc_err_get()\fR functions return the error status for a \fBDMA\fR or access handle respectively. If a fault has occurred that affects the resource mapped by the supplied handle, the supplied @@ -107,11 +104,9 @@ the impacted device instance. If the recovery and retry succeed, a call should still be made to \fBddi_fm_service_impact()\fR but \fBDDI_SERVICE_UNAFFECTED\fR should be specified. .SH CONTEXT -.LP The \fBddi_fm_acc_err_get()\fR and \fBddi_fm_dma_err_get()\fR functions can be called from user, kernel, or high-level interrupt context. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -126,7 +121,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBddi_dma_mem_alloc\fR(9F), \fBddi_fm_acc_err_clear\fR(9F), \fBddi_fm_service_impact\fR(9F), \fBddi_get8\fR(9F), \fBddi_put8\fR(9F), \fBddi_regs_map_setup\fR(9F), diff --git a/usr/src/man/man9f/ddi_fm_ereport_post.9f b/usr/src/man/man9f/ddi_fm_ereport_post.9f index 8f1b90669e..92a443c43b 100644 --- a/usr/src/man/man9f/ddi_fm_ereport_post.9f +++ b/usr/src/man/man9f/ddi_fm_ereport_post.9f @@ -7,7 +7,6 @@ .SH NAME ddi_fm_ereport_post \- post an FMA Protocol Error Report Event .SH SYNOPSIS -.LP .nf #include <sys/ddifm.h> @@ -16,11 +15,8 @@ ddi_fm_ereport_post \- post an FMA Protocol Error Report Event .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -57,8 +53,6 @@ Determines whether caller can sleep for memory or other event resources. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_fm_ereport_post()\fR function causes an encoded fault management error report name-value pair list to be queued for delivery to the Fault Manager daemon, \fBfmd\fR(1M). The \fIsflag\fR parameter indicates whether or @@ -168,13 +162,9 @@ Additional nvpair tuples can describe error conditions for logging purposes, but are not interpreted by the \fBI/O\fR framework or fault manager. The end of the argument list is specified by \fINULL\fR. .SH CONTEXT -.sp -.LP The \fBddi_fm_ereport_post()\fR function can be called from user, kernel, or high-level interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -189,6 +179,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBfmd\fR(1M), \fBattributes\fR(5), \fBddi_fm_service_impact\fR(9F) diff --git a/usr/src/man/man9f/ddi_fm_handler_register.9f b/usr/src/man/man9f/ddi_fm_handler_register.9f index 9a660cde27..092ec6ff28 100644 --- a/usr/src/man/man9f/ddi_fm_handler_register.9f +++ b/usr/src/man/man9f/ddi_fm_handler_register.9f @@ -8,7 +8,6 @@ ddi_fm_handler_register, ddi_fm_handler_unregister \- register or unregister an error handling callback .SH SYNOPSIS -.LP .nf #include <sys/ddifm.h> @@ -22,11 +21,8 @@ error handling callback .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -54,8 +50,6 @@ Pointer to private data for use by the caller .RE .SH DESCRIPTION -.sp -.LP The \fBddi_fm_handler_register()\fR function registers an error handler callback routine with the \fBI/O\fR Fault Management framework. The error handler callback, \fIerror_handler\fR, is called to process error conditions @@ -132,7 +126,7 @@ access or \fBDMA\fR handles. .sp .LP For each error detected, the driver must formulate and post an error report via -\fBddi_fm_ereport_post()\fR for problem analysis by the Solaris Fault Manager +\fBddi_fm_ereport_post()\fR for problem analysis by the illumos Fault Manager \fBfmd\fR(1M). .sp .LP @@ -173,16 +167,12 @@ error handler callback, an error expectation flag, and any potential access or The \fBddi_fm_handler_unregister()\fR function removes a previously registered error handling callback for the device instance specified by the \fIdip\fR. .SH CONTEXT -.sp -.LP The \fBddi_fm_handler_register()\fR and \fBddi_fm_handler_unregister()\fR functions must be called from kernel context in an \fBattach\fR(9E) or \fBdetach\fR(9E) entry point. The registered error handler, \fIerror_handler\fR, callback can be called from kernel, interrupt, or high level interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -197,8 +187,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBfmd\fR(1M), \fBattributes\fR(5), \fBattach\fR(9E), \fBdetach\fR(9E), \fBddi_fm_ereport_post\fR(9F), \fBddi_fm_init\fR(9F), \fBddi_get8\fR(9F), \fBddi_put8\fR(9F), \fBpci_ereport_post\fR(9F), \fBddi_fm_error\fR(9S) diff --git a/usr/src/man/man9f/ddi_fm_service_impact.9f b/usr/src/man/man9f/ddi_fm_service_impact.9f index f7ac58fb2d..5ecaaffb74 100644 --- a/usr/src/man/man9f/ddi_fm_service_impact.9f +++ b/usr/src/man/man9f/ddi_fm_service_impact.9f @@ -7,7 +7,6 @@ .SH NAME ddi_fm_service_impact \- report the impact of an error .SH SYNOPSIS -.LP .nf #include <sys/ddifm.h> @@ -15,8 +14,7 @@ ddi_fm_service_impact \- report the impact of an error .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -36,7 +34,6 @@ Impact of error .RE .SH DESCRIPTION -.LP The following service impact values are accepted by \fBddi_fm_service_impact()\fR: .sp @@ -85,11 +82,9 @@ The service provided by the device was unaffected by the error. .RE .SH CONTEXT -.LP The \fBddi_fm_service_impact()\fR function can be called from user, kernel, or high-level interrupt context. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -104,6 +99,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBfmd\fR(1M), \fBattributes\fR(5), \fBddi_fm_ereport_post\fR(9F), \fBpci_ereport_post\fR(9F) diff --git a/usr/src/man/man9f/ddi_get8.9f b/usr/src/man/man9f/ddi_get8.9f index 4c979e6612..7ab78b1fe1 100644 --- a/usr/src/man/man9f/ddi_get8.9f +++ b/usr/src/man/man9f/ddi_get8.9f @@ -9,7 +9,6 @@ ddi_get8, ddi_get16, ddi_get32, ddi_get64, ddi_getb, ddi_getw, ddi_getl, ddi_getll \- read data from the mapped memory address, device register or allocated DMA memory address .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -35,15 +34,12 @@ allocated DMA memory address .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_getb()\fR, \fBddi_getl()\fR, +illumos DDI specific (illumos DDI). The \fBddi_getb()\fR, \fBddi_getl()\fR, \fBddi_getll()\fR, and \fBddi_getw()\fR functions are obsolete. The \fBddi_get8()\fR function replaces \fBddi_getb()\fR. The \fBddi_get32()\fR function replaces \fBddi_getl()\fR. The \fBddi_get64()\fR function replaces \fBddi_getll()\fR. The \fBddi_get16()\fR function replaces \fBddi_getw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -63,8 +59,6 @@ Base device address. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_get8()\fR, \fBddi_get16()\fR, \fBddi_get32()\fR, and \fBddi_get64()\fR functions read 8 bits, 16 bits, 32 bits and 64 bits of data, respectively, from the device address, \fIdev_addr\fR. @@ -82,16 +76,10 @@ high-interrupt context. These types include \fBISA\fR and SBus buses. See you can, under certain conditions, call these \fBDDI\fR functions from a high-interrupt context. See \fBpci\fR(4). .SH RETURN VALUES -.sp -.LP These functions return the value read from the mapped address. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -108,7 +96,5 @@ T} .TE .SH SEE ALSO -.sp -.LP \fBddi_put8\fR(9F), \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F), \fBddi_rep_get8\fR(9F), \fBddi_rep_put8\fR(9F) diff --git a/usr/src/man/man9f/ddi_get_cred.9f b/usr/src/man/man9f/ddi_get_cred.9f index efbb7a619f..3fbe70ef7a 100644 --- a/usr/src/man/man9f/ddi_get_cred.9f +++ b/usr/src/man/man9f/ddi_get_cred.9f @@ -7,7 +7,6 @@ .SH NAME ddi_get_cred \- returns a pointer to the credential structure of the caller .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -19,23 +18,13 @@ ddi_get_cred \- returns a pointer to the credential structure of the caller .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_get_cred()\fR returns a pointer to the user credential structure of the caller. .SH RETURN VALUES -.sp -.LP \fBddi_get_cred()\fR returns a pointer to the caller's credential structure. .SH CONTEXT -.sp -.LP \fBddi_get_cred()\fR can be called from user context only. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_get_devstate.9f b/usr/src/man/man9f/ddi_get_devstate.9f index b0ddec0c67..6d1e14e4a3 100644 --- a/usr/src/man/man9f/ddi_get_devstate.9f +++ b/usr/src/man/man9f/ddi_get_devstate.9f @@ -7,7 +7,6 @@ .SH NAME ddi_get_devstate \- Check device state .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -16,11 +15,8 @@ ddi_get_devstate \- Check device state .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR \fR @@ -30,14 +26,11 @@ Pointer to the device's \fBdev_info\fR structure .RE .SH DESCRIPTION -.sp -.LP The \fBddi_get_devstate()\fR function returns a value indicating the state of the device specified by \fB dip\fR, as derived from the configuration operations that have been performed on it (or on the bus on which it resides) and any fault reports relating to it. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_DEVSTATE_OFFLINE\fR\fR @@ -88,13 +81,9 @@ due to a fault. .RE .SH CONTEXT -.sp -.LP The \fBddi_get_devstate()\fR function may be called from user, kernel, or interrupt context. .SH NOTES -.sp -.LP A device driver should call this function to check its own state at each major entry point, and before committing resources to a requested operation. If a driver discovers that its device is already down, it should perform required @@ -113,7 +102,5 @@ to enqueue the operation and service it once the bus has been unquiesced. Note that not all busses support the quiesce/unquiesce operations, so this value may never be seen by some drivers. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBioctl\fR(9E), \fBopen\fR(9E), \fBread\fR(9E), \fBstrategy\fR(9E), \fBwrite\fR(9E), \fBddi_dev_report_fault\fR(9F) diff --git a/usr/src/man/man9f/ddi_get_driver_private.9f b/usr/src/man/man9f/ddi_get_driver_private.9f index 967703fe0a..ba6ede26cb 100644 --- a/usr/src/man/man9f/ddi_get_driver_private.9f +++ b/usr/src/man/man9f/ddi_get_driver_private.9f @@ -8,7 +8,6 @@ ddi_get_driver_private, ddi_set_driver_private \- get or set the address of the device's private data area .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -25,12 +24,8 @@ device's private data area .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBddi_get_driver_private()\fR .sp .ne 2 @@ -63,8 +58,6 @@ Data area address to set. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_get_driver_private()\fR function returns the address of the device's private data area from the device information structure pointed to by \fIdip\fR. @@ -74,16 +67,10 @@ The \fBddi_set_driver_private()\fR function sets the address of the device's private data area in the device information structure pointed to by \fIdip\fR with the value of \fIdata\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_get_driver_private()\fR function returns the contents of \fBdevi_driver_data\fR. If \fBddi_set_driver_private()\fR has not been previously called with \fIdip\fR, an unpredictable value is returned. .SH CONTEXT -.sp -.LP These functions can be called from user , interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_get_eventcookie.9f b/usr/src/man/man9f/ddi_get_eventcookie.9f index 5bf9a62dc4..e531e33e88 100644 --- a/usr/src/man/man9f/ddi_get_eventcookie.9f +++ b/usr/src/man/man9f/ddi_get_eventcookie.9f @@ -7,7 +7,6 @@ .SH NAME ddi_get_eventcookie \- retrieve a NDI event service cookie handle .SH SYNOPSIS -.LP .nf #include <sys/dditypes.h> #include <sys/sunddi.h> @@ -17,11 +16,8 @@ ddi_get_eventcookie \- retrieve a NDI event service cookie handle .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fBdev_info_t *\fR\fIdip\fR\fR @@ -52,8 +48,6 @@ Pointer to cookie where event cookie will be returned. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_get_eventcookie()\fR function queries the device tree for a cookie matching the given event name and returns a reference to that cookie. The search is performed by a calling up the device tree hierarchy until the request @@ -64,7 +58,6 @@ reached. The cookie returned by this function can be used to register a callback handler, unregister a callback handler, or post an event. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_SUCCESS\fR\fR @@ -84,13 +77,9 @@ device tree hierarchy. .RE .SH CONTEXT -.sp -.LP The \fBddi_get_eventcookie()\fR function can be called from user and kernel contexts only. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -105,8 +94,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_add_event_handler\fR(9F), \fBddi_remove_event_handler\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_get_instance.9f b/usr/src/man/man9f/ddi_get_instance.9f index a2d096f39f..f25f40e719 100644 --- a/usr/src/man/man9f/ddi_get_instance.9f +++ b/usr/src/man/man9f/ddi_get_instance.9f @@ -7,7 +7,6 @@ .SH NAME ddi_get_instance \- get device instance number .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ ddi_get_instance \- get device instance number .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -32,8 +28,6 @@ Pointer to \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_get_instance()\fR function returns the instance number of the device corresponding to \fIdip\fR. .sp @@ -53,18 +47,12 @@ driver may not appear to be in consecutive order. For example, if device removed, \fBfoo1\fR will continue to be associated with instance number \fB1\fR (even though \fBfoo1\fR is now the only device of its type on the system). .SH RETURN VALUES -.sp -.LP The \fBddi_get_instance()\fR function returns the instance number of the device corresponding to \fIdip\fR. .SH CONTEXT -.sp -.LP The \fBddi_get_instance()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBpath_to_inst\fR(4) .sp .LP diff --git a/usr/src/man/man9f/ddi_get_kt_did.9f b/usr/src/man/man9f/ddi_get_kt_did.9f index bb54383981..21954ca531 100644 --- a/usr/src/man/man9f/ddi_get_kt_did.9f +++ b/usr/src/man/man9f/ddi_get_kt_did.9f @@ -7,7 +7,6 @@ .SH NAME ddi_get_kt_did \- get identifier of current thread .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -19,31 +18,19 @@ ddi_get_kt_did \- get identifier of current thread .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBddi_get_kt_did()\fR function returns a unique 64-bit identifier for the currently running thread. .SH CONTEXT -.sp -.LP This routine can be called from user, kernel, or interrupt context. This routine cannot be called from a high-level interrupt context. .SH RETURN VALUES -.sp -.LP \fBddi_get_kt_did()\fR always returns the identifier for the current thread. There are no error conditions. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The value returned by this function can also be seen in \fBadb\fR or \fBmdb\fR as the \fBdid\fR field displayed when using the \fBthread\fR macro. .sp diff --git a/usr/src/man/man9f/ddi_get_lbolt.9f b/usr/src/man/man9f/ddi_get_lbolt.9f index 250fbbe20c..f7ae6bb3eb 100644 --- a/usr/src/man/man9f/ddi_get_lbolt.9f +++ b/usr/src/man/man9f/ddi_get_lbolt.9f @@ -8,7 +8,6 @@ .SH NAME ddi_get_lbolt \- returns the value of lbolt .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -20,28 +19,18 @@ ddi_get_lbolt \- returns the value of lbolt .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_get_lbolt()\fR returns the value of \fBlbolt\fR where \fBlbolt\fR is an integer that represents the number of clock ticks since the last system reboot. This value is used as a counter or timer inside the system kernel. The tick frequency can be determined by using \fBdrv_usectohz\fR(9F) which converts microseconds into clock ticks. .SH RETURN VALUES -.sp -.LP \fBddi_get_lbolt()\fR returns the value of \fBlbolt\fR. .SH CONTEXT -.sp -.LP This routine can be called from any context. .SH SEE ALSO -.sp -.LP \fBddi_get_time\fR(9F), \fBdrv_getparm\fR(9F), \fBdrv_usectohz\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_get_parent.9f b/usr/src/man/man9f/ddi_get_parent.9f index 149bd37f99..f58aa73b2e 100644 --- a/usr/src/man/man9f/ddi_get_parent.9f +++ b/usr/src/man/man9f/ddi_get_parent.9f @@ -7,7 +7,6 @@ .SH NAME ddi_get_parent \- find the parent of a device information structure .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ ddi_get_parent \- find the parent of a device information structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -32,21 +28,13 @@ Pointer to a device information structure. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_get_parent()\fR function returns a pointer to the device information structure which is the parent of the one pointed to by \fIdip\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_get_parent()\fR function returns a pointer to a device information structure. .SH CONTEXT -.sp -.LP The \fBddi_get_parent()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_get_pid.9f b/usr/src/man/man9f/ddi_get_pid.9f index 0e9b518767..dfdd865b3f 100644 --- a/usr/src/man/man9f/ddi_get_pid.9f +++ b/usr/src/man/man9f/ddi_get_pid.9f @@ -8,7 +8,6 @@ .SH NAME ddi_get_pid \- returns the process \fBID\fR .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -20,27 +19,17 @@ ddi_get_pid \- returns the process \fBID\fR .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_get_pid()\fR obtains the process \fBID\fR of the current process. This value can be used to allow only a select process to perform a certain operation. It can also be used to determine whether a device context belongs to the current process. .SH RETURN VALUES -.sp -.LP \fBddi_get_pid()\fR returns the process \fBID\fR. .SH CONTEXT -.sp -.LP This routine can be called from user context only. .SH SEE ALSO -.sp -.LP \fBdrv_getparm\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_get_time.9f b/usr/src/man/man9f/ddi_get_time.9f index 16b383c0c4..36e33890f9 100644 --- a/usr/src/man/man9f/ddi_get_time.9f +++ b/usr/src/man/man9f/ddi_get_time.9f @@ -9,7 +9,6 @@ .SH NAME ddi_get_time \- returns the current time in seconds .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -21,28 +20,18 @@ ddi_get_time \- returns the current time in seconds .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_get_time()\fR returns the current time in seconds since 00:00:00 UTC, January 1, 1970. Changes in time of day clock may result in this value changing. In other words, the value is not monotonically increasing and therefore it must not be used to set wait or expiration intervals. For that, instead use \fBddi_get_lbolt\fR(9F) or \fBgethrtime\fR(9F). .SH RETURN VALUES -.sp -.LP \fBddi_get_time()\fR returns the time in seconds. .SH CONTEXT -.sp -.LP This routine can be called from any context. .SH SEE ALSO -.sp -.LP \fBddi_get_lbolt\fR(9F), \fBdrv_getparm\fR(9F), \fBdrv_usectohz\fR(9F), \fBgethrtime\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_in_panic.9f b/usr/src/man/man9f/ddi_in_panic.9f index bdbbfd69e2..2622afe873 100644 --- a/usr/src/man/man9f/ddi_in_panic.9f +++ b/usr/src/man/man9f/ddi_in_panic.9f @@ -8,7 +8,6 @@ .SH NAME ddi_in_panic \- determine if system is in panic state .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,12 +18,8 @@ ddi_in_panic \- determine if system is in panic state .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP Drivers controlling devices on which the system may write a kernel crash dump in the event of a panic can call \fBddi_in_panic()\fR to determine if the system is panicking. @@ -39,17 +34,11 @@ can \fBdelay\fR(9F) be relied upon, since it is implemented via Drivers that need to enforce a time delay such as \fBSCSI \fRbus reset delay time must busy-wait when the system is panicking. .SH RETURN VALUES -.sp -.LP \fBddi_in_panic()\fR returns \fB1\fR if the system is in panic, or \fB0\fR otherwise. .SH CONTEXT -.sp -.LP \fBddi_in_panic()\fR may be called from any context. .SH SEE ALSO -.sp -.LP \fBdump\fR(9E), \fBdelay\fR(9F), \fBddi_trigger_softintr\fR(9F), \fBtimeout\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_intr_add_handler.9f b/usr/src/man/man9f/ddi_intr_add_handler.9f index 37f54a8adc..f5b554bbc4 100644 --- a/usr/src/man/man9f/ddi_intr_add_handler.9f +++ b/usr/src/man/man9f/ddi_intr_add_handler.9f @@ -8,7 +8,6 @@ ddi_intr_add_handler, ddi_intr_remove_handler \- add or remove interrupt handler .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -28,12 +27,8 @@ handler .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBddi_intr_add_handler()\fR .sp .ne 2 @@ -84,8 +79,6 @@ DDI interrupt handle .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_add_handler()\fR function adds an interrupt handler given by the \fIinthandler\fR argument to the system with the handler arguments \fIarg1\fR and \fIarg2\fR for the previously allocated interrupt handle @@ -122,8 +115,6 @@ added and duplicated instances of the handler must be removed with \fBddi_intr_remove_handler()\fR in order for the handler to be completely removed. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_add_handler()\fR and \fBddi_intr_remove_handler()\fR functions return: .sp @@ -154,13 +145,9 @@ On any implementation specific failure. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_add_handler()\fR and \fBddi_intr_remove_handler()\fR functions can be called from kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -175,8 +162,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBattach\fR(9E), \fBdetach\fR(9E), \fBddi_intr_alloc\fR(9F), \fBddi_intr_block_enable\fR(9F), \fBddi_intr_disable\fR(9F), \fBddi_intr_dup_handler\fR(9F), @@ -187,8 +172,6 @@ Interface Stability Committed .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Consumers of these interfaces should verify that the return value is not equal to \fBDDI_SUCCESS\fR. Incomplete checking for failure codes could result in inconsistent behavior among platforms. diff --git a/usr/src/man/man9f/ddi_intr_add_softint.9f b/usr/src/man/man9f/ddi_intr_add_softint.9f index 7ffbf122e2..4767701d2a 100644 --- a/usr/src/man/man9f/ddi_intr_add_softint.9f +++ b/usr/src/man/man9f/ddi_intr_add_softint.9f @@ -9,7 +9,6 @@ ddi_intr_add_softint, ddi_intr_remove_softint, ddi_intr_trigger_softint, ddi_intr_get_softint_pri, ddi_intr_set_softint_pri \- software interrupt handling routines .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -47,12 +46,8 @@ handling routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBddi_intr_add_softint()\fR .sp .ne 2 @@ -175,8 +170,6 @@ Soft interrupt priority of the handle .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_add_softint()\fR function adds the soft interrupt handler given by the \fIhandler\fR argument \fIarg1\fR. The \fIhandler\fR runs at the soft interrupt priority given by the \fIsoft_pri\fR argument. @@ -240,8 +233,6 @@ priority, a small integer value, associated with the soft interrupt handle. The handle is defined by the \fIh\fR argument, and the priority returned is in the value of the integer pointed to by the \fIsoft_prip\fR argument. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_add_softint()\fR, \fBddi_intr_remove_softint()\fR, \fBddi_intr_trigger_softint()\fR, \fBddi_intr_get_softint_pri()\fR, \fBddi_intr_set_softint_pri()\fR functions return: @@ -291,14 +282,11 @@ On encountering a previously triggered softint event that is pending. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_add_softint()\fR, \fBddi_intr_remove_softint()\fR, \fBddi_intr_trigger_softint()\fR, \fBddi_intr_get_softint_pri()\fR, \fBddi_intr_set_softint_pri()\fR functions can be called from either user or kernel non-interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRDevice using high-level interrupts .sp .LP @@ -489,8 +477,6 @@ xxsoftint_handler(void *arg1, void *arg2) .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -505,8 +491,6 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBattach\fR(9E), \fBddi_intr_alloc\fR(9F), \fBddi_intr_free\fR(9F), \fBddi_intr_get_hilevel_pri\fR(9F), \fBmutex_init\fR(9F), \fBrw_init\fR(9F), \fBrwlock\fR(9F) @@ -514,8 +498,6 @@ Interface Stability Evolving .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Consumers of these interfaces should verify that the return value is not equal to \fBDDI_SUCCESS\fR. Incomplete checking for failure codes could result in inconsistent behavior among platforms. diff --git a/usr/src/man/man9f/ddi_intr_alloc.9f b/usr/src/man/man9f/ddi_intr_alloc.9f index a8829831e7..76e63ece15 100644 --- a/usr/src/man/man9f/ddi_intr_alloc.9f +++ b/usr/src/man/man9f/ddi_intr_alloc.9f @@ -8,7 +8,6 @@ ddi_intr_alloc, ddi_intr_free \- allocate or free interrupts for a given interrupt type .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -25,12 +24,8 @@ interrupt type .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBddi_intr_alloc()\fR .sp .ne 2 @@ -110,8 +105,6 @@ DDI interrupt handle .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_alloc()\fR function allocates interrupts of the interrupt type given by the \fItype\fR argument beginning at the interrupt number \fIinum\fR. If \fBddi_intr_alloc()\fR allocates any interrupts, it returns the actual @@ -163,8 +156,6 @@ should not be used in any further calls. The \fBddi_intr_free()\fR function should be called once for each handle in the handle array. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_alloc()\fR and \fBddi_intr_free()\fR functions return: .sp .ne 2 @@ -212,13 +203,9 @@ On any implementation specific failure. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_alloc()\fR and \fBddi_intr_free()\fR functions can be called from kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -233,8 +220,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_add_handler\fR(9F), \fBddi_intr_block_enable\fR(9F), \fBddi_intr_disable\fR(9F), \fBddi_intr_enable\fR(9F), \fBddi_intr_get_cap\fR(9F), @@ -244,8 +229,6 @@ Interface Stability Committed .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Consumers of these interfaces should verify that the return value is not equal to \fBDDI_SUCCESS\fR. Incomplete checking for failure codes could result in inconsistent behavior among platforms. diff --git a/usr/src/man/man9f/ddi_intr_dup_handler.9f b/usr/src/man/man9f/ddi_intr_dup_handler.9f index 0015714550..e531e9ddd7 100644 --- a/usr/src/man/man9f/ddi_intr_dup_handler.9f +++ b/usr/src/man/man9f/ddi_intr_dup_handler.9f @@ -8,7 +8,6 @@ ddi_intr_dup_handler \- reuse interrupt handler and arguments for MSI-X interrupts .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -20,11 +19,8 @@ interrupts .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIprimary\fR\fR @@ -52,13 +48,11 @@ Pointer to new DDI interrupt handle .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_dup_handler()\fR function is a feature for MSI-X interrupts that allows an unallocated interrupt vector of a device to use a previously initialized or added primary MSI-X interrupt vector in order to share the same vector address, vector data, interrupt handler, and handler arguments. This -feature allows a driver to alias the resources provided by the Solaris +feature allows a driver to alias the resources provided by the illumos Operating System to the unallocated interrupt vectors on an associated device. For example, if 2 MSI-X interrupts were allocated to a driver and 32 interrupts were supported on the device, the driver could alias the 2 interrupts it @@ -102,8 +96,6 @@ freed. Otherwise, calls to \fBddi_intr_remove_handler()\fR will fail with See the EXAMPLES section for code that illustrates the use of the \fBddi_intr_dup_handler()\fR function. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_dup_handler()\fR function returns: .sp .ne 2 @@ -139,7 +131,6 @@ On any implementation specific failure. .RE .SH EXAMPLES -.LP \fBExample 1 \fRUsing the \fBddi_intr_dup_handler()\fR function .sp .in +2 @@ -266,13 +257,9 @@ remove_msix_interrupts(intr_state_t *state) .in -2 .SH CONTEXT -.sp -.LP The \fBddi_intr_dup_handler()\fR function can be called from kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -287,8 +274,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_add_handler\fR(9F), \fBddi_intr_alloc\fR(9F), \fBddi_intr_clr_mask\fR(9F), \fBddi_intr_disable\fR(9F), \fBddi_intr_enable\fR(9F), \fBddi_intr_free\fR(9F), diff --git a/usr/src/man/man9f/ddi_intr_enable.9f b/usr/src/man/man9f/ddi_intr_enable.9f index 1ddad705e0..de422f487f 100644 --- a/usr/src/man/man9f/ddi_intr_enable.9f +++ b/usr/src/man/man9f/ddi_intr_enable.9f @@ -9,7 +9,6 @@ ddi_intr_enable, ddi_intr_block_enable, ddi_intr_disable, ddi_intr_block_disable \- enable or disable a given interrupt or range of interrupts .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -37,12 +36,8 @@ interrupts .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBddi_intr_enable()\fR .sp .ne 2 @@ -108,8 +103,6 @@ Number of interrupts .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_enable()\fR function enables the interrupt given by the interrupt handle \fIh\fR. .sp @@ -166,8 +159,6 @@ interrupt with \fBddi_intr_remove_handler()\fR and \fBddi_intr_free()\fR, respectively. The \fBddi_intr_block_disable()\fR function should be called if the \fBddi_intr_block_enable()\fR function was used to enable the interrupts. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_enable()\fR, \fBddi_intr_block_enable()\fR, \fBddi_intr_disable()\fR, and \fBddi_intr_block_disable()\fR functions return: .sp @@ -198,14 +189,10 @@ On any implementation specific failure. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_enable()\fR, \fBddi_intr_block_enable()\fR, \fBddi_intr_disable()\fR, and \fBddi_intr_block_disable()\fR functions can be called from kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -220,8 +207,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_add_handler\fR(9F), \fBddi_intr_alloc\fR(9F), \fBddi_intr_dup_handler\fR(9F), \fBddi_intr_free\fR(9F), \fBddi_intr_get_cap\fR(9F), \fBddi_intr_remove_handler\fR(9F), \fBmutex\fR(9F), @@ -230,8 +215,6 @@ Interface Stability Committed .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Consumers of these interfaces should verify that the return value is not equal to \fBDDI_SUCCESS\fR. Incomplete checking for failure codes could result in inconsistent behavior among platforms. diff --git a/usr/src/man/man9f/ddi_intr_get_cap.9f b/usr/src/man/man9f/ddi_intr_get_cap.9f index 605ae5339e..e1454adc11 100644 --- a/usr/src/man/man9f/ddi_intr_get_cap.9f +++ b/usr/src/man/man9f/ddi_intr_get_cap.9f @@ -8,7 +8,6 @@ ddi_intr_get_cap, ddi_intr_set_cap \- get or set interrupt capabilities for a given interrupt type .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -24,12 +23,8 @@ given interrupt type .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBddi_intr_get_cap()\fR .sp .ne 2 @@ -71,8 +66,6 @@ Contains the capability flag to be set .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_get_cap()\fR function returns the interrupt capability flags for the interrupt handle \fIh\fR. Upon a successful return, the flags are returned in the integer pointed to by the \fIflagsp\fR argument. @@ -144,8 +137,6 @@ The \fBddi_intr_set_cap()\fR function can be called after interrupts are allocated and prior to adding the interrupt handler. For all other times it returns failure. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_get_cap()\fR and \fBddi_intr_set_cap()\fR functions return: .sp .ne 2 @@ -184,13 +175,9 @@ On device not supporting operation. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_get_cap()\fR and \fBddi_intr_set_cap()\fR functions can be called from either user or kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -205,8 +192,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_alloc\fR(9F), \fBddi_intr_block_enable\fR(9F), \fBddi_intr_get_nintrs\fR(9F), \fBddi_intr_get_pending\fR(9F), \fBddi_intr_get_supported_types\fR(9F), \fBddi_intr_set_mask\fR(9F) @@ -214,8 +199,6 @@ Interface Stability Committed .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Consumers of these interfaces should verify that the return value is not equal to \fBDDI_SUCCESS\fR. Incomplete checking for failure codes could result in inconsistent behavior among platforms. diff --git a/usr/src/man/man9f/ddi_intr_get_hilevel_pri.9f b/usr/src/man/man9f/ddi_intr_get_hilevel_pri.9f index 0c4df24099..89068a899b 100644 --- a/usr/src/man/man9f/ddi_intr_get_hilevel_pri.9f +++ b/usr/src/man/man9f/ddi_intr_get_hilevel_pri.9f @@ -8,7 +8,6 @@ ddi_intr_get_hilevel_pri \- get minimum priority level for a high-level interrupt .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -19,12 +18,8 @@ interrupt .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP Upon a successful return, the \fBddi_intr_get_hilevel_pri()\fR function returns the minimum priority level for a high-level interrupt. The return priority value can be used to compare to other priority values, such as those returned @@ -56,18 +51,12 @@ are not. Devices such as those those using SBus interrupts or VME bus level 6 or 7 interrupts must use the \fBddi_intr_get_hilevel_pri()\fR function to test the type of interrupt handler that can be used. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_get_hilevel_pri()\fR function returns the priority value for a high-level interrupt. .SH CONTEXT -.sp -.LP The \fBddi_intr_get_hilevel_pri()\fR function can be called from either user or kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -82,8 +71,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_add_handler\fR(9F), \fBddi_intr_alloc\fR(9F), \fBddi_intr_enable\fR(9F), \fBddi_intr_get_pri\fR(9F), \fBddi_intr_trigger_softint\fR(9F), \fBmutex\fR(9F) diff --git a/usr/src/man/man9f/ddi_intr_get_nintrs.9f b/usr/src/man/man9f/ddi_intr_get_nintrs.9f index 59d817ad4e..6cee238173 100644 --- a/usr/src/man/man9f/ddi_intr_get_nintrs.9f +++ b/usr/src/man/man9f/ddi_intr_get_nintrs.9f @@ -8,7 +8,6 @@ ddi_intr_get_nintrs, ddi_intr_get_navail \- return number of interrupts supported or available for a given interrupt type .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -24,12 +23,8 @@ supported or available for a given interrupt type .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBddi_intr_get_nintrs()\fR .sp .ne 2 @@ -91,8 +86,6 @@ from the system .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_get_nintrs()\fR function returns the number of interrupts of the given \fItype\fR supported by a particular hardware device. On a successful return, the number of supported interrupts is returned as an integer pointed to @@ -121,8 +114,6 @@ The \fBddi_intr_get_supported_types\fR(9F) function returns a list of valid supported types for the given hardware device. It must be called prior to calling either the \fBddi_intr_get_nintrs()\fR or \fBddi_intr_get_navail()\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_get_nintrs()\fR and \fBddi_intr_get_navail()\fR functions return: .sp @@ -162,13 +153,9 @@ On any implementation specific failure. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_get_nintrs()\fR and \fBddi_intr_get_navail()\fR functions can be called from either user or kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -183,16 +170,12 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_alloc\fR(9F), \fBddi_intr_enable\fR(9F), \fBddi_intr_get_supported_types\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The \fBddi_intr_get_nintrs()\fR and \fBddi_intr_get_navail()\fR functions can be called at any time, even if the driver has added an interrupt handler for a given interrupt specification. diff --git a/usr/src/man/man9f/ddi_intr_get_pending.9f b/usr/src/man/man9f/ddi_intr_get_pending.9f index 6fca6effae..072eec5ab1 100644 --- a/usr/src/man/man9f/ddi_intr_get_pending.9f +++ b/usr/src/man/man9f/ddi_intr_get_pending.9f @@ -7,7 +7,6 @@ .SH NAME ddi_intr_get_pending \- get pending bit for a given interrupt .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -18,11 +17,8 @@ ddi_intr_get_pending \- get pending bit for a given interrupt .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIh\fR\fR @@ -41,8 +37,6 @@ Pointer to the pending capability returned for this handle .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_get_pending()\fR function returns non-zero as the integer pointed to by the \fIpendingp\fR argument if a corresponding interrupt is pending. The corresponding interrupt handle \fIh\fR must already be allocated. @@ -56,8 +50,6 @@ If the \fBDDI_INTR_FLAG_PENDING\fR capability is not supported, \fBddi_intr_get_pending()\fR returns \fBDDI_ENOTSUP\fR and zero in \fIpendingp\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_get_pending()\fR function returns: .sp .ne 2 @@ -96,13 +88,9 @@ On device not supporting operation. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_get_pending()\fR function can be called from either user or kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -117,8 +105,6 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_block_enable\fR(9F), \fBddi_intr_block_disable\fR(9F), \fBddi_intr_clr_mask\fR(9F), \fBddi_intr_disable\fR(9F), \fBddi_intr_enable\fR(9F), @@ -127,8 +113,6 @@ Interface Stability Evolving .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Any consumer of this interface should verify that the return value is not equal to \fBDDI_SUCCESS\fR. Incomplete checking for failure codes could result in inconsistent behavior among platforms. diff --git a/usr/src/man/man9f/ddi_intr_get_pri.9f b/usr/src/man/man9f/ddi_intr_get_pri.9f index e1753b64b8..2161e40acf 100644 --- a/usr/src/man/man9f/ddi_intr_get_pri.9f +++ b/usr/src/man/man9f/ddi_intr_get_pri.9f @@ -7,7 +7,6 @@ .SH NAME ddi_intr_get_pri, ddi_intr_set_pri \- get or set priority of a given interrupt .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -23,12 +22,8 @@ ddi_intr_get_pri, ddi_intr_set_pri \- get or set priority of a given interrupt .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBddi_intr_get_pri()\fR .sp .ne 2 @@ -70,8 +65,6 @@ Contains the priority to be set .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_get_pri()\fR function returns the current priority of the interrupt handle \fIh\fR of a given device. Upon a successful return, \fIprip\fR points to a small integer value, typically in the @@ -97,8 +90,6 @@ The \fBddi_intr_set_pri()\fR function can only be called prior to adding the interrupt handler or when an interrupt handler is unassigned. \fBDDI_FAILURE\fR is returned in all other cases. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_get_pri()\fR and \fBddi_intr_set_pri()\fR functions return: .sp .ne 2 @@ -137,13 +128,9 @@ On device not supporting operation. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_get_pri()\fR and \fBddi_intr_set_pri()\fR functions can be called from kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -158,16 +145,12 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_alloc\fR(9F), \fBddi_intr_enable\fR(9F), \fBmutex_init\fR(9F), \fBrw_init\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The priority returned from \fBddi_intr_get_pri()\fR should be typecast by calling the \fBDDI_INTR_PRI\fR macro before passing it onto \fBmutex_init\fR(9F). diff --git a/usr/src/man/man9f/ddi_intr_get_supported_types.9f b/usr/src/man/man9f/ddi_intr_get_supported_types.9f index fcb94260ce..74cb4fb61f 100644 --- a/usr/src/man/man9f/ddi_intr_get_supported_types.9f +++ b/usr/src/man/man9f/ddi_intr_get_supported_types.9f @@ -8,7 +8,6 @@ ddi_intr_get_supported_types \- return information on supported hardware interrupt types .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -19,11 +18,8 @@ interrupt types .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -42,8 +38,6 @@ Pointer to supported interrupt types .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_get_supported_types()\fR function retrieves the interrupt types supported by a particular hardware device and by the system software. Upon successful return, the supported types are returned as a bit mask in the @@ -61,8 +55,6 @@ An interrupt type is usable by the hardware device if it is returned by the programmed to use one of the returned interrupt types to receive hardware interrupts. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_get_supported_types()\fR function returns: .sp .ne 2 @@ -93,13 +85,9 @@ interrupts. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_get_supported_types()\fR function can be called from user or kernel non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -114,8 +102,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBpci\fR(4), \fBattributes\fR(5), \fBpcmcia\fR(7D), \fBsysbus\fR(4), \fBddi_intr_add_handler\fR(9F), \fBddi_intr_alloc\fR(9F), \fBddi_intr_enable\fR(9F) @@ -123,8 +109,6 @@ Interface Stability Committed .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The \fBddi_intr_get_supported_types()\fR function can be called by the device driver even at any time if the driver has added an interrupt handler for a given interrupt type. diff --git a/usr/src/man/man9f/ddi_intr_hilevel.9f b/usr/src/man/man9f/ddi_intr_hilevel.9f index 35e1fa772c..dbeaade7c4 100644 --- a/usr/src/man/man9f/ddi_intr_hilevel.9f +++ b/usr/src/man/man9f/ddi_intr_hilevel.9f @@ -7,7 +7,6 @@ .SH NAME ddi_intr_hilevel \- indicate interrupt handler type .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,13 +17,10 @@ ddi_intr_hilevel \- indicate interrupt handler type .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). This interface is obsolete. Use the new +illumos DDI specific (illumos DDI). This interface is obsolete. Use the new interrupt interfaces referenced in \fBIntro\fR(9F). Refer to \fIWriting Device Drivers\fR for more information. .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -43,8 +39,6 @@ Interrupt number. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_hilevel()\fR function returns non-zero if the specified interrupt is a "high level" interrupt. .sp @@ -72,7 +66,6 @@ example those using SBus or VME bus level 6 or 7 interrupts must use this test because on some machines those interrupts are high level (above the scheduler level) and on other machines they are not. .SH RETURN VALUES -.sp .ne 2 .na \fBnon-zero\fR @@ -82,12 +75,8 @@ indicates a high-level interrupt. .RE .SH CONTEXT -.sp -.LP These functions can be called from useruser, interrupt, or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -102,8 +91,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBddi_add_intr\fR(9F), \fBIntro\fR(9F), \fBmutex\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_intr_set_mask.9f b/usr/src/man/man9f/ddi_intr_set_mask.9f index 035b5ca768..636fda2741 100644 --- a/usr/src/man/man9f/ddi_intr_set_mask.9f +++ b/usr/src/man/man9f/ddi_intr_set_mask.9f @@ -7,7 +7,6 @@ .SH NAME ddi_intr_set_mask, ddi_intr_clr_mask \- set or clear mask for a given interrupt .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/conf.h> @@ -23,11 +22,8 @@ ddi_intr_set_mask, ddi_intr_clr_mask \- set or clear mask for a given interrupt .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIh\fR\fR @@ -37,8 +33,6 @@ DDI interrupt handle .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_set_mask()\fR function masks the given interrupt pointed to by the device's interrupt handle \fIh\fR if the device or host bridge supports the masking operation. The \fBddi_intr_get_cap()\fR function returns the \fBRO\fR @@ -62,8 +56,6 @@ temporarily masked the interrupt. A call to \fBddi_intr_clr_mask()\fR must be preceded by a call to \fBddi_intr_set_mask()\fR. It is not necessary to call \fBddi_intr_clr_mask()\fR when adding and enabling the interrupt. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_set_mask()\fR and \fBddi_intr_clr_mask()\fR functions return: .sp .ne 2 @@ -102,13 +94,9 @@ On device not supporting operation. .RE .SH CONTEXT -.sp -.LP The \fBddi_intr_set_mask()\fR and \fBddi_intr_clr_mask()\fR functions can be called from any context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -123,8 +111,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_intr_block_disable\fR(9F), \fBddi_intr_block_enable\fR(9F), \fBddi_intr_disable\fR(9F), \fBddi_intr_enable\fR(9F), \fBddi_intr_get_pending\fR(9F) @@ -132,8 +118,6 @@ Interface Stability Committed .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Consumers of these interfaces should verify that the return value is not equal to \fBDDI_SUCCESS\fR. Incomplete checking for failure codes could result in inconsistent behavior among platforms. diff --git a/usr/src/man/man9f/ddi_intr_set_nreq.9f b/usr/src/man/man9f/ddi_intr_set_nreq.9f index 7064e9c675..991faf2e12 100644 --- a/usr/src/man/man9f/ddi_intr_set_nreq.9f +++ b/usr/src/man/man9f/ddi_intr_set_nreq.9f @@ -8,7 +8,6 @@ ddi_intr_set_nreq \- set the number of interrupts requested for a device driver instance .SH SYNOPSIS -.LP .nf #include <sys/ddi_intr.h> @@ -18,11 +17,8 @@ instance .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -41,8 +37,6 @@ Number of interrupts requested. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_intr_set_nreq()\fR function changes the number of interrupts requested by a device driver instance. .sp @@ -68,8 +62,6 @@ can process actions related to changes in interrupt availability. See \fBddi_cb_register\fR(9F) for an explanation on how to enable this functionality. .SH RETURN VALUES -.sp -.LP The \fBddi_intr_set_nreq()\fR function returns: .sp .ne 2 @@ -109,12 +101,8 @@ Implementation specific failure .RE .SH CONTEXT -.sp -.LP These functions can be called from kernel, non-interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -131,13 +119,9 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBattach\fR(9E), \fBddi_cb_register\fR(9F), \fBddi_intr_alloc\fR(9F), \fBddi_intr_get_nintrs\fR(9F) .SH NOTES -.sp -.LP The Interrupt Resource Management feature is limited to device driver instances that are using MSI-X interrupts (interrupt type \fBDDI_INTR_TYPE_MSIX\fR). Attempts to use this function for any other type of interrupts fails with diff --git a/usr/src/man/man9f/ddi_io_get8.9f b/usr/src/man/man9f/ddi_io_get8.9f index e5557a5ff2..5ba4c455ce 100644 --- a/usr/src/man/man9f/ddi_io_get8.9f +++ b/usr/src/man/man9f/ddi_io_get8.9f @@ -8,7 +8,6 @@ ddi_io_get8, ddi_io_get16, ddi_io_get32, ddi_io_getb, ddi_io_getl, ddi_io_getw \- read data from the mapped device register in I/O space .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -29,9 +28,7 @@ ddi_io_get8, ddi_io_get16, ddi_io_get32, ddi_io_getb, ddi_io_getl, ddi_io_getw .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_io_get8()\fR, +illumos DDI specific (illumos DDI). The \fBddi_io_get8()\fR, \fBddi_io_get16()\fR, \fBddi_io_get32()\fR, \fBddi_io_getb()\fR, \fBddi_io_getl()\fR, and \fBddi_io_getw()\fR functions are obsolete. The \fBddi_get8\fR(9F) function replaces \fBddi_io_get8()\fR. The @@ -41,7 +38,6 @@ Solaris DDI specific (Solaris DDI). The \fBddi_io_get8()\fR, \fBddi_get32\fR(9F) function replaces \fBddi_io_getl()\fR. The \fBddi_get16\fR(9F) function replaces \fBddi_io_getw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -61,8 +57,6 @@ Device address. .RE .SH DESCRIPTION -.sp -.LP These routines generate a read of various sizes from the device address, \fIdev_addr\fR, in I/O space. The \fBddi_io_get8()\fR, \fBddi_io_get16()\fR, and \fBddi_io_get32()\fR functions read 8 bits, 16 bits, and 32 bits of data, @@ -74,12 +68,8 @@ view between the host and the device based on the encoded information in the data access handle. The translation may involve byte-swapping if the host and the device have incompatible endian characteristics. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -94,8 +84,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBisa\fR(4), \fBddi_get8\fR(9F), \fBddi_get16\fR(9F), \fBddi_get32\fR(9F), \fBddi_io_put8\fR(9F), \fBddi_io_rep_get8\fR(9F), \fBddi_io_rep_put8\fR(9F), \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F), diff --git a/usr/src/man/man9f/ddi_io_put8.9f b/usr/src/man/man9f/ddi_io_put8.9f index 61ad766abe..231bdfe938 100644 --- a/usr/src/man/man9f/ddi_io_put8.9f +++ b/usr/src/man/man9f/ddi_io_put8.9f @@ -8,7 +8,6 @@ ddi_io_put8, ddi_io_put16, ddi_io_put32, ddi_io_putb, ddi_io_putl, ddi_io_putw \- write data to the mapped device register in I/O space .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -32,9 +31,7 @@ ddi_io_put8, ddi_io_put16, ddi_io_put32, ddi_io_putb, ddi_io_putl, ddi_io_putw .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_io_put8()\fR, +illumos DDI specific (illumos DDI). The \fBddi_io_put8()\fR, \fBddi_io_put16()\fR, \fBddi_io_put32()\fR, \fBddi_io_putb()\fR, \fBddi_io_putl()\fR, and \fBddi_io_putw()\fR functions are obsolete. The \fBddi_put8\fR(9F) function replaces \fBddi_io_put8()\fR. The @@ -44,7 +41,6 @@ Solaris DDI specific (Solaris DDI). The \fBddi_io_put8()\fR, \fBddi_put32\fR(9F) function replaces \fBddi_io_putl()\fR. The \fBddi_put16\fR(9F) function replaces \fBddi_io_putw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -73,8 +69,6 @@ Data to be written to the device. .RE .SH DESCRIPTION -.sp -.LP These routines generate a write of various sizes to the device address, \fIdev_addr\fR, in I/O space. The \fBddi_io_put8()\fR, \fBddi_io_put16()\fR, and \fBddi_io_put32()\fR functions write 8 bits, 16 bits, and 32 bits of data, @@ -86,12 +80,8 @@ view between the host and the device based on the encoded information in the data access handle. The translation may involve byte-swapping if the host and the device have incompatible endian characteristics. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -106,8 +96,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBisa\fR(4), \fBddi_io_get8\fR(9F), \fBddi_io_rep_get8\fR(9F), \fBddi_io_rep_put8\fR(9F), \fBddi_put8\fR(9F), \fBddi_put16\fR(9F), \fBddi_put32\fR(9F), \fBddi_regs_map_setup\fR(9F), diff --git a/usr/src/man/man9f/ddi_io_rep_get8.9f b/usr/src/man/man9f/ddi_io_rep_get8.9f index ac24d9d35c..695e6ef301 100644 --- a/usr/src/man/man9f/ddi_io_rep_get8.9f +++ b/usr/src/man/man9f/ddi_io_rep_get8.9f @@ -9,7 +9,6 @@ ddi_io_rep_get8, ddi_io_rep_get16, ddi_io_rep_get32, ddi_io_rep_getb, ddi_io_rep_getl, ddi_io_rep_getw \- read multiple data from the mapped device register in I/O space .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -33,9 +32,7 @@ register in I/O space .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_io_rep_get8()\fR, +illumos DDI specific (illumos DDI). The \fBddi_io_rep_get8()\fR, \fBddi_io_rep_get16()\fR, \fBddi_io_rep_get32()\fR, \fBddi_io_rep_getb()\fR, \fBddi_io_rep_getl()\fR, and \fBddi_io_rep_getw()\fR functions are obsolete. The \fBddi_rep_get8\fR(9F) function replaces \fBddi_io_rep_get8()\fR. The @@ -45,7 +42,6 @@ The \fBddi_rep_get8\fR(9F) function replaces \fBddi_io_rep_get8()\fR. The \fBddi_rep_get32\fR(9F) function replaces \fBddi_io_rep_getl()\fR. The \fBddi_rep_get16\fR(9F) function replaces \fBddi_io_rep_getw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -83,8 +79,6 @@ Number of data accesses to perform. .RE .SH DESCRIPTION -.sp -.LP These routines generate multiple reads from the device address, \fIdev_addr\fR, in I/O space. \fIrepcount\fR data is copied from the device address, \fIdev_addr\fR, to the host address, \fIhost_addr\fR. For each input datum, the @@ -99,12 +93,8 @@ view between the host and the device based on the encoded information in the data access handle. The translation may involve byte-swapping if the host and the device have incompatible endian characteristics. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -119,8 +109,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBisa\fR(4), \fBddi_io_get8\fR(9F), \fBddi_io_put8\fR(9F), \fBddi_io_rep_put8\fR(9F), \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F), \fBddi_rep_get8\fR(9F), \fBddi_rep_get16\fR(9F), diff --git a/usr/src/man/man9f/ddi_io_rep_put8.9f b/usr/src/man/man9f/ddi_io_rep_put8.9f index b9fdf27161..decd7c7a8a 100644 --- a/usr/src/man/man9f/ddi_io_rep_put8.9f +++ b/usr/src/man/man9f/ddi_io_rep_put8.9f @@ -9,7 +9,6 @@ ddi_io_rep_put8, ddi_io_rep_put16, ddi_io_rep_put32, ddi_io_rep_putb, ddi_io_rep_putl, ddi_io_rep_putw \- write multiple data to the mapped device register in I/O space .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -33,9 +32,7 @@ register in I/O space .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_io_rep_put8()\fR, +illumos DDI specific (illumos DDI). The \fBddi_io_rep_put8()\fR, \fBddi_io_rep_put16()\fR, \fBddi_io_rep_put32()\fR, \fBddi_io_rep_putb()\fR, \fBddi_io_rep_putl()\fR, and \fBddi_io_rep_putw()\fR functions are obsolete. The \fBddi_rep_put8\fR(9F) function replaces \fBddi_io_rep_put8()\fR. The @@ -45,7 +42,6 @@ The \fBddi_rep_put8\fR(9F) function replaces \fBddi_io_rep_put8()\fR. The \fBddi_rep_put32\fR(9F) function replaces \fBddi_io_rep_putl()\fR. The \fBddi_rep_put16\fR(9F) function replaces \fBddi_io_rep_putw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -83,8 +79,6 @@ Number of data accesses to perform. .RE .SH DESCRIPTION -.sp -.LP These routines generate multiple writes to the device address, \fIdev_address\fR, in I/O space. \fIrepcount\fR data is copied from the host address, \fIhost_addr\fR, to the device address, \fIdev_addr\fR. For each input @@ -99,12 +93,8 @@ view between the host and the device based on the encoded information in the data access handle. The translation may involve byte-swapping if the host and the device have incompatible endian characteristics. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -119,8 +109,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBisa\fR(4), \fBddi_io_get8\fR(9F), \fBddi_io_put8\fR(9F), \fBddi_io_rep_get8\fR(9F), \fBddi_regs_map_setup\fR(9F), \fBddi_rep_put8\fR(9F), \fBddi_rep_put16\fR(9F), \fBddi_rep_put32\fR(9F), diff --git a/usr/src/man/man9f/ddi_log_sysevent.9f b/usr/src/man/man9f/ddi_log_sysevent.9f index 6194c137da..b7451c4f1d 100644 --- a/usr/src/man/man9f/ddi_log_sysevent.9f +++ b/usr/src/man/man9f/ddi_log_sysevent.9f @@ -7,7 +7,6 @@ .SH NAME ddi_log_sysevent \- log system event for drivers .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -20,11 +19,8 @@ ddi_log_sysevent \- log system event for drivers .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -99,8 +95,6 @@ available. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_log_sysevent()\fR function causes a system event, of the specified class and subclass, to be generated on behalf of the driver and queued for delivery to \fBsyseventd\fR, the user-land \fBsysevent\fR daemon. @@ -121,8 +115,6 @@ driver name, with the format: The two fields of \fBeidp\fR, \fBeid_seq\fR and \fBeid_ts\fR, are sufficient to uniquely identify an event. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBsysevent_id_t\fR are: .sp .in +2 @@ -133,8 +125,6 @@ The structure members of \fBsysevent_id_t\fR are: .in -2 .SH RETURN VALUES -.sp -.LP The \fBddi_log_sysevent()\fR function returns: .sp .ne 2 @@ -249,13 +239,10 @@ DATA_TYPE_INT64_ARRAY DATA_TYPE_UINT64_ARRAY .in -2 .SH CONTEXT -.sp -.LP The \fBddi_log_sysevent()\fR function can be called from user, interrupt, or kernel context, except when \fIsleep_flag\fR is \fBDDI_SLEEP\fR, in which case it cannot be called from interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRLogging System Event with No Attributes .sp .in +2 @@ -339,8 +326,6 @@ static int .in -2 .SH SEE ALSO -.sp -.LP \fBsyseventd\fR(1M), \fBattributes\fR(5), \fBnvlist_add_boolean\fR(9F), \fBnvlist_alloc\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_mem_get8.9f b/usr/src/man/man9f/ddi_mem_get8.9f index 6bb6a2c60f..11f3fa9802 100644 --- a/usr/src/man/man9f/ddi_mem_get8.9f +++ b/usr/src/man/man9f/ddi_mem_get8.9f @@ -9,7 +9,6 @@ ddi_mem_get8, ddi_mem_get16, ddi_mem_get32, ddi_mem_get64, ddi_mem_getb, ddi_mem_getl, ddi_mem_getll, ddi_mem_getw \- read data from mapped device in the memory space or allocated DMA memory .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -35,9 +34,7 @@ the memory space or allocated DMA memory .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_mem_get8()\fR, +illumos DDI specific (illumos DDI). The \fBddi_mem_get8()\fR, \fBddi_mem_get16()\fR, \fBddi_mem_get32()\fR, \fBddi_mem_get64()\fR, \fBddi_mem_getb()\fR, \fBddi_mem_getl()\fR, \fBddi_mem_getll()\fR, and \fBddi_mem_getw()\fR functions are obsolete. The \fBddi_get8\fR(9F) function @@ -50,7 +47,6 @@ replaces \fBddi_mem_get8()\fR. The \fBddi_get16\fR(9F) function replaces \fBddi_mem_getll()\fR. The \fBddi_get16\fR(9F) function replaces \fBddi_mem_getw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -70,8 +66,6 @@ Base device address. .RE .SH DESCRIPTION -.sp -.LP These routines generate a read of various sizes from memory space or allocated \fBDMA \fRmemory. The \fBddi_mem_get8()\fR, \fBddi_mem_get16()\fR, \fBddi_mem_get32()\fR, and \fBddi_mem_get64()\fR functions read 8 bits, 16 @@ -84,12 +78,8 @@ view between the host and the device based on the encoded information in the data access handle. The translation may involve byte-swapping if the host and the device have incompatible endian characteristics. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -104,8 +94,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBddi_get8\fR(9F), \fBddi_get16\fR(9F), \fBddi_get32\fR(9F), \fBddi_get64\fR(9F), \fBddi_mem_put8\fR(9F), \fBddi_mem_rep_get8\fR(9F), \fBddi_mem_rep_put8\fR(9F), \fBddi_regs_map_setup\fR(9F), diff --git a/usr/src/man/man9f/ddi_mem_put8.9f b/usr/src/man/man9f/ddi_mem_put8.9f index e78585be0d..a04a0670ac 100644 --- a/usr/src/man/man9f/ddi_mem_put8.9f +++ b/usr/src/man/man9f/ddi_mem_put8.9f @@ -9,7 +9,6 @@ ddi_mem_put8, ddi_mem_put16, ddi_mem_put32, ddi_mem_put64, ddi_mem_putb, ddi_mem_putw, ddi_mem_putl, ddi_mem_putll \- write data to mapped device in the memory space or allocated DMA memory .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -39,7 +38,6 @@ memory space or allocated DMA memory .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -68,9 +66,7 @@ The data to be written to the device. .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_mem_put8()\fR, +illumos DDI specific (illumos DDI). The \fBddi_mem_put8()\fR, \fBddi_mem_put16()\fR, \fBddi_mem_put32()\fR, \fBddi_mem_put64()\fR, \fBddi_mem_putb()\fR, \fBddi_mem_putl()\fR, \fBddi_mem_putll()\fR, and \fBddi_mem_putw()\fR functions are obsolete. The \fBddi_put8\fR(9F) function @@ -83,8 +79,6 @@ replaces \fBddi_mem_put8()\fR. The \fBddi_put16\fR(9F) function replaces \fBddi_mem_putll()\fR. The \fBddi_put16\fR(9F) function replaces \fBddi_mem_putw()\fR. .SH DESCRIPTION -.sp -.LP These routines generate a write of various sizes to memory space or allocated \fBDMA \fRmemory. The \fBddi_mem_put8()\fR, \fBddi_mem_put16()\fR, \fBddi_mem_put32()\fR, and \fBddi_mem_put64()\fR functions write 8 bits, 16 @@ -97,12 +91,8 @@ view between the host and the device based on the encoded information in the data access handle. The translation may involve byte-swapping if the host and the device have incompatible endian characteristics. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -117,8 +107,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBddi_mem_get8\fR(9F), \fBddi_mem_rep_get8\fR(9F), \fBddi_put8\fR(9F), \fBddi_put16\fR(9F), \fBddi_put32\fR(9F), \fBddi_put64\fR(9F), \fBddi_mem_get8\fR(9F), \fBddi_regs_map_setup\fR(9F), diff --git a/usr/src/man/man9f/ddi_mem_rep_get8.9f b/usr/src/man/man9f/ddi_mem_rep_get8.9f index ddedd0b2c5..5aa5cd42ff 100644 --- a/usr/src/man/man9f/ddi_mem_rep_get8.9f +++ b/usr/src/man/man9f/ddi_mem_rep_get8.9f @@ -9,7 +9,6 @@ ddi_mem_rep_get8, ddi_mem_rep_get16, ddi_mem_rep_get32, ddi_mem_rep_get64, ddi_mem_rep_getb, ddi_mem_rep_getl, ddi_mem_rep_getll, ddi_mem_rep_getw \- read multiple data from mapped device in the memory space or allocated DMA memory .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -43,9 +42,7 @@ multiple data from mapped device in the memory space or allocated DMA memory .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_mem_rep_get8()\fR, +illumos DDI specific (illumos DDI). The \fBddi_mem_rep_get8()\fR, \fBddi_mem_rep_get16()\fR, \fBddi_mem_rep_get32()\fR, \fBddi_mem_rep_get64()\fR, \fBddi_mem_rep_getb()\fR, \fBddi_mem_rep_getl()\fR, \fBddi_mem_rep_getll()\fR, and \fBddi_mem_rep_getw()\fR functions are obsolete. @@ -58,7 +55,6 @@ The \fBddi_rep_get8\fR(9F) function replaces \fBddi_mem_rep_get8()\fR. The \fBddi_rep_get64\fR(9F) function replaces \fBddi_mem_rep_getll()\fR. The \fBddi_rep_get16\fR(9F) function replaces \fBddi_mem_rep_getw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -124,8 +120,6 @@ Do not advance the device address, \fIdev_addr\fR, during data accesses. .RE .SH DESCRIPTION -.sp -.LP These routines generate multiple reads from memory space or allocated \fBDMA \fRmemory. \fIrepcount\fR data is copied from the device address, \fIdev_addr\fR, in memory space to the host address, \fIhost_addr\fR. For each @@ -149,12 +143,8 @@ However, when the \fIflags\fR argument is set to \fBDDI_DEV_NO_AUTOINCR\fR, the same device address will be used for every datum access. For example, this flag may be useful when reading from a data register. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -169,8 +159,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBddi_mem_get8\fR(9F), \fBddi_mem_put8\fR(9F), \fBddi_mem_rep_put8\fR(9F), \fBddi_regs_map_setup\fR(9F), \fBddi_rep_get8\fR(9F), \fBddi_rep_get16\fR(9F), \fBddi_rep_get32\fR(9F), \fBddi_rep_get64\fR(9F), \fBddi_device_acc_attr\fR(9S) diff --git a/usr/src/man/man9f/ddi_mem_rep_put8.9f b/usr/src/man/man9f/ddi_mem_rep_put8.9f index c5901f00f5..5d6c0eebfe 100644 --- a/usr/src/man/man9f/ddi_mem_rep_put8.9f +++ b/usr/src/man/man9f/ddi_mem_rep_put8.9f @@ -10,7 +10,6 @@ ddi_mem_rep_putb, ddi_mem_rep_putl, ddi_mem_rep_putll, ddi_mem_rep_putw \- write multiple data to mapped device in the memory space or allocated DMA memory .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -40,9 +39,7 @@ memory .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_mem_rep_put8()\fR, +illumos DDI specific (illumos DDI). The \fBddi_mem_rep_put8()\fR, \fBddi_mem_rep_put16()\fR, \fBddi_mem_rep_put32()\fR, \fBddi_mem_rep_put64()\fR, \fBddi_mem_rep_putb()\fR, \fBddi_mem_rep_putl()\fR, \fBddi_mem_rep_putll()\fR, and \fBddi_mem_rep_putw()\fR functions are obsolete. @@ -55,7 +52,6 @@ The \fBddi_rep_put8\fR(9F) function replaces \fBddi_mem_rep_put8()\fR. The \fBddi_rep_put64\fR(9F) function replaces \fBddi_mem_rep_putll()\fR. The \fBddi_rep_put16\fR(9F) function replaces \fBddi_mem_rep_putw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -121,8 +117,6 @@ Do not advance the device address, \fIdev_addr\fR, during data accesses. .RE .SH DESCRIPTION -.sp -.LP These routines generate multiple writes to memory space or allocated \fBDMA \fRmemory. \fIrepcount\fR data is copied from the host address, \fIhost_addr\fR, to the device address, \fIdev_addr\fR, in memory space. For @@ -146,12 +140,8 @@ the \fIflags\fR argument is set to \fBDDI_DEV_NO_AUTOINCR\fR, the same device address will be used for every datum access. For example, this flag may be useful when writing from a data register. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -166,8 +156,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBddi_mem_get8\fR(9F), \fBddi_mem_put8\fR(9F), \fBddi_mem_rep_get8\fR(9F), \fBddi_regs_map_setup\fR(9F), \fBddi_rep_put8\fR(9F), \fBddi_rep_put16\fR(9F), \fBddi_rep_put32\fR(9F), \fBddi_rep_put64\fR(9F), \fBddi_device_acc_attr\fR(9S) diff --git a/usr/src/man/man9f/ddi_mmap_get_model.9f b/usr/src/man/man9f/ddi_mmap_get_model.9f index 33c43e961d..75752db515 100644 --- a/usr/src/man/man9f/ddi_mmap_get_model.9f +++ b/usr/src/man/man9f/ddi_mmap_get_model.9f @@ -8,7 +8,6 @@ .SH NAME ddi_mmap_get_model \- return data model type of current thread .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,12 +18,8 @@ ddi_mmap_get_model \- return data model type of current thread .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBddi_mmap_get_model()\fR returns the \fIC\fR Language Type Model which the current thread expects. \fBddi_mmap_get_model()\fR is used in combination with \fBddi_model_convert_from\fR(9F) in the \fBmmap\fR(9E) driver entry point to @@ -33,7 +28,6 @@ the device driver. The device driver might have to adjust the shape of data structures before exporting them to a user thread which supports a different data model. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_MODEL_ILP32\fR \fR @@ -62,12 +56,9 @@ entry point. .RE .SH CONTEXT -.sp -.LP The \fBddi_mmap_get_model()\fR function can only be called from the \fBmmap\fR(9E) driver entry point. .SH EXAMPLES -.LP \fBExample 1 \fR: Using \fBddi_mmap_get_model()\fR .sp .LP @@ -111,8 +102,6 @@ xxmmap(dev_t dev, off_t off, int prot) { .in -2 .SH SEE ALSO -.sp -.LP \fBmmap\fR(9E), \fBddi_model_convert_from\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_model_convert_from.9f b/usr/src/man/man9f/ddi_model_convert_from.9f index 752ee456d5..a67b5c8bf4 100644 --- a/usr/src/man/man9f/ddi_model_convert_from.9f +++ b/usr/src/man/man9f/ddi_model_convert_from.9f @@ -7,7 +7,6 @@ .SH NAME ddi_model_convert_from \- determine data model type mismatch .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -16,11 +15,8 @@ ddi_model_convert_from \- determine data model type mismatch .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImodel\fR \fR @@ -30,11 +26,9 @@ The data model type of the current thread. .RE .SH DESCRIPTION -.sp -.LP \fBddi_model_convert_from()\fR is used to determine if the current thread uses a different \fBC\fR Language Type Model than the device driver. The 64-bit -version of Solaris will require a 64-bit kernel to support both 64-bit and +version of illumos will require a 64-bit kernel to support both 64-bit and 32-bit user mode programs. The difference between a 32-bit program and a 64-bit program is in its \fBC\fR Language Type Model: a 32-bit program is \fBILP32\fR (integer, longs, and pointers are 32-bit) and a 64-bit program is \fBLP64\fR @@ -48,7 +42,6 @@ the format of the data before sending it to a 32-bit application. between the device driver and the application requires reformatting to any non-native data model. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_MODEL_ILP32\fR \fR @@ -67,11 +60,8 @@ No conversion is necessary. Current thread and driver use the same data model. .RE .SH CONTEXT -.sp -.LP \fBddi_model_convert_from()\fR can be called from any context. .SH EXAMPLES -.LP \fBExample 1 \fR: Using \fBddi_model_convert_from()\fR in the \fBioctl()\fR entry point to support both 32-bit and 64-bit applications. .sp @@ -117,8 +107,6 @@ xxioctl(dev_t dev, int cmd, intptr_t arg, int mode, .in -2 .SH SEE ALSO -.sp -.LP \fBioctl\fR(9E), \fBmmap\fR(9E), \fBddi_mmap_get_model\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_modopen.9f b/usr/src/man/man9f/ddi_modopen.9f index 8574de81fe..aa88d65b86 100644 --- a/usr/src/man/man9f/ddi_modopen.9f +++ b/usr/src/man/man9f/ddi_modopen.9f @@ -8,7 +8,6 @@ ddi_modopen, ddi_modsym, ddi_modclose \- dynamically-loaded kernel module functions .SH SYNOPSIS -.LP .nf #include <sys/modctl.h> @@ -28,11 +27,8 @@ functions .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImodname\fR\fR @@ -94,8 +90,6 @@ Symbol's name as a character string. .RE .SH DESCRIPTION -.sp -.LP The function prototypes for \fBddi_modopen()\fR, \fBddi_modsym()\fR, and \fBddi_modclose()\fR are modeled after the userland \fBlibdl\fR(3LIB), \fBdlopen\fR(3C), \fBdlsym\fR(3C), and \fBdlclose\fR(3C) interfaces, however @@ -163,8 +157,6 @@ panic). When the last \fBddi_modclose()\fR of a module occurs, and there are no further references to the module, the module \fB_fini\fR(9E)entry point may be called. If \fB_fini\fR returns success then the module may be unloaded. .SH RETURN VALUES -.sp -.LP The \fBddi_modopen()\fR function returns a handle to the dynamically-loaded kernel module. The \fBddi_modopen()\fR function returns \fBNULL\fR if the module cannot be found, the object cannot be relocated, or an error occurs @@ -183,11 +175,8 @@ When either \fBddi_modopen()\fR or \fBddi_modsym()\fR return \fBNULL\fR, additional \fIerrno\fR information related to the failure is returned in \fI*errnop\fR if it is not \fBNULL\fR. .SH CONTEXT -.sp -.LP \fBddi_modopen()\fR can be called from user context only. .SH EXAMPLES -.LP \fBExample 1 \fRCoding a Dynamically Loaded Kernel Module .sp .LP @@ -299,8 +288,6 @@ rv = ddi_modclose(modp); .in -2 .SH SEE ALSO -.sp -.LP \fBdlclose\fR(3C), \fBdlopen\fR(3C), \fBdlsym\fR(3C), \fBlibdl\fR(3LIB), \fBboot\fR(1M), \fBelfwrap\fR(1), \fBmodload\fR(1M), \fBsystem\fR(4), \fB_fini\fR(9E), \fB_info\fR(9E), \fB_init\fR(9E) @@ -308,8 +295,6 @@ rv = ddi_modclose(modp); .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP A \fBsystem\fR(4)forceload must be established for modules targeted by \fBddi_modopen()\fR by code involved in the mount of root on "bootdev" during machine \fBboot\fR(1M). diff --git a/usr/src/man/man9f/ddi_no_info.9f b/usr/src/man/man9f/ddi_no_info.9f index 1315cf73b9..21d97e53d5 100644 --- a/usr/src/man/man9f/ddi_no_info.9f +++ b/usr/src/man/man9f/ddi_no_info.9f @@ -7,7 +7,6 @@ .SH NAME ddi_no_info \- stub for getinfo(9E) .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ ddi_no_info \- stub for getinfo(9E) .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fBdev_info_t *\fIdip\fR\fR @@ -61,18 +57,12 @@ Pointer to where the requested information is stored. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_no_info()\fR function always returns \fBDDI_FAILURE\fR. It is provided as a convenience routine for drivers not providing a \fBcb_ops\fR(9S) or for network drivers only providing DLPI-2 services. Such drivers can use \fBddi_no_info()\fR in the \fBdevo_getinfo\fR entry point (see \fBgetinfo\fR(9E)) of the \fBdev_ops\fR(9S) structure. .SH RETURN VALUES -.sp -.LP The \fBddi_no_info()\fR function always returns \fBDDI_FAILURE\fR. .SH SEE ALSO -.sp -.LP \fBgetinfo\fR(9E), \fBqassociate\fR(9F), \fBcb_ops\fR(9S), \fBdev_ops\fR(9S) diff --git a/usr/src/man/man9f/ddi_node_name.9f b/usr/src/man/man9f/ddi_node_name.9f index 898569fd27..01bc4f3aa9 100644 --- a/usr/src/man/man9f/ddi_node_name.9f +++ b/usr/src/man/man9f/ddi_node_name.9f @@ -8,7 +8,6 @@ .SH NAME ddi_node_name \- return the devinfo node name .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ ddi_node_name \- return the devinfo node name .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -33,23 +29,15 @@ A pointer the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_node_name()\fR function returns the device node name contained in the \fBdev_info\fR node pointed to by \fIdip\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_node_name()\fR function returns the device node name contained in the \fBdev_info\fR structure. .SH CONTEXT -.sp -.LP The \fBddi_node_name()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBddi_binding_name\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_peek.9f b/usr/src/man/man9f/ddi_peek.9f index b1a8e0cf2a..160e9b17de 100644 --- a/usr/src/man/man9f/ddi_peek.9f +++ b/usr/src/man/man9f/ddi_peek.9f @@ -8,7 +8,6 @@ ddi_peek, ddi_peek8, ddi_peek16, ddi_peek32, ddi_peek64, ddi_peekc, ddi_peeks, ddi_peekl, ddi_peekd \- read a value from a location .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -34,14 +33,11 @@ ddi_peekl, ddi_peekd \- read a value from a location .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_peekc()\fR, \fBddi_peeks()\fR, +illumos DDI specific (illumos DDI). The \fBddi_peekc()\fR, \fBddi_peeks()\fR, \fBddi_peekl()\fR, and \fBddi_peekd()\fR functions are obsolete. Use, respectively, \fBddi_peek8()\fR, \fBddi_peek16()\fR, \fBddi_peek32()\fR, and \fBddi_peek64()\fR, instead. .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -70,8 +66,6 @@ the value read from the location will simply be discarded. .RE .SH DESCRIPTION -.sp -.LP These routines cautiously attempt to read a value from a specified virtual address, and return the value to the caller, using the parent nexus driver to assist in the process where necessary. @@ -85,7 +79,6 @@ The routines are most useful when first trying to establish the presence of a device on the system in a driver's \fBprobe\fR(9E) or \fBattach\fR(9E) routines. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_SUCCESS\fR\fR @@ -106,11 +99,8 @@ unchanged. .RE .SH CONTEXT -.sp -.LP These functions can be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRChecking to see that the status register of a device is mapped into the kernel address space: .sp @@ -157,15 +147,11 @@ failure: .in -2 .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBprobe\fR(9E), \fBddi_poke\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The functions described in this manual page previously used symbolic names which specified their data access size; the function names have been changed so they now specify a fixed-width data size. See the following table for the new diff --git a/usr/src/man/man9f/ddi_periodic_add.9f b/usr/src/man/man9f/ddi_periodic_add.9f index 72b7430190..bdd433e14e 100644 --- a/usr/src/man/man9f/ddi_periodic_add.9f +++ b/usr/src/man/man9f/ddi_periodic_add.9f @@ -8,7 +8,6 @@ .SH NAME ddi_periodic_add \- request periodic function invocation .SH SYNOPSIS -.LP .nf #include <sys/dditypes.h> #include <sys/sunddi.h> @@ -18,8 +17,7 @@ ddi_periodic_add \- request periodic function invocation .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -65,7 +63,6 @@ pre-defined macro (\fBDDI_IPL_0\fR, ... , \fBDDI_IPL_10\fR), or the .RE .SH DESCRIPTION -.LP The \fBddi_periodic_add()\fR function schedules the specified function to be periodically invoked in the nanosecond interval time. .sp @@ -76,16 +73,13 @@ approximation. If the callback function has not finished execution when the next interval expires, the system will skip running the callback for that interval. .SH RETURN VALUES -.LP \fBddi_periodic_add()\fR returns the non-zero opaque value (\fBddi_periodic_t\fR), which is later used to cancel the periodic request with \fBddi_periodic_delete\fR(9F). .SH CONTEXT -.LP The \fBddi_periodic_add()\fR function may be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBddi_periodic_add()\fR for a periodic callback function .sp .LP @@ -163,12 +157,10 @@ invoked in interrupt context at level 7. .in -2 .SH SEE ALSO -.LP \fBcv_timedwait\fR(9F), \fBddi_intr_get_pri\fR(9F), \fBddi_periodic_delete\fR(9F), \fBddi_intr_get_softint_pri\fR(9F), \fBqtimeout\fR(9F), \fBquntimeout\fR(9F), \fBtimeout\fR(9F), \fBuntimeout\fR(9F) .SH NOTES -.LP The caller must specify \fIinterval\fR as an even, non-zero multiple of 10ms. No other values are supported at this time. The interval specified is a lower bound on the interval between executions of the callback. diff --git a/usr/src/man/man9f/ddi_periodic_delete.9f b/usr/src/man/man9f/ddi_periodic_delete.9f index 84cd2d8990..e33fac515a 100644 --- a/usr/src/man/man9f/ddi_periodic_delete.9f +++ b/usr/src/man/man9f/ddi_periodic_delete.9f @@ -9,7 +9,6 @@ .SH NAME ddi_periodic_delete \- cancel periodic function invocation requests .SH SYNOPSIS -.LP .nf #include <sys/dditypes.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ ddi_periodic_delete \- cancel periodic function invocation requests .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIrequest\fR\fR @@ -32,8 +28,6 @@ Solaris DDI specific (Solaris DDI) .RE .SH DESCRIPTION -.sp -.LP The \fBddi_periodic_delete()\fR function cancels a periodic invocation request previously established with \fBddi_periodic_add\fR(9F). .sp @@ -54,12 +48,9 @@ acquired by the callback function must not be held across the call to The callback will not be invoked again after the call to \fBddi_periodic_delete()\fR returns. .SH CONTEXT -.sp -.LP The \fBddi_periodic_delete()\fR function may be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRCancelling a periodic invocation request .sp .LP @@ -113,13 +104,9 @@ my_periodic_func(void *arg) .in -2 .SH SEE ALSO -.sp -.LP \fBcv_timedwait\fR(9F), \fBddi_intr_get_pri\fR(9F), \fBddi_periodic_add\fR(9F), \fBqtimeout\fR(9F), \fBquntimeout\fR(9F), \fBtimeout\fR(9F), \fBuntimeout\fR(9F) .SH NOTES -.sp -.LP Historically this interface was advertised as safe for use from within the periodic callback function. In order to ensure the correct operation of the system, and as reflected in the documentation above, this unlikely (and diff --git a/usr/src/man/man9f/ddi_poke.9f b/usr/src/man/man9f/ddi_poke.9f index 2809917ced..ec6813275b 100644 --- a/usr/src/man/man9f/ddi_poke.9f +++ b/usr/src/man/man9f/ddi_poke.9f @@ -8,7 +8,6 @@ ddi_poke, ddi_poke8, ddi_poke16, ddi_poke32, ddi_poke64, ddi_pokec, ddi_pokes, ddi_pokel, ddi_poked \- write a value to a location .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -34,14 +33,11 @@ ddi_pokel, ddi_poked \- write a value to a location .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_pokec()\fR, \fBddi_pokes()\fR, +illumos DDI specific (illumos DDI). The \fBddi_pokec()\fR, \fBddi_pokes()\fR, \fBddi_pokel()\fR, and \fBddi_poked()\fR functions are obsolete. Use, respectively, \fBddi_poke8()\fR, \fBddi_poke16()\fR, \fBddi_poke32()\fR, and \fBddi_poke64()\fR, instead. .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -69,8 +65,6 @@ Value to be written to the location. .RE .SH DESCRIPTION -.sp -.LP These routines cautiously attempt to write a value to a specified virtual address, using the parent nexus driver to assist in the process where necessary. @@ -88,7 +82,6 @@ routines. On multiprocessing machines these routines can be extremely heavy-weight, so use the \fBddi_peek\fR(9F) routines instead if possible. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_SUCCESS\fR\fR @@ -107,19 +100,13 @@ An error occurred while trying to write to the location. .RE .SH CONTEXT -.sp -.LP These functions can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBprobe\fR(9E), \fBddi_peek\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The functions described in this manual page previously used symbolic names which specified their data access size; the function names have been changed so they now specify a fixed-width data size. See the following table for the new diff --git a/usr/src/man/man9f/ddi_prop_create.9f b/usr/src/man/man9f/ddi_prop_create.9f index cfc26835c2..884f83f390 100644 --- a/usr/src/man/man9f/ddi_prop_create.9f +++ b/usr/src/man/man9f/ddi_prop_create.9f @@ -41,7 +41,7 @@ drivers .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI). The \fBddi_prop_create()\fR and +illumos DDI specific (illumos DDI). The \fBddi_prop_create()\fR and \fBddi_prop_modify()\fR functions are obsolete. Use \fBddi_prop_update\fR(9F) instead of these functions. .SH PARAMETERS diff --git a/usr/src/man/man9f/ddi_prop_exists.9f b/usr/src/man/man9f/ddi_prop_exists.9f index f88fcfe9c5..4f545ea541 100644 --- a/usr/src/man/man9f/ddi_prop_exists.9f +++ b/usr/src/man/man9f/ddi_prop_exists.9f @@ -7,7 +7,6 @@ .SH NAME ddi_prop_exists \- check for the existence of a property .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ ddi_prop_exists \- check for the existence of a property .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImatch_dev\fR \fR @@ -81,8 +77,6 @@ String containing the name of the property. .RE .SH DESCRIPTION -.sp -.LP \fBddi_prop_exists()\fR checks for the existence of a property regardless of the property value data type. .sp @@ -137,16 +131,11 @@ the only way to look up this property is with a \fImatch_dev\fR set to .LP \fIname\fR must always be set to the name of the property being looked up. .SH RETURN VALUES -.sp -.LP \fBddi_prop_exists()\fR returns \fB1\fR if the property exists and \fB0\fR otherwise. .SH CONTEXT -.sp -.LP These functions can be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fR: Using \fBddi_prop_exists()\fR .sp .LP @@ -168,8 +157,6 @@ The following example demonstrates the use of \fBddi_prop_exists()\fR. .in -2 .SH SEE ALSO -.sp -.LP \fBddi_prop_get_int\fR(9F), \fBddi_prop_lookup\fR(9F), \fBddi_prop_remove\fR(9F), \fBddi_prop_update\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_prop_get_int.9f b/usr/src/man/man9f/ddi_prop_get_int.9f index b5fcaf613f..2bd50ae67e 100644 --- a/usr/src/man/man9f/ddi_prop_get_int.9f +++ b/usr/src/man/man9f/ddi_prop_get_int.9f @@ -7,7 +7,6 @@ .SH NAME ddi_prop_get_int, ddi_prop_get_int64 \- lookup integer property .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -25,7 +24,6 @@ ddi_prop_get_int, ddi_prop_get_int64 \- lookup integer property .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fImatch_dev\fR\fR @@ -91,12 +89,8 @@ An integer value that is returned if the property cannot be found. .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBddi_prop_get_int()\fR and \fBddi_prop_get_int64()\fR functions search for an integer property and, if found, returns the value of the property. .sp @@ -160,19 +154,14 @@ property. .LP \fBddi_prop_get_int64()\fR will not search the PROM for 64-bit property values. .SH RETURN VALUES -.sp -.LP \fBddi_prop_get_int()\fR and \fBddi_prop_get_int64()\fR return the value of the property. If the property is not found, the argument \fBdefvalue\fR is returned. If the property is found, but cannot be decoded into an \fBint\fR or an \fBint64\fR, then \fBDDI_PROP_NOT_FOUND\fR is returned. .SH CONTEXT -.sp -.LP \fBddi_prop_get_int()\fR and \fBddi_prop_get_int64()\fR can be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBddi_prop_get_int()\fR .sp .LP @@ -181,7 +170,7 @@ The following example demonstrates the use of \fBddi_prop_get_int()\fR. .sp .in +2 .nf -\fB +\fB /* * Get the value of the integer "width" property, using * our own default if no such property exists @@ -192,8 +181,6 @@ The following example demonstrates the use of \fBddi_prop_get_int()\fR. .in -2 .SH SEE ALSO -.sp -.LP \fBddi_prop_exists\fR(9F), \fBddi_prop_lookup\fR(9F), \fBddi_prop_remove\fR(9F), \fBddi_prop_update\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_prop_lookup.9f b/usr/src/man/man9f/ddi_prop_lookup.9f index c371ee8d3a..8b89c7cb14 100644 --- a/usr/src/man/man9f/ddi_prop_lookup.9f +++ b/usr/src/man/man9f/ddi_prop_lookup.9f @@ -9,7 +9,6 @@ ddi_prop_lookup, ddi_prop_lookup_int_array, ddi_prop_lookup_int64_array, ddi_prop_lookup_string_array, ddi_prop_lookup_string, ddi_prop_lookup_byte_array, ddi_prop_free \- look up property information .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -50,7 +49,6 @@ ddi_prop_lookup_byte_array, ddi_prop_free \- look up property information .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fImatch_dev\fR\fR @@ -185,12 +183,8 @@ point to memory containing the byte array value of the property. .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The property look up routines search for and, if found, return the value of a given property. Properties are searched for based on the \fIdip\fR, \fIname\fR, \fImatch_dev\fR, and the type of the data (integer, string, or byte). The @@ -349,8 +343,6 @@ Frees the resources associated with a property previously allocated using .RE .SH RETURN VALUES -.sp -.LP The functions \fBddi_prop_lookup_int_array()\fR, \fBddi_prop_lookup_int64_array()\fR, \fBddi_prop_lookup_string_array()\fR, \fBddi_prop_lookup_string()\fR, and \fBddi_prop_lookup_byte_array()\fR return @@ -403,11 +395,8 @@ The value of the property cannot be decoded. .RE .SH CONTEXT -.sp -.LP These functions can be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBddi_prop_lookup_int_array()\fR .sp .LP @@ -417,7 +406,7 @@ The following example demonstrates the use of .sp .in +2 .nf - + int *options; int noptions; @@ -441,8 +430,6 @@ int noptions; .in -2 .SH SEE ALSO -.sp -.LP \fBexecve\fR(2), \fBddi_prop_exists\fR(9F), \fBddi_prop_get_int\fR(9F), \fBddi_prop_remove\fR(9F), \fBddi_prop_undefine\fR(9F), \fBddi_prop_update\fR(9F) diff --git a/usr/src/man/man9f/ddi_prop_op.9f b/usr/src/man/man9f/ddi_prop_op.9f index 64b7b3958e..87dfd0294c 100644 --- a/usr/src/man/man9f/ddi_prop_op.9f +++ b/usr/src/man/man9f/ddi_prop_op.9f @@ -8,7 +8,6 @@ ddi_prop_op, ddi_getprop, ddi_getlongprop, ddi_getlongprop_buf, ddi_getproplen \- get property information for leaf device drivers .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/ddi.h> @@ -45,16 +44,13 @@ ddi_prop_op, ddi_getprop, ddi_getlongprop, ddi_getlongprop_buf, ddi_getproplen .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_getlongprop()\fR, +illumos DDI specific (illumos DDI). The \fBddi_getlongprop()\fR, \fBddi_getlongprop_buf()\fR, \fBddi_getprop()\fR, and \fBddi_getproplen()\fR functions are obsolete. Use \fBddi_prop_lookup\fR(9F) instead of \fBddi_getlongprop()\fR, \fBddi_getlongprop_buf()\fR, and \fBddi_getproplen()\fR. Use \fBddi_prop_get_int\fR(9F) instead of \fBddi_getprop()\fR .SH PARAMETERS -.sp .ne 2 .na \fB\fIdev\fR\fR @@ -161,8 +157,6 @@ The value that \fBddi_getprop()\fR returns if the property is not found. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_prop_op()\fR function gets arbitrary-size properties for leaf devices. The routine searches the device's property list. If it does not find the property at the device level, it examines the \fIflags\fR argument, and if @@ -242,8 +236,6 @@ The \fBddi_getproplen()\fR function returns the length of a given property. It is a convenience wrapper for \fBddi_prop_op()\fR with \fIprop_op\fR set to \fBPROP_LEN\fR. .SH RETURN VALUES -.sp -.LP The \fBddi_prop_op()\fR, \fBddi_getlongprop()\fR, \fBddi_getlongprop_buf()\fR, and \fBddi_getproplen()\fR functions return: .sp @@ -302,14 +294,10 @@ The value of the property or the value passed into the routine as \fIdefvalue\fR if the property is not found. By convention, the value of zero length properties (boolean properties) are returned as the integer value 1. .SH CONTEXT -.sp -.LP These functions can be called from user, interrupt, or kernel context, provided \fBDDI_PROP_CANSLEEP\fR is not set; if it is set, they cannot be called from interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -326,8 +314,6 @@ T} .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_prop_create\fR(9F), \fBddi_prop_get_int\fR(9F), \fBddi_prop_lookup\fR(9F), \fBkmem_alloc\fR(9F), \fBkmem_free\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_prop_update.9f b/usr/src/man/man9f/ddi_prop_update.9f index 16156f8a1f..3a322ae094 100644 --- a/usr/src/man/man9f/ddi_prop_update.9f +++ b/usr/src/man/man9f/ddi_prop_update.9f @@ -10,7 +10,6 @@ ddi_prop_update_string_array, ddi_prop_update_int64, ddi_prop_update_int64_array, ddi_prop_update_string, ddi_prop_update_byte_array \- update properties .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -58,7 +57,6 @@ ddi_prop_update_int64_array, ddi_prop_update_string, ddi_prop_update_byte_array .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIdev\fR \fR @@ -182,12 +180,8 @@ A pointer to a byte array with which to update the property. .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The property update routines search for and, if found, modify the value of a given property. Properties are searched for based on the \fIdip\fR, \fIname\fR, \fIdev\fR, and the type of the data (integer, string, or byte). The driver @@ -297,8 +291,6 @@ pointer to a byte array with which to update the property. The property update routines may block to allocate memory needed to hold the value of the property. .SH RETURN VALUES -.sp -.LP All of the property update routines return: .sp .ne 2 @@ -329,11 +321,8 @@ If the bytes of the property cannot be encoded. .RE .SH CONTEXT -.sp -.LP These functions can only be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRUpdating Properties .sp .LP @@ -359,8 +348,6 @@ int options[4]; .in -2 .SH SEE ALSO -.sp -.LP \fBexecve\fR(2), \fBattach\fR(9E), \fBddi_prop_lookup\fR(9F), \fBddi_prop_remove\fR(9F), \fBmakedevice\fR(9F) .sp diff --git a/usr/src/man/man9f/ddi_put8.9f b/usr/src/man/man9f/ddi_put8.9f index ae1bfe2ae2..052053ca99 100644 --- a/usr/src/man/man9f/ddi_put8.9f +++ b/usr/src/man/man9f/ddi_put8.9f @@ -9,7 +9,6 @@ ddi_put8, ddi_put16, ddi_put32, ddi_put64, ddi_putb, ddi_putl, ddi_putll, ddi_putw \- write data to the mapped memory address, device register or allocated DMA memory address .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -39,15 +38,12 @@ allocated DMA memory address .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_putb()\fR, \fBddi_putl()\fR, +illumos DDI specific (illumos DDI). The \fBddi_putb()\fR, \fBddi_putl()\fR, \fBddi_putll()\fR, and \fBddi_putw()\fR functions are obsolete. The \fBddi_put8()\fR function replaces \fBddi_putb()\fR. The \fBddi_put32()\fR function replaces \fBddi_putl()\fR. The \fBddi_put64()\fR function replaces \fBddi_putll()\fR. The \fBddi_put16()\fR function replaces \fBddi_putw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -76,8 +72,6 @@ Base device address. .RE .SH DESCRIPTION -.sp -.LP These routines generate a write of various sizes to the mapped memory or device register. The \fBddi_put8()\fR, \fBddi_put16()\fR, \fBddi_put32()\fR, and \fBddi_put64()\fR functions write 8 bits, 16 bits, 32 bits and 64 bits of data, @@ -96,12 +90,8 @@ high-interrupt context. These types include \fBISA\fR and SBus buses. See you can, under certain conditions, call these \fBDDI\fR functions from a high-interrupt context. See \fBpci\fR(4). .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -118,7 +108,5 @@ T} .TE .SH SEE ALSO -.sp -.LP \fBddi_get8\fR(9F), \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F), \fBddi_rep_get8\fR(9F), \fBddi_rep_put8\fR(9F), \fBddi_device_acc_attr\fR(9S) diff --git a/usr/src/man/man9f/ddi_regs_map_free.9f b/usr/src/man/man9f/ddi_regs_map_free.9f index 4f09d2c099..30eaf344bb 100644 --- a/usr/src/man/man9f/ddi_regs_map_free.9f +++ b/usr/src/man/man9f/ddi_regs_map_free.9f @@ -7,7 +7,6 @@ .SH NAME ddi_regs_map_free \- free a previously mapped register address space .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ ddi_regs_map_free \- free a previously mapped register address space .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris \fBDDI\fR specific (Solaris \fBDDI\fR). +illumos \fBDDI\fR specific (illumos \fBDDI\fR). .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR \fR @@ -33,19 +29,13 @@ routine such as \fBddi_regs_map_setup\fR(9F). .RE .SH DESCRIPTION -.sp -.LP \fBddi_regs_map_free()\fR frees the mapping represented by the data access handle \fIhandle\fR. This function is provided for drivers preparing to detach themselves from the system, allowing them to release allocated system resources represented in the handle. .SH CONTEXT -.sp -.LP \fBddi_regs_map_free()\fR must be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -60,8 +50,6 @@ Architecture PCI Local Bus, SBus, ISA .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_regs_map_setup\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/ddi_regs_map_setup.9f b/usr/src/man/man9f/ddi_regs_map_setup.9f index 4494150244..8f48138dbd 100644 --- a/usr/src/man/man9f/ddi_regs_map_setup.9f +++ b/usr/src/man/man9f/ddi_regs_map_setup.9f @@ -8,7 +8,6 @@ .SH NAME ddi_regs_map_setup \- set up a mapping for a register address space .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -21,8 +20,7 @@ ddi_regs_map_setup \- set up a mapping for a register address space .fi .SH INTERFACE LEVEL -.LP -Solaris \fBDDI\fR specific (Solaris \fBDDI\fR). +illumos \fBDDI\fR specific (illumos \fBDDI\fR). .SH PARAMETERS .ne 2 .na @@ -94,7 +92,6 @@ Pointer to a data access handle. .RE .SH DESCRIPTION -.LP \fBddi_regs_map_setup()\fR maps in the register set given by \fIrnumber\fR. The register number determines which register set is mapped if more than one exists. @@ -136,7 +133,6 @@ devices, see \fBpci\fR(4). For PCI express devices, see \fBpcie\fR(4). For ISA devices, see \fBisa\fR(4). For cardbus, see \fBcardbus\fR(4). For SBus devices, see \fBsbus\fR(4). .SH RETURN VALUES -.LP \fBddi_regs_map_setup()\fR returns: .sp .ne 2 @@ -183,10 +179,8 @@ platforms. Also, there is potential overlap between \fBDDI_ME_RNUMBER_RANGE\fR and \fBDDI_FAILURE\fR. Drivers should check for \fB!=DDI_SUCCESS\fR rather than checking for a specific failure value. .SH CONTEXT -.LP \fBddi_regs_map_setup()\fR must be called from user or kernel context. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -201,7 +195,6 @@ Architecture PCI Local Bus, SBus, ISA .TE .SH SEE ALSO -.LP \fBcardbus\fR(4), \fBisa\fR(4), \fBpci\fR(4), \fBpcie\fR(4), \fBsbus\fR(4), \fBattributes\fR(5), \fBddi_regs_map_free\fR(9F), \fBddi_device_acc_attr\fR(9S) .sp diff --git a/usr/src/man/man9f/ddi_remove_event_handler.9f b/usr/src/man/man9f/ddi_remove_event_handler.9f index f46282b99c..5ad077876c 100644 --- a/usr/src/man/man9f/ddi_remove_event_handler.9f +++ b/usr/src/man/man9f/ddi_remove_event_handler.9f @@ -7,7 +7,6 @@ .SH NAME ddi_remove_event_handler \- remove an NDI event service callback handler .SH SYNOPSIS -.LP .nf #include <sys/dditypes.h> #include <sys/sunddi.h> @@ -16,11 +15,8 @@ ddi_remove_event_handler \- remove an NDI event service callback handler .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fBddi_registration_id_t \fR\fIid\fR\fR @@ -31,14 +27,11 @@ upon successful registration. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_remove_event_handler()\fR function removes the callback handler specified by the registration \fIid\fR (\fBddi_registration_id_t\fR). Upon successful removal, the callback handler is removed from the system and will not be invoked in the face of the event. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_SUCCESS\fR\fR @@ -57,13 +50,9 @@ Failed to remove callback handler. .RE .SH CONTEXT -.sp -.LP The \fBddi_remove_event_handler()\fR function can be called from user and kernel contexts only. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -78,15 +67,11 @@ Stability Level Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_add_event_handler\fR(9F), \fBddi_get_eventcookie\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Device drivers must remove all registered callback handlers before \fBdetach\fR(9E) processing for that device instance is complete. diff --git a/usr/src/man/man9f/ddi_remove_minor_node.9f b/usr/src/man/man9f/ddi_remove_minor_node.9f index bf8cc9e709..51f412777a 100644 --- a/usr/src/man/man9f/ddi_remove_minor_node.9f +++ b/usr/src/man/man9f/ddi_remove_minor_node.9f @@ -12,7 +12,7 @@ ddi_remove_minor_node \- remove a minor node for this dev_info .fi .SH INTERFACE LEVEL -Solaris \fBDDI\fR specific (Solaris \fBDDI\fR). +illumos \fBDDI\fR specific (illumos \fBDDI\fR). .SH PARAMETERS .ne 2 .na diff --git a/usr/src/man/man9f/ddi_removing_power.9f b/usr/src/man/man9f/ddi_removing_power.9f index 138818b9a1..28c2856657 100644 --- a/usr/src/man/man9f/ddi_removing_power.9f +++ b/usr/src/man/man9f/ddi_removing_power.9f @@ -8,7 +8,6 @@ ddi_removing_power \- check whether \fBDDI_SUSPEND\fR might result in power being removed from a device .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,12 +18,8 @@ being removed from a device .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBddi_removing_power()\fR function indicates whether a currently pending call into a driver's \fBdetach\fR(9E) entry point with a command of \fBDDI_SUSPEND\fR is likely to result in power being removed from the device. @@ -33,8 +28,6 @@ call into a driver's \fBdetach\fR(9E) entry point with a command of \fBddi_removing_power()\fR can return true and power still not be removed from the device due to a failure to suspend and power off the system. .SH PARAMETERS -.sp -.LP The \fBddi_removing_power()\fR function supports the following parameter: .sp .ne 2 @@ -46,8 +39,6 @@ pointer to the device's \fBdev_info\fR structure .RE .SH RETURN VALUES -.sp -.LP The \fBddi_removing_power()\fR function returns: .sp .ne 2 @@ -70,7 +61,6 @@ Power will not be removed by the framework as a result of the pending .RE .SH EXAMPLES -.LP \fBExample 1 \fRProtecting a Tape from Abrupt Power Removal .sp .LP @@ -99,8 +89,6 @@ int .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -115,8 +103,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBcpr\fR(7), \fBattach\fR(9E), \fBdetach\fR(9E) .sp .LP diff --git a/usr/src/man/man9f/ddi_rep_get8.9f b/usr/src/man/man9f/ddi_rep_get8.9f index 40607c5667..22a3e5e63a 100644 --- a/usr/src/man/man9f/ddi_rep_get8.9f +++ b/usr/src/man/man9f/ddi_rep_get8.9f @@ -9,7 +9,6 @@ ddi_rep_get8, ddi_rep_get16, ddi_rep_get32, ddi_rep_get64, ddi_rep_getw, ddi_rep_getl, ddi_rep_getll, ddi_rep_getb \- read data from the mapped memory address, device register or allocated DMA memory address .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -39,16 +38,13 @@ address, device register or allocated DMA memory address .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_rep_getb()\fR, +illumos DDI specific (illumos DDI). The \fBddi_rep_getb()\fR, \fBddi_rep_getl()\fR, \fBddi_rep_getll()\fR, and \fBddi_rep_getw()\fR functions are obsolete. The \fBddi_rep_get8()\fR function replaces \fBddi_rep_getb()\fR. The \fBddi_rep_get32()\fR function replaces \fBddi_rep_getl()\fR. The \fBddi_rep_get64()\fR function replaces \fBddi_rep_getll()\fR. The \fBddi_rep_get16()\fR function replaces \fBddi_rep_getw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -114,8 +110,6 @@ Do not advance the device address, \fIdev_addr\fR, during data accesses. .RE .SH DESCRIPTION -.sp -.LP These routines generate multiple reads from the mapped memory or device register. \fIrepcount\fR data is copied from the device address, \fIdev_addr\fR, to the host address, \fIhost_addr\fR. For each input datum, the @@ -139,16 +133,10 @@ device and increment its address on the next input datum. However, when the will be used for every datum access. For example, this flag may be useful when reading from a data register. .SH RETURN VALUES -.sp -.LP These functions return the value read from the mapped address. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -165,7 +153,5 @@ T} .TE .SH SEE ALSO -.sp -.LP \fBddi_get8\fR(9F), \fBddi_put8\fR(9F), \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F), \fBddi_rep_put8\fR(9F) diff --git a/usr/src/man/man9f/ddi_rep_put8.9f b/usr/src/man/man9f/ddi_rep_put8.9f index b0066c9720..602d459e69 100644 --- a/usr/src/man/man9f/ddi_rep_put8.9f +++ b/usr/src/man/man9f/ddi_rep_put8.9f @@ -9,7 +9,6 @@ ddi_rep_put8, ddi_rep_put16, ddi_rep_put32, ddi_rep_put64, ddi_rep_putb, ddi_rep_putw, ddi_rep_putl, ddi_rep_putll \- write data to the mapped memory address, device register or allocated DMA memory address .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -39,16 +38,13 @@ address, device register or allocated DMA memory address .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBddi_rep_putb()\fR, +illumos DDI specific (illumos DDI). The \fBddi_rep_putb()\fR, \fBddi_rep_putl()\fR, \fBddi_rep_putll()\fR, and \fBddi_rep_putw()\fR functions are obsolete. The \fBddi_rep_put8()\fR function replaces \fBddi_rep_putb()\fR. The \fBddi_rep_put32()\fR function replaces \fBddi_rep_putl()\fR. The \fBddi_rep_put64()\fR function replaces \fBddi_rep_putll()\fR. The \fBddi_rep_put16()\fR function replaces \fBddi_rep_putw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -114,8 +110,6 @@ Do not advance the device address, \fIdev_addr\fR, during data accesses. .RE .SH DESCRIPTION -.sp -.LP These routines generate multiple writes to the mapped memory or device register. \fIrepcount\fR data is copied from the host address, \fIhost_addr\fR, to the device address, \fIdev_addr\fR. For each input datum, the @@ -139,12 +133,8 @@ device and increment its address on the next input datum. However, when the address will be used for every datum access. For example, this flag may be useful when writing to a data register. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -161,8 +151,6 @@ T} .TE .SH SEE ALSO -.sp -.LP \fBddi_get8\fR(9F), \fBddi_put8\fR(9F), \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F), \fBddi_rep_get8\fR(9F), \fBddi_device_acc_attr\fR(9S) diff --git a/usr/src/man/man9f/ddi_report_dev.9f b/usr/src/man/man9f/ddi_report_dev.9f index e9b4b458f4..b391c63cf0 100644 --- a/usr/src/man/man9f/ddi_report_dev.9f +++ b/usr/src/man/man9f/ddi_report_dev.9f @@ -7,7 +7,6 @@ .SH NAME ddi_report_dev \- announce a device .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ ddi_report_dev \- announce a device .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR \fR @@ -33,19 +29,13 @@ a pointer the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fBddi_report_dev()\fR prints a banner at boot time, announcing the device pointed to by \fIdip\fR. The banner is always placed in the system logfile (displayed by \fBdmesg\fR(1M)), but is only displayed on the console if the system was booted with the verbose (\fB-v\fR) argument. .SH CONTEXT -.sp -.LP \fBddi_report_dev()\fR can be called from user context. .SH SEE ALSO -.sp -.LP \fBdmesg\fR(1M), \fBkernel\fR(1M) .sp .LP diff --git a/usr/src/man/man9f/ddi_root_node.9f b/usr/src/man/man9f/ddi_root_node.9f index 397b780be9..1f6529d775 100644 --- a/usr/src/man/man9f/ddi_root_node.9f +++ b/usr/src/man/man9f/ddi_root_node.9f @@ -7,7 +7,6 @@ .SH NAME ddi_root_node \- get the root of the dev_info tree .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -19,25 +18,15 @@ ddi_root_node \- get the root of the dev_info tree .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBddi_root_node()\fR function returns a pointer to the root node of the device information tree. .SH RETURN VALUES -.sp -.LP The \fBddi_root_node()\fR function returns a pointer to a device information structure. .SH CONTEXT -.sp -.LP The \fBddi_root_node()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_slaveonly.9f b/usr/src/man/man9f/ddi_slaveonly.9f index cd7e11d3d3..70ea8ce18f 100644 --- a/usr/src/man/man9f/ddi_slaveonly.9f +++ b/usr/src/man/man9f/ddi_slaveonly.9f @@ -7,7 +7,6 @@ .SH NAME ddi_slaveonly \- tell if a device is installed in a slave access only location .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ ddi_slaveonly \- tell if a device is installed in a slave access only location .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -33,14 +29,11 @@ A pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_slaveonly()\fR function tells the caller if the bus, or part of the bus that the device is installed on, does not permit the device to become a DMA master, that is, whether the device has been installed in a slave access only slot. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBDDI_SUCCESS\fR\fR @@ -59,11 +52,7 @@ The device has not been installed in a slave access only location. .RE .SH CONTEXT -.sp -.LP The \fBddi_slaveonly()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_soft_state.9f b/usr/src/man/man9f/ddi_soft_state.9f index e841b827f3..86c227d9ff 100644 --- a/usr/src/man/man9f/ddi_soft_state.9f +++ b/usr/src/man/man9f/ddi_soft_state.9f @@ -10,7 +10,6 @@ ddi_soft_state, ddi_get_soft_state, ddi_soft_state_fini, ddi_soft_state_free, ddi_soft_state_init, ddi_soft_state_zalloc \- driver soft state utility routines .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -41,11 +40,8 @@ routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIstate_p\fR\fR @@ -95,8 +91,6 @@ associated devinfo node. .RE .SH DESCRIPTION -.sp -.LP Most device drivers maintain state information with each instance of the device they control; for example, a soft copy of a device control register, a mutex that must be held while accessing a piece of hardware, a partition table, or a @@ -151,8 +145,6 @@ The \fBddi_soft_state_zalloc()\fR, \fBddi_soft_state_free()\fR and \fBddi_get_soft_state()\fR routines coordinate access to the underlying data structures in an MT-safe fashion, thus no additional locks should be necessary. .SH RETURN VALUES -.sp -.LP \fBddi_get_soft_state()\fR .sp .ne 2 @@ -218,8 +210,6 @@ allocate an item number that was already allocated. .RE .SH CONTEXT -.sp -.LP The \fBddi_soft_state_init()\fR and \fBddi_soft_state_alloc()\fR functions can be called from user or kernel context only, since they may internally call \fBkmem_zalloc\fR(9F) with the \fBKM_SLEEP\fR flag. @@ -228,7 +218,6 @@ be called from user or kernel context only, since they may internally call The \fBddi_soft_state_fini()\fR, \fBddi_soft_state_free()\fR and \fBddi_get_soft_state()\fR routines can be called from any driver context. .SH EXAMPLES -.LP \fBExample 1 \fRCreating and Removing Data Structures .sp .LP @@ -284,7 +273,7 @@ xxattach(dev_info_t *dip, ddi_attach_cmd_t cmd) if (ddi_soft_state_zalloc(statep, instance) != DDI_SUCCESS) return (DDI_FAILURE); softc = ddi_get_soft_state(statep, instance); - softc->dip = dip; + softc->dip = dip; ... return (DDI_SUCCESS); default: @@ -328,28 +317,20 @@ xxopen(dev_t *devp, int flag, int otyp, cred_t *cred_p) .in -2 .SH SEE ALSO -.sp -.LP \fB_fini\fR(9E), \fB_init\fR(9E), \fBattach\fR(9E), \fBdetach\fR(9E), \fBddi_get_instance\fR(9F), \fBgetminor\fR(9F), \fBkmem_zalloc\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP There is no attempt to validate the \fBitem\fR parameter given to \fBddi_soft_state_zalloc()\fR other than it must be a positive signed integer. Therefore very large item numbers may cause the driver to hang forever waiting for virtual memory resources that can never be satisfied. .SH NOTES -.sp -.LP If necessary, a hierarchy of state structures can be constructed by embedding state pointers in higher order state structures. .SH DIAGNOSTICS -.sp -.LP All of the messages described below usually indicate bugs in the driver and should not appear in normal operation of the system. .sp diff --git a/usr/src/man/man9f/ddi_strtol.9f b/usr/src/man/man9f/ddi_strtol.9f index 102e332e7c..69dcf2e7ed 100644 --- a/usr/src/man/man9f/ddi_strtol.9f +++ b/usr/src/man/man9f/ddi_strtol.9f @@ -7,7 +7,6 @@ .SH NAME ddi_strtol \- String conversion routines .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -17,11 +16,8 @@ ddi_strtol \- String conversion routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIstr\fR \fR @@ -58,8 +54,6 @@ Pointer to variable which contains the converted value. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_strtol()\fR function converts the initial portion of the string pointed to by \fIstr\fR to a type \fBlong\fR int representation and stores the converted value in result. @@ -132,8 +126,6 @@ If the subject sequence is empty or does not have the expected form, no conversion is performed and the value of \fIstr\fR is stored in the object pointed to by \fIendptr\fR, provided that \fIendptr\fR is not a null pointer. .SH RETURN VALUES -.sp -.LP Upon successful completion, \fBddi_strtol()\fR returns \fB0\fR and stores the converted value in \fIresult\fR. If no conversion is performed due to invalid \fIbase\fR, \fBddi_strtol()\fR returns \fBEINVAL\fR and the variable pointed by @@ -144,11 +136,7 @@ If the correct value is outside the range of representable values, \fBddi_strtol()\fR returns \fBERANGE\fR and the value pointed to by \fIresult\fR is not changed. .SH CONTEXT -.sp -.LP The \fBddi_strtol()\fR function may be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_strtoll.9f b/usr/src/man/man9f/ddi_strtoll.9f index 8067a65bae..bd45002a89 100644 --- a/usr/src/man/man9f/ddi_strtoll.9f +++ b/usr/src/man/man9f/ddi_strtoll.9f @@ -47,7 +47,6 @@ .SH NAME ddi_strtoll, ddi_strtoull \- string conversion functions .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -63,7 +62,6 @@ ddi_strtoll, ddi_strtoull \- string conversion functions .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIstr\fR\fR @@ -100,12 +98,8 @@ pointer to variable which contains the converted value .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBddi_strtoll()\fR function converts the initial portion of the string pointed to by \fIstr\fR to a type \fBlonglong_t\fR representation and stores the converted value in \fIresult\fR. @@ -184,19 +178,13 @@ If the subject sequence is empty or does not have the expected form, no conversion is performed and the value of \fIstr\fR is stored in the object pointed to by \fIendptr\fR, provided that \fIendptr\fR is not a null pointer. .SH RETURN VALUES -.sp -.LP Upon successful completion, these functions return 0 and store the converted value in \fIresult\fR. If no conversion is performed due to an invalid base, these functions return \fBEINVAL\fR and the variable pointed by \fIresult\fR is not changed. .SH CONTEXT -.sp -.LP These functions may be called from user, kernel or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -211,6 +199,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_strtoul.9f b/usr/src/man/man9f/ddi_strtoul.9f index 7093ba8d2c..18ce641edd 100644 --- a/usr/src/man/man9f/ddi_strtoul.9f +++ b/usr/src/man/man9f/ddi_strtoul.9f @@ -7,7 +7,6 @@ .SH NAME ddi_strtoul \- String conversion functions .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -17,11 +16,8 @@ ddi_strtoul \- String conversion functions .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIstr\fR \fR @@ -58,8 +54,6 @@ Pointer to variable which contains the converted value. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_strtoul()\fR function converts the initial portion of the string pointed to by \fIstr\fR to a type \fBunsigned long\fR int representation and stores the converted value in \fIresult\fR. @@ -132,8 +126,6 @@ If the subject sequence is empty or does not have the expected form, no conversion is performed and the value of \fIstr\fR is stored in the object pointed to by \fIendptr\fR, provided that \fIendptr\fR is not a null pointer. .SH RETURN VALUES -.sp -.LP Upon successful completion, \fBddi_strtoul()\fR returns \fB0\fR and stores the converted value in \fIresult\fR. If no conversion is performed due to invalid \fIbase\fR, \fBddi_strtoul()\fR returns \fBEINVAL\fR and the variable pointed @@ -144,11 +136,7 @@ If the correct value is outside the range of representable values, \fBddi_strtoul()\fR returns \fBERANGE\fR and the value pointed to by \fIresult\fR is not changed. .SH CONTEXT -.sp -.LP The \fBddi_strtoul()\fR function may be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/ddi_umem_alloc.9f b/usr/src/man/man9f/ddi_umem_alloc.9f index 07ea3c63b6..113f87583f 100644 --- a/usr/src/man/man9f/ddi_umem_alloc.9f +++ b/usr/src/man/man9f/ddi_umem_alloc.9f @@ -8,7 +8,6 @@ .SH NAME ddi_umem_alloc, ddi_umem_free \- allocate and free page-aligned kernel memory .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/sunddi.h> @@ -23,12 +22,9 @@ ddi_umem_alloc, ddi_umem_free \- allocate and free page-aligned kernel memory .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .SS "ddi_umem_alloc()" -.sp .ne 2 .na \fB\fIsize\fR\fR @@ -63,7 +59,6 @@ Pointer to a kernel memory cookie. .RE .SS "ddi_umem_free()" -.sp .ne 2 .na \fB\fIcookie\fR\fR @@ -73,8 +68,6 @@ A kernel memory cookie allocated in \fBddi_umem_alloc()\fR. .RE .SH DESCRIPTION -.sp -.LP \fBddi_umem_alloc()\fR allocates page-aligned kernel memory and returns a pointer to the allocated memory. The number of bytes allocated is a multiple of the system page size (roundup of \fIsize\fR). The allocated memory can be used @@ -101,7 +94,6 @@ To free the allocated memory, a driver calls \fBddi_umem_free()\fR with the cookie obtained from \fBddi_umem_alloc()\fR. \fBddi_umem_free()\fR releases the entire buffer. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBNon-null\fR\fR @@ -122,23 +114,17 @@ Memory cannot be allocated by \fBddi_umem_alloc()\fR because .RE .SH CONTEXT -.sp -.LP \fBddi_umem_alloc()\fR can be called from any context if \fIflag\fR is set to \fBDDI_UMEM_NOSLEEP.\fR If \fBDDI_UMEM_SLEEP\fR is set, \fBddi_umem_alloc()\fR can be called from user and kernel context only. \fBddi_umem_free()\fR can be called from any context. .SH SEE ALSO -.sp -.LP \fBdevmap\fR(9E), \fBcondvar\fR(9F), \fBdevmap_umem_setup\fR(9F), \fBkmem_alloc\fR(9F), \fBmutex\fR(9F), \fBrwlock\fR(9F), \fBsemaphore\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP Setting the \fBDDI_UMEM_PAGEABLE\fR flag in \fBddi_umem_alloc()\fR will result in an allocation of pageable memory. Because these pages can be swapped out to secondary memory devices, drivers should use this flag with care. This memory @@ -178,7 +164,5 @@ Do not call \fBddi_umem_alloc()\fR within \fBDDI_SUSPEND\fR and \fBDDI_RESUME\fR operations. Memory acquired at these times is not reliable. In some cases, such a call can cause a system to hang. .SH NOTES -.sp -.LP \fBddi_umem_alloc(0,\fR \fIflag\fR, \fIcookiep\fR\fB)\fR always returns \fBNULL.\fR \fBddi_umem_free(NULL)\fR has no effects on system. diff --git a/usr/src/man/man9f/ddi_umem_iosetup.9f b/usr/src/man/man9f/ddi_umem_iosetup.9f index 082be2b78a..2256980b7a 100644 --- a/usr/src/man/man9f/ddi_umem_iosetup.9f +++ b/usr/src/man/man9f/ddi_umem_iosetup.9f @@ -7,24 +7,20 @@ .SH NAME ddi_umem_iosetup \- Setup I/O requests to application memory .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> -\fBstruct buf *\fR\fBddi_umem_iosetup\fR(\fBddi_umem_cookie_t\fR \fIcookie,\fRoff_t off, - size_t \fIlen\fR, int \fIdirection\fR, dev_t \fIdev\fR, daddr_t \fIblkno\fR, +\fBstruct buf *\fR\fBddi_umem_iosetup\fR(\fBddi_umem_cookie_t\fR \fIcookie,\fRoff_t off, + size_t \fIlen\fR, int \fIdirection\fR, dev_t \fIdev\fR, daddr_t \fIblkno\fR, int (*iodone) (struct buf *), int \fIsleepflag\fR); .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIcookie\fR \fR @@ -101,8 +97,6 @@ available. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_umem_iosetup\fR(9F) function is used by drivers to setup I/O requests to application memory which has been locked down using \fBddi_umem_lock\fR(9F). @@ -143,18 +137,12 @@ The \fIsleepflag \fR parameter determines if the caller can sleep for memory. After the I/O has completed and the buffer structure is no longer needed, the driver calls \fBfreerbuf\fR(9F) to free the buffer structure. .SH RETURN VALUES -.sp -.LP The \fBddi_umem_iosetup\fR(9F) function returns a pointer to the initialized buffer header, or \fBNULL\fR if no space is available. .SH CONTEXT -.sp -.LP The \fBddi_umem_iosetup\fR(9F) function can be called from any context only if flag is set to \fBDDI_UMEM_NOSLEEP\fR. If \fBDDI_UMEM_SLEEP\fR is set, \fBddi_umem_iosetup\fR(9F) can be called from user and kernel context only. .SH SEE ALSO -.sp -.LP \fBddi_umem_lock\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBfreerbuf\fR(9F), \fBphysio\fR(9F), \fBbuf\fR(9S) diff --git a/usr/src/man/man9f/ddi_umem_lock.9f b/usr/src/man/man9f/ddi_umem_lock.9f index dc7598870a..bc8689cd6d 100644 --- a/usr/src/man/man9f/ddi_umem_lock.9f +++ b/usr/src/man/man9f/ddi_umem_lock.9f @@ -7,7 +7,6 @@ .SH NAME ddi_umem_lock, ddi_umem_unlock \- lock and unlock memory pages .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -22,12 +21,9 @@ ddi_umem_lock, ddi_umem_unlock \- lock and unlock memory pages .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .SS "ddi_umem_lock" -.sp .ne 2 .na \fB\fIaddr\fR\fR @@ -82,7 +78,6 @@ Pointer to a kernel memory cookie. .RE .SS "ddi_umem_unlock" -.sp .ne 2 .na \fBcookie\fR @@ -92,8 +87,6 @@ Kernel memory cookie allocated by \fBddi_umem_lock()\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBddi_umem_lock()\fR function locks down the physical pages (including I/O pages) that correspond to the current process' virtual address range [\fIaddr\fR, \fIaddr\fR + \fIsize\fR) and fills in a cookie representing the @@ -125,8 +118,6 @@ pages are locked down by the device driver. The device driver must ensure that the physical pages have been unlocked after the application has called \fBclose\fR(2). .SH RETURN VALUES -.sp -.LP On success, a \fB0\fR is returned. Otherwise, one of the following \fBerrno\fR values is returned. .sp @@ -177,18 +168,12 @@ Requested memory is not aligned on a system page boundary. .RE .SH CONTEXT -.sp -.LP The \fBddi_umem_lock()\fR function can only be called from user context; \fBddi_umem_unlock()\fR from user, kernel, and interrupt contexts. .SH SEE ALSO -.sp -.LP \fBddi_umem_iosetup\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBdevmap_umem_setup\fR(9F), \fBddi_umem_alloc\fR(9F) .SH NOTES -.sp -.LP The \fBddi_umem_unlock()\fR function consumes physical memory. The driver is responsible for a speedy unlock to free up the resources. .sp diff --git a/usr/src/man/man9f/devmap_default_access.9f b/usr/src/man/man9f/devmap_default_access.9f index 9e34bbcb06..200a15c387 100644 --- a/usr/src/man/man9f/devmap_default_access.9f +++ b/usr/src/man/man9f/devmap_default_access.9f @@ -7,7 +7,6 @@ .SH NAME devmap_default_access \- default driver memory access function .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ devmap_default_access \- default driver memory access function .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdhp\fR \fR @@ -77,8 +73,6 @@ Type of access. .RE .SH DESCRIPTION -.sp -.LP \fBdevmap_default_access()\fR is a function providing the semantics of \fBdevmap_access\fR(9E). The drivers call \fBdevmap_default_access()\fR to handle the mappings that do not support context switching. The drivers should @@ -91,7 +85,6 @@ or be used as the \fBdevmap_access\fR(9E) entry point. The arguments \fIdhp\fR, \fIpvtp\fR, \fIoff\fR, \fIlen\fR, \fItype\fR, and \fIrw\fR are provided by the \fBdevmap_access\fR(9E) entry point and must not be modified. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR \fR @@ -110,12 +103,9 @@ An error occurred. .RE .SH CONTEXT -.sp -.LP \fBdevmap_default_access()\fR must be called from the driver's \fBdevmap_access\fR(9E) entry point. .SH EXAMPLES -.LP \fBExample 1 \fRUsing devmap_default_access in devmap_access. .sp .LP @@ -186,8 +176,6 @@ xxdevmap_access(devmap_cookie_t dhp, void *pvtp, offset_t off, .in -2 .SH SEE ALSO -.sp -.LP \fBdevmap_access\fR(9E), \fBdevmap_do_ctxmgt\fR(9F), \fBdevmap_callback_ctl\fR(9S) .sp diff --git a/usr/src/man/man9f/devmap_devmem_setup.9f b/usr/src/man/man9f/devmap_devmem_setup.9f index b7c36e8087..6a914399ca 100644 --- a/usr/src/man/man9f/devmap_devmem_setup.9f +++ b/usr/src/man/man9f/devmap_devmem_setup.9f @@ -7,7 +7,6 @@ .SH NAME devmap_devmem_setup, devmap_umem_setup \- set driver memory mapping parameters .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -29,12 +28,8 @@ devmap_devmem_setup, devmap_umem_setup \- set driver memory mapping parameters .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP \fBdevmap_devmem_setup()\fR parameters: .sp .ne 2 @@ -343,8 +338,6 @@ release. Reserved for future use. .RE .SH DESCRIPTION -.sp -.LP The \fBdevmap_devmem_setup()\fR and \fBdevmap_umem_setup()\fR functions are used in the \fBdevmap\fR(9E) entry point to pass mapping parameters from the driver to the system. @@ -438,7 +431,6 @@ Drivers use \fBdevmap_umem_setup()\fR to export the kernel memory allocated by address that is aligned with the kernel virtual address being mapped to avoid cache incoherence if the mapping is not \fBMAP_FIXED.\fR .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR\fR @@ -457,13 +449,9 @@ An error occurred. .RE .SH CONTEXT -.sp -.LP \fBdevmap_devmem_setup()\fR and \fBdevmap_umem_setup()\fR can be called from user, kernel, and interrupt context. .SH SEE ALSO -.sp -.LP \fBexit\fR(2), \fBfork\fR(2), \fBmmap\fR(2), \fBmunmap\fR(2), \fBdevmap\fR(9E), \fBddi_umem_alloc\fR(9F), \fBddi_device_acc_attr\fR(9S), \fBdevmap_callback_ctl\fR(9S) diff --git a/usr/src/man/man9f/devmap_do_ctxmgt.9f b/usr/src/man/man9f/devmap_do_ctxmgt.9f index 06ec004ad2..4c2229fa82 100644 --- a/usr/src/man/man9f/devmap_do_ctxmgt.9f +++ b/usr/src/man/man9f/devmap_do_ctxmgt.9f @@ -7,7 +7,6 @@ .SH NAME devmap_do_ctxmgt \- perform device context switching on a mapping .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -21,11 +20,8 @@ devmap_do_ctxmgt \- perform device context switching on a mapping .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdhp\fR \fR @@ -92,8 +88,6 @@ modified. .RE .SH DESCRIPTION -.sp -.LP Device drivers call \fBdevmap_do_ctxmgt()\fR in the \fBdevmap_access\fR(9E) entry point to perform device context switching on a mapping. \fBdevmap_do_ctxmgt()\fR passes a pointer to a driver supplied callback @@ -117,7 +111,6 @@ actual device context switching. The return value from \fBdevmap_contextmgt\fR(9E) will be returned directly to \fBdevmap_do_ctxmgt()\fR. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR \fR @@ -136,12 +129,9 @@ An error occurred. .RE .SH CONTEXT -.sp -.LP \fBdevmap_do_ctxmgt()\fR must be called from the driver's \fBdevmap_access\fR(9E) entry point. .SH EXAMPLES -.LP \fBExample 1 \fRUsing devmap_do_ctxmgt in the devmap_access entry point. .sp .LP @@ -212,8 +202,6 @@ xxdevmap_access(devmap_cookie_t dhp, void *pvtp, offset_t off, .in -2 .SH SEE ALSO -.sp -.LP \fBdevmap_access\fR(9E), \fBdevmap_contextmgt\fR(9E), \fBdevmap_default_access\fR(9F) .sp diff --git a/usr/src/man/man9f/devmap_set_ctx_timeout.9f b/usr/src/man/man9f/devmap_set_ctx_timeout.9f index 9699da21e7..614971ec8f 100644 --- a/usr/src/man/man9f/devmap_set_ctx_timeout.9f +++ b/usr/src/man/man9f/devmap_set_ctx_timeout.9f @@ -8,7 +8,6 @@ devmap_set_ctx_timeout \- set the timeout value for the context management callback .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ callback .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdhp\fR\fR @@ -43,8 +39,6 @@ management callback function. .RE .SH DESCRIPTION -.sp -.LP The \fBdevmap_set_ctx_timeout()\fR function specifies the time interval for the system to wait between successive calls to the driver's context management callback function, \fBdevmap_contextmgt\fR(9E). @@ -56,11 +50,7 @@ Device drivers typically call \fBdevmap_set_ctx_timeout()\fR in the value of \fB0\fR will result in no delay between successive calls to the driver's \fBdevmap_contextmgt\fR(9E) callback function. .SH CONTEXT -.sp -.LP The \fBdevmap_set_ctx_timeout()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBdevmap_contextmgt\fR(9E), \fBdevmap_map\fR(9E), \fBtimeout\fR(9F) diff --git a/usr/src/man/man9f/devmap_setup.9f b/usr/src/man/man9f/devmap_setup.9f index 2c0182899b..2f77b7240e 100644 --- a/usr/src/man/man9f/devmap_setup.9f +++ b/usr/src/man/man9f/devmap_setup.9f @@ -8,7 +8,6 @@ devmap_setup, ddi_devmap_segmap \- set up a user mapping to device memory using the devmap framework .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -28,11 +27,8 @@ the devmap framework .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdev\fR \fR @@ -192,8 +188,6 @@ Pointer to the user credential structure. .RE .SH DESCRIPTION -.sp -.LP \fBdevmap_setup()\fR and \fBddi_devmap_segmap()\fR allow device drivers to use the devmap framework to set up user mappings to device memory. The devmap framework provides several advantages over the default device mapping framework @@ -259,7 +253,6 @@ offset within the device address space. If the driver does not provide its own \fBdevmap\fR(9E) entry point, \fBEINVAL\fR will be returned to the \fBmmap\fR(2) system call. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR \fR @@ -280,13 +273,9 @@ entry point. .RE .SH CONTEXT -.sp -.LP \fBdevmap_setup()\fR and \fBddi_devmap_segmap()\fR can be called from user or kernel context only. .SH SEE ALSO -.sp -.LP \fBmmap\fR(2), \fBdevmap\fR(9E), \fBsegmap\fR(9E), \fBddi_segmap\fR(9F), \fBddi_segmap_setup\fR(9F), \fBcb_ops\fR(9S) .sp diff --git a/usr/src/man/man9f/devmap_unload.9f b/usr/src/man/man9f/devmap_unload.9f index 73694ba1aa..40a684c7de 100644 --- a/usr/src/man/man9f/devmap_unload.9f +++ b/usr/src/man/man9f/devmap_unload.9f @@ -7,7 +7,6 @@ .SH NAME devmap_unload, devmap_load \- control validation of memory address translations .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -24,11 +23,8 @@ devmap_unload, devmap_load \- control validation of memory address translations .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdhp\fR \fR @@ -57,7 +53,6 @@ Length (in bytes) of the range being affected. .RE .SS "devmap_load() only" -.sp .ne 2 .na \fB\fItype\fR \fR @@ -76,8 +71,6 @@ Direction of access. .RE .SH DESCRIPTION -.sp -.LP \fBdevmap_unload()\fR and \fBdevmap_load()\fR are used to control the validation of the memory mapping described by \fIdhp\fR in the specified range. \fBdevmap_unload()\fR invalidates the mapping translations and will generate @@ -116,7 +109,6 @@ A non-zero return value from either \fBdevmap_unload()\fR or may result in a \fBSIGSEGV\fR or \fBSIGBUS\fR signal being delivered to the process. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR \fR @@ -135,11 +127,8 @@ An error occurred. .RE .SH CONTEXT -.sp -.LP These routines can be called from user or kernel context only. .SH EXAMPLES -.LP \fBExample 1 \fRManaging a One-Page Device Context .sp .LP @@ -183,8 +172,6 @@ xxdevmap_contextmgt(devmap_cookie_t dhp, void *pvtp, offset_t off, .in -2 .SH SEE ALSO -.sp -.LP \fBdevmap_access\fR(9E), \fBdevmap_contextmgt\fR(9E) .sp .LP diff --git a/usr/src/man/man9f/disksort.9f b/usr/src/man/man9f/disksort.9f index b6943f5009..f7531a7c6f 100644 --- a/usr/src/man/man9f/disksort.9f +++ b/usr/src/man/man9f/disksort.9f @@ -7,7 +7,6 @@ .SH NAME disksort \- single direction elevator seek sort for buffers .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/ddi.h> @@ -18,11 +17,8 @@ void .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdp\fR\fR @@ -48,8 +44,6 @@ meaningful sort key value prior to calling \fBdisksort()\fR. .RE .SH DESCRIPTION -.sp -.LP The function \fBdisksort()\fR sorts a pointer to a buffer into a single forward linked list headed by the \fBav_forw\fR element of the argument \fI*dp\fR. .sp @@ -73,18 +67,12 @@ of the \fBav_back\fR structure element of the argument \fI*dp\fR. The maintain the forward linkage. The value at the head of the list presumably indicates the currently active disk area. .SH CONTEXT -.sp -.LP This function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBstrategy\fR(9E), \fBbuf\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP The \fBdisksort()\fR function does no locking. Therefore, any locking is completely the responsibility of the caller. diff --git a/usr/src/man/man9f/dlbindack.9f b/usr/src/man/man9f/dlbindack.9f index d1121b47d9..256dc9c6aa 100644 --- a/usr/src/man/man9f/dlbindack.9f +++ b/usr/src/man/man9f/dlbindack.9f @@ -8,7 +8,6 @@ dlbindack, dlphysaddrack, dlokack, dlerrorack, dluderrorind \- DLPI device driver helper functions .SH SYNOPSIS -.LP .nf #include <sys/dlpi.h> @@ -42,8 +41,7 @@ driver helper functions .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -146,7 +144,6 @@ in the \fBDLPI\fR request. .RE .SH DESCRIPTION -.LP All functions described in this manpage take a pointer to the message passed to the \fBDLPI\fR provider (\fBmblk_t\fR) and attempt to reuse it in formulating the \fBM_PROTO\fR reply. If the message block is too small to be reused, it is @@ -180,18 +177,14 @@ message reply used to complete the \fBDL_PHYS_ADDR_ACK\fR processing. The \fBdluderrorind()\fR function provides the \fBDL_UDERROR_IND\fR message reply used to complete an unsuccessful \fBDL_UNITDATA_REQ\fR. .SH RETURN VALUES -.LP None. .SH NOTES -.LP These functions are not required if you are are writing a \fBDLPI\fR device driver using \fBgld\fR(7D). .SH CONTEXT -.LP All \fBDLPI\fR helper functions can be called from user, interrupt, or kernel context. .SH SEE ALSO -.LP \fBgld\fR(7D), \fBdlpi\fR(7P), \fBqreply\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/esballoc.9f b/usr/src/man/man9f/esballoc.9f index dc93fa68ee..812e8255dd 100644 --- a/usr/src/man/man9f/esballoc.9f +++ b/usr/src/man/man9f/esballoc.9f @@ -54,9 +54,9 @@ allocate a message block using a caller-supplied buffer .sp .LP .nf -\fBesballoca()\fR: Solaris DDI specific (Solaris DDI) -\fBdesballoc()\fR: Solaris DDI specific (Solaris DDI) -\fBdesballoca()\fR: Solaris DDI specific (Solaris DDI) +\fBesballoca()\fR: illumos DDI specific (illumos DDI) +\fBdesballoc()\fR: illumos DDI specific (illumos DDI) +\fBdesballoca()\fR: illumos DDI specific (illumos DDI) .fi .SH PARAMETERS .ne 2 diff --git a/usr/src/man/man9f/gld.9f b/usr/src/man/man9f/gld.9f index b7eadc7177..8724f4c23d 100644 --- a/usr/src/man/man9f/gld.9f +++ b/usr/src/man/man9f/gld.9f @@ -51,7 +51,7 @@ gld_sched, gld_intr \- Generic LAN Driver service routines .fi .SH INTERFACE LEVEL -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS .ne 2 .na diff --git a/usr/src/man/man9f/hook_alloc.9f b/usr/src/man/man9f/hook_alloc.9f index 51e2525737..585f08ef6b 100644 --- a/usr/src/man/man9f/hook_alloc.9f +++ b/usr/src/man/man9f/hook_alloc.9f @@ -7,7 +7,6 @@ .SH NAME hook_alloc \- allocate a hook_t data structure .SH SYNOPSIS -.LP .nf #include <sys/hook.h> @@ -15,11 +14,8 @@ hook_alloc \- allocate a hook_t data structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIversion\fR\fR @@ -29,23 +25,15 @@ must always be the symbol \fBHOOK_VERSION\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBhook_alloc()\fR function allocates a \fBhook_t\fR structure, returning a pointer for the caller to use. .SH RETURN VALUES -.sp -.LP Upon success, \fBhook_alloc()\fR returns a pointer to the allocated \fIhook_t\fR structure. On failure, \fBhook_alloc()\fR returns a \fINULL\fR pointer. .SH CONTEXT -.sp -.LP The \fBhook_alloc()\fR function may be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -60,6 +48,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBhook_free\fR(9F), \fBhook_t\fR(9S) diff --git a/usr/src/man/man9f/hook_free.9f b/usr/src/man/man9f/hook_free.9f index f4fb38cac5..fd5f933af7 100644 --- a/usr/src/man/man9f/hook_free.9f +++ b/usr/src/man/man9f/hook_free.9f @@ -7,7 +7,6 @@ .SH NAME hook_free \- free a hook_t data structure .SH SYNOPSIS -.LP .nf #include <sys/hook.h> @@ -15,11 +14,8 @@ hook_free \- free a hook_t data structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIhook\fR\fR @@ -29,18 +25,12 @@ pointer returned by \fBhook_alloc\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBhook_free()\fR function frees a \fBhook_t\fR structure that was originally allocated by \fBhook_alloc\fR(9F). .SH CONTEXT -.sp -.LP The \fBhook_free()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -55,6 +45,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBhook_alloc\fR(9F), \fBhook_t\fR(9S) diff --git a/usr/src/man/man9f/id32_alloc.9f b/usr/src/man/man9f/id32_alloc.9f index a5a410247f..8503ab2049 100644 --- a/usr/src/man/man9f/id32_alloc.9f +++ b/usr/src/man/man9f/id32_alloc.9f @@ -7,7 +7,6 @@ .SH NAME id32_alloc, id32_free, id32_lookup \- 32-bit driver ID management routines .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/id32.h> @@ -28,11 +27,8 @@ id32_alloc, id32_free, id32_lookup \- 32-bit driver ID management routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIptr\fR\fR @@ -52,8 +48,6 @@ description) .RE .SH DESCRIPTION -.sp -.LP These routines were originally developed so that device drivers could manage 64-bit pointers on devices that save space only for 32-bit pointers. .sp @@ -65,7 +59,7 @@ initiated, the driver passes this token to the hardware. When the I/O completes the hardware passes back this 32-bit token. .sp .LP -Before Solaris supported 64-bit pointers, device drivers just passed a raw +Before illumos supported 64-bit pointers, device drivers just passed a raw 32-bit pointer to the hardware. When pointers grew to be 64 bits this was no longer possible. The \fBid32_*()\fR routines were created to help drivers translate between 64-bit pointers and a 32-bit token. @@ -87,15 +81,11 @@ valid. When \fBid32_lookup()\fR detects an invalid token it returns NULL. Calling routines should check for this return value so that they do not try to dereference a NULL pointer. .SH CONTEXT -.sp -.LP These functions can be called from user or interrupt context. The routine \fBid32_alloc()\fR should not be called from interrupt context when the \fBKM_SLEEP\fR flag is passed in. All other routines can be called from interrupt or kernel context. .SH SEE ALSO -.sp -.LP \fBkmem_alloc\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/kiconv.9f b/usr/src/man/man9f/kiconv.9f index 5812ff77f7..71c21890e1 100644 --- a/usr/src/man/man9f/kiconv.9f +++ b/usr/src/man/man9f/kiconv.9f @@ -7,7 +7,6 @@ .SH NAME kiconv \- buffer-based code conversion function .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/errno.h> @@ -20,12 +19,8 @@ kiconv \- buffer-based code conversion function .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP The parameters for the \fBkiconv\fR function are as follows: .sp .ne 2 @@ -130,8 +125,6 @@ The \fIcd\fR input parameter is not a valid open code conversion descriptor. .RE .SH DESCRIPTION -.sp -.LP The \fBkiconv()\fR function converts the sequence of characters from one \fBcodeset\fR, in the array specified by \fIinbuf\fR, into a sequence of corresponding characters in another \fBcodeset\fR, in the array specified by @@ -180,8 +173,6 @@ for which an identical character does not exist in the target \fBcodeset\fR, \fBkiconv()\fR performs an implementation-defined conversion (that is, a non-identical conversion) on this character. .SH RETURN VALUES -.sp -.LP The \fBkiconv()\fR function updates the variables pointed to by the parameters to reflect the extent of the conversion and returns the number of non-identical conversions performed. If the entire string in the input buffer is converted, @@ -191,11 +182,8 @@ stopped due to any conditions mentioned above, the value pointed to by If such and other error occurs, \fBkiconv()\fR returns (\fBsize_t\fR)-1 and sets \fIerrno\fR to indicate the error. .SH CONTEXT -.sp -.LP \fBkiconv()\fR can be called from user or interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRPerforming a Simple Conversion .sp .LP @@ -265,8 +253,6 @@ doconv_error_return: .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -281,8 +267,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBiconv\fR(3C), \fBiconv_close\fR(3C), \fBiconv_open\fR(3C), \fBu8_strcmp\fR(3C), \fBu8_textprep_str\fR(3C), \fBu8_validate\fR(3C), \fBuconv_u16tou32\fR(3C), \fBuconv_u16tou8\fR(3C), \fBuconv_u32tou16\fR(3C), @@ -299,7 +283,5 @@ The Unicode Standard: .LP http://www.unicode.org/standard/standard.html .SH NOTES -.sp -.LP The \fBiconv\fR(3C) man page also has a good example code that can be referenced. diff --git a/usr/src/man/man9f/kiconv_close.9f b/usr/src/man/man9f/kiconv_close.9f index 95859cced8..095cee4530 100644 --- a/usr/src/man/man9f/kiconv_close.9f +++ b/usr/src/man/man9f/kiconv_close.9f @@ -7,7 +7,6 @@ .SH NAME kiconv_close \- code conversion descriptor deallocation function .SH SYNOPSIS -.LP .nf #include <sys/errno.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ kiconv_close \- code conversion descriptor deallocation function .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIcd\fR\fR @@ -32,14 +28,10 @@ Code conversion descriptor to be deallocated. .RE .SH DESCRIPTION -.sp -.LP The \fBkiconv_close()\fR function deallocates the conversion descriptor \fIcd\fR and all other associated resources allocated by the \fBkiconv_open()\fR function. .SH RETURN VALUES -.sp -.LP Upon successful completion, \fBkiconv_close()\fR returns 0; otherwise, it returns the following \fIerrno\fR value to indicate the error: .sp @@ -52,11 +44,8 @@ The code conversion descriptor is invalid. .RE .SH CONTEXT -.sp -.LP \fBkiconv_close()\fR can be called from user or interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRClosing the Code Conversion .sp .LP @@ -86,8 +75,6 @@ error checking: .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -102,8 +89,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBiconv\fR(3C), \fBiconv_close\fR(3C), \fBiconv_open\fR(3C), \fBu8_strcmp\fR(3C), \fBu8_textprep_str\fR(3C), \fBu8_validate\fR(3C), \fBuconv_u16tou32\fR(3C), \fBuconv_u16tou8\fR(3C), \fBuconv_u32tou16\fR(3C), diff --git a/usr/src/man/man9f/kiconv_open.9f b/usr/src/man/man9f/kiconv_open.9f index 344bff45ec..45132541fb 100644 --- a/usr/src/man/man9f/kiconv_open.9f +++ b/usr/src/man/man9f/kiconv_open.9f @@ -7,7 +7,6 @@ .SH NAME kiconv_open \- code conversion descriptor allocation function .SH SYNOPSIS -.LP .nf #include <sys/sunddi.h> @@ -17,11 +16,8 @@ kiconv_open \- code conversion descriptor allocation function .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fItocode\fR\fR @@ -40,8 +36,6 @@ Points to a source codeset name string. .RE .SH DESCRIPTION -.sp -.LP The \fBkiconv_open()\fR function returns a code conversion descriptor that describes a conversion from the codeset specified by \fIfromcode\fR to the codeset specified by \fItocode\fR. For state-dependent encodings, the @@ -142,19 +136,14 @@ Aliases Original Name A conversion descriptor remains valid until it is closed by using \fBkiconv_close()\fR. .SH RETURN VALUES -.sp -.LP Upon successful completion, \fBkiconv_open()\fR returns a code conversion descriptor for use on subsequent calls to \fBkiconv()\fR. Otherwise, if the conversion specified by \fIfromcode\fR and \fItocode\fR is not supported or for any other reasons the code conversion descriptor cannot be allocated, \fBkiconv_open()\fR returns (\fBkiconv_t\fR)-1 to indicate the error. .SH CONTEXT -.sp -.LP \fBkiconv_open()\fR can be called from user context only. .SH EXAMPLES -.LP \fBExample 1 \fROpening a Code Conversion .sp .LP @@ -177,8 +166,6 @@ if (cd == (kiconv_t)-1) { .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -193,8 +180,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBiconv\fR(3C), \fBiconv_close\fR(3C), \fBiconv_open\fR(3C), \fBu8_strcmp\fR(3C), \fBu8_textprep_str\fR(3C), \fBu8_validate\fR(3C), \fBuconv_u16tou32\fR(3C), \fBuconv_u16tou8\fR(3C), \fBuconv_u32tou16\fR(3C), @@ -211,8 +196,6 @@ The Unicode Standard .LP http://www.unicode.org/standard/standard.html .SH NOTES -.sp -.LP The code conversions are available between \fBUTF-8\fR and the above noted \fIcodesets\fR. For example, to convert from \fBEUC-JP \fRto \fBShift_JIS\fR, first convert \fBEUC-JP\fR to \fBUTF-8\fR and then convert \fBUTF-8\fR to diff --git a/usr/src/man/man9f/kiconvstr.9f b/usr/src/man/man9f/kiconvstr.9f index 9dd5686a7c..5fa6c293f7 100644 --- a/usr/src/man/man9f/kiconvstr.9f +++ b/usr/src/man/man9f/kiconvstr.9f @@ -7,7 +7,6 @@ .SH NAME kiconvstr \- string-based code conversion function .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/errno.h> @@ -20,12 +19,8 @@ kiconvstr \- string-based code conversion function .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp -.LP The parameters for the \fBkiconvstr\fR function are as follows: .sp .ne 2 @@ -177,8 +172,6 @@ The requested conversion is not supported. .RE .SH DESCRIPTION -.sp -.LP The \fBkiconvstr()\fR function converts the sequence of characters from one \fBcodeset\fR, in the array specified by \fIinarray\fR, into a sequence of corresponding characters in another \fBcodeset\fR, in the array specified by @@ -218,8 +211,6 @@ array, instead of stopping the conversion, \fBkiconvstr()\fR treats such characters as if they are non-identical characters and does non-identical conversions on such character bytes. .SH RETURN VALUES -.sp -.LP The \fBkiconvstr()\fR function updates the values pointed to by the \fIinlen\fR and \fIoutlen\fR parameters to reflect the extent of the conversion and returns the number of non-identical conversions performed. If the entire string in the @@ -229,11 +220,8 @@ pointed to by \fIinlen\fR is non-zero and \fIerrno\fR is set to indicate the condition. If an error occurs, \fBkiconvstr()\fR returns (\fBsize_t\fR)-1 and sets \fIerrno\fR to indicate the error. .SH CONTEXT -.sp -.LP \fBkiconvstr()\fR can be called from user or interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRPerforming a Code Conversion .sp .LP @@ -293,8 +281,6 @@ if (ret == (size_t)-1) { .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -309,8 +295,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBiconv\fR(3C), \fBiconv_close\fR(3C), \fBiconv_open\fR(3C), \fBu8_strcmp\fR(3C), \fBu8_textprep_str\fR(3C), \fBu8_validate\fR(3C), \fBuconv_u16tou32\fR(3C), \fBuconv_u16tou8\fR(3C), \fBuconv_u32tou16\fR(3C), diff --git a/usr/src/man/man9f/kmem_cache_create.9f b/usr/src/man/man9f/kmem_cache_create.9f index d096223d90..73e3b67570 100644 --- a/usr/src/man/man9f/kmem_cache_create.9f +++ b/usr/src/man/man9f/kmem_cache_create.9f @@ -9,7 +9,6 @@ kmem_cache_create, kmem_cache_alloc, kmem_cache_free, kmem_cache_destroy, kmem_cache_set_move \- kernel memory cache allocator operations .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kmem.h> @@ -63,10 +62,8 @@ kmem_cache_set_move \- kernel memory cache allocator operations .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.LP The parameters for the \fBkmem_cache_*\fR functions are as follows: .sp .ne 2 @@ -299,7 +296,6 @@ typically a pointer to the \fBsoft-state\fR structure. .RE .SH DESCRIPTION -.LP In many cases, the cost of initializing and destroying an object exceeds the cost of allocating and freeing memory for it. The functions described here address this condition. @@ -562,7 +558,6 @@ it. .RE .SH CONTEXT -.LP Constructors can be invoked during any call to \fBkmem_cache_alloc()\fR, and will run in that context. Similarly, destructors can be invoked during any call to \fBkmem_cache_free()\fR, and can also be invoked during @@ -596,7 +591,6 @@ many clients register a \fBmove()\fR function, the allocator never tries to move more than one object at a time. Neither the allocator nor the client can be assumed to know the object's whereabouts at the time of the callback. .SH EXAMPLES -.LP \fBExample 1 \fRObject Caching .sp .LP @@ -715,7 +709,6 @@ kmem_cache_set_move(object_cache, object_move); .in -2 .SH RETURN VALUES -.LP If successful, the constructor function must return \fB0\fR. If KM_NOSLEEP is set and memory cannot be allocated without sleeping, the constructor must return -\fB1\fR. @@ -728,7 +721,6 @@ If successful, \fBkmem_cache_alloc()\fR returns a pointer to the allocated object. If \fBKM_NOSLEEP\fR is set and memory cannot be allocated without sleeping, \fBkmem_cache_alloc()\fR returns \fBNULL\fR. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -743,7 +735,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBcondvar\fR(9F), \fBkmem_alloc\fR(9F), \fBmutex\fR(9F), \fBkstat\fR(9S) .sp .LP @@ -758,7 +749,6 @@ J.; USENIX Summer 1994 Technical Conference (1994). Resources\fR, Bonwick, J. and Adams, J.; USENIX 2001 Technical Conference (2001). .SH NOTES -.LP The constructor must be immediately reversible by the destructor, since the allocator may call the constructor and destructor on objects still under its control at any time without client involvement. diff --git a/usr/src/man/man9f/kstat_create.9f b/usr/src/man/man9f/kstat_create.9f index 322b8d9d88..0df58c1c30 100644 --- a/usr/src/man/man9f/kstat_create.9f +++ b/usr/src/man/man9f/kstat_create.9f @@ -7,7 +7,6 @@ .SH NAME kstat_create \- create and initialize a new kstat .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -20,8 +19,7 @@ kstat_create \- create and initialize a new kstat .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -173,7 +171,6 @@ goes away. .RE .SH DESCRIPTION -.LP \fBkstat_create()\fR is used in conjunction with \fBkstat_install\fR(9F) to allocate and initialize a \fBkstat\fR(9S) structure. The method is generally as follows: @@ -198,14 +195,11 @@ have the \fBks_data\fR field set at this time. The provider may also set the Once the \fBkstat\fR is completely initialized, \fBkstat_install\fR(9F) is used to make the \fBkstat\fR accessible to the outside world. .SH RETURN VALUES -.LP If successful, \fBkstat_create()\fR returns a pointer to the allocated \fBkstat\fR. \fINULL\fR is returned upon failure. .SH CONTEXT -.LP \fBkstat_create()\fR can be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRAllocating and Initializing a \fBkstat\fR Structure .sp .in +2 @@ -220,7 +214,6 @@ pkstat_t *ksp; .in -2 .SH SEE ALSO -.LP \fBkstat\fR(3KSTAT), \fBddi_get_instance\fR(9F), \fBkstat_delete\fR(9F), \fBkstat_install\fR(9F), \fBkstat_named_init\fR(9F), \fBkstat\fR(9S), \fBkstat_named\fR(9S) diff --git a/usr/src/man/man9f/kstat_delete.9f b/usr/src/man/man9f/kstat_delete.9f index 5e9b11c522..b5d5dc4201 100644 --- a/usr/src/man/man9f/kstat_delete.9f +++ b/usr/src/man/man9f/kstat_delete.9f @@ -7,7 +7,6 @@ .SH NAME kstat_delete \- remove a kstat from the system .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -18,11 +17,8 @@ kstat_delete \- remove a kstat from the system .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIksp\fR \fR @@ -32,29 +28,19 @@ Pointer to a currently installed \fBkstat\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP \fBkstat_delete()\fR removes \fIksp\fR from the \fBkstat\fR chain and frees all associated system resources. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP \fBkstat_delete()\fR can be called from any context. .SH SEE ALSO -.sp -.LP \fBkstat_create\fR(9F), \fBkstat_install\fR(9F), \fBkstat_named_init\fR(9F), \fBkstat\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP When calling \fBkstat_delete()\fR, the driver must not be holding that \fBkstat\fR's \fBks_lock\fR. Otherwise, it may deadlock with a \fBkstat\fR reader. diff --git a/usr/src/man/man9f/kstat_install.9f b/usr/src/man/man9f/kstat_install.9f index 4324cf1797..22bffeb97a 100644 --- a/usr/src/man/man9f/kstat_install.9f +++ b/usr/src/man/man9f/kstat_install.9f @@ -7,7 +7,6 @@ .SH NAME kstat_install \- add a fully initialized kstat to the system .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -18,11 +17,8 @@ kstat_install \- add a fully initialized kstat to the system .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIksp\fR\fR @@ -32,8 +28,6 @@ Pointer to a fully initialized \fBkstat\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP \fBkstat_install()\fR is used in conjunction with \fBkstat_create\fR(9F) to allocate and initialize a \fBkstat\fR(9S) structure. .sp @@ -48,15 +42,10 @@ in a kstat of type \fBKSTAT_TYPE_NAMED\fR). Virtual kstats must have the Once the kstat is completely initialized, \fBkstat_install\fR is used to make the kstat accessible to the outside world. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP \fBkstat_install()\fR can be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRAllocating and Initializing a \fBkstat\fR Structure .sp .LP @@ -68,16 +57,14 @@ as follows: .nf kstat_t *ksp; ksp = kstat_create(module, instance, name, class, type, ndata, flags); -if (ksp) { - /* ... provider initialization, if necessary */ - kstat_install(ksp); +if (ksp) { + /* ... provider initialization, if necessary */ + kstat_install(ksp); } .fi .in -2 .SH SEE ALSO -.sp -.LP \fBkstat_create\fR(9F), \fBkstat_delete\fR(9F), \fBkstat_named_init\fR(9F), \fBkstat\fR(9S) .sp diff --git a/usr/src/man/man9f/kstat_named_init.9f b/usr/src/man/man9f/kstat_named_init.9f index b65e3809b3..6ede85f4b1 100644 --- a/usr/src/man/man9f/kstat_named_init.9f +++ b/usr/src/man/man9f/kstat_named_init.9f @@ -7,7 +7,6 @@ .SH NAME kstat_named_init, kstat_named_setstr \- initialize a named kstat .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -24,8 +23,7 @@ kstat_named_init, kstat_named_setstr \- initialize a named kstat .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -118,7 +116,6 @@ Pointer to a \fBNULL\fR-terminated string. .RE .SH DESCRIPTION -.LP \fBkstat_named_init()\fR associates a name and a type with a \fBkstat_named\fR(9S) structure. .sp @@ -131,14 +128,11 @@ persistent kstat the string argument must remain valid even after the module that created the kstat is unloaded. This is the only supported method of changing the value of long strings. .SH RETURN VALUES -.LP None. .SH CONTEXT -.LP \fBkstat_named_init()\fR and \fBkstat_named_setstr()\fR can be called from user or kernel context. .SH SEE ALSO -.LP \fBkstat_create\fR(9F), \fBkstat_install\fR(9F), \fBkstat\fR(9S), \fBkstat_named\fR(9S) .sp diff --git a/usr/src/man/man9f/kstat_queue.9f b/usr/src/man/man9f/kstat_queue.9f index e1a215b524..ec67b5e1cd 100644 --- a/usr/src/man/man9f/kstat_queue.9f +++ b/usr/src/man/man9f/kstat_queue.9f @@ -9,7 +9,6 @@ kstat_queue, kstat_waitq_enter, kstat_waitq_exit, kstat_runq_enter, kstat_runq_exit, kstat_waitq_to_runq, kstat_runq_back_to_waitq \- update I/O kstat statistics .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -45,8 +44,7 @@ kstat statistics .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -57,7 +55,6 @@ Pointer to a \fBkstat_io\fR(9S) structure. .RE .SH DESCRIPTION -.LP A large number of \fBI/O\fR subsystems have at least two basic "lists" (or queues) of transactions they manage: one for transactions that have been accepted for processing but for which processing has yet to begin, and one for @@ -133,18 +130,14 @@ example). .RE .SH RETURN VALUES -.LP None. .SH CONTEXT -.LP The \fBkstat_queue()\fR family of functions can be called from user or kernel context. .SH WARNINGS -.LP These transitions must be protected by holding the \fBkstat\fR's \fBks_lock\fR, and must be completely accurate (all transitions are recorded). Forgetting a transition may, for example, make an idle disk appear 100% busy. .SH SEE ALSO -.LP \fBbiodone\fR(9F), \fBdisksort\fR(9F), \fBkstat_create\fR(9F), \fBkstat_delete\fR(9F), \fBkstat_named_init\fR(9F), \fBkstat\fR(9S), \fBkstat_io\fR(9S) diff --git a/usr/src/man/man9f/ldi_ev_finalize.9f b/usr/src/man/man9f/ldi_ev_finalize.9f index 6b2ebae76e..bd695b511d 100644 --- a/usr/src/man/man9f/ldi_ev_finalize.9f +++ b/usr/src/man/man9f/ldi_ev_finalize.9f @@ -7,7 +7,6 @@ .SH NAME ldi_ev_finalize \- propagate disposition of a state change event .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -16,11 +15,8 @@ ldi_ev_finalize \- propagate disposition of a state change event .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdev_info_t *dip\fR\fR @@ -82,8 +78,6 @@ Event specific data. .RE .SH DESCRIPTION -.sp -.LP The \fBldi_ev_finalize()\fR function propagates the final disposition of an event up the software stack. It may result in two actions: .RS +4 @@ -112,15 +106,10 @@ cookie currently possessed by the layered driver. If that is the case, the layered driver must generate another event cookie via a new \fBldi_ev_get_cookie\fR(9F) call. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user and kernel contexts only. .SH EXAMPLES -.LP \fBExample 1 \fRInvoking ldi_ev_finalize(9F) from widget's finalize callback .sp .LP @@ -158,7 +147,5 @@ widget_finalize(ldi_handle_t lh, ldi_ev_cookie_t foo_cookie, .in -2 .SH SEE ALSO -.sp -.LP \fBldi_ev_get_cookie\fR(9F), \fBldi_ev_register_callbacks\fR(9F), \fBldi_ev_remove_callbacks\fR(9F) diff --git a/usr/src/man/man9f/ldi_ev_get_cookie.9f b/usr/src/man/man9f/ldi_ev_get_cookie.9f index 21fef65a05..c66b8af509 100644 --- a/usr/src/man/man9f/ldi_ev_get_cookie.9f +++ b/usr/src/man/man9f/ldi_ev_get_cookie.9f @@ -7,7 +7,6 @@ .SH NAME ldi_ev_get_cookie \- get an LDI event cookie for a specified event .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -16,11 +15,8 @@ ldi_ev_get_cookie \- get an LDI event cookie for a specified event .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIldi_handle_t lh\fR\fR @@ -53,8 +49,6 @@ on return. .RE .SH DESCRIPTION -.sp -.LP The \fBldi_ev_get_cookie()\fR function accepts the string name of a state change event affecting the device represented by the layered driver handle "\fBlh\fR" and returns an opaque cookie on success. The call is successful if @@ -91,8 +85,6 @@ The device is moving to the degraded state. for NDI event services. For such events, \fBldi_ev_get_cookie()\fR replaces \fBldi_get_eventcookie\fR(9F) (which is now obsolete). .SH RETURN VALUES -.sp -.LP The return values for this function are: .sp .ne 2 @@ -115,10 +107,6 @@ An error occurred and the cookie was not created. .RE .SH CONTEXT -.sp -.LP This function can be called from user and kernel contexts only. .SH SEE ALSO -.sp -.LP \fBldi_ev_register_callbacks\fR(9F), \fBldi_ev_remove_callbacks\fR(9F) diff --git a/usr/src/man/man9f/ldi_ev_get_type.9f b/usr/src/man/man9f/ldi_ev_get_type.9f index 50f4792bc1..811e74ed57 100644 --- a/usr/src/man/man9f/ldi_ev_get_type.9f +++ b/usr/src/man/man9f/ldi_ev_get_type.9f @@ -7,7 +7,6 @@ .SH NAME ldi_ev_get_type \- get event name string from event cookie .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -15,11 +14,8 @@ ldi_ev_get_type \- get event name string from event cookie .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIldi_ev_cookie_t cookie\fR\fR @@ -31,21 +27,13 @@ An opaque event cookie for the event type returned by a previous call to .RE .SH DESCRIPTION -.sp -.LP The \fBldi_ev_get_type()\fR function returns the event string represented by the \fBLDI\fR event cookie "\fBcookie\fR". .SH RETURN VALUES -.sp -.LP On success, this function returns the event string represented by "\fBcookie\fR". On failure, this function returns \fBNULL\fR. .SH CONTEXT -.sp -.LP This function can be called from user and kernel contexts only. .SH SEE ALSO -.sp -.LP \fBldi_ev_get_cookie\fR(9F), \fBldi_ev_register_callbacks\fR(9F), \fBldi_ev_remove_callbacks\fR(9F) diff --git a/usr/src/man/man9f/ldi_ev_notify.9f b/usr/src/man/man9f/ldi_ev_notify.9f index a38224a28c..9f28c5da2f 100644 --- a/usr/src/man/man9f/ldi_ev_notify.9f +++ b/usr/src/man/man9f/ldi_ev_notify.9f @@ -7,7 +7,6 @@ .SH NAME ldi_ev_notify \- propagate notification of a state change event .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -16,11 +15,8 @@ ldi_ev_notify \- propagate notification of a state change event .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdev_info_t *dip\fR\fR @@ -72,8 +68,6 @@ Event specific data. .RE .SH DESCRIPTION -.sp -.LP The \fBldi_ev_notify()\fR function propagates an event up the software stack. It may result in two actions: .RS +4 @@ -152,8 +146,6 @@ static int .in -2 .SH RETURN VALUES -.sp -.LP The return values for this function are: .sp .ne 2 @@ -176,11 +168,7 @@ Consumers are blocking the state change. .RE .SH CONTEXT -.sp -.LP This function can be called from user and kernel context only. .SH SEE ALSO -.sp -.LP \fBldi_ev_get_cookie\fR(9F), \fBldi_ev_register_callbacks\fR(9F), \fBldi_ev_remove_callbacks\fR(9F) diff --git a/usr/src/man/man9f/ldi_ev_register_callbacks.9f b/usr/src/man/man9f/ldi_ev_register_callbacks.9f index 07f41c8f2f..51193558f0 100644 --- a/usr/src/man/man9f/ldi_ev_register_callbacks.9f +++ b/usr/src/man/man9f/ldi_ev_register_callbacks.9f @@ -7,7 +7,6 @@ .SH NAME ldi_ev_register_callbacks \- add a notify and/or finalize callback .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -17,11 +16,8 @@ ldi_ev_register_callbacks \- add a notify and/or finalize callback .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIldi_handle_t lh\fR\fR @@ -126,8 +122,6 @@ upon successful registration. .RE .SH DESCRIPTION -.sp -.LP The \fBldi_ev_register_callbacks()\fR interface allows layered drivers to register notify and finalize callbacks for certain events. These events are listed in the \fBldi_ev_get_cookie\fR(9F) man page. The notify callback is @@ -326,8 +320,6 @@ Once the registration of the callback(s) is successful, an opaque \fIldi_callback_id_t\fR structure is returned which may be used to unregister the callback(s) later. .SH RETURN VALUES -.sp -.LP The return values for this function are: .sp .ne 2 @@ -350,11 +342,8 @@ Failed to add callback(s). .RE .SH CONTEXT -.sp -.LP This function can be called from user and kernel contexts only. .SH EXAMPLES -.LP \fBExample 1 \fRRegistration and Callbacks for the OFFLINE Event .sp .LP @@ -522,7 +511,5 @@ dgrd_finalize(ldi_handle_t lh, ldi_ev_cookie_t off_cookie, .in -2 .SH SEE ALSO -.sp -.LP \fBldi_ev_finalize\fR(9F), \fBldi_ev_get_cookie\fR(9F), \fBldi_ev_notify\fR(9F), \fBldi_ev_remove_callbacks\fR(9F) diff --git a/usr/src/man/man9f/ldi_ev_remove_callbacks.9f b/usr/src/man/man9f/ldi_ev_remove_callbacks.9f index 2a5a1b27cf..7f31fac655 100644 --- a/usr/src/man/man9f/ldi_ev_remove_callbacks.9f +++ b/usr/src/man/man9f/ldi_ev_remove_callbacks.9f @@ -7,7 +7,6 @@ .SH NAME ldi_ev_remove_callbacks \- remove all callbacks for a given callback ID .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -15,11 +14,8 @@ ldi_ev_remove_callbacks \- remove all callbacks for a given callback ID .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIldi_callback_id_t id\fR\fR @@ -31,8 +27,6 @@ An opaque data structure returned on successful calls to .RE .SH DESCRIPTION -.sp -.LP The \fBldi_ev_remove_callback()\fR function unregisters any callbacks that were registered via \fBldi_ev_register_callbacks\fR(9F). Once this function returns, the callback \fBID\fR is no longer valid. @@ -46,14 +40,8 @@ system if the entity registering the callback (a \fBdev_t\fR, \fBdip\fR or \fBmodule\fR) no longer exists on the system and the callbacks have not been unregistered. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user and kernel contexts only. .SH SEE ALSO -.sp -.LP \fBldi_ev_get_cookie\fR(9F), \fBldi_ev_register_callbacks\fR(9F) diff --git a/usr/src/man/man9f/ldi_prop_exists.9f b/usr/src/man/man9f/ldi_prop_exists.9f index 25cb7aee7d..1473c22eb3 100644 --- a/usr/src/man/man9f/ldi_prop_exists.9f +++ b/usr/src/man/man9f/ldi_prop_exists.9f @@ -7,7 +7,6 @@ .SH NAME ldi_prop_exists \- Check for the existence of a property .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -15,11 +14,8 @@ ldi_prop_exists \- Check for the existence of a property .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIlh\fR\fR @@ -79,8 +75,6 @@ String containing the name of the property. .RE .SH DESCRIPTION -.sp -.LP \fBldi_prop_exists()\fR checks for the existence of a property associated with a device represented by the layered driver handle, regardless of the property value data type. @@ -143,16 +137,11 @@ DDI_DEV_T_NONE. .LP name must always be set to the name of the property being looked up. .SH RETURN VALUES -.sp -.LP \fBldi_prop_exists()\fR returns \fB1\fR if the property exists and \fB0\fR otherwise. .SH CONTEXT -.sp -.LP This function may be called from user or kernel context. .SH EXAMPLE -.sp .in +2 .nf The following example demonstrates the use of ldi_prop_exists(). @@ -163,8 +152,6 @@ The following example demonstrates the use of ldi_prop_exists(). .in -2 .SH SEE ALSO -.sp -.LP \fBddi_prop_exists(9F)\fR .sp .LP diff --git a/usr/src/man/man9f/ldi_prop_get_int.9f b/usr/src/man/man9f/ldi_prop_get_int.9f index 90c2606ac6..70a611eabe 100644 --- a/usr/src/man/man9f/ldi_prop_get_int.9f +++ b/usr/src/man/man9f/ldi_prop_get_int.9f @@ -7,7 +7,6 @@ .SH NAME ldi_prop_get_int, ldi_prop_get_int64 \- Lookup integer property .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -22,7 +21,6 @@ ldi_prop_get_int, ldi_prop_get_int64 \- Lookup integer property .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIlh\fR \fR @@ -90,12 +88,8 @@ Integer value that is returned if the property is not found. .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBldi_prop_get_int()\fR and \fBldi_prop_get_int64()\fR functions search for an integer property associated with a device represented by the layered driver handle. If the integer property is found, the functions return the @@ -163,20 +157,14 @@ not found, the argument defvalue is returned as the property value. .LP \fBldi_prop_get_int64()\fR does not search the PROM for 64-bit property values. .SH RETURN VALUES -.sp -.LP \fBldi_prop_get_int()\fR and \fBldi_prop_get_int64()\fR return the property value. If the property is not found, the argument \fBdefvalue\fR is returned. If the property is found, but cannot be decoded into an int or an int64_t, DDI_PROP_NOT_FOUND is returned. .SH CONTEXT -.sp -.LP \fBldi_prop_get_int()\fR and \fBldi_prop_get_int64()\fR can be called from user or kernel context. .SH EXAMPLES -.sp -.LP Using\fB ldi_prop_get_int64()\fR. .sp .in +2 @@ -196,8 +184,6 @@ The following example demonstrates the use of ldi_prop_get_int64(). .in -2 .SH SEE ALSO -.sp -.LP \fBddi_prop_get_int\fR(9F), \fBddi_prop_get_int64\fR(9F), \fBldi_prop_exists\fR(9F) .sp diff --git a/usr/src/man/man9f/ldi_prop_lookup_int_array.9f b/usr/src/man/man9f/ldi_prop_lookup_int_array.9f index 0843e5f84c..477edb06b4 100644 --- a/usr/src/man/man9f/ldi_prop_lookup_int_array.9f +++ b/usr/src/man/man9f/ldi_prop_lookup_int_array.9f @@ -9,7 +9,6 @@ ldi_prop_lookup_int_array, ldi_prop_lookup_int64_array, ldi_prop_lookup_string_array, ldi_prop_lookup_string, ldi_prop_lookup_byte_array \- Lookup property information .SH SYNOPSIS -.LP .nf #include <sys/sunldi.h> @@ -42,7 +41,6 @@ ldi_prop_lookup_byte_array \- Lookup property information .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIlh\fR\fR @@ -173,12 +171,8 @@ memory containing the property byte array value. .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The property look up functions search for and, if found, return the value of a given property. Properties are searched for based on the dip and dev_t values associated with the layered handle, the property name, and type of the data @@ -344,8 +338,6 @@ Frees the resources associated with a property previously allocated using .RE .SH RETURN VALUES -.sp -.LP The functions \fBldi_prop_lookup_int_array()\fR, \fBldi_prop_lookup_int64_array()\fR, \fBldi_prop_lookup_string_array()\fR, \fBldi_prop_lookup_string()\fR, and \fBldi_prop_lookup_byte_array()\fR return @@ -397,11 +389,8 @@ Property value cannot be decoded. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH EXAMPLE -.sp .in +2 .nf Using ldi_prop_lookup_int64_array(). @@ -436,8 +425,6 @@ Using ldi_prop_lookup_int64_array(). .in -2 .SH SEE ALSO -.sp -.LP \fBexecve\fR(2), \fBddi_prop_free\fR(9F), \fBddi_prop_lookup\fR(9F), \fBldi_prop_exists\fR(9F) . .sp diff --git a/usr/src/man/man9f/mcopyin.9f b/usr/src/man/man9f/mcopyin.9f index cd131ee117..9c636c99b6 100644 --- a/usr/src/man/man9f/mcopyin.9f +++ b/usr/src/man/man9f/mcopyin.9f @@ -7,7 +7,6 @@ .SH NAME mcopyin \- Convert an M_IOCTL or M_IOCDATA message to an M_COPYIN .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -19,11 +18,8 @@ mcopyin \- Convert an M_IOCTL or M_IOCDATA message to an M_COPYIN .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImp\fR\fR @@ -61,8 +57,6 @@ set. .RE .SH DESCRIPTION -.sp -.LP The \fBmcopyin()\fR function converts an M_IOCTL or M_IOCDATA message into an M_COPYIN message using the supplied arguments. .sp @@ -78,16 +72,10 @@ assigned the pointer-sized quantity found at \fBmp->b_cont->b_rptr\fR. .LP Any trailing message blocks associated with \fImp\fR are freed. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fBmcopyout\fR(9F), \fBcopyreq\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/mcopymsg.9f b/usr/src/man/man9f/mcopymsg.9f index a717c4687a..8613770c61 100644 --- a/usr/src/man/man9f/mcopymsg.9f +++ b/usr/src/man/man9f/mcopymsg.9f @@ -7,7 +7,6 @@ .SH NAME mcopymsg \- Copy message contents into a buffer and free message .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -18,11 +17,8 @@ mcopymsg \- Copy message contents into a buffer and free message .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImp\fR\fR @@ -41,8 +37,6 @@ Buffer in which to copy. .RE .SH DESCRIPTION -.sp -.LP The \fBmcopymsg()\fR function copies the contents of the specified message into the specified buffer. If the message consists of more than a single message block, the contents of each message block are placed consecutively into the @@ -54,16 +48,10 @@ The provided buffer must be large enough to accommodate the message. If the buffer is not large enough, the results are unspecified. The \fBmsgsize\fR(9F) function can be used to calculate the total size of the message beforehand. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fBfreemsg\fR(9F), \fBmsgsize\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/mcopyout.9f b/usr/src/man/man9f/mcopyout.9f index 31d4210ef8..35f2805018 100644 --- a/usr/src/man/man9f/mcopyout.9f +++ b/usr/src/man/man9f/mcopyout.9f @@ -7,7 +7,6 @@ .SH NAME mcopyout \- Convert an M_IOCTL or M_IOCDATA message to an M_COPYOUT .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -19,11 +18,8 @@ mcopyout \- Convert an M_IOCTL or M_IOCDATA message to an M_COPYOUT .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImp\fR\fR @@ -69,8 +65,6 @@ Optionally, the payload to copy out. .RE .SH DESCRIPTION -.sp -.LP The \fBmcopyout()\fR function converts an M_IOCTL or M_IOCDATA message into an M_COPYOUT message using the supplied arguments. .sp @@ -88,16 +82,10 @@ If \fIdp\fR is not NULL, any trailing message blocks associated with \fImp\fR are freed, \fBmp->b_cont\fR is reset to \fIdp\fR and \fBdp->b_wptr\fR is set to \fBdp->b_rptr + size\fR. Otherwise, any trailing message blocks are unaffected. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fBmcopyin\fR(9F), \fBcopyreq\fR(9S), \fBiocblk\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/memchr.9f b/usr/src/man/man9f/memchr.9f index ba71a32613..64a4180888 100644 --- a/usr/src/man/man9f/memchr.9f +++ b/usr/src/man/man9f/memchr.9f @@ -7,7 +7,6 @@ .SH NAME memchr, memcmp, memcpy, memmove, memset \- Memory operations .SH SYNOPSIS -.LP .nf #include <sys/sunddi.h> @@ -37,11 +36,8 @@ memchr, memcmp, memcpy, memmove, memset \- Memory operations .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdst\fR\fR @@ -69,8 +65,6 @@ Pointers to character strings. .RE .SH DESCRIPTION -.sp -.LP These functions operate as efficiently as possible on memory areas (arrays of bytes bounded by a count, not terminated by a null character). They do not check for the overflow of any receiving memory area. @@ -103,17 +97,11 @@ The \fBmemset()\fR function sets the first \fIn\fR bytes in memory area \fIs\fR to the value of \fIc\fR (converted to an \fBunsigned char\fR). It returns \fIs\fR. .SH USAGE -.sp -.LP Using \fBmemcpy()\fR might be faster than using \fBmemmove()\fR if the application knows that the objects being copied do not overlap. .SH CONTEXT -.sp -.LP These functions can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBbcopy\fR(9F), \fBddi_copyin\fR(9F), \fBstrcpy\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/merror.9f b/usr/src/man/man9f/merror.9f index ef93fbb4ce..2d00b04e2f 100644 --- a/usr/src/man/man9f/merror.9f +++ b/usr/src/man/man9f/merror.9f @@ -7,7 +7,6 @@ .SH NAME merror \- Send an M_ERROR message upstream .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -18,11 +17,8 @@ merror \- Send an M_ERROR message upstream .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIwq\fR\fR @@ -50,8 +46,6 @@ Error code to include in the M_ERROR message. .RE .SH DESCRIPTION -.sp -.LP The \fBmerror()\fR function constructs an M_ERROR message, and sends the resulting message upstream. .sp @@ -67,21 +61,13 @@ If the allocation or conversion fails, \fBmerror()\fR silently fails. Otherwise, the resulting one-byte data block is assigned the specified error code and sent upstream. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH NOTES -.sp -.LP Callers must not hold any locks across an \fBmerror()\fR that can be acquired as part of \fBput\fR(9E) processing. .SH SEE ALSO -.sp -.LP \fBput\fR(9E), \fBdupmsg\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/mexchange.9f b/usr/src/man/man9f/mexchange.9f index 09876ca405..f8433b0b36 100644 --- a/usr/src/man/man9f/mexchange.9f +++ b/usr/src/man/man9f/mexchange.9f @@ -7,7 +7,6 @@ .SH NAME mexchange \- Exchange one message for another .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -19,11 +18,8 @@ mexchange \- Exchange one message for another .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIwq\fR\fR @@ -70,8 +66,6 @@ Optionally, a 4 byte value to store at the beginning of the returned message. .RE .SH DESCRIPTION -.sp -.LP The \fBmexchange()\fR function exchanges the passed in message for another message of the specified \fIsize\fR and \fItype\fR. .sp @@ -88,17 +82,11 @@ first 4 bytes are assigned to be \fIprimtype\fR. This is chiefly useful for STREAMS-based protocols such as \fBDLPI\fR and \fBTPI\fR which store the protocol message type in the first 4 bytes of each message. .SH RETURN VALUES -.sp -.LP A pointer to the requested message is returned on success. NULL is returned on failure. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fBdupmsg\fR(9F), \fBmerror\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/mioc2ack.9f b/usr/src/man/man9f/mioc2ack.9f index 7092e06a26..3a8be0b368 100644 --- a/usr/src/man/man9f/mioc2ack.9f +++ b/usr/src/man/man9f/mioc2ack.9f @@ -7,7 +7,6 @@ .SH NAME mioc2ack \- Convert an M_IOCTL message to an M_IOCACK message .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -18,11 +17,8 @@ mioc2ack \- Convert an M_IOCTL message to an M_IOCACK message .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImp\fR\fR @@ -59,8 +55,6 @@ Value to set the ioc_rval of the \fBiocblk\fR(9S) to. .RE .SH DESCRIPTION -.sp -.LP The \fBmioc2ack()\fR function converts an M_IOCTL message into an M_IOCACK message using the supplied arguments. .sp @@ -73,16 +67,10 @@ associated with \fImp\fR to the passed-in values, and clears the is not NULL, \fBmioc2ack()\fR resets \fBdp->b_wptr\fR to be \fBdp->b_rptr + count\fR (that is, it sets \fIdp\fR to be exactly \fIcount\fR bytes in length). .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fBmiocack\fR(9F), \fBmiocnak\fR(9F), \fBiocblk\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/miocack.9f b/usr/src/man/man9f/miocack.9f index 9343198dcf..aaaef89b72 100644 --- a/usr/src/man/man9f/miocack.9f +++ b/usr/src/man/man9f/miocack.9f @@ -7,7 +7,6 @@ .SH NAME miocack \- Positively acknowledge an M_IOCTL message .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -18,11 +17,8 @@ miocack \- Positively acknowledge an M_IOCTL message .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIwq\fR\fR @@ -59,8 +55,6 @@ Value to set the ioc_rval of the \fBiocblk\fR(9S) to. .RE .SH DESCRIPTION -.sp -.LP The \fBmiocack()\fR function converts an M_IOCTL message into a M_IOCACK message and sends the resulting message upstream. .sp @@ -77,21 +71,13 @@ Callers that only need to perform the message conversion, or need to perform additional steps between the conversion and the sending of the M_IOCACK should use \fBmioc2ack\fR(9F). .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH NOTES -.sp -.LP Callers must not hold any locks across a \fBmiocack()\fR that can be acquired as part of \fBput\fR(9E) processing. .SH SEE ALSO -.sp -.LP \fBmioc2ack\fR(9F), \fBput\fR(9E), \fBiocblk\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/miocnak.9f b/usr/src/man/man9f/miocnak.9f index 73964af683..fab60e1029 100644 --- a/usr/src/man/man9f/miocnak.9f +++ b/usr/src/man/man9f/miocnak.9f @@ -7,7 +7,6 @@ .SH NAME miocnak \- Negatively acknowledge an M_IOCTL message .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -18,11 +17,8 @@ miocnak \- Negatively acknowledge an M_IOCTL message .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIwq\fR\fR @@ -59,8 +55,6 @@ Value to set the ioc_error of the \fBiocblk\fR(9S) to. .RE .SH DESCRIPTION -.sp -.LP The \fBmiocnak()\fR function converts an M_IOCTL message into an M_IOCNAK message and sends the resulting message upstream. .sp @@ -72,21 +66,13 @@ field. Since payloads cannot currently be associated with M_IOCNAK messages, \fIcount\fR must always be zero. If \fIerror\fR is passed as zero, \fBEINVAL\fR is assumed. .SH RETURN VALUES -.sp -.LP None. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH NOTES -.sp -.LP Callers must not hold any locks across a \fBmiocnak()\fR that can be acquired as part of \fBput\fR(9E) processing. .SH SEE ALSO -.sp -.LP \fBmioc2ack\fR(9F), \fBmiocack\fR(9F), \fBput\fR(9E), \fBiocblk\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/miocpullup.9f b/usr/src/man/man9f/miocpullup.9f index 043192c98e..f30d960d19 100644 --- a/usr/src/man/man9f/miocpullup.9f +++ b/usr/src/man/man9f/miocpullup.9f @@ -7,7 +7,6 @@ .SH NAME miocpullup \- Prepare the payload of an M_IOCTL message for access .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -18,11 +17,8 @@ miocpullup \- Prepare the payload of an M_IOCTL message for access .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImp\fR\fR @@ -41,8 +37,6 @@ Number of bytes to prepare. .RE .SH DESCRIPTION -.sp -.LP The \fBmiocpullup()\fR function prepares the payload of the specified M_IOCTL message for access by ensuring that it consists of at least \fIsize\fR bytes of data. @@ -54,15 +48,9 @@ as necessary to provide contiguous access to at least \fIsize\fR bytes of data. As a special case, if \fIsize\fR is zero, \fBmiocpullup()\fR returns successfully, even if no payload exists. .SH RETURN VALUES -.sp -.LP Zero is returned on success. Otherwise an errno value is returned indicating the problem. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fISTREAMS Programming Guide\fR diff --git a/usr/src/man/man9f/mkiocb.9f b/usr/src/man/man9f/mkiocb.9f index 3df49e13fe..800de99ae0 100644 --- a/usr/src/man/man9f/mkiocb.9f +++ b/usr/src/man/man9f/mkiocb.9f @@ -7,7 +7,6 @@ .SH NAME mkiocb \- allocates a STREAMS ioctl block for M_IOCTL messages in the kernel. .SH SYNOPSIS -.LP .nf #include <sys/stream.h> @@ -17,11 +16,8 @@ mkiocb \- allocates a STREAMS ioctl block for M_IOCTL messages in the kernel. .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIcommand\fR\fR @@ -31,8 +27,6 @@ ioctl command for the \fBioc_cmd\fR field. .RE .SH DESCRIPTION -.sp -.LP STREAMS modules or drivers might need to issue an ioctl to a lower module or driver. The \fBmkiocb()\fR function tries to allocate (using \fBallocb\fR(9F)) a STREAMS \fBM_IOCTL\fR message block (\fBiocblk\fR(9S)). Buffer allocation @@ -139,20 +133,15 @@ Set to \fBIOC_NATIVE\fR to reflect that this is native to the running kernel. .RE .SH RETURN VALUES -.sp -.LP Upon success, the \fBmkiocb()\fR function returns a pointer to the allocated \fBmblk_t\fR of type \fBM_IOCTL\fR. .sp .LP On failure, it returns a null pointer. .SH CONTEXT -.sp -.LP The \fBmkiocb()\fR function can be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fR\fBM_IOCTL\fR Allocation .sp .LP @@ -244,8 +233,6 @@ is available. .in -2 .SH SEE ALSO -.sp -.LP \fBallocb\fR(9F), \fBputnext\fR(9F), \fBqbufcall\fR(9F), \fBqwait_sig\fR(9F), \fBcopyreq\fR(9S), \fBcopyresp\fR(9S), \fBiocblk\fR(9S) .sp @@ -255,8 +242,6 @@ is available. .LP \fISTREAMS Programming Guide\fR .SH WARNINGS -.sp -.LP It is the module's responsibility to remember the \fBID\fR value of the \fBM_IOCTL\fR that was allocated. This will ensure proper cleanup and \fBID\fR matching when the \fBM_IOCACK\fR or \fBM_IOCNAK\fR is received. diff --git a/usr/src/man/man9f/mod_install.9f b/usr/src/man/man9f/mod_install.9f index 2165166ed4..942b2d1952 100644 --- a/usr/src/man/man9f/mod_install.9f +++ b/usr/src/man/man9f/mod_install.9f @@ -8,7 +8,6 @@ mod_install, mod_remove, mod_info, mod_modname \- add, remove or query a loadable module .SH SYNOPSIS -.LP .nf #include <sys/modctl.h> @@ -34,8 +33,7 @@ loadable module .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -56,7 +54,6 @@ Pointer to the \fBmodinfo\fR structure passed to \fB_info\fR(9E). .RE .SH DESCRIPTION -.LP \fBmod_install()\fR must be called from a module's \fB_init\fR(9E) routine. .sp .LP @@ -89,7 +86,6 @@ driver, the module name is the same as the driver name. This function can be used to avoid compiled-in knowledge of the module name, and is of particular use when \fB_init\fR(9E) needs to call a function like \fBkstat_create\fR(9F). .SH RETURN VALUES -.LP \fBmod_install()\fR and \fBmod_remove()\fR return \fB0\fR upon success and non-zero on failure. .sp @@ -100,10 +96,8 @@ non-zero on failure. \fBmod_modname()\fR returns the name of the module. The returned name remains valid as long as the module remains loaded. .SH EXAMPLES -.LP See \fB_init\fR(9E) for an example that uses these functions. .SH SEE ALSO -.LP \fB_fini\fR(9E), \fB_info\fR(9E), \fB_init\fR(9E), \fBkstat_create\fR(9F), \fBmodldrv\fR(9S), \fBmodlinkage\fR(9S), \fBmodlstrmod\fR(9S) .sp diff --git a/usr/src/man/man9f/msgsize.9f b/usr/src/man/man9f/msgsize.9f index b8bbabc830..11efb2acfb 100644 --- a/usr/src/man/man9f/msgsize.9f +++ b/usr/src/man/man9f/msgsize.9f @@ -7,7 +7,6 @@ .SH NAME msgsize \- Return the total number of bytes in a message .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/strsun.h> @@ -18,11 +17,8 @@ msgsize \- Return the total number of bytes in a message .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fImp\fR\fR @@ -32,21 +28,13 @@ Message to be evaluated. .RE .SH DESCRIPTION -.sp -.LP The \fBmsgsize()\fR function counts the number of bytes in a message, regardless of the data type of the underlying data blocks. .SH RETURN VALUES -.sp -.LP Number of bytes in the message. .SH CONTEXT -.sp -.LP This function can be called from user, kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fBmsgdsize\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/mt-streams.9f b/usr/src/man/man9f/mt-streams.9f index 895254f4d7..a2ec1e2093 100644 --- a/usr/src/man/man9f/mt-streams.9f +++ b/usr/src/man/man9f/mt-streams.9f @@ -7,18 +7,13 @@ .SH NAME mt-streams \- STREAMS multithreading .SH SYNOPSIS -.LP .nf #include <sys/conf.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP STREAMS drivers configure the degree of concurrency using the \fBcb_flag\fR field in the \fBcb_ops\fR structure (see \fBcb_ops\fR(9S)). The corresponding field for \fBSTREAMS \fRmodules is the \fBf_flag\fR in the \fBfmodsw\fR @@ -50,8 +45,6 @@ different entry points. .LP All MT safe modules/drivers specify the \fBD_MP\fR flag. .SS "Inner Perimeter Flags" -.sp -.LP The inner perimeter presence and scope are controlled by the mutually exclusive flags: .sp @@ -92,8 +85,6 @@ The module/driver has no inner perimeter. .RE .SS "Outer Perimeter Flags" -.sp -.LP The outer perimeter presence is configured using: .sp .ne 2 @@ -158,8 +149,6 @@ or outer perimeter from shared to exclusive. The use and semantics of \fBqprocson()\fR and \fBqprocsoff\fR(9F) is independent of the inner and outer perimeters. .SH SEE ALSO -.sp -.LP \fBclose\fR(9E), \fBopen\fR(9E), \fBput\fR(9E), \fBsrv\fR(9E), \fBqprocsoff\fR(9F), \fBqprocson\fR(9F), \fBqwait\fR(9F), \fBqwriter\fR(9F), \fBcb_ops\fR(9S) diff --git a/usr/src/man/man9f/mutex.9f b/usr/src/man/man9f/mutex.9f index 78c34e4b3f..cc77960ad7 100644 --- a/usr/src/man/man9f/mutex.9f +++ b/usr/src/man/man9f/mutex.9f @@ -8,7 +8,6 @@ mutex, mutex_enter, mutex_exit, mutex_init, mutex_destroy, mutex_owned, mutex_tryenter \- mutual exclusion lock routines .SH SYNOPSIS -.LP .nf #include <sys/ksynch.h> @@ -42,11 +41,8 @@ mutex_tryenter \- mutual exclusion lock routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImp\fR\fR @@ -84,8 +80,6 @@ Type-specific argument for initialization routine. .RE .SH DESCRIPTION -.sp -.LP A mutex enforces a policy of mutual exclusion. Only one thread at a time may hold a particular mutex. Threads trying to lock a held mutex will block until the mutex is unlocked. @@ -135,8 +129,6 @@ memory containing the mutex, and should be called with the mutex unheld (not owned by any thread). The caller must be sure that no other thread attempts to use the mutex. .SH RETURN VALUES -.sp -.LP \fBmutex_tryenter()\fR returns a non-zero value on success and zero on failure. .sp .LP @@ -144,13 +136,10 @@ use the mutex. holds the mutex pointed to by \fImp\fR, or when that cannot be determined, if any thread holds the mutex. Otherwise \fBmutex_owned()\fR returns zero. .SH CONTEXT -.sp -.LP These functions can be called from user, kernel, or high-level interrupt context, except for \fBmutex_init()\fR and \fBmutex_destroy()\fR, which can be called from user or kernel context only. .SH EXAMPLES -.LP \fBExample 1 \fRInitializing a Mutex .sp .LP @@ -184,8 +173,6 @@ xxstart(struct xxunit *un) .in -2 .SH SEE ALSO -.sp -.LP \fBlockstat\fR(1M), \fBIntro\fR(9F), \fBcondvar\fR(9F), \fBddi_intr_alloc\fR(9F), \fBddi_intr_add_handler\fR(9F), \fBddi_intr_get_pri\fR(9F), \fBddi_intr_get_softint_pri\fR(9F), @@ -194,8 +181,6 @@ xxstart(struct xxunit *un) .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Compiling with \fB_LOCKTEST\fR or \fB_MPSTATS\fR defined has no effect. To gather lock statistics, see \fBlockstat\fR(1M). .sp diff --git a/usr/src/man/man9f/net_event_notify_register.9f b/usr/src/man/man9f/net_event_notify_register.9f index ad4d374281..972c5fc59d 100644 --- a/usr/src/man/man9f/net_event_notify_register.9f +++ b/usr/src/man/man9f/net_event_notify_register.9f @@ -8,7 +8,6 @@ net_event_notify_register, net_event_notify_unregister \- add/delete a function to be called for changes to a event .SH SYNOPSIS -.LP .nf #include <sys/hook.h> #include <sys/neti.h> @@ -25,11 +24,8 @@ to be called for changes to a event .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIfamily\fR\fR @@ -66,8 +62,6 @@ pointer to pass into the \fBcallback()\fR function when a change occurs. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_event_notify_register()\fR function registers a function represented by the pointer \fIcallback\fR to be called when there is a change to the event represented by \fIfamily\fR. The types of changes for which notifications are @@ -80,7 +74,7 @@ function calls to the specified \fIcallback\fR. .sp .LP The name of a hook should be considered a private interface unless otherwise -specified. The hook names used by \fBIPFilter\fR in Solaris are a public, but +specified. The hook names used by \fBIPFilter\fR in illumos are a public, but uncommitted, interface. .sp .LP @@ -125,8 +119,6 @@ is the name of the hook being added/removed .RE .SH RETURN VALUES -.sp -.LP If these functions succeed, 0 is returned. Otherwise, the following error is returned: .sp @@ -139,12 +131,8 @@ the given callback function is already registered. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -159,7 +147,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBnet_hook_register\fR(9F), \fBnet_hook_unregister\fR(9F), \fBnet_protocol_lookup\fR(9F) diff --git a/usr/src/man/man9f/net_getifname.9f b/usr/src/man/man9f/net_getifname.9f index 2c683db17b..e36e202e1c 100644 --- a/usr/src/man/man9f/net_getifname.9f +++ b/usr/src/man/man9f/net_getifname.9f @@ -7,7 +7,6 @@ .SH NAME net_getifname \- determine the name given to a network interface .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ net_getifname \- determine the name given to a network interface .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -58,16 +54,12 @@ size of the buffer in which to store the interface name. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_getifname()\fR function copies the name of the network interface into the buffer provided. The name will always be null-terminated. If the buffer is too small to fit both the interface name and the null-terminated name, the name in the buffer is truncated to fit. See \fBnet_phygetnext\fR(9F) for an example on how to use this function. .SH RETURN VALUES -.sp -.LP The \fBnet_getifname()\fR function returns: .sp .ne 2 @@ -97,13 +89,9 @@ Unsuccessful. .RE .SH CONTEXT -.sp -.LP The \fBnet_getifname()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -118,7 +106,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_phygetnext\fR(9F), \fBnet_phylookup\fR(9F), \fBnet_protocol_lookup\fR(9F) diff --git a/usr/src/man/man9f/net_getlifaddr.9f b/usr/src/man/man9f/net_getlifaddr.9f index 9ea110383d..8a2741ccb5 100644 --- a/usr/src/man/man9f/net_getlifaddr.9f +++ b/usr/src/man/man9f/net_getlifaddr.9f @@ -7,7 +7,6 @@ .SH NAME net_getlifaddr \- determine a network address for a given interface .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -17,11 +16,8 @@ net_getlifaddr \- determine a network address for a given interface .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -70,8 +66,6 @@ pointer to an area of memory to store the address data. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_getlifaddr()\fR function retrieves the address information for each logical interface. Each call to \fBnet_getlifaddr()\fR requires that the caller pass a pointer to an array of address information types to retrieve, and an @@ -123,8 +117,6 @@ network interfaces that support broadcast packets. .RE .SH RETURN VALUES -.sp -.LP The \fBnet_getlifaddr()\fR function returns: .sp .ne 2 @@ -154,13 +146,9 @@ Unsuccessful. .RE .SH CONTEXT -.sp -.LP The \fBnet_getifaddr()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -175,7 +163,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_lifgetnext\fR(9F), \fBnet_phylookup\fR(9F), \fBnet_phygetnext\fR(9F), \fBnet_protocol_lookup\fR(9F) diff --git a/usr/src/man/man9f/net_getmtu.9f b/usr/src/man/man9f/net_getmtu.9f index f8c92e4d9d..7cec286b0d 100644 --- a/usr/src/man/man9f/net_getmtu.9f +++ b/usr/src/man/man9f/net_getmtu.9f @@ -7,7 +7,6 @@ .SH NAME net_getmtu \- determine the MTU of a given network interface .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_getmtu \- determine the MTU of a given network interface .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -39,26 +35,18 @@ value returned from a successful call to \fBnet_phylookup\fR(9F) or .RE .SH DESCRIPTION -.sp -.LP The \fBnet_getmtu()\fR function receives information about the current \fBMTU\fR of a network interface. The value returned from this function call should not be cached as the \fBMTU\fR of a network interface since it is not guaranteed to be constant. .SH RETURN VALUES -.sp -.LP The \fBnet_getmtu()\fR function returns -1 if the network protocol does not support this feature and otherwise returns the current MTU of the network interface. .SH CONTEXT -.sp -.LP The \fBnet_getmtu()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -73,7 +61,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_phygetnext\fR(9F), \fBnet_phylookup\fR(9F), \fBnet_protocol_lookup\fR(9F) diff --git a/usr/src/man/man9f/net_getnetid.9f b/usr/src/man/man9f/net_getnetid.9f index 5e6f596589..a2fc841223 100644 --- a/usr/src/man/man9f/net_getnetid.9f +++ b/usr/src/man/man9f/net_getnetid.9f @@ -7,7 +7,6 @@ .SH NAME net_getnetid \- returns the instance identifier .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_getnetid \- returns the instance identifier .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -29,22 +25,14 @@ value returned from a successful call to \fBnet_protocol_lookup\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_getnetid()\fR function returns the instance identifier for the protocol instance returned via a call to \fBnet_protocol_lookup\fR(9F). .SH RETURN VALUES -.sp -.LP The \fBnet_getnetid()\fR function returns the value of the instance identifier. .SH CONTEXT -.sp -.LP The \fBnet_getnetid()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -59,6 +47,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_protocol_lookup\fR(9F) diff --git a/usr/src/man/man9f/net_getpmtuenabled.9f b/usr/src/man/man9f/net_getpmtuenabled.9f index cd14dcd5ff..e34a122ace 100644 --- a/usr/src/man/man9f/net_getpmtuenabled.9f +++ b/usr/src/man/man9f/net_getpmtuenabled.9f @@ -8,7 +8,6 @@ net_getpmtuenabled \- determine if path MTU discovery is enabled for a network protocol .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ protocol .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -30,13 +26,9 @@ value returned from a successful call to \fBnet_protocol_lookup\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_getpmtuenabled()\fR function returns a value to indicate whether or not path \fBMTU\fR (\fBPMTU\fR) discovery is enabled for this network protocol. .SH RETURN VALUES -.sp -.LP The \fBnet_getpmtuenabled()\fR function returns: .sp .ne 2 @@ -66,13 +58,9 @@ PATH MTU discovery is enabled. .RE .SH CONTEXT -.sp -.LP The \fBnet_getpmtuenabled()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -87,6 +75,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_getmtu\fR(9F), \fBnet_protocol_lookup\fR(9F) diff --git a/usr/src/man/man9f/net_hook_register.9f b/usr/src/man/man9f/net_hook_register.9f index 3d10a10524..1a42e7a327 100644 --- a/usr/src/man/man9f/net_hook_register.9f +++ b/usr/src/man/man9f/net_hook_register.9f @@ -8,7 +8,6 @@ .SH NAME net_hook_register \- add a hook to be called in event processing .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ net_hook_register \- add a hook to be called in event processing .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIinfo\fR\fR @@ -48,8 +44,6 @@ pointer to a \fBhook_t\fR structure. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_hook_register()\fR function uses hooks that allow callbacks to be registered with events that belong to a network protocol. A successful call to \fBnet_hook_register()\fR requires that a valid handle for a network protocol be @@ -113,8 +107,6 @@ is activated. .RE .SH RETURN VALUES -.sp -.LP If the \fBnet_hook_register()\fR function succeeds, 0 is returned. Otherwise, one of the following errors is returned: .sp @@ -174,13 +166,9 @@ with this value. The netstack corresponding to \fIinfo\fR is condemned or no longer exists. .SH CONTEXT -.sp -.LP The \fBnet_hook_register()\fR function may be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -195,6 +183,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_hook_unregister\fR(9F), \fBhook_t\fR(9S) diff --git a/usr/src/man/man9f/net_hook_unregister.9f b/usr/src/man/man9f/net_hook_unregister.9f index 73558d459f..3015bd5590 100644 --- a/usr/src/man/man9f/net_hook_unregister.9f +++ b/usr/src/man/man9f/net_hook_unregister.9f @@ -7,7 +7,6 @@ .SH NAME net_hook_unregister \- disable a hook that was called in event processing .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_hook_unregister \- disable a hook that was called in event processing .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -38,23 +34,15 @@ value returned from a successful call to \fBnet_hook_register\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_hook_unregister()\fR function disables the callback hooks that were registered with the \fBnet_hook_register()\fR function. .SH RETURN VALUES -.sp -.LP If the \fBnet_hook_unregister()\fR function succeeds, 0 is returned. Otherwise, an error indicating the problem encountered. .SH CONTEXT -.sp -.LP The \fBnet_hook_unregister()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -69,6 +57,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_hook_register\fR(9F) diff --git a/usr/src/man/man9f/net_inject.9f b/usr/src/man/man9f/net_inject.9f index c446e36370..9362be6e86 100644 --- a/usr/src/man/man9f/net_inject.9f +++ b/usr/src/man/man9f/net_inject.9f @@ -8,7 +8,6 @@ net_inject \- determine if a network interface name exists for a network protocol .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -17,11 +16,8 @@ protocol .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -50,8 +46,6 @@ details about the packet to be injected. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_inject()\fR function provides an interface to allow delivery of network layer (layer 3) packets either into the kernel or onto the network. The method of delivery is determined by style. @@ -96,8 +90,6 @@ structure with the packet to be delivered. See \fBnet_inject_t\fR(9S) for more details on the structure \fBnet_inject_t\fR. .SH RETURN VALUES -.sp -.LP The \fBnet_inject()\fR function returns: .sp .ne 2 @@ -127,13 +119,9 @@ The packet could not be queued up or sent out immediately. .RE .SH CONTEXT -.sp -.LP The \fBnet_inject()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -148,6 +136,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_protocol_lookup\fR(9F), \fBnetinfo\fR(9F), \fBnet_inject_t\fR(9S) diff --git a/usr/src/man/man9f/net_inject_alloc.9f b/usr/src/man/man9f/net_inject_alloc.9f index 8c7b973937..cae8739866 100644 --- a/usr/src/man/man9f/net_inject_alloc.9f +++ b/usr/src/man/man9f/net_inject_alloc.9f @@ -7,7 +7,6 @@ .SH NAME net_inject_alloc \- allocate a net_inject_t structure .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_inject_alloc \- allocate a net_inject_t structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIversion\fR\fR @@ -29,24 +25,16 @@ must always be the symbol \fBNETI_VERSION\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_inject_alloc()\fR function allocates a \fBnet_inject_t\fR structure, returning a pointer for the caller to use. .SH RETURN VALUES -.sp -.LP Upon success, \fBnet_inject_alloc()\fR returns a pointer to the allocated \fInet_inject_t\fR structure. On failure, \fBhook_alloc()\fR returns a \fINULL\fR pointer. .SH CONTEXT -.sp -.LP The \fBnet_inject_alloc()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -61,6 +49,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_inject_free\fR(9F), \fBnet_inject_t\fR(9S) diff --git a/usr/src/man/man9f/net_inject_free.9f b/usr/src/man/man9f/net_inject_free.9f index 24d5f79af0..b0542df26e 100644 --- a/usr/src/man/man9f/net_inject_free.9f +++ b/usr/src/man/man9f/net_inject_free.9f @@ -7,7 +7,6 @@ .SH NAME net_inject_free \- free a net_inject_t structure .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_inject_free \- free a net_inject_t structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIinject\fR\fR @@ -29,18 +25,12 @@ pointer returned by \fBnet_inject_alloc\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_inject_free()\fR function frees a \fBnet_inject_t\fR structure that was originally allocated by \fBnet_inject_alloc\fR(9F). .SH CONTEXT -.sp -.LP The \fBnet_inject_free()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -55,6 +45,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_inject_alloc\fR(9F), \fBattributes\fR(5), \fBnet_inject_t\fR(9S) diff --git a/usr/src/man/man9f/net_instance_alloc.9f b/usr/src/man/man9f/net_instance_alloc.9f index 146054f5d4..c995c4867e 100644 --- a/usr/src/man/man9f/net_instance_alloc.9f +++ b/usr/src/man/man9f/net_instance_alloc.9f @@ -8,7 +8,6 @@ .SH NAME net_instance_alloc \- allocate a net_instance_t structure .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ net_instance_alloc \- allocate a net_instance_t structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIversion\fR\fR @@ -30,23 +26,15 @@ must always be the symbol \fBNETINFO_VERSION\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_instance_alloc()\fR function allocates a \fBnet_instance_t\fR structure, returning a pointer for the caller to use. .SH RETURN VALUES -.sp -.LP Upon success, \fBnet_instance_alloc()\fR returns a pointer to the allocated \fInet_instance_t\fR structure. On failure, it returns a \fINULL\fR pointer. .SH CONTEXT -.sp -.LP The \fBnet_instance_alloc()\fR function may be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -61,6 +49,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_instance_free\fR(9F), \fBattributes\fR(5), \fBnet_inject_t\fR(9S) diff --git a/usr/src/man/man9f/net_instance_free.9f b/usr/src/man/man9f/net_instance_free.9f index 4435657644..f47b65d47a 100644 --- a/usr/src/man/man9f/net_instance_free.9f +++ b/usr/src/man/man9f/net_instance_free.9f @@ -7,7 +7,6 @@ .SH NAME net_instance_free \- free a net_instance_t structure .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_instance_free \- free a net_instance_t structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet_instance\fR\fR @@ -29,18 +25,12 @@ pointer returned by \fBnet_instance_alloc\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_instance_free()\fR function frees a \fBnet_instance_t\fR structure that was originally allocated by \fBnet_instance_alloc\fR(9F). .SH CONTEXT -.sp -.LP The \fBnet_instance_free()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -55,6 +45,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_instance_alloc\fR(9F), \fBattributes\fR(5), \fBnet_instance_t\fR(9S) diff --git a/usr/src/man/man9f/net_instance_notify_register.9f b/usr/src/man/man9f/net_instance_notify_register.9f index 44ff9fa68e..ed1bb1d3f0 100644 --- a/usr/src/man/man9f/net_instance_notify_register.9f +++ b/usr/src/man/man9f/net_instance_notify_register.9f @@ -8,7 +8,6 @@ net_instance_notify_register, net_instance_notify_unregister \- add/delete a function to be called for changes to an instance .SH SYNOPSIS -.LP .nf #include <sys/hook.h> #include <sys/neti.h> @@ -25,11 +24,8 @@ function to be called for changes to an instance .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInetid\fR\fR @@ -58,8 +54,6 @@ pointer to pass into the \fBcallback()\fR function when a change occurs. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_instance_notify_register()\fR function registers a function represented by the pointer \fIcallback\fR to be called when there is a new instance added or removed from the given network instance (represented by @@ -110,8 +104,6 @@ is the name of the instance being added/removed .RE .SH RETURN VALUES -.sp -.LP If these functions succeed, 0 is returned. Otherwise, the following error is returned: .sp @@ -124,12 +116,8 @@ the given callback function is already registered. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -144,7 +132,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBnet_instance_register\fR(9F), \fBnet_instance_unregister\fR(9F), \fBnet_zoneidtonetid\fR(9F) diff --git a/usr/src/man/man9f/net_instance_register.9f b/usr/src/man/man9f/net_instance_register.9f index 67a0f49713..f5eacb6f35 100644 --- a/usr/src/man/man9f/net_instance_register.9f +++ b/usr/src/man/man9f/net_instance_register.9f @@ -8,7 +8,6 @@ net_instance_register \- register a set of instances to occur with IP instance events .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ events .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIinstances\fR\fR @@ -30,25 +26,17 @@ must be a pointer returned by \fBnet_instance_alloc\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_instance_register()\fR function attempts to record the set of functions passed by instances that are to be called when an event related to \fBIP\fR instance maintenance occurs. .SH RETURN VALUES -.sp -.LP If the \fBnet_instance_register()\fR function succeeds, \fBDDI_SUCCESS\fR is returned. Otherwise, \fBDDI_FAILURE\fR is returned to indicate failure due to the name in the instance already being present. .SH CONTEXT -.sp -.LP The \fBnet_instance_register()\fR function may be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -63,7 +51,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_instance_alloc\fR(9F), \fBnet_instance_unregister\fR(9F), \fBattributes\fR(5), \fBnet_instance_t\fR(9S) diff --git a/usr/src/man/man9f/net_instance_unregister.9f b/usr/src/man/man9f/net_instance_unregister.9f index 9fa3a44b46..bfb81cf2af 100644 --- a/usr/src/man/man9f/net_instance_unregister.9f +++ b/usr/src/man/man9f/net_instance_unregister.9f @@ -7,7 +7,6 @@ .SH NAME net_instance_unregister \- disable a set of instances .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_instance_unregister \- disable a set of instances .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIinstances\fR\fR @@ -29,23 +25,15 @@ must be a pointer returned by \fBnet_instance_alloc\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_instance_unregister()\fR function removes the set of instances that were previously registered with the \fBnet_instance_register()\fR function. .SH RETURN VALUES -.sp -.LP If the \fBnet_instance_unregister()\fR function succeeds, 0 is returned. Otherwise, an error indicating the problem encountered. .SH CONTEXT -.sp -.LP The \fBnet_instance_unregister()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -60,7 +48,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_instance_alloc\fR(9F), \fBnet_instance_register\fR(9F), \fBattributes\fR(5), \fBnet_instance_t\fR(9S) diff --git a/usr/src/man/man9f/net_ispartialchecksum.9f b/usr/src/man/man9f/net_ispartialchecksum.9f index 38cb2e4a4f..8ffb4c673e 100644 --- a/usr/src/man/man9f/net_ispartialchecksum.9f +++ b/usr/src/man/man9f/net_ispartialchecksum.9f @@ -8,7 +8,6 @@ net_ispartialchecksum \- indicate if a packet is being scheduled for hardware checksum calculation .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ checksum calculation .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -39,16 +35,12 @@ the \fBmblk\fR structure holding a packet that is the subject of this query. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_ispartialchecksum()\fR function looks at the fields within the \fBmblk\fR structure to determine if the packet contained inside contains headers with only partial checksum values. Partial checksum values are stored inside headers when the calculation of the complete checksum is being handled by the hardware. .SH RETURN VALUES -.sp -.LP The \fBnet_ispartialchecksum()\fR function returns: .sp .ne 2 @@ -109,13 +101,9 @@ Partial layer 4 checksum calculated .RE .SH CONTEXT -.sp -.LP The \fBnet_ispartialchecksum()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -130,7 +118,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_isvalidchecksum\fR(9F), \fBnet_protocol_lookup\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_isvalidchecksum.9f b/usr/src/man/man9f/net_isvalidchecksum.9f index 582fee53ce..07d90553d5 100644 --- a/usr/src/man/man9f/net_isvalidchecksum.9f +++ b/usr/src/man/man9f/net_isvalidchecksum.9f @@ -7,7 +7,6 @@ .SH NAME net_isvalidchecksum \- verify layer 3 and layer 4 checksums .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_isvalidchecksum \- verify layer 3 and layer 4 checksums .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -38,8 +34,6 @@ the \fBmblk\fR structure holding a packet that is the subject of this query. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_isvalidchecksum()\fR function verifies the layer 3 checksum (and, in some case, the layer 4 checksum) in the packet. If possible, fields that are used by hardware checksum'ing are examined rather than manually verifying that @@ -50,8 +44,6 @@ For both \fBIPv4\fR and \fBIPv6\fR, \fBTCP\fR, \fBUDP\fR and \fBICMP\fR (including \fBICMPV6\fR for \fBIPv6\fR) layer 4 checksums are currently validated. .SH RETURN VALUES -.sp -.LP The \fBnet_isvalidchecksum()\fR function returns: .sp .ne 2 @@ -81,13 +73,9 @@ The packet does contain partial checksums. .RE .SH CONTEXT -.sp -.LP The \fBnet_isvalidchecksum()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -102,7 +90,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_ispartialchecksum\fR(9F), \fBnet_protocol_lookup\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_kstat_create.9f b/usr/src/man/man9f/net_kstat_create.9f index 4dc32de1d5..4d23a6cec6 100644 --- a/usr/src/man/man9f/net_kstat_create.9f +++ b/usr/src/man/man9f/net_kstat_create.9f @@ -8,7 +8,6 @@ net_kstat_create \- create and initialize a new kstat for a specific instance of IP .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -20,11 +19,8 @@ of IP .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInetid\fR\fR @@ -172,24 +168,16 @@ goes away. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_kstat_create()\fR function allocates and initializes a \fBkstat\fR(9S) structure. See \fBkstat_create\fR(9F) for a complete discussion of this function. .SH RETURN VALUES -.sp -.LP If successful, \fBnet_kstat_create()\fR returns a pointer to the allocated \fBkstat\fR. \fINULL\fR is returned upon failure. .SH CONTEXT -.sp -.LP The \fBnet_kstat_create()\fR function may be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -204,7 +192,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBddi_get_instance\fR(9F), \fBkstat_create\fR(9F), \fBkstat_delete\fR(9F), \fBnet_kstat_delete\fR(9F), \fBhook_t\fR(9S), \fBkstat_named\fR(9S) diff --git a/usr/src/man/man9f/net_kstat_delete.9f b/usr/src/man/man9f/net_kstat_delete.9f index abd74e3dea..e9b339d3af 100644 --- a/usr/src/man/man9f/net_kstat_delete.9f +++ b/usr/src/man/man9f/net_kstat_delete.9f @@ -8,7 +8,6 @@ net_kstat_delete \- remove a kstat for a specific instance of IP from the system .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -18,11 +17,8 @@ system .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInetid\fR\fR @@ -41,24 +37,16 @@ Pointer to a currently installed \fBkstat\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_kstat_delete()\fR function removes \fIksp\fR from the \fBkstat\fR chain and frees all associated system resources. See \fBkstat_delete\fR(9F) for a complete discussion of this function. .SH RETURN VALUES -.sp -.LP If successful, \fBnet_kstat_delete()\fR returns a pointer to the allocated \fBkstat\fR. \fINULL\fR is returned upon failure. .SH CONTEXT -.sp -.LP The \fBnet_kstat_delete()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -73,7 +61,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBkstat_create\fR(9F), \fBkstat_delete\fR(9F), \fBnet_kstat_create\fR(9F), \fBhook_t\fR(9S), \fBkstat_named\fR(9S) diff --git a/usr/src/man/man9f/net_lifgetnext.9f b/usr/src/man/man9f/net_lifgetnext.9f index a33b47805d..6fb5e6d3a1 100644 --- a/usr/src/man/man9f/net_lifgetnext.9f +++ b/usr/src/man/man9f/net_lifgetnext.9f @@ -7,7 +7,6 @@ .SH NAME net_lifgetnext \- search through a list of logical network interfaces .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ net_lifgetnext \- search through a list of logical network interfaces .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -49,8 +45,6 @@ value returned from a successful call to this function. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_lifgetnext()\fR function is used to search through all of the logical interfaces that are associated with a physical network interface. To start searching through this list, a value of 0 should be passed through as the @@ -63,7 +57,6 @@ that exists, at the time of the call, within the scope of the network interface and its assigned network protocol. This value is only guaranteed to be unique for a name within the scope of the network interface and its assigned protocol. .SH EXAMPLES -.sp .in +2 .nf net_data_t net; @@ -91,20 +84,14 @@ for a name within the scope of the network interface and its assigned protocol. .sp .SH RETURN VALUES -.sp -.LP The \fBnet_lifgetnext()\fR function returns a value of -1 if it is not supported by the network protocol and a value of 0 if an attempt to go beyond the last network interface is made. Otherwise, it returns a value representing a network interface. .SH CONTEXT -.sp -.LP The \fBnet_lifgetnext()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -119,6 +106,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_phygetnext\fR(9F), \fBnet_phylookup\fR(9F) diff --git a/usr/src/man/man9f/net_netidtozonid.9f b/usr/src/man/man9f/net_netidtozonid.9f index 4e33f506b6..32946ad504 100644 --- a/usr/src/man/man9f/net_netidtozonid.9f +++ b/usr/src/man/man9f/net_netidtozonid.9f @@ -7,7 +7,6 @@ .SH NAME net_netidtozonid \- map a netid_t structure identifier to a zoneid_t structure .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_netidtozonid \- map a netid_t structure identifier to a zoneid_t structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -29,26 +25,18 @@ valid \fBnetid_t\fR structure that refers to an existing \fBIP\fR instance. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_netidtozonid()\fR function maps the given \fBnetid_t\fR (used to represent an instance of \fBIP\fR) into the matching \fBzoneid_t\fR structure that is associated with it. .SH RETURN VALUES -.sp -.LP The \fBnet_netidtozonid()\fR function returns -1 if no mapping took place. Otherwise, it returns the \fBzoneid_t\fR structure currently associated with a \fBnetid_t\fR structure. For shared stack zones, the \fBzoneid_t\fR structure for the global zone is returned. .SH CONTEXT -.sp -.LP The \fBnet_netidtozonid()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -63,6 +51,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_zoneidtonetid\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_phygetnext.9f b/usr/src/man/man9f/net_phygetnext.9f index 61d0b2207b..b30728787b 100644 --- a/usr/src/man/man9f/net_phygetnext.9f +++ b/usr/src/man/man9f/net_phygetnext.9f @@ -7,7 +7,6 @@ .SH NAME net_phygetnext \- search through the current list of network interfaces .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_phygetnext \- search through the current list of network interfaces .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -39,8 +35,6 @@ value returned from a successful call to this function or .RE .SH DESCRIPTION -.sp -.LP The \fBnet_phygetnext()\fR function searches through all of the network interfaces that a network protocol "owns". To start searching through all of the interfaces owned by a protocol, a value of 0 should be passed through as @@ -53,7 +47,6 @@ that exists, at the time of the call, within the scope of the network interface. This value is only guaranteed to be unique for a name within the scope of the network protocol. .SH EXAMPLES -.sp .in +2 .nf net_data_t net; @@ -76,19 +69,13 @@ scope of the network protocol. .sp .SH RETURN VALUES -.sp -.LP The \fBnet_phygetnext()\fR function returns -1 if it is not supported by the network protocol or 0 if an attempt to go beyond the last network interface is made. Otherwise, it returns a value representing a network interface. .SH CONTEXT -.sp -.LP The \fBnet_phygetnext()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -103,6 +90,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_phylookup\fR(9F), \fBnet_protocol_lookup\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_phylookup.9f b/usr/src/man/man9f/net_phylookup.9f index 640f1f0e89..917762db86 100644 --- a/usr/src/man/man9f/net_phylookup.9f +++ b/usr/src/man/man9f/net_phylookup.9f @@ -8,7 +8,6 @@ net_phylookup \- determine if a network interface name exists for a network protocol .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ protocol .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -39,8 +35,6 @@ name of the network interface to find. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_phylookup()\fR function attempts to resolve the interface name passed in with the network protocol. .sp @@ -50,21 +44,15 @@ that exists, at the time of the call, within the scope of the network interface. This value is only guaranteed to be unique for a name within the scope of the network protocol. .SH RETURN VALUES -.sp -.LP The \fBnet_phylookup()\fR function returns -1 if it is not supported by the network protocol, and 0 if the named network interface does not exist (or is otherwise unknown). Otherwise, it returns a value greater than 0 representing a network interface that currently exists within the scope of this network protocol. .SH CONTEXT -.sp -.LP The \fBnet_phylookup()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -79,7 +67,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_getifname\fR(9F), \fBnet_phygetnext\fR(9F), \fBnet_protocol_lookup\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_protocol_lookup.9f b/usr/src/man/man9f/net_protocol_lookup.9f index cafa4c2c4f..e864a162e4 100644 --- a/usr/src/man/man9f/net_protocol_lookup.9f +++ b/usr/src/man/man9f/net_protocol_lookup.9f @@ -8,7 +8,6 @@ .SH NAME net_protocol_lookup \- locate an implementation of a network layer protocol .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ net_protocol_lookup \- locate an implementation of a network layer protocol .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIid\fR\fR @@ -39,8 +35,6 @@ name of the network protocol to find. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_protocol_lookup()\fR function attempts to locate a data structure that defines what capabilities it is exporting through this interface. The value returned by this call is guaranteed to be valid until it is passed into a @@ -53,19 +47,13 @@ registered. The symbols \fBNHF_INET\fR and \fBNHF_INET6\fR should be passed to \fBnet_protocol_lookup()\fR as the protocol name to gain access to either \fBIPv4\fR or \fBIPv6\fR respectively. .SH RETURN VALUES -.sp -.LP The \fBnet_protocol_lookup()\fR function returns \fBNULL\fR if it does not find any knowledge about the network protocol referenced. Otherwise, it returns a value that can be used with other calls in this framework. .SH CONTEXT -.sp -.LP The \fBnet_protocol_lookup()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -80,6 +68,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_protocol_release\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_protocol_notify_register.9f b/usr/src/man/man9f/net_protocol_notify_register.9f index 0f39ac1173..a896d106f0 100644 --- a/usr/src/man/man9f/net_protocol_notify_register.9f +++ b/usr/src/man/man9f/net_protocol_notify_register.9f @@ -8,7 +8,6 @@ net_protocol_notify_register, net_instance_protocol_unregister \- add/delete a function to be called for changes to a protocol .SH SYNOPSIS -.LP .nf #include <sys/hook.h> #include <sys/neti.h> @@ -25,11 +24,8 @@ function to be called for changes to a protocol .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIfamily\fR\fR @@ -57,8 +53,6 @@ pointer to pass into the \fBcallback()\fR function when a change occurs. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_protocol_notify_register()\fR function registers a function represented by the pointer \fIcallback\fR to be called when there is a change to the protocol represented by \fIfamily\fR. The types of changes for which @@ -110,8 +104,6 @@ is the name of the protocol being added/removed .RE .SH RETURN VALUES -.sp -.LP If these functions succeed, 0 is returned. Otherwise, the following error is returned: .sp @@ -124,12 +116,8 @@ the given callback function is already registered. .RE .SH CONTEXT -.sp -.LP These functions may be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -144,6 +132,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBnet_protocol_lookup\fR(9F) diff --git a/usr/src/man/man9f/net_protocol_release.9f b/usr/src/man/man9f/net_protocol_release.9f index f1759d099d..c5acc5674f 100644 --- a/usr/src/man/man9f/net_protocol_release.9f +++ b/usr/src/man/man9f/net_protocol_release.9f @@ -9,7 +9,6 @@ net_protocol_release \- indicate that a reference to a network protocol is no longer required .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -17,11 +16,8 @@ longer required .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIinfo\fR\fR @@ -31,14 +27,10 @@ value returned from a successful call to \fBnet_protocol_lookup\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_protocol_release()\fR function indicates to the network information framework that the caller is no longer interested in any knowledge about the network protocol to which the parameter being passed through applies. .SH RETURN VALUES -.sp -.LP The \fBnet_protocol_release()\fR function returns: .sp .ne 2 @@ -68,13 +60,9 @@ Unsuccessful because this function has been called too many times. .RE .SH CONTEXT -.sp -.LP The \fBnet_protocol_release()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -89,6 +77,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_protocol_lookup\fR(9F), \fBnet_protocol_walk\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_protocol_walk.9f b/usr/src/man/man9f/net_protocol_walk.9f index 03b90aad15..9fcd5ffd19 100644 --- a/usr/src/man/man9f/net_protocol_walk.9f +++ b/usr/src/man/man9f/net_protocol_walk.9f @@ -7,7 +7,6 @@ .SH NAME net_protocol_walk \- step through the list of registered network protocols .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,11 +14,8 @@ net_protocol_walk \- step through the list of registered network protocols .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -29,8 +25,6 @@ value returned from a successful call to \fBnet_protocol_lookup\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBnet_protocol_walk()\fR function walks through all of the network protocols that have been registered with this interface. The initial call to \fBnet_protocol_walk()\fR should be made by passing in \fBNULL\fR as the value @@ -43,19 +37,13 @@ list of network protocols, until \fBNULL\fR is returned or, when finished with using the value returned, pass it into a call to \fBnet_protocol_release\fR(9F). .SH RETURN VALUES -.sp -.LP The \fBnet_protocol_walk()\fR function returns \fBNULL\fR when the end of the list is returned. Otherwise, it returns a non-\fBNULL\fR value as a token for being passed into other function calls within this interface. .SH CONTEXT -.sp -.LP The \fBnet_protocol_walk()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -70,7 +58,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_protocol_lookup\fR(9F), \fBnet_protocol_release\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_routeto.9f b/usr/src/man/man9f/net_routeto.9f index 6b712656e6..d5ef6b0280 100644 --- a/usr/src/man/man9f/net_routeto.9f +++ b/usr/src/man/man9f/net_routeto.9f @@ -7,7 +7,6 @@ .SH NAME net_routeto \- indicate which network interface packets are sent .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -16,11 +15,8 @@ net_routeto \- indicate which network interface packets are sent .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fInet\fR\fR @@ -50,16 +46,12 @@ passed instead. .RE .SH DESCRIPTION -.sp -.LP The \fBnet_routeto()\fR function indicates which network interface packets destined for a particular address would be sent out of, according to the systems network routing tables. If \fBnext\fR is supplied as a non-\fBNULL\fR pointer, the \fBIP\fR address of the \fBnexthop\fR router to be used is returned in it. .SH RETURN VALUES -.sp -.LP The \fBnet_routeto()\fR function returns: .sp .ne 2 @@ -89,13 +81,9 @@ Indicates which network interface can be used to reach the given address. .RE .SH CONTEXT -.sp -.LP The \fBnet_routeto()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -110,7 +98,5 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_phygetnext\fR(9F), \fBnet_phylookup\fR(9F), \fBnet_protocol_lookup\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/net_zoneidtonetid.9f b/usr/src/man/man9f/net_zoneidtonetid.9f index 96cc1c0267..990e82261e 100644 --- a/usr/src/man/man9f/net_zoneidtonetid.9f +++ b/usr/src/man/man9f/net_zoneidtonetid.9f @@ -7,7 +7,6 @@ .SH NAME net_zoneidtonetid \- map a zoneid_t structure identifier to a netid_t structure .SH SYNOPSIS -.LP .nf #include <sys/neti.h> @@ -15,8 +14,7 @@ net_zoneidtonetid \- map a zoneid_t structure identifier to a netid_t structure .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -27,24 +25,20 @@ valid \fBzoneid_t\fR structure that refers to a running zone. .RE .SH DESCRIPTION -.LP The \fBnet_zoneidtonetid()\fR function maps the given \fBzoneid_t\fR structure (used to represent a zone that is currently running) into a \fBnetid_t\fR structure that is associated with the \fBIP\fR instance supporting network functions for that zone. .SH RETURN VALUES -.LP The \fBnet_zoneidtonetid()\fR function returns -1 if no mapping took place. Otherwise, it returns the \fBnetid_t\fR structure currently used by the \fBzoneid_t\fR structure. For zones that are using a shared \fBIP\fR instance, the \fBnetid_t\fR structure for the instance owned by the global zone is returned. .SH CONTEXT -.LP The \fBnet_zoneidtonetid()\fR function may be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -59,5 +53,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBnet_netidtozonid\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9f/nochpoll.9f b/usr/src/man/man9f/nochpoll.9f index de9b48577a..f93369c4d0 100644 --- a/usr/src/man/man9f/nochpoll.9f +++ b/usr/src/man/man9f/nochpoll.9f @@ -7,7 +7,6 @@ .SH NAME nochpoll \- error return function for non-pollable devices .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -19,11 +18,8 @@ nochpoll \- error return function for non-pollable devices .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdev\fR\fR @@ -69,23 +65,15 @@ Poll head pointer. .RE .SH DESCRIPTION -.sp -.LP The \fBnochpoll()\fR function is a routine that simply returns the value \fBENXIO\fR. It is intended to be used in the \fBcb_ops\fR(9S) structure of a device driver for devices that do not support the \fBpoll\fR(2) system call. .SH RETURN VALUES -.sp -.LP The \fBnochpoll()\fR function returns \fBENXIO\fR. .SH CONTEXT -.sp -.LP The \fBnochpoll()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBpoll\fR(2), \fBchpoll\fR(9E), \fBcb_ops\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/nvlist_add_boolean.9f b/usr/src/man/man9f/nvlist_add_boolean.9f index e50a062d41..1c6056c937 100644 --- a/usr/src/man/man9f/nvlist_add_boolean.9f +++ b/usr/src/man/man9f/nvlist_add_boolean.9f @@ -15,7 +15,6 @@ nvlist_add_int32_array, nvlist_add_uint32_array, nvlist_add_int64_array, nvlist_add_uint64_array, nvlist_add_string_array, nvlist_t \- value pair functions .SH SYNOPSIS -.LP .nf #include <sys/nvpair.h> @@ -161,11 +160,8 @@ functions .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fInvl\fR\fR @@ -211,8 +207,6 @@ Value or starting address of the array value. .RE .SH DESCRIPTION -.sp -.LP These functions add a new name-value pair to an \fBnvlist_t\fR. The memory allocation policy follows that specified in \fBnvlist_alloc()\fR, \fBnvlist_unpack()\fR, or \fBnvlist_dup()\fR. See \fBnvlist_alloc\fR(9F). The @@ -242,7 +236,6 @@ the synchronization. The \fBnvlist_add_boolean()\fR function is deprecated and the \fBnvlist_add_boolean_value()\fR function is used instead. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR\fR @@ -270,8 +263,6 @@ insufficient memory .RE .SH CONTEXT -.sp -.LP These functions can be called from interrupt context only if (1) the default allocator is used and the \fBKM_NOSLEEP\fR flag is set, or (2) the specified allocator did not sleep for free memory (for example, if it uses a diff --git a/usr/src/man/man9f/nvlist_alloc.9f b/usr/src/man/man9f/nvlist_alloc.9f index 8ee31ff69d..f48a5df577 100644 --- a/usr/src/man/man9f/nvlist_alloc.9f +++ b/usr/src/man/man9f/nvlist_alloc.9f @@ -9,7 +9,6 @@ nvlist_alloc, nvlist_free, nvlist_size, nvlist_pack, nvlist_unpack, nvlist_dup, nv_alloc_init, nv_alloc_fini, nvlist_xalloc, nvlist_xpack, nvlist_xunpack, nvlist_xdup, nvlist_merge \- Manage a name-value pair list .SH SYNOPSIS -.LP .nf #include <sys/nvpair.h> @@ -104,8 +103,7 @@ Pluggable Allocation Initialization with Fixed Allocator: .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -234,7 +232,6 @@ Points to a nv_alloc_t structure to be used for the specified \fBnvlist_t\fR. .RE .SH DESCRIPTION -.LP List Manipulation: .sp .LP @@ -336,7 +333,6 @@ has the type \fBNV_UNIQUE_NAME_TYPE\fR). The \fBnvlist_lookup_nv_alloc()\fR function retrieves the pointer to the allocator used when manipulating a name-value pair list. .SS "PLUGGABLE ALLOCATORS" -.LP Using Pluggable Allocators: .sp .LP @@ -419,7 +415,6 @@ When invoked on a fixed-buffer, the \fBnv_alloc_reset()\fR function resets the fixed buffer and prepares it for re-use. The framework consumer is responsible for freeing the buffer passed to \fBnv_alloc_init()\fR. .SS "CREATING PLUGGABLE ALLOCATORS" -.LP Any producer of name-value pairs may possibily specify his own allocator routines. You must provide the following pluggable allocator operations in the allocator implementation. @@ -468,7 +463,6 @@ must exactly match the original allocation. The disposition of the allocated objects and the memory used to store them is left to the allocator implementation. .SH RETURN VALUES -.LP For \fBnvlist_alloc()\fR, \fBnvlist_dup()\fR, \fBnvlist_xalloc()\fR, and \fBnvlist_xdup()\fR: .sp @@ -575,7 +569,6 @@ For \fBnvlist_lookup_nv_alloc()\fR: .LP pointer to the allocator .SH USAGE -.LP The fixed-buffer allocator is very simple allocator. It uses a pre-allocated buffer for memory allocations and it can be used in interrupt context. You are responsible for allocation and de-allocation for the pre-allocated buffer. @@ -627,7 +620,6 @@ responsible for allocation and de-allocation for the pre-allocated buffer. .in -2 .SH CONTEXT -.LP The \fBnvlist_alloc()\fR, \fBnvlist_pack()\fR, \fBnvlist_unpack()\fR, and \fBnvlist_dup()\fR functions can be called from interrupt context only if the \fBKM_NOSLEEP\fR flag is set. They can be called from user context with any diff --git a/usr/src/man/man9f/nvlist_lookup_boolean.9f b/usr/src/man/man9f/nvlist_lookup_boolean.9f index 7fd56883c9..f36112c331 100644 --- a/usr/src/man/man9f/nvlist_lookup_boolean.9f +++ b/usr/src/man/man9f/nvlist_lookup_boolean.9f @@ -173,7 +173,7 @@ indicated by the interface name and retrieve data value .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na diff --git a/usr/src/man/man9f/nvlist_next_nvpair.9f b/usr/src/man/man9f/nvlist_next_nvpair.9f index 7e5ed274a0..d13bb725c8 100644 --- a/usr/src/man/man9f/nvlist_next_nvpair.9f +++ b/usr/src/man/man9f/nvlist_next_nvpair.9f @@ -8,7 +8,6 @@ nvlist_next_nvpair, nvpair_name, nvpair_type \- return data regarding name-value pairs .SH SYNOPSIS -.LP .nf #include <sys/nvpair.h> @@ -26,11 +25,8 @@ name-value pairs .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fInvl\fR\fR @@ -49,8 +45,6 @@ Handle to a name-value pair. .RE .SH DESCRIPTION -.sp -.LP The \fBnvlist_next_nvpair()\fR function returns a handle to the next name-value pair (\fBnvpair\fR) in the list following \fInvpair\fR. If \fInvpair\fR is NULL, the first pair is returned. If \fInvpair\fR is the last pair in the @@ -65,8 +59,6 @@ The \fBnvpair_type()\fR function retrieves the value of the \fInvpair\fR in the form of enumerated type \fBdata_type_t\fR. This is used to determine the appropriate \fBnvpair_*()\fR function to call for retrieving the value. .SH RETURN VALUES -.sp -.LP For \fBnvpair_name()\fR: a string containing the name. .sp .LP @@ -112,6 +104,4 @@ manipulated. This includes \fBnvlist_next_nvpair()\fR, \fBnvpair_name()\fR and created with NV_UNIQUE_NAME_TYPE and NV_UNIQUE_NAME. See \fBnvlist_alloc\fR(9F) for more details. .SH CONTEXT -.sp -.LP These functions can be called from user, interrupt, or kernel context. diff --git a/usr/src/man/man9f/nvlist_remove.9f b/usr/src/man/man9f/nvlist_remove.9f index 0adac9f3ab..c0efcdacd4 100644 --- a/usr/src/man/man9f/nvlist_remove.9f +++ b/usr/src/man/man9f/nvlist_remove.9f @@ -7,7 +7,6 @@ .SH NAME nvlist_remove, nvlist_remove_all \- remove name-value pairs .SH SYNOPSIS -.LP .nf #include <sys/nvpair.h> @@ -20,11 +19,8 @@ nvlist_remove, nvlist_remove_all \- remove name-value pairs .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fInvl\fR\fR @@ -52,8 +48,6 @@ Data type of the \fBnvpair\fR to be removed. .RE .SH DESCRIPTION -.sp -.LP The \fBnvlist_remove()\fR function removes the first occurrence of \fInvpair\fR that matches the name and the type. .sp @@ -66,16 +60,11 @@ Multiple threads can simultaneously read the same \fBnvlist_t\fR but only one thread may actively change a given \fBnvlist_t\fR at a time. The caller is responsible for the synchronization. .SH RETURN VALUES -.sp -.LP These functions return \fB0\fR on success and an error value on failure. .SH CONTEXT -.sp -.LP The \fBnvlist_remove()\fR and \fBnvlist_remove_all()\fR functions can be called from user, interrupt, or kernel context. .SH ERRORS -.sp .ne 2 .na \fBEINVAL\fR diff --git a/usr/src/man/man9f/nvpair_value_byte.9f b/usr/src/man/man9f/nvpair_value_byte.9f index bb7474f654..06d1fdcd68 100644 --- a/usr/src/man/man9f/nvpair_value_byte.9f +++ b/usr/src/man/man9f/nvpair_value_byte.9f @@ -15,7 +15,6 @@ nvpair_value_uint16_array, nvpair_value_uint32_array, nvpair_value_uint64_array, nvpair_value_string_array \- retrieve value from a name-value pair .SH SYNOPSIS -.LP .nf #include <sys/nvpair.h> @@ -150,11 +149,8 @@ name-value pair .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fInvpair\fR\fR @@ -182,8 +178,6 @@ Address to store the value or starting address of array value. .RE .SH DESCRIPTION -.sp -.LP These functions retrieve the value of \fInvpair\fR. The data type of \fInvpair\fR must match the function name for the call to be successful. .sp @@ -203,7 +197,6 @@ removed from or replaced in an nvlist. Replacement can happen during pair addition on nvlists created with NV_UNIQUE_NAME_TYPE and NV_UNIQUE_NAME. See \fBnvlist_alloc(9F)\fR for more details. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR\fR @@ -223,6 +216,4 @@ match the interface name. .RE .SH CONTEXT -.sp -.LP These functions can be called from user, interrupt, or kernel context. diff --git a/usr/src/man/man9f/pci_config_get8.9f b/usr/src/man/man9f/pci_config_get8.9f index f315bf6713..07954c4780 100644 --- a/usr/src/man/man9f/pci_config_get8.9f +++ b/usr/src/man/man9f/pci_config_get8.9f @@ -11,7 +11,6 @@ pci_config_getb, pci_config_getl, pci_config_getll, pci_config_getw, pci_config_putb, pci_config_putl, pci_config_putll, pci_config_putw \- read or write single datum of various sizes to the PCI Local Bus Configuration space .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -61,9 +60,7 @@ write single datum of various sizes to the PCI Local Bus Configuration space .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBpci_config_getb()\fR, +illumos DDI specific (illumos DDI). The \fBpci_config_getb()\fR, \fBpci_config_getl()\fR, \fBpci_config_getll()\fR, \fBpci_config_getw()\fR, \fBpci_config_putb()\fR, \fBpci_config_putl()\fR, \fBpci_config_putll()\fR, and \fBpci_config_putw()\fR functions are obsolete. The \fBpci_config_get8()\fR @@ -76,7 +73,6 @@ replaces \fBpci_config_putl()\fR. The \fBpci_config_put64()\fR function replaces \fBpci_config_putll()\fR. The \fBpci_config_put16()\fR function replaces \fBpci_config_putw()\fR. .SH PARAMETERS -.sp .ne 2 .na \fB\fIhandle\fR\fR @@ -104,8 +100,6 @@ Output data. .RE .SH DESCRIPTION -.sp -.LP These routines read or write a single datum of various sizes from or to the \fBPCI \fRLocal Bus Configuration space. The \fBpci_config_get8()\fR, \fBpci_config_get16()\fR, \fBpci_config_get32()\fR, and @@ -123,18 +117,12 @@ format to or from little endian format. .LP \fBpci_config_setup\fR(9F) must be called before invoking these functions. .SH RETURN VALUES -.sp -.LP \fBpci_config_get8()\fR, \fBpci_config_get16()\fR, \fBpci_config_get32()\fR, and \fBpci_config_get64()\fR return the value read from the \fBPCI \fRLocal Bus Configuration space. .SH CONTEXT -.sp -.LP These routines can be called from user, kernel, or interrupt context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -151,6 +139,4 @@ T} .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBpci_config_setup\fR(9F), \fBpci_config_teardown\fR(9F) diff --git a/usr/src/man/man9f/pci_config_setup.9f b/usr/src/man/man9f/pci_config_setup.9f index f59cb89d08..ac3e77e395 100644 --- a/usr/src/man/man9f/pci_config_setup.9f +++ b/usr/src/man/man9f/pci_config_setup.9f @@ -8,7 +8,6 @@ pci_config_setup, pci_config_teardown \- setup or tear down the resources for enabling accesses to the PCI Local Bus Configuration space .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -24,8 +23,7 @@ enabling accesses to the PCI Local Bus Configuration space .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -45,13 +43,11 @@ Pointer to a data access handle. .RE .SH DESCRIPTION -.LP \fBpci_config_setup()\fR sets up the necessary resources for enabling subsequent data accesses to the \fBPCI \fRLocal Bus Configuration space. \fBpci_config_teardown()\fR reclaims and removes those resources represented by the data access handle returned from \fBpci_config_setup()\fR. .SH RETURN VALUES -.LP \fBpci_config_setup()\fR returns: .sp .ne 2 @@ -72,16 +68,13 @@ Unable to allocate resources for setup. .RE .SH CONTEXT -.LP \fBpci_config_setup()\fR must be called from user or kernel context. \fBpci_config_teardown()\fR can be called from any context. .SH NOTES -.LP These functions are specific to \fBPCI \fRbus device drivers. For drivers using these functions, a single source to support devices with multiple bus versions may not be easy to maintain. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -96,7 +89,6 @@ Architecture PCI Local Bus .TE .SH SEE ALSO -.LP \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man9f/pci_ereport_setup.9f b/usr/src/man/man9f/pci_ereport_setup.9f index 649db95543..32f8774a3e 100644 --- a/usr/src/man/man9f/pci_ereport_setup.9f +++ b/usr/src/man/man9f/pci_ereport_setup.9f @@ -8,7 +8,6 @@ pci_ereport_setup, pci_ereport_teardown, pci_ereport_post \- post error reports for the generic PCI errors logged in the PCI Configuration Status register. .SH SYNOPSIS -.LP .nf #include <sys/sunddi.h> @@ -27,8 +26,7 @@ for the generic PCI errors logged in the PCI Configuration Status register. .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -57,7 +55,6 @@ Pointer to status bit storage location .RE .SH DESCRIPTION -.LP The \fBpci_ereport_setup()\fR function initializes support for error report generation and sets up the resources for subsequent access to \fBPCI\fR, \fBPCI/X\fR or \fBPCI Express Configuration\fR space. The caller must have @@ -163,7 +160,7 @@ Error report events are generated automatically if \fBfme_flag\fR is set to \fBDDI_FM_ERR_UNEXPECTED\fR and the corresponding error bits are set in the various \fBPCI\fR, \fBPCI/X\fR or \fBPCI Express Bus\fR error registers of the device associated with \fIdip\fR. The generated error report events are posted -to the Solaris Fault Manager, \fBfmd\fR(1M), for diagnosis. +to the illumos Fault Manager, \fBfmd\fR(1M), for diagnosis. .sp .LP If the status argument is non-null, \fBpci_ereport_post()\fR saves the contents @@ -219,7 +216,6 @@ error on the operational state of the system. This is treated the same way as .RE .SH CONTEXT -.LP The \fBpci_ereport_setup()\fR and \fBpci_ereport_teardown()\fR functions must be called from user or kernel context. .sp @@ -260,7 +256,6 @@ xxx_detach(dev_info_t *dip, ddi_attach_cmd_t cmd) { .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -275,7 +270,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBfmd\fR(1M), \fBattributes\fR(5), \fBddi_fm_handler_register\fR(9F), \fBddi_fm_init\fR(9F), \fBddi_peek\fR(9F), \fBddi_poke\fR(9F), \fBddi_fm_error\fR(9S) diff --git a/usr/src/man/man9f/pci_report_pmcap.9f b/usr/src/man/man9f/pci_report_pmcap.9f index d077596020..868a9835da 100644 --- a/usr/src/man/man9f/pci_report_pmcap.9f +++ b/usr/src/man/man9f/pci_report_pmcap.9f @@ -7,7 +7,6 @@ .SH NAME pci_report_pmcap \- Report Power Management capability of a PCI device .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -18,11 +17,8 @@ pci_report_pmcap \- Report Power Management capability of a PCI device .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -50,8 +46,6 @@ Argument for the capability .RE .SH DESCRIPTION -.sp -.LP Some PCI devices provide power management capabilities in addition to those provided by the PCI Power Management Specification. The \fBpci_report_pmcap()\fR function reports those Power Management capabilities @@ -92,8 +86,6 @@ If the driver doesn't make this call, \fBPCI_PM_IDLESPEED_NONE\fR is assumed. In this case, one offending device can keep the entire bus from being power managed. .SH RETURN VALUES -.sp -.LP The \fBpci_report_pmcap()\fR function returns: .sp .ne 2 @@ -114,13 +106,9 @@ Failure to report capability because of invalid argument(s) .RE .SH CONTEXT -.sp -.LP The \fBpci_report_pmcap()\fR function can be called from user, kernel and interrupt context. .SH EXAMPLES -.sp -.LP 1. A device driver knows that the device it controls works with any clock between DC and 33 MHz as specified in \fISection 4.2.3.1: Clock Specification \fR of the \fIPCI Bus Specification Revision 2.1\fR. The device driver makes @@ -152,8 +140,6 @@ if (pci_report_pmcap(dip, PCI_PM_IDLESPEED, (void *)4000) != .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -168,8 +154,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR .sp .LP diff --git a/usr/src/man/man9f/pci_save_config_regs.9f b/usr/src/man/man9f/pci_save_config_regs.9f index 49d2d2ff9c..2aa230d691 100644 --- a/usr/src/man/man9f/pci_save_config_regs.9f +++ b/usr/src/man/man9f/pci_save_config_regs.9f @@ -8,7 +8,6 @@ pci_save_config_regs, pci_restore_config_regs \- save and restore the PCI configuration registers .SH SYNOPSIS -.LP .nf \fB#include <sys/ddi.h>\fR \fB#include <sys/sunddi.h>\fR @@ -24,11 +23,8 @@ configuration registers .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI-specific (Solaris DDI). +illumos DDI-specific (illumos DDI). .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -38,8 +34,6 @@ Pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fBpci_save_config_regs()\fR saves the current configuration registers on persistent system memory. \fBpci_restore_config_regs()\fR restores configuration registers previously saved by \fBpci_save_config_regs()\fR. @@ -50,8 +44,6 @@ entry point before powering a device off (to PCI state D3). Likewise, \fBpci_restore_config_regs()\fR should be called after powering a device on (from PCI state D3), but before accessing the device. See \fBpower\fR(9E). .SH RETURN VALUES -.sp -.LP \fBpci_save_config_regs()\fR and \fBpci_restore_config_regs()\fR return: .sp .ne 2 @@ -72,11 +64,8 @@ Operation failed to complete successfully. .RE .SH CONTEXT -.sp -.LP Both these functions can be called from user or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRInvoking the save and restore functions .sp .in +2 @@ -130,8 +119,6 @@ xx_power(dev_info_t *dip, int component, int level) { .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -146,8 +133,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBpower\fR(9E) .sp .LP diff --git a/usr/src/man/man9f/physio.9f b/usr/src/man/man9f/physio.9f index 14957980b4..8c72550bd6 100644 --- a/usr/src/man/man9f/physio.9f +++ b/usr/src/man/man9f/physio.9f @@ -8,7 +8,6 @@ .SH NAME physio, minphys \- perform physical I/O .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/buf.h> @@ -26,12 +25,9 @@ physio, minphys \- perform physical I/O .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .SS "\fBphysio()\fR" -.sp .ne 2 .na \fB\fIstrat\fR \fR @@ -89,7 +85,6 @@ Pointer to the \fBuio\fR structure which describes the user \fBI/O\fR request. .RE .SS "\fBminphys()\fR" -.sp .ne 2 .na \fB\fIbp\fR \fR @@ -99,8 +94,6 @@ Pointer to a \fBbuf\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fBphysio()\fR performs unbuffered \fBI/O\fR operations between the device \fIdev\fR and the address space described in the \fBuio\fR structure. .sp @@ -127,8 +120,6 @@ default for the capabilities of the system. Drivers that provide their own \fBmincnt()\fR routine should also call \fBminphys()\fR to make sure they do not exceed the system limit. .SH RETURN VALUES -.sp -.LP \fBphysio()\fR returns: .sp .ne 2 @@ -149,20 +140,14 @@ Upon failure. .RE .SH CONTEXT -.sp -.LP \fBphysio()\fR can be called from user context only. .SH SEE ALSO -.sp -.LP \fBstrategy\fR(9E), \fBbiodone\fR(9F), \fBbiowait\fR(9F), \fBbuf\fR(9S), \fBuio\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP Since \fBphysio()\fR calls \fBbiowait()\fR to block until each buf transfer is complete, it is the drivers responsibility to call \fBbiodone\fR(9F) when the transfer is complete, or \fBphysio()\fR will block forever. diff --git a/usr/src/man/man9f/pm_busy_component.9f b/usr/src/man/man9f/pm_busy_component.9f index 0221e06fac..593a0f2294 100644 --- a/usr/src/man/man9f/pm_busy_component.9f +++ b/usr/src/man/man9f/pm_busy_component.9f @@ -8,7 +8,6 @@ pm_busy_component, pm_idle_component \- control device component availability for Power Management .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -24,11 +23,8 @@ for Power Management .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -47,8 +43,6 @@ The number of the component to be power-managed. .RE .SH DESCRIPTION -.sp -.LP The \fBpm_busy_component()\fR function sets \fIcomponent\fR of \fIdip\fR to be busy. Calls to \fBpm_busy_component()\fR are stacked, requiring a corresponding number of calls to \fBpm_idle_component()\fR to make the component idle again. @@ -68,8 +62,6 @@ If these functions are called as a result of entry into the driver's functions must be called from the same thread which entered \fBattach\fR(9E), \fBdetach\fR(9E) or \fBpower\fR(9E). .SH RETURN VALUES -.sp -.LP The \fBpm_busy_component()\fR and \fBpm_idle_component()\fR functions return: .sp .ne 2 @@ -90,14 +82,10 @@ Invalid component number \fIcomponent\fR or the device has no components. .RE .SH CONTEXT -.sp -.LP These functions can be called from user or kernel context. These functions may also be called from interrupt context, providing they are not the first Power Management function called by the driver. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -112,8 +100,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBpower.conf\fR(4), \fBpm\fR(7D), \fBattach\fR(9E), \fBdetach\fR(9E), \fBpower\fR(9E), \fBpm_raise_power\fR(9F), \fBpm\fR(9P), \fBpm-components\fR(9P) diff --git a/usr/src/man/man9f/pm_power_has_changed.9f b/usr/src/man/man9f/pm_power_has_changed.9f index 4be174f197..4ea0032dd4 100644 --- a/usr/src/man/man9f/pm_power_has_changed.9f +++ b/usr/src/man/man9f/pm_power_has_changed.9f @@ -8,7 +8,6 @@ pm_power_has_changed \- Notify Power Management framework of autonomous power level change .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -17,11 +16,8 @@ level change .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -49,8 +45,6 @@ Power level to which the indicated component has changed .RE .SH DESCRIPTION -.sp -.LP The \fBpm_power_has_changed\fR(9F) function notifies the Power Management framework that the power level of component of \fIdip \fR has changed to \fIlevel\fR. @@ -84,8 +78,6 @@ function must be called from the same thread which entered \fBattach\fR(9E), \fBdetach\fR(9E) or \fBpower\fR(9E). .RE .SH RETURN VALUES -.sp -.LP The \fBpm_power_has_changed()\fR function returns: .sp .ne 2 @@ -106,14 +98,10 @@ Invalid component \fIcomponent\fR or power level \fIlevel\fR. .RE .SH CONTEXT -.sp -.LP This function can be called from user or kernel context. This function can also be called from interrupt context, providing that it is not the first Power Management function called by the driver. .SH EXAMPLES -.sp -.LP A hypothetical driver might include this code to handle \fBpm_power_has_changed\fR(9F): .sp @@ -164,8 +152,6 @@ xxdisk_power(dev_info *dip, int comp, int level) .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -180,8 +166,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBpower.conf\fR(4), \fBpm\fR(7D), \fBattach\fR(9E), \fBdetach\fR(9E), \fBpower\fR(9E), \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F), \fBpm_raise_power\fR(9F), \fBpm_lower_power\fR(9F), \fBpm\fR(9P), diff --git a/usr/src/man/man9f/pm_raise_power.9f b/usr/src/man/man9f/pm_raise_power.9f index 9fd65bab63..d3277f468e 100644 --- a/usr/src/man/man9f/pm_raise_power.9f +++ b/usr/src/man/man9f/pm_raise_power.9f @@ -7,7 +7,6 @@ .SH NAME pm_raise_power, pm_lower_power \- Raise or lower power of components .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -21,12 +20,9 @@ pm_raise_power, pm_lower_power \- Raise or lower power of components .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .SS "pm_raise_power" -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -54,7 +50,6 @@ The power level to which the indicated \fIcomponent\fR will be raised .RE .SS "pm_lower_power" -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -82,8 +77,6 @@ Power level to which the indicated \fIcomponent\fR will be lowered .RE .SH DESCRIPTION -.sp -.LP The \fBpm_raise_power\fR(9F) function requests the Power Management framework to raise the power level of \fIcomponent \fRof \fIdip\fR to at least \fIlevel. \fR @@ -145,8 +138,6 @@ functions must be called from the same thread which entered \fBattach\fR(9E), \fBdetach\fR(9E) or \fBpower\fR(9E). .RE .SH RETURN VALUES -.sp -.LP The \fBpm_raise_power\fR(9F) function returns: .sp .ne 2 @@ -192,8 +183,6 @@ is not detaching. .RE .SH EXAMPLES -.sp -.LP A hypothetical disk driver might include this code to handle \fBpm_raise_power\fR(9F): .sp @@ -267,12 +256,8 @@ xxdisk_power(dev_info *dip, int comp, int level) .in -2 .SH CONTEXT -.sp -.LP These functions can be called from user or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attribute: .sp @@ -287,8 +272,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBpower.conf\fR(4), \fBpm\fR(7D), \fBattach\fR(9E), \fBdetach\fR(9E), \fBpower\fR(9E), \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F), \fBpm\fR(9P), \fBpm-components\fR(9P) diff --git a/usr/src/man/man9f/pm_trans_check.9f b/usr/src/man/man9f/pm_trans_check.9f index b40063d458..3ad0bf1ccd 100644 --- a/usr/src/man/man9f/pm_trans_check.9f +++ b/usr/src/man/man9f/pm_trans_check.9f @@ -7,7 +7,6 @@ .SH NAME pm_trans_check \- Device power cycle advisory check .SH SYNOPSIS -.LP .nf #include <sys/sunddi.h> @@ -15,11 +14,8 @@ pm_trans_check \- Device power cycle advisory check .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdatap\fR\fR @@ -38,8 +34,6 @@ Pointer to time difference when next power cycle will be advised .RE .SH DESCRIPTION -.sp -.LP The \fBpm_trans_check()\fR function checks if a power-cycle is currently advised based on data in the \fBpm_trans_data\fR structure. This function is provided to prevent damage to devices from excess power cycles; drivers for @@ -96,7 +90,6 @@ struct pm_trans_data { .in -2 .SH RETURN VALUES -.sp .ne 2 .na \fB\fB1\fR\fR @@ -124,8 +117,6 @@ Error due to invalid argument. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -140,8 +131,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBpower.conf\fR(4), \fBattributes\fR(5), \fBpower\fR(9E) .sp .LP diff --git a/usr/src/man/man9f/priv_getbyname.9f b/usr/src/man/man9f/priv_getbyname.9f index b817b0d7f3..f60b76d366 100644 --- a/usr/src/man/man9f/priv_getbyname.9f +++ b/usr/src/man/man9f/priv_getbyname.9f @@ -7,7 +7,6 @@ .SH NAME priv_getbyname \- map a privilege name to a number .SH SYNOPSIS -.LP .nf #include <sys/cred.h> @@ -17,11 +16,8 @@ priv_getbyname \- map a privilege name to a number .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIpriv\fR\fR @@ -40,8 +36,6 @@ flags, must be zero or \fBPRIV_ALLOC\fR .RE .SH DESCRIPTION -.sp -.LP The \fBpriv_getbyname()\fR function maps a privilege name to a privilege number for use with the \fBpriv_*()\fR kernel interfaces. .sp @@ -61,12 +55,9 @@ Privilege names are case insensitive but allocated privileges preserve case. Allocated privileges can be at most \fB{PRIVNAME_MAX}\fR characters long and can contain only alphanumeric characters and the underscore character. .SH RETURN VALUES -.sp -.LP This function returns the privilege number, which is greater than or equal to 0, if it succeeds. It returns a negative error number if an error occurs. .SH ERRORS -.sp .ne 2 .na \fB\fBEINVAL\fR\fR @@ -113,12 +104,8 @@ An attempt was made to allocate a privilege that was longer than .RE .SH CONTEXT -.sp -.LP This functions can be called from user and kernel contexts. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -135,8 +122,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBprivileges\fR(5) .sp .LP diff --git a/usr/src/man/man9f/priv_policy.9f b/usr/src/man/man9f/priv_policy.9f index 9178229d8d..e84cb344e3 100644 --- a/usr/src/man/man9f/priv_policy.9f +++ b/usr/src/man/man9f/priv_policy.9f @@ -8,7 +8,6 @@ priv_policy, priv_policy_only, priv_policy_choice \- check, report, and audit privileges .SH SYNOPSIS -.LP .nf #include <sys/policy.h> @@ -29,11 +28,8 @@ privileges .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIcr\fR\fR @@ -83,8 +79,6 @@ included in the output, NULL is usually the best value to pass as a parameter. .RE .SH DESCRIPTION -.sp -.LP These functions aid in privilege checking and privilege debugging. .sp .LP @@ -106,8 +100,6 @@ and has no side effects. The \fBpriv_policy_choice()\fR function behaves like \fBpriv_policy_only()\fR but records the successfully used non-basic privileges in the audit trail. .SH RETURN VALUES -.sp -.LP On success, \fBpriv_policy()\fR return 0. On failure it returns its parameter \fIerr\fR. .sp @@ -115,7 +107,6 @@ On success, \fBpriv_policy()\fR return 0. On failure it returns its parameter On success, \fBpriv_policy_choice()\fR and \fBpriv_policy_only()\fR return 1, on failure both return 0. .SH ERRORS -.sp .ne 2 .na \fB\fBEINVAL\fR\fR @@ -162,12 +153,8 @@ An attempt was made to allocate a privilege that was longer than .RE .SH CONTEXT -.sp -.LP This functions can be called from user, interrupt, or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -182,8 +169,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBacct\fR(3HEAD), \fBattributes\fR(5), \fBprivileges\fR(5) .sp .LP diff --git a/usr/src/man/man9f/proc_signal.9f b/usr/src/man/man9f/proc_signal.9f index 27b5f99034..d81b55e273 100644 --- a/usr/src/man/man9f/proc_signal.9f +++ b/usr/src/man/man9f/proc_signal.9f @@ -8,7 +8,6 @@ .SH NAME proc_signal, proc_ref, proc_unref \- send a signal to a process .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -30,11 +29,8 @@ proc_signal, proc_ref, proc_unref \- send a signal to a process .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIpref\fR\fR @@ -53,8 +49,6 @@ Signal number to be sent to the process. .RE .SH DESCRIPTION -.sp -.LP This set of routines allows a driver to send a signal to a process. The routine \fBproc_ref()\fR is used to retrieve an unambiguous reference to the process for signalling purposes. The return value can be used as a unique handle on the @@ -139,8 +133,6 @@ calling \fBproc_unref()\fR. The driver writer must ensure that for each call made to \fBproc_ref()\fR, there is exactly one corresponding call to \fBproc_unref()\fR. .SH RETURN VALUES -.sp -.LP The \fBproc_ref()\fR returns the following: .sp .ne 2 @@ -173,14 +165,10 @@ The process no longer exists; no signal was sent. .RE .SH CONTEXT -.sp -.LP The \fBproc_unref()\fR and \fBproc_signal()\fR functions can be called from user, interrupt, or kernel context. The \fBproc_ref()\fR function should be called only from user context. .SH SEE ALSO -.sp -.LP \fBsignal.h\fR(3HEAD), \fBputnextctl1\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/qassociate.9f b/usr/src/man/man9f/qassociate.9f index 4f2c4eb591..1b75e9b9c6 100644 --- a/usr/src/man/man9f/qassociate.9f +++ b/usr/src/man/man9f/qassociate.9f @@ -7,7 +7,6 @@ .SH NAME qassociate \- associate STREAMS queue with driver instance .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/stream.h> @@ -19,11 +18,8 @@ qassociate \- associate STREAMS queue with driver instance .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fBqueue_t *\fIq\fR\fR @@ -43,8 +39,6 @@ Driver instance number or -1. .RE .SH DESCRIPTION -.sp -.LP The \fBqassociate()\fR function must be used by \fBDLPI\fR style 2 device drivers to manage the association between STREAMS queues and device instances. The \fBgld\fR(7D) does this automatically on behalf of drivers based on it. It @@ -75,12 +69,9 @@ specified instance. Any prior association is left untouched. The interface typically fails because of failure to locate and attach the device instance. The interface never fails if the specified instance is -1. .SH CONTEXT -.sp -.LP The \fBqassociate()\fR function can be called from the stream's \fBput\fR(9E) entry point. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR\fR @@ -99,8 +90,6 @@ Failure. .RE .SH EXAMPLES -.sp -.LP DLPI style 2 network driver \fBDL_ATTACH_REQ\fR code specifies: .sp .in +2 @@ -142,7 +131,5 @@ qassociate(q, -1); This informs the framework that this driver has been modified to be DDI-compliant. .SH SEE ALSO -.sp -.LP \fBdlpi\fR(7P), \fBgld\fR(7D), \fBopen\fR(9E), \fBput\fR(9E), \fBddi_no_info\fR(9F), \fBqueue\fR(9S) diff --git a/usr/src/man/man9f/qbufcall.9f b/usr/src/man/man9f/qbufcall.9f index 2c9dbb0e1d..d409ad72d7 100644 --- a/usr/src/man/man9f/qbufcall.9f +++ b/usr/src/man/man9f/qbufcall.9f @@ -7,7 +7,6 @@ .SH NAME qbufcall \- call a function when a buffer becomes available .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ qbufcall \- call a function when a buffer becomes available .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIq\fR\fR @@ -69,8 +65,6 @@ Argument to the function to be called when a buffer becomes available. .RE .SH DESCRIPTION -.sp -.LP The \fBqbufcall()\fR function serves as a \fBqtimeout\fR(9F) call of indeterminate length. When a buffer allocation request fails, \fBqbufcall()\fR can be used to schedule the routine \fIfunc\fR to be called with the argument @@ -91,20 +85,14 @@ close routine calls \fBqprocsoff\fR(9F). \fBqprocson\fR(9F) must be called before calling either \fBqbufcall()\fR or \fBqtimeout\fR(9F). .SH RETURN VALUES -.sp -.LP If successful, the \fBqbufcall()\fR function returns a \fBqbufcall\fR \fBID\fR that can be used in a call to \fBqunbufcall\fR(9F) to cancel the request. If the \fBqbufcall()\fR scheduling fails, \fIfunc\fR is never called and \fB0\fR is returned. .SH CONTEXT -.sp -.LP The \fBqbufcall()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBallocb\fR(9F), \fBmt-streams\fR(9F), \fBqprocson\fR(9F), \fBqtimeout\fR(9F), \fBqunbufcall\fR(9F), \fBquntimeout\fR(9F) .sp @@ -114,8 +102,6 @@ context. .LP \fISTREAMS Programming Guide\fR .SH WARNINGS -.sp -.LP Even when \fIfunc\fR is called by \fBqbufcall()\fR, \fBallocb\fR(9F) can fail if another module or driver had allocated the memory before \fIfunc\fR was able to call \fBallocb\fR(9F). diff --git a/usr/src/man/man9f/qtimeout.9f b/usr/src/man/man9f/qtimeout.9f index b120ffd6e5..5a78f82ec3 100644 --- a/usr/src/man/man9f/qtimeout.9f +++ b/usr/src/man/man9f/qtimeout.9f @@ -8,7 +8,6 @@ .SH NAME qtimeout \- execute a function after a specified length of time .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/ddi.h> @@ -19,11 +18,8 @@ qtimeout \- execute a function after a specified length of time .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIq\fR\fR @@ -61,8 +57,6 @@ Number of clock ticks to wait before the function is called. Use .RE .SH DESCRIPTION -.sp -.LP The \fBqtimeout()\fR function schedules the specified function \fIfunc\fR to be called after a specified time interval. \fIfunc\fR is called with \fIarg\fR as a parameter. Control is immediately returned to the caller. This is useful when @@ -84,19 +78,13 @@ close routine calls \fBqprocsoff\fR(9F). .LP The \fBqprocson\fR(9F) function must be called before calling \fBqtimeout()\fR. .SH RETURN VALUES -.sp -.LP The \fBqtimeout()\fR function returns an opaque non-zero \fBtimeout\fR identifier that can be passed to \fBquntimeout\fR(9F) to cancel the request. Note: No value is returned from the called function. .SH CONTEXT -.sp -.LP The \fBqtimeout()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBdrv_usectohz\fR(9F), \fBmt-streams\fR(9F), \fBqbufcall\fR(9F), \fBqprocson\fR(9F), \fBqunbufcall\fR(9F), \fBquntimeout\fR(9F) .sp diff --git a/usr/src/man/man9f/qunbufcall.9f b/usr/src/man/man9f/qunbufcall.9f index d61f4a0f0a..048146241b 100644 --- a/usr/src/man/man9f/qunbufcall.9f +++ b/usr/src/man/man9f/qunbufcall.9f @@ -7,7 +7,6 @@ .SH NAME qunbufcall \- cancel a pending qbufcall request .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/ddi.h> @@ -17,11 +16,8 @@ qunbufcall \- cancel a pending qbufcall request .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIq\fR\fR @@ -40,8 +36,6 @@ Identifier returned from \fBqbufcall\fR(9F). .RE .SH DESCRIPTION -.sp -.LP The \fBqunbufcall()\fR function cancels a pending \fBqbufcall()\fR request. The argument \fIid\fR is a non-zero identifier of the request to be cancelled. \fIid\fR is returned from the \fBqbufcall()\fR function used to issue the @@ -56,13 +50,9 @@ is blocked at the perimeters associated with the queue. All outstanding timeouts and bufcalls must be cancelled before a driver close routine can block and before the close routine calls \fBqprocsoff\fR(9F). .SH CONTEXT -.sp -.LP The \fBqunbufcall()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBmt-streams\fR(9F), \fBqbufcall\fR(9F), \fBqtimeout\fR(9F), \fBquntimeout\fR(9F) .sp diff --git a/usr/src/man/man9f/quntimeout.9f b/usr/src/man/man9f/quntimeout.9f index a5afa3e416..4cf660d375 100644 --- a/usr/src/man/man9f/quntimeout.9f +++ b/usr/src/man/man9f/quntimeout.9f @@ -7,7 +7,6 @@ .SH NAME quntimeout \- cancel previous qtimeout function call .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/ddi.h> @@ -18,11 +17,8 @@ quntimeout \- cancel previous qtimeout function call .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIq\fR\fR @@ -41,8 +37,6 @@ Opaque timeout \fBID\fR a previous \fBqtimeout\fR(9F) call. .RE .SH DESCRIPTION -.sp -.LP The \fBquntimeout()\fR function cancels a pending \fBqtimeout\fR(9F) request. The \fBquntimeout()\fR function is tailored to be used with the enhanced \fBSTREAMS\fR framework interface, which is based on the concept of perimeters. @@ -54,18 +48,12 @@ returns. All outstanding timeouts and bufcalls must be cancelled before a driver close routine can block and before the close routine calls \fBqprocsoff\fR(9F). .SH RETURN VALUES -.sp -.LP The \fBquntimeout()\fR function returns \fB-1\fR if the \fBid\fR is not found. Otherwise, \fBquntimeout()\fR returns a \fB0\fR or positive value. .SH CONTEXT -.sp -.LP The \fBquntimeout()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBmt-streams\fR(9F), \fBqbufcall\fR(9F), \fBqtimeout\fR(9F), \fBqunbufcall\fR(9F) .sp diff --git a/usr/src/man/man9f/qwait.9f b/usr/src/man/man9f/qwait.9f index 9c64aec997..9542c0cab5 100644 --- a/usr/src/man/man9f/qwait.9f +++ b/usr/src/man/man9f/qwait.9f @@ -7,7 +7,6 @@ .SH NAME qwait, qwait_sig \- STREAMS wait routines .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/ddi.h> @@ -23,11 +22,8 @@ qwait, qwait_sig \- STREAMS wait routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIqp\fR\fR @@ -37,8 +33,6 @@ Pointer to the queue that is being opened or closed. .RE .SH DESCRIPTION -.sp -.LP \fBqwait()\fR and \fBqwait_sig()\fR are used to wait for a message to arrive to the \fBput\fR(9E) or \fBsrv\fR(9E) procedures. \fBqwait()\fR and \fBqwait_sig()\fR can also be used to wait for \fBqbufcall\fR(9F) or @@ -81,7 +75,6 @@ returns zero when the waiting was interrupted by a signal. perimeters and the signalling is implicit when a thread leaves the inner perimeter. See \fBcondvar\fR(9F). .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR\fR @@ -92,12 +85,9 @@ signaled, and the function returned because a signal was pending. .RE .SH CONTEXT -.sp -.LP These functions can only be called from an \fBopen\fR(9E) or \fBclose\fR(9E) routine. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBqwait()\fR .sp .LP @@ -144,8 +134,6 @@ xxrput(qp, mp) .in -2 .SH SEE ALSO -.sp -.LP \fBclose\fR(9E), \fBopen\fR(9E), \fBput\fR(9E), \fBsrv\fR(9E), \fBcondvar\fR(9F), \fBddi_can_receive_sig\fR(9F), \fBmt-streams\fR(9F), \fBqbufcall\fR(9F), \fBqprocson\fR(9F), \fBqtimeout\fR(9F) diff --git a/usr/src/man/man9f/qwriter.9f b/usr/src/man/man9f/qwriter.9f index 7920cfa753..4a5ccaf51b 100644 --- a/usr/src/man/man9f/qwriter.9f +++ b/usr/src/man/man9f/qwriter.9f @@ -7,7 +7,6 @@ .SH NAME qwriter \- asynchronous STREAMS perimeter upgrade .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/ddi.h> @@ -18,11 +17,8 @@ qwriter \- asynchronous STREAMS perimeter upgrade .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIqp\fR \fR @@ -60,8 +56,6 @@ Either \fBPERIM_INNER\fR or \fBPERIM_OUTER\fR. .RE .SH DESCRIPTION -.sp -.LP \fBqwriter()\fR is used to upgrade the access at either the inner or the outer perimeter from shared to exclusive and call the specified callback function when the upgrade has succeeded. See \fBmt-streams\fR(9F). The callback function @@ -90,14 +84,10 @@ framework will prevent other messages from entering the inner perimeter associated with the queue until the upgrade has completed and the callback function has finished executing. .SH CONTEXT -.sp -.LP \fBqwriter()\fR can only be called from an \fBput\fR(9E) or \fBsrv\fR(9E) routine, or from a \fBqwriter()\fR, \fBqtimeout\fR(9F), or \fBqbufcall\fR(9F) callback function. .SH SEE ALSO -.sp -.LP \fBput\fR(9E), \fBsrv\fR(9E), \fBmt-streams\fR(9F), \fBqbufcall\fR(9F), \fBqtimeout\fR(9F) .sp diff --git a/usr/src/man/man9f/rwlock.9f b/usr/src/man/man9f/rwlock.9f index 5186d4aa54..d43b062505 100644 --- a/usr/src/man/man9f/rwlock.9f +++ b/usr/src/man/man9f/rwlock.9f @@ -9,7 +9,6 @@ rwlock, rw_init, rw_destroy, rw_enter, rw_exit, rw_tryenter, rw_downgrade, rw_tryupgrade, rw_read_locked \- readers/writer lock functions .SH SYNOPSIS -.LP .nf #include <sys/ksynch.h> @@ -54,11 +53,8 @@ rw_tryupgrade, rw_read_locked \- readers/writer lock functions .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIrwlp\fR\fR @@ -109,8 +105,6 @@ that may be blocked on exclusive access (\fBRW_READER_STARVEWRITER\fR). .RE .SH DESCRIPTION -.sp -.LP A multiple-readers, single-writer lock is represented by the \fBkrwlock_t\fR data type. This type of lock will allow many threads to have simultaneous read-only access to an object. Only one thread may have write access at any one @@ -190,7 +184,6 @@ holds the lock for read, and zero if the caller holds the lock for write. The caller must hold the lock. The system may panic if \fBrw_read_locked()\fR is called for a lock that isn't held by the caller. .SH RETURN VALUES -.sp .ne 2 .na \fB\fB0\fR\fR @@ -238,14 +231,10 @@ successful return from \fBrw_tryenter()\fR or \fBrw_tryupgrade()\fR. .RE .SH CONTEXT -.sp -.LP These functions can be called from user, interrupt, or kernel context, except for \fBrw_init()\fR and \fBrw_destroy()\fR, which can be called from user context only. .SH SEE ALSO -.sp -.LP \fBcondvar\fR(9F), \fBddi_intr_alloc\fR(9F), \fBddi_intr_add_handler\fR(9F), \fBddi_intr_get_pri\fR(9F), \fBddi_intr_get_softint_pri\fR(9F), \fBmutex\fR(9F), \fBsemaphore\fR(9F) @@ -253,7 +242,5 @@ context only. .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP Compiling with \fB_LOCKTEST\fR or \fB_MPSTATS\fR defined no longer has any effect. To gather lock statistics, see \fBlockstat\fR(1M). diff --git a/usr/src/man/man9f/scsi_abort.9f b/usr/src/man/man9f/scsi_abort.9f index 9d226699b9..a12a01f47a 100644 --- a/usr/src/man/man9f/scsi_abort.9f +++ b/usr/src/man/man9f/scsi_abort.9f @@ -7,7 +7,6 @@ .SH NAME scsi_abort \- abort a SCSI command .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_abort \- abort a SCSI command .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR\fR @@ -40,16 +36,12 @@ Pointer to a \fBscsi_pkt\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_abort()\fR function terminates a command that has been transported to the host adapter driver. A \fINULL\fR \fIpkt\fR causes all outstanding packets to be aborted. On a successful abort, the \fBpkt_reason\fR is set to \fBCMD_ABORTED\fR and \fBpkt_statistics\fR is \fBOR\fR'ed with \fBSTAT_ABORTED\fR. .SH RETURN VALUES -.sp -.LP The \fBscsi_abort()\fR function returns: .sp .ne 2 @@ -70,12 +62,9 @@ on failure. .RE .SH CONTEXT -.sp -.LP The \fBscsi_abort()\fR function can be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRTerminating a command. .sp .in +2 @@ -87,8 +76,6 @@ context. .in -2 .SH SEE ALSO -.sp -.LP \fBtran_abort\fR(9E), \fBscsi_reset\fR(9F), \fBscsi_pkt\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/scsi_alloc_consistent_buf.9f b/usr/src/man/man9f/scsi_alloc_consistent_buf.9f index 5b4bf2700b..aaf292f402 100644 --- a/usr/src/man/man9f/scsi_alloc_consistent_buf.9f +++ b/usr/src/man/man9f/scsi_alloc_consistent_buf.9f @@ -7,7 +7,6 @@ .SH NAME scsi_alloc_consistent_buf \- allocate an I/O buffer for SCSI DMA .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -19,11 +18,8 @@ scsi_alloc_consistent_buf \- allocate an I/O buffer for SCSI DMA .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR\fR @@ -79,8 +75,6 @@ The callback function argument. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_alloc_consistent_buf()\fR function returns allocates a buffer header and the associated data buffer for direct memory access (DMA) transfer. This buffer is allocated from the \fBiobp\fR space, which is considered @@ -135,20 +129,15 @@ invoked. .RE .SH RETURN VALUES -.sp -.LP The \fBscsi_alloc_consistent_buf()\fR function returns a pointer to a \fBbuf\fR(9S) structure on success. It returns \fBNULL\fR if resources are not available even if \fIwaitfunc\fR was not \fBSLEEP_FUNC\fR. .SH CONTEXT -.sp -.LP If \fIcallback\fR is \fBSLEEP_FUNC\fR, then this routine may be called only from user-level code. Otherwise, it may be called fromuser, interrupt, or kernel context. The \fIcallback\fR function may not block or call routines that block. .SH EXAMPLES -.LP \fBExample 1 \fRAllocate a request sense packet with consistent DMA resources attached. .sp @@ -169,18 +158,16 @@ attached. .in +2 .nf bp = scsi_alloc_consistent_buf(&devp->sd_address, NULL, - SUN_INQSIZE, B_READ, canwait, NULL); + SUN_INQSIZE, B_READ, canwait, NULL); if (bp) { - pkt = scsi_init_pkt(&devp->sd_address, NULL, bp, - CDB_GROUP0, 1, PP_LEN, PKT_CONSISTENT, + pkt = scsi_init_pkt(&devp->sd_address, NULL, bp, + CDB_GROUP0, 1, PP_LEN, PKT_CONSISTENT, canwait, NULL); } .fi .in -2 .SH SEE ALSO -.sp -.LP \fBddi_dma_mem_alloc\fR(9F), \fBddi_dma_sync\fR(9F), \fBgetrbuf\fR(9F), \fBscsi_destroy_pkt\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_free_consistent_buf\fR(9F), \fBbuf\fR(9S), \fBscsi_address\fR(9S) diff --git a/usr/src/man/man9f/scsi_cname.9f b/usr/src/man/man9f/scsi_cname.9f index 49e52a5fd1..067ced1db3 100644 --- a/usr/src/man/man9f/scsi_cname.9f +++ b/usr/src/man/man9f/scsi_cname.9f @@ -8,7 +8,6 @@ scsi_cname, scsi_dname, scsi_mname, scsi_rname, scsi_sname \- decode a SCSI name .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -38,11 +37,8 @@ name .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIcmd\fR\fR @@ -97,8 +93,6 @@ A \fBSCSI\fR sense key value. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_cname()\fR function decodes \fBSCSI\fR commands. \fIcmdvec\fR is a pointer to an array of strings. The first byte of the string is the command value, and the remainder is the name of the command. @@ -116,16 +110,11 @@ The \fBscsi_rname()\fR function decodes packet completion reasons. .LP The \fBscsi_sname()\fR function decodes \fBSCSI\fR sense keys. .SH RETURN VALUES -.sp -.LP These functions return a pointer to a string. If an argument is invalid, they return a string to that effect. .SH CONTEXT -.sp -.LP These functions can be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRDecoding SCSI tape commands. .sp .LP @@ -136,7 +125,7 @@ The \fBscsi_cname()\fR function decodes \fBSCSI \fRtape commands as follows: .nf static char *st_cmds[] = { "\e000test unit ready", - "\e001rewind", + "\e001rewind", "\e003request sense", "\e010read", "\e012write", @@ -155,6 +144,4 @@ static char *st_cmds[] = { .in -2 .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/scsi_destroy_pkt.9f b/usr/src/man/man9f/scsi_destroy_pkt.9f index 16e70663f7..1d848cb7be 100644 --- a/usr/src/man/man9f/scsi_destroy_pkt.9f +++ b/usr/src/man/man9f/scsi_destroy_pkt.9f @@ -7,7 +7,6 @@ .SH NAME scsi_destroy_pkt \- free an allocated SCSI packet and its DMA resource .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_destroy_pkt \- free an allocated SCSI packet and its DMA resource .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIpktp\fR\fR @@ -31,18 +27,13 @@ Pointer to a \fBscsi_pkt\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_destroy_pkt()\fR function releases all necessary resources, typically at the end of an I/O transfer. The data is synchronized to memory, then the \fBDMA\fR resources are deallocated and \fIpktp\fR is freed. .SH CONTEXT -.sp -.LP The \fBscsi_destroy_pkt()\fR function may be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRReleasing resources .sp .in +2 @@ -52,8 +43,6 @@ scsi_destroy_pkt(un->un_rqs); .in -2 .SH SEE ALSO -.sp -.LP \fBtran_destroy_pkt\fR(9E), \fBscsi_init_pkt\fR(9F), \fBscsi_pkt\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/scsi_errmsg.9f b/usr/src/man/man9f/scsi_errmsg.9f index 7e974c7dcd..24b5d78c7b 100644 --- a/usr/src/man/man9f/scsi_errmsg.9f +++ b/usr/src/man/man9f/scsi_errmsg.9f @@ -7,7 +7,6 @@ .SH NAME scsi_errmsg \- display a SCSI request sense message .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -19,11 +18,8 @@ scsi_errmsg \- display a SCSI request sense message .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdevp\fR\fR @@ -96,8 +92,6 @@ A pointer to a \fBscsi_extended_sense\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_errmsg()\fR function interprets the request sense information in the \fIsensep\fR pointer and generates a standard message that is displayed using \fBscsi_log\fR(9F). The first line of the message is always a @@ -121,13 +115,13 @@ following table: .TS c c c l l l . -\fBSeverity Value:\fR \fBString:\fR -\fBSCSI_ERR_ALL\fR \fBAll\fR -\fBSCSI_ERR_UNKNOWN\fR \fBUnknown\fR -\fBSCSI_ERR_INFO\fR \fBInformational\fR -\fBSCSI_ERR_RECOVERE\fR \fBRecovered\fR -\fBSCSI_ERR_RETRYABL\fR \fBRetryable\fR -\fBSCSI_ERR_FATAL\fR \fBFatal\fR +\fBSeverity Value:\fR \fBString:\fR +\fBSCSI_ERR_ALL\fR \fBAll\fR +\fBSCSI_ERR_UNKNOWN\fR \fBUnknown\fR +\fBSCSI_ERR_INFO\fR \fBInformational\fR +\fBSCSI_ERR_RECOVERE\fR \fBRecovered\fR +\fBSCSI_ERR_RETRYABL\fR \fBRetryable\fR +\fBSCSI_ERR_FATAL\fR \fBFatal\fR .TE .sp @@ -183,12 +177,9 @@ static struct scsi_key_strings scsi_cmds[] = { .in -2 .SH CONTEXT -.sp -.LP The \fBscsi_errmsg()\fR function may be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRGenerating error information. .sp .LP @@ -219,8 +210,6 @@ ASC: 0x29 (reset), ASCQ: 0x0, FRU: 0x0\fR .in -2 .SH SEE ALSO -.sp -.LP \fBcmn_err\fR(9F), \fBscsi_log\fR(9F), \fBscsi_device\fR(9S), \fBscsi_extended_sense\fR(9S), \fBscsi_pkt\fR(9S) .sp diff --git a/usr/src/man/man9f/scsi_ext_sense_fields.9f b/usr/src/man/man9f/scsi_ext_sense_fields.9f index 705f7216db..ef6c3933a9 100644 --- a/usr/src/man/man9f/scsi_ext_sense_fields.9f +++ b/usr/src/man/man9f/scsi_ext_sense_fields.9f @@ -8,7 +8,6 @@ scsi_ext_sense_fields, scsi_sense_info_uint64, scsi_sense_cmdspecific_uint64 \- retrieve fields from SCSI sense data .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -32,11 +31,8 @@ retrieve fields from SCSI sense data .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIsense_buffer\fR\fR @@ -112,8 +108,6 @@ parameter. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_ext_sense_fields()\fR function can be used to retrieve any of the extended sense data fields from a sense data buffer, regardless of whether the sense data is in fixed format or in descriptor format. @@ -153,8 +147,6 @@ information field as a 64 bit integer. Drivers should use \fBscsi_validate_sense\fR(9F) to ensure that the sense buffer contains valid sense data. .SH RETURN VALUES -.sp -.LP The \fBscsi_sense_info_uint64()\fR function returns \fBTRUE\fR if the information field is present and valid. Otherwise it returns \fBFALSE\fR. .sp @@ -163,14 +155,10 @@ The \fBscsi_sense_cmdspecific_uint64()\fR function returns \fBTRUE\fR if the command specific information field is present and valid. Otherwise it returns \fBFALSE\fR. .SH CONTEXT -.sp -.LP The \fBscsi_ext_sense_fields()\fR, \fBscsi_sense_info_uint64()\fR and \fBscsi_sense_cmdspecific_uint64()()\fR functions can be called from user or interrupt context. .SH SEE ALSO -.sp -.LP \fBscsi_find_sense_descr\fR(9F), \fBscsi_sense_asc\fR(9F), \fBscsi_sense_ascq\fR(9F), \fBscsi_sense_key\fR(9F), \fBscsi_validate_sense\fR(9F) diff --git a/usr/src/man/man9f/scsi_find_sense_descr.9f b/usr/src/man/man9f/scsi_find_sense_descr.9f index 0d23e47154..76bb4990bb 100644 --- a/usr/src/man/man9f/scsi_find_sense_descr.9f +++ b/usr/src/man/man9f/scsi_find_sense_descr.9f @@ -7,7 +7,6 @@ .SH NAME scsi_find_sense_descr \- find descriptor in SCSI sense data .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,11 +17,8 @@ scsi_find_sense_descr \- find descriptor in SCSI sense data .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIsense_buffer\fR\fR @@ -52,8 +48,6 @@ descriptor. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_find_sense_descr()\fR function is used to obtain a pointer to a specific descriptor type, specified by \fIreq_descr_type\fR, within a descriptor sense buffer. Before returning the pointer, @@ -83,19 +77,13 @@ types are already defined: Drivers should use \fBscsi_validate_sense\fR(9F) to ensure that the sense buffer contains valid descriptor sense data. .SH RETURN VALUES -.sp -.LP The \fBscsi_find_sense_descr()\fR function returns a pointer to a sense descriptor of the requested type if a descriptor of that type exists. If no such descriptor exists, \fBscsi_find_sense_descr()\fR returns \fINULL\fR. .SH CONTEXT -.sp -.LP The \fBscsi_find_sense_descr()\fR function can be called from user or interrupt context. .SH SEE ALSO -.sp -.LP \fBscsi_ext_sense_fields\fR(9F), \fBscsi_sense_asc\fR(9F), \fBscsi_sense_ascq\fR(9F), \fBscsi_sense_cmdspecific_uint64\fR(9F), \fBscsi_sense_info_uint64\fR(9F), \fBscsi_sense_key\fR(9F), diff --git a/usr/src/man/man9f/scsi_free_consistent_buf.9f b/usr/src/man/man9f/scsi_free_consistent_buf.9f index 999fc26a40..9912dcf7c0 100644 --- a/usr/src/man/man9f/scsi_free_consistent_buf.9f +++ b/usr/src/man/man9f/scsi_free_consistent_buf.9f @@ -8,7 +8,6 @@ .SH NAME scsi_free_consistent_buf \- free a previously allocated SCSI DMA I/O buffer .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,11 +17,8 @@ scsi_free_consistent_buf \- free a previously allocated SCSI DMA I/O buffer .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIbp\fR\fR @@ -32,26 +28,18 @@ Pointer to the \fBbuf\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_free_consistent_buf()\fR function frees a buffer header and consistent data buffer that was previously allocated using \fBscsi_alloc_consistent_buf\fR(9F). .SH CONTEXT -.sp -.LP The \fBscsi_free_consistent_buf()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBfreerbuf\fR(9F), \fBscsi_alloc_consistent_buf\fR(9F), \fBbuf\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH WARNING -.sp -.LP The \fBscsi_free_consistent_buf()\fR function will call \fBfreerbuf\fR(9F) to free the \fBbuf\fR(9S) that was allocated before or during the call to \fBscsi_alloc_consistent_buf\fR(9F). diff --git a/usr/src/man/man9f/scsi_get_device_type_scsi_options.9f b/usr/src/man/man9f/scsi_get_device_type_scsi_options.9f index d7a912a05b..04eddd328a 100644 --- a/usr/src/man/man9f/scsi_get_device_type_scsi_options.9f +++ b/usr/src/man/man9f/scsi_get_device_type_scsi_options.9f @@ -8,7 +8,6 @@ scsi_get_device_type_scsi_options \- look up per-device-type scsi-options property .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -19,11 +18,8 @@ property .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -51,8 +47,6 @@ Value returned if no match is found. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_get_device_type_scsi_options()\fR function looks up the property \fBdevice-type-scsi-options-list\fR, which can be specified in the HBA's \fBdriver.conf\fR(4) file. This property allows specification of @@ -121,15 +115,9 @@ The \fBscsi_get_device_type_scsi_options()\fR function searches the list of duplets for a matching \fBINQUIRY\fR string. If a match is found, \fBscsi_get_device_type_scsi_options()\fR returns the corresponding value. .SH RETURN VALUES -.sp -.LP \fBscsi_get_device_type_scsi_options()\fR returns the \fBscsi-options\fR value found, or if no match is found the \fBdefault_scsi_options\fR value passed in. .SH CONTEXT -.sp -.LP This function can be called from kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR diff --git a/usr/src/man/man9f/scsi_get_device_type_string.9f b/usr/src/man/man9f/scsi_get_device_type_string.9f index 7196a54288..1b72f7119a 100644 --- a/usr/src/man/man9f/scsi_get_device_type_string.9f +++ b/usr/src/man/man9f/scsi_get_device_type_string.9f @@ -8,7 +8,6 @@ scsi_get_device_type_string \- look up per-device-type, returning matching information string .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -19,11 +18,8 @@ information string .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIprop_name\fR\fR @@ -52,8 +48,6 @@ Pointer to a \fBscsi_device\fR(9S) structure of the target. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_get_device_type_string()\fR function looks up the \fIprop_name\fR property, which can be specified in the HBA's \fBdriver.conf\fR(4)file. This property allows specification of per-device-type information. The syntax for @@ -95,7 +89,7 @@ For example: .nf scsi_vhci_failover_override = "STK FLEXLINE 400", "f_asym_lsi", - "SUN T4", "f_tpgs";; + "SUN T4", "f_tpgs";; .fi .in -2 .sp @@ -108,8 +102,6 @@ for a matching INQUIRY string. If a match is found, string. The meaning of the returned <\fIinformation\fR> string is determined by the caller. .SH RETURN VALUES -.sp -.LP \fBscsi_get_device_type_string()\fR returns a copy of the matching <\fIinformation\fR> string, or if no match is found, \fBNULL\fR is returned. When a non-NULL value is returned, the caller is responsible for freeing the @@ -122,12 +114,8 @@ kmem_free(info, strlen(info) + 1); .in -2 .SH CONTEXT -.sp -.LP This function can be called from kernel or interrupt context. .SH SEE ALSO -.sp -.LP \fBdriver.conf\fR(4) .sp .LP diff --git a/usr/src/man/man9f/scsi_hba_init.9f b/usr/src/man/man9f/scsi_hba_init.9f index c0f97c1dab..cfd664141d 100644 --- a/usr/src/man/man9f/scsi_hba_init.9f +++ b/usr/src/man/man9f/scsi_hba_init.9f @@ -8,7 +8,6 @@ scsi_hba_init, scsi_hba_fini \- SCSI Host Bus Adapter system initialization and completion routines .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -23,11 +22,8 @@ completion routines .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fImodlp\fR \fR @@ -38,8 +34,6 @@ Pointer to the Host Bus Adapters module linkage structure. .SH DESCRIPTION .SS "\fBscsi_hba_init()\fR" -.sp -.LP \fBscsi_hba_init()\fR is the system-provided initialization routine for \fBSCSI\fR \fBHBA\fR drivers. The \fBscsi_hba_init()\fR function registers the \fBHBA\fR in the system and allows the driver to accept configuration requests @@ -49,35 +43,25 @@ be called in the \fBHBA\fR's \fB_init\fR(9E) routine before \fBHBA\fR's \fB_init\fR(9E) should call \fBscsi_hba_fini()\fR before returning failure. .SS "\fBscsi_hba_fini()\fR" -.sp -.LP \fBscsi_hba_fini()\fR is the system provided completion routine for \fBSCSI\fR \fBHBA\fR drivers. \fBscsi_hba_fini()\fR removes all of the system references for the \fBHBA\fR that were created in \fBscsi_hba_init()\fR. The \fBscsi_hba_fini()\fR routine should be called in the \fBHBA\fR's \fB_fini\fR(9E) routine if \fBmod_remove\fR(9F) is successful. .SH RETURN VALUES -.sp -.LP \fBscsi_hba_init()\fR returns \fB0\fR if successful, and a non-zero value otherwise. If \fBscsi_hba_init()\fR fails, the HBA's \fB_init()\fR entry point should return the value returned by \fBscsi_hba_init()\fR. .SH CONTEXT -.sp -.LP \fBscsi_hba_init()\fR and \fBscsi_hba_fini()\fR should be called from \fB_init\fR(9E) or \fB_fini\fR(9E), respectively. .SH SEE ALSO -.sp -.LP \fB_fini\fR(9E), \fB_init\fR(9E), \fBmod_install\fR(9F), \fBmod_remove\fR(9F), \fBscsi_pktalloc\fR(9F), \fBscsi_pktfree\fR(9F), \fBscsi_hba_tran\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The \fBHBA\fR is responsible for ensuring that no \fBDDI\fR request routines are called on behalf of its \fBSCSI\fR target drivers once \fBscsi_hba_fini()\fR is called. diff --git a/usr/src/man/man9f/scsi_hba_lookup_capstr.9f b/usr/src/man/man9f/scsi_hba_lookup_capstr.9f index e305464393..b92b8b8c20 100644 --- a/usr/src/man/man9f/scsi_hba_lookup_capstr.9f +++ b/usr/src/man/man9f/scsi_hba_lookup_capstr.9f @@ -7,7 +7,6 @@ .SH NAME scsi_hba_lookup_capstr \- return index matching capability string .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_hba_lookup_capstr \- return index matching capability string .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIcapstr\fR\fR @@ -31,8 +27,6 @@ Pointer to a string .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_hba_lookup_capstr()\fR function attempts to match \fIcapstr\fR against a known set of capability strings. If found, the defined index for the matched capability is returned. @@ -230,19 +224,13 @@ The following indices are defined for the capability strings listed below. .RE .SH RETURN VALUES -.sp -.LP The \fBscsi_hba_lookup_capstr()\fR function returns a non-negative index value that corresponds to the capability string. If the string does not match a known capability, \fB-1\fR is returned. .SH CONTEXT -.sp -.LP The \fBscsi_hba_lookup_capstr()\fR function can be called from user, interrupt, or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -257,8 +245,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBtran_getcap\fR(9E), \fBtran_setcap\fR(9E), \fBscsi_ifgetcap\fR(9F), \fBscsi_ifsetcap\fR(9F), \fBscsi_reset_notify\fR(9F) .sp diff --git a/usr/src/man/man9f/scsi_hba_pkt_alloc.9f b/usr/src/man/man9f/scsi_hba_pkt_alloc.9f index 3ee7964bfd..bbced72edd 100644 --- a/usr/src/man/man9f/scsi_hba_pkt_alloc.9f +++ b/usr/src/man/man9f/scsi_hba_pkt_alloc.9f @@ -7,7 +7,6 @@ .SH NAME scsi_hba_pkt_alloc, scsi_hba_pkt_free \- allocate and free a scsi_pkt structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -25,11 +24,8 @@ scsi_hba_pkt_alloc, scsi_hba_pkt_free \- allocate and free a scsi_pkt structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -135,8 +131,6 @@ A pointer to a \fBscsi_pkt\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP For \fBscsi_hba_pkt_alloc()\fR: .sp .LP @@ -202,13 +196,9 @@ For \fBscsi_hba_pkt_free()\fR: The \fBscsi_hba_pkt_free()\fR function frees the space allocated for the \fBscsi_pkt\fR(9S) structure. .SH RETURN VALUES -.sp -.LP The \fBscsi_hba_pkt_alloc()\fR function returns a pointer to the \fBscsi_pkt\fR structure, or \fINULL\fR if no space is available. .SH CONTEXT -.sp -.LP The \fBscsi_hba_pkt_alloc()\fR function can be called from user, interrupt, or kernel context. Drivers must not allow \fBscsi_hba_pkt_alloc()\fR to sleep if called from an interrupt routine. @@ -217,8 +207,6 @@ called from an interrupt routine. The \fBscsi_hba_pkt_free()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBtran_init_pkt\fR(9E), \fBscsi_address\fR(9S), \fBscsi_pkt\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/scsi_hba_pkt_comp.9f b/usr/src/man/man9f/scsi_hba_pkt_comp.9f index c890da7161..1896e23526 100644 --- a/usr/src/man/man9f/scsi_hba_pkt_comp.9f +++ b/usr/src/man/man9f/scsi_hba_pkt_comp.9f @@ -7,7 +7,6 @@ .SH NAME scsi_hba_pkt_comp \- scsi_pkt completion routine .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -15,7 +14,6 @@ scsi_hba_pkt_comp \- scsi_pkt completion routine .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIpkt\fR\fR @@ -25,12 +23,8 @@ Pointer to a \fBscsi_pkt\fR(9S) structure. .RE .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP After filling in \fBscsi_pkt\fR(9S) fields with packet completion information, an HBA driver should call the \fBscsi_hba_pkt_comp()\fR function. This function is the recommended way for an HBA driver to signal completion of a @@ -48,13 +42,9 @@ to the \fIpkt_comp\fR() callback function defined in \fBscsi_pkt\fR(9S). This \fBscsi_hba_pkt_comp()\fR, and may occur from a different thread executing on a different CPU. .SH CONTEXT -.sp -.LP The \fBscsi_hba_pkt_comp()\fR function can be called from user, interrupt, or kernel context. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -69,11 +59,7 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBtran_setup_pkt\fR(9E), \fBscsi_pkt\fR(9S) .SH NOTES -.sp -.LP HBA driver calls \fBscsi_hba_pkt_comp()\fR instead of calling \fBscsi_pkt\fR(9S) \fIpkt_comp\fR directly. diff --git a/usr/src/man/man9f/scsi_hba_probe.9f b/usr/src/man/man9f/scsi_hba_probe.9f index aca69c749c..75f1f271da 100644 --- a/usr/src/man/man9f/scsi_hba_probe.9f +++ b/usr/src/man/man9f/scsi_hba_probe.9f @@ -7,7 +7,6 @@ .SH NAME scsi_hba_probe \- default SCSI HBA probe function .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_hba_probe \- default SCSI HBA probe function .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIsd\fR \fR @@ -40,25 +36,17 @@ Pointer to a \fBscsi_device\fR(9S) structure describing the target. .RE .SH DESCRIPTION -.sp -.LP \fBscsi_hba_probe()\fR is a function providing the semantics of \fBscsi_probe\fR(9F). An \fBHBA\fR driver may call \fBscsi_hba_probe()\fR from its \fBtran_tgt_probe\fR(9E) entry point, to probe for the existence of a target on the \fBSCSI\fR bus, or the \fBHBA\fR may set \fBtran_tgt_probe\fR(9E) to point to \fBscsi_hba_probe\fR directly. .SH RETURN VALUES -.sp -.LP See \fBscsi_probe\fR(9F) for the return values from \fBscsi_hba_probe()\fR. .SH CONTEXT -.sp -.LP \fBscsi_hba_probe()\fR should only be called from the \fBHBA\fR's \fBtran_tgt_probe\fR(9E) entry point. .SH SEE ALSO -.sp -.LP \fBtran_tgt_probe\fR(9E), \fBscsi_probe\fR(9F), \fBscsi_device\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/scsi_hba_tran_alloc.9f b/usr/src/man/man9f/scsi_hba_tran_alloc.9f index 29c5f05b06..351de0e60e 100644 --- a/usr/src/man/man9f/scsi_hba_tran_alloc.9f +++ b/usr/src/man/man9f/scsi_hba_tran_alloc.9f @@ -8,7 +8,6 @@ scsi_hba_tran_alloc, scsi_hba_tran_free \- allocate and free transport structures .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -23,11 +22,8 @@ structures .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -56,8 +52,6 @@ Pointer to a \fBscsi_hba_tran\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP For \fBscsi_hba_tran_alloc()\fR: .sp .LP @@ -78,13 +72,9 @@ For \fBscsi_hba_tran_free()\fR: The \fBscsi_hba_tran_free()\fR function is used to free the \fBscsi_hba_tran\fR(9S) structure allocated by \fBscsi_hba_tran_alloc()\fR. .SH RETURN VALUES -.sp -.LP The \fBscsi_hba_tran_alloc()\fR function returns a pointer to the allocated transport structure, or \fBNULL\fR if no space is available. .SH CONTEXT -.sp -.LP The \fBscsi_hba_tran_alloc()\fR function can be called from user, interrupt, or kernel context. Drivers must not allow \fBscsi_hba_tran_alloc()\fR to sleep if called from an interrupt routine. @@ -93,8 +83,6 @@ called from an interrupt routine. The \fBscsi_hba_tran_free()\fR function can be called from user, interrupt, or kernel context context. .SH SEE ALSO -.sp -.LP \fBscsi_hba_attach_setup\fR(9F), \fBscsi_hba_tran\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/scsi_ifgetcap.9f b/usr/src/man/man9f/scsi_ifgetcap.9f index a6dabf72b0..356b60a747 100644 --- a/usr/src/man/man9f/scsi_ifgetcap.9f +++ b/usr/src/man/man9f/scsi_ifgetcap.9f @@ -8,7 +8,6 @@ .SH NAME scsi_ifgetcap, scsi_ifsetcap \- get/set SCSI transport capability .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -24,8 +23,7 @@ scsi_ifgetcap, scsi_ifsetcap \- get/set SCSI transport capability .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -63,7 +61,6 @@ Determines if all targets or only the specified target is affected. .RE .SH DESCRIPTION -.LP The \fBscsi_ifsetcap()\fR function is used by target drivers to set the capabilities of the host adapter driver. The \fIcap\fR pointer is a name-value pair identified by a null-terminated character string and the integer value of @@ -331,7 +328,6 @@ the default value of the target driver is used for the \fBCDB\fR determination. .RE .SH RETURN VALUES -.LP The \fBscsi_ifsetcap()\fR function returns: .sp .ne 2 @@ -375,7 +371,6 @@ If the capability was not defined. .RE .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBscsi_ifgetcap()\fR .sp .in +2 @@ -402,10 +397,8 @@ if (scsi_ifsetcap(&devp->sd_address, "tagged-qing", 1, 1) == 1) { .in -2 .SH CONTEXT -.LP These functions can be called from user, interrupt, or kernel context. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -420,7 +413,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBtran_reset\fR(9E), \fBscsi_hba_lookup_capstr\fR(9F), \fBscsi_reset\fR(9F), \fBscsi_reset_notify\fR(9F), \fBddi_dma_attr\fR(9S), \fBscsi_address\fR(9S), \fBscsi_arq_status\fR(9S) diff --git a/usr/src/man/man9f/scsi_init_pkt.9f b/usr/src/man/man9f/scsi_init_pkt.9f index 28b84b6cd1..b15128114b 100644 --- a/usr/src/man/man9f/scsi_init_pkt.9f +++ b/usr/src/man/man9f/scsi_init_pkt.9f @@ -8,7 +8,6 @@ .SH NAME scsi_init_pkt \- prepare a complete SCSI packet .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -20,11 +19,8 @@ scsi_init_pkt \- prepare a complete SCSI packet .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR\fR @@ -154,8 +150,6 @@ The \fIcallback\fR function argument. .RE .SH DESCRIPTION -.sp -.LP Target drivers use \fBscsi_init_pkt()\fR to request the transport layer to allocate and initialize a packet for a \fBSCSI\fR command which possibly includes a data transfer. If \fIpktp\fR is \fINULL,\fR a new \fBscsi_pkt\fR(9S) @@ -275,21 +269,16 @@ When allocating \fBDMA\fR resources, \fBscsi_init_pkt()\fR returns the the system was unable to allocate \fBDMA\fR resources. A \fBpkt_resid\fR of \fB0\fR means that all necessary \fBDMA\fR resources were allocated. .SH RETURN VALUES -.sp -.LP The \fBscsi_init_pkt()\fR function returns \fINULL\fR if the packet or \fBDMA\fR resources could not be allocated. Otherwise, it returns a pointer to an initialized \fBscsi_pkt\fR(9S). If \fIpktp\fR was not \fINULL\fR the return value will be \fIpktp\fR on successful initialization of the packet. .SH CONTEXT -.sp -.LP If \fIcallback\fR is \fBSLEEP_FUNC\fR, then this routine can be called only from user-level code. Otherwise, it can be called from user, interrupt, or kernel context. The \fIcallback\fR function may not block or call routines that block. .SH EXAMPLES -.LP \fBExample 1 \fRAllocating a Packet Without \fBDMA\fR Resources Attached .sp .LP @@ -368,8 +357,6 @@ my_pkt = scsi_init_pkt(&devp->sd_address, NULL, bp, CDB_GROUP0, .in -2 .SH SEE ALSO -.sp -.LP \fBscsi_alloc_consistent_buf\fR(9F), \fBscsi_destroy_pkt\fR(9F), \fBscsi_dmaget\fR(9F), \fBscsi_pktalloc\fR(9F), \fBbuf\fR(9S), \fBscsi_address\fR(9S), \fBscsi_pkt\fR(9S) @@ -377,8 +364,6 @@ my_pkt = scsi_init_pkt(&devp->sd_address, NULL, bp, CDB_GROUP0, .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP If a \fBDMA\fR allocation request fails with \fBDDI_DMA_NOMAPPING\fR, the \fBB_ERROR\fR flag will be set in \fIbp\fR, and the \fBb_error\fR field will be set to \fBEFAULT\fR. diff --git a/usr/src/man/man9f/scsi_log.9f b/usr/src/man/man9f/scsi_log.9f index 882ed2eb0f..0d8d5f4a05 100644 --- a/usr/src/man/man9f/scsi_log.9f +++ b/usr/src/man/man9f/scsi_log.9f @@ -7,7 +7,6 @@ .SH NAME scsi_log \- display a SCSI-device-related message .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> #include <sys/cmn_err.h> @@ -19,11 +18,8 @@ scsi_log \- display a SCSI-device-related message .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -60,8 +56,6 @@ Display format. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_log()\fR function is a utility function that displays a message via the \fBcmn_err\fR(9F) routine. The error levels that can be passed in to this function are \fBCE_PANIC\fR, \fBCE_WARN\fR, \fBCE_NOTE\fR, \fBCE_CONT\fR, and @@ -99,13 +93,9 @@ condition is met, the \fB?\fR character has no effect and is simply ignored. All formatting conversions in use by \fBcmn_err()\fR also work with \fBscsi_log()\fR. .SH CONTEXT -.sp -.LP The \fBscsi_log()\fR function may be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBkernel\fR(1M), \fBsd\fR(7D), \fBcmn_err\fR(9F), \fBscsi_errmsg\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/scsi_poll.9f b/usr/src/man/man9f/scsi_poll.9f index 4a511a7458..42f5c30905 100644 --- a/usr/src/man/man9f/scsi_poll.9f +++ b/usr/src/man/man9f/scsi_poll.9f @@ -7,7 +7,6 @@ .SH NAME scsi_poll \- run a polled SCSI command on behalf of a target driver .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_poll \- run a polled SCSI command on behalf of a target driver .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIpkt\fR\fR @@ -31,8 +27,6 @@ Pointer to the \fBscsi_pkt\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_poll()\fR function requests the host adapter driver to run a polled command. Unlike \fBscsi_transport\fR(9F) which runs commands asynchronously, \fBscsi_poll()\fR runs commands to completion before returning. If the @@ -40,8 +34,6 @@ command. Unlike \fBscsi_transport\fR(9F) which runs commands asynchronously, defaulted to \fBSCSI_POLL_TIMEOUT\fR to prevent an indefinite hang of the system. .SH RETURN VALUES -.sp -.LP The \fBscsi_poll()\fR function returns: .sp .ne 2 @@ -62,21 +54,15 @@ command failed. .RE .SH CONTEXT -.sp -.LP The \fBscsi_poll()\fR function can be called from user, interrupt, or kernel context. This function should not be called when the caller is executing \fBtimeout\fR(9F) in the context of a thread. .SH SEE ALSO -.sp -.LP \fBmakecom\fR(9F), \fBscsi_transport\fR(9F), \fBscsi_pkt\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP Since \fBscsi_poll()\fR runs commands to completion before returning, it may require more time than is desirable when called from interrupt context. Therefore, calling \fBscsi_poll\fR from interrupt context is not recommended. diff --git a/usr/src/man/man9f/scsi_probe.9f b/usr/src/man/man9f/scsi_probe.9f index 21b9d5d496..5e04869f7d 100644 --- a/usr/src/man/man9f/scsi_probe.9f +++ b/usr/src/man/man9f/scsi_probe.9f @@ -7,7 +7,6 @@ .SH NAME scsi_probe \- utility for probing a scsi device .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_probe \- utility for probing a scsi device .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIdevp\fR \fR @@ -40,8 +36,6 @@ Pointer to a \fBscsi_device\fR(9S) structure .RE .SH DESCRIPTION -.sp -.LP \fBscsi_probe()\fR determines whether a \fBtarget/lun\fR is present and sets up the \fBscsi_device\fR structure with inquiry data. .sp @@ -84,8 +78,6 @@ Wait indefinitely for resources. .RE .SH RETURN VALUES -.sp -.LP \fBscsi_probe()\fR returns: .sp .ne 2 @@ -151,14 +143,11 @@ Device does not respond to an INQUIRY. .RE .SH CONTEXT -.sp -.LP \fBscsi_probe()\fR is normally called from the target driver's \fBprobe\fR(9E) or \fBattach\fR(9E) routine. In any case, this routine should not be called from interrupt context, because it can sleep waiting for memory to be allocated. .SH EXAMPLES -.LP \fBExample 1 \fR Using \fBscsi_probe()\fR .sp .in +2 @@ -189,8 +178,6 @@ allocated. .in -2 .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBprobe\fR(9E), \fBscsi_slave\fR(9F), \fBscsi_unprobe\fR(9F), \fBscsi_unslave\fR(9F), \fBscsi_device\fR(9S), \fBscsi_inquiry\fR(9S) @@ -201,7 +188,5 @@ allocated. .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP A \fIwaitfunc\fR function other than \fBNULL_FUNC\fR or \fBSLEEP_FUNC\fR is not supported and may have unexpected results. diff --git a/usr/src/man/man9f/scsi_reset.9f b/usr/src/man/man9f/scsi_reset.9f index 21c3c360aa..bfbb189d12 100644 --- a/usr/src/man/man9f/scsi_reset.9f +++ b/usr/src/man/man9f/scsi_reset.9f @@ -7,7 +7,6 @@ .SH NAME scsi_reset \- reset a SCSI bus or target .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_reset \- reset a SCSI bus or target .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR\fR @@ -40,8 +36,6 @@ The level of reset required. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_reset()\fR function asks the host adapter driver to reset the \fBSCSI \fRbus or a \fBSCSI \fRtarget as specified by \fIlevel\fR. If \fIlevel\fR equals \fBRESET_ALL\fR, the \fBSCSI\fR bus is reset. If it equals @@ -78,8 +72,6 @@ have already called \fBscsi_transport()\fR, but not yet queued or transported its command. In this case the HBA will not yet have received the second thread's packet and this packet will not be aborted. .SH RETURN VALUES -.sp -.LP The \fBscsi_reset()\fR function returns: .sp .ne 2 @@ -100,13 +92,9 @@ Upon failure. .RE .SH CONTEXT -.sp -.LP The \fBscsi_reset()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBtran_reset\fR(9E), \fBtran_reset_notify\fR(9E), \fBscsi_abort\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/scsi_reset_notify.9f b/usr/src/man/man9f/scsi_reset_notify.9f index 30537b1e04..a7872a80fe 100644 --- a/usr/src/man/man9f/scsi_reset_notify.9f +++ b/usr/src/man/man9f/scsi_reset_notify.9f @@ -8,7 +8,6 @@ .SH NAME scsi_reset_notify \- notify target driver of bus resets .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -19,11 +18,8 @@ scsi_reset_notify \- notify target driver of bus resets .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIap\fR\fR @@ -60,8 +56,6 @@ The callback function argument. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_reset_notify()\fR function is used by a target driver when it needs to be notified of a bus reset. The bus reset could be issued by the transport layer (e.g. the host bus adapter (\fBHBA)\fR driver or controller) or by @@ -95,8 +89,6 @@ Target drivers can find out whether the \fBHBA\fR driver and controller support reset notification by checking the \fBreset-notification\fR capability using the \fBscsi_ifgetcap\fR(9F) function. .SH RETURN VALUES -.sp -.LP If \fIflag\fR is \fBSCSI_RESET_NOTIFY\fR, \fBscsi_reset_notify()\fR returns: .sp .ne 2 @@ -139,13 +131,9 @@ No notification request was registered. .RE .SH CONTEXT -.sp -.LP The \fBscsi_reset_notify()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBscsi_address\fR(9S), \fBscsi_ifgetcap\fR(9F) .sp .LP diff --git a/usr/src/man/man9f/scsi_sense_key.9f b/usr/src/man/man9f/scsi_sense_key.9f index f681fb7502..bb3438e5d4 100644 --- a/usr/src/man/man9f/scsi_sense_key.9f +++ b/usr/src/man/man9f/scsi_sense_key.9f @@ -8,7 +8,6 @@ scsi_sense_key, scsi_sense_asc, scsi_sense_ascq \- retrieve fields from SCSI sense data .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -28,8 +27,7 @@ sense data .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -42,7 +40,6 @@ fixed or descriptor format. .RE .SH DESCRIPTION -.LP The \fBscsi_sense_key()\fR function returns the sense key value from the sense data contained in the sense_buffer. .sp @@ -63,17 +60,14 @@ whether the sense data is in fixed format or descriptor format. Drivers should use \fBscsi_validate_sense\fR(9F) to ensure that valid sense key, \fBasc\fR, and \fBascq\fR values are present in the sense data. .SH RETURN VALUES -.LP The \fBscsi_sense_key()\fR function returns the sense key value from the sense buffer. The \fBscsi_sense_asc()\fR function returns the additional sense code (\fBASC\fR) from the sense buffer and the \fBscsi_sense_ascq()\fR function returns the additional sense code qualifier (\fBASCQ\fR) from the sense buffer. .SH CONTEXT -.LP The \fBscsi_sense_key()\fR, \fBscsi_sense_asc()\fR, and \fBscsi_sense_ascq()\fR functions can be called from user or interrupt context. .SH SEE ALSO -.LP \fBscsi_ext_sense_fields\fR(9F), \fBscsi_find_sense_descr\fR(9F), \fBscsi_sense_cmdspecific_uint64\fR(9F), \fBscsi_sense_info_uint64\fR(9F), \fBscsi_validate_sense\fR(9F) diff --git a/usr/src/man/man9f/scsi_setup_cdb.9f b/usr/src/man/man9f/scsi_setup_cdb.9f index 9aaf67be27..76e7433b73 100644 --- a/usr/src/man/man9f/scsi_setup_cdb.9f +++ b/usr/src/man/man9f/scsi_setup_cdb.9f @@ -7,18 +7,14 @@ .SH NAME scsi_setup_cdb \- setup SCSI command descriptor block (CDB) .SH SYNOPSIS -.LP .nf \fBint\fR \fBscsi_setup_cdb\fR(\fBunion scsi_cdb\fR \fI*cdbp\fR, \fBuchar_t\fR \fIcmd\fR, \fBuint_t\fR \fIaddr\fR, \fBuint_t\fR \fIcnt\fR, \fBuint_t\fR \fIothr_cdb_data\fR); .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIcdbp\fR\fR @@ -66,8 +62,6 @@ Additional \fBCDB\fR data. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_setup_cdb()\fR function initializes a group 0, 1, 2, 4, or 5 type of command descriptor block pointed to by \fIcdbp\fR using \fIcmd\fR, \fIaddr\fR, \fIcnt\fR, \fIothr_cdb_data\fR. @@ -83,8 +77,6 @@ The \fBscsi_setup_cdb()\fR function does not set the \fBLUN\fR bits in \fBCDB\fR[1] as the \fBmakecom\fR(9F) functions do. Also, the fixed bit for sequential access device commands is not set. .SH RETURN VALUES -.sp -.LP The \fBscsi_setup_cdb()\fR function returns: .sp .ne 2 @@ -105,12 +97,8 @@ Upon failure. .RE .SH CONTEXT -.sp -.LP These functions can be called from a user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBmakecom\fR(9F), \fBscsi_pkt\fR(9S) .sp .LP diff --git a/usr/src/man/man9f/scsi_sync_pkt.9f b/usr/src/man/man9f/scsi_sync_pkt.9f index 7ee6290a32..58b6b42b1a 100644 --- a/usr/src/man/man9f/scsi_sync_pkt.9f +++ b/usr/src/man/man9f/scsi_sync_pkt.9f @@ -7,7 +7,6 @@ .SH NAME scsi_sync_pkt \- synchronize CPU and I/O views of memory .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_sync_pkt \- synchronize CPU and I/O views of memory .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIpktp\fR\fR @@ -31,8 +27,6 @@ Pointer to a \fBscsi_pkt\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP The \fBscsi_sync_pkt()\fR function is used to selectively synchronize a \fBCPU\fR's or device's view of the data associated with the \fBSCSI\fR packet that has been mapped for \fBI/O\fR. This may involve operations such as flushes @@ -54,13 +48,9 @@ then \fBscsi_sync_pkt()\fR must be called before calling a device to memory \fBscsi_sync_pkt()\fR must be called after the completion of the packet but before accessing the data in memory. .SH CONTEXT -.sp -.LP The \fBscsi_sync_pkt()\fR function may be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fBtran_sync_pkt\fR(9E), \fBddi_dma_sync\fR(9F), \fBscsi_destroy_pkt\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_transport\fR(9F), \fBscsi_pkt\fR(9S) .sp diff --git a/usr/src/man/man9f/scsi_transport.9f b/usr/src/man/man9f/scsi_transport.9f index 4b4f7c65c7..072fe877b0 100644 --- a/usr/src/man/man9f/scsi_transport.9f +++ b/usr/src/man/man9f/scsi_transport.9f @@ -7,7 +7,6 @@ .SH NAME scsi_transport \- request by a SCSI target driver to start a command .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -17,11 +16,8 @@ scsi_transport \- request by a SCSI target driver to start a command .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIpkt\fR\fR @@ -31,8 +27,6 @@ Pointer to a \fBscsi_pkt\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP Target drivers use \fBscsi_transport()\fR to request the host adapter driver to transport a command to the \fBSCSI \fRtarget device specified by \fIpkt\fR. The target driver must obtain resources for the packet using @@ -44,8 +38,6 @@ completion of the \fBSCSI\fR command the host adapter calls the completion routine provided by the target driver in the \fBpkt_comp\fR member of the \fBscsi_pkt\fR pointed to by \fIpkt\fR. .SH RETURN VALUES -.sp -.LP The \fBscsi_transport()\fR function returns: .sp .ne 2 @@ -87,12 +79,9 @@ A fatal error has occurred in the transport layer. .RE .SH CONTEXT -.sp -.LP The \fBscsi_transport()\fR function can be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBscsi_transport()\fR .sp .in +2 @@ -105,8 +94,6 @@ if ((status = scsi_transport(rqpkt)) != TRAN_ACCEPT) { .in -2 .SH SEE ALSO -.sp -.LP \fBtran_start\fR(9E), \fBmakecom\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_pktalloc\fR(9F), \fBscsi_poll\fR(9F), \fBscsi_pkt\fR(9S) .sp diff --git a/usr/src/man/man9f/scsi_unprobe.9f b/usr/src/man/man9f/scsi_unprobe.9f index 15efbebcf8..5b31d103b1 100644 --- a/usr/src/man/man9f/scsi_unprobe.9f +++ b/usr/src/man/man9f/scsi_unprobe.9f @@ -7,7 +7,6 @@ .SH NAME scsi_unprobe, scsi_unslave \- free resources allocated during initial probing .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -22,12 +21,9 @@ scsi_unprobe, scsi_unslave \- free resources allocated during initial probing .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). The \fBscsi_unslave()\fR interface is +illumos DDI specific (illumos DDI). The \fBscsi_unslave()\fR interface is obsolete. Use \fBscsi_unprobe()\fR instead. .SH PARAMETERS -.sp .ne 2 .na \fB\fIdevp\fR \fR @@ -37,25 +33,17 @@ Pointer to a \fBscsi_device\fR(9S) structure. .RE .SH DESCRIPTION -.sp -.LP \fBscsi_unprobe()\fR and \fBscsi_unslave()\fR are used to free any resources that were allocated on the driver's behalf during \fBscsi_slave\fR(9F) and \fBscsi_probe\fR(9F) activity. .SH CONTEXT -.sp -.LP \fBscsi_unprobe()\fR and \fBscsi_unslave()\fR must not be called from an interrupt context. .SH SEE ALSO -.sp -.LP \fBscsi_probe\fR(9F), \fBscsi_slave\fR(9F), \fBscsi_device\fR(9S) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The \fBscsi_unslave()\fR function is obsolete and will be discontinued in a future release. This function has been replaced by \fBscsi_unprobe()\fR. diff --git a/usr/src/man/man9f/scsi_validate_sense.9f b/usr/src/man/man9f/scsi_validate_sense.9f index efe75a55af..dc06bda8cd 100644 --- a/usr/src/man/man9f/scsi_validate_sense.9f +++ b/usr/src/man/man9f/scsi_validate_sense.9f @@ -7,7 +7,6 @@ .SH NAME scsi_validate_sense \- find descriptor in SCSI sense data .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -18,8 +17,7 @@ scsi_validate_sense \- find descriptor in SCSI sense data .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .ne 2 .na @@ -49,7 +47,6 @@ Returns additional properties of the sense data. .RE .SH DESCRIPTION -.LP The \fBscsi_validate_sense()\fR function returns the format of the sense data contained in the provided sense buffer. If the response code field in the sense data is not recognized or if there is not enough sense data to include sense @@ -110,11 +107,9 @@ The sense data in the buffer is in "descriptor format". .RE .SH CONTEXT -.LP The \fBscsi_validate_sense()\fR function can be called from user or interrupt context. .SH SEE ALSO -.LP \fBscsi_ext_sense_fields\fR(9F), \fBscsi_find_sense_descr\fR(9F), \fBscsi_sense_asc\fR(9F), \fBscsi_sense_ascq\fR(9F), \fBscsi_sense_cmdspecific_uint64\fR(9F), \fBscsi_sense_info_uint64\fR(9F), diff --git a/usr/src/man/man9f/scsi_vu_errmsg.9f b/usr/src/man/man9f/scsi_vu_errmsg.9f index 0d2ead1e18..0573364d88 100644 --- a/usr/src/man/man9f/scsi_vu_errmsg.9f +++ b/usr/src/man/man9f/scsi_vu_errmsg.9f @@ -7,7 +7,6 @@ .SH NAME scsi_vu_errmsg \- display a SCSI request sense message .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> @@ -21,10 +20,8 @@ scsi_vu_errmsg \- display a SCSI request sense message .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.LP The following parameters are supported: .sp .ne 2 @@ -124,7 +121,6 @@ possible and \fINULL\fR if no decoding is possible. .RE .SH DESCRIPTION -.LP This function is very similar to \fBscsi_errmsg\fR(9F) but allows decoding of vendor-unique ASC/ASCQ and FRU information. .sp @@ -214,11 +210,9 @@ For a basic SCSI disk, the following list is appropriate: .in -2 .SH CONTEXT -.LP The \fBscsi_vu_errmsg()\fR function may be called from user, interrupt, or kernel context. .SH EXAMPLES -.LP \fBExample 1 \fRUsing \fBscsi_vu_errmsg()\fR .sp .in +2 @@ -254,7 +248,6 @@ WARNING: /sbus@1,f8000000/esp@0,800000/sd@1,0 (sd1): .in -2 .SH SEE ALSO -.LP \fBcmn_err\fR(9F), \fBscsi_errmsg\fR(9F), \fBscsi_log\fR(9F), \fBscsi_errmsg\fR(9F), \fBscsi_asc_key_strings\fR(9S), \fBscsi_device\fR(9S), \fBscsi_extended_sense\fR(9S), \fBscsi_pkt\fR(9S) diff --git a/usr/src/man/man9f/stoi.9f b/usr/src/man/man9f/stoi.9f index 74bc07d6bc..f41b6b28fb 100644 --- a/usr/src/man/man9f/stoi.9f +++ b/usr/src/man/man9f/stoi.9f @@ -7,7 +7,6 @@ .SH NAME stoi, numtos \- convert between an integer and a decimal string .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> @@ -20,11 +19,8 @@ stoi, numtos \- convert between an integer and a decimal string .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIstr\fR\fR @@ -53,32 +49,20 @@ Character buffer to hold converted decimal number. .SH DESCRIPTION .SS "\fBstoi()\fR" -.sp -.LP The \fBstoi()\fR function returns the integer value of a string of decimal numeric characters beginning at \fI**str\fR. No overflow checking is done. \fI*str\fR is updated to point at the last character examined. .SS "\fBnumtos()\fR" -.sp -.LP The \fBnumtos()\fR function converts a \fBlong\fR into a null-terminated character string. No bounds checking is done. The caller must ensure there is enough space to hold the result. .SH RETURN VALUES -.sp -.LP The \fBstoi()\fR function returns the integer value of the string \fIstr\fR. .SH CONTEXT -.sp -.LP The \fBstoi()\fR function can be called from user, interrupt, or kernel context. .SH SEE ALSO -.sp -.LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP The \fBstoi()\fR function handles only positive integers; it does not handle leading minus signs. diff --git a/usr/src/man/man9f/string.9f b/usr/src/man/man9f/string.9f index 49d6e957c7..537871c952 100644 --- a/usr/src/man/man9f/string.9f +++ b/usr/src/man/man9f/string.9f @@ -9,7 +9,6 @@ string, strcasecmp, strncasecmp, strcat, strncat, strlcat, strchr, strrchr, strcmp, strncmp, strcpy, strncpy, strlcpy, strfree, strspn, strdup, ddi_strdup, strlen, strnlen \- string operations .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> @@ -103,10 +102,8 @@ strdup, ddi_strdup, strlen, strnlen \- string operations .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.LP The arguments \fIs\fR, \fIs1\fR, and \fIs2\fR point to strings (arrays of characters terminated by a null character). The \fBstrcat()\fR, \fBstrncat()\fR, \fBstrlcat()\fR, \fBstrcpy()\fR, \fBstrncpy()\fR, @@ -114,13 +111,11 @@ characters terminated by a null character). The \fBstrcat()\fR, Additionally, the \fBstrcpy()\fR function does not check for overflow of the array. .SS "\fBstrcasecmp()\fR, \fBstrncasecmp()\fR" -.LP The \fBstrcasecmp()\fR and \fBstrncasecmp()\fR functions are case-insensitive versions of \fBstrcmp()\fR and \fBstrncmp()\fR respectively, described below. They assume the \fBASCII\fR character set and ignore differences in case when comparing lower and upper case characters. .SS "\fBstrcat()\fR, \fBstrncat()\fR, and \fBstrlcat()\fR" -.LP The \fBstrcat()\fR function appends a copy of string \fIs2\fR, including the terminating null character, to the end of string \fIs1\fR. The \fBstrncat()\fR function appends at most \fIn\fR characters of \fIs2\fR to \fIs1\fR, not @@ -153,14 +148,12 @@ if (strlcat(dst, src, dstsize) >= dstsize) .in -2 .SS "\fBstrchr()\fR, \fBstrrchr()\fR" -.LP The \fBstrchr()\fR function returns a pointer to the first occurrence of \fIc\fR (converted to a \fBchar\fR) in string \fIs\fR, or a null pointer if \fIc\fR does not occur in the string. The \fBstrrchr()\fR function returns a pointer to the last occurrence of \fIc\fR. The null character terminating a string is considered to be part of the string. .SS "\fBstrcmp()\fR, \fBstrncmp()\fR" -.LP The \fBstrcmp()\fR function compares two strings byte-by-byte, according to the ordering of your machine's character set. The function returns an integer greater than, equal to, or less than 0, if the string pointed to by \fIs1\fR @@ -171,7 +164,6 @@ strings being compared. The \fBstrncmp()\fR function makes the same comparison but looks at a maximum of \fIn\fR bytes. Bytes following a null byte are not compared. .SS "\fBstrcpy()\fR, \fBstrncpy()\fR, \fBstrlcpy()\fR" -.LP The \fBstrcpy()\fR function copies string \fIs2\fR to \fIs1\fR, including the terminating null character, stopping after the null character has been copied. The \fBstrncpy()\fR function copies exactly \fIn\fR bytes, truncating \fIs2\fR @@ -196,17 +188,14 @@ if (strlcpy(dst, src, dstsize) >= dstsize) .in -2 .SS "\fBstrfree()\fR" -.LP The \fBstrfree()\fR function frees the memory associated with the string pointed to by \fIs\fR. This memory pointed to by \fIs\fR must be of size \fBstrlen\fR(\fIs\fR)+1, and must have been allocated (either directly or indirectly) by \fBkmem_alloc\fR(9F) or \fBkmem_zalloc\fR(9F). .SS "\fBstrspn()\fR" -.LP The \fBstrspn()\fR function returns the length of the initial segment of string \fIs1\fR that consists entirely of characters from string \fIs2\fR. .SS "\fBstrdup()\fR, \fBddi_strdup()\fR" -.LP The \fBddi_strdup()\fR function returns a pointer to a new string that is a duplicate of the string pointed to by \fIs1\fR. The returned pointer can be passed to \fBstrfree()\fR or \fBkmem_free\fR(9F). The space for the new string @@ -221,7 +210,6 @@ The \fBstrdup()\fR function behaves the same as the \fBddi_strdup()\fR when called with the \fBKM_SLEEP\fR flag. This means that \fBstrdup()\fR can sleep until memory is available and will always succeed. .SS "\fBstrlen()\fR, \fBstrnlen()\fR" -.LP The \fBstrlen()\fR function returns the number of bytes in \fIs\fR, not including the terminating null character. .sp @@ -231,7 +219,6 @@ bytes in \fIs\fR, not including the terminating null character. The \fBstrnlen()\fR function never examines more than \fIn\fR bytes of the string pointed to by \fIs\fR. .SH CONTEXT -.LP The \fBstrdup()\fR and \fBddi_strdup()\fR functions can be called from user or kernel context. .sp @@ -243,7 +230,6 @@ the \fBKM_NOSLEEP\fR flag is set. All the other string manipulation functions can be called from user, interrupt, or kernel context. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -258,14 +244,12 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBstring\fR(3C), \fBattributes\fR(5), \fBbcopy\fR(9F), \fBddi_copyin\fR(9F), \fBkmem_alloc\fR(9F) .sp .LP \fIWriting Device Drivers\fR .SH NOTES -.LP If copying takes place between objects that overlap, the behavior of \fBstrlcat()\fR, \fBstrncat()\fR, \fBstrcpy()\fR, \fBstrlcpy()\fR, and \fBstrncpy()\fR is undefined. diff --git a/usr/src/man/man9f/taskq.9f b/usr/src/man/man9f/taskq.9f index 25448203dc..4b4f8ace6d 100644 --- a/usr/src/man/man9f/taskq.9f +++ b/usr/src/man/man9f/taskq.9f @@ -49,7 +49,7 @@ operations .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na diff --git a/usr/src/man/man9f/u8_strcmp.9f b/usr/src/man/man9f/u8_strcmp.9f index 21317fae5a..cd9b90ed5f 100644 --- a/usr/src/man/man9f/u8_strcmp.9f +++ b/usr/src/man/man9f/u8_strcmp.9f @@ -7,7 +7,6 @@ .SH NAME u8_strcmp \- UTF-8 string comparison function .SH SYNOPSIS -.LP .nf #include <sys/sunddi.h> @@ -16,11 +15,8 @@ u8_strcmp \- UTF-8 string comparison function .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIs1\fR, \fIs2\fR\fR @@ -215,8 +211,6 @@ The specified Unicode version value is not supported. .RE .SH DESCRIPTION -.sp -.LP After proper pre-processing, the \fBu8_strcmp()\fR function compares two UTF-8 strings byte-by-byte, according to the machine ordering defined by the corresponding version of the Unicode Standard. @@ -225,8 +219,6 @@ corresponding version of the Unicode Standard. When multiple comparison options are specified, Unicode Normalization is performed after case-sensitive or case-insensitive processing is performed. .SH RETURN VALUES -.sp -.LP The \fBu8_strcmp()\fR function returns an integer greater than, equal to, or less than 0 if the string pointed to by \fIs1\fR is greater than, equal to, or less than the string pointed to by \fIs2\fR, respectively. @@ -237,11 +229,8 @@ character causes the function to set \fIerrno\fR to indicate the error. Afterward, the comparison is still performed on the resultant strings and a value based on byte-by-byte comparison is always returned. .SH CONTEXT -.sp -.LP The \fBu8_strcmp()\fR function can be called from user or interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRPerform simple default string comparison. .sp .in +2 @@ -329,8 +318,6 @@ docmp_nfd_caseinsensitive_u320(const char *u1, const char *u2) { .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -345,8 +332,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBu8_validate\fR(3C), \fBu8_textprep_str\fR(3C), \fBu8_validate\fR(3C), \fBattributes\fR(5), \fBu8_textprep_str\fR(9F), \fBu8_validate\fR(9F), \fBuconv_u16tou32\fR(9F) diff --git a/usr/src/man/man9f/u8_textprep_str.9f b/usr/src/man/man9f/u8_textprep_str.9f index 29ddb5b9a1..d08f71e32d 100644 --- a/usr/src/man/man9f/u8_textprep_str.9f +++ b/usr/src/man/man9f/u8_textprep_str.9f @@ -7,7 +7,6 @@ .SH NAME u8_textprep_str \- string-based UTF-8 text preparation function .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/errno.h> @@ -19,11 +18,8 @@ u8_textprep_str \- string-based UTF-8 text preparation function .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIinarray\fR\fR @@ -268,8 +264,6 @@ The specified Unicode version value is not a supported version. .RE .SH DESCRIPTION -.sp -.LP The \fBu8_textprep_str()\fR function prepares the sequence of UTF-8 characters in the array specified by \fIinarray\fR into a sequence of corresponding UTF-8 characters prepared in the array specified by \fIoutarray\fR. The \fIinarray\fR @@ -295,8 +289,6 @@ reflect the number of bytes still not prepared in the input array. The value pointed to by \fIoutlen\fR is decremented to reflect the number of bytes still available in the output array. .SH RETURN VALUES -.sp -.LP The \fBu8_textprep_str()\fR function updates the values pointed to by \fIinlen\fR and \fIoutlen\fR arguments to reflect the extent of the preparation. When \fBU8_TEXTPREP_IGNORE_INVALID\fR is specified, @@ -310,12 +302,9 @@ mentioned above, the value pointed to by \fIinlen\fR will be non-zero and \fBu8_textprep_str()\fR returns (\fBsize_t\fR)-1 and sets \fIerrno\fR to indicate the error. .SH CONTEXT -.sp -.LP The \fBu8_textprep_str()\fR function can be called from user or interrupt context. .SH EXAMPLES -.LP \fBExample 1 \fRSimple UTF-8 text preparation .sp .in +2 @@ -364,8 +353,6 @@ if (ret == (size_t)-1) { .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -380,8 +367,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBu8_strcmp\fR(3C), \fBu8_textprep_str\fR(3C), \fBu8_validate\fR(3C), \fBattributes\fR(5), \fBu8_strcmp\fR(9F), \fBu8_validate\fR(9F), \fBuconv_u16tou32\fR(9F) diff --git a/usr/src/man/man9f/u8_validate.9f b/usr/src/man/man9f/u8_validate.9f index cc8e56cd03..11cd5e8112 100644 --- a/usr/src/man/man9f/u8_validate.9f +++ b/usr/src/man/man9f/u8_validate.9f @@ -7,7 +7,6 @@ .SH NAME u8_validate \- validate UTF-8 characters and calculate the byte length .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/errno.h> @@ -18,11 +17,8 @@ u8_validate \- validate UTF-8 characters and calculate the byte length .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIu8str\fR\fR @@ -156,20 +152,15 @@ range of the Unicode coding space. .RE .SH DESCRIPTION -.sp -.LP The \fBu8_validate()\fR function validates \fIu8str\fR in UTF-8 and determines the number of bytes constituting the character(s) pointed to by \fIu8str\fR. .SH RETURN VALUES -.sp -.LP If \fIu8str\fR is a null pointer, \fBu8_validate()\fR returns 0. Otherwise, \fBu8_validate()\fR returns either the number of bytes that constitute the characters if the next \fIn\fR or fewer bytes form valid characters, or -1 if there is an validation failure, in which case it may set \fIerrno\fR to indicate the error. .SH EXAMPLES -.LP \fBExample 1 \fRDetermine the length of the first UTF-8 character. .sp .in +2 @@ -272,8 +263,6 @@ if (len == -1) { .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -288,8 +277,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBu8_strcmp\fR(3C), \fBu8_textprep_str\fR(3C), \fBu8_validate\fR(3C), \fBattributes\fR(5), \fBu8_strcmp\fR(9F), \fBu8_textprep_str\fR(9F), \fBuconv_u16tou32\fR(9F) diff --git a/usr/src/man/man9f/uconv_u16tou32.9f b/usr/src/man/man9f/uconv_u16tou32.9f index 2a5ff771a8..3dd09887d8 100644 --- a/usr/src/man/man9f/uconv_u16tou32.9f +++ b/usr/src/man/man9f/uconv_u16tou32.9f @@ -8,7 +8,6 @@ uconv_u16tou32, uconv_u16tou8, uconv_u32tou16, uconv_u32tou8, uconv_u8tou16, uconv_u8tou32 \- Unicode encoding conversion functions .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/errno.h> @@ -49,11 +48,8 @@ uconv_u8tou32 \- Unicode encoding conversion functions .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS -.sp .ne 2 .na \fB\fIutf16str\fR\fR @@ -224,8 +220,6 @@ character to indicate the byte ordering if the output parameter is in .RE .SH DESCRIPTION -.sp -.LP The \fBuconv_u16tou32()\fR function reads the given \fIutf16str\fR in \fBUTF-16\fR until \fBU+0000\fR (zero) in \fIutf16str\fR is encountered as a character or until the number of 16-bit unsigned integers specified in @@ -305,14 +299,10 @@ the specified number of input parameter elements at \fIutf16len\fR, As output parameters, \fIutf16len\fR, \fIutf32len\fR, and \fIutf8len\fR are not changed if conversion fails for any reason. .SH CONTEXT -.sp -.LP The \fBuconv_u16tou32()\fR, \fBuconv_u16tou8()\fR, \fBuconv_u32tou16()\fR, \fBuconv_u32tou8()\fR, \fBuconv_u8tou16()\fR, and \fBuconv_u8tou32()\fR functions can be called from user or interrupt context. .SH RETURN VALUES -.sp -.LP Upon successful conversion, the functions return \fB0\fR. Upon failure, the functions return one of the following \fBerrno\fR values: .sp @@ -355,7 +345,6 @@ Conflicting byte-ordering option \fIflag\fR values are detected. .RE .SH EXAMPLES -.LP \fBExample 1 \fRConvert a \fBUTF-16\fR string in little-endian byte ordering into \fBUTF-8\fR string. .sp @@ -470,8 +459,6 @@ if (ret != 0) { .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -486,15 +473,11 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBuconv_u16tou32\fR(3C), \fBattributes\fR(5) .sp .LP The Unicode Standard (http://www.unicode.org) .SH NOTES -.sp -.LP Each \fBUTF-16\fR or \fBUTF-32\fR character maps to an \fBUTF-8\fR character that might need one to maximum of four bytes. .sp diff --git a/usr/src/man/man9f/usb_alloc_request.9f b/usr/src/man/man9f/usb_alloc_request.9f index f8a68298f6..9e5baeadde 100644 --- a/usr/src/man/man9f/usb_alloc_request.9f +++ b/usr/src/man/man9f/usb_alloc_request.9f @@ -9,7 +9,6 @@ usb_alloc_request, usb_alloc_ctrl_req, usb_free_ctrl_req, usb_alloc_bulk_req, usb_free_bulk_req, usb_alloc_intr_req, usb_free_intr_req, usb_alloc_isoc_req, usb_free_isoc_req \- Allocate and free USB transfer requests .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -56,12 +55,8 @@ usb_free_isoc_req \- Allocate and free USB transfer requests .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp -.LP For \fBusb_alloc_ctrl_req()\fR, \fBusb_alloc_bulk_req()\fR and \fBusb_alloc_intr_req()\fR: .sp @@ -147,8 +142,6 @@ Pointer to the request structure to be freed. Can be \fBNULL\fR. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_alloc_ctrl_req()\fR, \fBusb_alloc_bulk_req()\fR, \fBusb_alloc_intr_req()\fR, and \fBusb_alloc_isoc_req()\fR functions allocate control, bulk, interrupt, or isochronous requests. Optionally, these @@ -173,8 +166,6 @@ corresponding request. If the request's data block pointer is non-zero, the data block is also freed. For isoc requests, the array of packet descriptors is freed. .SH RETURN VALUES -.sp -.LP For \fBusb_alloc_ctrl_req()\fR, \fBusb_alloc_bulk_req()\fR, \fBusb_alloc_intr_req()\fR and \fBusb_alloc_isoc_req()\fR: .sp @@ -190,15 +181,12 @@ USB_FLAGS_SLEEP is set but the call was made in interrupt context. For \fBusb_free_ctrl_req()\fR, \fBusb_free_bulk_req()\fR, \fBusb_free_intr_req()\fR and \fBusb_free_isoc_req()\fR: None. .SH CONTEXT -.sp -.LP The allocation routines can always be called from kernel and user context. They may be called from interrupt context only if USB_FLAGS_SLEEP is not specified. .sp .LP The free routines may be called from kernel, user, and interrupt context. .SH EXAMPLES -.sp .in +2 .nf /* This allocates and initializes an asynchronous control @@ -228,8 +216,6 @@ The free routines may be called from kernel, user, and interrupt context. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -246,8 +232,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_current_frame_number\fR(9F), \fBusb_get_max_pkts_per_isoc_request\fR(9F), \fBusb_pipe_get_max_bulk_transfer_size\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), diff --git a/usr/src/man/man9f/usb_client_attach.9f b/usr/src/man/man9f/usb_client_attach.9f index 6aa757d190..b7654cb6f1 100644 --- a/usr/src/man/man9f/usb_client_attach.9f +++ b/usr/src/man/man9f/usb_client_attach.9f @@ -9,7 +9,6 @@ usb_client_attach, usb_client_detach \- USBA framework registration of client USB drivers .SH SYNOPSIS -.LP .nf #define USBDRV_MAJOR_VER <major> #define USBDRV_MINOR_VER <minor> @@ -28,10 +27,8 @@ USB drivers .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.LP For \fBusb_client_attach()\fR: .sp .ne 2 @@ -82,7 +79,6 @@ Pointer to a usb_client_dev_data_t to free. Can be NULL. .RE .SH DESCRIPTION -.LP The \fBusb_client_attach()\fR function registers a driver with the USBA framework and must be called before any other USBA function. Usually, \fBusb_client_attach()\fR is followed by a call to \fBusb_get_dev_data\fR(9F). @@ -95,7 +91,6 @@ dev_data argument is non-NULL. The \fBusb_client_detach()\fR function is the last USBA function a client calls before completing \fBdetach\fR(9E). It is not necessary to call \fBusb_client_detach()\fR during a suspend operation. .SS "VERSIONING" -.LP USBDRV_VERSION is a macro which creates a version number based on the USBDRV_MAJOR_VER and USBDRV_MINOR_VER definitions. It must be passed as the version argument. @@ -115,7 +110,6 @@ Definitions of USBDRV_MAJOR_VERSION and USBDRV_MINOR_VERSION must appear in the client driver above the reference to <\fBsys/usb/usba.h\fR>. Note that different releases have different USBA_[MAJOR|MINOR]_VER numbers. .SH RETURN VALUES -.LP For \fBusb_client_attach()\fR: .sp .ne 2 @@ -184,7 +178,6 @@ Not called from an attach routine context. .RE .SH CONTEXT -.LP The \fBusb_client_attach()\fR function may only be called from \fBattach\fR(9E). .sp @@ -213,7 +206,6 @@ or \fBdetach\fR(9E). .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -230,6 +222,5 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBattach\fR(9E), \fBdetach\fR(9E), \fBusb_get_dev_data\fR(9F) diff --git a/usr/src/man/man9f/usb_clr_feature.9f b/usr/src/man/man9f/usb_clr_feature.9f index 24f666093a..02a5053658 100644 --- a/usr/src/man/man9f/usb_clr_feature.9f +++ b/usr/src/man/man9f/usb_clr_feature.9f @@ -8,7 +8,6 @@ .SH NAME usb_clr_feature \- Clear feature of USB device, interface or endpoint .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -23,11 +22,8 @@ usb_clr_feature \- Clear feature of USB device, interface or endpoint .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -127,8 +123,6 @@ Second argument passed to callback handler. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_clr_feature()\fR function clears a specific feature of a device, interface or endpoint. This function always blocks and waits for resources if not available, regardless of the flags argument. @@ -138,7 +132,6 @@ This call blocks for completion if USB_FLAGS_SLEEP is set in flags. It returns immediately and calls the callback upon completion if USB_FLAGS_SLEEP is not set. .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -184,8 +177,6 @@ Clearing of feature was unsuccessful. .RE .SH CONTEXT -.sp -.LP May always be called from user or kernel context. May be called from interrupt context only if USB_FLAGS_SLEEP is not set in flags. .sp @@ -195,7 +186,6 @@ supplied, can block because it is executing in kernel context. Otherwise the callback cannot block. Please see \fBusb_callback_flags\fR(9S) for more information on callbacks. .SH EXAMPLES -.sp .in +2 .nf if (usb_clr_feature(dip, pipe_handle, USB_DEV_REQ_RCPT_EP, @@ -210,8 +200,6 @@ if (usb_clr_feature(dip, pipe_handle, USB_DEV_REQ_RCPT_EP, .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -228,7 +216,5 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_status\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_pipe_get_state\fR(9F), \fBusb_callback_flags\fR(9S) diff --git a/usr/src/man/man9f/usb_create_pm_components.9f b/usr/src/man/man9f/usb_create_pm_components.9f index 9346fb4a55..d2d729f270 100644 --- a/usr/src/man/man9f/usb_create_pm_components.9f +++ b/usr/src/man/man9f/usb_create_pm_components.9f @@ -7,7 +7,6 @@ .SH NAME usb_create_pm_components \- Create power management components for USB devices .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -17,11 +16,8 @@ usb_create_pm_components \- Create power management components for USB devices .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -77,8 +73,6 @@ Corresponds to USB_DEV_OS_PWR_0 or no power. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_create_pm_components()\fR function creates pm component properties that assume the standard USB D0-D3 powerlevels (USB_DEV_PWR_D0 - USB_DEV_PWR_D3). See the device's relevant USB descriptor to determine the @@ -91,7 +85,6 @@ Note that these USB power levels are inverse of OS power levels. For example, USB_DEV_OS_PWR_0 and USB_DEV_PWR_D3 are equivalent levels corresponding to powered-down. .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -110,11 +103,8 @@ An error occurred. .RE .SH CONTEXT -.sp -.LP May be called from user or kernel context. .SH EXAMPLES -.sp .in +2 .nf uint_t *pwrstates; @@ -128,8 +118,6 @@ May be called from user or kernel context. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -146,8 +134,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_clr_feature\fR(9F), \fBusb_register_hotplug_cbs\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_handle_remote_wakeup\fR(9F), diff --git a/usr/src/man/man9f/usb_get_addr.9f b/usr/src/man/man9f/usb_get_addr.9f index 746530b264..109437755e 100644 --- a/usr/src/man/man9f/usb_get_addr.9f +++ b/usr/src/man/man9f/usb_get_addr.9f @@ -7,7 +7,6 @@ .SH NAME usb_get_addr \- Retrieve device USB address .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -15,8 +14,7 @@ usb_get_addr \- Retrieve device USB address .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -27,19 +25,16 @@ Pointer to the device's dev_info structure. .RE .SH DESCRIPTION -.LP The \fBusb_get_addr()\fR function returns the current USB bus address for debugging purposes. The returned address is unique for a specific USB bus, and may be replicated if multiple host controller instances are present on the system. .SH RETURN VALUES -.LP On success: USB device address. .sp .LP On failure: returns 0. Fails if dip is NULL. .SH CONTEXT -.LP May be called from user, kernel or interrupt context. .SH EXAMPLES .in +2 @@ -51,7 +46,6 @@ usb_addr = usb_get_addr(dip); .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -68,5 +62,4 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_pipe_xopen\fR(9F) diff --git a/usr/src/man/man9f/usb_get_alt_if.9f b/usr/src/man/man9f/usb_get_alt_if.9f index 837fdf0fc3..c726aeb312 100644 --- a/usr/src/man/man9f/usb_get_alt_if.9f +++ b/usr/src/man/man9f/usb_get_alt_if.9f @@ -8,7 +8,6 @@ usb_get_alt_if, usb_set_alt_if, usb_get_if_number, usb_owns_device \- Get and set alternate interface values .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -42,12 +41,8 @@ set alternate interface values .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp -.LP For \fBusb_get_alt_if()\fR: .sp .ne 2 @@ -168,8 +163,6 @@ Pointer to device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP USB devices can have multiple configurations, each with many interfaces. Within interfaces are alternate settings, and within alternate settings are endpoints. .sp @@ -264,8 +257,6 @@ The \fBusb_owns_device()\fR function returns \fBB_TRUE\fR if the driver of the dip argument owns the entire device, or \fBB_FALSE\fR if it owns just a particular interface. .SH RETURN VALUES -.sp -.LP For \fBusb_get_alt_if()\fR: .sp .ne 2 @@ -403,8 +394,6 @@ Driver of the dip argument owns only the current interface. .RE .SH CONTEXT -.sp -.LP The \fBusb_get_if_number()\fR and \fBusb_owns_device()\fR functions may be called from user or kernel context. .sp @@ -419,7 +408,6 @@ executing in kernel context. Otherwise the callback cannot block. See .LP The \fBusb_get_alt_if()\fR function may be called from user or kernel context. .SH EXAMPLES -.sp .in +2 .nf /* Change alternate setting of interface 0. Wait for completion. */ @@ -435,8 +423,6 @@ if (usb_set_alt_if( .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -453,7 +439,5 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_get_cfg\fR(9F) diff --git a/usr/src/man/man9f/usb_get_cfg.9f b/usr/src/man/man9f/usb_get_cfg.9f index 12d387470b..94d2c47b6c 100644 --- a/usr/src/man/man9f/usb_get_cfg.9f +++ b/usr/src/man/man9f/usb_get_cfg.9f @@ -7,7 +7,6 @@ .SH NAME usb_get_cfg, usb_set_cfg \- Get and set current USB device configuration .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -25,10 +24,8 @@ usb_get_cfg, usb_set_cfg \- Get and set current USB device configuration .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.LP For \fBusb_get_cfg()\fR: .sp .ne 2 @@ -108,7 +105,6 @@ Second argument passed to callback handler. .RE .SH DESCRIPTION -.LP The \fBusb_get_cfg()\fR function retrieves the current configuration. It ignores the flags argument and always blocks while contacting the device. .sp @@ -131,7 +127,6 @@ function is the only supported programmatic way to change device configuration. This call blocks if USB_FLAGS_SLEEP is set in flags. It returns immediately and calls the callback on completion if USB_FLAGS_SLEEP is not set. .SH RETURN VALUES -.LP For \fBusb_get_cfg()\fR: .sp .ne 2 @@ -231,7 +226,6 @@ One or more pipes other than the default control pipe are open on the device. .RE .SH CONTEXT -.LP The \fBusb_get_cfg()\fR function may be called from user or kernel context. .sp .LP @@ -281,7 +275,6 @@ information on callbacks. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -298,7 +291,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_pipe_xopen\fR(9F), \fBusb_callback_flags\fR(9S), \fBusb_cfg_descr\fR(9S), \fBusb_ep_descr\fR(9S), diff --git a/usr/src/man/man9f/usb_get_current_frame_number.9f b/usr/src/man/man9f/usb_get_current_frame_number.9f index a0ac6a4916..daa7176e47 100644 --- a/usr/src/man/man9f/usb_get_current_frame_number.9f +++ b/usr/src/man/man9f/usb_get_current_frame_number.9f @@ -7,7 +7,6 @@ .SH NAME usb_get_current_frame_number \- Return current logical usb frame number .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -17,11 +16,8 @@ usb_get_current_frame_number \- Return current logical usb frame number .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -31,8 +27,6 @@ Pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_get_current_frame_number()\fR function retrieves the current logical USB frame number. .sp @@ -44,21 +38,16 @@ isochronous request. .sp .LP The USB specification requires that the frame frequency (the period between -start-of-frame packets) is one millisecond. The Solaris operating environment +start-of-frame packets) is one millisecond. The illumos operating environment USB implementation uses a running counter of the number of milliseconds since boot as the current logical frame number. .SH RETURN VALUES -.sp -.LP On success, the \fBusb_get_current_frame_number()\fR function returns the current USB frame number. On failure it returns \fB0\fR. The function fails if \fIdip\fR is NULL. .SH CONTEXT -.sp -.LP May be called from user, kernel or interrupt context. .SH EXAMPLES -.sp .in +2 .nf usb_pipe_handle_t handle; @@ -79,8 +68,6 @@ May be called from user, kernel or interrupt context. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -97,8 +84,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_alloc_isoc_req\fR(9F), \fBusb_get_max_pkts_per_isoc_request\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), \fBusb_pipe_get_max_bulk_transfer_size\fR(9F), \fBusb_isoc_request\fR(9S) diff --git a/usr/src/man/man9f/usb_get_dev_data.9f b/usr/src/man/man9f/usb_get_dev_data.9f index 01269dfa15..9290fdfd51 100644 --- a/usr/src/man/man9f/usb_get_dev_data.9f +++ b/usr/src/man/man9f/usb_get_dev_data.9f @@ -8,7 +8,6 @@ usb_get_dev_data, usb_free_dev_data, usb_free_descr_tree, usb_print_descr_tree \- Retrieve device configuration information .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -34,10 +33,8 @@ usb_get_dev_data, usb_free_dev_data, usb_free_descr_tree, usb_print_descr_tree .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.LP For \fBusb_get_dev_data()\fR: .sp .ne 2 @@ -141,7 +138,6 @@ on-screen. .RE .SH DESCRIPTION -.LP The \fBusb_get_dev_data()\fR function interrogates a device and returns its configuration information in a usb_client_dev_data_t structure. Most USBA functions require information which comes from a usb_client_dev_data_t, and all @@ -219,7 +215,6 @@ which dumps the descriptor tree to the screen when the system is verbose booted (\fBboot\fR \fB-v\fR). Output is spaced with blank lines for readability and provides you with an on-screen look at what a device has to offer. .SH RETURN VALUES -.LP For \fBusb_get_dev_data()\fR: .sp .ne 2 @@ -313,7 +308,6 @@ Other error. .RE .SH CONTEXT -.LP The \fBusb_get_dev_data()\fR and \fBusb_print_descr_tree()\fR functions may be called from user or kernel context. .sp @@ -385,7 +379,6 @@ current OS device node. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -402,7 +395,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_client_attach\fR(9F), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_lookup_ep_data\fR(9F), \fBusb_parse_data\fR(9F), diff --git a/usr/src/man/man9f/usb_get_max_pkts_per_isoc_request.9f b/usr/src/man/man9f/usb_get_max_pkts_per_isoc_request.9f index ce423b652f..a796a777b1 100644 --- a/usr/src/man/man9f/usb_get_max_pkts_per_isoc_request.9f +++ b/usr/src/man/man9f/usb_get_max_pkts_per_isoc_request.9f @@ -8,7 +8,6 @@ usb_get_max_pkts_per_isoc_request \- Get maximum number of packets allowed per isochronous request .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -18,8 +17,7 @@ isochronous request .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -30,7 +28,6 @@ Pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.LP The \fBusb_get_max_pkts_per_isoc_request()\fR function returns the maximum number of isochronous packets per request that the host control driver can support. This number can be used to determine the maximum amount of data which @@ -47,12 +44,10 @@ max = usb_get_max_pkts_per_isoc_request(dip) * endpoint_max_packet_size; where endpoint_max_packet_size is the wMaxPacketSize field of the isochronous endpoint over which the transfer will take place. .SH RETURN VALUES -.LP On success, the \fBusb_get_max_pkts_per_isoc_request()\fR function returns the maximum number of isochronous pkts per request. On failure it returns \fB0\fR. The function fails if \fIdip\fR is NULL. .SH CONTEXT -.LP May be called from user, kernel or interrupt context. .SH EXAMPLES .in +2 @@ -97,7 +92,6 @@ if (usb_pipe_isoc_xfer(pipe, isoc_req, USB_FLAGS_NOSLEEP) != USB_SUCCESS) { .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -114,7 +108,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_pipe_isoc_xfer\fR(9F), \fBusb_alloc_request\fR(9F), \fBusb_get_current_frame_number\fR(9F), \fBusb_ep_descr\fR(9S), \fBusb_isoc_request\fR(9S) diff --git a/usr/src/man/man9f/usb_get_status.9f b/usr/src/man/man9f/usb_get_status.9f index fbb87453be..f7d440ce3e 100644 --- a/usr/src/man/man9f/usb_get_status.9f +++ b/usr/src/man/man9f/usb_get_status.9f @@ -7,7 +7,6 @@ .SH NAME usb_get_status \- Get status of a USB device/endpoint/interface .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -19,11 +18,8 @@ usb_get_status \- Get status of a USB device/endpoint/interface .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -85,8 +81,6 @@ None are recognized. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_get_status()\fR function returns the status of a device, interface or endpoint. All status requests use the default control pipe. Length of data returned is USB_GET_STATUS_LEN bytes. Always block and wait for resources if @@ -107,7 +101,6 @@ halted). A set bit indicates the corresponding status. When the \fIrequest_type\fR is USB_DEV_REQ_RCPT_IF, interface status is requested and USB_IF_STATUS (zero) is returned. .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -144,11 +137,8 @@ Status not returned successfully. .RE .SH CONTEXT -.sp -.LP May be called from user or kernel context. .SH EXAMPLES -.sp .in +2 .nf uint16_t status; @@ -166,8 +156,6 @@ May be called from user or kernel context. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -184,7 +172,5 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_clr_feature\fR(9F), \fBusb_get_alt_if\fR(9F), \fBusb_pipe_get_state\fR(9F), \fBusb_get_cfg\fR(9F), diff --git a/usr/src/man/man9f/usb_get_string_descr.9f b/usr/src/man/man9f/usb_get_string_descr.9f index 2efa17d692..98e058b5e5 100644 --- a/usr/src/man/man9f/usb_get_string_descr.9f +++ b/usr/src/man/man9f/usb_get_string_descr.9f @@ -8,7 +8,6 @@ .SH NAME usb_get_string_descr \- Get string descriptor from device .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -20,11 +19,8 @@ usb_get_string_descr \- Get string descriptor from device .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -70,8 +66,6 @@ Size of buf in bytes. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_get_string_descr()\fR function retrieves a parsed string descriptor from a device. \fIdip\fR specifies the device, while \fIindex\fR indicates which descriptor to return. @@ -88,7 +82,6 @@ descriptor index describing a specific configuration. Retrieved descriptors that do not fit into \fIbuflen\fR bytes are truncated. All returned descriptors are null-terminated. .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -117,11 +110,8 @@ Descriptor cannot be retrieved. .RE .SH CONTEXT -.sp -.LP May be called from user or kernel context. .SH EXAMPLES -.sp .in +2 .nf /* Get the first string descriptor. */ @@ -137,8 +127,6 @@ May be called from user or kernel context. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -155,6 +143,4 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_dev_data\fR(9F), \fBusb_string_descr\fR(9S) diff --git a/usr/src/man/man9f/usb_handle_remote_wakeup.9f b/usr/src/man/man9f/usb_handle_remote_wakeup.9f index 916ab45f77..3e945fe30f 100644 --- a/usr/src/man/man9f/usb_handle_remote_wakeup.9f +++ b/usr/src/man/man9f/usb_handle_remote_wakeup.9f @@ -7,7 +7,6 @@ .SH NAME usb_handle_remote_wakeup \- Enable or disable remote wakeup on USB devices .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -17,11 +16,8 @@ usb_handle_remote_wakeup \- Enable or disable remote wakeup on USB devices .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -40,12 +36,9 @@ Command. Either USB_REMOTE_WAKEUP_ENABLE or USB_REMOTE_WAKEUP_DISABLE. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_handle_remote_wakeup()\fR function enables or disables remote wakeup on a USB device. This call can block. .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -64,11 +57,8 @@ Remote wakeup is not supported by the device. An internal error occurred. .RE .SH CONTEXT -.sp -.LP May be called from user or kernel context. .SH EXAMPLES -.sp .in +2 .nf uint_t *pwrstates; @@ -82,8 +72,6 @@ May be called from user or kernel context. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -100,8 +88,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F), \fBpm_lower_power\fR(9F), \fBpm_raise_power\fR(9F), \fBusb_clr_feature\fR(9F), \fBusb_create_pm_components\fR(9F), \fBusb_get_cfg\fR(9F), diff --git a/usr/src/man/man9f/usb_lookup_ep_data.9f b/usr/src/man/man9f/usb_lookup_ep_data.9f index 18f2317b98..b3a467aae2 100644 --- a/usr/src/man/man9f/usb_lookup_ep_data.9f +++ b/usr/src/man/man9f/usb_lookup_ep_data.9f @@ -7,7 +7,6 @@ .SH NAME usb_lookup_ep_data \- Lookup endpoint information .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -19,8 +18,7 @@ usb_lookup_ep_data \- Lookup endpoint information .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -89,7 +87,6 @@ ignored for bi-directional control endpoints. .RE .SH DESCRIPTION -.LP The \fBusb_lookup_ep_data()\fR function returns endpoint information from the tree embedded in client data returned from \fBusb_get_dev_data\fR. It operates on the current configuration (pointed to by the dev_curr_cfg field of the @@ -98,7 +95,6 @@ endpoints it finds which match the specifications of the other arguments, and then retrieves information on the next matching endpoint it finds. Note that it does not make a copy of the data, but points to the tree itself. .SH RETURN VALUES -.LP On success: the tree node corresponding to the desired endpoint. .sp .LP @@ -106,10 +102,8 @@ On failure: returns NULL. Fails if \fIdip\fR or \fIdev_datap\fR are NULL, if the desired endpoint does not exist in the tree, or no tree is present in dev_datap. .SH CONTEXT -.LP May be called from user, kernel or interrupt context. .SH EXAMPLES -.LP Retrieve the polling interval for the second interrupt endpoint at interface 0, alt 3: .sp @@ -141,7 +135,6 @@ Retrieve the maximum packet size for the first control pipe at interface 0, alt .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -158,6 +151,5 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_get_dev_data\fR(9F), \fBusb_pipe_open\fR(9F), \fBusb_cfg_descr\fR(9S), \fBusb_if_descr\fR(9S), \fBusb_ep_descr\fR(9S) diff --git a/usr/src/man/man9f/usb_parse_data.9f b/usr/src/man/man9f/usb_parse_data.9f index f3ac26e710..c6954bd5fa 100644 --- a/usr/src/man/man9f/usb_parse_data.9f +++ b/usr/src/man/man9f/usb_parse_data.9f @@ -17,7 +17,7 @@ usb_parse_data \- Tokenize and align the bytes of raw variable-format data .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na diff --git a/usr/src/man/man9f/usb_pipe_bulk_xfer.9f b/usr/src/man/man9f/usb_pipe_bulk_xfer.9f index 04f0e61570..26a9c1164a 100644 --- a/usr/src/man/man9f/usb_pipe_bulk_xfer.9f +++ b/usr/src/man/man9f/usb_pipe_bulk_xfer.9f @@ -7,7 +7,6 @@ .SH NAME usb_pipe_bulk_xfer \- USB bulk transfer function .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -18,8 +17,7 @@ usb_pipe_bulk_xfer \- USB bulk transfer function .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -48,7 +46,6 @@ USB_FLAGS_SLEEP is the only flag recognized. Wait for request to complete. .RE .SH DESCRIPTION -.LP The \fBusb_pipe_bulk_xfer()\fR function requests the USBA framework to perform a transfer through a USB bulk pipe. The request is passed to the host controller driver (HCD), which performs the necessary transactions to complete @@ -175,7 +172,6 @@ and bulk_cb_flags fields of the request. Please see \fBusb_completion_reason\fR(9S) and \fBusb_callback_flags\fR(9S) for more information. .SH CONTEXT -.LP May be called from kernel or user context without regard to arguments. May be called from interrupt context only when the USB_FLAGS_SLEEP flag is clear. .SH EXAMPLES @@ -203,7 +199,6 @@ called from interrupt context only when the USB_FLAGS_SLEEP flag is clear. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -220,7 +215,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_status\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_get_state\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), diff --git a/usr/src/man/man9f/usb_pipe_close.9f b/usr/src/man/man9f/usb_pipe_close.9f index 65de310245..b1b2c0c11f 100644 --- a/usr/src/man/man9f/usb_pipe_close.9f +++ b/usr/src/man/man9f/usb_pipe_close.9f @@ -21,7 +21,7 @@ usb_pipe_close \- Close and cleanup a USB device pipe .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na diff --git a/usr/src/man/man9f/usb_pipe_ctrl_xfer.9f b/usr/src/man/man9f/usb_pipe_ctrl_xfer.9f index 9e8f057b58..0bd4600208 100644 --- a/usr/src/man/man9f/usb_pipe_ctrl_xfer.9f +++ b/usr/src/man/man9f/usb_pipe_ctrl_xfer.9f @@ -8,7 +8,6 @@ usb_pipe_ctrl_xfer, usb_pipe_ctrl_xfer_wait \- USB control pipe transfer functions .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -26,10 +25,8 @@ functions .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.LP For \fBusb_pipe_ctrl_xfer()\fR: .sp .ne 2 @@ -120,7 +117,6 @@ No flags are recognized. Reserved for future expansion. .RE .SH DESCRIPTION -.LP The \fBusb_pipe_ctrl_xfer()\fR function requests the USBA framework to perform a transfer through a USB control pipe. The request is passed to the host controller driver (HCD), which performs the necessary transactions to complete @@ -183,7 +179,6 @@ Mblks for data are allocated optionally when a request is allocated via argument. Control requests passing or receiving no supplemental data need not allocate an mblk. .SH RETURN VALUES -.LP For \fBusb_pipe_ctrl_xfer()\fR: .sp .ne 2 @@ -314,7 +309,6 @@ and ctrl_cb_flags fields of the request. Please see \fBusb_callback_flags\fR(9S) and \fBusb_completion_reason\fR(9S) for more information. .SH CONTEXT -.LP The \fBusb_pipe_ctrl_xfer()\fR function may be called from kernel or user context without regard to arguments and from the interrupt context only when the USB_FLAGS_SLEEP flag is clear. @@ -430,7 +424,6 @@ context. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -447,7 +440,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_status\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), diff --git a/usr/src/man/man9f/usb_pipe_drain_reqs.9f b/usr/src/man/man9f/usb_pipe_drain_reqs.9f index a987e49a5c..f1fe843cbd 100644 --- a/usr/src/man/man9f/usb_pipe_drain_reqs.9f +++ b/usr/src/man/man9f/usb_pipe_drain_reqs.9f @@ -7,7 +7,6 @@ .SH NAME usb_pipe_drain_reqs \- Allow completion of pending pipe requests .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -21,11 +20,8 @@ usb_pipe_drain_reqs \- Allow completion of pending pipe requests .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -82,8 +78,6 @@ Second argument passed to callback function. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_pipe_drain_reqs()\fR function provides waits for pending requests to complete and then provides synchronous or asynchronous notification that all pending requests on a non-shared pipe indicated by pipe_handle have completed. @@ -166,7 +160,6 @@ Error starting asynchronous request. .RE .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -204,8 +197,6 @@ Pipe is not open, is closing or is closed. .RE .SH CONTEXT -.sp -.LP May be called from user or kernel context. .sp .LP @@ -214,7 +205,6 @@ supplied, can block because it is executing in kernel context. Otherwise the callback cannot block. Please see \fBusb_callback_flags\fR(9S) for more information on callbacks. .SH EXAMPLES -.sp .in +2 .nf mydev_detach(dev_info_t *dip, ddi_detach_cmd_t cmd) @@ -245,8 +235,6 @@ information on callbacks. .in -2 .SH NOTES -.sp -.LP For pipes other than the default control pipe, it is recommended to close the pipe using a synchronous \fBusb_pipe_close()\fR. \fBusb_pipe_close()\fR with the USB_FLAGS_SLEEP flag allows any pending requests in that pipe to complete @@ -257,8 +245,6 @@ Do not call \fBusb_pipe_drain_reqs()\fR while additional requests are being submitted by a different thread. This action can stall the calling thread of \fBusb_pipe_drain_reqs()\fR unnecessarily. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -275,7 +261,5 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_pipe_close\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_callback_flags\fR(9S) diff --git a/usr/src/man/man9f/usb_pipe_get_max_bulk_transfer_size.9f b/usr/src/man/man9f/usb_pipe_get_max_bulk_transfer_size.9f index 4612777264..f47745fe2e 100644 --- a/usr/src/man/man9f/usb_pipe_get_max_bulk_transfer_size.9f +++ b/usr/src/man/man9f/usb_pipe_get_max_bulk_transfer_size.9f @@ -8,7 +8,6 @@ .SH NAME usb_pipe_get_max_bulk_transfer_size \- Get maximum bulk transfer size .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -18,11 +17,8 @@ usb_pipe_get_max_bulk_transfer_size \- Get maximum bulk transfer size .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -41,14 +37,11 @@ Returns the bulk transfer size. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_pipe_get_max_bulk_transfer_size()\fR function returns the maximum data transfer size in bytes that the host controller driver can support per bulk request. This information can be used to limit or break down larger requests to manageable sizes. .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -76,11 +69,8 @@ Size could not be returned. Zero is returned in \fIsize\fR arg. .RE .SH CONTEXT -.sp -.LP May be called from user, kernel or interrupt context. .SH EXAMPLES -.sp .in +2 .nf int xxx_attach(dev_info_t *dip, int command) @@ -104,8 +94,6 @@ May be called from user, kernel or interrupt context. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -122,7 +110,5 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_alloc_request\fR(9F), \fBusb_bulk_request\fR(9S) diff --git a/usr/src/man/man9f/usb_pipe_get_state.9f b/usr/src/man/man9f/usb_pipe_get_state.9f index a236d6649e..bfc79c8eff 100644 --- a/usr/src/man/man9f/usb_pipe_get_state.9f +++ b/usr/src/man/man9f/usb_pipe_get_state.9f @@ -7,7 +7,6 @@ .SH NAME usb_pipe_get_state \- Return USB pipe state .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -18,8 +17,7 @@ usb_pipe_get_state \- Return USB pipe state .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -48,7 +46,6 @@ No flags are recognized. Reserved for future expansion. .RE .SH DESCRIPTION -.LP The \fBusb_pipe_get_state()\fR function retrieves the state of the pipe referred to by \fIpipe_handle\fR into the location pointed to by \fIpipe_state\fR. @@ -132,7 +129,6 @@ Pipe_handle argument is \fBNULL\fR. .RE .SH CONTEXT -.LP May be called from user, kernel or interrupt context. .SH EXAMPLES .in +2 @@ -152,7 +148,6 @@ May be called from user, kernel or interrupt context. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -169,7 +164,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_clr_feature\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_status\fR(9F), \fBusb_pipe_close\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_xopen\fR(9F), diff --git a/usr/src/man/man9f/usb_pipe_intr_xfer.9f b/usr/src/man/man9f/usb_pipe_intr_xfer.9f index b08ea5d323..ca4c2cdee7 100644 --- a/usr/src/man/man9f/usb_pipe_intr_xfer.9f +++ b/usr/src/man/man9f/usb_pipe_intr_xfer.9f @@ -8,7 +8,6 @@ usb_pipe_intr_xfer, usb_pipe_stop_intr_polling \- USB interrupt transfer and polling functions .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -24,10 +23,8 @@ polling functions .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.LP For \fBusb_pipe_intr_xfer()\fR: .sp .ne 2 @@ -80,7 +77,6 @@ USB_FLAGS_SLEEP is the only flag recognized. Wait for polling to stop. .RE .SH DESCRIPTION -.LP The \fBusb_pipe_intr_xfer()\fR function requests the USBA framework to perform a transfer through a USB interrupt pipe. The request is passed to the host controller driver (HCD), which performs the necessary transactions to complete @@ -91,7 +87,6 @@ There are three categories of interrupt transfers: periodic or polled interrupt-IN, single-transfer interrupt-IN, and (single-transfer) interrupt-OUT. .SS "Periodic Interrupt-IN Transfers" -.LP Periodic or polled interrupt-IN transfers execute on input requests which do not have the USB_ATTRS_ONE_XFER attribute set. One request enables repetitive transfers at a periodic rate set by the endpoint's bInterval. There can be only @@ -122,7 +117,6 @@ set, the current (non-original) request is returned on error. Call this case. The USB_CR_STOPPED_POLLING flag is always set for callbacks where the original request is returned. .SS "Single-transfer Interrupt-IN Transfers" -.LP Interrupt-IN requests which have the USB_ATTRS_ONE_XFER attribute perform a single transfer. Such requests are synchronous when the USB_FLAGS_SLEEP flag is specified. Calls for synchronous requests do not return until their transaction @@ -130,7 +124,6 @@ is complete, and their callbacks are optional. The request is returned to the client through the normal or the exception completion callback to signal either normal completion or an error condition. .SS "Interrupt-OUT Transfers" -.LP Interrupt-OUT requests always set up for a single transfer. However, multiple requests can be queued and execute in periodic fashion until depleted. .sp @@ -190,7 +183,6 @@ Mblks for data for interrupt-OUT requests are allocated when a request is allocated via \fBusb_alloc_intr_req\fR(9F) by passing a non-negative value for the \fIlen\fR argument. .SH RETURN VALUES -.LP For \fBusb_pipe_intr_xfer()\fR .sp .ne 2 @@ -313,7 +305,6 @@ logfile. Exception handlers' queued requests which are flushed by these commands before execution are returned with completion reason of USB_CR_FLUSHED. .SH CONTEXT -.LP Both of these functions can be called from kernel or user context without regard to arguments, and may be called from interrupt context only when the USB_FLAGS_SLEEP flag is clear. @@ -380,7 +371,6 @@ USB_FLAGS_SLEEP flag is clear. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -397,7 +387,6 @@ Interface stability Evolving .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_status\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_get_state\fR(9F), diff --git a/usr/src/man/man9f/usb_pipe_isoc_xfer.9f b/usr/src/man/man9f/usb_pipe_isoc_xfer.9f index 137a3f7a87..2c5dd5a365 100644 --- a/usr/src/man/man9f/usb_pipe_isoc_xfer.9f +++ b/usr/src/man/man9f/usb_pipe_isoc_xfer.9f @@ -8,7 +8,6 @@ usb_pipe_isoc_xfer, usb_pipe_stop_isoc_polling \- USB isochronous transfer and polling functions .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -26,10 +25,8 @@ polling functions .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.LP For \fBusb_pipe_isoc_xfer()\fR: .sp .ne 2 @@ -81,7 +78,6 @@ USB_FLAGS_SLEEP is the only flag recognized. Wait for polling to stop. .RE .SH DESCRIPTION -.LP The \fBusb_pipe_isoc_xfer()\fR function requests the USBA framework to perform a transfer through a USB isochronous pipe. The request is passed to the host controller driver (HCD), which performs the necessary transactions to @@ -112,7 +108,6 @@ exception callbacks. Such errors will instead be logged in the packet descriptor's isoc_pkt_status field. These errors can be examined when the completed request is returned through a normal callback. .SS "Isochronous-OUT TRANSFERS" -.LP Allocate room for data when allocating isochronous-OUT requests via usb_alloc_isoc_req(9F), by passing a positive value for the \fIlen\fR argument. The data will be divided among the request transactions, each @@ -127,7 +122,6 @@ new request has its USB_ATTRS_ISOC_XFER_ASAP attribute set, the host controller driver will queue the request to start on a frame which immediately follows the last frame of the last queued request. .SS "Isochronous-IN TRANSFERS" -.LP All isochronous-IN transfers start background polling, and require only a single (original) request. The USBA framework will allocate a new request each time polling has new data to return. Specify a zero length when calling @@ -140,7 +134,6 @@ The original request passed to \fBusb_pipe_isoc_xfer()\fR will be used to return status when polling termination is requested, or for error condition notification. There can be only one isochronous-IN request submitted at a time. .SS "CALLBACKS" -.LP Isochronous transfer normal-completion callbacks cannot block for any reason since they are called from interrupt context. They will have USB_CB_INTR_CONTEXT set in their callback flags to note this. @@ -220,7 +213,6 @@ exception callback with a completion reason of USB_CR_STOPPED_POLLING. .RE .SH RETURN VALUES -.LP For \fBusb_pipe_isoc_xfer()\fR: .sp .ne 2 @@ -367,7 +359,6 @@ context; the pipe handle is invalid, NULL or pertains to a closing or closed pipe; or the pipe is in an error state. Messages regarding these errors will be logged to the console logfile. .SH CONTEXT -.LP Both of these functions may be called from kernel or user context without regard to arguments. May be called from interrupt context only when the USB_FLAGS_SLEEP flag is clear. @@ -421,7 +412,6 @@ USB_FLAGS_SLEEP flag is clear. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -438,7 +428,6 @@ Interface stability Evolving .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_current_frame_number\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_max_pkts_per_isoc_request\fR(9F), \fBusb_get_status\fR(9F), diff --git a/usr/src/man/man9f/usb_pipe_reset.9f b/usr/src/man/man9f/usb_pipe_reset.9f index 6bba298b4b..98008e6546 100644 --- a/usr/src/man/man9f/usb_pipe_reset.9f +++ b/usr/src/man/man9f/usb_pipe_reset.9f @@ -18,7 +18,7 @@ usb_pipe_reset \- Abort queued requests from a USB pipe and reset the pipe .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na diff --git a/usr/src/man/man9f/usb_pipe_set_private.9f b/usr/src/man/man9f/usb_pipe_set_private.9f index 20735dcc1d..a03ee1ec37 100644 --- a/usr/src/man/man9f/usb_pipe_set_private.9f +++ b/usr/src/man/man9f/usb_pipe_set_private.9f @@ -8,7 +8,6 @@ usb_pipe_set_private, usb_pipe_get_private \- USB user-defined pipe data-field facility .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -21,10 +20,8 @@ facility .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.LP For \fBusb_pipe_set_private()\fR: .sp .ne 2 @@ -57,7 +54,6 @@ Pipe handle from which user-defined data is retrieved. .RE .SH DESCRIPTION -.LP The \fBusb_set_driver_private()\fR function initializes the user-private data field of the pipe referred to by \fIpipe_handle\fR, using \fIdata\fR. The user-private data field is used to store any data the client desires and is @@ -69,7 +65,6 @@ The \fBusb_get_driver_private()\fR function retrieves the user-private data stored via \fBusb_set_driver_private()\fR, from the pipe referred to by \fIpipe_handle\fR. .SH RETURN VALUES -.LP For \fBusb_pipe_set_private()\fR: .sp .ne 2 @@ -111,7 +106,6 @@ On success: usb_opaque_t pointer to data being retrieved. On failure: \fBNULL\fR. Fails if pipe handle is \fBNULL\fR or invalid. Fails if pipe handle is to a pipe which is closing or closed. .SH CONTEXT -.LP May be called from user, kernel or interrupt context. .SH EXAMPLES .in +2 @@ -131,7 +125,6 @@ May be called from user, kernel or interrupt context. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -148,5 +141,4 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_pipe_xopen\fR(9F), \fBusb_alloc_request\fR(9F) diff --git a/usr/src/man/man9f/usb_pipe_xopen.9f b/usr/src/man/man9f/usb_pipe_xopen.9f index 4d403a786e..283758ed09 100644 --- a/usr/src/man/man9f/usb_pipe_xopen.9f +++ b/usr/src/man/man9f/usb_pipe_xopen.9f @@ -29,7 +29,7 @@ .Fa "usb_pipe_handle_t *pipe_handle" .Fc .Sh INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .Sh PARAMETERS .Bl -tag -width Fa .It Fa dip diff --git a/usr/src/man/man9f/usb_register_hotplug_cbs.9f b/usr/src/man/man9f/usb_register_hotplug_cbs.9f index 57642a40b8..a69f836d8b 100644 --- a/usr/src/man/man9f/usb_register_hotplug_cbs.9f +++ b/usr/src/man/man9f/usb_register_hotplug_cbs.9f @@ -9,7 +9,6 @@ usb_register_hotplug_cbs, usb_unregister_hotplug_cbs \- Register/unregister for notification of device hotplug events .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> @@ -26,12 +25,8 @@ notification of device hotplug events .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS -.sp -.LP For \fBusb_register_hotplug_cbs()\fR .sp .ne 2 @@ -80,8 +75,6 @@ Pointer to the device's \fBdev_info\fR structure. .RE .SH DESCRIPTION -.sp -.LP The \fBusb_register_hotplug_cbs()\fR function registers callbacks to be executed when the USB device represented by \fIdip\fR is hotplugged or removed. .sp @@ -90,8 +83,6 @@ The \fBusb_unregister_hotplug_cbs()\fR function unregisters or disengages callbacks from executing when the USB device represented by \fIdip\fR is hotplugged or removed. .SH RETURN VALUES -.sp -.LP For \fBusb_register_hotplug_cbs()\fR: .sp .ne 2 @@ -117,8 +108,6 @@ Callbacks could not be successfully registered. .LP For \fBusb_unregister_hotplug_cbs()\fR: None .SH CONTEXT -.sp -.LP The \fBusb_register_hotplug_cbs()\fR function may be called only from \fBattach\fR(9E). .sp @@ -135,7 +124,6 @@ thread can then safely call any DDI function it needs to handle the event. .LP The registered callback handlers execute in kernel context. .SH EXAMPLES -.sp .in +2 .nf @@ -164,8 +152,6 @@ The registered callback handlers execute in kernel context. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -182,7 +168,5 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBattach\fR(9E), \fBdetach\fR(9E), \fBusb_get_status\fR(9F) diff --git a/usr/src/man/man9f/usb_reset_device.9f b/usr/src/man/man9f/usb_reset_device.9f index d094450d30..5459f4d87d 100644 --- a/usr/src/man/man9f/usb_reset_device.9f +++ b/usr/src/man/man9f/usb_reset_device.9f @@ -7,7 +7,6 @@ .SH NAME usb_reset_device \- reset a USB device according to the reset_level. .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h @@ -18,8 +17,7 @@ usb_reset_device \- reset a USB device according to the reset_level. .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH PARAMETERS .ne 2 .na @@ -42,7 +40,6 @@ The level to which the device is reset. See below for a list of valid .RE .SH DESCRIPTION -.LP The \fBusb_reset_device()\fR function provides a client driver to request a hardware reset for a \fBUSB\fR device, which may be required in some situations such as: @@ -101,7 +98,6 @@ depending on where the failure occurred. .RE .SH RETURN VALUES -.LP The return values for the \fBusb_reset_device()\fR function are: .sp .ne 2 @@ -164,7 +160,6 @@ If \fBUSB_RESET_LVL_DEFAULT\fR is specified, called from interrupt context .RE .SH EXAMPLES -.LP \fBExample 1 \fRResetting a Device .sp .LP @@ -233,11 +228,9 @@ static int xxx_attach(dev_info_t *dip, ddi_attach_cmd_t cmd) .in -2 .SH CONTEXT -.LP The \fBusb_reset_device()\fR function may be called from user or kernel context. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -254,11 +247,9 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_clr_feature\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_pipe_close\fR(9F), \fBusb_pipe_xopen\fR(9F), \fBusb_pipe_reset\fR(9F), .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 @@ -310,5 +301,4 @@ function. .RE .SH NOTES -.LP Always close all applications before resetting a device. diff --git a/usr/src/man/man9f/va_arg.9f b/usr/src/man/man9f/va_arg.9f index 55452ce38a..580a2f975c 100644 --- a/usr/src/man/man9f/va_arg.9f +++ b/usr/src/man/man9f/va_arg.9f @@ -8,7 +8,6 @@ .SH NAME va_arg, va_start, va_copy, va_end \- handle variable argument list .SH SYNOPSIS -.LP .nf #include <sys/varargs.h> @@ -33,8 +32,7 @@ va_arg, va_start, va_copy, va_end \- handle variable argument list .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH PARAMETERS .SS "\fBva_start()\fR" .ne 2 @@ -100,7 +98,6 @@ Pointer to variable argument list. .RE .SH DESCRIPTION -.LP This set of macros allows portable procedures that accept variable argument lists to be written. Routines that have variable argument lists but do not use the \fBvarargs\fR macros are inherently non-portable, as different machines use @@ -150,7 +147,6 @@ The \fBva_end()\fR macro is used to clean up. It invalidates \fIpvar\fR for use Multiple traversals, each bracketed by a call to \fBva_start()\fR and \fBva_end()\fR, are possible. .SH EXAMPLES -.LP \fBExample 1 \fRCreating a Variable Length Command .sp .LP @@ -181,10 +177,8 @@ xx_write_cmd(uchar_t *cmdp, int ncmdbytes, ...) .in -2 .SH SEE ALSO -.LP \fBvcmn_err\fR(9F), \fBvsprintf\fR(9F) .SH NOTES -.LP It is up to the calling routine to specify in some manner how many arguments there are, since it is not always possible to determine the number of arguments from the stack frame. diff --git a/usr/src/man/man9s/Intro.9s b/usr/src/man/man9s/Intro.9s index 45aabc5549..c63d790b57 100644 --- a/usr/src/man/man9s/Intro.9s +++ b/usr/src/man/man9s/Intro.9s @@ -69,12 +69,12 @@ and in that order, and as final entries. .Pp The following table summarizes the STREAMS structures described in Section 9S. -.Bl -column "module_info" "Solaris DDI" -offset indent +.Bl -column "module_info" "illumos DDI" -offset indent .It Structure Ta Type .It Vt copyreq Ta DDI/DKI .It Vt copyresp Ta DDI/DKI .It Vt datab Ta DDI/DKI -.It Vt fmodsw Ta Solaris DDI +.It Vt fmodsw Ta illumos DDI .It Vt free_rtn Ta DDI/DKI .It Vt iocblk Ta DDI/DKI .It Vt linkblk Ta DDI/DKI @@ -82,43 +82,43 @@ The following table summarizes the STREAMS structures described in Section 9S. .It Vt msgb Ta DDI/DKI .It Vt qband Ta DDI/DKI .It Vt qinit Ta DDI/DKI -.It Vt queclass Ta Solaris DDI +.It Vt queclass Ta illumos DDI .It Vt queue Ta DDI/DKI .It Vt streamtab Ta DDI/DKI .It Vt stroptions Ta DDI/DKI .El .Pp The following table summarizes structures that are not specific to STREAMS I/O. -.Bl -column "ddi_device_acc_attr" "Solaris x86 DDI" -offset indent +.Bl -column "ddi_device_acc_attr" "illumos x86 DDI" -offset indent .It Structure Type -.It Vt aio_req Ta Solaris DDI +.It Vt aio_req Ta illumos DDI .It Vt buf Ta DDI/DKI -.It Vt cb_ops Ta Solaris DDI -.It Vt ddi_device_acc_attr Ta Solaris DDI -.It Vt ddi_dma_attr Ta Solaris DDI -.It Vt ddi_dma_cookie Ta Solaris DDI -.It Vt ddi_dmae_req Ta Solaris x86 DDI -.It Vt ddi_idevice_cookie Ta Solaris DDI -.It Vt ddi_mapdev_ctl Ta Solaris DDI -.It Vt devmap_callback_ctl Ta Solaris DDI -.It Vt dev_ops Ta Solaris DDI +.It Vt cb_ops Ta illumos DDI +.It Vt ddi_device_acc_attr Ta illumos DDI +.It Vt ddi_dma_attr Ta illumos DDI +.It Vt ddi_dma_cookie Ta illumos DDI +.It Vt ddi_dmae_req Ta illumos x86 DDI +.It Vt ddi_idevice_cookie Ta illumos DDI +.It Vt ddi_mapdev_ctl Ta illumos DDI +.It Vt devmap_callback_ctl Ta illumos DDI +.It Vt dev_ops Ta illumos DDI .It Vt iovec Ta DDI/DKI -.It Vt kstat Ta Solaris DDI -.It Vt kstat_intr Ta Solaris DDI -.It Vt kstat_io Ta Solaris DDI -.It Vt kstat_named Ta Solaris DDI +.It Vt kstat Ta illumos DDI +.It Vt kstat_intr Ta illumos DDI +.It Vt kstat_io Ta illumos DDI +.It Vt kstat_named Ta illumos DDI .It Vt map Ta DDI/DKI -.It Vt modldrv Ta Solaris DDI -.It Vt modlinkage Ta Solaris DDI -.It Vt modlstrmod Ta Solaris DDI -.It Vt scsi_address Ta Solaris DDI -.It Vt scsi_arq_status Ta Solaris DDI -.It Vt scsi_device Ta Solaris DDI -.It Vt scsi_extended_sense Ta Solaris DDI -.It Vt scsi_hba_tran Ta Solaris DDI -.It Vt scsi_inquiry Ta Solaris DDI -.It Vt scsi_pkt Ta Solaris DDI -.It Vt scsi_status Ta Solaris DDI +.It Vt modldrv Ta illumos DDI +.It Vt modlinkage Ta illumos DDI +.It Vt modlstrmod Ta illumos DDI +.It Vt scsi_address Ta illumos DDI +.It Vt scsi_arq_status Ta illumos DDI +.It Vt scsi_device Ta illumos DDI +.It Vt scsi_extended_sense Ta illumos DDI +.It Vt scsi_hba_tran Ta illumos DDI +.It Vt scsi_inquiry Ta illumos DDI +.It Vt scsi_pkt Ta illumos DDI +.It Vt scsi_status Ta illumos DDI .It Vt uio Ta DDI/DKI .El .Sh SEE ALSO diff --git a/usr/src/man/man9s/aio_req.9s b/usr/src/man/man9s/aio_req.9s index 808b2b406a..352eb3a7e4 100644 --- a/usr/src/man/man9s/aio_req.9s +++ b/usr/src/man/man9s/aio_req.9s @@ -27,7 +27,7 @@ .In sys/ddi.h .In sys/sunddi.h .Sh INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .Sh DESCRIPTION An .Vt aio_req diff --git a/usr/src/man/man9s/cb_ops.9s b/usr/src/man/man9s/cb_ops.9s index 07e9f3bb53..64f4a64d30 100644 --- a/usr/src/man/man9s/cb_ops.9s +++ b/usr/src/man/man9s/cb_ops.9s @@ -25,7 +25,7 @@ .In sys/ddi.h .In sys/sunddi.h .Sh INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .Sh DESCRIPTION The .Nm diff --git a/usr/src/man/man9s/ddi_device_acc_attr.9s b/usr/src/man/man9s/ddi_device_acc_attr.9s index 0730aadca3..b58b080032 100644 --- a/usr/src/man/man9s/ddi_device_acc_attr.9s +++ b/usr/src/man/man9s/ddi_device_acc_attr.9s @@ -8,17 +8,14 @@ .SH NAME ddi_device_acc_attr \- data access attributes structure .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.LP The \fBddi_device_acc_attr\fR structure describes the data access characteristics and requirements of the device. .SH STRUCTURE MEMBERS @@ -207,7 +204,6 @@ additional fault-recovery code. .RE .SH EXAMPLES -.LP The following examples illustrate the use of device register address mapping setup functions and different data access functions. .LP @@ -357,7 +353,6 @@ if (status & DATA_READY) .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -372,7 +367,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBddi_fm_acc_err_get\fR(9F), \fBddi_get16\fR(9F), \fBddi_put16\fR(9F), \fBddi_regs_map_setup\fR(9F) .sp diff --git a/usr/src/man/man9s/ddi_dma_attr.9s b/usr/src/man/man9s/ddi_dma_attr.9s index 73865d9f2b..e73ad90b02 100644 --- a/usr/src/man/man9s/ddi_dma_attr.9s +++ b/usr/src/man/man9s/ddi_dma_attr.9s @@ -12,7 +12,7 @@ ddi_dma_attr \- DMA attributes structure .fi .SH INTERFACE LEVEL -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION A \fBddi_dma_attr_t\fR structure describes device- and \fBDMA\fR engine-specific attributes necessary to allocate \fBDMA\fR resources for a diff --git a/usr/src/man/man9s/ddi_dma_cookie.9s b/usr/src/man/man9s/ddi_dma_cookie.9s index e940c75901..7f31b98967 100644 --- a/usr/src/man/man9s/ddi_dma_cookie.9s +++ b/usr/src/man/man9s/ddi_dma_cookie.9s @@ -7,25 +7,19 @@ .SH NAME ddi_dma_cookie \- DMA address cookie .SH SYNOPSIS -.LP .nf #include <sys/sunddi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBddi_dma_cookie_t\fR structure contains \fBDMA\fR address information required to program a \fBDMA\fR engine. The structure is filled in by a call to \fBddi_dma_getwin\fR(9F), \fBddi_dma_addr_bind_handle\fR(9F), or \fBddi_dma_buf_bind_handle\fR(9F), to get device-specific \fBDMA\fR transfer information for a \fBDMA\fR request or a \fBDMA\fR window. .SH STRUCTURE MEMBERS -.sp .in +2 .nf typedef struct { @@ -75,8 +69,6 @@ to be specified in a \fBddi_dma_attr\fR(9S) structure. \fBdmac_type\fR contains bus-specific type bits, if appropriate. For example, a device on a \fBPCI\fR bus has \fBPCI\fR address modifier bits placed here. .SH SEE ALSO -.sp -.LP \fBpci\fR(4), \fBsbus\fR(4), \fBsysbus\fR(4), \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_getwin\fR(9F), \fBddi_dma_nextcookie\fR(9F), \fBddi_dma_attr\fR(9S) diff --git a/usr/src/man/man9s/ddi_dmae_req.9s b/usr/src/man/man9s/ddi_dmae_req.9s index e1cba837b3..cac2325a87 100644 --- a/usr/src/man/man9s/ddi_dmae_req.9s +++ b/usr/src/man/man9s/ddi_dmae_req.9s @@ -8,18 +8,13 @@ .SH NAME ddi_dmae_req \- DMA engine request structure .SH SYNOPSIS -.LP .nf #include <sys/dma_engine.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris x86 DDI specific (Solaris x86 DDI). +illumos x86 DDI specific (illumos x86 DDI). .SH DESCRIPTION -.sp -.LP A device driver uses the \fBddi_dmae_req\fR structure to describe the parameters for a \fBDMA\fR channel. This structure contains all the information necessary to set up the channel, except for the \fBDMA\fR memory address and @@ -28,21 +23,19 @@ devices. Other modes might be desirable for some devices, or to increase performance. The \fBDMA\fR engine request structure is passed to \fBddi_dmae_prog\fR(9F). .SH STRUCTURE MEMBERS -.sp -.LP The \fBddi_dmae_req\fR structure contains several members, each of which controls some aspect of DMA engine operation. The structure members associated with supported DMA engine options are described here. .sp .in +2 .nf -uchar_tder_command; /* Read / Write * -/uchar_tder_bufprocess; /* Standard / Chain */ -uchar_tder_path; /* 8 / 16 / 32 */ -uchar_tder_cycles; /* Compat / Type A / Type B / Burst */ -uchar_tder_trans; /* Single / Demand / Block */ -ddi_dma_cookie_t*(*proc)(); /* address of nextcookie routine */ -void*procparms; /* parameter for nextcookie call */ +uchar_t der_command; /* Read / Write * / +uchar_t der_bufprocess; /* Standard / Chain */ +uchar_t der_path; /* 8 / 16 / 32 */ +uchar_t der_cycles; /* Compat / Type A / Type B / Burst */ +uchar_t der_trans; /* Single / Demand / Block */ +ddi_dma_cookie_t *(*proc)(); /* address of nextcookie routine */ +void *procparms; /* parameter for nextcookie call */ .fi .in -2 @@ -205,8 +198,6 @@ default, in the \fBder_cycles\fR structure member) should use the .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -221,7 +212,5 @@ Architecture x86 .TE .SH SEE ALSO -.sp -.LP \fBisa\fR(4), \fBattributes\fR(5), \fBddi_dmae\fR(9F), \fBddi_dma_attr\fR(9S) diff --git a/usr/src/man/man9s/ddi_fm_error.9s b/usr/src/man/man9s/ddi_fm_error.9s index fd2297e635..fc5a0bdbc8 100644 --- a/usr/src/man/man9s/ddi_fm_error.9s +++ b/usr/src/man/man9s/ddi_fm_error.9s @@ -7,25 +7,19 @@ .SH NAME ddi_fm_error \- I/O error status structure .SH SYNOPSIS -.LP .nf #include <sys/ddifm.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP A \fBddi_fm_error_t\fR structure contains common data necessary for \fBI/O\fR error handling. A pointer to a \fBddi_fm_error_t\fR structure is passed to error handling callbacks where it can then be used in a call to \fBpci_ereport_post()\fR. The same structure is also returned to callers of \fBddi_fm_acc_err_get()\fR and \fBddi_fm_dma_err_get()\fR. .SH STRUCTURE MEMBERS -.sp .in +2 .nf int fme_version; @@ -109,8 +103,6 @@ that can be returned from \fBpci_ereport_post()\fR The \fBfme_dma_handle\fR is the valid \fBDMA\fR handle associated with the error that can be returned from \fBpci_ereport_post()\fR .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -125,8 +117,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBddi_fm_acc_err_get\fR(9F), \fBddi_fm_dma_err_get\fR(9F), \fBddi_fm_handler_register\fR(9F), \fBddi_peek\fR(9F), \fBddi_poke\fR(9F), \fBpci_ereport_post\fR(9F) diff --git a/usr/src/man/man9s/ddi_idevice_cookie.9s b/usr/src/man/man9s/ddi_idevice_cookie.9s index 46dde493a4..da7502938a 100644 --- a/usr/src/man/man9s/ddi_idevice_cookie.9s +++ b/usr/src/man/man9s/ddi_idevice_cookie.9s @@ -7,27 +7,21 @@ .SH NAME ddi_idevice_cookie \- device interrupt cookie .SH SYNOPSIS -.LP .nf #include <sys/ddi.h> #include <sys/sunddi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). This interface is obsolete. Use the new +illumos DDI specific (illumos DDI). This interface is obsolete. Use the new interrupt interfaces referenced in \fBIntro\fR(9F). Refer to \fIWriting Device Drivers\fR for more information. .SH DESCRIPTION -.sp -.LP The \fBddi_idevice_cookie_t\fR structure contains interrupt priority and interrupt vector information for a device. This structure is useful for devices having programmable bus-interrupt levels. \fBddi_add_intr\fR(9F) assigns values to the \fBddi_idevice_cookie_t\fR structure members. .SH STRUCTURE MEMBERS -.sp .in +2 .nf u_short idev_vector; /* interrupt vector */ @@ -41,8 +35,6 @@ The \fBidev_vector\fR field contains the interrupt vector number for vectored bus architectures such as VMEbus. The \fBidev_priority\fR field contains the bus interrupt priority level. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -57,8 +49,6 @@ Interface Stability Obsolete .TE .SH SEE ALSO -.sp -.LP \fBddi_add_intr\fR(9F), \fBIntro\fR(9F) .sp .LP diff --git a/usr/src/man/man9s/dev_ops.9s b/usr/src/man/man9s/dev_ops.9s index d657f3046e..ee030b9198 100644 --- a/usr/src/man/man9s/dev_ops.9s +++ b/usr/src/man/man9s/dev_ops.9s @@ -7,19 +7,14 @@ .SH NAME dev_ops \- device operations structure .SH SYNOPSIS -.LP .nf #include <sys/conf.h> #include <sys/devops.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP \fBdev_ops\fR contains driver common fields and pointers to the \fBbus_ops\fR and \fBcb_ops\fR(9S). .sp @@ -138,7 +133,6 @@ does not need to implement quiesce. .RE .SH STRUCTURE MEMBERS -.sp .in +2 .nf int devo_rev; @@ -160,8 +154,6 @@ int (*devo_quiesce)(dev_info_t *dip); .in -2 .SH SEE ALSO -.sp -.LP \fBattach\fR(9E), \fBdetach\fR(9E), \fBgetinfo\fR(9E), \fBprobe\fR(9E), \fBpower\fR(9E), \fBquiesce\fR(9E), \fBnodev\fR(9F) .sp diff --git a/usr/src/man/man9s/devmap_callback_ctl.9s b/usr/src/man/man9s/devmap_callback_ctl.9s index 5124226499..e79f5ecd18 100644 --- a/usr/src/man/man9s/devmap_callback_ctl.9s +++ b/usr/src/man/man9s/devmap_callback_ctl.9s @@ -7,18 +7,13 @@ .SH NAME devmap_callback_ctl \- device mapping-control structure .SH SYNOPSIS -.LP .nf #include <sys/ddidevmap.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP A \fBdevmap_callback_ctl\fR structure describes a set of callback routines that are called by the system to notify a device driver to manage events on the device mappings created by \fBdevmap_setup\fR(9F) or @@ -95,7 +90,6 @@ system calls. .RE .SH STRUCTURE MEMBERS -.sp .in +2 .nf int devmap_rev; @@ -112,8 +106,6 @@ void (*devmap_unmap)(devmap_cookie_t dhp, void *pvtp, .in -2 .SH SEE ALSO -.sp -.LP \fBexit\fR(2), \fBfork\fR(2), \fBmmap\fR(2), \fBmunmap\fR(2), \fBdevmap\fR(9E), \fBdevmap_access\fR(9E), \fBdevmap_dup\fR(9E), \fBdevmap_map\fR(9E), \fBdevmap_unmap\fR(9E), \fBddi_devmap_segmap\fR(9F), diff --git a/usr/src/man/man9s/fmodsw.9s b/usr/src/man/man9s/fmodsw.9s index 4551dec548..fbcdbbe110 100644 --- a/usr/src/man/man9s/fmodsw.9s +++ b/usr/src/man/man9s/fmodsw.9s @@ -8,19 +8,14 @@ .SH NAME fmodsw \- STREAMS module declaration structure .SH SYNOPSIS -.LP .nf #include <sys/stream.h> #include <sys/conf.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBfmodsw\fR structure contains information for STREAMS modules. All STREAMS modules must define a \fBfmodsw\fR structure. .sp @@ -34,7 +29,6 @@ All modules must set the \fBf_flag\fR to \fBD_MP\fR to indicate that they safely allow multiple threads of execution. See \fBmt-streams\fR(9F) for additional flags. .SH STRUCTURE MEMBERS -.sp .in +2 .nf char f_name[FMNAMESZ + 1]; /* module name */ @@ -44,14 +38,10 @@ int f_flag; /* flags */ .in -2 .SH SEE ALSO -.sp -.LP \fBmt-streams\fR(9F), \fBmodlstrmod\fR(9S), \fBmodule_info\fR(9S) .sp .LP \fISTREAMS Programming Guide\fR .SH WARNINGS -.sp -.LP If \fBf_name\fR does not match the module binary name, unexpected failures can occur. diff --git a/usr/src/man/man9s/gld_mac_info.9s b/usr/src/man/man9s/gld_mac_info.9s index f9496356c1..458d4baa03 100644 --- a/usr/src/man/man9s/gld_mac_info.9s +++ b/usr/src/man/man9s/gld_mac_info.9s @@ -7,18 +7,13 @@ .SH NAME gld_mac_info \- Generic LAN Driver MAC info data structure .SH SYNOPSIS -.LP .nf #include <sys/gld.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The Generic LAN Driver (GLD) Media Access Control (MAC) information (\fBgld_mac_info\fR) structure is the main data interface between the device-specific driver and GLD. It contains data required by GLD and a pointer @@ -28,11 +23,10 @@ to an optional additional driver-specific information structure. The \fBgld_mac_info\fR structure should be allocated using \fBgld_mac_alloc()\fR and deallocated using \fBgld_mac_free()\fR. Drivers can make no assumptions about the length of this structure, which might be -different in different releases of Solaris and/or GLD. Structure members +different in different releases of illumos and/or GLD. Structure members private to GLD, not documented here, should not be set or read by the device-specific driver. .SH STRUCTURE MEMBERS -.sp .in +2 .nf caddr_t gldm_private; /* Driver private data */ @@ -210,7 +204,7 @@ Interface). This structure member must be correctly set for GLD to function properly. .sp Support for the DL_TPR and DL_FDDI media types is obsolete and may be removed -in a future release of Solaris. +in a future release of illumos. .RE .sp @@ -340,8 +334,6 @@ link state, the GLD_CAP_LINKSTATE bit should be set. .RE .SH SEE ALSO -.sp -.LP \fBgld\fR(7D), \fBdlpi\fR(7P), \fBattach\fR(9E), \fBgld\fR(9E), \fBddi_add_intr\fR(9F), \fBgld\fR(9F), \fBgld_stats\fR(9S) .sp diff --git a/usr/src/man/man9s/gld_stats.9s b/usr/src/man/man9s/gld_stats.9s index d241c017fd..de2462b1f6 100644 --- a/usr/src/man/man9s/gld_stats.9s +++ b/usr/src/man/man9s/gld_stats.9s @@ -7,18 +7,13 @@ .SH NAME gld_stats \- Generic LAN Driver statistics data structure .SH SYNOPSIS -.LP .nf #include <sys/gld.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The Generic LAN Driver (GLD) statistics (\fBgld_stats\fR) structure is used to communicate statistics and state information from a GLD-based driver to GLD when returning from a driver's \fBgldm_get_stats()\fR routine as discussed in @@ -30,12 +25,10 @@ each statistic. .sp .LP Drivers can make no assumptions about the length of this structure, which might -be different in different releases of Solaris and/or GLD. Structure members +be different in different releases of illumos and/or GLD. Structure members private to GLD, not documented here, should not be set or read by the device specific driver. .SH STRUCTURE MEMBERS -.sp -.LP The following structure members are defined for all media types: .sp .in +2 @@ -102,7 +95,7 @@ Note - .sp .RS 2 Support for the DL_TPR media type is obsolete and may be removed in a future -release of Solaris. +release of illumos. .RE .sp .LP @@ -125,7 +118,7 @@ Note - .sp .RS 2 Support for the DL_FDDI media type is obsolete and may be removed in a future -release of Solaris. +release of illumos. .RE .sp .LP @@ -167,8 +160,6 @@ also be specified. .RE .SH SEE ALSO -.sp -.LP \fBgld\fR(7D), \fBgld\fR(9F), \fBgld\fR(9E), \fBgld_mac_info\fR(9S) .sp .LP diff --git a/usr/src/man/man9s/hook_nic_event.9s b/usr/src/man/man9s/hook_nic_event.9s index 4a40fb6cac..13faa42f04 100644 --- a/usr/src/man/man9s/hook_nic_event.9s +++ b/usr/src/man/man9s/hook_nic_event.9s @@ -8,7 +8,6 @@ hook_nic_event \- data structure describing events related to network interfaces .SH SYNOPSIS -.LP .nf #include <sys/neti.h> #include <sys/hook.h> @@ -16,12 +15,8 @@ interfaces .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBhook_nic_event\fR structure contains fields that relate to an event that has occurred and belongs to a network interface. This structure is passed through to callbacks for \fBNE_PLUMB\fR, \fBNE_UNPLUMB\fR, \fBNE_UP\fR, @@ -30,7 +25,6 @@ through to callbacks for \fBNE_PLUMB\fR, \fBNE_UNPLUMB\fR, \fBNE_UP\fR, .LP A callback may not alter any of the fields in this structure. .SH STRUCTURE MEMBERS -.sp .in +2 .nf net_data_t hne_family; @@ -126,8 +120,6 @@ new network address. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -142,6 +134,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnetinfo\fR(9F) diff --git a/usr/src/man/man9s/hook_pkt_event.9s b/usr/src/man/man9s/hook_pkt_event.9s index 0ef9c67e02..89d7cc9cfc 100644 --- a/usr/src/man/man9s/hook_pkt_event.9s +++ b/usr/src/man/man9s/hook_pkt_event.9s @@ -7,7 +7,6 @@ .SH NAME hook_pkt_event \- packet event structure passed through to hooks .SH SYNOPSIS -.LP .nf #include <sys/neti.h> #include <sys/hook.h> @@ -15,12 +14,8 @@ hook_pkt_event \- packet event structure passed through to hooks .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBhook_pkt_event\fR structure contains fields that relate to a packet in a network protocol handler. This structure is passed through to a callback for \fBNH_PRE_ROUTING\fR, \fBNH_POST_ROUTING\fR, \fBNH_FORWARDING\fR, @@ -48,7 +43,6 @@ NH_LOOPBACK_OUT yes yes yes yes .sp .SH STRUCTURE MEMBERS -.sp .in +2 .nf net_data_t hne_family; @@ -156,8 +150,6 @@ possible with physical in packet events. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -172,6 +164,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_protocol_lookup\fR(9F), \fBnetinfo\fR(9F) diff --git a/usr/src/man/man9s/hook_t.9s b/usr/src/man/man9s/hook_t.9s index 818603ba59..22fefc1b36 100644 --- a/usr/src/man/man9s/hook_t.9s +++ b/usr/src/man/man9s/hook_t.9s @@ -8,23 +8,17 @@ .SH NAME hook_t \- callback structure for subscribing to netinfo events .SH SYNOPSIS -.LP .nf #include <sys/hook.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBhook_t\fR data structure defines a callback that is to be inserted into a networking event. This data structure must be allocated with a call to \fBhook_alloc()\fR and released with a call to \fBhook_free()\fR. .SH STRUCTURE MEMBERS -.sp .in +2 .nf hook_func_t h_func; /* callback function to invoke */ @@ -40,8 +34,6 @@ typedef int (*hook_func_t)(net_event_t token, hook_data_t info, .in -2 .SS "CALLBACK RETURN VALUES" -.sp -.LP The value returned by the \fBhook_func_t\fR function indicates whether or not the packet should still be considered valid. If the callback function has modified the packet in such a way that it should no longer be processed or @@ -50,8 +42,6 @@ considered valid, e.g. called \fBfreemsg\fR(9F), then the callback should return .sp .SS "HINT TYPES" -.sp -.LP Hook hints are hints that are used at the time of insertion and are not rules that enforce where a hook lives for its entire lifetime on an event. The valid values for the \fBh_hint\fR field are: @@ -103,8 +93,6 @@ Place the hook after another hook on the list of hooks. The value in .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -119,6 +107,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnetinfo\fR(9F) diff --git a/usr/src/man/man9s/kstat.9s b/usr/src/man/man9s/kstat.9s index 9c0b351035..35ecc7c515 100644 --- a/usr/src/man/man9s/kstat.9s +++ b/usr/src/man/man9s/kstat.9s @@ -7,7 +7,6 @@ .SH NAME kstat \- kernel statistics structure .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -16,12 +15,8 @@ kstat \- kernel statistics structure .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP Each kernel statistic (\fBkstat\fR) exported by device drivers consists of a header section and a data section. The \fBkstat\fR structure is the header portion of the statistic. @@ -35,7 +30,6 @@ structure in any other manner. After allocation, the driver should perform any further initialization needed before calling \fBkstat_install\fR(9F) to actually export the \fBkstat\fR. .SH STRUCTURE MEMBERS -.sp .in +2 .nf void *ks_data; /* kstat type-specif. data */ @@ -129,8 +123,6 @@ data structures. .RE .SH SEE ALSO -.sp -.LP \fBkstat_create\fR(9F) .sp .LP diff --git a/usr/src/man/man9s/kstat_intr.9s b/usr/src/man/man9s/kstat_intr.9s index 8d8ae79097..1e3ee6a685 100644 --- a/usr/src/man/man9s/kstat_intr.9s +++ b/usr/src/man/man9s/kstat_intr.9s @@ -7,7 +7,6 @@ .SH NAME kstat_intr \- structure for interrupt kstats .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -16,12 +15,8 @@ kstat_intr \- structure for interrupt kstats .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP Interrupt statistics are kept in the \fBkstat_intr\fR structure. When \fBkstat_create\fR(9F) creates an interrupt \fBkstat\fR, the \fBks_data\fR field is a pointer to one of these structures. The macro \fBKSTAT_INTR_PTR()\fR @@ -52,7 +47,6 @@ in a particular system configuration. Devices that have more than one interrupt of the same type should use multiple structures. .SH STRUCTURE MEMBERS -.sp .in +2 .nf ulong_t intrs[KSTAT_NUM_INTRS]; /* interrupt counters */ @@ -113,8 +107,6 @@ Multiple service interrupt .RE .SH SEE ALSO -.sp -.LP \fBkstat\fR(9S) .sp .LP diff --git a/usr/src/man/man9s/kstat_io.9s b/usr/src/man/man9s/kstat_io.9s index b23d98aed7..5c0c0c3adb 100644 --- a/usr/src/man/man9s/kstat_io.9s +++ b/usr/src/man/man9s/kstat_io.9s @@ -7,7 +7,6 @@ .SH NAME kstat_io \- structure for I/O kstats .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -16,12 +15,8 @@ kstat_io \- structure for I/O kstats .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP I/O kstat statistics are kept in a \fBkstat_io\fR structure. When \fBkstat_create\fR(9F) creates an \fBI/O\fR \fBkstat\fR, the \fBks_data\fR field is a pointer to one of these structures. The macro \fBKSTAT_IO_PTR()\fR @@ -34,7 +29,6 @@ is provided to retrieve this field. It looks like this: .in -2 .SH STRUCTURE MEMBERS -.sp .in +2 .nf u_longlong_t nread; /* number of bytes read */ @@ -65,8 +59,6 @@ write operation. Other \fBI/O\fR statistics are updated through the use of the \fBkstat_queue\fR(9F) functions. .SH SEE ALSO -.sp -.LP \fBkstat_create\fR(9F), \fBkstat_named_init\fR(9F), \fBkstat_queue\fR(9F), \fBkstat_runq_back_to_waitq\fR(9F), \fBkstat_runq_enter\fR(9F), \fBkstat_runq_exit\fR(9F), \fBkstat_waitq_enter\fR(9F), diff --git a/usr/src/man/man9s/kstat_named.9s b/usr/src/man/man9s/kstat_named.9s index 0285fc7d08..88f75683f8 100644 --- a/usr/src/man/man9s/kstat_named.9s +++ b/usr/src/man/man9s/kstat_named.9s @@ -7,7 +7,6 @@ .SH NAME kstat_named \- structure for named kstats .SH SYNOPSIS -.LP .nf #include <sys/types.h> #include <sys/kstat.h> @@ -16,19 +15,14 @@ kstat_named \- structure for named kstats .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP Named \fBkstats\fR are an array of name-value pairs. These pairs are kept in the \fBkstat_named\fR structure. When a \fBkstat\fR is created by \fBkstat_create\fR(9F), the driver specifies how many of these structures will be allocated. The structures are returned as an array pointed to by the \fBks_data\fR field. .SH STRUCTURE MEMBERS -.sp .in +2 .nf union { @@ -47,8 +41,6 @@ The only member exposed to drivers is the \fBvalue\fR member. This field is a union of several data types. The driver must specify which type it will use in the call to \fBkstat_named_init()\fR. .SH SEE ALSO -.sp -.LP \fBkstat_create\fR(9F), \fBkstat_named_init\fR(9F) .sp .LP diff --git a/usr/src/man/man9s/modldrv.9s b/usr/src/man/man9s/modldrv.9s index 375c594deb..eb07caca17 100644 --- a/usr/src/man/man9s/modldrv.9s +++ b/usr/src/man/man9s/modldrv.9s @@ -7,22 +7,16 @@ .SH NAME modldrv \- linkage structure for loadable drivers .SH SYNOPSIS -.LP .nf #include <sys/modctl.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBmodldrv\fR structure is used by device drivers to export driver specific information to the kernel. .SH STRUCTURE MEMBERS -.sp .in +2 .nf struct mod_ops *drv_modops; @@ -63,8 +57,6 @@ Pointer to the driver's \fBdev_ops\fR(9S) structure. .RE .SH SEE ALSO -.sp -.LP \fBadd_drv\fR(1M), \fBdev_ops\fR(9S), \fBmodlinkage\fR(9S) .sp .LP diff --git a/usr/src/man/man9s/modlinkage.9s b/usr/src/man/man9s/modlinkage.9s index 99de328aa7..55d262e6cb 100644 --- a/usr/src/man/man9s/modlinkage.9s +++ b/usr/src/man/man9s/modlinkage.9s @@ -7,23 +7,17 @@ .SH NAME modlinkage \- module linkage structure .SH SYNOPSIS -.LP .nf #include <sys/modctl.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBmodlinkage\fR structure is provided by the module writer to the routines that install, remove, and retrieve information from a module. See \fB_init\fR(9E), \fB_fini\fR(9E), and \fB_info\fR(9E). .SH STRUCTURE MEMBERS -.sp .in +2 .nf int ml_rev @@ -52,8 +46,6 @@ have only one linkage structure. .RE .SH SEE ALSO -.sp -.LP \fBadd_drv\fR(1M), \fB_fini\fR(9E), \fB_info\fR(9E), \fB_init\fR(9E), \fBmodldrv\fR(9S), \fBmodlstrmod\fR(9S) .sp diff --git a/usr/src/man/man9s/modlmisc.9s b/usr/src/man/man9s/modlmisc.9s index 5ab74808cf..56ac4f5233 100644 --- a/usr/src/man/man9s/modlmisc.9s +++ b/usr/src/man/man9s/modlmisc.9s @@ -7,22 +7,16 @@ .SH NAME modlmisc \- linkage structure for loadable miscellaneous modules .SH SYNOPSIS -.LP .nf #include <sys/modctl.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBmodlmisc\fR structure is used by miscellaneous modules to export module specific information to the kernel. .SH STRUCTURE MEMBERS -.sp .in +2 .nf struct mod_ops *misc_modops; @@ -52,6 +46,4 @@ also contain other information (such as a version number). .RE .SH SEE ALSO -.sp -.LP \fBmodload\fR(1M), \fBmodlinkage\fR(9S) diff --git a/usr/src/man/man9s/modlstrmod.9s b/usr/src/man/man9s/modlstrmod.9s index 37748a6645..a45f4d48bf 100644 --- a/usr/src/man/man9s/modlstrmod.9s +++ b/usr/src/man/man9s/modlstrmod.9s @@ -7,22 +7,16 @@ .SH NAME modlstrmod \- linkage structure for loadable STREAMS modules .SH SYNOPSIS -.LP .nf #include <sys/modctl.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBmodlstrmod\fR structure is used by STREAMS modules to export module specific information to the kernel. .SH STRUCTURE MEMBERS -.sp .in +2 .nf struct mod_ops *strmod_modops; @@ -63,8 +57,6 @@ the kernel's class table when the module is loaded. .RE .SH SEE ALSO -.sp -.LP \fBmodload\fR(1M) .sp .LP diff --git a/usr/src/man/man9s/net_inject_t.9s b/usr/src/man/man9s/net_inject_t.9s index c787626a60..cf62ae6711 100644 --- a/usr/src/man/man9s/net_inject_t.9s +++ b/usr/src/man/man9s/net_inject_t.9s @@ -7,23 +7,17 @@ .SH NAME net_inject_t \- structure for describing how to transmit a packet .SH SYNOPSIS -.LP .nf #include <sys/neti.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBnet_inject_t\fR data structure passes information in to \fBnet_inject\fR about how to transmit a packet. Transmit includes sending the packet up into the system as well as out of it. .SH STRUCTURE MEMBERS -.sp .in +2 .nf mblk_t *ni_packet; /* start of the packet */ @@ -64,8 +58,6 @@ The physical interface where the packet will be injected. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -80,6 +72,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnet_inject\fR(9F), \fBnetinfo\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9s/net_instance_t.9s b/usr/src/man/man9s/net_instance_t.9s index 4f4b143276..b2ae46c6ee 100644 --- a/usr/src/man/man9s/net_instance_t.9s +++ b/usr/src/man/man9s/net_instance_t.9s @@ -8,18 +8,13 @@ .SH NAME net_instance_t \- packet event structure passed through to hooks .SH SYNOPSIS -.LP .nf #include <sys/neti.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBnet_instance_t\fR data structure defines a collection of instances to be called when relevant events happen within \fBIP\fR. The value returned by the \fBnin_create()\fR function is stored internally and passed back to both the @@ -27,7 +22,6 @@ called when relevant events happen within \fBIP\fR. The value returned by the The \fBnetid_t\fR passed through to each function can be used to uniquely identify each instance of \fBIP\fR. .SH STRUCTURE MEMBERS -.sp .in +2 .nf char *nin_name; @@ -76,8 +70,6 @@ Function to be called when an instance of \fBIP\fR is being shutdown. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -92,6 +84,4 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP \fBnetinfo\fR(9F), \fBattributes\fR(5) diff --git a/usr/src/man/man9s/queclass.9s b/usr/src/man/man9s/queclass.9s index d5021d73a4..c2418a614b 100644 --- a/usr/src/man/man9s/queclass.9s +++ b/usr/src/man/man9s/queclass.9s @@ -9,7 +9,6 @@ queclass \- a STREAMS macro that returns the queue message class definitions for a given message block .SH SYNOPSIS -.LP .nf #include <sys/stream.h> @@ -17,12 +16,8 @@ for a given message block .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP \fBqueclass\fR returns the queue message class definition for a given data block pointed to by the message block \fIbp\fR passed in. .sp @@ -30,6 +25,4 @@ block pointed to by the message block \fIbp\fR passed in. The message can be either \fBQNORM\fR, a normal priority message, or \fBQPCTL\fR, a high priority message. .SH SEE ALSO -.sp -.LP \fISTREAMS Programming Guide\fR diff --git a/usr/src/man/man9s/queue.9s b/usr/src/man/man9s/queue.9s index 7265f96dee..dc577e6f69 100644 --- a/usr/src/man/man9s/queue.9s +++ b/usr/src/man/man9s/queue.9s @@ -8,21 +8,17 @@ .SH NAME queue \- STREAMS queue structure .SH SYNOPSIS -.LP .nf #include <sys/stream.h> .fi .SH INTERFACE LEVEL -.LP Architecture independent level 1 (DDI/DKI) .SH DESCRIPTION -.LP A \fBSTREAMS\fR driver or module consists of two \fBqueue\fR structures: \fIread\fR for upstream processing and \fIwrite\fR for downstream processing. The queue structure is the major building block of a stream. .SS "\fBqueue\fR Structure Members" -.LP The \fBqueue\fR structure is defined as type \fBqueue_t\fR. The structure can be accessed at any time from inside a \fBSTREAMS\fR entry point associated with that queue. @@ -48,7 +44,6 @@ size_t q_lowat; /* queue low water mark */ Contstraints and restrictions on the use of \fBq_flag\fR and \fBqueue_t\fR fields and the \fBq_next\fR values are detailed in the following sections. .SS "\fBq_flag\fR Field" -.LP The \fBq_flag\fR field must be used only to check the following flag values. .sp .ne 2 @@ -114,7 +109,6 @@ Downstream processing element wants to write to queue. .RE .SS "\fBqueue_t\fR Fields" -.LP Aside from \fBq_ptr\fR and \fBq_qinfo\fR, a module or driver must never assume that a \fBqueue_t\fR field value will remain unchanged across calls to \fBSTREAMS\fR entry points. In addition, many fields can change values inside a @@ -171,12 +165,11 @@ visible fields, \fBq_qinfo\fR, \fBq_first\fR, \fBq_last\fR, \fBq_next\fR, \fBq_count\fR, and \fBq_flag\fR, must never be modified by a module or driver. .sp .LP -The Solaris DDI requires that \fBSTREAMS\fR modules and drivers obey the rules +The illumos DDI requires that \fBSTREAMS\fR modules and drivers obey the rules described on this page. Those that do not follow the rules can cause data corruption or system instability, and might change in behavior across updates or upgrades. .SS "\fBq_next\fR Restrictions" -.LP There are additional restrictions associated with the use of the \fBq_next\fR value. In particular, a \fBSTREAMS\fR module or driver: .RS +4 @@ -210,7 +203,6 @@ However, checking \fBq_next\fR for NULL can be used to distinguish a module from a driver in code shared by both. .RE .SH SEE ALSO -.LP \fBclose\fR(9E), \fBopen\fR(9E), \fBbcanput\fR(9F), \fBcanput\fR(9F), \fBgetq\fR(9F), \fBinsq\fR(9F), \fBmod_install\fR(9F), \fBput\fR(9F), \fBputbq\fR(9F), \fBputctl\fR(9F), \fBputctl1\fR(9F), \fBputnext\fR(9F), diff --git a/usr/src/man/man9s/scsi_arq_status.9s b/usr/src/man/man9s/scsi_arq_status.9s index af8e207b71..77eaabb8cb 100644 --- a/usr/src/man/man9s/scsi_arq_status.9s +++ b/usr/src/man/man9s/scsi_arq_status.9s @@ -7,18 +7,13 @@ .SH NAME scsi_arq_status \- SCSI auto request sense structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP When auto request sense has been enabled using \fBscsi_ifsetcap\fR(9F) and the "auto-rqsense" capability, the target driver must allocate a status area in the \fBSCSI\fR packet structure for the auto request sense structure (see @@ -29,7 +24,6 @@ sense structure supplies the \fBSCSI\fR status of the original command, the transport information pertaining to the request sense command, and the request sense data. .SH STRUCTURE MEMBERS -.sp .in +2 .nf struct scsi_status sts_status; /* SCSI status */ @@ -72,8 +66,6 @@ request sense command. \fBsts_sensedata\fR contains the actual sense data if the request sense command completed normally. .SH SEE ALSO -.sp -.LP \fBscsi_ifgetcap\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_extended_sense\fR(9S), \fBscsi_pkt\fR(9S) .sp diff --git a/usr/src/man/man9s/scsi_asc_key_strings.9s b/usr/src/man/man9s/scsi_asc_key_strings.9s index ec63989f70..71dd1b50e9 100644 --- a/usr/src/man/man9s/scsi_asc_key_strings.9s +++ b/usr/src/man/man9s/scsi_asc_key_strings.9s @@ -7,22 +7,16 @@ .SH NAME scsi_asc_key_strings \- SCSI ASC ASCQ to message structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL -.sp -.LP - Solaris DDI specific (Solaris DDI). + illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBscsi_asc_key_strings\fR structure stores the ASC and ASCQ codes and a pointer to the related ASCII string. .SH STRUCTURE MEMBERS -.sp .in +2 .nf ushort_t asc; /* ASC code */ @@ -39,8 +33,6 @@ message Points to the NULL terminated ASCII string .in -2 .SH SEE ALSO -.sp -.LP \fBscsi_vu_errmsg\fR(9F) .sp .LP diff --git a/usr/src/man/man9s/scsi_device.9s b/usr/src/man/man9s/scsi_device.9s index 3deef975ed..73994674c6 100644 --- a/usr/src/man/man9s/scsi_device.9s +++ b/usr/src/man/man9s/scsi_device.9s @@ -7,18 +7,13 @@ .SH NAME scsi_device \- SCSI device structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBscsi_device\fR structure stores common information about each SCSI logical unit, including pointers to areas that contain both generic and device specific information. There is one \fBscsi_device\fR structure for each logical @@ -26,7 +21,6 @@ unit attached to the system. The host adapter driver initializes part of this structure prior to \fBprobe\fR(9E) and destroys this structure after a probe failure or successful \fBdetach\fR(9E). .SH STRUCTURE MEMBERS -.sp .in +2 .nf struct scsi_address sd_address; /* Routing info. */ @@ -74,8 +68,6 @@ buffer. \fBsd_private\fR is reserved for the use of target drivers and should generally be used to point to target specific data structures. .SH SEE ALSO -.sp -.LP \fBdetach\fR(9E), \fBprobe\fR(9E), \fBmakecom\fR(9F), \fBmutex\fR(9F), \fBscsi_probe\fR(9F), \fBscsi_extended_sense\fR(9S), \fBscsi_pkt\fR(9S) .sp diff --git a/usr/src/man/man9s/scsi_extended_sense.9s b/usr/src/man/man9s/scsi_extended_sense.9s index 3ee1af1510..000a9a8589 100644 --- a/usr/src/man/man9s/scsi_extended_sense.9s +++ b/usr/src/man/man9s/scsi_extended_sense.9s @@ -7,25 +7,19 @@ .SH NAME scsi_extended_sense \- SCSI extended sense structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBscsi_extended_sense\fR structure for error codes \fB0x70\fR (current errors) and \fB0x71\fR (deferred errors) is returned on a successful \fBREQUEST SENSE\fR command. \fBSCSI-2 \fRcompliant targets are required to return at least the first 18 bytes of this structure. This structure is part of \fBscsi_device\fR(9S) structure. .SH STRUCTURE MEMBERS -.sp .in +2 .nf uchar_t es_valid :1; /* Sense data is valid */ @@ -279,8 +273,6 @@ that has failed. valid bit (bit 7) is \fB1\fR. This field is reserved for sense keys not defined above. .SH SEE ALSO -.sp -.LP \fBscsi_device\fR(9S) .sp .LP diff --git a/usr/src/man/man9s/scsi_hba_tran.9s b/usr/src/man/man9s/scsi_hba_tran.9s index b886a06c4e..f88974829f 100644 --- a/usr/src/man/man9s/scsi_hba_tran.9s +++ b/usr/src/man/man9s/scsi_hba_tran.9s @@ -7,23 +7,17 @@ .SH NAME scsi_hba_tran \- SCSI Host Bus Adapter (HBA) driver transport vector structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris architecture specific (Solaris DDI). +illumos architecture specific (illumos DDI). .SH DESCRIPTION -.sp -.LP A \fBscsi_hba_tran_t\fR structure defines vectors that an \fBHBA\fR driver exports to \fBSCSA\fR interfaces so that \fBHBA\fR specific functions can be executed. .SH STRUCTURE MEMBERS -.sp .in +2 .nf dev_info_t *tran_hba_dip; /* HBAs dev_info @@ -324,8 +318,6 @@ the \fBservices.h\fR header file. .RE .SH SEE ALSO -.sp -.LP \fBtran_abort\fR(9E), \fBtran_bus_reset\fR(9E), \fBtran_destroy_pkt\fR(9E), \fBtran_dmafree\fR(9E), \fBtran_getcap\fR(9E), \fBtran_init_pkt\fR(9E), \fBtran_quiesce\fR(9E), \fBtran_reset\fR(9E), \fBtran_reset_notify\fR(9E), diff --git a/usr/src/man/man9s/scsi_inquiry.9s b/usr/src/man/man9s/scsi_inquiry.9s index aa71a92270..b56fce4e99 100644 --- a/usr/src/man/man9s/scsi_inquiry.9s +++ b/usr/src/man/man9s/scsi_inquiry.9s @@ -7,25 +7,19 @@ .SH NAME scsi_inquiry \- SCSI inquiry structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP The \fBscsi_inquiry\fR structure contains 36 required bytes, followed by a variable number of vendor-specific parameters. Bytes 59 through 95, if returned, are reserved for future standardization. This structure is part of \fBscsi_device\fR(9S) structure and typically filled in by \fBscsi_probe\fR(9F). .SH STRUCTURE MEMBERS -.sp .in +2 .nf Lines that start with an 'X' will be deleted before submission; @@ -431,8 +425,6 @@ selection. .LP \fBinq_ius\fR the \fBSPI3\fR target device supports information unit transfers. .SH SEE ALSO -.sp -.LP \fBscsi_probe\fR(9F), \fBscsi_device\fR(9S) .sp .LP diff --git a/usr/src/man/man9s/scsi_pkt.9s b/usr/src/man/man9s/scsi_pkt.9s index 2cf6e7629e..208ae10eee 100644 --- a/usr/src/man/man9s/scsi_pkt.9s +++ b/usr/src/man/man9s/scsi_pkt.9s @@ -7,18 +7,13 @@ .SH NAME scsi_pkt \- SCSI packet structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI). +illumos DDI specific (illumos DDI). .SH DESCRIPTION -.sp -.LP A \fBscsi_pkt\fR structure defines the packet that is allocated by \fBscsi_init_pkt\fR(9F). The target driver fills in some information and passes it to \fBscsi_transport\fR(9F) for execution on the target. The host bus @@ -28,7 +23,6 @@ specified in the packet is called with a pointer to the packet as its argument. From fields within the packet, the target driver can determine the success or failure of the command. .SH STRUCTURE MEMBERS -.sp .in +2 .nf opaque_t pkt_ha_private; /* private data for @@ -251,8 +245,6 @@ DMA flags used, such as \fBDDI_DMA_READ\fR and \fBDDI_DMA_WRITE\fR. See The host adapter driver will update the \fBpkt_resid\fR, \fBpkt_reason\fR, \fBpkt_state\fR, and \fBpkt_statistics\fR fields. .SS "\fBpkt_flags\fR Definitions" -.sp -.LP The appropriate definitions for the structure member \fBpkt_flags\fR are: .sp .ne 2 @@ -344,8 +336,6 @@ performance. .RE .SS "\fBpkt_reason\fR Definitions" -.sp -.LP The appropriate definitions for the structure member \fBpkt_reason\fR are: .sp .ne 2 @@ -555,8 +545,6 @@ The device has been removed. .RE .SS "pkt_state Definitions" -.sp -.LP The appropriate definitions for the structure member \fBpkt_state\fR are: .sp .ne 2 @@ -628,8 +616,6 @@ data residual based on the \fIstatuslen\fR parameter of the .RE .SS "pkt_statistics Definitions" -.sp -.LP The definitions that are appropriate for the structure member \fBpkt_statistics\fR are: .sp @@ -696,8 +682,6 @@ Command timed out. .RE .SH SEE ALSO -.sp -.LP \fBtran_init_pkt\fR(9E), \fBtran_setup_pkt\fR(9E), \fBscsi_arq_status\fR(9S), \fBscsi_init_pkt\fR(9F), \fBscsi_transport\fR(9F), \fBscsi_status\fR(9S), \fBscsi_hba_pkt_comp\fR(9F) @@ -705,8 +689,6 @@ Command timed out. .LP \fIWriting Device Drivers\fR .SH NOTES -.sp -.LP HBA drivers should signal \fBscsi_pkt\fR completion by calling \fBscsi_hba_pkt_comp\fR(9F). This is mandatory for HBA drivers that implement \fBtran_setup_pkt\fR(9E). Failure to comply results in undefined behavior. diff --git a/usr/src/man/man9s/scsi_status.9s b/usr/src/man/man9s/scsi_status.9s index b6bb0da585..d32a1decfb 100644 --- a/usr/src/man/man9s/scsi_status.9s +++ b/usr/src/man/man9s/scsi_status.9s @@ -8,23 +8,17 @@ .SH NAME scsi_status \- SCSI status structure .SH SYNOPSIS -.LP .nf #include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBSCSI-2\fRstandard defines a status byte that is normally sent by the target to the initiator during the status phase at the completion of each command. .SH STRUCTURE MEMBERS -.sp .in +2 .nf uchar sts_scsi2 :1; /* SCSI-2 modifier bit */ @@ -171,8 +165,6 @@ it is returned when the command queue in the target is full. .RE .SH SEE ALSO -.sp -.LP \fBscsi_ifgetcap\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_extended_sense\fR(9S), \fBscsi_pkt\fR(9S) .sp diff --git a/usr/src/man/man9s/tuple.9s b/usr/src/man/man9s/tuple.9s index 6108701806..13844612ba 100644 --- a/usr/src/man/man9s/tuple.9s +++ b/usr/src/man/man9s/tuple.9s @@ -8,18 +8,13 @@ .SH NAME tuple \- card information structure (CIS) access structure .SH SYNOPSIS -.LP .nf #include <sys/pccard.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI Specific (Solaris DDI) +illumos DDI Specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBtuple_t\fR structure is the basic data structure provided by card services to manage \fBPC\fR card information. A \fBPC\fR card provides identification and configuration information through its card information @@ -62,14 +57,12 @@ of the number of tuple-parsing utility functions; for custom tuples, the driver may get access to the raw tuple data by calling \fBcsx_GetTupleData\fR(9F). .sp .LP -Solaris \fBPC\fR card drivers do not need to be concerned with which \fBCIS +illumos \fBPC\fR card drivers do not need to be concerned with which \fBCIS \fRchain a tuple appears in. On a multi-function \fBPC\fR card, the client will get the tuples from the global \fBCIS \fRfollowed by the tuples in the function-specific \fBCIS\fR. The caller will not get any tuples from a function-specific \fBCIS \fRthat does not belong to the caller's function. .SH STRUCTURE MEMBERS -.sp -.LP The structure members of \fBtuple_t\fR are: .sp .in +2 @@ -96,7 +89,7 @@ The fields are defined as follows: \fB\fBSocket\fR \fR .ad .RS 17n -Not used in Solaris, but for portability with other card services +Not used in illumos, but for portability with other card services implementations, it should be set to the logical socket number. .RE @@ -220,8 +213,6 @@ the \fBDesiredTuple\fR field is returned. .RE .SH SEE ALSO -.sp -.LP \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F), \fBcsx_ParseTuple\fR(9F), \fBcsx_Parse_CISTPL_BATTERY\fR(9F), \fBcsx_Parse_CISTPL_BYTEORDER\fR(9F), \fBcsx_Parse_CISTPL_CFTABLE_ENTRY\fR(9F), diff --git a/usr/src/man/man9s/usb_bulk_req.9s b/usr/src/man/man9s/usb_bulk_req.9s index 564f6f84d1..be8fd8bf0d 100644 --- a/usr/src/man/man9s/usb_bulk_req.9s +++ b/usr/src/man/man9s/usb_bulk_req.9s @@ -7,16 +7,13 @@ .SH NAME usb_bulk_req, usb_bulk_req_t, usb_bulk_request \- USB bulk request structure .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.LP A bulk request (that is, a request sent through a bulk pipe) is used to transfer large amounts of data in reliable but non-time-critical fashion. Please refer to Section \fI5.8\fR of the \fIUSB 2.0\fR specification for @@ -240,7 +237,6 @@ summarize recovery actions taken and errors encountered during recovery. See All usb request types share the same callback handling. See \fBusb_callback_flags\fR(9S) for details. .SH ATTRIBUTES -.LP See attributes(5) for descriptions of the following attributes: .sp @@ -257,7 +253,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBusb_alloc_request\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_get_max_bulk_transfer_size\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), diff --git a/usr/src/man/man9s/usb_callback_flags.9s b/usr/src/man/man9s/usb_callback_flags.9s index b275e9f461..d81ce21873 100644 --- a/usr/src/man/man9s/usb_callback_flags.9s +++ b/usr/src/man/man9s/usb_callback_flags.9s @@ -7,18 +7,13 @@ .SH NAME usb_callback_flags \- USB callback flag definitions .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP If the USB framework detects an error during a request execution, it calls the client driver's exception callback handler to report what happened. Callback flags (which are set prior to calling the exception callback handler) detail @@ -143,8 +138,6 @@ Callback is executing in interrupt context and should not block. The usb_cb_flags_t enumerated type defines a bitmask. Multiple bits can be set, reporting back multiple statuses to the exception callback handler. .SS "CALLBACK HANDLER" -.sp -.LP The USBA framework supports callback handling as a way of asynchronous client driver notification. There are three kinds of callbacks: Normal completion transfer callback, exception (error) completion transfer callback, and command @@ -157,8 +150,6 @@ USB_FLAGS_SLEEP flag. (USB_FLAGS_SLEEP tells the request or command to block until completed.) Callback handlers must be specified whenever an asynchronous transfer is requested. .SS "PIPE POLICY" -.sp -.LP Each pipe is associated with a pool of threads that are used to run callbacks associated with requests on that pipe. All transfer completion callbacks for a particular pipe are run serially by a single thread. @@ -281,8 +272,6 @@ type of request (ctrl, intr, isoc or bulk.) .in -2 .SS "COMMAND COMPLETION CALLBACKS" -.sp -.LP Calls to some non-transfer functions can be set up for callback notification. These include \fBusb_pipe_close\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_pipe_drain_reqs\fR(9F), \fBusb_set_cfg\fR(9F), \fBusb_set_alt_if\fR(9F) @@ -319,8 +308,6 @@ The callback flags can be checked when rval indicates failure status. Just as for transfer completion callbacks, callback flags return additional information on execution events. .SH ATTRIBUTES -.sp -.LP See attributes(5) for descriptions of the following attributes: .sp @@ -337,8 +324,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBusb_alloc_request\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), \fBusb_bulk_request\fR(9S), diff --git a/usr/src/man/man9s/usb_cfg_descr.9s b/usr/src/man/man9s/usb_cfg_descr.9s index 29ab926a79..8d28a372db 100644 --- a/usr/src/man/man9s/usb_cfg_descr.9s +++ b/usr/src/man/man9s/usb_cfg_descr.9s @@ -7,18 +7,13 @@ .SH NAME usb_cfg_descr \- USB configuration descriptor .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBusb_cfg_descr_t\fR configuration descriptor defines attributes of a configuration. A configuration contains one or more interfaces. A configuration descriptor acts as a header for the group of other descriptors describing the @@ -66,8 +61,6 @@ Configuration descriptors define the following bmAttributes: .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -84,8 +77,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_parse_data\fR(9F), \fBusb_ctrl_request\fR(9S), \fBusb_dev_descr\fR(9S), diff --git a/usr/src/man/man9s/usb_client_dev_data.9s b/usr/src/man/man9s/usb_client_dev_data.9s index d1a0cfe12d..dc9bbd4b90 100644 --- a/usr/src/man/man9s/usb_client_dev_data.9s +++ b/usr/src/man/man9s/usb_client_dev_data.9s @@ -7,16 +7,13 @@ .SH NAME usb_client_dev_data \- Device configuration information .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.LP The usb_client_dev_data_t structure carries all device configuration information. It is provided to a USB client driver through a call to \fBusb_get_dev_data\fR(9F). Most USBA functions require information which comes @@ -159,7 +156,6 @@ USB_PARSE_LVL_NONE is returned when no tree is returned. Note that the value of this field can differ from the parse_level requested as an argument to \fBusb_get_dev_data()\fR. .SS "TREE STRUCTURE" -.LP The root of the tree is dev_cfg, an array of usb_cfg_data_t configuration nodes, each representing one device configuration. The array index does not correspond to a configuration's value; use the bConfigurationValue field of @@ -224,7 +220,6 @@ Configuration and interface alternate nodes return string descriptions. Note that all string descriptions returned have a maximum length of USB_MAXSTRINGLEN bytes and are in English ASCII. .SH EXAMPLES -.LP In the following example, a device's configuration data, including the following descriptor tree, is retrieved by \fBusb_get_dev_data\fR(9F) into usb_client_dev_data_t *reg_data: @@ -274,7 +269,6 @@ usb_client_dev_data_t *reg_data: .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -291,7 +285,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_lookup_ep_data\fR(9F), \fBusb_parse_data\fR(9F), \fBusb_pipe_open\fR(9F), \fBusb_cfg_descr\fR(9S), diff --git a/usr/src/man/man9s/usb_completion_reason.9s b/usr/src/man/man9s/usb_completion_reason.9s index 1a9626f6bb..a44247c03f 100644 --- a/usr/src/man/man9s/usb_completion_reason.9s +++ b/usr/src/man/man9s/usb_completion_reason.9s @@ -7,18 +7,13 @@ .SH NAME usb_completion_reason \- USB completion reason definitions .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP If an error occurs during execution of a USB request, the USBA framework calls a client driver's exception callback handler to relay what happened. The host controller reports transport errors to the exception callback handler through @@ -235,8 +230,6 @@ hardware error. .RE .SH ATTRIBUTES -.sp -.LP See attributes(5) for descriptions of the following attributes: .sp @@ -253,8 +246,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBusb_alloc_request\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), \fBusb_bulk_request\fR(9S), diff --git a/usr/src/man/man9s/usb_ctrl_req.9s b/usr/src/man/man9s/usb_ctrl_req.9s index e3e9b828dd..cb9b9c9f3b 100644 --- a/usr/src/man/man9s/usb_ctrl_req.9s +++ b/usr/src/man/man9s/usb_ctrl_req.9s @@ -7,23 +7,19 @@ .SH NAME usb_ctrl_req, usb_ctrl_req_t, usb_ctrl_request \- USB control pipe request structure .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.LP A control request is used to send device commands (or requests) and to read status. Please refer to Section\fI 5.5\fR of the \fIUSB 2.0\fR specification for information on control pipes. For information on formatting requests, see Section \fI9.3\fR of the \fIUSB 2.0\fR specification. The USB 2.0 specification is available at \fIwww.usb.org\fR. .SH STRUCTURE MEMBERS -.LP The fields in the usb_ctrl_req_t are used to format a control request: .sp .in +2 @@ -155,7 +151,6 @@ Unicode language ID, used as wIndex for USB_REQ_SET/GET_DESCRIPTOR .in -2 .SH ATTRIBUTES -.LP See attributes(5) for descriptions of the following attributes: .sp @@ -172,7 +167,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBusb_alloc_request\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), \fBusb_bulk_request\fR(9S), diff --git a/usr/src/man/man9s/usb_dev_descr.9s b/usr/src/man/man9s/usb_dev_descr.9s index 7d12f017c8..3d800ca2d7 100644 --- a/usr/src/man/man9s/usb_dev_descr.9s +++ b/usr/src/man/man9s/usb_dev_descr.9s @@ -7,18 +7,13 @@ .SH NAME usb_dev_descr \- USB device descriptor .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBusb_dev_descr_t\fR device descriptor defines device-wide attributes. Please refer to Section \fI9.6.1\fR of the \fIUSB 2.0\fR specification. The \fIUSB 2.0\fR specification is available at \fIwww.usb.org\fR. @@ -99,8 +94,6 @@ A device descriptor contains the following fields: .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -117,8 +110,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_parse_data\fR(9F), \fBusb_cfg_descr\fR(9S), \fBusb_ctrl_request\fR(9S), diff --git a/usr/src/man/man9s/usb_dev_qlf_descr.9s b/usr/src/man/man9s/usb_dev_qlf_descr.9s index 997c72606c..4e7bfc1ab6 100644 --- a/usr/src/man/man9s/usb_dev_qlf_descr.9s +++ b/usr/src/man/man9s/usb_dev_qlf_descr.9s @@ -7,18 +7,13 @@ .SH NAME usb_dev_qlf_descr \- USB device qualifier descriptor .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The device qualifier descriptor \fBusb_dev_qlf_descr_t\fR defines how fields of a high speed device's device descriptor would look if that device is run at a different speed. If a high-speed device is running currently at full/high @@ -63,8 +58,6 @@ uint8_t bReserved Reserved. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -81,8 +74,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_parse_data\fR(9F), \fBusb_ctrl_request\fR(9S), \fBusb_cfg_descr\fR(9S), diff --git a/usr/src/man/man9s/usb_ep_descr.9s b/usr/src/man/man9s/usb_ep_descr.9s index 55c1e5918f..bfe07d2028 100644 --- a/usr/src/man/man9s/usb_ep_descr.9s +++ b/usr/src/man/man9s/usb_ep_descr.9s @@ -7,18 +7,13 @@ .SH NAME usb_ep_descr \- USB endpoint descriptor .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBusb_ep_descr_t\fR endpoint descriptor defines endpoint attributes. An endpoint is a uniquely addressable portion of a USB device that is a source or sink of data. @@ -120,8 +115,6 @@ is 2**(value-1). See Section 9.6.6 of the USB 2.0 specification. .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -138,8 +131,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_parse_data\fR(9F), \fBusb_cfg_descr\fR(9S), \fBusb_ctrl_request\fR(9S), diff --git a/usr/src/man/man9s/usb_if_descr.9s b/usr/src/man/man9s/usb_if_descr.9s index 42a5de9dd8..40c56d8ed0 100644 --- a/usr/src/man/man9s/usb_if_descr.9s +++ b/usr/src/man/man9s/usb_if_descr.9s @@ -7,18 +7,13 @@ .SH NAME usb_if_descr \- USB interface descriptor .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBusb_if_descr_t\fR interface descriptor defines attributes of an interface. A configuration contains one or more interfaces. An interface contains one or more endpoints. @@ -103,8 +98,6 @@ values are as follows: .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -121,8 +114,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_parse_data\fR(9F), \fBusb_cfg_descr\fR(9S), \fBusb_ctrl_request\fR(9S), diff --git a/usr/src/man/man9s/usb_intr_req.9s b/usr/src/man/man9s/usb_intr_req.9s index b6e8ab5473..73dab8ef3d 100644 --- a/usr/src/man/man9s/usb_intr_req.9s +++ b/usr/src/man/man9s/usb_intr_req.9s @@ -7,16 +7,13 @@ .SH NAME usb_intr_req, usb_intr_req_t, usb_intr_request \- USB interrupt request structure .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.LP An interrupt request (that is, a request sent through an interrupt pipe), is used to transfer small amounts of data infrequently, but with bounded service periods. (Data flows in either direction.) Please refer to Section @@ -261,7 +258,6 @@ constraints and caveats: .in -2 .SH ATTRIBUTES -.LP See attributes(5) for descriptions of the following attributes: .sp @@ -278,7 +274,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBusb_alloc_request\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), \fBusb_bulk_request\fR(9S), diff --git a/usr/src/man/man9s/usb_isoc_req.9s b/usr/src/man/man9s/usb_isoc_req.9s index 83d4b7e17c..0649cbc84d 100644 --- a/usr/src/man/man9s/usb_isoc_req.9s +++ b/usr/src/man/man9s/usb_isoc_req.9s @@ -7,16 +7,13 @@ .SH NAME usb_isoc_req, usb_isoc_req_t, usb_isoc_request \- USB isochronous request structure .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.LP A request sent through an isochronous pipe is used to transfer large amounts of packetized data with relative unreliability, but with bounded service periods. A packet is guaranteed to be tried within a bounded time period, but is not @@ -231,7 +228,6 @@ usb_callback_flags(9s) for a description of use and operation. .in -2 .SH ATTRIBUTES -.LP See attributes(5) for descriptions of the following attributes: .sp @@ -248,7 +244,6 @@ Interface stability Committed .TE .SH SEE ALSO -.LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_current_frame_number\fR(9F), \fBusb_get_max_pkts_per_isoc_request\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), diff --git a/usr/src/man/man9s/usb_other_speed_cfg_descr.9s b/usr/src/man/man9s/usb_other_speed_cfg_descr.9s index cbf493c17c..0379503e48 100644 --- a/usr/src/man/man9s/usb_other_speed_cfg_descr.9s +++ b/usr/src/man/man9s/usb_other_speed_cfg_descr.9s @@ -7,18 +7,13 @@ .SH NAME usb_other_speed_cfg_descr \- USB other speed configuration descriptor .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBusb_other_speed_cfg_descr_t\fR configuration descriptor defines how fields of a high speed device's configuration descriptor change if that device is run at its other speed. Fields of this descriptor reflect configuration @@ -64,8 +59,6 @@ uint8_t bMaxPower Maximum power consumption .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -82,8 +75,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_parse_data\fR(9F), \fBusb_cfg_descr\fR(9S), \fBusb_ctrl_request\fR(9S), diff --git a/usr/src/man/man9s/usb_request_attributes.9s b/usr/src/man/man9s/usb_request_attributes.9s index 0339de2290..b5cb3faa60 100644 --- a/usr/src/man/man9s/usb_request_attributes.9s +++ b/usr/src/man/man9s/usb_request_attributes.9s @@ -7,18 +7,13 @@ .SH NAME usb_request_attributes \- Definition of USB request attributes .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP Request attributes specify how the USBA framework handles request execution. Request attributes are specified in the request's *_attributes field and belong to the enumerated type usb_req_attrs_t. @@ -124,7 +119,6 @@ isoc_frame_no of the usb_isoc_req_t is ignored. Please see .RE .SH EXAMPLES -.sp .in +2 .nf /* @@ -173,8 +167,6 @@ isoc_frame_no of the usb_isoc_req_t is ignored. Please see .in -2 .SH ATTRIBUTES -.sp -.LP See attributes(5) for descriptions of the following attributes: .sp @@ -191,8 +183,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBusb_alloc_request\fR(9F), \fBusb_get_current_frame_number\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), diff --git a/usr/src/man/man9s/usb_string_descr.9s b/usr/src/man/man9s/usb_string_descr.9s index bd74fe4065..6d28259580 100644 --- a/usr/src/man/man9s/usb_string_descr.9s +++ b/usr/src/man/man9s/usb_string_descr.9s @@ -7,18 +7,13 @@ .SH NAME usb_string_descr \- USB string descriptor .SH SYNOPSIS -.LP .nf #include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) +illumos DDI specific (illumos DDI) .SH DESCRIPTION -.sp -.LP The \fBusb_string_descr_t\fR string descriptor defines the attributes of a string, including size and Unicode language ID. Other USB descriptors may have string descriptor index fields which refer to specific string descriptors @@ -44,8 +39,6 @@ uint16_t bString[1]; Variable length Unicode encoded .in -2 .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -62,8 +55,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp -.LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_parse_data\fR(9F), \fBusb_ctrl_request\fR(9S) diff --git a/usr/src/tools/scripts/nightly b/usr/src/tools/scripts/nightly index 8d65890e1f..72bc1f2c3e 100755 --- a/usr/src/tools/scripts/nightly +++ b/usr/src/tools/scripts/nightly @@ -655,7 +655,7 @@ if [ -f /etc/nightly.conf ]; then fi if [ -f $1 ]; then - if [[ $1 = */* ]]; then + if [[ $1 == */* ]]; then . $1 else . ./$1 @@ -843,19 +843,19 @@ if [ "${SUNWSPRO}" != "" ]; then fi hostname=$(uname -n) -if [[ $DMAKE_MAX_JOBS != +([0-9]) || $DMAKE_MAX_JOBS -eq 0 ]] +if [[ $DMAKE_MAX_JOBS != +([0-9]) || $DMAKE_MAX_JOBS == 0 ]] then maxjobs= if [[ -f $HOME/.make.machines ]] then # Note: there is a hard tab and space character in the []s # below. - egrep -i "^[ ]*$hostname[ \.]" \ + egrep -i "^[ ]*${hostname}[ \.]" \ $HOME/.make.machines | read host jobs maxjobs=${jobs##*=} fi - if [[ $maxjobs != +([0-9]) || $maxjobs -eq 0 ]] + if [[ $maxjobs != +([0-9]) || $maxjobs == 0 ]] then # default maxjobs=4 @@ -1119,7 +1119,7 @@ function create_lock { function allprotos { typeset roots="$ROOT" - if [[ "$F_FLAG" = n && "$MULTI_PROTO" = yes ]]; then + if [[ "$F_FLAG" == n && "$MULTI_PROTO" == yes ]]; then roots="$roots $ROOT-nd" fi @@ -1338,7 +1338,7 @@ if [ "$i_FLAG" = "n" -a -d "$SRC" ]; then build_extras_ok=n fi - if [[ "$t_FLAG" = "y" ]]; then + if [[ "$t_FLAG" == "y" ]]; then echo "\n==== Make tools clobber at `date` ====\n" >> $LOGFILE cd ${TOOLS} rm -f ${TOOLS}/clobber-${MACH}.out @@ -1533,7 +1533,7 @@ if [ "$n_FLAG" = "n" ]; then # $CODEMGR_WS. If so, then SCM_TYPE was previously "none," # but should now be the same as $BRINGOVER_WS. # - [[ $SCM_TYPE = none ]] && SCM_TYPE=$PARENT_SCM_TYPE + [[ $SCM_TYPE == none ]] && SCM_TYPE=$PARENT_SCM_TYPE run_hook POST_BRINGOVER @@ -1548,7 +1548,7 @@ fi [[ -d "${CODEMGR_WS}" ]] || fatal_error "Error: ${CODEMGR_WS} is not a directory." [[ -f "${CODEMGR_WS}/usr/src/Makefile" ]] || fatal_error "Error: ${CODEMGR_WS}/usr/src/Makefile not found." -if [[ "$t_FLAG" = "y" ]]; then +if [[ "$t_FLAG" == "y" ]]; then set_non_debug_build_flags bootstrap_tools || fatal_error "Error: could not bootstrap tools" @@ -1627,7 +1627,7 @@ fi # # Build and use the workspace's tools if requested # -if [[ "$t_FLAG" = "y" ]]; then +if [[ "$t_FLAG" == "y" ]]; then set_non_debug_build_flags build_tools ${TOOLS_PROTO} @@ -1668,13 +1668,35 @@ normal_build ORIG_SRC=$SRC BINARCHIVE=${CODEMGR_WS}/bin-${MACH}.cpio.Z +abspkg= +for d in $abssrcdirs; do + if [ -d "$d/pkg" ]; then + abspkg="$abspkg $d" + fi +done + +if [ "$L_FLAG" != "y" -a "$build_ok" = y ]; then + echo "\n==== Linting packages ====\n" | \ + tee -a $LOGFILE >> $mail_msg_file + + if [ -n "$abspkg" ]; then + for d in "$abspkg"; do + ( cd $d/pkg ; $MAKE -e pkglint ) | \ + tee -a $LOGFILE | \ + egrep -v 'Lint engine setup|Starting lint run' + done 2>&1 | tee $TMPDIR/pkglint_noise >> $mail_msg_file + if [[ -s $TMPDIR/pkglint_noise ]]; then + build_extras_ok=n + fi + fi +fi # # There are several checks that need to look at the proto area, but # they only need to look at one, and they don't care whether it's # DEBUG or non-DEBUG. # -if [[ "$MULTI_PROTO" = yes && "$D_FLAG" = n ]]; then +if [[ "$MULTI_PROTO" == yes && "$D_FLAG" == n ]]; then checkroot=$ROOT-nd else checkroot=$ROOT @@ -1754,12 +1776,12 @@ if [ "$U_FLAG" = "y" -a "$build_ok" = "y" ]; then rm -rf $NIGHTLY_PARENT_ROOT/* unset Ulockfile mkdir -p $NIGHTLY_PARENT_ROOT - if [[ "$MULTI_PROTO" = no || "$D_FLAG" = y ]]; then + if [[ "$MULTI_PROTO" == no || "$D_FLAG" == y ]]; then ( cd $ROOT; tar cf - . | ( cd $NIGHTLY_PARENT_ROOT; umask 0; tar xpf - ) ) 2>&1 | tee -a $mail_msg_file >> $LOGFILE fi - if [[ "$MULTI_PROTO" = yes && "$F_FLAG" = n ]]; then + if [[ "$MULTI_PROTO" == yes && "$F_FLAG" == n ]]; then rm -rf $NIGHTLY_PARENT_ROOT-nd/* mkdir -p $NIGHTLY_PARENT_ROOT-nd cd $ROOT-nd @@ -1772,7 +1794,7 @@ if [ "$U_FLAG" = "y" -a "$build_ok" = "y" ]; then tee -a $LOGFILE >> $mail_msg_file rm -rf $NIGHTLY_PARENT_TOOLS_ROOT/* mkdir -p $NIGHTLY_PARENT_TOOLS_ROOT - if [[ "$MULTI_PROTO" = no || "$D_FLAG" = y ]]; then + if [[ "$MULTI_PROTO" == no || "$D_FLAG" == y ]]; then ( cd $TOOLS_PROTO; tar cf - . | ( cd $NIGHTLY_PARENT_TOOLS_ROOT; umask 0; tar xpf - ) ) 2>&1 | @@ -1784,7 +1806,7 @@ fi # # ELF verification: ABI (-A) and runtime (-r) checks # -if [[ ($build_ok = y) && (($A_FLAG = y) || ($r_FLAG = y)) ]]; then +if [[ ($build_ok == y) && (($A_FLAG == y) || ($r_FLAG == y)) ]]; then # Directory ELF-data.$MACH holds the files produced by these tests. elf_ddir=$SRC/ELF-data.$MACH @@ -1802,7 +1824,7 @@ if [[ ($build_ok = y) && (($A_FLAG = y) || ($r_FLAG = y)) ]]; then # them from separately calling find_elf to do the same work twice. find_elf -fr $checkroot > $elf_ddir/object_list - if [[ $A_FLAG = y ]]; then + if [[ $A_FLAG == y ]]; then echo "\n==== Check versioning and ABI information ====\n" | \ tee -a $LOGFILE >> $mail_msg_file @@ -1845,13 +1867,13 @@ if [[ ($build_ok = y) && (($A_FLAG = y) || ($r_FLAG = y)) ]]; then fi fi - if [[ $r_FLAG = y ]]; then + if [[ $r_FLAG == y ]]; then echo "\n==== Check ELF runtime attributes ====\n" | \ tee -a $LOGFILE >> $mail_msg_file # If we're doing a DEBUG build the proto area will be left # with debuggable objects, thus don't assert -s. - if [[ $D_FLAG = y ]]; then + if [[ $D_FLAG == y ]]; then rtime_sflag="" else rtime_sflag="-s" @@ -1893,7 +1915,7 @@ if [[ ($build_ok = y) && (($A_FLAG = y) || ($r_FLAG = y)) ]]; then fi # If -u set, copy contents of ELF-data.$MACH to the parent workspace. - if [[ "$u_FLAG" = "y" ]]; then + if [[ "$u_FLAG" == "y" ]]; then p_elf_ddir=$PARENT_WS/usr/src/ELF-data.$MACH # If parent lacks the ELF-data.$MACH directory, create it @@ -1981,13 +2003,6 @@ if [ "$CHECK_PATHS" = y -a "$N_FLAG" != y ]; then fi fi -abspkg= -for d in $abssrcdirs; do - if [ -d "$d/pkg" ]; then - abspkg="$abspkg $d" - fi -done - if [ "$M_FLAG" != "y" -a "$build_ok" = y ]; then echo "\n==== Impact on file permissions ====\n" \ >> $mail_msg_file @@ -1999,28 +2014,12 @@ if [ "$M_FLAG" != "y" -a "$build_ok" = y ]; then fi fi -if [ "$L_FLAG" != "y" -a "$build_ok" = y ]; then - echo "\n==== Linting packages ====\n" | \ - tee -a $LOGFILE >> $mail_msg_file - - if [ -n "$abspkg" ]; then - for d in "$abspkg"; do - ( cd $d/pkg ; $MAKE -e pkglint ) | \ - tee -a $LOGFILE | \ - egrep -v 'Lint engine setup|Starting lint run' - done 2>&1 | tee $TMPDIR/pkglint_noise >> $mail_msg_file - if [[ -s $TMPDIR/pkglint_noise ]]; then - build_extras_ok=n - fi - fi -fi - if [ "$w_FLAG" = "y" -a "$build_ok" = "y" ]; then - if [[ "$MULTI_PROTO" = no || "$D_FLAG" = y ]]; then + if [[ "$MULTI_PROTO" == no || "$D_FLAG" == y ]]; then do_wsdiff DEBUG $ROOT.prev $ROOT fi - if [[ "$MULTI_PROTO" = yes && "$F_FLAG" = n ]]; then + if [[ "$MULTI_PROTO" == yes && "$F_FLAG" == n ]]; then do_wsdiff non-DEBUG $ROOT-nd.prev $ROOT-nd fi fi |