[v2] doc: update size parameter details
Checks
Commit Message
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(-)
Comments
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``.
>
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``.
>>
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.
@@ -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.
@@ -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``.