Merge remote-tracking branch 'omap_dss2/for-next'
[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
cf8076c3
MCC
9.. attention:: This ioctl is deprecated.
10
15e7d615 11Name
586027ce 12====
5377d91f 13
586027ce 14FE_SET_FRONTEND
5377d91f 15
15e7d615
MCC
16
17Synopsis
586027ce 18========
5377d91f 19
cf8076c3
MCC
20.. c:function:: int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
21 :name: FE_SET_FRONTEND
5377d91f 22
5377d91f 23
15e7d615 24Arguments
586027ce 25=========
5377d91f 26
cf8076c3
MCC
27``fd``
28 File descriptor returned by :c:func:`open() <dvb-fe-open>`.
5377d91f 29
cf8076c3
MCC
30``p``
31 Points to parameters for tuning operation.
5377d91f
MH
32
33
15e7d615 34Description
586027ce
MCC
35===========
36
37This ioctl call starts a tuning operation using specified parameters.
38The result of this call will be successful if the parameters were valid
39and the tuning could be initiated. The result of the tuning operation in
40itself, however, will arrive asynchronously as an event (see
41documentation for :ref:`FE_GET_EVENT` and
42FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
43operation is initiated before the previous one was completed, the
44previous operation will be aborted in favor of the new one. This command
45requires read/write access to the device.
46
47
15e7d615 48Return Value
586027ce 49============
5377d91f
MH
50
51On success 0 is returned, on error -1 and the ``errno`` variable is set
52appropriately. The generic error codes are described at the
53:ref:`Generic Error Codes <gen-errors>` chapter.
54
5377d91f
MH
55.. flat-table::
56 :header-rows: 0
57 :stub-columns: 0
58
59
60 - .. row 1
61
cdb4af0f 62 - ``EINVAL``
5377d91f
MH
63
64 - Maximum supported symbol rate reached.
This page took 0.047534 seconds and 5 git commands to generate.