Merge remote-tracking branch 'omap_dss2/for-next'

[deliverable/linux.git] / Documentation / media / uapi / dvb / video-set-highlight.rst

diff --git a/Documentation/media/uapi/dvb/video-set-highlight.rst b/Documentation/media/uapi/dvb/video-set-highlight.rst
index 6ff11af713550697319fa04b05e016b63654a261..90aeafd923b71fd4de4590ffc2f341123c91e34e 100644 (file)
--- a/Documentation/media/uapi/dvb/video-set-highlight.rst
+++ b/Documentation/media/uapi/dvb/video-set-highlight.rst
@@ -11,11 +11,13 @@ Name
 
 VIDEO_SET_HIGHLIGHT
 
+.. attention:: This ioctl is deprecated.
 
 Synopsis
 --------
 
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
+.. c:function:: int ioctl(fd, VIDEO_SET_HIGHLIGHT, struct video_highlight *vhilite)
+    :name: VIDEO_SET_HIGHLIGHT
 
 
 Arguments
@@ -51,6 +53,30 @@ Description
 This ioctl sets the SPU highlight information for the menu access of a
 DVD.
 
+.. c:type:: video_highlight
+
+.. code-block:: c
+
+       typedef
+       struct video_highlight {
+               int     active;      /*    1=show highlight, 0=hide highlight */
+               __u8    contrast1;   /*    7- 4  Pattern pixel contrast */
+                               /*    3- 0  Background pixel contrast */
+               __u8    contrast2;   /*    7- 4  Emphasis pixel-2 contrast */
+                               /*    3- 0  Emphasis pixel-1 contrast */
+               __u8    color1;      /*    7- 4  Pattern pixel color */
+                               /*    3- 0  Background pixel color */
+               __u8    color2;      /*    7- 4  Emphasis pixel-2 color */
+                               /*    3- 0  Emphasis pixel-1 color */
+               __u32    ypos;       /*   23-22  auto action mode */
+                               /*   21-12  start y */
+                               /*    9- 0  end y */
+               __u32    xpos;       /*   23-22  button color number */
+                               /*   21-12  start x */
+                               /*    9- 0  end x */
+       } video_highlight_t;
+
+
 
 Return Value
 ------------