usr/src/man/man9f/ddi_mem_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_MEM_GET8 9F "Nov 1, 2005"
   7 .SH NAME
   8 ddi_mem_get8, ddi_mem_get16, ddi_mem_get32, ddi_mem_get64, ddi_mem_getb,
   9 ddi_mem_getl, ddi_mem_getll, ddi_mem_getw \- read data from mapped device in
  10 the memory space or allocated DMA memory
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 #include <sys/ddi.h>
  15 #include <sys/sunddi.h>
  16
  17
  18
  19 \fBuint8_t\fR \fBddi_mem_get8\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint8_t *\fR\fIdev_addr\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBuint16_t\fR \fBddi_mem_get16\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint16_t *\fR \fIdev_addr\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBuint32_t\fR \fBddi_mem_get32\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint32_t *\fR\fIdev_addr\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBuint64_t\fR \fBddi_mem_get64\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint64_t *\fR\fIdev_addr\fR);
  35 .fi
  36
  37 .SH INTERFACE LEVEL
  38 .sp
  39 .LP
  40 Solaris DDI specific (Solaris DDI). The \fBddi_mem_get8()\fR,
  41 \fBddi_mem_get16()\fR, \fBddi_mem_get32()\fR, \fBddi_mem_get64()\fR,
  42 \fBddi_mem_getb()\fR, \fBddi_mem_getl()\fR, \fBddi_mem_getll()\fR, and
  43 \fBddi_mem_getw()\fR functions are obsolete. The \fBddi_get8\fR(9F) function
  44 replaces \fBddi_mem_get8()\fR. The \fBddi_get16\fR(9F) function replaces
  45 \fBddi_mem_get16()\fR. The \fBddi_get32\fR(9F) function replaces
  46 \fBddi_mem_get32()\fR. The \fBddi_get64\fR(9F) function replaces
  47 \fBddi_mem_get64()\fR. The \fBddi_get8\fR(9F) function replaces
  48 \fBddi_mem_getb()\fR. The \fBddi_get32\fR(9F) function replaces
  49 \fBddi_mem_getl()\fR. The \fBddi_get64\fR(9F) function replaces
  50 \fBddi_mem_getll()\fR. The \fBddi_get16\fR(9F) function replaces
  51 \fBddi_mem_getw()\fR.
  52 .SH PARAMETERS
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIhandle\fR\fR
  57 .ad
  58 .RS 12n
  59 The data access handle returned from setup calls, such as
  60 \fBddi_regs_map_setup\fR(9F).
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fIdev_addr\fR\fR
  67 .ad
  68 .RS 12n
  69 Base device address.
  70 .RE
  71
  72 .SH DESCRIPTION
  73 .sp
  74 .LP
  75 These routines generate a read of various sizes from memory space or allocated
  76 \fBDMA \fRmemory. The \fBddi_mem_get8()\fR, \fBddi_mem_get16()\fR,
  77 \fBddi_mem_get32()\fR, and \fBddi_mem_get64()\fR functions read 8 bits, 16
  78 bits, 32 bits and 64 bits of data, respectively, from the device address,
  79 \fIdev_addr\fR, in memory space.
  80 .sp
  81 .LP
  82 Each individual datum will automatically be translated to maintain a consistent
  83 view between the host and the device based on the encoded information in the
  84 data access handle. The translation may involve byte-swapping if the host and
  85 the device have incompatible endian characteristics.
  86 .SH CONTEXT
  87 .sp
  88 .LP
  89 These functions can be called from user, kernel, or interrupt context.
  90 .SH ATTRIBUTES
  91 .sp
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .sp
  95
  96 .sp
  97 .TS
  98 box;
  99 c | c
 100 l | l .
 101 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 102 _
 103 Interface Stability     Obsolete
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBddi_get8\fR(9F), \fBddi_get16\fR(9F), \fBddi_get32\fR(9F),
 110 \fBddi_get64\fR(9F), \fBddi_mem_put8\fR(9F), \fBddi_mem_rep_get8\fR(9F),
 111 \fBddi_mem_rep_put8\fR(9F), \fBddi_regs_map_setup\fR(9F),
 112 \fBddi_device_acc_attr\fR(9S)