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

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.fe
   3
   4 .. _FE_GET_INFO:
   5
   6 *****************
   7 ioctl FE_GET_INFO
   8 *****************
   9
  10 Name
  11 ====
  12
  13 FE_GET_INFO - Query Digital TV frontend capabilities and returns information
  14 about the - front-end. This call only requires read-only access to the device.
  15
  16 Synopsis
  17 ========
  18
  19 .. c:macro:: FE_GET_INFO
  20
  21 ``int ioctl(int fd, FE_GET_INFO, struct dvb_frontend_info *argp)``
  22
  23 Arguments
  24 =========
  25
  26 ``fd``
  27     File descriptor returned by :c:func:`open()`.
  28
  29 ``argp``
  30     pointer to struct :c:type:`dvb_frontend_info`
  31
  32 Description
  33 ===========
  34
  35 All Digital TV frontend devices support the :ref:`FE_GET_INFO` ioctl. It is
  36 used to identify kernel devices compatible with this specification and to
  37 obtain information about driver and hardware capabilities. The ioctl
  38 takes a pointer to dvb_frontend_info which is filled by the driver.
  39 When the driver is not compatible with this specification the ioctl
  40 returns an error.
  41
  42 frontend capabilities
  43 =====================
  44
  45 Capabilities describe what a frontend can do. Some capabilities are
  46 supported only on some specific frontend types.
  47
  48 The frontend capabilities are described at :c:type:`fe_caps`.
  49
  50 Return Value
  51 ============
  52
  53 On success 0 is returned.
  54
  55 On error -1 is returned, and the ``errno`` variable is set
  56 appropriately.
  57
  58 Generic error codes are described at the
  59 :ref:`Generic Error Codes <gen-errors>` chapter.