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

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

diff --git a/Documentation/media/uapi/dvb/video-get-event.rst b/Documentation/media/uapi/dvb/video-get-event.rst
index a1484a2..6ad14cd 100644 (file)
--- a/Documentation/media/uapi/dvb/video-get-event.rst
+++ b/Documentation/media/uapi/dvb/video-get-event.rst
@@ -11,11 +11,13 @@ Name
 
 VIDEO_GET_EVENT
 
+.. attention:: This ioctl is deprecated.
 
 Synopsis
 --------
 
-.. cpp:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
+.. c:function:: int ioctl(fd, VIDEO_GET_EVENT, struct video_event *ev)
+    :name: VIDEO_GET_EVENT
 
 
 Arguments
@@ -62,6 +64,23 @@ included in the exceptfds argument, and for poll(), POLLPRI should be
 specified as the wake-up condition. Read-only permissions are sufficient
 for this ioctl call.
 
+.. c:type:: video_event
+
+.. code-block:: c
+
+       struct video_event {
+               __s32 type;
+       #define VIDEO_EVENT_SIZE_CHANGED        1
+       #define VIDEO_EVENT_FRAME_RATE_CHANGED  2
+       #define VIDEO_EVENT_DECODER_STOPPED     3
+       #define VIDEO_EVENT_VSYNC               4
+               __kernel_time_t timestamp;
+               union {
+                       video_size_t size;
+                       unsigned int frame_rate;        /* in frames per 1000sec */
+                       unsigned char vsync_field;      /* unknown/odd/even/progressive */
+               } u;
+       };
 
 Return Value
 ------------