Current File : //usr/man/man3devinfo/di_path_bus_addr.3devinfo

'\" te
.\" Copyright (c) 2008, 2013, Oracle and/or its affiliates. All rights reserved.
.TH di_path_bus_addr  3DEVINFO "10 Jul 2012" "SunOS 5.11" "Device Information Library Functions"
.SH NAME
di_path_bus_addr, di_path_client_node, di_path_instance, di_path_node_name, di_path_phci_node, di_path_state \- return libdevinfo path node information
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldevinfo\fR [ \fIlibrary\fR... ]
#include <libdevinfo.h>

\fBchar *\fR\fBdi_path_bus_addr\fR(\fBdi_path_t\fR \fIpath\fR);
.fi

.LP
.nf
\fBdi_node_t\fR \fBdi_path_client_node\fR(\fBdi_path_t\fR \fIpath\fR);
.fi

.LP
.nf
\fBint\fR \fBdi_path_instance\fR(\fBdi_path_t\fR \fIpath\fR);
.fi

.LP
.nf
\fBchar *\fR\fBdi_path_node_name\fR(\fBdi_path_t\fR \fIpath\fR);
.fi

.LP
.nf
\fBdi_node_t\fR \fBdi_path_phci_node\fR(\fBdi_path_t\fR \fIpath\fR);
.fi

.LP
.nf
\fBdi_path_state_t\fR \fBdi_path_state\fR(\fBdi_path_t\fR \fIpath\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIpath\fR\fR
.ad
.RS 8n
.rt  
The handle to a path node in a \fBdi_init\fR(3DEVINFO) snapshot.
.RE

.SH DESCRIPTION
.sp
.LP
These functions extract information associated with a path node. 
.SH RETURN VALUES
.sp
.LP
The \fBdi_path_bus_addr()\fR function returns a string representing the pHCI child path node's unit-address. This function is the \fBdi_path_t\fR peer of \fBdi_bus_addr\fR(3DEVINFO).
.sp
.LP
The \fBdi_path_client_node()\fR function returns the \fBdi_node_t\fR of the 'client' device node associated with the given path node. If the client device node is not present in the current device tree snapshot, \fBDI_NODE_NIL\fR is returned and \fBerrno\fR is set to \fBENOTSUP\fR.
.sp
.LP
The \fBdi_path_node_name()\fR function returns a pointer to a null-terminated string containing the path node name. This function is the \fBdi_path_t\fR peer of \fBdi_node_name\fR(3DEVINFO).
.sp
.LP
The \fBdi_path_instance()\fR function returns the instance number associated with the given path node.  A path node instance is persistent across \fBattach\fR(9E)/\fBdetach\fR(9E) and device reconfigurations, but not across reboot.  A path node instance is unrelated to a device node \fBdi_instance\fR(3DEVINFO).
.sp
.LP
The \fBdi_path_phci_node()\fR function returns the \fBdi_node_t\fR of the pHCI host adapter associated with the given path node.  If the pHCI device node is not present in the current device tree snapshot, \fBDI_NODE_NIL\fR is returned and \fBerrno\fR is set to \fBENOTSUP\fR.
.sp
.LP
The \fBdi_path_state()\fR function returns the state of an I/O path. This function may return one of the following values:
.sp
.ne 2
.mk
.na
\fB\fBDI_PATH_STATE_ONLINE\fR\fR
.ad
.sp .6
.RS 4n
Identifies that the \fBpath_info\fR node is online and I/O requests can be routed through this path.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDI_PATH_STATE_OFFLINE\fR\fR
.ad
.sp .6
.RS 4n
Identifies that the \fBpath_info\fR node is in offline state.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDI_PATH_STATE_FAULT\fR\fR
.ad
.sp .6
.RS 4n
Identifies that the \fBpath_info\fR node is in faulted state and not ready for I/O operations.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDI_PATH_STATE_STANDBY\fR\fR
.ad
.sp .6
.RS 4n
Identifies that the \fBpath_info\fR node is in standby state and not ready for I/O operations. It is a failover path.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDI_PATH_STATE_UNAVAILABLE\fR\fR
.ad
.sp .6
.RS 4n
Identifies that the \fBpath_info\fR node is in unavailable state and not ready for I/O  operations. It cannot be used as a failover path.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5)  for descriptions 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
\fBdi_bus_addr\fR(3DEVINFO), \fBdi_devfs_path\fR(3DEVINFO), \fBdi_init\fR(3DEVINFO), \fBdi_instance\fR(3DEVINFO), \fBdi_node_name\fR(3DEVINFO), \fBdi_path_client_next_path\fR(3DEVINFO), \fBdi_path_prop_next\fR(3DEVINFO), \fBdi_path_prop_bytes\fR(3DEVINFO), \fBdi_path_prop_lookup_bytes\fR(3DEVINFO), \fBdi_path_prop_next\fR(3DEVINFO), \fBlibdevinfo\fR(3LIB), \fBattributes\fR(5)
.sp
.LP
\fIWriting Device Drivers for Oracle Solaris 11.2\fR