Merge tag 'random_for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tytso...
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / fe-set-frontend-tune-mode.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _FE_SET_FRONTEND_TUNE_MODE:
4
5 *******************************
6 ioctl FE_SET_FRONTEND_TUNE_MODE
7 *******************************
8
9 Name
10 ====
11
12 FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
13
14
15 Synopsis
16 ========
17
18 .. cpp:function:: int ioctl( int fd, int request, unsigned int flags )
19
20
21 Arguments
22 =========
23
24 ``fd``
25     File descriptor returned by :ref:`open() <frontend_f_open>`.
26
27 ``request``
28     FE_SET_FRONTEND_TUNE_MODE
29
30 ``flags``
31     Valid flags:
32
33     -  0 - normal tune mode
34
35     -  FE_TUNE_MODE_ONESHOT - When set, this flag will disable any
36        zigzagging or other "normal" tuning behaviour. Additionally,
37        there will be no automatic monitoring of the lock status, and
38        hence no frontend events will be generated. If a frontend device
39        is closed, this flag will be automatically turned off when the
40        device is reopened read-write.
41
42
43 Description
44 ===========
45
46 Allow setting tuner mode flags to the frontend, between 0 (normal) or
47 FE_TUNE_MODE_ONESHOT mode
48
49
50 Return Value
51 ============
52
53 On success 0 is returned, on error -1 and the ``errno`` variable is set
54 appropriately. The generic error codes are described at the
55 :ref:`Generic Error Codes <gen-errors>` chapter.