summaryrefslogtreecommitdiffstats
path: root/include/drm/drm_crtc.h
diff options
context:
space:
mode:
authorDaniel Vetter <daniel.vetter@ffwll.ch>2017-05-24 16:51:45 +0200
committerDaniel Vetter <daniel.vetter@ffwll.ch>2017-06-20 10:26:01 +0200
commit57d30230c573e3f1a49ae7e0f7f8b73b17881415 (patch)
treea395d6088f1f0be02aa9dd4f5a626d3699423a08 /include/drm/drm_crtc.h
parent27fa5510f18b11845a6c46755e41ea66eeaccf0a (diff)
downloadlinux-stable-57d30230c573e3f1a49ae7e0f7f8b73b17881415.tar.gz
linux-stable-57d30230c573e3f1a49ae7e0f7f8b73b17881415.tar.bz2
linux-stable-57d30230c573e3f1a49ae7e0f7f8b73b17881415.zip
drm/doc: vblank cleanup
Unify and review everything, plus make sure it's all correct markup. Drop the kernel-doc for internal functions. Also rework the overview section, it's become rather outdated. Unfortuantely the kernel-doc in drm_driver isn't rendered yet, but that will change as soon as drm_driver is kernel-docified properly. Also document properly that drm_vblank_cleanup is optional, the core calls this already. v2: Make it clear that cleanup happens in drm_dev_fini for drivers with their own ->release callback (Thierry). Acked-by: Thierry Reding <treding@nvidia.com> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> Link: http://patchwork.freedesktop.org/patch/msgid/20170524145212.27837-11-daniel.vetter@ffwll.ch
Diffstat (limited to 'include/drm/drm_crtc.h')
-rw-r--r--include/drm/drm_crtc.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h
index 629a5fe075b3..3a911a64c257 100644
--- a/include/drm/drm_crtc.h
+++ b/include/drm/drm_crtc.h
@@ -685,6 +685,9 @@ struct drm_crtc_funcs {
* drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
* enabling a CRTC.
*
+ * See also &drm_device.vblank_disable_immediate and
+ * &drm_device.max_vblank_count.
+ *
* Returns:
*
* Raw vblank counter value.