From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jerin Jacob Subject: Re: [PATCH 19/20] thunderx/nicvf: updated driver documentation and release notes Date: Thu, 19 May 2016 11:49:26 +0530 Message-ID: <20160519061921.GA3535@localhost.localdomain> References: <1462634198-2289-1-git-send-email-jerin.jacob@caviumnetworks.com> <1462634198-2289-20-git-send-email-jerin.jacob@caviumnetworks.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Cc: "dev@dpdk.org" , "thomas.monjalon@6wind.com" , "Richardson, Bruce" , Slawomir Rosek To: "Mcnamara, John" Return-path: Received: from na01-by2-obe.outbound.protection.outlook.com (mail-by2on0055.outbound.protection.outlook.com [207.46.100.55]) by dpdk.org (Postfix) with ESMTP id 2F2B86C99 for ; Thu, 19 May 2016 08:19:52 +0200 (CEST) Content-Disposition: inline In-Reply-To: List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On Tue, May 17, 2016 at 04:31:58PM +0000, Mcnamara, John wrote: > > -----Original Message----- > > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Jerin Jacob > > Sent: Saturday, May 7, 2016 4:17 PM > > To: dev@dpdk.org > > Cc: thomas.monjalon@6wind.com; Richardson, Bruce > > ; Jerin Jacob > > ; Slawomir Rosek > > > > Subject: [dpdk-dev] [PATCH 19/20] thunderx/nicvf: updated driver > > documentation and release notes > > Hi, > > Very good documentation. The content is quite clear and almost no RST issues. > The only comment is on some of the long lines. In general console blocks > have to be wrapped at 80 chars or else they go off the page in the PDF docs. > I see that you did that in some places but not in others. > > It is worth building the pdf docs to check for that: > > make doc-guides-pdf > mupdf build/doc/pdf/guides/nics.pdf & > > Some minor comments below: Thanks John for the review. Will fix it in v2. > > > > + > > +#. Start ``testpmd`` with basic parameters: > > + > > + .. code-block:: console > > + > > + ./arm64-thunderx-linuxapp-gcc/app/testpmd -c 0xf -n 4 -w > > + 0002:01:00.2 -- -i --disable-hw-vlan-filter --crc-strip --no-flush-rx > > + --port-topology=loop > > Would be better wrapped as something like this: > > .. code-block:: console > > ./arm64-thunderx-linuxapp-gcc/app/testpmd -c 0xf -n 4 -w 0002:01:00.2 \ > -- -i --disable-hw-vlan-filter --crc-strip --no-flush-rx > --port-topology=loop > > > > + > > + Example output: > > + > > + .. code-block:: console > > + > > + ... > > + > > + PMD: rte_nicvf_pmd_init(): librte_pmd_thunderx nicvf version 1.0 > > + > > + ... > > + EAL: probe driver: 177d:11 rte_nicvf_pmd > > + EAL: using IOMMU type 1 (Type 1) > > + EAL: PCI memory mapped at 0x3ffade50000 > > + EAL: Trying to map BAR 4 that contains the MSI-X table. Trying > > offsets: 0x40000000000:0x0000, 0x10000:0x1f0000 > > + EAL: PCI memory mapped at 0x3ffadc60000 > > + PMD: nicvf_eth_dev_init(): nicvf: device (177d:11) 2:1:0:2 > > + PMD: nicvf_eth_dev_init(): node=0 vf=1 mode=tns-bypass sqs=false > > loopback_supported=true > > + PMD: nicvf_eth_dev_init(): Port 0 (177d:11) mac=a6:c6:d9:17:78:01 > > + Interactive-mode selected > > + Configuring Port 0 (socket 0) > > > Also, this should be wrapped (even though it is the actual output): > > ... > EAL: probe driver: 177d:11 rte_nicvf_pmd > EAL: using IOMMU type 1 (Type 1) > EAL: PCI memory mapped at 0x3ffade50000 > EAL: Trying to map BAR 4 that contains the MSI-X table. > Trying offsets: 0x40000000000:0x0000, 0x10000:0x1f0000 > EAL: PCI memory mapped at 0x3ffadc60000 > PMD: nicvf_eth_dev_init(): nicvf: device (177d:11) 2:1:0:2 > PMD: nicvf_eth_dev_init(): node=0 vf=1 mode=tns-bypass sqs=false > loopback_supported=true > PMD: nicvf_eth_dev_init(): Port 0 (177d:11) mac=a6:c6:d9:17:78:01 > Interactive-mode selected > Configuring Port 0 (socket 0) > ... > > > > +SR-IOV: Prerequisites and sample Application Notes > > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > + > > +Current ThunderX NIC PF/VF kernel modules maps each physical Ethernet > > +port automatically to virtual function (VF) and presented as PCIe-like > > SR-IOV device. > > > Slightly better as: > > Current ThunderX NIC PF/VF kernel modules maps each physical Ethernet port > automatically to virtual functions (VF) and presents them as PCIe-like SR-IOV device. > > > > + Example qemu guest launch command: > > + > > + .. code-block:: console > > + > > + sudo qemu-system-aarch64 -name vm1 -machine > > virt,gic_version=3,accel=kvm,usb=off \ > > + -cpu host -m 4096 \ > > + -smp 4,sockets=1,cores=8,threads=1 \ > > + -nographic -nodefaults \ > > + -kernel \ > > Also wrap the first line: > > .. code-block:: console > > sudo qemu-system-aarch64 -name vm1 \ > -machine virt,gic_version=3,accel=kvm,usb=off \ > -cpu host -m 4096 \ > ... > > > Apart from those small changes: > > Acked-by: John McNamara > > > >