diff mbox series

doc: update the doc for adding EAL option

Message ID 1538409290-24998-1-git-send-email-eric.zhang@windriver.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: update the doc for adding EAL option |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

eric zhang Oct. 1, 2018, 3:54 p.m. UTC 
  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(+)

Comments

Anatoly Burakov Oct. 2, 2018, 9:59 a.m. UTC | #1 
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!).

In addition, the commit headline is very vague. Suggested rewording:

doc: document --iova-mode EAL flag

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?

> +
>   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.

+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>``

> +
> +    Force IOVA mode to a specific value. Valid values are 'pa' or 'va'.
> +
>   
>   Testpmd Command-line Options
>   ----------------------------
>
Thomas Monjalon Oct. 2, 2018, 10:04 a.m. UTC | #2 
02/10/2018 11:59, Burakov, Anatoly:
> 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?

I agree
Ferruh Yigit Oct. 2, 2018, 12:58 p.m. UTC | #3 
On 10/2/2018 11:04 AM, Thomas Monjalon wrote:
> 02/10/2018 11:59, Burakov, Anatoly:
>> 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?
> 
> I agree

+1
eric zhang Oct. 2, 2018, 8:05 p.m. UTC | #4 
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
>>   ----------------------------
>>
>
>
Anatoly Burakov Oct. 3, 2018, 10:53 a.m. UTC | #5 
On 02-Oct-18 9:05 PM, Eric Zhang wrote:
> 
> 
> 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?

Yes, that is what i was implying. Sorry i didn't make it clear enough.

>>
>>> +
>>>   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.

Yes. For now it's OK to put it into testpmd documentation. We'll fix 
this problem later.

>>
>> +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

Code actually doesn't care if you put a "=" sign there :) It is better 
to follow style the rest of documentation has.

>>
>>> +
>>> +    Force IOVA mode to a specific value. Valid values are 'pa' or 'va'.
>>> +
>>>     Testpmd Command-line Options
>>>   ----------------------------
>>>
>>
>>
> 
>
diff mbox series

Patch

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').
+
 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.
 
     Use malloc instead of hugetlbfs.
 
+*   ``--iova-mode=mode``
+
+    Force IOVA mode to a specific value. Valid values are 'pa' or 'va'.
+
 
 Testpmd Command-line Options
 ----------------------------