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