diff options
Diffstat (limited to 'usr/src/man/man9s')
72 files changed, 507 insertions, 1243 deletions
diff --git a/usr/src/man/man9s/Intro.9s b/usr/src/man/man9s/Intro.9s index 202b8589d6..36c9438abe 100644 --- a/usr/src/man/man9s/Intro.9s +++ b/usr/src/man/man9s/Intro.9s @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH Intro 9S "15 May 2001" "SunOS 5.11" "Data Structures for Drivers" +.TH INTRO 9S "May 15, 2001" .SH NAME Intro, intro \- introduction to kernel data structures and properties .SH DESCRIPTION @@ -69,41 +69,40 @@ The following table summarizes the STREAMS structures described in Section 9S. .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -StructureType +box; +c | c +l | l . +Structure Type _ -\fBcopyreq\fRDDI/DKI +\fBcopyreq\fR DDI/DKI _ -\fBcopyresp\fRDDI/DKI +\fBcopyresp\fR DDI/DKI _ -\fBdatab\fRDDI/DKI +\fBdatab\fR DDI/DKI _ -\fBfmodsw\fRSolaris DDI +\fBfmodsw\fR Solaris DDI _ -\fBfree_rtn\fRDDI/DKI +\fBfree_rtn\fR DDI/DKI _ -\fBiocblk\fRDDI/DKI +\fBiocblk\fR DDI/DKI _ -\fBlinkblk\fRDDI/DKI +\fBlinkblk\fR DDI/DKI _ -\fBmodule_info\fRDDI/DKI +\fBmodule_info\fR DDI/DKI _ -\fBmsgb\fRDDI/DKI +\fBmsgb\fR DDI/DKI _ -\fBqband\fRDDI/DKI +\fBqband\fR DDI/DKI _ -\fBqinit\fRDDI/DKI +\fBqinit\fR DDI/DKI _ -\fBqueclass\fRSolaris DDI +\fBqueclass\fR Solaris DDI _ -\fBqueue\fRDDI/DKI +\fBqueue\fR DDI/DKI _ -\fBstreamtab\fRDDI/DKI +\fBstreamtab\fR DDI/DKI _ -\fBstroptions\fRDDI/DKI +\fBstroptions\fR DDI/DKI .TE .sp @@ -113,75 +112,74 @@ The following table summarizes structures that are not specific to STREAMS I/O. .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -StructureType +box; +c | c +l | l . +Structure Type _ -\fBaio_req\fRSolaris DDI +\fBaio_req\fR Solaris DDI _ -\fBbuf\fRDDI/DKI +\fBbuf\fR DDI/DKI _ -\fBcb_ops\fRSolaris DDI +\fBcb_ops\fR Solaris DDI _ -\fBddi_device_acc_attr\fRSolaris DDI +\fBddi_device_acc_attr\fR Solaris DDI _ -\fBddi_dma_attr\fRSolaris DDI +\fBddi_dma_attr\fR Solaris DDI _ -\fBddi_dma_cookie\fRSolaris DDI +\fBddi_dma_cookie\fR Solaris DDI _ -\fBddi_dma_lim_sparc\fRSolaris SPARC DDI +\fBddi_dma_lim_sparc\fR Solaris SPARC DDI _ -\fBddi_dma_lim_x86\fRSolaris x86 DDI +\fBddi_dma_lim_x86\fR Solaris x86 DDI _ -\fBddi_dma_req\fRSolaris DDI +\fBddi_dma_req\fR Solaris DDI _ -\fBddi_dmae_req\fRSolaris x86 DDI +\fBddi_dmae_req\fR Solaris x86 DDI _ -\fBddi_idevice_cookie\fRSolaris DDI +\fBddi_idevice_cookie\fR Solaris DDI _ -\fBddi_mapdev_ctl\fRSolaris DDI +\fBddi_mapdev_ctl\fR Solaris DDI _ -\fBdevmap_callback_ctl\fRSolaris DDI +\fBdevmap_callback_ctl\fR Solaris DDI _ -\fBdev_ops\fRSolaris DDI +\fBdev_ops\fR Solaris DDI _ -\fBiovec\fRDDI/DKI +\fBiovec\fR DDI/DKI _ -\fBkstat\fRSolaris DDI +\fBkstat\fR Solaris DDI _ -\fBkstat_intr\fRSolaris DDI +\fBkstat_intr\fR Solaris DDI _ -\fBkstat_io\fRSolaris DDI +\fBkstat_io\fR Solaris DDI _ -\fBkstat_named\fRSolaris DDI +\fBkstat_named\fR Solaris DDI _ -\fBmap\fRDDI/DKI +\fBmap\fR DDI/DKI _ -\fBmodldrv\fRSolaris DDI +\fBmodldrv\fR Solaris DDI _ -\fBmodlinkage\fRSolaris DDI +\fBmodlinkage\fR Solaris DDI _ -\fBmodlstrmod\fRSolaris DDI +\fBmodlstrmod\fR Solaris DDI _ -\fBscsi_address\fRSolaris DDI +\fBscsi_address\fR Solaris DDI _ -\fBscsi_arq_status\fRSolaris DDI +\fBscsi_arq_status\fR Solaris DDI _ -\fBscsi_device\fRSolaris DDI +\fBscsi_device\fR Solaris DDI _ -\fBscsi_extended_sense\fRSolaris DDI +\fBscsi_extended_sense\fR Solaris DDI _ -\fBscsi_hba_tran\fRSolaris DDI +\fBscsi_hba_tran\fR Solaris DDI _ -\fBscsi_inquiry\fRSolaris DDI +\fBscsi_inquiry\fR Solaris DDI _ -\fBscsi_pkt\fRSolaris DDI +\fBscsi_pkt\fR Solaris DDI _ -\fBscsi_status\fRSolaris DDI +\fBscsi_status\fR Solaris DDI _ -\fBuio\fRDDI/DKI +\fBuio\fR DDI/DKI .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/aio_req.9s b/usr/src/man/man9s/aio_req.9s index 4fb18dbac7..980e32556d 100644 --- a/usr/src/man/man9s/aio_req.9s +++ b/usr/src/man/man9s/aio_req.9s @@ -4,16 +4,16 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH aio_req 9S "28 Mar 1997" "SunOS 5.11" "Data Structures for Drivers" +.TH AIO_REQ 9S "Mar 28, 1997" .SH NAME aio_req \- asynchronous I/O request structure .SH SYNOPSIS .LP .nf -#include <sys/uio.h> -#include <sys/aio_req.h> -#include <sys/ddi.h> -#include <sys/sunddi.h> +#include <sys/uio.h> +#include <sys/aio_req.h> +#include <sys/ddi.h> +#include <sys/sunddi.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/buf.9s b/usr/src/man/man9s/buf.9s index d525bd4e85..bb85a8b67d 100644 --- a/usr/src/man/man9s/buf.9s +++ b/usr/src/man/man9s/buf.9s @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH buf 9S "19 Sep 2002" "SunOS 5.11" "Data Structures for Drivers" +.TH BUF 9S "Sep 19, 2002" .SH NAME buf \- block I/O data transfer structure .SH SYNOPSIS @@ -46,16 +46,16 @@ device is maximized. The \fBav_forw\fR and the \fBav_back\fR members of the .sp .in +2 .nf -int b_flags; /* Buffer status */ +int b_flags; /* Buffer status */ struct buf *av_forw; /* Driver work list link */ struct buf *av_back; /* Driver work list link */ -size_t b_bcount; /* # of bytes to transfer */ +size_t b_bcount; /* # of bytes to transfer */ union { - caddr_t b_addr; /* Buffer's virtual address */ + caddr_t b_addr; /* Buffer's virtual address */ } b_un; -daddr_t b_blkno; /* Block number on device */ -diskaddr_t b_lblkno; /* Expanded block number on dev. */ -size_t b_resid; /* # of bytes not xferred */ +daddr_t b_blkno; /* Block number on device */ +diskaddr_t b_lblkno; /* Expanded block number on dev. */ +size_t b_resid; /* # of bytes not xferred */ size_t b_bufsize; /* size of alloc. buffer */ int (*b_iodone)(struct buf *); /* function called */ /* by biodone */ @@ -85,12 +85,10 @@ kernel and may not be used. Valid flags are as follows: .sp .ne 2 -.mk .na \fB\fBB_BUSY\fR \fR .ad .RS 13n -.rt Indicates the buffer is in use. The driver must not change this flag unless it allocated the buffer with \fBgetrbuf\fR(9F) and no \fBI/O\fR operation is in progress. @@ -98,23 +96,19 @@ progress. .sp .ne 2 -.mk .na \fB\fBB_DONE\fR \fR .ad .RS 13n -.rt Indicates the data transfer has completed. This flag is read-only. .RE .sp .ne 2 -.mk .na \fB\fBB_ERROR\fR \fR .ad .RS 13n -.rt Indicates an \fBI/O\fR transfer error. It is set in conjunction with the \fBb_error\fR field. \fBbioerror\fR(9F) should be used in preference to setting the \fBB_ERROR\fR bit. @@ -122,12 +116,10 @@ the \fBB_ERROR\fR bit. .sp .ne 2 -.mk .na \fB\fBB_PAGEIO\fR \fR .ad .RS 13n -.rt Indicates the buffer is being used in a paged \fBI/O\fR request. See the description of the \fBb_un.b_addr\fR field for more information. This flag is read-only. @@ -135,12 +127,10 @@ read-only. .sp .ne 2 -.mk .na \fB\fBB_PHYS\fR \fR .ad .RS 13n -.rt indicates the buffer header is being used for physical (direct) \fBI/O\fR to a user data area. See the description of the \fBb_un.b_addr\fR field for more information. This flag is read-only. @@ -148,23 +138,19 @@ information. This flag is read-only. .sp .ne 2 -.mk .na \fB\fBB_READ\fR \fR .ad .RS 13n -.rt Indicates that data is to be read from the peripheral device into main memory. .RE .sp .ne 2 -.mk .na \fB\fBB_WRITE\fR \fR .ad .RS 13n -.rt Indicates that the data is to be transferred from main memory to the peripheral device. \fBB_WRITE\fR is a pseudo flag and cannot be directly tested; it is only detected as the NOT form of \fBB_READ\fR. diff --git a/usr/src/man/man9s/cb_ops.9s b/usr/src/man/man9s/cb_ops.9s index 377c603e3a..5366974b64 100644 --- a/usr/src/man/man9s/cb_ops.9s +++ b/usr/src/man/man9s/cb_ops.9s @@ -3,15 +3,15 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH cb_ops 9S "24 Apr 2008" "SunOS 5.11" "Data Structures for Drivers" +.TH CB_OPS 9S "Apr 24, 2008" .SH NAME cb_ops \- character/block entry points structure .SH SYNOPSIS .LP .nf -#include <sys/conf.h> +#include <sys/conf.h> #include <sys/ddi.h> -#include <sys/sunddi.h> +#include <sys/sunddi.h> .fi .SH INTERFACE LEVEL @@ -60,27 +60,25 @@ are provided in the character/block driver operations structure. .sp .TS -tab(); -cw(1.17i) cw(1.36i) cw(1.25i) cw(1.72i) -lw(1.17i) lw(1.36i) lw(1.25i) lw(1.72i) -. -block/charFunctionDescription +c c c c +l l l l . +block/char Function Description _ -b/cXXopen\fBDDI\fR/\fBDKI\fR -b/cXXclose\fBDDI\fR/\fBDKI\fR -bXXstrategyDDI/DKI -bXXprintDDI/DKI -bXXdumpDDI(Sun) -cXXreadDDI/DKI -cXXwriteDDI/DKI -cXXioctlDDI/DKI -cXXdevmapDDI(Sun) -cXXmmapDKI -cXXsegmapDKI -cXXchpollDDI/DKI -cXXprop_opDDI(Sun) -cXXareadDDI(Sun) -cXXawriteDDI(Sun) +b/c XXopen \fBDDI\fR/\fBDKI\fR +b/c XXclose \fBDDI\fR/\fBDKI\fR +b XXstrategy DDI/DKI +b XXprint DDI/DKI +b XXdump DDI(Sun) +c XXread DDI/DKI +c XXwrite DDI/DKI +c XXioctl DDI/DKI +c XXdevmap DDI(Sun) +c XXmmap DKI +c XXsegmap DKI +c XXchpoll DDI/DKI +c XXprop_op DDI(Sun) +c XXaread DDI(Sun) +c XXawrite DDI(Sun) .TE .SH STRUCTURE MEMBERS @@ -94,18 +92,18 @@ int (*cb_print)(dev_t dev, char *str); int (*cb_dump)(dev_t dev, caddr_t addr, daddr_t blkno, int nblk); int (*cb_read)(dev_t dev, struct uio *uiop, cred_t *credp); int (*cb_write)(dev_t dev, struct uio *uiop, cred_t *credp); -int (*cb_ioctl)(dev_t dev, int cmd, intptr_t arg, int mode, +int (*cb_ioctl)(dev_t dev, int cmd, intptr_t arg, int mode, cred_t *credp, int *rvalp); -int (*cb_devmap)(dev_t dev, devmap_cookie_t dhp, offset_t off, +int (*cb_devmap)(dev_t dev, devmap_cookie_t dhp, offset_t off, size_t len, size_t *maplen, uint_t model); int (*cb_mmap)(dev_t dev, off_t off, int prot); -int (*cb_segmap)(dev_t dev, off_t off, struct as *asp, - caddr_t *addrp, off_t len, unsigned int prot, +int (*cb_segmap)(dev_t dev, off_t off, struct as *asp, + caddr_t *addrp, off_t len, unsigned int prot, unsigned int maxprot, unsigned int flags, cred_t *credp); -int (*cb_chpoll)(dev_t dev, short events, int anyyet, +int (*cb_chpoll)(dev_t dev, short events, int anyyet, short *reventsp, struct pollhead **phpp); -int (*cb_prop_op)(dev_t dev, dev_info_t *dip, - ddi_prop_op_t prop_op, int mod_flags, +int (*cb_prop_op)(dev_t dev, dev_info_t *dip, + ddi_prop_op_t prop_op, int mod_flags, char *name, caddr_t valuep, int *length); struct streamtab *cb_str; /* streams information */ int cb_flag; diff --git a/usr/src/man/man9s/copyreq.9s b/usr/src/man/man9s/copyreq.9s index 89a8fc7370..d75be110d1 100644 --- a/usr/src/man/man9s/copyreq.9s +++ b/usr/src/man/man9s/copyreq.9s @@ -4,14 +4,14 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH copyreq 9S "6 October 2000" "SunOS 5.11" "Data Structures for Drivers" +.TH COPYREQ 9S "Oct 6, 2000" .SH NAME copyreq \- STREAMS data structure for the M_COPYIN and the M_COPYOUT message types .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/copyresp.9s b/usr/src/man/man9s/copyresp.9s index ebdfa93434..5cde22a46f 100644 --- a/usr/src/man/man9s/copyresp.9s +++ b/usr/src/man/man9s/copyresp.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH copyresp 9S "14 Nov 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH COPYRESP 9S "Nov 14, 1996" .SH NAME copyresp \- STREAMS data structure for the M_IOCDATA message type .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL @@ -30,7 +30,7 @@ cred_t *cp_cr; /* full credentials */ uint_t cp_id; /* ioctl id (from ioc_id) */ uint_t cp_flag; /* ioctl flags */ mblk_t *cp_private; /* private state information */ -caddr_t cp_rval; /* status of request: 0 -> success; +caddr_t cp_rval; /* status of request: 0 -> success; /* non-zero -> failure */ .fi .in -2 diff --git a/usr/src/man/man9s/datab.9s b/usr/src/man/man9s/datab.9s index 595edef517..686b5fb9da 100644 --- a/usr/src/man/man9s/datab.9s +++ b/usr/src/man/man9s/datab.9s @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH datab 9S "24 Oct 2003" "SunOS 5.11" "Data Structures for Drivers" +.TH DATAB 9S "Oct 24, 2003" .SH NAME datab, dblk \- STREAMS message data structure .SH SYNOPSIS diff --git a/usr/src/man/man9s/ddi_device_acc_attr.9s b/usr/src/man/man9s/ddi_device_acc_attr.9s index 3418a8c609..da8f7e47d8 100644 --- a/usr/src/man/man9s/ddi_device_acc_attr.9s +++ b/usr/src/man/man9s/ddi_device_acc_attr.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_device_acc_attr 9S "13 May 2007" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_DEVICE_ACC_ATTR 9S "May 13, 2007" .SH NAME ddi_device_acc_attr \- data access attributes structure .SH SYNOPSIS @@ -43,34 +43,28 @@ The \fBdevacc_attr_endian_flags\fR member describes the endian characteristics of the device. Specify one of the following values: .sp .ne 2 -.mk .na \fB\fBDDI_NEVERSWAP_ACC\fR\fR .ad .RS 24n -.rt Data access with no byte swapping .RE .sp .ne 2 -.mk .na \fB\fBDDI_STRUCTURE_BE_ACC\fR\fR .ad .RS 24n -.rt Structural data access in big-endian format .RE .sp .ne 2 -.mk .na \fB\fBDDI_STRUCTURE_LE_ACC\fR\fR .ad .RS 24n -.rt Structural data access in little endian format .RE @@ -95,24 +89,20 @@ The \fBdevacc_attr_dataorder\fR member describes the order in which the \fBCPU\fR references data. Specify one of the following values. .sp .ne 2 -.mk .na \fB\fBDDI_STRICTORDER_ACC\fR\fR .ad .RS 27n -.rt Data references must be issued by a \fBCPU\fR in program order. Strict ordering is the default behavior. .RE .sp .ne 2 -.mk .na \fB\fBDDI_UNORDERED_OK_ACC\fR\fR .ad .RS 27n -.rt The \fBCPU\fR can reorder the data references. This includes all kinds of reordering. For example, a load followed by a store might be replaced by a store followed by a load. @@ -120,12 +110,10 @@ store followed by a load. .sp .ne 2 -.mk .na \fB\fBDDI_MERGING_OK_ACC\fR\fR .ad .RS 27n -.rt The \fBCPU\fR can merge individual stores to consecutive locations. For example, the \fBCPU\fR can turn two consecutive byte stores into one half-word store. It can also batch individual loads. For example, the \fBCPU\fR might @@ -135,12 +123,10 @@ turn two consecutive byte loads into one half-word load. .sp .ne 2 -.mk .na \fB\fBDDI_LOADCACHING_OK_ACC\fR\fR .ad .RS 27n -.rt The \fBCPU\fR can cache the data it fetches and reuse it until another store occurs. The default behavior is to fetch new data on every load. \fBDDI_LOADCACHING_OK_ACC\fR also implies merging and reordering. @@ -148,12 +134,10 @@ occurs. The default behavior is to fetch new data on every load. .sp .ne 2 -.mk .na \fB\fBDDI_STORECACHING_OK_ACC\fR\fR .ad .RS 27n -.rt The \fBCPU\fR can keep the data in the cache and push it to the device, perhaps with other data, at a later time. The default behavior is to push the data right away. \fBDDI_STORECACHING_OK_ACC\fR also implies load caching, merging, @@ -170,24 +154,20 @@ merged, and cached together. The values defined for \fBdevacc_attr_access\fR are: .sp .ne 2 -.mk .na \fB\fBDDI_DEFAULT_ACC\fR\fR .ad .RS 20n -.rt If an \fBI/O\fR fault occurs, the system will take the default action, which might be to panic. .RE .sp .ne 2 -.mk .na \fB\fBDDI_FLAGERR_ACC\fR\fR .ad .RS 20n -.rt Using this value indicates that the driver is hardened: able to cope with the incorrect results of \fBI/O\fR operations that might result from an \fBI/O\fR fault. The value also indicates that the driver will use @@ -207,12 +187,10 @@ panic anyway. .sp .ne 2 -.mk .na \fB\fBDDI_CAUTIOUS_ACC\fR\fR .ad .RS 20n -.rt This value indicates that an \fBI/O\fR fault is anticipated and should be handled as gracefully as possible. For example, the framework should not print a console message. @@ -260,16 +238,16 @@ ddi_acc_handle_t handle; /* * setup the device attribute structure for little endian, - * strict ordering and 16-bit word access. + * strict ordering and 16-bit word access. */ dev_attr.devacc_attr_version = DDI_DEVICE_ATTR_V0; dev_attr.devacc_attr_endian_flags = DDI_STRUCTURE_LE_ACC; dev_attr.devacc_attr_dataorder = DDI_STRICTORDER_ACC; /* - * set up the device registers address mapping + * set up the device registers address mapping */ -ddi_regs_map_setup(dip, rnumber, (caddr_t *)&dev_addr, offset, len, +ddi_regs_map_setup(dip, rnumber, (caddr_t *)&dev_addr, offset, len, &dev_attr, &handle); /* read a 16-bit word command register from the device */ @@ -308,14 +286,14 @@ uchar_t buf[256]; /* * setup the device attribute structure for never swap, - * unordered and 32-bit word access. + * unordered and 32-bit word access. */ dev_attr.devacc_attr_version = DDI_DEVICE_ATTR_V0; dev_attr.devacc_attr_endian_flags = DDI_NEVERSWAP_ACC; dev_attr.devacc_attr_dataorder = DDI_UNORDERED_OK_ACC; /* - * map in the RGB big-endian aperture + * map in the RGB big-endian aperture * while running in a big endian machine * - offset 96K and len 32K */ @@ -356,7 +334,7 @@ uchar_t buf[256]; /* * setup the device attribute structure for never swap, - * strict ordering and 32-bit word access. + * strict ordering and 32-bit word access. */ dev_attr.devacc_attr_version = DDI_DEVICE_ATTR_V0; dev_attr.devacc_attr_endian_flags = DDI_NEVERSWAP_ACC; @@ -373,7 +351,7 @@ status = ddi_getw(handle, &dev_blkp->d_status); if (status & DATA_READY) /* Read 1K bytes off the 32-bit data register */ - ddi_rep_getl(handle, buf, &dev_blkp->d_data, + ddi_rep_getl(handle, buf, &dev_blkp->d_data, 256, DDI_DEV_NO_AUTOINCR); .fi .in -2 @@ -386,13 +364,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/ddi_dma_attr.9s b/usr/src/man/man9s/ddi_dma_attr.9s index 0cb26bed70..c4c100bf94 100644 --- a/usr/src/man/man9s/ddi_dma_attr.9s +++ b/usr/src/man/man9s/ddi_dma_attr.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_dma_attr 9S "12 Feb 2009" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_DMA_ATTR 9S "Feb 12, 2009" .SH NAME ddi_dma_attr \- DMA attributes structure .SH SYNOPSIS @@ -111,47 +111,39 @@ The \fBdma_attr_sgllen\fR field describes the length of the \fBDMA\fR scatter/gather list of a device. Possible values are as follows: .sp .ne 2 -.mk .na \fB\fB< 0\fR\fR .ad .RS 7n -.rt Device \fBDMA\fR engine is not constrained by the size, for example, with\fBDMA\fR chaining. .RE .sp .ne 2 -.mk .na \fB\fB= 0\fR\fR .ad .RS 7n -.rt Reserved. .RE .sp .ne 2 -.mk .na \fB\fB= 1\fR\fR .ad .RS 7n -.rt Device \fBDMA\fR engine does not support scatter/gather such as third party \fBDMA\fR. .RE .sp .ne 2 -.mk .na \fB\fB> 1\fR\fR .ad .RS 7n -.rt Device \fBDMA\fR engine uses scatter/gather. The \fBdma_attr_sgllen\fR value is the maximum number of entries in the list. .RE @@ -172,7 +164,6 @@ granularity of the device transfer size. The \fBdma_attr_flags\fR field can be set to a combination of: .sp .ne 2 -.mk .na \fB\fBDDI_DMA_FORCE_PHYSICAL\fR\fR .ad @@ -193,7 +184,6 @@ the operation. .sp .ne 2 -.mk .na \fB\fBDDI_DMA_FLAGERR\fR\fR .ad @@ -218,7 +208,6 @@ anyway. .sp .ne 2 -.mk .na \fB\fBDDI_DMA_RELAXED_ORDERING\fR\fR .ad @@ -305,16 +294,16 @@ The corresponding \fBddi_dma_attr_t\fR structure is initialized as follows: .nf static ddi_dma_attr_t dma_attrs = { DMA_ATTR_V0 /* version number */ - (uint64_t)0x0, /* low address */ + (uint64_t)0x0, /* low address */ (uint64_t)0xffffffff, /* high address */ (uint64_t)0xffffff, /* DMA counter max */ - (uint64_t)0x1 /* alignment */ + (uint64_t)0x1 /* alignment */ 0x0c, /* burst sizes */ 0x1, /* minimum transfer size */ (uint64_t)0x3ffffff, /* maximum transfer size */ (uint64_t)0x7fff, /* maximum segment size */ 17, /* scatter/gather list lgth */ - 512 /* granularity */ + 512 /* granularity */ 0 /* DMA flags */ }; .fi @@ -328,13 +317,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/ddi_dma_cookie.9s b/usr/src/man/man9s/ddi_dma_cookie.9s index 024443027a..e940c75901 100644 --- a/usr/src/man/man9s/ddi_dma_cookie.9s +++ b/usr/src/man/man9s/ddi_dma_cookie.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_dma_cookie 9S "30 Sep 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_DMA_COOKIE 9S "Sep 30, 1996" .SH NAME ddi_dma_cookie \- DMA address cookie .SH SYNOPSIS diff --git a/usr/src/man/man9s/ddi_dma_lim_sparc.9s b/usr/src/man/man9s/ddi_dma_lim_sparc.9s index 9f5ae88373..045628502f 100644 --- a/usr/src/man/man9s/ddi_dma_lim_sparc.9s +++ b/usr/src/man/man9s/ddi_dma_lim_sparc.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_dma_lim_sparc 9S "12 Oct 2005" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_DMA_LIM_SPARC 9S "Oct 12, 2005" .SH NAME ddi_dma_lim_sparc, ddi_dma_lim \- SPARC DMA limits structure .SH SYNOPSIS @@ -35,7 +35,7 @@ uint_t dlim_addr_lo; /* low range of 32 bit addressing capability */ uint_t dlim_addr_hi; /* inclusive upper bound of address. capability */ -uint_t dlim_cntr_max; /* inclusive upper bound of +uint_t dlim_cntr_max; /* inclusive upper bound of dma engine address limit * / uint_t dlim_burstsizes; /* binary encoded dma burst sizes */ uint_t dlim_minxfer; /* minimum effective dma xfer size */ @@ -112,13 +112,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityObsolete +Interface Stability Obsolete .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/ddi_dma_lim_x86.9s b/usr/src/man/man9s/ddi_dma_lim_x86.9s index 5e6799c0e7..8ed46c1e13 100644 --- a/usr/src/man/man9s/ddi_dma_lim_x86.9s +++ b/usr/src/man/man9s/ddi_dma_lim_x86.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_dma_lim_x86 9S "12 Oct 2005" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_DMA_LIM_X86 9S "Oct 12, 2005" .SH NAME ddi_dma_lim_x86 \- x86 DMA limits structure .SH SYNOPSIS @@ -38,19 +38,19 @@ should \fInot relax\fR any restrictions imposed by \fBddi_dmae_getlim()\fR. .sp .in +2 .nf -uint_t dlim_addr_lo; /* low range of 32 bit +uint_t dlim_addr_lo; /* low range of 32 bit addressing capability */ -uint_t dlim_addr_hi; /* inclusive upper bound of +uint_t dlim_addr_hi; /* inclusive upper bound of addressing capability */ uint_t dlim_minxfer; /* minimum effective dma transfer size */ uint_t dlim_version; /* version number of structure */ -uint_t dlim_adreg_max; /* inclusive upper bound of +uint_t dlim_adreg_max; /* inclusive upper bound of incrementing addr reg */ uint_t dlim_ctreg_max; /* maximum transfer count minus one */ -uint_t dlim_granular; /* granularity (and min size) of +uint_t dlim_granular; /* granularity (and min size) of transfer count */ short dlim_sgllen; /* length of DMA scatter/gather list */ -uint_t dlim_reqsize; /* maximum transfer size in bytes of +uint_t dlim_reqsize; /* maximum transfer size in bytes of a single I/O */ .fi .in -2 @@ -131,13 +131,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityObsolete +Interface Stability Obsolete .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/ddi_dma_req.9s b/usr/src/man/man9s/ddi_dma_req.9s index f0062f8a41..6bfa49dbcc 100644 --- a/usr/src/man/man9s/ddi_dma_req.9s +++ b/usr/src/man/man9s/ddi_dma_req.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_dma_req 9S "12 Oct 2005" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_DMA_REQ 9S "Oct 12, 2005" .SH NAME ddi_dma_req \- DMA Request structure .SH SYNOPSIS @@ -26,13 +26,13 @@ driver can use it to describe forms of allocations and ways to allocate .sp .in +2 .nf -ddi_dma_lim_t *dmar_limits; /* Caller's dma engine +ddi_dma_lim_t *dmar_limits; /* Caller's dma engine constraints */ -uint_t dmar_flags; /* Contains info for +uint_t dmar_flags; /* Contains info for mapping routines */ int (*dmar_fp)(caddr_t);/* Callback function */ caddr_t dmar_arg; /* Callback function's argument */ -ddi_dma_obj_t dmar_object; /* Descrip. of object +ddi_dma_obj_t dmar_object; /* Descrip. of object to be mapped */ .fi .in -2 @@ -117,12 +117,10 @@ the value set in the structure member \fBdmar_arg\fR. The specified callback function \fBmust\fR return either: .sp .ne 2 -.mk .na \fB\fB0\fR\fR .ad .RS 5n -.rt Indicating that it attempted to allocate a \fBDMA\fR resource but failed to do so, again, in which case the callback function will be put back on a list to be called again later. @@ -130,12 +128,10 @@ called again later. .sp .ne 2 -.mk .na \fB\fB1\fR\fR .ad .RS 5n -.rt Indicating either success at allocating \fBDMA\fR resources or that it no longer wants to retry. .RE @@ -207,13 +203,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityObsolete +Interface Stability Obsolete .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/ddi_dmae_req.9s b/usr/src/man/man9s/ddi_dmae_req.9s index 79f493a064..38b30162f6 100644 --- a/usr/src/man/man9s/ddi_dmae_req.9s +++ b/usr/src/man/man9s/ddi_dmae_req.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_dmae_req 9S "18 Nov 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_DMAE_REQ 9S "Nov 18, 2004" .SH NAME ddi_dmae_req \- DMA engine request structure .SH SYNOPSIS @@ -47,12 +47,10 @@ void*procparms; /* parameter for nextcookie call */ .sp .ne 2 -.mk .na \fB\fBder_command\fR\fR .ad .RS 18n -.rt Specifies what \fBDMA\fR operation is to be performed. The value \fBDMAE_CMD_WRITE\fR signifies that data is to be transferred from memory to the \fBI/O \fRdevice. The value \fBDMAE_CMD_READ\fR signifies that data is to @@ -62,12 +60,10 @@ the driver before calling \fBddi_dmae_prog()\fR. .sp .ne 2 -.mk .na \fB\fBder_bufprocess\fR\fR .ad .RS 18n -.rt On some bus types, a driver can set \fBder_bufprocess\fR to the value \fBDMAE_BUF_CHAIN\fR to specify that multiple \fBDMA\fR cookies will be given to the \fBDMA\fR engine for a single \fBI/O\fR transfer. This action causes a @@ -171,12 +167,10 @@ segment to be a multiple of the device-granularity size. .sp .ne 2 -.mk .na \fB\fBder_path\fR\fR .ad .RS 18n -.rt Specifies the \fBDMA\fR transfer size. The default of zero (\fBDMAE_PATH_DEF\fR) specifies \fBISA\fR compatibility mode. In that mode, channels 0, 1, 2, and 3 are programmed in 8-bit mode (\fBDMAE_PATH_8\fR), and @@ -186,12 +180,10 @@ channels 5, 6, and 7 are programmed in 16-bit, count-by-word mode .sp .ne 2 -.mk .na \fB\fBder_cycles\fR\fR .ad .RS 18n -.rt Specifies the timing mode to be used during \fBDMA\fR data transfers. The default of zero (\fBDMAE_CYCLES_1\fR) specifies \fBISA\fR compatible timing. Drivers using this mode must also specify \fBDMAE_TRANS_SNGL\fR in the @@ -200,12 +192,10 @@ Drivers using this mode must also specify \fBDMAE_TRANS_SNGL\fR in the .sp .ne 2 -.mk .na \fB\fBder_trans\fR\fR .ad .RS 18n -.rt Specifies the bus transfer mode that the \fBDMA\fR engine should expect from the device. The default value of zero (\fBDMAE_TRANS_SNGL\fR) specifies that the device performs one transfer for each bus arbitration cycle. Devices that @@ -222,13 +212,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Architecturex86 +Architecture x86 .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/ddi_fm_error.9s b/usr/src/man/man9s/ddi_fm_error.9s index 21c48c64c1..fd2297e635 100644 --- a/usr/src/man/man9s/ddi_fm_error.9s +++ b/usr/src/man/man9s/ddi_fm_error.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_fm_error 9S "13 May 2007" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_FM_ERROR 9S "May 13, 2007" .SH NAME ddi_fm_error \- I/O error status structure .SH SYNOPSIS @@ -63,47 +63,39 @@ The \fBfme_status\fR indicates current status of an error handler callback or resource handle: .sp .ne 2 -.mk .na \fB\fBDDI_FM_OK\fR\fR .ad .RS 19n -.rt No errors were detected. .RE .sp .ne 2 -.mk .na \fB\fBDDI_FM_FATAL\fR\fR .ad .RS 19n -.rt An error which is considered fatal to the operational state of the system was detected. .RE .sp .ne 2 -.mk .na \fB\fBDDI_FM_NONFATAL\fR\fR .ad .RS 19n -.rt An error which is not considered fatal to the operational state of the system was detected. .RE .sp .ne 2 -.mk .na \fB\fBDDI_FM_UNKNOWN\fR\fR .ad .RS 19n -.rt An error was detected, but the driver was unable to determine the impact of the error on the operational state of the system. .RE @@ -124,13 +116,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/ddi_idevice_cookie.9s b/usr/src/man/man9s/ddi_idevice_cookie.9s index b341179a6d..46dde493a4 100644 --- a/usr/src/man/man9s/ddi_idevice_cookie.9s +++ b/usr/src/man/man9s/ddi_idevice_cookie.9s @@ -3,14 +3,14 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ddi_idevice_cookie 9S "19 Oct 2005" "SunOS 5.11" "Data Structures for Drivers" +.TH DDI_IDEVICE_COOKIE 9S "Oct 19, 2005" .SH NAME ddi_idevice_cookie \- device interrupt cookie .SH SYNOPSIS .LP .nf #include <sys/ddi.h> -#include <sys/sunddi.h> +#include <sys/sunddi.h> .fi .SH INTERFACE LEVEL @@ -48,13 +48,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityObsolete +Interface Stability Obsolete .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/dev_ops.9s b/usr/src/man/man9s/dev_ops.9s index 94b3d6d49b..d657f3046e 100644 --- a/usr/src/man/man9s/dev_ops.9s +++ b/usr/src/man/man9s/dev_ops.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH dev_ops 9S "16 Sep 2008" "SunOS 5.11" "Data Structures for Drivers" +.TH DEV_OPS 9S "Sep 16, 2008" .SH NAME dev_ops \- device operations structure .SH SYNOPSIS @@ -28,134 +28,110 @@ Following are the device functions provided in the device operations structure. All fields must be set at compile time. .sp .ne 2 -.mk .na \fB\fBdevo_rev\fR\fR .ad .RS 17n -.rt Driver build version. Set this to \fBDEVO_REV\fR. .RE .sp .ne 2 -.mk .na \fB\fBdevo_refcnt\fR\fR .ad .RS 17n -.rt Driver reference count. Set this to \fB0\fR. .RE .sp .ne 2 -.mk .na \fB\fBdevo_getinfo\fR\fR .ad .RS 17n -.rt Get device driver information (see \fBgetinfo\fR(9E)). .RE .sp .ne 2 -.mk .na \fB\fBdevo_identify\fR\fR .ad .RS 17n -.rt This entry point is obsolete. Set to \fBnulldev\fR. .RE .sp .ne 2 -.mk .na \fB\fBdevo_probe\fR\fR .ad .RS 17n -.rt Probe device. See \fBprobe\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBdevo_attach\fR\fR .ad .RS 17n -.rt Attach driver to \fBdev_info\fR. See \fBattach\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBdevo_detach\fR\fR .ad .RS 17n -.rt Detach/prepare driver to unload. See \fBdetach\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBdevo_reset\fR\fR .ad .RS 17n -.rt Reset device. (Not supported in this release.) Set this to \fBnodev\fR. .RE .sp .ne 2 -.mk .na \fB\fBdevo_cb_ops\fR\fR .ad .RS 17n -.rt Pointer to \fBcb_ops\fR(9S) structure for leaf drivers. .RE .sp .ne 2 -.mk .na \fB\fBdevo_bus_ops\fR\fR .ad .RS 17n -.rt Pointer to bus operations structure for nexus drivers. Set this to \fINULL\fR if this is for a leaf driver. .RE .sp .ne 2 -.mk .na \fB\fBdevo_power\fR\fR .ad .RS 17n -.rt Power a device attached to system. See \fBpower\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBdevo_quiesce\fR\fR .ad .RS 17n -.rt Quiesce a device attached to system (see \fBquiesce\fR(9E) for more information). This can be set to \fBddi_quiesce_not_needed()\fR if the driver does not need to implement quiesce. diff --git a/usr/src/man/man9s/devmap_callback_ctl.9s b/usr/src/man/man9s/devmap_callback_ctl.9s index 54ddeebbf4..5124226499 100644 --- a/usr/src/man/man9s/devmap_callback_ctl.9s +++ b/usr/src/man/man9s/devmap_callback_ctl.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH devmap_callback_ctl 9S "24 Jul 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH DEVMAP_CALLBACK_CTL 9S "Jul 24, 1996" .SH NAME devmap_callback_ctl \- device mapping-control structure .SH SYNOPSIS @@ -37,23 +37,19 @@ initialize the following fields, if the driver wants the entry points to be called by the system: .sp .ne 2 -.mk .na \fB\fBdevmap_rev\fR \fR .ad .RS 18n -.rt Version number. Set this to \fBDEVMAP_OPS_REV\fR. .RE .sp .ne 2 -.mk .na \fB\fBdevmap_map\fR \fR .ad .RS 18n -.rt Set to the address of the \fBdevmap_map\fR(9E) entry point or to \fINULL\fR if the driver does not support this callback. If set, the system calls the \fBdevmap_map\fR(9E) entry point during the \fBmmap\fR(2) system call. The @@ -63,12 +59,10 @@ return the pointer to the private data structure to the system for later use. .sp .ne 2 -.mk .na \fB\fBdevmap_access\fR \fR .ad .RS 18n -.rt Set to the address of the \fBdevmap_access\fR(9E) entry point or to \fINULL\fR if the driver does not support this callback. If set, the system calls the driver's \fBdevmap_access\fR(9E) entry point during memory access. The system @@ -79,12 +73,10 @@ it returns to the system. .sp .ne 2 -.mk .na \fB\fBdevmap_dup\fR \fR .ad .RS 18n -.rt Set to the address of the \fBdevmap_dup\fR(9E) entry point or to \fINULL\fR if the driver does not support this call. If set, the system calls the \fBdevmap_dup\fR(9E) entry point during the \fBfork\fR(2) system call. @@ -92,12 +84,10 @@ the driver does not support this call. If set, the system calls the .sp .ne 2 -.mk .na \fB\fBdevmap_unmap\fR \fR .ad .RS 18n -.rt Set to the address of the \fBdevmap_unmap\fR(9E) entry point or to \fINULL\fR if the driver does not support this call. If set, the system will call the \fBdevmap_unmap\fR(9E) entry point during the \fBmunmap\fR(2) or \fBexit\fR(2) @@ -109,14 +99,14 @@ system calls. .in +2 .nf int devmap_rev; -int (*devmap_map)(devmap_cookie_t dhp, dev_t dev, +int (*devmap_map)(devmap_cookie_t dhp, dev_t dev, uint_t flags,offset_t off, size_t len, void **pvtp); -int (*devmap_access)(devmap_cookie_t dhp, void *pvtp, +int (*devmap_access)(devmap_cookie_t dhp, void *pvtp, offset_t off, size_t len, uint_t type, uint_t rw); int (*devmap_dup)(devmap_cookie_t dhp, void *pvtp, devmap_cookie_t new_dhp, void **new_pvtp); -void (*devmap_unmap)(devmap_cookie_t dhp, void *pvtp, - offset_t off, size_t len, devmap_cookie_t new_dhp1, +void (*devmap_unmap)(devmap_cookie_t dhp, void *pvtp, + offset_t off, size_t len, devmap_cookie_t new_dhp1, void **new_pvtp1, devmap_cookie_t new_dhp2, void **new_pvtp2); .fi .in -2 diff --git a/usr/src/man/man9s/fmodsw.9s b/usr/src/man/man9s/fmodsw.9s index 0538391bf4..4551dec548 100644 --- a/usr/src/man/man9s/fmodsw.9s +++ b/usr/src/man/man9s/fmodsw.9s @@ -4,14 +4,14 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH fmodsw 9S "14 Nov 2002" "SunOS 5.11" "Data Structures for Drivers" +.TH FMODSW 9S "Nov 14, 2002" .SH NAME fmodsw \- STREAMS module declaration structure .SH SYNOPSIS .LP .nf #include <sys/stream.h> -#include <sys/conf.h> +#include <sys/conf.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/free_rtn.9s b/usr/src/man/man9s/free_rtn.9s index 98a7993d03..978f620f95 100644 --- a/usr/src/man/man9s/free_rtn.9s +++ b/usr/src/man/man9s/free_rtn.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH free_rtn 9S "13 Nov 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH FREE_RTN 9S "Nov 13, 1996" .SH NAME free_rtn \- structure that specifies a driver's message-freeing routine .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/gld_mac_info.9s b/usr/src/man/man9s/gld_mac_info.9s index 980ef515da..f9496356c1 100644 --- a/usr/src/man/man9s/gld_mac_info.9s +++ b/usr/src/man/man9s/gld_mac_info.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH gld_mac_info 9S "7 June 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH GLD_MAC_INFO 9S "Jun 7, 2004" .SH NAME gld_mac_info \- Generic LAN Driver MAC info data structure .SH SYNOPSIS @@ -70,7 +70,7 @@ ddi_iblock_cookie_tgldm_cookie; /* Device's interrupt */ /* block cookie */ int gldm_margin /* accepted data beyond */ /*gldm_maxpkt */ -uint32_t gldm_capabilities; /* Device capabilities */ +uint32_t gldm_capabilities; /* Device capabilities */ .fi .in -2 .sp @@ -81,12 +81,10 @@ Below is a description of the members of the \fBgld_mac_info\fR structure that are visible to the device driver. .sp .ne 2 -.mk .na \fB\fBgldm_private\fR\fR .ad .RS 16n -.rt This structure member is private to the device-specific driver and is not used or modified by GLD. Conventionally, this is used as a pointer to private data, pointing to a driver-defined and driver-allocated per-instance data structure. @@ -101,134 +99,110 @@ structure members, so changes made by the driver after calling \fBgld_register()\fR might cause unpredicted results. .sp .ne 2 -.mk .na \fB\fBgldm_reset\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_start\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_stop\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_set_mac_addr\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_set_multicast\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_set_promiscuous\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_send\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_intr\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_get_stats\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_ioctl\fR\fR .ad .RS 24n -.rt Pointer to driver entry point; can be \fINULL\fR; see \fBgld\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBgldm_ident\fR\fR .ad .RS 24n -.rt Pointer to a string containing a short description of the device. It is used to identify the device in system messages. .RE .sp .ne 2 -.mk .na \fB\fBgldm_type\fR\fR .ad .RS 24n -.rt The type of device the driver handles. The values currently supported by GLD are \fBDL_ETHER\fR (IEEE 802.3 and Ethernet Bus), \fBDL_TPR\fR (IEEE 802.5 Token Passing Ring), and \fBDL_FDDI\fR (ISO 9314-2 Fibre Distributed Data @@ -241,12 +215,10 @@ in a future release of Solaris. .sp .ne 2 -.mk .na \fB\fBgldm_minpkt\fR\fR .ad .RS 24n -.rt Minimum \fIService\fR \fIData\fR \fIUnit\fR size \(em the minimum packet size, not including the MAC header, that the device will transmit. This can be zero if the device-specific driver can handle any required padding. @@ -254,12 +226,10 @@ if the device-specific driver can handle any required padding. .sp .ne 2 -.mk .na \fB\fBgldm_maxpkt\fR\fR .ad .RS 24n -.rt Maximum \fIService\fR \fIData\fR \fIUnit\fR size \(em the maximum size of packet, not including the MAC header, that can be transmitted by the device. For Ethernet, this number is 1500. @@ -267,24 +237,20 @@ For Ethernet, this number is 1500. .sp .ne 2 -.mk .na \fB\fBgldm_addrlen\fR\fR .ad .RS 24n -.rt The length in bytes of physical addresses handled by the device. For Ethernet, Token Ring, and FDDI, the value of this structure member should be 6. .RE .sp .ne 2 -.mk .na \fB\fBgldm_saplen\fR\fR .ad .RS 24n -.rt The length in bytes of the Service Access Point (SAP) address used by the driver. For GLD-based drivers, this should always be set to -2, to indicate that two-byte SAP values are supported and that the SAP appears \fIafter\fR the @@ -294,12 +260,10 @@ DL_INFO_ACK'' in the DLPI specification for more details. .sp .ne 2 -.mk .na \fB\fBgldm_broadcast_addr\fR\fR .ad .RS 24n -.rt Pointer to an array of bytes of length \fBgldm_addrlen\fR containing the broadcast address to be used for transmit. The driver must allocate space to hold the broadcast address, fill it in with the appropriate value, and set @@ -309,12 +273,10 @@ the broadcast address is normally 0xFF-FF-FF-FF-FF-FF. .sp .ne 2 -.mk .na \fB\fBgldm_vendor_addr\fR\fR .ad .RS 24n -.rt Pointer to an array of bytes of length \fBgldm_addrlen\fR containing the vendor-provided network physical address of the device. The driver must allocate space to hold the address, fill it in with information read from the @@ -323,12 +285,10 @@ device, and set \fBgldm_vendor_addr\fR to point at it. .sp .ne 2 -.mk .na \fB\fBgldm_ppa\fR\fR .ad .RS 24n -.rt The Physical Point of Attachment (PPA) number for this instance of the device. Normally this should be set to the instance number, returned from \fBddi_get_instance\fR(9F). @@ -336,23 +296,19 @@ Normally this should be set to the instance number, returned from .sp .ne 2 -.mk .na \fB\fBgldm_devinfo\fR\fR .ad .RS 24n -.rt Pointer to the \fBdev_info\fR node for this device. .RE .sp .ne 2 -.mk .na \fB\fBgldm_cookie\fR\fR .ad .RS 24n -.rt The interrupt block cookie returned by \fBddi_get_iblock_cookie\fR(9F), \fBddi_add_intr\fR(9F), \fBddi_get_soft_iblock_cookie\fR(9F), or \fBddi_add_softintr\fR(9F). This must correspond to the device's receive @@ -361,12 +317,10 @@ interrupt, from which \fBgld_recv()\fR is called. .sp .ne 2 -.mk .na \fB\fBgldm_margin\fR\fR .ad .RS 24n -.rt Drivers set this value to the amount of data in bytes that the device can transmit beyond \fBgldm_maxpkt\fR. For example, if an Ethernet device can handle packets whose payload section is no greater than 1522 bytes and the @@ -377,12 +331,10 @@ reported in acknowledgements of the DLIOCMARGININFO ioctl (see \fBdlpi\fR(7P)). .sp .ne 2 -.mk .na \fB\fBgldm_capabilities\fR\fR .ad .RS 24n -.rt Bit-field of device capabilities. If the device is capable of reporting media link state, the GLD_CAP_LINKSTATE bit should be set. .RE diff --git a/usr/src/man/man9s/gld_stats.9s b/usr/src/man/man9s/gld_stats.9s index 5404b6b18d..d241c017fd 100644 --- a/usr/src/man/man9s/gld_stats.9s +++ b/usr/src/man/man9s/gld_stats.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH gld_stats 9S "7 Jun 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH GLD_STATS 9S "Jun 7, 2004" .SH NAME gld_stats \- Generic LAN Driver statistics data structure .SH SYNOPSIS @@ -133,12 +133,10 @@ Most of the above statistics variables are counters denoting the number of times the particular event was observed. Exceptions are: .sp .ne 2 -.mk .na \fB\fBglds_speed\fR \fR .ad .RS 16n -.rt An estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. @@ -146,12 +144,10 @@ estimation can be made, this object should contain the nominal bandwidth. .sp .ne 2 -.mk .na \fB\fBglds_media\fR \fR .ad .RS 16n -.rt The type of media (wiring) or connector used by the hardware. Currently supported media names include \fBGLDM_AUI\fR, \fBGLDM_BNC\fR, \fBGLDM_TP\fR, \fBGLDM_10BT\fR, \fBGLDM_100BT\fR, \fBGLDM_100BTX\fR, \fBGLDM_100BT4\fR, @@ -161,12 +157,10 @@ supported media names include \fBGLDM_AUI\fR, \fBGLDM_BNC\fR, \fBGLDM_TP\fR, .sp .ne 2 -.mk .na \fB\fBglds_duplex\fR \fR .ad .RS 16n -.rt Current duplex state of the interface. Supported values are \fBGLD_DUPLEX_HALF\fR and \fBGLD_DUPLEX_FULL\fR. \fBGLD_DUPLEX_UNKNOWN\fR can also be specified. diff --git a/usr/src/man/man9s/hook_nic_event.9s b/usr/src/man/man9s/hook_nic_event.9s index a6cf54e7c4..4a40fb6cac 100644 --- a/usr/src/man/man9s/hook_nic_event.9s +++ b/usr/src/man/man9s/hook_nic_event.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH hook_nic_event 9S "1 May 2008" "SunOS 5.11" "Data Structures for Drivers" +.TH HOOK_NIC_EVENT 9S "May 1, 2008" .SH NAME hook_nic_event \- data structure describing events related to network interfaces @@ -33,13 +33,13 @@ A callback may not alter any of the fields in this structure. .sp .in +2 .nf -net_data_t hne_family; -phy_if_t pkt_private; -lif_if_t hne_lif; +net_data_t hne_family; +phy_if_t pkt_private; +lif_if_t hne_lif; nic_event_t hne_event; nic_event_data_t hne_data; size_t hne_datalen; - + .fi .in -2 @@ -48,91 +48,75 @@ size_t hne_datalen; The following fields are set for each event: .sp .ne 2 -.mk .na \fB\fBhne_family\fR\fR .ad .RS 14n -.rt A valid reference for the network protocol that owns this network interface and can be in calls to other \fBnetinfo\fR(9F) functions. .RE .sp .ne 2 -.mk .na \fB\fBhne_nic\fR\fR .ad .RS 14n -.rt The physical interface to which an event belongs. .RE .sp .ne 2 -.mk .na \fB\fBhne_event\fR\fR .ad .RS 14n -.rt A value that indicates the respective event. The current list of available events is: .sp .ne 2 -.mk .na \fB\fBNE_PLUMB\fR\fR .ad .RS 21n -.rt an interface has just been created. .RE .sp .ne 2 -.mk .na \fB\fBNE_UNPLUMB\fR\fR .ad .RS 21n -.rt an interface has just been destroyed and no more events should be received for it. .RE .sp .ne 2 -.mk .na \fB\fBNE_UP\fR\fR .ad .RS 21n -.rt an interface has changed the state to "up" and may now generate packet events. .RE .sp .ne 2 -.mk .na \fB\fBNE_DOWN\fR\fR .ad .RS 21n -.rt an interface has changed the state to "down" and will no longer generate packet events. .RE .sp .ne 2 -.mk .na \fB\fBNE_ADDRESS_CHANGE\fR\fR .ad .RS 21n -.rt an address on an interface has changed. \fBhne_lif\fR refers to the logical interface for which the change is occurring, \fBhne_data\fR is a pointer to a \fBsockaddr\fR structure that is \fBhne_datalen\fR bytes long and contains the @@ -149,13 +133,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/hook_pkt_event.9s b/usr/src/man/man9s/hook_pkt_event.9s index ab91ecafc0..0ef9c67e02 100644 --- a/usr/src/man/man9s/hook_pkt_event.9s +++ b/usr/src/man/man9s/hook_pkt_event.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH hook_pkt_event 9S "1 May 2008" "SunOS 5.11" "Data Structures for Drivers" +.TH HOOK_PKT_EVENT 9S "May 1, 2008" .SH NAME hook_pkt_event \- packet event structure passed through to hooks .SH SYNOPSIS @@ -51,7 +51,7 @@ NH_LOOPBACK_OUT yes yes yes yes .sp .in +2 .nf -net_data_t hne_family; +net_data_t hne_family; phy_if_t hpe_ifp; phy_if_t hpe_ofp; void *hpe_hdr; @@ -59,7 +59,7 @@ mblk_t *hpe_mp; mblk_t *hpe_mb; uint32_t hpe_flags; - + .fi .in -2 @@ -68,91 +68,75 @@ uint32_t hpe_flags; The following fields are set for each event: .sp .ne 2 -.mk .na \fB\fBhne_family\fR\fR .ad .RS 14n -.rt The protocol family for this packet. This value matches the corresponding value returned from a call to \fBnet_protocol_lookup\fR(9F). .RE .sp .ne 2 -.mk .na \fB\fBhpe_ifp\fR\fR .ad .RS 14n -.rt The inbound interface for a packet. .RE .sp .ne 2 -.mk .na \fB\fBhpe_ofp\fR\fR .ad .RS 14n -.rt The outbound interface for a packet. .RE .sp .ne 2 -.mk .na \fB\fBhpe_hdr\fR\fR .ad .RS 14n -.rt Pointer to the start of the network protocol header within an \fBmblk_t\fR structure. .RE .sp .ne 2 -.mk .na \fB\fBhpe_mp\fR\fR .ad .RS 14n -.rt Pointer to the \fBmblk_t\fR pointer that points to the first \fBmblk_t\fR structure in this packet. .RE .sp .ne 2 -.mk .na \fB\fBhpe_mb\fR\fR .ad .RS 14n -.rt Pointer to the \fBmblk_t\fR structure that contains \fBhpe_hdr\fR. .RE .sp .ne 2 -.mk .na \fB\fBhpe_flags\fR\fR .ad .RS 13n -.rt This field is used to carry additional properties of packets. The current collection of defined bits available is: .sp .ne 2 -.mk .na \fB\fBHPE_BROADCAST\fR\fR .ad .RS 17n -.rt This bit is set if the packet was recognized as a broadcast packet from the link layer. The bit cannot be set if \fBHPE_MULTICAST\fR is set, currently only possible with physical in packet events. @@ -160,12 +144,10 @@ possible with physical in packet events. .sp .ne 2 -.mk .na \fB\fBHPE_MULTICAST\fR\fR .ad .RS 17n -.rt This set if the packet was recognized as a multicast packet from the link layer. This bit cannot be set if \fBHPE_BROADCAST\fR is set, currently only possible with physical in packet events. @@ -181,13 +163,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/hook_t.9s b/usr/src/man/man9s/hook_t.9s index 0c51da7308..b8abef07a5 100644 --- a/usr/src/man/man9s/hook_t.9s +++ b/usr/src/man/man9s/hook_t.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH hook_t 9S "1 May 2008" "SunOS 5.11" "Data Structures for Drivers" +.TH HOOK_T 9S "May 1, 2008" .SH NAME hook_t \- callback structure for subscribing to netinfo events .SH SYNOPSIS @@ -33,8 +33,8 @@ hook_hint_t h_hint; /* insertion hint type */ uintptr_t h_hintvalue; /* used with h_hint */ void *h_arg; /* value to pass into h_func */ -typedef int (*hook_func_t)(net_event_t token, hook_data_t info, - void *); +typedef int (*hook_func_t)(net_event_t token, hook_data_t info, + void *); .fi .in -2 @@ -46,57 +46,47 @@ that enforce where a hook lives for its entire lifetime on an event. The valid values for the \fBh_hint\fR field are: .sp .ne 2 -.mk .na \fB\fBHH_NONE\fR\fR .ad .RS 13n -.rt Insert the hook wherever convenient. .RE .sp .ne 2 -.mk .na \fB\fBHH_FIRST\fR\fR .ad .RS 13n -.rt Place the hook first on the list of hooks. .RE .sp .ne 2 -.mk .na \fB\fBHH_LAST\fR\fR .ad .RS 13n -.rt Place the hook last on the list of hooks. .RE .sp .ne 2 -.mk .na \fB\fBHH_BEFORE\fR\fR .ad .RS 13n -.rt Place the hook before another hook on the list of hooks. The value in \fBh_hintvalue\fR must be a pointer to the name of another hook. .RE .sp .ne 2 -.mk .na \fB\fBHH_AFTER\fR\fR .ad .RS 13n -.rt Place the hook after another hook on the list of hooks. The value in \fBh_hintvalue\fR must be a pointer to the name of another hook. .RE @@ -109,13 +99,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/iocblk.9s b/usr/src/man/man9s/iocblk.9s index 6366aa5f08..d73f5fdb4e 100644 --- a/usr/src/man/man9s/iocblk.9s +++ b/usr/src/man/man9s/iocblk.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH iocblk 9S "13 Nov 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH IOCBLK 9S "Nov 13, 1996" .SH NAME iocblk \- STREAMS data structure for the M_IOCTL message type .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/iovec.9s b/usr/src/man/man9s/iovec.9s index fe4ac10923..fffed62e67 100644 --- a/usr/src/man/man9s/iovec.9s +++ b/usr/src/man/man9s/iovec.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH iovec 9S "11 Apr 1991" "SunOS 5.11" "Data Structures for Drivers" +.TH IOVEC 9S "Apr 11, 1991" .SH NAME iovec \- data storage structure for I/O using uio .SH SYNOPSIS .LP .nf -#include <sys/uio.h> +#include <sys/uio.h> .fi .SH INTERFACE LEVEL @@ -28,7 +28,7 @@ and length specification. .in +2 .nf caddr_t iov_base; /* base address of the data storage area */ - /* represented by the iovec structure */ + /* represented by the iovec structure */ int iov_len; /* size of the data storage area in bytes */ .fi .in -2 diff --git a/usr/src/man/man9s/kstat.9s b/usr/src/man/man9s/kstat.9s index 5365d81cdb..9c0b351035 100644 --- a/usr/src/man/man9s/kstat.9s +++ b/usr/src/man/man9s/kstat.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH kstat 9S "4 Apr 1994" "SunOS 5.11" "Data Structures for Drivers" +.TH KSTAT 9S "Apr 4, 1994" .SH NAME kstat \- kernel statistics structure .SH SYNOPSIS @@ -39,12 +39,12 @@ before calling \fBkstat_install\fR(9F) to actually export the \fBkstat\fR. .in +2 .nf void *ks_data; /* kstat type-specif. data */ -ulong_t ks_ndata; /* # of type-specif. data +ulong_t ks_ndata; /* # of type-specif. data records */ -ulong_t ks_data_size; /* total size of kstat data +ulong_t ks_data_size; /* total size of kstat data section */ int (*ks_update)(struct kstat *, int); -void *ks_private; /* arbitrary provider-private +void *ks_private; /* arbitrary provider-private data */ void *ks_lock; /* protects kstat's data */ .fi @@ -56,12 +56,10 @@ The members of the \fBkstat\fR structure available to examine or set by a driver are as follows: .sp .ne 2 -.mk .na \fB\fBks_data\fR \fR .ad .RS 17n -.rt Points to the data portion of the \fBkstat\fR. Either allocated by \fBkstat_create\fR(9F) for the drivers use, or by the driver if it is using virtual \fBkstat\fRs. @@ -69,36 +67,30 @@ virtual \fBkstat\fRs. .sp .ne 2 -.mk .na \fB\fBks_ndata\fR \fR .ad .RS 17n -.rt The number of data records in this \fBkstat\fR. Set by the \fBks_update\fR(9E) routine. .RE .sp .ne 2 -.mk .na \fB\fBks_data_size\fR \fR .ad .RS 17n -.rt The amount of data pointed to by \fBks_data\fR. Set by the \fBks_update\fR(9E) routine. .RE .sp .ne 2 -.mk .na \fB\fBks_update\fR \fR .ad .RS 17n -.rt Pointer to a routine that dynamically updates \fBkstat\fR. This is useful for drivers where the underlying device keeps cheap hardware statistics, but where extraction is expensive. Instead of constantly keeping the \fBkstat\fR data @@ -109,23 +101,19 @@ feature, set the \fBks_update\fR field before calling \fBkstat_install\fR(9F). .sp .ne 2 -.mk .na \fB\fBks_private\fR \fR .ad .RS 17n -.rt Is a private field for the driver's use. Often used in \fBks_update\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBks_lock\fR \fR .ad .RS 17n -.rt Is a pointer to a mutex that protects this \fBkstat\fR. \fBkstat\fR data sections are optionally protected by the per-\fBkstat\fR \fBks_lock\fR. If \fBks_lock\fR is non-\fINULL\fR, \fBkstat\fR clients (such as \fB/dev/kstat\fR) diff --git a/usr/src/man/man9s/kstat_intr.9s b/usr/src/man/man9s/kstat_intr.9s index 2fd923f4b9..8d8ae79097 100644 --- a/usr/src/man/man9s/kstat_intr.9s +++ b/usr/src/man/man9s/kstat_intr.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH kstat_intr 9S "4 Apr 1994" "SunOS 5.11" "Data Structures for Drivers" +.TH KSTAT_INTR 9S "Apr 4, 1994" .SH NAME kstat_intr \- structure for interrupt kstats .SH SYNOPSIS @@ -69,56 +69,46 @@ based on the type of interrupt condition. The following indexes are supported: .sp .ne 2 -.mk .na \fB\fBKSTAT_INTR_HARD\fR \fR .ad .RS 24n -.rt Hard interrupt .RE .sp .ne 2 -.mk .na \fB\fBKSTAT_INTR_SOFT\fR \fR .ad .RS 24n -.rt Soft interrupt .RE .sp .ne 2 -.mk .na \fB\fBKSTAT_INTR_WATCHDOG\fR \fR .ad .RS 24n -.rt Watchdog interrupt .RE .sp .ne 2 -.mk .na \fB\fBKSTAT_INTR_SPURIOUS\fR \fR .ad .RS 24n -.rt Spurious interrupt .RE .sp .ne 2 -.mk .na \fB\fBKSTAT_INTR_MULTSVC\fR \fR .ad .RS 24n -.rt Multiple service interrupt .RE diff --git a/usr/src/man/man9s/kstat_io.9s b/usr/src/man/man9s/kstat_io.9s index a28378153a..b23d98aed7 100644 --- a/usr/src/man/man9s/kstat_io.9s +++ b/usr/src/man/man9s/kstat_io.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH kstat_io 9S "4 Apr 1994" "SunOS 5.11" "Data Structures for Drivers" +.TH KSTAT_IO 9S "Apr 4, 1994" .SH NAME kstat_io \- structure for I/O kstats .SH SYNOPSIS diff --git a/usr/src/man/man9s/kstat_named.9s b/usr/src/man/man9s/kstat_named.9s index 4efc473497..0285fc7d08 100644 --- a/usr/src/man/man9s/kstat_named.9s +++ b/usr/src/man/man9s/kstat_named.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH kstat_named 9S "4 Apr 1994" "SunOS 5.11" "Data Structures for Drivers" +.TH KSTAT_NAMED 9S "Apr 4, 1994" .SH NAME kstat_named \- structure for named kstats .SH SYNOPSIS @@ -34,10 +34,10 @@ be allocated. The structures are returned as an array pointed to by the union { char c[16]; long l; - ulong_t ul; + ulong_t ul; longlong_t ll; u_longlong_t ull; -} value; /* value of counter */ +} value; /* value of counter */ .fi .in -2 diff --git a/usr/src/man/man9s/linkblk.9s b/usr/src/man/man9s/linkblk.9s index de3f5bcc79..d85cfc6488 100644 --- a/usr/src/man/man9s/linkblk.9s +++ b/usr/src/man/man9s/linkblk.9s @@ -3,14 +3,14 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH linkblk 9S "7 Jul 1994" "SunOS 5.11" "Data Structures for Drivers" +.TH LINKBLK 9S "Jul 7, 1994" .SH NAME linkblk \- STREAMS data structure sent to multiplexor drivers to indicate a link .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/modldrv.9s b/usr/src/man/man9s/modldrv.9s index ffe222e8f6..375c594deb 100644 --- a/usr/src/man/man9s/modldrv.9s +++ b/usr/src/man/man9s/modldrv.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH modldrv 9S "5 Mar 2001" "SunOS 5.11" "Data Structures for Drivers" +.TH MODLDRV 9S "Mar 5, 2001" .SH NAME modldrv \- linkage structure for loadable drivers .SH SYNOPSIS .LP .nf -#include <sys/modctl.h> +#include <sys/modctl.h> .fi .SH INTERFACE LEVEL @@ -25,32 +25,28 @@ information to the kernel. .sp .in +2 .nf -struct mod_ops *drv_modops; -char *drv_linkinfo; +struct mod_ops *drv_modops; +char *drv_linkinfo; struct dev_ops *drv_dev_ops; .fi .in -2 .sp .ne 2 -.mk .na \fB\fBdrv_modops\fR \fR .ad .RS 17n -.rt Must always be initialized to the address of \fBmod_driverops\fR. This member identifies the module as a loadable driver. .RE .sp .ne 2 -.mk .na \fB\fBdrv_linkinfo\fR \fR .ad .RS 17n -.rt Can be any string up to \fBMODMAXNAMELEN\fR characters (including the terminating NULL character), and is used to describe the module and its version number. This is usually the name of the driver and module version information, @@ -59,12 +55,10 @@ but can contain other information as well. .sp .ne 2 -.mk .na \fB\fBdrv_dev_ops\fR \fR .ad .RS 17n -.rt Pointer to the driver's \fBdev_ops\fR(9S) structure. .RE diff --git a/usr/src/man/man9s/modlinkage.9s b/usr/src/man/man9s/modlinkage.9s index 5cc116d1a7..99de328aa7 100644 --- a/usr/src/man/man9s/modlinkage.9s +++ b/usr/src/man/man9s/modlinkage.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH modlinkage 9S "18 Sep 1992" "SunOS 5.11" "Data Structures for Drivers" +.TH MODLINKAGE 9S "Sep 18, 1992" .SH NAME modlinkage \- module linkage structure .SH SYNOPSIS .LP .nf -#include <sys/modctl.h> +#include <sys/modctl.h> .fi .SH INTERFACE LEVEL @@ -33,24 +33,20 @@ void *ml_linkage[4]; .sp .ne 2 -.mk .na \fB\fBml_rev\fR \fR .ad .RS 15n -.rt Is the revision of the loadable modules system. This must have the value \fBMODREV_1\fR . .RE .sp .ne 2 -.mk .na \fB\fBml_linkage\fR \fR .ad .RS 15n -.rt Is a null-terminated array of pointers to linkage structures. Driver modules have only one linkage structure. .RE diff --git a/usr/src/man/man9s/modlmisc.9s b/usr/src/man/man9s/modlmisc.9s index 09616d1a47..5ab74808cf 100644 --- a/usr/src/man/man9s/modlmisc.9s +++ b/usr/src/man/man9s/modlmisc.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH modlmisc 9S "6 Nov 2007" "SunOS 5.11" "Data Structures for Drivers" +.TH MODLMISC 9S "Nov 6, 2007" .SH NAME modlmisc \- linkage structure for loadable miscellaneous modules .SH SYNOPSIS @@ -25,31 +25,27 @@ specific information to the kernel. .sp .in +2 .nf -struct mod_ops *misc_modops; -char *misc_linkinfo; +struct mod_ops *misc_modops; +char *misc_linkinfo; .fi .in -2 .sp .ne 2 -.mk .na \fB\fBmisc_modops\fR\fR .ad .RS 17n -.rt Must always be initialized to the address of \fBmod_miscops\fR. This member identifies the module as a loadable miscellaneous module. .RE .sp .ne 2 -.mk .na \fB\fBmisc_linkinfo\fR\fR .ad .RS 17n -.rt Can be any string up to \fBMODMAXNAMELEN\fR characters (including the terminating \fBNULL\fR characters), and is used to describe the module, but can also contain other information (such as a version number). diff --git a/usr/src/man/man9s/modlstrmod.9s b/usr/src/man/man9s/modlstrmod.9s index 47380e83b8..37748a6645 100644 --- a/usr/src/man/man9s/modlstrmod.9s +++ b/usr/src/man/man9s/modlstrmod.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH modlstrmod 9S "7 Jun 1993" "SunOS 5.11" "Data Structures for Drivers" +.TH MODLSTRMOD 9S "Jun 7, 1993" .SH NAME modlstrmod \- linkage structure for loadable STREAMS modules .SH SYNOPSIS .LP .nf -#include <sys/modctl.h> +#include <sys/modctl.h> .fi .SH INTERFACE LEVEL @@ -25,32 +25,28 @@ specific information to the kernel. .sp .in +2 .nf -struct mod_ops *strmod_modops; -char *strmod_linkinfo; +struct mod_ops *strmod_modops; +char *strmod_linkinfo; struct fmodsw *strmod_fmodsw; .fi .in -2 .sp .ne 2 -.mk .na \fB\fBstrmod_modops\fR \fR .ad .RS 20n -.rt Must always be initialized to the address of \fBmod_strmodops\fR. This identifies the module as a loadable STREAMS module. .RE .sp .ne 2 -.mk .na \fB\fBstrmod_linkinfo\fR \fR .ad .RS 20n -.rt Can be any string up to \fBMODMAXNAMELEN\fR, and is used to describe the module. This string is usually the name of the module, but can contain other information (such as a version number). @@ -58,12 +54,10 @@ information (such as a version number). .sp .ne 2 -.mk .na \fB\fBstrmod_fmodsw\fR \fR .ad .RS 20n -.rt Is a pointer to a template of a class entry within the module that is copied to the kernel's class table when the module is loaded. .RE diff --git a/usr/src/man/man9s/module_info.9s b/usr/src/man/man9s/module_info.9s index bf40b3ce38..cb58fd2cc7 100644 --- a/usr/src/man/man9s/module_info.9s +++ b/usr/src/man/man9s/module_info.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH module_info 9S "26 Nov 2002" "SunOS 5.11" "Data Structures for Drivers" +.TH MODULE_INFO 9S "Nov 26, 2002" .SH NAME module_info \- STREAMS driver identification and limit value structure .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/msgb.9s b/usr/src/man/man9s/msgb.9s index e0d5d50669..975b6ee756 100644 --- a/usr/src/man/man9s/msgb.9s +++ b/usr/src/man/man9s/msgb.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH msgb 9S "11 Apr 1991" "SunOS 5.11" "Data Structures for Drivers" +.TH MSGB 9S "Apr 11, 1991" .SH NAME msgb, mblk \- STREAMS message block structure .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL @@ -49,23 +49,19 @@ unsigned short b_flag; /* used by stream head */ Valid flags are as follows: .sp .ne 2 -.mk .na \fB\fBMSGMARK\fR \fR .ad .RS 13n -.rt Last byte of message is marked. .RE .sp .ne 2 -.mk .na \fB\fBMSGDELIM\fR \fR .ad .RS 13n -.rt Message is delimited. .RE diff --git a/usr/src/man/man9s/net_inject_t.9s b/usr/src/man/man9s/net_inject_t.9s index 148a13733a..c787626a60 100644 --- a/usr/src/man/man9s/net_inject_t.9s +++ b/usr/src/man/man9s/net_inject_t.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH net_inject_t 9S "1 May 2008" "SunOS 5.11" "Data Structures for Drivers" +.TH NET_INJECT_T 9S "May 1, 2008" .SH NAME net_inject_t \- structure for describing how to transmit a packet .SH SYNOPSIS @@ -34,23 +34,19 @@ the system as well as out of it. .sp .ne 2 -.mk .na \fB\fBni_packet\fR\fR .ad .RS 15n -.rt Pointer to the first the \fBmblk_t\fR data structure that makes up this packet. .RE .sp .ne 2 -.mk .na \fB\fBni_addr\fR\fR .ad .RS 15n -.rt This field is only required to be initialized if \fBNI_DIRECT_OUT\fR is being used to transmit the packet. The \fBsockaddr_storage\fR field must be set to indicate whether the destination address contained in the structure is @@ -60,12 +56,10 @@ indicate whether the destination address contained in the structure is .sp .ne 2 -.mk .na \fB\fBni_physical\fR\fR .ad .RS 15n -.rt The physical interface where the packet will be injected. .RE @@ -77,13 +71,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/net_instance_t.9s b/usr/src/man/man9s/net_instance_t.9s index 8a187f356d..956bbcdb3a 100644 --- a/usr/src/man/man9s/net_instance_t.9s +++ b/usr/src/man/man9s/net_instance_t.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH net_instance_t 9S "1 May 2008" "SunOS 5.11" "Data Structures for Drivers" +.TH NET_INSTANCE_T 9S "May 1, 2008" .SH NAME net_instance_t \- packet event structure passed through to hooks .SH SYNOPSIS @@ -38,45 +38,37 @@ identify each instance of \fBIP\fR. .sp .ne 2 -.mk .na \fB\fBnin_name\fR\fR .ad .RS 16n -.rt Name of the owner of the instance. .RE .sp .ne 2 -.mk .na \fB\fBnin_create\fR\fR .ad .RS 16n -.rt Function to be called when a new instance of \fBIP\fR is created. .RE .sp .ne 2 -.mk .na \fB\fBnin_destroy\fR\fR .ad .RS 16n -.rt Function to be called when an instance of \fBIP\fR is being destroyed. .RE .sp .ne 2 -.mk .na \fB\fBnin_shutdown\fR\fR .ad .RS 16n -.rt Function to be called when an instance of \fBIP\fR is being shutdown. \fBnin_shutdown()\fR is called before \fBnin_destroy()\fR is called. .RE @@ -89,13 +81,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/qband.9s b/usr/src/man/man9s/qband.9s index 0cb0da9408..1dc13c88a8 100644 --- a/usr/src/man/man9s/qband.9s +++ b/usr/src/man/man9s/qband.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH qband 9S "14 Nov 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH QBAND 9S "Nov 14, 1996" .SH NAME qband \- STREAMS queue flow control information structure .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL @@ -44,23 +44,19 @@ uint_t qb_flag; /* see below */ Valid flags are as follows: .sp .ne 2 -.mk .na \fB\fBQB_FULL\fR \fR .ad .RS 13n -.rt Band is considered full. .RE .sp .ne 2 -.mk .na \fB\fBQB_WANTW\fR \fR .ad .RS 13n -.rt Someone wants to write to band. .RE diff --git a/usr/src/man/man9s/qinit.9s b/usr/src/man/man9s/qinit.9s index 8bb2d4a85a..0f9cda2f60 100644 --- a/usr/src/man/man9s/qinit.9s +++ b/usr/src/man/man9s/qinit.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH qinit 9S "11 Apr 1991" "SunOS 5.11" "Data Structures for Drivers" +.TH QINIT 9S "Apr 11, 1991" .SH NAME qinit \- STREAMS queue processing procedures structure .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/queclass.9s b/usr/src/man/man9s/queclass.9s index ea483db78a..d5021d73a4 100644 --- a/usr/src/man/man9s/queclass.9s +++ b/usr/src/man/man9s/queclass.9s @@ -4,14 +4,14 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH queclass 9S "07 Mar 1994" "SunOS 5.11" "Data Structures for Drivers" +.TH QUECLASS 9S "Mar 07, 1994" .SH NAME queclass \- a STREAMS macro that returns the queue message class definitions for a given message block .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> \fB\fR\fBqueclass\fR(\fBmblk_t *\fR\fIbp\fR); .fi diff --git a/usr/src/man/man9s/queue.9s b/usr/src/man/man9s/queue.9s index fa672b7672..12d008d08b 100644 --- a/usr/src/man/man9s/queue.9s +++ b/usr/src/man/man9s/queue.9s @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH queue 9S "10 Jan 2006" "SunOS 5.11" "Data Structures for Drivers" +.TH QUEUE 9S "Jan 10, 2006" .SH NAME queue \- STREAMS queue structure .SH SYNOPSIS @@ -56,78 +56,64 @@ fields and the \fBq_next\fR values are detailed in the following sections. The \fBq_flag\fR field must be used only to check the following flag values. .sp .ne 2 -.mk .na \fB\fBQFULL\fR\fR .ad .RS 10n -.rt Queue is full. .RE .sp .ne 2 -.mk .na \fB\fBQREADR\fR\fR .ad .RS 10n -.rt Queue is used for upstream (read-side) processing. .RE .sp .ne 2 -.mk .na \fB\fBQUSE\fR\fR .ad .RS 10n -.rt Queue has been allocated. .RE .sp .ne 2 -.mk .na \fB\fBQENAB\fR\fR .ad .RS 10n -.rt Queue has been enabled for service by \fBqenable\fR(9F). .RE .sp .ne 2 -.mk .na \fB\fBQNOENB\fR\fR .ad .RS 10n -.rt Queue will not be scheduled for service by \fBputq\fR(9F). .RE .sp .ne 2 -.mk .na \fB\fBQWANTR\fR\fR .ad .RS 10n -.rt Upstream processing element wants to read from queue. .RE .sp .ne 2 -.mk .na \fB\fBQWANTW\fR\fR .ad .RS 10n -.rt Downstream processing element wants to write to queue. .RE diff --git a/usr/src/man/man9s/scsi_address.9s b/usr/src/man/man9s/scsi_address.9s index cf2d6f38fd..48b19e85f1 100644 --- a/usr/src/man/man9s/scsi_address.9s +++ b/usr/src/man/man9s/scsi_address.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_address 9S "30 Aug 1995" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_ADDRESS 9S "Aug 30, 1995" .SH NAME scsi_address \- SCSI address structure .SH SYNOPSIS .LP .nf -#include <sys/scsi/scsi.h> +#include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/scsi_arq_status.9s b/usr/src/man/man9s/scsi_arq_status.9s index 5792eca23a..af8e207b71 100644 --- a/usr/src/man/man9s/scsi_arq_status.9s +++ b/usr/src/man/man9s/scsi_arq_status.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_arq_status 9S "30 Sep 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_ARQ_STATUS 9S "Sep 30, 1996" .SH NAME scsi_arq_status \- SCSI auto request sense structure .SH SYNOPSIS .LP .nf -#include <sys/scsi/scsi.h> +#include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL @@ -33,7 +33,7 @@ sense data. .in +2 .nf struct scsi_status sts_status; /* SCSI status */ -struct scsi_status sts_rqpkt_status; /* SCSI status of +struct scsi_status sts_rqpkt_status; /* SCSI status of request sense cmd */ uchar_t sts_rqpkt_reason; /* reason completion */ uchar_t sts_rqpkt_resid; /* residue */ diff --git a/usr/src/man/man9s/scsi_asc_key_strings.9s b/usr/src/man/man9s/scsi_asc_key_strings.9s index 7fd323e05b..ec63989f70 100644 --- a/usr/src/man/man9s/scsi_asc_key_strings.9s +++ b/usr/src/man/man9s/scsi_asc_key_strings.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_asc_key_strings 9S "24 Feb 1998" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_ASC_KEY_STRINGS 9S "Feb 24, 1998" .SH NAME scsi_asc_key_strings \- SCSI ASC ASCQ to message structure .SH SYNOPSIS diff --git a/usr/src/man/man9s/scsi_device.9s b/usr/src/man/man9s/scsi_device.9s index 3a5499fdf5..3deef975ed 100644 --- a/usr/src/man/man9s/scsi_device.9s +++ b/usr/src/man/man9s/scsi_device.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_device 9S "19 Feb 1993" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_DEVICE 9S "Feb 19, 1993" .SH NAME scsi_device \- SCSI device structure .SH SYNOPSIS @@ -36,7 +36,7 @@ kmutex_t sd_mutex; /* Mutex for this dev. */ struct scsi_inquiry *sd_inq; /* scsi_inquiry data struc. */ struct scsi_extended_sense *sd_sense; /* Optional request */ /* sense buffer ptr */ -caddr_t sd_private; /* Target drivers +caddr_t sd_private; /* Target drivers private data */ .fi .in -2 diff --git a/usr/src/man/man9s/scsi_extended_sense.9s b/usr/src/man/man9s/scsi_extended_sense.9s index 34d7bc81ca..3ee1af1510 100644 --- a/usr/src/man/man9s/scsi_extended_sense.9s +++ b/usr/src/man/man9s/scsi_extended_sense.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_extended_sense 9S "30 Aug 1995" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_EXTENDED_SENSE 9S "Aug 30, 1995" .SH NAME scsi_extended_sense \- SCSI extended sense structure .SH SYNOPSIS @@ -82,7 +82,6 @@ match the logical block length of the data on the medium. condition. The following sense keys are defined: .sp .ne 2 -.mk .na \fB\fBKEY_NO_SENSE\fR \fR .ad @@ -93,7 +92,6 @@ Indicates that there is no specific sense key information to be reported. .sp .ne 2 -.mk .na \fB\fBKEY_RECOVERABLE_ERROR\fR \fR .ad @@ -105,7 +103,6 @@ action performed by the target. .sp .ne 2 -.mk .na \fB\fBKEY_NOT_READY\fR \fR .ad @@ -116,7 +113,6 @@ Indicates that the logical unit addressed cannot be accessed. .sp .ne 2 -.mk .na \fB\fBKEY_MEDIUM_ERROR\fR \fR .ad @@ -128,7 +124,6 @@ was probably caused by a flaw on the medium or an error in the recorded data. .sp .ne 2 -.mk .na \fB\fBKEY_HARDWARE_ERROR\fR \fR .ad @@ -140,7 +135,6 @@ performing the command or during a self test. .sp .ne 2 -.mk .na \fB\fBKEY_ILLEGAL_REQUEST\fR \fR .ad @@ -152,7 +146,6 @@ additional parameters supplied as data for some commands. .sp .ne 2 -.mk .na \fB\fBKEY_UNIT_ATTENTION\fR \fR .ad @@ -164,7 +157,6 @@ been reset. .sp .ne 2 -.mk .na \fB\fBKEY_WRITE_PROTECT/KEY_DATA_PROTECT\fR \fR .ad @@ -176,7 +168,6 @@ block that is protected from this operation. .sp .ne 2 -.mk .na \fB\fBKEY_BLANK_CHECK\fR \fR .ad @@ -189,7 +180,6 @@ write-once device encountered a non-blank medium while writing. .sp .ne 2 -.mk .na \fB\fBKEY_VENDOR_UNIQUE\fR \fR .ad @@ -200,7 +190,6 @@ This sense key is available for reporting vendor-specific conditions. .sp .ne 2 -.mk .na \fB\fBKEY_COPY_ABORTED\fR \fR .ad @@ -212,7 +201,6 @@ was aborted. .sp .ne 2 -.mk .na \fB\fBKEY_ABORTED_COMMAND\fR \fR .ad @@ -223,7 +211,6 @@ Indicates that the target aborted the command. .sp .ne 2 -.mk .na \fB\fBKEY_EQUAL\fR \fR .ad @@ -235,7 +222,6 @@ comparison. .sp .ne 2 -.mk .na \fB\fBKEY_VOLUME_OVERFLOW\fR \fR .ad @@ -247,7 +233,6 @@ and data might remain in the buffer that has not been written to the medium. .sp .ne 2 -.mk .na \fB\fBKEY_MISCOMPARE\fR \fR .ad @@ -258,7 +243,6 @@ Indicates that the source data did not match the data read from the medium. .sp .ne 2 -.mk .na \fB\fBKEY_RESERVE\fR \fR .ad diff --git a/usr/src/man/man9s/scsi_hba_tran.9s b/usr/src/man/man9s/scsi_hba_tran.9s index d357de164d..b886a06c4e 100644 --- a/usr/src/man/man9s/scsi_hba_tran.9s +++ b/usr/src/man/man9s/scsi_hba_tran.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_hba_tran 9S "30 May 2006" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_HBA_TRAN 9S "May 30, 2006" .SH NAME scsi_hba_tran \- SCSI Host Bus Adapter (HBA) driver transport vector structure .SH SYNOPSIS @@ -29,79 +29,73 @@ executed. dev_info_t *tran_hba_dip; /* HBAs dev_info pointer */ void *tran_hba_private; /* HBA softstate */ -void *tran_tgt_private; /* HBA target private +void *tran_tgt_private; /* HBA target private pointer */ struct scsi_device *tran_sd; /* scsi_device */ int (*tran_tgt_init)( ); /* Transport target */ Initialization */ -int (*tran_tgt_probe)( ); /* Transport target +int (*tran_tgt_probe)( ); /* Transport target probe */ -void (*tran_tgt_free)( ); /* Transport target +void (*tran_tgt_free)( ); /* Transport target free */ int (*tran_start)( ); /* Transport start */ int (*tran_reset)( ); /* Transport reset */ int (*tran_abort)( ); /* Transport abort */ -int (*tran_getcap)( ); /* Capability +int (*tran_getcap)( ); /* Capability retrieval */ -int (*tran_setcap)( ); /* Capability +int (*tran_setcap)( ); /* Capability establishment */ -struct scsi_pkt *(*tran_init_pkt)( ); /* Packet and DMA +struct scsi_pkt *(*tran_init_pkt)( ); /* Packet and DMA allocation */ void (*tran_destroy_pkt)( ); /* Packet and DMA */ deallocation */ void (*tran_dmafree)( ); /* DMA deallocation */ void (*tran_sync_pkt)( ); /* Sync DMA */ -void (*tran_reset_notify)( );/* Bus reset +void (*tran_reset_notify)( );/* Bus reset notification */ int (*tran_bus_reset)( ); /* Reset bus only */ int (*tran_quiesce)( ); /* Quiesce a bus */ int (*tran_unquiesce)( ); /* Unquiesce a bus */ -int (*tran_setup_pkt)( ); /* Initialization +int (*tran_setup_pkt)( ); /* Initialization for pkt */ int (*tran_teardown_pkt)( );/* Deallocation */ int (*tran_pkt_constructor) ( ); /* Constructor */ int (*tran_pkt_destructor) ( ); /* Destructor */ -int tran_hba_len; /* # bytes for +int tran_hba_len; /* # bytes for pkt_ha_private */ -int tran_interconnect_type; /* transport +int tran_interconnect_type; /* transport interconnect */ .fi .in -2 .sp .ne 2 -.mk .na \fB\fBtran_hba_dip\fR\fR .ad .RS 26n -.rt \fBdev_info\fR pointer to the \fBHBA\fR that supplies the \fBscsi_hba_tran\fR structure. .RE .sp .ne 2 -.mk .na \fB\fBtran_hba_private\fR\fR .ad .RS 26n -.rt Private pointer that the \fBHBA\fR driver can use to refer to the device's soft state structure. .RE .sp .ne 2 -.mk .na \fB\fBtran_tgt_private\fR\fR .ad .RS 26n -.rt Private pointer that the \fBHBA\fR can use to refer to per-target specific data. This field can only be used when the \fBSCSI_HBA_TRAN_CLONE\fR flag is specified in \fBscsi_hba_attach\fR(9F). In this case, the \fBHBA\fR driver must @@ -110,137 +104,113 @@ initialize this field in its \fBtran_tgt_init\fR(9E) entry point. .sp .ne 2 -.mk .na \fB\fBtran_sd\fR\fR .ad .RS 26n -.rt Pointer to \fBscsi_device\fR(9S) structure if cloning; otherwise \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fBtran_tgt_init\fR\fR .ad .RS 26n -.rt Function entry that allows per-target \fBHBA\fR initialization, if necessary. .RE .sp .ne 2 -.mk .na \fB\fBtran_tgt_probe\fR\fR .ad .RS 26n -.rt Function entry that allows per-target \fBscsi_probe\fR(9F) customization, if necessary. .RE .sp .ne 2 -.mk .na \fB\fBtran_tgt_free\fR\fR .ad .RS 26n -.rt Function entry that allows per-target \fBHBA\fR deallocation, if necessary. .RE .sp .ne 2 -.mk .na \fB\fBtran_start\fR\fR .ad .RS 26n -.rt Function entry that starts a \fBSCSI\fR command execution on the \fBHBA\fR hardware. .RE .sp .ne 2 -.mk .na \fB\fBtran_reset\fR\fR .ad .RS 26n -.rt Function entry that resets a \fBSCSI\fR bus or target device. .RE .sp .ne 2 -.mk .na \fB\fBtran_abort\fR\fR .ad .RS 26n -.rt Function entry that aborts one \fBSCSI\fR command, or all pending \fBSCSI\fR commands. .RE .sp .ne 2 -.mk .na \fB\fBtran_getcap\fR\fR .ad .RS 26n -.rt Function entry that retrieves a \fBSCSI\fR capability. .RE .sp .ne 2 -.mk .na \fB\fBtran_setcap\fR\fR .ad .RS 26n -.rt Function entry that sets a \fBSCSI\fR capability. .RE .sp .ne 2 -.mk .na \fB\fBtran_init_pkt\fR\fR .ad .RS 26n -.rt Function entry that allocates a \fBscsi_pkt\fR structure. .RE .sp .ne 2 -.mk .na \fB\fBtran_destroy_pkt\fR\fR .ad .RS 26n -.rt Function entry that frees a \fBscsi_pkt\fR structure allocated by \fBtran_init_pkt\fR. .RE .sp .ne 2 -.mk .na \fB\fBtran_dmafree\fR\fR .ad .RS 26n -.rt Function entry that frees \fBDMA\fR resources that were previously allocated by \fBtran_init_pkt\fR. Not called for \fBHBA\fR drivers that provide a \fBtran_setup_pkt\fR entry point. @@ -248,129 +218,107 @@ Function entry that frees \fBDMA\fR resources that were previously allocated by .sp .ne 2 -.mk .na \fB\fBtran_sync_pkt\fR\fR .ad .RS 26n -.rt Synchronizes data in \fIpkt\fR after a data transfer has been completed. Not called for \fBHBA\fR drivers that provide a \fBtran_setup_pkt\fR entry point. .RE .sp .ne 2 -.mk .na \fB\fBtran_reset_notify\fR\fR .ad .RS 26n -.rt Function entry that allows a target to register a bus reset notification request with the \fBHBA\fR driver. .RE .sp .ne 2 -.mk .na \fB\fBtran_bus_reset\fR\fR .ad .RS 26n -.rt Function entry that resets the \fBSCSI\fR bus without resetting targets. .RE .sp .ne 2 -.mk .na \fB\fBtran_quiesce\fR\fR .ad .RS 26n -.rt Function entry that waits for all outstanding commands to complete and blocks (or queues) any \fBI/O\fR requests issued. .RE .sp .ne 2 -.mk .na \fB\fBtran_unquiesce\fR\fR .ad .RS 26n -.rt Function entry that allows \fBI/O\fR activities to resume on the \fBSCSI\fR bus. .RE .sp .ne 2 -.mk .na \fB\fBtran_setup_pkt\fR\fR .ad .RS 26n -.rt Optional entry point that initializes a \fBscsi_pkt\fR structure. See \fBtran_setup_pkt\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBtran_teardown_pkt\fR\fR .ad .RS 26n -.rt Entry point that releases resources allocated by \fBtran_setup_pkt\fR. .RE .sp .ne 2 -.mk .na \fB\fBtran_pkt_constructor\fR\fR .ad .RS 26n -.rt Additional optional entry point that performs the actions of a constructor. See \fBtran_setup_pkt\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBtran_pkt_destructor\fR\fR .ad .RS 26n -.rt Additional optional entry point that performs the actions of a destructor. See \fBtran_setup_pkt\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBtran_hba_len\fR\fR .ad .RS 26n -.rt Size of \fBpkt_ha_private\fR. See \fBtran_setup_pkt\fR(9E). .RE .sp .ne 2 -.mk .na \fB\fBtran_interconnect_type\fR\fR .ad .RS 26n -.rt Integer value that denotes the interconnect type of the transport as defined in the \fBservices.h\fR header file. .RE diff --git a/usr/src/man/man9s/scsi_inquiry.9s b/usr/src/man/man9s/scsi_inquiry.9s index 9d2a3aa676..aa71a92270 100644 --- a/usr/src/man/man9s/scsi_inquiry.9s +++ b/usr/src/man/man9s/scsi_inquiry.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_inquiry 9S "5 Nov 2008" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_INQUIRY 9S "Nov 5, 2008" .SH NAME scsi_inquiry \- SCSI inquiry structure .SH SYNOPSIS @@ -28,7 +28,7 @@ returned, are reserved for future standardization. This structure is part of .sp .in +2 .nf -Lines that start with an 'X' will be deleted before submission; +Lines that start with an 'X' will be deleted before submission; they are being classified as unstable at this time. uchar_t inq_dtype; /* Periph. qualifier, dev. type */ @@ -75,199 +75,163 @@ Peripheral Device Type and bits 5 - 7 represent the Peripheral Qualifier. The following values are appropriate for Peripheral Device Type field: .sp .ne 2 -.mk .na \fB\fBDTYPE_DIRECT\fR\fR .ad .RS 20n -.rt Direct-access device (for example, magnetic disk). .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_SEQUENTIAL\fR\fR .ad .RS 20n -.rt Sequential-access device (for example, magnetic tape). .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_PRINTER\fR\fR .ad .RS 20n -.rt Printer device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_PROCESSOR\fR\fR .ad .RS 20n -.rt Processor device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_WORM\fR\fR .ad .RS 20n -.rt Write-once device (for example, some optical disks). .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_RODIRECT\fR\fR .ad .RS 20n -.rt CD-ROM device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_SCANNER\fR\fR .ad .RS 20n -.rt Scanner device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_OPTICAL\fR\fR .ad .RS 20n -.rt Optical memory device (for example, some optical disks). .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_CHANGER\fR\fR .ad .RS 20n -.rt Medium Changer device (for example, jukeboxes). .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_COMM\fR\fR .ad .RS 20n -.rt Communications device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_ARRAY_CTRL\fR\fR .ad .RS 20n -.rt Array controller device (for example, \fBRAID\fR). .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_ESI\fR\fR .ad .RS 20n -.rt Enclosure services device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_RBC\fR\fR .ad .RS 20n -.rt Simplified direct-access device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_OCRW\fR\fR .ad .RS 20n -.rt Optical card reader/writer device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_BRIDGE\fR\fR .ad .RS 20n -.rt Bridge. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_OSD\fR\fR .ad .RS 20n -.rt Object-based storage device. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_UNKNOWN\fR\fR .ad .RS 20n -.rt Unknown or no device type. .RE .sp .ne 2 -.mk .na \fB\fBDTYPE_MASK\fR\fR .ad .RS 20n -.rt Mask to isolate Peripheral Device Type field. .RE @@ -276,12 +240,10 @@ Mask to isolate Peripheral Device Type field. The following values are appropriate for the Peripheral Qualifier field: .sp .ne 2 -.mk .na \fB\fBDPQ_POSSIBLE\fR\fR .ad .RS 17n -.rt The specified peripheral device type is currently connected to this logical unit. If the target cannot determine whether or not a physical device is currently connected, it uses this peripheral qualifier when returning the @@ -291,12 +253,10 @@ ready for access by the initiator. .sp .ne 2 -.mk .na \fB\fBDPQ_SUPPORTED\fR\fR .ad .RS 17n -.rt The target is capable of supporting the specified peripheral device type on this logical unit. However, the physical device is not currently connected to this logical unit. @@ -304,12 +264,10 @@ this logical unit. .sp .ne 2 -.mk .na \fB\fBDPQ_NEVER\fR\fR .ad .RS 17n -.rt The target is not capable of supporting a physical device on this logical unit. For this peripheral qualifier, the peripheral device type shall be set to \fBDTYPE_UNKNOWN\fR to provide compatibility with previous versions of @@ -319,23 +277,19 @@ qualifier is reserved. .sp .ne 2 -.mk .na \fB\fBDPQ_VUNIQ\fR\fR .ad .RS 17n -.rt This is a vendor-unique qualifier. .RE .sp .ne 2 -.mk .na \fB\fBDPQ_MASK\fR\fR .ad .RS 17n -.rt Mask to isolate Peripheral Qualifier field. .RE diff --git a/usr/src/man/man9s/scsi_pkt.9s b/usr/src/man/man9s/scsi_pkt.9s index fcc6d29102..2cf6e7629e 100644 --- a/usr/src/man/man9s/scsi_pkt.9s +++ b/usr/src/man/man9s/scsi_pkt.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_pkt 9S "11 Jan 2009" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_PKT 9S "Jan 11, 2009" .SH NAME scsi_pkt \- SCSI packet structure .SH SYNOPSIS @@ -31,24 +31,24 @@ failure of the command. .sp .in +2 .nf -opaque_t pkt_ha_private; /* private data for +opaque_t pkt_ha_private; /* private data for host adapter */ struct scsi_address pkt_address; /* destination packet */ -opaque_t pkt_private; /* private data +opaque_t pkt_private; /* private data for target driver */ void (*pkt_comp)(struct scsi_pkt *); /* callback */ uint_t pkt_flags; /* flags */ -int pkt_time; /* time allotted to +int pkt_time; /* time allotted to complete command */ -uchar_t *pkt_scbp; /* pointer to +uchar_t *pkt_scbp; /* pointer to status block */ -uchar_t *pkt_cdbp; /* pointer to +uchar_t *pkt_cdbp; /* pointer to command block */ -ssize_t pkt_resid; /* number of bytes +ssize_t pkt_resid; /* number of bytes not transferred */ uint_t pkt_state; /* state of command */ uint_t pkt_statistics; /* statistics */ -uchar_t pkt_reason; /* reason completion +uchar_t pkt_reason; /* reason completion called */ uint_t pkt_cdblen; /* length of pkt_cdbp */ uint_t pkt_scdblen; /* length of pkt_scbp */ @@ -61,48 +61,40 @@ uint_t pkt_dma_flags; /* DMA flags */ .sp .ne 2 -.mk .na \fB\fBpkt_ha_private\fR\fR .ad .RS 18n -.rt Opaque pointer that the HBA uses to reference a private data structure that transfers \fBscsi_pkt\fR requests. .RE .sp .ne 2 -.mk .na \fB\fBpkt_address\fR\fR .ad .RS 18n -.rt Initialized by \fBscsi_init_pkt\fR(9F), \fBpkt_address\fR records the intended route and the recipient of a request. .RE .sp .ne 2 -.mk .na \fB\fBpkt_private\fR\fR .ad .RS 18n -.rt Reserved for the use of the target driver, \fBpkt_private\fR is not changed by the HBA driver. .RE .sp .ne 2 -.mk .na \fB\fBpkt_comp\fR\fR .ad .RS 18n -.rt Specifies the command completion callback routine. When the host adapter driver has gone as far as it can in transporting a command to a \fBSCSI\fR target, and the command has either run to completion or can go no further for some other @@ -114,24 +106,20 @@ might sleep. .sp .ne 2 -.mk .na \fB\fBpkt_flags\fR\fR .ad .RS 18n -.rt Provides additional information about how the target driver expects the command to be executed. See \fBpkt_flag Definitions\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_time\fR\fR .ad .RS 18n -.rt Set by the target driver to represent the maximum time allowed in seconds for this command to complete. Timeout starts when the command is transmitted on the \fBSCSI\fR bus. The \fBpkt_time\fR may be \fB0\fR if no timeout is required. @@ -139,12 +127,10 @@ this command to complete. Timeout starts when the command is transmitted on the .sp .ne 2 -.mk .na \fB\fBpkt_scbp\fR\fR .ad .RS 18n -.rt Points to either a struct \fBscsi_status\fR(9S) or, if \fBauto-rqsense\fR is enabled and \fBpkt_state\fR includes \fBSTATE_ARQ_DONE\fR, a struct \fBscsi_arq_status\fR. If \fBscsi_status\fR is returned, the \fBSCSI\fR status @@ -154,24 +140,20 @@ byte resulting from the requested command is available. If .sp .ne 2 -.mk .na \fB\fBpkt_cdbp\fR\fR .ad .RS 18n -.rt Points to a kernel-addressable buffer with a length specified by a call to the proper resource allocation routine, \fBscsi_init_pkt\fR(9F). .RE .sp .ne 2 -.mk .na \fB\fBpkt_resid\fR\fR .ad .RS 18n -.rt Contains a residual count, either the number of data bytes that have not been transferred (\fBscsi_transport\fR(9F)) or the number of data bytes for which DMA resources could not be allocated \fBscsi_init_pkt\fR(9F). In the latter @@ -181,103 +163,85 @@ called with the \fBPKT_DMA_PARTIAL\fR flag. .sp .ne 2 -.mk .na \fB\fBpkt_state\fR\fR .ad .RS 18n -.rt Has bit positions that represent the six most important states that a \fBSCSI\fR command can go through. See \fBpkt_state Definitions\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_statistics\fR\fR .ad .RS 18n -.rt Maintains some transport-related statistics. See \fBpkt_statistics Definitions\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_reason\fR\fR .ad .RS 18n -.rt Contains a completion code that indicates why the \fBpkt_comp\fR function was called. See \fBpkt_reason Definitions\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_cdblen\fR\fR .ad .RS 18n -.rt Length of buffer pointed to by \fBpkt_cdbp\fR. See \fBtran_setup_pkt\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_scblen\fR\fR .ad .RS 18n -.rt Length of buffer pointed to by \fBpkt_scbp\fR. See \fBtran_setup_pkt\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_tgtlen\fR\fR .ad .RS 18n -.rt Length of buffer pointed to by \fBpkt_private\fR. See \fBtran_setup_pkt\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_numcookies\fR\fR .ad .RS 18n -.rt Length \fBpkt_cookies\fR array. See \fBtran_setup_pkt\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_cookies\fR\fR .ad .RS 18n -.rt Array of DMA cookies. See \fBtran_setup_pkt\fR. .RE .sp .ne 2 -.mk .na \fB\fBpkt_dma_flags\fR\fR .ad .RS 18n -.rt DMA flags used, such as \fBDDI_DMA_READ\fR and \fBDDI_DMA_WRITE\fR. See \fBtran_setup_pkt\fR. .RE @@ -292,101 +256,83 @@ The host adapter driver will update the \fBpkt_resid\fR, \fBpkt_reason\fR, The appropriate definitions for the structure member \fBpkt_flags\fR are: .sp .ne 2 -.mk .na \fB\fBFLAG_NOINTR\fR\fR .ad .RS 30n -.rt Run command with no command completion callback. Command is complete upon return from \fBscsi_transport\fR(9F). .RE .sp .ne 2 -.mk .na \fB\fBFLAG_NODISCON\fR\fR .ad .RS 30n -.rt Run command without disconnects. .RE .sp .ne 2 -.mk .na \fB\fBFLAG_NOPARITY\fR\fR .ad .RS 30n -.rt Run command without parity checking. .RE .sp .ne 2 -.mk .na \fB\fBFLAG_HTAG\fR\fR .ad .RS 30n -.rt Run command as the head-of-queue-tagged command. .RE .sp .ne 2 -.mk .na \fB\fBFLAG_OTAG\fR\fR .ad .RS 30n -.rt Run command as an ordered-queue-tagged command. .RE .sp .ne 2 -.mk .na \fB\fBFLAG_STAG\fR\fR .ad .RS 30n -.rt Run command as a simple-queue-tagged command. .RE .sp .ne 2 -.mk .na \fB\fBFLAG_SENSING\fR\fR .ad .RS 30n -.rt Indicates a request sense command. .RE .sp .ne 2 -.mk .na \fB\fBFLAG_HEAD\fR\fR .ad .RS 30n -.rt Place command at the head of the queue. .RE .sp .ne 2 -.mk .na \fB\fBFLAG_RENEGOTIATE_WIDE_SYNC\fR\fR .ad .RS 30n -.rt Before transporting this command, the host adapter should initiate the renegotiation of wide mode and synchronous transfer speed. Normally, the HBA driver manages negotiations but under certain conditions forcing a @@ -403,254 +349,208 @@ performance. The appropriate definitions for the structure member \fBpkt_reason\fR are: .sp .ne 2 -.mk .na \fB\fBCMD_CMPLT\fR\fR .ad .RS 20n -.rt No transport errors; normal completion. .RE .sp .ne 2 -.mk .na \fB\fBCMD_INCOMPLETE\fR\fR .ad .RS 20n -.rt Transport stopped with abnormal state. .RE .sp .ne 2 -.mk .na \fB\fBCMD_DMA_DERR\fR\fR .ad .RS 20n -.rt \fBDMA\fRd irection error. .RE .sp .ne 2 -.mk .na \fB\fBCMD_TRAN_ERR\fR\fR .ad .RS 20n -.rt Unspecified transport error. .RE .sp .ne 2 -.mk .na \fB\fBCMD_RESET\fR\fR .ad .RS 20n -.rt \fBSCSI\fR bus reset destroyed command. .RE .sp .ne 2 -.mk .na \fB\fBCMD_ABORTED\fR\fR .ad .RS 20n -.rt Command transport aborted on request. .RE .sp .ne 2 -.mk .na \fB\fBCMD_TIMEOUT\fR\fR .ad .RS 20n -.rt Command timed out. .RE .sp .ne 2 -.mk .na \fB\fBCMD_DATA_OVR\fR\fR .ad .RS 20n -.rt Data overrun. .RE .sp .ne 2 -.mk .na \fB\fBCMD_CMD_OVR\fR\fR .ad .RS 20n -.rt Command overrun. .RE .sp .ne 2 -.mk .na \fB\fBCMD_STS_OVR\fR\fR .ad .RS 20n -.rt Status overrun. .RE .sp .ne 2 -.mk .na \fB\fBCMD_BADMSG\fR\fR .ad .RS 20n -.rt Message not command complete. .RE .sp .ne 2 -.mk .na \fB\fBCMD_NOMSGOUT\fR\fR .ad .RS 20n -.rt Target refused to go to message out phase. .RE .sp .ne 2 -.mk .na \fB\fBCMD_XID_FAIL\fR\fR .ad .RS 20n -.rt Extended identify message rejected. .RE .sp .ne 2 -.mk .na \fB\fBCMD_IDE_FAIL\fR\fR .ad .RS 20n -.rt "Initiator Detected Error" message rejected. .RE .sp .ne 2 -.mk .na \fB\fBCMD_ABORT_FAIL\fR\fR .ad .RS 20n -.rt Abort message rejected. .RE .sp .ne 2 -.mk .na \fB\fBCMD_REJECT_FAIL\fR\fR .ad .RS 20n -.rt Reject message rejected. .RE .sp .ne 2 -.mk .na \fB\fBCMD_NOP_FAIL\fR\fR .ad .RS 20n -.rt "No Operation" message rejected. .RE .sp .ne 2 -.mk .na \fB\fBCMD_PER_FAIL\fR\fR .ad .RS 20n -.rt "Message Parity Error" message rejected. .RE .sp .ne 2 -.mk .na \fB\fBCMD_BDR_FAIL\fR\fR .ad .RS 20n -.rt "Bus Device Reset" message rejected. .RE .sp .ne 2 -.mk .na \fB\fBCMD_ID_FAIL\fR\fR .ad .RS 20n -.rt Identify message rejected. .RE .sp .ne 2 -.mk .na \fB\fBCMD_UNX_BUS_FREE\fR\fR .ad .RS 20n -.rt Unexpected bus free phase. .RE .sp .ne 2 -.mk .na \fB\fBCMD_TAG_REJECT\fR\fR .ad .RS 20n -.rt Target rejected the tag message. .RE .sp .ne 2 -.mk .na \fB\fBCMD_DEV_GONE\fR\fR .ad .RS 20n -.rt The device has been removed. .RE @@ -660,79 +560,65 @@ The device has been removed. The appropriate definitions for the structure member \fBpkt_state\fR are: .sp .ne 2 -.mk .na \fB\fBSTATE_GOT_BUS\fR\fR .ad .RS 22n -.rt Bus arbitration succeeded. .RE .sp .ne 2 -.mk .na \fB\fBSTATE_GOT_TARGET\fR\fR .ad .RS 22n -.rt Target successfully selected. .RE .sp .ne 2 -.mk .na \fB\fBSTATE_SENT_CMD\fR\fR .ad .RS 22n -.rt Command successfully sent. .RE .sp .ne 2 -.mk .na \fB\fBSTATE_XFERRED_DATA\fR\fR .ad .RS 22n -.rt Data transfer took place. .RE .sp .ne 2 -.mk .na \fB\fBSTATE_GOT_STATUS\fR\fR .ad .RS 22n -.rt Status received. .RE .sp .ne 2 -.mk .na \fB\fBSTATE_ARQ_DONE\fR\fR .ad .RS 22n -.rt The command resulted in a check condition and the host adapter driver executed an automatic request sense command. .RE .sp .ne 2 -.mk .na \fB\fBSTATE_XARQ_DONE\fR\fR .ad .RS 22n -.rt The command requested in extra sense data using a \fBPKT_XARQ\fR flag got a check condition. The host adapter driver was able to successfully request and return this. The \fBscsi_pkt.pkt_scbp->sts_rqpkt_resid\fR returns the sense @@ -748,78 +634,64 @@ The definitions that are appropriate for the structure member \fBpkt_statistics\fR are: .sp .ne 2 -.mk .na \fB\fBSTAT_DISCON\fR\fR .ad .RS 18n -.rt Device disconnect. .RE .sp .ne 2 -.mk .na \fB\fBSTAT_SYNC\fR\fR .ad .RS 18n -.rt Command did a synchronous data transfer. .RE .sp .ne 2 -.mk .na \fB\fBSTAT_PERR\fR\fR .ad .RS 18n -.rt \fBSCSI\fR parity error. .RE .sp .ne 2 -.mk .na \fB\fBSTAT_BUS_RESET\fR\fR .ad .RS 18n -.rt Bus reset. .RE .sp .ne 2 -.mk .na \fB\fBSTAT_DEV_RESET\fR\fR .ad .RS 18n -.rt Device reset. .RE .sp .ne 2 -.mk .na \fB\fBSTAT_ABORTED\fR\fR .ad .RS 18n -.rt Command was aborted. .RE .sp .ne 2 -.mk .na \fB\fBSTAT_TIMEOUT\fR\fR .ad .RS 18n -.rt Command timed out. .RE diff --git a/usr/src/man/man9s/scsi_status.9s b/usr/src/man/man9s/scsi_status.9s index 8b91c70bd5..b6bb0da585 100644 --- a/usr/src/man/man9s/scsi_status.9s +++ b/usr/src/man/man9s/scsi_status.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH scsi_status 9S "30 Aug 1995" "SunOS 5.11" "Data Structures for Drivers" +.TH SCSI_STATUS 9S "Aug 30, 1995" .SH NAME scsi_status \- SCSI status structure .SH SYNOPSIS .LP .nf -#include <sys/scsi/scsi.h> +#include <sys/scsi/scsi.h> .fi .SH INTERFACE LEVEL @@ -66,7 +66,6 @@ command queue in the target is full. For accessing the status as a byte, the following values are appropriate: .sp .ne 2 -.mk .na \fB\fBSTATUS_GOOD\fR \fR .ad @@ -77,7 +76,6 @@ This status indicates that the target has successfully completed the command. .sp .ne 2 -.mk .na \fB\fBSTATUS_CHECK\fR \fR .ad @@ -88,7 +86,6 @@ This status indicates that a contingent allegiance condition has occurred. .sp .ne 2 -.mk .na \fB\fBSTATUS_MET\fR \fR .ad @@ -99,7 +96,6 @@ This status is returned when the requested operations are satisfied. .sp .ne 2 -.mk .na \fB\fBSTATUS_BUSY\fR \fR .ad @@ -110,7 +106,6 @@ This status indicates that the target is busy. .sp .ne 2 -.mk .na \fB\fBSTATUS_INTERMEDIATE\fR \fR .ad @@ -122,7 +117,6 @@ linked commands. .sp .ne 2 -.mk .na \fB\fBSTATUS_SCSI2\fR \fR .ad @@ -133,7 +127,6 @@ This is the \fBSCSI-2 \fRmodifier bit. .sp .ne 2 -.mk .na \fB\fBSTATUS_INTERMEDIATE_MET\fR \fR .ad @@ -144,7 +137,6 @@ This status is a combination of \fBSTATUS_MET\fR and \fBSTATUS_INTERMEDIATE\fR. .sp .ne 2 -.mk .na \fB\fBSTATUS_RESERVATION_CONFLICT\fR \fR .ad @@ -157,7 +149,6 @@ a logical unit or an extent within a logical unit is reserved. .sp .ne 2 -.mk .na \fB\fBSTATUS_TERMINATED\fR \fR .ad @@ -170,7 +161,6 @@ after receiving a terminate \fBI/O\fR process message. .sp .ne 2 -.mk .na \fB\fBSTATUS_QFULL\fR \fR .ad diff --git a/usr/src/man/man9s/streamtab.9s b/usr/src/man/man9s/streamtab.9s index d5436a41a4..82d479a496 100644 --- a/usr/src/man/man9s/streamtab.9s +++ b/usr/src/man/man9s/streamtab.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH streamtab 9S "11 Apr 1991" "SunOS 5.11" "Data Structures for Drivers" +.TH STREAMTAB 9S "Apr 11, 1991" .SH NAME streamtab \- STREAMS entity declaration structure .SH SYNOPSIS .LP .nf -#include <sys/stream.h> +#include <sys/stream.h> .fi .SH INTERFACE LEVEL diff --git a/usr/src/man/man9s/stroptions.9s b/usr/src/man/man9s/stroptions.9s index 3c00ba8c13..91954e0a9a 100644 --- a/usr/src/man/man9s/stroptions.9s +++ b/usr/src/man/man9s/stroptions.9s @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH stroptions 9S "14 Nov 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH STROPTIONS 9S "Nov 14, 1996" .SH NAME stroptions \- options structure for M_SETOPTS message .SH SYNOPSIS @@ -47,177 +47,145 @@ The following are the flags that can be set in the \fBso_flags\fR bit mask in the \fBstroptions\fR structure. Note that multiple flags can be set. .sp .ne 2 -.mk .na \fB\fBSO_READOPT\fR\fR .ad .RS 21n -.rt Set read option. .RE .sp .ne 2 -.mk .na \fB\fBSO_WROFF\fR\fR .ad .RS 21n -.rt Set write offset. .RE .sp .ne 2 -.mk .na \fB\fBSO_MINPSZ\fR\fR .ad .RS 21n -.rt Set minimum packet size .RE .sp .ne 2 -.mk .na \fB\fBSO_MAXPSZ\fR\fR .ad .RS 21n -.rt Set maximum packet size. .RE .sp .ne 2 -.mk .na \fB\fBSO_HIWAT\fR\fR .ad .RS 21n -.rt Set high water mark. .RE .sp .ne 2 -.mk .na \fB\fBSO_LOWAT\fR\fR .ad .RS 21n -.rt Set low water mark. .RE .sp .ne 2 -.mk .na \fB\fBSO_MREADON\fR\fR .ad .RS 21n -.rt Set read notification ON. .RE .sp .ne 2 -.mk .na \fB\fBSO_MREADOFF\fR\fR .ad .RS 21n -.rt Set read notification OFF. .RE .sp .ne 2 -.mk .na \fB\fBSO_NDELON\fR\fR .ad .RS 21n -.rt Old TTY semantics for NDELAY reads and writes. .RE .sp .ne 2 -.mk .na \fB\fBSO_NDELOFFSTREAMS\fR\fR .ad .RS 21n -.rt Semantics for NDELAY reads and writes. .RE .sp .ne 2 -.mk .na \fB\fBSO_ISTTY\fR\fR .ad .RS 21n -.rt The stream is acting as a terminal. .RE .sp .ne 2 -.mk .na \fB\fBSO_ISNTTY\fR\fR .ad .RS 21n -.rt The stream is not acting as a terminal. .RE .sp .ne 2 -.mk .na \fB\fBSO_TOSTOP\fR\fR .ad .RS 21n -.rt Stop on background writes to this stream. .RE .sp .ne 2 -.mk .na \fB\fBSO_TONSTOP\fR\fR .ad .RS 21n -.rt Do not stop on background writes to this stream. .RE .sp .ne 2 -.mk .na \fB\fBSO_BAND\fR\fR .ad .RS 21n -.rt Water marks affect band. .RE .sp .ne 2 -.mk .na \fB\fBSO_ERROPT\fR\fR .ad .RS 21n -.rt Set error option. .RE @@ -228,34 +196,28 @@ When \fBSO_READOPT\fR is set, the \fBso_readopt\fR field of the \fBread\fR(2). .sp .ne 2 -.mk .na \fB\fBRNORM\fR\fR .ad .RS 9n -.rt Read message normal. .RE .sp .ne 2 -.mk .na \fB\fBRMSGD\fR\fR .ad .RS 9n -.rt Read message discard. .RE .sp .ne 2 -.mk .na \fB\fBRMSGN\fR\fR .ad .RS 9n -.rt Read message, no discard. .RE @@ -269,23 +231,19 @@ When \fBSO_ERROPT\fR is set, the \fBso_erropt\fR field of the \fBstroptions\fR structure can take a value that is either none or one of: .sp .ne 2 -.mk .na \fB\fBRERRNORM\fR\fR .ad .RS 18n -.rt Persistent read errors; default. .RE .sp .ne 2 -.mk .na \fB\fBRERRNONPERSIST\fR\fR .ad .RS 18n -.rt Non-persistent read errors. .RE @@ -294,23 +252,19 @@ Non-persistent read errors. \fBOR'ed \fRwith either none or one of: .sp .ne 2 -.mk .na \fB\fBWERRNORM\fR\fR .ad .RS 18n -.rt Persistent write errors; default. .RE .sp .ne 2 -.mk .na \fB\fBWERRNONPERSIST\fR\fR .ad .RS 18n -.rt Non-persistent write errors. .RE diff --git a/usr/src/man/man9s/tuple.9s b/usr/src/man/man9s/tuple.9s index c067c5a534..6108701806 100644 --- a/usr/src/man/man9s/tuple.9s +++ b/usr/src/man/man9s/tuple.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH tuple 9S "20 Dec 1996" "SunOS 5.11" "Data Structures for Drivers" +.TH TUPLE 9S "Dec 20, 1996" .SH NAME tuple \- card information structure (CIS) access structure .SH SYNOPSIS .LP .nf -#include <sys/pccard.h> +#include <sys/pccard.h> .fi .SH INTERFACE LEVEL @@ -92,28 +92,23 @@ cisdata_t TupleLink; /* tuple link */ The fields are defined as follows: .sp .ne 2 -.mk .na \fB\fBSocket\fR \fR .ad .RS 17n -.rt Not used in Solaris, but for portability with other card services implementations, it should be set to the logical socket number. .RE .sp .ne 2 -.mk .na \fB\fBAttributes\fR \fR .ad .RS 17n -.rt This field is bit-mapped. The following bits are defined: .sp .ne 2 -.mk .na \fB\fBTUPLE_RETURN_LINK\fR \fR .ad @@ -124,7 +119,6 @@ Return link tuples if set. .sp .ne 2 -.mk .na \fB\fBTUPLE_RETURN_IGNORED_TUPLES\fR \fR .ad @@ -137,7 +131,6 @@ the same tuples in a function-specific \fBCIS \fRchain. .sp .ne 2 -.mk .na \fB\fBTUPLE_RETURN_NAME\fR \fR .ad @@ -150,12 +143,10 @@ Return tuple name string using the \fBcsx_ParseTuple\fR(9F) function if set. .sp .ne 2 -.mk .na \fB\fBDesiredTuple\fR \fR .ad .RS 17n -.rt This field is the requested tuple type code to be returned when calling \fBcsx_GetFirstTuple\fR(9F) or \fBcsx_GetNextTuple\fR(9F). \fBRETURN_FIRST_TUPLE\fR is used to return the first tuple regardless of tuple @@ -165,12 +156,10 @@ tuple type. .sp .ne 2 -.mk .na \fB\fBTupleOffset\fR \fR .ad .RS 17n -.rt This field allows partial tuple information to be retrieved, starting at the specified offset within the tuple. This field must only be set before calling \fBcsx_GetTupleData\fR(9F). @@ -178,12 +167,10 @@ specified offset within the tuple. This field must only be set before calling .sp .ne 2 -.mk .na \fB\fBTupleDataMax\fR \fR .ad .RS 17n -.rt This field is the size of the tuple data buffer that card services uses to return raw tuple data from \fBcsx_GetTupleData\fR(9F). It can be larger than the number of bytes in the tuple data body. Card services ignores any value @@ -192,36 +179,30 @@ placed here by the client. .sp .ne 2 -.mk .na \fB\fBTupleDataLen\fR \fR .ad .RS 17n -.rt This field is the actual size of the tuple data body. It represents the number of tuple data body bytes returned by \fBcsx_GetTupleData\fR(9F). .RE .sp .ne 2 -.mk .na \fB\fBTupleData\fR \fR .ad .RS 17n -.rt This field is an array of bytes containing the raw tuple data body contents returned by \fBcsx_GetTupleData\fR(9F). .RE .sp .ne 2 -.mk .na \fB\fBTupleCode\fR \fR .ad .RS 17n -.rt This field is the tuple type code and is returned by \fBcsx_GetFirstTuple\fR(9F) or \fBcsx_GetNextTuple\fR(9F) when a tuple matching the \fBDesiredTuple\fR field is returned. @@ -229,12 +210,10 @@ the \fBDesiredTuple\fR field is returned. .sp .ne 2 -.mk .na \fB\fBTupleLink\fR \fR .ad .RS 17n -.rt This field is the tuple link, the offset to the next tuple, and is returned by \fBcsx_GetFirstTuple\fR(9F) or \fBcsx_GetNextTuple\fR(9F) when a tuple matching the \fBDesiredTuple\fR field is returned. diff --git a/usr/src/man/man9s/uio.9s b/usr/src/man/man9s/uio.9s index fd8fdb3f32..867cdda360 100644 --- a/usr/src/man/man9s/uio.9s +++ b/usr/src/man/man9s/uio.9s @@ -4,13 +4,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH uio 9S "26Mar 2009" "SunOS 5.11" "Data Structures for Drivers" +.TH UIO 9S "Mar 26, 2009" .SH NAME uio \- scatter/gather I/O request structure .SH SYNOPSIS .LP .nf -#include <sys/uio.h> +#include <sys/uio.h> .fi .SH INTERFACE LEVEL @@ -41,7 +41,7 @@ before use, by \fBbzero\fR(9F), \fBkmem_zalloc\fR(9F), or an equivalent. iovec_t *uio_iov; /* pointer to start of iovec */ /* list for uio struc. */ int uio_iovcnt; /* number of iovecs in list */ -off_t uio_offset; /* 32-bit offset into file where +off_t uio_offset; /* 32-bit offset into file where /* data is xferred. See NOTES. */ offset_t uio_loffset; /* 64-bit offset into file where */ /* data is xferred. See NOTES. */ diff --git a/usr/src/man/man9s/usb_bulk_request.9s b/usr/src/man/man9s/usb_bulk_request.9s index 0828b2885a..ff76d494fa 100644 --- a/usr/src/man/man9s/usb_bulk_request.9s +++ b/usr/src/man/man9s/usb_bulk_request.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_bulk_request 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_BULK_REQUEST 9S "Jan 5, 2004" .SH NAME usb_bulk_request \- USB bulk request structure .SH SYNOPSIS @@ -67,35 +67,29 @@ Request attributes define special handling for transfers. The following attributes are valid for bulk requests: .sp .ne 2 -.mk .na \fBUSB_ATTRS_SHORT_XFER_OK\fR .ad .RS 27n -.rt USB framework accepts transfers where less data is received than expected. .RE .sp .ne 2 -.mk .na \fBUSB_ATTRS_AUTOCLEARING\fR .ad .RS 27n -.rt USB framework resets pipe and clears functional stalls automatically on exception. .RE .sp .ne 2 -.mk .na \fBUSB_ATTRS_PIPE_RESET\fR .ad .RS 27n -.rt USB framework resets pipe automatically on exception. .RE @@ -140,7 +134,7 @@ Flags Type Attributes Data Timeout Semantics sleep IN SHORT_XFER_OK !=NULL > 0 See note (H) X OUT SHORT_XFER_OK X X illegal - + no sleep OUT X !=NULL 0 See note (I) no sleep OUT X !=NULL > 0 See note (J) @@ -255,15 +249,14 @@ See attributes(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_callback_flags.9s b/usr/src/man/man9s/usb_callback_flags.9s index 244549db6b..b275e9f461 100644 --- a/usr/src/man/man9s/usb_callback_flags.9s +++ b/usr/src/man/man9s/usb_callback_flags.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_callback_flags 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_CALLBACK_FLAGS 9S "Jan 5, 2004" .SH NAME usb_callback_flags \- USB callback flag definitions .SH SYNOPSIS @@ -38,23 +38,19 @@ errors detected. The usb_cb_flags_t enumerated type contains the following definitions: .sp .ne 2 -.mk .na \fBUSB_CB_NO_INFO\fR .ad .RS 27n -.rt No additional errors discovered or recovery actions taken. .RE .sp .ne 2 -.mk .na \fBUSB_CB_FUNCTIONAL_STALL\fR .ad .RS 27n -.rt A functional stall occurred during the transfer. A functional stall is usually caused by a hardware error, and must be explicitly cleared. A functional stall is fatal if it cannot be cleared. The default control pipe @@ -63,24 +59,20 @@ never shows a functional stall. .sp .ne 2 -.mk .na \fBUSB_CB_STALL_CLEARED\fR .ad .RS 27n -.rt A functional stall has been cleared by the USBA framework. This can happen if USB_ATTRS_AUTOCLEARING is set in the request's xxxx_attributes field. .RE .sp .ne 2 -.mk .na \fBUSB_CB_PROTOCOL_STALL\fR .ad .RS 27n -.rt A protocol stall has occurred during the transfer. A protocol stall is caused usually by an invalid or misunderstood command. It is cleared automatically when the device is given its next command. The USBA framework @@ -89,12 +81,10 @@ treats stalls detected on default pipe transfers as protocol stalls. .sp .ne 2 -.mk .na \fBUSB_CB_RESET_PIPE\fR .ad .RS 27n -.rt A pipe with a stall has been reset automatically via autoclearing, or via an explicit call to \fBusb_pipe_reset\fR(9F). Resetting a pipe consists of stopping all transactions on a pipe, setting the pipe to the idle state, and if @@ -106,12 +96,10 @@ called. .sp .ne 2 -.mk .na \fBUSB_CB_ASYNC_REQ_FAILED\fR .ad .RS 27n -.rt Resources could not be allocated to process callbacks asynchronously. Callbacks receiving this flag must not block, since those callbacks are executing in a context which holds resources shared by the rest @@ -123,12 +111,10 @@ to queue. .sp .ne 2 -.mk .na \fBUSB_CB_SUBMIT_FAILED\fR .ad .RS 27n -.rt A queued request was submitted to the host controller driver and was rejected. The usb_completion_reason shows why the request was rejected by the host controller. @@ -136,23 +122,19 @@ the host controller. .sp .ne 2 -.mk .na \fBUSB_CB_NO_RESOURCES\fR .ad .RS 27n -.rt Insufficient resources were available for recovery to proceed. .RE .sp .ne 2 -.mk .na \fBUSB_CB_INTR_CONTEXT\fR .ad .RS 27n -.rt Callback is executing in interrupt context and should not block. .RE @@ -344,15 +326,14 @@ See attributes(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_cfg_descr.9s b/usr/src/man/man9s/usb_cfg_descr.9s index 461ba9ee18..29ab926a79 100644 --- a/usr/src/man/man9s/usb_cfg_descr.9s +++ b/usr/src/man/man9s/usb_cfg_descr.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_cfg_descr 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_CFG_DESCR 9S "Jan 5, 2004" .SH NAME usb_cfg_descr \- USB configuration descriptor .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -73,15 +73,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_client_dev_data.9s b/usr/src/man/man9s/usb_client_dev_data.9s index 8d3d4f4661..0cccba2df3 100644 --- a/usr/src/man/man9s/usb_client_dev_data.9s +++ b/usr/src/man/man9s/usb_client_dev_data.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_client_dev_data 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_CLIENT_DEV_DATA 9S "Jan 5, 2004" .SH NAME usb_client_dev_data \- Device configuration information .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -77,24 +77,20 @@ dev_parse_level represents the extent of the device represented by the tree returned by the dev_cfg field and has the following possible values: .sp .ne 2 -.mk .na \fBUSB_PARSE_LVL_NONE\fR .ad .RS 22n -.rt Build no tree. dev_n_cfg returns 0, dev_cfg and dev_curr_cfg are returned NULL, the dev_curr_xxx fields are invalid. .RE .sp .ne 2 -.mk .na \fBUSB_PARSE_LVL_IF\fR .ad .RS 22n -.rt Parse configured interface only, if configuration# and interface properties are set (as when different interfaces are viewed by the OS as different device instances). If an OS device instance is set up to represent an entire physical @@ -103,24 +99,20 @@ device, this works like USB_PARSE_LVL_ALL. .sp .ne 2 -.mk .na \fBUSB_PARSE_LVL_CFG\fR .ad .RS 22n -.rt Parse entire configuration of configured interface only. This is like USB_PARSE_LVL_IF except entire configuration is returned. .RE .sp .ne 2 -.mk .na \fBUSB_PARSE_LVL_ALL\fR .ad .RS 22n -.rt Parse entire device (all configurations), even when driver is bound to a single interface of a single configuration. .RE @@ -293,15 +285,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_completion_reason.9s b/usr/src/man/man9s/usb_completion_reason.9s index 9a3fdacbcf..d6be41b8a1 100644 --- a/usr/src/man/man9s/usb_completion_reason.9s +++ b/usr/src/man/man9s/usb_completion_reason.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_completion_reason 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_COMPLETION_REASON 9S "Jan 5, 2004" .SH NAME usb_completion_reason \- USB completion reason definitions .SH SYNOPSIS @@ -30,56 +30,46 @@ detected. The usb_cr_t enumerated type contains the following definitions: .sp .ne 2 -.mk .na \fBUSB_CR_OK\fR .ad .RS 27n -.rt The transfer completed without any errors being detected. .RE .sp .ne 2 -.mk .na \fBUSB_CR_CRC\fR .ad .RS 27n -.rt CRC error was detected. .RE .sp .ne 2 -.mk .na \fBUSB_CR_BITSTUFFING\fR .ad .RS 27n -.rt Bit stuffing violation was detected. .RE .sp .ne 2 -.mk .na \fBUSB_CR_DATA_TOGGLE_MM\fR .ad .RS 27n -.rt Data toggle packet identifier did not match expected value. .RE .sp .ne 2 -.mk .na \fBUSB_CR_STALL\fR .ad .RS 27n -.rt The device endpoint indicated that it is stalled. If autoclearing is enabled for the request (request attributes has USB_ATTRS_AUTOCLEARING set), check the callback flags (usb_cb_flags_t) in the callback handler to determine whether @@ -90,58 +80,48 @@ information on autoclearing. .sp .ne 2 -.mk .na \fBUSB_CR_DEV_NOT_RESP\fR .ad .RS 27n -.rt Host controller timed out while waiting for device to respond. .RE .sp .ne 2 -.mk .na \fBUSB_CR_PID_CHECKFAILURE\fR .ad .RS 27n -.rt Check bits on the packet identifier returned from the device were not as expected. .RE .sp .ne 2 -.mk .na \fBUSB_CR_UNEXP_PID\fR .ad .RS 27n -.rt Packet identifier received was not valid. .RE .sp .ne 2 -.mk .na \fBUSB_CR_DATA_OVERRUN\fR .ad .RS 27n -.rt Amount of data returned exceeded either the maximum packet size of the endpoint or the remaining buffer size. .RE .sp .ne 2 -.mk .na \fBUSB_CR_DATA_UNDERRUN\fR .ad .RS 27n -.rt Amount of data returned was not sufficient to fill the specified buffer and the USB_ATTRS_SHORT_XFER_OK attribute was not set. Please see \fBusb_request_attributes\fR(9S) for more information on allowance of short @@ -150,128 +130,106 @@ transfers. .sp .ne 2 -.mk .na \fBUSB_CR_BUFFER_OVERRUN\fR .ad .RS 27n -.rt A device sent data faster than the system could digest it. .RE .sp .ne 2 -.mk .na \fBUSB_CR_BUFFER_UNDERRUN\fR .ad .RS 27n -.rt The host controller could not get data from the system fast enough to keep up with the required USB data rate. .RE .sp .ne 2 -.mk .na \fBUSB_CR_TIMEOUT\fR .ad .RS 27n -.rt A timeout specified in a control, bulk, or one-time interrupt request has expired. .RE .sp .ne 2 -.mk .na \fBUSB_CR_NOT_ACCESSED\fR .ad .RS 27n -.rt Request was not accessed nor processed by the host controller. .RE .sp .ne 2 -.mk .na \fBUSB_CR_NO_RESOURCES\fR .ad .RS 27n -.rt No resources were available to continue servicing a periodic interrupt or isochronous request. .RE .sp .ne 2 -.mk .na \fBUSB_CR_STOPPED_POLLING\fR .ad .RS 27n -.rt Servicing of the current periodic request cannot continue because polling on an interrupt-IN or isochronous-IN endpoint has stopped. .RE .sp .ne 2 -.mk .na \fBUSB_CR_PIPE_CLOSING\fR .ad .RS 27n -.rt Request was not started because the pipe to which it was queued was closing or closed. .RE .sp .ne 2 -.mk .na \fBUSB_CR_PIPE_RESET\fR .ad .RS 27n -.rt Request was not started because the pipe to which it was queued was reset. .RE .sp .ne 2 -.mk .na \fBUSB_CR_NOT_SUPPORTED\fR .ad .RS 27n -.rt Request or command is not supported. .RE .sp .ne 2 -.mk .na \fBUSB_CR_FLUSHED\fR .ad .RS 27n -.rt Request was not completed because the pipe to which it was queued went to an error state, became stalled, was reset or was closed. .RE .sp .ne 2 -.mk .na \fBUSB_CR_HC_HARDWARE_ERR\fR .ad .RS 27n -.rt Request could not be completed due to a general host controller hardware error. .RE @@ -284,15 +242,14 @@ See attributes(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_ctrl_request.9s b/usr/src/man/man9s/usb_ctrl_request.9s index 617f9f2734..bc59381f13 100644 --- a/usr/src/man/man9s/usb_ctrl_request.9s +++ b/usr/src/man/man9s/usb_ctrl_request.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_ctrl_request 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_CTRL_REQUEST 9S "Jan 5, 2004" .SH NAME usb_ctrl_request \- USB control pipe request structure .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -64,35 +64,29 @@ Request attributes define special handling for transfers. The following attributes are valid for control requests: .sp .ne 2 -.mk .na \fBUSB_ATTRS_SHORT_XFER_OK\fR .ad .RS 27n -.rt Accept transfers where less data is received than expected. .RE .sp .ne 2 -.mk .na \fBUSB_ATTRS_AUTOCLEARING\fR .ad .RS 27n -.rt Have USB framework reset pipe and clear functional stalls automatically on exception. .RE .sp .ne 2 -.mk .na \fBUSB_ATTRS_PIPE_RESET\fR .ad .RS 27n -.rt Have USB framework reset pipe automatically on exception. .RE @@ -171,15 +165,14 @@ See attributes(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_dev_descr.9s b/usr/src/man/man9s/usb_dev_descr.9s index 63ea514436..7d12f017c8 100644 --- a/usr/src/man/man9s/usb_dev_descr.9s +++ b/usr/src/man/man9s/usb_dev_descr.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_dev_descr 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_DEV_DESCR 9S "Jan 5, 2004" .SH NAME usb_dev_descr \- USB device descriptor .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -94,7 +94,7 @@ A device descriptor contains the following fields: USB_CLASS_WIRELESS Wireless controller device class. - + .fi .in -2 @@ -106,15 +106,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_dev_qlf_descr.9s b/usr/src/man/man9s/usb_dev_qlf_descr.9s index 76c23f99c8..468164d9d1 100644 --- a/usr/src/man/man9s/usb_dev_qlf_descr.9s +++ b/usr/src/man/man9s/usb_dev_qlf_descr.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_dev_qlf_descr 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_DEV_QLF_DESCR 9S "Jan 5, 2004" .SH NAME usb_dev_qlf_descr \- USB device qualifier descriptor .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -39,7 +39,7 @@ uint8_t bDescriptorType Set to USB_DESCR_TYPE_DEV_QLF. uint16_t bcdUSB USB specification release number in binary coded decimal. -uint8_t bDeviceClass Device class code. +uint8_t bDeviceClass Device class code. (See \fBusb_dev_descr(9s)\fR.) uint8_t bDeviceSubClass Device subclass code.(See @@ -70,15 +70,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_ep_descr.9s b/usr/src/man/man9s/usb_ep_descr.9s index 353e5e1a84..55c1e5918f 100644 --- a/usr/src/man/man9s/usb_ep_descr.9s +++ b/usr/src/man/man9s/usb_ep_descr.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_ep_descr 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_EP_DESCR 9S "Jan 5, 2004" .SH NAME usb_ep_descr \- USB endpoint descriptor .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -82,7 +82,7 @@ isochronous endpoints: USB_EP_USAGE_MASK bmAttributes feedback type bit fld Endpoint descriptor additional-transaction-opportunities- -per-microframe wMaxPacketSize values and mask for high speed +per-microframe wMaxPacketSize values and mask for high speed isochronous and interrupt endpoints: USB_EP_MAX_PKTSZ_MASK Mask for packetsize bits USB_EP_MAX_XACTS_MASK Bits for additional transfers per @@ -115,7 +115,7 @@ is 2**(value-1). See Section 9.6.6 of the USB 2.0 specification. USB_EP_MIN_HIGH_ISOCH_INTRVL Min poll interval, highspd isoc e/p USB_EP_MAX_HIGH_ISOCH_INTRVL Max poll interval, highspd isoc e/p - + .fi .in -2 @@ -127,15 +127,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_if_descr.9s b/usr/src/man/man9s/usb_if_descr.9s index 9a5f53b4e3..42a5de9dd8 100644 --- a/usr/src/man/man9s/usb_if_descr.9s +++ b/usr/src/man/man9s/usb_if_descr.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_if_descr 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_IF_DESCR 9S "Jan 5, 2004" .SH NAME usb_if_descr \- USB interface descriptor .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -98,7 +98,7 @@ values are as follows: USB_CLASS_WIRELESS Wireless interface class - + .fi .in -2 @@ -110,15 +110,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_intr_request.9s b/usr/src/man/man9s/usb_intr_request.9s index 82427b3dc1..9f8fc006cb 100644 --- a/usr/src/man/man9s/usb_intr_request.9s +++ b/usr/src/man/man9s/usb_intr_request.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_intr_request 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_INTR_REQUEST 9S "Jan 5, 2004" .SH NAME usb_intr_request \- USB interrupt request structure .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -67,46 +67,38 @@ Request attributes define special handling for transfers. The following attributes are valid for interrupt requests: .sp .ne 2 -.mk .na \fBUSB_ATTRS_SHORT_XFER_OK\fR .ad .RS 27n -.rt Accept transfers where less data is received than expected. .RE .sp .ne 2 -.mk .na \fBUSB_ATTRS_AUTOCLEARING\fR .ad .RS 27n -.rt Have USB framework reset pipe and clear functional stalls automatically on exception. .RE .sp .ne 2 -.mk .na \fBUSB_ATTRS_PIPE_RESET\fR .ad .RS 27n -.rt Have USB framework reset pipe automatically on exception. .RE .sp .ne 2 -.mk .na \fBUSB_ATTRS_ONE_XFER\fR .ad .RS 27n -.rt Perform a single IN transfer. Do not start periodic transfers with this request. .RE @@ -117,14 +109,14 @@ Please see \fBusb_request_attributes\fR(9S) for more information. .sp .in +2 .nf -Interrupt transfers/requests are subject to the following +Interrupt transfers/requests are subject to the following constraints and caveats: -1) The following table indicates combinations of - usb_pipe_intr_xfer() flags argument and fields +1) The following table indicates combinations of + usb_pipe_intr_xfer() flags argument and fields of the usb_intr_req_t request argument (X = don't care): - "none" as attributes in the table below indicates + "none" as attributes in the table below indicates neither ONE_XFER nor SHORT_XFER_OK flags Type attributes data timeout semantics @@ -146,7 +138,7 @@ constraints and caveats: X OUT X NULL X illegal X OUT ONE_XFER X X illegal - + X OUT SHORT_XFER_OK X X illegal no sleep OUT none !=NULL 0 See table note (F) @@ -160,112 +152,112 @@ constraints and caveats: Table notes: A) Continuous polling, new data is returned in cloned request - structures via continous callbacks, original request is + structures via continous callbacks, original request is returned on stop polling. - B) One time poll, no timeout, callback when data is + B) One time poll, no timeout, callback when data is received. - C) One time poll, with timeout, callback when data + C) One time poll, with timeout, callback when data is received. - D) One time poll, no timeout, one callback, unblock + D) One time poll, no timeout, one callback, unblock when transfer completes. - E) One time poll, timeout, one callback, unblock when + E) One time poll, timeout, one callback, unblock when transfer completes or timeout occurs. - F) Transfer until data exhausted, no timeout, callback + F) Transfer until data exhausted, no timeout, callback when done. - G) Transfer until data exhausted, timeout, callback + G) Transfer until data exhausted, timeout, callback when done. - H) Transfer until data exhausted, no timeout, unblock + H) Transfer until data exhausted, no timeout, unblock when data is received. - I) Transfer until data exhausted, timeout, unblock + I) Transfer until data exhausted, timeout, unblock when data is received. - 2) USB_FLAGS_SLEEP indicates here just to wait for - resources, except when ONE_XFER is set, in which case it + 2) USB_FLAGS_SLEEP indicates here just to wait for + resources, except when ONE_XFER is set, in which case it also waits for completion before returning. 3) Reads (IN): - a) The client driver does *not* provide a data buffer. - By default, a READ request would mean continuous - polling for data IN. The USBA framework allocates a - new data buffer for each poll. intr_len specifies + a) The client driver does *not* provide a data buffer. + By default, a READ request would mean continuous + polling for data IN. The USBA framework allocates a + new data buffer for each poll. intr_len specifies the amount of 'periodic data' for each poll. - b) The USBA framework issues a callback to the client - at the end of a polling interval when there is data to - return. Each callback returns its data in a new request - cloned from the original. Note that the amount of data + b) The USBA framework issues a callback to the client + at the end of a polling interval when there is data to + return. Each callback returns its data in a new request + cloned from the original. Note that the amount of data read IN is either intr_len or "wMaxPacketSize" in length. - c) Normally, the HCD keeps polling the interrupt endpoint - forever even if there is no data to be read IN. A - client driver may stop this polling by calling + c) Normally, the HCD keeps polling the interrupt endpoint + forever even if there is no data to be read IN. A + client driver may stop this polling by calling usb_pipe_stop_intr_polling(9F). - - d) If a client driver chooses to pass USB_ATTRS_ONE_XFER - as 'xfer_attributes' the HCD polls for data until - some data is received. The USBA framework reads in - the data, does a callback, and stops polling for any + + d) If a client driver chooses to pass USB_ATTRS_ONE_XFER + as 'xfer_attributes' the HCD polls for data until + some data is received. The USBA framework reads in + the data, does a callback, and stops polling for any more data. In this case, the client - driver need not explicitly call + driver need not explicitly call usb_pipe_stop_intr_polling(). - e) All requests with USB_ATTRS_ONE_XFER require callbacks - to be specified. - - f) When continuous polling is stopped, the original + e) All requests with USB_ATTRS_ONE_XFER require callbacks + to be specified. + + f) When continuous polling is stopped, the original request is returned with USB_CR_STOPPED_POLLING. - - g) If the USB_ATTRS_SHORT_XFER_OK attribute is not set - and a short transfer is received while polling, - an error is assumed and polling is stopped. In this - case or the case of other errors, the error must be cleared - and polling restarted by the client driver. Setting the + + g) If the USB_ATTRS_SHORT_XFER_OK attribute is not set + and a short transfer is received while polling, + an error is assumed and polling is stopped. In this + case or the case of other errors, the error must be cleared + and polling restarted by the client driver. Setting the USB_ATTRS_AUTOCLEARING attribute will clear the error - but not restart polling. (NOTE: Polling can be - restarted from an exception callback corresponding to - an original request. Please see usb_pipe_intr_xfer(9F) + but not restart polling. (NOTE: Polling can be + restarted from an exception callback corresponding to + an original request. Please see usb_pipe_intr_xfer(9F) for more information. 4) Writes (OUT): - - a) A client driver provides the data buffer, and + + a) A client driver provides the data buffer, and data, needed for intr write. - b) Unlike read (see previous section), there + b) Unlike read (see previous section), there is no continuous write mode. - c) The USB_ATTRS_ONE_XFER attribute is illegal. - By default USBA keeps writing intr data until + c) The USB_ATTRS_ONE_XFER attribute is illegal. + By default USBA keeps writing intr data until the provided data buffer has been - written out. The USBA framework does ONE + written out. The USBA framework does ONE callback to the client driver. d) Queueing is supported. - The intr_completion_reason indicates the status - of the transfer. See usb_completion_reason(9S) for + The intr_completion_reason indicates the status + of the transfer. See usb_completion_reason(9S) for usb_cr_t definitions. - The intr_cb_flags are set prior to calling the - exception callback handler, to summarize recovery actions + The intr_cb_flags are set prior to calling the + exception callback handler, to summarize recovery actions taken and errors encountered during - recovery. See usb_callback_flags(9S) for + recovery. See usb_callback_flags(9S) for usb_cb_flags_t definitions. --- Callback handling --- - All usb request types share the same callback - handling. Please see usb_callback_flags(9S) for a + All usb request types share the same callback + handling. Please see usb_callback_flags(9S) for a description of use and operation. .fi .in -2 @@ -278,15 +270,14 @@ See attributes(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_isoc_request.9s b/usr/src/man/man9s/usb_isoc_request.9s index 195b6feab6..0473228f6a 100644 --- a/usr/src/man/man9s/usb_isoc_request.9s +++ b/usr/src/man/man9s/usb_isoc_request.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_isoc_request 9S "28 Dec 2006" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_ISOC_REQUEST 9S "Dec 28, 2006" .SH NAME usb_isoc_request \- USB isochronous request structure .SH SYNOPSIS @@ -40,7 +40,7 @@ ushort_t isoc_pkts_count; /* num USB pkts in this request */ * The sum of all pkt lengths in an isoc request. Recommend to set it to * zero, so the sum of isoc_pkt_length in the isoc_pkt_descr list will be * used automatically and no check will be apply to this element. - */ + */ ushort_t isoc_pkts_length; ushort_t isoc_error_count;/* num pkts completed w/errs */ usb_req_attrs_t isoc_attributes;/* request-specific attrs */ @@ -107,36 +107,30 @@ Request attributes define special handling for transfers. The following attributes are valid for isochronous requests: .sp .ne 2 -.mk .na \fB\fBUSB_ATTRS_ISOC_START_FRAME\fR\fR .ad .RS 30n -.rt Start transferring at the starting frame number specified in the \fBisoc_frame_no\fR field of the request. .RE .sp .ne 2 -.mk .na \fB\fBUSB_ATTRS_ISOC_XFER_ASAP\fR\fR .ad .RS 30n -.rt Start transferring as soon as possible. The \fBUSBA\fR framework picks an immediate frame number to map to the starting frame number. .RE .sp .ne 2 -.mk .na \fB\fBUSB_ATTRS_SHORT_XFER_OK\fR\fR .ad .RS 30n -.rt Accept transfers where less data is received than expected. .RE @@ -157,9 +151,9 @@ caveats: .in +2 .nf 1) The following table indicates combinations of usb_pipe_isoc_xfer - flags argument and fields of the usb_isoc_req_t request argument - (X = don't care). (Note that attributes considered in this table - are ONE_XFER, START_FRAME, XFER_ASAP, and SHORT_XFER, and that + flags argument and fields of the usb_isoc_req_t request argument + (X = don't care). (Note that attributes considered in this table + are ONE_XFER, START_FRAME, XFER_ASAP, and SHORT_XFER, and that some transfer types are characterized by multiple table entries.) Flags Type Attributes Data Semantics @@ -172,8 +166,8 @@ X X ISOC_START_FRAME X illegal & ISOC_XFER_ASAP X X !ISOC_START_FRAME X illegal - & !ISOC_XFER_ASAP - + & !ISOC_XFER_ASAP + X OUT SHORT_XFER_OK X illegal X IN X !=NULL See table note (A) @@ -184,18 +178,18 @@ X X ISOC_XFER_ASAP !=NULL See table note (C) Table notes: - A) continuous polling, new data is returned in - cloned request structures via continous callbacks, + A) continuous polling, new data is returned in + cloned request structures via continous callbacks, original request is returned on stop polling - B) invalid if the current_frame number is past + B) invalid if the current_frame number is past "isoc_frame_no" or "isoc_frame_no" == 0 - C)"isoc_frame_no" is ignored. The USBA framework - determines which frame to insert and start + C)"isoc_frame_no" is ignored. The USBA framework + determines which frame to insert and start the transfer. -2) USB_FLAGS_SLEEP indicates to wait for resources but +2) USB_FLAGS_SLEEP indicates to wait for resources but not for completion. 3) For polled reads: @@ -210,30 +204,30 @@ Table notes: match the isoc_pkt_length field of the packet descriptor unless a short transfer occurs. The actual size is returned in the - isoc_pkt_actual_length field of the packet + isoc_pkt_actual_length field of the packet descriptor. When all packets of the request have been processed, a normal callback is done to sig- nal the completion of the original request. - B. When continuous polling is stopped, the original - request is returned in an exception callback with a - completion reason of USB_CR_STOPPED_POLLING. + B. When continuous polling is stopped, the original + request is returned in an exception callback with a + completion reason of USB_CR_STOPPED_POLLING. (NOTE: Polling can be restarted from an exception - callback corresponding to an original request. + callback corresponding to an original request. Please see usb_pipe_isoc_xfer(9F) for more information. C. Callbacks must be specified. - The isoc_completion_reason indicates the status of the transfer. See + The isoc_completion_reason indicates the status of the transfer. See usb_completion_reason(9s) for usb_cr_t definitions. - The isoc_cb_flags are set prior to calling the exception - callback handler to summarize recovery actions taken and - errors encountered during recovery. See usb_callback_flags(9s) + The isoc_cb_flags are set prior to calling the exception + callback handler to summarize recovery actions taken and + errors encountered during recovery. See usb_callback_flags(9s) for usb_cb_flags_t definitions. --- Callback handling --- -All usb request types share the same callback handling. Please see +All usb request types share the same callback handling. Please see usb_callback_flags(9s) for a description of use and operation. .fi .in -2 @@ -246,15 +240,14 @@ See attributes(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO 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 8c28bdbfbe..cbf493c17c 100644 --- a/usr/src/man/man9s/usb_other_speed_cfg_descr.9s +++ b/usr/src/man/man9s/usb_other_speed_cfg_descr.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_other_speed_cfg_descr 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_OTHER_SPEED_CFG_DESCR 9S "Jan 5, 2004" .SH NAME usb_other_speed_cfg_descr \- USB other speed configuration descriptor .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -51,14 +51,14 @@ uint8_t bConfigurationValue ID of the current other-speed configuration (1-based). uint8_t iConfiguration Configuration value. - Valid if > 0. Pass to + Valid if > 0. Pass to usb_get_string_descr(9F) to retrieve string. uint8_t bmAttributes Configuration characteristics [See usb_cfg_descr(9S).] -uint8_t bMaxPower Maximum power consumption +uint8_t bMaxPower Maximum power consumption in 2mA units. .fi .in -2 @@ -71,15 +71,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_request_attributes.9s b/usr/src/man/man9s/usb_request_attributes.9s index 58a140685a..0339de2290 100644 --- a/usr/src/man/man9s/usb_request_attributes.9s +++ b/usr/src/man/man9s/usb_request_attributes.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_request_attributes 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_REQUEST_ATTRIBUTES 9S "Jan 5, 2004" .SH NAME usb_request_attributes \- Definition of USB request attributes .SH SYNOPSIS @@ -27,12 +27,10 @@ to the enumerated type usb_req_attrs_t. Supported request attributes are: .sp .ne 2 -.mk .na \fBUSB_ATTRS_SHORT_XFER_OK\fR .ad .RS 30n -.rt Use this attribute when the maximum transfer size is known, but it is possible for the request to receive a smaller amount of data. This attribute tells the USBA framework to accept without error transfers which are shorter @@ -41,12 +39,10 @@ than expected. .sp .ne 2 -.mk .na \fBUSB_ATTRS_PIPE_RESET\fR .ad .RS 30n -.rt Have the USB framework reset the pipe automatically if an error occurs during the transfer. Do not attempt to clear any stall. The USB_CB_RESET_PIPE callback flag is passed to the client driver's exception handler to show the @@ -56,12 +52,10 @@ unless the pipe is the default pipe. .sp .ne 2 -.mk .na \fBUSB_ATTRS_AUTOCLEARING\fR .ad .RS 30n -.rt Have the USB framework reset the pipe and clear functional stalls automatically if an error occurs during the transfer. The callback flags passed to the client driver's exception handler show the status after the attempt to clear the @@ -87,12 +81,10 @@ default pipe. .sp .ne 2 -.mk .na \fBUSB_ATTRS_ONE_XFER\fR .ad .RS 30n -.rt Applies only to interrupt-IN requests. Without this flag, interrupt-IN requests start periodic polling of the interrupt pipe. This flag specifies to perform only a single transfer. Do not start periodic transfers with this request. @@ -100,12 +92,10 @@ only a single transfer. Do not start periodic transfers with this request. .sp .ne 2 -.mk .na \fBUSB_ATTRS_ISOC_START_FRAME\fR .ad .RS 30n -.rt Applies only to isochronous requests and specifies that a request be started at a given frame number. The starting frame number is provided in the isoc_frame_no field of the usb_isoc_req_t. Please see @@ -122,12 +112,10 @@ starting frames which have passed are rejected. .sp .ne 2 -.mk .na \fBUSB_ATTRS_ISOC_XFER_ASAP\fR .ad .RS 30n -.rt Applies only to isochronous requests and specifies that a request start as soon as possible. The host controller driver picks a starting frame number which immediately follows the last frame of the last queued request. The @@ -192,15 +180,14 @@ See attributes(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man9s/usb_string_descr.9s b/usr/src/man/man9s/usb_string_descr.9s index 30e40f860e..bd74fe4065 100644 --- a/usr/src/man/man9s/usb_string_descr.9s +++ b/usr/src/man/man9s/usb_string_descr.9s @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH usb_string_descr 9S "5 Jan 2004" "SunOS 5.11" "Data Structures for Drivers" +.TH USB_STRING_DESCR 9S "Jan 5, 2004" .SH NAME usb_string_descr \- USB string descriptor .SH SYNOPSIS .LP .nf -#include <sys/usb/usba.h> +#include <sys/usb/usba.h> .fi .SH INTERFACE LEVEL @@ -38,7 +38,7 @@ uint8_t bLength Size of this descriptor, uint8_t bDescriptorType Set to USB_DESCR_TYPE_STRING. -uint16_t bString[1]; Variable length Unicode encoded +uint16_t bString[1]; Variable length Unicode encoded string. .fi .in -2 @@ -51,15 +51,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitecturePCI-based systems +Architecture PCI-based systems _ -Interface stabilityCommitted +Interface stability Committed .TE .SH SEE ALSO |