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

   1 '\" te
   2 .\" Copyright (c) 2006, 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_FREE 9F "Jan 16, 2006"
   7 .SH NAME
   8 ddi_dma_free \- release system DMA resources
   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_free\fR(\fBddi_dma_handle_t\fR \fIhandle\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 This interface is obsolete. \fBddi_dma_free_handle\fR(9F) should be used
  24 instead.
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIhandle\fR\fR
  30 .ad
  31 .RS 10n
  32 The handle filled in by a call to \fBddi_dma_setup\fR(9F).
  33 .RE
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 The \fBddi_dma_free()\fR function releases system \fBDMA\fR resources set up by
  39 \fBddi_dma_setup\fR(9F). When a \fBDMA\fR transfer completes, the driver should
  40 free up system \fBDMA\fR resources established by a call to
  41 \fBddi_dma_setup\fR(9F). This is done by a call to \fBddi_dma_free()\fR.
  42 \fBddi_dma_free()\fR does an implicit \fBddi_dma_sync\fR(9F) for you so any
  43 further synchronization steps are not necessary.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 The \fBddi_dma_free()\fR function returns:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBDDI_SUCCESS\fR\fR
  52 .ad
  53 .RS 15n
  54 Successfully released resources
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBDDI_FAILURE\fR\fR
  61 .ad
  62 .RS 15n
  63 Failed to free resources
  64 .RE
  65
  66 .SH CONTEXT
  67 .sp
  68 .LP
  69 The \fBddi_dma_free()\fR function can be called from user, interrupt, or kernel
  70 context.
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for a description of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 Stability Level Obsolete
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBattributes\fR(5), \fBddi_dma_addr_setup\fR(9F), \fBddi_dma_buf_setup\fR(9F),
  91 \fBddi_dma_free_handle\fR(9F), \fBddi_dma_htoc\fR(9F), \fBddi_dma_sync\fR(9F),
  92 \fBddi_dma_req\fR(9S)
  93 .sp
  94 .LP
  95 \fIWriting Device Drivers\fR