drm/doc: integrate drm_crtc.c kerneldoc

And do a quick pass to adjust them to the last few (years?) of changes
...

This time actually compile-tested ;-)

Reviewed-by: Rob Clark <rob@ti.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
This commit is contained in:
Daniel Vetter 2012-12-02 00:09:18 +01:00
parent 8faf6b18a2
commit 065a50ed3e
2 changed files with 48 additions and 48 deletions

View File

@ -1609,6 +1609,10 @@ void intel_crt_init(struct drm_device *dev)
make its properties available to applications. make its properties available to applications.
</para> </para>
</sect2> </sect2>
<sect2>
<title>KMS API Functions</title>
!Edrivers/gpu/drm/drm_crtc.c
</sect2>
</sect1> </sect1>
<!-- Internals: kms helper functions --> <!-- Internals: kms helper functions -->

View File

@ -203,10 +203,10 @@ char *drm_get_connector_status_name(enum drm_connector_status status)
} }
/** /**
* drm_mode_object_get - allocate a new identifier * drm_mode_object_get - allocate a new modeset identifier
* @dev: DRM device * @dev: DRM device
* @ptr: object pointer, used to generate unique ID * @obj: object pointer, used to generate unique ID
* @type: object type * @obj_type: object type
* *
* Create a unique identifier based on @ptr in @dev's identifier space. Used * Create a unique identifier based on @ptr in @dev's identifier space. Used
* for tracking modes, CRTCs and connectors. * for tracking modes, CRTCs and connectors.
@ -241,9 +241,9 @@ again:
} }
/** /**
* drm_mode_object_put - free an identifer * drm_mode_object_put - free a modeset identifer
* @dev: DRM device * @dev: DRM device
* @id: ID to free * @object: object to free
* *
* Free @id from @dev's unique identifier pool. * Free @id from @dev's unique identifier pool.
*/ */
@ -273,6 +273,8 @@ EXPORT_SYMBOL(drm_mode_object_find);
/** /**
* drm_framebuffer_init - initialize a framebuffer * drm_framebuffer_init - initialize a framebuffer
* @dev: DRM device * @dev: DRM device
* @fb: framebuffer to be initialized
* @funcs: ... with these functions
* *
* Allocates an ID for the framebuffer's parent mode object, sets its mode * Allocates an ID for the framebuffer's parent mode object, sets its mode
* functions & device file and adds it to the master fd list. * functions & device file and adds it to the master fd list.
@ -309,6 +311,9 @@ static void drm_framebuffer_free(struct kref *kref)
/** /**
* drm_framebuffer_unreference - unref a framebuffer * drm_framebuffer_unreference - unref a framebuffer
* @fb: framebuffer to unref
*
* This functions decrements the fb's refcount and frees it if it drops to zero.
*/ */
void drm_framebuffer_unreference(struct drm_framebuffer *fb) void drm_framebuffer_unreference(struct drm_framebuffer *fb)
{ {
@ -321,6 +326,7 @@ EXPORT_SYMBOL(drm_framebuffer_unreference);
/** /**
* drm_framebuffer_reference - incr the fb refcnt * drm_framebuffer_reference - incr the fb refcnt
* @fb: framebuffer
*/ */
void drm_framebuffer_reference(struct drm_framebuffer *fb) void drm_framebuffer_reference(struct drm_framebuffer *fb)
{ {
@ -493,7 +499,7 @@ EXPORT_SYMBOL(drm_mode_remove);
* @dev: DRM device * @dev: DRM device
* @connector: the connector to init * @connector: the connector to init
* @funcs: callbacks for this connector * @funcs: callbacks for this connector
* @name: user visible name of the connector * @connector_type: user visible type of the connector
* *
* Initialises a preallocated connector. Connectors should be * Initialises a preallocated connector. Connectors should be
* subclassed as part of driver connector objects. * subclassed as part of driver connector objects.
@ -1145,10 +1151,9 @@ static int drm_crtc_convert_umode(struct drm_display_mode *out,
/** /**
* drm_mode_getresources - get graphics configuration * drm_mode_getresources - get graphics configuration
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Construct a set of configuration description structures and return * Construct a set of configuration description structures and return
* them to the user, including CRTC, connector and framebuffer configuration. * them to the user, including CRTC, connector and framebuffer configuration.
@ -1330,10 +1335,9 @@ out:
/** /**
* drm_mode_getcrtc - get CRTC configuration * drm_mode_getcrtc - get CRTC configuration
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Construct a CRTC configuration structure to return to the user. * Construct a CRTC configuration structure to return to the user.
* *
@ -1387,10 +1391,9 @@ out:
/** /**
* drm_mode_getconnector - get connector configuration * drm_mode_getconnector - get connector configuration
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Construct a connector configuration structure to return to the user. * Construct a connector configuration structure to return to the user.
* *
@ -1675,7 +1678,7 @@ out:
* drm_mode_setplane - set up or tear down an plane * drm_mode_setplane - set up or tear down an plane
* @dev: DRM device * @dev: DRM device
* @data: ioctl data* * @data: ioctl data*
* @file_prive: DRM file info * @file_priv: DRM file info
* *
* Set plane info, including placement, fb, scaling, and other factors. * Set plane info, including placement, fb, scaling, and other factors.
* Or pass a NULL fb to disable. * Or pass a NULL fb to disable.
@ -1801,10 +1804,9 @@ out:
/** /**
* drm_mode_setcrtc - set CRTC configuration * drm_mode_setcrtc - set CRTC configuration
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Build a new CRTC configuration based on user request. * Build a new CRTC configuration based on user request.
* *
@ -2056,10 +2058,9 @@ EXPORT_SYMBOL(drm_mode_legacy_fb_format);
/** /**
* drm_mode_addfb - add an FB to the graphics configuration * drm_mode_addfb - add an FB to the graphics configuration
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Add a new FB to the specified CRTC, given a user request. * Add a new FB to the specified CRTC, given a user request.
* *
@ -2237,10 +2238,9 @@ static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
/** /**
* drm_mode_addfb2 - add an FB to the graphics configuration * drm_mode_addfb2 - add an FB to the graphics configuration
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Add a new FB to the specified CRTC, given a user request with format. * Add a new FB to the specified CRTC, given a user request with format.
* *
@ -2300,10 +2300,9 @@ out:
/** /**
* drm_mode_rmfb - remove an FB from the configuration * drm_mode_rmfb - remove an FB from the configuration
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Remove the FB specified by the user. * Remove the FB specified by the user.
* *
@ -2352,10 +2351,9 @@ out:
/** /**
* drm_mode_getfb - get FB info * drm_mode_getfb - get FB info
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Lookup the FB given its ID and return info about it. * Lookup the FB given its ID and return info about it.
* *
@ -2471,7 +2469,7 @@ out_err1:
/** /**
* drm_fb_release - remove and free the FBs on this file * drm_fb_release - remove and free the FBs on this file
* @filp: file * from the ioctl * @priv: drm file for the ioctl
* *
* Destroy all the FBs associated with @filp. * Destroy all the FBs associated with @filp.
* *
@ -2581,10 +2579,9 @@ EXPORT_SYMBOL(drm_mode_detachmode_crtc);
/** /**
* drm_fb_attachmode - Attach a user mode to an connector * drm_fb_attachmode - Attach a user mode to an connector
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* This attaches a user specified mode to an connector. * This attaches a user specified mode to an connector.
* Called by the user via ioctl. * Called by the user via ioctl.
@ -2636,10 +2633,9 @@ out:
/** /**
* drm_fb_detachmode - Detach a user specified mode from an connector * drm_fb_detachmode - Detach a user specified mode from an connector
* @inode: inode from the ioctl * @dev: drm device for the ioctl
* @filp: file * from the ioctl * @data: data pointer for the ioctl
* @cmd: cmd from ioctl * @file_priv: drm file for the ioctl call
* @arg: arg from ioctl
* *
* Called by the user via ioctl. * Called by the user via ioctl.
* *