.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "HVCS_GET_PARTNER_INFO" "9" "09 October 2005" "" ""

.SH NAME
hvcs_get_partner_info \- Get all of the partner info for a vty-server adapter
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int hvcs_get_partner_info  (uint32_t \fIunit_address\fB, struct list_head * \fIhead\fB, unsigned long * \fIpi_buff\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIunit_address\fB\fR
The unit_address of the vty-server adapter for which this
function is fetching partner info.
.TP
\fB\fIhead\fB\fR
An initialized list_head pointer to an empty list to use to return the
list of partner info fetched from the hypervisor to the caller.
.TP
\fB\fIpi_buff\fB\fR
A page sized buffer pre-allocated prior to calling this function
that is to be used to be used by firmware as an iterator to keep track
of the partner info retrieval.
.SH "DESCRIPTION"
.PP
This function returns non-zero on success, or if there is no partner info.
.PP
The pi_buff is pre-allocated prior to calling this function because this
function may be called with a spin_lock held and kmalloc of a page is not
recommended as GFP_ATOMIC.
.PP
The first long of this buffer is used to store a partner unit address.  The
second long is used to store a partner partition ID and starting at
pi_buff[2] is the 79 character Converged Location Code (diff size than the
unsigned longs, hence the casting mumbo jumbo you see later).
.PP
Invocation of this function should always be followed by an invocation of
\fBhvcs_free_partner_info\fR using a pointer to the SAME list head instance
that was passed as a parameter to this function.