[v4,5/5] doc: add ZLIB PMD guide
diff mbox series

Message ID 1532357474-9544-6-git-send-email-shally.verma@caviumnetworks.com
State Superseded, archived
Delegated to: Pablo de Lara Guarch
Headers show
Series
  • compress: add ZLIB compression PMD
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Shally Verma July 23, 2018, 2:51 p.m. UTC
Add zlib pmd feature support and user guide with
build and run instructions

Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
---
 MAINTAINERS                               |  2 +
 doc/guides/compressdevs/features/zlib.ini | 11 +++++
 doc/guides/compressdevs/index.rst         |  1 +
 doc/guides/compressdevs/zlib.rst          | 69 +++++++++++++++++++++++++++++++
 4 files changed, 83 insertions(+)

Comments

Pablo de Lara July 23, 2018, 5:58 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shally Verma
> Sent: Monday, July 23, 2018 3:51 PM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Cc: dev@dpdk.org; pathreya@caviumnetworks.com;
> mchalla@caviumnetworks.com; Sunila Sahu
> <sunila.sahu@caviumnetworks.com>; Ashish Gupta
> <ashish.gupta@caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> 
> Add zlib pmd feature support and user guide with build and run instructions
> 
> Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
> Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
> ---
>  MAINTAINERS                               |  2 +
>  doc/guides/compressdevs/features/zlib.ini | 11 +++++
>  doc/guides/compressdevs/index.rst         |  1 +
>  doc/guides/compressdevs/zlib.rst          | 69
> +++++++++++++++++++++++++++++++
>  4 files changed, 83 insertions(+)
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index ca27c6f..7e3c450 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -875,6 +875,8 @@ F: drivers/common/qat/  ZLIB
>  M: Sunila Sahu <sunila.sahu@caviumnetworks.com>
>  F: drivers/compress/zlib/
> +F: doc/guides/compressdevs/zlib.rst
> +F: doc/guides/compressdevs/features/zlib.ini
> 
>  Eventdev Drivers
>  ----------------
> diff --git a/doc/guides/compressdevs/features/zlib.ini
> b/doc/guides/compressdevs/features/zlib.ini
> new file mode 100644
> index 0000000..c794643
> --- /dev/null
> +++ b/doc/guides/compressdevs/features/zlib.ini
> @@ -0,0 +1,11 @@
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +; Supported features of 'ZLIB' compression driver.
> +;
> +[Features]
> +Pass-through   = Y
> +Deflate        = Y
> +Fixed          = Y
> +Dynamic        = Y
> +OOP SGL In SGL Out  = Y

I assume that you support also "OOP SGL In LB Out" and "OOP LB In SGL Out", right?
Verma, Shally July 23, 2018, 6 p.m. UTC | #2
>-----Original Message-----
>From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>Sent: 23 July 2018 23:28
>To: Verma, Shally <Shally.Verma@cavium.com>
>Cc: dev@dpdk.org; Athreya, Narayana Prasad <NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
><Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>; Gupta, Ashish <Ashish.Gupta@cavium.com>
>Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
>
>External Email
>
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shally Verma
>> Sent: Monday, July 23, 2018 3:51 PM
>> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>> Cc: dev@dpdk.org; pathreya@caviumnetworks.com;
>> mchalla@caviumnetworks.com; Sunila Sahu
>> <sunila.sahu@caviumnetworks.com>; Ashish Gupta
>> <ashish.gupta@caviumnetworks.com>
>> Subject: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
>>
>> Add zlib pmd feature support and user guide with build and run instructions
>>
>> Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
>> Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
>> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
>> ---
>>  MAINTAINERS                               |  2 +
>>  doc/guides/compressdevs/features/zlib.ini | 11 +++++
>>  doc/guides/compressdevs/index.rst         |  1 +
>>  doc/guides/compressdevs/zlib.rst          | 69
>> +++++++++++++++++++++++++++++++
>>  4 files changed, 83 insertions(+)
>>
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index ca27c6f..7e3c450 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -875,6 +875,8 @@ F: drivers/common/qat/  ZLIB
>>  M: Sunila Sahu <sunila.sahu@caviumnetworks.com>
>>  F: drivers/compress/zlib/
>> +F: doc/guides/compressdevs/zlib.rst
>> +F: doc/guides/compressdevs/features/zlib.ini
>>
>>  Eventdev Drivers
>>  ----------------
>> diff --git a/doc/guides/compressdevs/features/zlib.ini
>> b/doc/guides/compressdevs/features/zlib.ini
>> new file mode 100644
>> index 0000000..c794643
>> --- /dev/null
>> +++ b/doc/guides/compressdevs/features/zlib.ini
>> @@ -0,0 +1,11 @@
>> +;
>> +; Refer to default.ini for the full list of available PMD features.
>> +;
>> +; Supported features of 'ZLIB' compression driver.
>> +;
>> +[Features]
>> +Pass-through   = Y
>> +Deflate        = Y
>> +Fixed          = Y
>> +Dynamic        = Y
>> +OOP SGL In SGL Out  = Y
>
>I assume that you support also "OOP SGL In LB Out" and "OOP LB In SGL Out", right?
yes, but untested thus not claiming.

