Fibre Channel Adapter and Converged Network Adapter (FCoE) API. Table of Contents

Size: px

Start display at page:

Download "Fibre Channel Adapter and Converged Network Adapter (FCoE) API. Table of Contents"

Allison Marshall
5 years ago
Views:

1 Fibre Channel Adapter and Converged Network Adapter (FCoE) API 1 Package Contents 2 OS Support 3 Supported Functions 4 Using the SNIA API Library 4.1 Downloading the API Release 4.2 Extracting the SNIA API Library 4.3 Installing the SNIA API Library 4.4 Installing on RHEL 4.x 4.5 Uninstalling the SNIA API Library 4.6 Enabling Debug in the API 5 Additional Notes 6 Contacting Support QLogic Corporation All rights reserved Table of Contents 1 Package Contents The Fibre Channel Adapter and Converged Network Adapter (FCoE) API for the Linux package contains the following files and directories. File or Directory Name hba.conf lib get_version libinstall libremove Release.txt Readme.txt Description Configuration file for QLogic adapters. This directory contains the API binary files to be installed. This directory contains the binary files to get API versions. Script file to install and setup adapter API library. Linux script to remove libqlsdm.so from /usr/lib and /usr/lib64. Text version of this package release file. Text version of this package readme file. Fibre Channel Adapter and Converged Network Adapter (FCoE) API Readme Page 1 of 5

2 2 OS Support The Fibre Channel Adapter and Converged Network Adapter API for Linux are compatible with the following operating system (OS) platforms: Operating Systems OS Name OS Type Hardware Platform Red Hat RHEL AS 5.x 32-bit and 64-bit Intel x86, Intel 64, AMD64, Intel IA64, and PPC64 Novell SLES 9 32-bit and 64-bit Intel x86, Intel 64, AMD64, Intel IA64, and PPC64 Novell SLES 10.x 32-bit and 64-bit Intel x86, Intel 64, AMD64, Intel IA64, and PPC64 Novell SLES 11.x 32-bit and 64-bit Intel x86, Intel 64, AMD64, Intel IA64, and PPC64 NOTE: For specific OS service packs (SP) and updates, refer to the descriptions where this software version is posted on the QLogic Web site: 3 Supported Functions The Fibre Channel Adapter and Converged Network Adapter API for Linux support the following 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 Additional Notes. HBA_SendScsiInquiry HBA_SendReportLUNs HBA_SendReadCapacity HBA_SendScsiInquiryV2 HBA_SendReportLUNsV2 HBA_SendReadCapacityV2 HBA_GetFcpTargetMappingV2 HBA_GetFcpTargetMapping HBA_GetPortStatistics HBA_GetEventBuffer HBA_SendRPS HBA_SendRLS (current via response buffer of HBA_SendRPS) Fibre Channel Adapter and Converged Network Adapter (FCoE) API Readme Page 2 of 5

3 4 Using the SNIA API Library This section provides procedures for downloading, extracting, installing, and uninstalling the SNIA API library, including: 4.1 Downloading the API Release 4.2 Extracting the SNIA API Library 4.3 Installing the SNIA API Library 4.4 Installing on RHEL 4.x 4.5 Uninstalling the SNIA API Library 4.6 Enabling Debug in the API 4.1 Downloading the API Release To download the current API release package: 1. Download the API distribution package (qlapi-vx.yybuildzz-rel.tgz) from the download pages of the QLogic Web site for your Fibre Channel Adapter or Converged Network Adapter and OS. NOTE: x is a major version, yy is a minor version, and zz is a build version of API. 2. If prompted "What would you like to do with this file?" choose Save this file to disk. 3. Create a directory on the local hard drive and download the driver. 4.2 Extracting the SNIA API Library To extract the SNIA API library: 1. Using the files you downloaded as described in section 4.1, copy the distribution file (qlapi-vx.yybuildzz-rel.tgz) to /qlapi. 2. Issue the following commands from the /(root) directory: # mkdir qlapi # cp qlapi-vx.yybuildzz-rel.tgz qlapi/ # cd qlapi # tar -xvzf *.tgz 4.3 Installing the SNIA API Library To install and set up the API library, issue the following command in the current directory: #./libinstall This command installs and sets up the Converged Network Adapter and Host Bus Adapter API library). Fibre Channel Adapter and Converged Network Adapter (FCoE) API Readme Page 3 of 5

