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