xref: /illumos-gate/usr/src/man/man9f/ddi_get8.9f (revision f37b3cbb6f67aaea5eec1c335bdc7bf432867d64)
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_GET8 9F "March 6, 2023"
NAME
ddi_get8, ddi_get16, ddi_get32, ddi_get64, - read data from the mapped memory address, device register or allocated DMA memory address
SYNOPSIS
#include <sys/ddi.h>
#include <sys/sunddi.h>



uint8_t ddi_get8(ddi_acc_handle_t handle, uint8_t *dev_addr);

uint16_t ddi_get16(ddi_acc_handle_t handle, uint16_t *dev_addr);

uint32_t ddi_get32(ddi_acc_handle_t handle, uint32_t *dev_addr);

uint64_t ddi_get64(ddi_acc_handle_t handle, uint64_t *dev_addr);
INTERFACE LEVEL
illumos DDI specific (illumos DDI). The ddi_getb(), ddi_getl(), ddi_getll(), and ddi_getw() functions are obsolete. The ddi_get8() function replaces ddi_getb(). The ddi_get32() function replaces ddi_getl(). The ddi_get64() function replaces ddi_getll(). The ddi_get16() function replaces ddi_getw().
PARAMETERS
handle

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

dev_addr

Base device address.

DESCRIPTION
The ddi_get8(), ddi_get16(), ddi_get32(), and ddi_get64() functions read 8 bits, 16 bits, 32 bits and 64 bits of data, respectively, from the device address, dev_addr.

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.

These DDI functions can be called from a high-interrupt context for the ISA bus and, under certain conditions, for the PCI bus. See sysbus(5), isa(5) and pci(5) for details.

RETURN VALUES
These functions return the value read from the mapped address.
CONTEXT
These functions can be called from user, kernel, or interrupt context.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
SEE ALSO
ddi_put8 (9F), ddi_regs_map_free (9F), ddi_regs_map_setup (9F), ddi_rep_get8 (9F), ddi_rep_put8 (9F)