[PATCH] doc: update size parameter details

fengchengwen fengchengwen at huawei.com
Thu Mar 7 14:27:01 CET 2024


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


More information about the stable mailing list