aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorMichael Witten <mfwitten@gmail.com>2011-08-25 17:11:30 -0400
committerMichael Witten <mfwitten@gmail.com>2011-08-29 16:00:18 -0400
commit51b9500de28a1e5e7a2090de5d345d6d98581617 (patch)
treeed0effbf00934f4790c2fec7d54d69d433dd3cf4 /Documentation
parent65ffef508f23d5e67940cadc8eca2ae34738018a (diff)
DocBook/drm: Use a <variablelist> for vblank ioctls
Signed-off-by: Michael Witten <mfwitten@gmail.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/drm.tmpl39
1 files changed, 25 insertions, 14 deletions
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
index da011f2af9cb..457d56a1a966 100644
--- a/Documentation/DocBook/drm.tmpl
+++ b/Documentation/DocBook/drm.tmpl
@@ -619,23 +619,34 @@ void intel_crt_init(struct drm_device *dev)
619 <title>VBlank event handling</title> 619 <title>VBlank event handling</title>
620 <para> 620 <para>
621 The DRM core exposes two vertical blank related ioctls: 621 The DRM core exposes two vertical blank related ioctls:
622 DRM_IOCTL_WAIT_VBLANK and DRM_IOCTL_MODESET_CTL. 622 <variablelist>
623 <varlistentry>
624 <term>DRM_IOCTL_WAIT_VBLANK</term>
625 <listitem>
626 <para>
627 This takes a struct drm_wait_vblank structure as its argument,
628 and it is used to block or request a signal when a specified
629 vblank event occurs.
630 </para>
631 </listitem>
632 </varlistentry>
633 <varlistentry>
634 <term>DRM_IOCTL_MODESET_CTL</term>
635 <listitem>
636 <para>
637 This should be called by application level drivers before and
638 after mode setting, since on many devices the vertical blank
639 counter is reset at that time. Internally, the DRM snapshots
640 the last vblank count when the ioctl is called with the
641 _DRM_PRE_MODESET command so that the counter won't go backwards
642 (which is dealt with when _DRM_POST_MODESET is used).
643 </para>
644 </listitem>
645 </varlistentry>
646 </variablelist>
623<!--!Edrivers/char/drm/drm_irq.c--> 647<!--!Edrivers/char/drm/drm_irq.c-->
624 </para> 648 </para>
625 <para> 649 <para>
626 DRM_IOCTL_WAIT_VBLANK takes a struct drm_wait_vblank structure
627 as its argument, and is used to block or request a signal when a
628 specified vblank event occurs.
629 </para>
630 <para>
631 DRM_IOCTL_MODESET_CTL should be called by application level
632 drivers before and after mode setting, since on many devices, the
633 vertical blank counter is reset at that time. Internally,
634 the DRM snapshots the last vblank count when the ioctl is called
635 with the _DRM_PRE_MODESET command so that the counter won't go
636 backwards (which is dealt with when _DRM_POST_MODESET is used).
637 </para>
638 <para>
639 To support the functions above, the DRM core provides several 650 To support the functions above, the DRM core provides several
640 helper functions for tracking vertical blank counters, and 651 helper functions for tracking vertical blank counters, and
641 requires drivers to provide several callbacks: 652 requires drivers to provide several callbacks: