Common Fibre Channel HBA Information Library Functions
HBA_SendRLS(3HBAAPI)
NAME
HBA_SendRLS, HBA_SendRPL, HBA_SendRPS, HBA_SendSRL,
HBA_SendLIRR - issue an Extended Link Service through the
local HBA PortSYNOPSIS
cc [ flag... ] file... -lHBAAPI [ library... ]
#include
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
handlean open handle returned from HBA_OpenAdapter(3HBAAPI)
hbaPortWWNHBA_SendRLS() the Port WWN of the local HBA through
which to send the RLSHBA_SendRPL() the Port WWN of the local HBA through
which to send the RPLSunOS 5.11 Last change: 1 Sep 2003 1
Common Fibre Channel HBA Information Library FunctionsHBA_SendRLS(3HBAAPI)
HBA_SendRPS() the Port WWN of the local HBA through
which to send the RPSHBA_SendSRL() the Port WWN of the local HBA through
which to send the SRLHBA_SendLIRR() the Port WWN of the local HBA through
which to send the LIRR destWWNHBA_SendRLS() the Port WWN of the remote Target to
which the RLS is sentHBA_SendLIRR() he Port WWN of the remote Target to
which the LIRR is sent wwnIf 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 whichloops 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 listis requested. If agent_wwn is zero, it is ignored.
SunOS 5.11 Last change: 1 Sep 2003 2
Common Fibre Channel HBA Information Library FunctionsHBA_SendRLS(3HBAAPI)
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 rela-
tive 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 typeIf 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. pRspBufferHBA_SendRLS() a pointer to a buffer into which the
RLS response is copiedHBA_SendRPL() a pointer to a buffer into which the
RPL response is copiedHBA_SendRPS() a pointer to a buffer into which the
RPS response is copiedHBA_SendSRL() a pointer to a buffer into which the
SRL response is copiedSunOS 5.11 Last change: 1 Sep 2003 3
Common Fibre Channel HBA Information Library FunctionsHBA_SendRLS(3HBAAPI)
HBA_SendLIRR() A pointer to a buffer into which the
LIRRresponse is copied. RspBufferSize a pointer to the size of the bufferHBA_SendRLS() A size of 28 is sufficient for the
HBA_SendLIRR() 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 asso-
ciated with the agent WWN or agent-domain. For more infor-
mation 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) inFC-FS.
RETURN VALUES
SunOS 5.11 Last change: 1 Sep 2003 4
Common Fibre Channel HBA Information Library FunctionsHBA_SendRLS(3HBAAPI)
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 rejeced 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(5) for descriptions of the following attri-
butes:____________________________________________________________
| 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(5)
T11 FC-MI Specification
SunOS 5.11 Last change: 1 Sep 2003 5
Common Fibre Channel HBA Information Library FunctionsHBA_SendRLS(3HBAAPI)
SunOS 5.11 Last change: 1 Sep 2003 6