New upstream version 18.08
[deb_dpdk.git] / doc / guides / compressdevs / overview.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2018 Intel Corporation.
3
4 Compression Device Supported Functionality Matrices
5 ===================================================
6
7 Supported Feature Flags
8 -----------------------
9
10 .. _table_compression_pmd_features:
11
12 .. include:: overview_feature_table.txt
13
14 .. Note::
15
16    - "Pass-through" feature flag refers to the ability of the PMD
17      to let input buffers pass-through it, copying the input to the output,
18      without making any modifications to it (no compression done).
19
20    - "OOP SGL In SGL Out" feature flag stands for
21      "Out-of-place Scatter-gather list Input, Scatter-gater list Output",
22      which means PMD supports different scatter-gather styled input and output buffers
23      (i.e. both can consists of multiple segments).
24
25    - "OOP SGL In LB Out" feature flag stands for
26      "Out-of-place Scatter-gather list Input, Linear Buffers Output",
27      which means PMD supports input from scatter-gathered styled buffers, outputting linear buffers
28      (i.e. single segment).
29
30    - "OOP LB In SGL Out" feature flag stands for
31      "Out-of-place Linear Buffers Input, Scatter-gather list Output",
32      which means PMD supports input from linear buffer, outputting scatter-gathered styled buffers.