1 '\" te 2 .\" Copyright (c) 2001, Sun Microsystems, Inc., All Rights Reserved. 3 .\" Copyright 1989 AT&T 4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. 5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. 6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] 7 .TH INTRO 9S "May 15, 2001" 8 .SH NAME 9 Intro, intro \- introduction to kernel data structures and properties 10 .SH DESCRIPTION 11 .sp 12 .LP 13 Section 9P describes kernel properties used by device drivers. Section 9S 14 describes the data structures used by drivers to share information between the 15 driver and the kernel. See \fBIntro\fR(9E) for an overview of device driver 16 interfaces. 17 .sp 18 .LP 19 In Section 9S, reference pages contain the following headings: 20 .RS +4 21 .TP 22 .ie t \(bu 23 .el o 24 \fBNAME\fR summarizes the purpose of the structure or property. 25 .RE 26 .RS +4 27 .TP 28 .ie t \(bu 29 .el o 30 \fBSYNOPSIS\fR lists the include file that defines the structure or property. 31 .RE 32 .RS +4 33 .TP 34 .ie t \(bu 35 .el o 36 \fBINTERFACE\fR \fBLEVEL\fR describes any architecture dependencies. 37 .RE 38 .RS +4 39 .TP 40 .ie t \(bu 41 .el o 42 \fBDESCRIPTION\fR provides general information about the structure or property. 43 .RE 44 .RS +4 45 .TP 46 .ie t \(bu 47 .el o 48 \fBSTRUCTURE\fR \fBMEMBERS\fR lists all accessible structure members (for 49 Section 9S). 50 .RE 51 .RS +4 52 .TP 53 .ie t \(bu 54 .el o 55 \fBSEE\fR \fBALSO\fR gives sources for further information. 56 .RE 57 .sp 58 .LP 59 Of the preceding headings, Section 9P reference pages contain the \fBNAME\fR, 60 \fBDESCRIPTION\fR, and \fBSEE\fR \fBALSO\fR fields. 61 .sp 62 .LP 63 Every driver MUST include <\fBsys/ddi.h\fR> and <\fBsys/sunddi.h\fR>, in that 64 order, and as final entries. 65 .sp 66 .LP 67 The following table summarizes the STREAMS structures described in Section 9S. 68 .sp 69 70 .sp 71 .TS 72 box; 73 c | c 74 l | l . 75 Structure Type 76 _ 77 \fBcopyreq\fR DDI/DKI 78 _ 79 \fBcopyresp\fR DDI/DKI 80 _ 81 \fBdatab\fR DDI/DKI 82 _ 83 \fBfmodsw\fR Solaris DDI 84 _ 85 \fBfree_rtn\fR DDI/DKI 86 _ 87 \fBiocblk\fR DDI/DKI 88 _ 89 \fBlinkblk\fR DDI/DKI 90 _ 91 \fBmodule_info\fR DDI/DKI 92 _ 93 \fBmsgb\fR DDI/DKI 94 _ 95 \fBqband\fR DDI/DKI 96 _ 97 \fBqinit\fR DDI/DKI 98 _ 99 \fBqueclass\fR Solaris DDI 100 _ 101 \fBqueue\fR DDI/DKI 102 _ 103 \fBstreamtab\fR DDI/DKI 104 _ 105 \fBstroptions\fR DDI/DKI 106 .TE 107 108 .sp 109 .LP 110 The following table summarizes structures that are not specific to STREAMS I/O. 111 .sp 112 113 .sp 114 .TS 115 box; 116 c | c 117 l | l . 118 Structure Type 119 _ 120 \fBaio_req\fR Solaris DDI 121 _ 122 \fBbuf\fR DDI/DKI 123 _ 124 \fBcb_ops\fR Solaris DDI 125 _ 126 \fBddi_device_acc_attr\fR Solaris DDI 127 _ 128 \fBddi_dma_attr\fR Solaris DDI 129 _ 130 \fBddi_dma_cookie\fR Solaris DDI 131 _ 132 \fBddi_dma_lim_sparc\fR Solaris SPARC DDI 133 _ 134 \fBddi_dma_lim_x86\fR Solaris x86 DDI 135 _ 136 \fBddi_dma_req\fR Solaris DDI 137 _ 138 \fBddi_dmae_req\fR Solaris x86 DDI 139 _ 140 \fBddi_idevice_cookie\fR Solaris DDI 141 _ 142 \fBddi_mapdev_ctl\fR Solaris DDI 143 _ 144 \fBdevmap_callback_ctl\fR Solaris DDI 145 _ 146 \fBdev_ops\fR Solaris DDI 147 _ 148 \fBiovec\fR DDI/DKI 149 _ 150 \fBkstat\fR Solaris DDI 151 _ 152 \fBkstat_intr\fR Solaris DDI 153 _ 154 \fBkstat_io\fR Solaris DDI 155 _ 156 \fBkstat_named\fR Solaris DDI 157 _ 158 \fBmap\fR DDI/DKI 159 _ 160 \fBmodldrv\fR Solaris DDI 161 _ 162 \fBmodlinkage\fR Solaris DDI 163 _ 164 \fBmodlstrmod\fR Solaris DDI 165 _ 166 \fBscsi_address\fR Solaris DDI 167 _ 168 \fBscsi_arq_status\fR Solaris DDI 169 _ 170 \fBscsi_device\fR Solaris DDI 171 _ 172 \fBscsi_extended_sense\fR Solaris DDI 173 _ 174 \fBscsi_hba_tran\fR Solaris DDI 175 _ 176 \fBscsi_inquiry\fR Solaris DDI 177 _ 178 \fBscsi_pkt\fR Solaris DDI 179 _ 180 \fBscsi_status\fR Solaris DDI 181 _ 182 \fBuio\fR DDI/DKI 183 .TE 184 185 .SH SEE ALSO 186 .sp 187 .LP 188 \fBIntro\fR(9E) 189 .SH NOTES 190 .sp 191 .LP 192 Do not declare arrays of structures as the size of the structures can change 193 between releases. Rely only on the structure members listed in this chapter and 194 not on unlisted members or the position of a member in a structure.