From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 1AB3B271 for ; Tue, 24 Apr 2018 13:04:29 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 24 Apr 2018 04:04:29 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.49,322,1520924400"; d="scan'208";a="44208531" Received: from irsmsx104.ger.corp.intel.com ([163.33.3.159]) by FMSMGA003.fm.intel.com with ESMTP; 24 Apr 2018 04:04:28 -0700 Received: from irsmsx108.ger.corp.intel.com ([169.254.11.155]) by IRSMSX104.ger.corp.intel.com ([169.254.5.171]) with mapi id 14.03.0319.002; Tue, 24 Apr 2018 12:04:25 +0100 From: "De Lara Guarch, Pablo" To: "Daly, Lee" , "dev@dpdk.org" CC: "Tucker, Greg B" , "Jain, Deepak K" , "Trahe, Fiona" Thread-Topic: [PATCH v3 11/11] compress/isal: add ISA-L compression PMD docs Thread-Index: AQHT1lERwsOu4QFdwUKWssPHU2bGN6QPxwow Date: Tue, 24 Apr 2018 11:04:25 +0000 Message-ID: References: <1523038388-29964-1-git-send-email-lee.daly@intel.com> <1523972132-6894-1-git-send-email-lee.daly@intel.com> <1523972132-6894-12-git-send-email-lee.daly@intel.com> In-Reply-To: <1523972132-6894-12-git-send-email-lee.daly@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYjc5OWE1ZTAtOGVhNS00NjFmLTkxYmQtZmQ0ZDg0ZjZkNWIwIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6Ik9hQjZEbFFRSE9ndDYydTFFYm84aWZwdkZrMDl1SnpaUm9JTVA5RXVKKzQ9In0= x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.0.200.100 dlp-reaction: no-action x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v3 11/11] compress/isal: add ISA-L compression PMD 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: , X-List-Received-Date: Tue, 24 Apr 2018 11:04:30 -0000 > -----Original Message----- > From: Daly, Lee > Sent: Tuesday, April 17, 2018 2:36 PM > To: dev@dpdk.org > Cc: De Lara Guarch, Pablo ; Tucker, Greg = B > ; Jain, Deepak K ; Trah= e, > Fiona ; Daly, Lee > Subject: [PATCH v3 11/11] compress/isal: add ISA-L compression PMD docs Change title to " doc: add compress isa-l PMD guide >=20 > Signed-off-by: Lee Daly > --- > MAINTAINERS | 5 ++ > devtools/test-build.sh | 4 ++ > doc/guides/compressdevs/features/isal.ini | 40 +++++++++++++ > doc/guides/compressdevs/index.rst | 1 + > doc/guides/compressdevs/isal.rst | 94 > +++++++++++++++++++++++++++++++ > 5 files changed, 144 insertions(+) > create mode 100644 doc/guides/compressdevs/features/isal.ini > create mode 100644 doc/guides/compressdevs/isal.rst >=20 > diff --git a/MAINTAINERS b/MAINTAINERS > index 37b9b1d..baccae7 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -771,6 +771,11 @@ Compression Drivers > M: Pablo de Lara > T: git://dpdk.org/next/dpdk-next-crypto Add F: doc/guides/compressdev/features/default.ini, but better in patch 10. >=20 > +ISA-L PMD > +M: Lee Daly > +F: drivers/compress/isal You can add these three lines above in the first patch and then add the files below in this patch. > +F: doc/guides/compressdevs/isal.rst > +F: doc/guides/compressdevs/features/isal.ini >=20 > Eventdev Drivers > ---------------- > diff --git a/devtools/test-build.sh b/devtools/test-build.sh index > 3362edc..66f3ece 100755 > --- a/devtools/test-build.sh > +++ b/devtools/test-build.sh ... > + test "$DPDK_DEP_ISAL" !=3D y || \ > + sed -ri 's,(ISAL_PMD=3D)n,\1y,' $1/.config > test "$DPDK_DEP_PCAP" !=3D y || \ > sed -ri 's,(PCAP=3D)n,\1y,' $1/.config > test -z "$ARMV8_CRYPTO_LIB_PATH" || \ diff --git Add the changes for test-build.sh in first patch. ... > diff --git a/doc/guides/compressdevs/index.rst > b/doc/guides/compressdevs/index.rst > index 9271cee..bc59ce8 100644 > --- a/doc/guides/compressdevs/index.rst > +++ b/doc/guides/compressdevs/index.rst > @@ -10,3 +10,4 @@ Compression Device Drivers > :numbered: >=20 > overview > + isal > diff --git a/doc/guides/compressdevs/isal.rst > b/doc/guides/compressdevs/isal.rst > new file mode 100644 > index 0000000..d76f7ae > --- /dev/null > +++ b/doc/guides/compressdevs/isal.rst > @@ -0,0 +1,94 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2018 Intel Corporation. > + > +ISA-L Compression Poll Mode Driver > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +The ISA-L PMD (**librte_pmd_isal_comp**) provides poll mode compression > +& decompression driver support for utilizing Intel ISA-L library, which > +implements the deflate algorithim for both compression and > +decompression > + > +Features > +-------- > + > +ISA-L PMD has support for: > + > +Compression/Decompression algorithm: > + > +* DEFLATE > + > +Huffman code type: > + > +* DEFAULT > +* FIXED > +* DYNAMIC Remove DEFAULT, which is supported by all PMDs. > + > +Checksum support: > + > +* Adler32 > +* CRC32 > + > +Window size support: > + > +* 32K > + > +Limitations > +----------- > + > +* Chained mbufs are not supported. > + > +* Compressdev level 0, no compression, is not supported. ISA-L level 0 > +used for > + > +fixed huffman codes. > + > +* Out of order operations are not supported I don't think this is a limitation. What kind of "out of order" do you mean= here? Some PMDs can process operations out of order, but that is expected from th= e API. If a PMD processes them in order, it is also OK. ... > +The following parameters (all optional) can be provided in the previous = two > calls: There is only one parameter, so change to "the following parameter". > + > +* socket_id: Specify the socket where the memory for the device is > +going to be allocated > + (by default, socket_id will be the socket where the core that is creat= ing the > PMD is running on). > -- > 2.7.4