Intro(9S) Data Structures for Drivers Intro(9S)
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 informa-
tion 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:
o NAME summarizes the purpose of the structure or property.
o SYNOPSIS lists the include file that defines the structure or property.
o INTERFACE LEVEL describes any architecture dependencies.
o DESCRIPTION provides general information about the structure or property.
o STRUCTURE MEMBERS lists all accessible structure members (for Section 9S).
o 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.
+-----------------------------+-----------------------------+
| Structure | Type |
+-----------------------------+-----------------------------+
|copyreq |DDI/DKI |
+-----------------------------+-----------------------------+
|copyresp |DDI/DKI |
+-----------------------------+-----------------------------+
|datab |DDI/DKI |
+-----------------------------+-----------------------------+
|fmodsw |Solaris DDI |
+-----------------------------+-----------------------------+
|free_rtn |DDI/DKI |
+-----------------------------+-----------------------------+
|iocblk |DDI/DKI |
+-----------------------------+-----------------------------+
|linkblk |DDI/DKI |
+-----------------------------+-----------------------------+
|module_info |DDI/DKI |
+-----------------------------+-----------------------------+
|msgb |DDI/DKI |
+-----------------------------+-----------------------------+
|qband |DDI/DKI |
+-----------------------------+-----------------------------+
|qinit |DDI/DKI |
+-----------------------------+-----------------------------+
|queclass |Solaris DDI |
+-----------------------------+-----------------------------+
|queue |DDI/DKI |
+-----------------------------+-----------------------------+
|streamtab |DDI/DKI |
+-----------------------------+-----------------------------+
|stroptions |DDI/DKI |
+-----------------------------+-----------------------------+
The following table summarizes structures that are not specific to STREAMS I/O.
+-----------------------------+-----------------------------+
| Structure | Type |
+-----------------------------+-----------------------------+
|aio_req |Solaris DDI |
+-----------------------------+-----------------------------+
|buf |DDI/DKI |
+-----------------------------+-----------------------------+
|cb_ops |Solaris DDI |
+-----------------------------+-----------------------------+
|ddi_device_acc_attr |Solaris DDI |
+-----------------------------+-----------------------------+
|ddi_dma_attr |Solaris DDI |
+-----------------------------+-----------------------------+
|ddi_dma_cookie |Solaris DDI |
+-----------------------------+-----------------------------+
|ddi_dma_lim_sparc |Solaris SPARC DDI |
+-----------------------------+-----------------------------+
|ddi_dma_lim_x86 |Solaris x86 DDI |
+-----------------------------+-----------------------------+
|ddi_dma_req |Solaris DDI |
+-----------------------------+-----------------------------+
|ddi_dmae_req |Solaris x86 DDI |
+-----------------------------+-----------------------------+
|ddi_idevice_cookie |Solaris DDI |
+-----------------------------+-----------------------------+
|ddi_mapdev_ctl |Solaris DDI |
+-----------------------------+-----------------------------+
|devmap_callback_ctl |Solaris DDI |
+-----------------------------+-----------------------------+
|dev_ops |Solaris DDI |
+-----------------------------+-----------------------------+
|iovec |DDI/DKI |
+-----------------------------+-----------------------------+
|kstat |Solaris DDI |
+-----------------------------+-----------------------------+
|kstat_intr |Solaris DDI |
+-----------------------------+-----------------------------+
|kstat_io |Solaris DDI |
+-----------------------------+-----------------------------+
|kstat_named |Solaris DDI |
+-----------------------------+-----------------------------+
|map |DDI/DKI |
+-----------------------------+-----------------------------+
|modldrv |Solaris DDI |
+-----------------------------+-----------------------------+
|modlinkage |Solaris DDI |
+-----------------------------+-----------------------------+
|modlstrmod |Solaris DDI |
+-----------------------------+-----------------------------+
|scsi_address |Solaris DDI |
+-----------------------------+-----------------------------+
|scsi_arq_status |Solaris DDI |
+-----------------------------+-----------------------------+
|scsi_device |Solaris DDI |
+-----------------------------+-----------------------------+
|scsi_extended_sense |Solaris DDI |
+-----------------------------+-----------------------------+
|scsi_hba_tran |Solaris DDI |
+-----------------------------+-----------------------------+
|scsi_inquiry |Solaris DDI |
+-----------------------------+-----------------------------+
|scsi_pkt |Solaris DDI |
+-----------------------------+-----------------------------+
|scsi_status |Solaris DDI |
+-----------------------------+-----------------------------+
|uio |DDI/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.
LIST OF FUNCTIONS
Name Description
aio_req(9S) asynchronous I/O request structure
buf(9S) block I/O data transfer structure
cb_ops(9S) character/block entry points structure
copyreq(9S) STREAMS data structure for the M_COPYIN and the M_COPYOUT message types
copyresp(9S) STREAMS data structure for the M_IOCDATA message type
datab(9S) STREAMS message data structure
dblk(9S) See datab(9S)
ddi_device_acc_attr(9S) data access attributes structure
ddi_dma_attr(9S) DMA attributes structure
ddi_dma_cookie(9S) DMA address cookie
ddi_dma_lim(9S) See ddi_dma_lim_sparc(9S)
ddi_dma_lim_sparc(9S) SPARC DMA limits structure
ddi_dma_lim_x86(9S) DMA limits structure
ddi_dma_req(9S) DMA Request structure
ddi_dmae_req(9S) DMA engine request structure
ddi_idevice_cookie(9S) device interrupt cookie
dev_ops(9S) device operations structure
devmap_callback_ctl(9S) device mapping-control structure
fmodsw(9S) STREAMS module declaration structure
free_rtn(9S) structure that specifies a driver's message-freeing routine
gld_mac_info(9S) Generic LAN Driver MAC info data structure
gld_stats(9S) Generic LAN Driver statistics data structure
iocblk(9S) STREAMS data structure for the M_IOCTL message type
iovec(9S) data storage structure for I/O using uio
kstat(9S) kernel statistics structure
kstat_intr(9S) structure for interrupt kstats
kstat_io(9S) structure for I/O kstats
kstat_named(9S) structure for named kstats
linkblk(9S) STREAMS data structure sent to multiplexor drivers to indicate a link
mblk(9S) See msgb(9S)
modldrv(9S) linkage structure for loadable drivers
modlinkage(9S) module linkage structure
modlstrmod(9S) linkage structure for loadable STREAMS modules
module_info(9S) STREAMS driver identification and limit value structure
msgb(9S) STREAMS message block structure
qband(9S) STREAMS queue flow control information structure
qinit(9S) STREAMS queue processing procedures structure
queclass(9S) a STREAMS macro that returns the queue message class definitions for a given message block
queue(9S) STREAMS queue structure
scsi_address(9S) SCSI address structure
scsi_arq_status(9S) SCSI auto request sense structure
scsi_asc_key_strings(9S) SCSI ASC ASCQ to message structure
scsi_device(9S) SCSI device structure
scsi_extended_sense(9S) SCSI extended sense structure
scsi_hba_tran(9S) SCSI Host Bus Adapter (HBA) driver transport vector structure
scsi_inquiry(9S) SCSI inquiry structure
scsi_pkt(9S) SCSI packet structure
scsi_status(9S) SCSI status structure
streamtab(9S) STREAMS entity declaration structure
stroptions(9S) options structure for M_SETOPTS message
tuple(9S) card information structure (CIS) access structure
uio(9S) scatter/gather I/O request structure
usb_bulk_request(9S) USB bulk request structure
usb_callback_flags(9S) USB callback flag definitions
usb_cfg_descr(9S) USB configuration descriptor
usb_client_dev_data(9S) Device configuration information
usb_completion_reason(9S) USB completion reason definitions
usb_ctrl_request(9S) USB control pipe request structure
usb_dev_descr(9S) USB device descriptor
usb_dev_qlf_descr(9S) USB device qualifier descriptor
usb_ep_descr(9S) USB endpoint descriptor
usb_if_descr(9S) USB interface descriptor
usb_intr_request(9S) USB interrupt request structure
usb_isoc_request(9S) USB isochronous request structure
usb_other_speed_cfg_descr(9S) USB other speed configuration descriptor
usb_request_attributes(9S) Definition of USB request attributes
usb_string_descr(9S) USB string descriptor
SunOS 5.10 21 Dec 2004 Intro(9S)