usr/src/man/man3rsm/rsm_memseg_import_put.3rsm

   1 '\" te
   2 .\"  Copyright (c) 2001 by 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 RSM_MEMSEG_IMPORT_PUT 3RSM "Jun 8, 2001"
   7 .SH NAME
   8 rsm_memseg_import_put, rsm_memseg_import_put8, rsm_memseg_import_put16,
   9 rsm_memseg_import_put32, rsm_memseg_import_put64 \- write to a segment
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR... ] \fIfile\fR... -lrsm [ \fIlibrary\fR... ]
  14 #include <rsmapi.h>
  15
  16 \fBint\fR \fBrsm_memseg_import_put\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
  17      \fBoff_t\fR \fIoffset\fR, \fBvoid *\fR\fIsrc_addr\fR, \fBsize_t\fR \fIlength\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBrsm_memseg_import_put8\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
  23      \fBoff_t\fR \fIoffset\fR, \fBuint8_t\fR \fIdatap\fR, \fBulong_t\fR \fIrep_cnt\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBrsm_memseg_import_put16\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
  29      \fBoff_t\fR \fIoffset\fR, \fBuint16_t\fR \fIdatap\fR, \fBulong_t\fR \fIrep_cnt\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBrsm_memseg_import_put32\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
  35      \fBoff_t\fR \fIoffset\fR, \fBuint32_t\fR \fIdatap\fR, \fBulong_t\fR \fIrep_cnt\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBrsm_memseg_import_put64\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
  41      \fBoff_t\fR \fIoffset\fR, \fBuint64_t\fR \fIdatap\fR, \fBulong_t\fR \fIrep_cnt\fR);
  42 .fi
  43
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 When using interconnects that allow memory mapping (see
  48 \fBrsm_memseg_import_map\fR(3RSM)), standard CPU memory operations may be used
  49 for accessing memory of a segment. If, however, a mapping is not provided, then
  50 explicitly calling these functions facilitates writing to a segment. Depending
  51 on the attributes of the extension library for the interconnect, these
  52 functions may involve doing an implicit mapping before performing the data
  53 transfer. Applications can be made interconnect-independent with respect to
  54 segment writes by using these functions. The data access error detection is
  55 performed through the use of barriers (see
  56 \fBrsm_memseg_import_open_barrier\fR(3RSM)). The default barrier operation mode
  57 is \fBRSM_BARRIER_MODE_IMPLICIT\fR, which means that around every put operation
  58 open and close barrier operations are performed automatically. Explicit error
  59 handling may also be set up for these functions (see
  60 \fBrsm_memseg_import_set_mode\fR(3RSM)).
  61 .sp
  62 .LP
  63 The  \fBrsm_memseg_import_put()\fR function copies \fIlength\fR bytes from
  64 local memory with start address  \fIsrc_addr\fR to the imported segment
  65 \fIim_memseg\fR beginning at location \fIoffset\fR from the start of the
  66 segment.
  67 .sp
  68 .LP
  69 The \fBrsm_memseg_import_put8()\fR function copies \fIrep_cnt\fR number of
  70 8-bit quantities from successive local memory locations pointed to by
  71 \fIdatap\fR to successive locations starting from \fIoffset\fR in the imported
  72 segment.
  73 .sp
  74 .LP
  75 The \fBrsm_memseg_import_put16()\fR function copies \fIrep_cnt\fR number of
  76 16-bit quantities from successive local memory locations pointed to by
  77 \fIdatap\fR to successive locations starting from \fIoffset\fR in the imported
  78 segment. The offset must be aligned at half-word address boundary.
  79 .sp
  80 .LP
  81 The \fBrsm_memseg_import_put32()\fR function copies \fIrep_cnt\fR number of
  82 32-bit quantities from successive local memory locations pointed to by
  83 \fIdatap\fR to successive locations starting from \fIoffset\fR in the imported
  84 segment. The offset must be aligned at word address boundary.
  85 .sp
  86 .LP
  87 The \fBrsm_memseg_import_put64()\fR function copies \fIrep_cnt\fR number of
  88 64-bit quantities from successive local memory locations pointed to by
  89 \fIdatap\fR to successive locations starting from \fIoffset\fR in the imported
  90 segment. The offset must be aligned at double-word address boundary.
  91 .sp
  92 .LP
  93 The data transfer functions that transfer small quantities of data (that is,
  94 8-, 16-, 32-, and 64-bit quantities) perform byte swapping prior to the data
  95 transfer, in the event that the source and destination have incompatible endian
  96 characteristics.
  97 .SH RETURN VALUES
  98 .sp
  99 .LP
 100 Upon successful completion, these functions return 0. Otherwise, an error value
 101 is returned to indicate the error.
 102 .SH ERRORS
 103 .sp
 104 .LP
 105 These functions can return the following errors:
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBRSMERR_BAD_SEG_HNDL\fR \fR
 110 .ad
 111 .sp .6
 112 .RS 4n
 113 Invalid segment handle.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBRSMERR_BAD_ADDR\fR \fR
 120 .ad
 121 .sp .6
 122 .RS 4n
 123 Bad address.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBRSMERR_BAD_MEM_ALIGNMENT\fR \fR
 130 .ad
 131 .sp .6
 132 .RS 4n
 133 Invalid memory alignment for pointer.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBRSMERR_BAD_OFFSET\fR \fR
 140 .ad
 141 .sp .6
 142 .RS 4n
 143 Invalid offset.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBRSMERR_BAD_LENGTH\fR \fR
 150 .ad
 151 .sp .6
 152 .RS 4n
 153 Invalid length.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBRSMERR_PERM_DENIED\fR \fR
 160 .ad
 161 .sp .6
 162 .RS 4n
 163 Permission denied.
 164 .RE
 165
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fBRSMERR_INSUFFICIENT_RESOURCES\fR \fR
 170 .ad
 171 .sp .6
 172 .RS 4n
 173 Insufficient resources.
 174 .RE
 175
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fBRSMERR_BARRIER_UNINITIALIZED\fR \fR
 180 .ad
 181 .sp .6
 182 .RS 4n
 183 Barrier not initialized.
 184 .RE
 185
 186 .sp
 187 .ne 2
 188 .na
 189 \fB\fBRSMERR_BARRIER_FAILURE\fR \fR
 190 .ad
 191 .sp .6
 192 .RS 4n
 193 I/O completion error.
 194 .RE
 195
 196 .sp
 197 .ne 2
 198 .na
 199 \fB\fBRSMERR_CONN_ABORTED\fR \fR
 200 .ad
 201 .sp .6
 202 .RS 4n
 203 Connection aborted.
 204 .RE
 205
 206 .SH ATTRIBUTES
 207 .sp
 208 .LP
 209 See \fBattributes\fR(5) for descriptions of the following attributes:
 210 .sp
 211
 212 .sp
 213 .TS
 214 box;
 215 c | c
 216 l | l .
 217 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 218 _
 219 Interface Stability     Evolving
 220 _
 221 MT-Level        MT-Safe
 222 .TE
 223
 224 .SH SEE ALSO
 225 .sp
 226 .LP
 227 \fBrsm_memseg_import_get\fR(3RSM), \fBrsm_memseg_import_init_barrier\fR(3RSM),
 228 \fBrsm_memseg_import_open_barrier\fR(3RSM),
 229 \fBrsm_memseg_import_set_mode\fR(3RSM), \fBattributes\fR(5)