Commit 35f2c3ae authored by Ville Syrjälä's avatar Ville Syrjälä Committed by Dave Airlie
Browse files

drm: Add kernel-doc for plane functions 



v2: Follow the drm_crtc documentation fixes

Signed-off-by: default avatarVille Syrjälä <ville.syrjala@linux.intel.com>
Signed-off-by: default avatarDave Airlie <airlied@gmail.com>
parent 3858bc5d

drivers/gpu/drm/drm_crtc.c

+32 −0
Original line number Diff line number Diff line
@@ -819,6 +819,21 @@ void drm_encoder_cleanup(struct drm_encoder *encoder) 
}

EXPORT_SYMBOL(drm_encoder_cleanup);



/**

 * drm_plane_init - Initialise a new plane object

 * @dev: DRM device

 * @plane: plane object to init

 * @possible_crtcs: bitmask of possible CRTCs

 * @funcs: callbacks for the new plane

 * @formats: array of supported formats (%DRM_FORMAT_*)

 * @format_count: number of elements in @formats

 * @priv: plane is private (hidden from userspace)?

 *

 * Inits a new object created as base part of a driver plane object.

 *

 * RETURNS:

 * Zero on success, error code on failure.

 */

int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,

		   unsigned long possible_crtcs,

		   const struct drm_plane_funcs *funcs,
@@ -867,6 +882,14 @@ int drm_plane_init(struct drm_device *dev, struct drm_plane *plane, 
}

EXPORT_SYMBOL(drm_plane_init);



/**

 * drm_plane_cleanup - Clean up the core plane usage

 * @plane: plane to cleanup

 *

 * This function cleans up @plane and removes it from the DRM mode setting

 * core. Note that the function does *not* free the plane structure itself,

 * this is the responsibility of the caller.

 */

void drm_plane_cleanup(struct drm_plane *plane)

{

	struct drm_device *dev = plane->dev;
@@ -883,6 +906,15 @@ void drm_plane_cleanup(struct drm_plane *plane) 
}

EXPORT_SYMBOL(drm_plane_cleanup);



/**

 * drm_plane_force_disable - Forcibly disable a plane

 * @plane: plane to disable

 *

 * Forces the plane to be disabled.

 *

 * Used when the plane's current framebuffer is destroyed,

 * and when restoring fbdev mode.

 */

void drm_plane_force_disable(struct drm_plane *plane)

{

	int ret;