share/man/man9f/ddi_dma_burstsizes.9f

   1 '\" te
   2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   3 .\" Copyright (c) 1994, Sun Microsystems, Inc.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH DDI_DMA_BURSTSIZES 9F "May 24, 2014"
   8 .SH NAME
   9 ddi_dma_burstsizes \- find out the allowed burst sizes for a DMA mapping
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/conf.h>
  14 #include <sys/ddi.h>
  15 #include <sys/sunddi.h>
  16
  17
  18
  19 \fBint\fR \fBddi_dma_burstsizes\fR(\fBddi_dma_handle_t\fR \fIhandle\fR);
  20 .fi
  21
  22 .SH INTERFACE LEVEL
  23 .sp
  24 .LP
  25 Solaris DDI specific (Solaris DDI).
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIhandle\fR \fR
  31 .ad
  32 .RS 11n
  33 A \fBDMA\fR handle.
  34 .RE
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 \fBddi_dma_burstsizes()\fR returns the allowed burst sizes for a \fBDMA\fR
  40 mapping. This value is derived from the \fBdma_attr_burstsizes\fR member of the
  41 \fBddi_dma_attr\fR(9S) structure, but it shows the allowable burstsizes
  42 \fBafter\fR imposing on it the limitations of other device layers in addition
  43 to device's own limitations.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 \fBddi_dma_burstsizes()\fR returns a binary encoded value of the allowable
  48 \fBDMA\fR burst sizes. See \fBddi_dma_attr\fR(9S) for a discussion of
  49 \fBDMA\fR burst sizes.
  50 .SH CONTEXT
  51 .sp
  52 .LP
  53 This function can be called from user or interrupt context.
  54 .SH SEE ALSO
  55 .sp
  56 .LP
  57 \fBddi_dma_alloc_handle\fR(9F), \fBddi_dma_attr\fR(9S)
  58 .sp
  59 .LP
  60 \fIWriting Device Drivers\fR