From: "De Lara Guarch, Pablo" <pablo.de.lara.guarch@intel.com>
To: "Daly, Lee" <lee.daly@intel.com>, "dev@dpdk.org" <dev@dpdk.org>
Cc: "Tucker, Greg B" <greg.b.tucker@intel.com>,
"Jain, Deepak K" <deepak.k.jain@intel.com>,
"Trahe, Fiona" <fiona.trahe@intel.com>
Subject: Re: [dpdk-dev] [PATCH v3 11/11] compress/isal: add ISA-L compression PMD docs
Date: Tue, 24 Apr 2018 11:04:25 +0000 [thread overview]
Message-ID: <E115CCD9D858EF4F90C690B0DCB4D8976CCDBACB@IRSMSX108.ger.corp.intel.com> (raw)
In-Reply-To: <1523972132-6894-12-git-send-email-lee.daly@intel.com>
> -----Original Message-----
> From: Daly, Lee
> Sent: Tuesday, April 17, 2018 2:36 PM
> To: dev@dpdk.org
> Cc: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Tucker, Greg B
> <greg.b.tucker@intel.com>; Jain, Deepak K <deepak.k.jain@intel.com>; Trahe,
> Fiona <fiona.trahe@intel.com>; Daly, Lee <lee.daly@intel.com>
> Subject: [PATCH v3 11/11] compress/isal: add ISA-L compression PMD docs
Change title to " doc: add compress isa-l PMD guide
>
> Signed-off-by: Lee Daly <lee.daly@intel.com>
> ---
> 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
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 37b9b1d..baccae7 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -771,6 +771,11 @@ Compression Drivers
> M: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> T: git://dpdk.org/next/dpdk-next-crypto
Add F: doc/guides/compressdev/features/default.ini, but better in patch 10.
>
> +ISA-L PMD
> +M: Lee Daly <lee.daly@intel.com>
> +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
>
> 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" != y || \
> + sed -ri 's,(ISAL_PMD=)n,\1y,' $1/.config
> test "$DPDK_DEP_PCAP" != y || \
> sed -ri 's,(PCAP=)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:
>
> 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
> +==================================
> +
> +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 the 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 creating the
> PMD is running on).
> --
> 2.7.4
next prev parent reply other threads:[~2018-04-24 11:04 UTC|newest]
Thread overview: 70+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-09 16:50 [dpdk-dev] [PATCH] compress/isal: ISA-L compression PMD Lee Daly
2018-04-06 18:13 ` [dpdk-dev] [PATCH v2] " Lee Daly
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 00/11] add " Lee Daly
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 01/11] compress/isal: add skeleton " Lee Daly
2018-04-24 8:56 ` De Lara Guarch, Pablo
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 02/11] compress/isal: add pmd device init and de-init Lee Daly
2018-04-24 9:21 ` De Lara Guarch, Pablo
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 03/11] compress/isal: add basic pmd ops Lee Daly
2018-04-24 9:28 ` De Lara Guarch, Pablo
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 04/11] compress/isal: add private xform related ops Lee Daly
2018-04-24 9:45 ` De Lara Guarch, Pablo
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 05/11] compress/isal: add queue pair " Lee Daly
2018-04-24 9:56 ` De Lara Guarch, Pablo
2018-04-26 16:44 ` Daly, Lee
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 06/11] compress/isal: support enqueue/dequeue api Lee Daly
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 07/11] compress/isal: add stats related ops Lee Daly
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 08/11] compress/isal: add ISA-L compression functionality Lee Daly
2018-04-24 10:05 ` De Lara Guarch, Pablo
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 09/11] compress/isal: add ISA-L decomp functionality Lee Daly
2018-04-24 10:09 ` De Lara Guarch, Pablo
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 10/11] compress/isal: add generic compression driver docs Lee Daly
2018-04-23 14:47 ` Kovacevic, Marko
2018-04-24 10:47 ` De Lara Guarch, Pablo
2018-04-24 11:06 ` De Lara Guarch, Pablo
2018-04-25 14:25 ` Daly, Lee
2018-04-17 13:35 ` [dpdk-dev] [PATCH v3 11/11] compress/isal: add ISA-L compression PMD docs Lee Daly
2018-04-23 14:53 ` Kovacevic, Marko
2018-04-23 15:33 ` Kovacevic, Marko
2018-04-23 15:51 ` Daly, Lee
2018-04-24 11:04 ` De Lara Guarch, Pablo [this message]
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 00/10] add ISA-L compression PMD Lee Daly
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 01/10] compress/isal: add skeleton " Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 00/10] add " Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 01/10] compress/isal: add skeleton " Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 00/10] add " Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 01/10] compress/isal: add skeleton " Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 02/10] compress/isal: add pmd device init and de-init Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 03/10] compress/isal: add basic pmd ops Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 04/10] compress/isal: add private xform related ops Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 05/10] compress/isal: add queue pair " Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 06/10] compress/isal: support enqueue/dequeue api Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 07/10] compress/isal: add stats related ops Lee Daly
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 08/10] compress/isal: add ISA-L compression functionality Lee Daly
2018-05-09 17:39 ` Tucker, Greg B
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 09/10] compress/isal: add ISA-L decomp functionality Lee Daly
2018-05-09 17:41 ` Tucker, Greg B
2018-05-09 16:14 ` [dpdk-dev] [PATCH v6 10/10] doc: add compression driver and ISA-L PMD docs Lee Daly
2018-05-09 20:56 ` [dpdk-dev] [PATCH v6 00/10] add ISA-L compression PMD De Lara Guarch, Pablo
2018-05-09 21:36 ` De Lara Guarch, Pablo
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 02/10] compress/isal: add pmd device init and de-init Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 03/10] compress/isal: add basic pmd ops Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 04/10] compress/isal: add private xform related ops Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 05/10] compress/isal: add queue pair " Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 06/10] compress/isal: support enqueue/dequeue api Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 07/10] compress/isal: add stats related ops Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 08/10] compress/isal: add ISA-L compression functionality Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 09/10] compress/isal: add ISA-L decomp functionality Lee Daly
2018-05-08 12:32 ` [dpdk-dev] [PATCH v5 10/10] doc: add compression driver and ISA-L PMD docs Lee Daly
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 02/10] compress/isal: add pmd device init and de-init Lee Daly
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 03/10] compress/isal: add basic pmd ops Lee Daly
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 04/10] compress/isal: add private xform related ops Lee Daly
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 05/10] compress/isal: add queue pair " Lee Daly
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 06/10] compress/isal: support enqueue/dequeue api Lee Daly
2018-05-03 21:46 ` De Lara Guarch, Pablo
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 07/10] compress/isal: add stats related ops Lee Daly
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 08/10] compress/isal: add ISA-L compression functionality Lee Daly
2018-05-03 21:37 ` De Lara Guarch, Pablo
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 09/10] compress/isal: add ISA-L decomp functionality Lee Daly
2018-04-27 23:38 ` [dpdk-dev] [PATCH v4 10/10] doc: add compression driver and ISA-L PMD docs Lee Daly
2018-05-03 21:49 ` De Lara Guarch, Pablo
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=E115CCD9D858EF4F90C690B0DCB4D8976CCDBACB@IRSMSX108.ger.corp.intel.com \
--to=pablo.de.lara.guarch@intel.com \
--cc=deepak.k.jain@intel.com \
--cc=dev@dpdk.org \
--cc=fiona.trahe@intel.com \
--cc=greg.b.tucker@intel.com \
--cc=lee.daly@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).