'\" 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] .TH DDI_IO_GET8 9F "Nov 1, 2005" .SH NAME ddi_io_get8, ddi_io_get16, ddi_io_get32 \- read data from the mapped device register in I/O space .SH SYNOPSIS .nf #include #include \fBuint8_t\fR \fBddi_io_get8\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint8_t *\fR\fIdev_addr\fR); .fi .LP .nf \fBuint16_t\fR \fBddi_io_get16\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint16_t *\fR\fIdev_addr\fR); .fi .LP .nf \fBuint32_t\fR \fBddi_io_get32\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint32_t *\fR\fIdev_addr\fR); .fi .SH INTERFACE LEVEL illumos DDI specific (illumos DDI). The \fBddi_io_get8()\fR, \fBddi_io_get16()\fR, \fBddi_io_get32()\fR, \fBddi_io_getb()\fR, \fBddi_io_getl()\fR, and \fBddi_io_getw()\fR functions are obsolete. The \fBddi_get8\fR(9F) function replaces \fBddi_io_get8()\fR. The \fBddi_get16\fR(9F) function replaces \fBddi_io_get16()\fR. The \fBddi_get32\fR(9F) function replaces \fBddi_io_get32()\fR. .SH PARAMETERS .ne 2 .na \fB\fIhandle\fR\fR .ad .RS 12n Data access handle returned from setup calls, such as \fBddi_regs_map_setup\fR(9F). .RE .sp .ne 2 .na \fB\fIdev_addr\fR\fR .ad .RS 12n Device address. .RE .SH DESCRIPTION These routines generate a read of various sizes from the device address, \fIdev_addr\fR, in I/O space. The \fBddi_io_get8()\fR, \fBddi_io_get16()\fR, and \fBddi_io_get32()\fR functions read 8 bits, 16 bits, and 32 bits of data, respectively, from the device address, \fIdev_addr\fR. .sp .LP 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. .SH CONTEXT These functions can be called from user, kernel, or interrupt context. .SH ATTRIBUTES See \fBattributes\fR(7) for descriptions of the following attributes: .sp .sp .TS box; c | c l | l . ATTRIBUTE TYPE ATTRIBUTE VALUE _ Interface Stability Obsolete .TE .SH SEE ALSO .BR isa (5), .BR ddi_get16 (9F), .BR ddi_get32 (9F), .BR ddi_get8 (9F), .BR ddi_io_put8 (9F), .BR ddi_io_rep_get8 (9F), .BR ddi_io_rep_put8 (9F), .BR ddi_regs_map_free (9F), .BR ddi_regs_map_setup (9F), .BR ddi_device_acc_attr (9S)