1.. Permission is granted to copy, distribute and/or modify this 2.. document under the terms of the GNU Free Documentation License, 3.. Version 1.1 or any later version published by the Free Software 4.. Foundation, with no Invariant Sections, no Front-Cover Texts 5.. and no Back-Cover Texts. A copy of the license is included at 6.. Documentation/userspace-api/media/fdl-appendix.rst. 7.. 8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections 9 10.. _FE_READ_STATUS: 11 12******************** 13ioctl FE_READ_STATUS 14******************** 15 16Name 17==== 18 19FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device 20 21 22Synopsis 23======== 24 25.. c:function:: int ioctl( int fd, FE_READ_STATUS, unsigned int *status ) 26 :name: FE_READ_STATUS 27 28 29Arguments 30========= 31 32``fd`` 33 File descriptor returned by :ref:`open() <frontend_f_open>`. 34 35``status`` 36 pointer to a bitmask integer filled with the values defined by enum 37 :c:type:`fe_status`. 38 39 40Description 41=========== 42 43All Digital TV frontend devices support the ``FE_READ_STATUS`` ioctl. It is 44used to check about the locking status of the frontend after being 45tuned. The ioctl takes a pointer to an integer where the status will be 46written. 47 48.. note:: 49 50 The size of status is actually sizeof(enum fe_status), with 51 varies according with the architecture. This needs to be fixed in the 52 future. 53 54 55int fe_status 56============= 57 58The fe_status parameter is used to indicate the current state and/or 59state changes of the frontend hardware. It is produced using the enum 60:c:type:`fe_status` values on a bitmask 61 62 63Return Value 64============ 65 66On success 0 is returned. 67 68On error -1 is returned, and the ``errno`` variable is set 69appropriately. 70 71Generic error codes are described at the 72:ref:`Generic Error Codes <gen-errors>` chapter. 73