[PATCH] drm/plane: Clarify our expectations for src/dst rectangles

[Maarten Lankhorst]

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 at 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 at linux.intel.com>
>
Noticed I dropped the explanation for dst when checking docbook output, fixed and pushed. :)