About this Document
This programmer’s guide provides information on the architecture of the software and usage guidelines.
Information on the use of Intel® QuickAssist Technology (Intel® QAT) APIs, which provide the interface to the acceleration services (cryptographic and data compression), is documented in the related Intel® QAT software library documentation referenced in the Release Notes.
In this document, for convenience:
Software package is used as a generic term for the Intel® QAT Software Package for Hardware Version 2.0.
Acceleration driver is used as a generic term for the software that allows the Intel® QAT Software Library APIs to access the Intel® QAT Endpoint(s).
Note
Refer to the Release Notes for a list of supported platforms.
Note
Current version of this document covers the out-of-tree acceleration driver. Future version of this document will be updated to cover in-tree driver as well.
For additional details on in-tree driver refer to https://github.com/intel/qatlib.
Conventions and Terminology
The following conventions are used in this manual:
Code text- code examples, command line entries, Application Programming Interface (API) names, parameters, filenames, directory paths, and executables.Bold text - graphical user interface entries, buttons, and actions in instructions.
Italic text - key terms and publication titles.
The following terms and acronyms are used in this manual.
Term |
Description |
|---|---|
API |
Application Programming Interface |
asym |
Asymmetric Cryptography |
BDF |
Bus Device Function |
BOM |
Bill of Materials |
CBC |
Cipher Block Chaining |
cy |
Cryptography |
dc |
Data Compression |
GRUB |
Grand Unified Bootloader |
OS |
Operating System |
PCI |
Peripheral Component Interconnect |
PF |
PCIe Physical Function |
Intel® QAT |
Intel® QuickAssist Technology |
SKU |
Stock Keeping Unit |
SR-IOV |
Single Root-I/O Virtualization |
VF |
Virtual Function |