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

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   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_GET_ATTR 9F "Oct 12, 2005"
   7 .SH NAME
   8 ddi_dma_get_attr \- get the device DMA attribute structure from 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_get_attr\fR(\fBddi_dma_handle_t\fR \fIhandle\fR, \fBddi_dma_attr_t *\fR\fIattrp\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI). This interface is obsolete.
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIhandle\fR\fR
  29 .ad
  30 .RS 10n
  31 The handle filled in by a call to \fBddi_dma_alloc_handle\fR(9F).
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIattrp\fR\fR
  38 .ad
  39 .RS 10n
  40 Pointer to a buffer suitable for holding a DMA attribute structure. See
  41 \fBddi_dma_attr\fR(9S).
  42 .RE
  43
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 \fBddi_dma_get_attr()\fR is used to get a \fBddi_dma_attr\fR(9S) structure.
  48 This structure describes the attributes of the DMA data path to which any
  49 memory object bound to the given handle will be subject.
  50 .SH RETURN VALUES
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBDDI_SUCCESS\fR\fR
  55 .ad
  56 .RS 19n
  57 Successfully passed back attribute structure in buffer pointed to by
  58 \fIattrp\fR.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBDDI_DMA_BADATTR\fR\fR
  65 .ad
  66 .RS 19n
  67 A valid attribute structure could not be passed back.
  68 .RE
  69
  70 .SH CONTEXT
  71 .sp
  72 .LP
  73 \fBddi_dma_get_attr()\fR can be called from any context.
  74 .SH ATTRIBUTES
  75 .sp
  76 .LP
  77 See \fBattributes\fR(5) for descriptions of the following attributes:
  78 .sp
  79
  80 .sp
  81 .TS
  82 box;
  83 c | c
  84 l | l .
  85 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  86 _
  87 Interface Stability     Obsolete
  88 .TE
  89
  90 .SH SEE ALSO
  91 .sp
  92 .LP
  93 \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_attr\fR(9S)