0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.fe
0003
0004 .. _FE_GET_INFO:
0005
0006 *****************
0007 ioctl FE_GET_INFO
0008 *****************
0009
0010 Name
0011 ====
0012
0013 FE_GET_INFO - Query Digital TV frontend capabilities and returns information
0014 about the - front-end. This call only requires read-only access to the device.
0015
0016 Synopsis
0017 ========
0018
0019 .. c:macro:: FE_GET_INFO
0020
0021 ``int ioctl(int fd, FE_GET_INFO, struct dvb_frontend_info *argp)``
0022
0023 Arguments
0024 =========
0025
0026 ``fd``
0027 File descriptor returned by :c:func:`open()`.
0028
0029 ``argp``
0030 pointer to struct :c:type:`dvb_frontend_info`
0031
0032 Description
0033 ===========
0034
0035 All Digital TV frontend devices support the :ref:`FE_GET_INFO` ioctl. It is
0036 used to identify kernel devices compatible with this specification and to
0037 obtain information about driver and hardware capabilities. The ioctl
0038 takes a pointer to dvb_frontend_info which is filled by the driver.
0039 When the driver is not compatible with this specification the ioctl
0040 returns an error.
0041
0042 frontend capabilities
0043 =====================
0044
0045 Capabilities describe what a frontend can do. Some capabilities are
0046 supported only on some specific frontend types.
0047
0048 The frontend capabilities are described at :c:type:`fe_caps`.
0049
0050 Return Value
0051 ============
0052
0053 On success 0 is returned.
0054
0055 On error -1 is returned, and the ``errno`` variable is set
0056 appropriately.
0057
0058 Generic error codes are described at the
0059 :ref:`Generic Error Codes <gen-errors>` chapter.