From patchwork Tue Apr 17 13:35:31 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Daly, Lee" X-Patchwork-Id: 38322 X-Patchwork-Delegate: pablo.de.lara.guarch@intel.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 2EF288D39; Tue, 17 Apr 2018 15:36:18 +0200 (CEST) Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by dpdk.org (Postfix) with ESMTP id 5A822AACC for ; Tue, 17 Apr 2018 15:36:02 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 17 Apr 2018 06:36:02 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.48,463,1517904000"; d="scan'208";a="34915455" Received: from silpixa00399501.ir.intel.com ([10.237.223.69]) by orsmga006.jf.intel.com with ESMTP; 17 Apr 2018 06:36:00 -0700 From: Lee Daly To: dev@dpdk.org Cc: pablo.de.lara.guarch@intel.com, greg.b.tucker@intel.com, deepak.k.jain@intel.com, fiona.trahe@intel.com, Lee Daly Date: Tue, 17 Apr 2018 14:35:31 +0100 Message-Id: <1523972132-6894-11-git-send-email-lee.daly@intel.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1523972132-6894-1-git-send-email-lee.daly@intel.com> References: <1523038388-29964-1-git-send-email-lee.daly@intel.com> <1523972132-6894-1-git-send-email-lee.daly@intel.com> Subject: [dpdk-dev] [PATCH v3 10/11] compress/isal: add generic compression driver docs X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Signed-off-by: Lee Daly --- MAINTAINERS | 6 ++ doc/guides/compressdevs/features/default.ini | 42 +++++++++++ doc/guides/compressdevs/index.rst | 12 ++++ doc/guides/compressdevs/overview.rst | 12 ++++ doc/guides/compressdevs/overview_feature_table.txt | 81 ++++++++++++++++++++++ doc/guides/index.rst | 1 + 6 files changed, 154 insertions(+) create mode 100644 doc/guides/compressdevs/features/default.ini create mode 100644 doc/guides/compressdevs/index.rst create mode 100644 doc/guides/compressdevs/overview.rst create mode 100644 doc/guides/compressdevs/overview_feature_table.txt diff --git a/MAINTAINERS b/MAINTAINERS index d2dd61c..37b9b1d 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -766,6 +766,12 @@ F: doc/guides/cryptodevs/zuc.rst F: doc/guides/cryptodevs/features/zuc.ini +Compression Drivers +------------------- +M: Pablo de Lara +T: git://dpdk.org/next/dpdk-next-crypto + + Eventdev Drivers ---------------- M: Jerin Jacob diff --git a/doc/guides/compressdevs/features/default.ini b/doc/guides/compressdevs/features/default.ini new file mode 100644 index 0000000..b7fe1e1 --- /dev/null +++ b/doc/guides/compressdevs/features/default.ini @@ -0,0 +1,42 @@ +; +; Features of a default compression driver. +; +; This file defines the features that are valid for inclusion in +; the other driver files and also the order that they appear in +; the features table in the documentation. +; +[FEATURES] +HW Accelerated = +CPU SSE = +CPU AVX = +CPU AVX2 = +CPU AVX512 = +CPU NEON = +Stateful = +By-Pass = +Chained mbufs = +; +; Supported algorithims of the 'ISA-L' compression driver. +; +[ALGORITHIM] +Deflate = +LZS = +; +; Supported checksums of the 'ISA-L' compression driver. +; +[CHECKSUMS] +Adler32 = +Crc32 = +Adler32&Crc32 = +; +; Supported huffman codes of the 'ISA-L' compression driver. +; +[HUFFMAN CODES] +Default = +Fixed = +Dynamic = +Semi-Dynamic = +; +; Supported others of the 'ISA-L' compression driver. +; +[OTHERS] diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst new file mode 100644 index 0000000..9271cee --- /dev/null +++ b/doc/guides/compressdevs/index.rst @@ -0,0 +1,12 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Intel Corporation. + +Compression Device Drivers +========================== + + +.. toctree:: + :maxdepth: 2 + :numbered: + + overview diff --git a/doc/guides/compressdevs/overview.rst b/doc/guides/compressdevs/overview.rst new file mode 100644 index 0000000..ca37de1 --- /dev/null +++ b/doc/guides/compressdevs/overview.rst @@ -0,0 +1,12 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Intel Corporation. + +Compression Device Supported Functionality Matrices +=================================================== + +Supported Feature Flags +----------------------- + +.. _table_compression_pmd_features: + +.. include:: overview_feature_table.txt diff --git a/doc/guides/compressdevs/overview_feature_table.txt b/doc/guides/compressdevs/overview_feature_table.txt new file mode 100644 index 0000000..b775124 --- /dev/null +++ b/doc/guides/compressdevs/overview_feature_table.txt @@ -0,0 +1,81 @@ + +.. raw:: html + + + +.. table:: Features availability in compress drivers + + ========================= = + Feature i + s + a + - + l + + ========================= = + Symmetric compression Y + Sym operation chaining + HW Accelerated + Protocol offload + CPU SSE Y + CPU AVX Y + CPU AVX2 Y + CPU AVX512 Y + CPU NEON + CPU ARM CE + Mbuf scatter gather + ========================= = diff --git a/doc/guides/index.rst b/doc/guides/index.rst index d60529d..18fe0ec 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -17,6 +17,7 @@ DPDK documentation nics/index bbdevs/index cryptodevs/index + compressdevs/index eventdevs/index mempool/index platform/index