'\" te
.\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
.TH dlpi_get_physaddr 3DLPI "22 Aug 2007" "SunOS 5.11" "Data Link Provider Interface Library Functions"
.SH NAME
dlpi_get_physaddr \- get physical address using DLPI
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldlpi\fR [ \fIlibrary\fR... ]
#include <libdlpi.h>

\fBint\fR \fBdlpi_get_physaddr\fR(\fBdlpi_handle_t\fR \fIdh\fR, \fBuint_t\fR \fItype\fR,
     \fBvoid *\fR\fIaddrp\fR,\fBsize_t *\fR\fIaddrlenp\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBdlpi_get_physaddr()\fR function gets a physical address from the \fBDLPI\fR link instance associated with \fBDLPI\fR handle \fIdh\fR. The retrieved address depends upon \fItype\fR, which can be:
.sp
.ne 2
.mk
.na
\fB\fBDL_FACT_PHYS_ADDR\fR\fR
.ad
.RS 21n
.rt  
Factory physical address 
.RE

.sp
.ne 2
.mk
.na
\fB\fBDL_CURR_PHYS_ADDR\fR\fR
.ad
.RS 21n
.rt  
Current physical address
.RE

.sp
.LP
The operation can be performed in any \fBDLPI\fR state of \fIdh\fR.
.sp
.LP
The caller must ensure that \fIaddrp\fR is at least \fBDLPI_PHYSADDR_MAX\fR bytes in size and \fIaddrlenp\fR must contain the length of \fIaddrp\fR. Upon success, \fIaddrp\fR contains the specified physical address, and \fIaddrlenp\fR contains the physical address length. If a physical address is not available, \fIaddrp\fR is not filled in and \fIaddrlenp\fR is set to zero.
.SH RETURN VALUES
.sp
.LP
Upon success, \fBDLPI_SUCCESS\fR is returned. If \fBDL_SYSERR\fR is returned, \fBerrno\fR contains the specific UNIX system error value. Otherwise, a \fBDLPI\fR error value defined in \fB<sys/dlpi.h>\fR or an error value listed in the following section is returned.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBDLPI_EBADMSG\fR\fR
.ad
.RS 18n
.rt  
Bad DLPI message
.RE

.sp
.ne 2
.mk
.na
\fB\fBDLPI_EINHANDLE\fR\fR
.ad
.RS 18n
.rt  
Invalid \fBDLPI\fR handle
.RE

.sp
.ne 2
.mk
.na
\fB\fBDLPI_EINVAL\fR\fR
.ad
.RS 18n
.rt  
Invalid argument
.RE

.sp
.ne 2
.mk
.na
\fB\fBDLPI_ETIMEDOUT\fR\fR
.ad
.RS 18n
.rt  
\fBDLPI\fR operation timed out
.RE

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

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBdlpi_set_physaddr\fR(3DLPI), \fBlibdlpi\fR(3LIB), \fBattributes\fR(5)