usr/src/man/man9f/ddi_dma_nextcookie.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_NEXTCOOKIE 9F "Sep 26, 1994"
   7 .SH NAME
   8 ddi_dma_nextcookie \- retrieve subsequent DMA cookie
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h>
  14
  15
  16
  17 \fBvoid\fR \fBddi_dma_nextcookie\fR(\fBddi_dma_handle_t\fR \fIhandle\fR,
  18      \fBddi_dma_cookie_t *\fR\fIcookiep\fR);
  19 .fi
  20
  21 .SH PARAMETERS
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fIhandle\fR\fR
  26 .ad
  27 .RS 11n
  28 The handle previously allocated by a call to  \fBddi_dma_alloc_handle\fR(9F).
  29 .RE
  30
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIcookiep\fR\fR
  35 .ad
  36 .RS 11n
  37 A pointer to a  \fBddi_dma_cookie\fR(9S) structure.
  38 .RE
  39
  40 .SH INTERFACE LEVEL
  41 .sp
  42 .LP
  43 Solaris DDI specific (Solaris DDI).
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 \fBddi_dma_nextcookie()\fR retrieves subsequent  \fBDMA\fR cookies for a
  48 \fBDMA\fR object.   \fBddi_dma_nextcookie()\fR fills in the
  49 \fBddi_dma_cookie\fR(9S) structure pointed to by  \fIcookiep\fR. The
  50 \fBddi_dma_cookie\fR(9S) structure must be allocated prior to calling
  51 \fBddi_dma_nextcookie()\fR.
  52 .sp
  53 .LP
  54 The \fBDMA\fR cookie count returned by \fBddi_dma_buf_bind_handle\fR(9F),
  55 \fBddi_dma_addr_bind_handle\fR(9F), or \fBddi_dma_getwin\fR(9F) indicates the
  56 number of \fBDMA\fR cookies a \fBDMA\fR object consists of. If the resulting
  57 cookie count,  \fIN\fR, is larger than 1,  \fBddi_dma_nextcookie()\fR must be
  58 called \fIN\fR-1 times to retrieve all  \fBDMA\fR cookies.
  59 .SH CONTEXT
  60 .sp
  61 .LP
  62 \fBddi_dma_nextcookie()\fR can be called from user, kernel, or interrupt
  63 context.
  64 .SH EXAMPLES
  65 .LP
  66 \fBExample 1 \fRProcess a scatter-gather list of I/O requests.
  67 .sp
  68 .LP
  69 This example demonstrates the use of  \fBddi_dma_nextcookie()\fR to process a
  70 scatter-gather list of I/O requests.
  71
  72 .sp
  73 .in +2
  74 .nf
  75 /* setup scatter-gather list with multiple DMA cookies */
  76 ddi_dma_cookie_t  dmacookie;
  77 uint_t            ccount;
  78 \&...
  79
  80 status = ddi_dma_buf_bind_handle(handle, bp, DDI_DMA_READ,
  81         NULL, NULL, &dmacookie, &ccount);
  82
  83 if (status == DDI_DMA_MAPPED) {
  84
  85         /* program DMA engine with first cookie */
  86
  87         while (--ccount > 0) {
  88                 ddi_dma_nextcookie(handle, &dmacookie);
  89                 /* program DMA engine with next cookie */
  90         }
  91 }
  92 \&...
  93 .fi
  94 .in -2
  95
  96 .SH SEE ALSO
  97 .sp
  98 .LP
  99 \fBddi_dma_addr_bind_handle\fR(9F), \fBddi_dma_alloc_handle\fR(9F),
 100 \fBddi_dma_buf_bind_handle\fR(9F), \fBddi_dma_unbind_handle\fR(9F),
 101 \fBddi_dma_cookie\fR(9S)
 102 .sp
 103 .LP
 104 \fIWriting Device Drivers\fR