[Intel-gfx] [PATCH v2 7/7] drm/connector: add ref to drm_connector_get in iter docs

From: Simon Ser <contact@emersion.fr>
To: dri-devel@lists.freedesktop.org, amd-gfx@lists.freedesktop.org
Cc: pekka.paalanen@collabora.com, michel@daenzer.net,
	alexander.deucher@amd.com, harry.wentland@amd.com,
	intel-gfx@lists.freedesktop.org
Subject: [Intel-gfx] [PATCH v2 7/7] drm/connector: add ref to drm_connector_get in iter docs
Date: Wed, 09 Jun 2021 21:24:10 +0000	[thread overview]
Message-ID: <KRoUI7OC9lRIvk3YzdGm6tcMVAVlG1fR78Ll7kTZZT4@cp3-web-051.plabs.ch> (raw)

Mention that connectors need to be referenced manually if they are
to be accessed after the iteration has progressed or ended.

Signed-off-by: Simon Ser <contact@emersion.fr>
---
 include/drm/drm_connector.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index 714d1a01c065..c1af1e4ca560 100644
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -1735,6 +1735,11 @@ void drm_mode_put_tile_group(struct drm_device *dev,
  * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
  * drm_connector_list_iter_next() respectively the convenience macro
  * drm_for_each_connector_iter().
+ *
+ * Note that the return value of drm_connector_list_iter_next() is only valid
+ * up to the next drm_connector_list_iter_next() or
+ * drm_connector_list_iter_end() call. If you want to use the connector later,
+ * then you need to grab your own reference first using drm_connector_get().
  */
 struct drm_connector_list_iter {
 /* private: */
-- 
2.31.1


_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
