0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.fe
0003
0004 .. _FE_READ_STATUS:
0005
0006 ********************
0007 ioctl FE_READ_STATUS
0008 ********************
0009
0010 Name
0011 ====
0012
0013 FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device
0014
0015 Synopsis
0016 ========
0017
0018 .. c:macro:: FE_READ_STATUS
0019
0020 ``int ioctl(int fd, FE_READ_STATUS, unsigned int *status)``
0021
0022 Arguments
0023 =========
0024
0025 ``fd``
0026 File descriptor returned by :c:func:`open()`.
0027
0028 ``status``
0029 pointer to a bitmask integer filled with the values defined by enum
0030 :c:type:`fe_status`.
0031
0032 Description
0033 ===========
0034
0035 All Digital TV frontend devices support the ``FE_READ_STATUS`` ioctl. It is
0036 used to check about the locking status of the frontend after being
0037 tuned. The ioctl takes a pointer to an integer where the status will be
0038 written.
0039
0040 .. note::
0041
0042 The size of status is actually sizeof(enum fe_status), with
0043 varies according with the architecture. This needs to be fixed in the
0044 future.
0045
0046 int fe_status
0047 =============
0048
0049 The fe_status parameter is used to indicate the current state and/or
0050 state changes of the frontend hardware. It is produced using the enum
0051 :c:type:`fe_status` values on a bitmask
0052
0053 Return Value
0054 ============
0055
0056 On success 0 is returned.
0057
0058 On error -1 is returned, and the ``errno`` variable is set
0059 appropriately.
0060
0061 Generic error codes are described at the
0062 :ref:`Generic Error Codes <gen-errors>` chapter.
