1 .. SPDX-License-Identifier: GFDL-1.1-no-invari 1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.fe 2 .. c:namespace:: DTV.fe
3 3
4 .. _FE_GET_EVENT: 4 .. _FE_GET_EVENT:
5 5
6 ************ 6 ************
7 FE_GET_EVENT 7 FE_GET_EVENT
8 ************ 8 ************
9 9
10 Name 10 Name
11 ==== 11 ====
12 12
13 FE_GET_EVENT 13 FE_GET_EVENT
14 14
15 .. attention:: This ioctl is deprecated. 15 .. attention:: This ioctl is deprecated.
16 16
17 Synopsis 17 Synopsis
18 ======== 18 ========
19 19
20 .. c:macro:: FE_GET_EVENT 20 .. c:macro:: FE_GET_EVENT
21 21
22 ``int ioctl(int fd, FE_GET_EVENT, struct dvb_f 22 ``int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev)``
23 23
24 Arguments 24 Arguments
25 ========= 25 =========
26 26
27 ``fd`` 27 ``fd``
28 File descriptor returned by :c:func:`open( 28 File descriptor returned by :c:func:`open()`.
29 29
30 ``ev`` 30 ``ev``
31 Points to the location where the event, if 31 Points to the location where the event, if any, is to be stored.
32 32
33 Description 33 Description
34 =========== 34 ===========
35 35
36 This ioctl call returns a frontend event if av 36 This ioctl call returns a frontend event if available. If an event is
37 not available, the behavior depends on whether 37 not available, the behavior depends on whether the device is in blocking
38 or non-blocking mode. In the latter case, the 38 or non-blocking mode. In the latter case, the call fails immediately
39 with errno set to ``EWOULDBLOCK``. In the form 39 with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
40 an event becomes available. 40 an event becomes available.
41 41
42 Return Value 42 Return Value
43 ============ 43 ============
44 44
45 On success 0 is returned. 45 On success 0 is returned.
46 46
47 On error -1 is returned, and the ``errno`` var 47 On error -1 is returned, and the ``errno`` variable is set
48 appropriately. 48 appropriately.
49 49
50 .. flat-table:: 50 .. flat-table::
51 :header-rows: 0 51 :header-rows: 0
52 :stub-columns: 0 52 :stub-columns: 0
53 53
54 - .. row 1 54 - .. row 1
55 55
56 - ``EWOULDBLOCK`` 56 - ``EWOULDBLOCK``
57 57
58 - There is no event pending, and the d 58 - There is no event pending, and the device is in non-blocking mode.
59 59
60 - .. row 2 60 - .. row 2
61 61
62 - ``EOVERFLOW`` 62 - ``EOVERFLOW``
63 63
64 - Overflow in event queue - one or mor 64 - Overflow in event queue - one or more events were lost.
65 65
66 Generic error codes are described at the 66 Generic error codes are described at the
67 :ref:`Generic Error Codes <gen-errors>` chapte 67 :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.