diff mbox series

accel/ivpu: Document DRM_IVPU_PARAM_CAPABILITIES

Message ID 20230810080707.3545883-1-stanislaw.gruszka@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series accel/ivpu: Document DRM_IVPU_PARAM_CAPABILITIES | expand

Commit Message

Stanislaw Gruszka Aug. 10, 2023, 8:07 a.m. UTC
Add comments regarding new DRM_IVPU_PARAM_CAPABILITIES param.

Signed-off-by: Stanislaw Gruszka <stanislaw.gruszka@linux.intel.com>
---
 include/uapi/drm/ivpu_accel.h | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

Comments

Jeffrey Hugo Aug. 10, 2023, 2:27 p.m. UTC | #1
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@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;
>
Stanislaw Gruszka Aug. 10, 2023, 2:32 p.m. UTC | #2
On Thu, Aug 10, 2023 at 08:27:08AM -0600, Jeffrey Hugo wrote:
> 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@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?

Looks better :-)

Thanks
Stanislaw
Jeffrey Hugo Aug. 10, 2023, 2:49 p.m. UTC | #3
On 8/10/2023 8:32 AM, Stanislaw Gruszka wrote:
> On Thu, Aug 10, 2023 at 08:27:08AM -0600, Jeffrey Hugo wrote:
>> 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@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?
> 
> Looks better :-)

Ok.  I guess with that
Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
Stanislaw Gruszka Aug. 11, 2023, 8:52 a.m. UTC | #4
On Thu, Aug 10, 2023 at 08:49:00AM -0600, Jeffrey Hugo wrote:
> On 8/10/2023 8:32 AM, Stanislaw Gruszka wrote:
> > On Thu, Aug 10, 2023 at 08:27:08AM -0600, Jeffrey Hugo wrote:
> > > 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@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?
> > 
> > Looks better :-)
> 
> Ok.  I guess with that
> Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com>

Thanks, applied to drm-misc-next

Regards
Stanislaw
diff mbox series

Patch

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.
+ */
+#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;