xref: /illumos-gate/usr/src/man/man9f/ddi_mem_rep_get8.9f (revision 80d556f9fa4f5a4857a6619909d286fb17e240f7)
te
Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
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_MEM_REP_GET8 9F "Nov 1, 2005"
NAME
ddi_mem_rep_get8, ddi_mem_rep_get16, ddi_mem_rep_get32, ddi_mem_rep_get64, - read multiple data from mapped device in the memory space or allocated DMA memory
SYNOPSIS
#include <sys/ddi.h>
#include <sys/sunddi.h>



void ddi_mem_rep_get8(ddi_acc_handle_t handle,
 uint8_t *host_addr, uint8_t *dev_addr, size_t repcount,
 uint_t flags);

void ddi_mem_rep_get16(ddi_acc_handle_t handle,
 uint16_t *host_addr, uint16_t *dev_addr, size_t repcount,
 uint_t flags);

void ddi_mem_rep_get32(ddi_acc_handle_t handle,
 uint32_t *host_addr, uint32_t *dev_addr, size_t repcount,
 uint_t flags);

void ddi_mem_rep_get64(ddi_acc_handle_t handle,
 uint64_t *host_addr, uint64_t *dev_addr, size_t repcount,
 uint_t flags);
INTERFACE LEVEL
illumos DDI specific (illumos DDI). The ddi_mem_rep_get8(), ddi_mem_rep_get16(), ddi_mem_rep_get32(), ddi_mem_rep_get64(), ddi_mem_rep_getb(), ddi_mem_rep_getl(), ddi_mem_rep_getll(), and ddi_mem_rep_getw() functions are obsolete. The ddi_rep_get8(9F) function replaces ddi_mem_rep_get8(). The ddi_rep_get16(9F) function replaces ddi_mem_rep_get16(). The ddi_rep_get32(9F) function replaces ddi_mem_rep_get32(). The ddi_rep_get64(9F) function replaces ddi_mem_rep_get64().
PARAMETERS
handle

The data access handle returned from setup calls, such as ddi_regs_map_setup(9F).

host_addr

Base host address.

dev_addr

Base device address.

repcount

Number of data accesses to perform.

flags

Device address flags: DDI_DEV_AUTOINCR

Automatically increment the device address, dev_addr, during data accesses.

DDI_DEV_NO_AUTOINCR

Do not advance the device address, dev_addr, during data accesses.

DESCRIPTION
These routines generate multiple reads from memory space or allocated DMA memory. repcount data is copied from the device address, dev_addr, in memory space to the host address, host_addr. For each input datum, the ddi_mem_rep_get8(), ddi_mem_rep_get16(), ddi_mem_rep_get32(), and ddi_mem_rep_get64() functions read 8 bits, 16 bits, 32 bits and 64 bits of data, respectively, from the device address, dev_addr. dev_addr and host_addr must be aligned to the datum boundary described by the function.

Each individual datum will automatically be translated to maintain a consistent view between the host and the device based on the encoded information in the data access handle. The translation may involve byte-swapping if the host and the device have incompatible endian characteristics.

When the flags argument is set to DDI_DEV_AUTOINCR, these functions will treat the device address, dev_addr, as a memory buffer location on the device and increments its address on the next input datum. However, when the flags argument is set to DDI_DEV_NO_AUTOINCR, the same device address will be used for every datum access. For example, this flag may be useful when reading from a data register.

CONTEXT
These functions can be called from user, kernel, or interrupt context.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Obsolete
SEE ALSO
ddi_mem_get8(9F), ddi_mem_put8(9F), ddi_mem_rep_put8(9F), ddi_regs_map_setup(9F), ddi_rep_get8(9F), ddi_rep_get16(9F), ddi_rep_get32(9F), ddi_rep_get64(9F), ddi_device_acc_attr(9S)