From: Eric Zhang <eric.zhang@windriver.com>
To: "Burakov, Anatoly" <anatoly.burakov@intel.com>,
<john.mcnamara@intel.com>, <hemant.agrawal@nxp.com>,
Thomas Monjalon <thomas@monjalon.net>
Cc: <allain.legacy@windriver.com>, <matt.peters@windriver.com>,
<dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: update the doc for adding EAL option
Date: Tue, 2 Oct 2018 16:05:25 -0400 [thread overview]
Message-ID: <1fb2710d-c54b-b794-5d14-78751a7663fc@windriver.com> (raw)
In-Reply-To: <c299b533-0b75-2ebc-e6d5-b42885b7f139@intel.com>
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 <eric.zhang@windriver.com>
>> ---
>> 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 <pa|va>``
Maybe like "--iova-mode=<pa|va>" to comply with code
>
>> +
>> + Force IOVA mode to a specific value. Valid values are 'pa' or 'va'.
>> +
>> Testpmd Command-line Options
>> ----------------------------
>>
>
>
next prev parent reply other threads:[~2018-10-02 20:06 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-01 15:54 eric zhang
2018-10-02 9:59 ` Burakov, Anatoly
2018-10-02 10:04 ` Thomas Monjalon
2018-10-02 12:58 ` Ferruh Yigit
2018-10-02 20:05 ` Eric Zhang [this message]
2018-10-03 10:53 ` Burakov, Anatoly
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1fb2710d-c54b-b794-5d14-78751a7663fc@windriver.com \
--to=eric.zhang@windriver.com \
--cc=allain.legacy@windriver.com \
--cc=anatoly.burakov@intel.com \
--cc=dev@dpdk.org \
--cc=hemant.agrawal@nxp.com \
--cc=john.mcnamara@intel.com \
--cc=matt.peters@windriver.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).