xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/dvb/fe-set-frontend.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: DTV.fe
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _FE_SET_FRONTEND:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun***************
7*4882a593SmuzhiyunFE_SET_FRONTEND
8*4882a593Smuzhiyun***************
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun.. attention:: This ioctl is deprecated.
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunName
13*4882a593Smuzhiyun====
14*4882a593Smuzhiyun
15*4882a593SmuzhiyunFE_SET_FRONTEND
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunSynopsis
18*4882a593Smuzhiyun========
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun.. c:macro:: FE_SET_FRONTEND
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun``int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p)``
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunArguments
25*4882a593Smuzhiyun=========
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun``fd``
28*4882a593Smuzhiyun    File descriptor returned by :c:func:`open()`.
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun``p``
31*4882a593Smuzhiyun    Points to parameters for tuning operation.
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunDescription
34*4882a593Smuzhiyun===========
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunThis ioctl call starts a tuning operation using specified parameters.
37*4882a593SmuzhiyunThe result of this call will be successful if the parameters were valid
38*4882a593Smuzhiyunand the tuning could be initiated. The result of the tuning operation in
39*4882a593Smuzhiyunitself, however, will arrive asynchronously as an event (see
40*4882a593Smuzhiyundocumentation for :ref:`FE_GET_EVENT` and
41*4882a593SmuzhiyunFrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
42*4882a593Smuzhiyunoperation is initiated before the previous one was completed, the
43*4882a593Smuzhiyunprevious operation will be aborted in favor of the new one. This command
44*4882a593Smuzhiyunrequires read/write access to the device.
45*4882a593Smuzhiyun
46*4882a593SmuzhiyunReturn Value
47*4882a593Smuzhiyun============
48*4882a593Smuzhiyun
49*4882a593SmuzhiyunOn success 0 is returned.
50*4882a593Smuzhiyun
51*4882a593SmuzhiyunOn error -1 is returned, and the ``errno`` variable is set
52*4882a593Smuzhiyunappropriately.
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun.. flat-table::
57*4882a593Smuzhiyun    :header-rows:  0
58*4882a593Smuzhiyun    :stub-columns: 0
59*4882a593Smuzhiyun    :widths: 1 16
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun    -  .. row 1
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun       -  ``EINVAL``
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun       -  Maximum supported symbol rate reached.
66*4882a593Smuzhiyun
67*4882a593SmuzhiyunGeneric error codes are described at the
68*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
69