xref: /linux/Documentation/userspace-api/media/dvb/fe-set-frontend-tune-mode.rst (revision c532de5a67a70f8533d495f8f2aaa9a0491c3ad0)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: DTV.fe
3
4.. _FE_SET_FRONTEND_TUNE_MODE:
5
6*******************************
7ioctl FE_SET_FRONTEND_TUNE_MODE
8*******************************
9
10Name
11====
12
13FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
14
15Synopsis
16========
17
18.. c:macro:: FE_SET_FRONTEND_TUNE_MODE
19
20``int ioctl(int fd, FE_SET_FRONTEND_TUNE_MODE, unsigned int flags)``
21
22Arguments
23=========
24
25``fd``
26    File descriptor returned by :c:func:`open()`.
27
28``flags``
29    Valid flags:
30
31    -  0 - normal tune mode
32
33    -  ``FE_TUNE_MODE_ONESHOT`` - When set, this flag will disable any
34       zigzagging or other "normal" tuning behaviour. Additionally,
35       there will be no automatic monitoring of the lock status, and
36       hence no frontend events will be generated. If a frontend device
37       is closed, this flag will be automatically turned off when the
38       device is reopened read-write.
39
40Description
41===========
42
43Allow setting tuner mode flags to the frontend, between 0 (normal) or
44``FE_TUNE_MODE_ONESHOT`` mode
45
46Return Value
47============
48
49On success 0 is returned.
50
51On error -1 is returned, and the ``errno`` variable is set
52appropriately.
53
54Generic error codes are described at the
55:ref:`Generic Error Codes <gen-errors>` chapter.
56