drm/plane: Clarify our expectations for src/dst rectangles
diff mbox series

Message ID 20191010112918.15724-1-maarten.lankhorst@linux.intel.com
State New
Headers show
Series
  • drm/plane: Clarify our expectations for src/dst rectangles
Related show

Commit Message

Maarten Lankhorst Oct. 10, 2019, 11:29 a.m. UTC
The rectangles are usually clipped, but it can be useful to have
them unclipped, for example for cursor planes.

Signed-off-by: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
---
 include/drm/drm_plane.h | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

Comments

Ville Syrjälä Oct. 10, 2019, 12:36 p.m. UTC | #1
On Thu, Oct 10, 2019 at 01:29:17PM +0200, Maarten Lankhorst wrote:
> The rectangles are usually clipped, but it can be useful to have
> them unclipped, for example for cursor planes.
> 
> Signed-off-by: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> ---
>  include/drm/drm_plane.h | 22 ++++++++++++++++++++--
>  1 file changed, 20 insertions(+), 2 deletions(-)
> 
> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
> index cd5903ad33f7..94bbbf215100 100644
> --- a/include/drm/drm_plane.h
> +++ b/include/drm/drm_plane.h
> @@ -183,8 +183,26 @@ struct drm_plane_state {
>  	 */
>  	struct drm_property_blob *fb_damage_clips;
>  
> -	/** @src: clipped source coordinates of the plane (in 16.16) */
> -	/** @dst: clipped destination coordinates of the plane */
> +	/**
> +	 * @src:
> +	 *
> +	 * source coordinates of the plane (in 16.16).
> +	 *
> +	 * When using drm_atomic_helper_check_plane_state(),
> +	 * the coordinates are clipped, but the driver may choose
> +	 * to use unclipped coordinates instead.
> +	 *
> +	 * This can be useful when using a hardcoded size in a cursor plane.

I would instead say something like "when the hardware performs
the clipping automagically".

> +	 */
> +	/**
> +	 * @dst:
> +	 *
> +	 * When using drm_atomic_helper_check_plane_state(),
> +	 * the coordinates are clipped, but the driver may choose
> +	 * to use unclipped coordinates instead.
> +	 *
> +	 * This can be useful when using a hardcoded size in a cursor plane.
> +	 */
>  	struct drm_rect src, dst;
>  
>  	/**
> -- 
> 2.23.0
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
Maarten Lankhorst Oct. 10, 2019, 12:46 p.m. UTC | #2
Op 10-10-2019 om 14:36 schreef Ville Syrjälä:
> On Thu, Oct 10, 2019 at 01:29:17PM +0200, Maarten Lankhorst wrote:
>> The rectangles are usually clipped, but it can be useful to have
>> them unclipped, for example for cursor planes.
>>
>> Signed-off-by: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
>> ---
>>  include/drm/drm_plane.h | 22 ++++++++++++++++++++--
>>  1 file changed, 20 insertions(+), 2 deletions(-)
>>
>> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
>> index cd5903ad33f7..94bbbf215100 100644
>> --- a/include/drm/drm_plane.h
>> +++ b/include/drm/drm_plane.h
>> @@ -183,8 +183,26 @@ struct drm_plane_state {
>>  	 */
>>  	struct drm_property_blob *fb_damage_clips;
>>  
>> -	/** @src: clipped source coordinates of the plane (in 16.16) */
>> -	/** @dst: clipped destination coordinates of the plane */
>> +	/**
>> +	 * @src:
>> +	 *
>> +	 * source coordinates of the plane (in 16.16).
>> +	 *
>> +	 * When using drm_atomic_helper_check_plane_state(),
>> +	 * the coordinates are clipped, but the driver may choose
>> +	 * to use unclipped coordinates instead.
>> +	 *
>> +	 * This can be useful when using a hardcoded size in a cursor plane.
> I would instead say something like "when the hardware performs
> the clipping automagically".


With that fixed, r-b?
Ville Syrjälä Oct. 10, 2019, 1:07 p.m. UTC | #3
On Thu, Oct 10, 2019 at 02:46:26PM +0200, Maarten Lankhorst wrote:
> Op 10-10-2019 om 14:36 schreef Ville Syrjälä:
> > On Thu, Oct 10, 2019 at 01:29:17PM +0200, Maarten Lankhorst wrote:
> >> The rectangles are usually clipped, but it can be useful to have
> >> them unclipped, for example for cursor planes.
> >>
> >> Signed-off-by: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> >> ---
> >>  include/drm/drm_plane.h | 22 ++++++++++++++++++++--
> >>  1 file changed, 20 insertions(+), 2 deletions(-)
> >>
> >> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
> >> index cd5903ad33f7..94bbbf215100 100644
> >> --- a/include/drm/drm_plane.h
> >> +++ b/include/drm/drm_plane.h
> >> @@ -183,8 +183,26 @@ struct drm_plane_state {
> >>  	 */
> >>  	struct drm_property_blob *fb_damage_clips;
> >>  
> >> -	/** @src: clipped source coordinates of the plane (in 16.16) */
> >> -	/** @dst: clipped destination coordinates of the plane */
> >> +	/**
> >> +	 * @src:
> >> +	 *
> >> +	 * source coordinates of the plane (in 16.16).
> >> +	 *
> >> +	 * When using drm_atomic_helper_check_plane_state(),
> >> +	 * the coordinates are clipped, but the driver may choose
> >> +	 * to use unclipped coordinates instead.
> >> +	 *
> >> +	 * This can be useful when using a hardcoded size in a cursor plane.
> > I would instead say something like "when the hardware performs
> > the clipping automagically".
> 
> 
> With that fixed, r-b?

Aye

Reviewed-by: Ville Syrjälä <ville.syrjala@linux.intel.com>
Maarten Lankhorst Oct. 10, 2019, 1:49 p.m. UTC | #4
Op 10-10-2019 om 15:07 schreef Ville Syrjälä:
> On Thu, Oct 10, 2019 at 02:46:26PM +0200, Maarten Lankhorst wrote:
>> Op 10-10-2019 om 14:36 schreef Ville Syrjälä:
>>> On Thu, Oct 10, 2019 at 01:29:17PM +0200, Maarten Lankhorst wrote:
>>>> The rectangles are usually clipped, but it can be useful to have
>>>> them unclipped, for example for cursor planes.
>>>>
>>>> Signed-off-by: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
>>>> ---
>>>>  include/drm/drm_plane.h | 22 ++++++++++++++++++++--
>>>>  1 file changed, 20 insertions(+), 2 deletions(-)
>>>>
>>>> diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
>>>> index cd5903ad33f7..94bbbf215100 100644
>>>> --- a/include/drm/drm_plane.h
>>>> +++ b/include/drm/drm_plane.h
>>>> @@ -183,8 +183,26 @@ struct drm_plane_state {
>>>>  	 */
>>>>  	struct drm_property_blob *fb_damage_clips;
>>>>  
>>>> -	/** @src: clipped source coordinates of the plane (in 16.16) */
>>>> -	/** @dst: clipped destination coordinates of the plane */
>>>> +	/**
>>>> +	 * @src:
>>>> +	 *
>>>> +	 * source coordinates of the plane (in 16.16).
>>>> +	 *
>>>> +	 * When using drm_atomic_helper_check_plane_state(),
>>>> +	 * the coordinates are clipped, but the driver may choose
>>>> +	 * to use unclipped coordinates instead.
>>>> +	 *
>>>> +	 * This can be useful when using a hardcoded size in a cursor plane.
>>> I would instead say something like "when the hardware performs
>>> the clipping automagically".
>>
>> With that fixed, r-b?
> Aye
>
> Reviewed-by: Ville Syrjälä <ville.syrjala@linux.intel.com>
>
Noticed I dropped the explanation for dst when checking docbook output, fixed and pushed. :)

Patch
diff mbox series

diff --git a/include/drm/drm_plane.h b/include/drm/drm_plane.h
index cd5903ad33f7..94bbbf215100 100644
--- a/include/drm/drm_plane.h
+++ b/include/drm/drm_plane.h
@@ -183,8 +183,26 @@  struct drm_plane_state {
 	 */
 	struct drm_property_blob *fb_damage_clips;
 
-	/** @src: clipped source coordinates of the plane (in 16.16) */
-	/** @dst: clipped destination coordinates of the plane */
+	/**
+	 * @src:
+	 *
+	 * source coordinates of the plane (in 16.16).
+	 *
+	 * When using drm_atomic_helper_check_plane_state(),
+	 * the coordinates are clipped, but the driver may choose
+	 * to use unclipped coordinates instead.
+	 *
+	 * This can be useful when using a hardcoded size in a cursor plane.
+	 */
+	/**
+	 * @dst:
+	 *
+	 * When using drm_atomic_helper_check_plane_state(),
+	 * the coordinates are clipped, but the driver may choose
+	 * to use unclipped coordinates instead.
+	 *
+	 * This can be useful when using a hardcoded size in a cursor plane.
+	 */
 	struct drm_rect src, dst;
 
 	/**