drm/probe-helper: Document drm_helper_hpd_irq_event() return value
authorMaxime Ripard <maxime@cerno.tech>
Tue, 14 Sep 2021 10:17:22 +0000 (12:17 +0200)
committerMaxime Ripard <maxime@cerno.tech>
Tue, 28 Sep 2021 10:17:25 +0000 (12:17 +0200)
The documentation of the drm_helper_hpd_irq_event() function didn't
document the value that function was returning. Add that part as well.

Signed-off-by: Maxime Ripard <maxime@cerno.tech>
Reviewed-by: Sam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20210914101724.266570-1-maxime@cerno.tech
drivers/gpu/drm/drm_probe_helper.c

index 5606bca3caa83caa8439b8765b4cdb74a5f002a3..5b77fb5c1a325c92cb0f65adf84b732f603c0e69 100644 (file)
@@ -817,6 +817,9 @@ EXPORT_SYMBOL(drm_kms_helper_poll_fini);
  *
  * Note that a connector can be both polled and probed from the hotplug handler,
  * in case the hotplug interrupt is known to be unreliable.
+ *
+ * Returns:
+ * A boolean indicating whether the connector status changed or not
  */
 bool drm_helper_hpd_irq_event(struct drm_device *dev)
 {