54f38fcae5
Since 2017, there is an space reserved for userspace API,
created by changeset 1d596dee38 ("docs: Create a user-space API guide").
As the media subsystem was one of the first subsystems to use
Sphinx, until this patch, we were keeping things on a separate
place.
Let's just use the new location, as having all uAPI altogether
will likely make things easier for developers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
79 lines
1.8 KiB
ReStructuredText
79 lines
1.8 KiB
ReStructuredText
.. Permission is granted to copy, distribute and/or modify this
|
|
.. document under the terms of the GNU Free Documentation License,
|
|
.. Version 1.1 or any later version published by the Free Software
|
|
.. Foundation, with no Invariant Sections, no Front-Cover Texts
|
|
.. and no Back-Cover Texts. A copy of the license is included at
|
|
.. Documentation/userspace-api/media/fdl-appendix.rst.
|
|
..
|
|
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
|
|
|
|
.. _FE_SET_FRONTEND:
|
|
|
|
***************
|
|
FE_SET_FRONTEND
|
|
***************
|
|
|
|
.. attention:: This ioctl is deprecated.
|
|
|
|
Name
|
|
====
|
|
|
|
FE_SET_FRONTEND
|
|
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. c:function:: int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
|
|
:name: FE_SET_FRONTEND
|
|
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``fd``
|
|
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
|
|
|
|
``p``
|
|
Points to parameters for tuning operation.
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
This ioctl call starts a tuning operation using specified parameters.
|
|
The result of this call will be successful if the parameters were valid
|
|
and the tuning could be initiated. The result of the tuning operation in
|
|
itself, however, will arrive asynchronously as an event (see
|
|
documentation for :ref:`FE_GET_EVENT` and
|
|
FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
|
|
operation is initiated before the previous one was completed, the
|
|
previous operation will be aborted in favor of the new one. This command
|
|
requires read/write access to the device.
|
|
|
|
|
|
Return Value
|
|
============
|
|
|
|
On success 0 is returned.
|
|
|
|
On error -1 is returned, and the ``errno`` variable is set
|
|
appropriately.
|
|
|
|
.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
|
|
|
|
.. flat-table::
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
:widths: 1 16
|
|
|
|
- .. row 1
|
|
|
|
- ``EINVAL``
|
|
|
|
- Maximum supported symbol rate reached.
|
|
|
|
|
|
Generic error codes are described at the
|
|
:ref:`Generic Error Codes <gen-errors>` chapter.
|