summaryrefslogtreecommitdiff
path: root/usr/src/man/man9f/ddi_dma_addr_setup.9f
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man9f/ddi_dma_addr_setup.9f')
-rw-r--r--usr/src/man/man9f/ddi_dma_addr_setup.9f156
1 files changed, 0 insertions, 156 deletions
diff --git a/usr/src/man/man9f/ddi_dma_addr_setup.9f b/usr/src/man/man9f/ddi_dma_addr_setup.9f
deleted file mode 100644
index 52f3a367be..0000000000
--- a/usr/src/man/man9f/ddi_dma_addr_setup.9f
+++ /dev/null
@@ -1,156 +0,0 @@
-'\" te
-.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
-.\" 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_ADDR_SETUP 9F "Apr 04, 2006"
-.SH NAME
-ddi_dma_addr_setup \- easier DMA setup for use with virtual addresses
-.SH SYNOPSIS
-.LP
-.nf
-#include <sys/ddi.h>
-#include <sys/sunddi.h>
-
-\fBint\fR \fBddi_dma_addr_setup\fR(\fBdev_info_t *\fR\fIdip\fR, \fBstruct as *\fR\fIas\fR, \fBcaddr_t\fR \fIaddr\fR,
- \fBsize_t\fR \fIlen\fR, \fBuint_t\fR \fIflags\fR, \fBint (*\fR\fIwaitfp\fR) (caddr_t), \fBcaddr_t\fR \fIarg\fR,
- \fBddi_dma_lim_t *\fR \fIlim\fR, \fBddi_dma_handle_t *\fR\fIhandlep\fR);
-.fi
-
-.SH INTERFACE LEVEL
-.sp
-.LP
-This interface is obsolete. \fBddi_dma_addr_bind_handle\fR(9F) should be used
-instead.
-.SH PARAMETERS
-.sp
-.ne 2
-.na
-\fB\fIdip\fR\fR
-.ad
-.RS 11n
-A pointer to the device's \fBdev_info\fR structure.
-.RE
-
-.sp
-.ne 2
-.na
-\fB\fIas\fR\fR
-.ad
-.RS 11n
-A pointer to an address space structure. Should be set to \fINULL\fR, which
-implies kernel address space.
-.RE
-
-.sp
-.ne 2
-.na
-\fB\fIaddr\fR\fR
-.ad
-.RS 11n
-Virtual address of the memory object.
-.RE
-
-.sp
-.ne 2
-.na
-\fB\fIlen\fR\fR
-.ad
-.RS 11n
-Length of the memory object in bytes.
-.RE
-
-.sp
-.ne 2
-.na
-\fB\fIflags\fR\fR
-.ad
-.RS 11n
-Flags that would go into the \fBddi_dma_req\fR structure (see
-\fBddi_dma_req\fR(9S)).
-.RE
-
-.sp
-.ne 2
-.na
-\fB\fIwaitfp\fR\fR
-.ad
-.RS 11n
-The address of a function to call back later if resources aren't available now.
-The special function addresses \fBDDI_DMA_SLEEP\fR and \fBDDI_DMA_DONTWAIT\fR
-(see \fBddi_dma_req\fR(9S)) are taken to mean, respectively, wait until
-resources are available or, do not wait at all and do not schedule a callback.
-.RE
-
-.sp
-.ne 2
-.na
-\fB\fIarg\fR\fR
-.ad
-.RS 11n
-Argument to be passed to a callback function, if such a function is specified.
-.RE
-
-.sp
-.ne 2
-.na
-\fB\fIlim\fR\fR
-.ad
-.RS 11n
-A pointer to a \fBDMA\fR limits structure for this device (see
-\fBddi_dma_lim_sparc\fR(9S) or \fBddi_dma_lim_x86\fR(9S)). If this pointer is
-\fINULL\fR, a default set of \fBDMA\fR limits is assumed.
-.RE
-
-.sp
-.ne 2
-.na
-\fB\fIhandlep\fR\fR
-.ad
-.RS 11n
-Pointer to a \fBDMA\fR handle. See \fBddi_dma_setup\fR(9F) for a discussion of
-handle.
-.RE
-
-.SH DESCRIPTION
-.sp
-.LP
-The \fBddi_dma_addr_setup()\fR function is an interface to
-\fBddi_dma_setup\fR(9F). It uses its arguments to construct an appropriate
-\fBddi_dma_req\fR structure and calls \fBddi_dma_setup\fR(9F) with it.
-.SH RETURN VALUES
-.sp
-.LP
-See \fBddi_dma_setup\fR(9F) for the possible return values for this function.
-.SH CONTEXT
-.sp
-.LP
-The \fBddi_dma_addr_setup()\fR can be called from user, interrupt, or kernel
-context, except when \fIwaitfp\fR is set to \fBDDI_DMA_SLEEP\fR, in which case
-it cannot be called from interrupt context.
-.SH ATTRIBUTES
-.sp
-.LP
-See \fBattributes\fR(5) for a description of the following attributes:
-.sp
-
-.sp
-.TS
-box;
-c | c
-l | l .
-ATTRIBUTE TYPE ATTRIBUTE VALUE
-_
-Stability Level Obsolete
-.TE
-
-.SH SEE ALSO
-.sp
-.LP
-\fBattributes\fR(5), \fBddi_dma_buf_setup\fR(9F), \fBddi_dma_free\fR(9F),
-\fBddi_dma_htoc\fR(9F), \fBddi_dma_setup\fR(9F), \fBddi_dma_sync\fR(9F),
-\fBddi_iopb_alloc\fR(9F), \fBddi_dma_lim_sparc\fR(9S),
-\fBddi_dma_lim_x86\fR(9S), \fBddi_dma_req\fR(9S)
-.sp
-.LP
-\fIWriting Device Drivers\fR