GitHub-Mirror/Star64_linux
2
0
Fork 0
mirror of https://github.com/Fishwaldo/Star64_linux.git synced 2025-06-27 00:51:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

drm/doc: Polish docs for drm_mode_object

Browse source 
I figured an overview section here is overkill, and better
to just document the 2 structures themselves well enough.

v2: Review from Archit:
- Appease checkpatch in moved code.
- Spelling fixes in the kerneldoc.

Reviewed-by: Archit Taneja <architt@codeaurora.org>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: http://patchwork.freedesktop.org/patch/msgid/20160829082757.17913-5-daniel.vetter@ffwll.ch
This commit is contained in:
Daniel Vetter 2016-08-29 10:27:53 +02:00
parent f094d88195
commit a2511a557e
2 changed files with 60 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

17
drivers/gpu/drm/drm_mode_object.c
View file

@ -97,7 +97,7 @@ void drm_mode_object_register(struct drm_device *dev,
* for reference counted modeset objects like framebuffers.
*/
void drm_mode_object_unregister(struct drm_device *dev,
struct drm_mode_object *object)
struct drm_mode_object *object)
{
mutex_lock(&dev->mode_config.idr_mutex);
if (object->id) {
@ -152,7 +152,7 @@ EXPORT_SYMBOL(drm_mode_object_find);
* drm_mode_object_unreference - decr the object refcnt
* @obj: mode_object
*
* This functions decrements the object's refcount if it is a refcounted modeset
* This function decrements the object's refcount if it is a refcounted modeset
* object. It is a no-op on any other object. This is used to drop references
* acquired with drm_mode_object_reference().
*/
@ -169,7 +169,7 @@ EXPORT_SYMBOL(drm_mode_object_unreference);
* drm_mode_object_reference - incr the object refcnt
* @obj: mode_object
*
* This functions increments the object's refcount if it is a refcounted modeset
* This function increments the object's refcount if it is a refcounted modeset
* object. It is a no-op on any other object. References should be dropped again
* by calling drm_mode_object_unreference().
*/
@ -218,10 +218,16 @@ EXPORT_SYMBOL(drm_object_attach_property);
* @property: property to set
* @val: value the property should be set to
*
* This functions sets a given property on a given object. This function only
* This function sets a given property on a given object. This function only
* changes the software state of the property, it does not call into the
* driver's ->set_property callback.
*
* Note that atomic drivers should not have any need to call this, the core will
* ensure consistency of values reported back to userspace through the
* appropriate ->atomic_get_property callback. Only legacy drivers should call
* this function to update the tracked value (after clamping and other
* restrictions have been applied).
*
* Returns:
* Zero on success, error code on failure.
*/
@ -252,6 +258,9 @@ EXPORT_SYMBOL(drm_object_property_set_value);
* value this might be out of sync with the hardware, depending upon the driver
* and property.
*
* Atomic drivers should never call this function directly, the core will read
* out property values through the various ->atomic_get_property callbacks.
*
* Returns:
* Zero on success, error code on failure.
*/