               QLogic Linux Common HBA API Shared Library

    This software is licensed by QLogic for use by its customers only.
                  Copyright (c) 2003 QLogic Corporation
                           All rights reserved


Contents
========

1.  OS Support
2.  Supported Functions
3.  Special Notes
4.  Contacting QLogic


-----------------------------------------------------------------------------

1. OS Support
=============

This QLogic Linux API library package was tested on RedHat v7.2/v8.0 with
kernel version 2.4.18-14.


-----------------------------------------------------------------------------

2. Supported Functions
======================

This API release is v2.01 beta 5, which must be used with and has been
tested with driver version 6.05.00+.

The following functions are supported:

SNIA Common API functions (from v2.0 final specification) --
  HBA_GetVersion
  HBA_LoadLibrary
  HBA_FreeLibrary
  HBA_GetNumberOfAdapters 
  HBA_GetAdapterName
  HBA_OpenAdapter
  HBA_CloseAdapter
  HBA_GetAdapterAttributes
  HBA_GetAdapterPortAttributes
  HBA_GetDiscoveredPortAttributes
  HBA_SendCTPassThru
  HBA_SetRNIDMgmtInfo
  HBA_GetRNIDMgmtInfo
  HBA_SendRNID (NOTE: data returned is not SNIA 1.x compliant. See Special Notes.)
  HBA_SendScsiInquiry
  HBA_SendReportLUNs
  HBA_SendReadCapacity
  HBA_SendScsiInquiryV2
  HBA_SendReportLUNsV2
  HBA_SendReadCapacityV2
  HBA_GetFcpTargetMapping
  HBA_GetPortStatistics
  HBA_GetEventBuffer
  HBA_SendRPS
  HBA_SendRLS (current via response buffer of HBA_SendRPS)


-----------------------------------------------------------------------------

3. Special Notes
================

-   FC Port ID format

    Currently, the FC Port ID is always returned by the QLogic defined
    SDM API in 3 byte fields.  However, the SNIA defined Common API
    returns the FC Port ID in a 32bit field.  In libqlsdm v1.10 Beta+
    and Linux HBA driver v4.35 Beta and later, the ioctl and API
    implementations treat this 32bit field as if it is an array of 4
    bytes, and store the FC Port ID in bytes 1, 2, and 3 of this array.
    Byte 0 of this 32bit field is treated as a reserved field.

-   HBA_SendRNID data format

    Due to the current low level of interest in the usage of this
    function, the data format has been changed per customer request.
    The resulting data is shifted down 4 bytes compared to the
    format defined in the SNIA specification.  The value of the
    newly created 4 bytes at the beginning of the returned data
    should be ignored as they are currently only hardcoded
    values.  The function return status still represents the
    actual response status of the RNID command sent.

-   Other features not supported

    Currently Linux API library does not support any externally
    available NVRAM and diagnostics related API function.  These
    supports are planned for a later date.


-----------------------------------------------------------------------------

4. Contacting QLogic
====================

For latest product information, adapter drivers and utilities, or to
report problems related to QLA family of products, please visit QLogic's
website (www.qlogic.com). 


-----------------------------------------------------------------------------

This commercial computer software and documentation is provided with
RESTRICTED RIGHTS.  Use, duplication, or disclosure by the
Government is subject to restrictions set forth in subparagraph
(c) (1) (ii) of the Rights in Technical Data and Computer Software
clause at DFARS 252.227-7013, or subparagraphs (c) (1) and (2) of the
Commercial Computer Software -- Restricted Rights clause at
FAR 52.227-19, or Alternate III of the Rights in Data -- General
clause at FAR 52.227-14, as applicable.  The manufacturer /
subcontractor is QLogic Corp, 26650 Aliso Viejo Pkwy, Aliso Viejo,
CA  92656.

QLogic Corporation is a registered trademark.

Other products and company names are registered trademarks or trademarks 
of their respective holders.
