From patchwork Mon Jan 14 15:11:21 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tomasz Jozwiak X-Patchwork-Id: 49800 X-Patchwork-Delegate: gakhil@marvell.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 652BB1B148; Mon, 14 Jan 2019 16:11:25 +0100 (CET) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id AC2E61B12B for ; Mon, 14 Jan 2019 16:11:24 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 14 Jan 2019 07:11:23 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,478,1539673200"; d="scan'208";a="125927436" Received: from tjozwiax-mobl.ger.corp.intel.com (HELO tojo-Virtual-Machine.mshome.net) ([10.103.104.47]) by orsmga002.jf.intel.com with ESMTP; 14 Jan 2019 07:11:21 -0800 From: Tomasz Jozwiak To: dev@dpdk.org, fiona.trahe@intel.com, tomaszx.jozwiak@intel.com, pablo.de.lara.guarch@intel.com Date: Mon, 14 Jan 2019 16:11:21 +0100 Message-Id: <1547478681-3453-1-git-send-email-tomaszx.jozwiak@intel.com> X-Mailer: git-send-email 2.7.4 Subject: [dpdk-dev] [PATCH] doc: update description in qat compression guide 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" Added limitations description for the QAT compression PMD. Updated intermediate buffers description in qat.rst file. Signed-off-by: Tomasz Jozwiak Acked-by: Fiona Trahe --- doc/guides/compressdevs/qat_comp.rst | 4 ++++ doc/guides/cryptodevs/qat.rst | 6 ++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/guides/compressdevs/qat_comp.rst b/doc/guides/compressdevs/qat_comp.rst index 567a1fc..5631cb1 100644 --- a/doc/guides/compressdevs/qat_comp.rst +++ b/doc/guides/compressdevs/qat_comp.rst @@ -35,6 +35,10 @@ Limitations * Compressdev level 0, no compression, is not supported. * Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported). * No BSD support as BSD QAT kernel driver not available. +* Number of segments in mbuf chains in the op must be <= RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS from the config file. +* When using Deflate dynamic huffman encoding for compression, the input size (op.src.length) + must be < CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE from the config file, + see :ref:`building_qat_config` for more details. Installation diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst index 9fb9f01..d692c17 100644 --- a/doc/guides/cryptodevs/qat.rst +++ b/doc/guides/cryptodevs/qat.rst @@ -145,6 +145,8 @@ Quick instructions for QAT compressdev PMD are as follows: make +.. _building_qat_config: + Build Configuration ~~~~~~~~~~~~~~~~~~~ @@ -180,8 +182,8 @@ An extra (max_inflight_ops x 16) bytes per queue_pair will be used for every inc QAT compression PMD needs intermediate buffers to support Deflate compression with Dynamic Huffman encoding. CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE specifies the size of a single buffer, the PMD will allocate a multiple of these, -plus some extra space for associated meta-data. For GEN2 devices, 20 buffers plus -1472 bytes are allocated. +plus some extra space for associated meta-data. For GEN2 devices, 20 buffers are +allocated while for GEN1 devices, 12 buffers are allocated, plus 1472 bytes overhead. .. Note::