[media] fix broken references on dvb/video*rst

Trivially fix those broken references, by copying the structs fron the header, just like other API documentation at the DVB side. This doesn't have the level of quality used at the V4L2 side of the API, but, as this documents a deprecated API, used only by av7110 driver, it doesn't make much sense to invest time making it better.

Mauro Carvalho Chehab committed 10 years ago

Commit 848d1031 parent 189d72413 files · +159 −6Browse files

Unified · Split

13 files

Documentation/media/uapi/dvb/video-command.rst +30 −0
Documentation/media/uapi/dvb/video-get-event.rst +17 −0
Documentation/media/uapi/dvb/video-get-navi.rst +9 −1
Documentation/media/uapi/dvb/video-get-size.rst +10 −0
Documentation/media/uapi/dvb/video-get-status.rst +11 −0
Documentation/media/uapi/dvb/video-select-source.rst +10 −0
Documentation/media/uapi/dvb/video-set-attributes.rst +16 −0
Documentation/media/uapi/dvb/video-set-display-format.rst +1 −1
Documentation/media/uapi/dvb/video-set-format.rst +9 −0
Documentation/media/uapi/dvb/video-set-highlight.rst +25 −1
Documentation/media/uapi/dvb/video-set-spu-palette.rst +9 −1
Documentation/media/uapi/dvb/video-set-spu.rst +10 −1
include/uapi/linux/dvb/video.h +2 −1

Documentation/media/uapi/dvb/video-command.rst+30−0

@@ -59,6 +59,36 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the · 58 unmodified lines
59	59	:ref:`VIDIOC_DECODER_CMD` documentation for
60	60	more information.
61	61
	62	+.. c:type:: struct video_command
	63	+
	64	+.. code-block:: c
	65	+
	66	+ /* The structure must be zeroed before use by the application
	67	+ This ensures it can be extended safely in the future. */
	68	+ struct video_command {
	69	+ __u32 cmd;
	70	+ __u32 flags;
	71	+ union {
	72	+ struct {
	73	+ __u64 pts;
	74	+ } stop;
	75	+
	76	+ struct {
	77	+ /* 0 or 1000 specifies normal speed,
	78	+ 1 specifies forward single stepping,
	79	+ -1 specifies backward single stepping,
	80	+ >1: playback at speed/1000 of the normal speed,
	81	+ <-1: reverse playback at (-speed/1000) of the normal speed. */
	82	+ __s32 speed;
	83	+ __u32 format;
	84	+ } play;
	85	+
	86	+ struct {
	87	+ __u32 data[16];
	88	+ } raw;
	89	+ };
	90	+ };
	91	+
62	92
63	93	Return Value
64	94	------------

Documentation/media/uapi/dvb/video-get-event.rst+17−0

@@ -64,6 +64,23 @@ included in the exceptfds argument, and for poll(), POLLPRI should be · 63 unmodified lines
64	64	specified as the wake-up condition. Read-only permissions are sufficient
65	65	for this ioctl call.
66	66
	67	+.. c:type:: video_event
	68	+
	69	+.. code-block:: c
	70	+
	71	+ struct video_event {
	72	+ __s32 type;
	73	+ #define VIDEO_EVENT_SIZE_CHANGED 1
	74	+ #define VIDEO_EVENT_FRAME_RATE_CHANGED 2
	75	+ #define VIDEO_EVENT_DECODER_STOPPED 3
	76	+ #define VIDEO_EVENT_VSYNC 4
	77	+ __kernel_time_t timestamp;
	78	+ union {
	79	+ video_size_t size;
	80	+ unsigned int frame_rate; /* in frames per 1000sec */
	81	+ unsigned char vsync_field; /* unknown/odd/even/progressive */
	82	+ } u;
	83	+ };
67	84
68	85	Return Value
69	86	------------

Documentation/media/uapi/dvb/video-get-navi.rst+9−1

@@ -16,7 +16,7 @@ VIDEO_GET_NAVI · 15 unmodified lines
16	16	Synopsis
17	17	--------
18	18
19		−.. c:function:: int ioctl(fd, VIDEO_GET_NAVI , video_navi_pack_t *navipack)
	19	+.. c:function:: int ioctl(fd, VIDEO_GET_NAVI , struct video_navi_pack *navipack)
20	20	:name: VIDEO_GET_NAVI
21	21
22	22
@@ -54,6 +54,14 @@ This ioctl returns navigational information from the DVD stream. This is · 31 unmodified lines
54	54	especially needed if an encoded stream has to be decoded by the
55	55	hardware.
56	56
	57	+.. c:type:: video_navi_pack
	58	+
	59	+.. code-block::c
	60	+
	61	+ typedef struct video_navi_pack {
	62	+ int length; /* 0 ... 1024 */
	63	+ __u8 data[1024];
	64	+ } video_navi_pack_t;
