diff options
Diffstat (limited to 'usr/src/man/man9s')
53 files changed, 88 insertions, 517 deletions
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..6b608e8908 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,8 +23,6 @@ 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. @@ -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) |