[PATCH] doc: update size parameter details

[PATCH] doc: update size parameter details

[Vipin Varghese]

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``.
-- 
2.34.1

Re: [PATCH] doc: update size parameter details

[Varghese, Vipin]

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

Re: [PATCH] doc: update size parameter details

[fengchengwen]

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

Re: [PATCH] doc: update size parameter details

[Varghese, Vipin]

[-- Attachment #1: Type: text/plain, Size: 1390 bytes --]


<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

[-- Attachment #2: Type: text/html, Size: 2508 bytes --]

[PATCH v2] doc: update size parameter details

[Vipin Varghese]

For configuration parameters `mem_size` and `buf_size` are represented
as megabytes and bytes respectively in application. Update the
documentation and to represent the same.

V2 Changes:
 - add mem_size and buf_size in config.ini, suggested by Chengwen.

Signed-off-by: Vipin Varghese <vipin.varghese@amd.com>
---
---
 app/test-dma-perf/config.ini | 4 ++--
 doc/guides/tools/dmaperf.rst | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/app/test-dma-perf/config.ini b/app/test-dma-perf/config.ini
index b550f4b23f..17aa91c22d 100644
--- a/app/test-dma-perf/config.ini
+++ b/app/test-dma-perf/config.ini
@@ -5,8 +5,8 @@
 ; Supported test types are DMA_MEM_COPY and CPU_MEM_COPY.
 
 ; Parameters:
-; "mem_size" denotes the size of the memory footprint.
-; "buf_size" denotes the memory size of a single operation.
+; "mem_size" denotes the size of the memory footprint in megabytes (MB) for source and destination.
+; "buf_size" denotes the memory size of a single operation in bytes (B).
 ; "dma_ring_size" denotes the dma ring buffer size. It should be must be a power of two, and between
 ;  64 and 4096.
 ; "kick_batch" denotes the dma operation batch size, and should be greater than 1 normally.
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``.
-- 
2.39.3

Re: [PATCH v2] doc: update size parameter details

[fengchengwen]

Acked-by: Chengwen Feng <fengchengwen@huawei.com>

On 2024/3/12 12:22, Vipin Varghese wrote:
> For configuration parameters `mem_size` and `buf_size` are represented
> as megabytes and bytes respectively in application. Update the
> documentation and to represent the same.
> 
> V2 Changes:
>  - add mem_size and buf_size in config.ini, suggested by Chengwen.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@amd.com>
> ---
> ---
>  app/test-dma-perf/config.ini | 4 ++--
>  doc/guides/tools/dmaperf.rst | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/app/test-dma-perf/config.ini b/app/test-dma-perf/config.ini
> index b550f4b23f..17aa91c22d 100644
> --- a/app/test-dma-perf/config.ini
> +++ b/app/test-dma-perf/config.ini
> @@ -5,8 +5,8 @@
>  ; Supported test types are DMA_MEM_COPY and CPU_MEM_COPY.
>  
>  ; Parameters:
> -; "mem_size" denotes the size of the memory footprint.
> -; "buf_size" denotes the memory size of a single operation.
> +; "mem_size" denotes the size of the memory footprint in megabytes (MB) for source and destination.
> +; "buf_size" denotes the memory size of a single operation in bytes (B).
>  ; "dma_ring_size" denotes the dma ring buffer size. It should be must be a power of two, and between
>  ;  64 and 4096.
>  ; "kick_batch" denotes the dma operation batch size, and should be greater than 1 normally.
> 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``.
> 

Re: [PATCH v2] doc: update size parameter details

[fengchengwen]

Sorry for same reply,

@Vipin,
the title should reflect which submodule, so pls add prefix: test/dma-perf:
Suggest: test/dma-perf: refine size parameter details in doc
Just a suggestion, you could refine it.

On 2024/3/12 14:07, fengchengwen wrote:
> Acked-by: Chengwen Feng <fengchengwen@huawei.com>
> 
> On 2024/3/12 12:22, Vipin Varghese wrote:
>> For configuration parameters `mem_size` and `buf_size` are represented
>> as megabytes and bytes respectively in application. Update the
>> documentation and to represent the same.
>>
>> V2 Changes:
>>  - add mem_size and buf_size in config.ini, suggested by Chengwen.
>>
>> Signed-off-by: Vipin Varghese <vipin.varghese@amd.com>
>> ---
>> ---
>>  app/test-dma-perf/config.ini | 4 ++--
>>  doc/guides/tools/dmaperf.rst | 4 ++--
>>  2 files changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/app/test-dma-perf/config.ini b/app/test-dma-perf/config.ini
>> index b550f4b23f..17aa91c22d 100644
>> --- a/app/test-dma-perf/config.ini
>> +++ b/app/test-dma-perf/config.ini
>> @@ -5,8 +5,8 @@
>>  ; Supported test types are DMA_MEM_COPY and CPU_MEM_COPY.
>>  
>>  ; Parameters:
>> -; "mem_size" denotes the size of the memory footprint.
>> -; "buf_size" denotes the memory size of a single operation.
>> +; "mem_size" denotes the size of the memory footprint in megabytes (MB) for source and destination.
>> +; "buf_size" denotes the memory size of a single operation in bytes (B).
>>  ; "dma_ring_size" denotes the dma ring buffer size. It should be must be a power of two, and between
>>  ;  64 and 4096.
>>  ; "kick_batch" denotes the dma operation batch size, and should be greater than 1 normally.
>> 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``.
>>

Re: [PATCH v2] doc: update size parameter details

[Thomas Monjalon]

12/03/2024 07:17, fengchengwen:
> Sorry for same reply,
> 
> @Vipin,
> the title should reflect which submodule, so pls add prefix: test/dma-perf:

No it should be app/dma-perf.
If not sure about a prefix, you may check the git history for the directory.

> Suggest: test/dma-perf: refine size parameter details in doc
> Just a suggestion, you could refine it.
> 
> On 2024/3/12 14:07, fengchengwen wrote:
> > Acked-by: Chengwen Feng <fengchengwen@huawei.com>

Please add your ack below the sign-off for clearer reply chain.

> > On 2024/3/12 12:22, Vipin Varghese wrote:
> >> For configuration parameters `mem_size` and `buf_size` are represented
> >> as megabytes and bytes respectively in application. Update the
> >> documentation and to represent the same.
> >>
> >> V2 Changes:
> >>  - add mem_size and buf_size in config.ini, suggested by Chengwen.
> >>
> >> Signed-off-by: Vipin Varghese <vipin.varghese@amd.com>

Applied, thanks.