Thanks
Shally
Pablo de Lara July 23, 2018, 9:18 p.m. UTC | #3
Hi Shally,

> -----Original Message-----
> From: Verma, Shally [mailto:Shally.Verma@cavium.com]
> Sent: Monday, July 23, 2018 7:00 PM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Cc: dev@dpdk.org; Athreya, Narayana Prasad
> <NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
> <Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>;
> Gupta, Ashish <Ashish.Gupta@cavium.com>
> Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> 
> 
> 
> >-----Original Message-----
> >From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> >Sent: 23 July 2018 23:28
> >To: Verma, Shally <Shally.Verma@cavium.com>
> >Cc: dev@dpdk.org; Athreya, Narayana Prasad
> ><NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
> ><Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>;
> >Gupta, Ashish <Ashish.Gupta@cavium.com>
> >Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> >
> >External Email
> >
> >> -----Original Message-----
> >> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shally Verma
> >> Sent: Monday, July 23, 2018 3:51 PM
> >> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> >> Cc: dev@dpdk.org; pathreya@caviumnetworks.com;
> >> mchalla@caviumnetworks.com; Sunila Sahu
> >> <sunila.sahu@caviumnetworks.com>; Ashish Gupta
> >> <ashish.gupta@caviumnetworks.com>
> >> Subject: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> >>
> >> Add zlib pmd feature support and user guide with build and run
> >> instructions
> >>
> >> Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
> >> Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
> >> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
> >> ---
> >>  MAINTAINERS                               |  2 +
> >>  doc/guides/compressdevs/features/zlib.ini | 11 +++++
> >>  doc/guides/compressdevs/index.rst         |  1 +
> >>  doc/guides/compressdevs/zlib.rst          | 69
> >> +++++++++++++++++++++++++++++++
> >>  4 files changed, 83 insertions(+)
> >>
> >> diff --git a/MAINTAINERS b/MAINTAINERS index ca27c6f..7e3c450 100644
> >> --- a/MAINTAINERS
> >> +++ b/MAINTAINERS
> >> @@ -875,6 +875,8 @@ F: drivers/common/qat/  ZLIB
> >>  M: Sunila Sahu <sunila.sahu@caviumnetworks.com>
> >>  F: drivers/compress/zlib/
> >> +F: doc/guides/compressdevs/zlib.rst
> >> +F: doc/guides/compressdevs/features/zlib.ini
> >>
> >>  Eventdev Drivers
> >>  ----------------
> >> diff --git a/doc/guides/compressdevs/features/zlib.ini
> >> b/doc/guides/compressdevs/features/zlib.ini
> >> new file mode 100644
> >> index 0000000..c794643
> >> --- /dev/null
> >> +++ b/doc/guides/compressdevs/features/zlib.ini
> >> @@ -0,0 +1,11 @@
> >> +;
> >> +; Refer to default.ini for the full list of available PMD features.
> >> +;
> >> +; Supported features of 'ZLIB' compression driver.
> >> +;
> >> +[Features]
> >> +Pass-through   = Y
> >> +Deflate        = Y
> >> +Fixed          = Y
> >> +Dynamic        = Y
> >> +OOP SGL In SGL Out  = Y
> >
> >I assume that you support also "OOP SGL In LB Out" and "OOP LB In SGL Out",
> right?
> yes, but untested thus not claiming.

Right, but knowing that a Linear buffer is basically an SGL with just one segment,
I think it is safe to say that you support these two other cases.
The only reason why we have them is in case, you only support one of them, but you don't support SGL in SGL Out).

