usr/src/man/man9f/ddi_dma_unbind_handle.9f

   1 '\" te
   2 .\" Copyright (c) 1994, Sun Microsystems, Inc.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH DDI_DMA_UNBIND_HANDLE 9F "Sep 26, 1994"
   7 .SH NAME
   8 ddi_dma_unbind_handle \- unbinds the address in a DMA handle
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h>
  14
  15
  16
  17 \fBint\fR \fBddi_dma_unbind_handle\fR(\fBddi_dma_handle_t\fR \fIhandle\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIhandle\fR \fR
  25 .ad
  26 .RS 11n
  27 The  \fBDMA\fR handle previously allocated by a call to
  28 \fBddi_dma_alloc_handle\fR(9F).
  29 .RE
  30
  31 .SH INTERFACE LEVEL
  32 .sp
  33 .LP
  34 Solaris DDI specific (Solaris DDI).
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 \fBddi_dma_unbind_handle()\fR frees all  \fBDMA\fR resources associated with an
  39 existing  \fBDMA\fR handle.  When a  \fBDMA\fR transfer completes, the driver
  40 should call \fBddi_dma_unbind_handle()\fR to free system  \fBDMA\fR resources
  41 established by a call to \fBddi_dma_buf_bind_handle\fR(9F) or
  42 \fBddi_dma_addr_bind_handle\fR(9F). \fBddi_dma_unbind_handle()\fR does an
  43 implicit \fBddi_dma_sync\fR(9F) making further synchronization steps
  44 unnecessary.
  45 .SH RETURN VALUES
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBDDI_SUCCESS\fR \fR
  50 .ad
  51 .RS 16n
  52 on success
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBDDI_FAILURE\fR \fR
  59 .ad
  60 .RS 16n
  61 on failure
  62 .RE
  63
  64 .SH CONTEXT
  65 .sp
  66 .LP
  67 \fBddi_dma_unbind_handle()\fR can be called from user, kernel, or interrupt
  68 context.
  69 .SH SEE ALSO
  70 .sp
  71 .LP
  72 \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F),
  73 \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_free_handle\fR(9F),
  74 \fBddi_dma_sync\fR(9F)
  75 .sp
  76 .LP
  77 \fIWriting Device Drivers\fR