1.. -*- coding: utf-8; mode: rst -*-
2
3.. _FE_READ_STATUS:
4
5********************
6ioctl FE_READ_STATUS
7********************
8
9Name
10====
11
12FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device
13
14
15Synopsis
16========
17
18.. c:function:: int ioctl( int fd, FE_READ_STATUS, unsigned int *status )
19    :name: FE_READ_STATUS
20
21
22Arguments
23=========
24
25``fd``
26    File descriptor returned by :ref:`open() <frontend_f_open>`.
27
28``status``
29    pointer to a bitmask integer filled with the values defined by enum
30    :c:type:`fe_status`.
31
32
33Description
34===========
35
36All Digital TV frontend devices support the ``FE_READ_STATUS`` ioctl. It is
37used to check about the locking status of the frontend after being
38tuned. The ioctl takes a pointer to an integer where the status will be
39written.
40
41.. note::
42
43   The size of status is actually sizeof(enum fe_status), with
44   varies according with the architecture. This needs to be fixed in the
45   future.
46
47
48int fe_status
49=============
50
51The fe_status parameter is used to indicate the current state and/or
52state changes of the frontend hardware. It is produced using the enum
53:c:type:`fe_status` values on a bitmask
54
55
56Return Value
57============
58
59On success 0 is returned.
60
61On error -1 is returned, and the ``errno`` variable is set
62appropriately.
63
64Generic error codes are described at the
65:ref:`Generic Error Codes <gen-errors>` chapter.
66