Merge remote-tracking branches 'asoc/topic/ux500' and 'asoc/topic/wm8962' into asoc...
[deliverable/linux.git] / Documentation / media / uapi / 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
15e7d615 9Name
586027ce 10====
5377d91f 11
586027ce 12FE_SET_FRONTEND
5377d91f 13
15e7d615
MCC
14
15Synopsis
586027ce 16========
5377d91f 17
5929cb17 18.. cpp:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
5377d91f 19
5377d91f 20
15e7d615 21Arguments
586027ce 22=========
5377d91f
MH
23
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
7347081e 39 - Equals :ref:`FE_SET_FRONTEND` for this
0579e6e3 40 command.
5377d91f
MH
41
42 - .. row 3
43
d38395ab 44 - struct dvb_frontend_parameters \*p
5377d91f
MH
45
46 - Points to parameters for tuning operation.
47
48
15e7d615 49Description
586027ce
MCC
50===========
51
52This ioctl call starts a tuning operation using specified parameters.
53The result of this call will be successful if the parameters were valid
54and the tuning could be initiated. The result of the tuning operation in
55itself, however, will arrive asynchronously as an event (see
56documentation for :ref:`FE_GET_EVENT` and
57FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
58operation is initiated before the previous one was completed, the
59previous operation will be aborted in favor of the new one. This command
60requires read/write access to the device.
61
62
15e7d615 63Return Value
586027ce 64============
5377d91f
MH
65
66On success 0 is returned, on error -1 and the ``errno`` variable is set
67appropriately. The generic error codes are described at the
68:ref:`Generic Error Codes <gen-errors>` chapter.
69
5377d91f
MH
70.. flat-table::
71 :header-rows: 0
72 :stub-columns: 0
73
74
75 - .. row 1
76
cdb4af0f 77 - ``EINVAL``
5377d91f
MH
78
79 - Maximum supported symbol rate reached.
This page took 0.048092 seconds and 5 git commands to generate.