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