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