share/man/man9f/ddi_mem_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_PUT8 9F "Nov 1, 2005"
   7 .SH NAME
   8 ddi_mem_put8, ddi_mem_put16, ddi_mem_put32, ddi_mem_put64, ddi_mem_putb,
   9 ddi_mem_putw, ddi_mem_putl, ddi_mem_putll \- write data to mapped device in the
  10 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 \fBvoid\fR \fBddi_mem_put8\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint8_t *\fR\fIdev_addr\fR,
  20      \fBuint8_t\fR \fIvalue\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid\fR \fBddi_mem_put16\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint16_t *\fR\fIdev_addr\fR,
  26      \fBuint16_t\fR \fIvalue\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBvoid\fR \fBddi_mem_put32\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint32_t *\fR\fIdev_addr\fR,
  32      \fBuint32_t\fR \fIvalue\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBvoid\fR \fBddi_mem_put64\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint64_t *\fR\fIdev_addr\fR,
  38      \fBuint64_t\fR \fIvalue\fR);
  39 .fi
  40
  41 .SH PARAMETERS
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIhandle\fR\fR
  46 .ad
  47 .RS 12n
  48 The data access handle returned from setup calls, such as
  49 \fBddi_regs_map_setup\fR(9F).
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIdev_addr\fR\fR
  56 .ad
  57 .RS 12n
  58 Base device address.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIvalue\fR\fR
  65 .ad
  66 .RS 12n
  67 The data to be written to the device.
  68 .RE
  69
  70 .SH INTERFACE LEVEL
  71 .sp
  72 .LP
  73 Solaris DDI specific (Solaris DDI). The \fBddi_mem_put8()\fR,
  74 \fBddi_mem_put16()\fR, \fBddi_mem_put32()\fR, \fBddi_mem_put64()\fR,
  75 \fBddi_mem_putb()\fR, \fBddi_mem_putl()\fR, \fBddi_mem_putll()\fR, and
  76 \fBddi_mem_putw()\fR functions are obsolete. The \fBddi_put8\fR(9F) function
  77 replaces \fBddi_mem_put8()\fR. The \fBddi_put16\fR(9F) function replaces
  78 \fBddi_mem_put16()\fR. The \fBddi_put32\fR(9F) function replaces
  79 \fBddi_mem_put32()\fR. The \fBddi_put64\fR(9F) function replaces
  80 \fBddi_mem_put64()\fR. The \fBddi_put8\fR(9F) function replaces
  81 \fBddi_mem_putb()\fR. The \fBddi_put32\fR(9F) function replaces
  82 \fBddi_mem_putl()\fR. The \fBddi_put64\fR(9F) function replaces
  83 \fBddi_mem_putll()\fR. The \fBddi_put16\fR(9F) function replaces
  84 \fBddi_mem_putw()\fR.
  85 .SH DESCRIPTION
  86 .sp
  87 .LP
  88 These routines generate a write of various sizes to memory space or allocated
  89 \fBDMA \fRmemory. The \fBddi_mem_put8()\fR, \fBddi_mem_put16()\fR,
  90 \fBddi_mem_put32()\fR, and \fBddi_mem_put64()\fR functions write 8 bits, 16
  91 bits, 32 bits and 64 bits of data, respectively, to the device address,
  92 \fIdev_addr\fR, in memory space.
  93 .sp
  94 .LP
  95 Each individual datum will automatically be translated to maintain a consistent
  96 view between the host and the device based on the encoded information in the
  97 data access handle. The translation may involve byte-swapping if the host and
  98 the device have incompatible endian characteristics.
  99 .SH CONTEXT
 100 .sp
 101 .LP
 102 These functions can be called from user, kernel, or interrupt context.
 103 .SH ATTRIBUTES
 104 .sp
 105 .LP
 106 See \fBattributes\fR(5) for descriptions of the following attributes:
 107 .sp
 108
 109 .sp
 110 .TS
 111 box;
 112 c | c
 113 l | l .
 114 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 115 _
 116 Interface Stability     Obsolete
 117 .TE
 118
 119 .SH SEE ALSO
 120 .sp
 121 .LP
 122 \fBddi_mem_get8\fR(9F), \fBddi_mem_rep_get8\fR(9F), \fBddi_put8\fR(9F),
 123 \fBddi_put16\fR(9F), \fBddi_put32\fR(9F), \fBddi_put64\fR(9F),
 124 \fBddi_mem_get8\fR(9F), \fBddi_regs_map_setup\fR(9F),
 125 \fBddi_device_acc_attr\fR(9S)