xref: /titanic_52/usr/src/man/man9s/Intro.9s (revision 7aa76ffc594f84c1c092911a84f85a79ddb44c73)
te
Copyright (c) 2001, Sun Microsystems, Inc., All Rights Reserved.
Copyright 1989 AT&T
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
Intro 9S "15 May 2001" "SunOS 5.11" "Data Structures for Drivers"
NAME
Intro, intro - introduction to kernel data structures and properties
DESCRIPTION

Section 9P describes kernel properties used by device drivers. Section 9S describes the data structures used by drivers to share information between the driver and the kernel. See Intro(9E) for an overview of device driver interfaces.

In Section 9S, reference pages contain the following headings:

NAME summarizes the purpose of the structure or property.

SYNOPSIS lists the include file that defines the structure or property.

INTERFACE LEVEL describes any architecture dependencies.

DESCRIPTION provides general information about the structure or property.

STRUCTURE MEMBERS lists all accessible structure members (for Section 9S).

SEE ALSO gives sources for further information.

Of the preceding headings, Section 9P reference pages contain the NAME, DESCRIPTION, and SEE ALSO fields.

Every driver MUST include <sys/ddi.h> and <sys/sunddi.h>, in that order, and as final entries.

The following table summarizes the STREAMS structures described in Section 9S.

StructureType
copyreqDDI/DKI
copyrespDDI/DKI
databDDI/DKI
fmodswSolaris DDI
free_rtnDDI/DKI
iocblkDDI/DKI
linkblkDDI/DKI
module_infoDDI/DKI
msgbDDI/DKI
qbandDDI/DKI
qinitDDI/DKI
queclassSolaris DDI
queueDDI/DKI
streamtabDDI/DKI
stroptionsDDI/DKI

The following table summarizes structures that are not specific to STREAMS I/O.

StructureType
aio_reqSolaris DDI
bufDDI/DKI
cb_opsSolaris DDI
ddi_device_acc_attrSolaris DDI
ddi_dma_attrSolaris DDI
ddi_dma_cookieSolaris DDI
ddi_dma_lim_sparcSolaris SPARC DDI
ddi_dma_lim_x86Solaris x86 DDI
ddi_dma_reqSolaris DDI
ddi_dmae_reqSolaris x86 DDI
ddi_idevice_cookieSolaris DDI
ddi_mapdev_ctlSolaris DDI
devmap_callback_ctlSolaris DDI
dev_opsSolaris DDI
iovecDDI/DKI
kstatSolaris DDI
kstat_intrSolaris DDI
kstat_ioSolaris DDI
kstat_namedSolaris DDI
mapDDI/DKI
modldrvSolaris DDI
modlinkageSolaris DDI
modlstrmodSolaris DDI
scsi_addressSolaris DDI
scsi_arq_statusSolaris DDI
scsi_deviceSolaris DDI
scsi_extended_senseSolaris DDI
scsi_hba_tranSolaris DDI
scsi_inquirySolaris DDI
scsi_pktSolaris DDI
scsi_statusSolaris DDI
uioDDI/DKI
SEE ALSO

Intro(9E)

NOTES

Do not declare arrays of structures as the size of the structures can change between releases. Rely only on the structure members listed in this chapter and not on unlisted members or the position of a member in a structure.