xref: /openbmc/linux/Documentation/userspace-api/media/dvb/dmx-stop.rst (revision 54f38fcae536ea202ce7d6a359521492fba30c1f)
1*54f38fcaSMauro Carvalho Chehab.. Permission is granted to copy, distribute and/or modify this
2*54f38fcaSMauro Carvalho Chehab.. document under the terms of the GNU Free Documentation License,
3*54f38fcaSMauro Carvalho Chehab.. Version 1.1 or any later version published by the Free Software
4*54f38fcaSMauro Carvalho Chehab.. Foundation, with no Invariant Sections, no Front-Cover Texts
5*54f38fcaSMauro Carvalho Chehab.. and no Back-Cover Texts. A copy of the license is included at
6*54f38fcaSMauro Carvalho Chehab.. Documentation/userspace-api/media/fdl-appendix.rst.
7*54f38fcaSMauro Carvalho Chehab..
8*54f38fcaSMauro Carvalho Chehab.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9*54f38fcaSMauro Carvalho Chehab
10*54f38fcaSMauro Carvalho Chehab.. _DMX_STOP:
11*54f38fcaSMauro Carvalho Chehab
12*54f38fcaSMauro Carvalho Chehab========
13*54f38fcaSMauro Carvalho ChehabDMX_STOP
14*54f38fcaSMauro Carvalho Chehab========
15*54f38fcaSMauro Carvalho Chehab
16*54f38fcaSMauro Carvalho ChehabName
17*54f38fcaSMauro Carvalho Chehab----
18*54f38fcaSMauro Carvalho Chehab
19*54f38fcaSMauro Carvalho ChehabDMX_STOP
20*54f38fcaSMauro Carvalho Chehab
21*54f38fcaSMauro Carvalho Chehab
22*54f38fcaSMauro Carvalho ChehabSynopsis
23*54f38fcaSMauro Carvalho Chehab--------
24*54f38fcaSMauro Carvalho Chehab
25*54f38fcaSMauro Carvalho Chehab.. c:function:: int ioctl( int fd, DMX_STOP)
26*54f38fcaSMauro Carvalho Chehab    :name: DMX_STOP
27*54f38fcaSMauro Carvalho Chehab
28*54f38fcaSMauro Carvalho Chehab
29*54f38fcaSMauro Carvalho ChehabArguments
30*54f38fcaSMauro Carvalho Chehab---------
31*54f38fcaSMauro Carvalho Chehab
32*54f38fcaSMauro Carvalho Chehab``fd``
33*54f38fcaSMauro Carvalho Chehab    File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
34*54f38fcaSMauro Carvalho Chehab
35*54f38fcaSMauro Carvalho ChehabDescription
36*54f38fcaSMauro Carvalho Chehab-----------
37*54f38fcaSMauro Carvalho Chehab
38*54f38fcaSMauro Carvalho ChehabThis ioctl call is used to stop the actual filtering operation defined
39*54f38fcaSMauro Carvalho Chehabvia the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` and
40*54f38fcaSMauro Carvalho Chehabstarted via the :ref:`DMX_START` command.
41*54f38fcaSMauro Carvalho Chehab
42*54f38fcaSMauro Carvalho Chehab
43*54f38fcaSMauro Carvalho ChehabReturn Value
44*54f38fcaSMauro Carvalho Chehab------------
45*54f38fcaSMauro Carvalho Chehab
46*54f38fcaSMauro Carvalho ChehabOn success 0 is returned.
47*54f38fcaSMauro Carvalho Chehab
48*54f38fcaSMauro Carvalho ChehabOn error -1 is returned, and the ``errno`` variable is set
49*54f38fcaSMauro Carvalho Chehabappropriately.
50*54f38fcaSMauro Carvalho Chehab
51*54f38fcaSMauro Carvalho ChehabThe generic error codes are described at the
52*54f38fcaSMauro Carvalho Chehab:ref:`Generic Error Codes <gen-errors>` chapter.
53