Documentation/userspace-api/media/dvb/fe-get-frontend.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.fe
   3
   4 .. _FE_GET_FRONTEND:
   5
   6 ***************
   7 FE_GET_FRONTEND
   8 ***************
   9
  10 Name
  11 ====
  12
  13 FE_GET_FRONTEND
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 ========
  19
  20 .. c:macro:: FE_GET_FRONTEND
  21
  22 ``int ioctl(int fd, FE_GET_FRONTEND, struct dvb_frontend_parameters *p)``
  23
  24 Arguments
  25 =========
  26
  27 ``fd``
  28     File descriptor returned by :c:func:`open()`.
  29
  30 ``p``
  31     Points to parameters for tuning operation.
  32
  33 Description
  34 ===========
  35
  36 This ioctl call queries the currently effective frontend parameters. For
  37 this command, read-only access to the device is sufficient.
  38
  39 Return Value
  40 ============
  41
  42 On success 0 is returned.
  43
  44 On error -1 is returned, and the ``errno`` variable is set
  45 appropriately.
  46
  47 .. flat-table::
  48     :header-rows:  0
  49     :stub-columns: 0
  50
  51     -  .. row 1
  52
  53        -  ``EINVAL``
  54
  55        -  Maximum supported symbol rate reached.
  56
  57 Generic error codes are described at the
  58 :ref:`Generic Error Codes <gen-errors>` chapter.