doc: update size parameter details

Message ID 20231212104508.1941-1-vipin.varghese@amd.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: update size parameter details |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-compile-arm64-testing success Testing PASS

Commit Message

Vipin Varghese Dec. 12, 2023, 10:45 a.m. UTC
  For configuration parameters `mem_size` and `buf_size` are represented
as megabytes and bytes respectively in application. Update the
documentation to represent the same.

Signed-off-by: Vipin Varghese <vipin.varghese@amd.com>
---
 doc/guides/tools/dmaperf.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Comments

Vipin Varghese March 6, 2024, 6:08 a.m. UTC | #1
> Caution: This message originated from an External Source. Use proper caution when opening attachments, clicking links, or responding.
>
>
> For configuration parameters `mem_size` and `buf_size` are represented
> as megabytes and bytes respectively in application. Update the
> documentation to represent the same.
>
> Signed-off-by: Vipin Varghese <vipin.varghese@amd.com>
> ---
>   doc/guides/tools/dmaperf.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst
> index 9e3e78a6b7..6f85fceb8a 100644
> --- a/doc/guides/tools/dmaperf.rst
> +++ b/doc/guides/tools/dmaperf.rst
> @@ -74,10 +74,10 @@ Configuration Parameters
>     Currently supported types are ``DMA_MEM_COPY`` and ``CPU_MEM_COPY``.
>
>   ``mem_size``
> -  The size of the memory footprint.
> +  The size of the memory footprint in megabytes (MB) for source and destination.
>
>   ``buf_size``
> -  The memory size of a single operation.
> +  The memory size of a single operation in bytes (B).
>
>   ``dma_ring_size``
>     The DMA ring buffer size. Must be a power of two, and between ``64`` and ``4096``.
Hi Chengwen, can you please help us to review the changes ?
> --
> 2.34.1
>
  
Chengwen Feng March 7, 2024, 1:27 p.m. UTC | #2
Addressed
Hi Vipin,

On 2023/12/12 18:45, Vipin Varghese wrote:
> For configuration parameters `mem_size` and `buf_size` are represented
> as megabytes and bytes respectively in application. Update the
> documentation to represent the same.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@amd.com>
> ---
>  doc/guides/tools/dmaperf.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst
> index 9e3e78a6b7..6f85fceb8a 100644
> --- a/doc/guides/tools/dmaperf.rst
> +++ b/doc/guides/tools/dmaperf.rst
> @@ -74,10 +74,10 @@ Configuration Parameters
>    Currently supported types are ``DMA_MEM_COPY`` and ``CPU_MEM_COPY``.
>  
>  ``mem_size``
> -  The size of the memory footprint.
> +  The size of the memory footprint in megabytes (MB) for source and destination.

I prefer not add "for source and destination", it makes sense without this, and maybe future test like fill don't have source buffer.

>  
>  ``buf_size``
> -  The memory size of a single operation.
> +  The memory size of a single operation in bytes (B).
>  
>  ``dma_ring_size``
>    The DMA ring buffer size. Must be a power of two, and between ``64`` and ``4096``.
> 

BTW: Could you please also modify the app/test-dma-perf/config.ini (which also missing this)

Thanks
  
Vipin Varghese March 7, 2024, 3:50 p.m. UTC | #3
<snipped>
>> -  The size of the memory footprint.
>> +  The size of the memory footprint in megabytes (MB) for source and destination.
> I prefer not add "for source and destination", it makes sense without this, and maybe future test like fill don't have source buffer.

The current dma-perf application, makes use of memory in MegaBytes for 
combined buffer of source and destination. That is, if the total memory 
is 10MB

this is split into 5MB for source buffer and 5MB for destination buffer.


dma-fill option is not enabled or used in dma-test-perf yet. I would 
recommend, once the feature is added `both fill-pattern and mem_size 
will get added`.

As it is not available this is  not applicable. Hence I am do not agree 
`it makes sense without this` instead it is needed to be clear.

>
>>   ``buf_size``
>> -  The memory size of a single operation.
>> +  The memory size of a single operation in bytes (B).
>>
>>   ``dma_ring_size``
>>     The DMA ring buffer size. Must be a power of two, and between ``64`` and ``4096``.
>>
> BTW: Could you please also modify the app/test-dma-perf/config.ini (which also missing this)

dma-perf documentation is updated with right message. Yes, I can 
understand end-user may also refer to the comments in `config.ini`.  So 
yes i can shared v2 with same message as v1

`memsize is combination of source and destination in MB`

>
> Thanks
  

Patch

diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst
index 9e3e78a6b7..6f85fceb8a 100644
--- a/doc/guides/tools/dmaperf.rst
+++ b/doc/guides/tools/dmaperf.rst
@@ -74,10 +74,10 @@  Configuration Parameters
   Currently supported types are ``DMA_MEM_COPY`` and ``CPU_MEM_COPY``.
 
 ``mem_size``
-  The size of the memory footprint.
+  The size of the memory footprint in megabytes (MB) for source and destination.
 
 ``buf_size``
-  The memory size of a single operation.
+  The memory size of a single operation in bytes (B).
 
 ``dma_ring_size``
   The DMA ring buffer size. Must be a power of two, and between ``64`` and ``4096``.