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