Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid

[cascardo/linux.git] / Documentation / media / uapi / dvb / video-command.rst

diff --git a/Documentation/media/uapi/dvb/video-command.rst b/Documentation/media/uapi/dvb/video-command.rst
index 42a98a4..536d0fd 100644 (file)
--- a/Documentation/media/uapi/dvb/video-command.rst
+++ b/Documentation/media/uapi/dvb/video-command.rst
@@ -11,11 +11,13 @@ Name
 
 VIDEO_COMMAND
 
+.. attention:: This ioctl is deprecated.
 
 Synopsis
 --------
 
-.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
+.. c:function:: int ioctl(int fd, VIDEO_COMMAND, struct video_command *cmd)
+    :name: VIDEO_COMMAND
 
 
 Arguments
@@ -57,6 +59,36 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the
 :ref:`VIDIOC_DECODER_CMD` documentation for
 more information.
 
+.. c:type:: struct video_command
+
+.. code-block:: c
+
+       /* The structure must be zeroed before use by the application
+       This ensures it can be extended safely in the future. */
+       struct video_command {
+               __u32 cmd;
+               __u32 flags;
+               union {
+                       struct {
+                               __u64 pts;
+                       } stop;
+
+                       struct {
+                               /* 0 or 1000 specifies normal speed,
+                               1 specifies forward single stepping,
+                               -1 specifies backward single stepping,
+                               >1: playback at speed/1000 of the normal speed,
+                               <-1: reverse playback at (-speed/1000) of the normal speed. */
+                               __s32 speed;
+                               __u32 format;
+                       } play;
+
+                       struct {
+                               __u32 data[16];
+                       } raw;
+               };
+       };
+
 
 Return Value
 ------------