ddi_dma_htoc.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_htoc 9F "16 Jan 2006" "SunOS 5.11" "Kernel Functions for Drivers"
NAME
ddi_dma_htoc - convert a DMA handle to a DMA address cookie
SYNOPSIS

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



int ddi_dma_htoc(ddi_dma_handle_t handle, off_t off, 
 ddi_dma_cookie_t *cookiep);
INTERFACE LEVEL

This interface is obsolete. ddi_dma_addr_bind_handle(9F) or ddi_dma_buf_bind_handle(9F) should be used instead.

PARAMETERS

handle

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

off

An offset into the object that handle maps.

cookiep

A pointer to a ddi_dma_cookie(9S) structure.

DESCRIPTION

The ddi_dma_htoc() function takes a DMA handle (established by ddi_dma_setup(9F)), and fills in the cookie pointed to by cookiep with the appropriate address, length, and bus type to be used to program the DMA engine.

RETURN VALUES

The ddi_dma_htoc() function returns:

DDI_SUCCESS

Successfully filled in the cookie pointed to by cookiep.

DDI_FAILURE

Failed to successfully fill in the cookie.

CONTEXT

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

ATTRIBUTES

See attributes(5) for a description of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Stability LevelObsolete
SEE ALSO

attributes(5), ddi_dma_addr_bind_handle(9F), ddi_dma_addr_setup(9F), ddi_dma_buf_bind_handle(9F), ddi_dma_buf_setup(9F), ddi_dma_setup(9F), ddi_dma_sync(9F), ddi_dma_cookie(9S)

Writing Device Drivers