Skip to contentSkip to conversation

drm/mode_object: fix documentation for object lookups.

PATCH In review Dave Airlie 2 participants 2 messages Nov 8, 2017 – Nov 9, 2017

Subsystems (2)
lore
Share & tools
lore

Dave Airlie

author maintainer
#0 lore raw

PATCH 1/1 drm/mode_object: fix documentation for object lookups.

From: Dave Airlie <[email protected]>

The lease updates missed a few bits of docs, fixed up the wrong name on the property lookup fn as well.

---
 drivers/gpu/drm/drm_framebuffer.c | 1 +
 drivers/gpu/drm/drm_mode_object.c | 1 +
 include/drm/drm_connector.h       | 1 +
 include/drm/drm_crtc.h            | 1 +
 include/drm/drm_encoder.h         | 1 +
 include/drm/drm_plane.h           | 1 +
 include/drm/drm_property.h        | 3 ++-
 7 files changed, 8 insertions(+), 1 deletion(-)
drivers/gpu/drm/drm_framebuffer.c +1 -0
index 2affe53..279c103 100644
@@ -681,6 +681,7 @@ EXPORT_SYMBOL(drm_framebuffer_init);
 /**
  * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
  * @dev: drm device
+ * @file_priv: drm file to check for lease against.
  * @id: id of the fb object
  *
  * If successful, this grabs an additional reference to the framebuffer -
drivers/gpu/drm/drm_mode_object.c +1 -0
index 7c8b269..ce4d2fb 100644
@@ -151,6 +151,7 @@ struct drm_mode_object *__drm_mode_object_find(struct drm_device *dev,
 
 /**
  * drm_mode_object_find - look up a drm object with static lifetime
+ * @dev: drm device
  * @file_priv: drm file
  * @id: id of the mode object
  * @type: type of the mode object
include/drm/drm_connector.h +1 -0
index b4285c40..7a71405 100644
@@ -933,6 +933,7 @@ static inline unsigned drm_connector_index(struct drm_connector *connector)
 /**
  * drm_connector_lookup - lookup connector object
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: connector object id
  *
  * This function looks up the connector object specified by id
include/drm/drm_crtc.h +1 -0
index f7fccee..a2d81d2 100644
@@ -952,6 +952,7 @@ struct drm_crtc *drm_crtc_from_index(struct drm_device *dev, int idx);
 /**
  * drm_crtc_find - look up a CRTC object from its ID
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: &drm_mode_object ID
  *
  * This can be used to look up a CRTC from its userspace ID. Only used by
include/drm/drm_encoder.h +1 -0
index 86db0da..ee4cfbe 100644
@@ -208,6 +208,7 @@ static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
 /**
  * drm_encoder_find - find a &drm_encoder
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: encoder id
  *
  * Returns the encoder with @id, NULL if it doesn't exist. Simple wrapper around
include/drm/drm_plane.h +1 -0
index 069c4c8..5716150 100644
@@ -591,6 +591,7 @@ int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
 /**
  * drm_plane_find - find a &drm_plane
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: plane id
  *
  * Returns the plane with @id, NULL if it doesn't exist. Simple wrapper around
include/drm/drm_property.h +2 -1
index 429d821..8a522b4 100644
@@ -305,8 +305,9 @@ drm_property_unreference_blob(struct drm_property_blob *blob)
 }
 
 /**
- * drm_connector_find - find property object
+ * drm_property_find - find property object
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: property object id
  *
  * This function looks up the property object specified by id and returns it.
Signature · 6 lines
2.9.5

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · Dave Airlie

From: Dave Airlie <[email protected]>

The lease updates missed a few bits of docs, fixed up the wrong name on the property lookup fn as well.

Thanks a lot! Would have typed them myself, but was a bit late yesterday.

Quoted 104 lines
---
 drivers/gpu/drm/drm_framebuffer.c | 1 +
 drivers/gpu/drm/drm_mode_object.c | 1 +
 include/drm/drm_connector.h       | 1 +
 include/drm/drm_crtc.h            | 1 +
 include/drm/drm_encoder.h         | 1 +
 include/drm/drm_plane.h           | 1 +
 include/drm/drm_property.h        | 3 ++-
 7 files changed, 8 insertions(+), 1 deletion(-)
drivers/gpu/drm/drm_framebuffer.c +1 -0
index 2affe53..279c103 100644
@@ -681,6 +681,7 @@ EXPORT_SYMBOL(drm_framebuffer_init);
 /**
  * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
  * @dev: drm device
+ * @file_priv: drm file to check for lease against.
  * @id: id of the fb object
  *
  * If successful, this grabs an additional reference to the framebuffer -
drivers/gpu/drm/drm_mode_object.c +1 -0
index 7c8b269..ce4d2fb 100644
@@ -151,6 +151,7 @@ struct drm_mode_object *__drm_mode_object_find(struct drm_device *dev,
 
 /**
  * drm_mode_object_find - look up a drm object with static lifetime
+ * @dev: drm device
  * @file_priv: drm file
  * @id: id of the mode object
  * @type: type of the mode object
include/drm/drm_connector.h +1 -0
index b4285c40..7a71405 100644
@@ -933,6 +933,7 @@ static inline unsigned drm_connector_index(struct drm_connector *connector)
 /**
  * drm_connector_lookup - lookup connector object
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: connector object id
  *
  * This function looks up the connector object specified by id
include/drm/drm_crtc.h +1 -0
index f7fccee..a2d81d2 100644
@@ -952,6 +952,7 @@ struct drm_crtc *drm_crtc_from_index(struct drm_device *dev, int idx);
 /**
  * drm_crtc_find - look up a CRTC object from its ID
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: &drm_mode_object ID
  *
  * This can be used to look up a CRTC from its userspace ID. Only used by
include/drm/drm_encoder.h +1 -0
index 86db0da..ee4cfbe 100644
@@ -208,6 +208,7 @@ static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
 /**
  * drm_encoder_find - find a &drm_encoder
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: encoder id
  *
  * Returns the encoder with @id, NULL if it doesn't exist. Simple wrapper around
include/drm/drm_plane.h +1 -0
index 069c4c8..5716150 100644
@@ -591,6 +591,7 @@ int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
 /**
  * drm_plane_find - find a &drm_plane
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: plane id
  *
  * Returns the plane with @id, NULL if it doesn't exist. Simple wrapper around
include/drm/drm_property.h +2 -1
index 429d821..8a522b4 100644
@@ -305,8 +305,9 @@ drm_property_unreference_blob(struct drm_property_blob *blob)
 }
 
 /**
- * drm_connector_find - find property object
+ * drm_property_find - find property object
  * @dev: DRM device
+ * @file_priv: drm file to check for lease against.
  * @id: property object id
  *
  * This function looks up the property object specified by id and returns it.
Signature · 6 lines
2.9.5

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel