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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _FE_GET_FRONTEND:
  11
  12 ***************
  13 FE_GET_FRONTEND
  14 ***************
  15
  16 Name
  17 ====
  18
  19 FE_GET_FRONTEND
  20
  21 .. attention:: This ioctl is deprecated.
  22
  23
  24 Synopsis
  25 ========
  26
  27 .. c:function:: int ioctl(int fd, FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
  28     :name: FE_GET_FRONTEND
  29
  30
  31 Arguments
  32 =========
  33
  34 ``fd``
  35     File descriptor returned by :c:func:`open() <dvb-fe-open>`.
  36
  37
  38 ``p``
  39     Points to parameters for tuning operation.
  40
  41
  42 Description
  43 ===========
  44
  45 This ioctl call queries the currently effective frontend parameters. For
  46 this command, read-only access to the device is sufficient.
  47
  48
  49 Return Value
  50 ============
  51
  52 On success 0 is returned.
  53
  54 On error -1 is returned, and the ``errno`` variable is set
  55 appropriately.
  56
  57 .. flat-table::
  58     :header-rows:  0
  59     :stub-columns: 0
  60
  61
  62     -  .. row 1
  63
  64        -  ``EINVAL``
  65
  66        -  Maximum supported symbol rate reached.
  67
  68 Generic error codes are described at the
  69 :ref:`Generic Error Codes <gen-errors>` chapter.