I won't have time to extend the test for those combinations in this release, I hope I can do that in the next one,
but as said, I think it is safe to claim that this PMD supports all the cases.

> 
> Thanks
> Shally
Verma, Shally July 24, 2018, 5:32 a.m. UTC | #4
>-----Original Message-----
>From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>Sent: 24 July 2018 02:49
>To: Verma, Shally <Shally.Verma@cavium.com>
>Cc: dev@dpdk.org; Athreya, Narayana Prasad <NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
><Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>; Gupta, Ashish <Ashish.Gupta@cavium.com>
>Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
>
>External Email
>
>Hi Shally,
>
>> -----Original Message-----
>> From: Verma, Shally [mailto:Shally.Verma@cavium.com]
>> Sent: Monday, July 23, 2018 7:00 PM
>> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>> Cc: dev@dpdk.org; Athreya, Narayana Prasad
>> <NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
>> <Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>;
>> Gupta, Ashish <Ashish.Gupta@cavium.com>
>> Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
>>
>>
>>
>> >-----Original Message-----
>> >From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>> >Sent: 23 July 2018 23:28
>> >To: Verma, Shally <Shally.Verma@cavium.com>
>> >Cc: dev@dpdk.org; Athreya, Narayana Prasad
>> ><NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
>> ><Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>;
>> >Gupta, Ashish <Ashish.Gupta@cavium.com>
>> >Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
>> >
>> >External Email
>> >
>> >> -----Original Message-----
>> >> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shally Verma
>> >> Sent: Monday, July 23, 2018 3:51 PM
>> >> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>> >> Cc: dev@dpdk.org; pathreya@caviumnetworks.com;
>> >> mchalla@caviumnetworks.com; Sunila Sahu
>> >> <sunila.sahu@caviumnetworks.com>; Ashish Gupta
>> >> <ashish.gupta@caviumnetworks.com>
>> >> Subject: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
>> >>
>> >> Add zlib pmd feature support and user guide with build and run
>> >> instructions
>> >>
>> >> Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
>> >> Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
>> >> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
>> >> ---
>> >>  MAINTAINERS                               |  2 +
>> >>  doc/guides/compressdevs/features/zlib.ini | 11 +++++
>> >>  doc/guides/compressdevs/index.rst         |  1 +
>> >>  doc/guides/compressdevs/zlib.rst          | 69
>> >> +++++++++++++++++++++++++++++++
>> >>  4 files changed, 83 insertions(+)
>> >>
>> >> diff --git a/MAINTAINERS b/MAINTAINERS index ca27c6f..7e3c450 100644
>> >> --- a/MAINTAINERS
>> >> +++ b/MAINTAINERS
>> >> @@ -875,6 +875,8 @@ F: drivers/common/qat/  ZLIB
>> >>  M: Sunila Sahu <sunila.sahu@caviumnetworks.com>
>> >>  F: drivers/compress/zlib/
>> >> +F: doc/guides/compressdevs/zlib.rst
>> >> +F: doc/guides/compressdevs/features/zlib.ini
>> >>
>> >>  Eventdev Drivers
>> >>  ----------------
>> >> diff --git a/doc/guides/compressdevs/features/zlib.ini
>> >> b/doc/guides/compressdevs/features/zlib.ini
>> >> new file mode 100644
>> >> index 0000000..c794643
>> >> --- /dev/null
>> >> +++ b/doc/guides/compressdevs/features/zlib.ini
>> >> @@ -0,0 +1,11 @@
>> >> +;
>> >> +; Refer to default.ini for the full list of available PMD features.
>> >> +;
>> >> +; Supported features of 'ZLIB' compression driver.
>> >> +;
>> >> +[Features]
>> >> +Pass-through   = Y
>> >> +Deflate        = Y
>> >> +Fixed          = Y
>> >> +Dynamic        = Y
>> >> +OOP SGL In SGL Out  = Y
>> >
>> >I assume that you support also "OOP SGL In LB Out" and "OOP LB In SGL Out",
>> right?
>> yes, but untested thus not claiming.
>
>Right, but knowing that a Linear buffer is basically an SGL with just one segment,
>I think it is safe to say that you support these two other cases.
>The only reason why we have them is in case, you only support one of them, but you don't support SGL in SGL Out).
>
>I won't have time to extend the test for those combinations in this release, I hope I can do that in the next one,
>but as said, I think it is safe to claim that this PMD supports all the cases.
Agree. However I would still wait to test them before claiming support.

