usr/src/man/man3dlpi/dlpi_set_physaddr.3dlpi

   1 '\" te
   2 .\"  Copyright (c) 2007, 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 DLPI_SET_PHYSADDR 3DLPI "Aug 22, 2007"
   7 .SH NAME
   8 dlpi_set_physaddr \- set physical address using DLPI
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldlpi\fR [ \fIlibrary\fR... ]
  13 #include <libdlpi.h>
  14
  15 \fBint\fR \fBdlpi_set_physaddr\fR(\fBdlpi_handle_t\fR \fIdh\fR, \fBuint_t\fR \fItype\fR,
  16      \fBconst void *\fR\fIaddrp\fR, \fBsize_t *\fR\fIaddrlen\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBdlpi_set_physaddr()\fR function sets the physical address via \fBDLPI\fR
  23 handle \fIdh\fR associated with the \fBDLPI\fR link instance. Upon success, the
  24 physical address is set to \fIaddrp\fR with a length of \fIaddrlen\fR bytes.
  25 .sp
  26 .LP
  27 In this release, \fItype\fR must be set to \fBDL_CURR_PHYS_ADDR\fR, which sets
  28 the current physical address.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 Upon success, \fBDLPI_SUCCESS\fR is returned. If \fBDL_SYSERR\fR is returned,
  33 \fBerrno\fR contains the specific UNIX system error value. Otherwise, a
  34 \fBDLPI\fR error value defined in \fB<sys/dlpi.h>\fR or an error value listed
  35 in the following section is returned.
  36 .SH ERRORS
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBDLPI_EBADMSG\fR\fR
  41 .ad
  42 .RS 18n
  43 Bad DLPI message
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBDLPI_EINHANDLE\fR\fR
  50 .ad
  51 .RS 18n
  52 Invalid \fBDLPI\fR handle
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBDLPI_EINVAL\fR\fR
  59 .ad
  60 .RS 18n
  61 Invalid argument
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBDLPI_ETIMEDOUT\fR\fR
  68 .ad
  69 .RS 18n
  70 \fBDLPI\fR operation timed out
  71 .RE
  72
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for description of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Committed
  87 _
  88 MT-Level        Safe
  89 .TE
  90
  91 .SH SEE ALSO
  92 .sp
  93 .LP
  94 \fBdlpi_get_physaddr\fR(3DLPI), \fBlibdlpi\fR(3LIB), \fBattributes\fR(5)