share/man/man9f/ddi_io_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_PUT8 9F "Nov 1, 2005"
   7 .SH NAME
   8 ddi_io_put8, ddi_io_put16, ddi_io_put32, ddi_io_putb, ddi_io_putl, ddi_io_putw
   9 \- write data to the mapped device register in I/O space
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/ddi.h>
  14 #include <sys/sunddi.h>
  15
  16
  17
  18 \fBvoid\fR \fBddi_io_put8\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint8_t *\fR\fIdev_addr\fR,
  19      uint8_t \fIvalue\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBvoid\fR \fBddi_io_put16\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint16_t *\fR\fIdev_addr\fR,
  25      uint16_t \fIvalue\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBvoid\fR \fBddi_io_put32\fR(\fBddi_acc_handle_t\fR \fIhandle\fR, \fBuint32_t *\fR\fIdev_addr\fR,
  31      uint32_t \fIvalue\fR);
  32 .fi
  33
  34 .SH INTERFACE LEVEL
  35 .sp
  36 .LP
  37 Solaris DDI specific (Solaris DDI). The \fBddi_io_put8()\fR,
  38 \fBddi_io_put16()\fR, \fBddi_io_put32()\fR, \fBddi_io_putb()\fR,
  39 \fBddi_io_putl()\fR, and \fBddi_io_putw()\fR functions are obsolete. The
  40 \fBddi_put8\fR(9F) function replaces \fBddi_io_put8()\fR. The
  41 \fBddi_put16\fR(9F) function replaces \fBddi_io_put16()\fR. The
  42 \fBddi_put32\fR(9F) function replaces \fBddi_io_put32()\fR. The
  43 \fBddi_put8\fR(9F) function replaces \fBddi_io_putb()\fR. The
  44 \fBddi_put32\fR(9F) function replaces \fBddi_io_putl()\fR. The
  45 \fBddi_put16\fR(9F) function replaces \fBddi_io_putw()\fR.
  46 .SH PARAMETERS
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIhandle\fR\fR
  51 .ad
  52 .RS 12n
  53 Data access handle returned from setup calls, such as
  54 \fBddi_regs_map_setup\fR(9F).
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIdev_addr\fR\fR
  61 .ad
  62 .RS 12n
  63 Base device address.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIvalue\fR\fR
  70 .ad
  71 .RS 12n
  72 Data to be written to the device.
  73 .RE
  74
  75 .SH DESCRIPTION
  76 .sp
  77 .LP
  78 These routines generate a write of various sizes to the device address,
  79 \fIdev_addr\fR, in I/O space. The \fBddi_io_put8()\fR, \fBddi_io_put16()\fR,
  80 and \fBddi_io_put32()\fR functions write 8 bits, 16 bits, and 32 bits of data,
  81 respectively, to the device address, \fIdev_addr\fR.
  82 .sp
  83 .LP
  84 Each individual datum will automatically be translated to maintain a consistent
  85 view between the host and the device based on the encoded information in the
  86 data access handle.  The translation may involve byte-swapping if the host and
  87 the device have incompatible endian characteristics.
  88 .SH CONTEXT
  89 .sp
  90 .LP
  91 These functions can be called from user, kernel, or interrupt context.
  92 .SH ATTRIBUTES
  93 .sp
  94 .LP
  95 See \fBattributes\fR(5) for descriptions of the following attributes:
  96 .sp
  97
  98 .sp
  99 .TS
 100 box;
 101 c | c
 102 l | l .
 103 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 104 _
 105 Interface Stability     Obsolete
 106 .TE
 107
 108 .SH SEE ALSO
 109 .sp
 110 .LP
 111 \fBisa\fR(4), \fBddi_io_get8\fR(9F), \fBddi_io_rep_get8\fR(9F),
 112 \fBddi_io_rep_put8\fR(9F), \fBddi_put8\fR(9F), \fBddi_put16\fR(9F),
 113 \fBddi_put32\fR(9F), \fBddi_regs_map_setup\fR(9F),
 114 \fBddi_device_acc_attr\fR(9S)