ddi_dma_coff.9f revision c10c16dec587a0662068f6e2991c29ed3a9db943
te
Copyright (c) 2006, 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_coff 9F "16 Jan 2006" "SunOS 5.11" "Kernel Functions for Drivers"
NAME
ddi_dma_coff - convert a DMA cookie to an offset within a DMA handle.
SYNOPSIS

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



int ddi_dma_coff(ddi_dma_handle_t handle, ddi_dma_cookie_t *cookiep,
 off_t *offp);
INTERFACE LEVEL

Solaris SPARC DDI (Solaris SPARC DDI). This interface is obsolete.

PARAMETERS

handle

The handle filled in by a call to ddi_dma_setup(9F).

cookiep

A pointer to a DMA cookie (see ddi_dma_cookie(9S)) that contains the appropriate address, length and bus type to be used in programming the DMA engine.

offp

A pointer to an offset to be filled in.

DESCRIPTION

The ddi_dma_coff() function converts the values in DMA cookie pointed to by cookiep to an offset (in bytes) from the beginning of the object that the DMAhandle has mapped.

The ddi_dma_coff() function allows a driver to update a DMA cookie with values it reads from its device's DMA engine after a transfer completes and convert that value into an offset into the object that is mapped for DMA.

RETURN VALUES

The ddi_dma_coff() function returns:

DDI_SUCCESS

Successfully filled in offp.

DDI_FAILURE

Failed to successfully fill in offp.

CONTEXT

The ddi_dma_coff() function can be called from user, interrupt, or kernel context.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityObsolete
SEE ALSO

ddi_dma_setup(9F), ddi_dma_sync(9F), ddi_dma_cookie(9S)

Writing Device Drivers