Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[cascardo/linux.git] / Documentation / media / uapi / dvb / dmx-start.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _DMX_START:
4
5 =========
6 DMX_START
7 =========
8
9 Name
10 ----
11
12 DMX_START
13
14
15 Synopsis
16 --------
17
18 .. c:function:: int ioctl( int fd, DMX_START)
19     :name: DMX_START
20
21
22 Arguments
23 ---------
24
25 ``fd``
26     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
27
28 Description
29 -----------
30
31 This ioctl call is used to start the actual filtering operation defined
32 via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
33
34
35 Return Value
36 ------------
37
38 On success 0 is returned, on error -1 and the ``errno`` variable is set
39 appropriately. The generic error codes are described at the
40 :ref:`Generic Error Codes <gen-errors>` chapter.
41
42 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
43
44 .. flat-table::
45     :header-rows:  0
46     :stub-columns: 0
47
48
49     -  .. row 1
50
51        -  ``EINVAL``
52
53        -  Invalid argument, i.e. no filtering parameters provided via the
54           DMX_SET_FILTER or DMX_SET_PES_FILTER functions.
55
56     -  .. row 2
57
58        -  ``EBUSY``
59
60        -  This error code indicates that there are conflicting requests.
61           There are active filters filtering data from another input source.
62           Make sure that these filters are stopped before starting this
63           filter.