doc-rst: linux_tv DocBook to reST migration (docs-next)
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / fe-set-frontend-tune-mode.rst
CommitLineData
5377d91f
MH
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _FE_SET_FRONTEND_TUNE_MODE:
4
5*******************************
6ioctl FE_SET_FRONTEND_TUNE_MODE
7*******************************
8
9*man FE_SET_FRONTEND_TUNE_MODE(2)*
10
11Allow setting tuner mode flags to the frontend.
12
13
14Synopsis
15========
16
17.. c:function:: int ioctl( int fd, int request, unsigned int flags )
18
19Arguments
20=========
21
22``fd``
23 File descriptor returned by :ref:`open() <frontend_f_open>`.
24
25``request``
26 FE_SET_FRONTEND_TUNE_MODE
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
40
41Description
42===========
43
44Allow setting tuner mode flags to the frontend, between 0 (normal) or
45FE_TUNE_MODE_ONESHOT mode
46
47RETURN VALUE
48
49On success 0 is returned, on error -1 and the ``errno`` variable is set
50appropriately. The generic error codes are described at the
51:ref:`Generic Error Codes <gen-errors>` chapter.
52
53
54.. ------------------------------------------------------------------------------
55.. This file was automatically converted from DocBook-XML with the dbxml
56.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
57.. from the linux kernel, refer to:
58..
59.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
60.. ------------------------------------------------------------------------------
This page took 0.025272 seconds and 5 git commands to generate.