Commit 3835b46e authored by Gustavo Padovan's avatar Gustavo Padovan Committed by Daniel Vetter

drm/plane: add inline doc for struct drm_plane

Some of the members of struct drm_plane had extra comments so for these
add inline kernel comment to consolidate all documentation in one place.
Signed-off-by: default avatarGustavo Padovan <gustavo.padovan@collabora.co.uk>
[danvet: Bikeshed a bit more to have real paragraphs with real
sentences.]
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Link: http://patchwork.freedesktop.org/patch/msgid/1478513013-3221-4-git-send-email-gustavo@padovan.org
parent 5d586983
...@@ -32,11 +32,6 @@ struct drm_crtc; ...@@ -32,11 +32,6 @@ struct drm_crtc;
/** /**
* struct drm_plane_state - mutable plane state * struct drm_plane_state - mutable plane state
* @plane: backpointer to the plane * @plane: backpointer to the plane
* @crtc: currently bound CRTC, NULL if disabled
* @fb: currently bound framebuffer
* @fence: optional fence to wait for before scanning out @fb
* @crtc_x: left position of visible portion of plane on crtc
* @crtc_y: upper position of visible portion of plane on crtc
* @crtc_w: width of visible portion of plane on crtc * @crtc_w: width of visible portion of plane on crtc
* @crtc_h: height of visible portion of plane on crtc * @crtc_h: height of visible portion of plane on crtc
* @src_x: left position of visible portion of plane within * @src_x: left position of visible portion of plane within
...@@ -51,18 +46,51 @@ struct drm_crtc; ...@@ -51,18 +46,51 @@ struct drm_crtc;
* where N is the number of active planes for given crtc * where N is the number of active planes for given crtc
* @src: clipped source coordinates of the plane (in 16.16) * @src: clipped source coordinates of the plane (in 16.16)
* @dst: clipped destination coordinates of the plane * @dst: clipped destination coordinates of the plane
* @visible: visibility of the plane
* @state: backpointer to global drm_atomic_state * @state: backpointer to global drm_atomic_state
*/ */
struct drm_plane_state { struct drm_plane_state {
struct drm_plane *plane; struct drm_plane *plane;
struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_plane() */ /**
struct drm_framebuffer *fb; /* do not write directly, use drm_atomic_set_fb_for_plane() */ * @crtc:
struct dma_fence *fence; /* do not write directly, use drm_atomic_set_fence_for_plane() */ *
* Currently bound CRTC, NULL if disabled. Do not this write directly,
* use drm_atomic_set_crtc_for_plane()
*/
struct drm_crtc *crtc;
/**
* @fb:
*
* Currently bound framebuffer. Do not write this directly, use
* drm_atomic_set_fb_for_plane()
*/
struct drm_framebuffer *fb;
/**
* @fence:
*
* Optional fence to wait for before scanning out @fb. Do not write this
* directly, use drm_atomic_set_fence_for_plane()
*/
struct dma_fence *fence;
/**
* @crtc_x:
*
* Left position of visible portion of plane on crtc, signed dest
* location allows it to be partially off screen.
*/
int32_t crtc_x;
/**
* @crtc_y:
*
* Upper position of visible portion of plane on crtc, signed dest
* location allows it to be partially off screen.
*/
int32_t crtc_y;
/* Signed dest location allows it to be partially off screen */
int32_t crtc_x, crtc_y;
uint32_t crtc_w, crtc_h; uint32_t crtc_w, crtc_h;
/* Source values are 16.16 fixed point */ /* Source values are 16.16 fixed point */
...@@ -79,9 +107,11 @@ struct drm_plane_state { ...@@ -79,9 +107,11 @@ struct drm_plane_state {
/* Clipped coordinates */ /* Clipped coordinates */
struct drm_rect src, dst; struct drm_rect src, dst;
/* /**
* Is the plane actually visible? Can be false even * @visible:
* if fb!=NULL and crtc!=NULL, due to clipping. *
* Visibility of the plane. This can be false even if fb!=NULL and
* crtc!=NULL, due to clipping.
*/ */
bool visible; bool visible;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment