hbaapi_fc3_mgmt_fns(3C) 												   hbaapi_fc3_mgmt_fns(3C)

NAME

       hbaapi_fc3_mgmt_fns: HBA_SendCTPassThru(), HBA_GetEventBuffer(), HBA_SetRNIDMgmtInfo(), HBA_GetRNIDMgmtInfo(), HBA_SendRNID() - Fibre Chan-
       nel SNIA HBA APIs for handling FC-3 management functions

SYNOPSIS


DESCRIPTION

       The manpage covers the following Fibre Channel Storage Network Industry Association Host Bus Adapter APIs.

       This function sends a CT pass through frame.
	      An HBA should decode this request as per routing the CT frame in a fabric according to the field within the CT frame.

	      The argument handle is of type (refer to and is obtained through a call to

	      The argument ptr_req_buffer is a pointer to the buffer which contains the CT request.

	      The argument req_buffer_size corresponds to the size of the buffer which contains the CT request.

	      The argument ptr_rsp_buffer is a pointer to the buffer which receives the response data.

	      The argument rsp_buffer_size corresponds to the size of the buffer which receives the response information.

	      This function applies only to an HBA connected in a public loop or fabric topology.

       This function removes and returns the next events from the HBA's event queue.
	      The number of events returned will be the lesser of the value of argument EventCount at call and the number of entries available	in
	      the event queue.

	      This  provides  a simple polled interface to a basic set of HBA-detected events.	An improved method of notification is intended for
	      an early subsequent version of this API.

	      The event queue's internal implementation is not constrained but its behavior is a circular queue of event records (structure  refer
	      to that represent either RSCN, link status, or other events.

	      Event  records  are added as events occur and removed in order of occurrence as any application gets them.  The size of the queue is
	      implementation dependent.  If the queue becomes full, then any newly added records will replace  the  oldest  records,  causing  the
	      older records to be lost.  If multiple applications make overlapping sequences of calls, the available events will each be delivered
	      to only one of the applications.	The exact distribution is not predictable, but the sequence of events delivered to any application
	      will still be strictly in order of event occurrence.

	      The argument handle is of type (refer to and is obtained through a call to

	      The argument event_buffer is a pointer to a buffer to receive events.

	      The  argument  event_count  corresponds  to  the number of event records in the buffer to receive events.  It is set to the size (in
	      event records) of the buffer for receiving events on call, and returned as the number of events actually delivered.

	    1. The arrival of an RSCN ELS will be treated as a separate event for each "Affected N-Port ID Page" carried by the RSCN.

	    2. This function is currently not supported by the HP SNIA vendor library implementation and will return when called.

       This function sets the RNID (Request Node Identification Information Data)
	      returned from the HBA.  For further information see Request Node Identification Data (RNID) section of and look for the topic

	      The argument handle is of type (see and is obtained through a call to

	      The argument info is a pointer to a management information structure of type

	      This function is currently not supported by the HP SNIA vendor library implementation and will return when called.

       Returns the RNID (Request Node Identification Information Data) from the HBA.
	      For further information see section in the and check for the topic

	      The argument handle is of type (refer to and is obtained through a call to

	      The argument ptr_info is pointer to buffer of type Data in this buffer when available is in Big Endian format.

	      This function is currently not supported by the HP SNIA vendor library implementation and will return when called.

       Issues an ELS RNID (Request Node Identification Data) to another node
	      in format 0xDF (Topology Discovery Specific Node Identification Data).  For further information see the section in the and look  for
	      the topic

	      The argument handle is of (refer to type and is obtained through a call to

	      The argument wwn corresponds to the Port WWN of a device's name.	The argument wwn_type has been deprecated.

	      The argument ptr_rsp_buffer is a pointer to a response buffer in Big Endian format.

	      The  argument  rsp_buffer_size  is  set to length of when calling this function.	On return, this argument contains the size of data
	      written to

	      This function is currently not supported by the HP SNIA vendor library implementation and will return when called.

RETURN VALUES

       and return the following values:

	      On success.

	      An internal library or system error is detected.

	      The library is busy processing a call that cannot be executed concurrently with other calls  and	may  be  modifying  internal  data
	      structures.

	      The handle passed to this function is invalid.

	      Any of the pointer passed to this function is NULL.

	      The adapter to which the handle corresponds is not available.

       returns:

	      In addition to the above listed errors, when the response buffer is not
						large enough to hold the complete response.

       returns:

	      In addition to the above listed errors, when the World Wide Name (WWN)
						argument passed by the user is invalid.

EXAMPLE

   HBA_SendCTPassThru()
       unsigned char test_ct_command[24] = { /* GA_NXT CT command (with zoning) */
	   0x01, 0x00, 0x00, 0x00,
	   0xFC, 0x02, 0x00, 0x00,
	   0x01, 0x00, 0x00, 0x00,
	   0x00, 0x00, 0x00, 0x00,
	   0x00, 0x00, 0x00, 0x00
	   0x00, 0x00, 0x00, 0x00
       };

       HBA_STATUS status;
       HBA_UINT32 numberofadapters;
       char adaptername[256];
       HBA_HANDLE adapterhandle;
       unsigned char test_ct_output[4096];
       memset (test_ct_output, 0, sizeof (test_ct_output));
       status = HBA_SendCTPassThru (adapterhandle, test_ct_command,
	    sizeof (test_ct_command), test_ct_output, sizeof (test_ct_output));
       if (status == HBA_STATUS_OK) {
	    printf ("HBA_SendCTPassThru with Zoning - HBA_STATUS_OK
");
	    printf ("HBA_SendCTPassThru - successful
");
       } else {
	    printf ("HBA_SendCTPassThru - Failed
");
       }

   HBA_GetEventBuffer()
       HBA_UINT32 event_count = 10;
       if ((status = HBA_GetEventBuffer(adapterhandle, &event_buffer,
	    &event_count)) == HBA_STATUS_OK) {
	    printf("success in HBA_GetEventBuffer
");
       } else
	    printf("error in HBA_GetEventBuffer
");

   HBA_SetRNIDMgmtInfo()
       if ((status = HBA_SetRNIDMgmtInfo(adapterhandle, &info)) == HBA_STATUS_OK) {
	    printf("success in HBA_SetRNIDMgmtInfo
");
       } else
	    printf("error in HBA_SetRNIDMgmtInfo
");

   HBA_GetRNIDMgmtInfo()
       if ((status = HBA_GetRNIDMgmtInfo(adapterhandle, &info)) == HBA_STATUS_OK) {
	    printf("success in HBA_GetRNIDMgmtInfo
");
       } else
	    printf("error in HBA_GetRNIDMgmtInfo
");

   HBA_SendRNID()
       if ((status = HBA_SendRNID(adapterhandle, wwn, wwntype, resp_buffer,
	    sizeof(resp_buffer))) == HBA_STATUS_OK) {
	    printf("success in HBA_SendRNID
");
       } else
	    printf("error in HBA_SendRNID
");

FILES

       Contains the related data structures and definitions as in

AUTHOR

       These APIs were developed by Hewlett-Packard Company.

SEE ALSO

       HBAAPI(3C),  HBA_GetVersion(3C),  HBA_LoadLibrary(3C),  HBA_FreeLibrary(3C),  HBA_GetNumberOfAdapters(3C), HBA_GetAdapterName(3C), HBA_Ope-
       nAdapter(3C), HBA_CloseAdapter(3C), HBA_GetAdapterAttributes(3C), HBA_GetAdapterPortAttributes(3C), HBA_GetPortStatistics(3C),  HBA_GetDis-
       coveredPortAttributes(3C),  HBA_GetPortAttributesByWWN(3C),  HBA_GetFcpTargetMapping(3C),  HBA_GetFcpPersistentBinding(3C), HBA_SendScsiIn-
       quiry(3C), HBA_SendReportLUNs(3C), HBA_SendReadCapacity(3C), HBA_RefreshInformation(3C), HBA_ResetStatistics(3C).

															   hbaapi_fc3_mgmt_fns(3C)