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