doc-rst: linux_tv: simplify references
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / FE_SET_FRONTEND.rst
CommitLineData
5377d91f
MH
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _FE_SET_FRONTEND:
4
5***************
6FE_SET_FRONTEND
7***************
8
9DESCRIPTION
10
11This ioctl call starts a tuning operation using specified parameters.
12The result of this call will be successful if the parameters were valid
13and the tuning could be initiated. The result of the tuning operation in
14itself, however, will arrive asynchronously as an event (see
7347081e
MCC
15documentation for :ref:`FE_GET_EVENT` and
16FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
5377d91f
MH
17operation is initiated before the previous one was completed, the
18previous operation will be aborted in favor of the new one. This command
19requires read/write access to the device.
20
21SYNOPSIS
22
23int ioctl(int fd, int request =
7347081e 24:ref:`FE_SET_FRONTEND`, struct
5377d91f
MH
25dvb_frontend_parameters *p);
26
27PARAMETERS
28
29
30
31.. flat-table::
32 :header-rows: 0
33 :stub-columns: 0
34
35
36 - .. row 1
37
38 - int fd
39
40 - File descriptor returned by a previous call to open().
41
42 - .. row 2
43
44 - int request
45
7347081e 46 - Equals :ref:`FE_SET_FRONTEND` for this
5377d91f
MH
47 command.
48
49 - .. row 3
50
51 - struct dvb_frontend_parameters *p
52
53 - Points to parameters for tuning operation.
54
55
56RETURN VALUE
57
58On success 0 is returned, on error -1 and the ``errno`` variable is set
59appropriately. The generic error codes are described at the
60:ref:`Generic Error Codes <gen-errors>` chapter.
61
62
63
64.. flat-table::
65 :header-rows: 0
66 :stub-columns: 0
67
68
69 - .. row 1
70
71 - EINVAL
72
73 - Maximum supported symbol rate reached.
74
75
76
77
78.. ------------------------------------------------------------------------------
79.. This file was automatically converted from DocBook-XML with the dbxml
80.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
81.. from the linux kernel, refer to:
82..
83.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
84.. ------------------------------------------------------------------------------
This page took 0.031545 seconds and 5 git commands to generate.