usr/src/man/man9f/ddi_io_get8.9f

   1 '\" te
   2 .\"  Copyright (c) 2005, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH DDI_IO_GET8 9F "Nov 1, 2005"
   7 .SH NAME
   8 ddi_io_get8, ddi_io_get16, ddi_io_get32, ddi_io_getb, ddi_io_getl, ddi_io_getw
   9 \- read data from the mapped device register in I/O space
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/ddi.h>
  14 #include <sys/sunddi.h>
  15
  16
  17
  18 \fBuint8_t\fR \fBddi_io_get8\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint8_t *\fR\fIdev_addr\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBuint16_t\fR \fBddi_io_get16\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint16_t  *\fR\fIdev_addr\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBuint32_t\fR \fBddi_io_get32\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint32_t  *\fR\fIdev_addr\fR);
  29 .fi
  30
  31 .SH INTERFACE LEVEL
  32 .sp
  33 .LP
  34 Solaris DDI specific (Solaris DDI). The \fBddi_io_get8()\fR,
  35 \fBddi_io_get16()\fR, \fBddi_io_get32()\fR, \fBddi_io_getb()\fR,
  36 \fBddi_io_getl()\fR, and \fBddi_io_getw()\fR functions are obsolete. The
  37 \fBddi_get8\fR(9F) function replaces \fBddi_io_get8()\fR. The
  38 \fBddi_get16\fR(9F) function replaces \fBddi_io_get16()\fR. The
  39 \fBddi_get32\fR(9F) function replaces \fBddi_io_get32()\fR. The
  40 \fBddi_get8\fR(9F) function replaces \fBddi_io_getb()\fR. The
  41 \fBddi_get32\fR(9F) function replaces \fBddi_io_getl()\fR. The
  42 \fBddi_get16\fR(9F) function replaces \fBddi_io_getw()\fR.
  43 .SH PARAMETERS
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIhandle\fR\fR
  48 .ad
  49 .RS 12n
  50 Data access handle returned from setup calls, such as
  51 \fBddi_regs_map_setup\fR(9F).
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fIdev_addr\fR\fR
  58 .ad
  59 .RS 12n
  60 Device address.
  61 .RE
  62
  63 .SH DESCRIPTION
  64 .sp
  65 .LP
  66 These routines generate a read of various sizes from the device address,
  67 \fIdev_addr\fR, in I/O space. The \fBddi_io_get8()\fR, \fBddi_io_get16()\fR,
  68 and \fBddi_io_get32()\fR functions read 8 bits, 16 bits, and 32 bits of data,
  69 respectively, from the device address, \fIdev_addr\fR.
  70 .sp
  71 .LP
  72 Each individual datum will automatically be translated to maintain a consistent
  73 view between the host and the device based on the encoded information in the
  74 data access handle.  The translation may involve byte-swapping if the host and
  75 the device have incompatible endian characteristics.
  76 .SH CONTEXT
  77 .sp
  78 .LP
  79 These functions can be called from user, kernel, or interrupt context.
  80 .SH ATTRIBUTES
  81 .sp
  82 .LP
  83 See \fBattributes\fR(5) for descriptions of the following attributes:
  84 .sp
  85
  86 .sp
  87 .TS
  88 box;
  89 c | c
  90 l | l .
  91 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  92 _
  93 Interface Stability     Obsolete
  94 .TE
  95
  96 .SH SEE ALSO
  97 .sp
  98 .LP
  99 \fBisa\fR(4), \fBddi_get8\fR(9F), \fBddi_get16\fR(9F), \fBddi_get32\fR(9F),
 100 \fBddi_io_put8\fR(9F), \fBddi_io_rep_get8\fR(9F), \fBddi_io_rep_put8\fR(9F),
 101 \fBddi_regs_map_free\fR(9F), \fBddi_regs_map_setup\fR(9F),
 102 \fBddi_device_acc_attr\fR(9S)