Unverified Commit 77a71abb authored by Simon Ser's avatar Simon Ser
Browse files

drm/doc: introduce new section for standard plane properties 



Introduce a new "Standard Plane Properties" section for properties
defined in drm_plane.c. Move the mis-placed IN_FORMATS docs there.

Signed-off-by: default avatarSimon Ser <contact@emersion.fr>
Reviewed-by: default avatarDaniel Vetter <daniel@ffwll.ch>
Cc: Pekka Paalanen <ppaalanen@gmail.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20201217113220.102271-3-contact@emersion.fr
parent 46f9be4c

Documentation/gpu/drm-kms.rst

+6 −0
Original line number Diff line number Diff line
@@ -493,6 +493,12 @@ Standard CRTC Properties 
.. kernel-doc:: drivers/gpu/drm/drm_crtc.c

   :doc: standard CRTC properties



Standard Plane Properties

-------------------------



.. kernel-doc:: drivers/gpu/drm/drm_plane.c

   :doc: standard plane properties



Plane Composition Properties

----------------------------

drivers/gpu/drm/drm_blend.c

+0 −6
Original line number Diff line number Diff line
@@ -185,12 +185,6 @@ 
 *		 plane does not expose the "alpha" property, then this is

 *		 assumed to be 1.0

 *

 * IN_FORMATS:

 *	Blob property which contains the set of buffer format and modifier

 *	pairs supported by this plane. The blob is a drm_format_modifier_blob

 *	struct. Without this property the plane doesn't support buffers with

 *	modifiers. Userspace cannot change this property.

 *

 * Note that all the property extensions described here apply either to the

 * plane or the CRTC (e.g. for the background color, which currently is not

 * exposed and assumed to be black).

drivers/gpu/drm/drm_plane.c

+12 −0
Original line number Diff line number Diff line
@@ -61,6 +61,18 @@ 
 * userspace too much.

 */



/**

 * DOC: standard plane properties

 *

 * DRM planes have a few standardized properties:

 *

 * IN_FORMATS:

 *     Blob property which contains the set of buffer format and modifier

 *     pairs supported by this plane. The blob is a drm_format_modifier_blob

 *     struct. Without this property the plane doesn't support buffers with

 *     modifiers. Userspace cannot change this property.

 */



static unsigned int drm_num_planes(struct drm_device *dev)

{

	unsigned int num = 0;