Intel QuickAssist for Windows* Release Notes Package Version: QAT1.0.0-40 June 2018 Revision 001US Document Number: 337758-001US
You may not use or facilitate the use of this document in connection with any infringement or other legal analysis concerning Intel products described herein. You agree to grant Intel a non-exclusive, royalty-free license to any patent claim thereafter drafted which includes subject matter disclosed herein. Intel technologies' features and benefits depend on system configuration and may require enabled hardware, software or service activation. Performance varies depending on system configuration. No computer system can be absolutely secure. Check with your system manufacturer or retailer or learn more at intel.com. Intel technologies may require enabled hardware, specific software, or services activation. Check with your system manufacturer or retailer. The products described may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request. All information provided here is subject to change without notice. Contact your Intel representative to obtain the latest Intel product specifications and roadmaps. No computer system can be absolutely secure. Check with your system manufacturer or retailer or learn more at intel.com. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document. Intel does not control or audit third-party benchmark data or the web sites referenced in this document. You should visit the referenced web site and confirm whether referenced data are accurate. Copies of documents which have an order number and are referenced in this document may be obtained by calling 1-800-548-4725 or by visiting www.intel.com/design/literature.htm. Intel, the Intel logo, and Xeon are trademarks of Intel Corporation in the United States and other countries. *Other names and brands may be claimed as the property of others. Copyright 2018, Intel Corporation. All Rights Reserved. Release Notes v1.0.0-22 June 2018 2 Document Number: 337758-001US
Contents 1.0 Description of Release...5 1.1 Supported Hardware Platforms...5 1.2 Supported Operating Systems...5 1.3 Features...5 1.4 Customer Support...6 1.5 List of Files in this Release...6 1.6 Reference Documents...6 1.7 Terminology...7 2.0 Limitations and Known Issue...8 2.1 Limitations...8 2.2 Known Issues...8 3.0 Software Installation...9 4.0 Test Application... 10 Figures Figure 1. Device Manager...9 Tables Table 1. Intel QuickAssist Technology Generic Documentation...6 Table 2. Intel QuickAssist Technology Software Specific Documentation...6 Table 3. Terminology...7 Table 4. QATE-15336- Parcomp Compression Completion Times may Vary Widely Under Certain Conditions...8 June 2018 Release Notes v1.0.0-22 Document Number: 337758-001US 3
Revision History Revision Number Description Revision Date 001 Initial release. June 2018 Release Notes v1.0.0-22 June 2018 4 Document Number: 337758-001US
Description of Release 1.0 Description of Release This document contains information on the accompanying Intel QuickAssist Technology (intel QAT) Windows* Software release 1.0.0-40. This document also describes extensions and deviations from the release functionality described in Table 2, Intel QuickAssist Technology Software for Linux* Software Programmer s Guide for the various platforms that support Intel QAT. These release notes may include known issues with third-party or reference platform components that affect the operation of the software. 1.1 Supported Hardware Platforms The software in this release has been validated against the following devices: Intel QuickAssist Adapter 8960 and 8970 Intel Xeon Scalable Platform with Intel C62x Chipset 1.2 Supported Operating Systems The software in this release has been validated against the following Operating Systems (OS): Windows* Server 2012 R2 Update1 Windows Server 2016 1.3 Features Note: The software only provides Data Compression services. Support for cryptographic services will be provided in a future production release. The software provides the following Data Compression services: Static Deflate Stateless compression/decompression Dynamic Deflate Stateless compression/decompression Includes sample code application for compression services - parcomp Includes the following compression/decompression QATZIP APIs: qzinit qzsetupsession qzcompress qzdecompress qzteardownsession June 2018 Release Notes v1.0.0-22 Document Number: 337758-001US 5
Description of Release qzclose qzgetstatus qzsetdefaults qzgetdefaults qzmalloc qzfree Note: This software release has passed the Windows* Hardware Lab Kit (HLK*) Certification and contains certified device drivers. 1.4 Customer Support Intel offers support for this software at the Application Program Interface (API) level, defined in Table 1 and Table 2 Programmer Guides and API reference manuals listed in Section 2.3. If the field representative has created an account for you, support requests can be submitted via https://premier.intel.com. 1.5 List of Files in this Release The Bill of Materials (BOM), is included as a text file in the released software package. This text file is labeled file list and is located at the top directory level for each release. 1.6 Reference Documents Table 1 lists Intel QuickAssist Technology generic documentation. Table 2 lists Intel QuickAssist Technology specific documentation Table 1. Intel QuickAssist Technology Generic Documentation Document Document No./Location Intel QuickAssist Technology API Programmer s Guide 330684 Intel QuickAssist Technology Performance Optimization Guide 330687 Table 2. Intel QuickAssist Technology Software Specific Documentation Document Document No./Location Intel QuickAssist Technology Software for Linux* Software Programmer s Guide 336210 Release Notes v1.0.0-22 June 2018 6 Document Number: 337758-001US
Description of Release 1.7 Terminology Table 3. Terminology Term Description API BOM OPC OS Intel QAT HLK* Application Program Interface Bill of Materials Open Core Protocol Operating System Intel QuickAssist Windows* Hardware Lab Kit June 2018 Release Notes v1.0.0-22 Document Number: 337758-001US 7
Limitations and Known Issue 2.0 Limitations and Known Issue 2.1 Limitations The following features are not supported yet: Static Deflate Stateful compression/decompression Dynamic Deflate Stateful compression/decompression Public cryptography algorithms 2.2 Known Issues Table 4. QATE-15336- Parcomp Compression Completion Times may Vary Widely Under Certain Conditions Title Reference # Description Resolution Parcomp Compression Completion Times may Vary Widely Under Certain Conditions QATE-15336 During testing with parcomp with the OCP module (Intel Ethernet Network Adapter X722) installed the time taken to compress a given file can vary by a wide margin. The time taken in compress operation does not vary. The time including file I/O and memory allocations can vary from 4s to 60+s. When the OCP module is not installed the total time taken to compress the file remains consistent. No work-around available. Affected OS Windows Server 2012 Driver/Module CPM IA Compression Release Notes v1.0.0-22 June 2018 8 Document Number: 337758-001US
Software Installation 3.0 Software Installation An installation application (Setup.exe) is included in the package. Use this application to install the package on the targeted OS. For more information on how to install the package, refer to the Readme file included in the package:.\quickassist\readme.txt The README.txt file can also be found upon completion of installation in the following folder: <Program Files>\Intel\Intel(R) QuickAssist Technology For those customers that had already installed the previous evaluation version of the Intel QAT driver, uninstall it and reboot before installing this new production package. Note: To make sure the software installation completed successfully and the Intel QAT devices runs normally, Refer to Figure 1, Device Manager, lists three Intel C62x Accelerator Intel QAT devices under the Security accelerators folder. Figure 1. Device Manager June 2018 Release Notes v1.0.0-22 Document Number: 337758-001US 9
Test Application 4.0 Test Application A compression test application, parcomp, is included in this package. For more information on how to use the parcomp application, please refer to the Readme file included in the package. You can find the README file under the installed path:.\quickassist\readme.txt. Release Notes v1.0.0-22 June 2018 10 Document Number: 337758-001US