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

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