summaryrefslogtreecommitdiff
path: root/usr/src/man/man9f/ddi_add_intr.9f
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2021-06-05 13:56:20 -0500
committerRichard Lowe <richlowe@richlowe.net>2021-06-16 18:11:25 -0500
commit3184921aa9155f2314caa4909eba31a0be558b3d (patch)
tree667e64951654ac5e690b652a17b1a265a8f96486 /usr/src/man/man9f/ddi_add_intr.9f
parentceab728f83b0af9260d2d3fb69014f3781af2101 (diff)
downloadillumos-joyent-3184921aa9155f2314caa4909eba31a0be558b3d.tar.gz
13854 manual should say "illumos DDI"
Reviewed by: Peter Tribble <peter.tribble@gmail.com> Reviewed by: Andy Fiddaman <andy@omnios.org> Reviewed by: Toomas Soome <tsoome@me.com> Approved by: Gordon Ross <gordon.w.ross@gmail.com>
Diffstat (limited to 'usr/src/man/man9f/ddi_add_intr.9f')
-rw-r--r--usr/src/man/man9f/ddi_add_intr.9f27
1 files changed, 1 insertions, 26 deletions
diff --git a/usr/src/man/man9f/ddi_add_intr.9f b/usr/src/man/man9f/ddi_add_intr.9f
index e8c445a525..1a68b1bb04 100644
--- a/usr/src/man/man9f/ddi_add_intr.9f
+++ b/usr/src/man/man9f/ddi_add_intr.9f
@@ -8,7 +8,6 @@
ddi_add_intr, ddi_get_iblock_cookie, ddi_remove_intr \- hardware interrupt
handling routines
.SH SYNOPSIS
-.LP
.nf
#include <sys/types.h>
#include <sys/conf.h>
@@ -37,14 +36,10 @@ handling routines
.fi
.SH INTERFACE LEVEL
-.sp
-.LP
-Solaris DDI specific (Solaris DDI). These interfaces are obsolete. Use the new
+illumos DDI specific (illumos DDI). These interfaces are obsolete. Use the new
interrupt interfaces referenced in \fBIntro\fR(9F). Refer to \fIWriting Device
Drivers\fR for more information.
.SH PARAMETERS
-.sp
-.LP
For \fBddi_get_iblock_cookie()\fR:
.sp
.ne 2
@@ -164,8 +159,6 @@ Block cookie which identifies the interrupt handler to be removed.
.SH DESCRIPTION
.SS "ddi_get_iblock_cookie(\|)"
-.sp
-.LP
\fBddi_get_iblock_cookie()\fR retrieves the interrupt block cookie associated
with a particular interrupt specification. This routine should be called before
\fBddi_add_intr()\fR to retrieve the interrupt block cookie needed to
@@ -189,8 +182,6 @@ locks. This may happen when an interrupt for a different device occurs on the
same interrupt level. If the interrupt routine acquires the lock before the
lock has been initialized, undefined behavior may result.
.SS "ddi_add_intr(\|)"
-.sp
-.LP
\fBddi_add_intr()\fR adds an interrupt handler to the system. The interrupt
number \fIinumber\fR determines which interrupt the handler will be associated
with. (Refer to \fBddi_get_iblock_cookie()\fR above.)
@@ -224,8 +215,6 @@ information cannot be found on the sun4u architecture, either
sun4m architectures, if the interrupt information cannot be found,
\fBDDI_INTR_NOTFOUND\fR is returned.
.SS "ddi_remove_intr(\|)"
-.sp
-.LP
\fBddi_remove_intr()\fR removes an interrupt handler from the system.
Unloadable drivers should call this routine during their \fBdetach\fR(9E)
routine to remove their interrupt handler from the system.
@@ -237,14 +226,10 @@ for the device interrupt routine to complete before returning. Therefore, locks
acquired by the interrupt handler should not be held across the call to
\fBddi_remove_intr()\fR or deadlock may result.
.SS "For All Three Functions:"
-.sp
-.LP
For certain bus types, you can call these \fBDDI\fR functions from a
high-interrupt context. These types include \fBISA\fR and SBus buses. See
\fBsysbus\fR(4), \fBisa\fR(4), and \fBsbus\fR(4) for details.
.SH RETURN VALUES
-.sp
-.LP
\fBddi_add_intr()\fR and \fBddi_get_iblock_cookie()\fR return:
.sp
.ne 2
@@ -275,13 +260,9 @@ On failure. \fBDDI_FAILURE\fR can also be returned on failure to find interrupt
.RE
.SH CONTEXT
-.sp
-.LP
\fBddi_add_intr()\fR, \fBddi_remove_intr()\fR, and
\fBddi_get_iblock_cookie()\fR can be called from user or kernel context.
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -296,8 +277,6 @@ Interface Stability Obsolete
.TE
.SH SEE ALSO
-.sp
-.LP
\fBdriver.conf\fR(4), \fBisa\fR(4), \fBsbus\fR(4), \fBsysbus\fR(4),
\fBattach\fR(9E), \fBdetach\fR(9E), \fBddi_intr_hilevel\fR(9F),
\fBIntro\fR(9F), \fBmutex\fR(9F), \fBmutex_init\fR(9F), \fBrw_init\fR(9F),
@@ -306,8 +285,6 @@ Interface Stability Obsolete
.LP
\fIWriting Device Drivers\fR
.SH NOTES
-.sp
-.LP
\fBddi_get_iblock_cookie()\fR must not be called \fBafter\fR the driver adds an
interrupt handler for the interrupt specification corresponding to
\fIinumber\fR.
@@ -317,8 +294,6 @@ All consumers of these interfaces, checking return codes, should verify
\fBreturn_code != DDI_SUCCESS\fR. Checking for specific failure codes can
result in inconsistent behaviors among platforms.
.SH BUGS
-.sp
-.LP
The \fIidevice_cookiep\fR should really point to a data structure that is
specific to the bus architecture that the device operates on. Currently the
SBus and PCI buses are supported and a single data structure is used to