Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

HBA_SendSRL(3HBAAPI)

Name

HBA_SendRLS, HBA_SendRPL, HBA_SendRPS, HBA_SendSRL, HBA_SendLIRR - issue an Extended Link Service through the local HBA Port

Synopsis

cc [ flag… ] file–lHBAAPI [ library… ]
#include <hbaapi.h>

HBA_STATUS  HBA_SendRLS(HBA_HANDLE handle, HBA_WWN hbaPortWWN,
     HBA_WWN destWWN, void * pRspBuffer,
     HBA_UINT32 *pRspBufferSize);
HBA_STATUS HBA_SendRPL(HBA_HANDLE handle, HBA_WWN hbaPortWWN,
     HBA_WWN agentWWN, HBA_UINT32 agent_domain,
     HBA_UINT32 portIndex, void * pRspBuffer,
     HBA_UINT32 *pRspBufferSize);
HBA_STATUS HBA_SendRPS(HBA_HANDLE handle, HBA_WWN hbaPortWWN,
     HBA_WWN agentWWN, HBA_UINT32 agent_domain,
     HBA_WWN object_wwn, HBA_UINT32 object_port_number,
     void * pRspBuffer, HBA_UINT32 *pRspBufferSize);
HBA_STATUS HBA_SendSRL(HBA_HANDLE handle, HBA_WWN hbaPortWWN,
     HBA_WWN wwn, HBA_UINT32 domain,
     void * pRspBuffer, HBA_UINT32 *pRspBufferSize);
HBA_STATUS HBA_SendLIRR(HBA_HANDLE handle, HBA_WWN hbaPortWWN,
     HBA_WWN destWWN, HBA_UINT8 function, HBA_UINT8 type,
     void * pRspBuffer, HBA_UINT32 *pRspBufferSize);

Parameters

handle

an open handle returned from HBA_OpenAdapter(3HBAAPI)

hbaPortWWN
HBA_SendRLS()

the Port WWN of the local HBA through which to send the RLS

HBA_SendRPL()

the Port WWN of the local HBA through which to send the RPL

HBA_SendRPS()

the Port WWN of the local HBA through which to send the RPS

HBA_SendSRL()

the Port WWN of the local HBA through which to send the SRL

HBA_SendLIRR()

the Port WWN of the local HBA through which to send the LIRR

destWWN
HBA_SendRLS()

the Port WWN of the remote Target to which the RLS is sent

HBA_SendLIRR()

the Port WWN of the remote Target to which the LIRR is sent

wwn

If non-zero, wwn is the port WWN to be scanned. If wwn is zero, it is ignored.

domain

If wwn is zero, domain is the domain number for which loops will be scanned. If wwn is non-zero, domain is ignored.

agent_wwn

If non-zero, agent_wwn is the port WWN for which the port list is requested. If agent_wwn is zero, it is ignored.

agent_domain

If agent_wwn is non-zero, agent_domain is the domain number and the domain controller for which the port list is requested. If agent_wwn is zero, it is ignored.

port_index

index of the first FC_Port returned in the response list

object_wwn

If non-zero, object_wwn is the port WWN for which the Port Status is requested. If object_wwn is zero, it is ignored.

object_port_number

If object_wwn is zero, object_port_number is the relative port number of the FC_Port for which the Port Status is requested. If object_wwn is non-zero, object_port_number is ignored.

function

the registration function to be performed

type

If type is non-zero, the type is the FC-4 device TYPE for which specific link incident information requested is requested. If type is zero, only common link incident information is requested.

pRspBuffer
HBA_SendRLS()

a pointer to a buffer into which the RLS response is copied

HBA_SendRPL()

a pointer to a buffer into which the RPL response is copied

HBA_SendRPS()

a pointer to a buffer into which the RPS response is copied

HBA_SendSRL()

a pointer to a buffer into which the SRL response is copied

HBA_SendLIRR()

A pointer to a buffer into which the LIRRresponse is copied.

RspBufferSize

a pointer to the size of the buffer

HBA_SendRLS()
HBA_SendLIRR()

A size of 28 is sufficient for the largest response.

HBA_SendRPS()

A size of 58 is sufficient for the largest response.

HBA_SendSRL()

A size of 8 is sufficient for the largest response.

Description

The HBA_SendRLS() function returns the Link Error Status Block associated with the agent WWN or agent-domain. For more information see "Read Link Status Block (RLS)" in FC-FS.

The HBA_SendRPL() function returns the Read Port List associated with the agent WWN or agent-domain. For more information see "Read Port List (RPL)" in FC-FS.

The HBA_SendRPS() function returns the Read Port Status Block associated with the agent WWN or agent-domain. For more information see "Read Port Status Block(RPS)" in FC-FS.

The HBA_SendSRL() function returns the Scan Remote Loop associated with the agent WWN or agent-domain. For more information see "Scan Remote Loop(SRL)" in FC-FS.

The HBA_SendLIRR() function returns the Link Incident Record Registration associated with the destportWWN. For more information see "Link Incident Record Registration (LIRR) in FC-FS.

Return Values

These functions return the following values:

HBA_STATUS_OK

The LS_ACC for the ELS has been returned.

HBA_STATUS_ERROR_ELS_REJECT

The ELS has been rejected by the local HBA Port.

HBA_STATUS_ERROR_ILLEGAL_WWN

The value of hbaPortWWN is not a valid port WWN on the specified HBA.

HBA_STATUS_ERROR

An error occurred.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
Standard: FC-HBA Version 4 (API version 2)
MT-Level
Safe
Standard
FC-MI 1.92 (API version 1)

See Also

HBA_OpenAdapter(3HBAAPI), libhbaapi(3LIB), attributes(7)

T11 FC-MI Specification