General Section
The general section of the configuration file contains general parameters and statistics parameters.
Note
Default denotes the value in the configuration file when shipped or the value used if not specified in the configuration file.
This table describes the other parameters that can be included in the General section.
Parameter |
Description |
Default |
Range |
|---|---|---|---|
|
Defines the service(s) available (cryptographic [cy], symmetric [sym], asymmetric [asym], data compression [dc]). Refer to ServicesEnabled for additional details. |
<varies> |
sym, asym, cy, dc Note: Multiple values permitted, use; as the delimiter. |
|
Specifies the services that are available when the driver loads. |
Default |
See ServicesProfile for additional details. |
|
Specifies the number of cryptographic concurrent symmetric requests for cryptographic instances in general. Refer to Concurrent Requests for additional details. |
512 |
64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, or 65536 |
|
Specifies the number of cryptographic concurrent asymmetric requests for cryptographic instances in general. Refer to Concurrent Requests for additional details. |
64 |
64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, or 65536 |
|
Specifies the number of data compression concurrent requests for data compression instances in general. Refer to Concurrent Requests for additional details. |
512 |
64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, or 65536 |
|
Specifies the size in KB of each intermediate buffer in on-chip memory for dynamic compression. |
64 |
32 or 64 |
|
Flag enables dc chaining. NOTE: |
0 |
0 or 1 |
|
Default heartbeat timer. |
1000 |
> 200 |
|
Automatically resets the device in case of fatal error or heartbeat failure. |
0 |
0 or 1 |
|
This flag is to enable power management idle support. Refer to Power Management Parameters for additional details. |
1 |
0 or 1 |
|
This flag is to enable SVM support. Refer to Shared Virtual Memory Parameters for additional details. |
0 |
0 or 1 |
|
This flag is to enable Address Translation Service(ATS). Refer to Shared Virtual Memory Parameters for additional details. |
0 |
0 or 1 |
ServicesEnabled
Important
Enable only the services your workload requires. Enabling multiple services can partition internal hardware resources and may reduce the peak throughput available to an individual service. The resource allocation depends on the service combination and QAT 2.0 software version; in particular, combined SYM+ASYM mode differs from SYM+DC and ASYM+DC modes.
Additional details on the ServicesEnabled parameter:
This parameter is valid for all QAT devices.
The default value varies depending on the underlying QAT Endpoint.
cyis not a validServicesEnabledvalue for QAT 2.0 devices. Thecombined firmware object’s
cyname does not change configuration syntax; useasymand/orsyminstead.
On QAT 2.0 endpoints, a maximum of two of the three services (
asym,sym, anddc) may be enabled simultaneously.
Performance Considerations
Important
The following applies to QAT 2.0 devices. Actual performance depends on workload characteristics, including packet size; benchmark the target configuration for workload-specific results.
To maximize the hardware resources available to a service, specify only that
service in ServicesEnabled. A QAT 2.0 device has two Acceleration Engine
clusters, each with four Acceleration Engines.
With one service enabled, both crypto units can be assigned to that service.
- With
sym;dcorasym;dc, the allocation remains a 4|4 split, with one four-AE unit assigned to each service, independent of the workload mix. An idle second service does not cause its allocated AEs to be reassigned.
- With
- Starting with QAT20.L.1.2.30-00263,
sym;asymuses combined crypto firmware and configures both crypto units for multi-service operation. Unlike the earlier separate-unit allocation, SYM-capable threads are available across all eight crypto AEs. Some threads on each AE remain allocated to ASYM, so this is not equivalent to dedicating all AE threads to SYM.
- Starting with QAT20.L.1.2.30-00263,
Configuration examples:
ServicesEnabled = sym— both crypto units are assigned to SYM.ServicesEnabled = sym;dc— four AEs are assigned to SYM and four to DC.ServicesEnabled = asym;dc— four AEs are assigned to ASYM and four to DC.ServicesEnabled = sym;asym— both crypto units use combined firmware.Both services have threads across the eight crypto AEs, with threads allocated to each service within each AE.
ServicesProfile
Important
This parameter is valid for QAT1.7x devices.
The ServicesProfile parameter defines the services that are available when the driver loads. For example, if ServicesProfile = COMPRESSION is in the General section,
the compression and decompression are available, along with service chaining, but not cryptography.
Note
When a ServicesProfiles parameter value is used that supports rate limiting is defined, internal resources are reallocated to administrating Rate Limiting/Device Utilization. This reduces performance by roughly 5%.
General Default Configuration Parameters
Service |
DEFAULT |
CRYPTO |
COMPRESSION |
CUSTOM1 |
|---|---|---|---|---|
Asymmetric Crypto |
YES |
YES |
YES |
|
Symmetric Crypto |
YES |
YES |
YES |
|
Hash |
YES |
YES |
YES |
YES |
Cipher |
YES |
YES |
YES |
|
MGF KeyGen |
YES |
YES |
||
SSL/TLS KeyGen |
YES |
YES |
YES |
|
HKDF |
YES |
YES |
||
Compression |
YES |
YES |
YES |
|
Decompression (stateless) |
YES |
YES |
YES |
|
Decompression (stateful) |
YES |
YES |
||
Service Chaining |
YES |
|||
Device Utilization |
YES |
YES |
YES |
|
Rate Limiting |
YES |
YES |
YES |
Note
Set the service profile to determine available features.
Concurrent Requests
Additional details on the concurrent request parameters:
This parameter is valid for all QAT devices.
For each service enabled,
NumConcurrentRequestsmust be set to value from the range.The number of concurrent requests registered by the Intel® QuickAssist driver is set to
NumConcurrentRequests - 2.
This implementation guarantees that the request ring will never be full and avoids the need for a Memory Mapped IO (MMIO) read. This implementation maximizes throughput performance.
Power Management Parameters
Important
This parameter is valid for QAT2.0 devices.
Power management configuration is included in the device configuration file (i.e. /etc/4xxx_devX.conf where X is the 0-based index of
the device.)
Power management configurations parameters include:
PmIdleSupport- Configure the device to enable/disable power management idle supporting. Power management idle support is enabled by default.
Refer to the Power Management section for additional details.