Merge remote-tracking branch 'selinux/next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-get-navi.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_GET_NAVI:
4
586027ce 5==============
47d23e36
MCC
6VIDEO_GET_NAVI
7==============
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_GET_NAVI
47d23e36 13
cf8076c3 14.. attention:: This ioctl is deprecated.
15e7d615
MCC
15
16Synopsis
47d23e36
MCC
17--------
18
848d1031 19.. c:function:: int ioctl(fd, VIDEO_GET_NAVI , struct video_navi_pack *navipack)
cf8076c3 20 :name: VIDEO_GET_NAVI
47d23e36 21
47d23e36 22
15e7d615 23Arguments
586027ce 24---------
47d23e36
MCC
25
26.. flat-table::
27 :header-rows: 0
28 :stub-columns: 0
29
30
31 - .. row 1
32
33 - int fd
34
35 - File descriptor returned by a previous call to open().
36
37 - .. row 2
38
39 - int request
40
41 - Equals VIDEO_GET_NAVI for this command.
42
43 - .. row 3
44
45 - video_navi_pack_t \*navipack
46
47 - PCI or DSI pack (private stream 2) according to section ??.
48
49
15e7d615 50Description
586027ce
MCC
51-----------
52
53This ioctl returns navigational information from the DVD stream. This is
54especially needed if an encoded stream has to be decoded by the
55hardware.
56
848d1031
MCC
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;
586027ce 65
15e7d615 66Return Value
47d23e36
MCC
67------------
68
69On success 0 is returned, on error -1 and the ``errno`` variable is set
70appropriately. The generic error codes are described at the
71:ref:`Generic Error Codes <gen-errors>` chapter.
72
73
74
75.. flat-table::
76 :header-rows: 0
77 :stub-columns: 0
78
79
80 - .. row 1
81
82 - ``EFAULT``
83
84 - driver is not able to return navigational information
This page took 0.046239 seconds and 5 git commands to generate.