drm/doc: Polish docs for drm_mode_object
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
diff --git a/drivers/gpu/drm/drm_mode_object.c b/drivers/gpu/drm/drm_mode_object.c
index a92aeed..6edda83 100644
--- a/drivers/gpu/drm/drm_mode_object.c
+++ b/drivers/gpu/drm/drm_mode_object.c
@@ -97,7 +97,7 @@
* 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 @@
* 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 @@
* 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 @@
* @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 @@
* 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.
*/