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

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