drm: rcar-du: Document the rcar_du_plane_state structure

Document the structure fields using kerneldoc.

Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2015-04-29 00:12:40 +03:00
parent bce9936a0d
commit 0855c6827f
1 changed files with 10 additions and 1 deletions

View File

@ -46,11 +46,20 @@ struct rcar_du_planes {
struct drm_property *zpos;
};
/**
* struct rcar_du_plane_state - Driver-specific plane state
* @state: base DRM plane state
* @format: information about the pixel format used by the plane
* @hwindex: 0-based hardware plane index, -1 means unused
* @alpha: value of the plane alpha property
* @colorkey: value of the plane colorkey property
* @zpos: value of the plane zpos property
*/
struct rcar_du_plane_state {
struct drm_plane_state state;
const struct rcar_du_format_info *format;
int hwindex; /* 0-based, -1 means unused */
int hwindex;
unsigned int alpha;
unsigned int colorkey;