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 3255E1396 for ; Wed, 22 Mar 2017 13:29:49 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=intel.com; i=@intel.com; q=dns/txt; s=intel; t=1490185790; x=1521721790; h=from:to:cc:subject:date:message-id:references: in-reply-to:content-transfer-encoding:mime-version; bh=LxoeJ5aGEWEK/lTv9xyxxnn10Cwdf9nAqknjnXK+68A=; b=cU8EwblWStSez93MM0s6Iy1slk9FvSpKHQ2rNL1u1Ug61mruMDrIxJga KMV3Z0bsjHywR3vosyAl/ITCPGPSpw==; Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 22 Mar 2017 05:29:48 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.36,205,1486454400"; d="scan'208";a="1111048131" Received: from irsmsx154.ger.corp.intel.com ([163.33.192.96]) by orsmga001.jf.intel.com with ESMTP; 22 Mar 2017 05:29:48 -0700 Received: from irsmsx104.ger.corp.intel.com ([169.254.5.142]) by IRSMSX154.ger.corp.intel.com ([169.254.12.40]) with mapi id 14.03.0248.002; Wed, 22 Mar 2017 12:29:47 +0000 From: "Mcnamara, John" To: "Trahe, Fiona" , "dev@dpdk.org" , "De Lara Guarch, Pablo" , "Kusztal, ArkadiuszX" CC: "Jain, Deepak K" , "Trahe, Fiona" , "Griffin, John" Thread-Topic: [dpdk-dev] [PATCH v2 2/3] doc: restructure QAT PMD guide Thread-Index: AQHSmQpygf++Zip8jUu0kJc/Rxdy8KGg116w Date: Wed, 22 Mar 2017 12:29:47 +0000 Message-ID: References: <1487691610-11974-1-git-send-email-fiona.trahe@intel.com> <1489087247-456-3-git-send-email-fiona.trahe@intel.com> In-Reply-To: <1489087247-456-3-git-send-email-fiona.trahe@intel.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNDc2NjcxY2YtMDAxOS00ZTMzLWExZTEtNWY5N2I3NzRkYmY5IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6InA2ZjdNYnJUSlRNT05iVnpqT1ZBMlRwWEF4d0NVeGp6U1R0ZmxKNU5WZ2s9In0= 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 v2 2/3] doc: restructure QAT PMD guide 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: Wed, 22 Mar 2017 12:29:50 -0000 Hi Fiona, Thanks for the improvements to the doc. Some minor comments below. > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Fiona Trahe > Sent: Thursday, March 9, 2017 7:21 PM > To: dev@dpdk.org; De Lara Guarch, Pablo ; > Kusztal, ArkadiuszX > Cc: Jain, Deepak K ; Trahe, Fiona > ; Griffin, John > Subject: [dpdk-dev] [PATCH v2 2/3] doc: restructure QAT PMD guide >=20 > Restructure QAT PMD instructions and add a device table to minimise > duplication for each device and make it easier to add devices. > Fix some device name typos. >=20 > Technology C3xxx** -device, kernel 4.5 or greater is needed. > -See instructions for `Installation using kernel.org driver`_ below. > +.. csv-table:: > + :header: "device", "driver", "kernel module", "pci driver", "PF DID", > "num PFs", "VF DID", "num VFs per PF" > + :stub-columns: 1 >=20 > + DH895xCC,01.org,icp_qa_al, n/a,435,1,443,32 > + DH895xCC,4.4+,qat_dh895xcc,dh895xcc,435,1,443,32 > + C62x,4.5+,qat_c62x,c6xx,37c8,3,37c9,16 > + C3xxx,4.5+,qat_c3xxx,c3xxx,19e2,1,19e3,16 This table format is hard to read, not recommended in the Documentation Guidelines and we are trying to remove it in other sections so use the standard table format instead: .. _table_qat_pmds_drivers: .. table:: QAT devices and drivers +----------+--------+---------------+------------+--------+---------+---= -----+------------+ | Device | Driver | Kernel Module | Pci Driver | PF Did | Num PFs | Vf= Did | VFs per PF | +=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=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=3D=3D+=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ | DH895xCC | 01.org | icp_qa_al | n/a | 435 | 1 | 44= 3 | 32 | +----------+--------+---------------+------------+--------+---------+---= -----+------------+ | DH895xCC | 4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 44= 3 | 32 | +----------+--------+---------------+------------+--------+---------+---= -----+------------+ | C62x | 4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37= c9 | 16 | +----------+--------+---------------+------------+--------+---------+---= -----+------------+ | C3xxx | 4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19= e3 | 16 | +----------+--------+---------------+------------+--------+---------+---= -----+------------+ >=20 > -Installation using 01.org QAT driver > + > +The ``driver`` column indicates either the linux kernel version in Use ``Driver`` here to match new table heading. Also s/linux/Linux/g. >=20 > -NOTE: There is no driver available for **Intel QuickAssist Technology > C62x** and -**Intel QuickAssist Technology C3xxx** devices on 01.org. > +The examples below are based on the C62x device, if you have a > +different device use the corresponding values in the above table. > + > +In BIOS ensure that SRIOV is enabled and either > +a) disable VT-d or > +b) enable VT-d and set ``"intel_iommu=3Don iommu=3Dpt"`` in the grub fil= e. This doesn't render as a list. Probably a bullet list would be better here: In BIOS ensure that SRIOV is enabled and either: * Disable VT-d or * Enable VT-d and set ``"intel_iommu=3Don iommu=3Dpt"`` in the grub fil= e. > + echo 16 > /sys/bus/pci/drivers/c6xx/0000\:1a\:00.0/sriov_numvfs > + echo 16 > /sys/bus/pci/drivers/c6xx/0000\:3d\:00.0/sriov_numvfs > + echo 16 > /sys/bus/pci/drivers/c6xx/0000\:3f\:00.0/sriov_numvfs Backslashes are not required here. > + > +**Notes**: > + > +If the QAT kernel modules are not loaded and you see an error like > +``Failed to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this > +may be as a result of not using a distribution, but just updating the > kernel directly. You could use the RST Note directive here: .. Note:: If the QAT kernel modules are not loaded and you see an error like ``Fai= led to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as= a result of not using a distribution, but just updating the kernel directl= y. > + > +Download firmware from the kernel firmware repo at: > +http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git > +/tree/ Would be better as an embedded link: Download firmware from the `kernel firmware repo `_. > + > +Copy qat binaries to /lib/firmware: > + > +* ``cp qat_895xcc.bin /lib/firmware`` > +* ``cp qat_895xcc_mmp.bin /lib/firmware`` Here and elsewhere, instead of using a bullet list of commands it would be clearer and simpler to use a verbatim section: Copy qat binaries to ``/lib/firmware``:: cp qat_895xcc.bin /lib/firmware cp qat_895xcc_mmp.bin /lib/firmware > + > +cd to your linux source root directory and start the qat kernel modules: > + > +* ``insmod ./drivers/crypto/qat/qat_common/intel_qat.ko`` > +* ``insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko`` > + > + > +If you see the following warning in /var/log/messages it can be ignored: > +``IOMMU should be enabled for SR-IOV to work correctly`` Backquote ``/var/log/messages``. >=20 > -**Note**: If using a later kernel and the build fails with an error > relating to ``strict_stroul`` not being available apply the following > patch: > +**Notes**: > + > +If using a later kernel and the build fails with an error relating to > ``strict_stroul`` not being available apply the following patch: Also make this an RST note: .. Note:: If using a later kernel and the build fails with an error relating to ``strict_stroul`` not being available apply the following patch: > Binding the available VFs to the DPDK UIO driver > ------------------------------------------------ >=20 > -For **Intel(R) QuickAssist Technology DH895xcc** device: > -The unbind command below assumes ``bdfs`` of ``03:01.00-03:04.07``, if > yours are different adjust the unbind command below:: >=20 > - cd $RTE_SDK > - modprobe uio > - insmod ./build/kmod/igb_uio.ko > +Unbind the VFs from the stock driver so they can be bound to the uio > driver. >=20 > - for device in $(seq 1 4); do \ > - for fn in $(seq 0 7); do \ > - echo -n 0000:03:0${device}.${fn} > \ > - /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind= ; > \ > - done; \ > - done > +For **Intel(R) QuickAssist Technology DH895xCC** device: It would be better to make this and follow sub-sections into real sub-secti= ons at a lower level: For an Intel(R) QuickAssist Technology DH895xCC device ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For an Intel(R) QuickAssist Technology C62x device ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For Intel(R) QuickAssist Technology C3xxx device ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Bind to the DPDK uio driver ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- John