Thanks
Shally
>
>>
>> Thanks
>> Shally
Pablo de Lara July 24, 2018, 7:47 a.m. UTC | #5
> -----Original Message-----
> From: Verma, Shally [mailto:Shally.Verma@cavium.com]
> Sent: Tuesday, July 24, 2018 6:32 AM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Cc: dev@dpdk.org; Athreya, Narayana Prasad
> <NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
> <Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>;
> Gupta, Ashish <Ashish.Gupta@cavium.com>
> Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> 
> 
> 
> >-----Original Message-----
> >From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> >Sent: 24 July 2018 02:49
> >To: Verma, Shally <Shally.Verma@cavium.com>
> >Cc: dev@dpdk.org; Athreya, Narayana Prasad
> ><NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
> ><Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>;
> >Gupta, Ashish <Ashish.Gupta@cavium.com>
> >Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> >
> >External Email
> >
> >Hi Shally,
> >
> >> -----Original Message-----
> >> From: Verma, Shally [mailto:Shally.Verma@cavium.com]
> >> Sent: Monday, July 23, 2018 7:00 PM
> >> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> >> Cc: dev@dpdk.org; Athreya, Narayana Prasad
> >> <NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
> >> <Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>;
> >> Gupta, Ashish <Ashish.Gupta@cavium.com>
> >> Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> >>
> >>
> >>
> >> >-----Original Message-----
> >> >From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> >> >Sent: 23 July 2018 23:28
> >> >To: Verma, Shally <Shally.Verma@cavium.com>
> >> >Cc: dev@dpdk.org; Athreya, Narayana Prasad
> >> ><NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
> >> ><Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>;
> >> >Gupta, Ashish <Ashish.Gupta@cavium.com>
> >> >Subject: RE: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> >> >
> >> >External Email
> >> >
> >> >> -----Original Message-----
> >> >> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shally Verma
> >> >> Sent: Monday, July 23, 2018 3:51 PM
> >> >> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> >> >> Cc: dev@dpdk.org; pathreya@caviumnetworks.com;
> >> >> mchalla@caviumnetworks.com; Sunila Sahu
> >> >> <sunila.sahu@caviumnetworks.com>; Ashish Gupta
> >> >> <ashish.gupta@caviumnetworks.com>
> >> >> Subject: [dpdk-dev] [PATCH v4 5/5] doc: add ZLIB PMD guide
> >> >>
> >> >> Add zlib pmd feature support and user guide with build and run
> >> >> instructions
> >> >>
> >> >> Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
> >> >> Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
> >> >> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
> >> >> ---
> >> >>  MAINTAINERS                               |  2 +
> >> >>  doc/guides/compressdevs/features/zlib.ini | 11 +++++
> >> >>  doc/guides/compressdevs/index.rst         |  1 +
> >> >>  doc/guides/compressdevs/zlib.rst          | 69
> >> >> +++++++++++++++++++++++++++++++
> >> >>  4 files changed, 83 insertions(+)
> >> >>
> >> >> diff --git a/MAINTAINERS b/MAINTAINERS index ca27c6f..7e3c450
> >> >> 100644
> >> >> --- a/MAINTAINERS
> >> >> +++ b/MAINTAINERS
> >> >> @@ -875,6 +875,8 @@ F: drivers/common/qat/  ZLIB
> >> >>  M: Sunila Sahu <sunila.sahu@caviumnetworks.com>
> >> >>  F: drivers/compress/zlib/
> >> >> +F: doc/guides/compressdevs/zlib.rst
> >> >> +F: doc/guides/compressdevs/features/zlib.ini
> >> >>
> >> >>  Eventdev Drivers
> >> >>  ----------------
> >> >> diff --git a/doc/guides/compressdevs/features/zlib.ini
> >> >> b/doc/guides/compressdevs/features/zlib.ini
> >> >> new file mode 100644
> >> >> index 0000000..c794643
> >> >> --- /dev/null
> >> >> +++ b/doc/guides/compressdevs/features/zlib.ini
> >> >> @@ -0,0 +1,11 @@
> >> >> +;
> >> >> +; Refer to default.ini for the full list of available PMD features.
> >> >> +;
> >> >> +; Supported features of 'ZLIB' compression driver.
> >> >> +;
> >> >> +[Features]
> >> >> +Pass-through   = Y
> >> >> +Deflate        = Y
> >> >> +Fixed          = Y
> >> >> +Dynamic        = Y
> >> >> +OOP SGL In SGL Out  = Y
> >> >
> >> >I assume that you support also "OOP SGL In LB Out" and "OOP LB In
> >> >SGL Out",
> >> right?
> >> yes, but untested thus not claiming.
> >
> >Right, but knowing that a Linear buffer is basically an SGL with just
> >one segment, I think it is safe to say that you support these two other cases.
> >The only reason why we have them is in case, you only support one of them,
> but you don't support SGL in SGL Out).
> >
> >I won't have time to extend the test for those combinations in this
> >release, I hope I can do that in the next one, but as said, I think it is safe to
> claim that this PMD supports all the cases.
> Agree. However I would still wait to test them before claiming support.