57	65
58	66	Return Value
59	67	------------

Documentation/media/uapi/dvb/video-get-size.rst+10−0

@@ -52,6 +52,16 @@ Description · 51 unmodified lines
52	52
53	53	This ioctl returns the size and aspect ratio.
54	54
	55	+.. c:type:: video_size_t
	56	+
	57	+.. code-block::c
	58	+
	59	+ typedef struct {
	60	+ int w;
	61	+ int h;
	62	+ video_format_t aspect_ratio;
	63	+ } video_size_t;
	64	+
55	65
56	66	Return Value
57	67	------------

Documentation/media/uapi/dvb/video-get-status.rst+11−0

@@ -53,6 +53,17 @@ Description · 52 unmodified lines
53	53	This ioctl call asks the Video Device to return the current status of
54	54	the device.
55	55
	56	+.. c:type:: video_status
	57	+
	58	+.. code-block:: c
	59	+
	60	+ struct video_status {
	61	+ int video_blank; /* blank video on freeze? */
	62	+ video_play_state_t play_state; /* current state of playback */
	63	+ video_stream_source_t stream_source; /* current source (demux/memory) */
	64	+ video_format_t video_format; /* current aspect ratio of stream*/
	65	+ video_displayformat_t display_format;/* selected cropping mode */
	66	+ };
56	67
57	68	Return Value
58	69	------------

Documentation/media/uapi/dvb/video-select-source.rst+10−0

@@ -58,6 +58,16 @@ This ioctl call informs the video device which source shall be used for · 57 unmodified lines
58	58	the input data. The possible sources are demux or memory. If memory is
59	59	selected, the data is fed to the video device through the write command.
60	60
	61	+.. c:type:: video_stream_source_t
	62	+
	63	+.. code-block:: c
	64	+
	65	+ typedef enum {
	66	+ VIDEO_SOURCE_DEMUX, /* Select the demux as the main source */
	67	+ VIDEO_SOURCE_MEMORY /* If this source is selected, the stream
	68	+ comes from the user through the write
	69	+ system call */
	70	+ } video_stream_source_t;
61	71
62	72	Return Value
63	73	------------

Documentation/media/uapi/dvb/video-set-attributes.rst+16−0

@@ -55,6 +55,22 @@ information about the stream. Some hardware may not need this · 54 unmodified lines
55	55	information, but the call also tells the hardware to prepare for DVD
56	56	playback.
57	57
	58	+.. c:type:: video_attributes_t
	59	+
	60	+.. code-block::c
	61	+
	62	+ typedef __u16 video_attributes_t;
	63	+ /* bits: descr. */
	64	+ /* 15-14 Video compression mode (0=MPEG-1, 1=MPEG-2) */
	65	+ /* 13-12 TV system (0=525/60, 1=625/50) */
	66	+ /* 11-10 Aspect ratio (0=4:3, 3=16:9) */
	67	+ /* 9- 8 permitted display mode on 4:3 monitor (0=both, 1=only pan-sca */
	68	+ /* 7 line 21-1 data present in GOP (1=yes, 0=no) */
	69	+ /* 6 line 21-2 data present in GOP (1=yes, 0=no) */
	70	+ /* 5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
	71	+ /* 2 source letterboxed (1=yes, 0=no) */
	72	+ /* 0 film/camera mode (0=camera, 1=film (625/50 only)) */
	73	+
58	74
59	75	Return Value
60	76	------------

Documentation/media/uapi/dvb/video-set-display-format.rst+1−1

@@ -16,7 +16,7 @@ VIDEO_SET_DISPLAY_FORMAT · 15 unmodified lines
16	16	Synopsis
17	17	--------
18	18
19		−.. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
	19	+.. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT)
20	20	:name: VIDEO_SET_DISPLAY_FORMAT
21	21
22	22

Documentation/media/uapi/dvb/video-set-format.rst+9−0

@@ -54,6 +54,15 @@ This ioctl sets the screen format (aspect ratio) of the connected output · 53 unmodified lines
54	54	device (TV) so that the output of the decoder can be adjusted
55	55	accordingly.
56	56
	57	+.. c:type:: video_format_t
	58	+
	59	+.. code-block:: c
	60	+
	61	+ typedef enum {
	62	+ VIDEO_FORMAT_4_3, /* Select 4:3 format */
	63	+ VIDEO_FORMAT_16_9, /* Select 16:9 format. */
	64	+ VIDEO_FORMAT_221_1 /* 2.21:1 */
	65	+ } video_format_t;
