blob: 6c3034fe5fa2b1102c71065f5dcd0b0a23289fd2 [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03001.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_GET_NAVI:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -03005==============
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03006VIDEO_GET_NAVI
7==============
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -03009Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030010----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030011
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030012VIDEO_GET_NAVI
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030013
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030014
15Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030016--------
17
Mauro Carvalho Chehab5929cb12016-07-05 15:22:59 -030018.. cpp:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030019
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030020
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030021Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030022---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030023
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
39 - Equals VIDEO_GET_NAVI for this command.
40
41 - .. row 3
42
43 - video_navi_pack_t \*navipack
44
45 - PCI or DSI pack (private stream 2) according to section ??.
46
47
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030048Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030049-----------
50
51This ioctl returns navigational information from the DVD stream. This is
52especially needed if an encoded stream has to be decoded by the
53hardware.
54
55
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030056Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030057------------
58
59On success 0 is returned, on error -1 and the ``errno`` variable is set
60appropriately. The generic error codes are described at the
61:ref:`Generic Error Codes <gen-errors>` chapter.
62
63
64
65.. flat-table::
66 :header-rows: 0
67 :stub-columns: 0
68
69
70 - .. row 1
71
72 - ``EFAULT``
73
74 - driver is not able to return navigational information