Sure, no problem.

Thanks,
Pablo

> 
> Thanks
> Shally
> >
> >>
> >> Thanks
> >> Shally

Patch
diff mbox series

diff --git a/MAINTAINERS b/MAINTAINERS
index ca27c6f..7e3c450 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -875,6 +875,8 @@  F: drivers/common/qat/
 ZLIB
 M: Sunila Sahu <sunila.sahu@caviumnetworks.com>
 F: drivers/compress/zlib/
+F: doc/guides/compressdevs/zlib.rst
+F: doc/guides/compressdevs/features/zlib.ini
 
 Eventdev Drivers
 ----------------
diff --git a/doc/guides/compressdevs/features/zlib.ini b/doc/guides/compressdevs/features/zlib.ini
new file mode 100644
index 0000000..c794643
--- /dev/null
+++ b/doc/guides/compressdevs/features/zlib.ini
@@ -0,0 +1,11 @@ 
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+; Supported features of 'ZLIB' compression driver.
+;
+[Features]
+Pass-through   = Y
+Deflate        = Y
+Fixed          = Y
+Dynamic        = Y
+OOP SGL In SGL Out  = Y
diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst
index 4228768..6ba6641 100644
--- a/doc/guides/compressdevs/index.rst
+++ b/doc/guides/compressdevs/index.rst
@@ -12,3 +12,4 @@  Compression Device Drivers
     overview
     isal
     qat_comp
+    zlib
diff --git a/doc/guides/compressdevs/zlib.rst b/doc/guides/compressdevs/zlib.rst
new file mode 100644
index 0000000..c020792
--- /dev/null
+++ b/doc/guides/compressdevs/zlib.rst
@@ -0,0 +1,69 @@ 
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2018 Cavium Networks.
+
+ZLIB Compression Poll Mode Driver
+==================================
+
+The ZLIB PMD (**librte_pmd_zlib**) provides poll mode compression &
+decompression driver based on SW zlib library,
+
+Features
+--------
+
+ZLIB PMD has support for:
+
+Compression/Decompression algorithm:
+
+* DEFLATE
+
+Huffman code type:
+
+* FIXED
+* DYNAMIC
+
+Window size support:
+
+* Min - 256 bytes
+* Max - 32K
+
+Limitations
+-----------
+
+* Stateful  not supported.
+
+Installation
+------------
+
+* To build DPDK with ZLIB library, the user is required to download the ``libz`` library.
+* Use following command for installation.
+
+* For Fedora users::
+     sudo yum install zlib-devel
+* For Ubuntu users::
+     sudo apt-get install zlib1g-dev
+
+* Once downloaded, the user needs to build the library.
+
+* To build from sources
+  download zlib sources from http://zlib.net/ and do following before building DPDK::
+
+    make
+    sudo make install
+
+Initialization
+--------------
+
+In order to enable this virtual compression PMD, user must:
+
+* Set ``CONFIG_RTE_LIBRTE_PMD_ZLIB=y`` in config/common_base.
+
+To use the PMD in an application, user must:
+
+* Call ``rte_vdev_init("compress_zlib")`` within the application.
+
+* Use ``--vdev="compress_zlib"`` in the EAL options, which will call ``rte_vdev_init()`` internally.
+
+The following parameter (optional) can be provided in the previous two calls:
+
+* ``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).