From mboxrd@z Thu Jan 1 00:00:00 1970 From: Eric Zhang Subject: Re: [PATCH] doc: update the doc for adding EAL option Date: Tue, 2 Oct 2018 16:05:25 -0400 Message-ID: <1fb2710d-c54b-b794-5d14-78751a7663fc@windriver.com> References: <1538409290-24998-1-git-send-email-eric.zhang@windriver.com> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8"; format=flowed Content-Transfer-Encoding: 8bit Cc: , , To: "Burakov, Anatoly" , , , Thomas Monjalon Return-path: Received: from mail5.wrs.com (mail5.windriver.com [192.103.53.11]) by dpdk.org (Postfix) with ESMTP id 9ED51343C for ; Tue, 2 Oct 2018 22:06:19 +0200 (CEST) In-Reply-To: Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 10/02/2018 05:59 AM, Burakov, Anatoly wrote: > Hi Eric, > > Ferruh has already mention that this should be part of the patch > adding the --iova-mode flag, not separate (or at the very least be in > the same patchset!). OK. I will generate version 3 which has one patchset includes code and document patches. > > In addition, the commit headline is very vague. Suggested rewording: > > doc: document --iova-mode EAL flag ok.    On 01-Oct-18 4:54 PM, eric zhang wrote: >> This patch updates Programmer's Guide and EAL parameter guides >> to show EAL option "--iova-mode" support. >> >> Signed-off-by: eric zhang >> --- >>   doc/guides/prog_guide/env_abstraction_layer.rst | 8 ++++++++ >>   doc/guides/testpmd_app_ug/run_app.rst           | 4 ++++ >>   2 files changed, 12 insertions(+) >> >> diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst >> b/doc/guides/prog_guide/env_abstraction_layer.rst >> index d362c92..a47fb38 100644 >> --- a/doc/guides/prog_guide/env_abstraction_layer.rst >> +++ b/doc/guides/prog_guide/env_abstraction_layer.rst >> @@ -321,6 +321,14 @@ Misc Functions >>     Locks and atomic operations are per-architecture (i686 and x86_64). >>   +IOVA Mode Configuration >> +~~~~~~~~~~~~~~~~~~~~~~~ >> + >> +Auto detection of the IOVA mode, based on probing the PCI bus and >> IOMMU configuration, may not report >> +the desired addressing mode when virtual devices that are not >> directly attached to the PCI bus are present. >> +To facilitate forcing the IOVA mode to a specific value the EAL >> command line option ``--iova-mode=mode`` can >> +be used to select either physical addressing('pa') or virtual >> addressing('va'). > > Presumably this isn't only applicable to PCI bus, but can be any bus, > correct? It should be applicable to any bus since it would override the result from whatever bus scheme. Do you suggest to not mention "PCI bus" in the description? > >> + >>   Memory Segments and Memory Zones (memzone) >>   ------------------------------------------ >>   diff --git a/doc/guides/testpmd_app_ug/run_app.rst >> b/doc/guides/testpmd_app_ug/run_app.rst >> index f301c2b..be2911c 100644 >> --- a/doc/guides/testpmd_app_ug/run_app.rst >> +++ b/doc/guides/testpmd_app_ug/run_app.rst >> @@ -133,6 +133,10 @@ See the DPDK Getting Started Guides for more >> information on these options. > > I wanted to ask why are you adding this to testpmd user guide, as this > is an EAL parameter, not a testpmd parameter, but as far as i can > tell, there isn't a central location where we document all EAL flags. That's the place that I can find where most eal command-line options are addressed. > > +Thomas, John > > This looks like a gap in our documentation. There should be a place > where we can describe all EAL parameters. Since they can be > OS-specific, it probably should be somewhere under Linux/FreeBSD GSG. > Thoughts? > >>         Use malloc instead of hugetlbfs. >>   +*   ``--iova-mode=mode`` > > Current style is to list all valid values, like this: > > ``--iova-mode `` Maybe like "--iova-mode=" to comply with code > >> + >> +    Force IOVA mode to a specific value. Valid values are 'pa' or 'va'. >> + >>     Testpmd Command-line Options >>   ---------------------------- >> > >