[PATCH] accel/ivpu: Document DRM_IVPU_PARAM_CAPABILITIES

[Jeffrey Hugo]

On 8/10/2023 2:07 AM, Stanislaw Gruszka wrote:
> Add comments regarding new DRM_IVPU_PARAM_CAPABILITIES param.
> 
> Signed-off-by: Stanislaw Gruszka <stanislaw.gruszka at linux.intel.com>
> ---
>   include/uapi/drm/ivpu_accel.h | 19 +++++++++++++++++--
>   1 file changed, 17 insertions(+), 2 deletions(-)
> 
> diff --git a/include/uapi/drm/ivpu_accel.h b/include/uapi/drm/ivpu_accel.h
> index a58a14c9f222..7d1ecc5bbac3 100644
> --- a/include/uapi/drm/ivpu_accel.h
> +++ b/include/uapi/drm/ivpu_accel.h
> @@ -69,8 +69,21 @@ extern "C" {
>   #define DRM_IVPU_CONTEXT_PRIORITY_FOCUS	    2
>   #define DRM_IVPU_CONTEXT_PRIORITY_REALTIME  3
>   
> -#define DRM_IVPU_CAP_METRIC_STREAMER	    1
> -#define DRM_IVPU_CAP_DMA_MEMORY_RANGE       2
> +/**
> + * DRM_IVPU_CAP_METRIC_STREAMER
> + *
> + * Metric streamer support, provides sampling of various hardware
> + * performance metrics (like DMA bandwidth, cache miss/hits),
> + * can be used for profiling.

Feels like this is a run-on sentence.  I think this reads better -

Metric streamer support.  Provides sampling of various hardware 
performance metrics like DMA bandwidth and cache miss/hits.  Can be used 
for profiling.

What do you think?

> + */
> +#define DRM_IVPU_CAP_METRIC_STREAMER	1
> +/**
> + * DRM_IVPU_CAP_DMA_MEMORY_RANGE
> + *
> + * Driver has capability to allocate separate memory range
> + * accessible by hardware DMA.
> + */
> +#define DRM_IVPU_CAP_DMA_MEMORY_RANGE	2
>   
>   /**
>    * struct drm_ivpu_param - Get/Set VPU parameters
> @@ -123,6 +136,8 @@ struct drm_ivpu_param {
>   	 * %DRM_IVPU_PARAM_SKU:
>   	 * VPU SKU ID (read-only)
>   	 *
> +	 * %DRM_IVPU_PARAM_CAPABILITIES:
> +	 * Supported capabilities (read-only)
>   	 */
>   	__u32 param;
>