Documentation/media/uapi/dvb/fe-set-frontend.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _FE_SET_FRONTEND:
  11
  12 ***************
  13 FE_SET_FRONTEND
  14 ***************
  15
  16 .. attention:: This ioctl is deprecated.
  17
  18 Name
  19 ====
  20
  21 FE_SET_FRONTEND
  22
  23
  24 Synopsis
  25 ========
  26
  27 .. c:function:: int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
  28     :name: FE_SET_FRONTEND
  29
  30
  31 Arguments
  32 =========
  33
  34 ``fd``
  35     File descriptor returned by :c:func:`open() <dvb-fe-open>`.
  36
  37 ``p``
  38     Points to parameters for tuning operation.
  39
  40
  41 Description
  42 ===========
  43
  44 This ioctl call starts a tuning operation using specified parameters.
  45 The result of this call will be successful if the parameters were valid
  46 and the tuning could be initiated. The result of the tuning operation in
  47 itself, however, will arrive asynchronously as an event (see
  48 documentation for :ref:`FE_GET_EVENT` and
  49 FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
  50 operation is initiated before the previous one was completed, the
  51 previous operation will be aborted in favor of the new one. This command
  52 requires read/write access to the device.
  53
  54
  55 Return Value
  56 ============
  57
  58 On success 0 is returned.
  59
  60 On error -1 is returned, and the ``errno`` variable is set
  61 appropriately.
  62
  63 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  64
  65 .. flat-table::
  66     :header-rows:  0
  67     :stub-columns: 0
  68     :widths: 1 16
  69
  70     -  .. row 1
  71
  72        -  ``EINVAL``
  73
  74        -  Maximum supported symbol rate reached.
  75
  76
  77 Generic error codes are described at the
  78 :ref:`Generic Error Codes <gen-errors>` chapter.