4 4.4 Installing on RHEL 4.x In addition to installing the SNIA API library, RHEL 4.x users must load an additional kernel module, and then set the system to automatically load the module at boot time. For details, see the following sections: Load Additional Kernel Module Manually Load Module Automatically at Boot Time Load Additional Kernel Module Manually You must load an additional kernel module before using the API library on RHEL 4 update 6 and later distributions. To load this module, enter the following commands: # modprobe qioctlmod # lsmod grep qioctlmod (should show the loaded module) Load Module Automatically at Boot Time To set your system to automatically load the qioctlmod kernel module during system boot, issue the following commands: # echo modprobe qioctlmod >> /etc/rc.modules # chmod +x /etc/rc.modules 4.5 Uninstalling the SNIA API Library To remove the API library, issue the following command in the current directory: #./libremove (script file to remove Host Bus Adapter API library) 4.6 Enabling Debug in the API To enable debug in API, issue the following command: # export QL_FCAPI_DEBUG=<debug level> The following debug levels are supported by API: # QL_FCAPI_DEBUG=0x27 For SDM API debug with IOCTL-based drivers # QL_FCAPI_DEBUG=0x47 For SNIA API debug with IOCTL-based drivers # QL_FCAPI_DEBUG=0x87 For RUBAH API debug with IOCTL-based drivers # QL_FCAPI_DEBUG=0x267 For SDM and SNIA API debug with sysfs and IOCTL-based drivers # QL_FCAPI_DEBUG=0x2E7 For SDM, RUBAH, and SNIA API debug with sysfs and IOCTL-based drivers NOTES: QL_FCAPI_DEBUG=0x267 is the recommended debug level. The API debug log is saved in the /usr/lib/libqlsdm.log file. To redirect log messages seen on the console, redirect stderr to a log file, for example,./hbaapitest 2> console_log.txt. Fibre Channel Adapter and Converged Network Adapter (FCoE) API Readme Page 4 of 5

5 Additional Notes The following additional notes apply: Fibre Channel port ID format: The QLogic-defined SDM API always returns the Fibre Channel port ID in 3-byte fields.

5 5 Additional Notes The following additional notes apply: Fibre Channel port ID format: The QLogic-defined SDM API always returns the Fibre Channel port ID in 3-byte fields. However, the SNIA-defined Common API returns the Fibre Channel port ID in a 32-bit field. In libqlsdm v1.10 Beta+ and Linux Host Bus Adapter Driver v4.35 Beta and later, the ioctl and API implementations treat this 32-bit field as if it was an array of 4 bytes; it stores the Fibre Channel port ID in bytes 1, 2, and 3 of this array. It treats byte 0 of this 32-bit field as a reserved field. HBA_SendRNID data format: Due to the low level of interest in using 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. You should ignore the value of the newly created 4 bytes at the beginning of the returned data because there are currently only hard-coded values. The function return status still represents the actual response status of the RNID command sent. Other features not supported: The Linux API library does not support any externally available NVRAM and diagnostics-related API function. QLogic plans to support these features at a later date. 6 Contacting Support Please feel free to contact your QLogic approved reseller or QLogic Technical Support at any phase of integration for assistance. QLogic Technical Support can be reached by the following methods: Web: support@qlogic.com Go to Top Copyright All rights reserved worldwide. QLogic, the QLogic logo, and the Powered by QLogic logo are registered trademarks of QLogic Corporation. All other brand and product names are trademarks or registered trademarks of their respective owners. Fibre Channel Adapter and Converged Network Adapter (FCoE) API Readme Page 5 of 5

SANsurfer iscsi Host Bus Adapter CLI. Table of Contents

SANsurfer iscsi Host Bus Adapter CLI QLogic Corporation All rights reserved Table of Contents 1 Package Contents 2 Requirements 2.1 Hardware Requirements 2.2 Software Requirements 3 OS Support 4 Supported