te
Copyright (c) 1994, Sun Microsystems, Inc.
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.
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.
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]
ddi_dma_nextcookie - retrieve subsequent DMA cookie

#include <sys/ddi.h>
#include <sys/sunddi.h>



void ddi_dma_nextcookie(ddi_dma_handle_t handle,
 ddi_dma_cookie_t *cookiep);

handle cookiep

Solaris DDI specific (Solaris DDI).

ddi_dma_nextcookie() retrieves subsequent DMA cookies for a DMA object. ddi_dma_nextcookie() fills in the ddi_dma_cookie(9S) structure pointed to by cookiep. The ddi_dma_cookie(9S) structure must be allocated prior to calling ddi_dma_nextcookie().

The DMA cookie count returned by ddi_dma_buf_bind_handle(9F), ddi_dma_addr_bind_handle(9F), or ddi_dma_getwin(9F) indicates the number of DMA cookies a DMA object consists of. If the resulting cookie count, N, is larger than 1, ddi_dma_nextcookie() must be called N-1 times to retrieve all DMA cookies.

ddi_dma_nextcookie() can be called from user, kernel, or interrupt context.

Example 1 Process a scatter-gather list of I/O requests.

This example demonstrates the use of ddi_dma_nextcookie() to process a scatter-gather list of I/O requests.

/* setup scatter-gather list with multiple DMA cookies */
ddi_dma_cookie_t dmacookie;
uint_t ccount;
...

status = ddi_dma_buf_bind_handle(handle, bp, DDI_DMA_READ,
 NULL, NULL, &dmacookie, &ccount);

if (status == DDI_DMA_MAPPED) {

 /* program DMA engine with first cookie */

 while (--ccount > 0) {
 ddi_dma_nextcookie(handle, &dmacookie);
 /* program DMA engine with next cookie */
 }
}
...

ddi_dma_addr_bind_handle(9F), ddi_dma_alloc_handle(9F), ddi_dma_buf_bind_handle(9F), ddi_dma_unbind_handle(9F), ddi_dma_cookie(9S)

Writing Device Drivers