1 .. SPDX-License-Identifier: GFDL-1.1-no-invari !! 1 .. Permission is granted to copy, distribute and/or modify this
2 .. c:namespace:: DTV.fe !! 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
3 9
4 .. _FE_READ_STATUS: 10 .. _FE_READ_STATUS:
5 11
6 ******************** 12 ********************
7 ioctl FE_READ_STATUS 13 ioctl FE_READ_STATUS
8 ******************** 14 ********************
9 15
10 Name 16 Name
11 ==== 17 ====
12 18
13 FE_READ_STATUS - Returns status information ab 19 FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device
14 20
>> 21
15 Synopsis 22 Synopsis
16 ======== 23 ========
17 24
18 .. c:macro:: FE_READ_STATUS !! 25 .. c:function:: int ioctl( int fd, FE_READ_STATUS, unsigned int *status )
>> 26 :name: FE_READ_STATUS
19 27
20 ``int ioctl(int fd, FE_READ_STATUS, unsigned i <<
21 28
22 Arguments 29 Arguments
23 ========= 30 =========
24 31
25 ``fd`` 32 ``fd``
26 File descriptor returned by :c:func:`open( !! 33 File descriptor returned by :ref:`open() <frontend_f_open>`.
27 34
28 ``status`` 35 ``status``
29 pointer to a bitmask integer filled with t 36 pointer to a bitmask integer filled with the values defined by enum
30 :c:type:`fe_status`. 37 :c:type:`fe_status`.
31 38
>> 39
32 Description 40 Description
33 =========== 41 ===========
34 42
35 All Digital TV frontend devices support the `` 43 All Digital TV frontend devices support the ``FE_READ_STATUS`` ioctl. It is
36 used to check about the locking status of the 44 used to check about the locking status of the frontend after being
37 tuned. The ioctl takes a pointer to an integer 45 tuned. The ioctl takes a pointer to an integer where the status will be
38 written. 46 written.
39 47
40 .. note:: 48 .. note::
41 49
42 The size of status is actually sizeof(enum 50 The size of status is actually sizeof(enum fe_status), with
43 varies according with the architecture. Thi 51 varies according with the architecture. This needs to be fixed in the
44 future. 52 future.
45 53
>> 54
46 int fe_status 55 int fe_status
47 ============= 56 =============
48 57
49 The fe_status parameter is used to indicate th 58 The fe_status parameter is used to indicate the current state and/or
50 state changes of the frontend hardware. It is 59 state changes of the frontend hardware. It is produced using the enum
51 :c:type:`fe_status` values on a bitmask 60 :c:type:`fe_status` values on a bitmask
>> 61
52 62
53 Return Value 63 Return Value
54 ============ 64 ============
55 65
56 On success 0 is returned. 66 On success 0 is returned.
57 67
58 On error -1 is returned, and the ``errno`` var 68 On error -1 is returned, and the ``errno`` variable is set
59 appropriately. 69 appropriately.
60 70
61 Generic error codes are described at the 71 Generic error codes are described at the
62 :ref:`Generic Error Codes <gen-errors>` chapte 72 :ref:`Generic Error Codes <gen-errors>` chapter.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.