share/man/man9f/ddi_io_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_IO_REP_PUT8 9F "Nov 1, 2005"
   7 .SH NAME
   8 ddi_io_rep_put8, ddi_io_rep_put16, ddi_io_rep_put32, ddi_io_rep_putb,
   9 ddi_io_rep_putl, ddi_io_rep_putw \- write multiple data to the mapped device
  10 register in I/O space
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 #include <sys/ddi.h>
  15 #include <sys/sunddi.h>
  16
  17
  18
  19 \fBvoid\fR \fBddi_io_rep_put8\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint8_t *\fR\fIhost_addr\fR,
  20      \fBuin8_t *\fR\fIdev_addr\fR, \fBsize_t\fR \fIrepcount\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid\fR \fBddi_io_rep_put16\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint16_t *\fR\fIhost_addr\fR,
  26      \fBuin16_t *\fR\fIdev_addr\fR, \fBsize_t\fR \fIrepcount\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBvoid\fR \fBddi_io_rep_put32\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint32_t *\fR\fIhost_addr\fR,
  32      \fBuin32_t *\fR\fIdev_addr\fR, \fBsize_t\fR \fIrepcount\fR);
  33 .fi
  34
  35 .SH INTERFACE LEVEL
  36 .sp
  37 .LP
  38 Solaris DDI specific (Solaris DDI). The \fBddi_io_rep_put8()\fR,
  39 \fBddi_io_rep_put16()\fR, \fBddi_io_rep_put32()\fR, \fBddi_io_rep_putb()\fR,
  40 \fBddi_io_rep_putl()\fR, and \fBddi_io_rep_putw()\fR functions are obsolete.
  41 The \fBddi_rep_put8\fR(9F) function replaces \fBddi_io_rep_put8()\fR. The
  42 \fBddi_rep_put16\fR(9F) function replaces \fBddi_io_rep_put16()\fR. The
  43 \fBddi_rep_put32\fR(9F) function replaces \fBddi_io_rep_put32()\fR. The
  44 \fBddi_rep_put8\fR(9F) function replaces \fBddi_io_rep_putb()\fR. The
  45 \fBddi_rep_put32\fR(9F) function replaces \fBddi_io_rep_putl()\fR. The
  46 \fBddi_rep_put16\fR(9F) function replaces \fBddi_io_rep_putw()\fR.
  47 .SH PARAMETERS
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIhandle\fR\fR
  52 .ad
  53 .RS 13n
  54 Data access handle returned from setup calls, such as
  55 \fBddi_regs_map_setup\fR(9F).
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fIhost_addr\fR\fR
  62 .ad
  63 .RS 13n
  64 Base host address.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fIdev_addr\fR\fR
  71 .ad
  72 .RS 13n
  73 Base device address.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fIrepcount\fR\fR
  80 .ad
  81 .RS 13n
  82 Number of data accesses to perform.
  83 .RE
  84
  85 .SH DESCRIPTION
  86 .sp
  87 .LP
  88 These routines generate multiple writes to the device address,
  89 \fIdev_address\fR, in I/O space. \fIrepcount\fR data is copied from the host
  90 address, \fIhost_addr\fR, to the device address, \fIdev_addr\fR. For each input
  91 datum, the \fBddi_io_rep_put8()\fR, \fBddi_io_rep_put16()\fR, and
  92 \fBddi_io_rep_put32()\fR functions write 8 bits, 16 bits, and 32 bits of data,
  93 respectively, to the device address. \fIhost_addr\fR must be aligned to the
  94 datum boundary described by the function.
  95 .sp
  96 .LP
  97 Each individual datum will automatically be translated to maintain a consistent
  98 view between the host and the device based on the encoded information in the
  99 data access handle.  The translation may involve byte-swapping if the host and
 100 the device have incompatible endian characteristics.
 101 .SH CONTEXT
 102 .sp
 103 .LP
 104 These functions can be called from user, kernel, or interrupt context.
 105 .SH ATTRIBUTES
 106 .sp
 107 .LP
 108 See \fBattributes\fR(5) for descriptions of the following attributes:
 109 .sp
 110
 111 .sp
 112 .TS
 113 box;
 114 c | c
 115 l | l .
 116 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 117 _
 118 Interface Stability     Obsolete
 119 .TE
 120
 121 .SH SEE ALSO
 122 .sp
 123 .LP
 124 \fBisa\fR(4), \fBddi_io_get8\fR(9F), \fBddi_io_put8\fR(9F),
 125 \fBddi_io_rep_get8\fR(9F), \fBddi_regs_map_setup\fR(9F),
 126 \fBddi_rep_put8\fR(9F), \fBddi_rep_put16\fR(9F), \fBddi_rep_put32\fR(9F),
 127 \fBddi_device_acc_attr\fR(9S)