> -----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.gua...@intel.com>; Tucker, Greg B > <greg.b.tuc...@intel.com>; Jain, Deepak K <deepak.k.j...@intel.com>; Trahe, > Fiona <fiona.tr...@intel.com>; Daly, Lee <lee.d...@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.d...@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.gua...@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.d...@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
