'\" te
.\"  Copyright (c) 2001 by Sun Microsystems, Inc.  All rights reserved.
.\" 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.
.\" 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.
.\" 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]
.TH RSM_MEMSEG_IMPORT_PUT 3RSM "Jun 8, 2001"
.SH NAME
rsm_memseg_import_put, rsm_memseg_import_put8, rsm_memseg_import_put16,
rsm_memseg_import_put32, rsm_memseg_import_put64 \- write to a segment
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... -lrsm [ \fIlibrary\fR... ]
#include <rsmapi.h>

\fBint\fR \fBrsm_memseg_import_put\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
     \fBoff_t\fR \fIoffset\fR, \fBvoid *\fR\fIsrc_addr\fR, \fBsize_t\fR \fIlength\fR);
.fi

.LP
.nf
\fBint\fR \fBrsm_memseg_import_put8\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
     \fBoff_t\fR \fIoffset\fR, \fBuint8_t\fR \fIdatap\fR, \fBulong_t\fR \fIrep_cnt\fR);
.fi

.LP
.nf
\fBint\fR \fBrsm_memseg_import_put16\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
     \fBoff_t\fR \fIoffset\fR, \fBuint16_t\fR \fIdatap\fR, \fBulong_t\fR \fIrep_cnt\fR);
.fi

.LP
.nf
\fBint\fR \fBrsm_memseg_import_put32\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
     \fBoff_t\fR \fIoffset\fR, \fBuint32_t\fR \fIdatap\fR, \fBulong_t\fR \fIrep_cnt\fR);
.fi

.LP
.nf
\fBint\fR \fBrsm_memseg_import_put64\fR(\fBrsm_memseg_import_handle_t\fR \fIim_memseg\fR,
     \fBoff_t\fR \fIoffset\fR, \fBuint64_t\fR \fIdatap\fR, \fBulong_t\fR \fIrep_cnt\fR);
.fi

.SH DESCRIPTION
.sp
.LP
When using interconnects that allow memory mapping (see
\fBrsm_memseg_import_map\fR(3RSM)), standard CPU memory operations may be used
for accessing memory of a segment. If, however, a mapping is not provided, then
explicitly calling these functions facilitates writing to a segment. Depending
on the attributes of the extension library for the interconnect, these
functions may involve doing an implicit mapping before performing the data
transfer. Applications can be made interconnect-independent with respect to
segment writes by using these functions. The data access error detection is
performed through the use of barriers (see
\fBrsm_memseg_import_open_barrier\fR(3RSM)). The default barrier operation mode
is \fBRSM_BARRIER_MODE_IMPLICIT\fR, which means that around every put operation
open and close barrier operations are performed automatically. Explicit error
handling may also be set up for these functions (see
\fBrsm_memseg_import_set_mode\fR(3RSM)).
.sp
.LP
The  \fBrsm_memseg_import_put()\fR function copies \fIlength\fR bytes from
local memory with start address  \fIsrc_addr\fR to the imported segment
\fIim_memseg\fR beginning at location \fIoffset\fR from the start of the
segment.
.sp
.LP
The \fBrsm_memseg_import_put8()\fR function copies \fIrep_cnt\fR number of
8-bit quantities from successive local memory locations pointed to by
\fIdatap\fR to successive locations starting from \fIoffset\fR in the imported
segment.
.sp
.LP
The \fBrsm_memseg_import_put16()\fR function copies \fIrep_cnt\fR number of
16-bit quantities from successive local memory locations pointed to by
\fIdatap\fR to successive locations starting from \fIoffset\fR in the imported
segment. The offset must be aligned at half-word address boundary.
.sp
.LP
The \fBrsm_memseg_import_put32()\fR function copies \fIrep_cnt\fR number of
32-bit quantities from successive local memory locations pointed to by
\fIdatap\fR to successive locations starting from \fIoffset\fR in the imported
segment. The offset must be aligned at word address boundary.
.sp
.LP
The \fBrsm_memseg_import_put64()\fR function copies \fIrep_cnt\fR number of
64-bit quantities from successive local memory locations pointed to by
\fIdatap\fR to successive locations starting from \fIoffset\fR in the imported
segment. The offset must be aligned at double-word address boundary.
.sp
.LP
The data transfer functions that transfer small quantities of data (that is,
8-, 16-, 32-, and 64-bit quantities) perform byte swapping prior to the data
transfer, in the event that the source and destination have incompatible endian
characteristics.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, these functions return 0. Otherwise, an error value
is returned to indicate the error.
.SH ERRORS
.sp
.LP
These functions can return the following errors:
.sp
.ne 2
.na
\fB\fBRSMERR_BAD_SEG_HNDL\fR \fR
.ad
.sp .6
.RS 4n
Invalid segment handle.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_BAD_ADDR\fR \fR
.ad
.sp .6
.RS 4n
Bad address.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_BAD_MEM_ALIGNMENT\fR \fR
.ad
.sp .6
.RS 4n
Invalid memory alignment for pointer.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_BAD_OFFSET\fR \fR
.ad
.sp .6
.RS 4n
Invalid offset.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_BAD_LENGTH\fR \fR
.ad
.sp .6
.RS 4n
Invalid length.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_PERM_DENIED\fR \fR
.ad
.sp .6
.RS 4n
Permission denied.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_INSUFFICIENT_RESOURCES\fR \fR
.ad
.sp .6
.RS 4n
Insufficient resources.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_BARRIER_UNINITIALIZED\fR \fR
.ad
.sp .6
.RS 4n
Barrier not initialized.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_BARRIER_FAILURE\fR \fR
.ad
.sp .6
.RS 4n
I/O completion error.
.RE

.sp
.ne 2
.na
\fB\fBRSMERR_CONN_ABORTED\fR \fR
.ad
.sp .6
.RS 4n
Connection aborted.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Evolving
_
MT-Level	MT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBrsm_memseg_import_get\fR(3RSM), \fBrsm_memseg_import_init_barrier\fR(3RSM),
\fBrsm_memseg_import_open_barrier\fR(3RSM),
\fBrsm_memseg_import_set_mode\fR(3RSM), \fBattributes\fR(5)