From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id F3E092B82 for ; Mon, 23 Apr 2018 17:33:57 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 23 Apr 2018 08:33:50 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.49,318,1520924400"; d="scan'208";a="34628536" Received: from irsmsx109.ger.corp.intel.com ([163.33.3.23]) by fmsmga008.fm.intel.com with ESMTP; 23 Apr 2018 08:33:49 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.61]) by IRSMSX109.ger.corp.intel.com ([169.254.13.170]) with mapi id 14.03.0319.002; Mon, 23 Apr 2018 16:33:48 +0100 From: "Kovacevic, Marko" To: "Daly, Lee" , "dev@dpdk.org" CC: "De Lara Guarch, Pablo" , "Tucker, Greg B" , "Jain, Deepak K" , "Trahe, Fiona" , "Daly, Lee" Thread-Topic: [dpdk-dev] [PATCH v3 11/11] compress/isal: add ISA-L compression PMD docs Thread-Index: AQHT1lFbgV4uUfNxZkmErKee80edEqQOfVFw Date: Mon, 23 Apr 2018 15:33:47 +0000 Message-ID: <6DC05C7C5F25994B81B3F2F214251F66361F5D@IRSMSX103.ger.corp.intel.com> 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: dlp-product: dlpe-windows dlp-version: 11.0.200.100 dlp-reaction: no-action x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMmQxYjMyYzQtOTA0OS00NDhjLTlmNGYtZmZlOTlkNTBmZjQwIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6Ik5PcmFcLzJxVXc1aWpuN1Iyc2hYQ1FTR2llaDdmM2ljWDVpUmFkVjFTTGN3PSJ9 x-ctpclassification: CTP_NT x-originating-ip: [163.33.239.181] 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: Mon, 23 Apr 2018 15:33:59 -0000 =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 > +++++++++++++++++++++++++++++++ <...> > +Limitations > +----------- > + > +* Chained mbufs are not supported. > + > +* Compressdev level 0, no compression, is not supported. ISA-L level 0 > +used for > + > +fixed huffman codes. For the bit above have the two lines together as it messes up the format an= d look of the sentance * Compressdev level 0, no compression, is not supported. ISA-L level 0 used for fixed huffman codes. > +* Out of order operations are not supported > + > +Installation > +------------ > + > +* To build DPDK with Intel's ISA-L library, the user is required to > +download > + > +the library from > + > +``_. Same here,=20 +* To build DPDK with Intel's ISA-L library, the user is required to download the library from ``_. > +* Once downloaded, the user needs to build the library, the ISA-L > +autotools > + > +are usualy sufficient:: > + > + ./autogen.sh > + ./configure > + Same above, also use 4 spaces to indent the code block not tabs,=20 * Once downloaded, the user needs to build the library, the ISA-L autotools are usualy sufficient:: =20 ./autogen.sh ./configure > +make can be used to install the library on their system, before buildin= g > DPDK:: > + > + make > + sudo make install Spaces instead of tabs for the commands above > +* To build with meson, the "libisal.pc" file, must be copied into > +"pkgconfig", > + > +e.g. /usr/lib/pkgconfig or /usr/lib64/pkgconfig depending on your > +system, > + > +for meson to find the ISA-L library. "libisal.pc" is located in library = sources,:: > + > + cp isal/libisal.pc /usr/lib/pkgconfig/ > + > +instructions on how to download below. Same changes as above also you can get rid of the comma after sources * To build with meson, the "libisal.pc" file, must be copied into "pkgconfig", e.g. /usr/lib/pkgconfig or /usr/lib64/pkgconfig depending= =20 on your system, for meson to find the ISA-L library. "libisal.pc" is lo= cated=20 in library sources :: cp isal/libisal.pc /usr/lib/pkgconfig/ instructions on how to download below. <...> > +Initialization > +-------------- > + > +In order to enable this virtual compression PMD, user must: > + > +* Set CONFIG_RTE_LIBRTE_PMD_ISAL=3Dy in config/common_base. > + > +To use the PMD in an application, user must: > + > +* Call rte_vdev_init("compress_isal") within the application. > + > +* Use --vdev=3D"compress_isal" in the EAL options, which will call > rte_vdev_init() internally. > + > +The following parameters (all 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 creat= ing the > PMD is running on). In this section commands like CONFIG_RTE_LIBRTE_PMD_ISAL=3Dy and --vdev=3D= "compress_isal"=20 Put them in `` `` quotes to highlight it's a command as it's a bit hard = to see and also looks better. Marko K