57	66
58	67	Return Value
59	68	------------

Documentation/media/uapi/dvb/video-set-highlight.rst+25−1

@@ -16,7 +16,7 @@ VIDEO_SET_HIGHLIGHT · 15 unmodified lines
16	16	Synopsis
17	17	--------
18	18
19		−.. c:function:: int ioctl(fd, VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
	19	+.. c:function:: int ioctl(fd, VIDEO_SET_HIGHLIGHT, struct video_highlight *vhilite)
20	20	:name: VIDEO_SET_HIGHLIGHT
21	21
22	22
@@ -53,6 +53,30 @@ Description · 30 unmodified lines
53	53	This ioctl sets the SPU highlight information for the menu access of a
54	54	DVD.
55	55
	56	+.. c:type:: video_highlight
	57	+
	58	+.. code-block:: c
	59	+
	60	+ typedef
	61	+ struct video_highlight {
	62	+ int active; /* 1=show highlight, 0=hide highlight */
	63	+ __u8 contrast1; /* 7- 4 Pattern pixel contrast */
	64	+ /* 3- 0 Background pixel contrast */
	65	+ __u8 contrast2; /* 7- 4 Emphasis pixel-2 contrast */
	66	+ /* 3- 0 Emphasis pixel-1 contrast */
	67	+ __u8 color1; /* 7- 4 Pattern pixel color */
	68	+ /* 3- 0 Background pixel color */
	69	+ __u8 color2; /* 7- 4 Emphasis pixel-2 color */
	70	+ /* 3- 0 Emphasis pixel-1 color */
	71	+ __u32 ypos; /* 23-22 auto action mode */
	72	+ /* 21-12 start y */
	73	+ /* 9- 0 end y */
	74	+ __u32 xpos; /* 23-22 button color number */
	75	+ /* 21-12 start x */
	76	+ /* 9- 0 end x */
	77	+ } video_highlight_t;
	78	+
	79	+
56	80
57	81	Return Value
58	82	------------

Documentation/media/uapi/dvb/video-set-spu-palette.rst+9−1

@@ -16,7 +16,7 @@ VIDEO_SET_SPU_PALETTE · 15 unmodified lines
16	16	Synopsis
17	17	--------
18	18
19		−.. c:function:: int ioctl(fd, VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
	19	+.. c:function:: int ioctl(fd, VIDEO_SET_SPU_PALETTE, struct video_spu_palette *palette )
20	20	:name: VIDEO_SET_SPU_PALETTE
21	21
22	22
@@ -52,6 +52,14 @@ Description · 29 unmodified lines
52	52
53	53	This ioctl sets the SPU color palette.
54	54
	55	+.. c:type:: video_spu_palette
	56	+
	57	+.. code-block::c
	58	+
	59	+ typedef struct video_spu_palette { /* SPU Palette information */
	60	+ int length;
	61	+ __u8 __user *palette;
	62	+ } video_spu_palette_t;
55	63
56	64	Return Value
57	65	------------

Documentation/media/uapi/dvb/video-set-spu.rst+10−1

@@ -16,7 +16,7 @@ VIDEO_SET_SPU · 15 unmodified lines
16	16	Synopsis
17	17	--------
18	18
19		−.. c:function:: int ioctl(fd, VIDEO_SET_SPU , video_spu_t *spu)
	19	+.. c:function:: int ioctl(fd, VIDEO_SET_SPU , struct video_spu *spu)
20	20	:name: VIDEO_SET_SPU
21	21
22	22
@@ -54,6 +54,15 @@ Description · 31 unmodified lines
54	54	This ioctl activates or deactivates SPU decoding in a DVD input stream.
55	55	It can only be used, if the driver is able to handle a DVD stream.
56	56
	57	+.. c:type:: struct video_spu
	58	+
	59	+.. code-block:: c
	60	+
	61	+ typedef struct video_spu {
	62	+ int active;
	63	+ int stream_id;
	64	+ } video_spu_t;
	65	+
57	66
58	67	Return Value
59	68	------------

include/uapi/linux/dvb/video.h+2−1

@@ -206,7 +206,8 @@ typedef __u16 video_attributes_t; · 205 unmodified lines
206	206	/* 6 line 21-2 data present in GOP (1=yes, 0=no) */
207	207	/* 5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
208	208	/* 2 source letterboxed (1=yes, 0=no) */
209		−/* 0 film/camera mode (0=camera, 1=film (625/50 only)) */
	209	+/* 0 film/camera mode (0=
	210	+ camera, 1=film (625/50 only)) /
210	211
211	212
212	213	/* bit definitions for capabilities: */