0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.fe
0003
0004 .. _FE_SET_FRONTEND:
0005
0006 ***************
0007 FE_SET_FRONTEND
0008 ***************
0009
0010 .. attention:: This ioctl is deprecated.
0011
0012 Name
0013 ====
0014
0015 FE_SET_FRONTEND
0016
0017 Synopsis
0018 ========
0019
0020 .. c:macro:: FE_SET_FRONTEND
0021
0022 ``int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p)``
0023
0024 Arguments
0025 =========
0026
0027 ``fd``
0028 File descriptor returned by :c:func:`open()`.
0029
0030 ``p``
0031 Points to parameters for tuning operation.
0032
0033 Description
0034 ===========
0035
0036 This ioctl call starts a tuning operation using specified parameters.
0037 The result of this call will be successful if the parameters were valid
0038 and the tuning could be initiated. The result of the tuning operation in
0039 itself, however, will arrive asynchronously as an event (see
0040 documentation for :ref:`FE_GET_EVENT` and
0041 FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
0042 operation is initiated before the previous one was completed, the
0043 previous operation will be aborted in favor of the new one. This command
0044 requires read/write access to the device.
0045
0046 Return Value
0047 ============
0048
0049 On success 0 is returned.
0050
0051 On error -1 is returned, and the ``errno`` variable is set
0052 appropriately.
0053
0054 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
0055
0056 .. flat-table::
0057 :header-rows: 0
0058 :stub-columns: 0
0059 :widths: 1 16
0060
0061 - .. row 1
0062
0063 - ``EINVAL``
0064
0065 - Maximum supported symbol rate reached.
0066
0067 Generic error codes are described at the
0068 :ref:`Generic Error Codes <gen-errors>` chapter.