share/man/man9f/ddi_rep_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_REP_GET8 9F "Nov 1, 2005"
   7 .SH NAME
   8 ddi_rep_get8, ddi_rep_get16, ddi_rep_get32, ddi_rep_get64, ddi_rep_getw,
   9 ddi_rep_getl, ddi_rep_getll, ddi_rep_getb \- read data from the mapped memory
  10 address, device register or allocated DMA memory address
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 #include <sys/ddi.h>
  15 #include <sys/sunddi.h>
  16
  17
  18
  19 \fBvoid\fR \fBddi_rep_get8\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint8_t\fR \fI*host_addr\fR,
  20      \fBuint8_t\fR \fI*dev_addr\fR, \fBsize_t\fR \fIrepcount\fR, \fBuint_t\fR \fIflags\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid\fR \fBddi_rep_get16\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint16_t\fR \fI*host_addr\fR,
  26      \fBuint16_t\fR \fI*dev_addr\fR, \fBsize_t\fR \fIrepcount\fR, \fBuint_t\fR \fIflags\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBvoid\fR \fBddi_rep_get32\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint32_t\fR \fI*host_addr\fR,
  32      \fBuint32_t\fR \fI*dev_addr\fR, \fBsize_t\fR \fIrepcount\fR, \fBuint_t\fR \fIflags\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBvoid\fR \fBddi_rep_get64\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint64_t\fR \fI*host_addr\fR,
  38      \fBuint64_t\fR \fI*dev_addr\fR, \fBsize_t\fR \fIrepcount\fR, \fBuint_t\fR \fIflags\fR);
  39 .fi
  40
  41 .SH INTERFACE LEVEL
  42 .sp
  43 .LP
  44 Solaris DDI specific (Solaris DDI). The \fBddi_rep_getb()\fR,
  45 \fBddi_rep_getl()\fR, \fBddi_rep_getll()\fR, and \fBddi_rep_getw()\fR functions
  46 are obsolete. The \fBddi_rep_get8()\fR function replaces \fBddi_rep_getb()\fR.
  47 The \fBddi_rep_get32()\fR function replaces \fBddi_rep_getl()\fR. The
  48 \fBddi_rep_get64()\fR function replaces \fBddi_rep_getll()\fR. The
  49 \fBddi_rep_get16()\fR function replaces \fBddi_rep_getw()\fR.
  50 .SH PARAMETERS
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIhandle\fR\fR
  55 .ad
  56 .RS 13n
  57 The data access handle returned from setup calls, such as
  58 \fBddi_regs_map_setup\fR(9F).
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIhost_addr\fR\fR
  65 .ad
  66 .RS 13n
  67 Base host address.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fIdev_addr\fR\fR
  74 .ad
  75 .RS 13n
  76 Base device address.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fIrepcount\fR\fR
  83 .ad
  84 .RS 13n
  85 Number of data accesses to perform.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fIflags\fR\fR
  92 .ad
  93 .RS 13n
  94 Device address flags:
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBDDI_DEV_AUTOINCR\fR\fR
  99 .ad
 100 .RS 23n
 101 Automatically increment the device address, \fIdev_addr\fR, during data
 102 accesses.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBDDI_DEV_NO_AUTOINCR\fR\fR
 109 .ad
 110 .RS 23n
 111 Do not advance the device address, \fIdev_addr\fR, during data accesses.
 112 .RE
 113
 114 .RE
 115
 116 .SH DESCRIPTION
 117 .sp
 118 .LP
 119 These routines generate multiple reads from the mapped memory or device
 120 register. \fIrepcount\fR data is copied from the device address,
 121 \fIdev_addr\fR, to the host address, \fIhost_addr\fR. For each input datum, the
 122 \fBddi_rep_get8()\fR, \fBddi_rep_get16()\fR, \fBddi_rep_get32()\fR, and
 123 \fBddi_rep_get64()\fR functions read 8 bits, 16 bits, 32 bits, and 64 bits of
 124 data, respectively, from the device address, \fIdev_addr\fR. \fIdev_addr\fR and
 125 \fIhost_addr\fR must be aligned to the datum boundary described by the
 126 function.
 127 .sp
 128 .LP
 129 Each individual datum will automatically be translated to maintain a consistent
 130 view between the host and the device based on the encoded information in the
 131 data access handle. The translation may involve byte-swapping if the host and
 132 the device have incompatible endian characteristics.
 133 .sp
 134 .LP
 135 When the  \fIflags\fR argument is set to \fBDDI_DEV_AUTOINCR\fR, these function
 136 treat the device address, \fIdev_addr\fR, as a memory buffer location on the
 137 device and increment its address on the next input datum. However, when the
 138 \fIflags\fR argument is to \fBDDI_DEV_NO_AUTOINCR\fR, the same device address
 139 will be used for every datum access. For example, this flag may be useful when
 140 reading from a data register.
 141 .SH RETURN VALUES
 142 .sp
 143 .LP
 144 These functions return the value read from the mapped address.
 145 .SH CONTEXT
 146 .sp
 147 .LP
 148 These functions can be called from user, kernel, or interrupt context.
 149 .SH ATTRIBUTES
 150 .sp
 151 .LP
 152 See \fBattributes\fR(5) for descriptions of the following attributes:
 153 .sp
 154
 155 .sp
 156 .TS
 157 box;
 158 c | c
 159 l | l .
 160 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 161 _
 162 Interface Stability     T{
 163 \fBddi_rep_getb()\fR, \fBddi_rep_getl()\fR, \fBddi_rep_getll()\fR, and \fBddi_rep_getw()\fR are Obsolete \fBddi_rep_get8()\fR, \fBddi_rep_get16()\fR, \fBddi_rep_get32()\fR, \fBddi_rep_get64()\fR are Committed
 164 T}
 165 .TE
 166
 167 .SH SEE ALSO
 168 .sp
 169 .LP
 170 \fBddi_get8\fR(9F), \fBddi_put8\fR(9F), \fBddi_regs_map_free\fR(9F),
 171 \fBddi_regs_map_setup\fR(9F), \fBddi_rep_put8\fR(9F)